Show TOC

Background documentationi5Chart Methods

 

You can use scripting methods to return information from an SAP Manufacturing Integration and Intelligence (SAP MII) chart.

Features

The following table lists common methods to use with i5Charts:

Methods

Description

Refresh ()

Refreshes only the chart with latest data from the query template. Changes to the display template are reflected in the updated chart.

getChartTemplateObject ()

Gets access to the JS object representation for the display template using getChartTemplateObject method.

getChartObject ()

Gets handle to the display template object that created the chart

getSelectedPoint ()

Returns the integer index of the selected point on the chart

getQueryObject ()

Returns the JS object representation of the query template associated with the chart

Update (boolean)

Calls the method on the chart object to run the chart with the modified display/query template settings. The boolean input property tells the application whether or not to run the Query template while updating the chart. If the value is True would run the Query Template. False would not run the query template

isTimeBasedQuery()

Returns true if the selected query is time-based.

setChartHeight(height)

Sets the height of the container/cell for the chart. In other words, the chart will be rendered in the specified height and stretch 100% to fit the width of the cell.

setChartWidth(width)

Sets the width of the container/cell for the chart.

setChartSize(width, height)

Sets the width and height of the container/cell for the chart.

getPenColor(dataSeriesIndex)

Gets the color of the marker

getPenMarkerStyle(dataSeriesIndex)

Gets the marker style

getPenType(dataSeriesIndex)

Gets the marker type

getViolationMarkerColor(dataSeriesIndex)

Gets the violation color marker of the selected attribute

getLineThickness(dataSeriesIndex)

Gets the thickness of the line

getLineStyle(dataSeriesIndex)

Gets the style of the line

setPenColor(dataSeriesIndex, color)

Sets the marker color

setPenMarkerStyle(dataSeriesIndex, markerStyleIndex)

Sets the style of the marker

setPenType(dataSeriesIndex, penType)

Sets the pen type

setViolationMarkerColor(dataSeriesIndex, color)

Sets the violation color marker of the selected attribute

setLineStyle(dataSeriesIndex, lineStyleIndex)

Sets the style of the line

setLineThickness(dataSeriesIndex, thickness)

Sets the thickness of the line

registerChartSelectionEventHandler(var myhandler)

This method will be called in OnChartSelection. You must pass Javascript method as the parameter to the method.

Activities

You can access Javadocs for the i5Charts using https://<server>:<port>/XMII/JSDOC/i5ChartAllClasses.html.