Interface LayersOptions

interface LayersOptions {
    autoZIndex?: boolean;
    collapsed?: boolean;
    hideSingleBase?: boolean;
    position?: ControlPosition;
    sortFunction?: (
        layerA: Layer,
        layerB: Layer,
        nameA: string,
        nameB: string,
    ) => number;
    sortLayers?: boolean;
}

Hierarchy (View Summary)

Properties

autoZIndex? collapsed? hideSingleBase? position? sortFunction? sortLayers?

Properties

OptionalautoZIndex

autoZIndex?: boolean

Optionalcollapsed

collapsed?: boolean

OptionalhideSingleBase

hideSingleBase?: boolean

Optionalposition

position?: ControlPosition

OptionalsortFunction

sortFunction?: (
    layerA: Layer,
    layerB: Layer,
    nameA: string,
    nameB: string,
) => number

A compare function that will be used for sorting the layers, when sortLayers is true. The function receives both the L.Layer instances and their names, as in sortFunction(layerA, layerB, nameA, nameB). By default, it sorts layers alphabetically by their name.

OptionalsortLayers

sortLayers?: boolean

Whether to sort the layers. When false, layers will keep the order in which they were added to the control.

Settings

Member Visibility

On This Page

Properties