Class VectorStyleItem

Hierarchy (View Summary)

StyleItem
- VectorStyleItem

Accessors

cesiumFillColor

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

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

className

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

fillColor

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

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

image

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

label

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

pattern

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

stroke

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

style

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

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

text

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

`Static`className

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

Constructors

constructor

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

Methods

`Protected`_styleChanged

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

assign

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

clone

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

destroy

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

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

getOptionsForFeature

getOptionsForFeature(feature: Feature): VectorStyleItemOptions
Parameters
- feature: Feature
Returns VectorStyleItemOptions
- Defined in src/style/vectorStyleItem.ts:788

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

unset

unset(section: keyof VectorStyleItemExclusion): 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:835

updateCesiumStyle

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

updateCesiumStyleColor

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

updateCesiumStyleImage

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

updateCesiumStyleText

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

validateOptions

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

`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

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