import { AnyLayer } from "../unions";
/**
 * These options can be used by some APIs returning an array of layers (or sublayers).
 *
 * @group Layer Utilities
 **/
export interface LayerRetrievalOptions {
    /**
     * 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.
     */
    sortByDisplayOrder?: 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.
     */
    includeInternalLayers?: boolean;
}
/**
 * These options can be used when recursively retrieving layers from a collection.
 *
 * @group Layer Utilities
 **/
export interface RecursiveRetrievalOptions extends LayerRetrievalOptions {
    /**
     * 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.
     */
    filter?: (layer: AnyLayer) => boolean;
}