API Docs for: 1.0.2
Show:

GIScene.Process.LineOfSightNetwork_allToAll Class

The Line of Sight Network (all to all) Process calculates the intervisibility between all points in the given dataset (point layer)

Constructor

GIScene.Process.LineOfSightNetwork_allToAll

()

Methods

execute

(
  • [onExecute]
)

run the process with the inputs that have been set before To get notified when the process is finished add an event listener on the execute event. The event will provide a content propery with a data object with all input and output values of the process

Parameters:

  • [onExecute] Function optional

    callback when process is finished

Example:

    var doSomething = function(event){
        var outputs = event.content.outputs;
        //do something with the results
    }
    process.addEventListener('execute', doSomething);
    process.execute();

getOutput

(
  • outputIdentifier
)
Mixed
Method to get a specific output result after process execution

Parameters:

  • outputIdentifier Object

Returns:

Mixed: an output value of the process

getOutputs

() Object
Method to get all process outputs after process execution

Returns:

Object: An object containing all process outputs

getParamDescriptionById

(
  • identifier
)
Object
Get a param desription (input or ouput) by its identifier

Parameters:

  • identifier String

Returns:

Object: parameterDescription

setInput

(
  • inputIdentifier
  • value
)
Method to set a specific input parameter

Parameters:

  • inputIdentifier String
    the inputIdentifier defined in the process description
  • value Mixed
    the value of the input to be set

setInputs

(
  • inputParams
)
Method to set several inputs at a time

Parameters:

  • inputParams Object
    An object with key:value pairs of input parameters, where key corresponds to the inputIdentifiers defined in the process description

Events

execute event has a content property referring to the processes data object with inputs and outputs