SVGGraph options: label_y

« Return to previous page

Option name:

label_y

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 or FALSE value, or any values that convert easily such as 1, "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 or float 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 or 1.63e5 or M_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:

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:

axis label multi-axis

Text label for Y axis.

This option sets a text label to display next to the Y axis. For normal bar, line and scatter graphs this is the vertical axis up the side of the graph and for horizontal bar graphs it is the horizontal axis.

The default value of this option is an empty string and no label is displayed. The value of this option will be overridden by setting the label_v option (or the label_h option for horizontal graphs) to a non-empty string.

For multiple Y-axis graphs the option supports an array containing a label for each axis, for example:

$settings['label_y'] = array('Age in years', 'Weight in kilograms');

For more details see the label_h and label_v options.

See also:: label_h label_v label_x label_space label_font label_font_size label_colour graph_title

« Back to top of page Main SVGGraph page »