LayerFilterAPI#

Interface LayerFilterAPI

The LayerFilterAPI is used to manage the visualization of Layers. These are additional metadata information from input data and are not always provided.

Hierarchy

LayerFilterAPI
- ContextAPI

Index

Methods

getEnabledLayerFilters getRegisteredLayerFilters isNodePartOfEnabledLayers setLayerFilterEnabled

Methods

getEnabledLayerFilters

getEnabledLayerFilters(): string[]
Returns the currently defined list of enabled LayerFilters.

Returns string[]
An array of strings representing the names of the enabled LayerFilters.

getRegisteredLayerFilters

getRegisteredLayerFilters(): {
[key: string]: boolean;
}
Returns the currently defined list of LayerFilters.

Returns {
[key: string]: boolean;
}
Returns the registered LayerFilters and their states.
- [key: string]: boolean

isNodePartOfEnabledLayers

isNodePartOfEnabledLayers(nodeID): Promise<boolean>
Returns true if the specified nodeID is part of an enabled Layer.
Parameters
- nodeID: number
  
  The nodeID which should be checked.
Returns Promise<boolean>

setLayerFilterEnabled

setLayerFilterEnabled(name, enabled): SetLayerFilterEnabledResult
Sets layers to enabled whose names are in the array of names.
Parameters
- name: string
  
  The name of the LayerFilter
- enabled: boolean
  
  The new enabled state.
Returns SetLayerFilterEnabledResult

Did you find this page useful? Please give it a rating:

★ ★ ★ ★ ★

Thank you for rating this page!

Any issues or feedback?

What kind of problem would you like to report?

This page needs code samples
Code samples do not work
Information is missing
Please tell us more about what's wrong:
Information is incorrect
Please tell us more about what's wrong:
Information is unclear or confusing
Please tell us more about what's wrong:
The page is rendered incorrectly (styling/CSS)
Give Feedback