On line guide/help

You are on page 28 of the online help. Navigate sequentially through the guide pages or search for a topic of interest to you.

Index Prev. Next

Kpichart

Draw a KPI chart

A KPI stands for Key Performance Indicator. It's a measurable value that shows how effectively a company or an individual is achieving a key business objective.
For example, think about your car's engine temperature. The engine temperature gauge quickly tells you if the engine is running as it should (not too hot, not too cold), which makes it a key performance indicator.


Parameters

Elements / attributes of the <kpichart> element:

Coordinate parameters (required) that define the print area of the chart
<x1> Starting X coordinate (upper/left corner)
<y1> Starting Y coordinate (upper/left corner)
<x2> Ending X coordinate (bottom/right corner)
<y2> Ending Y coordinate (bottom/right corner)
The coordinates can also be set with <x>, <y>, <width>, <height> instead of x1, y1, x2, y2 (one of the two methods is required).

Parameters that define the appearance of the graph:
<value> (numeric, float, required) Chart value to display. Placeholders are supported, eg. {kpi.margin} or {MY_VALUE} (version 1.0.11 or later)
<border> Border of the chart: 0 hide (default), 1 show (version 1.0.11 or later)
<radius> (numeric, float) Radius of the corners of the background area (if set to zero the background is a rectangle)
<title> (string) Chart title
<titlefont> Font of the title and of the segment label (if not set, the default font is used)
<format> Format mask of the displayed value, eg. F2 or C0 € (default: 1 decimal) (version 1.0.11 or later)
<segmentlist> Defines the segments that represent the different sections of the chart. Optional. If no segments are defined, a single default segment will be used.

Optional parameters:
<printif> Optional expression: the element is printed only if the expression is true, eg. {doc.type}=1. See the Conditional printing page.

Example

A KPI chart with two segments: red background for negative values, green background for positive values.

KPI chart example