node-gdal-next node-gdal-next

  • API Docs for Version: 1.0.0

    • Show:

    gdal.Geometry

    Abstract base class for all geometry classes.

    Table of Contents

    Methods

    boundary ()

    Defined in src/gdal_geometry.cpp:393

    Compute boundary.

    Returns:

    gdal.Geometry

    buffer
    (
    • distance
    • segments
    )

    Defined in src/gdal_geometry.cpp:515

    Buffers the geometry by the given distance.

    Parameters:

    • distance Number
    • segments Integer

    Returns:

    gdal.Geometry

    centroid ()

    Defined in src/gdal_geometry.cpp:693

    Compute the centroid of the geometry.

    Returns:

    gdal.Point

    clone ()

    Defined in src/gdal_geometry.cpp:369

    Clones the instance.

    Returns:

    gdal.Geometry

    closeRings ()

    Defined in src/gdal_geometry.cpp:192

    Closes any un-closed rings.

    contains
    (
    • geometry
    )

    Defined in src/gdal_geometry.cpp:300

    Determines if the current geometry contains the provided geometry.

    Parameters:

    Returns:

    Boolean

    convexHull ()

    Defined in src/gdal_geometry.cpp:381

    Compute convex hull.

    Returns:

    gdal.Geometry

    crosses
    (
    • geometry
    )

    Defined in src/gdal_geometry.cpp:282

    Determines if the two geometries cross.

    Parameters:

    Returns:

    Boolean

    difference
    (
    • geometry
    )

    Defined in src/gdal_geometry.cpp:441

    Compute the difference of this geometry with another.

    Parameters:

    Returns:

    gdal.Geometry

    disjoint
    (
    • geometry
    )

    Defined in src/gdal_geometry.cpp:264

    Determines if the two geometries are disjoint.

    Parameters:

    Returns:

    Boolean

    distance
    (
    • geometry
    )

    Defined in src/gdal_geometry.cpp:318

    Computes the distance between the two geometries.

    Parameters:

    Returns:

    Number

    empty ()

    Defined in src/gdal_geometry.cpp:199

    Clears the geometry.

    equals
    (
    • geometry
    )

    Defined in src/gdal_geometry.cpp:255

    Determines if the two geometries equal each other.

    Parameters:

    Returns:

    Boolean

    flattenTo2D ()

    Defined in src/gdal_geometry.cpp:769

    Convert geometry to strictly 2D

    Returns:

    void

    getEnvelope () gdal.Envelope

    Defined in src/gdal_geometry.cpp:711

    Computes the bounding box (envelope).

    Returns:

    gdal.Envelope:

    Bounding envelope

    getEnvelope3D () gdal.Envelope3D

    Defined in src/gdal_geometry.cpp:739

    Computes the 3D bounding box (envelope).

    Returns:

    gdal.Envelope3D:

    Bounding envelope

    intersection
    (
    • geometry
    )

    Defined in src/gdal_geometry.cpp:405

    Compute intersection with another geometry.

    Parameters:

    Returns:

    gdal.Geometry

    intersects
    (
    • geometry
    )

    Defined in src/gdal_geometry.cpp:245

    Determines if the two geometries intersect.

    Parameters:

    Returns:

    Boolean

    isEmpty ()

    Defined in src/gdal_geometry.cpp:213

    Determines if the geometry is empty.

    Returns:

    Boolean

    isRing ()

    Defined in src/gdal_geometry.cpp:237

    Determines if the geometry is a ring.

    Returns:

    Boolean

    isSimple ()

    Defined in src/gdal_geometry.cpp:229

    Determines if the geometry is simple.

    Returns:

    Boolean

    isValid ()

    Defined in src/gdal_geometry.cpp:221

    Determines if the geometry is valid.

    Returns:

    Boolean

    overlaps
    (
    • geometry
    )

    Defined in src/gdal_geometry.cpp:309

    Determines if the current geometry overlaps the provided geometry.

    Parameters:

    Returns:

    Boolean

    segmentize
    (
    • segment_length
    )

    Defined in src/gdal_geometry.cpp:328

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

    Parameters:

    • segment_length Number

    Returns:

    Number

    simplify
    (
    • tolerance
    )

    Defined in src/gdal_geometry.cpp:477

    Reduces the geometry complexity.

    Parameters:

    • tolerance Number

    Returns:

    gdal.Geometry

    simplifyPreserveTopology
    (
    • tolerance
    )

    Defined in src/gdal_geometry.cpp:496

    Reduces the geometry complexity while preserving the topology.

    Parameters:

    • tolerance Number

    Returns:

    gdal.Geometry

    swapXY ()

    Defined in src/gdal_geometry.cpp:206

    Swaps x, y coordinates.

    symDifference
    (
    • geometry
    )

    Defined in src/gdal_geometry.cpp:459

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

    Parameters:

    Returns:

    gdal.Geometry

    toGML ()

    Defined in src/gdal_geometry.cpp:649

    Convert a geometry into GML format.

    Returns:

    gdal.Geometry

    toJSON ()

    Defined in src/gdal_geometry.cpp:671

    Convert a geometry into JSON format.

    Returns:

    gdal.Geometry

    toKML ()

    Defined in src/gdal_geometry.cpp:627

    Convert a geometry into KML format.

    Returns:

    gdal.Geometry

    toObject () Object

    Defined in lib/gdal.js:237

    Converts the geometry to a GeoJSON object representation.

    Returns:

    Object:

    GeoJSON

    touches
    (
    • geometry
    )

    Defined in src/gdal_geometry.cpp:273

    Determines if the two geometries touch.

    Parameters:

    Returns:

    Boolean

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

    Defined in src/gdal_geometry.cpp:563

    Convert a geometry into well known binary format.

    Parameters:

    • [byte_order="MSB"] String optional

      (Constants (wkbByteOrder))

    • [variant="OGC"] String optional

      (see options)

    Returns:

    gdal.Geometry

    toWKT ()

    Defined in src/gdal_geometry.cpp:537

    Convert a geometry into well known text format.

    Returns:

    gdal.Geometry

    transform
    (
    • transformation
    )

    Defined in src/gdal_geometry.cpp:337

    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
    )

    Defined in src/gdal_geometry.cpp:358

    Transforms the geometry to match the provided SpatialReference.

    Parameters:

    union
    (
    • geometry
    )

    Defined in src/gdal_geometry.cpp:423

    Compute the union of this geometry with another.

    Parameters:

    Returns:

    gdal.Geometry

    within
    (
    • geometry
    )

    Defined in src/gdal_geometry.cpp:291

    Determines if the current geometry is within the provided geometry.

    Parameters:

    Returns:

    Boolean

    Attributes

    coordinateDimension

    Integer

    Defined in src/gdal_geometry.cpp:977

    dimension

    Integer readonly

    Defined in src/gdal_geometry.cpp:966

    name

    String readonly

    Defined in src/gdal_geometry.cpp:931

    wkbSize

    Integer readonly

    Defined in src/gdal_geometry.cpp:955

    wkbType

    Integer readonly

    Defined in src/gdal_geometry.cpp:942

    See Constants (wkbGeometryType).

    Static Methods

    gdal.Geometry.create
    (
    • type
    )

    Defined in src/gdal_geometry.cpp:887

    Creates an empty Geometry from a WKB type.

    Parameters:

    • type Integer

      WKB geometry type (Constants (wkbGeometryType))

    Returns:

    gdal.Geometry

    gdal.Geometry.fromGeoJson
    (
    • geojson
    )

    Defined in src/gdal_geometry.cpp:853

    Creates a Geometry from a GeoJSON string.

    Parameters:

    • geojson Object

    Returns:

    gdal.Geometry

    gdal.Geometry.fromWKB
    (
    • wkb
    • srs
    )

    Defined in src/gdal_geometry.cpp:811

    Creates a Geometry from a WKB buffer.

    Parameters:

    Returns:

    gdal.Geometry

    gdal.Geometry.fromWKT
    (
    • wkt
    • srs
    )

    Defined in src/gdal_geometry.cpp:779

    Creates a Geometry from a WKT string.

    Parameters:

    Returns:

    gdal.Geometry

    gdal.Geometry.getConstructor
    (
    • type
    )

    Defined in src/gdal_geometry.cpp:1023

    Returns the Geometry subclass that matches the given WKB geometry type.

    Parameters:

    • type Integer

      WKB geometry type (Constants (wkbGeometryType))

    Returns:

    Function

    gdal.Geometry.getName
    (
    • type
    )

    Defined in src/gdal_geometry.cpp:1040

    Returns the Geometry subclass name that matches the given WKB geometry type.

    Parameters:

    • type Integer

      WKB geometry type (Constants (wkbGeometryType))

    Returns:

    String