node-gdal-next node-gdal-next

  • API Docs for Version: 1.0.0

    • Show:

    gdal.LineString

    Extends gdal.Geometry

    Concrete representation of a multi-vertex line.

    Table of Contents

    Constructor

    gdal.LineString ()

    Defined in src/gdal_linestring.cpp:53

    Example:

    var lineString = new gdal.LineString();
lineString.points.add(new gdal.Point(0,0));
lineString.points.add(new gdal.Point(0,10));`

    Methods

    addSubLineString
    (
    • line
    • start=0
    • end=-1
    )
    Void

    Defined in src/gdal_linestring.cpp:160

    Add a segment of another linestring to this one.

    Adds the request range of vertices to the end of this line string in an efficient manner. If the start index is larger than the end index then the vertices will be reversed as they are copied.

    Parameters:

    • line gdal.LineString

      the other linestring

    • [start=0] Int optional

      the first vertex to copy, defaults to 0 to start with the first vertex in the other linestring

    • [end=-1] Int optional

      the last vertex to copy, defaults to -1 indicating the last vertex of the other linestring

    Returns:

    Void
    boundary ()

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

    Compute boundary.

    Returns:

    gdal.Geometry

    buffer
    (
    • distance
    • segments
    )

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

    Buffers the geometry by the given distance.

    Parameters:

    • distance Number
    • segments Integer

    Returns:

    gdal.Geometry

    centroid ()

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

    Compute the centroid of the geometry.

    Returns:

    gdal.Point

    clone ()

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

    Clones the instance.

    Returns:

    gdal.Geometry

    closeRings ()

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

    Closes any un-closed rings.

    contains
    (
    • geometry
    )

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

    Determines if the current geometry contains the provided geometry.

    Parameters:

    Returns:

    Boolean

    convexHull ()

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

    Compute convex hull.

    Returns:

    gdal.Geometry

    crosses
    (
    • geometry
    )

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

    Determines if the two geometries cross.

    Parameters:

    Returns:

    Boolean

    difference
    (
    • geometry
    )

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

    Compute the difference of this geometry with another.

    Parameters:

    Returns:

    gdal.Geometry

    disjoint
    (
    • geometry
    )

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

    Determines if the two geometries are disjoint.

    Parameters:

    Returns:

    Boolean

    distance
    (
    • geometry
    )

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

    Computes the distance between the two geometries.

    Parameters:

    Returns:

    Number

    empty ()

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

    Clears the geometry.

    equals
    (
    • geometry
    )

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

    Determines if the two geometries equal each other.

    Parameters:

    Returns:

    Boolean

    flattenTo2D ()

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

    Convert geometry to strictly 2D

    Returns:

    void

    getEnvelope () gdal.Envelope

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

    Computes the bounding box (envelope).

    Returns:

    gdal.Envelope:

    Bounding envelope

    getEnvelope3D () gdal.Envelope3D

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

    Computes the 3D bounding box (envelope).

    Returns:

    gdal.Envelope3D:

    Bounding envelope

    getLength ()

    Defined in src/gdal_linestring.cpp:130

    Computes the length of the line string.

    Returns:

    Number

    intersection
    (
    • geometry
    )

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

    Compute intersection with another geometry.

    Parameters:

    Returns:

    gdal.Geometry

    intersects
    (
    • geometry
    )

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

    Determines if the two geometries intersect.

    Parameters:

    Returns:

    Boolean

    isEmpty ()

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

    Determines if the geometry is empty.

    Returns:

    Boolean

    isRing ()

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

    Determines if the geometry is a ring.

    Returns:

    Boolean

    isSimple ()

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

    Determines if the geometry is simple.

    Returns:

    Boolean

    isValid ()

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

    Determines if the geometry is valid.

    Returns:

    Boolean

    overlaps
    (
    • geometry
    )

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

    Determines if the current geometry overlaps the provided geometry.

    Parameters:

    Returns:

    Boolean

    segmentize
    (
    • segment_length
    )

    Inherited from gdal.Geometry: 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
    )

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

    Reduces the geometry complexity.

    Parameters:

    • tolerance Number

    Returns:

    gdal.Geometry

    simplifyPreserveTopology
    (
    • tolerance
    )

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

    Reduces the geometry complexity while preserving the topology.

    Parameters:

    • tolerance Number

    Returns:

    gdal.Geometry

    swapXY ()

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

    Swaps x, y coordinates.

    symDifference
    (
    • geometry
    )

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

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

    Parameters:

    Returns:

    gdal.Geometry

    toGML ()

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

    Convert a geometry into GML format.

    Returns:

    gdal.Geometry

    toJSON ()

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

    Convert a geometry into JSON format.

    Returns:

    gdal.Geometry

    toKML ()

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

    Convert a geometry into KML format.

    Returns:

    gdal.Geometry

    toObject () Object

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

    Converts the geometry to a GeoJSON object representation.

    Returns:

    Object:

    GeoJSON

    touches
    (
    • geometry
    )

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

    Determines if the two geometries touch.

    Parameters:

    Returns:

    Boolean

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

    Inherited from gdal.Geometry: 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 ()

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

    Convert a geometry into well known text format.

    Returns:

    gdal.Geometry

    transform
    (
    • transformation
    )

    Inherited from gdal.Geometry: 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
    )

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

    Transforms the geometry to match the provided SpatialReference.

    Parameters:

    union
    (
    • geometry
    )

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

    Compute the union of this geometry with another.

    Parameters:

    Returns:

    gdal.Geometry

    value
    (
    • distance
    )
    gdal.Point

    Defined in src/gdal_linestring.cpp:138

    Returns the point at the specified distance along the line string.

    Parameters:

    • distance Number

    Returns:

    gdal.Point
    within
    (
    • geometry
    )

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

    Determines if the current geometry is within the provided geometry.

    Parameters:

    Returns:

    Boolean

    Attributes

    coordinateDimension

    Integer

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

    dimension

    Integer readonly

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

    name

    String readonly

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

    points

    gdal.LineStringPoints

    Defined in src/gdal_linestring.cpp:201

    Points that make up the line string.

    wkbSize

    Integer readonly

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

    wkbType

    Integer readonly

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

    See Constants (wkbGeometryType).