SVGGraph options: data_label_filter

« Return to previous page

Option name:

data_label_filter

Default value:

NULL

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.

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

Limits the data labels displayed.

This option specifies which labels should be shown. By default all labels are shown (up to the data_label_max_count value).

The value for this option should be a string containing one or more of these options:

• all

  Displays all the labels.

• none

  Displays none of the labels.

• start

  Displays the label for the first data item.

• end

  Displays the label for the last data item.

• min

  Displays the label for the data item with the minimum value.

• max

  Displays the label for the data item with the maximum value.

• peaks

  Displays labels for data items where the value has reached a peak (where the previous value is smaller and the next value is not any greater).

• troughs

  Displays labels for data items where the value has reached a trough (where the previous value is greater and the next value is not any smaller).

• nonzero

  Displays labels for any data items with a value greater than or less than 0.

• N (an integer)

  Displays data labels for every Nth data item.

• N+O (both integers)

  Displays data labels for every Nth data item, starting at offset O.

These options are explained with examples on the data labels page.

See also:

show_data_labels data_label_max_count

« Back to top of page Main SVGGraph page »