Class: GOffice::GraphAxis

Inherits:
GraphAxisBase show all
Defined in:
(unknown)

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from GraphAxisBase

#clamped_position, #cross_axis_id, #cross_axis_id=, #cross_location, #crossed_axis, #crossed_axis_type, #get_crossed_axis_for_plot, #major_tick_in=, #major_tick_in?, #major_tick_labeled=, #major_tick_labeled?, #major_tick_out=, #major_tick_out?, #major_tick_size_pts, #major_tick_size_pts=, #minor_tick_in=, #minor_tick_in?, #minor_tick_out=, #minor_tick_out?, #minor_tick_size_pts, #minor_tick_size_pts=, #padding_pts, #padding_pts=, #pos, #pos=, #pos_str, #pos_str=, #position, #position=

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

.from_str=(str) ⇒ GOffice::GraphAxisSet

Parameters:

  • str (String)

Returns:

Instance Method Details

#add_contributor(contrib) ⇒ nil

Register contrib as taking part in the negotiation of axis's bounds.

Parameters:

Returns:

  • (nil)

#assigned_format_string_XL ⇒ String

Returns assigned-format-string-XL.

Returns:

  • (String) —

    assigned-format-string-XL

#assigned_format_string_XL=(assigned_format_string_XL) ⇒ String

Parameters:

  • assigned_format_string_XL (String)

Returns:

  • (String) —

    assigned-format-string-XL

  • (String) —

    assigned-format-string-XL

#atype ⇒ GOffice::GraphAxisType

Returns:

#axis_ref ⇒ String

Returns axis-ref.

Returns:

  • (String) —

    axis-ref

#axis_ref=(axis_ref) ⇒ String

Parameters:

  • axis_ref (String)

Returns:

  • (String) —

    axis-ref

  • (String) —

    axis-ref

#bound_changed(contrib) ⇒ nil

Parameters:

Returns:

  • (nil)

#circular_rotation ⇒ Float

Returns circular-rotation.

Returns:

  • (Float) —

    circular-rotation

#circular_rotation=(circular_rotation) ⇒ Float

Parameters:

  • circular_rotation (Float)

Returns:

  • (Float) —

    circular-rotation

  • (Float) —

    circular-rotation

#clear_contributors ⇒ nil

Returns:

  • (nil)

#color_map ⇒ GOffice::GraphAxisColorMap

Retrieves the Gog::AxisColorMap associated to the axis or nil.

Returns:

#color_map_name ⇒ String

Returns color-map-name.

Returns:

  • (String) —

    color-map-name

#color_map_name=(color_map_name) ⇒ String

Parameters:

  • color_map_name (String)

Returns:

  • (String) —

    color-map-name

  • (String) —

    color-map-name

#color_scale ⇒ GOffice::GraphColorScale

Retrieves the Gog::ColorScale associated to the axis or nil. for color and pseudo-3d axes.

Returns:

#contributors ⇒ GLib::SList<GOffice::GraphObject>

contributors

Returns:

#data_get_bounds(data, minimum, maximum) ⇒ nil

Parameters:

Returns:

  • (nil)

#date_conv ⇒ GOffice::DateConventions

Returns:

  • (GOffice::DateConventions)

#del_contributor(contrib) ⇒ nil

contrib no longer takes part in the negotiation of axis's bounds.

Parameters:

Returns:

  • (nil)

#display_factor ⇒ Float

Returns display-factor.

Returns:

  • (Float) —

    display-factor

#display_factor=(display_factor) ⇒ Float

Parameters:

  • display_factor (Float)

Returns:

  • (Float) —

    display-factor

  • (Float) —

    display-factor

#effective_format ⇒ GOffice::Format

from gog_axis_get_format in that it never returns a general format (see #go_format_is_general).

Returns:

  • (GOffice::Format) —

    the #GOFormat used for the axis labels. Differs

#format ⇒ GOffice::Format

Returns the format assigned to axis.

Returns:

  • (GOffice::Format) —

    the format assigned to axis.

#format=(fmt) ⇒ Boolean

Returns true if things changed.

Parameters:

  • fmt (GOffice::Format) —

    #GOFormat

Returns:

  • (Boolean) —

    true if things changed

#get_bounds(minima, maxima) ⇒ Boolean

Returns true if the bounds stored in minima and maxima are sane.

Parameters:

  • minima (Float) —

    non-NULL storage for result

  • maxima (Float) —

    non-NULL storage for result

Returns:

  • (Boolean) —

    true if the bounds stored in minima and maxima are sane

#get_effective_span(start, end) ⇒ nil

Parameters:

  • start (Float)
  • end (Float)

Returns:

  • (nil)

#get_entry(i, user_defined) ⇒ Float

Returns the value of axis element i and sets user_defined or NaN on error.

Parameters:

Returns:

  • (Float) —

    the value of axis element i and sets user_defined or NaN on error

#get_grid_line(major) ⇒ GOffice::GraphGridLine

if it doesn't exists.

Parameters:

  • major (Boolean) —

    whether to retrieve major or minor grid line.

Returns:

#get_labels(plot_that_labeled_axis) ⇒ GOffice::Data

along with the plot that it was associated with

Parameters:

Returns:

  • (GOffice::Data) —

    the possibly NULL #GOData used as a label for this axis

#get_ticks(ticks) ⇒ Integer

An accessor to axis->ticks.

Parameters:

  • ticks (GOffice::GraphAxisTick) —

    an array of Gog::AxisTick

Returns:

  • (Integer) —

    number of ticks

#invert_axis=(invert_axis) ⇒ Boolean

Parameters:

  • invert_axis (Boolean)

Returns:

  • (Boolean) —

    invert-axis

  • (Boolean) —

    invert-axis

#invert_axis? ⇒ Boolean

Returns invert-axis.

Returns:

  • (Boolean) —

    invert-axis

#is_center_on_ticks ⇒ Boolean

Returns TRUE if labels are centered on ticks when axis is discrete.

Returns:

  • (Boolean) —

    TRUE if labels are centered on ticks when axis is discrete

#is_discrete ⇒ Boolean

Returns TRUE if axis enumerates a set of discrete items, rather than a continuous value.

Returns:

  • (Boolean) —

    TRUE if axis enumerates a set of discrete items, rather than a continuous value

#is_inverted ⇒ Boolean

Returns TRUE if axis is inverted.

Returns:

  • (Boolean) —

    TRUE if axis is inverted.

#is_zero_important ⇒ Boolean

Returns:

  • (Boolean)

#major_ticks_distance ⇒ Float

Returns:

  • (Float)

#map_name ⇒ String

Returns map-name.

Returns:

  • (String) —

    map-name

#map_name=(map_name) ⇒ String

Parameters:

  • map_name (String)

Returns:

  • (String) —

    map-name

  • (String) —

    map-name

#metrics ⇒ String

Returns metrics.

Returns:

  • (String) —

    metrics

#metrics=(metrics) ⇒ String

Parameters:

  • metrics (String)

Returns:

  • (String) —

    metrics

  • (String) —

    metrics

#metrics_ratio ⇒ Float

Returns metrics-ratio.

Returns:

  • (Float) —

    metrics-ratio

#metrics_ratio=(metrics_ratio) ⇒ Float

Parameters:

  • metrics_ratio (Float)

Returns:

  • (Float) —

    metrics-ratio

  • (Float) —

    metrics-ratio

#metrics_unit ⇒ String

Returns metrics-unit.

Returns:

  • (String) —

    metrics-unit

#metrics_unit=(metrics_unit) ⇒ String

Parameters:

  • metrics_unit (String)

Returns:

  • (String) —

    metrics-unit

  • (String) —

    metrics-unit

#polar_perimeter ⇒ Float

Returns:

  • (Float)

#polar_unit ⇒ String

Returns polar-unit.

Returns:

  • (String) —

    polar-unit

#polar_unit=(polar_unit) ⇒ String

Parameters:

  • polar_unit (String)

Returns:

  • (String) —

    polar-unit

  • (String) —

    polar-unit

#ref_axis ⇒ GOffice::GraphAxis

NULL.

Returns:

#set_bounds(minimum, maximum) ⇒ nil

Sets axis bounds. If minimum or maximum are not finite values, corresponding bound remains unchanged.

Parameters:

  • minimum (Float) —

    axis low bound

  • maximum (Float) —

    axis high bound

Returns:

  • (nil)

#set_extents(start, stop) ⇒ nil

Set axis exents. It's a convenience function that sets axis bounds taking into account invert flag.

Parameters:

  • start (Float) —

    axis start bound

  • stop (Float) —

    axis stop bound

Returns:

  • (nil)

#span_end ⇒ Float

Returns span-end.

Returns:

  • (Float) —

    span-end

#span_end=(span_end) ⇒ Float

Parameters:

  • span_end (Float)

Returns:

  • (Float) —

    span-end

  • (Float) —

    span-end

#span_start ⇒ Float

Returns span-start.

Returns:

  • (Float) —

    span-start

#span_start=(span_start) ⇒ Float

Parameters:

  • span_start (Float)

Returns:

  • (Float) —

    span-start

  • (Float) —

    span-start

#type ⇒ Integer

Returns type.

Returns:

  • (Integer) —

    type

#type=(type) ⇒ Integer

Parameters:

  • type (Integer)

Returns:

  • (Integer) —

    type

  • (Integer) —

    type