Class: Writexlsx::Chart::Chartline

Inherits:
Object
  • Object
show all
Includes:
Gradient, Utility
Defined in:
lib/write_xlsx/chart/series.rb

Direct Known Subclasses

Gridline, Marker, Point, Trendline

Constant Summary

Constants included from Utility

Utility::CHAR_WIDTHS, Utility::COL_MAX, Utility::PERL_TRUE_VALUES, Utility::ROW_MAX, Utility::SHEETNAME_MAX, Utility::STR_MAX

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Gradient

#gradient_properties

Methods included from Utility

#absolute_char, #check_dimensions, #check_dimensions_and_update_max_min_values, #check_parameter, #color, #convert_date_time, #convert_font_args, #dash_types, delete_files, #escape_url, #fill_properties, #float_to_str, #get_font_latin_attributes, #get_font_style_attributes, #get_image_properties, #layout_properties, #legend_properties, #line_fill_properties, #line_properties, #palette_color, #params_to_font, #pattern_properties, #pixels_to_points, #process_bmp, #process_gif, #process_jpg, #process_png, #process_workbook_options, #ptrue?, #put_deprecate_message, #quote_sheetname, #r_id_attributes, #row_col_notation, #shape_style_base, #store_col_max_min_values, #store_row_max_min_values, #substitute_cellref, #underline_attributes, #v_shape_attributes_base, #v_shape_style_base, #value_or_raise, #write_a_body_pr, #write_a_def_rpr, #write_a_end_para_rpr, #write_a_lst_style, #write_a_p_formula, #write_a_p_pr_formula, #write_a_solid_fill, #write_a_srgb_clr, #write_anchor, #write_auto_fill, #write_color, #write_comment_path, #write_def_rpr_r_pr_common, #write_div, #write_fill, #write_font, #write_stroke, #write_tx_pr, #write_xml_declaration, #xl_cell_to_rowcol, #xl_col_to_name, #xl_range, #xl_range_formula, #xl_rowcol_to_cell, #xl_string_pixel_width, #xml_str

Constructor Details

#initialize(params) ⇒ Chartline

Returns a new instance of Chartline.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# File 'lib/write_xlsx/chart/series.rb', line 14

def initialize(params)
  @line      = params[:line]
  @fill      = params[:fill]
  @pattern   = params[:pattern]
  @gradient  = params[:gradient]
  # Set the line properties for the marker..
  @line = line_properties(@line)
  # Allow 'border' as a synonym for 'line'.
  @line = line_properties(params[:border]) if params[:border]
  # Set the fill properties for the marker.
  @fill = fill_properties(@fill)
  # Set the pattern properties for the series.
  @pattern = pattern_properties(@pattern)
  # Set the gradient fill properties for the series.
  @gradient = gradient_properties(@gradient)
  # Pattern fill overrides solid fill.
  @fill = nil if ptrue?(@gradient)
  # Gradient fill overrides solid and pattern fills.
  if ptrue?(@gradient)
    @pattern = nil
    @fill    = nil
  end
end

Instance Attribute Details

#fillObject (readonly)

Returns the value of attribute fill.



12
13
14
# File 'lib/write_xlsx/chart/series.rb', line 12

def fill
  @fill
end

#gradientObject (readonly)

Returns the value of attribute gradient.



12
13
14
# File 'lib/write_xlsx/chart/series.rb', line 12

def gradient
  @gradient
end

#lineObject (readonly)

Returns the value of attribute line.



12
13
14
# File 'lib/write_xlsx/chart/series.rb', line 12

def line
  @line
end

#patternObject (readonly)

Returns the value of attribute pattern.



12
13
14
# File 'lib/write_xlsx/chart/series.rb', line 12

def pattern
  @pattern
end

#typeObject (readonly)

Returns the value of attribute type.



12
13
14
# File 'lib/write_xlsx/chart/series.rb', line 12

def type
  @type
end

Instance Method Details

#fill_defined?Boolean

Returns:

  • (Boolean)


42
43
44
# File 'lib/write_xlsx/chart/series.rb', line 42

def fill_defined?
  fill && ptrue?(fill[:_defined])
end

#line_defined?Boolean

Returns:

  • (Boolean)


38
39
40
# File 'lib/write_xlsx/chart/series.rb', line 38

def line_defined?
  line && ptrue?(line[:_defined])
end