SVGGraph options: legend_entries

« Return to previous page

Option name:
legend_entries
Default value:
NULL
Added in version:
2.6
Data type:
array [?]

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.
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 CylinderGraph DonutGraph EmptyGraph ExplodedDonutGraph ExplodedPie3DGraph ExplodedPieGraph FloatingBarGraph GroupedBar3DGraph GroupedBarGraph GroupedCylinderGraph Histogram HorizontalBarGraph HorizontalFloatingBarGraph HorizontalGroupedBarGraph HorizontalStackedBarGraph LineGraph MultiLineGraph MultiRadarGraph MultiScatterGraph MultiSteppedLineGraph Pie3DGraph PieGraph PolarArea3DGraph PolarAreaGraph PopulationPyramid RadarGraph ScatterGraph SemiDonutGraph StackedBar3DGraph StackedBarAndLineGraph StackedBarGraph StackedCylinderGraph StackedGroupedBar3DGraph StackedGroupedBarGraph StackedGroupedCylinderGraph StackedLineGraph SteppedLineGraph
Tags:
global legend

Array of entries for the legend.

Each entry in the array should be a string to display in the legend. For single dataset graphs, each data item will use one entry from the array. For multiple dataset graphs, each dataset will use one entry from the array.

Legend entries for data items that are 0 or NULL are not usually displayed - see the legend_show_empty option to change this behaviour.

The entries in this array can be overridden using the legend_text structured data option - see the Structured data page for details.

Entries may be split across multiple lines by including a linefeed character ("\n") inside the (double-quoted) string, for example "Watermelon\nbanana".

From version 3.9 each legend entry may be an array containing the legend text and a link.

Example:

$settings['legend_entries'] = ['Sales', 'Orders', ['Stock', '/stock-control/'] ];
See also:
show_legend legend_show_empty

« Back to top of page Main SVGGraph page »