Module: Libxlsxwriter::WorksheetWrappers

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

Overview

(Not documented)

Fields:

:file

(FFI::Pointer(*FILE))

:optimize_tmpfile

(FFI::Pointer(*FILE))

:table

(TableRows)

:hyperlinks

(TableRows)

:array

(FFI::Pointer(**Cell))

:merged_ranges

(MergedRanges)

:selections

(Selections)

:image_data

(ImageData)

:chart_data

(ChartData)

:dim_rowmin

(Integer)

:dim_rowmax

(Integer)

:dim_colmin

(Integer)

:dim_colmax

(Integer)

:sst

(Sst)

:name

(String)

:quoted_name

(String)

:tmpdir

(String)

:index

(Integer)

:active

(Integer)

:selected

(Integer)

:hidden

(Integer)

:active_sheet

(FFI::Pointer(*Uint16T))

:first_sheet

(FFI::Pointer(*Uint16T))

:col_options

(FFI::Pointer(**ColOptions))

:col_options_max

(Integer)

:col_sizes

(FFI::Pointer(*Double))

:col_sizes_max

(Integer)

:col_formats

(FFI::Pointer(**Format))

:col_formats_max

(Integer)

:col_size_changed

(Integer)

:row_size_changed

(Integer)

:optimize

(Integer)

:optimize_row

(FFI::Pointer(*Row))

:fit_height

(Integer)

:fit_width

(Integer)

:horizontal_dpi

(Integer)

:hlink_count

(Integer)

:page_start

(Integer)

:print_scale

(Integer)

:rel_count

(Integer)

:vertical_dpi

(Integer)

:zoom

(Integer)

:filter_on

(Integer)

:fit_page

(Integer)

:hcenter

(Integer)

:orientation

(Integer)

:outline_changed

(Integer)

:outline_on

(Integer)

:page_order

(Integer)

:page_setup_changed

(Integer)

:page_view

(Integer)

:paper_size

(Integer)

:print_gridlines

(Integer)

:print_headers

(Integer)

:print_options_changed

(Integer)

:right_to_left

(Integer)

:screen_gridlines

(Integer)

:show_zeros

(Integer)

:vba_codename

(Integer)

:vcenter

(Integer)

:zoom_scale_normal

(Integer)

:tab_color

(Integer)

:margin_left

(Float)

:margin_right

(Float)

:margin_top

(Float)

:margin_bottom

(Float)

:margin_header

(Float)

:margin_footer

(Float)

:default_row_height

(Float)

:default_row_pixels

(Integer)

:default_col_pixels

(Integer)

:default_row_zeroed

(Integer)

:default_row_set

(Integer)

:header_footer_changed

(Integer)

:header

(Array<Integer>)

:footer

(Array<Integer>)

:repeat_rows

(RepeatRows)

:repeat_cols

(RepeatCols)

:print_area

(PrintArea)

:autofilter

(Autofilter)

:merged_range_count

(Integer)

:hbreaks

(FFI::Pointer(*RowT))

:vbreaks

(FFI::Pointer(*ColT))

:hbreaks_count

(Integer)

:vbreaks_count

(Integer)

:external_hyperlinks

(FFI::Pointer(*RelTuples))

:external_drawing_links

(FFI::Pointer(*RelTuples))

:drawing_links

(FFI::Pointer(*RelTuples))

:panes

(Panes)

:protection

(Protection)

:drawing

(Drawing)

:list_pointers

(WorksheetListPointers)

Instance Method Summary collapse

Instance Method Details

#activatenil

Returns:

  • (nil)


6309
6310
6311
# File 'lib/fast_excel/binding.rb', line 6309

def activate()
  Libxlsxwriter.worksheet_activate(self)
end

#assemble_xml_filenil

Returns:

  • (nil)


6548
6549
6550
# File 'lib/fast_excel/binding.rb', line 6548

def assemble_xml_file()
  Libxlsxwriter.worksheet_assemble_xml_file(self)
end

#autofilter(first_row, first_col, last_row, last_col) ⇒ Symbol from _enum_error_

Parameters:

  • first_row (Integer)
  • first_col (Integer)
  • last_row (Integer)
  • last_col (Integer)

Returns:



6304
6305
6306
# File 'lib/fast_excel/binding.rb', line 6304

def autofilter(first_row, first_col, last_row, last_col)
  Libxlsxwriter.worksheet_autofilter(self, first_row, first_col, last_row, last_col)
end

#center_horizontallynil

Returns:

  • (nil)


6456
6457
6458
# File 'lib/fast_excel/binding.rb', line 6456

def center_horizontally()
  Libxlsxwriter.worksheet_center_horizontally(self)
end

#center_verticallynil

Returns:

  • (nil)


6461
6462
6463
# File 'lib/fast_excel/binding.rb', line 6461

def center_vertically()
  Libxlsxwriter.worksheet_center_vertically(self)
end

#find_row(row_num) ⇒ Row

Parameters:

  • row_num (Integer)

Returns:



6575
6576
6577
# File 'lib/fast_excel/binding.rb', line 6575

def find_row(row_num)
  Row.new Libxlsxwriter.worksheet_find_row(self, row_num)
end

#fit_to_pages(width, height) ⇒ nil

Parameters:

  • width (Integer)
  • height (Integer)

Returns:

  • (nil)


6496
6497
6498
# File 'lib/fast_excel/binding.rb', line 6496

def fit_to_pages(width, height)
  Libxlsxwriter.worksheet_fit_to_pages(self, width, height)
end

#freenil

Returns:

  • (nil)


6543
6544
6545
# File 'lib/fast_excel/binding.rb', line 6543

def free()
  Libxlsxwriter.worksheet_free(self)
end

#freeze_panes(row, col) ⇒ nil

Parameters:

  • row (Integer)
  • col (Integer)

Returns:

  • (nil)


6331
6332
6333
# File 'lib/fast_excel/binding.rb', line 6331

def freeze_panes(row, col)
  Libxlsxwriter.worksheet_freeze_panes(self, row, col)
end

#freeze_panes_opt(first_row, first_col, top_row, left_col, type) ⇒ nil

Parameters:

  • first_row (Integer)
  • first_col (Integer)
  • top_row (Integer)
  • left_col (Integer)
  • type (Integer)

Returns:

  • (nil)


6348
6349
6350
# File 'lib/fast_excel/binding.rb', line 6348

def freeze_panes_opt(first_row, first_col, top_row, left_col, type)
  Libxlsxwriter.worksheet_freeze_panes_opt(self, first_row, first_col, top_row, left_col, type)
end

#gridlines(option) ⇒ nil

Parameters:

  • option (Integer)

Returns:

  • (nil)


6451
6452
6453
# File 'lib/fast_excel/binding.rb', line 6451

def gridlines(option)
  Libxlsxwriter.worksheet_gridlines(self, option)
end

#hidenil

Returns:

  • (nil)


6319
6320
6321
# File 'lib/fast_excel/binding.rb', line 6319

def hide()
  Libxlsxwriter.worksheet_hide(self)
end

#hide_zeronil

Returns:

  • (nil)


6518
6519
6520
# File 'lib/fast_excel/binding.rb', line 6518

def hide_zero()
  Libxlsxwriter.worksheet_hide_zero(self)
end

#insert_chart(row, col, chart) ⇒ Symbol from _enum_error_

Parameters:

  • row (Integer)
  • col (Integer)
  • chart (Chart)

Returns:



6275
6276
6277
# File 'lib/fast_excel/binding.rb', line 6275

def insert_chart(row, col, chart)
  Libxlsxwriter.worksheet_insert_chart(self, row, col, chart)
end

#insert_chart_opt(row, col, chart, user_options) ⇒ Symbol from _enum_error_

Parameters:

Returns:



6284
6285
6286
# File 'lib/fast_excel/binding.rb', line 6284

def insert_chart_opt(row, col, chart, user_options)
  Libxlsxwriter.worksheet_insert_chart_opt(self, row, col, chart, user_options)
end

#insert_image(row, col, filename) ⇒ Symbol from _enum_error_

Parameters:

  • row (Integer)
  • col (Integer)
  • filename (String)

Returns:



6258
6259
6260
# File 'lib/fast_excel/binding.rb', line 6258

def insert_image(row, col, filename)
  Libxlsxwriter.worksheet_insert_image(self, row, col, filename)
end

#insert_image_opt(row, col, filename, options) ⇒ Symbol from _enum_error_

Parameters:

  • row (Integer)
  • col (Integer)
  • filename (String)
  • options (ImageOptions)

Returns:



6267
6268
6269
# File 'lib/fast_excel/binding.rb', line 6267

def insert_image_opt(row, col, filename, options)
  Libxlsxwriter.worksheet_insert_image_opt(self, row, col, filename, options)
end

#merge_range(first_row, first_col, last_row, last_col, string, format) ⇒ Symbol from _enum_error_

Parameters:

  • first_row (Integer)
  • first_col (Integer)
  • last_row (Integer)
  • last_col (Integer)
  • string (String)
  • format (Format)

Returns:



6295
6296
6297
# File 'lib/fast_excel/binding.rb', line 6295

def merge_range(first_row, first_col, last_row, last_col, string, format)
  Libxlsxwriter.worksheet_merge_range(self, first_row, first_col, last_row, last_col, string, format)
end

#prepare_chart(chart_ref_id, drawing_id, image_data) ⇒ nil

Parameters:

  • chart_ref_id (Integer)
  • drawing_id (Integer)
  • image_data (ImageOptions)

Returns:

  • (nil)


6569
6570
6571
# File 'lib/fast_excel/binding.rb', line 6569

def prepare_chart(chart_ref_id, drawing_id, image_data)
  Libxlsxwriter.worksheet_prepare_chart(self, chart_ref_id, drawing_id, image_data)
end

#prepare_image(image_ref_id, drawing_id, image_data) ⇒ nil

Parameters:

  • image_ref_id (Integer)
  • drawing_id (Integer)
  • image_data (ImageOptions)

Returns:

  • (nil)


6561
6562
6563
# File 'lib/fast_excel/binding.rb', line 6561

def prepare_image(image_ref_id, drawing_id, image_data)
  Libxlsxwriter.worksheet_prepare_image(self, image_ref_id, drawing_id, image_data)
end

Returns:

  • (nil)


6439
6440
6441
# File 'lib/fast_excel/binding.rb', line 6439

def print_across()
  Libxlsxwriter.worksheet_print_across(self)
end

Parameters:

  • first_row (Integer)
  • first_col (Integer)
  • last_row (Integer)
  • last_col (Integer)

Returns:



6489
6490
6491
# File 'lib/fast_excel/binding.rb', line 6489

def print_area(first_row, first_col, last_row, last_col)
  Libxlsxwriter.worksheet_print_area(self, first_row, first_col, last_row, last_col)
end

Returns:

  • (nil)


6466
6467
6468
# File 'lib/fast_excel/binding.rb', line 6466

def print_row_col_headers()
  Libxlsxwriter.worksheet_print_row_col_headers(self)
end

#protect(password, options) ⇒ nil

Parameters:

Returns:

  • (nil)


6531
6532
6533
# File 'lib/fast_excel/binding.rb', line 6531

def protect(password, options)
  Libxlsxwriter.worksheet_protect(self, password, options)
end

#repeat_columns(first_col, last_col) ⇒ Symbol from _enum_error_

Parameters:

  • first_col (Integer)
  • last_col (Integer)

Returns:



6480
6481
6482
# File 'lib/fast_excel/binding.rb', line 6480

def repeat_columns(first_col, last_col)
  Libxlsxwriter.worksheet_repeat_columns(self, first_col, last_col)
end

#repeat_rows(first_row, last_row) ⇒ Symbol from _enum_error_

Parameters:

  • first_row (Integer)
  • last_row (Integer)

Returns:



6473
6474
6475
# File 'lib/fast_excel/binding.rb', line 6473

def repeat_rows(first_row, last_row)
  Libxlsxwriter.worksheet_repeat_rows(self, first_row, last_row)
end

#right_to_leftnil

Returns:

  • (nil)


6513
6514
6515
# File 'lib/fast_excel/binding.rb', line 6513

def right_to_left()
  Libxlsxwriter.worksheet_right_to_left(self)
end

#selectnil

Returns:

  • (nil)


6314
6315
6316
# File 'lib/fast_excel/binding.rb', line 6314

def select()
  Libxlsxwriter.worksheet_select(self)
end

#set_column(first_col, last_col, width, format) ⇒ Symbol from _enum_error_

Parameters:

  • first_col (Integer)
  • last_col (Integer)
  • width (Float)
  • format (Format)

Returns:



6240
6241
6242
# File 'lib/fast_excel/binding.rb', line 6240

def set_column(first_col, last_col, width, format)
  Libxlsxwriter.worksheet_set_column(self, first_col, last_col, width, format)
end

#set_column_opt(first_col, last_col, width, format, options) ⇒ Symbol from _enum_error_

Parameters:

Returns:



6250
6251
6252
# File 'lib/fast_excel/binding.rb', line 6250

def set_column_opt(first_col, last_col, width, format, options)
  Libxlsxwriter.worksheet_set_column_opt(self, first_col, last_col, width, format, options)
end

#set_default_row(height, hide_unused_rows) ⇒ nil

Parameters:

  • height (Float)
  • hide_unused_rows (Integer)

Returns:

  • (nil)


6538
6539
6540
# File 'lib/fast_excel/binding.rb', line 6538

def set_default_row(height, hide_unused_rows)
  Libxlsxwriter.worksheet_set_default_row(self, height, hide_unused_rows)
end

#set_first_sheetnil

Returns:

  • (nil)


6324
6325
6326
# File 'lib/fast_excel/binding.rb', line 6324

def set_first_sheet()
  Libxlsxwriter.worksheet_set_first_sheet(self)
end

Parameters:

  • string (String)

Returns:



6408
6409
6410
# File 'lib/fast_excel/binding.rb', line 6408

def set_footer(string)
  Libxlsxwriter.worksheet_set_footer(self, string)
end

Parameters:

Returns:



6422
6423
6424
# File 'lib/fast_excel/binding.rb', line 6422

def set_footer_opt(string, options)
  Libxlsxwriter.worksheet_set_footer_opt(self, string, options)
end

#set_h_pagebreaks(breaks) ⇒ Symbol from _enum_error_

Parameters:

  • breaks (FFI::Pointer(*U_int))

Returns:



6428
6429
6430
# File 'lib/fast_excel/binding.rb', line 6428

def set_h_pagebreaks(breaks)
  Libxlsxwriter.worksheet_set_h_pagebreaks(self, breaks)
end

#set_header(string) ⇒ Symbol from _enum_error_

Parameters:

  • string (String)

Returns:



6402
6403
6404
# File 'lib/fast_excel/binding.rb', line 6402

def set_header(string)
  Libxlsxwriter.worksheet_set_header(self, string)
end

#set_header_opt(string, options) ⇒ Symbol from _enum_error_

Parameters:

Returns:



6415
6416
6417
# File 'lib/fast_excel/binding.rb', line 6415

def set_header_opt(string, options)
  Libxlsxwriter.worksheet_set_header_opt(self, string, options)
end

#set_landscapenil

Returns:

  • (nil)


6371
6372
6373
# File 'lib/fast_excel/binding.rb', line 6371

def set_landscape()
  Libxlsxwriter.worksheet_set_landscape(self)
end

#set_margins(left, right, top, bottom) ⇒ nil

Parameters:

  • left (Float)
  • right (Float)
  • top (Float)
  • bottom (Float)

Returns:

  • (nil)


6396
6397
6398
# File 'lib/fast_excel/binding.rb', line 6396

def set_margins(left, right, top, bottom)
  Libxlsxwriter.worksheet_set_margins(self, left, right, top, bottom)
end

#set_page_viewnil

Returns:

  • (nil)


6381
6382
6383
# File 'lib/fast_excel/binding.rb', line 6381

def set_page_view()
  Libxlsxwriter.worksheet_set_page_view(self)
end

#set_paper(paper_type) ⇒ nil

Parameters:

  • paper_type (Integer)

Returns:

  • (nil)


6387
6388
6389
# File 'lib/fast_excel/binding.rb', line 6387

def set_paper(paper_type)
  Libxlsxwriter.worksheet_set_paper(self, paper_type)
end

#set_portraitnil

Returns:

  • (nil)


6376
6377
6378
# File 'lib/fast_excel/binding.rb', line 6376

def set_portrait()
  Libxlsxwriter.worksheet_set_portrait(self)
end

#set_print_scale(scale) ⇒ nil

Parameters:

  • scale (Integer)

Returns:

  • (nil)


6508
6509
6510
# File 'lib/fast_excel/binding.rb', line 6508

def set_print_scale(scale)
  Libxlsxwriter.worksheet_set_print_scale(self, scale)
end

#set_row(row, height, format) ⇒ Symbol from _enum_error_

Parameters:

  • row (Integer)
  • height (Float)
  • format (Format)

Returns:



6222
6223
6224
# File 'lib/fast_excel/binding.rb', line 6222

def set_row(row, height, format)
  Libxlsxwriter.worksheet_set_row(self, row, height, format)
end

#set_row_opt(row, height, format, options) ⇒ Symbol from _enum_error_

Parameters:

Returns:



6231
6232
6233
# File 'lib/fast_excel/binding.rb', line 6231

def set_row_opt(row, height, format, options)
  Libxlsxwriter.worksheet_set_row_opt(self, row, height, format, options)
end

#set_selection(first_row, first_col, last_row, last_col) ⇒ nil

Parameters:

  • first_row (Integer)
  • first_col (Integer)
  • last_row (Integer)
  • last_col (Integer)

Returns:

  • (nil)


6366
6367
6368
# File 'lib/fast_excel/binding.rb', line 6366

def set_selection(first_row, first_col, last_row, last_col)
  Libxlsxwriter.worksheet_set_selection(self, first_row, first_col, last_row, last_col)
end

#set_start_page(start_page) ⇒ nil

Parameters:

  • start_page (Integer)

Returns:

  • (nil)


6502
6503
6504
# File 'lib/fast_excel/binding.rb', line 6502

def set_start_page(start_page)
  Libxlsxwriter.worksheet_set_start_page(self, start_page)
end

#set_tab_color(color) ⇒ nil

Parameters:

  • color (Integer)

Returns:

  • (nil)


6524
6525
6526
# File 'lib/fast_excel/binding.rb', line 6524

def set_tab_color(color)
  Libxlsxwriter.worksheet_set_tab_color(self, color)
end

#set_v_pagebreaks(breaks) ⇒ Symbol from _enum_error_

Parameters:

  • breaks (FFI::Pointer(*U_short))

Returns:



6434
6435
6436
# File 'lib/fast_excel/binding.rb', line 6434

def set_v_pagebreaks(breaks)
  Libxlsxwriter.worksheet_set_v_pagebreaks(self, breaks)
end

#set_zoom(scale) ⇒ nil

Parameters:

  • scale (Integer)

Returns:

  • (nil)


6445
6446
6447
# File 'lib/fast_excel/binding.rb', line 6445

def set_zoom(scale)
  Libxlsxwriter.worksheet_set_zoom(self, scale)
end

#split_panes(vertical, horizontal) ⇒ nil

Parameters:

  • vertical (Float)
  • horizontal (Float)

Returns:

  • (nil)


6338
6339
6340
# File 'lib/fast_excel/binding.rb', line 6338

def split_panes(vertical, horizontal)
  Libxlsxwriter.worksheet_split_panes(self, vertical, horizontal)
end

#split_panes_opt(vertical, horizontal, top_row, left_col) ⇒ nil

Parameters:

  • vertical (Float)
  • horizontal (Float)
  • top_row (Integer)
  • left_col (Integer)

Returns:

  • (nil)


6357
6358
6359
# File 'lib/fast_excel/binding.rb', line 6357

def split_panes_opt(vertical, horizontal, top_row, left_col)
  Libxlsxwriter.worksheet_split_panes_opt(self, vertical, horizontal, top_row, left_col)
end

#write_array_formula(first_row, first_col, last_row, last_col, formula, format) ⇒ Symbol from _enum_error_

Parameters:

  • first_row (Integer)
  • first_col (Integer)
  • last_row (Integer)
  • last_col (Integer)
  • formula (String)
  • format (Format)

Returns:



6146
6147
6148
# File 'lib/fast_excel/binding.rb', line 6146

def write_array_formula(first_row, first_col, last_row, last_col, formula, format)
  Libxlsxwriter.worksheet_write_array_formula(self, first_row, first_col, last_row, last_col, formula, format)
end

#write_array_formula_num(first_row, first_col, last_row, last_col, formula, format, result) ⇒ Symbol from _enum_error_

Parameters:

  • first_row (Integer)
  • first_col (Integer)
  • last_row (Integer)
  • last_col (Integer)
  • formula (String)
  • format (Format)
  • result (Float)

Returns:



6158
6159
6160
# File 'lib/fast_excel/binding.rb', line 6158

def write_array_formula_num(first_row, first_col, last_row, last_col, formula, format, result)
  Libxlsxwriter.worksheet_write_array_formula_num(self, first_row, first_col, last_row, last_col, formula, format, result)
end

#write_blank(row, col, format) ⇒ Symbol from _enum_error_

Parameters:

  • row (Integer)
  • col (Integer)
  • format (Format)

Returns:



6204
6205
6206
# File 'lib/fast_excel/binding.rb', line 6204

def write_blank(row, col, format)
  Libxlsxwriter.worksheet_write_blank(self, row, col, format)
end

#write_boolean(row, col, value, format) ⇒ Symbol from _enum_error_

Parameters:

  • row (Integer)
  • col (Integer)
  • value (Integer)
  • format (Format)

Returns:



6196
6197
6198
# File 'lib/fast_excel/binding.rb', line 6196

def write_boolean(row, col, value, format)
  Libxlsxwriter.worksheet_write_boolean(self, row, col, value, format)
end

#write_datetime(row, col, datetime, format) ⇒ Symbol from _enum_error_

Parameters:

Returns:



6167
6168
6169
# File 'lib/fast_excel/binding.rb', line 6167

def write_datetime(row, col, datetime, format)
  Libxlsxwriter.worksheet_write_datetime(self, row, col, datetime, format)
end

#write_formula(row, col, formula, format) ⇒ Symbol from _enum_error_

Parameters:

  • row (Integer)
  • col (Integer)
  • formula (String)
  • format (Format)

Returns:



6135
6136
6137
# File 'lib/fast_excel/binding.rb', line 6135

def write_formula(row, col, formula, format)
  Libxlsxwriter.worksheet_write_formula(self, row, col, formula, format)
end

#write_formula_num(row, col, formula, format, result) ⇒ Symbol from _enum_error_

Parameters:

  • row (Integer)
  • col (Integer)
  • formula (String)
  • format (Format)
  • result (Float)

Returns:



6214
6215
6216
# File 'lib/fast_excel/binding.rb', line 6214

def write_formula_num(row, col, formula, format, result)
  Libxlsxwriter.worksheet_write_formula_num(self, row, col, formula, format, result)
end

#write_number(row, col, number, format) ⇒ Symbol from _enum_error_

Parameters:

  • row (Integer)
  • col (Integer)
  • number (Float)
  • format (Format)

Returns:



6117
6118
6119
# File 'lib/fast_excel/binding.rb', line 6117

def write_number(row, col, number, format)
  Libxlsxwriter.worksheet_write_number(self, row, col, number, format)
end

#write_single_rownil

Returns:

  • (nil)


6553
6554
6555
# File 'lib/fast_excel/binding.rb', line 6553

def write_single_row()
  Libxlsxwriter.worksheet_write_single_row(self)
end

#write_string(row, col, string, format) ⇒ Symbol from _enum_error_

Parameters:

  • row (Integer)
  • col (Integer)
  • string (String)
  • format (Format)

Returns:



6126
6127
6128
# File 'lib/fast_excel/binding.rb', line 6126

def write_string(row, col, string, format)
  Libxlsxwriter.worksheet_write_string(self, row, col, string, format)
end

#write_url(row, col, url, format) ⇒ Symbol from _enum_error_

Parameters:

  • row (Integer)
  • col (Integer)
  • url (String)
  • format (Format)

Returns:



6187
6188
6189
# File 'lib/fast_excel/binding.rb', line 6187

def write_url(row, col, url, format)
  Libxlsxwriter.worksheet_write_url(self, row, col, url, format)
end

#write_url_opt(row_num, col_num, url, format, string, tooltip) ⇒ Symbol from _enum_error_

Parameters:

  • row_num (Integer)
  • col_num (Integer)
  • url (String)
  • format (Format)
  • string (String)
  • tooltip (String)

Returns:



6178
6179
6180
# File 'lib/fast_excel/binding.rb', line 6178

def write_url_opt(row_num, col_num, url, format, string, tooltip)
  Libxlsxwriter.worksheet_write_url_opt(self, row_num, col_num, url, format, string, tooltip)
end