Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MultiPolygon

The MultiPolygon class is a type of GeometryObject representing a MultiPolygon.

example


var multiPolyGeometryObject = { type: "MultiPolygon", coordinates: [[[[-82.4, 29.2], [-82.4, 29.5], [-82.1, 29.5], [-82.1, 29.2], [-82.4, 29.2]], [[-81.4, 28.2], [-81.4, 28.5], [-81.1, 28.5], [-81.1, 28.2], [-81.4, 28.2]]]] };
var multiPoly=new MultiPolygon(multiPolyGeometryObject);

Hierarchy

  • MultiPolygon

Implements

Index

Constructors

constructor

  • Parameters

    Returns MultiPolygon

  • Parameters

    Returns MultiPolygon

  • Parameters

    Returns MultiPolygon

Properties

bbox

  • get bbox(): number[]
  • Retrieves an array of numbers that represent the bounding box of this MultiPolygon.

    Returns number[]

coordinates

coordinates: Position[][][] = []

The coordinates property is an array of an array of an array of Position.

Private terraPrimitive

Private turfFeature

  • Construct a Turf Feature from this MultiPolygon.

    Returns Feature

    the [[turf.Feature]] of this MultiPolygon.

type

  • get type(): string
  • The type property of a geometry as a string ('MultiPolygon').

    Returns string

Methods

buffer

  • buffer(geometryMeasure: GeometryMeasure): GeometryObject
  • buffer(geometryMeasure: GeometryMeasure): GeometryObject
  • buffer(geometryMeasure: GeometryMeasure): GeometryObject

contains

  • contains(geometryObject: GeometryObject): boolean
  • contains(geometryObject: GeometryObject): boolean
  • contains(geometryObject: GeometryObject): boolean
  • See if this MultiPolygon contains the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

  • See if this MultiPolygon contains the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

  • See if this MultiPolygon contains the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

convexHull

  • convexHull(): Polygon
  • convexHull(): Polygon
  • convexHull(): Polygon
  • Convex Hull is the Polygon stretched around this MultiPolygon

    Returns Polygon

    a new Polygon

  • Convex Hull is the Polygon stretched around this MultiPolygon

    Returns Polygon

    a new Polygon

  • Convex Hull is the Polygon stretched around this MultiPolygon

    Returns Polygon

    a new Polygon

getArea

  • getArea(units: string): GeometryMeasure
  • getArea(units: string): GeometryMeasure
  • getArea(units: string): GeometryMeasure
  • Get the area as GeometryMeasure in the specified unitType ('feet', 'inches', 'kilometers', 'meters', 'miles', 'yards', 'acres', 'hectares').

    Parameters

    • units: string

    Returns GeometryMeasure

    a boolean

  • Get the area as GeometryMeasure in the specified unitType ('feet', 'inches', 'kilometers', 'meters', 'miles', 'yards', 'acres', 'hectares').

    Parameters

    • units: string

    Returns GeometryMeasure

    a boolean

  • Get the area as GeometryMeasure in the specified unitType ('feet', 'inches', 'kilometers', 'meters', 'miles', 'yards', 'acres', 'hectares').

    Parameters

    • units: string

    Returns GeometryMeasure

    a boolean

intersects

  • intersects(geometryObject: GeometryObject): boolean
  • intersects(geometryObject: GeometryObject): boolean
  • intersects(geometryObject: GeometryObject): boolean
  • See if this MultiPolygon intersects the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

  • See if this MultiPolygon intersects the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

  • See if this MultiPolygon intersects the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

toWkt

  • toWkt(): string
  • toWkt(): string
  • toWkt(): string
  • Convert this MultiPolygon to well-known text representation.

    Returns string

    the well-known text representation this MultiPolygon.

  • Convert this MultiPolygon to well-known text representation.

    Returns string

    the well-known text representation this MultiPolygon.

  • Convert this MultiPolygon to well-known text representation.

    Returns string

    the well-known text representation this MultiPolygon.

within

  • within(geometryObject: GeometryObject): boolean
  • within(geometryObject: GeometryObject): boolean
  • within(geometryObject: GeometryObject): boolean
  • See if this MultiPolygon is within the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

  • See if this MultiPolygon is within the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

  • See if this MultiPolygon is within the GeometryObject given as an input parameter.

    Parameters

    Returns boolean

    a boolean

Static createFromWkt

  • createFromWkt(wkt: string): MultiPolygon
  • createFromWkt(wkt: string): MultiPolygon
  • createFromWkt(wkt: string): MultiPolygon
  • Static method for creating a MultiPolygon from well-known text.

    Parameters

    • wkt: string

      is a string of well-known text representing a MultiPolygon.

    Returns MultiPolygon

    a MultiPolygon parsed from the well-known text.

  • Static method for creating a MultiPolygon from well-known text.

    Parameters

    • wkt: string

      is a string of well-known text representing a MultiPolygon.

    Returns MultiPolygon

    a MultiPolygon parsed from the well-known text.

  • Static method for creating a MultiPolygon from well-known text.

    Parameters

    • wkt: string

      is a string of well-known text representing a MultiPolygon.

    Returns MultiPolygon

    a MultiPolygon parsed from the well-known text.