Class StyleItem

An abstract style definition which can be applied to a layer

Hierarchy (view full)

VcsObject
- StyleItem
  - DeclarativeStyleItem
  - VectorStyleItem

Index

Accessors

className style 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 VcsObject.className
- Defined in src/vcsObject.ts:45

style

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

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

`Static`className

get className(): string
Returns string
Overrides VcsObject.className
- Defined in src/style/styleItem.ts:22

Constructors

constructor

new StyleItem(options): StyleItem
Parameters
- options: StyleItemOptions
Returns StyleItem
Overrides VcsObject.constructor
- Defined in src/style/styleItem.ts:46

Methods

`Protected`_styleChanged

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

assign

assign(styleItem): StyleItem
Parameters
- styleItem: StyleItem
Returns StyleItem
- Defined in src/style/styleItem.ts:99

clone

clone(_result?): StyleItem
Clones this style. Does not pass the name property.
Parameters
- Optional_result: StyleItem
Returns StyleItem
- Defined in src/style/styleItem.ts:92

destroy

destroy(): void
Returns void
Overrides VcsObject.destroy
- Defined in src/style/styleItem.ts:126

equals

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

getLogger

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

isSupported

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

toJSON

toJSON(): StyleItemOptions
Returns StyleItemOptions
Overrides VcsObject.toJSON
- Defined in src/style/styleItem.ts:78

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