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

مستندات / جاوااسکریپت / منابع / کنترل آدرس یابی

GeocodeControl

توسط point هنگام جستجو و انتخاب یک ایتم از لیست نتیجه، عارضه نقطه‌ای با توجه به گزینه‌های اختصاص یافته در مختصات مدنظر نمایش می‌یابد و در صورت استفاده نشدن از آن، مشخصات مربوط به point ابزار انتخابگر در نظر گرفته می‌شود و درصورتیکه این گزینه هم استفاده نشده باشد هیچ عارضه‌ای را نمایش نمی‌دهد.

GeocodeControl {
    point?: Point,
    style?: GeocodeStyle,
    options?: GeocodeOptions,
    events?: GeocodeEvents
}

GeocodeStyle

  • number width (غیرضروری)
  • string className (غیرضروری) - اختصاص کلاس CSS.
GeocodeStyle {
    width?: number,
    className?: string
}

GeocodeOptions

  • boolean autocomplete (غیرضروری) -
  • string placeholder (غیرضروری) - پیشفرض: یافتن آدرس/مکان.
  • string position (غیرضروری) - موقعیت کنترل. پیشفرض: top-right.
GeocodeOptions {
    autocomplete?: boolean,
    placeholder?: string,
    position?: string
}

result

آرگومان‌ها:

  • object event
    • string address
    • LatLng latlng

زمانیکه جستجو برای یافتن آدرس انجام شده باشد با کلیک بروی آیتمی از نتیجه، این event صدا زده می‌شود.

set(address)

پارامترها:

  • string address

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

آدرس را در باکس جستجو قرار داده و نتیجه را نشان می‌دهد.

clear()

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

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

محتوای باکس جستجو به همراه نتیجه یافت شده را پاک می‌کند.

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