Class LayerAPI

constructor

• new LayerAPI(iApi): LayerAPI

• Parameters

  • iApi: InstanceAPI

  Returns LayerAPI

files

ogc

allErrorLayers

• allErrorLayers(): LayerInstance[]

• Return all error layers.

  Returns LayerInstance[]

  all error layers

allLayers

• allLayers(): LayerInstance[]

• Return all registered layers.

  Returns LayerInstance[]

  all registered layers

createLayer

• createLayer(config): LayerInstance

• Will generate a RAMP Layer based on the supplied config object.

  Parameters

  • config: RampLayerConfig

    a valid layer configuration object

  Returns LayerInstance

  Layer in uninitialized load state

getLayer

• getLayer(layerId): undefined | LayerInstance

• Access an instantiated layer object.

  Parameters

  • layerId: string

    layer id or uid of the layer

  Returns undefined | LayerInstance

  The layer instance with the given id. Returns undefined is layer is not found.

getLayerControls

• getLayerControls(layerId): undefined | {
      controls: LayerControl[];
      disabledControls: LayerControl[];
  }

• Get controls and disabled controls configuration of the layer with the given id.

  Parameters

  • layerId: string

    layer id or uid of the layer

  Returns undefined | {
      controls: LayerControl[];
      disabledControls: LayerControl[];
  }

  The layer's controls and disabled controls configuration. Returns undefined if layer is not found.