Class: Writexlsx::Drawings

Inherits:
Object
  • Object
show all
Includes:
Utility
Defined in:
lib/write_xlsx/drawing.rb

Constant Summary

Constants included from Utility

Utility::CHAR_WIDTHS, Utility::COL_MAX, Utility::DEFAULT_COL_PIXELS, Utility::MAX_DIGIT_WIDTH, Utility::PADDING, Utility::PERL_TRUE_VALUES, Utility::ROW_MAX, Utility::SHEETNAME_MAX, Utility::STR_MAX

Instance Attribute Summary collapse

Instance Method Summary collapse

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, #layout_properties, #legend_properties, #line_fill_properties, #line_properties, #palette_color_from_index, #params_to_font, #pattern_properties, #pixels_to_points, #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

Constructor Details

#initialize ⇒ Drawings

Returns a new instance of Drawings.



878
879
880
881
882
883
 
# File 'lib/write_xlsx/drawing.rb', line 878

def initialize
  @writer = Package::XMLWriterSimple.new
  @drawings    = []
  @embedded    = false
  @orientation = false
end

Instance Attribute Details

#embedded=(value) ⇒ Object (writeonly)

Sets the attribute embedded

Parameters:

  • value —

    the value to set the attribute embedded to.



876
877
878
 
# File 'lib/write_xlsx/drawing.rb', line 876

def embedded=(value)
  @embedded = value
end

#orientation=(value) ⇒ Object (writeonly)

Sets the attribute orientation

Parameters:

  • value —

    the value to set the attribute orientation to.



876
877
878
 
# File 'lib/write_xlsx/drawing.rb', line 876

def orientation=(value)
  @orientation = value
end

Instance Method Details

#add_drawing_object(drawing) ⇒ Object

Add a chart, image or shape sub object to the drawing.



922
923
924
 
# File 'lib/write_xlsx/drawing.rb', line 922

def add_drawing_object(drawing)
  @drawings << drawing
end

#assemble_xml_file ⇒ Object

Assemble and write the XML file.



896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
 
# File 'lib/write_xlsx/drawing.rb', line 896

def assemble_xml_file
  write_xml_declaration do
    # Write the xdr:wsDr element.
    write_drawing_workspace do
      if @embedded
        @drawings.each_with_index do |drawing, index|
          # Write the xdr:twoCellAnchor element.
          drawing.writer = @writer
          drawing.embedded = @embedded
          drawing.write_two_cell_anchor(index + 1)
        end
      else
        # Write the xdr:absoluteAnchor element.
        drawing = Drawing.new(nil, nil, nil, nil, nil, nil)
        drawing.writer = @writer
        drawing.embedded = @embedded
        drawing.orientation = @orientation
        drawing.write_absolute_anchor(1)
      end
    end
  end
end

#set_xml_writer(filename) ⇒ Object 



889
890
891
 
# File 'lib/write_xlsx/drawing.rb', line 889

def set_xml_writer(filename)
  @writer.set_xml_writer(filename)
end

#xml_str ⇒ Object 



885
886
887
 
# File 'lib/write_xlsx/drawing.rb', line 885

def xml_str
  @writer.string
end