Class: GOffice::GraphChart

Inherits:

GraphOutlinedObject

• Object
• GraphObject
• GraphStyledObject
• GraphOutlinedObject
• GOffice::GraphChart

Defined in:

(unknown)

Class Method Summary

• .view_get_plot_area(view) ⇒ GOffice::GraphViewAllocation

Instance Method Summary

• #axis_set ⇒ GOffice::GraphAxisSet
• #axis_set_assign(type) ⇒ Boolean
• #axis_set_is_valid(type) ⇒ Boolean
• #cardinality_valid=(cardinality_valid) ⇒ Boolean
• #cardinality_valid? ⇒ Boolean

  Cardinality-valid.

• #columns ⇒ Integer

  Columns.

• #columns=(columns) ⇒ Integer
• #foreach_elem(only_visible, handler, data) ⇒ nil

  Applies handler to children.

• #get_axes(target) ⇒ GLib::SList<GOffice::GraphAxis>

  caller must free of all axis of type target associated with chart.

• #get_cardinality(full, visible) ⇒ nil

  Update and cache cardinality values if required, and returns full and visible cardinality.

• #get_plot_area(plot_area) ⇒ Boolean

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

• #get_position(x, y, cols, rows) ⇒ Boolean

  TRUE if the chart has been positioned.

• #grid ⇒ GOffice::GraphGrid

  otherwise NULL.

• #is_3d ⇒ Boolean
• #is_plot_area_manual=(is_plot_area_manual) ⇒ Boolean
• #is_plot_area_manual? ⇒ Boolean

  Is-plot-area-manual.

• #plot_area ⇒ String

  Plot-area.

• #plot_area=(plot_area) ⇒ String
• #plots ⇒ GLib::SList<GOffice::GraphPlot>

  in chart.

• #request_cardinality_update ⇒ nil
• #rows ⇒ Integer

  Rows.

• #rows=(rows) ⇒ Integer
• #set_position(x, y, cols, rows) ⇒ nil
• #xpos ⇒ Integer

  Xpos.

• #xpos=(xpos) ⇒ Integer
• #ypos ⇒ Integer

  Ypos.

• #ypos=(ypos) ⇒ Integer

Methods inherited from GraphOutlinedObject

#pad, #padding_pts, #padding_pts=

Methods inherited from GraphStyledObject

#style, #style=

Methods inherited from GraphObject

#add_by_name, #add_by_role, #alignment, #alignment=, #anchor, #anchor=, #can_reorder, #clear_parent, #compass, #compass=, #document_changed, #dup, #emit_changed, #find_role_by_name, #get_child_by_name, #get_child_by_role, #get_children, #get_editor, #get_manual_allocation, #get_manual_position, #get_parent_typed, #get_position_flags, #graph, #id, #id=, #initialize, #invisible=, #invisible?, #is_default_position_flags, #is_deletable, #is_position_manual=, #is_position_manual?, #manual_position=, #manual_size, #manual_size=, #manual_size_mode, #name, #name=, #new_view, #parent, #position, #position=, #possible_additions, register_roles, #reorder, #request_editor_update, #request_update, sax_push_parser, set_arg, #set_parent, #set_position_flags, #theme, #update, #write_xml_sax

Constructor Details

This class inherits a constructor from GOffice::GraphObject

Class Method Details

.view_get_plot_area(view) ⇒ GOffice::GraphViewAllocation

Parameters:

• view (GOffice::GraphView)

Returns:

• (GOffice::GraphViewAllocation)

Instance Method Details

#axis_set ⇒ GOffice::GraphAxisSet

Returns:

• (GOffice::GraphAxisSet)

#axis_set_assign(type) ⇒ Boolean

Parameters:

• type (GOffice::GraphAxisSet)

Returns:

• (Boolean)

#axis_set_is_valid(type) ⇒ Boolean

Parameters:

• type (GOffice::GraphAxisSet)

Returns:

• (Boolean)

#cardinality_valid=(cardinality_valid) ⇒ Boolean

Parameters:

• cardinality_valid (Boolean)

Returns:

• (Boolean) —

  cardinality-valid

• (Boolean) —

  cardinality-valid

#cardinality_valid? ⇒ Boolean

Returns cardinality-valid.

Returns:

• (Boolean) —

  cardinality-valid

#columns ⇒ Integer

Returns columns.

Returns:

• (Integer) —

  columns

#columns=(columns) ⇒ Integer

Parameters:

• columns (Integer)

Returns:

• (Integer) —

  columns

• (Integer) —

  columns

#foreach_elem(only_visible, handler, data) ⇒ nil

Applies handler to children

Parameters:

• only_visible (Boolean) —

  whether to only apply to visible children

• handler (GOffice::GraphEnumFunc) —

  callback

• data (GObject) —

  user data

Returns:

• (nil)

#get_axes(target) ⇒ GLib::SList<GOffice::GraphAxis>

caller must free of all axis of type target
associated with chart.

Parameters:

• target (GOffice::GraphAxisType) —

  Gog::AxisType

Returns:

• (GLib::SList<GOffice::GraphAxis>) —

  a list which the

#get_cardinality(full, visible) ⇒ nil

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 nil.

Parameters:

• full (Integer) —

  placeholder for full cardinality

• visible (Integer) —

  placeholder for visible cardinality

Returns:

• (nil)

#get_plot_area(plot_area) ⇒ Boolean

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

Parameters:

• plot_area (GOffice::GraphViewAllocation) —

  Gog::ViewAllocation

Returns:

• (Boolean) —

  true if plot area position is manual.

#get_position(x, y, cols, rows) ⇒ Boolean

Returns TRUE if the chart has been positioned.

Parameters:

• x (Integer)
• y (Integer)
• cols (Integer)
• rows (Integer)

Returns:

• (Boolean) —

  TRUE if the chart has been positioned.

#grid ⇒ GOffice::GraphGrid

otherwise NULL.

Returns:

• (GOffice::GraphGrid) —

  the grid associated with chart if one exists

#is_3d ⇒ Boolean

Returns:

• (Boolean)

#is_plot_area_manual=(is_plot_area_manual) ⇒ Boolean

Parameters:

• is_plot_area_manual (Boolean)

Returns:

• (Boolean) —

  is-plot-area-manual

• (Boolean) —

  is-plot-area-manual

#is_plot_area_manual? ⇒ Boolean

Returns is-plot-area-manual.

Returns:

• (Boolean) —

  is-plot-area-manual

#plot_area ⇒ String

Returns plot-area.

Returns:

• (String) —

  plot-area

#plot_area=(plot_area) ⇒ String

Parameters:

• plot_area (String)

Returns:

• (String) —

  plot-area

• (String) —

  plot-area

#plots ⇒ GLib::SList<GOffice::GraphPlot>

in chart.

Returns:

• (GLib::SList<GOffice::GraphPlot>) —

  the list of the plots

#request_cardinality_update ⇒ nil

Returns:

• (nil)

#rows ⇒ Integer

Returns rows.

Returns:

• (Integer) —

  rows

#rows=(rows) ⇒ Integer

Parameters:

• rows (Integer)

Returns:

• (Integer) —

  rows

• (Integer) —

  rows

#set_position(x, y, cols, rows) ⇒ nil

Parameters:

• x (Integer)
• y (Integer)
• cols (Integer)
• rows (Integer)

Returns:

• (nil)

#xpos ⇒ Integer

Returns xpos.

Returns:

• (Integer) —

  xpos

#xpos=(xpos) ⇒ Integer

Parameters:

• xpos (Integer)

Returns:

• (Integer) —

  xpos

• (Integer) —

  xpos

#ypos ⇒ Integer

Returns ypos.

Returns:

• (Integer) —

  ypos

#ypos=(ypos) ⇒ Integer

Parameters:

• ypos (Integer)

Returns:

• (Integer) —

  ypos

• (Integer) —

  ypos