Class: Shadow

Extends

• vcs.vcm.widgets.Widget

Members

active{boolean}

className{string}

class Name of the Object

currentTime{Date}

The date currently used by the widget

initialized{boolean}

name{string}

unique Name

timezone{string}

The used timezone string

values{Object}

Value Object used for the ui to observe changes to the widget state. The date is the current timestamp, not a date object Object: { active: boolean, date: number }

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>} inherited

Returns the widgets supported maps

isActive(){boolean} inherited

returns the active state of the widget

Deprecated

• v3.6 use the property active directly

Returns:

state of the widget

isInitialized(){boolean} inherited

checks if the Widget is already initialized

Deprecated

• Yes

Returns:

true if all requirements are there

isSupported(map){boolean} inherited

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

setDate(date)

Sets the date of the shadow widget

Name	Type	Description
date	Date

Throws:

vcs.vcm.util.InvalidArgument

setDayOfYear(dayOfYear)

Sets the day of the current year

Name	Type	Description
dayOfYear	number

Throws:

vcs.vcm.util.InvalidArgument

setMinutesOfDay(minutesOfDay)

Sets the minutes of the day, used by the slider

Name	Type	Description
minutesOfDay	Number

Throws:

vcs.vcm.util.InvalidArgument

toggleShadow()

toggles the widget state