Class: View

View(propertiesopt)

new View(propertiesopt)

Create a View.
Parameters:
Name Type Attributes Default Description
properties Object <optional>
 {} the properties of the view
Properties
Name Type Attributes Default Description
container string The div element to attach to
css string The css classes to set, can be multiple if separate by spaces
supportedLayers Array.<string> List the supported layers of this View. It is corresponding to the the 'type' Layer property
visible boolean set the default behavior of the visibility of the view
layers Array.<Object> <optional>
 [] The initial layers to add
Source:

Methods

addLayer(layer)

Adds a layer to the view. A broadcastChannel is going to listen the new dataSources
Parameters:
Name Type Description
layer Layer The layer object
Source:

attachTo(divId)

Attach the view to a specific div. If the view has already been attached to a div, it will be removed from its current parent and will be attached to new one. Note: the onResize() is called at the end of the process.
Parameters:
Name Type Description
divId String The div element to attach to
Source:

getDataSourcesId() → {Array.<String>}

Gets the list of the dataSource ids contained into the view.
Source:
Returns:
The list of dataSource ids
Type
Array.<String>

getDivId() → {String}

Gets the div id of the DOM element.
Source:
Returns:
The div id of the view
Type
String

getId() → {String}

Gets the inner id of the view object.
Source:
Returns:
The id of the view
Type
String

hide()

Hide the view
Source:

removeAllFromLayer(layer)

Removes a Layer from the view.
Parameters:
Name Type Description
layer Layer The layer object
Source:

removeAllFromLayers()

Removes all view item from the view.
Source:

reset()

Calls for resetting the view.
Source:

setData(dataSourceId, data)

Set the data to the view. Each view has to handle the kind of the data separately.
Parameters:
Name Type Description
dataSourceId String The dataSource id of the source providing the data
data Array.<any> The data array to set
Source:

show(properties)

Show the view.
Parameters:
Name Type Description
properties Object A generic object
Source:

Events

beforeAddingItems

This method is called before attaching any view items passed as arguments in the constructor of the view.
Parameters:
Name Type Description
options Object A generic object to use
Source:

onResize

Callback called when the view is resized
Source: