SVGGraph options: legend_position

« Return to previous page

Option name:
legend_position
Default value:
"top right"
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:
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:
global legend

Position of the legend.

This option is a string or array specifying the position of the legend on the graph.

Using a string

The string version should contain a combination of these keywords:

  • top

    The legend will be at the top of the document. Default when neither top or bottom are specified.

  • bottom

    The legend will be at the bottom of the document.

  • left

    The legend will be on the left side of the document. Default when neither left or right are specified.

  • right

    The legend will be on the right side of the document.

  • inner

    The legend will be positioned inside the grid area on grid-based graphs, or inside the padding on other types of graph. Default when neither inner or outer are specified.

  • outer

    The legend will be positioned at the outer edges of the document.

The string can also contain a pair of X and Y numeric values to offset the legend by a specific number of pixels.

The position of the legend does not affect the position of the graph, or anything else - you must choose where to put the legend so that it does not interfere with the graph data (or use the legend_draggable and legend_autohide options).

The keywords in the string are read from left to right with the top/bottom, left/right and inner/outer pairs cancelling out previous occurrences. This means that a string like "inner outer left top bottom right" would give the same result as "outer bottom right".

Some examples:

// empty string, same as 'inner top left'
$settings['legend_position'] = '';

The default setting is the string "top right", but the default position when the string is empty is the top left corner inside the grid/padding area.

// bottom right of SVG document
$settings['legend_position'] = 'outer bottom right';

In this example the legend will be tight against the bottom and right edges of the SVG document.

// 10 pixels from right, 20 pixels from bottom
$settings['legend_position'] = 'bottom right -10 -20';

This example uses the X value -10 and Y value -20 to shift the legend in from the edge of the grid space or padding area.

Using an array

From version 3.14 you can use an array of coordinates to position the legend instead of a string, in the same format as used for shape options.

Examples:

// legend at 100,100
$settings['legend_position'] = [100, 100];

// legend at grid position 2,95
$settings['legend_position'] = ['g2', 'g95'];

// legend horizontally centred, 10 pixels down
$settings['legend_position'] = ['cx', 10];

// legend horizontally centred in grid area, 10 pixels from bottom
$settings['legend_position'] = ['gcx', 'gb-10'];

The coordinates format is described in full on the shapes page.

See also:
show_legend legend_entries legend_draggable legend_autohide

« Back to top of page Main SVGGraph page »

This site uses cookies - details here.