new GoMapBoxLayer(layerOpts, topicId)
| Name | Type | Description |
|---|---|---|
layerOpts |
module:types~LayerOptsMapbox |
The layer options. |
topicId |
string |
The topic id. |
Properties:
| Name | Type | Description |
|---|---|---|
response |
string |
Extends
- GOLayer
- undefined
Methods
-
inherited addInteractions(interactions){GoLayerInteractions}
Layers/GoLayer/index.ts, line 184 -
Adds interactions to the layer.
Name Type Description interactionsLayerInteractions The interactions to be added to the layer.
Returns:
Type Description GoLayerInteractions The interactions object associated with the layer. -
canFilter(){boolean}
Layers/GoBaseMapLayer/MapBox/index.ts, line 84 -
Determines if the layer can be filtered.
Returns:
Type Description boolean False, as this layer cannot be filtered. -
inherited changeLayerOpacity(opacity){void}
Layers/GoLayer/index.ts, line 167 -
Changes the opacity of the layer.
Name Type Description opacitynumber The new opacity value (0-100).
Returns:
Type Description void -
inherited emit(eventName, args){void}
Layers/GoLayer/index.ts, line 227 -
Emits an event to all registered listeners for the specified event.
Name Type Description eventNamestring The name of the event to emit.
argsArray.<any> repeatable Additional arguments to pass to the event listeners.
Returns:
Type Description void -
inherited getAlias(){string}
Layers/GoLayer/index.ts, line 416 -
Gets the alias of the layer.
Returns:
Type Description string The alias of the layer. -
inherited getEventHandlers(eventName){Array.<function()>}
Layers/GoLayer/index.ts, line 246 -
Gets the event handlers for the specified event.
Name Type Description eventNamestring The name of the event to retrieve handlers for.
Returns:
Type Description Array.<function()> An array of event handler functions. -
inherited getExtent(){Array.<number>|null}
Layers/GoLayer/index.ts, line 547 -
Gets the geographical extent of the layer.
Returns:
Type Description Array.<number> | null The extent as an array of numbers or null if the extent is not defined. -
inherited getId(){string}
Layers/GoLayer/index.ts, line 424 -
Gets the unique identifier of the layer.
Returns:
Type Description string The layer ID. -
getLayer(){TileLayer.<TileSource>}
Layers/GoBaseMapLayer/MapBox/index.ts, line 95 -
Gets the OpenLayers tile layer.
Returns:
Type Description TileLayer.<TileSource> The tile layer. -
inherited getLayerName(){string}
Layers/GoLayer/index.ts, line 432 -
Gets the name of the layer.
Returns:
Type Description string The name of the layer. -
inherited getLayerOpts(){types.layerOptions}
Layers/GoLayer/index.ts, line 408 -
Gets the options used to configure the layer.
Returns:
Type Description types.layerOptions The layer configuration options. -
inherited getLayerProjection(){string}
Layers/GoLayer/index.ts, line 584 -
Get the projection code of the layer.
Returns:
Type Description string The projection code of the layer. -
Gets the style associated with the layer.
Returns:
Type Description GoStyle The style of the layer. -
inherited getLayerType(){string}
Layers/GoLayer/index.ts, line 448 -
Gets the type of the layer.
Returns:
Type Description string The layer type. -
inherited getLayerUrl()
Layers/GoLayer/index.ts, line 107 -
get layerUrl
-
inherited getMaxResolution(){number}
Layers/GoLayer/index.ts, line 464 -
Gets the maximum resolution at which the layer is visible.
Returns:
Type Description number The maximum resolution. -
inherited getMinResolution(){number}
Layers/GoLayer/index.ts, line 472 -
Gets the minimum resolution at which the layer is visible.
Returns:
Type Description number The minimum resolution. -
inherited getOlMap(){OlMap}
Layers/GoLayer/index.ts, line 400 -
Gets the OpenLayers map instance associated with the layer.
Returns:
Type Description OlMap The OpenLayers map instance. -
inherited getOptions(){layerOptions}
Layers/GoLayer/index.ts, line 567 -
Gets the options used to configure the layer.
Returns:
Type Description layerOptions The layer configuration options. -
inherited getUrl(){string}
Layers/GoLayer/index.ts, line 440 -
Gets the URL associated with the layer.
Returns:
Type Description string The URL of the layer. -
getVisibility(){boolean}
Layers/GoBaseMapLayer/MapBox/index.ts, line 103 -
Gets the visibility status of the layer.
Returns:
Type Description boolean The visibility status of the layer. -
inherited getZIndex(){number}
Layers/GoLayer/index.ts, line 456 -
Gets the z-index of the layer.
Returns:
Type Description number The z-index value. -
inherited goMap(){void}
Layers/GoLayer/index.ts, line 130 -
This function allow to get the map.
Returns:
Type Description void Return GOStagingMap -
inherited hasEvent(eventName){boolean}
Layers/GoLayer/index.ts, line 237 -
Checks if there are listeners registered for the specified event.
Name Type Description eventNamestring The name of the event to check for listeners.
Returns:
Type Description boolean True if there are listeners for the event, false otherwise. -
inherited hasFilter(){boolean}
Layers/GoLayer/index.ts, line 305 -
Checks if this layer currently has a filter applied.
Returns:
Type Description boolean True if a filter is applied, false otherwise. -
inherited isBaseLayer(){boolean}
Layers/GoLayer/index.ts, line 158 -
Checks if the layer is a base layer.
Returns:
Type Description boolean True if the layer is a base layer, false otherwise. -
inherited off(eventName, callback){void}
Layers/GoLayer/index.ts, line 217 -
Removes an event listener for the specified event.
Name Type Description eventNamestring optional The name of the event to remove the listener from.
callbackfunction optional The callback function to remove.
Returns:
Type Description void -
inherited on(eventName, callback){void}
Layers/GoLayer/index.ts, line 197 -
Registers an event listener for the specified event.
Name Type Description eventNamestring The name of the event to listen for.
callbackfunction The callback function to invoke when the event is fired.
Returns:
Type Description void -
inherited onLayerLoaded(){Promise.<unknown>}
Layers/GoLayer/index.ts, line 175 -
Returns a promise that resolves when the layer is fully loaded.
Returns:
Type Description Promise.<unknown> A promise that resolves when the layer is loaded. -
inherited onPropChange(obj, prop, callback){void}
Layers/GoLayer/index.ts, line 258 -
Monitors changes to a specific property of an object and fires an event when the property changes.
Name Type Description objObject The object containing the property to monitor.
propstring The name of the property to monitor.
callbackfunction The callback function to invoke when the property changes.
Returns:
Type Description void -
inherited once(eventName, callback){void}
Layers/GoLayer/index.ts, line 207 -
Registers a one-time event listener for the specified event.
Name Type Description eventNamestring The name of the event to listen for once.
callbackfunction The callback function to invoke when the event is fired.
Returns:
Type Description void -
inherited removeFilter(){void}
Layers/GoLayer/index.ts, line 355 -
Removes the filter applied to the layer, resetting it to the default state. Forces the layer to refresh after removing the filter.
Returns:
Type Description void -
inherited setLayerStyle(style){void|Promise}
Layers/GoLayer/index.ts, line 629 -
Sets the style of the layer and optionally adds annotations if applicable.
Name Type Description styleArray.<GoGlobalStyle> | GoGlobalStyle optional The style or array of styles to apply.
Returns:
Type Description void | Promise - Returns nothing or a promise depending on the type of style applied.
-
inherited setMaxResolution(maxResolution){void}
Layers/GoLayer/index.ts, line 611 -
Sets the maximum resolution at which the layer is visible.
Name Type Description maxResolutionnumber The maximum resolution value.
Returns:
Type Description void -
inherited setMinResolution(minResolution){void}
Layers/GoLayer/index.ts, line 620 -
Sets the minimum resolution at which the layer is visible.
Name Type Description minResolutionnumber The minimum resolution value.
Returns:
Type Description void -
inherited setVisibility(visibility){void}
Layers/GoLayer/index.ts, line 593 -
Sets the visibility of the layer.
Name Type Description visibilityboolean True to make the layer visible, false to hide it.
Returns:
Type Description void -
inherited setZIndex(zIndex){void}
Layers/GoLayer/index.ts, line 602 -
Sets the z-index of the layer.
Name Type Description zIndexnumber The z-index value to set.
Returns:
Type Description void -
type(){GOLayerType}
Layers/GoBaseMapLayer/MapBox/index.ts, line 76 -
Returns the type of the layer.
Returns:
Type Description GOLayerType The layer type. -
inherited unmount(){void}
Layers/GoLayer/index.ts, line 88 -
Unmount function
Returns:
Type Description void -
inherited validateLayerConfig(layerOpts){void}
Layers/GoLayer/index.ts, line 116 -
Validates the layer configuration and sets default values if necessary.
Name Type Description layerOptstypes.layerOptions The layer options to validate.
Returns:
Type Description void