node-gdal-next node-gdal-next

  • API Docs for Version: 1.0.0

    • Show:

    gdal.LineStringPoints

    An encapsulation of a LineString's points.

    Table of Contents

    Methods

    add
    (
    • point(s)
    )

    Defined in src/collections/linestring_points.cpp:251

    Adds point(s) to the line string. Also accepts any object with an x and y property.

    Parameters:

    Example:

    lineString.points.add(new gdal.Point(1, 2));
lineString.points.add([
    new gdal.Point(1, 2)
    new gdal.Point(3, 4)
]);`
    count () Integer

    Defined in src/collections/linestring_points.cpp:82

    Returns the number of points that are part of the line string.

    Returns:

    Integer
    forEach
    (
    • callback
    )

    Defined in lib/gdal.js:364

    Iterates through all points using a callback function.

    Parameters:

    • callback Function

      The callback to be called with each Point

    Example:

    lineString.points.forEach(function(point, i) { ... });`
    get
    (
    • index
    )
    gdal.Point

    Defined in src/collections/linestring_points.cpp:135

    Returns the point at the specified index.

    Parameters:

    • index Integer

      0-based index

    Returns:

    gdal.Point
    map
    (
    • callback
    )

    Defined in lib/gdal.js:348

    Iterates through all rings using a callback function and builds an array of the returned values.

    Parameters:

    • callback Function

      The callback to be called with each LineString

    Example:

    var result = polygon.rings.map(function(ring, i) {
    return value;
});`
    map
    (
    • callback
    )

    Defined in lib/gdal.js:377

    Iterates through all points using a callback function and builds an array of the returned values.

    Parameters:

    • callback Function

      The callback to be called with each Point

    Example:

    var result = lineString.points.map(function(point, i) {
    return value;
});`
    resize
    (
    • count
    )

    Defined in src/collections/linestring_points.cpp:115

    Adjusts the number of points that make up the line string.

    Parameters:

    • count Integer
    reverse ()

    Defined in src/collections/linestring_points.cpp:98

    Reverses the order of all the points.

    set
    (
    • index
    • point
    )

    Defined in src/collections/linestring_points.cpp:163

    Sets the point at the specified index.

    Parameters:

    Example:

    lineString.points.set(0, new gdal.Point(1, 2));`
    toArray () Array

    Defined in lib/gdal.js:489

    Outputs all points as a regular javascript array.

    Returns:

    Array:

    List of Point instances.