Class DeclarativeStyleItem

Style Object https://github.com/AnalyticalGraphicsInc/3d-tiles/tree/master/Styling

Hierarchy (View Summary)

StyleItem
- DeclarativeStyleItem

Index

Accessors

className

get className(): string
Returns string
Inherited from StyleItem.className
- Defined in src/vcsObject.ts:53

color

get color(): string | DeclarativeStyleItemConditions | undefined
Returns string | DeclarativeStyleItemConditions | undefined
- Defined in src/style/declarativeStyleItem.ts:403
set color(color: string | DeclarativeStyleItemConditions | undefined): void
Parameters
- color: string | DeclarativeStyleItemConditions | undefined
Returns void
- Defined in src/style/declarativeStyleItem.ts:407

font

get font(): string | DeclarativeStyleItemConditions | undefined
Returns string | DeclarativeStyleItemConditions | undefined
- Defined in src/style/declarativeStyleItem.ts:469
set font(font: string | DeclarativeStyleItemConditions | undefined): void
Parameters
- font: string | DeclarativeStyleItemConditions | undefined
Returns void
- Defined in src/style/declarativeStyleItem.ts:473

image

get image(): string | DeclarativeStyleItemConditions | undefined
Returns string | DeclarativeStyleItemConditions | undefined
- Defined in src/style/declarativeStyleItem.ts:436
set image(src: string | DeclarativeStyleItemConditions | undefined): void
Parameters
- src: string | DeclarativeStyleItemConditions | undefined
Returns void
- Defined in src/style/declarativeStyleItem.ts:440

labelColor

get labelColor(): string | DeclarativeStyleItemConditions | undefined
Returns string | DeclarativeStyleItemConditions | undefined
- Defined in src/style/declarativeStyleItem.ts:458
set labelColor(color: string | DeclarativeStyleItemConditions | undefined): void
Parameters
- color: string | DeclarativeStyleItemConditions | undefined
Returns void
- Defined in src/style/declarativeStyleItem.ts:462

labelText

get labelText(): string | DeclarativeStyleItemConditions | undefined
Returns string | DeclarativeStyleItemConditions | undefined
- Defined in src/style/declarativeStyleItem.ts:447
set labelText(text: string | DeclarativeStyleItemConditions | undefined): void
Parameters
- text: string | DeclarativeStyleItemConditions | undefined
Returns void
- Defined in src/style/declarativeStyleItem.ts:451

pointSize

get pointSize(): string | DeclarativeStyleItemConditions | undefined
Returns string | DeclarativeStyleItemConditions | undefined
- Defined in src/style/declarativeStyleItem.ts:480
set pointSize(
pointSize: string | DeclarativeStyleItemConditions | undefined,
): void
Parameters
- pointSize: string | DeclarativeStyleItemConditions | undefined
Returns void
- Defined in src/style/declarativeStyleItem.ts:484

show

get show(): string | boolean | DeclarativeStyleItemConditions | undefined
Returns string | boolean | DeclarativeStyleItemConditions | undefined
- Defined in src/style/declarativeStyleItem.ts:390
set show(
show: string | boolean | DeclarativeStyleItemConditions | undefined,
): void
Parameters
- show: string | boolean | DeclarativeStyleItemConditions | undefined
Returns void
- Defined in src/style/declarativeStyleItem.ts:394

strokeColor

get strokeColor(): string | DeclarativeStyleItemConditions | undefined
Returns string | DeclarativeStyleItemConditions | undefined
- Defined in src/style/declarativeStyleItem.ts:414
set strokeColor(
color: string | DeclarativeStyleItemConditions | undefined,
): void
Parameters
- color: string | DeclarativeStyleItemConditions | undefined
Returns void
- Defined in src/style/declarativeStyleItem.ts:418

strokeWidth

get strokeWidth(): string | DeclarativeStyleItemConditions | undefined
Returns string | DeclarativeStyleItemConditions | undefined
- Defined in src/style/declarativeStyleItem.ts:425
set strokeWidth(
width: string | DeclarativeStyleItemConditions | undefined,
): void
Parameters
- width: string | DeclarativeStyleItemConditions | undefined
Returns void
- Defined in src/style/declarativeStyleItem.ts:429

style

get style(): Style | StyleFunction
The 2D representation of this style

Returns Style | StyleFunction
Inherited from StyleItem.style
- Defined in src/style/styleItem.ts:61
set style(style: Style | StyleFunction): void
Parameters
- style: Style | StyleFunction
Returns void
Inherited from StyleItem.style
- Defined in src/style/styleItem.ts:65

styleOptions

get styleOptions(): DeclarativeStyleOptions
Returns DeclarativeStyleOptions
- Defined in src/style/declarativeStyleItem.ts:127

`Static`className

get className(): "DeclarativeStyleItem"
Returns "DeclarativeStyleItem"
Overrides StyleItem.className
- Defined in src/style/declarativeStyleItem.ts:91

Constructors

constructor

new DeclarativeStyleItem(
options: DeclarativeStyleItemOptions,
): DeclarativeStyleItem
Parameters
- options: DeclarativeStyleItemOptions
Returns DeclarativeStyleItem
Overrides StyleItem.constructor
- Defined in src/style/declarativeStyleItem.ts:104

Methods

`Protected`_styleChanged

_styleChanged(): void
Returns void
Inherited from StyleItem._styleChanged
- Defined in src/style/styleItem.ts:127

assign

assign(styleItem: DeclarativeStyleItem): this
Parameters
- styleItem: DeclarativeStyleItem
Returns this
Overrides StyleItem.assign
- Defined in src/style/declarativeStyleItem.ts:159

clone

clone(result?: DeclarativeStyleItem): DeclarativeStyleItem
Clones this style. Does not pass the name property.
Parameters
- Optionalresult: DeclarativeStyleItem
Returns DeclarativeStyleItem
Overrides StyleItem.clone
- Defined in src/style/declarativeStyleItem.ts:150

destroy

destroy(): void
Returns void
Overrides StyleItem.destroy
- Defined in src/style/declarativeStyleItem.ts:493

equals

equals(styleItem: StyleItem): boolean
Tests if two styleItems are equivalent. Does not match the name property (e.g. identifier)
Parameters
- styleItem: StyleItem
Returns boolean
Inherited from StyleItem.equals
- Defined in src/style/styleItem.ts:115

getLogger

getLogger(): Logger
Returns Logger
Inherited from StyleItem.getLogger
- Defined in src/vcsObject.ts:57

isSupported

isSupported(className: string): boolean
Parameters
- className: string
Returns boolean
Todo
redundant, remove
Inherited from StyleItem.isSupported
- Defined in src/style/styleItem.ts:73

toJSON

toJSON(): DeclarativeStyleItemOptions
Returns DeclarativeStyleItemOptions
Overrides StyleItem.toJSON
- Defined in src/style/declarativeStyleItem.ts:133

`Static`getDefaultOptions

getDefaultOptions(): VcsObjectOptions
Returns VcsObjectOptions
Inherited from StyleItem.getDefaultOptions
- Defined in src/vcsObject.ts:28

Properties

`Protected`_style

_style: Style | StyleFunction = ...

`Optional`[moduleIdSymbol]

"[moduleIdSymbol]"?: string

cesiumStyle

cesiumStyle: Cesium3DTileStyle = ...

The 3D representation of this style

colorBlendMode

colorBlendMode: Cesium3DTileColorBlendMode

isDestroyed

isDestroyed: boolean

`Readonly`name

name: string

unique Name

properties

properties: Record<string, unknown>

styleChanged

styleChanged: VcsEvent<void> = ...

Fired on style updates

supportedLayers

supportedLayers: string[] = []

Class DeclarativeStyleItem

Hierarchy (View Summary)

Index

Accessors

Constructors

Methods

Properties

Accessors

className

Returns string

color

Returns string | DeclarativeStyleItemConditions | undefined

Parameters

Returns void

font

Returns string | DeclarativeStyleItemConditions | undefined

Parameters

Returns void

image

Returns string | DeclarativeStyleItemConditions | undefined

Parameters

Returns void

labelColor

Returns string | DeclarativeStyleItemConditions | undefined

Parameters

Returns void

labelText

Returns string | DeclarativeStyleItemConditions | undefined

Parameters

Returns void

pointSize

Returns string | DeclarativeStyleItemConditions | undefined

Parameters

Returns void

show

Returns string | boolean | DeclarativeStyleItemConditions | undefined

Parameters

Returns void

strokeColor

Returns string | DeclarativeStyleItemConditions | undefined

Parameters

Returns void

strokeWidth

Returns string | DeclarativeStyleItemConditions | undefined

Parameters

Returns void

style

Returns Style | StyleFunction

Parameters

Returns void

styleOptions

Returns DeclarativeStyleOptions

StaticclassName

Returns "DeclarativeStyleItem"

Constructors

constructor

Parameters

Returns DeclarativeStyleItem

Methods

Protected_styleChanged

Returns void

assign

Parameters

Returns this

clone

Parameters

Returns DeclarativeStyleItem

destroy

Returns void

equals

Parameters

Returns boolean

getLogger

Returns Logger

isSupported

Parameters

Returns boolean

Todo

toJSON

Returns DeclarativeStyleItemOptions

`Static`className

`Protected`_styleChanged

`Static`getDefaultOptions

`Protected`_style

`Optional`[moduleIdSymbol]

`Readonly`name