Logo
Developer

VisioWeb 1.17.2

Class

visioweb.Place

Mapviewer's Place class.
This object should be obtained from the Mapviewer's getPlace and getPlaces methods.
Place objects correspond to identified surfaces in the map.

While images and texts can also be linked to an ID, they will materialize as POI objects in the data prepared for VisioWeb.

Methods summary


Name Description
isLoaded Returns whether some geometry elements were loaded for this place
resetColor Restores the original place's color, thus removing the potential highlight or temporary color.
setColor Set a place color (as highlight, or temporarly).
setIcon Set the place's icon (or options including 'url' property).
setName Set a place name (or options including 'text' property).

Methods detail

isLoaded() → {boolean}

Returns whether some geometry elements were loaded for this place
Since:
  • 1.9.8
Returns:
Type
boolean

resetColor() → {boolean}

Restores the original place's color, thus removing the potential highlight or temporary color.
Since:
  • 1.8.3 replaces removeHighlight()
Returns:
Type
boolean

setColor(color) → {boolean}

Set a place color (as highlight, or temporarly).
Parameters:
Name Type Description
color color highlight color in hexadecimal, e.g. 0x00ff00,
Since:
  • 1.8.3 replaces highlight()
Returns:
Type
boolean

setIcon(urlOrOptions) → {boolean}

Set the place's icon (or options including 'url' property).
Parameters:
Name Type Description
urlOrOptions string | Object
Since:
  • 1.9.8
See:
Returns:
Type
boolean

setName(labelOrOptions) → {boolean}

Set a place name (or options including 'text' property).
Parameters:
Name Type Description
labelOrOptions string | Object
Since:
  • 1.9.8
See:
Returns:
Type
boolean