Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • MappedinController
    • MapViewStore

Index

Properties

Private Optional #iframe

#iframe: HTMLIFrameElement

Private #markers

#markers: Set<string> = ...

BlueDot

BlueDot: { disable: () => Promise<undefined>; enable: (options?: TEnableBlueDotOptionsBase) => Promise<undefined> } = ...

BlueDot control interface

Type declaration

BlueDotState

BlueDotState: E_BLUEDOT_STATE = ...
deprecated

Use BlueDot Events instead

Camera

Camera: { rotation: number; set: (positionOptions?: TAnimatePositionOptions) => Promise<unknown>; setSafeAreaInsets: (safeAreaInsets: { bottom: number; left: number; right: number; top: number }) => void; tilt: number; focusOn: any } = ...

Camera controls interface

Type declaration

  • rotation: number
  • set: (positionOptions?: TAnimatePositionOptions) => Promise<unknown>
  • setSafeAreaInsets: (safeAreaInsets: { bottom: number; left: number; right: number; top: number }) => void
      • (safeAreaInsets: { bottom: number; left: number; right: number; top: number }): void
      • This is so that the map can be positioned on a portion of the screen, (example padding)

        Parameters

        • safeAreaInsets: { bottom: number; left: number; right: number; top: number }
          • bottom: number
          • left: number
          • right: number
          • top: number

        Returns void

  • tilt: number
  • focusOn: function
    • Parameters

      Returns Promise<unknown>

CameraControls

CameraControls: { rotation: number; setRotation: (rotation: number) => Promise<undefined>; setTilt: (tilt: number) => Promise<undefined>; tilt: number } = ...

V3 Camera controls interface

Type declaration

  • rotation: number
  • setRotation: (rotation: number) => Promise<undefined>
      • (rotation: number): Promise<undefined>
      • deprecated

        Use CameraControls.setRotation instead

        Parameters

        • rotation: number

          The new value to set the rotation to, in degrees from north..

        Returns Promise<undefined>

  • setTilt: (tilt: number) => Promise<undefined>
      • (tilt: number): Promise<undefined>
      • deprecated

        Use CameraControls.setTilt instead

        Parameters

        • tilt: number

          The new value to set the tilt to, in radians from top-down view.

        Returns Promise<undefined>

  • tilt: number

Journey

Journey: { clear: () => Promise<undefined>; draw: (directions: MappedinDirections | MappedinDirections[], options?: TSerializableJourneyOptions) => Promise<undefined>; setStep: (step: number) => Promise<undefined> } = ...

Journey management interface

Type declaration

_subscribers

_subscribers: any = {}

Optional currentMap

currentMap: MappedinMap

Current map of Venue

Optional options

state

state: STATE = ...

Optional venueData

venueData: Mappedin

Venue Data

Methods

addInteractivePolygon

  • addInteractivePolygon(polygonOrPolygonId: string | MappedinPolygon): Promise<unknown>
  • Make polygons clickable

    Parameters

    Returns Promise<unknown>

clearAllPolygonColors

  • clearAllPolygonColors(): Promise<unknown>
  • Clear all polygon colors

    Returns Promise<unknown>

clearJourney

  • clearJourney(): Promise<unknown>
  • Remove any paths and markers associated with journey

    deprecated

    Use mapView.Journey.clear instead

    Returns Promise<unknown>

clearPolygonColor

  • clearPolygonColor(polygonOrPolygonId: string | MappedinPolygon): Promise<unknown>
  • Clear Polygon Color

    Parameters

    Returns Promise<unknown>

createMarker

  • Create a marker attached to a MappedinNode, with any abitrary HTML code inside.

    Parameters

    Returns string

    markerId This marker id can later be used to remove the marker

destroy

  • destroy(): void
  • Returns void

drawJourney

drawPath

  • Draw a path based on a list of Nodes

    Parameters

    Returns Promise<unknown>

focusOn

  • focusOn(focusOptions: TFocusOptionsLegacy): Promise<unknown>
  • deprecated

    Use Camera.focusOn instead

    Parameters

    • focusOptions: TFocusOptionsLegacy

      You should provide at least one Node or Polygon, but everything else is optional.

    Returns Promise<unknown>

getDirections

getNearestNodeByScreenCoordinates

  • getNearestNodeByScreenCoordinates(x: number, y: number, mapIdOrMap?: string | MappedinMap): Promise<undefined | null | MappedinNode>
  • Gets the nearest node by screen coordinate

    Parameters

    • x: number
    • y: number
    • Optional mapIdOrMap: string | MappedinMap

    Returns Promise<undefined | null | MappedinNode>

labelAllLocations

  • labelAllLocations(options?: TLabelAllLocationFloatingLabelOptions): Promise<unknown>
  • labelAllLocations(options?: TReactNativeFlatLabelAllLocations | TReactNativeFlatLabelAllLocationsLegacy): Promise<unknown>
  • Parameters

    Returns Promise<unknown>

  • Parameters

    • Optional options: TReactNativeFlatLabelAllLocations | TReactNativeFlatLabelAllLocationsLegacy

    Returns Promise<unknown>

labelPolygon

  • labelPolygon(polygonOrPolygonId: string | MappedinPolygon, options: TReactNativeFloatingLabelPolygonOptions): Promise<unknown>
  • labelPolygon(polygonOrPolygonId: string | MappedinPolygon, options: TReactNativeFlatLabelPolygonOptions): Promise<unknown>
  • Parameters

    • polygonOrPolygonId: string | MappedinPolygon
    • options: TReactNativeFloatingLabelPolygonOptions

    Returns Promise<unknown>

  • Parameters

    • polygonOrPolygonId: string | MappedinPolygon
    • options: TReactNativeFlatLabelPolygonOptions

    Returns Promise<unknown>

off

  • off<EVENT_NAME>(eventName: EVENT_NAME, fn: (payload: any) => void): void
  • Type parameters

    • EVENT_NAME: string | number | symbol

    Parameters

    • eventName: EVENT_NAME
    • fn: (payload: any) => void
        • (payload: any): void
        • Parameters

          • payload: any

          Returns void

    Returns void

on

  • on<EVENT_NAME>(eventName: EVENT_NAME, fn: (payload: any) => void): void
  • Type parameters

    • EVENT_NAME: string | number | symbol

    Parameters

    • eventName: EVENT_NAME
    • fn: (payload: any) => void
        • (payload: any): void
        • Parameters

          • payload: any

          Returns void

    Returns void

publish

  • publish<EVENT_NAME>(eventName: EVENT_NAME, data: any): void
  • Type parameters

    • EVENT_NAME: string | number | symbol

    Parameters

    • eventName: EVENT_NAME
    • data: any

    Returns void

removeAllInteractivePolygons

  • removeAllInteractivePolygons(): Promise<unknown>
  • Remove all interactive polygons

    Returns Promise<unknown>

removeAllPaths

  • removeAllPaths(): Promise<unknown>
  • Remove all paths

    Returns Promise<unknown>

removeMarker

  • removeMarker(markerId: string): Promise<void>
  • Remove marker by id

    Parameters

    • markerId: string

    Returns Promise<void>

setMap

  • setMap(mapIdOrMap: string | MappedinMap): Promise<unknown>
  • Change Map/Level

    Parameters

    Returns Promise<unknown>

setPolygonColor

  • setPolygonColor(polygonIdOrPolygon: string | MappedinPolygon, color: string, opacity?: number, textColor?: string): Promise<unknown>
  • Set Polygon Color

    Parameters

    • polygonIdOrPolygon: string | MappedinPolygon
    • color: string
    • opacity: number = 1
    • Optional textColor: string

    Returns Promise<unknown>

setSafeArea

  • setSafeArea(padding: { bottom: number; left: number; right: number; top: number }): void
  • Padding - this is so that the map can be positioned on a portion of the screen

    deprecated

    Use Camera.setSafeAreaInsets instead

    Parameters

    • padding: { bottom: number; left: number; right: number; top: number }
      • bottom: number
      • left: number
      • right: number
      • top: number

    Returns void

setState

  • setState(state: STATE): Promise<undefined>
  • Set SDK state, which controls camera and other features geared towards a particular experience

    EXPLORE (default)

    FOLLOW - Lock Camera to the BlueDot so it follows it around the screen

    Parameters

    Returns Promise<undefined>