mapwize-sdk-react-native
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • MapwizeViewRef

Index

Properties

Properties

addImageToMap

addImageToMap: (imageName: string, imageBase64: string) => void

Add an image to the map in order to be able to use its name in other Mapwize method/props

Type declaration

    • (imageName: string, imageBase64: string): void

    • Parameters

      • imageName: string
      • imageBase64: string

      Returns void

centerOn

centerOn: (position: LatLngFloor | Place | PlacePreview | VenuePreview | Venue, zoom?: undefined | number, animated?: undefined | false | true) => void

Center on a specific location.

param

Can be a LatLngFloor, a Place, a PlacePreview, a Venue or a VenuePreview

param

Optional the targeted camera zoom level. Default value is 18

param

Optional If true, the camera movement will be animated. Default is true

Type declaration

getDirectionModes

getDirectionModes: () => Promise<DirectionMode[]>

Get the accessible direction mode for the venue / universe currently displayed

Type declaration

getFloor

getFloor: () => Promise<Floor>

Get the current displayed floor

Type declaration

getFloors

getFloors: () => Promise<Floor[]>

Get the current accessible floors regarding the venue/universe displayed

Type declaration

getFollowUserMode

getFollowUserMode: () => Promise<FollowUserMode>

Get the follow user mode

Type declaration

getLanguage

getLanguage: () => Promise<string>

Get the current language. If in a venue, it will return the language set for this venue. Otherwise, it will return the preferred language.

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

getLanguageForVenue

getLanguageForVenue: (venue: Venue) => Promise<string>

Get the language for a specific venue

Type declaration

    • (venue: Venue): Promise<string>

    • Parameters

      Returns Promise<string>

getPreferredLanguage

getPreferredLanguage: () => Promise<string>

Get the preferred language that should be chosen if available when entering in a venue

Type declaration

    • (): Promise<string>

    • Returns Promise<string>

getUniverse

getUniverse: () => Promise<Universe>

Get the current universe.

Type declaration

getUniverseForVenue

getUniverseForVenue: (venue: Venue) => Promise<Universe>

Get the universe for a specific venue.

Type declaration

getUniverses

getUniverses: () => Promise<Universe[]>

Get the list of accessible universe.

Type declaration

getZoom

getZoom: () => Promise<number>

Get the current zoom level

Type declaration

    • (): Promise<number>

    • Returns Promise<number>

grantAccess

grantAccess: (accessKey: string) => Promise<void>

Gain access to private building using an access key

Type declaration

    • (accessKey: string): Promise<void>

    • Parameters

      • accessKey: string

      Returns Promise<void>

resetNorth

resetNorth: () => void

Reset North

Type declaration

    • (): void

    • Returns void

setFloor

setFloor: (floorNumber: number) => void

Set the current displayed floor

param

that will be set

Type declaration

    • (floorNumber: number): void

    • Parameters

      • floorNumber: number

      Returns void

setFollowUserMode

setFollowUserMode: (followUserMode: FollowUserMode) => void

Set the follow user mode

Type declaration

setLanguageForVenue

setLanguageForVenue: (language: string, venue: Venue) => void

Set the language for a specific venue

Type declaration

    • (language: string, venue: Venue): void

    • Parameters

      • language: string
      • venue: Venue

      Returns void

setPreferredLanguage

setPreferredLanguage: (language: string) => void

Set the preferred language that should be chosen if available when entering in a venue

Type declaration

    • (language: string): void

    • Parameters

      • language: string

      Returns void

setUniverse

setUniverse: (universe: Universe) => void

Set universe. If in a venue, it will set the universe for this venue. Otherwise, it will set the universe for the next venue you enter in.

Type declaration

setUniverseForVenue

setUniverseForVenue: (universe: Universe, venue: Venue) => void

Set universe for the specific venue.

Type declaration

zoomTo

zoomTo: (zoom: number) => void

Zoom to the specified zoom level

Type declaration

    • (zoom: number): void

    • Parameters

      • zoom: number

      Returns void

Legend

  • Constructor
  • Property
  • Method
  • Property
  • Inherited property

Generated using TypeDoc