SVGGraph options: data_label_position

« Return to previous page

Option name:

data_label_position

Default value:

"top"

HorizontalBarGraph: right

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

Position of data label.

This option is the position of the data label relative to the data item it is labelling. Note: the data labels for pie slices are positioned using the label_position option and are not affected by data_label_position.

The value of this option should be a string containing a sequence of one or more of these keywords:

inside or inner

The label will be inside the data item (if it fits).
outside or outer

The label will be outside the data item.
top

The label will be at the top of the data item.
bottom

The label will be at the bottom of the data item.
left

The label will be at the left of the data item.
right

The label will be at the right of the data item.
above

The label will be at the top of the data item and outside it.
below

The label will be at the bottom of the data item and outside it.
centre

The label will be in the middle of the data item.

The position string is read from left to right, with inside and outside keywords modifying the keywords that follow:

$settings['data_label_position'] = 'outside top inside left';

This example will place the label outside the top edge of the data item, but within its width on the left side.

The position string can also contain an X and Y pixel offset at the end:

$settings['data_label_position'] = 'above 20 -10';

This will put the label above the data item, but 20 pixels to the right and 10 pixels upwards.

See the data labels page for more details.

See also:: show_data_labels data_label_type label_position

« Back to top of page Main SVGGraph page »