Class VectorStyleItem

Hierarchy (view full)

StyleItem
- VectorStyleItem

Accessors

cesiumFillColor

get cesiumFillColor(): null | Color
the current fill color as a cesium color

Returns null | Color
- Defined in src/style/vectorStyleItem.ts:307

className

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

fillColor

get fillColor(): undefined | Color
the current fill color, not the pattern

Returns undefined | Color
- Defined in src/style/vectorStyleItem.ts:277
set fillColor(color): void
Parameters
- color: undefined | ColorType
Returns void
- Defined in src/style/vectorStyleItem.ts:281

image

get image(): undefined | ImageStyle
Returns undefined | ImageStyle
- Defined in src/style/vectorStyleItem.ts:396
set image(image): void
Parameters
- image: undefined | ImageStyle
Returns void
- Defined in src/style/vectorStyleItem.ts:400

label

get label(): undefined | string
Returns undefined | string
- Defined in src/style/vectorStyleItem.ts:363
set label(label): void
Parameters
- label: undefined | string
Returns void
- Defined in src/style/vectorStyleItem.ts:367

pattern

get pattern(): undefined | VectorStyleItemPattern
Returns undefined | VectorStyleItemPattern
- Defined in src/style/vectorStyleItem.ts:315
set pattern(patternOptions): void
Parameters
- patternOptions: undefined | VectorStyleItemPattern
Returns void
- Defined in src/style/vectorStyleItem.ts:321

stroke

get stroke(): undefined | Stroke
Returns undefined | Stroke
- Defined in src/style/vectorStyleItem.ts:345
set stroke(stroke): void
Parameters
- stroke: undefined | Stroke
Returns void
- Defined in src/style/vectorStyleItem.ts:349

style

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

Returns Style | StyleFunction
Overrides StyleItem.style
- Defined in src/style/vectorStyleItem.ts:414
set style(style): void
The 2D representation of this style
Parameters
- style: Style | StyleFunction
Returns void
Overrides StyleItem.style
- Defined in src/style/vectorStyleItem.ts:418

text

get text(): undefined | Text
Returns undefined | Text
- Defined in src/style/vectorStyleItem.ts:379
set text(text): void
Parameters
- text: undefined | Text
Returns void
- Defined in src/style/vectorStyleItem.ts:383

`Static`className

get className(): "VectorStyleItem"
Returns "VectorStyleItem"
Overrides StyleItem.className
- Defined in src/style/vectorStyleItem.ts:114

Constructors

constructor

new VectorStyleItem(options): VectorStyleItem
Parameters
- options: VectorStyleItemOptions
Returns VectorStyleItem
Overrides StyleItem.constructor
- Defined in src/style/vectorStyleItem.ts:134

Methods

`Protected`_styleChanged

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

assign

assign(result): VectorStyleItem
Parameters
- result: VectorStyleItem
Returns VectorStyleItem
Overrides StyleItem.assign
- Defined in src/style/vectorStyleItem.ts:716

clone

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

destroy

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

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

getOptionsForFeature

getOptionsForFeature(feature): VectorStyleItemOptions
Parameters
- feature: Feature<Geometry>
Returns VectorStyleItemOptions
- Defined in src/style/vectorStyleItem.ts:793

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(): VectorStyleItemOptions
Returns VectorStyleItemOptions
Overrides StyleItem.toJSON
- Defined in src/style/vectorStyleItem.ts:753

unset

unset(section): void
Exclude a section from this style. Excluded section are not returned and cannot be assigned via .assign. Setting the section over a property will remove it from the excluded sections.
Parameters
- section: keyof VectorStyleItemExclusion
  one of fill, stroke, image
Returns void
- Defined in src/style/vectorStyleItem.ts:840

updateCesiumStyle

updateCesiumStyle(): void
Returns void
- Defined in src/style/vectorStyleItem.ts:470

updateCesiumStyleColor

updateCesiumStyleColor(silent): void
Parameters
- silent: boolean
Returns void
- Defined in src/style/vectorStyleItem.ts:477

updateCesiumStyleImage

updateCesiumStyleImage(silent): void
Parameters
- silent: boolean
Returns void
- Defined in src/style/vectorStyleItem.ts:503

updateCesiumStyleText

updateCesiumStyleText(silent): void
Parameters
- silent: boolean
Returns void
- Defined in src/style/vectorStyleItem.ts:598

validateOptions

validateOptions(options): void
Parameters
- options: VectorStyleItemOptions
Returns void
- Defined in src/style/vectorStyleItem.ts:188

Properties

`Protected`_style

_style: Style | StyleFunction = ...

`Optional`[moduleIdSymbol]

[moduleIdSymbol]?: string

cesiumStyle

cesiumStyle: Cesium3DTileStyle = ...

The 3D representation of this style

colorBlendMode

colorBlendMode: Cesium3DTileColorBlendMode

exclude

exclude: VectorStyleItemExclusion

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