Class: Feature

cercaliagl.Feature


Javascript ES5

const feature = new cercaliagl.Feature({ ... });

A vector object for geographics features with a geometry and other attribute. Feature must need a geometry in GeoJSON format or in WKT format. Then there are many attributes to adjust this feature styles and events.
These events can defined in constructor or in runtime modifing attribute as onClick, onMouseOver, etc.

Example usage:

const feature = new cercaliagl.Feature({
  wkt: 'POLYGON((2.177722861 41.413683777, 2.174677572 41.411310103, 2.171263974 41.413372702, 2.174830286 41.416057364, 2.177722861 41.413683777))',
  strokeColor: '#550000',
  strokeWidth: 2,
  fillOpacity: 0.5,
  simpleLabel: new cercaliagl.SimpleLabel({text: 'Example polygon'}),
  onClick: () => alert('Polygon click'),
});
map.addFeature(feature);
map.centerToFeatures([feature]);

new Feature(options)

Feature.js, line 88
Name Type Description
options
Name Type Description
id string

Feature id
editable boolean

Feature editable using mouse. Default false.
fillColor string

Feature fill color. Default value #009BFF.
fillOpacity number

Feature fill opacity. Default value 0.2.
strokeOpacity number

Feature stroke opacity. Default value 1.
strokeColor string

Feature stroke color. Default value #2196F3.
strokeWidth number

Feature stroke width. Default value 7.
outline boolean

Enable outline feature property. If no outline required, specify null. Default value true.
outlineColor string

Feature outline color. Default value #040252.
outlineOpacity number

Feature outline opacity. Default value 1.
outlineWidth number

Feature outline width. Default value 9.
visible boolean

Feature visible or not. Default true.
encodedLineString string

Encoded wkt linestring polyline.
encodedPolygon string

Encoded polygon polyline wkt.
encodedMultiPolygon Array.<string>

Array of encoded wkt polygons.
encodedGoogleLineString string

Linestring wkt encoded on google polyline .
encodedGooglePolygon string

Polygon wkt encoded on google polyline .
encodedGoogleMultiPolygon Array.<string>

Array of polygon wkts encoded on google polyline .
visible boolean

Feature visible or not. Default true.
onClick function

Function to execute on marker click.
onDoubleClick function

Function to execute on marker double click.
onMouseOut function

Function to execute on Mouse Out.
onMouseOver function

Function to execute on Mouse Over.
onMouseMove function

Function to execute on Mouse Over.
onRightClick function

Function to execute on marker right click.
onModifyStart function

Function to execute on marker right click.
onModifyEnd function

Function to execute on modify end. When feature is editable.
wkt string

WKT String with shape geometry to be painted. Mandatory to use that or geometry property. More info: https://es.wikipedia.org/wiki/Well_Known_Text
simpleLabel module:cercaliagl/SimpleLabel~SimpleLabel

Marker Simple Label object.
geometry module:cercaliagl/util~Polygon

GeoJSON Geometry. Mandatory to use this property or wkt property. More info: https://geojson.org/ (From geometry property).
zIndex number

Z-Index. Default 0.
extraProperties Object.<string, string>

Extra properties to put inside geojson. Default {}.
encodedPrecision number

Precision of encoded data. Default 5.
height number

Default 0.
showDirection boolean

Default false.

Extends

Members

onModifyEnd{function} {null}

Optional callback for when modification ends

onModifyStart{function} {null}

Optional callback for when modification starts

Methods

module:cercaliagl/Feature~Feature.fromGeoJSON(geojsonFeature, featureOptions)

Feature.js, line 744
Name Type Description
geojsonFeature Object

GeoJSON feature
featureOptions

Feature options

Name Type Description
id string

Feature id
editable boolean

Feature editable using mouse. Default false.
fillColor string

Feature fill color. Default value #009BFF.
fillOpacity number

Feature fill opacity. Default value 0.2.
strokeOpacity number

Feature stroke opacity. Default value 1.
strokeColor string

Feature stroke color. Default value #2196F3.
strokeWidth number

Feature stroke width. Default value 7.
outline boolean

Enable outline feature property. If no outline required, specify null. Default value true.
outlineColor string

Feature outline color. Default value #040252.
outlineOpacity number

Feature outline opacity. Default value 1.
outlineWidth number

Feature outline width. Default value 9.
visible boolean

Feature visible or not. Default true.
encodedLineString string

Encoded wkt linestring polyline.
encodedPolygon string

Encoded polygon polyline wkt.
encodedMultiPolygon Array.<string>

Array of encoded wkt polygons.
encodedGoogleLineString string

Linestring wkt encoded on google polyline .
encodedGooglePolygon string

Polygon wkt encoded on google polyline .
encodedGoogleMultiPolygon Array.<string>

Array of polygon wkts encoded on google polyline .
visible boolean

Feature visible or not. Default true.
onClick function

Function to execute on marker click.
onDoubleClick function

Function to execute on marker double click.
onMouseOut function

Function to execute on Mouse Out.
onMouseOver function

Function to execute on Mouse Over.
onMouseMove function

Function to execute on Mouse Over.
onRightClick function

Function to execute on marker right click.
onModifyStart function

Function to execute on marker right click.
onModifyEnd function

Function to execute on modify end. When feature is editable.
wkt string

WKT String with shape geometry to be painted. Mandatory to use that or geometry property. More info: https://es.wikipedia.org/wiki/Well_Known_Text
simpleLabel module:cercaliagl/SimpleLabel~SimpleLabel

Marker Simple Label object.
geometry module:cercaliagl/util~Polygon

GeoJSON Geometry. Mandatory to use this property or wkt property. More info: https://geojson.org/ (From geometry property).
zIndex number

Z-Index. Default 0.
extraProperties Object.<string, string>

Extra properties to put inside geojson. Default {}.
encodedPrecision number

Precision of encoded data. Default 5.
height number

Default 0.
showDirection boolean

Default false.

get(key){*} inherited

BaseObject.js, line 30

Gets a value.

Name Type Description
key string

Key name.
Returns:
Value.

getBounds(){module:cercaliagl/Bounds~Bounds}

Feature.js, line 375

Get feature bounds.

getClosestCoordinate(position){module:cercaliagl/LonLat~LonLat}

Feature.js, line 417

Get closest feature coordinate giving a position.

Name Type Description
position module:cercaliagl/LonLat~LonLat

Position
Returns:
Closest coordinate to point

getExtraProperties(){Object.<string, string>}

Feature.js, line 757

Get extra properties

Returns:
Extra properties

getFillColor(){*}

Feature.js, line 589
Returns:
Return color in hexadecimal format. For example #ff0000

getFillOpacity(){number}

Feature.js, line 608

Get fill opacity

Returns:
Values between 0 and 1.

getGeoJSON(){module:cercaliagl/BaseFeature~CercaliaFeature} inherited

BaseFeature.js, line 193
Returns:
GeoJSON

getGeometry(){module:cercaliagl/util~Polygon|module:cercaliagl/util~LineString|module:cercaliagl/util~MultiPolygon|module:cercaliagl/util~MultiLineString}

Feature.js, line 426

Get feature Geometry

Returns:
Geometry

getGeometryType(){string} inherited

BaseFeature.js, line 201
Returns:
GeoJSON

getId(){String} inherited

BaseFeature.js, line 170
Returns:
Id

getLayer(){module:cercaliagl/layer/Feature~Feature} inherited

BaseFeature.js, line 185
Returns:
Layer

getMap(){module:cercaliagl/Map~Map} inherited

BaseFeature.js, line 209
Returns:
Map

getOutlineColor(){string}

Feature.js, line 681
Returns:
Return color in hexadecimal format. For example #ff0000

getOutlineOpacity(){number}

Feature.js, line 719

Get opacity

Returns:
Opacity. Values between 0 and 1.

getOutlineWidth(){number}

Feature.js, line 700

Get outline width

Returns:
Width.

getSimpleLabel(){module:cercaliagl/SimpleLabel~SimpleLabel}

Feature.js, line 479

Get simple label object. Returns `nullp if it doesn't exist.

Returns:
Simple label

getStrokeColor(){string}

Feature.js, line 645
Returns:
Return color in hexadecimal format. For example #ff0000

getStrokeOpacity(){number}

Feature.js, line 627

Get stroke opacity

Returns:
Values between 0 and 1.

getStrokeWidth(){number}

Feature.js, line 663
Returns:
Width.

getWKT(){string}

Feature.js, line 459

Get geometry in WKT format.

Returns:
Geometry in WKT format

isEditable(){boolean}

Feature.js, line 505

Obtain if feature is editable.

Returns:
is editable

isShowingDirection(){boolean}

Feature.js, line 523

Obtain if feature is showing direction.

Returns:
is showing direction

isVisible(){boolean}

Feature.js, line 561

Obtain if feature is visible

Returns:
Return true if feature is visible

set(key, value) inherited

BaseObject.js, line 44

Sets a value.

Name Type Description
key string

Key name.
value *

Value.

setEditable(editable)

Feature.js, line 514

Set editable feature

Name Type Description
editable boolean

true to become editable feature.

setExtraProperties(properties)

Feature.js, line 766

Set extra properties

Name Type Description
properties Object.<string, string>

Extra properties

setFillColor(color)

Feature.js, line 580

Change feature fill color

Name Type Description
color string

Color in hexadecimal format. For example: #ff0000.

setFillOpacity(opacity)

Feature.js, line 598

Fill opacity.

Name Type Description
opacity number

Values between 0 and 1.

setGeometry(geometry)

Feature.js, line 435

Set geometry and update it.

Name Type Description
geometry

Geometry

Name Type Description
type 'Polygon'

Must be 'Polygon'
coordinates Array.<Array.<Array.<number>>>

The coordinates array

setMap(map) inherited

BaseFeature.js, line 217
Name Type Description
map module:cercaliagl/Map~Map

Map

setOutlineColor(color)

Feature.js, line 672

Change feature outline color

Name Type Description
color string

Color in hexadecimal format. For example: #ff0000.

setOutlineOpacity(opacity)

Feature.js, line 709

Change outline opacity

Name Type Description
opacity number

Opacity. Values between 0 and 1.

setOutlineWidth(width)

Feature.js, line 690

Change feature outline width

Name Type Description
width number

Width.

setShowDirection(showDirection)

Feature.js, line 532

Set show direction feature

Name Type Description
showDirection boolean

true to show feature's direction.

setSimpleLabel(simpleLabel)

Feature.js, line 488

Set simple label and update it on map.

Name Type Description
simpleLabel module:cercaliagl/SimpleLabel~SimpleLabel | null

simple Label

setStrokeColor(color)

Feature.js, line 636

Change feature stroke color

Name Type Description
color string

Color in hexadecimal format. For example: #ff0000.

setStrokeOpacity(opacity)

Feature.js, line 617

Stroke opacity.

Name Type Description
opacity number

Values between 0 and 1.

setStrokeWidth(width)

Feature.js, line 654

Change feature stroke width

Name Type Description
width number

Width.

setVisible(visible)

Feature.js, line 570

Show or hide feature.

Name Type Description
visible boolean

Visible true, not visible false.

setWKT(wkt)

Feature.js, line 468

Set geometry in WKT format and update it on map.

Name Type Description
wkt string

WKT geometry

setZIndex(zIndex)

Feature.js, line 450

Set zIndex and update it.

Name Type Description
zIndex number

zIndex