SVGGraph options: units_label
- Option name:
units_label
- Default value:
NULL
- Added in version:
- 2.13
- Data type:
- string [?]
The datatypes used in this documentation for specifying SVGGraph options are described below. All options can be a literal value of the data type described, a variable containing the data type, or an expression that will produce the data type when evaluated (and they must always be valid PHP expressions).
- array
- An
array
, the number and data types of its members will depend on the option for which is it used. - boolean
- A boolean
TRUE
orFALSE
value, or any values that convert easily such as1
,"1"
,0
and""
. - callback
- A callable function, which can be either the name of a function or an anonymous function itself.
- colour
- Any of the colour values supported by SVG inside a single or double
quoted string. These include three and six digit hex codes, RGB and
RGBA colours, and colour names. SVG uses
"none"
for no colour, which generally leaves things transparent. - fill
- A colour value or one of the gradients and patterns supported by SVGGraph. See the SVGGraph colours page for details.
- integer
- A negative or positive whole number or
0
. - measurement
- An
integer
orfloat
value, or a string containing a number followed by one of these CSS units:px
,in
,cm
,mm
,pt
,pc
. - number
- Any number supported by PHP, for example
1
or-3.2
or1.63e5
orM_PI
. - string
- Single or double quoted strings. Remember to double-quote your strings
if you are inserting a line break:
"Line 1\nLine 2"
.
- Per-dataset:
- no
- Supported by:
- ArrayGraph Bar3DGraph BarAndLineGraph BarGraph BoxAndWhiskerGraph BubbleGraph CandlestickGraph CylinderGraph Donut3DGraph DonutGraph EmptyGraph ExplodedDonut3DGraph ExplodedDonutGraph ExplodedPie3DGraph ExplodedPieGraph ExplodedSemiDonut3DGraph ExplodedSemiDonutGraph FloatingBarGraph GanttChart GroupedBar3DGraph GroupedBarGraph GroupedCylinderGraph Histogram HorizontalBar3DGraph HorizontalBarGraph HorizontalFloatingBarGraph HorizontalGroupedBar3DGraph HorizontalGroupedBarGraph HorizontalStackedBar3DGraph HorizontalStackedBarGraph LineGraph MultiLineGraph MultiRadarGraph MultiScatterGraph MultiSteppedLineGraph Pie3DGraph PieGraph PolarArea3DGraph PolarAreaGraph PopulationPyramid RadarGraph ScatterGraph SemiDonut3DGraph SemiDonutGraph StackedBar3DGraph StackedBarAndLineGraph StackedBarGraph StackedCylinderGraph StackedGroupedBar3DGraph StackedGroupedBarGraph StackedGroupedCylinderGraph StackedLineGraph SteppedLineGraph
- Tags:
String to display after value in data labels.
This option sets a string to display after the value inside data labels. This could be useful if your values are in millions, seconds, etc.
$settings['units_label'] = ' seconds';
This example will append the word "seconds" after the value in the label. The space is required in the string because SVGGraph does not add one.
To insert a units string in front of the value, use the units_before_label
option.
The string is only added to values in labels that come directly from the data.
Labels from structured data or the data_label_callback
function are not
affected.