new GoHighlight(userFeatures, userStyle, textFunction)
To create Highlight
| Name | Type | Description |
|---|---|---|
userFeatures |
string | Array.<Feature> |
User features. |
userStyle |
module:types~styleFromUser |
Styles for the highlight. |
textFunction |
function |
Function that returns the text to be displayed. |
Properties:
| Name | Type | Description |
|---|---|---|
highlightLayer |
VectorLayer.<VectorSource> | VectorImageLayer.<VectorSource> | Private - The layer to which you want to apply the highlight. |
idHighlight |
string | Private - The identificator of the hightlight. |
style |
style | Private - The style of the layer. |
originalStyle |
any | Private - The original style of the layer. |
textFunction |
function | Private - The text of the function. |
textFill |
fill | undefined | Private - The text of the fill. |
textStroke |
stroke | undefined | Private - The text of the stroke. |
id |
Array.<string> | Private - The identificator. |
styleOwnSVGcheck |
boolean | Private - The style of own SVG. |
Extends
- GOInteractionTool
- undefined
Methods
-
addFeatures(features){void}
Interactions/Features/interact/Highlight/GoHighlight.ts, line 270 -
Add features to HighLight Layer
Name Type Description featuresArray.<Feature> Array Features, If you want to add only one create an Array and push this feature like this [FEATURE]
Returns:
Type Description void - Returns nothing
-
changeStyle(userStyle){void}
Interactions/Features/interact/Highlight/GoHighlight.ts, line 243 -
Change style Highlight layer
Name Type Description userStylemodule:types~styleFromUser User Style to the feature
Returns:
Type Description void - Returns nothing
-
clearFeatures(){void}
Interactions/Features/interact/Highlight/GoHighlight.ts, line 278 -
Remove all features from HighLight Layer
Returns:
Type Description void - Returns nothing
-
getLayer(){VectorLayer.<VectorSource>|VectorImageLayer.<VectorSource>}
Interactions/Features/interact/Highlight/GoHighlight.ts, line 233 -
Obtain layer Highligth this is a Openlayers VectorLayer
Returns:
Type Description VectorLayer.<VectorSource> | VectorImageLayer.<VectorSource> -
getStyle(){Style|undefined}
Interactions/Features/interact/Highlight/GoHighlight.ts, line 224 -
Obtain layer style
Returns:
Type Description Style | undefined -
multipleFeatures(){void}
Interactions/Features/interact/Highlight/GoHighlight.ts, line 296 -
Add a feature to HighLight Layer
Returns:
Type Description void Return nothing -
setVisible(visible){void}
Interactions/Features/interact/Highlight/GoHighlight.ts, line 287 -
Set visible of HighLight Layer
Name Type Description visibleboolean True to make visible Highlight layer or false to disapear
Returns:
Type Description void - Returns nothing
-
setZIndex(zIndex){void}
Interactions/Features/interact/Highlight/GoHighlight.ts, line 260 -
Name Type Description zIndexThe z index
Returns:
Type Description void Returns nothing -
inherited typeLayerHidraulic(feature){string}
Interactions/utils/GoInteractionTool.ts, line 20 -
This function allow to create a style for the hidraulic layer.
Name Type Description featuremodule:types~FeatureLike The feature to style
Returns:
Type Description string Return the new style of the feature.
