Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FeatureDataSourceOptions

Options for FeaturesDataSource.

Hierarchy

Index

Properties

Optional addGroundPlane

addGroundPlane: undefined | false | true

Indicates whether to add a ground plane to cover the tile completely.

remarks

This is necessary for the fallback logic, such that the parent fall back tiles don't overlap the children tiles. Default is true (i.e. if not defined it is taken to be true)

Optional allowOverlappingTiles

allowOverlappingTiles: undefined | false | true

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

Optional createTileInfo

createTileInfo: undefined | false | true
deprecated

Tile info is not decoded anymore. The same information can be generated implementing a IGeometryProcessor and using [[OmvProtobufDataAdapter]] to decode OMV data.

Optional dataProvider

dataProvider: DataProvider

Optionally specify the DataProvider that should be used.

Optional dataSourceOrder

dataSourceOrder: undefined | number

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

Optional enableElevationOverlay

enableElevationOverlay: undefined | false | true

Indicates whether overlay on elevation is enabled. Defaults to false.

Optional enablePicking

enablePicking: undefined | false | true

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

default

true

Optional featureModifierId

featureModifierId: FeatureModifierId

Identifier used to choose OmvFeatureModifiers to be applied.

remarks

If left undefined at least OmvGenericFeatureModifier will be applied. The list of feature modifiers may be extended internally by some data source options such as politicalView which adds [[OmvPoliticalViewFeatureModifier]].

note

This parameter gets applied to the decoder used in the VectorTileDataSource which might be shared between various VectorTileDataSources.

Optional features

features: MapViewFeature[]

Initial set of features for new instance of FeaturesDataSource.

Shortcut for calling FeaturesDataSource.add after construction.

Optional filterDescr

filterDescr: OmvFeatureFilterDescription

A description for the feature filter that can be safely passed down to the web workers.

remarks

It has to be generated with the help of the OmvFeatureFilterDescriptionBuilder (to guarantee correctness). This parameter gets applied to the decoder used in the VectorTileDataSource which might be shared between various VectorTileDataSources.

Optional gatherFeatureAttributes

gatherFeatureAttributes: undefined | false | true

Gather feature attributes from OmvData. Defaults to false.

Optional gatherFeatureIds

gatherFeatureIds: undefined | false | true

Gather feature IDs from OmvData. Defaults to false.

deprecated

FeatureIds are always gathered, use gatherFeatureAttributes to gather all feature attributes.

Optional gatherRoadSegments

gatherRoadSegments: undefined | false | true
deprecated

Tile info is not decoded anymore. The same information can be generated implementing a IGeometryProcessor and using [[OmvProtobufDataAdapter]] to decode OMV data.

Optional geojson

Initial GeoJSON load for new instance of FeaturesDataSource.

Shortcut for calling FeaturesDataSource.setFromGeojson after construction.

Optional languages

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.

Optional maxDataLevel

maxDataLevel: undefined | number

The maximum zoom level at which data is available.

Optional maxDisplayLevel

maxDisplayLevel: undefined | number

The maximum zoom level at which DataSource is displayed.

Optional maxGeometryHeight

maxGeometryHeight: undefined | number

Maximum geometry height above ground level this DataSource can produce.

remarks

Used in first stage of frustum culling before {@link Tile#maxGeometryHeight} data is available.

default

EarthConstants.MAX_BUILDING_HEIGHT.

Optional maxZoomLevel

maxZoomLevel: undefined | number

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

deprecated

Use maxDataLevel and maxDisplayLevel instead.

Optional minDataLevel

minDataLevel: undefined | number

The minimum zoom level at which data is available.

Optional minDisplayLevel

minDisplayLevel: undefined | number

The minimum zoom level at which DataSource is displayed.

Optional minGeometryHeight

minGeometryHeight: undefined | 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 {@link Tile#minGeometryHeight} data is available.

default

0.

Optional minZoomLevel

minZoomLevel: undefined | number

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

deprecated

Use minDataLevel and minDisplayLevel instead.

Optional name

name: undefined | string

The unique name of a DataSource instance.

Optional politicalView

politicalView: undefined | string

Expresses specific country point of view that is used when rendering disputed features, like borders, names, etc. If undefined "defacto" or most widely accepted political view will be presented.

see

featureModifiers

Optional roundUpCoordinatesIfNeeded

roundUpCoordinatesIfNeeded: undefined | false | true

Indicates whether the decoder is allowed to adjust the coordinates to avoid possible glitches at the 180th meridian.

defaultvalue

true if the data service is https://vector.hereapi.com/v2/vectortiles/base/mc, false otherwise.

Optional showMissingTechniques

showMissingTechniques: undefined | false | true

If set to true, features that have no technique in the theme will be printed to the console (can be excessive!).

Optional skipShortLabels

skipShortLabels: undefined | false | true

If not set to false, very short text labels will be skipped during decoding based on a heuristic.

Optional storageLevelOffset

storageLevelOffset: undefined | number

Storage level offset applied to this DataSource.

Optional styleSetName

styleSetName: undefined | string

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

Optional tileFactory

tileFactory: TileFactory<Tile>

Optional, custom factory for {@link @here/harp-mapview#Tile} instances created by this VectorTileDataSource.

Optional tiler

tiler: ITiler

Custom tiler instance.

remarks

If not provided, GeoJsonDataProvider will obtain WorkerBasedTiler from ConcurrentTilerFacade.

Optional workerConnectionTimeout

workerConnectionTimeout: undefined | number

Timeout for connecting to the web worker in seconds. Default to 10s, search for: DEFAULT_WORKER_INITIALIZATION_TIMEOUT

Optional workerTilerUrl

workerTilerUrl: undefined | string

Worker script hosting Tiler service.

default

./decoder.bundle.ts

Generated using TypeDoc