FENIX Visualization box

var Box = require('fx-box/start');

var box = new Box(options);

Configuration

Check fx-box/config/config.js to have a look of the default configuration.

API

//This is an example
box.on("clone", function (state) {...});

• box.render() : used to pass asynchronously the box model
• box.on(event, callback[, context]) : pub/sub
• box.dispose() : dispose the catalog instance
• box.setStatus( state ) : set box status
• box.showTab( tab ) : show a specific tab. Use tabs id passed from configuration
• box.setSize( size ) : set AVB size
• box.flip( face ) : flip the AVB to desired face. If not face is provided, front is applied.
• box.getState() : get the AVB internal state

Events

• remove : triggered when the box is removed
• dispose : triggered when the box is disposed
• clone : triggered when the box is cloned. Event's payload will be the box's state
• minimize : triggered when the box is minimized. Event's payload will be the box's state
• resize : triggered when the box is resized. Event's payload will be the box's state

Box statutes

• ready : if everything is fine with the AVB
• error : if and error occurred during the visualization process
• loading : when the AVB is retrieving the required resource or is waiting for async model
• empty : when AVB model is empty
• huge : when AVB model is too big to be displayed

Available tab plugin

The following are the default available tabs. The plugin registry can be extended with the pluginRegistry configuration. In order to choose a specific tab use the tabs's id configuration.

Chart tab

This tab is used to show charts. It wraps the FENIX chart creator.

Download tab

This tab is used to allow the user to configure the download options.

Filter tab

This tab used to show filters and selectors. It wr aps the FENIX filter.

Map tab

This tab is used to show maps. It wraps the FENIX map creator.

Metadata tab

This tab is used to display the metadata information of the current AVB's resource. It wraps the FENIX metadata viewer.

Table tab

This tab is used to show tables. It wraps the FENIX table creator.