KSC Open API  13.1
Kaspersky Security Center API description
Chart parameters structure

Data representing a chart is a params (params) containing the following entries:

AttributeTypeDescription
KLRPT_CHART_DATAarrayData array; each array entry (params) contains the following attributes:
  • data (array) - series data; number of entries equals to the number of series in chart; each entry, (paramInt) or (paramLong), contains data value for appropriate the series (identified by index);
  • name (paramString) - data element description.
KLRPT_CHART_DATA_DESCparamStringData description
KLRPT_CHART_LGND_DESCparamStringSeries legend description
KLRPT_CHART_SERIESarraySeries titles; number of entries equals to the number of series in chart; each entry (paramString) contains the series title (identified by index)
KLRPT_CHART_SERIES_COLORSarrayRecommended colors for series; number of entries equals to the number of series in chart; each entry (paramInt) contains the recommended series color (identified by index), in form of RGB-value (8 bits per component).
KLRPT_CHART_STACK_SERIESparamBoolTrue if series should be drawn in "stacked" form (for non-pie charts only).
KLRPT_HORIZONTAL_COLUMNSparamBoolTrue for horizontal chart orientation (for non-pie charts only).
KLRPT_CHART_PIEparamBoolTrue for pie chart.
KLRPT_USE_SERIES_COLORS_FOR_DATAparamBoolTrue for single-series charts to use colors in "KLRPT_CHART_SERIES_COLORS" parameter to show data from "KLRPT_CHART_DATA" array (by index).
KLRPT_ROUND_COLUMNSparamBoolTrue if columns should be drawn in "rounded" style (for non-pie charts only).

E.g.:

            +--- (paramParams)
                +---KLRPT_CHART_DATA (paramArray)
                |   +---0 (paramParams)
                |   |   +---data (paramArray)
                |   |   |   +---0 = (paramInt)0
                |   |   |   +---1 = (paramInt)4
                |   |   |   +---2 = (paramInt)0
                |   |   +---name = (paramString)"631B52B3A5263BCC29026B87EFEFC78C"
                |   +---1 (paramParams)
                |   |   +---data (paramArray)
                |   |   |   +---0 = (paramInt)1
                |   |   |   +---1 = (paramInt)3
                |   |   |   +---2 = (paramInt)0
                |   |   +---name = (paramString)"8092899C5F60B2580BE1EEBDD7F48742"
                |   +---2 (paramParams)
                |       +---data (paramArray)
                |       |   +---0 = (paramInt)1
                |       |   +---1 = (paramInt)1999
                |       |   +---2 = (paramInt)0
                |       +---name = (paramString)"A123-E56789-027F1F3F"
                +---KLRPT_CHART_DATA_DESC = (paramString)"Number of licensing units:"
                +---KLRPT_CHART_LGND_DESC = (paramString)"Key usage:"
                +---KLRPT_CHART_SERIES (paramArray)
                |   +---0 = (paramString)"In use"
                |   +---1 = (paramString)"Vacant"
                |   +---2 = (paramString)"Exceeded"
                +---KLRPT_CHART_SERIES_COLORS (paramArray)
                |   +---0 = (paramInt)9557089
                |   +---1 = (paramInt)13620370
                |   +---2 = (paramInt)8947967
                +---KLRPT_CHART_STACK_SERIES = (paramBool)true
                +---KLRPT_HORIZONTAL_COLUMNS = (paramBool)true