Options
All
  • Public
  • Public/Protected
  • All
Menu

Mappedin Web SDK - v5.1.2

Index

Enumerations

Classes

Interfaces

Type Aliases

Variables

Functions

Type Aliases

CAMERA_EVENT_PAYLOAD: { CHANGED: { position: MappedinCoordinate; rotation: number; tilt: number; zoom: number }; POSITION_CHANGED: MappedinCoordinate; ROTATION_CHANGED: number; TILT_CHANGED: number; USER_INTERACTION_END: void; USER_INTERACTION_START: void; ZOOM_CHANGED: number }

Type declaration

  • CHANGED: { position: MappedinCoordinate; rotation: number; tilt: number; zoom: number }
  • POSITION_CHANGED: MappedinCoordinate
    deprecated

    Use E_CAMERA_EVENT.CHANGED instead

  • ROTATION_CHANGED: number
    deprecated

    Use E_CAMERA_EVENT.CHANGED instead

  • TILT_CHANGED: number
    deprecated

    Use E_CAMERA_EVENT.CHANGED instead

  • USER_INTERACTION_END: void
  • USER_INTERACTION_START: void
  • ZOOM_CHANGED: number
    deprecated

    Use E_CAMERA_EVENT.CHANGED instead

E_BLUEDOT_EVENT_PAYLOAD: { POSITION_UPDATE: TBlueDotPositionUpdate; STATE_CHANGE: TBlueDotStateChange }

Type declaration

E_SDK_EVENT_PAYLOAD: { CLICK: TMapClickEvent; MAP_CHANGED: MappedinMap; NOTHING_CLICKED: undefined; POLYGON_CLICKED: MappedinPolygon; STATE_CHANGE: STATE }

Type declaration

TAddFlatLabelOptions: { appearance?: TFlatLabelAppearance }

Type declaration

TAddFloatingLabelOptions: { appearance?: TFloatingLabelAppearance; rank?: COLLISION_RANKING_TIERS | number; scale?: number }

Type declaration

TBlueDotPositionUpdate: { bearing?: number; map?: MappedinMap; nearestNode?: MappedinNode; position?: TGeolocationObject }

Type declaration

TBlueDotStateChange: { markerVisibility?: E_BLUEDOT_MARKER_STATE; message?: GeolocationPositionError | string; name: E_BLUEDOT_STATE; reason?: E_BLUEDOT_STATE_REASON }

Type declaration

  • Optional markerVisibility?: E_BLUEDOT_MARKER_STATE

    Visiblity state of the Blue Dot marker

  • Optional message?: GeolocationPositionError | string

    Additional message to complement the reason

  • name: E_BLUEDOT_STATE

    What we currently know about the user's position, and how confident we are.

  • Optional reason?: E_BLUEDOT_STATE_REASON

    Reason why Blue Dot may be in the current state

TCameraAnimationOptions: { duration?: number; easing?: CAMERA_EASING_MODE }

Type declaration

  • Optional duration?: number

    Animation duration in milliseconds

  • Optional easing?: CAMERA_EASING_MODE
TCameraTargets: { coordinates?: MappedinCoordinate[]; nodes?: MappedinNode[]; polygons?: MappedinPolygon[] }

Type declaration

TCameraTransform: { position?: MappedinCoordinate | MappedinNode; rotation?: number; tilt?: number; zoom?: number }

Type declaration

  • Optional position?: MappedinCoordinate | MappedinNode
  • Optional rotation?: number

    Rotation in radians from north

  • Optional tilt?: number

    Tilt in radians

  • Optional zoom?: number

    Zoom = distance in meters from Camera to target

TConnectionProps: { direction?: string; icon?: string; isEntering?: boolean; toMapName?: string; type: any }

Type declaration

  • Optional direction?: string

    Direction "up" or "down"

  • Optional icon?: string
  • Optional isEntering?: boolean
  • Optional toMapName?: string
  • type: any

    Connection type, "escalator", "elevator", etc

TConnectionTemplateFn: (({ direction, type, toMapName }: TConnectionProps) => string)

Type declaration

TCreateCustomInnerHTMLTooltipOptions: TCreateTooltipCommonOptions & { contentHtml: string; padding?: number }
TCreateCustomTooltipOptions: TCreateTooltipCommonOptions & { html: string; selector: string }
TCreateMarkerOptions: { anchor?: MARKER_ANCHOR; rank?: COLLISION_RANKING_TIERS | number }

Type declaration

TCreateTextTooltipOptions: TCreateTooltipCommonOptions & { padding?: number; text: string }
TCreateThreeDMarkerOptions: { mapOrMapId: MappedinMap | MappedinMap["id"]; object: Object3D; position?: Vector3; rotation?: Euler; scale?: Vector3 }

Type declaration

  • mapOrMapId: MappedinMap | MappedinMap["id"]

    map to add the marker to

  • object: Object3D

    the marker object to add to the scene

  • Optional position?: Vector3

    if provided, sets the object's position on the map

  • Optional rotation?: Euler

    if provided, sets the object's rotation relative to the map

  • Optional scale?: Vector3

    if provided, sets the object's scale relative to the map

TCreateTooltipCommonOptions: { collisionRank?: COLLISION_RANKING_TIERS; defaultAnchorType?: keyof TOOLTIP_ANCHOR; enabledAnchorTypes?: TOOLTIP_ANCHOR }

Type declaration

  • Optional collisionRank?: COLLISION_RANKING_TIERS

    The rank of the object used when comparing colliders to determine which should be shown.

  • Optional defaultAnchorType?: keyof TOOLTIP_ANCHOR

    Default (starting) anchor for tooltips

  • Optional enabledAnchorTypes?: TOOLTIP_ANCHOR

    An object used to disable certain anchor positions from being used.

TCreateTooltipInternalOptions: { contentHtml?: string; html?: string; nodeOrCoordinate: MappedinNode | MappedinCoordinate; options?: TCreateTooltipCommonOptions | TCreateTooltipOptions; selector?: string }

Type declaration

TCreateTooltipOptions: TCreateTooltipCommonOptions & { padding?: number }
TEnableBlueDotOptions: { allowImplicitFloorLevel?: boolean; baseColor?: string; positionUpdater?: IPositionUpdater; showBearing?: boolean; smoothing?: boolean; useRotationMode?: boolean }

Type declaration

  • Optional allowImplicitFloorLevel?: boolean

    For venues that do not provide level updates, assume the user is always on the default map If this is false, and no level information is found from position updates, blueDotUpdate events will not include the nearest node This should probably be set true for single floor venues that have no level information in position updates

    defaultvalue

    false

  • Optional baseColor?: string

    Override the default color of the Blue Dot. We interpolate other colors, (such as aura and bearing) from this base color

    defaultvalue

    '#2266ff'

  • Optional positionUpdater?: IPositionUpdater

    Custom positionUpdater

    defaultvalue

    undefined

  • Optional showBearing?: boolean

    Show Bearing

    defaultvalue

    false

  • Optional smoothing?: boolean

    Smooth incoming position updates. Set to false if smoothing happens outside the SDK

    defaultvalue

    true

  • Optional useRotationMode?: boolean

    Whether to use the rotated view while following the user's position.

    defaultvalue

    false

TFlatLabelAllLocationsOptions: TLabelAllLocationCommonOptions & { appearance?: TFlatLabelAppearance }
TFlatLabelAppearance: { color?: string; font?: string; fontSize?: number; height?: number; margin?: number; scaleMin?: number; scaleStep?: number }

Type declaration

  • Optional color?: string

    Optional color in hexadecimal string e.g. #2e2e2e.

  • Optional font?: string

    A CSS style string font, e.g. "sans-serif". You can specify your own font via @font-face rule with a font family, and then include that here.

  • Optional fontSize?: number

    Size of the font in pixels.

    default

    12

  • Optional height?: number

    By default this is the upper bounds of the Polygon. If you don't have a Polygon, or want a custom height for some reason, you can set this.

  • Optional margin?: number

    The amount of space to leave before starting the text in pixels

    default

    5

  • Optional scaleMin?: number

    The minimum percentage we can shrink the label to if it won't fit within the bounds at 100%. If it doesn't fit at that level, it won't be created.

    default

    0.25

  • Optional scaleStep?: number

    How much to decrement the scale each time it doesn't fit, so we don't end up with too many different font sizes on screen at once. If you are only labeling a few MappedinPolygons rather than everything, you can set this and and scaleMin to 0.1 to fit everything except really long names perfectly.

    default

    0.25

TFlatLabelOptions: { canvasBounds?: { align: "left" | "right" | "center"; height: number; width: number; x: number; y: number }; text: string }

Type declaration

  • Optional canvasBounds?: { align: "left" | "right" | "center"; height: number; width: number; x: number; y: number }

    Set this if you want to label an arbitrary part of the Map. You will need to specify height as well.

    • align: "left" | "right" | "center"

      Whether the TextLabel should be anchored against the (x,y), or the opposite (horizontal) side of the box, or in the middle. It is * always vertically centered.

    • height: number

      The vertical space we have to fit the TextLabel.

    • width: number

      The horizontal space we have to fit the TextLabel.

    • x: number

      The x coordinate for the TextLabel anchor.

    • y: number

      The y coordinate for the TextLabel anchor.

  • text: string
TFloatingLabelAllLocationsOptions: TLabelAllLocationCommonOptions & { appearance?: TFloatingLabelAppearance }
TFloatingLabelAppearance: { margin?: number; marker?: { backgroundColor?: { active?: string; inactive?: string }; foregroundColor?: { active?: string; inactive?: string }; icon?: string; iconVisibilityThreshold?: number; size?: number }; text?: { backgroundColor?: string; foregroundColor?: string; lineHeight?: number; maxWidth?: number; numLines?: number; size?: number } }

Type declaration

  • Optional margin?: number

    Margin around the label and marker. This will affect label density

    default

    6

  • Optional marker?: { backgroundColor?: { active?: string; inactive?: string }; foregroundColor?: { active?: string; inactive?: string }; icon?: string; iconVisibilityThreshold?: number; size?: number }
    • Optional backgroundColor?: { active?: string; inactive?: string }
      • Optional active?: string

        Background color of the marker when it is active

      • Optional inactive?: string

        Background color of the marker when it is inactive (grayed out due to being outranked by other labels around)

    • Optional foregroundColor?: { active?: string; inactive?: string }
      • Optional active?: string

        Foreground color of the marker when it is active

      • Optional inactive?: string

        Foreground color of the marker when it is inactive (grayed out due to being outranked by other labels around)

    • Optional icon?: string

      SVG of icon to place inside Floating Label

    • Optional iconVisibilityThreshold?: number

      Defines when the icon becomes visible relative to the current zoom level anything below 0 will result in icons never showing up 0 ensures icons show up at maxZoom (fully zoomed in) 1 ensures they always show up

    • Optional size?: number

      Size of the marker in pixels

      deprecated

      Behavior when using this along with iconVisibilityThreshold and icon is undefined

  • Optional text?: { backgroundColor?: string; foregroundColor?: string; lineHeight?: number; maxWidth?: number; numLines?: number; size?: number }
    • Optional backgroundColor?: string

      Text background color

    • Optional foregroundColor?: string

      Text foreground color

    • Optional lineHeight?: number

      Line height sets the height of a line box. It's commonly used to set the distance between lines of text

      default

      1.2

    • Optional maxWidth?: number

      Maxiumum width of text in pixels

    • Optional numLines?: number

      Number of lines to display when text spans multiple lines

    • Optional size?: number

      Text size in pixels

TFloatingLabelPolygonOptions: { appearance?: TFloatingLabelAppearance; rank?: COLLISION_RANKING_TIERS | number; scale?: number; text: string }

Type declaration

  • Optional appearance?: TFloatingLabelAppearance

    Customize the appearance of the Floating Labels and their pins

  • Optional rank?: COLLISION_RANKING_TIERS | number

    Ranking tier to determine how likely a {@link FloatingLabel} will appear

  • Optional scale?: number
  • text: string
TFocusOnCameraOptions: { changeZoom?: boolean; minZoom?: number; rotation?: number; safeAreaInsets?: TSafeAreaInsets; tilt?: number }

Type declaration

  • Optional changeZoom?: boolean
  • Optional minZoom?: number
  • Optional rotation?: number
  • Optional safeAreaInsets?: TSafeAreaInsets
  • Optional tilt?: number
TGeolocationObject: { coords: { accuracy: number; floorLevel?: number; latitude: number; longitude: number }; positionIndex?: number; timestamp: number; type?: GEOLOCATION_STATUS }

An extension of the GeolocationPosition type. https://developer.mozilla.org/en-US/docs/Web/API/GeolocationPosition

Type declaration

  • coords: { accuracy: number; floorLevel?: number; latitude: number; longitude: number }
    • accuracy: number
    • Optional floorLevel?: number
    • latitude: number
    • longitude: number
  • Optional positionIndex?: number
  • timestamp: number
  • Optional type?: GEOLOCATION_STATUS
TGetPolygonsAtCoordinateOptions: { includeNonInteractive?: boolean }

Type declaration

  • Optional includeNonInteractive?: boolean

    Specifies whether polygons that cannot be interacted with should be included in the results. Default is false.

TGetVenueOptions: { accessToken?: string; baseUrl?: string; clientId?: string; clientSecret?: string; emitAnalyticsEvents?: boolean; headers?: { [ key in string]: string }; includeHidden?: boolean; language?: string; noAuth?: boolean; perspective?: string; platformString?: string; things?: any; useDraftData?: boolean; venue: string }

Type declaration

  • Optional accessToken?: string
  • Optional baseUrl?: string
  • Optional clientId?: string
  • Optional clientSecret?: string
  • Optional emitAnalyticsEvents?: boolean
  • Optional headers?: { [ key in string]: string }
  • Optional includeHidden?: boolean
  • Optional language?: string
  • Optional noAuth?: boolean
  • Optional perspective?: string
  • Optional platformString?: string
  • Optional things?: any
  • Optional useDraftData?: boolean
  • venue: string
TJourneyOptions: { connectionTemplate?: TConnectionTemplateFn; departureMarkerTemplate?: TMarkerTemplateFn; destinationMarkerTemplate?: TMarkerTemplateFn; inactivePathOptions?: TPathOptions; pathOptions?: TPathOptions; polygonHighlightColor?: string | false }

Type declaration

  • Optional connectionTemplate?: TConnectionTemplateFn

    Function that returns an HTML template to use as a connection tooltips (elevators, escalators, etc)

  • Optional departureMarkerTemplate?: TMarkerTemplateFn

    Function that returns an HTML template to use as a departure marker. Override with null | undefined to disable

  • Optional destinationMarkerTemplate?: TMarkerTemplateFn

    Function that returns an HTML template to use as a destination marker. Override with null | undefined to disable

  • Optional inactivePathOptions?: TPathOptions

    Path Options for the non-current path in multi-destination mode.

  • Optional pathOptions?: TPathOptions

    Path Options

  • Optional polygonHighlightColor?: string | false

    What color to highlight departure and destination polygons Pass false to disable

    default

    '#ff834c'

TLabelAllLocationCommonOptions: { createDespiteImage?: boolean; excludeTypes?: string[]; locations?: MappedinLocation[]; translationMap?: { [ key in string]: string }; sortFunction?: any }

Type declaration

  • Optional createDespiteImage?: boolean

    Display label despite the MappedinPolygon having an image on it. Often these images represent store logos.

    default

    false

  • Optional excludeTypes?: string[]

    Exclude specific location types from labeling

  • Optional locations?: MappedinLocation[]

    Locations to label - otherwise, use current venue object

  • Optional translationMap?: { [ key in string]: string }

    Custom Translation Map for {@link MappedinLocation.MappedinLocationState}

  • sortFunction?:function
TLabelAllLocationFlatLabelOptions: TLabelAllLocationCommonOptions & { appearance?: TFlatLabelAppearance; flatLabels: true }
deprecated
TLabelAllLocationFloatingLabelOptions: TLabelAllLocationCommonOptions & { appearance?: TFloatingLabelAppearance; flatLabels?: false }
deprecated
TMapClickEvent: { nearBlueDot: boolean; polygons: MappedinPolygon[]; position: { latitude: number; longitude: number } }

Type declaration

  • nearBlueDot: boolean

    Indicates whether the user clicked close to the Blue Dot object on the map, if present. If Blue Dot is disabled, this will always be false.

  • polygons: MappedinPolygon[]

    A list of MappedinPolygons corresponding to every polygon that a user's click passed through. These are in order of first to last intersected. Will be empty if no interactive polygons were clicked.

  • position: { latitude: number; longitude: number }

    The latitude / longitude of where the user clicked the map. Both components may be NaN if unable to compute these components.

    • latitude: number
    • longitude: number
TMapViewOptions: { alpha?: boolean; antialias?: boolean; backgroundAlpha?: number; backgroundColor?: string; disableHover?: boolean; disableZoomOnMapSizeChange?: boolean; firstMap?: MappedinMap | string; loadOptions?: { async?: boolean; mapRenderStrategy?: MAP_RENDER_MODE; zoomOverrides?: { blueDotFollowingZoomFactor?: number; focusZoomFactorPolygon?: number; zoomMultiplier?: number } }; multiBufferRendering?: boolean; onWebGLContextCreationError?: any; onWebGLContextLost?: any; onWebGLContextRestored?: any; onWebGLRendererError?: any }

Type declaration

  • Optional alpha?: boolean

    True if the opacity argument to setBackgroundColor should be considered.

    default

    true

  • Optional antialias?: boolean

    Controls whether antialiasing is on. Defaults to true, as long as devicePixelRatio is 1. This is very expensive on high resolution screens.

    default

    true

  • Optional backgroundAlpha?: number

    The opacity of the initial background color.

  • Optional backgroundColor?: string

    Background color of the map as a string e.g. #2e2e2e.

  • Optional disableHover?: boolean
  • Optional disableZoomOnMapSizeChange?: boolean
  • Optional firstMap?: MappedinMap | string

    First map to be rendered

  • Optional loadOptions?: { async?: boolean; mapRenderStrategy?: MAP_RENDER_MODE; zoomOverrides?: { blueDotFollowingZoomFactor?: number; focusZoomFactorPolygon?: number; zoomMultiplier?: number } }
    • Optional async?: boolean
    • Optional mapRenderStrategy?: MAP_RENDER_MODE

      By default, the SDK will merge all geometries by material to reduce the number of draw calls to the GPU To rever back to using a single geometry for every polygon, pass MAP_RENDER_MODE.MULTI_GEOMETRY

    • Optional zoomOverrides?: { blueDotFollowingZoomFactor?: number; focusZoomFactorPolygon?: number; zoomMultiplier?: number }
      • Optional blueDotFollowingZoomFactor?: number
      • Optional focusZoomFactorPolygon?: number
      • Optional zoomMultiplier?: number
  • Optional multiBufferRendering?: boolean

    Multi-buffer rendering should improve performance but may cause issues on older GPUs/browsers

    default

    true

  • onWebGLContextCreationError?:function
    • onWebGLContextCreationError(): void
    • Returns void

  • onWebGLContextLost?:function
    • onWebGLContextLost(): void
    • Returns void

  • onWebGLContextRestored?:function
    • onWebGLContextRestored(): void
    • Returns void

  • onWebGLRendererError?:function
    • onWebGLRendererError(): void
    • Returns void

TMapViewOptionsLegacy: { alpha?: boolean; antialias?: boolean; backgroundAlpha?: number; backgroundColor?: string; disableHover?: boolean; disableZoomOnMapSizeChange?: boolean; firstMap?: MappedinMap | string; loadOptions?: { mode?: "json" | "obj"; zoomOverrides?: { focusZoomFactorPolygon: unknown; zoomMultiplier: unknown } }; markerWorldIslandSplit?: boolean; multiBufferRendering?: boolean; onDataLoaded?: any; onFirstMapLoaded?: any; onWebGLContextCreationError?: any; onWebGLContextLost?: any; onWebGLContextRestored?: any; onWebGLRendererError?: any }

Type declaration

  • Optional alpha?: boolean

    True if the opacity argument to setBackgroundColor should be considered.

    default

    true

  • Optional antialias?: boolean

    Controls whether antialiasing is on. Defaults to true, as long as devicePixelRatio is 1. This is very expensive on high resolution screens.

    default

    true

  • Optional backgroundAlpha?: number

    The opacity of the initial background color.

  • Optional backgroundColor?: string

    Background color of the map as a string e.g. "#2e2e2e".

  • Optional disableHover?: boolean

    If you would like to completely disable the hover effect (if you are on a touch screen for example), set this to true.

    default

    false;

  • Optional disableZoomOnMapSizeChange?: boolean
  • Optional firstMap?: MappedinMap | string

    First map to be rendered

  • Optional loadOptions?: { mode?: "json" | "obj"; zoomOverrides?: { focusZoomFactorPolygon: unknown; zoomMultiplier: unknown } }
    • Optional mode?: "json" | "obj"
    • Optional zoomOverrides?: { focusZoomFactorPolygon: unknown; zoomMultiplier: unknown }
      • focusZoomFactorPolygon: unknown
      • zoomMultiplier: unknown
  • Optional markerWorldIslandSplit?: boolean
  • Optional multiBufferRendering?: boolean
    beta
  • onDataLoaded?:function
    • A callback executed with the 3D files have been downloaded for the first Map, and are starting to load into memory. The MapView is fully functional at this point, but some things will still be popping in.

      Parameters

      Returns void

  • onFirstMapLoaded?:function
    • onFirstMapLoaded(venue?: Mappedin): void
    • A callback executed when the first map is fully loaded. This means onDataLoaded has already been fired (if specified) and then all the textures and other resources have finished popping in.

      Parameters

      Returns void

  • onWebGLContextCreationError?:function
    • onWebGLContextCreationError(): void
    • Returns void

  • onWebGLContextLost?:function
    • onWebGLContextLost(): void
    • Returns void

  • onWebGLContextRestored?:function
    • onWebGLContextRestored(): void
    • Returns void

  • onWebGLRendererError?:function
    • onWebGLRendererError(): void
    • Returns void

TMappedinDirective: { action?: IAction; atLocation?: MappedinVortex; distance: number; instruction: string; node: MappedinNode; type?: BEARING_TYPE }

this is the "overloaded" version of the directive, with get-venue classes instead of stubs

Type declaration

  • Optional action?: IAction
  • Optional atLocation?: MappedinVortex
  • distance: number

    Distance from the last instruction to the current. Useful for turn by turn navigation

  • instruction: string
  • node: MappedinNode
  • Optional type?: BEARING_TYPE
TMappedinInitializeOptions: { mapView?: TMapViewOptions; venue: _TGetVenueOptions | _TGetVenueBundleOptions; firstMapSelector?: any }

Type declaration

TMappedinInitializeOutput: { mapView: MapView; venue: Mappedin }

Type declaration

TMappedinOfflineAllSearchMatch: { matchesOn: string; term: string; value?: string; weight: number }

Type declaration

  • matchesOn: string

    What field the search matched on

  • term: string

    The term that was found

  • Optional value?: string

    The value of that field

  • weight: number

    Term's weight

TMappedinOfflineSearchAllOptions: { constants: { CATEGORY_LOCATION_DESCRIPTION_WEIGHT: number; CATEGORY_LOCATION_NAME_WEIGHT: number; CATEGORY_LOCATION_TAGS_WEIGHT: number; CATEGORY_NAME_WEIGHT: number; LOCATION_DEFAULT_RANK: number; LOCATION_NAME_WEIGHT: number; PRIMARY_INDEX_FUZZYNESS: number; PRIMARY_INDEX_TAGS_NAME_WEIGHT: number; PRIMARY_INDEX_WEIGHT: number; RATIO_OF_FUZZY_TO_EXACT: number; RATIO_OF_PREFIX_TO_EXACT: number; SECONDARY_INDEX_WEIGHT: number }; emitAnalyticsEvents?: boolean; jsonIndex?: string; searchDescriptions?: boolean; searchDescriptionsInCategories?: boolean; searchTags?: boolean; searchTagsInCategories?: boolean; stopWords?: string[]; useLocationRank?: boolean }

A {@link Mappedin.OfflineSearch} is an offline search module

Type declaration

  • constants: { CATEGORY_LOCATION_DESCRIPTION_WEIGHT: number; CATEGORY_LOCATION_NAME_WEIGHT: number; CATEGORY_LOCATION_TAGS_WEIGHT: number; CATEGORY_NAME_WEIGHT: number; LOCATION_DEFAULT_RANK: number; LOCATION_NAME_WEIGHT: number; PRIMARY_INDEX_FUZZYNESS: number; PRIMARY_INDEX_TAGS_NAME_WEIGHT: number; PRIMARY_INDEX_WEIGHT: number; RATIO_OF_FUZZY_TO_EXACT: number; RATIO_OF_PREFIX_TO_EXACT: number; SECONDARY_INDEX_WEIGHT: number }

    Fine tune search constants

    • CATEGORY_LOCATION_DESCRIPTION_WEIGHT: number

      Multiplier for category locations' descriptions

      default

      0.0005

    • CATEGORY_LOCATION_NAME_WEIGHT: number

      Multiplier for category locations' names

      default

      0.01

    • CATEGORY_LOCATION_TAGS_WEIGHT: number

      Multiplier for category locations' tags

      default

      0.0005

    • CATEGORY_NAME_WEIGHT: number

      Multiplier for category names

      default

      0.5

    • LOCATION_DEFAULT_RANK: number

      Default rank when one isn't available in the data, default = 1

      default

      1

    • LOCATION_NAME_WEIGHT: number

      Multiplier for location names

      default

      1

    • PRIMARY_INDEX_FUZZYNESS: number

      Fuzziness index for location names and tags

      default

      0.09

    • PRIMARY_INDEX_TAGS_NAME_WEIGHT: number

      Multiplier for location tags

      default

      0.05

    • PRIMARY_INDEX_WEIGHT: number

      Multiplier for location names (1 by default)

      default

      1

    • RATIO_OF_FUZZY_TO_EXACT: number

      Ratio of Fuzzy Searches of Location names and tags relative to exact

      default

      0.01

    • RATIO_OF_PREFIX_TO_EXACT: number

      Ratio of Prefix Searches of Location names and tags relative to exact

      default

      0.2

    • SECONDARY_INDEX_WEIGHT: number

      Multiplier for descriptions

      default

      0.025

  • Optional emitAnalyticsEvents?: boolean

    Emit Analytics events when doing search

    default

    true when running in production

  • Optional jsonIndex?: string

    Initialize Search with a previously indexed JSON string (outputted by OfflineSearch.toJSON())

  • Optional searchDescriptions?: boolean

    Index location descriptions - typically better to use either tags or descriptions, depending on what's available

    default

    true

  • Optional searchDescriptionsInCategories?: boolean

    Also index all tags for every location in every category (caution: this may slow down indexing and search)

    default

    false

  • Optional searchTags?: boolean

    Index location tags - typically better to use either tags or descriptions, depending on what's available

    default

    true

  • Optional searchTagsInCategories?: boolean

    Also index all tags for every location in every category (caution: this may slow down indexing and search)

    default

    false

  • Optional stopWords?: string[]

    Array of stopwords to ignore when searching, default: english stopwords

  • Optional useLocationRank?: boolean

    Use the location polygons' rank in weighing results

TMappedinOfflineSearchOptions: Partial<TMappedinOfflineSearchAllOptions>
TMappedinOfflineSearchResult: { matches: TMappedinOfflineAllSearchMatch[]; object: MappedinLocation | MappedinCategory | Record<string, unknown>; score: number; type: "MappedinLocation" | "MappedinCategory" | "Custom" }

Type declaration

TMappedinOfflineSearchSuggestions: { hits: { text: string }[]; total: number }

Type declaration

  • hits: { text: string }[]

    List of suggestions

  • total: number

    Total number of suggestions generated

TMarkerTemplateFn: (({ icon, location }: TMarkerTemplateProps) => string)

Type declaration

TMarkerTemplateProps: { icon: string; location?: MappedinLocation }

Type declaration

TPadding: { bottom: number; left: number; right: number; top: number }

Type declaration

  • bottom: number
  • left: number
  • right: number
  • top: number
TPathOptions: { animateDrawing?: boolean; color?: string; displayArrowsOnPath?: boolean; drawDuration?: number; farRadius?: number; farZoom?: number; flattenPath?: boolean; nearRadius?: number; nearZoom?: number; pulseColor?: string; pulseIterations?: number; pulsePauseDuration?: number; showPulse?: boolean }

Type declaration

  • Optional animateDrawing?: boolean

    Animate the drawing of the path in the direction of travel.

    defaultvalue

    true

  • Optional color?: string

    Path Colour

    defaultvalue

    #00b800

  • Optional displayArrowsOnPath?: boolean

    Show arrows on path

    defaultvalue

    true

  • Optional drawDuration?: number

    Duration of path drawing

    defaultvalue

    1500

  • Optional farRadius?: number

    Radius of path at furthest zoom, in metres

    defaultvalue

    2.3 times nearRadius

  • Optional farZoom?: number

    Zoom level where the path size is farRadiustions.nearRadius

    defaultvalue

    10000

  • Optional flattenPath?: boolean

    Flatten the path to a 2D line

    defaultvalue

    false

  • Optional nearRadius?: number

    Radius of path at nearest zoom, in metres

    defaultvalue

    1.8

  • Optional nearZoom?: number

    Zoom level where the path size is nearRadius

    defaultvalue

    375

  • Optional pulseColor?: string

    Colour of path pulse

    defaultvalue

    '#ffffff'

  • Optional pulseIterations?: number

    Number of iterations to pulse to indicate direction

    defaultvalue

    Infinity

  • Optional pulsePauseDuration?: number

    How many milliseconds to wait before starting the next pulse after the current pulse travels the entirety of the path

    defaultvalue

    750

  • Optional showPulse?: boolean

    Show an animated pulse indicating the direction of travel.

    defaultvalue

    true

TSafeAreaInsets: { bottom: number; left: number; right: number; top: number; type?: SAFE_AREA_INSET_TYPE }

Type declaration

TShowVenueOptions: { backgroundAlpha?: number; backgroundColor?: string; firstMapId?: string; labelAllLocationsOnInit?: boolean; loadOptions?: { mapRenderStrategy?: MAP_RENDER_MODE } }

Type declaration

  • Optional backgroundAlpha?: number

    The opacity of the initial background color.

  • Optional backgroundColor?: string

    Sets the initial background color of the map, including while loading.

  • Optional firstMapId?: string

    The id of the first map to show on map load

  • Optional labelAllLocationsOnInit?: boolean

    Whether or not to display default styled Floating Labels initially

  • Optional loadOptions?: { mapRenderStrategy?: MAP_RENDER_MODE }
    • Optional mapRenderStrategy?: MAP_RENDER_MODE

      Set the map render strategy in order to optimize FPS

      beta
changeListenerFn<PAYLOAD>: ((update: PAYLOAD) => void)

Type Parameters

  • PAYLOAD

Type declaration

    • (update: PAYLOAD): void
    • Parameters

      • update: PAYLOAD

      Returns void

Variables

ANIMATION_TWEENS: { ease-in: any; ease-in-out: any; ease-out: any; linear: any } = ...

Type declaration

  • ease-in: any
  • ease-in-out: any
  • ease-out: any
  • linear: any
labelThemes: { darkOnLight: { margin: number; marker: { backgroundColor: { active: string; inactive: undefined }; foregroundColor: { active: string; inactive: undefined }; size: number }; text: { backgroundColor: string; foregroundColor: string; lineHeight: number; maxWidth: number; numLines: number; size: number } }; lightOnDark: { margin: number; marker: { backgroundColor: { active: string; inactive: undefined }; foregroundColor: { active: string; inactive: undefined }; size: number }; text: { backgroundColor: string; foregroundColor: string; lineHeight: number; maxWidth: number; numLines: number; size: number } } } = ...

Type declaration

  • darkOnLight: { margin: number; marker: { backgroundColor: { active: string; inactive: undefined }; foregroundColor: { active: string; inactive: undefined }; size: number }; text: { backgroundColor: string; foregroundColor: string; lineHeight: number; maxWidth: number; numLines: number; size: number } }
    • margin: number
    • marker: { backgroundColor: { active: string; inactive: undefined }; foregroundColor: { active: string; inactive: undefined }; size: number }
      • backgroundColor: { active: string; inactive: undefined }
        • active: string
        • inactive: undefined
      • foregroundColor: { active: string; inactive: undefined }
        • active: string
        • inactive: undefined
      • size: number
    • text: { backgroundColor: string; foregroundColor: string; lineHeight: number; maxWidth: number; numLines: number; size: number }
      • backgroundColor: string
      • foregroundColor: string
      • lineHeight: number
      • maxWidth: number
      • numLines: number
      • size: number
  • lightOnDark: { margin: number; marker: { backgroundColor: { active: string; inactive: undefined }; foregroundColor: { active: string; inactive: undefined }; size: number }; text: { backgroundColor: string; foregroundColor: string; lineHeight: number; maxWidth: number; numLines: number; size: number } }
    • margin: number
    • marker: { backgroundColor: { active: string; inactive: undefined }; foregroundColor: { active: string; inactive: undefined }; size: number }
      • backgroundColor: { active: string; inactive: undefined }
        • active: string
        • inactive: undefined
      • foregroundColor: { active: string; inactive: undefined }
        • active: string
        • inactive: undefined
      • size: number
    • text: { backgroundColor: string; foregroundColor: string; lineHeight: number; maxWidth: number; numLines: number; size: number }
      • backgroundColor: string
      • foregroundColor: string
      • lineHeight: number
      • maxWidth: number
      • numLines: number
      • size: number

Functions

  • getVenueBundle(userOptions: TGetVenueBundleOptions): Promise<Mappedin>
  • deprecated

    Fetching an offline Venue bundle It is possible to download the venue bundle with all assets built in, which allows for caching/offline solutions. Note 1: This requires enabling from Mappedin's Customer Solutions team. Note 2: This may behave a lot slower for large venues, especially those with many images. We are actively working on improving load times.

    Parameters

    • userOptions: TGetVenueBundleOptions

    Returns Promise<Mappedin>

  • setFetchFn(fetchFn: any): void
  • Overwrite the internal fetch function with your own. Typically for use in Node.js and Jest

    Parameters

    • fetchFn: any

    Returns void

  • Type Parameters

    Parameters

    • el: HTMLElement

      HTML Element where the mapView should be placed

    • venue: T

      Venue Object returned by getVenue

    • Optional options: TMapViewOptions

      MapView Options

    Returns Promise<MapView>