Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "geometry/geometry"

Index

Type aliases

BufferShape

BufferShape: "circle" | "polygon/line"

Value allowed in BUFFER_SHAPE_PROPERTY

Extent

Extent: [number, number, number, number]

2D extent of a geometry represented as an array in the format of [minimumX, minimumY, maximumX, maximumY]

Geometry

Geometry: Polygon | Point | LineString

GeoJSON Geometries supported by GeometryJSON

GeometryJSON

GeometryJSON: Feature & object

Extended GeoJSON used to represent map geometry. For details on GeoJSON see: https://geojson.org/

GeometryJSONProperties

GeometryJSONProperties: object

Custom GeoJSON properties used in GeometryJSON

Type declaration

  • Optional buffer?: undefined | number

    Buffer size

  • bufferUnit: LengthUnit

    Buffer size unit of measurement

  • color: string

    CSS color of geometry

  • id: string

    Unique identifier

  • shape: Shape

    Shape of geometry

Variables

Const BUFFER_SHAPE_PROPERTY

BUFFER_SHAPE_PROPERTY: "bufferShape" = "bufferShape"

The BUFFER_SHAPE_PROPERTY is set in GeometryJSON to identify buffered geometry for use in dynamic styles.

Const CIRCLE_BUFFER_PROPERTY_VALUE

CIRCLE_BUFFER_PROPERTY_VALUE: "circle" = "circle"

BUFFER_SHAPE_PROPERTY value for circle buffer geometry

Const POLYGON_LINE_BUFFER_PROPERTY_VALUE

POLYGON_LINE_BUFFER_PROPERTY_VALUE: "polygon/line" = "polygon/line"

BUFFER_SHAPE_PROPERTY value for polygon and line buffer geometry

Object literals

Const DEFAULT_GEOMETRY

DEFAULT_GEOMETRY: object

Bounding Box

Bounding Box: Polygon = DEFAULT_POLYGON

Point

Point: Point = DEFAULT_POINT

Point Radius

Point Radius: Point = DEFAULT_POINT

Polygon

Polygon: Polygon = DEFAULT_POLYGON

Line

Line: object

coordinates

coordinates: number[][] = [[0, 0]]

type

type: "LineString" = "LineString"

Const DEFAULT_POINT

DEFAULT_POINT: object

coordinates

coordinates: number[] = [0, 0]

type

type: "Point" = "Point"

Const DEFAULT_POLYGON

DEFAULT_POLYGON: object

coordinates

coordinates: number[][][] = [[[0, 0]]]

type

type: "Polygon" = "Polygon"

Const DEFAULT_PROPERTIES

DEFAULT_PROPERTIES: object

buffer

buffer: number = 0

bufferUnit

bufferUnit: "meters" | "kilometers" | "yards" | "feet" | "miles" | "nautical miles" = METERS

color

color: string = "blue"

id

id: string = ""

shape

shape: "Polygon" = "Polygon"

Generated using TypeDoc