Class: GoVerticalRemoteSensing

GoVerticalRemoteSensing

This class is used for create the remote sensing layer.

new GoVerticalRemoteSensing()

Layers/GoVerticalRemoteSensing/index.ts, line 50

Extends

  • undefined

Methods

__getUIInitialState(){Promise.<IVRSState>}

Layers/GoVerticalRemoteSensing/index.ts, line 190

Asynchronously retrieves the initial state of the UI for the mapping application. This function makes API calls to fetch necessary data, processes it, and then sets up the map with the retrieved data.

Upon successful completion of these operations, it resolves the promise with the current state of the UI.

Returns:
Type Description
Promise.<IVRSState> A promise that resolves with the current state of the UI after successful initialization and data loading.

__saveInfoValuesIntoState(attr, values)

Layers/GoVerticalRemoteSensing/index.ts, line 240

Save data InfoContainer Into State

Name Type Description
attr string

The attribute received

values unknown

The data received

canFilter(){boolean}

Layers/GoVerticalRemoteSensing/index.ts, line 345

Checks if filtering can be applied.

Returns:
Type Description
boolean
  • Always returns true in this implementation.

getApiBaseUrl(){string}

Layers/GoVerticalRemoteSensing/index.ts, line 254

Retrieves the base URL for the API.

Returns:
Type Description
string The base URL of the API.

getGeojsonData(){Object}

Layers/GoVerticalRemoteSensing/index.ts, line 302

Retrieves the GeoJSON data. This function returns the GeoJSON data used in the current context, typically representing geographical features.

Returns:
Type Description
Object The GeoJSON data object.

getGeojsonSource(){VectorSource}

Layers/GoVerticalRemoteSensing/index.ts, line 312

Retrieves the source of the GeoJSON layer. This function returns the VectorSource associated with the GeoJSON layer, containing the features to be rendered on the map.

Returns:
Type Description
VectorSource The source object of the GeoJSON layer.

getLayer(){VectorLayer.<VectorSource>}

Layers/GoVerticalRemoteSensing/index.ts, line 292

Retrieves the layer object. This function returns the VectorLayer with a VectorSource associated with the current context.

Returns:
Type Description
VectorLayer.<VectorSource> The VectorLayer object.

getLayerDescription(){string}

Layers/GoVerticalRemoteSensing/index.ts, line 352

Gets a description of the layer.

Returns:
Type Description
string
  • A description of the layer, "HexGrid Layer".

getSourceLayerType(){GoLayerSourceType|undefined}

Layers/GoVerticalRemoteSensing/index.ts, line 337

Gets the type of the source layer.

Returns:
Type Description
GoLayerSourceType | undefined The type of the source layer.

getUI(){UIMainContainer}

Layers/GoVerticalRemoteSensing/index.ts, line 263

Retrieves the UI main container instance.

Returns:
Type Description
UIMainContainer The instance of the main UI container.

getVisibility(){boolean}

Layers/GoVerticalRemoteSensing/index.ts, line 282

Retrieves the visibility status of the layer. This function returns a boolean indicating whether the layer is currently visible on the map.

Returns:
Type Description
boolean The visibility status of the layer.

loadGeojsonDataIntoMap(clientFeaturesData)

Layers/GoVerticalRemoteSensing/index.ts, line 225

Loads GeoJSON data into the map. It processes the received data and adds it as a new layer on the map.

Name Type Description
clientFeaturesData Object

GeoJSON data received from the RS4 service.

setMinMaxResolutions(layerOpts)

Layers/GoVerticalRemoteSensing/index.ts, line 324

Sets the minimum and maximum resolutions for the layer. This function updates the layer's resolution settings based on the provided layer options. If the minResolution and/or maxResolution are specified in the layer options, they are applied to the layer to control its visibility at different zoom levels.

Name Type Description
layerOpts layerOptions

An object containing layer options including minimum and maximum resolutions.

setVisibility(visibility)

Layers/GoVerticalRemoteSensing/index.ts, line 272

Sets the visibility of the layer and associated pipe.

Name Type Description
visibility boolean

The visibility state to set for the layer and pipe.

type(){string}

Layers/GoVerticalRemoteSensing/index.ts, line 178

Returns the type of the layer as defined in GOLayerType.

Returns:
Type Description
string The type of the layer.