This commit is contained in:
269
node_modules/ol/layer/MapboxVector.d.ts
generated
vendored
Normal file
269
node_modules/ol/layer/MapboxVector.d.ts
generated
vendored
Normal file
@@ -0,0 +1,269 @@
|
||||
export default MapboxVectorLayer;
|
||||
export type Options = {
|
||||
/**
|
||||
* The URL of the Mapbox style object to use for this layer. For a
|
||||
* style created with Mapbox Studio and hosted on Mapbox, this will look like
|
||||
* 'mapbox://styles/you/your-style'.
|
||||
*/
|
||||
styleUrl: string;
|
||||
/**
|
||||
* The access token for your Mapbox style. This has to be provided
|
||||
* for `mapbox://` style urls. For `https://` and other urls, any access key must be the last query
|
||||
* parameter of the style url.
|
||||
*/
|
||||
accessToken?: string | undefined;
|
||||
/**
|
||||
* If your style uses more than one source, you need to use either the
|
||||
* `source` property or the `layers` property to limit rendering to a single vector source. The
|
||||
* `source` property corresponds to the id of a vector source in your Mapbox style.
|
||||
*/
|
||||
source?: string | undefined;
|
||||
/**
|
||||
* Limit rendering to the list of included layers. All layers
|
||||
* must share the same vector source. If your style uses more than one source, you need to use
|
||||
* either the `source` property or the `layers` property to limit rendering to a single vector
|
||||
* source.
|
||||
*/
|
||||
layers?: string[] | undefined;
|
||||
/**
|
||||
* Declutter images and text. Decluttering is applied to all
|
||||
* image and text styles of all Vector and VectorTile layers that have set this to `true`. The priority
|
||||
* is defined by the z-index of the layer, the `zIndex` of the style and the render order of features.
|
||||
* Higher z-index means higher priority. Within the same z-index, a feature rendered before another has
|
||||
* higher priority.
|
||||
*
|
||||
* As an optimization decluttered features from layers with the same `className` are rendered above
|
||||
* the fill and stroke styles of all of those layers regardless of z-index. To opt out of this
|
||||
* behavior and place declutterd features with their own layer configure the layer with a `className`
|
||||
* other than `ol-layer`.
|
||||
*/
|
||||
declutter?: boolean | undefined;
|
||||
/**
|
||||
* Background color for the layer.
|
||||
* If not specified, the background from the Mapbox style object will be used. Set to `false` to prevent
|
||||
* the Mapbox style's background from being used.
|
||||
*/
|
||||
background?: false | import("./Base.js").BackgroundColor | undefined;
|
||||
/**
|
||||
* A CSS class name to set to the layer element.
|
||||
*/
|
||||
className?: string | undefined;
|
||||
/**
|
||||
* Opacity (0, 1).
|
||||
*/
|
||||
opacity?: number | undefined;
|
||||
/**
|
||||
* Visibility.
|
||||
*/
|
||||
visible?: boolean | undefined;
|
||||
/**
|
||||
* The bounding extent for layer rendering. The layer will not be
|
||||
* rendered outside of this extent.
|
||||
*/
|
||||
extent?: import("../extent.js").Extent | undefined;
|
||||
/**
|
||||
* The z-index for layer rendering. At rendering time, the layers
|
||||
* will be ordered, first by Z-index and then by position. When `undefined`, a `zIndex` of 0 is assumed
|
||||
* for layers that are added to the map's `layers` collection, or `Infinity` when the layer's `setMap()`
|
||||
* method was used.
|
||||
*/
|
||||
zIndex?: number | undefined;
|
||||
/**
|
||||
* The minimum resolution (inclusive) at which this layer will be
|
||||
* visible.
|
||||
*/
|
||||
minResolution?: number | undefined;
|
||||
/**
|
||||
* The maximum resolution (exclusive) below which this layer will
|
||||
* be visible. If neither `maxResolution` nor `minZoom` are defined, the layer's `maxResolution` will
|
||||
* match the style source's `minzoom`.
|
||||
*/
|
||||
maxResolution?: number | undefined;
|
||||
/**
|
||||
* The minimum view zoom level (exclusive) above which this layer will
|
||||
* be visible. If neither `maxResolution` nor `minZoom` are defined, the layer's `minZoom` will match
|
||||
* the style source's `minzoom`.
|
||||
*/
|
||||
minZoom?: number | undefined;
|
||||
/**
|
||||
* The maximum view zoom level (inclusive) at which this layer will
|
||||
* be visible.
|
||||
*/
|
||||
maxZoom?: number | undefined;
|
||||
/**
|
||||
* Render order. Function to be used when sorting
|
||||
* features before rendering. By default features are drawn in the order that they are created. Use
|
||||
* `null` to avoid the sort, but get an undefined draw order.
|
||||
*/
|
||||
renderOrder?: import("../render.js").OrderFunction | undefined;
|
||||
/**
|
||||
* The buffer in pixels around the tile extent used by the
|
||||
* renderer when getting features from the vector tile for the rendering or hit-detection.
|
||||
* Recommended value: Vector tiles are usually generated with a buffer, so this value should match
|
||||
* the largest possible buffer of the used tiles. It should be at least the size of the largest
|
||||
* point symbol or line width.
|
||||
*/
|
||||
renderBuffer?: number | undefined;
|
||||
/**
|
||||
* Render mode for vector tiles:
|
||||
* * `'hybrid'`: Polygon and line elements are rendered as images, so pixels are scaled during zoom
|
||||
* animations. Point symbols and texts are accurately rendered as vectors and can stay upright on
|
||||
* rotated views.
|
||||
* * `'vector'`: Everything is rendered as vectors. Use this mode for improved performance on vector
|
||||
* tile layers with only a few rendered features (e.g. for highlighting a subset of features of
|
||||
* another layer with the same source).
|
||||
*/
|
||||
renderMode?: any | string;
|
||||
/**
|
||||
* Sets the layer as overlay on a map. The map will not manage
|
||||
* this layer in its layers collection, and the layer will be rendered on top. This is useful for
|
||||
* temporary layers. The standard way to add a layer to a map and have it managed by the map is to
|
||||
* use {@link import ("../PluggableMap.js").default#addLayer map.addLayer()}.
|
||||
*/
|
||||
map?: import("../PluggableMap.js").default | undefined;
|
||||
/**
|
||||
* When set to `true`, feature batches will be
|
||||
* recreated during animations. This means that no vectors will be shown clipped, but the setting
|
||||
* will have a performance impact for large amounts of vector data. When set to `false`, batches
|
||||
* will be recreated when no animation is active.
|
||||
*/
|
||||
updateWhileAnimating?: boolean | undefined;
|
||||
/**
|
||||
* When set to `true`, feature batches will be
|
||||
* recreated during interactions. See also `updateWhileAnimating`.
|
||||
*/
|
||||
updateWhileInteracting?: boolean | undefined;
|
||||
/**
|
||||
* Preload. Load low-resolution tiles up to `preload` levels. `0`
|
||||
* means no preloading.
|
||||
*/
|
||||
preload?: number | undefined;
|
||||
/**
|
||||
* Use interim tiles on error.
|
||||
*/
|
||||
useInterimTilesOnError?: boolean | undefined;
|
||||
/**
|
||||
* Arbitrary observable properties. Can be accessed with `#get()` and `#set()`.
|
||||
*/
|
||||
properties?: {
|
||||
[x: string]: any;
|
||||
} | undefined;
|
||||
};
|
||||
/**
|
||||
* @typedef {Object} Options
|
||||
* @property {string} styleUrl The URL of the Mapbox style object to use for this layer. For a
|
||||
* style created with Mapbox Studio and hosted on Mapbox, this will look like
|
||||
* 'mapbox://styles/you/your-style'.
|
||||
* @property {string} [accessToken] The access token for your Mapbox style. This has to be provided
|
||||
* for `mapbox://` style urls. For `https://` and other urls, any access key must be the last query
|
||||
* parameter of the style url.
|
||||
* @property {string} [source] If your style uses more than one source, you need to use either the
|
||||
* `source` property or the `layers` property to limit rendering to a single vector source. The
|
||||
* `source` property corresponds to the id of a vector source in your Mapbox style.
|
||||
* @property {Array<string>} [layers] Limit rendering to the list of included layers. All layers
|
||||
* must share the same vector source. If your style uses more than one source, you need to use
|
||||
* either the `source` property or the `layers` property to limit rendering to a single vector
|
||||
* source.
|
||||
* @property {boolean} [declutter=true] Declutter images and text. Decluttering is applied to all
|
||||
* image and text styles of all Vector and VectorTile layers that have set this to `true`. The priority
|
||||
* is defined by the z-index of the layer, the `zIndex` of the style and the render order of features.
|
||||
* Higher z-index means higher priority. Within the same z-index, a feature rendered before another has
|
||||
* higher priority.
|
||||
*
|
||||
* As an optimization decluttered features from layers with the same `className` are rendered above
|
||||
* the fill and stroke styles of all of those layers regardless of z-index. To opt out of this
|
||||
* behavior and place declutterd features with their own layer configure the layer with a `className`
|
||||
* other than `ol-layer`.
|
||||
* @property {import("./Base.js").BackgroundColor|false} [background] Background color for the layer.
|
||||
* If not specified, the background from the Mapbox style object will be used. Set to `false` to prevent
|
||||
* the Mapbox style's background from being used.
|
||||
* @property {string} [className='ol-layer'] A CSS class name to set to the layer element.
|
||||
* @property {number} [opacity=1] Opacity (0, 1).
|
||||
* @property {boolean} [visible=true] Visibility.
|
||||
* @property {import("../extent.js").Extent} [extent] The bounding extent for layer rendering. The layer will not be
|
||||
* rendered outside of this extent.
|
||||
* @property {number} [zIndex] The z-index for layer rendering. At rendering time, the layers
|
||||
* will be ordered, first by Z-index and then by position. When `undefined`, a `zIndex` of 0 is assumed
|
||||
* for layers that are added to the map's `layers` collection, or `Infinity` when the layer's `setMap()`
|
||||
* method was used.
|
||||
* @property {number} [minResolution] The minimum resolution (inclusive) at which this layer will be
|
||||
* visible.
|
||||
* @property {number} [maxResolution] The maximum resolution (exclusive) below which this layer will
|
||||
* be visible. If neither `maxResolution` nor `minZoom` are defined, the layer's `maxResolution` will
|
||||
* match the style source's `minzoom`.
|
||||
* @property {number} [minZoom] The minimum view zoom level (exclusive) above which this layer will
|
||||
* be visible. If neither `maxResolution` nor `minZoom` are defined, the layer's `minZoom` will match
|
||||
* the style source's `minzoom`.
|
||||
* @property {number} [maxZoom] The maximum view zoom level (inclusive) at which this layer will
|
||||
* be visible.
|
||||
* @property {import("../render.js").OrderFunction} [renderOrder] Render order. Function to be used when sorting
|
||||
* features before rendering. By default features are drawn in the order that they are created. Use
|
||||
* `null` to avoid the sort, but get an undefined draw order.
|
||||
* @property {number} [renderBuffer=100] The buffer in pixels around the tile extent used by the
|
||||
* renderer when getting features from the vector tile for the rendering or hit-detection.
|
||||
* Recommended value: Vector tiles are usually generated with a buffer, so this value should match
|
||||
* the largest possible buffer of the used tiles. It should be at least the size of the largest
|
||||
* point symbol or line width.
|
||||
* @property {import("./VectorTileRenderType.js").default|string} [renderMode='hybrid'] Render mode for vector tiles:
|
||||
* * `'hybrid'`: Polygon and line elements are rendered as images, so pixels are scaled during zoom
|
||||
* animations. Point symbols and texts are accurately rendered as vectors and can stay upright on
|
||||
* rotated views.
|
||||
* * `'vector'`: Everything is rendered as vectors. Use this mode for improved performance on vector
|
||||
* tile layers with only a few rendered features (e.g. for highlighting a subset of features of
|
||||
* another layer with the same source).
|
||||
* @property {import("../PluggableMap.js").default} [map] Sets the layer as overlay on a map. The map will not manage
|
||||
* this layer in its layers collection, and the layer will be rendered on top. This is useful for
|
||||
* temporary layers. The standard way to add a layer to a map and have it managed by the map is to
|
||||
* use {@link import("../PluggableMap.js").default#addLayer map.addLayer()}.
|
||||
* @property {boolean} [updateWhileAnimating=false] When set to `true`, feature batches will be
|
||||
* recreated during animations. This means that no vectors will be shown clipped, but the setting
|
||||
* will have a performance impact for large amounts of vector data. When set to `false`, batches
|
||||
* will be recreated when no animation is active.
|
||||
* @property {boolean} [updateWhileInteracting=false] When set to `true`, feature batches will be
|
||||
* recreated during interactions. See also `updateWhileAnimating`.
|
||||
* @property {number} [preload=0] Preload. Load low-resolution tiles up to `preload` levels. `0`
|
||||
* means no preloading.
|
||||
* @property {boolean} [useInterimTilesOnError=true] Use interim tiles on error.
|
||||
* @property {Object<string, *>} [properties] Arbitrary observable properties. Can be accessed with `#get()` and `#set()`.
|
||||
*/
|
||||
/**
|
||||
* @classdesc
|
||||
* A vector tile layer based on a Mapbox style that uses a single vector source. Configure
|
||||
* the layer with the `styleUrl` and `accessToken` shown in Mapbox Studio's share panel.
|
||||
* If the style uses more than one source, use the `source` property to choose a single
|
||||
* vector source. If you want to render a subset of the layers in the style, use the `layers`
|
||||
* property (all layers must share the same vector source). See the constructor options for
|
||||
* more detail.
|
||||
*
|
||||
* var map = new Map({
|
||||
* view: new View({
|
||||
* center: [0, 0],
|
||||
* zoom: 1
|
||||
* }),
|
||||
* layers: [
|
||||
* new MapboxVectorLayer({
|
||||
* styleUrl: 'mapbox://styles/mapbox/bright-v9',
|
||||
* accessToken: 'your-mapbox-access-token-here'
|
||||
* })
|
||||
* ],
|
||||
* target: 'map'
|
||||
* });
|
||||
*
|
||||
* On configuration or loading error, the layer will trigger an `'error'` event. Listeners
|
||||
* will receive an object with an `error` property that can be used to diagnose the problem.
|
||||
*
|
||||
* @param {Options} options Options.
|
||||
* @extends {VectorTileLayer}
|
||||
* @fires module:ol/events/Event~BaseEvent#event:error
|
||||
* @api
|
||||
*/
|
||||
declare class MapboxVectorLayer extends VectorTileLayer {
|
||||
/**
|
||||
* @param {Options} options Layer options. At a minimum, `styleUrl` and `accessToken`
|
||||
* must be provided.
|
||||
*/
|
||||
constructor(options: Options);
|
||||
accessToken: string | undefined;
|
||||
}
|
||||
import VectorTileLayer from "../layer/VectorTile.js";
|
||||
//# sourceMappingURL=MapboxVector.d.ts.map
|
||||
Reference in New Issue
Block a user