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?: TBlueDotOptions) => Promise<undefined> } = ...

BlueDot control interface

Type declaration

  • disable: () => Promise<undefined>
      • (): Promise<undefined>
      • Disable BlueDot

        Returns Promise<undefined>

  • enable: (options?: TBlueDotOptions) => Promise<undefined>

BlueDotState

BlueDotState: typeof E_BLUEDOT_STATE = ...

CameraControls

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

Camera controls interface

Type declaration

  • rotation: number
  • setRotation: (rotation: number) => Promise<undefined>
      • (rotation: number): Promise<undefined>
      • 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>
      • 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

  • clear: () => Promise<undefined>
      • (): Promise<undefined>
      • Remove any paths and markers associated with journey

        Returns Promise<undefined>

  • draw: (directions: MappedinDirections | MappedinDirections[], options?: TSerializableJourneyOptions) => Promise<undefined>
  • setStep: (step: number) => Promise<undefined>
      • (step: number): Promise<undefined>
      • Set the current step of a multi-part journey

        Parameters

        • step: number

        Returns Promise<undefined>

Optional currentMap

currentMap: MappedinMap

Current map of Venue

Optional options

state

state: typeof STATE = ...

Optional venueData

venueData: Mappedin

Venue Data

Methods

addInteractivePolygon

  • addInteractivePolygon(polygonId: string): Promise<null>
  • addInteractivePolygon(polygon: MappedinPolygon): Promise<null>
  • Make polygons clickable

    Parameters

    • polygonId: string

    Returns Promise<null>

  • Parameters

    Returns Promise<null>

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(polygon: MappedinPolygon): Promise<null>
  • clearPolygonColor(polygonId: string): Promise<null>
  • Clear Polygon Color

    Parameters

    Returns Promise<null>

  • Parameters

    • polygonId: string

    Returns Promise<null>

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

disableBlueDot

  • disableBlueDot(): Promise<unknown>
  • Disable Blue Dot (use mapView.BlueDot.disable() instead)

    deprecated

    Returns Promise<unknown>

drawJourney

drawPath

  • Draw a path based on a list of Nodes

    Parameters

    Returns Promise<null>

  • Parameters

    Returns Promise<null>

enableBlueDot

  • Enable Blue Dot (use mapView.BlueDot.enable() instead)

    deprecated

    Parameters

    Returns Promise<unknown>

focusOn

  • Parameters

    • focusOptions: TFocusOptions

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

    Returns Promise<unknown>

getDirections

getNearestNodeByScreenCoordinates

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

    Parameters

    Returns Promise<null | MappedinNode>

  • Parameters

    • x: number
    • y: number
    • Optional mapId: string

    Returns Promise<null | MappedinNode>

labelAllLocations

labelPolygon

removeAllInteractivePolygons

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

    Returns Promise<void>

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(map: MappedinMap): Promise<null>
  • setMap(mapId: string): Promise<null>
  • Change Map/Level

    Parameters

    Returns Promise<null>

  • Parameters

    • mapId: string

    Returns Promise<null>

setPolygonColor

  • setPolygonColor(polygonId: string, color: string, opacity?: number, textColor?: string): Promise<null>
  • setPolygonColor(polygon: MappedinPolygon, color: string, opacity?: number, textColor?: string): Promise<null>
  • Set Polygon Color

    Parameters

    • polygonId: string
    • color: string
    • Optional opacity: number
    • Optional textColor: string

    Returns Promise<null>

  • Parameters

    • polygon: MappedinPolygon
    • color: string
    • Optional opacity: number
    • Optional textColor: string

    Returns Promise<null>

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

    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>