ASPxPivotGrid.GetKPIImage(PivotKPIGraphic, PivotKPIType, Int32) Method

Returns an image that corresponds to the specified KPI value.

Namespace: DevExpress.Web.ASPxPivotGrid

Assembly: DevExpress.Web.ASPxPivotGrid.v19.2.dll

Declaration

public ImageProperties GetKPIImage(
    PivotKPIGraphic graphic,
    PivotKPIType kpiType,
    int value
)
Public Function GetKPIImage(
    graphic As PivotKPIGraphic,
    kpiType As PivotKPIType,
    value As Integer
) As ImageProperties

Parameters

Name Type Description
graphic PivotKPIGraphic

A PivotKPIGraphic enumeration value that specifies the KPI graphic set. You shouldn't use the 'None' and 'ServerDefined' values.

kpiType PivotKPIType

A PivotKPIType enumeration value that identifies the image set. Images can be obtained only for trend and status KPI types.

value Int32

An integer value that specifies the KPI value (-1, 0 or 1).

Returns

Type Description
ImageProperties

An ImageProperties object that contains image settings for 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 12 graphic sets such as shapes, smiley faces, traffic lights, etc. To get these images, use the ASPxPivotGrid.GetOLAPKPIServerGraphic method. Individual KPI images can be obtained via the GetKPIImage method.

See Also