Class MapUnit

constructor

• new MapUnit(params): MapUnit

• Constructor.

  Parameters

  • params: Partial<MapUnit>

  Returns MapUnit

addCoordinate

• addCoordinate(latLng): void

• Adds an individual coordinate to the list of coordinates that make up the touchable area of the map unit's polygon.

  Parameters

  • latLng: LatLng

    the coordinate to add

  Returns void

addWayfindingNode

• addWayfindingNode(waypoint): void

• Adds a waypoint to the list of wayfinding nodes that are associated with the map unit.

  Parameters

  • waypoint: Waypoint

    the node to add

  Returns void

getCoordinates

• getCoordinates(): LatLng[][]

• Returns LatLng[][]

getGeoJsonFeature

• getGeoJsonFeature(): Feature<Geometry, {
      [name: string]: any;
  }>

• Returns Feature<Geometry, {
      [name: string]: any;
  }>

hasHotspot

• hasHotspot(): boolean

• Checks to see if the map unit contains a hotspot location.

  Returns boolean

  true if the map unit has a hotspot location, false othersie

hasIcon

• hasIcon(): boolean

• Checks to see if the map unit has an icon that can be used.

  Returns boolean

  true if the map unit has an icon and icon location, false otherwise

hasLabel

• hasLabel(): boolean

• Checks to see if the map unit contains data that can be used to generate a label.

  Returns boolean

  true if the map unit has a name and label location, false otherwise

isEmpty

• isEmpty(): boolean

• Checks to see if the map unit contains an ID.

  Returns boolean

  true if the id is empty, false otehrwise

setCoordinates

• setCoordinates(coordinates): void

• Parameters

  • coordinates: LatLng[][]

    the coordinates that form a polygon to represent the touchable area of a map unit.

  Returns void

toJSONObject

• toJSONObject(): Map<string, any>

• Returns Map<string, any>

  Since

  2.0.0

Optional category

Optional centerLocation

coordinates

Optional floor

geojsonCoordinates

geometryType

hotSpotLocation

Optional icon

Optional iconLocation

id

Optional labelLocation

name

Optional placeId

Optional type

wayfindingNodes