Class Layer<I>

active

• get active(): boolean

  Returns boolean

allowPicking

• get allowPicking(): boolean

  Returns boolean

• set allowPicking(allowPicking: boolean): 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: (string | symbol)[]): void

  Parameters

  • groups: (string | symbol)[]

  Returns void

globalHider

• get globalHider(): GlobalHider | undefined

  Returns GlobalHider | undefined

headers

• 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

hiddenObjectIds

• get hiddenObjectIds(): string[]

  Returns string[]

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

  Parameters

  • hiddenObjectIds: string[]

  Returns void

ignoreMapLayerTypes

• 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

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: string): void

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

  Parameters

  • value: string

  Returns void

mapNames

• 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

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: string | Record<string, string>): void

  Parameters

  • url: string | Record<string, string>

  Returns void

zIndex

• get zIndex(): number

  Returns number

• set zIndex(index: number): void

  Parameters

  • index: number

  Returns void

StaticclassName

• get className(): string

  Returns string

constructor

• new Layer<
      I extends
          LayerImplementation<VcsMap<VisualisationType>> = LayerImplementation<
          VcsMap<VisualisationType>,
      >,
  >(
      options: LayerOptions,
  ): Layer<I>

  Type Parameters

  • I extends LayerImplementation<VcsMap<VisualisationType>> = 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: VcsMap): I[]

  creates an array of layer implementations for the given map.

  Parameters

  • _map: VcsMap

    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(): Extent | null

  returns the Extent of this layer

  Returns Extent | null

getImplementationOptions

• getImplementationOptions(): LayerImplementationOptions

  Returns LayerImplementationOptions

getImplementations

• getImplementations(): I[]

  Returns all implementation of this layer for all maps

  Returns I[]

getImplementationsForMap

• getImplementationsForMap(map: VcsMap): I[]

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

  Parameters

  • map: VcsMap

    initialized Map

  Returns I[]

  return the specific implementation

getZoomToExtent

• getZoomToExtent(): Extent | null

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

  Returns Extent | null

initialize

• initialize(): Promise<void>

  initializes the layer, can be used to defer loading

  Returns Promise<void>

isSupported

• isSupported(map: VcsMap): boolean

  checks if the currently active map supports this layer

  Parameters

  • map: VcsMap

  Returns boolean

mapActivated

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

  Returns Promise<void>

  Link

mapDeactivated

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

  Returns void

reload

• reload(): Promise<void>

  Reloads all the data loaded and forces a redraw

  Returns Promise<void>

removedFromMap

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

  Returns void

setGlobalHider

• setGlobalHider(globalHider?: GlobalHider): void

  Parameters

  • OptionalglobalHider: GlobalHider

  Returns void

toJSON

• toJSON(defaultOptions?: LayerOptions): LayerOptions

  Parameters

  • defaultOptions: LayerOptions = ...

  Returns LayerOptions

StaticgetDefaultOptions

• getDefaultOptions(): LayerOptions

  Returns LayerOptions

activeOnStartup

copyright

OptionaldatasourceId

exclusiveGroupsChanged

extent

featureProvider

ReadonlymapNamesChanged

stateChanged

zIndexChanged