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

    Class DepartureHeading

    Departure heading

    Contains information about the direction the user is facing.

    Index

    Constructors

    Properties

    Methods

    Constructors

    • DepartureHeading constructor

      Parameters

      • options: { accuracy?: number; heading?: number } = {}

        Object containing the following properties:

        • heading: Heading in degrees (default: -1)
        • accuracy: Accuracy in degrees (default: 0)

      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

    • Equality check

      Parameters

      Returns boolean

      true if equal

    • Serialize to JSON

      Returns any

      JSON object

    • Deserialize from JSON

      Parameters

      • json: any

        JSON object

      Returns DepartureHeading

      DepartureHeading instance