Marker (legacy)

מחלקה Marker

google.maps.Marker class
extends MVCObject
library "marker"

const {Marker} = await google.maps.importLibrary("marker");
Marker
Marker([opts])
פרמטרים:
יוצרת סמן עם האפשרויות שצוינו. אם מציינים מפה, הסמן מתווסף למפה בזמן היצירה. שימו לב שצריך להגדיר את המיקום כדי שהסמן יוצג.
MAX_ZINDEX ערך ברירת המחדל המקסימלי של z-index שה-API יקצה לסמן. אפשר להגדיר ערך z-index גבוה יותר כדי להביא סמן לחזית.
getAnimation
getAnimation()
פרמטרים: אין
ערך מוחזר: Animation|null|undefined
קבלת האנימציה שפועלת כרגע.
getClickable
getClickable()
פרמטרים: אין
ערך מוחזר: boolean True אם אפשר ללחוץ על הסמן.
קבלת סטטוס הקישור של Marker.
getCursor
getCursor()
פרמטרים: אין
ערך מוחזר: string|null|undefined
קבלת סוג סמן העכבר שמוצג כשמציבים אותו מעל הדף.
getDraggable
getDraggable()
פרמטרים: אין
ערך מוחזר: boolean True אם הסמן ניתן לגרירה.
קבלת סטטוס הגרירה של Marker.
getIcon
getIcon()
פרמטרים: אין
ערך מוחזר: string|Icon|Symbol|null|undefined
הסמל של Marker. MarkerOptions.icon.
getLabel
getLabel()
פרמטרים: אין
ערך מוחזר: MarkerLabel|string|null|undefined
קבלת התווית של Marker. MarkerOptions.label.
getMap
getMap()
פרמטרים: אין
ערך מוחזר: Map|StreetViewPanorama|null
קבלת המפה או הפנורמה שבהן מוצג Marker.
getOpacity
getOpacity()
פרמטרים: אין
ערך מוחזר: number|null|undefined מספר בין 0.0 ל-1.0.
הצגת מידת האטימות של Marker.
getPosition
getPosition()
פרמטרים: אין
ערך מוחזר: LatLng|null|undefined
קבלת המיקום של Marker.
getShape
getShape()
פרמטרים: אין
ערך מוחזר: MarkerShape|null|undefined
קבלת הצורה של Marker שמשמשת לאינטראקציה. פרטים נוספים זמינים בMarkerOptions.shape ובMarkerShape.
getTitle
getTitle()
פרמטרים: אין
ערך מוחזר: string|null|undefined
קבלת הכותרת של ההסבר הקצר Marker. MarkerOptions.title.
getVisible
getVisible()
פרמטרים: אין
ערך מוחזר: boolean True אם הסמן גלוי.
הצגת החשיפה של Marker.
getZIndex
getZIndex()
פרמטרים: אין
ערך מוחזר: number|null|undefined zIndex של הסמן.
קבלת ה-zIndex של Marker. MarkerOptions.zIndex.
setAnimation
setAnimation([animation])
פרמטרים:
  • animation: Animation optional האנימציה שרוצים להפעיל.
הערך המוחזר: אין
הפעלת אנימציה. כל אנימציה שפועלת תבוטל. האנימציות שנתמכות כרגע הן: Animation.BOUNCE,‏ Animation.DROP. העברת null תגרום להפסקת האנימציה.
setClickable
setClickable(flag)
פרמטרים:
  • ‫flag: boolean אם הערך הוא true, אפשר ללחוץ על הסמן.
הערך המוחזר: אין
הגדרה אם אפשר ללחוץ על Marker.
setCursor
setCursor([cursor])
פרמטרים:
  • ‫cursor: סוג סמן העכבר string optional.
הערך המוחזר: אין
הגדרת סוג סמן העכבר שמוצג כשמציבים אותו מעל הדף.
setDraggable
setDraggable(flag)
פרמטרים:
  • ‫flag: boolean optional אם הערך הוא true, אפשר לגרור את הסמן.
הערך המוחזר: אין
הגדרה אם Marker ניתן לגרירה.
setIcon
setIcon([icon])
פרמטרים:
הערך המוחזר: אין
הגדרת הסמל של Marker. MarkerOptions.icon.
setLabel
setLabel([label])
פרמטרים:
  • ‫label: string|MarkerLabel optional התווית יכולה להיות מחרוזת תווים או אובייקט מסוג MarkerLabel.
הערך המוחזר: אין
מגדירים את התווית של Marker. MarkerOptions.label.
setMap
setMap(map)
פרמטרים:
הערך המוחזר: אין
הצגת Marker במפה או בתצוגה הפנורמית שצוינה. אם המפה מוגדרת לערך null, הסמן יוסר.
setOpacity
setOpacity([opacity])
פרמטרים:
  • ‫opacity: number optional מספר בין 0.0 (שקוף) ל-1.0 (אטום).
הערך המוחזר: אין
מגדירים את האטימות של Marker.
setOptions
setOptions(options)
פרמטרים:
הערך המוחזר: אין
מגדירים את האפשרויות של Marker.
setPosition
setPosition([latlng])
פרמטרים:
הערך המוחזר: אין
מגדירים את המיקום של Marker.
setShape
setShape([shape])
פרמטרים:
הערך המוחזר: אין
הגדרת הצורה של Marker שמשמש לאינטראקציה. פרטים נוספים זמינים בMarkerOptions.shape ובMarkerShape.
setTitle
setTitle([title])
פרמטרים:
  • title: string optional
הערך המוחזר: אין
הגדרת הכותרת של ההסבר הקצר של Marker. MarkerOptions.title.
setVisible
setVisible(visible)
פרמטרים:
  • visible: boolean אם true, הסמן גלוי
הערך המוחזר: אין
הגדרת החשיפה של Marker.
setZIndex
setZIndex([zIndex])
פרמטרים:
  • zIndex: number optional
הערך המוחזר: אין
מגדירים את ה-zIndex של Marker. MarkerOptions.zIndex.
‫עברו בירושה: addListener, bindTo, get, notify, set, setValues, unbind, unbindAll
animation_changed
function()
ארגומנטים: אין
האירוע הזה מופעל כשמאפיין האנימציה Marker משתנה.
click
function(event)
ארגומנטים:
האירוע הזה מופעל כשלוחצים על הסמל Marker.
clickable_changed
function()
ארגומנטים: אין
האירוע הזה מופעל כשהמאפיין Marker שניתן ללחוץ עליו משתנה.
contextmenu
function(event)
ארגומנטים:
האירוע הזה מופעל כשאירוע contextmenu של DOM מופעל ב-Marker
cursor_changed
function()
ארגומנטים: אין
האירוע הזה מופעל כשמאפיין הסמן Marker משתנה.
dblclick
function(event)
ארגומנטים:
האירוע הזה מופעל כשלוחצים לחיצה כפולה על הסמל Marker.
drag
function(event)
ארגומנטים:
האירוע הזה מופעל שוב ושוב בזמן שהמשתמש גורר את Marker.
dragend
function(event)
ארגומנטים:
האירוע הזה מופעל כשהמשתמש מפסיק לגרור את Marker.
draggable_changed
function()
ארגומנטים: אין
האירוע הזה מופעל כשהמאפיין Marker שניתן לגרירה משתנה.
dragstart
function(event)
ארגומנטים:
האירוע הזה מופעל כשהמשתמש מתחיל לגרור את Marker.
flat_changed
function()
ארגומנטים: אין
האירוע הזה מופעל כשהמאפיין Marker משתנה.
icon_changed
function()
ארגומנטים: אין
האירוע הזה מופעל כשמאפיין הסמל של Marker משתנה.
mousedown
function(event)
ארגומנטים:
האירוע הזה מופעל כשלוחצים על הלחצן השמאלי של העכבר ב-Marker.
mouseout
function(event)
ארגומנטים:
האירוע הזה מופעל כשהעכבר יוצא מהאזור של הסמל Marker.
mouseover
function(event)
ארגומנטים:
האירוע הזה מופעל כשהעכבר נכנס לאזור של הסמל Marker.
mouseup
function(event)
ארגומנטים:
האירוע הזה מופעל כשמשחררים את הלחצן של העכבר ב-Marker.
position_changed
function()
ארגומנטים: אין
האירוע הזה מופעל כשמאפיין המיקום של Marker משתנה.
shape_changed
function()
ארגומנטים: אין
האירוע הזה מופעל כשמאפיין הצורה Marker משתנה.
title_changed
function()
ארגומנטים: אין
האירוע הזה מופעל כשמאפיין הכותרת של Marker משתנה.
visible_changed
function()
ארגומנטים: אין
האירוע הזה מופעל כשמאפיין החשיפה של Marker משתנה.
zindex_changed
function()
ארגומנטים: אין
האירוע הזה מופעל כשמאפיין ה-zIndex של Marker משתנה.
rightclick
function(event)
ארגומנטים:
האירוע הזה מופעל בלחיצה ימנית על Marker.

ממשק MarkerOptions

ממשק google.maps.MarkerOptions

אובייקט MarkerOptions שמשמש להגדרת המאפיינים שאפשר להגדיר בסמן.

anchorPoint
אופציונלי
סוג: Point optional
ההיסט ממיקום הסמן לקצה של InfoWindow שנפתח כשהסמן משמש כעוגן.
animation
אופציונלי
סוג: Animation optional
ברירת המחדל: null
איזו אנימציה תופעל כשסמן יתווסף למפה.
clickable
אופציונלי
סוג: boolean optional
ברירת המחדל: true
אם הערך הוא true, הסמן מקבל אירועי עכבר ומגע.
BetacollisionBehavior
אופציונלי
סוג: string|CollisionBehavior optional
ברירת המחדל: null
הגדרת התנהגות במקרה של חפיפה בין סמנים במפות וקטוריות.
crossOnDrag
אופציונלי
סוג: boolean optional
ברירת המחדל: true
אם הערך הוא false, הצלב שמופיע מתחת לסמן בזמן הגרירה מושבת.
cursor
אופציונלי
סוג: string optional
ברירת המחדל: pointer
סוג סמן העכבר שיוצג כשמציבים אותו מעל הדף.
draggable
אופציונלי
סוג: boolean optional
ברירת המחדל: false
אם הערך הוא true, אפשר לגרור את הסמן. הערה: אם מגדירים את המאפיין הזה לערך true, אפשר יהיה ללחוץ על הסמן גם אם המאפיין clickable מוגדר לערך false.
icon
אופציונלי
סוג: string|Icon|Symbol optional
סמל לחזית. אם מספקים מחרוזת, המערכת מתייחסת אליה כאילו היא Icon עם המחרוזת בתור url.
label
אופציונלי
סוג: string|MarkerLabel optional
ברירת המחדל: null
הוספת תווית לסמן. תווית של סמן היא אות או מספר שמופיעים בתוך סמן. התווית יכולה להיות מחרוזת או אובייקט MarkerLabel. אם מספקים את הפרמטר הזה ולא מספקים את הפרמטר MarkerOptions.title, טקסט נגישות (למשל, לשימוש עם קוראי מסך) יתווסף לסמן עם הטקסט של התווית שסופקה. חשוב לדעת שהשדה label משמש כרגע רק לטקסט נגישות של סמנים לא מותאמים.
map
אופציונלי
סוג: Map|StreetViewPanorama optional
המפה שבה יוצג הסמן. המפה נדרשת כדי להציג את הסמן, ואפשר לספק אותה באמצעות Marker.setMap אם היא לא סופקה במהלך יצירת הסמן.
opacity
אופציונלי
סוג: number optional
ברירת מחדל: 1.0
מספר בין 0.0 (שקוף) ל-1.0 (אטום).
optimized
אופציונלי
סוג: boolean optional
האופטימיזציה משפרת את הביצועים על ידי עיבוד של סמנים רבים כרכיב סטטי אחד. האפשרות הזו שימושית במקרים שבהם נדרש מספר גדול של סמנים. מידע נוסף על אופטימיזציה של סמנים הערה: האופטימיזציה הזו לא משפיעה על סמנים במפות וקטוריות.
position
אופציונלי
סוג: LatLng|LatLngLiteral optional
מגדירה את מיקום הסמן. יכול להיות שסמן ייבנה אבל לא יוצג עד שהמיקום שלו יסופק – לדוגמה, על ידי פעולות או בחירות של משתמש. אפשר לציין את מיקום הסמן באמצעות Marker.setPosition אם הוא לא צוין במהלך יצירת הסמן.
shape
אופציונלי
סוג: MarkerShape optional
הגדרת אזור במפת התמונה שמשמשת לגרירה או ללחיצה.
title
אופציונלי
סוג: string optional
ברירת המחדל: undefined
טקסט שמופיע כשמעבירים את העכבר מעל התמונה. אם תספקו טקסט נגישות (למשל, לשימוש עם קוראי מסך), הוא יתווסף לסמן עם הערך שסופק. חשוב לדעת שהשדה title משמש כרגע רק לטקסט נגישות של סמנים לא מותאמים.
visible
אופציונלי
סוג: boolean optional
ברירת המחדל: true
אם true, הסמן גלוי.
zIndex
אופציונלי
סוג: number optional
כל הסמנים מוצגים במפה לפי סדר ה-zIndex שלהם, כאשר ערכים גבוהים יותר מוצגים לפני סמנים עם ערכים נמוכים יותר. כברירת מחדל, הסמנים מוצגים לפי המיקום האנכי שלהם במסך, כך שסמנים נמוכים יותר מופיעים לפני סמנים שנמצאים גבוה יותר במסך.

קבועים של CollisionBehavior

google.maps.CollisionBehavior קבועים
ספרייה "marker"

אפשר להשתמש בקבועים האלה גם כמחרוזות. ב-TypeScript, המחרוזות המילוליות מוגדרות לפי הסוג CollisionBehaviorString.

const {CollisionBehavior} = await google.maps.importLibrary("marker");
OPTIONAL_AND_HIDES_LOWER_PRIORITY הצגת הסמן רק אם הוא לא חופף לסמנים אחרים. אם שני סמנים מהסוג הזה חופפים, יוצג הסמן עם ערך ה-zIndex הגבוה יותר. אם יש להם אותו zIndex, מוצג זה עם מיקום המסך האנכי הנמוך יותר.
REQUIRED הצגת הסמן תמיד, גם אם יש חפיפה. זאת פעולת ברירת המחדל.
REQUIRED_AND_HIDES_OPTIONAL הסמן תמיד יוצג, גם אם יש חפיפה, ויוסתרו כל הסמנים או התוויות מסוג OPTIONAL_AND_HIDES_LOWER_PRIORITY שחופפים לסמן.

ממשק Icon

ממשק google.maps.Icon

מבנה שמייצג תמונה של סמל סמן.

url
סוג: string
כתובת ה-URL של התמונה או של גיליון ה-sprite.
anchor
אופציונלי
סוג: Point optional
המיקום שבו התמונה תעוגן ביחס למיקום של הסמן במפה. כברירת מחדל, העוגן ממוקם לאורך נקודת המרכז של החלק התחתון של התמונה.
labelOrigin
אופציונלי
סוג: Point optional
מקור התווית ביחס לפינה השמאלית העליונה של תמונת הסמל, אם הסמן מספק תווית. כברירת מחדל, נקודת המוצא נמצאת בנקודת המרכז של התמונה.
origin
אופציונלי
סוג: Point optional
המיקום של התמונה בתוך ספרייט, אם יש כזה. כברירת מחדל, נקודת המוצא נמצאת בפינה השמאלית העליונה של התמונה (0, 0).
scaledSize
אופציונלי
סוג: Size optional
הגודל של התמונה כולה אחרי שינוי קנה המידה, אם יש כזה. אפשר להשתמש במאפיין הזה כדי למתוח או לכווץ תמונה או ספרייט.
size
אופציונלי
סוג: Size optional
גודל התצוגה של הספרייט או התמונה. כשמשתמשים בספרייטים, צריך לציין את גודל הספרייט. אם לא מציינים את הגודל, הוא יוגדר כשהתמונה תיטען.

ממשק MarkerLabel

ממשק google.maps.MarkerLabel

האפשרויות האלה קובעות את המראה של תווית הסמן. תווית של סמן היא מחרוזת (לרוב תו בודד) שמופיעה בתוך הסמן. אם משתמשים בו עם סמן בהתאמה אישית, אפשר לשנות את המיקום שלו באמצעות המאפיין labelOrigin במחלקה Icon.

text
סוג: string
הטקסט שיוצג בתווית.
className
אופציונלי
סוג: string optional
ברירת המחדל: '' (מחרוזת ריקה)
המאפיין className של רכיב התווית (מקביל למאפיין class של הרכיב). אפשר להוסיף כמה מחלקות CSS שמופרדות ברווחים. אפשר להגדיר את הצבע, הגודל, העובי והמשפחה של הגופן רק דרך המאפיינים האחרים של MarkerLabel. אם משתמשים גם בניהול התנגשויות בין סמנים, אסור להשתמש במחלקות CSS כדי לשנות את המיקום או הכיוון של התווית (למשל, באמצעות תרגומים וסיבובים).
color
אופציונלי
סוג: string optional
ברירת המחדל: 'black'
צבע הטקסט של התווית.
fontFamily
אופציונלי
סוג: string optional
משפחת הגופנים של טקסט התווית (מקבילה למאפיין font-family ב-CSS).
fontSize
אופציונלי
סוג: string optional
ברירת המחדל: '14px'
גודל הגופן של טקסט התווית (מקביל למאפיין font-size ב-CSS).
fontWeight
אופציונלי
סוג: string optional
עובי הגופן של טקסט התווית (מקביל למאפיין font-weight ב-CSS).

ממשק MarkerShape

ממשק google.maps.MarkerShape

האובייקט הזה מגדיר את האזור שאפשר ללחוץ עליו בתמונה של סמן. הצורה מורכבת משני מאפיינים – type ו-coord – שמגדירים את האזור הלא שקוף של התמונה.

type
סוג: string
מתאר את סוג הצורה, ויכול להיות circle,‏ poly או rect.
coords
אופציונלי
סוג: Array<number> optional
הפורמט של המאפיין הזה תלוי בערך של type, והוא תואם למפרט של w3 AREA coords שמופיע בכתובת http://www.w3.org/TR/REC-html40/struct/objects.html#adef-coords.
המאפיין coords הוא מערך של מספרים שלמים שמציינים את מיקום הפיקסלים של הצורה ביחס לפינה השמאלית העליונה של תמונת היעד. הקואורדינטות תלויות בערך של type באופן הבא:
  - circle: הקואורדינטות הן [x1,y1,r] כאשר x1,y2 הן הקואורדינטות של מרכז המעגל, ו-r הוא הרדיוס של המעגל.
  - poly: הקואורדינטות הן [x1,y1,x2,y2...xn,yn], כאשר כל זוג x,y מכיל את הקואורדינטות של קודקוד אחד של המצולע. ‫
  - rect: הקואורדינטות הן [x1,y1,x2,y2], כאשר x1,y1 הן הקואורדינטות של הפינה השמאלית העליונה של המלבן ו-x2,y2 הן הקואורדינטות של הפינה הימנית התחתונה של המלבן.

ממשק Symbol

ממשק google.maps.Symbol

מתאר סמל, שמורכב מנתיב וקטורי עם סגנון. אפשר להשתמש בסמל כסמן או להציב אותו על קו פוליגוני.

path
סוג: SymbolPath|string
הנתיב של הסמל, שהוא נתיב סמל מובנה, או נתיב בהתאמה אישית שמבוטא באמצעות סימון נתיב SVG. חובה.
anchor
אופציונלי
סוג: Point optional
ברירת המחדל: google.maps.Point(0,0)
המיקום של הסמל ביחס לסמן או לקו הפוליגוני. הקואורדינטות של נתיב הסמל מתורגמות שמאלה ולמעלה לפי קואורדינטות ה-X וה-Y של העוגן, בהתאמה. המיקום מבוטא באותה מערכת קואורדינטות כמו הנתיב של הסמל.
fillColor
אופציונלי
סוג: string optional
צבע המילוי של הסמל. כל הצבעים של CSS3 נתמכים, חוץ מצבעים עם שמות מורחבים. בסמני סמלים, ברירת המחדל היא "black". בסמלים על קווים פוליגוניים, ברירת המחדל היא צבע הקו של הקו הפוליגוני המתאים.
fillOpacity
אופציונלי
סוג: number optional
ברירת המחדל: 0
מידת האטימות של המילוי של הסמל.
labelOrigin
אופציונלי
סוג: Point optional
ברירת המחדל: google.maps.Point(0,0)
מקור התווית ביחס למקור הנתיב, אם התווית מסופקת על ידי הסמן. נקודת המוצא מבוטאת באותה מערכת קואורדינטות כמו הנתיב של הסמל. המאפיין הזה לא משמש לסמלים בקווים פוליגוניים.
rotation
אופציונלי
סוג: number optional
ברירת המחדל: 0
הזווית שבה הסמל יסתובב, מבוטאת במעלות בכיוון השעון. סמל ב-IconSequence שבו fixedRotation הוא false מסובב ביחס לזווית של הקצה שעליו הוא נמצא.
scale
אופציונלי
סוג: number optional
הסכום שבו הסמל מוגדל או מוקטן. בסמני סמלים, ערך ברירת המחדל הוא 1. אחרי שינוי קנה המידה, הסמל יכול להיות בכל גודל. לסמלים בקו פוליגוני, ברירת המחדל היא עובי הקו של הקו הפוליגוני. אחרי שינוי קנה המידה, הסמל חייב להיות בתוך ריבוע בגודל 22 פיקסלים שמרכזו בנקודת העיגון של הסמל.
strokeColor
אופציונלי
סוג: string optional
צבע קו המתאר של הסמל. כל הצבעים של CSS3 נתמכים, חוץ מצבעים עם שמות מורחבים. בסמני סמלים, ברירת המחדל היא "black". בסמלים בקו פוליגוני, ברירת המחדל היא צבע הקו של הקו הפוליגוני.
strokeOpacity
אופציונלי
סוג: number optional
אטימות הקו של הסמל. בסמנים של סמלים, ברירת המחדל היא 1. לסמלים בקו פוליגוני, ברירת המחדל היא אטימות הקו של הקו הפוליגוני.
strokeWeight
אופציונלי
סוג: number optional
ברירת מחדל: ה-Symbol.scale של הסמל.
עובי הקו של הסמל.

קבועים של SymbolPath

google.maps.SymbolPath קבועים
ספרייה "core"

נתיבי סמלים מובנים.

const {SymbolPath} = await google.maps.importLibrary("core");
BACKWARD_CLOSED_ARROW חץ סגור שפונה אחורה.
BACKWARD_OPEN_ARROW חץ פתוח שפונה אחורה.
CIRCLE מעגל.
FORWARD_CLOSED_ARROW חץ סגור שפונה קדימה.
FORWARD_OPEN_ARROW חץ פתוח שמצביע קדימה.

קבועים של אנימציה

google.maps.Animation קבועים
ספרייה "marker"

אנימציות שאפשר להפעיל על סמן. כדי להפעיל אנימציה, משתמשים ב-method‏ Marker.setAnimation ב-Marker או באפשרות MarkerOptions.animation.

const {Animation} = await google.maps.importLibrary("marker");
BOUNCE הסמן מקפץ עד שהאנימציה נעצרת על ידי קריאה ל-Marker.setAnimation עם null.
DROP הסמן נופל מהחלק העליון של המפה למיקום הסופי שלו. האנימציה תיפסק כשהסמן יפסיק לזוז, ו-Marker.getAnimation יחזיר את הערך null. בדרך כלל מציינים את סוג האנימציה הזה כשיוצרים את הסמן.