کلاس نشانگر
google.maps.Marker
class
extends MVCObject
library "marker"
const {Marker} = await google.maps.importLibrary("marker");
سازنده | |
|---|---|
Marker |
Marker([opts])پارامترها:
نشانگری با گزینههای مشخصشده ایجاد میکند. اگر نقشهای مشخص شده باشد، نشانگر هنگام ساخت به نقشه اضافه میشود. توجه داشته باشید که برای نمایش نشانگر، باید موقعیت تنظیم شود. |
ثابتها | |
|---|---|
MAX_ZINDEX |
حداکثر شاخص z پیشفرضی که 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()پارامترها: هیچ
نماد Marker را دریافت کنید. MarkerOptions.icon را ببینید. |
getLabel |
getLabel()پارامترها: هیچ
مقدار برگشتی:
MarkerLabel|string|null|undefinedبرچسب Marker را دریافت کنید. MarkerOptions.label را ببینید. |
getMap |
getMap()پارامترها: هیچ
مقدار برگشتی:
Map|StreetViewPanorama|nullنقشه یا پانورامایی را که Marker روی آن ارائه شده است دریافت کنید. |
getOpacity |
getOpacity()پارامترها: هیچ
مقدار برگشتی:
number|null|undefined عددی بین ۰٫۰ و ۱٫۰.ماتی Marker را دریافت کنید. |
getPosition |
getPosition()پارامترها: هیچ
مقدار برگشتی:
LatLng|null|undefinedموقعیت Marker را دریافت کنید. |
getShape |
getShape()پارامترها: هیچ
مقدار برگشتی:
MarkerShape|null|undefined |
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.BOUNCE، Animation.DROP. ارسال null باعث توقف هرگونه پویانمایی میشود. |
setClickable |
setClickable(flag)پارامترها:
مقدار برگشتی: هیچ
تنظیم کنید که آیا Marker قابلکلیک باشد یا نه. |
setCursor |
setCursor([cursor])پارامترها:
مقدار برگشتی: هیچ
نوع مکاننمای موشواره را که هنگام نگه داشتن نشان داده میشود تنظیم کنید. |
setDraggable |
setDraggable(flag)پارامترها:
مقدار برگشتی: هیچ
تنظیم کنید که آیا Marker کشیدنی باشد یا نه. |
setIcon |
setIcon([icon])مقدار برگشتی: هیچ
نماد Marker را تنظیم کنید. MarkerOptions.icon را ببینید. |
setLabel |
setLabel([label])پارامترها:
مقدار برگشتی: هیچ
برچسب Marker را تنظیم کنید. MarkerOptions.label را ببینید. |
setMap |
setMap(map)پارامترها:
مقدار برگشتی: هیچ
Marker را در نقشه یا تمامنمای مشخصشده ارائه میکند. اگر نقشه روی null تنظیم شده باشد، نشانگر برداشته خواهد شد. |
setOpacity |
setOpacity([opacity])پارامترها:
مقدار برگشتی: هیچ
ماتی Marker را تنظیم میکند. |
setOptions |
setOptions(options)پارامترها:
مقدار برگشتی: هیچ
گزینههای Marker را تنظیم کنید. |
setPosition |
setPosition([latlng])پارامترها:
مقدار برگشتی: هیچ
موقعیت Marker را تنظیم کنید. |
setShape |
setShape([shape])پارامترها:
مقدار برگشتی: هیچ
|
setTitle |
setTitle([title])پارامترها:
مقدار برگشتی: هیچ
Set the title of the Marker tooltip. MarkerOptions.title را ببینید. |
setVisible |
setVisible(visible)پارامترها:
مقدار برگشتی: هیچ
تنظیم کنید که Marker نمایان باشد یا نه. |
setZIndex |
setZIndex([zIndex])پارامترها:
مقدار برگشتی: هیچ
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)متغیرهای مستقل:
این رویداد زمانی فعال میشود که رویداد DOM contextmenu در 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()متغیرهای مستقل: هیچ
این رویداد زمانی فعال میشود که ویژگی Marker zIndex تغییر کند. |
|
function(event)متغیرهای مستقل:
This event is fired for a rightclick on the Marker. |
میانای MarkerOptions
میانا
google.maps.MarkerOptions
شیء MarkerOptions برای تعریف ویژگیهایی که میتوان در «نشانگر» تنظیم کرد استفاده میشود.
مشخصات | |
|---|---|
anchorPoint
اختیاری |
نوع:
Point optionalفاصله از موقعیت نشانگر تا نوک InfoWindow که با نشانگر بهعنوان لنگر باز شده است. |
animation
اختیاری |
نوع:
Animation optionalپیشفرض:
nullکدام پویانمایی هنگام اضافه شدن نشانگر به نقشه پخش شود. |
clickable
اختیاری |
نوع:
boolean optionalپیشفرض:
trueاگر true، نشانگر رویدادهای لمسی و موشواره را دریافت میکند. |
اختیاری |
نوع:
string|CollisionBehavior optionalپیشفرض:
nullرفتار تصادم را برای نشانگرها در نقشههای بُرداری تنظیم کنید. |
crossOnDrag
اختیاری |
نوع:
boolean optionalپیشفرض:
trueاگر false، علامت ضربدر را که هنگام کشیدن زیر نشانگر ظاهر میشود غیرفعال میکند. |
cursor
اختیاری |
نوع:
string optionalپیشفرض:
pointerنوع مکاننمای موشواره برای نمایش هنگام نگه داشتن نشانگر. |
draggable
اختیاری |
نوع:
boolean optionalپیشفرض:
falseاگر true باشد، نشانگر را میتوان کشید. توجه: تنظیم این مقدار روی true باعث میشود نشانگر قابلکلیک باشد، حتی اگر clickable روی false تنظیم شده باشد. |
icon
اختیاری |
نماد پیشزمینه. اگر رشتهای ارائه شود، با آن طوری رفتار میشود که گویی Icon است و رشته بهعنوان url درنظر گرفته میشود. |
label
اختیاری |
نوع:
string|MarkerLabel optionalپیشفرض:
nullبرچسبی به نشانگر اضافه میکند. برچسب نشانگر حرف یا عددی است که داخل نشانگر نمایش داده میشود. برچسب میتواند رشته یا شیء MarkerLabel باشد. اگر ارائه شده باشد و MarkerOptions.title ارائه نشده باشد، نوشتار دسترسپذیری (مثلاً برای استفاده با صفحهخوانها) با نوشتار برچسب ارائهشده به نشانگر اضافه خواهد شد. لطفاً توجه داشته باشید که label درحالحاضر فقط برای نوشتار دسترسپذیری برای نشانگرهای بهینهنشده استفاده میشود. |
map
اختیاری |
نوع:
Map|StreetViewPanorama optionalنقشهای که نشانگر روی آن نمایش داده میشود. نقشه برای نمایش نشانگر لازم است و اگر در ساخت نشانگر ارائه نشده باشد، میتوان آن را با Marker.setMap ارائه کرد. |
opacity
اختیاری |
نوع:
number optionalپیشفرض: ۱.۰
عددی بین ۰٫۰ (شفاف) و ۱٫۰ (مات). |
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 را که با نشانگر همپوشانی دارد پنهان کنید. |
نماد میانا
میانا
google.maps.Icon
ساختاری که تصویر نماد «نشانگر» را نشان میدهد.
مشخصات | |
|---|---|
url |
نوع:
stringنشانی وب تصویر یا برگه اسپرایت. |
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 عنصر برچسب (معادل مشخصه کلاس عنصر). میتوانید چند کلاس CSS را که با فاصله از هم جدا شدهاند اضافه کنید. رنگ، اندازه، وزن، و خانواده قلم را فقط میتوان ازطریق دیگر ویژگیهای MarkerLabel تنظیم کرد. اگر از مدیریت برخورد نشانگر نیز استفاده میشود، نباید از کلاسهای CSS برای تغییر موقعیت یا جهت برچسب (مثلاً بااستفاده از ترجمه و چرخش) استفاده شود. |
color
اختیاری |
نوع:
string optionalپیشفرض:
'black'رنگ نوشتار برچسب. |
fontFamily
اختیاری |
نوع:
string optionalخانواده قلم نوشتار برچسب (معادل ویژگی CSS font-family). |
fontSize
اختیاری |
نوع:
string optionalپیشفرض:
'14px'اندازه قلم نوشتار برچسب (معادل ویژگی CSS font-size). |
fontWeight
اختیاری |
نوع:
string optionalسیاهی قلم نوشتار برچسب (معادل ویژگی CSS font-weight). |
میانای 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: coords [x1,y1,r] است که x1,y2 مختصات مرکز دایره و r شعاع دایره است. - poly: coords [x1,y1,x2,y2...xn,yn] است که هر جفت x,y حاوی مختصات یک رأس چندضلعی است. - rect: coords [x1,y1,x2,y2] است که x1,y1 مختصات گوشه بالا سمت چپ مستطیل و x2,y2 مختصات گوشه پایین سمت راست مستطیل است. |
نماد میانا
میانا
google.maps.Symbol
نمادی را توصیف میکند که شامل مسیر برداری با سبک است. از نماد میتوان بهعنوان نماد نشانگر استفاده کرد یا آن را روی چندخطی قرار داد.
مشخصات | |
|---|---|
path |
نوع:
SymbolPath|stringمسیر نماد، که مسیر نماد توکار است، یا مسیر سفارشی که بااستفاده از نشانگذاری مسیر SVG بیان میشود. الزامی. |
anchor
اختیاری |
نوع:
Point optionalپیشفرض:
google.maps.Point(0,0)موقعیت نماد نسبت به نشانگر یا چندخطی. مختصات مسیر نماد بهترتیب با مختصات x و y لنگر به چپ و بالا ترجمه میشود. موقعیت در همان سیستم مختصاتی بیان میشود که مسیر نماد است. |
fillColor
اختیاری |
نوع:
string optionalرنگ پرکننده نماد. همه رنگهای CSS3 بهجز رنگهای نامگذاریشده گسترده پشتیبانی میشوند. برای نشانگرهای نماد، این مقدار بهطور پیشفرض «سیاه» است. برای نمادهای روی چندخطیها، این مقدار بهطور پیشفرض رنگ خط چندخطی مربوطه است. |
fillOpacity
اختیاری |
نوع:
number optionalپیشفرض:
0ماتی پرکننده نماد. |
labelOrigin
اختیاری |
نوع:
Point optionalپیشفرض:
google.maps.Point(0,0)مبدأ برچسب نسبت به مبدأ مسیر، اگر برچسب توسط نشانگر ارائه شده باشد. مبدأ در همان سیستم مختصاتی بیان میشود که مسیر نماد بیان شده است. این ویژگی برای نمادهای چندخطی استفاده نمیشود. |
rotation
اختیاری |
نوع:
number optionalپیشفرض:
0زاویهای که نماد باید بچرخد، بهصورت ساعتگرد و برحسب درجه بیان میشود. نمادی در IconSequence که fixedRotation آن false است نسبت به زاویه لبهای که روی آن قرار دارد چرخانده شده است. |
scale
اختیاری |
نوع:
number optionalمقداری که اندازه نماد براساس آن مقیاسبندی میشود. برای نشانگرهای نماد، این مقدار بهطور پیشفرض ۱ است؛ پساز مقیاسبندی، نماد میتواند هر اندازهای داشته باشد. برای نمادهای روی چندخطی، این مقدار بهطور پیشفرض برابر با وزن خط چندخطی است؛ پساز مقیاسبندی، نماد باید درون مربعی به اندازه ۲۲ پیکسل قرار گیرد که مرکز آن لنگر نماد باشد. |
strokeColor
اختیاری |
نوع:
string optionalرنگ خط پیرامونی نماد. همه رنگهای CSS3 بهجز رنگهای نامگذاریشده گسترده پشتیبانی میشوند. برای نشانگرهای نماد، این مقدار بهطور پیشفرض «سیاه» است. برای نمادهای روی چندخطی، این مقدار بهطور پیشفرض رنگ خط چندخطی است. |
strokeOpacity
اختیاری |
نوع:
number optionalماتی ضربقلم نماد. برای نشانگرهای نماد، این مقدار بهطور پیشفرض ۱ است. برای نمادهای روی چندخطی، این مقدار بهطور پیشفرض روی شفافیت خط چندخطی تنظیم میشود. |
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"
پویانماییهایی که میتوانند روی نشانگر پخش شوند. برای پخش پویانمایی، از روش Marker.setAnimation در «نشانگر» یا گزینه MarkerOptions.animation استفاده کنید.
const {Animation} = await google.maps.importLibrary("marker");
ثابتها | |
|---|---|
BOUNCE |
نشانگر تا زمانی که پویانمایی با فراخوانی Marker.setAnimation با null متوقف شود، میپرد. |
DROP |
نشانگر از بالای نقشه به مکان نهاییاش میافتد. وقتی نشانگر متوقف شود، پویانمایی متوقف میشود و Marker.getAnimation null را برمیگرداند. این نوع پویانمایی معمولاً درطول ایجاد نشانگر مشخص میشود. |