node-gdal node-gdal

  • API Docs for Version: 0.11.0

    • Show:

    gdal.MultiPolygon

    Extends gdal.GeometryCollection

    Table of Contents

    Constructor

    gdal.MultiPolygon ()

    Defined in src/gdal_multipolygon.cpp:62

    Methods

    boundary ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:415

    Compute boundary.

    Returns:

    gdal.Geometry

    buffer
    (
    • distance
    • segments
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:544

    Buffers the geometry by the given distance.

    Parameters:

    • distance Number
    • segments Integer

    Returns:

    gdal.Geometry

    centroid ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:730

    Compute the centroid of the geometry.

    Returns:

    gdal.Point

    clone ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:389

    Clones the instance.

    Returns:

    gdal.Geometry

    closeRings ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:218

    Closes any un-closed rings.

    contains
    (
    • geometry
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:325

    Determines if the current geometry contains the provided geometry.

    Parameters:

    Returns:

    Boolean

    convexHull ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:402

    Compute convex hull.

    Returns:

    gdal.Geometry

    crosses
    (
    • geometry
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:307

    Determines if the two geometries cross.

    Parameters:

    Returns:

    Boolean

    difference
    (
    • geometry
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:466

    Compute the difference of this geometry with another.

    Parameters:

    Returns:

    gdal.Geometry

    disjoint
    (
    • geometry
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:289

    Determines if the two geometries are disjoint.

    Parameters:

    Returns:

    Boolean

    distance
    (
    • geometry
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:343

    Computes the distance between the two geometries.

    Parameters:

    Returns:

    Number

    empty ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:225

    Clears the geometry.

    equals
    (
    • geometry
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:280

    Determines if the two geometries equal each other.

    Parameters:

    Returns:

    Boolean

    getArea () Number

    Inherited from gdal.GeometryCollection but overwritten in src/gdal_multipolygon.cpp:152

    Computes the combined area of the collection.

    Returns:

    Number
    getEnvelope () gdal.Envelope

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:749

    Computes the bounding box (envelope).

    Returns:

    gdal.Envelope:

    Bounding envelope

    getEnvelope3D () gdal.Envelope3D

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:777

    Computes the 3D bounding box (envelope).

    Returns:

    gdal.Envelope3D:

    Bounding envelope

    getLength ()

    Inherited from gdal.GeometryCollection: src/gdal_geometrycollection.cpp:150

    Compute the length of a multicurve.

    Returns:

    Number

    intersection
    (
    • geometry
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:428

    Compute intersection with another geometry.

    Parameters:

    Returns:

    gdal.Geometry

    intersects
    (
    • geometry
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:271

    Determines if the two geometries intersect.

    Parameters:

    Returns:

    Boolean

    isEmpty ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:239

    Determines if the geometry is empty.

    Returns:

    Boolean

    isRing ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:263

    Determines if the geometry is a ring.

    Returns:

    Boolean

    isSimple ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:255

    Determines if the geometry is simple.

    Returns:

    Boolean

    isValid ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:247

    Determines if the geometry is valid.

    Returns:

    Boolean

    overlaps
    (
    • geometry
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:334

    Determines if the current geometry overlaps the provided geometry.

    Parameters:

    Returns:

    Boolean

    segmentize
    (
    • segment_length
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:352

    Modify the geometry such it has no segment longer then the given distance.

    Parameters:

    • segment_length Number

    Returns:

    Number

    simplify
    (
    • tolerance
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:504

    Reduces the geometry complexity.

    Parameters:

    • tolerance Number

    Returns:

    gdal.Geometry

    simplifyPreserveTopology
    (
    • tolerance
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:524

    Reduces the geometry complexity while preserving the topology.

    Parameters:

    • tolerance Number

    Returns:

    gdal.Geometry

    swapXY ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:232

    Swaps x, y coordinates.

    symDifference
    (
    • geometry
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:485

    Computes the symmetric difference of this geometry and the second geometry.

    Parameters:

    Returns:

    gdal.Geometry

    toGML ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:684

    Convert a geometry into GML format.

    Returns:

    gdal.Geometry

    toJSON ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:707

    Convert a geometry into JSON format.

    Returns:

    gdal.Geometry

    toKML ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:661

    Convert a geometry into KML format.

    Returns:

    gdal.Geometry

    toObject () Object

    Inherited from gdal.Geometry: lib/gdal.js:227

    Converts the geometry to a GeoJSON object representation.

    Returns:

    Object:

    GeoJSON

    touches
    (
    • geometry
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:298

    Determines if the two geometries touch.

    Parameters:

    Returns:

    Boolean

    toWKB
    (
    • byte_order="MSB"
    • variant="OGC"
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:594

    Convert a geometry into well known binary format.

    Parameters:

    Returns:

    gdal.Geometry

    toWKT ()

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:567

    Convert a geometry into well known text format.

    Returns:

    gdal.Geometry

    transform
    (
    • transformation
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:361

    Apply arbitrary coordinate transformation to the geometry.

    This method will transform the coordinates of a geometry from their current spatial reference system to a new target spatial reference system. Normally this means reprojecting the vectors, but it could include datum shifts, and changes of units.

    Note that this method does not require that the geometry already have a spatial reference system. It will be assumed that they can be treated as having the source spatial reference system of the CoordinateTransformation object, and the actual SRS of the geometry will be ignored.

    Parameters:

    transformTo
    (
    • srs
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:380

    Transforms the geometry to match the provided SpatialReference.

    Parameters:

    union
    (
    • geometry
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:447

    Compute the union of this geometry with another.

    Parameters:

    Returns:

    gdal.Geometry

    unionCascaded () gdal.Geometry

    Defined in src/gdal_multipolygon.cpp:137

    Unions all the geometries and returns the result.

    Returns:

    gdal.Geometry
    within
    (
    • geometry
    )

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:316

    Determines if the current geometry is within the provided geometry.

    Parameters:

    Returns:

    Boolean

    Attributes

    children

    gdal.GeometryCollectionChildren

    Inherited from gdal.GeometryCollection: src/gdal_geometrycollection.cpp:158

    All geometries represented by this collection.

    coordinateDimension

    Integer

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:1030

    dimension

    Integer readonly

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:1018

    name

    String readonly

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:981

    wkbSize

    Integer readonly

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:1006

    wkbType

    Integer readonly

    Inherited from gdal.Geometry: src/gdal_geometry.cpp:993

    See wkbGeometryTypes.