Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "geometry/shape-factory"

Index

Type aliases

Functions

Type aliases

geometryProps

geometryProps: object

Type declaration

  • Optional buffer?: undefined | number
  • Optional bufferUnit?: LengthUnit
  • geometry: Geometry
  • id: string
  • Optional properties?: undefined | object
  • shape: Shape

Functions

Const makeBBoxGeo

  • Creates a Bounding Box GeometryJSON object

    Parameters

    • id: string

      unique id for geometry

    • extent: Extent

      Extent of bounding box

    • Default value properties: object = {}

      hash of properties to pass to new GeometryJSON

    Returns GeometryJSON

    GeometryJSON

Const makeGeometryJSONFromGeometry

  • makeGeometryJSONFromGeometry(__namedParameters: object): GeometryJSON

  • Parameters

    • __namedParameters: object
      • buffer: number
      • bufferUnit: "meters" | "kilometers" | "yards" | "feet" | "miles" | "nautical miles"
      • geometry: Polygon | Point | LineString
      • id: string
      • properties: object
      • shape: "Polygon" | "Bounding Box" | "Point Radius" | "Point" | "Line"

    Returns GeometryJSON

Const makeLineGeo

  • makeLineGeo(id: string, lonLatCoordinateList: [number, number][], buffer: number, bufferUnit: LengthUnit, properties?: object): GeometryJSON

  • Creates a Line GeometryJSON object

    Parameters

    • id: string

      unique id for geometry

    • lonLatCoordinateList: [number, number][]

      array of coordinates in the format of [[longitude, lattitude], ...]

    • buffer: number

      buffer size

    • bufferUnit: LengthUnit

      buffer size unit of measurement

    • Default value properties: object = {}

      hash of properties to pass to new GeometryJSON

    Returns GeometryJSON

    GeometryJSON

Const makePointGeo

  • makePointGeo(id: string, lat: number, lon: number, properties?: object): GeometryJSON

  • Creates a Point GeometryJSON object

    Parameters

    • id: string

      unique id for geometry

    • lat: number

      center lattitude

    • lon: number

      center longitude

    • Default value properties: object = {}

      hash of properties to pass to new GeometryJSON

    Returns GeometryJSON

    GeometryJSON

Const makePointRadiusGeo

  • makePointRadiusGeo(id: string, lat: number, lon: number, radius: number, radiusUnit: LengthUnit, properties?: object): GeometryJSON

  • Creates a Point Radius GeometryJSON object

    Parameters

    • id: string

      unique id for geometry

    • lat: number

      center lattitude

    • lon: number

      center longitude

    • radius: number

      radius length

    • radiusUnit: LengthUnit

      radius length unit of measurement

    • Default value properties: object = {}

      hash of properties to pass to new GeometryJSON

    Returns GeometryJSON

    GeometryJSON

Const makePolygonGeo

  • makePolygonGeo(id: string, lonLatCoordinateList: [number, number][], buffer: number, bufferUnit: LengthUnit, properties?: object): GeometryJSON

  • Creates a Polygon GeometryJSON object

    Parameters

    • id: string

      unique id for geometry

    • lonLatCoordinateList: [number, number][]

      array of coordinates in the format of [[longitude, lattitude], ...]

    • buffer: number

      buffer size

    • bufferUnit: LengthUnit

      buffer size unit of measurement

    • Default value properties: object = {}

      hash of properties to pass to new GeometryJSON

    Returns GeometryJSON

    GeometryJSON

Generated using TypeDoc