Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MultiPolygon

A restricted form of MultiSurface where each Surface in the collection must be of type Polygon.

Hierarchy

Index

Constructors

constructor

Accessors

geometries

  • get geometries(): Array<Polygon>
  • set geometries(geometries: Array<Polygon>): void

geometryType

hasM

  • get hasM(): boolean
  • set hasM(hasM: boolean): void
  • Does the geometry have m coordinates

    Returns boolean

    true if has m coordinates

  • Set if the geometry has m coordinates

    Parameters

    • hasM: boolean

      true if has m coordinates

    Returns void

    true if has m coordinates

hasZ

  • get hasZ(): boolean
  • set hasZ(hasZ: boolean): void
  • Does the geometry have z coordinates

    Returns boolean

    true if has z coordinates

  • Set if the geometry has z coordinates

    Parameters

    • hasZ: boolean

      true if has z coordinates

    Returns void

    true if has z coordinates

is3D

  • get is3D(): boolean
  • Does the geometry have z coordinates

    see

    #hasZ()

    Returns boolean

    true if has z coordinates

polygons

  • get polygons(): Array<Polygon>
  • set polygons(polygons: Array<Polygon>): void

Methods

addGeometries

  • addGeometries(geometries: Array<Polygon>): void

addGeometry

  • addGeometry(geometry: Polygon): void

addPolygon

  • addPolygon(polygon: Polygon): void

addPolygons

  • addPolygons(polygons: Array<Polygon>): void

addSurface

  • addSurface(surface: Polygon): void

addSurfaces

  • addSurfaces(surfaces: Array<Polygon>): void

copy

equals

expandEnvelope

getAsGeometryCollection

getAsMultiCurve

getAsMultiLineString

getAsMultiPoint

getAsMultiPolygon

getAsMultiSurface

getCentroid

  • Get the mathematical centroid point of a 2 dimensional representation of the Geometry (balancing point of a 2d cutout of the geometry). Only the x and y coordinate of the resulting point are calculated and populated. The resulting {@link Point#getZ()} and {@link Point#getM()} methods will always return null.

    Returns Point

    centroid point

getCollectionType

  • Get the collection type by evaluating the geometries

    Returns GeometryType

    collection geometry type, one of: {@link GeometryType#MULTIPOINT}, {@link GeometryType#MULTILINESTRING}, {@link GeometryType#MULTIPOLYGON}, {@link GeometryType#MULTICURVE}, {@link GeometryType#MULTISURFACE}, {@link GeometryType#GEOMETRYCOLLECTION}

getDegreesCentroid

  • getDegreesCentroid(): Point
  • Get the geographic centroid point of a 2 dimensional representation of the degree unit Geometry. Only the x and y coordinate of the resulting point are calculated and populated. The resulting {@link Point#getZ()} and {@link Point#getM()} methods will always return null.

    Returns Point

    centroid point

getDimension

  • getDimension(): number

getEnvelope

getGeometry

getPolygon

getSurface

getSurfaces

isEmpty

  • isEmpty(): boolean

isMeasured

  • isMeasured(): boolean

isMultiCurve

  • isMultiCurve(): boolean

isMultiLineString

  • isMultiLineString(): boolean

isMultiPoint

  • isMultiPoint(): boolean

isMultiPolygon

  • isMultiPolygon(): boolean

isMultiSurface

  • isMultiSurface(): boolean

isSimple

  • isSimple(): boolean

numGeometries

  • numGeometries(): number

numPolygons

  • numPolygons(): number

numSurfaces

  • numSurfaces(): number

setSurfaces

  • setSurfaces(surfaces: Array<Polygon>): void

updateZM

Static hasM

  • hasM(geometries: Array<Geometry>): boolean
  • Determine if the geometries contain a M value

    Parameters

    • geometries: Array<Geometry>

      list of geometries

    Returns boolean

    true if has m

Static hasZ

  • hasZ(geometries: Array<Geometry>): boolean
  • Determine if the geometries contain a Z value

    Parameters

    • geometries: Array<Geometry>

      list of geometries

    Returns boolean

    true if has z

Generated using TypeDoc