class Series extends ConfigObject (View source)

Properties

Annotation $annotation Alignment of the series.
string $curveType Overrides the global curveType value for this series.
string $targetAxisIndex Which axis is the target of the series definition.
TextStyle $textStyle Text style of the series.
string $type The type of marker for this series.

Methods

mixed
__construct( array $config = array())

Builds the series object when passed an array of configuration options.

array
toArray( string $keyName = null)

Returns an array representation of the object.

array
getValues()

Same as toArray, but without the class name as a key to being multi-dimension.

annotation( Annotation $annotation)

An object to be applied to annotations for this series.

curveType( string $curveType)

Controls the curve of the lines when the line width is not zero.

targetAxisIndex( int $index)

Which axis to assign this series to.

type( string $type)

The default line type for any series not specified in the series property.

textStyle( TextStyle $textStyle)

An object that specifies the series text style.

Details

at line 66
mixed __construct( array $config = array())

Builds the series object when passed an array of configuration options.

Parameters

array $config Array of options.

Return Value

mixed

in ConfigObject at line 93
array toArray( string $keyName = null)

Returns an array representation of the object.

If passed a label, then the array will be returned with the label as the key.

Called with no label returns an array with the classname as the key.

Parameters

string $keyName Key name to be applied to generated array.

Return Value

array Assoc. array of the options of the object.

in ConfigObject at line 115
array getValues()

Same as toArray, but without the class name as a key to being multi-dimension.

Return Value

array Array of the options of the object.

at line 79
Series annotation( Annotation $annotation)

An object to be applied to annotations for this series.

This can be used to control, for instance, the textStyle for the series.

Parameters

Annotation $annotation Style of the series annotations

Return Value

Series

Exceptions

InvalidConfigValue

at line 105
Series curveType( string $curveType)

Controls the curve of the lines when the line width is not zero.

Can be one of the following: 'none' - Straight lines without curve. 'function' - The angles of the line will be smoothed.

Parameters

string $curveType

Return Value

Series

Exceptions

InvalidConfigValue

at line 140
Series targetAxisIndex( int $index)

Which axis to assign this series to.

0 is the default axis, and 1 is the opposite axis.

Default value is 0; set to 1 to define a chart where different series are rendered against different axes.

At least one series much be allocated to the default axis. You can define a different scale for different axes.

Parameters

int $index

Return Value

Series

Exceptions

InvalidConfigValue

at line 163
Series type( string $type)

The default line type for any series not specified in the series property.

Available values are: 'line', 'area', 'bars', 'candlesticks' and 'steppedArea'

Parameters

string $type

Return Value

Series

Exceptions

InvalidConfigValue

at line 193
Series textStyle( TextStyle $textStyle)

An object that specifies the series text style.

Parameters

TextStyle $textStyle

Return Value

Series

Exceptions

InvalidConfigValue