Module: Libxlsxwriter::WorkbookWrappers

Included in:
Workbook
Defined in:
lib/fast_excel/binding.rb

Overview

(Not documented)

Fields:

:file

(FFI::Pointer(*FILE))

:worksheets

(Worksheets)

:worksheet_names

(WorksheetNames)

:charts

(Charts)

:ordered_charts

(Charts)

:formats

(Formats)

:defined_names

(DefinedNames)

:sst

(Sst)

:properties

(DocProperties)

:custom_properties

(CustomProperties)

:filename

(String)

:options

(WorkbookOptions)

:num_sheets

(Integer)

:first_sheet

(Integer)

:active_sheet

(Integer)

:num_xf_formats

(Integer)

:num_format_count

(Integer)

:drawing_count

(Integer)

:font_count

(Integer)

:border_count

(Integer)

:fill_count

(Integer)

:optimize

(Integer)

:has_png

(Integer)

:has_jpeg

(Integer)

:has_bmp

(Integer)

:used_xf_formats

(HashTable)

Instance Method Summary collapse

Instance Method Details

#add_chart(chart_type) ⇒ Chart

Parameters:

  • chart_type (Integer)

Returns:



7751
7752
7753
 
# File 'lib/fast_excel/binding.rb', line 7751

def add_chart(chart_type)
  Chart.new Libxlsxwriter.workbook_add_chart(self, chart_type)
end

#add_format ⇒ Format

Returns:



7741
7742
7743
 
# File 'lib/fast_excel/binding.rb', line 7741

def add_format()
  Format.new Libxlsxwriter.workbook_add_format(self)
end

#add_worksheet(sheetname) ⇒ Worksheet

Parameters:

  • sheetname (String)

Returns:



7736
7737
7738
 
# File 'lib/fast_excel/binding.rb', line 7736

def add_worksheet(sheetname)
  Worksheet.new Libxlsxwriter.workbook_add_worksheet(self, sheetname)
end

#assemble_xml_file ⇒ nil

Returns:

  • (nil) 


7826
7827
7828
 
# File 'lib/fast_excel/binding.rb', line 7826

def assemble_xml_file()
  Libxlsxwriter.workbook_assemble_xml_file(self)
end

#close ⇒ Symbol from _enum_error_

Returns:



7756
7757
7758
 
# File 'lib/fast_excel/binding.rb', line 7756

def close()
  Libxlsxwriter.workbook_close(self)
end

#default_format ⇒ Object 



7745
7746
7747
 
# File 'lib/fast_excel/binding.rb', line 7745

def default_format()
  Format.new Libxlsxwriter.workbook_default_format(self)
end

#define_name(name, formula) ⇒ Symbol from _enum_error_

Parameters:

  • name (String)
  • formula (String)

Returns:



7804
7805
7806
 
# File 'lib/fast_excel/binding.rb', line 7804

def define_name(name, formula)
  Libxlsxwriter.workbook_define_name(self, name, formula)
end

#free ⇒ nil

Returns:

  • (nil) 


7821
7822
7823
 
# File 'lib/fast_excel/binding.rb', line 7821

def free()
  Libxlsxwriter.workbook_free(self)
end

#get_worksheet_by_name(name) ⇒ Worksheet

Parameters:

  • name (String)

Returns:



7810
7811
7812
 
# File 'lib/fast_excel/binding.rb', line 7810

def get_worksheet_by_name(name)
  Worksheet.new Libxlsxwriter.workbook_get_worksheet_by_name(self, name)
end

#set_custom_property_boolean(name, value) ⇒ Symbol from _enum_error_

Parameters:

  • name (String)
  • value (Integer)

Returns:



7790
7791
7792
 
# File 'lib/fast_excel/binding.rb', line 7790

def set_custom_property_boolean(name, value)
  Libxlsxwriter.workbook_set_custom_property_boolean(self, name, value)
end

#set_custom_property_datetime(name, datetime) ⇒ Symbol from _enum_error_

Parameters:

Returns:



7797
7798
7799
 
# File 'lib/fast_excel/binding.rb', line 7797

def set_custom_property_datetime(name, datetime)
  Libxlsxwriter.workbook_set_custom_property_datetime(self, name, datetime)
end

#set_custom_property_integer(name, value) ⇒ Symbol from _enum_error_

Parameters:

  • name (String)
  • value (Integer)

Returns:



7783
7784
7785
 
# File 'lib/fast_excel/binding.rb', line 7783

def set_custom_property_integer(name, value)
  Libxlsxwriter.workbook_set_custom_property_integer(self, name, value)
end

#set_custom_property_number(name, value) ⇒ Symbol from _enum_error_

Parameters:

  • name (String)
  • value (Float)

Returns:



7776
7777
7778
 
# File 'lib/fast_excel/binding.rb', line 7776

def set_custom_property_number(name, value)
  Libxlsxwriter.workbook_set_custom_property_number(self, name, value)
end

#set_custom_property_string(name, value) ⇒ Symbol from _enum_error_

Parameters:

  • name (String)
  • value (String)

Returns:



7769
7770
7771
 
# File 'lib/fast_excel/binding.rb', line 7769

def set_custom_property_string(name, value)
  Libxlsxwriter.workbook_set_custom_property_string(self, name, value)
end

#set_default_xf_indices ⇒ nil

Returns:

  • (nil) 


7831
7832
7833
 
# File 'lib/fast_excel/binding.rb', line 7831

def set_default_xf_indices()
  Libxlsxwriter.workbook_set_default_xf_indices(self)
end

#set_properties(properties) ⇒ Symbol from _enum_error_

Parameters:

Returns:



7762
7763
7764
 
# File 'lib/fast_excel/binding.rb', line 7762

def set_properties(properties)
  Libxlsxwriter.workbook_set_properties(self, properties)
end

#validate_worksheet_name(sheetname) ⇒ Symbol from _enum_error_

Parameters:

  • sheetname (String)

Returns:



7816
7817
7818
 
# File 'lib/fast_excel/binding.rb', line 7816

def validate_worksheet_name(sheetname)
  Libxlsxwriter.workbook_validate_worksheet_name(self, sheetname)
end