PivotGridControl.GetKPIBitmap(PivotKPIGraphic, Int32) Method

Returns an image that corresponds to a specific KPI value.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v19.1.dll

Declaration

C#

public Bitmap GetKPIBitmap(
    PivotKPIGraphic graphic,
    int state
)

VB.NET

Public Function GetKPIBitmap(
    graphic As PivotKPIGraphic,
    state As Integer
) As Bitmap

Parameters

Name	Type	Description
graphic	PivotKPIGraphic	A PivotKPIGraphic enumeration value that specifies the KPI graphic set.
state	Int32	An integer value that specifies the KPI value (-1, 0 or 1).

Returns

Type	Description
Bitmap	A Bitmap object that corresponds to the specified KPI value.

Remarks

Since KPI supports graphic representation for its Status and Trend values, these values can be replaced with images. OLAP supports a number of graphic sets such as shapes, smiley faces, traffic lights, etc. To specify the graphic set a field, use the PivotGridFieldBase.KPIGraphic property. Individual KPI images can be obtained via the GetKPIBitmap method.

To learn more, see Key Performance Indicators (KPIs).

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the GetKPIBitmap(PivotKPIGraphic, Int32) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

how-to-implement-kpis-without-an-olap-datasource-e290/CS/Form1.cs#L44

if(e.DataField == fieldStatus)
    bitmap = pivotGridControl1.GetKPIBitmap(statusGraphic, GetStatusValue(e));
else

VB.NET

how-to-implement-kpis-without-an-olap-datasource-e290/VB/Form1.vb#L47

If e.DataField Is fieldStatus Then
    bitmap = pivotGridControl1.GetKPIBitmap(statusGraphic, GetStatusValue(e))
Else