virtualcityMAP 3.6

Class: PluginItem

vcs.vcm.widgets.legend.PluginItem

A placeholder legend entry, where a plugin legend item should be rendered. To identify the plugin, provide the plugins name and the components name;

new vcs.vcm.widgets.legend.PluginItem(options)

Name Type Description
options vcs.vcm.widgets.legend.PluginItem.Options

Extends

Members

className{string}

class Name of the Object

config{Object}

The options passed to

id{string}

The unique id of the given item

level{number}

The nesting level of this tree item

name{string}

The components name

plugin{string}

The associated plugin

titleObject{Object}

Translateable title object. Where the key represents the local, and the value the translation for example: { en: 'Example', de: 'Beispiel' }

visible{boolean}

Whether the item should be displayed

Methods

activate(active, ignoreViewpoint) inherited

Activates the tree item

Name Type Description
active boolean

the state to activate to, false will deactivate
ignoreViewpoint boolean

if there is a viewpoint set, it is not activated

getViewPoint(){vcs.vcm.util.ViewPoint|null} inherited

returns the viewpoint for this treeitem

Deprecated
  • v3.6

    gotoViewpoint() inherited

    Goes to this tree items viewpoint, if there is one defined