Class: GOffice::GraphGraph

Inherits:
GraphOutlinedObject show all
Defined in:
(unknown)

Class Method Summary collapse

Instance Method Summary collapse

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, #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, sax_push_parser, set_arg, #set_parent, #set_position_flags, #update, #write_xml_sax

Constructor Details

This class inherits a constructor from GOffice::GraphObject

Class Method Details

.supported_image_formats ⇒ GLib::SList<GOffice::ImageFormat>

Builds a list of supported formats for image export. of GOImage::Format.

Returns:

Instance Method Details

#data ⇒ GLib::SList<GOffice::Data>

The caller should not modify or free the list.

Returns:

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

    a list of the GOData objects that are data to the graph.

#document ⇒ GOffice::Doc

Returns document.

Returns:

#document=(document) ⇒ GOffice::Doc

Parameters:

Returns:

#dup ⇒ GOffice::GraphGraph

Returns a deep copy of graph.

Returns:

#export_image(format, output, x_dpi, y_dpi) ⇒ Boolean

Exports an image of graph in given format, writing results in a Gsf::Output stream. If export format type is a bitmap one, it computes image size with x_dpi, y_dpi and graph size (see gog_graph_get_size()).

Parameters:

  • format (GOffice::ImageFormat) —

    image format for export

  • output (Gsf::Output) —

    a Gsf::Output stream

  • x_dpi (Float) —

    x resolution of exported graph

  • y_dpi (Float) —

    y resolution of exported graph

Returns:

  • (Boolean) —

    true if export succeed.

#force_update ⇒ nil

Do an update now if one has been queued.

Returns:

  • (nil)

#get_size(width, height) ⇒ nil

FIXME Returns the logical size of graph, in points.

Parameters:

  • width (Float) —

    logical width in pts

  • height (Float) —

    logical height in pts

Returns:

  • (nil)

#height_pts ⇒ Float

Returns height-pts.

Returns:

  • (Float) —

    height-pts

#height_pts=(height_pts) ⇒ Float

Parameters:

  • height_pts (Float)

Returns:

  • (Float) —

    height-pts

  • (Float) —

    height-pts

#num_cols ⇒ Integer

Returns:

  • (Integer)

#num_rows ⇒ Integer

Returns:

  • (Integer)

#ref_data(dat) ⇒ GOffice::Data

Returns dat or something equivalent to it that already exists in the graph. Otherwise use dat. Adds a gobject ref to the target and increments a count of the number of refs made from this Gog::Graph.

Parameters:

Returns:

  • (GOffice::Data) —

    dat or something equivalent to it that already exists in the graph. Otherwise use dat. Adds a gobject ref to the target and increments a count of the number of refs made from this Gog::Graph.

#render_to_cairo(cairo, w, h) ⇒ nil

Renders a graph using cairo. w and h are the requested width an height of the rendered graph, in the current cairo coordinate space. This function is not suited for multiple rendering of the same graph. gog_renderer_render_to cairo or gog_renderer_update/gog_renderer_get_cairo_surface should be used instead.

Parameters:

  • cairo (cairo::Context) —

    a cairo context

  • w (Float) —

    width

  • h (Float) —

    height

Returns:

  • (nil)

#request_update ⇒ Boolean

queue an update if one had not already be queued.

Returns:

  • (Boolean) —

    true if a handler has been added.

#set_size(width, height) ⇒ nil

Sets the logical size of graph, given in points.

Parameters:

  • width (Float) —

    logical width in pts

  • height (Float) —

    logical height in pts

Returns:

  • (nil)

#theme ⇒ GOffice::GraphTheme

Returns theme.

Returns:

#theme=(theme) ⇒ GOffice::GraphTheme

Parameters:

Returns:

#theme_name ⇒ String

Returns theme-name.

Returns:

  • (String) —

    theme-name

#theme_name=(theme_name) ⇒ String

Parameters:

  • theme_name (String)

Returns:

  • (String) —

    theme-name

  • (String) —

    theme-name

#unref_data(dat) ⇒ nil

Parameters:

Returns:

  • (nil)

#validate_chart_layout ⇒ Boolean

Check the layout of the chart grid and ensure that there are no empty cols or rows, and resize as necessary

Returns:

  • (Boolean) —

    true if anything changed.

#width_pts ⇒ Float

Returns width-pts.

Returns:

  • (Float) —

    width-pts

#width_pts=(width_pts) ⇒ Float

Parameters:

  • width_pts (Float)

Returns:

  • (Float) —

    width-pts

  • (Float) —

    width-pts