PivotGauge
2 May 201824 minutes to read
The PivotGauge control is ideal for highlighting business critical Key Performance Indicator (KPI) information in executive dashboards and report cards. The PivotGauge let you present values against goals in a very intuitive manner.
Example
<ej-pivotgauge ></ej-pivotgauge>
export class AppComponent {
//..
}
Requires
- module:jQuery-3.0.0.min.js
- module:ej.core.js
- module:ej.data.js
- module:ej.waitingpopup.js
- module:ej.circulargauge.js
- module:ej.pivot.common.js
- module:ej.olap.base.js
- module:ej.pivotanalysis.base.js
- module:ej.pivotgauge.js
Members
columnsCount number
Sets the number of columns to arrange the Pivot Gauges.
Default Value: 0
Example:
<ej-pivotgauge [columnsCount]=1>
</ej-pivotgauge>
export class AppComponent {
//..
}
cssClass string
Specifies the CSS class to PivotGauge to achieve custom theme.
Default Value: “”
Example:
<ej-pivotgauge cssClass="gradient-lime">
</ej-pivotgauge>
export class AppComponent {
//..
}
customObject object
Object utilized to pass additional information between client-end and service-end on operating in server mode.
Default Value: {}
Example:
<ej-pivotgauge [customObject]="customObject">
</ej-pivotgauge>
export class AppComponent {
public customObject;
constructor()
{
this.customObject = { Language: "en-US" };
}
}
dataSource object
Initializes the data source for the PivotGauge widget, when it functions completely on client-side.
Default Value: {}
Example:
<ej-pivotgauge [dataSource]="dataSource">
</ej-pivotgauge>
export class AppComponent {
public dataSource;
constructor()
{
this.dataSource = { data: value };
}
}
dataSource.cube string
Contains the respective cube name from OLAP database as string type.
Default Value: “”
Example:
<ej-pivotgauge dataSource.cube="Adventure Works">
</ej-pivotgauge>
export class AppComponent {
//..
}
dataSource.sourceInfo string
To set the data source name to fetch data from that.
Note: This is applicable only for Mondrian connection.
Default Value: “”
Example:
<ej-pivotgauge dataSource.sourceInfo="Provider Mondrian">
</ej-pivotgauge>
export class AppComponent {
//..
}
dataSource.providerName string
Set the provider name for PivotGauge to identify whether the provider is SSAS or Mondrian.
Note: This is applicable only for client side OLAP data.
Default Value: “ssas”
Name | Description |
---|---|
ssas | To bind an OLAP data source to PivotGauge through SSAS provider. |
mondrian | To bind a relational data source to PivotGauge through Mondrian provider. |
Example:
<ej-pivotgauge dataSource.providerName="mondrian">
</ej-pivotgauge>
export class AppComponent {
//..
}
dataSource.data object
Provides the raw data source for the PivotGauge.
Default Value: null
Example:
<ej-pivotgauge [dataSource.data]="data">
</ej-pivotgauge>
export class AppComponent {
//..
}
dataSource.catalog string
In connection with an OLAP database, this property contains the database name as string to fetch the data from the given connection string.
Default Value: “”
Example:
<ej-pivotgauge dataSource.catalog="Adventure Works DW 2008 SE">
</ej-pivotgauge>
export class AppComponent {
//..
}
dataSource.columns array
Lists out the items to bind in columns section.
Default Value: []
Example:
<ej-pivotgauge [dataSource.columns]="columns">
</ej-pivotgauge>
export class AppComponent {
public columns;
constructor()
{
this.columns = itemsArray;
}
}
dataSource.columns.fieldName string
Allows the user to bind the item by using its unique name as field name.
Default Value: “”
Example:
<ej-pivotgauge [dataSource.columns]="columns">
</ej-pivotgauge>
export class AppComponent {
public columns;
constructor()
{
this.columns = [{ fieldName : "MyFieldName" }];
}
}
dataSource.columns.filterItems object
Applies filter to the field members.
Default Value: null
Example:
<ej-pivotgauge [dataSource.columns]="columns">
</ej-pivotgauge>
export class AppComponent {
public columns;
constructor()
{
this.columns = [{ fieldName: "Country", filterItems: { filterType: ej.PivotAnalysis.FilterType.Exclude, values: ["Canada", "France"] } }];
}
}
dataSource.columns.filterItems.filterType enum
Sets the type of filter whether to include/exclude the mentioned values.
Note: This is applicable for Relational datasource only.
Default Value: ej.PivotAnalysis.FilterType.Exclude
Name | Description |
---|---|
Exclude | Excludes the specified values among the members of the field. |
Include | Includes the specified values alone among the members of the field. |
Example:
<ej-pivotgauge [dataSource.columns]="columns">
</ej-pivotgauge>
export class AppComponent {
public columns;
constructor()
{
this.columns = [{ fieldName: "Country", filterItems: { filterType: ej.PivotAnalysis.FilterType.Include, values: valueArray } }] }];
}
}
dataSource.columns.filterItems.values array
Contains the collection of items to be included/excluded among the field members.
Default Value: []
Example:
<ej-pivotgauge [dataSource.columns]="columns">
</ej-pivotgauge>
export class AppComponent {
public columns;
constructor()
{
this.columns = [{ fieldName: "Country", filterItems: { filterType: ej.PivotAnalysis.FilterType.Exclude, values: ["Canada", "France"] } }];
}
}
dataSource.rows array
Lists out the items to bind in rows section.
Default Value: []
Example:
<ej-pivotgauge [dataSource.rows]="rows">
</ej-pivotgauge>
export class AppComponent {
public rows;
constructor()
{
this.rows = itemsArray;
}
}
dataSource.rows.fieldName string
Allows the user to bind the item by using its unique name as field name.
Default Value: “”
Example:
<ej-pivotgauge [dataSource.rows]="rows">
</ej-pivotgauge>
export class AppComponent {
public rows;
constructor()
{
this.rows = [{ fieldName : "MyFieldName" }];
}
}
dataSource.rows.filterItems object
Applies filter to the field members.
Default Value: null
Example:
<ej-pivotgauge [dataSource.rows]="rows">
</ej-pivotgauge>
export class AppComponent {
public rows;
constructor()
{
this.rows = [{ fieldName: "Country", filterItems: { filterType: ej.PivotAnalysis.FilterType.Exclude, values: ["Canada", "France"] } }];
}
}
dataSource.rows.filterItems.filterType enum
Sets the type of filter whether to include/exclude the mentioned values.
Note: This is applicable for Relational datasource only.
Default Value: ej.PivotAnalysis.FilterType.Exclude
Name | Description |
---|---|
Exclude | Excludes the specified values among the members of the field. |
Include | Includes the specified values alone among the members of the field. |
Example:
<ej-pivotgauge [dataSource.rows]="rows">
</ej-pivotgauge>
export class AppComponent {
public rows;
constructor()
{
this.rows = [{ fieldName: "Country", filterItems: { filterType: ej.PivotAnalysis.FilterType.Include, values: valueArray } }] }];
}
}
dataSource.rows.filterItems.values array
Contains the collection of items to be included/excluded among the field members.
Default Value: []
Example:
<ej-pivotgauge [dataSource.rows]="rows">
</ej-pivotgauge>
export class AppComponent {
public rows;
constructor()
{
this.rows = [{ fieldName: "Country", filterItems: { filterType: ej.PivotAnalysis.FilterType.Exclude, values: ["Canada", "France"] } }];
}
}
dataSource.values array
Lists out the items supports calculation in PivotGauge.
Default Value: []
Example:
<ej-pivotgauge [dataSource.values]="values">
</ej-pivotgauge>
export class AppComponent {
public values;
constructor()
{
this.values = itemsArray;
}
}
dataSource.values.fieldName string
Allows the user to bind the item by using its unique name as field name for Relational datasource.
Default Value: “”
Example:
<ej-pivotgauge [dataSource.values]="values">
</ej-pivotgauge>
dataSource.values.fieldCaption string
Allows the user to set the display caption for an item for Relational datasource.
Default Value: “”
Example:
<ej-pivotgauge [dataSource.values]="values">
</ej-pivotgauge>
export class AppComponent {
public values;
constructor()
{
this.values = [{ fieldCaption : "MyFieldCaption" }];
}
}
dataSource.values.measures array
This holds the list of unique names of measures to bind them from the OLAP cube.
Default Value: []
Example:
<ej-pivotgauge [dataSource.values]="values">
</ej-pivotgauge>
export class AppComponent {
public values;
constructor()
{
this.values = [{ measures: itemsArray }];
}
}
dataSource.values.measures.fieldName string
Allows the user to bind the measure from OLAP datasource by using its unique name as field name.
Default Value: “”
Example:
<ej-pivotgauge [dataSource.values]="values">
</ej-pivotgauge>
export class AppComponent {
public values;
constructor()
{
this.values = [{ measures: [{ fieldName: "MeasureUniqueName" }] }];
}
}
dataSource.values.axis string
Allows to set the axis name to place the measures items.
Note: This is applicable for OLAP datasource only.
Default Value: “rows”
Example:
<ej-pivotgauge [dataSource.values]="values">
</ej-pivotgauge>
export class AppComponent {
public values;
constructor()
{
this.values = [{ axis : ej.olap.AxisName.Row }];
}
}
dataSource.values.isCalculatedField boolean
Indicates whether the field is a calculated field or not with Relational datasource.
Default Value: false
Example:
<ej-pivotgauge [dataSource.values]="values">
</ej-pivotgauge>
export class AppComponent {
public values;
constructor()
{
this.values = [{ isCalculatedField : true }];
}
}
dataSource.values.formula string
Allows to set the formula for calculation of values for calculated members in Relational datasource.
Default Value: “”
Example:
<ej-pivotgauge [dataSource.values]="values">
</ej-pivotgauge>
export class AppComponent {
public values;
constructor()
{
this.values = [{ formula : "Quantity*10" }];
}
}
dataSource.filters array
Lists out the items which supports filtering of values without displaying the members in UI in PivotGauge.
Default Value: []
Example:
<ej-pivotgauge [dataSource.filters]="filters">
</ej-pivotgauge>
export class AppComponent {
public values;
constructor()
{
this.filters = itemsArray;
}
}
dataSource.filters.fieldName string
Allows the user to bind the item by using its unique name as field name.
Default Value: “”
Example:
<ej-pivotgauge [dataSource.filters]="filters">
</ej-pivotgauge>
export class AppComponent {
public values;
constructor()
{
this.filters = [{ fieldName : "MyFieldName" }];
}
}
dataSource.filters.filterItems object
Applies filter to the field members.
Default Value: null
Example:
<ej-pivotgauge [dataSource.filters]="filters">
</ej-pivotgauge>
export class AppComponent {
public values;
constructor()
{
this.filters = [{ fieldName: "Country", filterItems : { filterType: ej.PivotAnalysis.FilterType.Exclude, values: ["Canada", "France"] } }];
}
}
dataSource.filters.filterItems.filterType enum
Sets the type of filter whether to include/exclude the mentioned values.
Note: This is applicable for Relational datasource only.
Default Value: ej.PivotAnalysis.FilterType.Exclude
Name | Description |
---|---|
Exclude | Excludes the specified values among the members of the field. |
Include | Includes the specified values alone among the members of the field. |
Example:
<ej-pivotgauge [dataSource.filters]="filters">
</ej-pivotgauge>
export class AppComponent {
public values;
constructor()
{
this.filters = [{ fieldName: "Country", filterItems : { filterType: ej.PivotAnalysis.FilterType.Include, values: valueArray } }];
}
}
dataSource.filters.filterItems.values array
Contains the collection of items to be included/excluded among the field members.
Default Value: []
Example:
<ej-pivotgauge [dataSource.filters]="filters">
</ej-pivotgauge>
export class AppComponent {
public values;
constructor()
{
this.filters = [{ fieldName: "Country", filterItems : { filterType: ej.PivotAnalysis.FilterType.Exclude, values: ["Canada", "France"] } }];
}
}
enableAnimation boolean
Enables/disables the animation of pointer in PivotGauge.
Default Value: false
Example:
<ej-pivotgauge [enableAnimation]="true">
</ej-pivotgauge>
export class AppComponent {
//..
}
animationSpeed number
Specifies animation speed of PivotGauge
Default Value: 500
Example:
<ej-pivotgauge [animationSpeed]=500>
</ej-pivotgauge>
export class AppComponent {
//..
}
enableTooltip boolean
Enables/disables tooltip visibility in PivotGauge.
Default Value: false
Example:
<ej-pivotgauge [enableTooltip]="true">
</ej-pivotgauge>
export class AppComponent {
//..
}
enableRTL boolean
Allows the user to view PivotGauge from right to left.
Default Value: false
Example:
<ej-pivotgauge [enableRTL]="true">
</ej-pivotgauge>
export class AppComponent {
//..
}
isResponsive boolean
Allows the user to enable PivotGauge’s responsiveness in the browser layout.
Default Value: false
Example:
<ej-pivotgauge [isResponsive]="true">
</ej-pivotgauge>
export class AppComponent {
//..
}
labelFormatSettings object
Allows the user to change the format of the label values in PivotGauge.
Default Value: null
Example:
<ej-pivotgauge [labelFormatSettings]="labelFormatSettings">
</ej-pivotgauge>
export class AppComponent {
public labelFormatSettings;
constructor()
{
this.labelFormatSettings = labelValueSettings;
}
}
labelFormatSettings.numberFormat enum
Allows the user to change the number format of the label values in PivotGauge.
Default Value: ej.PivotGauge.NumberFormat.Default
Name | Description |
---|---|
Default | To set default format for label values. |
Currency | To set currency format for label values. |
Percentage | To set percentage format for label values. |
Fraction | To set fraction format for label values. |
Scientific | To set scientific format for label values. |
Text | To set text format for label values. |
Notation | To set notation format for label values. |
Example:
<ej-pivotgauge [labelFormatSettings.numberFormat]="numberFormat">
</ej-pivotgauge>
export class AppComponent {
public numberFormat;
constructor()
{
this.numberFormat = ej.PivotGauge.NumberFormat.Default;
}
}
labelFormatSettings.decimalPlaces number
Allows you to set the number of digits displayed after decimal point.
Default Value: 5
Example:
<ej-pivotgauge [labelFormatSettings.decimalPlaces]=3>
</ej-pivotgauge>
export class AppComponent {
//..
}
labelFormatSettings.prefixText string
Allows you to add a text at the beginning of the label.
Default Value: “ “
Example:
<ej-pivotgauge [labelFormatSettings.prefixText]="prefixTextValue">
</ej-pivotgauge>
export class AppComponent {
//..
}
labelFormatSettings.suffixText string
Allows you to add text at the end of the label.
Default Value: “ “
Example:
<ej-pivotgauge [labelFormatSettings.suffixText]="suffixTextValue">
</ej-pivotgauge>
export class AppComponent {
//..
}
locale string
Allows the user to set the localized language for the widget.
Default Value: “en-US”
Example:
<ej-pivotgauge locale="en-US">
</ej-pivotgauge>
export class AppComponent {
//..
}
rowsCount number
Sets the number of rows to arrange the Pivot Gauges.
Default Value: 0
Example:
<ej-pivotgauge [rowsCount]=1>
</ej-pivotgauge>
export class AppComponent {
//..
}
scales object
Sets the scale values such as pointers, indicators, etc… for PivotGauge.
Default Value: {}
Example:
<ej-pivotgauge [scales]="scales">
</ej-pivotgauge>
export class AppComponent {
public scales;
constructor()
{
this.scales = { showRanges: true, showIndicators: true };
}
}
serviceMethodSettings object
Allows the user to set the custom name for the methods at service-end, communicated during AJAX post.
Note: This is applicable only for server mode operation.
Default Value: {}
Example:
<ej-pivotgauge [serviceMethodSettings]="serviceMethodSettings">
</ej-pivotgauge>
export class AppComponent {
public serviceMethodSettings;
constructor()
{
this.serviceMethodSettings = { initialize: "MyMethod" };
}
}
showHeaderLabel boolean
Enables/disables the header labels in PivotGauge.
Default Value: true
Example:
<ej-pivotgauge [showHeaderLabel]="false">
</ej-pivotgauge>
export class AppComponent {
//..
}
analysisMode enum
Sets the mode for the PivotGauge widget for binding either OLAP or Relational data source.
Default Value: ej.Pivot.AnalysisMode.Pivot
Name | Description |
---|---|
Pivot | To bind Relational datasource to PivotGauge widget |
Olap | To bind OLAP datasource to PivotGauge widget |
Example:
<ej-pivotgauge [analysisMode]="analysisMode">
</ej-pivotgauge>
export class AppComponent {
public analysisMode;
constructor()
{
this.analysisMode = ej.Pivot.AnalysisMode.Olap;
}
}
operationalMode enum
Sets the mode for the PivotGauge widget for binding data source either in server-side or client-side.
Name | Description |
---|---|
ClientMode | To bind data source completely from client-side. |
ServerMode | To bind data source completely from server-side. |
Default Value: ej.Pivot.OperationalMode.ClientMode
Example:
<ej-pivotgauge [operationalMode]="operationalMode">
</ej-pivotgauge>
export class AppComponent {
public operationalMode;
constructor()
{
this.operationalMode = ej.Pivot.OperationalMode.ServerMode;
}
}
Methods
refresh()
This function is used to refresh the PivotGauge at client-side itself.
Example:
export class PivotChartComponent {
ngAfterViewInit(){
let gaugeObj = $(".e-pivotgauge").data("ejPivotGauge");
gaugeObj.refresh();
}
}
removeImg()
This function removes the KPI related images from PivotGauge on binding OLAP datasource.
Example:
export class PivotChartComponent {
ngAfterViewInit(){
let gaugeObj = $(".e-pivotgauge").data("ejPivotGauge");
gaugeObj.removeImg();
}
}
renderControlFromJSON()
This function receives the JSON formatted datasource and renders the PivotGauge control.
Example:
export class PivotChartComponent {
ngAfterViewInit(){
let gaugeObj = $(".e-pivotgauge").data("ejPivotGauge");
gaugeObj.renderControlFromJSON(this.getJSONRecords());
}
}
destroy()
This function Destroy the PivotGauge widget all events bound using this._on will be unbind automatically and bring the control to pre-init state.
Example:
export class PivotChartComponent {
ngAfterViewInit(){
let gaugeObj = $(".e-pivotgauge").data("ejPivotGauge");
gaugeObj.destroy();
}
}
getJSONRecords()
Returns the JSON records formed to render the control.
Returns:
array
Example:
export class PivotChartComponent {
ngAfterViewInit(){
let gaugeObj = $(".e-pivotgauge").data("ejPivotGauge");
let jsonRecords = gaugeObj.getJSONRecords();
}
}
setJSONRecords()
Sets the JSON records to render the control.
Example:
export class PivotChartComponent {
ngAfterViewInit(){
let gaugeObj = $(".e-pivotgauge").data("ejPivotGauge");
gaugeObj.setJSONRecords(jsonRecords);
}
}
getJSONData()
Returns the JSON records required to render the PivotGauge on performing any action with OLAP data source.
Example:
export class PivotChartComponent {
ngAfterViewInit(){
let gaugeObj = $(".e-pivotgauge").data("ejPivotGauge");
let args = { action : "initialize", activeObject : gaugeObj };
let jsonData = gaugeObj.getJSONData(args, dataSource);
}
}
Events
beforePivotEnginePopulate
Triggers before populating the pivot engine on operating in client mode.
Event Parameters | ||
---|---|---|
Name | Type | Description |
gaugeObject | object | returns the current instance of PivotGauge control. |
Example:
<ej-pivotgauge (beforePivotEnginePopulate)="beforePivotEnginePopulate($event)">
</ej-pivotgauge>
export class AppComponent {
beforePivotEnginePopulate(args){
//Enter your code here.
}
}
load
Triggers when PivotGauge started loading at client-side.
Event Parameters | ||
---|---|---|
Name | Type | Description |
action | string | returns the current action of PivotGauge control. |
model | object | returns the model of PivotGauge control. |
element | object | returns the HTML element of the widget. |
customObject | object | returns the custom object bound to the control. |
Example:
<ej-pivotgauge (load)="load($event)">
</ej-pivotgauge>
export class AppComponent {
load(args){
//Enter your code here.
}
}
renderComplete
Triggers when PivotGauge widget completes all operations at client-side after any AJAX request.
Event Parameters | ||
---|---|---|
Name | Type | Description |
customObject | object | returns the custom object bound with PivotGauge control. |
element | object | returns the HTML element of PivotGauge control. |
Example:
<ej-pivotgauge (renderComplete)="renderComplete($event)">
</ej-pivotgauge>
export class AppComponent {
renderComplete(args){
//Enter your code here.
}
}
renderFailure
Triggers when any error occurred during AJAX request.
Event Parameters | ||
---|---|---|
Name | Type | Description |
element | object | returns the HTML element of PivotGauge control. |
customObject | object | returns the custom object bound with the control. |
message | string | returns the error message with error code. |
Example:
<ej-pivotgauge (renderFailure)="renderFailure($event)">
</ej-pivotgauge>
export class AppComponent {
renderFailure(args){
//Enter your code here.
}
}
renderSuccess
Triggers when PivotGauge successfully reaches client-side after any AJAX request.
Event Parameters | ||
---|---|---|
Name | Type | Description |
element | object | returns the HTML element of PivotGauge control. |
customObject | object | returns the custom object bound with the control. |
Example:
<ej-pivotgauge (renderSuccess)="renderSuccess($event)">
</ej-pivotgauge>
export class AppComponent {
renderSuccess(args){
//Enter your code here.
}
}