Module: meteoJS/modelviewer/container

Child class

Container([options])

Abstract types

adaptSuitableResource
getPossibleVariables(possibleSelectedVariables, selectedVariables)

isResourceSelected(selectedVariables, lastAddedVariable)
options

result_getSelectedVariablesWithResources

Events

change:displayVariables
change:enabledResources

change:selectedVariables
change:visibleResource

Class

Container

Abstract types

inner

adaptSuitableResource Object

Options to adapt a suitable resource to display.

Parameters

Name	Type	Description
enabled	boolean	Enabled adapt suitable resource.
getPossibleVariables	module:meteoJS/modelviewer/container~getPossibleVariables	Determines order of variables of a hierarchy level.
isResourceSelected	module:meteoJS/modelviewer/container~isResourceSelected	Is selectedVariables complete.

inner

getPossibleVariables(possibleSelectedVariables, selectedVariables) → Array of module:meteoJS/modelviewer/variable.Variable

If a suitable resource is searched, this method will be called several times. The first argument ist a list of variables. These variables are collected of one hierarchy level, defined by the resources object. The method returns an ordered list of these passed variables (or a subset). For these variables, further down in the hierarchy, a possible resource is searched. If one is found, this variable will be used for selectedVariables. Method is only used if adaptSuitableResource is enabled. Default algorythm is to return the list in the order of the Iterator.

Parameters

Name	Type	Optional	Description
possibleSelectedVariables	Array of module:meteoJS/modelviewer/variable.Variable		Variables to return an ordered list.
selectedVariables	Set containing module:meteoJS/modelviewer/variable.Variable		Already selected variables so far, top-down in hierarchy.

Returns: Array of module:meteoJS/modelviewer/variable.Variable - Ordered list.

inner

isResourceSelected(selectedVariables, lastAddedVariable) → boolean

With the passed selectedVariables, the method determines if already a suitable resource should be selected. If method returns true, the property selectedVariables will be set by the passed Set. Method used if adaptSuitableResource is enabled. Default algorythm is to return true if the Node of the lastAddedVariable contains resources.

Parameters

Name	Type	Optional	Description
selectedVariables	Set containing module:meteoJS/modelviewer/variable.Variable		Selected variables so far.
lastAddedVariable	(undefined or module:meteoJS/modelviewer/variable.Variable)		Last added variable to selectedVariables.

Returns: boolean - True if a suitable resource should be selected with the current state of selectedVariables.

inner

options module:meteoJS/base/unique~options

Options for constructor.

Parameters

Name	Type	Optional	Description
display	module:meteoJS/modelviewer/display.Display	Yes	Display object to output the container content to DOM.
adaptSuitableResource	module:meteoJS/modelviewer/container~adaptSuitableResource	Yes	Options for adapt suitable resource.

inner

result_getSelectedVariablesWithResources Array

Properties

Name	Type	Optional	Description
0	(undefined or Set containing module:meteoJS/modelviewer/variable.Variable)
1	(undefined or module:meteoJS/modelviewer/variable.Variable)

Events

change:displayVariables Object

Triggered, when displayVariables is changed.

Properties

Name Type Optional Description

options

Object

Options.

Values in options have the following properties:

Name	Type	Optional	Description
addedVariables	Set containing module:meteoJS/modelviewer/variable.Variable	Yes	Added variables to displayVariables.
removedVariables	Set containing module:meteoJS/modelviewer/variable.Variable	Yes	Removed variables to displayVariables.

change:enabledResources Object

Triggered, when visible Resource changes.

Properties

Name Type Optional Description

options

Object

Options.

Values in options have the following properties:

Name	Type	Optional	Description
enabledResources	Object with integer keys and module:meteoJS/modelviewer/resource.Resource properties	Yes	Enabled resources, selected by selectedVariables.

change:selectedVariables Object

Triggered, when selectedVariables is changed.

Properties

Name Type Optional Description

options

Object

Options.

Values in options have the following properties:

Name	Type	Optional	Description
addedVariables	Set containing module:meteoJS/modelviewer/variable.Variable	Yes	Added variables to selectedVariables.
removedVariables	Set containing module:meteoJS/modelviewer/variable.Variable	Yes	Removed variables to selectedVariables.

change:visibleResource

Triggered, when visible Resource changes.