SVGGraph options: figure

« Return to SVGGraph options page

Option name:
figure
Default value:
null
Added in version:
2.30
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 [?]

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:
Bar3DGraph BarAndLineGraph BarGraph BoxAndWhiskerGraph BubbleGraph CylinderGraph DonutGraph ExplodedPie3DGraph ExplodedPieGraph FloatingBarGraph GroupedBar3DGraph GroupedBarGraph GroupedCylinderGraph Histogram HorizontalBarGraph HorizontalFloatingBarGraph HorizontalGroupedBarGraph HorizontalStackedBarGraph LineGraph MultiLineGraph MultiRadarGraph MultiScatterGraph Pie3DGraph PieGraph PolarArea3DGraph PolarAreaGraph PopulationPyramid RadarGraph ScatterGraph SemiDonutGraph StackedBar3DGraph StackedBarAndLineGraph StackedBarGraph StackedCylinderGraph StackedGroupedBar3DGraph StackedGroupedBarGraph StackedGroupedCylinderGraph StackedLineGraph
Tags:
figure shape marker global

Defines a shape or group of shapes for reuse.

The figure option allows you to define complex shapes that can then be used as shapes or markers, or as components in other figures. The figure should be designed around the point (0,0) as the shape or shapes will be drawn with the origin translated to the required position.

The format of the figure option is an array of individual figures. Each figure is an array containing a name for the figure followed by one or more shape arrays.

Example:

$settings = array(
  'figure' => array(
    array(
      'the circle',
      array('circle', 'cx' => 10, 'cy' => 10, 'r' => 5),
      array('circle', 'cx' => 0, 'cy' => 0, 'r' => 6),
    ),
    array(
      'crosshairs',
      array('line', 'x1' => 0, 'x2' => 0, 'y1' => -10, 'y2' => 10),
      array('line', 'y1' => 0, 'y2' => 0, 'x1' => -10, 'x2' => 10),
    ),
  ),

  // use crosshairs as a shape
  'shape' => array(
    array('figure', 'name' => 'crosshairs', 'x' => 350, 'y' => 150),
  ),
);

This example creates two figures, one called "the circle" and containing two circles, and the second called "crosshairs" containing two lines crossing at (0,0). The first figure is not used, so will have no effect. The "crosshairs" figure is used as a shape positioned at (350,150).

The shape arrays are the same format as used by the shape option, a shape type followed by all the relevant options for drawing the shape. Figure shapes can contain other figures as long as they have already been defined in the figure array. Using undefined figures will result in an error message.

See also:
shape marker_type

« Back to top of page Main SVGGraph page »