@vcmap/core
    Preparing search index...

    Class WMTSLayer

    Hierarchy (View Summary)

    Index

    Accessors

    • get allowPicking(): boolean

      Returns boolean

    • set allowPicking(allowPicking: boolean): void

      Parameters

      • allowPicking: boolean

      Returns void

    • get className(): string

      Returns string

    • get exclusive(): boolean

      Indicates, that this layer is part of an exclusiveGroup

      Returns boolean

    • get exclusiveGroups(): (string | symbol)[]

      An array of arbitrary exclusive groups

      Returns (string | symbol)[]

    • set exclusiveGroups(groups: (string | symbol)[]): void

      Parameters

      • groups: (string | symbol)[]

      Returns void

    • get headers(): Record<string, string> | undefined

      directly manipulating the headers Object will not trigger a reload. Reload the data via layer.reload() manually.

      Returns Record<string, string> | undefined

    • set headers(headers: Record<string, string> | undefined): void

      Parameters

      • headers: Record<string, string> | undefined

      Returns void

    • get hiddenObjectIds(): string[]

      Returns string[]

    • set hiddenObjectIds(hiddenObjectIds: string[]): void

      Parameters

      • hiddenObjectIds: string[]

      Returns void

    • get ignoreMapLayerTypes(): boolean

      Returns boolean

    • set ignoreMapLayerTypes(value: boolean): void

      if set to true, the layer types of the map will be ignored when checking if the layer is supported. Changes will call reload on the layer.

      Parameters

      • value: boolean

      Returns void

    • get initialized(): boolean

      True if this layer has been initialized, typically after its first activation.

      Returns boolean

    • get locale(): string

      returns the currently set locale. Can be used to provide locale specific URLs.

      Returns string

    • set locale(value: string): void

      sets the locale and reloads the layer the if the URL is a locale aware Object.

      Parameters

      • value: string

      Returns void

    • get mapNames(): string[]

      Returns string[]

    • set mapNames(mapNames: string[]): void

      if provided, the layer will only be shown in the given MapNames. An empty array will show the layer in all configured maps. Changes will call reload on the layer.

      Parameters

      • mapNames: string[]

      Returns void

    • get opacity(): number

      The opacity between 0 (fully transparent) and 1 (fully opaque)

      Returns number

    • set opacity(opacity: number): void

      Parameters

      • opacity: number

      Returns void

    • get splitDirection(): SplitDirection

      The split directions of this layer

      Returns SplitDirection

    • set splitDirection(direction: SplitDirection): void

      Parameters

      • direction: SplitDirection

      Returns void

    • get url(): string

      A layers url, should on be configured, else an empty string

      Returns string

    • set url(url: string | Record<string, string>): void

      Parameters

      • url: string | Record<string, string>

      Returns void

    • get zIndex(): number

      Returns number

    • set zIndex(index: number): void

      Parameters

      • index: number

      Returns void

    Constructors

    Methods

    • Activates this layer object, i.e. changes its internal view state and updates the map. The returned promise resolves, once the layer & any _implementations are initialized and all data is loaded. Once the promise resolves, the layer can still be inactive, if deactivate was called while initializing the layer.

      Returns Promise<void>

    • destroys all current implementations and recreates the ones which have an active map. called for instance when the URL for a layer changes

      Returns Promise<void>

    • is called from the map when the map is activated, and this layer is in the layerCollection of the map. Will create an implementation if it does not exits and will forward the activation call to the implementation.

      Parameters

      Returns Promise<void>

    • is called from the map when the map is deactivated, and this layer is in the layerCollection of the map. will forward deactivation call to the map specific implementation

      Parameters

      Returns void

    Properties

    _headers?: Record<string, string>
    _supportedMaps: string[]

    The class names of the supported maps.

    _url: string | Record<string, string> | undefined
    "[moduleIdSymbol]"?: string
    activeOnStartup: boolean
    copyright: CopyrightOptions | undefined
    datasourceId?: string

    Optional Id to synchronize with the vcPublisher Datasources. This can also be used to track a connection to other sources of data.

    exclusiveGroupsChanged: VcsEvent<(string | symbol)[]>

    event raised if the exclusives group of the layer changes. is passed the array of exclusive groups as its only argument

    extent: Extent
    featureProvider: AbstractFeatureProvider | AbstractAttributeProvider | undefined

    An optional feature or attribute provider to provide or augment features on click events.

    format: string
    imageryLayerOptions: ConstructorOptions | undefined

    can be used to forward options to the cesium ImageryLayer

    https://cesium.com/learn/cesiumjs/ref-doc/ImageryLayer.html#.ConstructorOptions Changes requires calling layer.redraw() to take effect.

    isDestroyed: boolean
    layer: string
    mapNamesChanged: VcsEvent<string[]> = ...
    matrixIds: string[]
    maxLevel: number

    The maximum level to load. Changes require calling layer.redraw() to take effect.

    maxRenderingLevel: number | undefined

    defines the visible level in the rendered map, maps to Openlayers minZoom and Cesium minimiumTerrainLevel. Changes requires calling layer.redraw() to take effect.

    minLevel: number

    The minimum level to load. Changes require calling layer.redraw() to take effect.

    minRenderingLevel: number | undefined

    defines the visible level in the rendered map, maps to Openlayers minZoom and Cesium minimiumTerrainLevel. Changes requires calling layer.redraw() to take effect.

    name: string

    unique Name

    numberOfLevelZeroTilesX: number
    numberOfLevelZeroTilesY: number
    openlayersOptions: Partial<OLWMTSOptions>
    properties: Record<string, unknown>
    splitDirectionChanged: VcsEvent<SplitDirection> = ...

    raised if the split direction changes, is passed the split direction as its only argument

    stateChanged: VcsEvent<LayerState>

    Event raised, if the layers state changes. Is passed the LayerState as its only parameter

    tileMatrixPrefix: string
    tileMatrixSetID: string
    tileSize: Size
    tilingSchema: TilingScheme

    The TilingScheme of this layer Changes require calling layer.redraw() to take effect.

    wmtsStyle: string
    zIndexChanged: VcsEvent<number>

    Called when the zIndex of this layer is changed. Is passed the new zIndex as its only argument.