Open Pioneer Trails Packages
    Preparing search index...

    Interface RecursiveRetrievalOptions

    These options can be used when recursively retrieving layers from a collection.

    interface RecursiveRetrievalOptions {
        filter?: (layer: AnyLayer) => boolean;
        includeInternalLayers?: boolean;
        sortByDisplayOrder?: boolean;
    }

    Hierarchy (View Summary)

    Index

    Properties

    filter? includeInternalLayers? sortByDisplayOrder?

    Properties

    filter?: (layer: AnyLayer) => boolean

    Optional filter function to determine whether a layer should be included in the result. Return false to exclude a layer (and all its children) from the result.

    includeInternalLayers?: boolean

    If set to true internal layers (myLayer.internal === true) are included in the returned array of layers. This includes system layer as well, such as the layer for highlights or geolocation, which were not explicitly added to the map.

    By default, internal layers are not returned.

    sortByDisplayOrder?: boolean

    If set to true, layers will be ordered by their display order: Layers listed first in the returned array are shown below layers listed at a later index.

    By default, layers are returned in arbitrary order.

    Settings

    Member Visibility

    On This Page

    Properties