Hierarchy

  • RNMappedinController
    • MapViewStore

Properties

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

BlueDot control interface

Type declaration

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

        Returns Promise<undefined>

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

        Parameters

        Returns Promise<undefined>

Camera: TCameraManager = ...

Camera controls interface

FlatLabels: IFlatLabels<Promise<void>> = ...
FloatingLabels: IFloatingLabels<Promise<void>> = ...
Journey: {
    clear: (() => Promise<undefined>);
    draw: ((directions, options?) => Promise<undefined>);
    setStep: ((step) => Promise<undefined>);
    setStepByPath: ((path) => Promise<unknown>);
} = ...

Journey management interface

Type declaration

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

        Returns Promise<undefined>

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

        Parameters

        • step: number

        Returns Promise<undefined>

  • setStepByPath: ((path) => Promise<unknown>)
      • (path): Promise<unknown>
      • Parameters

        • path: {
              id: string;
          }
          • id: string

        Returns Promise<unknown>

Markers: {
    add: ((nodeOrCoordinate, contentHtml, options) => string);
    animate: ((markerId, nodeOrCoordinate, animationOptions) => Promise<void>);
    remove: ((markerId) => Promise<void>);
    setPosition: ((markerId, nodeOrCoordinate) => Promise<void>);
} = ...

Type declaration

  • add: ((nodeOrCoordinate, contentHtml, options) => string)
      • (nodeOrCoordinate, contentHtml, options): string
      • Parameters

        Returns string

  • animate: ((markerId, nodeOrCoordinate, animationOptions) => Promise<void>)
      • (markerId, nodeOrCoordinate, animationOptions): Promise<void>
      • Parameters

        Returns Promise<void>

  • remove: ((markerId) => Promise<void>)
      • (markerId): Promise<void>
      • Parameters

        • markerId: string

        Returns Promise<void>

  • setPosition: ((markerId, nodeOrCoordinate) => Promise<void>)
OfflineSearch: {
    addQuery: ((params) => Promise<unknown>);
    search: ((query) => Promise<TMappedinOfflineSearchResult[]>);
    suggest: ((query) => Promise<TMappedinOfflineSearchSuggestions>);
} = ...

Type declaration

Paths: {
    add: ((nodes, options?) => Promise<unknown>);
    remove: ((path) => Promise<void>);
    removeAll: (() => Promise<void>);
} = ...

Add or remove paths from the map

Type declaration

  • add: ((nodes, options?) => Promise<unknown>)
      • (nodes, options?): Promise<unknown>
      • Parameters

        Returns Promise<unknown>

  • remove: ((path) => Promise<void>)
      • (path): Promise<void>
      • Parameters

        • path: {
              id: string;
          }
          • id: string

        Returns Promise<void>

  • removeAll: (() => Promise<void>)
      • (): Promise<void>
      • Returns Promise<void>

currentMap?: MappedinMap

Current map of Venue

state: STATE = STATE.EXPLORE
venueData?: Mappedin

Venue Data

Methods

  • Make polygons clickable

    Parameters

    Returns Promise<unknown>

  • Clear all polygon colors

    Returns Promise<unknown>

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

  • Clear Polygon Color

    Parameters

    Returns Promise<unknown>

  • Creates a custom tooltip attached to a MappedinNode or a MappedinCoordinate, with any abitrary HTML code inside.

    Parameters

    • nodeOrCoordinate: MappedinNode | MappedinCoordinate

      Node or Coordinate to attach the tooltip to

    • contentHtml: string
    • selector: string
    • Optional options: TCreateTooltipCommonOptions

    Returns 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

  • Creates a tooltip attached to a MappedinNode or a MappedinCoordinate

    Parameters

    • nodeOrCoordinate: MappedinNode | MappedinCoordinate

      Node or Coordinate to attach the tooltip to

    • contentHtml: string
    • Optional options: TCreateTooltipOptions

    Returns Promise<string>

  • Parameters

    Returns Promise<unknown>

    Deprecated

    Use Paths.add instead.

    Draw a path based on a list of Nodes

  • Enables image flipping for a specific polygon

    Parameters

    Returns Promise<unknown>

  • Gets the nearest node by screen coordinate

    Parameters

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

    Returns Promise<MappedinNode>

  • Get all polygons that intersect with a specific coordinate.

    Parameters

    Returns Promise<MappedinPolygon[]>

  • Get all polygons that intersect with a specific screen coordinate.

    Parameters

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

    Returns Promise<MappedinPolygon[]>

  • Finds the primary MappedinLocation associated with a MappedinPolygon. This means a location attached to the polygon that has no parents, or, if there are none of those, a location nearest the top of some hierarchy that does have the polygon attached.

    // Log the primary location of a clicked polygon
    onClick={({ polygons }) => {
    if (polygons.length > 0) {
    for(const polygon of polygons) {
    console.log(await mapView.current?.getPrimaryLocationForPolygon(polygon));
    }
    }
    });

    Parameters

    Returns Promise<MappedinLocation>

    The primary MappedinLocation or null if none found.

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

    Parameters

    Returns Promise<void>

    Deprecated

    Please use FloatingLabels.labelAllLocations or FlatLabels.labelAllLocations instead.

  • Remove all interactive polygons

    Returns Promise<unknown>

  • Returns Promise<unknown>

    Deprecated

    Use Paths.removeAll instead.

    Remove all paths

  • Remove marker by id

    Parameters

    • markerId: string

    Returns Promise<void>

  • Remove tooltip by id

    Parameters

    • tooltipId: string

    Returns Promise<string>

  • Change Map/Level

    Parameters

    Returns Promise<unknown>

  • Set Polygon Color

    Parameters

    Returns Promise<unknown>

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