Class: Widget

Subclasses

• vcs.vcm.widgets.AdvancedWalkMode
• vcs.vcm.widgets.BalloonInfo
• vcs.vcm.widgets.DisplayQuality
• vcs.vcm.widgets.Export
• vcs.vcm.widgets.Flight
• vcs.vcm.widgets.heightProfile.HeightProfile
• vcs.vcm.widgets.legend.Legend
• vcs.vcm.widgets.Locator
• vcs.vcm.widgets.NavigationControls
• vcs.vcm.widgets.PDFCreator
• vcs.vcm.widgets.planning.Planning
• vcs.vcm.widgets.Query
• vcs.vcm.widgets.search.Search
• vcs.vcm.widgets.Shadow
• vcs.vcm.widgets.TransparentTerrainMode

Extends

• vcs.vcm.Object

Members

active{boolean}

className{string}

class Name of the Object

initialized{boolean}

name{string}

unique Name

Methods

getClassName(){string} inherited

returns the class name of this object.

Deprecated

• Yes

Returns:

className

getConfigObject(){Object} inherited

getId(){string} inherited

returns the id of this object

Deprecated

• Yes

getName(){string} inherited

returns the name of the Object, the name is either given by the config Object or a uuid is generated

Deprecated

• Yes

getSupportedMaps(){Array.<string>}

Returns the widgets supported maps

isActive(){boolean}

returns the active state of the widget

Deprecated

• v3.6 use the property active directly

Returns:

state of the widget

isInitialized(){boolean}

checks if the Widget is already initialized

Deprecated

• Yes

Returns:

true if all requirements are there

isSupported(map){boolean}

returns true if this widget supports the given map. Should be overriden by the widget

Name	Type	Description
map	string | vcs.vcm.maps.Map	the map or className to check for support

Type Definitions

vcs.vcm.widgets.Widget.Options{vcs.vcm.Object.Options}

Properties:

Name	Type	Description
title	string | undefined
supportedMaps	Array.<string> | undefined