Class AbstractLayerSetAbstract

ProtectedlayerApi

ProtectedgetMapId

• getMapId(): string

  Gets the MapId for the layer set

  Returns string

Protected AbstractonDeleteFromStore

• onDeleteFromStore(layerPath: string): void

  A must-override method called to delete a result set entry from the store

  Parameters

  • layerPath: string

    The layer path to delete from store

  Returns void

ProtectedonLayerSetUpdatedProcess

• onLayerSetUpdatedProcess(layerPath: string): void

  An overridable layer set updated function for a layer-set to indicate the layer set has been updated.

  Parameters

  • layerPath: string

    The layer path

  Returns void

ProtectedonProcessLayerStatusChanged

• onProcessLayerStatusChanged(
      layerConfig: ConfigBaseClass,
      layerStatus: TypeLayerStatus,
  ): void

  An overridable function for a layer-set to process a layer status changed event.

  Parameters

  • layerConfig: ConfigBaseClass

    The layer config

  • layerStatus: TypeLayerStatus

    The new layer status

  Returns void

ProtectedonProcessNameChanged

• onProcessNameChanged(layerPath: string, name: string): void

  An overridable function for a layer-set to process a layer name change.

  Parameters

  • layerPath: string

    The layer path being affected

  • name: string

    The new layer name

  Returns void

Protected AbstractonPropagateToStore

• onPropagateToStore(
      resultSetEntry: TypeResultSetEntry,
      type: PropagationType,
  ): void

  A must-override method called to propagate the result set entry to the store

  Parameters

  • resultSetEntry: TypeResultSetEntry

    The result set entry to propagate

  • type: PropagationType

  Returns void

ProtectedonRegisterLayer

• onRegisterLayer(layer: AbstractBaseLayer): void

  An overridable registration function for a layer-set that the registration process will use to create a new entry in the layer set for a specific geoview layer and layer path.

  Parameters

  • layer: AbstractBaseLayer

    The layer config

  Returns void

ProtectedonRegisterLayerCheck

• onRegisterLayerCheck(layer: AbstractBaseLayer): boolean

  An overridable registration condition function for a layer-set to check if the registration should happen for a specific geoview layer and layer path. By default, a layer-set always registers layers except when they are group layers.

  Parameters

  • layer: AbstractBaseLayer

    The layer

  Returns boolean

  True if the layer should be registered, false otherwise

ProtectedonRegisterLayerConfig

• onRegisterLayerConfig(layerConfig: ConfigBaseClass): void

  An overridable registration function for a layer-set that the registration process will use to create a new entry in the layer set for a specific geoview layer and layer path.

  Parameters

  • layerConfig: ConfigBaseClass

    The layer config

  Returns void

ProtectedonRegisterLayerConfigCheck

• onRegisterLayerConfigCheck(layerConfig: ConfigBaseClass): boolean

  An overridable registration condition function for a layer-set to check if the registration should happen for a specific geoview layer and layer path.

  Parameters

  • layerConfig: ConfigBaseClass

    The layer config

  Returns boolean

  True if the layer config should be registered, false otherwise

ProtectedonUnregisterLayer

• onUnregisterLayer(layer: AbstractBaseLayer | undefined): void

  An overridable unregistration function for a layer-set that the registration process will use to unregister a specific geoview layer.

  Parameters

  • layer: AbstractBaseLayer | undefined

    The layer

  Returns void

ProtectedonUnregisterLayerConfig

• onUnregisterLayerConfig(layerConfig: ConfigBaseClass | undefined): void

  An overridable unregistration function for a layer-set that the registration process will use to unregister a specific layer config.

  Parameters

  • layerConfig: ConfigBaseClass | undefined

    The layer config

  Returns void

Protected StaticalignRecordsWithOutFields

• alignRecordsWithOutFields(
      layerEntryConfig: AbstractBaseLayerEntryConfig,
      arrayOfRecords: TypeFeatureInfoEntry[],
  ): void
  Protected

  Align records with informatiom provided by OutFields from layer config. This will update fields in and delete unwanted fields from the arrayOfRecords

  Parameters

  • layerEntryConfig: AbstractBaseLayerEntryConfig

    The layer entry config object.

  • arrayOfRecords: TypeFeatureInfoEntry[]

    Features to delete fields from.

  Returns void

  Static

Protected StaticisInVisibleRange

• isInVisibleRange(
      layer: AbstractGVLayer,
      currentZoom: number | undefined,
  ): boolean

  Checks if the layer is in visible range.

  Parameters

  • layer: AbstractGVLayer

    The layer

  • currentZoom: number | undefined

    The map current zoom level

  Returns boolean

  True if the state is queryable or undefined

Protected StaticisQueryableType

• isQueryableType(layer: AbstractBaseLayer): boolean

  Checks if the layer is of queryable type based on its class definition

  Parameters

  • layer: AbstractBaseLayer

    The layer

  Returns boolean

  True if the layer is of queryable type

Protected StaticisSourceQueryable

• isSourceQueryable(layer: AbstractBaseLayer): boolean

  Checks if the layer config source is queryable.

  Parameters

  • layer: AbstractBaseLayer

    The layer

  Returns boolean

  True if the source is queryable or undefined

Protected StaticqueryLayerFeatures

• queryLayerFeatures(
      map: Map,
      geoviewLayer: AbstractGVLayer,
      queryType: QueryType,
      location: TypeLocation,
      queryGeometry?: boolean,
      abortController?: AbortController | undefined,
  ): Promise<TypeFeatureInfoEntry[]>

  Processes layer data to query features on it, if the layer path can be queried.

  Parameters

  • map: Map

    The Map to query layer features from.

  • geoviewLayer: AbstractGVLayer

    The geoview layer

  • queryType: QueryType

    The query type

  • location: TypeLocation

    The location for the query

  • queryGeometry: boolean = true

    The query geometry boolean

  • abortController: AbortController | undefined = undefined

    The optional abort controller.

  Returns Promise<TypeFeatureInfoEntry[]>

  A promise resolving to the query results