Class sap.viz.ui5.controls.VizFrameModule: sap/viz/ui5/controls/VizFrame

Adds some feed to the aggregation feeds.

Attaches event handler fnFunction to the deselectData event of this sap.viz.ui5.controls.VizFrame.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.viz.ui5.controls.VizFrame itself.

Event fires when certain data point(s) is(are) deselected, data context of deselected item(s) would be passed in

Attaches event handler fnFunction to the renderComplete event of this sap.viz.ui5.controls.VizFrame.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.viz.ui5.controls.VizFrame itself.

Event fires when the rendering ends.

Attaches event handler fnFunction to the selectData event of this sap.viz.ui5.controls.VizFrame.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.viz.ui5.controls.VizFrame itself.

Event fires when certain data point(s) is(are) selected, data context of selected item(s) would be passed in.

Destroys the dataset in the aggregation dataset.

Destroys all the feeds in the aggregation feeds.

Detaches event handler fnFunction from the deselectData event of this sap.viz.ui5.controls.VizFrame.

The passed function and listener object must match the ones used for event registration.

Detaches event handler fnFunction from the renderComplete event of this sap.viz.ui5.controls.VizFrame.

The passed function and listener object must match the ones used for event registration.

Detaches event handler fnFunction from the selectData event of this sap.viz.ui5.controls.VizFrame.

The passed function and listener object must match the ones used for event registration.

Export the current viz as SVG String. The viz is ready to be exported to svg ONLY after the initialization is finished. Any attempt to export to svg before that will result in an empty svg string.

{
    width: Number - the exported svg will be scaled to the specific width.
    height: Number - the exported svg will be scaled to the specific height.
    hideTitleLegend: Boolean - flag to indicate if the exported svg includes the original title and legend.
    hideAxis: Boolean - flag to indicate if the exported svg includes the original axis.
}

Gets content of aggregation dataset.

Dataset for chart.

Gets content of aggregation feeds.

All feeds for chart.

Return current legend group visibility.

Gets current value of property vizCustomizations.

Chart customizations property, aim to customize existing (build-in) charts to meet specific LoB requirements. Currently, supported chart type : column, dual_column, bar, dual_bar, stacked_column, stacked_bar, 100_stacked_bar, 100_stacked_column, 100_dual_stacked_bar, 100_dual_stacked_column, dual_stacked_bar, dual_stacked_column, line, horizontal_line, dual_line, dual_horizontal_line, combination, horizontal_combination, stacked_combination, horizontal_stacked_combination, dual_stacked_combination, dual_horizontal_stacked_combination, scatter, bubble.

Gets current value of property vizProperties.

Chart properties, refer to chart property doc for more details.

Gets current value of property vizScales.

Chart scales, refer to chart property doc for more details.

Gets current value of property vizType.

Type for viz frame. User can pass 'chartType' or 'info/chartType'. For example both 'bar' and 'info/bar' will create a info bar chart. Supported chart type: column, dual_column, bar, dual_bar, stacked_bar, stacked_column, line, dual_line, combination, bullet, bubble, time_bubble, pie, donut, timeseries_column, timeseries_line, timeseries_scatter, timeseries_bubble, scatter, vertical_bullet, dual_stacked_bar, 100_stacked_bar, 100_dual_stacked_bar, dual_stacked_column, 100_stacked_column, 100_dual_stacked_column, stacked_combination, horizontal_stacked_combination, dual_stacked_combination, dual_horizontal_stacked_combination, heatmap, waterfall, horizontal_waterfall

Default value is column.

Uid for viz frame. It supports other controls to connect to a viz instance.

Checks for the provided sap.viz.ui5.controls.common.feeds.FeedItem in the aggregation feeds. and returns its index if found or -1 otherwise.

Inserts a feed into the aggregation feeds.

Removes all the controls from the aggregation feeds.

Additionally, it unregisters them from the hosting UIArea.

Removes a feed from the aggregation feeds.

Sets the aggregated dataset.

Will respect the setting for all available legends.

Setter for property uiConfig. uiConfig could only set via settings parameter of constructor.

uiConfig from base type could config the instance. Supported uiConfig keyword: applicationSet, showErrorMessage

Example:

var vizFrame = new sap.viz.ui5.controls.VizFrame({
 'vizType' : 'bar',
 'uiConfig' : {
     'applicationSet' : 'fiori',
     'showErrorMessage' : true
 }
});

Sets a new value for property vizCustomizations.

Chart customizations property, aim to customize existing (build-in) charts to meet specific LoB requirements. Currently, supported chart type : column, dual_column, bar, dual_bar, stacked_column, stacked_bar, 100_stacked_bar, 100_stacked_column, 100_dual_stacked_bar, 100_dual_stacked_column, dual_stacked_bar, dual_stacked_column, line, horizontal_line, dual_line, dual_horizontal_line, combination, horizontal_combination, stacked_combination, horizontal_stacked_combination, dual_stacked_combination, dual_horizontal_stacked_combination, scatter, bubble.

When called with a value of null or undefined, the default value of the property will be restored.

Properties for viz frame.

Example:

 var vizFrame = new sap.viz.ui5.controls.VizFrame(...);
 var properties = {
     'legend' : { 'visible'; : true }
};
vizFrame.setVizProperties(properties);

Scales for viz frame.

Example:

 var vizFrame = new sap.viz.ui5.controls.VizFrame(...);
 var scales = [{
     'feed': 'color',
     'palette': ['#ff0000']
}];
vizFrame.setVizScales(scales);

Setter for property vizType. vizType could only set via settings parameter in Constructor. Do not set vizType at runtime.

vizType is a string of supported chart type or extension chart type.

Supported chart types: bubble, combination, column, bar, line, stacked_bar, stacked_column, bullet, vertical_bullet, timebubble. User can pass 'chartType' or 'info/chartType' for these supported chart types.

Example:

var vizFrame = new sap.viz.ui5.controls.VizFrame({
 'vizType' : 'bar'
});

For extension chart type, user should load extension js file manually at first.

Example:

var vizFrame = new sap.viz.ui5.controls.VizFrame({
 'vizType' : 'myextension'
});

Selections for viz frame. Example:

 var vizFrame = new sap.viz.ui5.controls.VizFrame(...);
 var points = [{
     data : {
         "Country" : "China",
         "Year" : "2001",
         "Product" : "Car",
         "Profit" : 25
     }}, {
     data : {
         "Country" : "China",
         "Year" : "2001",
         "Product" : "Trunk",
         "Profit" : 34
     }}];
 var action = {
     clearSelection : true
 };
vizFrame.vizSelection(points, action);

Update viz frame according to a JSON object, it can update css, properties, feeds and data model. Example:

var vizFrame = new sap.viz.ui5.controls.VizFrame(...);
var data = new  sap.viz.ui5.data.FlattenedDataset(...);
var properties = {
    'legend' : {'visible' : true},
};
var scales = [{
     'feed': 'color',
     'palette': ['#ff0000']
}];
var customizations = {id:"sap.viz.custom",customOverlayProperties: {}};
var FeedItem = sap.viz.ui5.controls.common.feeds.FeedItem;
var feeds = [
    new FeedItem({'uid' : 'primaryValues',
                  'type' : 'Measure',
                  'values' []}),
    new FeedItem({'uid' : 'regionColor',
                  'type' : 'Dimension',
                  'values' []})];
vizFrame.vizUpdate({
              'data' : data,
              'properties' : properties,
              'scales' : scales,
              'customizations' : customizations,
              'feeds' : feeds
          });

Zoom the chart plot.

Example:

 var vizFrame = new sap.viz.ui5.controls.VizFrame(...);
 vizFrame.zoom({direction: "in"});