Module: Libxlsxwriter::WorkbookWrappers

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

Overview

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:


84
85
86
# File 'lib/fast_excel/binding/workbook.rb', line 84

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

#add_formatFormat

Returns:


74
75
76
# File 'lib/fast_excel/binding/workbook.rb', line 74

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

#add_worksheet(sheetname) ⇒ Worksheet

Parameters:

  • sheetname (String)

Returns:


69
70
71
# File 'lib/fast_excel/binding/workbook.rb', line 69

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

#assemble_xml_filenil

Returns:

  • (nil)

159
160
161
# File 'lib/fast_excel/binding/workbook.rb', line 159

def assemble_xml_file()
  Libxlsxwriter.workbook_assemble_xml_file(self)
end

#closeSymbol from _enum_error_

Returns:


89
90
91
# File 'lib/fast_excel/binding/workbook.rb', line 89

def close()
  Libxlsxwriter.workbook_close(self)
end

#default_formatObject


78
79
80
# File 'lib/fast_excel/binding/workbook.rb', line 78

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:


137
138
139
# File 'lib/fast_excel/binding/workbook.rb', line 137

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

#freenil

Returns:

  • (nil)

154
155
156
# File 'lib/fast_excel/binding/workbook.rb', line 154

def free()
  Libxlsxwriter.workbook_free(self)
end

#get_worksheet_by_name(name) ⇒ Worksheet

Parameters:

  • name (String)

Returns:


143
144
145
# File 'lib/fast_excel/binding/workbook.rb', line 143

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:


123
124
125
# File 'lib/fast_excel/binding/workbook.rb', line 123

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:


130
131
132
# File 'lib/fast_excel/binding/workbook.rb', line 130

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:


116
117
118
# File 'lib/fast_excel/binding/workbook.rb', line 116

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:


109
110
111
# File 'lib/fast_excel/binding/workbook.rb', line 109

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:


102
103
104
# File 'lib/fast_excel/binding/workbook.rb', line 102

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

#set_default_xf_indicesnil

Returns:

  • (nil)

164
165
166
# File 'lib/fast_excel/binding/workbook.rb', line 164

def set_default_xf_indices()
  Libxlsxwriter.workbook_set_default_xf_indices(self)
end

#set_properties(properties) ⇒ Symbol from _enum_error_

Parameters:

Returns:


95
96
97
# File 'lib/fast_excel/binding/workbook.rb', line 95

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

#validate_worksheet_name(sheetname) ⇒ Symbol from _enum_error_

Parameters:

  • sheetname (String)

Returns:


149
150
151
# File 'lib/fast_excel/binding/workbook.rb', line 149

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