Interface PolarTileDataSourceOptions

Options for a DataSource.

Hierarchy

Properties

allowOverlappingTiles?: boolean

Whether the datasource can overlap tiles. Such overlapping is necessary when zooming out and waiting for the tiles to load, in this case, we use cached tiles to fill the missing gaps if available (and in some cases, the tiles can overlap, i.e. for example when a child is next to a parent, the parent is rendered beneath the child), however for some datasources (those that produce transparent tiles for example), this gives bad results, and as such, it should be disabled to reduce flickering. Another way to put it is that loading tiles are replaced with cached tiles and we then fall (back/forward) to the next appropriate zoom level.

Default

true
dataSourceOrder?: number

Number used to order [DataSource]'s relative to each other, see dataSourceOrder

debugTiles?: boolean

Enable debug display for generated tiles. Default is false.

enablePicking?: boolean

Whether features from these data source can picked by calling intersectMapObjects. Disabling picking for data sources that don't need it will improve picking performance.

Default

true
geometryLevelOffset?: number

Optional level offset of regular tiles from reference datasource to align tiles to. Default is -1.

languages?: string[]

Used to configure the languages used by the DataSource according to priority; the first language in the array has the highest priority.

An array of ISO 639-1 language codes.

maxDataLevel?: number

The maximum zoom level at which data is available.

maxDisplayLevel?: number

The maximum zoom level at which DataSource is displayed.

maxGeometryHeight?: number

Maximum geometry height above ground level this DataSource can produce.

Remarks

Used in first stage of frustum culling before Tile#maxGeometryHeight data is available.

Default

[[EarthConstants.MAX_BUILDING_HEIGHT]].
maxZoomLevel?: number

The maximum zoom level at which data is available or displayed at (depending on DataSource subclass).

Deprecated

Use [[maxDataLevel]] and [[maxDisplayLevel]] instead.

minDataLevel?: number

The minimum zoom level at which data is available.

minDisplayLevel?: number

The minimum zoom level at which DataSource is displayed.

minGeometryHeight?: number

Minimum geometry height below ground level this DataSource can produce. Negative values describe height below ground.

Remarks

Used in first stage of frustum culling before Tile#minGeometryHeight data is available.

Default

0.

minZoomLevel?: number

The minimum zoom level at which data is available or displayed at (depending on DataSource subclass).

Deprecated

Use [[minDataLevel]] and [[minDisplayLevel]] instead.

name?: string

The unique name of a DataSource instance.

storageLevelOffset?: number

Storage level offset applied to this DataSource.

styleSetName?: string

The name of the [[StyleSet]] to evaluate for the decoding.

Generated using TypeDoc