TThe following sections describe the available API calls, including their associated parameters and operations, which are provided with iWay Enable.
All iWay Enable JavaScript objects extend the following Support object.
iwenable.Support()
Parameters: None
All iWay Enable objects inherit the following operation. The operation renders the HTML and embeds the iWay Enable gauge or chart into the document.
render(url)
Parameter | Type | Description |
---|---|---|
url (Optional) | String | Specifies the URL for the XML file that renders the gauge or chart. If you supply a URL, it will override the value in the config parameter passed in the constructor of the extending object. |
iwenable is the iWay Enable namespace for all iWay Enable public APIs.
The namespace summary and detail are listed below:
Is the iWay Enable namespace, under which all iWay Enable APIs reside.
Method Summary:
Serializes a DOM object into an XML string.
Parameters:
Is the DOM object to be serialized.
Returns:
Method Summary:
Deserializes from an XML string into a DOM object.
Parameters:
Is the XML string to be parsed.
Returns:
Method Summary:
Returns the iWay Enable API version.
Returns:
Method Summary:
Constructs a DOM object from a Javascript object.
Parameters:
Is the Javascript object to convert into a DOM object.
Is the name of the root element in the constructed DOM object.
Returns:
Active reports are grid objects that allow special manipulation and configuration. An example of an active report is shown in the following example:
This API call creates an active report:
iwenable.ActiveReport(ctxt,id,debug,config,customData)
The Enable active report class wraps the active report library and provides integration with Enable dataset feeds.
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the ID of the HTML element that the grid is rendered in. |
debug | Integer | Configures the flag for debug options for the active report. Must be 1 or 0 (zero). |
config | Object | Configuration object for controlling the active report. An active report configuration object has the following parameters which are specified as strings:
Note: Italicized parameters are required. |
customData (Optional) | Object | Specifies the custom data which generates the active report without requiring data from a feed. The data must be a Javascript object in a dataset style. |
An angular gauge uses a radial scale to display a data range, and a dial to indicate a data value. One variation of an angular gauge is shown in the following image.
This API call creates an angular gauge. It is a subclas of Gauge.
iwenable.AngularGauge(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the gauge is rendered in. |
debug | Integer | Configures the flag for debug options for the angular gauge. Must be 1 or 0 (zero). |
config | Object | Configuration object for controlling the angular gauge. The default size is 240 x 200 pixels. |
The following methods are borrowed from the iwenable.Gauge class:
Use the following object for advanced configuration of iWay Enable gauges and charts.
The any object is a generic class used to load a custom SWF file, or an XML data file from a specified endpoint.
Note: Since the iwenable.ANY class is deprecated in iWay Enable 1.1, using the specific gauge classes is recommended.
This API call creates an ANY object:
iwenable.ANY(swf,durl,id,debug,config)
Parameter | Type | Description |
---|---|---|
swf | String | Specifies the URL for the Shockwave file. |
durl | String | Specifies the URL for the XML file that renders the object. |
id | String | Specifies the ID of the HTML element that will be rendered. |
debug | Integer | Specifies whether or not to debug the object. |
config | Object | Configures the iWay Enable object. |
The following methods are borrowed from the iwenable.Gauge class:
The bar chart class provides integration with the iWay Enable dataset feeds. Bar charts are displayed in two dimensions. The dataset columns corresponds to the Y-axis of a bar chart and the rows are displayed as different sets of data.
This API call creates a bar chart:
iwenable.BarChart(ctxt,id,config,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the bar chart is rendered in. |
config | Object | Configuration object for controlling the bar chart. A bar chart configuration object has the following parameters which are specified as strings:
Note: Italicized parameters are required. |
The following method is borrowed from the iwenable.YuiChart class:
You can use bubble charts when you want to visualize data. One variation of a bubble chart is shown in the following image.
This API call creates a bubble chart:
iwenable.Bubble(ctxt, id, debug, config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the ID of the HTML element that the chart is rendered in. |
debug | Integer | Configures the flag for debug options for the bubble chart. Must be 1 or 0 (zero). |
config | Object | Configuration object for controlling the bubble chart. |
You can use bulb gauges when a single value or state indicator is required. Colors can be selected to further enhance the visualization.
One variation of a bulb gauge is shown in the following image.
This API call creates a bulb gauge:
iwenable.Bulb(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the ID of the HTML element that the gauge is rendered in. |
debug | Integer | Configures the flag for debug options for the bulb gauge. Must be 1 or 0 (zero). |
config | Object | Configuration object for controlling the bulb gauge. The default size is 108 x 90 pixels. |
The following methods are borrowed from the iwenable.Gauge class:
Chart superclass is the parent class for all fusion widget charts. Charts are useful when you want to visualize data and discover patterns or trends over time. Data streaming charts are automatically updated in real-time.
Chart superclass provides basic fusion widget chart functionality and extension for all charts. Charts work differently then gauges in iWay Enable 1.1. Instead of making a call to the enable chart service (which is still available for backward compatibility), in iWay Enable 1.1, all fusion widget and fusion charts uses the document transform tools found under iwenable to generate the configuration XML, which is then directly fed into the Flash object
The API call creates a chart:
iwenable.Chart(ctxt, id, debug)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the ID of the HTML element that the gauge is rendered in. |
debug | Integer | Configures the flag for debug options for charts. Must be 1 or 0 (zero). |
The methods for charts is detailed below.
Is the rendering function. This is used to create or recreate the chart.
Parameter | Type | Description |
---|---|---|
durl (Optional) | String | Configures the durl formatted options to override the configuration. |
Changes or sets the configuration for the chart. If a chart element was specified in the configuration object, its options are merged into the options of the configuration object. The chart object takes precedance.
Parameter | Type | Description |
---|---|---|
config (Optional) | Object | Specifies the configuration object for charts. |
Column charts are charts that visualize two-dimensional data with comparison of the parts. The visuals are arranged as horizontally juxtaposed bars.
The column chart class provides integration with the iWay Enable dataset feeds. The dataset columns correspond to the X axis of a column chart. The rows are displayed as different sets of data. In this case, as different bars laid out side by side.
Parameter |
Type |
Description |
---|---|---|
ctxt |
String |
Specifies a relative or absolute path to the iWay Service Manager. |
id |
String |
Specifies the HTML element ID to the element that the chart is rendered in. |
config |
Object |
Configuration object for controlling the column chart. A column chart configuration object has the following parameters which are specified as strings:
Note: Italicized parameters are required. |
The following method is borrowed from the iwenable.YuiChart class:
A cylinder gauge indicates containment within a well-defined maximum and minimum value. Cylinder gauge is the gauge subclass for creating cylinders. One variation of a cylinder gauge is shown in the following image.
This API call creates a cylinder gauge. It is a subclass of gauge.
iwenable.Cylinder(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the gauge is rendered in. |
debug | Integer | Configures the flag for debug options for the cylinder gauge. Must be 1 or 0 (zero). |
config | Object | Specifies the configuration object for controlling the iWay Enable cylinder gauge. Cylinder has a default size of 144 x 180 pixels. |
The following methods are borrowed from the iwenable.Gauge class:
The YUI dataset chart superclass is the parent class for the YUI line chart. It is a superclass to the dataset YUI trendline chart superclass. The YUI dataset chart superclass provides more detailed functionality for manipulating dataset axis for chart consumption. Please refer to a specific chart object to create actual charts.
This API call creates a YUI dataset chart:
iwenable.DatasetYuiChart(ctxt, id, config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
config | Object | Specifies the configuration object for controlling the chart. |
The following method is borrowed from the iwenable.YuiChart class:
The YUI dataset trendline chart superclass is the parent class for many YUI charts and provides more detailed functionality for manipulating dataset series for chart consumption. Please refer to a specific chart object to create actual charts.
This API call creates a YUI dataset trendline chart:
iwenable.DatasetYuiTrendlineChart(ctxt, id, config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
config | Object | Specifies the configuration object for controlling the chart. |
The following method is borrowed from the iwenable.YuiChart class:
Data tables are basic grids that offers some styling, but not much more beyond functionality. They present a nice simple visualization for all dataset style feeds. One variation of a data table grid is shown in the following image.
Data table grids wraps the YUI data table object and provides integration with the iWay Enable dataset feeds.
This API call creates a data table grid:
iwenable.DataTable(ctxt, id, debug, config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the grid is rendered in. |
debug | Integer | Configures the flag for debug options for the data table grid. Must be 1 or 0 (zero). |
config | Object | Configuration object for controlling the data table. A data table grid configuration object has the following parameters which are specified as strings:
Note: Italicized parameters are required. |
Doughtnut 2D charts are useful when you when you want to visualize data and discover patterns or trends over time. Doughnut 2D charts extends fusion single series charts. One variation of a doughnut 2D chart is shown in the following image.
This API call creates a doughnut 2D chart. It extends the iwenable.FusionSingleSeriesChart class.
iwenable.Doughnut2D(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
debug | String | Configures the flag for debug options for the doughnut 2D chart. |
config | Object | Specifies the configuration object for controlling the chart. |
Doughtnut 3D charts are useful when you when you want to visualize data and discover patterns or trends over time. Doughnut 3D charts extends fusion single series charts. One variation of a doughnut 3D chart is shown in the following image.
This API call creates a doughnut 3D chart. It extends the iwenable.FusionSingleSeriesChart class.
iwenable.Doughnut3D(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
debug | String | Configures the flag for debug options for the doughnut 3D chart. |
config | Object | Specifies the configuration object for controlling the chart. |
Event clouds display as one-dimensional grids. They represent the data as differentially-sized labels. Event cloud grids creates a word cloud populated with entries from an iWay Enable JSON feed. The entries are typically event names, but can be anything. Each label is sized according to the specified sizing algorithm. One variation of an event cloud grid is shown in the following image.
This API call creates an event cloud grid:
iwenable.EventCloud(ctxt, id, debug, config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the grid is rendered in. |
debug | String | Configures the flag for debug options for the event cloud grid. Must be 1 or 0 (zero). |
config | Object | Specifies the configuration object for controlling the cloud grid. A event cloud grid configuration object has the following parameters which are specified as strings:
|
config (Continued) | Object (Continued) |
Note: Italicized parameters are required. |
Fusion charts superclass provides basic fusion chart funtionality for all charts to extend. Fusion charts work differently than the fusion widget charts, in that, they do not have native real-time update functionality. The iWay Enable integration layer provides functionality for integration with iWay Enable dataset feeds. Otherwise, fusion charts work similiarly to fusion widget charts.
This API call creates a fusion chart. It is a subclass of Chart.
iwenable.FusionCharts(ctxt, id, debug, config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the gauge is rendered in. |
debug | String | Configures the flag for debug options for fusion charts. Must be 1 or 0 (zero). |
config | Object | Specifies the configuration object for controlling fusion charts. A fusion chart configuration object has the following parameters which are specified as strings:
|
config (Continued) | Object (Continued) |
Note: Italicized parameters are required. |
Fusion single series chart is a superclass and extends the iwenable.FusionCharts class.
Parameter |
Type |
Description |
---|---|---|
ctxt |
String |
Specifies a relative or absolute path to the iWay Service Manager. |
id |
String |
Specifies the HTML element ID to the element that the chart is rendered in. |
debug |
String |
Configures the flag for debug options for the fusion single series chart. |
config |
Object |
Specifies the configuration object for controlling the chart. |
Gauge superclass is the parent class for all fusion widget gauges and provides functionality for all gauges to extend. Gauges are useful when you are interested in the current value of a monitored item. Gauges typically displays a single value as it falls within a range. This value can be updated in real-time.
Gauges converts the configuration object into a DURL format string, which is then fed to the service of the enable.gauge. The returned XML document is then used to drive the gauge.
This API call creates a gauge:
iwenable.Gauge(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies a relative or absolute path to the iWay Service Manager. |
id | String | Specifies the ID of the HTML element that the gauge is rendered in. |
debug | Integer | Configures the flag for debug options for gauges. Must be 1 or 0 (zero). |
config | Object | Specifies the configuration object for controlling the gauge. A typical gauge configuration object has the following parameters, which are specified as strings:
|
config (Continued) | Object |
Note: Italicized parameters are required. |
The methods for gauge is detailed below.
Is the rendering function. This creates or recreates the gauge.
Parameter | Type | Description |
---|---|---|
durl (Optional) | String | Specifies the DURL formatted options to override the configuration. |
Sets the configuration object for the gauge.
Parameter | Type | Description |
---|---|---|
config (Optional) | Object | Is the configuration object which replaces the exiting object specified in the constructor. |
Gauges typically displays a single value as it falls within a range. This value can be updated in real time. Several variations of Horizontal LED gauges are shown in the following image.
This API call creates a Horizontal LED gauge. It is a subclass of Gauge.
iwenable.HLED(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the elemet that the gauge is rendered in. |
debug | Integer | Configures the flag for debug options for gauges. Must be 1 or 0 (zero). |
config | Object | Specifies the configuration object for controlling the gauge. Horizontal LED gauge has a default size of 336 x 90 pixels. |
The following methods are borrowed from the iwenable.Gauge class:
A horizontal linear gauge indicates progression of a single value. Several variations of horizontal linear gauges are shown in the following image.
This API call creates a horizontal linear gauge. It is a subclass of Gauge.
iwenable.HLinearGauge(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the elemet that the gauge is rendered in. |
debug | Integer | Configures the flag for debug options for gauges. Must be 1 or 0 (zero). |
config | Object | Specifies the configuration object for controlling the gauge. Horizontal Linear gauge has a default size of 336 x 90 pixels. |
The following methods are borrowed from the iwenable.Gauge class:
Line charts are charts that visualize two-dimensional data as progressions. Line chart class provides integration with the iWay Enable dataset feeds. Data is displayed as lines progress across the X axis. The dataset columns corresponds to the X axis of a line chart. The rows are displayed as different sets of data. In this case, as different lines.
This API call creates a line chart. It extends the iwenable.DatasetYuiChart class.
iwenable.LineChart(ctxt, id, config, config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the elemet that the chart is rendered in. |
config | Object | Specifies the configuration object for controlling the chart. A line chart configuration object has the following parameters, which are specified as strings:
Note: Italicized parameters are required. |
The following method is borrowed from the iwenable.YuiChart class:
Pie chart class provides integration with the iWay Enable dataset feeds. Pie charts are charts that visualize one-dimensional data with respect to proportions of the whole and takes only the value of the first data column. The visuals are arranged as slices of a circular pie. Hence, the dataset feed used to drive it only needs to have a one data column.
This API call creates a pie chart. It extends the iwenable.YuiChart class.
iwenable.PieChart(ctxt, id, config, config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
config | Object | Specifies the configuration object for controlling the chart. A pie chart configuration object has the following parameters, which are specified as strings:
Note: Italicized parameters are required. |
The following method is borrowed from the iwenable.YuiChart class:
A real time area chart is similar to a line chart except that the area between the data line and axis is usually displayed in color. A real time area chart is shown in the following image.
This API call creates a real time area chart. It is a subclass of charts and extends the iwenable.Chart class.
iwenable.RealTimeArea(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
debug | Integer | Configures the flag for debug options for charts. Must be 1 or 0 (zero). |
config | Object | Specifies the configuration object for controlling the chart. A real time area chart configuration object has the following parameters, which are specified as strings:
|
config (Continued) | Object (Continued) |
|
config (Continued) | Object (Continued) |
Note: Italicized parameters are required. |
The following methods are borrowed from the iwenable.Chart class:
A real time column chart plots numerical data by displaying rectangular blocks against a scale that appears along the axis. The length of a column corresponds to a value or amount. A real time column chart is shown in the following image.
This API call creates a real time column chart. It is a subclass of charts and extends the iwenable.Chart class.
iwenable.RealTimeColumn(ctxt, id, debug, config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
debug | Integer | Configures the flag for debug options for charts. Must be 1 or 0 (zero). |
config | Object | Specifies the configuration object for controlling the chart. A real time column chart configuration object has the following parameters, which are specified as strings:
|
config (Continued) | Object (Continued) |
|
config (Continued) | Object (Continued) |
Note: Italicized parameters are required. |
The following methods are borrowed from the iwenable.Chart class:
A real time line chart reveals the movement or trend of numerical data over time. A real time line chart is shown in the following image.
This API call creates a real time line chart. It is a subclass of charts and extends the iwenable.Chart class.
iwenable.RealTimeLine(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
debug | Integer | Configures the flag for debug options for charts. Must be 1 or 0 (zero). |
config | Object | Specifies the configuration object for controlling the chart. A real time line chart configuration object has the following parameters, which are specified as strings:
|
config (Continued) | Object (Continued) |
|
config (Continued) | Object (Continued) |
Note: Italicized parameters are required. |
The following methods are borrowed from the iwenable.Chart class:
A real time line dual Y chart has two vertical axes. A real time line dual Y chart is shown in the following image.
This API call creates a real time line dual Y chart. It is a subclass of charts.
iwenable.RealTimeLineDY(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
debug | Integer | Configures the flag for debug options for charts. Must be 1 or 0 (zero). |
config | Object | Specifies the configuration object for controlling the chart. A real time line dual Y chart configuration object has the following parameters, which are specified as strings:
|
config (Continued) | Object (Continued) |
|
config (Continued) | Object (Continued) |
Note: Italicized parameters are required. |
The following methods are borrowed from the iwenable.Chart class:
A real time stacked area chart is shown in the following image.
This API call creates a real-time stacked area chart. It is a subclass of charts.
iwenable.RealTimeStackedArea(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
debug | Integer | Configures the flag for debug options for charts. Must be 1 or 0 (zero). |
config | Object | Specifies the configuration object for controlling the chart. A real time stacked area chart configuration object has the following parameters, which are specified as strings:
|
config (Continued) | Object (Continued) |
|
config (Continued) | Object (Continued) |
Note: Italicized parameters are required. |
The following methods are borrowed from the iwenable.Chart class:
A real time stacked column chart displays stacked groups of columns. A real time stacked column chart is shown in the following image.
This API call creates a real-time stacked column chart. It is a subclass of charts.
iwenable.RealTimeStackedColumn(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
debug | Integer | Configures the flag for debug options for charts. Must be 1 or 0 (zero). |
config | Object | Specifies the configuration object for controlling the chart. A real time stacked column chart configuration object has the following parameters, which are specified as strings:
|
config (Continued) | Object (Continued) |
|
config (Continued) | Object (Continued) |
Note: Italicized parameters are required. |
The following methods are borrowed from the iwenable.Chart class:
Stacked bar charts are charts that visualize two-dimensional data with regards to proportion to the whole. The visuals are arranged as horizontally stacked bars.
Stacked bar charts provides integration with the iWay Enable dataset feeds. The dataset columns corresponds to the Y axis of a stacked bar chart. The rows are displayed as different sets of data. In this case, as different bars stacked left to right.
This API call creates a stacked bar chart:
iwenable.StackedBarChart(ctxt,id,config,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
config | Object | Specifies the configuration object for controlling the chart. A stacked bar chart configuration object has the following parameters, which are specified as strings:
Note: Italicized parameters are required. |
The following method is borrowed from the iwenable.YuiChart class:
Stacked column charts are charts that visualize two-dimensional data with regards to proportion to the whole. The visuals are arranged as vertically stacked bars.
Stacked column charts provides integration with iWay Enable dataset feeds. The dataset columns corresponds to the Y axis of a stacked column chart. The rows are displayed as different sets of data. In this case, as different bars stacked on top of each other.
This API call creates a stacked column chart:
iwenable.StackedColumnChart(ctxt,id,config,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
config | Object | Specifies the configuration object for controlling the chart. A stacked column chart configuration object has the following parameters, which are specified as strings:
Note: Italicized parameters are required. |
The following method is borrowed from the iwenable.YuiChart class:
A thermometer gauge indicates the current position of a single data value within a given range of values. One variation of a thermometer gauge is shown in the following image.
This API call creates a thermometer gauge. It is a subclass of gauge.
iwenable.Thermometer(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the gauge is rendered in. |
debug | Integer | Configures the flag for debug options for the thermometer gauge. Must be 1 or 0 (zero). |
config | Object | Specifies the configuration object for controlling the gauge. Thermometer has a default size of 80 x 216 pixels. |
The following methods are borrowed from the iwenable.Gauge class:
One variation of a vertical LED gauge is shown in the following image.
This API call creates a vertical LED gauge. Vertical LED is a subclass of Gauge.
iwenable.VLED(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the gauge is rendered in. |
debug | Integer | Configures the flag for debug options for the vertical LED gauge. Must be 1 or 0 (zero). |
config | Object | Specifies the configuration object for controlling the gauge. Vertical LED has a default size of 80 x 216 pixels. |
The following methods are borrowed from the iwenable.Gauge class:
XY plot charts is a superclass and extends the iwenable.FusionChart class.
This API call creates an XY plot chart:
iwenable.XYPlotCharts(ctxt,id,debug,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
debug | Integer | Configures the flag for debug options for the XY plot chart. |
config | Object | Specifies the configuration object for controlling the chart. |
YUI chart superclass is the parent class for all YUI charts. This is a superclass to the iwenable.DatasetYuiChart class. Refer to a specific chart object in order to create an actual chart.
YUI charts superclass provides a basic YUI chart functionality for all such charts to extend. YUI charts creates a YUI data source object from the data which is returned by an iWay Enable feed. That object is then used to drive the indivudual YUI chart.
This API call creates a YUI chart:
iwenable.YuiChart(ctxt,id,config)
Parameter | Type | Description |
---|---|---|
ctxt | String | Specifies the relative or absolute path to the iWay Service Manager. |
id | String | Specifies the HTML element ID to the element that the chart is rendered in. |
config | Object | Specifies the configuration object for controlling the chart. |
The method for YUI chart is detailed below.
Is an empty function on YUI chart objects. They will render as soon as the constructor is called.
iWay Software |