Class: Go3dMap

Go3dMap

Represents a 3D map with configurable views, plugins, and widgets.

new Go3dMap(loader, mapConfig)

GoMap/Map/index.ts, line 19

Creates an instance of Go3dMap.

Name	Type	Description
`loader`	Go3dMapLoader	The loader responsible for loading the map.
`mapConfig`	Go3dMapConfigItem	Configuration for the map.

Methods

addPlugin(pluginOptions) GoMap/Map/index.ts, line 71

Adds a new plugin to the map.

Name	Type	Description
`pluginOptions`	Go3dPluginsConfig	Configuration for the new plugin.

addWidget(widgetOptions) GoMap/Map/index.ts, line 80

Adds a new widget to the map.

Name	Type	Description
`widgetOptions`	Go3dWidgetsConfig	Configuration for the new widget.

getMapConfig(){Go3dMapConfigItem} GoMap/Map/index.ts, line 246

Gets the configuration for the map.

Returns:

Type	Description
Go3dMapConfigItem	The map configuration.

getMapMode(){"dev"|"pro"} GoMap/Map/index.ts, line 238

Gets the current map mode.

Returns:

Type	Description
"dev" \| "pro"	The current map mode.

getPlugin(pluginId){BasePlugin|undefined} GoMap/Map/index.ts, line 53

Gets a specific plugin by its ID.

Name	Type	Description
`pluginId`	string	The ID of the plugin.

Returns:

Type	Description
BasePlugin \| undefined	The plugin if found, otherwise `undefined`.

getPlugins(){Map.<string, BasePlugin>} GoMap/Map/index.ts, line 44

Gets all plugins associated with the map.

Returns:

Type	Description
Map.<string, BasePlugin>	A map of plugins.

getView(viewId){Go3dView|undefined} GoMap/Map/index.ts, line 230

Gets a specific view by its ID.

Name	Type	Description
`viewId`	string	The ID of the view.

Returns:

Type	Description
Go3dView \| undefined	The view if found, otherwise `undefined`.

getViews(){Map.<string, Go3dView>} GoMap/Map/index.ts, line 221

Gets all views associated with the map.

Returns:

Type	Description
Map.<string, Go3dView>	A map of views.

getWidget(widgetId){BaseWidget|undefined} GoMap/Map/index.ts, line 108

Gets a specific widget by its ID.

Name	Type	Description
`widgetId`	string	The ID of the widget.

Returns:

Type	Description
BaseWidget \| undefined	The widget if found, otherwise `undefined`.

getWidgets(){Map.<string, BaseWidget>} GoMap/Map/index.ts, line 99

Gets all widgets associated with the map.

Returns:

Type	Description
Map.<string, BaseWidget>	A map of widgets.

removePlugin(pluginId) GoMap/Map/index.ts, line 61

Removes a plugin by its ID.

Name	Type	Description
`pluginId`	string	The ID of the plugin to remove.

removeWidget(widgetId) GoMap/Map/index.ts, line 89

Removes a widget by its ID.

Name	Type	Description
`widgetId`	string	The ID of the widget to remove.