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

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

Line

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

Line {
    latlngs: LatLng[],
    type: string,
    style?: LineStyle,
    options?:LineOptions,
    events?: LineEvents
}

LineResult

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

LineStyle

  • number width (غیرضروری) - پهنای خط بر حسب پیکسل. پیشفرض: 3
  • string color (غیرضروری) - رنگ خط بر اساس کد یا نام رنگ. پیشفرض: #02a9f4
  • string className (غیرضروری) - اختصاص کلاس CSS.
  • Side arrowHead (غیرضروری) - افزودن پیکان به ابتدا یا انتها و یا هر دو جهت پاره‌خط.
  • Side circleHead (غیرضروری) - افزودن دایره به ابتدا یا انتها و یا هر دو جهت پاره‌خط.
  • OutlineStyle outline (غیرضروری) - افزودن خطوطی پیرامون پاره‌خط اصلی.

گزینه‌های arrowHead و circleHead برای جهت دار کردن خط و یا نمایش ابتدا و انتهای آن کاربرد دارد. برخی اوقات لازم است که خطوط را در نواحی نمایش داد که همرنگ بادیگر اجزای نقشه است، در این مواقع بهتر است از یک خط مجزا بهره برد که پیرامون و پشت پاره‌خط اصلی که دارای پهنایی بیشتر و رنگی متفاوت است، رسم گردد و گزینه outline قادر به کشیدن این خط است.

LineStyle {
    width?: number,
    color?: string,
    className?: string,
    arrowHead?: Sides,
    circleHead?: Sides,
    outline?: OutlineStyle
}

OutlineStyle

  • number width (غیرضروری) - پهنای خط بر حسب پیکسل. پیشفرض: 5
  • string color (غیرضروری) - رنگ خط بر اساس کد یا نام رنگ. #fff
  • string className (غیرضروری) - اختصاص کلاس CSS.
  • OutlineStyle {
        width?: number,
        color?: string,
        className?: string
    }

    LineOptions

    • boolean focusable (غیرضروری) - قابلیت تمرکز روی پاره خط با click روی بخشی از خط.
    • boolean areaInfo (غیرضروری) - افزودن address دو جهت ابتدا و انتهای پاره خط به آرگومان‌ رویداد click.
    • Popup popup (غیرضروری)
    LineOptions: {
        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 حذف می‌گردد.