GOffice.GraphChart

Subclasses:

None

Methods

Inherited:

GOffice.GraphOutlinedObject (1), GOffice.GraphObject (40), GObject.Object (37), GOffice.StyledObject (8)

Structs:

GObject.ObjectClass (5)

class	view_get_plot_area (view)
	axis_set_assign (type)
	axis_set_is_valid (type)
	foreach_elem (only_visible, handler, *data)
	get_axes (target)
	get_axis_set ()
	get_cardinality (full, visible)
	get_grid ()
	get_plot_area (plot_area)
	get_plots ()
	get_position (x, y, cols, rows)
	is_3d ()
	request_cardinality_update ()
	set_plot_area (plot_area)
	set_position (x, y, cols, rows)

Virtual Methods

Inherited:

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

Properties

Inherited:

GOffice.GraphOutlinedObject (1), GOffice.GraphObject (8)

Name	Type	Flags	Short Description
cardinality-valid	bool	r	Is the charts cardinality currently valid
columns	int	r/w	Number of columns in graph grid
is-plot-area-manual	bool	r/w	Is plot area manual
plot-area	str	r/w	Position and size of plot area, in percentage of chart size
rows	int	r/w	Number of rows in graph grid
xpos	int	r/w	Horizontal chart position in graph grid
ypos	int	r/w	Vertical chart position in graph grid

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	Description
axes	[object]	r
axis_set	GOffice.GraphAxisSet	r
base	GOffice.GraphOutlinedObject	r
cardinality_valid	bool	r
cols	int	r
full_cardinality	int	r
grid	GOffice.GraphObject	r
is_plot_area_manual	bool	r
plot_area	GOffice.GraphViewAllocation	r
plots	[object]	r
rows	int	r
visible_cardinality	int	r
x_pos	int	r
x_pos_actual	int	r
y_pos	int	r
y_pos_actual	int	r

Class Details

class GOffice.GraphChart(**kwargs)

Bases:

GOffice.GraphOutlinedObject

Abstract:

No

classmethod view_get_plot_area(view)

Parameters:

view (GOffice.GraphView) –

Return type:

GOffice.GraphViewAllocation

axis_set_assign(type)

Parameters:

type (GOffice.GraphAxisSet) –

Return type:

bool

axis_set_is_valid(type)

Parameters:

type (GOffice.GraphAxisSet) –

Return type:

bool

foreach_elem(only_visible, handler, *data)

Parameters:

• only_visible (bool) – whether to only apply to visible children

• handler (GOffice.GraphEnumFunc) – callback

• data (object or None) – user data

Applies handler to children

get_axes(target)

Parameters:

target (GOffice.GraphAxisType) – GOffice.GraphAxisType

Returns:

a list which the caller must free of all axis of type target associated with self.

Return type:

[GOffice.GraphAxis]

get_axis_set()

Return type:

GOffice.GraphAxisSet

get_cardinality(full, visible)

Parameters:

• full (int) – placeholder for full cardinality

• visible (int) – placeholder for visible cardinality

Update and cache cardinality values if required, and returns full and visible cardinality. Full cardinality is the number of chart elements that require a different style. Visible cardinality is the number of chart elements shown in chart legend.

full and visible may be None.

get_grid()

Returns:

the grid associated with self if one exists otherwise None.

Return type:

GOffice.GraphGrid

get_plot_area(plot_area)

Parameters:

plot_area (GOffice.GraphViewAllocation) – GOffice.GraphViewAllocation

Returns:

True if plot area position is manual.

Return type:

bool

Stores plot area in plot_area, in fraction of chart size.

get_plots()

Returns:

the list of the plots in self.

Return type:

[GOffice.GraphPlot]

get_position(x, y, cols, rows)

Parameters:

• x (int) –

• y (int) –

• cols (int) –

• rows (int) –

Returns:

True if the chart has been positioned.

Return type:

bool

is_3d()

Return type:

bool

request_cardinality_update()

set_plot_area(plot_area)

Parameters:

plot_area (GOffice.GraphViewAllocation) – GOffice.GraphViewAllocation

If plot_area != None, sets plot area size and location, in fraction of chart size, and sets GogChart::is_plot_area_manual flag to True. If plot_area == None, sets GogChart::is_plot_area_manual to False.

set_position(x, y, cols, rows)

Parameters:

• x (int) –

• y (int) –

• cols (int) –

• rows (int) –

Property Details

GOffice.GraphChart.props.cardinality_valid

Name:

cardinality-valid

Type:

bool

Default Value:

False

Flags:

READABLE

Is the charts cardinality currently valid

GOffice.GraphChart.props.columns

Name:

columns

Type:

int

Default Value:

1

Flags:

READABLE, WRITABLE

Number of columns in graph grid

GOffice.GraphChart.props.is_plot_area_manual

Name:

is-plot-area-manual

Type:

bool

Default Value:

False

Flags:

READABLE, WRITABLE

Is plot area manual

GOffice.GraphChart.props.plot_area

Name:

plot-area

Type:

str

Default Value:

'0 0 1 1'

Flags:

READABLE, WRITABLE

Position and size of plot area, in percentage of chart size

GOffice.GraphChart.props.rows

Name:

rows

Type:

int

Default Value:

1

Flags:

READABLE, WRITABLE

Number of rows in graph grid

GOffice.GraphChart.props.xpos

Name:

xpos

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE

Horizontal chart position in graph grid

GOffice.GraphChart.props.ypos

Name:

ypos

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE

Vertical chart position in graph grid