مستندات پارسی‌مپ

مستندات / جاوااسکریپت / منابع / عارضه دایره‌ای

Circle

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

Circle {
    latlng: LatLng,
    type: string,
    radius: number,
    style?: CircleStyle,
    options?:CircleOptions,
    events?: CircleEvents
}

CircleResult

  • LatLng latlng - مجموعه‌ای از طول و عرض‌های جغرافیایی تعیین شده.
  • number radius - مجموعه‌ای از طول و عرض‌های جغرافیایی تعیین شده.
  • string type - نوع عارضه circle.
  • SideResult startSide - محتوی latlng و address مربوط به ابتدای جهت پاره خط.
  • SideResult endSide - محتوی latlng و address مربوط به انتهای جهت پاره خط.
  • string layerId - شناسه لایه ایجاد شده.
CircleResult {
    latlng: LatLng,
    radius: number,
    type: string,
    layerId: string
}

CircleStyle

  • number width (غیرضروری) - پهنای خطوط دور چندضلعی بر حسب پیکسل. پیشفرض: 3
  • string color (غیرضروری) - رنگ خطوط دور چندضلعی بر اساس کد یا نام رنگ. پیشفرض: #02a9f4
  • string fill (غیرضروری) - رنگ پس‌زمینه چندضلعی بر اساس کد یا نام رنگ. پیشفرض: #02a9f4
  • number alpha (غیرضروری) - سطح شفافیت پس زمینه چندضلعی عددی بین 0 تا 1. پیشرض: 1
  • string className (غیرضروری) - اختصاص کلاس CSS.
CircleStyle {
    width?: number,
    color?: string,
    fill?: string,
    alpha?: number,
    className?: string
}

CircleOptions

  • boolean focusable (غیرضروری) - قابلیت تمرکز روی دایره با click روی بخشی از آن.
  • Popup popup (غیرضروری)
CircleOptions: {
    focusable?: boolean,
    areaInfo?: boolean,
    popup?: Popup
}

click

آرگومان‌ها:

هنگام clickبروی بخشی از دایره، این event صدا زده می‌شود.

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 حذف می‌گردد.