SVGGraph options: label_v
- Option name:
label_v
- Default value:
""
- Added in version:
- 2.6
- 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
- Multi-axis:
- yes [?]
Multi-axis options allow specifying one option for all axes on a multi-axis graph, or an array of options to be used for each axis in turn. If there are more axes than entries in the option array, the sequence will be repeated.
Example:
$settings['axis_taste'] = 'banana'; $settings['axis_smell'] = ['lavender', 'lemon', 'pine'];
For this example, all axes will taste of banana, but the leftmost axis will smell of lavender, the second axis will smell of lemon and the third axis will smell of pine. If there is a fourth axis it will smell of lavender, repeating the sequence.
- Supported by:
- Bar3DGraph BarAndLineGraph BarGraph BoxAndWhiskerGraph BubbleGraph CandlestickGraph CylinderGraph FloatingBarGraph GanttChart GroupedBar3DGraph GroupedBarGraph GroupedCylinderGraph HorizontalBar3DGraph HorizontalBarGraph HorizontalFloatingBarGraph HorizontalGroupedBar3DGraph HorizontalGroupedBarGraph HorizontalStackedBar3DGraph HorizontalStackedBarGraph LineGraph MultiLineGraph MultiRadarGraph MultiScatterGraph MultiSteppedLineGraph PopulationPyramid RadarGraph ScatterGraph StackedBar3DGraph StackedBarAndLineGraph StackedBarGraph StackedCylinderGraph StackedGroupedBar3DGraph StackedGroupedBarGraph StackedGroupedCylinderGraph StackedLineGraph SteppedLineGraph
- Tags:
Text label for vertical axis.
This option sets a text label to display next to the vertical axis. The
default value is an empty string and no label is displayed. For multiple lines
of text, use a \n
character and remember to quote the string using
double-quote marks:
$settings['label_v'] = "Bananas per chicken\n(I've run out of ideas)";
For multiple Y-axis graphs the option supports an array containing a label for each axis, for example:
$settings['label_v'] = array('Pints of lager sold', 'Takeaway meal sales');
The lines that make up the text label are rotated through 90° with the bottom of the text nearest to the axis and the text centred relative to the grid area.
The label_v
option always labels the vertical axis and takes precedence
over the label_x
and label_y
options. For radar graphs the vertical axis
is the one that goes from the centre of the graph outwards.