Warning

Nightly releases are generated automatically from the latest source code and are intended for experimental purposes only. These builds may contain incomplete or untested features, bugs, or security vulnerabilities, and as such, are not for production use. Users should be aware that nightly releases may cause unexpected behavior, data loss, or system instability. Use of these releases is at the user's own risk, and it is advised to have adequate backups before testing. The software is provided as is with no guarantees or support.

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.

interface LayerFilterAPI {
    getEnabledLayerFilters(): string[];
    getRegisteredLayerFilters(): { [key: string]: boolean };
    isNodePartOfEnabledLayers(nodeID: number): Promise<boolean>;
    setLayerFilterEnabled(
        name: string,
        enabled: boolean,
    ): SetLayerFilterEnabledResult;
}

Hierarchy (View Summary)

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.

isNodePartOfEnabledLayers

  • isNodePartOfEnabledLayers(nodeID: number): 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: 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