Whether the datasource should have a ground plane (this plane covers the tile entirely and has the minimum possible renderOrder), this can be required in some cases when fallback parent tiles need to be covered by the children, otherwise the content will overlap. Default is false
Set to true if the MapView can cache tiles produced by this DataSource.
Overrides the default rendering order of this DataSource.
When dataSourceOrder is defined, all the objects created by this DataSource
will be rendered on top of the objects created by other DataSources with
lower dataSourceOrder values.
undefined
Set to true if this DataSource is enabled; false otherwise.
Protected Optional languagesAn array of ISO 639-1 language codes.
The maximum zoom level at which data is available.
The maximum zoom level at which DataSource is displayed.
The minimum zoom level at which data is available.
The minimum zoom level at which DataSource is displayed.
The unique name of a DataSource instance.
Set to true if the loader should be used to get the tile contents.
Maximum geometry height above ground level this DataSource can produce.
Used in first stage of frustum culling before Tile.maxGeometryHeight data is available.
0.
The maximum zoom level at which data is available or displayed at (depending on DataSource subclass).
Use [[maxDataLevel]] and [[maxDisplayLevel]] instead.
Minimum geometry height below ground level this DataSource can produce. A negative number
specifies a value below ground level.
Used in first stage of frustum culling before Tile.minGeometryHeight data is available.
0.
The minimum zoom level at which data is available or displayed at (depending on DataSource subclass).
Use [[minDataLevel]] and [[minDisplayLevel]] instead.
The @xyzmaps/harp-geoutils#Projection used by
the MapView that is holding this DataSource.
An Error is thrown if you call this method
before this DataSource has been added
to a MapView.
The difference between storage level and display level of tile.
Storage level offset is a value applied (added) to current zoom level giving a final tile level being displayed. This way we may differentiate current zoom level from the storage level that is displayed, giving fine grained control over the tiles being decoded an displayed.
Setup the relative offset between storage level and display level of tile.
Difference between zoom level and display level.
Returns the name of the [[StyleSet]] to use for the decoding.
Sets the name of the [[StyleSet]] to use for the decoding. If this DataSource is already attached to a MapView, this setter then reapplies [[StyleSet]] with this name found in MapViews theme.
This method is called when this DataSource is added to a MapView.
Overrides of this method must invoke the definition of the super class.
Clears the state of all the features of this DataSource.
This method is called when the DataSource is added to a MapView. Override this
method to provide any custom initialization, such as, to establish a network connection,
or to initialize complex data structures.
This method is called when this DataSource is removed from a MapView.
Overrides of this method must invoke the definition of the super class.
Computes the data zoom level to use.
The zoom level of the MapView.
The data zoom level to use.
Boolean which says whether a DataSource produces tiles that fully cover the tile, i.e. tiles underneath are completely hidden. Must be overridden for DataSource's that don't have a ground plane, but which still fully cover the tile, e.g. web tiles.
Returns true if DataSource should be displayed for the zoom level.
The zoom level of the MapView.
Returns true if this DataSource is ready
and the MapView can invoke getTile() to
start requesting data.
Sends a request to the MapView to redraw the scene.
Sets the state of the given feature id.
dataSource.setFeatureState(featureId, { enabled: true });
The id of the feature. Id numbers are deprecated in favor of strings.
The new state of the feature.
Used to express different country point of view (political view).
Optional pov: stringThe country code which point of view should be presented in lower-case ISO 3166-1 alpha-2 format.
Set to undefined (or empty string) if you want to reset to default point of view.
Returns true if MapView should render the text
elements with the given @xyzmaps/harp-geoutils#TileKey and
zoom level.
The zoom level.
The unique identifier for a map tile.
true if the text elements created for the
given @xyzmaps/harp-geoutils#TileKey should be rendered.
This is an additional check for the tiles that are already selected for rendering so the
default implementation returns true.
This method is called by MapView before the tile needs to be updated, for example after a theme change.
Generated using TypeDoc
DataSource providing geometry for poles