Class Layer<I>

active

• get active(): boolean

• Returns boolean

allowPicking

• get allowPicking(): boolean

• Returns boolean

• set allowPicking(allowPicking): void

• Parameters

  • allowPicking: boolean

  Returns void

exclusive

• get exclusive(): boolean

• Indicates, that this layer is part of an exclusiveGroup

  Returns boolean

exclusiveGroups

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

• An array of arbitrary exclusive groups

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

• Parameters

  • groups: (string | symbol)[]

  Returns void

globalHider

• get globalHider(): undefined | GlobalHider

• Returns undefined | GlobalHider

headers

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

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

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

• Parameters

  • headers: undefined | Record<string, string>

  Returns void

hiddenObjectIds

• get hiddenObjectIds(): string[]

• Returns string[]

• set hiddenObjectIds(hiddenObjectIds): void

• Parameters

  • hiddenObjectIds: string[]

  Returns void

initialized

• get initialized(): boolean

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

  Returns boolean

loading

• get loading(): boolean

• Returns boolean

locale

• get locale(): string

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

  Returns string
• set locale(value): void

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

  Parameters

  • value: string

  Returns void

state

• get state(): LayerState

• Returns LayerState

url

• get url(): string

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

  Returns string
• set url(url): void

• Parameters

  • url: string | Record<string, string>

  Returns void

zIndex

• get zIndex(): number

• Returns number

• set zIndex(index): void

• Parameters

  • index: number

  Returns void

Static className

• get className(): string

• Returns string

constructor

• new Layer<I>(options): Layer<I>

• Type Parameters

  • I extends LayerImplementation<VcsMap<VisualisationType>, I> = LayerImplementation<VcsMap<VisualisationType>>

  Parameters

  • options: LayerOptions

  Returns Layer<I>

activate

• activate(): Promise<void>

• 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>

createImplementationsForMap

• createImplementationsForMap(_map): I[]

• creates an array of layer implementations for the given map.

  Parameters

  • _map: VcsMap<VisualisationType>

    Map

  Returns I[]

  return the specific implementation

deactivate

• deactivate(): void

• Deactivates a layer, changing the internal view state

  Returns void

destroy

• destroy(): void

• disposes of this layer, removes instances from the current maps and the framework

  Returns void

forceRedraw

• forceRedraw(): 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>

getExtent

• getExtent(): null | Extent

• returns the Extent of this layer

  Returns null | Extent

getImplementationOptions

• getImplementationOptions(): LayerImplementationOptions

• Returns LayerImplementationOptions

getImplementations

• getImplementations(): I[]

• Returns all implementation of this layer for all maps

  Returns I[]

getImplementationsForMap

• getImplementationsForMap<T>(map): I[]

• creates or returns a cached array of layer implementations for the given map.

  Type Parameters

  • T extends VcsMap<VisualisationType, T>

  Parameters

  • map: T

    initialized Map

  Returns I[]

  return the specific implementation

getZoomToExtent

• getZoomToExtent(): null | Extent

• returns the Extent of this layer or null, if the layers extent was not defined or cannot be established

  Returns null | Extent

initialize

• initialize(): Promise<void>

• initializes the layer, can be used to defer loading

  Returns Promise<void>

isSupported

• isSupported(map): boolean

• checks if the currently active map supports this layer

  Parameters

  • map: VcsMap<VisualisationType>

  Returns boolean

mapActivated

• mapActivated(map): 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

  • map: VcsMap<VisualisationType>

  Returns Promise<void>

  Link

mapDeactivated

• mapDeactivated(map): 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

  • map: VcsMap<VisualisationType>

  Returns void

reload

• reload(): Promise<void>

• Reloads all the data loaded and forces a redraw

  Returns Promise<void>

removedFromMap

• removedFromMap(map): void

• is called when a layer is removed from the layer collection of a map or said map is destroyed. destroys the associated implementation.

  Parameters

  • map: VcsMap<VisualisationType>

  Returns void

setGlobalHider

• setGlobalHider(globalHider?): void

• Parameters

  • Optional globalHider: GlobalHider

  Returns void

toJSON

• toJSON(): LayerOptions

• Returns LayerOptions

Static getDefaultOptions

• getDefaultOptions(): LayerOptions

• Returns LayerOptions

activeOnStartup

copyright

Optional datasourceId

exclusiveGroupsChanged

extent

featureProvider

mapNames

stateChanged

zIndexChanged