@magiclane/maps-sdk
    Preparing search index...

    Class OverlayItemAlarmsList

    Geographic coordinates referenced list of OverlayItem alarms.

    Hierarchy

    • GemAutoreleaseObject
      • OverlayItemAlarmsList

    Implements

    Index

    Constructors

    constructor

    Accessors

    items pointerId referenceCoordinates size

    Methods

    dispose getDistance registerAutoReleaseObject

    Constructors

    Accessors

    • get items(): OverlayItemPosition[]

      The items list.

      Returns OverlayItemPosition[]

      The items list of the given type.

      An exception if it fails.

    • get pointerId(): any

      Returns any

    • get referenceCoordinates(): Coordinates

      Get reference coordinates.

      Returns Coordinates

      The reference coordinates.

      An exception if it fails.

    • get size(): number

      Get the number of items.

      Returns number

      The number of items.

      An exception if it fails.

    Methods

    • Returns void

    • Get the distance in meters from the item to the reference coordinate.

      Parameters

      • index: number

        The index of the overlay item.

      Returns number

      The distance to the item specified by index, or 0 if the index is not in range.

      An exception if it fails.

    • Registers an object for auto release. When the object is not used anymore, it will be released automatically from C++.

      Parameters

      • pointerId: any

        The pointer ID to register

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors
    Methods