VisioWeb2D 1.8.0

Class

vg.mapviewer.web2d.POI

MapViewer's POI class.

Constructor

new POI()

This object should be constructed from the MapViewer's addPOI() method.
See:

Members

visible :bool

Controls the visbility of the POI. NOTE: this property does not exist under IE8.

Methods

hide()

This method is called to hide the POI. Equivalent to the following
Example
POI.visible = false;

options(optionOrObjecct, value) → {Object|string}

Use this method to get or change a POI option. Note, in contrast to VisioWeb, the only available POI's object are those created directly via mapviewer.addPOI.
Parameters:
Name Type Description
optionOrObjecct string | object the option name; valid names for reading are all the options available to .addPOI() . If not specified return the options that were used to create the POI. if it is an object, it can specify multiple option:values. Options that can be changed currently only 'visible' and 'position'.
value string the option value to set. If not specified return the option value; This only works for 'visible' and 'position'
Since:
  • 1.7.19 Can take multiple options as an object.
See:
Returns:
if no value is given, it will return the current value for that option.
Type
Object | string
Example
poi.options('visible',false);
// or
poi = mapviewer.addPOI({text: "hello", position: {x: 0.6, y: 0.5}, visible: false})
poi.options({visible: true, position: {x: 0.5, y: 0.5}});

remove()

This method is called to remove a POI from the map.

show()

This method is called to show the POI. Equivalent to the following
Example
POI.visible = true;