Point

• LatLng latlng
• string type (غیرضروری) - نوع عارضه. پیشفرض: point
• PointStyle style (غیرضروری)
• PointOptions options (غیرضروری)
• PointEvents events (غیرضروری)

حداقل نیاز برای رسم یک عارضه نقطه‌ای تخصیص latlng است که بیانگر مختصات طول و عرض جغرافیایی نقطه است. آیکون پیشفرض مربوط به عارضه شامل: آدرس تصویر marker پارسی‌مپ است. در صورت اختصاص نوع عارضه باید مقدار pointدر نظر گرفته شود.

Point {
    latlng: LatLng,
    type?: string,
    style?: PointStyle,
    options?:PointOptions,
    events?: PointEvents,
}

PointResult

• LatLng latlng - طول و عرض جغرافیایی تعیین شده.
• string type - نوع عارضه point.
• string address - آدرس مکان جغرافیایی.
• string layerId - شناسه لایه ایجاد شده.

address زمانی در دسترس است که مقدار گزینه areaInfo از گزینه‌های عارضه نقطه‌ای true باشد.

PointResult {
    latlng: LatLng,
    type: string,
    address: string,
    layerId: string,
}

PointStyle

• string src (غیرضروری) - آدرس تصویر آیکون عارضه. پیشفرض: آدرس تصویر marker پارسی‌مپ.
• Margin margin (غیرضروری) - حاشیه آیکون عارضه بر حسب پیکسل. پیشفرض: left: width/2 و top: height.
• Size size (غیرضروری) - عرض و ارتفاع آیکون عارضه بر حسب پیکسل. پیشفرض: width: 25 و height: 43.
• number angle (غیرضروری) - زاویه آیکون عارضه بر حسب درجه از 0 تا 360 و مقادیر منفی. پیشفرض: 0.
• string className (غیرضروری) - اختصاص کلاس CSS.
• string html (غیرضروری) - محتوای html به صورت string بجای استفاده از ایجاد خودکار <img/>.

مقدار پیشفرض left حاشیه آیکون عارضه برابر width/2 یا نیمی از عرض آیکون و top برابر ارتفاع یا height آیکون است که با توجه به نحوه صحیح بکارگیری margin مکان دقیق قرار گیری آیکون به صورت پیش فرض گوشه سمت پایینی و مرکز ضلع رو به پایین آن است به طوری که آیکون عیناً بروی مختصات جغرافیایی قرار می‌یابد. هنگام استفاده از html پس از آن، گزینه های src و angle قابل استفاده نیستند. ولی می‌توان همچنان از sizeوmargin برای تنظیم موقعیت آیکون استفاده کرد.

PointStyle {
    src?: string,
    margin?: Margin,
    size?: Size,
    className?: string,
    angle?: number,
    html?: string,
}

PointOptions

• boolean draggable (غیرضروری) - قابلیت تغییر موقعیت عارضه از طریق drag کردن آیکون.
• boolean focusable (غیرضروری) - قابلیت تمرکز بر عارضه هنگام click بروی آیکون.
• boolean areaInfo (غیرضروری) - افزودن address به ارگومان رویدادهای click و dragend. پیشفرض: false
• Popup popup (غیرضروری)

draggable دارای دو رویداد drag و dragend است که به محض استفاده از این قابلیت قابل استفاده خواهند بود. فرایند تمرکز روی نقطه که با گزینهfocusable فعال می‌شود از طریق تغییر مختصات مرکز نقشه بر اساس latlng نقطه و تغییر سطح بزرگنمایی به maxZoom نقشه، اعمال می‌شود.

PointOptions: {
    draggable?: boolean,
    focusable?: boolean,
    areaInfo?: boolean,
    popup?: Popup
}

PointEvents

click

آرگومان‌ها:

• PointResult event

هنگام click بروی آیکون عارضه، این event صدا زده می‌شود.

drag

آرگومان‌ها:

• PointResult event

همزمان با جا به جایی آیکون توسط عمل drag، این event صدا زده می‌شود. این رویداد زمانی در دسترس است که گزینه draggable دارای مقدار true باشد.

dragend

آرگومان‌ها:

• PointResult event

پس از اینکه آیکون توسط عمل drag جابه جا شود. این event صدا زده می‌شود. این رویداد زمانی در دسترس است که گزینه draggable دارای مقدار true باشد.

PointMethods

getContainer()

پارامترها: فاقد ورودی

مقدار بازگشتی: Element

مقدار بازگشتی Container محتوی آیکون عارضه.

addListener(eventName, handler)

پارامترها:

• string eventName
• Function handler - اختصاص callback.

مقدار بازگشتی: number

مقدار بازگشتی listenerId مربوط به listener ایجاد شده از طریق تخصیص نام رویداد و callback تعیین شده به عنوان handler یک رویداد. زمانی که رویداد صدا زده می‌شود تابع اختصاص یافته، اجرا شود.

removeListener(eventName, listenerId)

پارامترها:

• string eventName
• string listenerId

مقدار بازگشتی: فاقد مقدار

یک listener از طریق نام رویداد و شناسه مدنظر حذف می‌گردد.

clearListeners(eventName)

پارامترها:

• string eventName

مقدار بازگشتی: فاقد مقدار

کل listenerهای اختصاص یافته به یک event حذف می‌گردد.