Interface StateChecker

A state checker can add additional messages (such as warnings) to an item displayed by the TOC.

A custom StateChecker has to be registered as toc.StateChecker.

interface StateChecker {
    checkState(
        options: CheckStateOptions,
    ): CheckStateResult | Promise<CheckStateResult>;
}

Index

Methods

Methods

checkState

checkState(
options: CheckStateOptions,
): CheckStateResult | Promise<CheckStateResult>
This method is called if the viewpoint of the map changes or a layer is added/loaded.
Parameters
- options: CheckStateOptions
Returns CheckStateResult | Promise<CheckStateResult>
- Defined in StateChecker.ts:18