Class: GOffice::GraphPlot

Inherits:
GraphObject show all
Defined in:
(unknown)

Class Method Summary collapse

Instance Method Summary collapse

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=, #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

#initialize(type) ⇒ GOffice::GraphPlot

Parameters:

  • type (GOffice::GraphPlotType)

Class Method Details

.families ⇒ GLib::HashTable<String>

registered plot families.

Returns:

  • (GLib::HashTable<String>) —

    the

.family_by_name(name) ⇒ GOffice::GraphPlotFamily

Returns the plot family if it exists.

Parameters:

  • name (String) —

    family name

Returns:

  • (GOffice::GraphPlotFamily) —

    the plot family if it exists.

.family_register(name, sample_image_file, priority, axis_set) ⇒ GOffice::GraphPlotFamily

Returns the new Gog::PlotFamily.

Parameters:

  • name (String) —

    family name

  • sample_image_file (String) —

    the sample image file name.

  • priority (Integer)
  • axis_set (GOffice::GraphAxisSet) —

    the used axis set.

Returns:

  • (GOffice::GraphPlotFamily) —

    the new Gog::PlotFamily.

.family_unregister(family) ⇒ nil

Parameters:

  • family (GOffice::GraphPlotFamily)

Returns:

  • (nil)

.type_register(family, col, row, name, sample_image_file, description, engine) ⇒ GOffice::GraphPlotType

Returns the new Gog::PlotType.

Parameters:

  • family (GOffice::GraphPlotFamily) —

    Gog::PlotFamily

  • col (Integer) —

    the column where the sample should appear.

  • row (Integer) —

    the row where the sample should appear.

  • name (String) —

    the plot type name.

  • sample_image_file (String) —

    the sample image file name.

  • description (String) —

    the plot type description.

  • engine (String) —

    the plot engine name.

Returns:

  • (GOffice::GraphPlotType) —

    the new Gog::PlotType.

Instance Method Details

#axis=(axis) ⇒ nil

Connect axis and plot.

Parameters:

Returns:

  • (nil)

#axis_clear(filter) ⇒ nil

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

Parameters:

Returns:

  • (nil)

#axis_set_assign(type) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#axis_set_is_valid(type) ⇒ Boolean

Parameters:

Returns:

  • (Boolean)

#axis_set_pref ⇒ GOffice::GraphAxisSet

Returns:

#bubble_axis ⇒ Integer

Returns bubble-axis.

Returns:

  • (Integer) —

    bubble-axis

#bubble_axis=(bubble_axis) ⇒ Integer

Parameters:

  • bubble_axis (Integer)

Returns:

  • (Integer) —

    bubble-axis

  • (Integer) —

    bubble-axis

#circ_axis ⇒ Integer

Returns circ-axis.

Returns:

  • (Integer) —

    circ-axis

#circ_axis=(circ_axis) ⇒ Integer

Parameters:

  • circ_axis (Integer)

Returns:

  • (Integer) —

    circ-axis

  • (Integer) —

    circ-axis

#clear_series ⇒ nil

Returns:

  • (nil)

#color_axis ⇒ Integer

Returns color-axis.

Returns:

  • (Integer) —

    color-axis

#color_axis=(color_axis) ⇒ Integer

Parameters:

  • color_axis (Integer)

Returns:

  • (Integer) —

    color-axis

  • (Integer) —

    color-axis

#description ⇒ GOffice::GraphPlotDesc

Returns the Gog::PlotDesc for plot.

Returns:

  • (GOffice::GraphPlotDesc) —

    the Gog::PlotDesc for plot.

#foreach_elem(only_visible, handler, data) ⇒ nil

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

Parameters:

  • only_visible (Boolean) —

    whether to restrict to visible elements.

  • handler (GOffice::GraphEnumFunc) —

    Gog::EnumFunc

  • data (GObject) —

    user data for func

Returns:

  • (nil)

#get_axis(type) ⇒ GOffice::GraphAxis

Returns the axis if any.

Parameters:

Returns:

#get_axis_bounds(axis, bounds) ⇒ GOffice::Data

Queries plot 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.

Parameters:

Returns:

  • (GOffice::Data) —

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

#get_cardinality(full, visible) ⇒ nil

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

full and visible may be nil.

Parameters:

  • full (Integer) —

    placeholder for full cardinality

  • visible (Integer) —

    placeholder for visible cardinality

Returns:

  • (nil)

#get_percent_value(series, index) ⇒ Float

Parameters:

  • series (Integer)
  • index (Integer)

Returns:

  • (Float)

#guru_helper ⇒ nil

Returns:

  • (nil)

#guru_hints ⇒ String

Returns guru-hints.

Returns:

  • (String) —

    guru-hints

#guru_hints=(guru_hints) ⇒ String

Parameters:

  • guru_hints (String)

Returns:

  • (String) —

    guru-hints

  • (String) —

    guru-hints

#interpolation ⇒ String

Returns interpolation.

Returns:

  • (String) —

    interpolation

#interpolation=(interpolation) ⇒ String

Parameters:

  • interpolation (String)

Returns:

  • (String) —

    interpolation

  • (String) —

    interpolation

#new_series ⇒ GOffice::GraphSeries

Returns a new GogSeries of a type consistent with plot.

Returns:

#plot_group ⇒ String

Returns plot-group.

Returns:

  • (String) —

    plot-group

#plot_group=(plot_group) ⇒ String

Parameters:

  • plot_group (String)

Returns:

  • (String) —

    plot-group

  • (String) —

    plot-group

#pseudo_3d_axis ⇒ Integer

Returns pseudo-3d-axis.

Returns:

  • (Integer) —

    pseudo-3d-axis

#pseudo_3d_axis=(pseudo_3d_axis) ⇒ Integer

Parameters:

  • pseudo_3d_axis (Integer)

Returns:

  • (Integer) —

    pseudo-3d-axis

  • (Integer) —

    pseudo-3d-axis

#radial_axis ⇒ Integer

Returns radial-axis.

Returns:

  • (Integer) —

    radial-axis

#radial_axis=(radial_axis) ⇒ Integer

Parameters:

  • radial_axis (Integer)

Returns:

  • (Integer) —

    radial-axis

  • (Integer) —

    radial-axis

#request_cardinality_update ⇒ nil

Returns:

  • (nil)

#series ⇒ GLib::SList<GOffice::GraphSeries>

Returns A list of the series in plot. Do not modify or free the list.

Returns:

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

    A list of the series in plot. Do not modify or free the list.

#supports_vary_style_by_element ⇒ Boolean

Returns:

  • (Boolean)

#update_3d ⇒ nil

Returns:

  • (nil)

#update_cardinality(index_num) ⇒ nil

Update cardinality and cache result. See gog_chart_get_cardinality.

Parameters:

  • index_num (Integer) —

    index offset for this plot

Returns:

  • (nil)

#vary_style_by_element=(vary_style_by_element) ⇒ Boolean

Parameters:

  • vary_style_by_element (Boolean)

Returns:

  • (Boolean) —

    vary-style-by-element

  • (Boolean) —

    vary-style-by-element

#vary_style_by_element? ⇒ Boolean

Returns vary-style-by-element.

Returns:

  • (Boolean) —

    vary-style-by-element

#x_axis ⇒ Integer

Returns x-axis.

Returns:

  • (Integer) —

    x-axis

#x_axis=(x_axis) ⇒ Integer

Parameters:

  • x_axis (Integer)

Returns:

  • (Integer) —

    x-axis

  • (Integer) —

    x-axis

#y_axis ⇒ Integer

Returns y-axis.

Returns:

  • (Integer) —

    y-axis

#y_axis=(y_axis) ⇒ Integer

Parameters:

  • y_axis (Integer)

Returns:

  • (Integer) —

    y-axis

  • (Integer) —

    y-axis

#z_axis ⇒ Integer

Returns z-axis.

Returns:

  • (Integer) —

    z-axis

#z_axis=(z_axis) ⇒ Integer

Parameters:

  • z_axis (Integer)

Returns:

  • (Integer) —

    z-axis

  • (Integer) —

    z-axis