BackgroundDataSource

Provides background geometry for all tiles.

Hierarchy

DataSource
- BackgroundDataSource

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new BackgroundDataSource(): BackgroundDataSource

Overrides DataSource.constructor
- Defined in @here/harp-mapview/lib/BackgroundDataSource.ts:20
Returns BackgroundDataSource

Properties

addGroundPlane

addGroundPlane: boolean = false

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

allowOverlappingTiles

allowOverlappingTiles: boolean = true

cacheable

cacheable: boolean = false

Set to true if the MapView can cache tiles produced by this DataSource.

dataSourceOrder

dataSourceOrder: number = 0

Overrides the default rendering order of this DataSource.

remarks: 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.
defaultvalue: undefined

enablePicking

enablePicking: boolean = true

enabled

enabled: boolean = true

Set to true if this DataSource is enabled; false otherwise.

Protected Optional languages

languages: string[]

An array of ISO 639-1 language codes.

maxDataLevel

maxDataLevel: number = 20

The maximum zoom level at which data is available.

maxDisplayLevel

maxDisplayLevel: number = 20

The maximum zoom level at which DataSource is displayed.

minDataLevel

minDataLevel: number = 1

The minimum zoom level at which data is available.

minDisplayLevel

minDisplayLevel: number = 1

The minimum zoom level at which DataSource is displayed.

name

name: string

The unique name of a DataSource instance.

useGeometryLoader

useGeometryLoader: boolean = false

Set to true if the loader should be used to get the tile contents.

Static Readonly GROUND_RENDER_ORDER

GROUND_RENDER_ORDER: number = Number.MIN_SAFE_INTEGER

Accessors

mapView

get mapView(): MapView

Inherited from BackgroundDataSource.mapView
- Defined in @here/harp-mapview/lib/DataSource.ts:409
The MapView that is holding this DataSource.

Returns MapView

maxGeometryHeight

get maxGeometryHeight(): number
set maxGeometryHeight(value: number): void

Inherited from BackgroundDataSource.maxGeometryHeight
- Defined in @here/harp-mapview/lib/DataSource.ts:599
Maximum geometry height above ground level this DataSource can produce.

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

default

0.

Returns number
Inherited from BackgroundDataSource.maxGeometryHeight
- Defined in @here/harp-mapview/lib/DataSource.ts:603
Maximum geometry height above ground level this DataSource can produce.

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

default

0.

Parameters
- value: number
Returns void

maxZoomLevel

get maxZoomLevel(): number
set maxZoomLevel(level: number): void

Inherited from BackgroundDataSource.maxZoomLevel
- Defined in @here/harp-mapview/lib/DataSource.ts:577
The maximum zoom level at which data is available or displayed at (depending on DataSource subclass).

deprecated

Use maxDataLevel and maxDisplayLevel instead.

Returns number
Inherited from BackgroundDataSource.maxZoomLevel
- Defined in @here/harp-mapview/lib/DataSource.ts:584
The maximum zoom level at which data is available or displayed at (depending on DataSource subclass).

deprecated

Use maxDataLevel and maxDisplayLevel instead.

Parameters
- level: number
Returns void

minGeometryHeight

get minGeometryHeight(): number
set minGeometryHeight(value: number): void

Inherited from BackgroundDataSource.minGeometryHeight
- Defined in @here/harp-mapview/lib/DataSource.ts:616
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 {@link Tile.minGeometryHeight} data is available.

default

0.

Returns number
Inherited from BackgroundDataSource.minGeometryHeight
- Defined in @here/harp-mapview/lib/DataSource.ts:620
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 {@link Tile.minGeometryHeight} data is available.

default

0.

Parameters
- value: number
Returns void

minZoomLevel

get minZoomLevel(): number
set minZoomLevel(level: number): void

Inherited from BackgroundDataSource.minZoomLevel
- Defined in @here/harp-mapview/lib/DataSource.ts:558
The minimum zoom level at which data is available or displayed at (depending on DataSource subclass).

deprecated

Use minDataLevel and minDisplayLevel instead.

Returns number
Inherited from BackgroundDataSource.minZoomLevel
- Defined in @here/harp-mapview/lib/DataSource.ts:565
The minimum zoom level at which data is available or displayed at (depending on DataSource subclass).

deprecated

Use minDataLevel and minDisplayLevel instead.

Parameters
- level: number
Returns void

projection

get projection(): Projection

Inherited from BackgroundDataSource.projection
- Defined in @here/harp-mapview/lib/DataSource.ts:425
The {@link @here/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.

Returns Projection

storageLevelOffset

get storageLevelOffset(): number
set storageLevelOffset(levelOffset: number): void

Inherited from BackgroundDataSource.storageLevelOffset
- Defined in @here/harp-mapview/lib/DataSource.ts:632
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.

Returns number
Inherited from BackgroundDataSource.storageLevelOffset
- Defined in @here/harp-mapview/lib/DataSource.ts:641
Setup the relative offset 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.

Parameters
- levelOffset: number
  
  Difference between zoom level and display level.
Returns void

styleSetName

get styleSetName(): string | undefined
set styleSetName(styleSetName: string | undefined): void

Inherited from BackgroundDataSource.styleSetName
- Defined in @here/harp-mapview/lib/DataSource.ts:352
Returns the name of the [[StyleSet]] to use for the decoding.

Returns string | undefined
Inherited from BackgroundDataSource.styleSetName
- Defined in @here/harp-mapview/lib/DataSource.ts:363
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.

Parameters
- styleSetName: string | undefined
Returns void

Methods

addEventListener

addEventListener(type: string, listener: (event: Event) => void): void

Inherited from RawShaderMaterial.addEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:26
Adds a listener to an event type.

Parameters
- type: string
  
  The type of event to listen to.
- listener: (event: Event) => void
  
  The function that gets called when the event is fired.
  - - (event: Event): void
    - Parameters
      - event: Event
      Returns void
Returns void

attach

attach(mapView: MapView): void

Inherited from BackgroundDataSource.attach
- Defined in @here/harp-mapview/lib/DataSource.ts:450
This method is called when this DataSource is added to a MapView.

Overrides of this method must invoke the definition of the super class.

Parameters
- mapView: MapView
  
  The instance of the MapView.
Returns void

canGetTile

canGetTile(zoomLevel: number, tileKey: TileKey): boolean

Inherited from BackgroundDataSource.canGetTile
- Defined in @here/harp-mapview/lib/DataSource.ts:685
Returns true if DataSource can load tile with given {@link @here/harp-geoutils#TileKey} and zoom level.

Parameters
- zoomLevel: number
  
  The zoom level of the MapView.
- tileKey: TileKey
  
  The unique identifier for a map tile.
Returns boolean

true if the tile for the given {@link @here/harp-geoutils#TileKey} can be loaded.

clearCache

clearCache(): void

Inherited from BackgroundDataSource.clearCache
- Defined in @here/harp-mapview/lib/DataSource.ts:381
Purges all the caching done by this DataSource

Returns void

clearFeatureState

clearFeatureState(): void

Inherited from BackgroundDataSource.clearFeatureState
- Defined in @here/harp-mapview/lib/DataSource.ts:322
Clears the state of all the features of this DataSource.

Returns void

connect

connect(): Promise<void>

Inherited from BackgroundDataSource.connect
- Defined in @here/harp-mapview/lib/DataSource.ts:434
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.

Returns Promise<void>

detach

detach(mapView: MapView): void

Inherited from BackgroundDataSource.detach
- Defined in @here/harp-mapview/lib/DataSource.ts:461
This method is called when this DataSource is removed from a MapView.

Overrides of this method must invoke the definition of the super class.

Parameters
- mapView: MapView
  
  The instance of the MapView.
Returns void

dispatchEvent

dispatchEvent(event: { type: string }): void

Inherited from RawShaderMaterial.dispatchEvent
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:46
Fire an event type.

Parameters
- event: { type: string }
  - [attachment: string]: any
  - type: string
Returns void

dispose

dispose(): void

Inherited from BackgroundDataSource.dispose
- Defined in @here/harp-mapview/lib/DataSource.ts:374
Destroys this DataSource.

Returns void

getDataZoomLevel

getDataZoomLevel(zoomLevel: number): number

Inherited from BackgroundDataSource.getDataZoomLevel
- Defined in @here/harp-mapview/lib/DataSource.ts:661
Computes the data zoom level to use.

Parameters
- zoomLevel: number
  
  The zoom level of the MapView.
Returns number

The data zoom level to use.

getFeatureState

getFeatureState(featureId: number | string): ValueMap | undefined

Inherited from BackgroundDataSource.getFeatureState
- Defined in @here/harp-mapview/lib/DataSource.ts:315
Gets the state of the given feature id.

Parameters
- featureId: number | string
  
  The id of the feature. Id numbers are deprecated in favor of strings.
Returns ValueMap | undefined

getTile

getTile(tileKey: TileKey): Tile | undefined

Overrides DataSource.getTile
- Defined in @here/harp-mapview/lib/BackgroundDataSource.ts:77
override

Parameters
- tileKey: TileKey
Returns Tile | undefined

getTilingScheme

getTilingScheme(): TilingScheme

Overrides DataSource.getTilingScheme
- Defined in @here/harp-mapview/lib/BackgroundDataSource.ts:72
override

Returns TilingScheme

hasEventListener

hasEventListener(type: string, listener: (event: Event) => void): boolean

Inherited from RawShaderMaterial.hasEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:33
Checks if listener is added to an event type.

Parameters
- type: string
  
  The type of event to listen to.
- listener: (event: Event) => void
  
  The function that gets called when the event is fired.
  - - (event: Event): void
    - Parameters
      - event: Event
      Returns void
Returns boolean

isDetached

isDetached(): boolean

Inherited from BackgroundDataSource.isDetached
- Defined in @here/harp-mapview/lib/DataSource.ts:470
Returns boolean

Whether this DataSource is detached from the MapView

isFullyCovering

isFullyCovering(): boolean

Inherited from BackgroundDataSource.isFullyCovering
- Defined in @here/harp-mapview/lib/DataSource.ts:393
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 boolean

isVisible

isVisible(zoomLevel: number): boolean

Inherited from BackgroundDataSource.isVisible
- Defined in @here/harp-mapview/lib/DataSource.ts:673
Returns true if DataSource should be displayed for the zoom level.

Parameters
- zoomLevel: number
  
  The zoom level of the MapView.
Returns boolean

ready

ready(): boolean

Inherited from BackgroundDataSource.ready
- Defined in @here/harp-mapview/lib/DataSource.ts:402
Returns true if this DataSource is ready and the MapView can invoke getTile() to start requesting data.

Returns boolean

removeEventListener

removeEventListener(type: string, listener: (event: Event) => void): void

Inherited from RawShaderMaterial.removeEventListener
- Defined in node_modules/@types/three/src/core/EventDispatcher.d.ts:40
Removes a listener from an event type.

Parameters
- type: string
  
  The type of the listener that gets removed.
- listener: (event: Event) => void
  
  The listener function that gets removed.
  - - (event: Event): void
    - Parameters
      - event: Event
      Returns void
Returns void

removeFeatureState

removeFeatureState(featureId: number | string): void

Inherited from BackgroundDataSource.removeFeatureState
- Defined in @here/harp-mapview/lib/DataSource.ts:345
Removes the state associated to the given feature.

Parameters
- featureId: number | string
  
  The id of the feature. Id numbers are deprecated in favor of strings.
Returns void

requestUpdate

requestUpdate(): void

Inherited from BackgroundDataSource.requestUpdate
- Defined in @here/harp-mapview/lib/DataSource.ts:724
Sends a request to the MapView to redraw the scene.

Returns void

setEnableElevationOverlay

setEnableElevationOverlay(enable: boolean): void

Inherited from BackgroundDataSource.setEnableElevationOverlay
- Defined in @here/harp-mapview/lib/DataSource.ts:651
Enables or disables overlay of geometry on elevation. It must be overloaded by data sources supporting this feature.

Parameters
- enable: boolean
Returns void

setFeatureState

setFeatureState(featureId: number | string, state: ValueMap): void

Inherited from BackgroundDataSource.setFeatureState
- Defined in @here/harp-mapview/lib/DataSource.ts:336
Sets the state of the given feature id.
```
dataSource.setFeatureState(featureId, { enabled: true });
```
Parameters
- featureId: number | string
  
  The id of the feature. Id numbers are deprecated in favor of strings.
- state: ValueMap
  
  The new state of the feature.
Returns void

setLanguages

setLanguages(languages?: string[]): void

Inherited from BackgroundDataSource.setLanguages
- Defined in @here/harp-mapview/lib/DataSource.ts:505
Used to configure the languages used by the DataSource according to priority; the first language in the array has the highest priority.

Parameters
- Optional languages: string[]
  
  An array of ISO 639-1 language codes.
Returns void

setPoliticalView

setPoliticalView(pov?: undefined | string): void

Inherited from BackgroundDataSource.setPoliticalView
- Defined in @here/harp-mapview/lib/DataSource.ts:517
Used to express different country point of view (political view).

note

Set to undefined (or empty string) if you want to reset to default point of view.

Parameters
- Optional pov: undefined | string
  
  The country code which point of view should be presented in lower-case ISO 3166-1 alpha-2 format.
Returns void

setTheme

setTheme(theme: Theme, languages?: string[]): Promise<void>

Overrides DataSource.setTheme
- Defined in @here/harp-mapview/lib/BackgroundDataSource.ts:56
override

Parameters
- theme: Theme
- Optional languages: string[]
Returns Promise<void>

setTilingScheme

setTilingScheme(tilingScheme?: TilingScheme): void

- Defined in @here/harp-mapview/lib/BackgroundDataSource.ts:60
Parameters
- Optional tilingScheme: TilingScheme
Returns void

shouldPreloadTiles

shouldPreloadTiles(): boolean

Inherited from BackgroundDataSource.shouldPreloadTiles
- Defined in @here/harp-mapview/lib/DataSource.ts:549
This method is called by the MapView to determine if the content of the surrounding tiles must be preloaded.

Returns boolean

true if the MapView should try to preload tiles surrounding the visible tiles; false otherwise. The default is false.

shouldRenderText

shouldRenderText(zoomLevel: number, tileKey: TileKey): boolean

Inherited from BackgroundDataSource.shouldRenderText
- Defined in @here/harp-mapview/lib/DataSource.ts:717
Returns true if MapView should render the text elements with the given {@link @here/harp-geoutils#TileKey} and zoom level.

remarks

This is an additional check for the tiles that are already selected for rendering so the default implementation returns true.

Parameters
- zoomLevel: number
  
  The zoom level.
- tileKey: TileKey
  
  The unique identifier for a map tile.
Returns boolean

true if the text elements created for the given {@link @here/harp-geoutils#TileKey} should be rendered.

shouldSubdivide

shouldSubdivide(zoomLevel: number, tileKey: TileKey): boolean

Inherited from BackgroundDataSource.shouldSubdivide
- Defined in @here/harp-mapview/lib/DataSource.ts:699
Returns true if MapView should traverse tiles further with given {@link @here/harp-geoutils#TileKey} and zoom level.

Parameters
- zoomLevel: number
  
  The zoom level of the MapView.
- tileKey: TileKey
  
  The unique identifier for a map tile.
Returns boolean

true if the subtiles of the given {@link @here/harp-geoutils#TileKey} should be checked for collisions.

updateStorageLevelOffset

updateStorageLevelOffset(): void

- Defined in @here/harp-mapview/lib/BackgroundDataSource.ts:29
Returns void

updateTile

updateTile(tile: Tile): void

Inherited from BackgroundDataSource.updateTile
- Defined in @here/harp-mapview/lib/DataSource.ts:538
This method is called by MapView before the tile needs to be updated, for example after a theme change.

Parameters
- tile: Tile
  
  The Tile to update.
Returns void

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns BackgroundDataSource

Properties

addGroundPlane

allowOverlappingTiles

cacheable

dataSourceOrder

enablePicking

enabled

Protected Optional languages

maxDataLevel

maxDisplayLevel

minDataLevel

minDisplayLevel

name

useGeometryLoader

Static Readonly GROUND_RENDER_ORDER

Accessors

mapView

Returns MapView

maxGeometryHeight

Returns number

Parameters

value: number

Returns void

maxZoomLevel

Returns number

Parameters

level: number

Returns void

minGeometryHeight

Returns number

Parameters

value: number

Returns void

minZoomLevel

Returns number

Parameters

level: number

Returns void

projection

Returns Projection

storageLevelOffset

Returns number

Parameters

levelOffset: number

Returns void

styleSetName

Returns string | undefined

Parameters

styleSetName: string | undefined

Returns void

Methods

addEventListener

Parameters

type: string

listener: (event: Event) => void

Parameters

event: Event

Returns void

Returns void

attach

Parameters

mapView: MapView

Returns void

canGetTile

Parameters

zoomLevel: number

tileKey: TileKey

Returns boolean

clearCache

Returns void

clearFeatureState