Class: RSUIMainContainer

RSUIMainContainer

Class representing the main container of the remote sensing user interface. This class extends RSUIBase and manages various components like top navigation bar, info container, and legend.

new RSUIMainContainer()

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 20
Properties:
Name Type Description
__layer GoRemoteSensing

The layer that contains the UI.

__topRSNavBar RSUITopNavBar

The top nav bar.

__infoRSContainer RSUIInfoRSContainer

The info container.

Since:
  • 3.3.0
See:
Example
import { GoRemoteSensing, RSUIMainContainer } from "go-remote-sensing";

const layer = new GoRemoteSensing();

const mainContainer = new RSUIMainContainer(layer);

const container = mainContainer.getContainer();

const layerContainer = mainContainer.getLayer();

Extends

  • undefined

Methods

__addContainerToMap(){void}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 260

This method adds the container of the UI to the current map.

Returns:
Type Description
void

__createToRSNavBar(){void}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 149

This method creates the top nav bar and adds it to the main container.

Returns:
Type Description
void

__setDefaults(options)

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 114

This method sets the default options of the UI.s

Name Type Description
options RSUIOptions

The options of the UI.

getId(){string}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 269

This method assing the id to the current container.

Returns:
Type Description
string

getInfoRSContainer(){RSUIInfoRSContainer}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 247

Retrieves the information container component.

Returns:
Type Description
RSUIInfoRSContainer The information container component.

getLang(){RSUILang}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 141

Allow to get the current lang of the UI.

Returns:
Type Description
RSUILang The class that handles the lang of the UI.

getLayer(){GoRemoteSensing}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 277

This method return the layer of this UI.

Returns:
Type Description
GoRemoteSensing The layer that contains the UI.

getTheme(){RSUITheme}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 133

Allow to get the current theme of the UI.

Returns:
Type Description
RSUITheme The class that handles the theme.

getTopRSNavBar(){RSUITopNavBar}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 239

Retrieves the top navigation bar component.

Returns:
Type Description
RSUITopNavBar The top navigation bar component.

getUIOptions(){RSUIOptions}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 125

Allow to get the options of the UI.

Returns:
Type Description
RSUIOptions The options of the UI.

setInfoContainer(infoContainer)

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 97

Replaces the current info container with a new one.

Name Type Description
infoContainer RSUIInfoRSContainer

The new info container to set.

RSUIMainContainer

new RSUIMainContainer(layer, options)

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 53

Constructs the main container of the remote sensing UI.

Name Type Description
layer GoRemoteSensing

The GoRemoteSensing layer instance.

options RSUIOptions

Configuration options for the UI.

Methods

__addContainerToMap(){void}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 260

This method adds the container of the UI to the current map.

Returns:
Type Description
void

__createToRSNavBar(){void}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 149

This method creates the top nav bar and adds it to the main container.

Returns:
Type Description
void

__setDefaults(options)

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 114

This method sets the default options of the UI.s

Name Type Description
options RSUIOptions

The options of the UI.

getId(){string}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 269

This method assing the id to the current container.

Returns:
Type Description
string

getInfoRSContainer(){RSUIInfoRSContainer}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 247

Retrieves the information container component.

Returns:
Type Description
RSUIInfoRSContainer The information container component.

getLang(){RSUILang}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 141

Allow to get the current lang of the UI.

Returns:
Type Description
RSUILang The class that handles the lang of the UI.

getLayer(){GoRemoteSensing}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 277

This method return the layer of this UI.

Returns:
Type Description
GoRemoteSensing The layer that contains the UI.

getTheme(){RSUITheme}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 133

Allow to get the current theme of the UI.

Returns:
Type Description
RSUITheme The class that handles the theme.

getTopRSNavBar(){RSUITopNavBar}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 239

Retrieves the top navigation bar component.

Returns:
Type Description
RSUITopNavBar The top navigation bar component.

getUIOptions(){RSUIOptions}

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 125

Allow to get the options of the UI.

Returns:
Type Description
RSUIOptions The options of the UI.

setInfoContainer(infoContainer)

Layers/GoRemoteSensing/clases/UI/components/RSUIMainContainer/index.ts, line 97

Replaces the current info container with a new one.

Name Type Description
infoContainer RSUIInfoRSContainer

The new info container to set.