node-gdal-next node-gdal-next

  • API Docs for Version: 1.0.0

    • Show:

    gdal.Driver

    Format specific driver.

    An instance of this class is created for each supported format, and manages information about the format.

    This roughly corresponds to a file format, though some drivers may be gateways to many formats through a secondary multi-library.

    Table of Contents

    Methods

    copyFiles
    (
    • name_old
    • name_new
    )

    Defined in src/gdal_driver.cpp:450

    Copy the files of a dataset.

    Parameters:

    • name_old String

      New name for the dataset.

    • name_new String

      Old name of the dataset.

    create
    (
    • filename
    • x_size=0
    • y_size=0
    • band_count=0
    • data_type=gdal.GDT_Byte
    • creation_options
    )

    Defined in src/gdal_driver.cpp:281

    Create a new dataset with this driver.

    Parameters:

    • filename String
    • [x_size=0] Integer optional

      raster width in pixels (ignored for vector datasets)

    • [y_size=0] Integer optional

      raster height in pixels (ignored for vector datasets)

    • [band_count=0] Integer optional
    • [data_type=gdal.GDT_Byte] Integer optional

      pixel data type (ignored for vector datasets) (see data types)

    • [creation_options] String[] | Object optional

      An array or object containing driver-specific dataset creation options

    Returns:

    gdal.Dataset

    createAsync
    (
    • filename
    • x_size=0
    • y_size=0
    • band_count=0
    • data_type=gdal.GDT_Byte
    • creation_options
    • callback
    )

    Defined in src/gdal_driver.cpp:303

    Asynchronously create a new dataset with this driver.

    Parameters:

    • filename String
    • [x_size=0] Integer optional

      raster width in pixels (ignored for vector datasets)

    • [y_size=0] Integer optional

      raster height in pixels (ignored for vector datasets)

    • [band_count=0] Integer optional
    • [data_type=gdal.GDT_Byte] Integer optional

      pixel data type (ignored for vector datasets) (see data types)

    • [creation_options] String[] | Object optional

      An array or object containing driver-specific dataset creation options

    • callback Callback

      promisifiable callback

    Returns:

    gdal.Dataset

    createCopy
    (
    • filename
    • src
    • strict=false
    • options=null
    )

    Defined in src/gdal_driver.cpp:417

    Create a copy of a dataset.

    Parameters:

    • filename String
    • src gdal.Dataset
    • [strict=false] Boolean optional
    • [options=null] String[] | Object optional

      An array or object containing driver-specific dataset creation options

    Returns:

    gdal.Dataset

    createCopyAsync
    (
    • filename
    • src
    • strict=false
    • options=null
    • callback
    )

    Defined in src/gdal_driver.cpp:433

    Asynchronously create a copy of a dataset.

    Parameters:

    • filename String
    • src gdal.Dataset
    • [strict=false] Boolean optional
    • [options=null] String[] | Object optional

      An array or object containing driver-specific dataset creation options

    • callback Callback

      promisifiable callback

    Returns:

    gdal.Dataset

    deleteDataset
    (
    • filename
    )

    Defined in src/gdal_driver.cpp:176

    Parameters:

    • filename String
    getMetadata
    (
    • domain
    )

    Defined in src/gdal_driver.cpp:516

    Returns metadata about the driver.

    Parameters:

    • [domain] String optional

    Returns:

    Object

    open
    (
    • path
    • mode=`"r"`
    )
    gdal.Dataset

    Defined in src/gdal_driver.cpp:614

    Opens a dataset.

    Parameters:

    • path String
    • [mode=`"r"`] String optional

      The mode to use to open the file: "r" or "r+"

    Returns:

    gdal.Dataset
    openAsync
    (
    • path
    • mode=`"r"`
    • callback
    )
    gdal.Dataset

    Defined in src/gdal_driver.cpp:628

    Opens a dataset.

    Parameters:

    • path String
    • [mode=`"r"`] String optional

      The mode to use to open the file: "r" or "r+"

    • callback Callback

      promisifiable callback

    Returns:

    gdal.Dataset
    rename
    (
    • new_name
    • old_name
    )

    Defined in src/gdal_driver.cpp:483

    Renames the dataset.

    Parameters:

    • new_name String

      New name for the dataset.

    • old_name String

      Old name of the dataset.

    Attributes

    description

    String readonly

    Defined in src/gdal_driver.cpp:157