LayerFilterAPI¶
Interface LayerFilterAPI
interface LayerFilterAPI {
getEnabledLayerFilters(): string[];
getRegisteredLayerFilters(): { [key: string]: boolean };
isNodePartOfEnabledLayers(nodeID: number): Promise<boolean>;
setLayerFilterEnabled(
name: string,
enabled: boolean,
): SetLayerFilterEnabledResult;
}
getEnabledLayerFilters(): string[];
getRegisteredLayerFilters(): { [key: string]: boolean };
isNodePartOfEnabledLayers(nodeID: number): Promise<boolean>;
setLayerFilterEnabled(
name: string,
enabled: boolean,
): SetLayerFilterEnabledResult;
}
Hierarchy (View Summary)
- LayerFilterAPI
Methods
get Enabled Layer Filters
get Registered Layer Filters
is Node Part Of Enabled Layers
set Layer Filter Enabled
- setLayerFilterEnabled(
name: string,
enabled: boolean,
): 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
- name: string
The LayerFilterAPI is used to manage the visualization of Layers. These are additional metadata information from input data and are not always provided.