new GOClusterLayer(layerOpts, topicId, map)
| Name | Type | Description |
|---|---|---|
layerOpts |
module:types~layerOptions |
The layer options. |
topicId |
string |
The topic id. |
map |
module:types~OlMap |
The map. |
Properties:
| Name | Type | Description |
|---|---|---|
clusterCounter |
number | |
extAnnotation |
Map.<string, types.clusterExtAnnotation> | |
layerProjection |
string | |
toProjection |
string |
Extends
- GOStyledLayer
- undefined
Methods
-
addFeatures(data, clear)
Layers/GoClusterLayer/index.ts, line 642 -
Add features to the layer.
Name Type Description dataObject The data to add to the layer.
clearboolean Whether to clear existing features before adding new ones.
-
inherited addFilterNoCQL(filter){void}
Layers/GoStyledLayer/index.ts, line 194 -
Adds a filter to the layer without using CQL.
Name Type Description filtertypes.filterNoCQL The filter to add.
Returns:
Type Description void -
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. -
inherited addStyleFunction(styleFunction){void}
Layers/GoStyledLayer/index.ts, line 233 -
Adds a style function to the layer.
Name Type Description styleFunctiontypes.styleFunction The style function to add.
Returns:
Type Description void -
canFilter(){boolean}
Layers/GoClusterLayer/index.ts, line 459 -
Check if the layer can be filtered.
Returns:
Type Description boolean True if the layer can be filtered, false otherwise. -
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 changeStyleConditional(style, clear){void}
Layers/GoStyledLayer/index.ts, line 133 -
Changes the style of the layer based on style conditions.
Name Type Default Description styletypes.styleGeojson | types.styleSVG The style information.
clearboolean false optional Whether to clear existing styles.
Returns:
Type Description void -
inherited changeStyleFromJSON(style){Style}
Layers/GoStyledLayer/index.ts, line 147 -
This function allow to change the style of the layer from a JSON
Name Type Description styletypes.styleGeojson Style Styles to apply over the layer
Returns:
Type Description Style - Return Style
-
checkSameGeom(features){boolean}
Layers/GoClusterLayer/index.ts, line 624 -
Check if all features in a cluster have the same geometry.
Name Type Description featuresArray.<Feature> The features in the cluster.
Returns:
Type Description boolean True if all features have the same geometry, false otherwise. -
inherited clasificationEnumTypeCQLGeometry(f, field, type, value){string}
Layers/GoStyledLayer/index.ts, line 252 -
This function allow to clasify the CQL filters of the type Geometry
Name Type Description fany The feature
fieldstring The field of the condition
typestring The type of the condition
valueArray.<any> The value of the condition
Returns:
Type Description string Return the CQL filter type Geometry. -
clusterCallback(callback)
Layers/GoClusterLayer/index.ts, line 388 -
Set the cluster callback function.
Name Type Description callbackfunction The callback function.
-
clusterStyleFunction(feature){Array.<Style>}
Layers/GoClusterLayer/index.ts, line 747 -
Define the cluster style for features in the layer.
Name Type Description featureFeature.<Geometry> The cluster feature.
Returns:
Type Description Array.<Style> An array of styles for the cluster feature. -
inherited createStyleFunction(mapUnits){function}
Layers/GoStyledLayer/index.ts, line 323 -
This function allow to create the styles of the layer
Name Type Description mapUnitsboolean The units of the map
Returns:
Type Description function A function that can be set as an OpenLayers style function. -
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 -
envelope()
Layers/GoClusterLayer/index.ts, line 404 -
Calculate and display the envelope (convex hull) of the cluster layer.
-
featureCluster(feature){string}
Layers/GoClusterLayer/index.ts, line 379 -
This function allow to set cluster feature
Name Type Description featuremodule:types~FeatureLike The feature to set
Returns:
Type Description string Return the feature. -
inherited fixIconPaths(styleName, origin){void}
Layers/GoStyledLayer/index.ts, line 339 -
This function allow to fix the paths of the icons
Name Type Description styleNamestring The name of the style
originstring The origin of the icon
Returns:
Type Description void Return nothing -
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. -
getFeaturesfromUrl(url){CancelablePromise.<(Array.<Feature>|Feature)>}
Layers/GoClusterLayer/index.ts, line 477 -
Get features from a specified URL.
Name Type Description urlstring The URL from which to fetch features.
Returns:
Type Description CancelablePromise.<(Array.<Feature>|Feature)> A CancelablePromise that resolves to an array of features or a single feature. -
getGeometryType(layerGeomType){GOGeometryType}
Layers/GoClusterLayer/index.ts, line 890 -
This method allow to get the geometry type.
Name Type Description layerGeomTypemodule:types~GeometryType Description of the condition
Returns:
Type Description GOGeometryType Return the geometry type. -
inherited getId(){string}
Layers/GoLayer/index.ts, line 424 -
Gets the unique identifier of the layer.
Returns:
Type Description string The layer ID. -
inherited getInitialStyle(keyStyle){Style}
Layers/GoStyledLayer/index.ts, line 546 -
Retrieves the initial style based on the provided key style.
Name Type Description keyStylestring The key to determine the type of style to retrieve ("json" or "svg").
Throws:
-
Throws an error if the keyStyle is not recognized or if an error occurs while processing the style.
- Type
- Error
Returns:
Type Description Style The initial style based on the key style provided. -
-
inherited getLabelField(){string}
Layers/GoStyledLayer/index.ts, line 380 -
Retrieves the label field from the style's text symbolizer.
Throws:
-
Throws an error if the text symbolizer is not found or if label type is not "expression".
- Type
- Error
Returns:
Type Description string The label field value. -
-
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 getMapStyle(idStyle){Map}
Layers/GoStyledLayer/index.ts, line 465 -
Retrieves the map style associated with the specified style ID. If no ID is provided, retrieves the initial style.
Name Type Description idStylestring optional The ID of the style to retrieve.
Returns:
Type Description Map The map of styles associated with the specified ID or initial style. -
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 getSLD(sldStyle, idLayer){CancelablePromise.<types.sldConfiguration>}
Layers/GoStyledLayer/index.ts, line 434 -
Retrieves the SLD (Styled Layer Descriptor) configuration based on the provided style options and layer ID.
Name Type Description sldStyletypes.styleOptions The style options containing the URL for the SLD.
idLayerstring The ID of the layer for which the SLD configuration is requested.
Returns:
Type Description CancelablePromise.<types.sldConfiguration> A promise that resolves to the SLD configuration. -
inherited getStyleFromSLD(sldStyle){CancelablePromise.<types.sldStyleFunction>}
Layers/GoStyledLayer/index.ts, line 393 -
Retrieves the SLD (Styled Layer Descriptor) configuration based on the provided style options.
Name Type Description sldStyletypes.styleOptions The style options containing the URL for the SLD.
Returns:
Type Description CancelablePromise.<types.sldStyleFunction> A promise that resolves to the SLD style function. -
inherited getStyleFunction(){types.sldStyleFunction}
Layers/GoStyledLayer/index.ts, line 371 -
Retrieves the style function associated with the layer.
Returns:
Type Description types.sldStyleFunction The style function for the layer. -
inherited getURLDownload(formatOutput){Array.<string>}
Layers/GoStyledLayer/index.ts, line 502 -
This function allow to get the URL to download any layer stored in Geoserver.
Name Type Description formatOutputstring Format of the output file
Returns:
Type Description Array.<string> Return an array of string [idLayer, formatOutput, url] -
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. -
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 hasLabelStyle(){boolean}
Layers/GoStyledLayer/index.ts, line 84 -
Determines if the layer has a label style.
Returns:
Type Description boolean True if label style exists, otherwise false. -
haveFilter(){boolean}
Layers/GoClusterLayer/index.ts, line 451 -
Check if the layer has a filter.
Returns:
Type Description boolean True if the layer has a filter, 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. -
isGeometryType(type){boolean}
Layers/GoClusterLayer/index.ts, line 495 -
This function allow to get the geometry types.
Name Type Description typestring The type to check.
Returns:
Type Description boolean Return true if the type is a geometry type. -
layerRenderListener(event)
Layers/GoClusterLayer/index.ts, line 672 -
Listener for the layer's prerender event to handle style changes.
Name Type Description eventObject The prerender event object.
-
asyncloader(extent){Promise.<any>}
Layers/GoClusterLayer/index.ts, line 504 -
Asynchronous data loader for the layer.
Name Type Description extentExtent The extent to load data for.
Returns:
Type Description Promise.<any> A promise that resolves with the loaded data. -
inherited mapStyleConditionGeometry(f, geometryFilter){string}
Layers/GoStyledLayer/index.ts, line 97 -
Maps style conditions based on geometry filter.
Name Type Description fFeature.<Geometry> The feature.
geometryFilterObject The geometry filter.
Name Type Description fieldstring The field of the condition.
typestring The type of the condition.
conditionArray.<any> The condition values.
Returns:
Type Description string The CQL filter for geometry. -
inherited mapStyleConditionSVG(style, clear){CancelablePromise.<Map.<string, Style>>}
Layers/GoStyledLayer/index.ts, line 111 -
Maps style conditions based on SVG styles.
Name Type Default Description styleArray.<types.styleConditionSVG> Array of SVG style conditions.
clearboolean false optional Whether to clear existing conditions.
Returns:
Type Description CancelablePromise.<Map.<string, Style>> A promise that resolves to a map of style conditions. -
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 -
radiousStyler(size){void}
Layers/GoClusterLayer/index.ts, line 691 -
This function allow to set the radius of the layer
Name Type Description sizenumber The radius size to set
Returns:
Type Description void Return nothing -
refresh()
Layers/GoClusterLayer/index.ts, line 395 -
Refresh the layer's source.
-
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 removeFilterNoCQL(filter){void}
Layers/GoStyledLayer/index.ts, line 215 -
Removes a filter from the layer without using CQL.
Name Type Description filtertypes.filterNoCQL The filter to remove.
Returns:
Type Description void -
setCustomIcons(styleSVG, styleSVGClusterInd, styleSVGCluster){Promise.<void>}
Layers/GoClusterLayer/index.ts, line 945 -
Sets icons for the layer based on the provided styles.
Name Type Description styleSVGstring optional SVG icon for individual features.
styleSVGClusterIndstring optional SVG icon used when two features share the same coordinates.
styleSVGClusterstring optional SVG icon displayed inside the cluster marker.
Returns:
Type Description Promise.<void> A promise that resolves when all icons have been set. -
setIcons(){Promise.<void>}
Layers/GoClusterLayer/index.ts, line 925 -
Sets icons for the layer based on provided styles.
Returns:
Type Description Promise.<void> A promise that resolves when the icons are set. -
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 setStyleValues(styleInfoSVG, clear){CancelablePromise.<Map.<string, Style>>}
Layers/GoStyledLayer/index.ts, line 579 -
Sets style values based on the provided SVG style information and optionally clears existing styles.
Name Type Description styleInfoSVGany The SVG style information to set.
clearboolean optional Optional flag to clear existing styles before applying the new ones.
Returns:
Type Description CancelablePromise.<Map.<string, Style>> A promise that resolves to a map of style values. -
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(){string}
Layers/GoClusterLayer/index.ts, line 467 -
Get the type of the layer.
Returns:
Type Description string The type of the layer ("GOClusterLayer"). -
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