Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VectorTileDataSource<TileType>

VectorTileDataSource is used for the visualization of vector tiles.

example
   const dataSource = new VectorTileDataSource({
       baseUrl: "https://vector.hereapi.com/v2/vectortiles/base/mc",
       authenticationCode: apikey
   });
   mapView.addDataSource(dataSource);

Type parameters

Hierarchy

Index

Constructors

constructor

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.

Protected Readonly logger

logger: ILogger = LoggerManager.instance.create("TileDataSource")

Protected Readonly m_decoder

m_decoder: ITileDecoder

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.

Accessors

decoder

mapView

maxGeometryHeight

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

maxZoomLevel

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

minGeometryHeight

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

minZoomLevel

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

projection

storageLevelOffset

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

styleSetName

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

Methods

addEventListener

  • addEventListener(type: string, listener: (event: Event) => void): void
  • 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

canGetTile

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

clearCache

  • clearCache(): void

clearFeatureState

  • clearFeatureState(): void

connect

  • connect(): Promise<void>

dataProvider

detach

dispatchEvent

  • dispatchEvent(event: { type: string }): void
  • Fire an event type.

    Parameters

    • event: { type: string }
      • [attachment: string]: any
      • type: string

    Returns void

dispose

  • dispose(): void

getDataZoomLevel

  • getDataZoomLevel(zoomLevel: number): number

getFeatureState

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

getTile

  • getTile(tileKey: TileKey, delayLoad?: boolean): TileType | undefined
  • Create a Tile and start the asynchronous download of the tile content. The Tile will be empty, but the download and decoding will be scheduled immediately. Tile instance is initialized with default copyrights, concatenated with copyrights from copyright provider of this data source.

    default

    false.

    override

    Parameters

    • tileKey: TileKey

      Quadtree address of the requested tile.

    • Default value delayLoad: boolean = false

      If true, the Tile will be created, but Tile.load will not be called.

    Returns TileType | undefined

getTileInfo

getTilingScheme

hasEventListener

  • hasEventListener(type: string, listener: (event: Event) => void): boolean
  • 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

isFullyCovering

  • isFullyCovering(): boolean

isVisible

  • isVisible(zoomLevel: number): boolean

ready

  • ready(): boolean

removeDataFilter

  • removeDataFilter(): void

removeEventListener

  • removeEventListener(type: string, listener: (event: Event) => void): void
  • 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

requestUpdate

  • requestUpdate(): void

setDataFilter

  • setDataFilter(filterDescription: OmvFeatureFilterDescription): void

setEnableElevationOverlay

  • setEnableElevationOverlay(enable: boolean): void

setFeatureState

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

setLanguages

  • setLanguages(languages: string[]): void

setPoliticalView

  • setPoliticalView(politicalView?: undefined | string): void

setTheme

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

shouldPreloadTiles

  • shouldPreloadTiles(): boolean

shouldRenderText

  • shouldRenderText(zoomLevel: number, tileKey: TileKey): boolean
  • 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

updateTile

  • updateTile(tile: Tile): void

Generated using TypeDoc