Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • RNMappedinController
    • MapViewStore

Index

Properties

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

BlueDot control interface

Type declaration

Camera: TCameraManager = ...

Camera controls interface

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

Journey management interface

Type declaration

OfflineSearch: { addQuery: ((params: { object: MappedinLocation | MappedinCategory | Record<string, unknown>; query: string; weight?: number }) => Promise<unknown>); search: ((query: string) => Promise<TMappedinOfflineSearchResult[]>); suggest: ((query: string) => Promise<TMappedinOfflineSearchSuggestions>) } = ...

Type declaration

currentMap?: MappedinMap

Current map of Venue

state: STATE = STATE.EXPLORE
venueData?: Mappedin

Venue Data

Methods

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

    Parameters

    Returns Promise<unknown>

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

    Returns Promise<unknown>

  • clearBundleCache(): Promise<void>
  • Clear any cached venue bundles that were downloaded as part of LOAD_VENUE with useBundle: true This ensure that the next time keys are passed in, we get a fresh bundle

    Returns Promise<void>

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

    Parameters

    Returns Promise<unknown>

  • createCustomTooltip(nodeOrCoordinate: MappedinCoordinate | MappedinNode, contentHtml: string, selector: string, options?: TCreateTooltipCommonOptions): Promise<string>
  • 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

  • Draw a path based on a list of Nodes

    Parameters

    Returns Promise<unknown>

  • Enables image flipping for a specific polygon

    Parameters

    Returns Promise<unknown>

  • 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>

  • Get all polygons that intersect with a specific coordinate.

    Parameters

    Returns Promise<MappedinPolygon[]>

  • getPolygonsAtScreenCoordinate(x: number, y: number, options?: TGetPolygonsAtCoordinateOptions): Promise<MappedinPolygon[]>
  • Get all polygons that intersect with a specific screen coordinate.

    Parameters

    • x: number
    • y: number
    • Optional options: TGetPolygonsAtCoordinateOptions

    Returns Promise<MappedinPolygon[]>

  • Label all polygons with locations either loaded via the API or passed in

    deprecated

    Please use FloatingLabels.labelAllLocations or FlatLabels.labelAllLocations instead.

    Parameters

    Returns Promise<void>

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

    Returns Promise<unknown>

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

    Returns Promise<unknown>

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

    Parameters

    • markerId: string

    Returns Promise<void>

  • removeTooltip(tooltipId: string): Promise<string>
  • Remove tooltip by id

    Parameters

    • tooltipId: string

    Returns Promise<string>

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

    Parameters

    Returns Promise<unknown>

  • Set Polygon Color

    Parameters

    Returns Promise<unknown>

  • 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>