Module: cercaliagl/util

Methods

module:cercaliagl/util.areaMetricToImperial(area){string}

util.js, line 328

import {areaMetricToImperial} from 'cercaliagl/util';

Convert area metric to imperial.

Name	Type	Description
area	number	Area in ha

Returns:

Area in acrees.

module:cercaliagl/util.checkPolygonSegmentIntersection(feature){boolean}

util.js, line 811

import {checkPolygonSegmentIntersection} from 'cercaliagl/util';

Name	Type	Description
feature	module:maplibre-gl~GeoJSONFeature	Polygon geojson feature

Returns:

Return true if a polygon feature has intersections

module:cercaliagl/util.convertDmsToDecimal(input){string}

util.js, line 271

import {convertDmsToDecimal} from 'cercaliagl/util';

Convert degrees minutes seconds to decimal format.

Name	Type	Description
input	string	Input string. Format examples: 40° 03' 49.3" N, 3° 24' 42.2" W, 40°03'49"N 3°24'42" W

Returns:

Decimal format. Example 41.431,2.41431

module:cercaliagl/util.createCircleGeometry(center, radius, vertices){module:cercaliagl/util~Polygon}

util.js, line 111

import {createCircleGeometry} from 'cercaliagl/util';

Create circle geometry given a center, a radius and optionally number of vertices.

Name	Type	Description
center	module:cercaliagl/LonLat~LonLat	Center.
radius	number	Radius in meters
vertices	number	Number of vertices. Default 64.

Returns:

geometry

module:cercaliagl/util.createMaplibreSimpleMarker(element, position){module:maplibre-gl~Marker}

util.js, line 704

import {createMaplibreSimpleMarker} from 'cercaliagl/util';

Name	Type	Description
element	HTMLElement	HTML element to use as the marker
position	module:cercaliagl/LonLat~LonLat	The position where to place the marker

Returns:

The created maplibre-gl marker

module:cercaliagl/util.distanceBetweenPoints(coordA, coordB){number}

util.js, line 141

import {distanceBetweenPoints} from 'cercaliagl/util';

Name	Type	Description
coordA	Array.<number>	Position 1
coordB	Array.<number>	Position 2

Returns:

Distance

module:cercaliagl/util.distanceMetricToImperial(distance){string}

util.js, line 310

import {distanceMetricToImperial} from 'cercaliagl/util';

Convert distance metric to imperial.

Name	Type	Description
distance	number	Distance in meters.

Returns:

distanceImp Distance imperial format string.

module:cercaliagl/util.distanceTo(coordA, coordB){number}

util.js, line 172

import {distanceTo} from 'cercaliagl/util';

Calculation distance between two coordinates.

Name	Type	Description
coordA	module:cercaliagl/LonLat~LonLat	Coordinate 1,
coordB	module:cercaliagl/LonLat~LonLat	Coordinate 2.

Returns:

distance between two coordinates.

module:cercaliagl/util.downloadKmlFromWkt(wkt, filename)

util.js, line 382

import {downloadKmlFromWkt} from 'cercaliagl/util';

SaveW route as KML.

Name	Type	Description
wkt	string	WKT.
filename	string	Filename.

module:cercaliagl/util.downloadXmlToFile(strXML, filename)

util.js, line 360

import {downloadXmlToFile} from 'cercaliagl/util';

Download XML file passing a XML string.

Name	Type	Description
strXML	string	XML in string format
filename	string	Filename to download.

module:cercaliagl/util.geofencing(polygon, lonLat){boolean}

util.js, line 687

import {geofencing} from 'cercaliagl/util';

Returns true if the coordinate is inside polygon. Polygon must be in WKT format.

Name	Type	Description
polygon	string	Polygon WKT string
lonLat	module:cercaliagl/LonLat~LonLat	Coordinate

Returns:

Return true if position is inside polygon.

module:cercaliagl/util.geojsonToWKT(geojson){string}

util.js, line 495

import {geojsonToWKT} from 'cercaliagl/util';

Transform GeoJSON format to WKT.

Name	Type	Description
geojson	Object	GeoJSON - https://geojson.org/

Returns:

WKT - http://es.wikipedia.org/wiki/Well_Known_Text

module:cercaliagl/util.getAnchorStringEquivalent(){Array.<number>}

util.js, line 1036

import {getAnchorStringEquivalent} from 'cercaliagl/util';

Returns:

Anchor equivalent

module:cercaliagl/util.getClosestFeatureByPosition(position){module:cercaliagl/Feature~Feature}

util.js, line 640

import {getClosestFeatureByPosition} from 'cercaliagl/util';

Get closest feature by a position given a position and a list of features.

Name	Type	Description
position	module:cercaliagl/LonLat~LonLat	Position * @param {Array.module:cercaliagl/Feature~Feature} features Features

Returns:

Feature,

module:cercaliagl/util.getClosestLonLatOfFeature(position, feature){module:cercaliagl/LonLat~LonLat}

util.js, line 598

import {getClosestLonLatOfFeature} from 'cercaliagl/util';

Get closest position of a feature given a coordinate (position)

Name	Type	Description
position	module:cercaliagl/LonLat~LonLat	Position
feature	module:cercaliagl/Feature~Feature	Feature

Returns:

Coordinate of closest feature

module:cercaliagl/util.getLinestringIntersectionsWithPolygon(polygonFeature, lineFeature){Array.<module:@turf/helpers~Feature.<module:@turf/helpers~LineString>>}

util.js, line 855

import {getLinestringIntersectionsWithPolygon} from 'cercaliagl/util';

Find intersections between a polygon and a linestring

Name	Type	Description
polygonFeature	module:cercaliagl/Feature~Feature	Polygon geojson feature 1
lineFeature	module:cercaliagl/Feature~Feature	Linestring geojson feature 2

Returns:

Return line segments inside polygon

module:cercaliagl/util.getPartialLinestring(feature, startfraction, endfraction){string|null}

util.js, line 968

import {getPartialLinestring} from 'cercaliagl/util';

It obtains a partial line in WKT format specifying minimum and maximum percentages in base 1.

Name	Type	Description
feature	module:cercaliagl/Feature~Feature	Feature
startfraction	number	Min fraction [0..1]
endfraction	number	Max fraction [0..1]

Returns:

WKT

module:cercaliagl/util.getProximityFormattedAddress(data){string}

util.js, line 286

import {getProximityFormattedAddress} from 'cercaliagl/util';

Get formatted adrress from proximity server data response.

Name	Type	Description
data	Proximity result Name Type Description cercalia module:cercaliagl/servers~ProximityResultData

Returns:

Formatted address.

module:cercaliagl/util.textRemoveHTMLTags(str){string}

util.js, line 776

import {textRemoveHTMLTags} from 'cercaliagl/util';

Remove HTML tags from a string.

Name	Type	Description
str	string	String with HTML

Returns:

String without HTML tags

module:cercaliagl/util.toRadians(angle){number}

util.js, line 99

import {toRadians} from 'cercaliagl/util';

Convert degrees to radiants.

Name	Type	Description
angle	number	Angle in degrees

Returns:

Angle in radiants.

module:cercaliagl/util.transformWKT(wkt, projectionSrc, projectionDst){string}

util.js, line 1013

import {transformWKT} from 'cercaliagl/util';

Transform WKT string to another projection.

Name	Type	Description
wkt	string	WKT http://es.wikipedia.org/wiki/Well_Known_Text
projectionSrc	string	Projection WKT origin
projectionDst	string	Projection WKT destination

Returns:

Geometry in WKT format transformed.

module:cercaliagl/util.transformWktToKML(wkt){string}

util.js, line 348

import {transformWktToKML} from 'cercaliagl/util';

Transform WKT to KML format (https://developers.google.com/kml/documentation/kmlreference).

Name	Type	Description
wkt	string	Geometry in WKT format.

Returns:

KML object.

module:cercaliagl/util.wktLinestringToPolygonBuffered(wkt, radius)

util.js, line 505

import {wktLinestringToPolygonBuffered} from 'cercaliagl/util';

Transform linestring to polygon adding a buffer.

Name	Type	Description
wkt	string	WKT - http://es.wikipedia.org/wiki/Well_Known_Text
radius	number	Radius. Default 10.

module:cercaliagl/util.wktToGeometry(wkt){GeoJSON}

util.js, line 485

import {wktToGeometry} from 'cercaliagl/util';

WKT to Geometry.

Name	Type	Description
wkt	string	WKT - http://es.wikipedia.org/wiki/Well_Known_Text

Returns:

GeoJSON - https://geojson.org/

Type Definitions

LineFeature{Object}

Properties:

Name	Type	Description
type	'Feature'	Must be 'Feature'
properties	Object	Any properties
geometry	module:cercaliagl/util~LineString | module:cercaliagl/util~MultiLineString	The geometry object

LineString{Object}

Properties:

Name	Type	Description
type	'LineString'	Must be 'LineString'
coordinates	Array.<Array.<number>>	The coordinates array

MultiLineString{Object}

Properties:

Name	Type	Description
type	'MultiLineString'	Must be 'MultiLineString'
coordinates	Array.<Array.<Array.<number>>>	The coordinates array

MultiPolygon{Object}

Properties:

Name	Type	Description
type	'MultiPolygon'	Must be 'MultiPolygon'
coordinates	Array.<Array.<Array.<Array.<number>>>>	The coordinates array

Point{Object}

Properties:

Name	Type	Description
type	'Point'	Must be 'Point'
coordinates	Array.<number>	The coordinates array [longitude, latitude]

Polygon{Object}

Properties:

Name	Type	Description
type	'Polygon'	Must be 'Polygon'
coordinates	Array.<Array.<Array.<number>>>	The coordinates array

PolygonFeature{Object}

Properties:

Name	Type	Description
type	'Feature'	Must be 'Feature'
properties	Object	Any properties
geometry	module:cercaliagl/util~Polygon | module:cercaliagl/util~MultiPolygon	The geometry object