virtualcityMAP 3 API Reference - Class: DeclarativeStyleItem

Class: DeclarativeStyleItem

new vcs.vcm.util.style.DeclarativeStyleItem(options)

Name	Type	Description
`options`	vcs.vcm.util.style.DeclarativeStyleItem.Options

Extends

vcs.vcm.util.style.StyleItem

Members

cesiumStyle{Cesium.Cesium3DTileStyle}

The 3D representation of this style

color{vcs.vcm.util.style.DeclarativeStyleItem.conditions} {string} {undefined}

font{vcs.vcm.util.style.DeclarativeStyleItem.conditions} {string} {undefined}

image{vcs.vcm.util.style.DeclarativeStyleItem.conditions} {string} {undefined}

labelColor{vcs.vcm.util.style.DeclarativeStyleItem.conditions} {string} {undefined}

labelText{vcs.vcm.util.style.DeclarativeStyleItem.conditions} {string} {undefined}

legend{Array.<vcs.vcm.util.style.StyleItem.LegendEntry>}

Legend entries

name{string} {number}

The name of the style

pointSize{vcs.vcm.util.style.DeclarativeStyleItem.conditions} {string} {undefined}

show{vcs.vcm.util.style.DeclarativeStyleItem.conditions} {string} {boolean} {undefined}

strokeColor{vcs.vcm.util.style.DeclarativeStyleItem.conditions} {string} {undefined}

strokeWidth{vcs.vcm.util.style.DeclarativeStyleItem.conditions} {string} {undefined}

style{ol.style.Style} {ol.StyleFunction}

The 2D representation of this style

styleChanged{Cesium.Event}

Fired on style updates

TODO

this is not yet the case for all vector style properties

Methods

clone(result){vcs.vcm.util.style.DeclarativeStyleItem}

Name	Type	Description
`result`	vcs.vcm.util.style.DeclarativeStyleItem

getOptions(sections){vcs.vcm.util.style.DeclarativeStyleItem.Options}

Name	Type	Description
`sections`	Object.<string, boolean>

getReference(){vcs.vcm.util.style.Reference} inherited

gets a reference to this style by its name. should only be used for static styles, aka styles already part of the config

Type Definitions

vcs.vcm.util.style.DeclarativeStyleItem.conditions{Object}

Properties:

Name	Type	Description
`conditions`	Array.<(Array.<string>\|string)>

vcs.vcm.util.style.DeclarativeStyleItem.DeclarativeStyleOptions{Object}

Properties:

Name	Type	Description
`defines`	Object \| undefined
`show`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| boolean \| undefined
`color`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`strokeColor`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined	custom 2D ol condition
`strokeWidth`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined	custom 2D ol condition
`scale`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`pointOutlineWidth`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`pointOutlineColor`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`pointSize`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`image`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined	this should be an icon url
`font`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined	a css font string
`labelStyle`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`labelText`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`labelColor`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`labelOutlineWidth`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`labelOutlineColor`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`anchorLineEnabled`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`anchorLineColor`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`heightOffset`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`verticalOrigin`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`horizontalOrigin`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`labelHorizontalOrigin`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined
`labelVerticalOrigin`	vcs.vcm.util.style.DeclarativeStyleItem.conditions \| string \| undefined

vcs.vcm.util.style.DeclarativeStyleItem.Options{vcs.vcm.util.style.StyleItem.Options}

Properties:

Name	Type	Description
`declarativeStyle`	vcs.vcm.util.style.DeclarativeStyleItem.DeclarativeStyleOptions \| undefined