SVGGraph options: data_label_type

« Return to previous page

Option name:

data_label_type

Default value:

"plain"

Added in version:

2.18

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:

yes [?]

Per-dataset options allow specifying one option for all datasets or an array of options to be used for each dataset in turn. If there are more datasets than entries in the option array, the sequence will be repeated.

Example:

$settings['widget_taste'] = 'banana';
$settings['widget_colour'] = array(
  'red', 'green', 'blue'
);

For this example, the widgets for all datasets will taste of banana. The graph will use red widgets for dataset 0, green widgets for dataset 1 and blue widgets for dataset 2. Dataset 3 repeats the sequence so its widgets will be red, dataset 4 will have green widgets and dataset 5 will have blue widgets.

Structure:

yes [?]

Structure options may also be used as fields in the structure option's array to specify overriding settings for each data item. For more details and examples, visit the structured data page.

Example:

$settings['widget_grunge'] = 'very';
$settings['structure'] = array(
  'key' => 0, 'value' => 1,
  'widget_grunge' => 2
);

In this example widgets will be very grungy, except when a non-null item with the key 2 in the structured data array sets the grunginess to a different value.

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 label structure data-label

The style of label to use.

This option sets the style of the labels displayed for data items. The available options are:

plain

The text is displayed by itself, with no boxes or lines.
box

The text is displayed inside a box.
bubble

The text is displayed inside a speech-bubble shaped box, with a tail pointing towards the data item.
line

The text is displayed without a box, but with a line pointing from the text to the data item.

From version 2.26, the following styles are also available:

circle

The text is displayed inside a circle.
square

The text is displayed inside a square box.
linecircle

The text is displayed inside a circle with a tail line leading towards the data item.
linebox

The text is displayed inside a box with a tail line leading towards the data item.
linesquare

The text is displayed inside a square box with a tail line leading towards the data item.
line2

The text is displayed without a box, but with a filled tail line pointing to the data item.

The linecircle, linebox, linesquare and line2 styles support different line endings nearest the data item using the data_label_tail_end option.

See also:: show_data_labels data_label_same_size data_label_round data_label_tail_length data_label_tail_width data_label_tail_end

« Back to top of page Main SVGGraph page »