Class: GoRemoteSensing

GoRemoteSensing

This class is used for create the remote sensing layer.

new GoRemoteSensing()

Layers/GoRemoteSensing/index.ts, line 60

Extends

  • undefined

Methods

__addSelectInteraction()

Layers/GoRemoteSensing/index.ts, line 410

Adds a select interaction to the map. This allows for features in the GeoJSON layer to be highlighted and selected on hover.

__getUIInitialState(){Promise.<IRSUIState>}

Layers/GoRemoteSensing/index.ts, line 287

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.

The function calls two services, rs1 and rs4, using the client ID from the layer options. It waits for both promises to resolve using Promise.all. If the rs1 data is not present or is empty, the function rejects the promise. Otherwise, it processes the rs1 data, selects an image from this data, and then loads raster and GeoJSON data into the map.

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

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

__goToPlot(feature)

Layers/GoRemoteSensing/index.ts, line 539

Zooms the map to focus on a specific feature (plot).

Name Type Description
feature Feature

The feature to zoom in on.

__loadRs1DataIntoState(clientData)

Layers/GoRemoteSensing/index.ts, line 342

Loads data from the RS1 service into the state. It organizes and processes the received data for further use.

Name Type Description
clientData Object

The data received from the RS1 service.

__saveRs1ResponseIntoState(clientData)

Layers/GoRemoteSensing/index.ts, line 328

Saves the response data from the RS1 service to the state. It updates the state with the received data.

Name Type Description
clientData Object

The data received from the RS1 service.

addClickStyleFunction(feature){Style}

Layers/GoRemoteSensing/index.ts, line 567

Defines a style function for a feature when it is clicked.

Name Type Description
feature Feature

The feature to apply the style to.

Returns:
Type Description
Style The style to be applied to the selected feature.

addPlotFilter(feature){Crop}

Layers/GoRemoteSensing/index.ts, line 196

Adds a plot filter to the layer. The filter is typically a Crop filter used to highlight or focus on specific features.

Name Type Description
feature Feature

The feature to which the Crop filter will be applied.

Returns:
Type Description
Crop The Crop filter applied to the feature.

changeRemoteSensingConfig(config)

Layers/GoRemoteSensing/index.ts, line 732

Changes the configuration of the Remote Sensing layer.

Name Type Description
config Object

The configuration object.

clearPlotFilters()

Layers/GoRemoteSensing/index.ts, line 263

Clears all plot filters from the layer.

geojsonStyleFunction(){Style}

Layers/GoRemoteSensing/index.ts, line 593

Defines the default style function for the features in the GeoJSON layer.

Returns:
Type Description
Style The default style for features in the GeoJSON layer.

getApiBaseUrl(){string}

Layers/GoRemoteSensing/index.ts, line 611

Retrieves the base URL for the API.

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

getEventHandlerProxy(){RSEventsProxy}

Layers/GoRemoteSensing/index.ts, line 765

Retrieves the event handlers proxy object. This function returns the event handlers proxy associated with the current context, used to manage event handling.

Returns:
Type Description
RSEventsProxy The event handlers proxy object.

getGeojsonData(){Array.<GeoJSONFeature>}

Layers/GoRemoteSensing/index.ts, line 775

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

Returns:
Type Description
Array.<GeoJSONFeature> The GeoJSON data

getGeojsonLayer(){WebGLVectorLayer.<VectorSource>}

Layers/GoRemoteSensing/index.ts, line 785

Retrieves the WebGLVectorLayer layer object. This function returns the WebGLVectorLayer instance used to display GeoJSON data on the map.

Returns:
Type Description
WebGLVectorLayer.<VectorSource> The WebGLVectorLayer object used for GeoJSON data.

getGeojsonSource(){VectorSource}

Layers/GoRemoteSensing/index.ts, line 795

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/GoRemoteSensing/index.ts, line 755

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.

getPlotFilter(plotIndex){Crop}

Layers/GoRemoteSensing/index.ts, line 247

Retrieves a plot filter from the layer based on the provided index.

Name Type Description
plotIndex number

The index of the plot filter to retrieve.

Returns:
Type Description
Crop The Crop filter at the given index.

getPlotFilters(){Array.<Crop>}

Layers/GoRemoteSensing/index.ts, line 256

Retrieves all plot filters from the layer.

Returns:
Type Description
Array.<Crop> An array of Crop filters applied to the layer.

getSelectedPlot(){Feature|null}

Layers/GoRemoteSensing/index.ts, line 557

Retrieves the currently selected plot.

Returns:
Type Description
Feature | null The selected plot feature, or null if no plot is selected.

getUI(){RSUIMainContainer}

Layers/GoRemoteSensing/index.ts, line 620

Retrieves the UI main container instance.

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

getVisibility(){boolean}

Layers/GoRemoteSensing/index.ts, line 745

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(clientGeometries)

Layers/GoRemoteSensing/index.ts, line 366

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

Name Type Description
clientGeometries Object

GeoJSON data received from the RS4 service.

loadRasterDataIntoMap(params, selectedIndex){Promise}

Layers/GoRemoteSensing/index.ts, line 641

Loads raster data into the map. It fetches and processes raster data based on specified parameters and updates the map layer.

Name Type Description
params Object

An object containing raster data parameters such as name and bounds.

selectedIndex GoIndexType

The selected index type for processing the raster data.

Returns:
Type Description
Promise A promise that resolves when the raster data has been loaded into the map.

loadStatsDataIntoMap(data_comparison)

Layers/GoRemoteSensing/index.ts, line 690

Loads statistical data into the map. It processes the comparison data and updates the map state.

Name Type Description
data_comparison Object

The statistical data for comparison.

onRemove()

Layers/GoRemoteSensing/index.ts, line 443

Cleans up resources and interactions when the layer is removed. Removes the select interaction and the GeoJSON layer from the map.

removePlotFilter(plotIndex)

Layers/GoRemoteSensing/index.ts, line 212

Removes a plot filter from the layer based on the provided index.

Name Type Description
plotIndex number

The index of the plot filter to remove.

removePlotFilters(plotIndexes)

Layers/GoRemoteSensing/index.ts, line 227

Removes multiple plot filters from the layer based on an array of indices.

Name Type Description
plotIndexes Array.<number>

An array of indices of the plot filters to remove.

setMinMaxResolutions(layerOpts)

Layers/GoRemoteSensing/index.ts, line 807

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/GoRemoteSensing/index.ts, line 629

Sets the visibility of the layer and associated plots.

Name Type Description
visibility boolean

The visibility state to set for the layer and plots.

syncTheme()

Layers/GoRemoteSensing/index.ts, line 174

Public method to synchronize theme with the application

type(){string}

Layers/GoRemoteSensing/index.ts, line 186

Returns the type of the layer as defined in GOLayerType.

Returns:
Type Description
string The type of the layer.

updateInfoContainerInfo(plotId)

Layers/GoRemoteSensing/index.ts, line 454

Updates the information container with data specific to a selected plot.

Name Type Description
plotId string

The identifier of the plot whose information is to be displayed.