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

    Class MapViewPreferences

    Mapview preferences

    Index

    Constructors

    Accessors

    • get areMapScalesDrawnByUser(): boolean

      Get if the map scales are drawn by the user or by the SDK

      Returns boolean

    • set areMapScalesDrawnByUser(value: boolean): void

      Set if the map scales are drawn by the user or by the SDK

      Parameters

      • value: boolean

      Returns void

    • set carModelByPath(filePath: string): void

      Set car model by path.

      Parameters

      • filePath: string

      Returns void

    • get cursorEnabled(): boolean

      Check if cursor is enabled.

      Returns boolean

    • get cursorRenderEnabled(): boolean

      Check if cursor render is enabled.

      Returns boolean

    • get drawFPS(): boolean

      Get frames per second draw state.

      Returns boolean

    • set enableCursor(isEnabled: boolean): void

      Enable/Disable the cursor mode

      Parameters

      • isEnabled: boolean

      Returns void

    • set enableCursorRender(value: boolean): void

      Enable/Disable the cursor rendering.

      Parameters

      • value: boolean

      Returns void

    • get focusViewport(): RectType<number>

      Get the map view focus viewport.

      Returns RectType<number>

    • set focusViewport(view: RectType<number>): void

      Set the map view focus viewport.

      Parameters

      Returns void

    • get mapId(): number

      Returns number

    • get mapScalePosition(): RectType<number>

      Get the map scale position.

      Returns RectType<number>

    • set mapScalePosition(value: RectType<number>): void

      Sets the map position.

      Parameters

      Returns void

    • get mapStyleId(): number

      Get the current view style content id.

      Returns number

    • get mapStylePath(): string

      Get the current map view style

      Returns string

    • get maxViewAngle(): number

      Get the maximum viewing angle.

      Returns number

    • get minViewAngle(): number

      Get the minimum viewing angle.

      Returns number

    • get northFixedFlag(): boolean

      Get the value of the NorthFixed flag.

      Returns boolean

    • get pointerId(): any

      Returns any

    • get rotationAngle(): number

      Get map rotation angle in degrees relative to north-south axis.

      Returns number

    • set rotationAngle(rotationAngle: number): void

      Set the map rotation angle in degrees relative to north-south axis.

      Parameters

      • rotationAngle: number

      Returns void

    • set setNorthFixedFlag(isNorthFixed: boolean): void

      Set the value of the NorthFixed flag.

      Parameters

      • isNorthFixed: boolean

      Returns void

    • get showMapScale(): boolean

      Check if map scale is shown

      Returns boolean

    • set showMapScale(value: boolean): void

      Check if map scale is shown

      Parameters

      • value: boolean

      Returns void

    • get tiltAngle(): number

      Get tilt angle in degrees.

      Returns number

    • set tiltAngle(tiltAngle: number): void

      Set tilt angle in degrees.

      Parameters

      • tiltAngle: number

      Returns void

    • get touchGesturesStates(): number

      Get enabled touch gestures packed.

      Returns number

    • set touchGesturesStates(enabledTouchGesturesBitfield: number): void

      Set enabled touch gestures packed.

      Parameters

      • enabledTouchGesturesBitfield: number

      Returns void

    • get trafficVisibility(): boolean

      Get traffic visibility.

      Returns boolean

    • get viewAngle(): number

      Get the viewing angle.

      Returns number

    Methods

    • Returns void

    • Enable / disable touch gestures.

      Parameters

      Returns void

    • Check if touch gesture is enabled.

      Parameters

      Returns boolean

    • Enable/disable frames per second draw.

      Parameters

      • isEnabled: boolean
      • pos: Point

      Returns void

    • Set map view details by content.

      Parameters

      Returns void

    • Set map view style by content buffer

      Parameters

      • buffer: Uint8Array
      • OptionalsmoothTransition: boolean

      Returns void

    • Set map view details by content id.

      Parameters

      • id: number
      • OptionalsmoothTransition: boolean

      Returns void

    • Set map view style by content path

      Parameters

      • path: string
      • OptionalsmoothTransition: boolean

      Returns void

    • Set traffic visibility.

      Parameters

      • isVisible: boolean

      Returns GemError

    • Set the viewing angle.

      Parameters

      • viewAngle: number
      • Optionalanimated: boolean

      Returns void

    • Parameters

      • buffer: Uint8Array

      Returns void

    • Parameters

      • id: number
      • mapId: number
      • mapPointerId: any

      Returns MapViewPreferences