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

    Class DepartureHeading

    Departure heading

    Contains information about the direction the user is facing.

    Index

    Constructors

    Properties

    Methods

    Constructors

    • Creates departure heading information.

      Parameters

      • Optionaloptions: { accuracy?: number; heading?: number }

        Configuration options

        • Optionalaccuracy?: number

          The departure heading accuracy in degrees. Values are in 0-90 interval. A typical value is 25 degrees. Default is 0

        • Optionalheading?: number

          The departure heading in degrees. Values are in 0-360 interval with 0 representing magnetic north. Value -1 means no departure heading is specified. Default is -1

      Returns DepartureHeading

    Properties

    accuracy: number

    The departure heading accuracy in degrees.

    Values are in 0-90 interval. A typical value is 25 degrees

    heading: number

    The departure heading in degrees.

    Values are in 0-360 interval with 0 representing the magnetic north. Value -1 means no departure heading is specified

    Methods

    • Check equality with another DepartureHeading

      Parameters

      Returns boolean

    • Get hash code for use in maps/sets

      Returns number

    • Internal

      Serializes this instance to a JSON-compatible map.

      Used internally, not intended for direct use by consumers. The map structure may change without notice.

      Returns Record<string, number>

      JSON-compatible map

    • Internal

      Creates an instance from a JSON-compatible map.

      Used internally, not intended for direct use by consumers. The map structure may change without notice.

      Parameters

      • json: any

        JSON-compatible map

      Returns DepartureHeading

      A new DepartureHeading instance