GeoLeaf Core API - v3.19.0
    Preparing search index...

    Interface LayerConfig

    Layer reference entry in the profile layers array. Points to a per-layer JSON config file loaded at runtime.

    interface LayerConfig {
        id?: string;
        url?: string;
        name?: string;
        label?: string;
        configFile?: string;
        layerManagerId?: string;
        showInLayerManager?: boolean;
        themeable?: boolean;
        searchable?: { fields: string[] };
        visible?: boolean;
        style?: string;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index
    id? url? name? label? configFile? layerManagerId? showInLayerManager? themeable? searchable? visible? style?
    id?: string

    Unique layer ID used throughout the app.

    url?: string

    Direct GeoJSON / tile URL (alternative to configFile).

    name?: string

    Internal name (legacy). Prefer label.

    label?: string

    Display label shown in the layer manager.

    configFile?: string

    Relative path to the layer's JSON config file.

    layerManagerId?: string

    Layer manager group/panel ID this layer belongs to.

    showInLayerManager?: boolean

    false keeps the layer out of the layer manager, and out of it only. Default true.

    themeable?: boolean

    false puts the layer out of the themes' reach. Default true.

    searchable?: { fields: string[] }

    Makes the layer findable by GeoLeaf.Layers.search, on its id and these fields.

    visible?: boolean

    Whether the layer is visible on startup. Default true.

    style?: string

    Active style ID applied to this layer.

    Settings
    Member Visibility

    On This Page
    Properties