The iLand Javascript API The iLand Javascript API

  • API Docs for Version: 1.0

    • APIs

    Show:

    Factory Class

    Defined in: iLand\factory_doc.js:1
    Module: iLand

    NOTE: The Factory is no longer necessary, and its use is deprecated!

    To create an object in Javascript, you can use the standard Javascript operator new:

    Examples

    // Create a instance of a Map object
var map = new Map;
// now you are good to use the objects properties and methods
console.log(map.name); // print the name of the stand grid file

    The Factory is a helper object for the creation of other iLand script objects such as a Map.

    Technically, the Factorycan instantiate objects of other C++ (QObject-based) types. This factory approach is used because the V8 (QJSEngine) had limitations with regard to the new operator of Javascript. Now (with version Qt6, and likely also some versions before) the proper use of new is possible again.

    Methods

    newClimateConverter

    () Object

    Defined in iLand\factory_doc.js:52

    Create an instance of a ClimateConverter (see https://iland-model.org/Object+ClimateConverter).

    Returns:

    Object:

    A Javascript ClimateConverter object

    newCSVFile

    (
    • file_name
    )
    Object

    Defined in iLand\factory_doc.js:30

    Create an instance of a CSVFile, a convenience class for reading and processing tabular data.

    Parameters:

    • file_name String

      The file to load with

    Returns:

    Object:

    A Javascript CSVFile object

    newGrid

    () Object

    Defined in iLand\factory_doc.js:46

    Create an instance of a Grid. Initially, the grid is empty.

    Returns:

    Object:

    A Javascript Grid object

    newMap

    () Object

    Defined in iLand\factory_doc.js:39

    Create an instance of a Map, a wrapper for a GIS raster file.

    Returns:

    Object:

    A Javascript Map object