GOffice.GraphPlot¶

Subclasses:: None

Methods¶

Inherited:: GOffice.GraphObject (40), GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`families` ()
class	`family_unregister` (family)
class	`new_by_name` (id)
class	`new_by_type` (type)
	`axis_clear` (filter)
	`axis_set_assign` (type)
	`axis_set_is_valid` (type)
	`axis_set_pref` ()
	`clear_series` ()
	`foreach_elem` (only_visible, handler, *data)
	`get_axis` (type)
	`get_axis_bounds` (axis, bounds)
	`get_cardinality` (full, visible)
	`get_percent_value` (series, index)
	`get_series` ()
	`guru_helper` ()
	`new_series` ()
	`request_cardinality_update` ()
	`set_axis` (axis)
	`supports_vary_style_by_element` ()
	`update_3d` ()
	`update_cardinality` (index_num)

Virtual Methods¶

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

	`do_enum_in_reverse` ()
	`do_foreach_elem` (only_visible, handler, data)
	`do_get_percent` (series, index)
	`do_guru_helper` (hint)
	`do_supports_vary_style_by_element` ()
	`do_update_3d` ()

Properties¶

Inherited:: GOffice.GraphObject (8)

Name	Type	Flags	Short Description
`bubble-axis`	`int`	r/w	Reference to bubble axis
`circ-axis`	`int`	r/w	Reference to circular axis
`color-axis`	`int`	r/w	Reference to color axis
`guru-hints`	`str`	r/w	Semicolon separated list of hints for automatic addition of objects in guru dialog
`interpolation`	`str`	r/w	Default type of series line interpolation
`plot-group`	`str`	r/w	Name of plot group if any
`pseudo-3d-axis`	`int`	r/w	Reference to pseudo-3D axis
`radial-axis`	`int`	r/w	Reference to radial axis
`vary-style-by-element`	`bool`	r/w	Use a different style for each segment
`x-axis`	`int`	r/w	Reference to X axis
`y-axis`	`int`	r/w	Reference to Y axis
`z-axis`	`int`	r/w	Reference to Z axis

Signals¶

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

Fields¶

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

Name	Type	Access
axis	[`GOffice.GraphAxis`]	r
base	`GOffice.GraphObject`	r
cardinality_valid	`bool`	r
desc	`GOffice.GraphPlotDesc`	r
full_cardinality	`int`	r
guru_hints	`str`	r
index_num	`int`	r
interpolation	`GOffice.LineInterpolation`	r
plot_group	`str`	r
rendering_order	`GOffice.GraphPlotRenderingOrder`	r
series	[`object`]	r
vary_style_by_element	`bool`	r
visible_cardinality	`int`	r

Class Details¶

class GOffice.GraphPlot(**kwargs)¶

Bases:: GOffice.GraphObject
Abstract:: Yes
Structure:: GOffice.GraphPlotClass

classmethod families()¶

Returns:: the registered plot families.
Return type:: {str: GOffice.GraphPlotFamily}

classmethod family_unregister(family)¶

Parameters:: family (GOffice.GraphPlotFamily) –

classmethod new_by_name(id)¶

Parameters:: id (str) –
Return type:: GOffice.GraphPlot

classmethod new_by_type(type)¶

Parameters:: type (GOffice.GraphPlotType) –
Return type:: GOffice.GraphPlot

axis_clear(filter)¶

Parameters:: filter (GOffice.GraphAxisSet) – GOffice.GraphAxisSet

A utility method to clear all existing axis associations flagged by filter

axis_set_assign(type)¶

Parameters:: type (GOffice.GraphAxisSet) –
Return type:: bool

axis_set_is_valid(type)¶

Parameters:: type (GOffice.GraphAxisSet) –
Return type:: bool

axis_set_pref()¶

Return type:: GOffice.GraphAxisSet

clear_series()¶

foreach_elem(only_visible, handler, *data)¶

Parameters:

only_visible (bool) – whether to restrict to visible elements.
handler (GOffice.GraphEnumFunc) – GOffice.GraphEnumFunc
data (object or None) – user data for func

Executes funcfor each plot element. Used to build a legend.

get_axis(type)¶

Parameters:: type (GOffice.GraphAxisType) – GOffice.GraphAxisType
Returns:: the axis if any.
Return type:: GOffice.GraphAxis

get_axis_bounds(axis, bounds)¶

Parameters:

axis (GOffice.GraphAxisType) – GOffice.GraphAxisType
bounds (GOffice.GraphPlotBoundInfo) – GOffice.GraphPlotBoundInfo

Returns:

The data providing the bound (does not add a ref)

Return type:

GOffice.Data

Queries self for its axis preferences for axis and stores the results in bounds. All elements of bounds are initialized to sane values before the query _EXCEPT_ ::fmt. The caller is responsible for initializing it. This is done so that once on plot has selected a format the others need not do the lookup too if so desired.

Caller is responsible for unrefing ::fmt.

get_cardinality(full, visible)¶

Parameters:

full (int) – placeholder for full cardinality
visible (int) – placeholder for visible cardinality

Return the number of logical elements in the plot. See gog_chart_get_cardinality.

full and visible may be None.

get_percent_value(series, index)¶

Parameters:

series (int) –
index (int) –

Return type:

float

get_series()¶

Returns:: A list of the series in self. Do not modify or free the list.
Return type:: [GOffice.GraphSeries]

guru_helper()¶

new_series()¶

Returns:: a new GOffice.GraphSeries of a type consistent with self.
Return type:: GOffice.GraphSeries

request_cardinality_update()¶

set_axis(axis)¶

Parameters:: axis (GOffice.GraphAxis) – GOffice.GraphAxis

Connect axis and self.

supports_vary_style_by_element()¶

Return type:: bool

update_3d()¶

update_cardinality(index_num)¶

Parameters:: index_num (int) – index offset for this plot

Update cardinality and cache result. See gog_chart_get_cardinality.

do_enum_in_reverse() virtual¶

Return type:: bool

do_foreach_elem(only_visible, handler, data) virtual¶

Parameters:

only_visible (bool) – whether to restrict to visible elements.
handler (GOffice.GraphEnumFunc) – GOffice.GraphEnumFunc
data (object or None) – user data for func

Executes funcfor each plot element. Used to build a legend.

do_get_percent(series, index) virtual¶

Parameters:

series (int) –
index (int) –

Return type:

float

do_guru_helper(hint) virtual¶

Parameters:: hint (str) –

do_supports_vary_style_by_element() virtual¶

Return type:: bool

do_update_3d() virtual¶

Property Details¶

GOffice.GraphPlot.props.bubble_axis¶

Name:: bubble-axis
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Reference to bubble axis

GOffice.GraphPlot.props.circ_axis¶

Name:: circ-axis
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Reference to circular axis

GOffice.GraphPlot.props.color_axis¶

Name:: color-axis
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Reference to color axis

GOffice.GraphPlot.props.guru_hints¶

Name:: guru-hints
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Semicolon separated list of hints for automatic addition of objects in guru dialog

GOffice.GraphPlot.props.interpolation¶

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

Default type of series line interpolation

GOffice.GraphPlot.props.plot_group¶

Name:: plot-group
Type:: str
Default Value:: None
Flags:: READABLE, WRITABLE

Name of plot group if any

GOffice.GraphPlot.props.pseudo_3d_axis¶

Name:: pseudo-3d-axis
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Reference to pseudo-3D axis

GOffice.GraphPlot.props.radial_axis¶

Name:: radial-axis
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Reference to radial axis

GOffice.GraphPlot.props.vary_style_by_element¶

Name:: vary-style-by-element
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Use a different style for each segment

GOffice.GraphPlot.props.x_axis¶

Name:: x-axis
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Reference to X axis

GOffice.GraphPlot.props.y_axis¶

Name:: y-axis
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Reference to Y axis

GOffice.GraphPlot.props.z_axis¶

Name:: z-axis
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Reference to Z axis