POLAR reference
    Preparing search index...

    Interface LayerConfiguration

    interface LayerConfiguration {
        id: string;
        name: string;
        type: LayerType;
        gfiMode?: "bboxDot" | "intersects";
        hideInMenu?: boolean;
        maxZoom?: number;
        minZoom?: number;
        options?: LayerConfigurationOptions;
        styleId?: string;
        visibility?: boolean;
    }
    Index

    Properties

    id name type gfiMode? hideInMenu? maxZoom? minZoom? options? styleId? visibility?

    Properties

    id: string

    Unique id to identify the layer.

    name: string

    Human-readable identifier and value to be displayed in the UI.

    type: LayerType

    Type of layer. Can be background layer, a feature ('mask') layer with specific information, or any custom string for grouping different mask layers. Custom strings allow for the categorization of layers into arbitrary groups.

    gfiMode?: "bboxDot" | "intersects"

    layers may have their own gfiMode.

    hideInMenu?: boolean

    Whether the mask-layer should be hidden from the LayerChooser selection menu.

    maxZoom?: number

    The maximum zoom level the layer will be rendered in.

    Number.MAX_SAFE_INTEGER
    minZoom?: number

    The minimum zoom level the layer will be rendered in.

    0
    options?: LayerConfigurationOptions

    Enables a configuration feature for the layer in its selection in the UI of the LayerChooser.

    styleId?: string

    ID of the used style. If the layer is also configured in mapConfiguration.markers, that configuration takes precedence over the configured styleId. Only applicable for vector-type layers. For more information and an example see mapConfiguration.featureStyles. Defaults and fallbacks to OpenLayers default styling.

    visibility?: boolean

    Initial visibility of the layers.

    false

    Settings

    Member Visibility

    On This Page

    Properties