GOffice.GraphSeries¶

Subclasses:	None

Methods¶

Inherited:	GOffice.GraphObject (40), GObject.Object (37), GOffice.StyledObject (8), GOffice.GraphDataset (7)
Structs:	GObject.ObjectClass (5)

	`check_validity` ()
	`get_element` (index)
	`get_fill_type` ()
	`get_fill_type_from_combo` (combo)
	`get_interpolation_params` ()
	`get_name` ()
	`get_overrides` ()
	`get_plot` ()
	`get_xy_data` (x, y)
	`get_xyz_data` (x, y, z)
	`has_legend` ()
	`is_valid` ()
	`map_XL_dim` (ms_type)
	`num_elements` ()
	`populate_fill_type_combo` (combo)
	`set_XL_dim` (ms_type, val)
	`set_dim` (dim_i, val)
	`set_fill_type` (fill_type)
	`set_index` (ind, is_manual)
	`set_name` (name_src)

Virtual Methods¶

Inherited:	GOffice.GraphStyledObject (2), GOffice.GraphObject (18), GObject.Object (7)

	`do_dim_changed` (dim_i)
	`do_get_interpolation_params` ()
	`do_get_xy_data` (x, y)

Properties¶

Inherited:	GOffice.GraphObject (8)

Name	Type	Flags	Short Description
`fill-type`	`str`	r/w	How to `GOffice.fill` the area
`has-legend`	`bool`	r/w	Should the series show up in legends
`interpolation`	`str`	r/w	Type of line interpolation
`interpolation-skip-invalid`	`bool`	r/w	Should the series interpolation ignore the invalid data

Signals¶

Inherited:	GOffice.GraphStyledObject (1), GOffice.GraphObject (7), GObject.Object (1)

Fields¶

Inherited:	GOffice.GraphStyledObject (1), GOffice.GraphObject (7), GObject.Object (1)

Name	Type	Access
acceptable_children	`int`	r
allowed_pos	`int`	r
base	`GOffice.GraphStyledObject`	r
default_pos	`GOffice.GraphSeriesLabelsPos`	r
fill_type	`GOffice.GraphSeriesFillType`	r
index	`int`	r
interpolation	`GOffice.LineInterpolation`	r
interpolation_skip_invalid	`bool`	r
manual_index	`int`	r
needs_recalc	`int`	r
overrides	[`object`]	r
plot	`GOffice.GraphPlot`	r
values	`GOffice.GraphDatasetElement`	r

Class Details¶

class GOffice.GraphSeries(**kwargs)¶

Bases:	`GOffice.GraphStyledObject`, `GOffice.GraphDataset`
Abstract:	Yes
Structure:	`GOffice.GraphSeriesClass`

check_validity()¶: Updates the is_valid flag for a series. This is an internal utility that should not really be necessary for general usage.

get_element(index)¶

Parameters:	index (`int`) – the element index
Returns:	the `GOffice.GraphSeriesElement` corresponding to index if any
Return type:	`GOffice.GraphSeriesElement`

get_fill_type()¶

Return type:	`GOffice.GraphSeriesFillType`

get_fill_type_from_combo(combo)¶

Parameters:	combo (`Gtk.ComboBox`) –
Return type:	`GOffice.GraphSeriesFillType`

get_interpolation_params()¶

Returns:	the interpolation parameters.
Return type:	`GOffice.GraphDataset`

Only constrained cubic spline interpolation use parameters (for the slopes at each end).

get_name()¶

Returns:	a `GOffice.DataScalar`, without added reference.
Return type:	`GOffice.Data`

Gets the _source_ of the name associated with the series. NOTE : this is _NOT_ the actual name.

get_overrides()¶

Returns:	the series overrides.
Return type:	[`GOffice.GraphSeriesElement`]

Overrides are data owning their own style, overriding the series style.

get_plot()¶

Returns:	the possibly `None` plot that contains this series.
Return type:	`GOffice.GraphPlot`

get_xy_data(x, y)¶

Parameters:	x (`float`) – y (`float`) –
Return type:	`int`

get_xyz_data(x, y, z)¶

Parameters:	x (`float`) – y (`float`) – z (`float`) –
Return type:	`int`

has_legend()¶

Returns:	`True` if the series has a visible legend entry
Return type:	`bool`

is_valid()¶

Returns:	the current cached validity. Does not recheck
Return type:	`bool`

map_XL_dim(ms_type)¶

Parameters:	ms_type (`GOffice.GraphMSDimType`) –
Return type:	`int`

num_elements()¶

Returns:	the number of elements in the series
Return type:	`int`

populate_fill_type_combo(combo)¶

Parameters:	combo (`Gtk.ComboBox`) –

set_XL_dim(ms_type, val)¶

Parameters:	ms_type (`GOffice.GraphMSDimType`) – val (`GOffice.Data`) –
Raises:	`GLib.Error`

set_dim(dim_i, val)¶

Parameters:	dim_i (`int`) – Which dimension val (`GOffice.Data`) – `GOffice.Data`
Raises:	`GLib.Error`

Absorbs a ref to val

set_fill_type(fill_type)¶

Parameters:	fill_type (`GOffice.GraphSeriesFillType`) –

set_index(ind, is_manual)¶

Parameters:	ind (`int`) – >= 0 assigns a new index, < 0 resets to auto is_manual (`bool`) – `bool`

If ind >= 0 attempt to assign the new index. Auto indicies (is_manual == False) will not override the current index if it is manual. An index < 0, will reset the index to automatic and potentially queue a revaluation of the parent chart’s cardinality.

set_name(name_src)¶

Parameters:	name_src (`GOffice.DataScalar`) – a `GOffice.DataScalar`
Raises:	`GLib.Error`

Absorbs a ref to name_src.

do_dim_changed(dim_i) virtual¶

Parameters:	dim_i (`int`) –

do_get_interpolation_params() virtual¶

Returns:	the interpolation parameters.
Return type:	`GOffice.GraphDataset`

Only constrained cubic spline interpolation use parameters (for the slopes at each end).

do_get_xy_data(x, y) virtual¶

Parameters:	x (`float`) – y (`float`) –
Return type:	`int`

Property Details¶

GOffice.GraphSeries.props.fill_type¶

Name:	`fill-type`
Type:	`str`
Default Value:	`'invalid'`
Flags:	`READABLE`, `WRITABLE`

How to GOffice.fill the area

GOffice.GraphSeries.props.has_legend¶

Name:	`has-legend`
Type:	`bool`
Default Value:	`True`
Flags:	`READABLE`, `WRITABLE`

Should the series show up in legends

GOffice.GraphSeries.props.interpolation¶

Name:	`interpolation`
Type:	`str`
Default Value:	`'linear'`
Flags:	`READABLE`, `WRITABLE`

Type of line interpolation

GOffice.GraphSeries.props.interpolation_skip_invalid¶

Name:	`interpolation-skip-invalid`
Type:	`bool`
Default Value:	`False`
Flags:	`READABLE`, `WRITABLE`

Should the series interpolation ignore the invalid data