SVGGraph options: guideline_text_position

« Return to previous page

Option name:

guideline_text_position

Default value:

"inside top right"

Added in version:

2.7

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:

no

Supported by:

Bar3DGraph BarAndLineGraph BarGraph BoxAndWhiskerGraph BubbleGraph CandlestickGraph CylinderGraph FloatingBarGraph GanttChart GroupedBar3DGraph GroupedBarGraph GroupedCylinderGraph HorizontalBar3DGraph HorizontalBarGraph HorizontalFloatingBarGraph HorizontalGroupedBar3DGraph HorizontalGroupedBarGraph HorizontalStackedBar3DGraph HorizontalStackedBarGraph LineGraph MultiLineGraph MultiScatterGraph MultiSteppedLineGraph PopulationPyramid ScatterGraph StackedBar3DGraph StackedBarAndLineGraph StackedBarGraph StackedCylinderGraph StackedGroupedBar3DGraph StackedGroupedBarGraph StackedGroupedCylinderGraph StackedLineGraph SteppedLineGraph

Tags:

guideline target line

Position of guide line text label.

This option sets the position of the title relative to the guide line. The value of this option should be a string containing one or more of these keywords (separated by spaces):

• "inside"

  The text label should be inside the grid area.

• "outside"

  The label should be outside the grid area.

• "top"

  The label will be above or at the top of the line.

• "bottom"

  The label will be below or at the bottom of the line.

• "left"

  The label will be to the left of the line.

• "right"

  The label will be to the right of the line.

The string can also contain a pair of X and Y offset values at the end to shift the label by a specific number of pixels in each direction:

$settings['guideline_text_position'] = "inside top left -10 -20";

This example will position the text at the top of the line and on the left, shifted 10 pixels to the left and 20 pixels up. Although the "inside" should put the text inside the grid area, the X and Y offset can move it anywhere (even off the edge of the SVG document).

See also:

guideline guideline_text_align guideline_text_padding guideline_text_angle

« Back to top of page Main SVGGraph page »