Leaflet.Control.Layers.Tree/LayersTree.d.ts at master · jjimenezshaw/Leaflet.Control.Layers.Tree · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
import * as L from 'leaflet';

export interface TreeObject {
    children?: TreeObject[];
    collapsed?: boolean;
    label: string;
    layer?: L.Layer;
    name?: string;
    selectAllCheckbox?: boolean | string;
}

export interface TreeOptions extends L.Control.LayersOptions {
    /**
    * Symbol displayed on a closed node.
    * @default '+'
    */
    closedSymbol?: string;

    /**
    * Symbol displayed on an open node.
    * @default '−' (&minus;)
    */
    openedSymbol?: string;

    /**
    * Symbol between the closed or opened symbol, and the text.
    * @default ' ' (a normal space)
    */
    spaceSymbol?: string;

    /**
    * Flag to indicate if the selector (+ or −) is after the text.
    * @default false
    */
    selectorBack?: boolean;

    /**
    * Flag to replace the toggle image (box with the layers image)
    * with the 'name' of the selected base layer.
    * If the name field is not present in the tree for this layer,
    * label is used.
    * See that you can show a different name when control is
    * collapsed than the one that appears in the tree
    * when it is expanded. Your node in the tree can be
    * { label: 'OSM', name: 'OpenStreetMap', layer: layer }.
    * @default false
    */
    namedToggle?: boolean;

    /**
    * Text for an entry in control that collapses the tree
    * (baselayers or overlays).
    * If empty, no entry is created.
    * @default ''.
    */
    collapseAll?: string;

    /**
    * Text for an entry in control that expands the tree.
    * If empty, no entry is created.
    * @default ''
    */
    expandAll?: string;

    /**
    * Controls if a label or only the checkbox/radio button can
    * toggle layers.
    * If set to both, overlay or base those labels can be clicked on
    * to toggle the layer.
    * @default 'both'.
    */
    labelIsSelector?: 'both' | 'overlay' | 'base' | string;
}

export class LayersTree extends L.Control.Layers {
    constructor(
        baseTree?: TreeObject,
        overlayTree?: TreeObject,
        options?: TreeOptions
    );

    setBaseTree(baseTree: TreeObject): this;

    setOverlayTree(overlayTree: TreeObject): this;

    addBaseLayer(layer: L.Layer, name: string): never;

    addOverlay(layer: L.Layer, name: string): never;

    removeLayer(layer: L.Layer): never;

    expandTree(isOverlay?: boolean): this;

    collapseTree(isOverlay?: boolean): this;

    expandSelected(isOverlay?: boolean): this;

    options: TreeOptions;
}