Class DeclarativeStyleItem

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

Hierarchy (view full)

StyleItem
- DeclarativeStyleItem

Index

Accessors

className color font image labelColor labelText pointSize show strokeColor strokeWidth style styleOptions className

Constructors

Methods

_styleChanged assign clone destroy equals getLogger isSupported toJSON

Properties

_style [moduleIdSymbol]? cesiumStyle colorBlendMode isDestroyed name properties styleChanged supportedLayers

Accessors

className

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

color

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

font

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

image

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

labelColor

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

labelText

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

pointSize

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

show

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

strokeColor

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

strokeWidth

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

style

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

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

styleOptions

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

`Static`className

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

Constructors

constructor

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

Methods

`Protected`_styleChanged

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

assign

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

clone

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

destroy

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

equals

equals(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:110

getLogger

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

isSupported

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

toJSON

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

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[] = []