node-gdal-next node-gdal-next

  • API Docs for Version: 1.0.0

    • Show:

    gdal.LayerFields

    Table of Contents

    Methods

    add
    (
    • def(s)
    • approx=true
    )

    Defined in src/collections/layer_fields.cpp:249

    Adds field(s).

    Parameters:

    • def(s) gdal.FieldDefn | Array

      A field definition, or array of field definitions.

    • [approx=true] Boolean optional
    count () Integer

    Defined in src/collections/layer_fields.cpp:81

    Returns the number of fields.

    Returns:

    Integer
    forEach
    (
    • callback
    )

    Defined in lib/gdal.js:248

    Iterates through all field definitions using a callback function.

    Parameters:

    • callback Function

      The callback to be called with each FieldDefn

    Example:

    layer.fields.forEach(function(field, i) { ... });`
    fromJSON
    (
    • object
    • approx_ok=false
    )

    Defined in lib/gdal.js:834

    Creates a LayerFields instance from an object of keys and values.

    Parameters:

    • object Object
    • [approx_ok=false] Boolean optional
    get
    (
    • field
    )
    gdal.FieldDefn

    Defined in src/collections/layer_fields.cpp:137

    Returns a field definition.

    Parameters:

    • field String | Integer

      Field name or index (0-based)

    Returns:

    gdal.FieldDefn
    getNames () Array

    Defined in src/collections/layer_fields.cpp:173

    Returns a list of field names.

    Returns:

    Array:

    List of strings.

    indexOf
    (
    • field
    )
    Integer

    Defined in src/collections/layer_fields.cpp:107

    Find the index of field in the layer.

    Parameters:

    • field String

    Returns:

    Integer:

    Field index, or -1 if the field doesn't exist

    map
    (
    • callback
    )

    Defined in lib/gdal.js:261

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

    Parameters:

    • callback Function

      The callback to be called with each FieldDefn

    Example:

    var result = layer.fields.map(function(field, i) {
    return value;
});`
    remove
    (
    • field
    )

    Defined in src/collections/layer_fields.cpp:208

    Removes a field.

    Parameters:

    • field String | Integer

      Field name or index (0-based)

    reorder
    (
    • map
    )

    Defined in src/collections/layer_fields.cpp:310

    Reorders fields.

    Parameters:

    • map Array

      An array of new indexes (integers)

    Example:

    // reverse field order
layer.fields.reorder([2,1,0]);`

    Attributes

    layer

    gdal.Layer readonly

    Defined in src/collections/layer_fields.cpp:381

    Parent layer