External module "geometry/utilities"

Index

Variables

Functions

Variables

Const MINIMUM_BUFFERED_LINE_COORDINATE_LENGTH

MINIMUM_BUFFERED_LINE_COORDINATE_LENGTH: 2 = 2

Const MINIMUM_BUFFERED_POLYGON_COORDINATE_LENGTH

MINIMUM_BUFFERED_POLYGON_COORDINATE_LENGTH: 4 = 4

Const bboxMaxX

bboxMaxX: 2 = 2

Const bboxMaxY

bboxMaxY: 3 = 3

Const bboxMinX

bboxMinX: 0 = 0

Const bboxMinY

bboxMinY: 1 = 1

Const shapeDetector

shapeDetector: ShapeDetector = new ShapeDetector()

Functions

Const bboxToExtent

bboxToExtent(bbox: turf.BBox): Extent

- Defined in geometry/utilities.tsx:194
Converts an arbitrary bbox value from GeoJSON to a 2D extent value

Parameters
- bbox: turf.BBox
  
  2D/3D GeoJSON bbox value
Returns Extent

Extent

cloneDeep

cloneDeep<T>(o: T): T

- Defined in geometry/utilities.tsx:17
Type parameters
- T
Parameters
- o: T
Returns T

Const combineExtents

combineExtents(extentList: Extent[]): Extent

- Defined in geometry/utilities.tsx:224
Calculates the combined 2D extent of an array of 2D extents

Parameters
- extentList: Extent[]
  
  array of extents if this is empty then [0, 0, 0, 0] is returned
Returns Extent

Extent

Const geoJSONToGeometryJSON

geoJSONToGeometryJSON(id: string, json: any): GeometryJSON

- Defined in geometry/utilities.tsx:45
Creates a full GeometryJSON object from a Feature or Geometry GeoJSON object

Parameters
- id: string
  
  unique id for geometry
- json: any
  
  GeoJSON object
Returns GeometryJSON

GeometryJSON

Const geoToExtent

geoToExtent(geo: GeometryJSON | Geometry): Extent

- Defined in geometry/utilities.tsx:208
Calculates the 2D extent of a GeometryJSON object

Parameters
- geo: GeometryJSON | Geometry
  
  GeometryJSON or Geometry object
Returns Extent

Extent

Const getBufferPropOrDefault

getBufferPropOrDefault(properties: GeometryJSONProperties): Buffer

- Defined in geometry/utilities.tsx:34
Returns a buffer property for the geometry providing a default empty value if there is no buffer property present

Parameters
- properties: GeometryJSONProperties
  
  GeometryJSON properties
Returns Buffer

Buffer

Const makeBufferedGeo

makeBufferedGeo(geo: GeometryJSON): GeometryJSON

- Defined in geometry/utilities.tsx:139
Creates a buffered GeometryJSON object from a source GeometryJSON object using it's geometry and buffer values

Parameters
- geo: GeometryJSON
  
  source GeometryJSON object
Returns GeometryJSON

GeometryJSON with buffer applied

Const makeEmptyGeometry

makeEmptyGeometry(id: string, shape: Shape, properties?: object): GeometryJSON

- Defined in geometry/utilities.tsx:111
Creates an empty GeometryJSON object

Parameters
- id: string
  
  unique id for geometry
- shape: Shape
  
  geometry shape
- Default value properties: object = {}
Returns GeometryJSON

GeometryJSON

Const makeGeometry

makeGeometry(id: string, geometryGeoJSON: any, color: string, shape: Shape, buffer?: number, bufferUnit?: LengthUnit, properties?: object): GeometryJSON

- Defined in geometry/utilities.tsx:73
Creates a full GeometryJSON object from a GeoJSON Geometry object

Parameters
- id: string
  
  unique id for geometry
- geometryGeoJSON: any
  
  GeoJSON Geometry object to extend
- color: string
  
  CSS color for geometry
- shape: Shape
  
  geometry shape
- Default value buffer: number = 0
- Default value bufferUnit: LengthUnit = METERS
- Default value properties: object = {}
Returns GeometryJSON

GeometryJSON

Generated using TypeDoc