Class FeatureVisibility

FeatureVisibility handles the visibility and highlighting of features of a specific FeatureLayer or DataSourceLayer and its FeatureLayerImplementation resp. DataSourceCesiumImpl. The visibility is being synchronized with the GlobalHider.

Hierarchy

FeatureVisibility

Index

Constructors

Methods

addHiddenFeature addHighlightFeature clearHiddenObjects clearHighlighting destroy hasHiddenFeature hasHighlightFeature hideObjects highlight showObjects unHighlight

Properties

changed hiddenObjects highlightedObjects lastUpdated

Constructors

constructor

new FeatureVisibility(): FeatureVisibility
Returns FeatureVisibility

Methods

addHiddenFeature

addHiddenFeature(id, feature): void
Parameters
- id: string | number
- feature: HighlightableFeature
Returns void
- Defined in src/layer/featureVisibility.ts:400

addHighlightFeature

addHighlightFeature(id, feature): void
Parameters
- id: string | number
- feature: HighlightableFeature
Returns void
- Defined in src/layer/featureVisibility.ts:328

clearHiddenObjects

clearHiddenObjects(): void
clears all the hidden objects

Returns void
- Defined in src/layer/featureVisibility.ts:389

clearHighlighting

clearHighlighting(): void
clears all highlighted objects

Returns void
- Defined in src/layer/featureVisibility.ts:314

destroy

destroy(): void
Clears all caches and removes cesium events.

Returns void
- Defined in src/layer/featureVisibility.ts:412

hasHiddenFeature

hasHiddenFeature(id, feature): boolean
Parameters
- id: string | number
- feature: HighlightableFeature
Returns boolean
- Defined in src/layer/featureVisibility.ts:393

hasHighlightFeature

hasHighlightFeature(id, feature): boolean
Parameters
- id: string | number
- feature: HighlightableFeature
Returns boolean
- Defined in src/layer/featureVisibility.ts:318

hideObjects

hideObjects(toHide): void
hides a number of objects
Parameters
- toHide: (string | number)[]
  
  A list of Object Ids which will be hidden
Returns void
- Defined in src/layer/featureVisibility.ts:344

highlight

highlight(toHighlight): void
highlights a number of features by ID (import("@vcmap-cesium/engine").Cesium3DTileFeature|ol/Feature) with the given color.
Parameters
- toHighlight: Record<string, HighlightStyleType>
Returns void
- Defined in src/layer/featureVisibility.ts:239

showObjects

showObjects(unHide): void
unHides a number of objects
Parameters
- unHide: (string | number)[]
  
  A list of Object Ids which will be unHidden
Returns void
- Defined in src/layer/featureVisibility.ts:366

unHighlight

unHighlight(toUnHighlight): void
unhighlights a number of features given by the ID (import("@vcmap-cesium/engine").Cesium3DTileFeature|import("ol").Feature<import("ol/geom/Geometry").default>)
Parameters
- toUnHighlight: (string | number)[]
  
  Array with IDS to unhighlight
Returns void
- Defined in src/layer/featureVisibility.ts:291

Properties

changed

changed: VcsEvent<FeatureVisibilityEvent> = ...

An event raised when the hidden or highlighted ids change. Is called with FeatureVisibilityEvent as its only argument

hiddenObjects

hiddenObjects: Record<string, Set<HighlightableFeature>> = {}

highlightedObjects

highlightedObjects: Record<string, HighlightedObject> = {}

lastUpdated

lastUpdated: number = ...

Generated using TypeDoc