Module: Libxlsxwriter::ChartWrappers

Included in:
Chart
Defined in:
lib/fast_excel/binding/chart.rb

Overview

Fields:

:file

(FFI::Pointer(*FILE))

:type

(Integer)

:subtype

(Integer)

:series_index

(Integer)

:write_chart_type

(FFI::Pointer(*))

:write_plot_area

(FFI::Pointer(*))

:x_axis

(ChartAxis) A pointer to the chart x_axis object which can be used in functions that configures the X axis.

:y_axis

(ChartAxis) A pointer to the chart y_axis object which can be used in functions that configures the Y axis.

:title

(ChartTitle)

:id

(Integer)

:axis_id_1

(Integer)

:axis_id_2

(Integer)

:axis_id_3

(Integer)

:axis_id_4

(Integer)

:in_use

(Integer)

:chart_group

(Integer)

:cat_has_num_fmt

(Integer)

:has_horiz_cat_axis

(Integer)

:has_horiz_val_axis

(Integer)

:style_id

(Integer)

:rotation

(Integer)

:hole_size

(Integer)

:no_title

(Integer)

:has_overlap

(Integer)

:overlap_y1

(Integer)

:overlap_y2

(Integer)

:gap_y1

(Integer)

:gap_y2

(Integer)

:grouping

(Integer)

:default_cross_between

(Integer)

:legend

(ChartLegend)

:delete_series

(FFI::Pointer(*Int16T))

:delete_series_count

(Integer)

:default_marker

(ChartMarker)

:chartarea_line

(ChartLine)

:chartarea_fill

(ChartFill)

:chartarea_pattern

(ChartPattern)

:plotarea_line

(ChartLine)

:plotarea_fill

(ChartFill)

:plotarea_pattern

(ChartPattern)

:has_drop_lines

(Integer)

:drop_lines_line

(ChartLine)

:has_high_low_lines

(Integer)

:high_low_lines_line

(ChartLine)

:series_list

(ChartSeriesList)

:has_table

(Integer)

:has_table_vertical

(Integer)

:has_table_horizontal

(Integer)

:has_table_outline

(Integer)

:has_table_legend_keys

(Integer)

:table_font

(ChartFont)

:show_blanks_as

(Integer)

:show_hidden_data

(Integer)

:has_up_down_bars

(Integer)

:up_bar_line

(ChartLine)

:down_bar_line

(ChartLine)

:up_bar_fill

(ChartFill)

:down_bar_fill

(ChartFill)

:default_label_position

(Integer)

:ordered_list_pointers

(ChartOrderedListPointers)

:list_pointers

(ChartListPointers)

Instance Method Summary collapse

Instance Method Details

#add_series(categories, values) ⇒ ChartSeries

Parameters:

  • categories (String)
  • values (String)

Returns:

[View source]

1747
1748
1749
 
# File 'lib/fast_excel/binding/chart.rb', line 1747

def add_series(categories, values)
  ChartSeries.new Libxlsxwriter.chart_add_series(self, categories, values)
end

#assemble_xml_file ⇒ nil

Returns:

  • (nil)
[View source]

1740
1741
1742
 
# File 'lib/fast_excel/binding/chart.rb', line 1740

def assemble_xml_file()
  Libxlsxwriter.chart_assemble_xml_file(self)
end

#chartarea_set_fill(fill) ⇒ nil

Parameters:

Returns:

  • (nil)
[View source]

1802
1803
1804
 
# File 'lib/fast_excel/binding/chart.rb', line 1802

def chartarea_set_fill(fill)
  Libxlsxwriter.chart_chartarea_set_fill(self, fill)
end

#chartarea_set_line(line) ⇒ nil

Parameters:

Returns:

  • (nil)
[View source]

1796
1797
1798
 
# File 'lib/fast_excel/binding/chart.rb', line 1796

def chartarea_set_line(line)
  Libxlsxwriter.chart_chartarea_set_line(self, line)
end

#chartarea_set_pattern(pattern) ⇒ nil

Parameters:

Returns:

  • (nil)
[View source]

1808
1809
1810
 
# File 'lib/fast_excel/binding/chart.rb', line 1808

def chartarea_set_pattern(pattern)
  Libxlsxwriter.chart_chartarea_set_pattern(self, pattern)
end

#free ⇒ nil

Returns:

  • (nil)
[View source]

1735
1736
1737
 
# File 'lib/fast_excel/binding/chart.rb', line 1735

def free()
  Libxlsxwriter.chart_free(self)
end

#legend_delete_series(delete_series) ⇒ Symbol from _enum_error_

Parameters:

  • delete_series (FFI::Pointer(*Short))

Returns:

[View source]

1790
1791
1792
 
# File 'lib/fast_excel/binding/chart.rb', line 1790

def legend_delete_series(delete_series)
  Libxlsxwriter.chart_legend_delete_series(self, delete_series)
end

#legend_set_font(font) ⇒ nil

Parameters:

Returns:

  • (nil)
[View source]

1784
1785
1786
 
# File 'lib/fast_excel/binding/chart.rb', line 1784

def legend_set_font(font)
  Libxlsxwriter.chart_legend_set_font(self, font)
end

#legend_set_position(position) ⇒ nil

Parameters:

  • position (Integer)

Returns:

  • (nil)
[View source]

1778
1779
1780
 
# File 'lib/fast_excel/binding/chart.rb', line 1778

def legend_set_position(position)
  Libxlsxwriter.chart_legend_set_position(self, position)
end

#plotarea_set_fill(fill) ⇒ nil

Parameters:

Returns:

  • (nil)
[View source]

1820
1821
1822
 
# File 'lib/fast_excel/binding/chart.rb', line 1820

def plotarea_set_fill(fill)
  Libxlsxwriter.chart_plotarea_set_fill(self, fill)
end

#plotarea_set_line(line) ⇒ nil

Parameters:

Returns:

  • (nil)
[View source]

1814
1815
1816
 
# File 'lib/fast_excel/binding/chart.rb', line 1814

def plotarea_set_line(line)
  Libxlsxwriter.chart_plotarea_set_line(self, line)
end

#plotarea_set_pattern(pattern) ⇒ nil

Parameters:

Returns:

  • (nil)
[View source]

1826
1827
1828
 
# File 'lib/fast_excel/binding/chart.rb', line 1826

def plotarea_set_pattern(pattern)
  Libxlsxwriter.chart_plotarea_set_pattern(self, pattern)
end

#set_drop_lines(line) ⇒ nil

Parameters:

Returns:

  • (nil)
[View source]

1872
1873
1874
 
# File 'lib/fast_excel/binding/chart.rb', line 1872

def set_drop_lines(line)
  Libxlsxwriter.chart_set_drop_lines(self, line)
end

#set_high_low_lines(line) ⇒ nil

Parameters:

Returns:

  • (nil)
[View source]

1878
1879
1880
 
# File 'lib/fast_excel/binding/chart.rb', line 1878

def set_high_low_lines(line)
  Libxlsxwriter.chart_set_high_low_lines(self, line)
end

#set_hole_size(size) ⇒ nil

Parameters:

  • size (Integer)

Returns:

  • (nil)
[View source]

1913
1914
1915
 
# File 'lib/fast_excel/binding/chart.rb', line 1913

def set_hole_size(size)
  Libxlsxwriter.chart_set_hole_size(self, size)
end

#set_rotation(rotation) ⇒ nil

Parameters:

  • rotation (Integer)

Returns:

  • (nil)
[View source]

1907
1908
1909
 
# File 'lib/fast_excel/binding/chart.rb', line 1907

def set_rotation(rotation)
  Libxlsxwriter.chart_set_rotation(self, rotation)
end

#set_series_gap(gap) ⇒ nil

Parameters:

  • gap (Integer)

Returns:

  • (nil)
[View source]

1890
1891
1892
 
# File 'lib/fast_excel/binding/chart.rb', line 1890

def set_series_gap(gap)
  Libxlsxwriter.chart_set_series_gap(self, gap)
end

#set_series_overlap(overlap) ⇒ nil

Parameters:

  • overlap (Integer)

Returns:

  • (nil)
[View source]

1884
1885
1886
 
# File 'lib/fast_excel/binding/chart.rb', line 1884

def set_series_overlap(overlap)
  Libxlsxwriter.chart_set_series_overlap(self, overlap)
end

#set_style(style_id) ⇒ nil

Parameters:

  • style_id (Integer)

Returns:

  • (nil)
[View source]

1832
1833
1834
 
# File 'lib/fast_excel/binding/chart.rb', line 1832

def set_style(style_id)
  Libxlsxwriter.chart_set_style(self, style_id)
end

#set_table ⇒ nil

Returns:

  • (nil)
[View source]

1837
1838
1839
 
# File 'lib/fast_excel/binding/chart.rb', line 1837

def set_table()
  Libxlsxwriter.chart_set_table(self)
end

#set_table_font(font) ⇒ nil

Parameters:

Returns:

  • (nil)
[View source]

1852
1853
1854
 
# File 'lib/fast_excel/binding/chart.rb', line 1852

def set_table_font(font)
  Libxlsxwriter.chart_set_table_font(self, font)
end

#set_table_grid(horizontal, vertical, outline, legend_keys) ⇒ nil

Parameters:

  • horizontal (Integer)
  • vertical (Integer)
  • outline (Integer)
  • legend_keys (Integer)

Returns:

  • (nil)
[View source]

1846
1847
1848
 
# File 'lib/fast_excel/binding/chart.rb', line 1846

def set_table_grid(horizontal, vertical, outline, legend_keys)
  Libxlsxwriter.chart_set_table_grid(self, horizontal, vertical, outline, legend_keys)
end

#set_up_down_bars ⇒ nil

Returns:

  • (nil)
[View source]

1857
1858
1859
 
# File 'lib/fast_excel/binding/chart.rb', line 1857

def set_up_down_bars()
  Libxlsxwriter.chart_set_up_down_bars(self)
end

#set_up_down_bars_format(up_bar_line, up_bar_fill, down_bar_line, down_bar_fill) ⇒ nil

Parameters:

Returns:

  • (nil)
[View source]

1866
1867
1868
 
# File 'lib/fast_excel/binding/chart.rb', line 1866

def set_up_down_bars_format(up_bar_line, up_bar_fill, down_bar_line, down_bar_fill)
  Libxlsxwriter.chart_set_up_down_bars_format(self, up_bar_line, up_bar_fill, down_bar_line, down_bar_fill)
end

#show_blanks_as(option) ⇒ nil

Parameters:

  • option (Integer)

Returns:

  • (nil)
[View source]

1896
1897
1898
 
# File 'lib/fast_excel/binding/chart.rb', line 1896

def show_blanks_as(option)
  Libxlsxwriter.chart_show_blanks_as(self, option)
end

#show_hidden_data ⇒ nil

Returns:

  • (nil)
[View source]

1901
1902
1903
 
# File 'lib/fast_excel/binding/chart.rb', line 1901

def show_hidden_data()
  Libxlsxwriter.chart_show_hidden_data(self)
end

#title_off ⇒ nil

Returns:

  • (nil)
[View source]

1772
1773
1774
 
# File 'lib/fast_excel/binding/chart.rb', line 1772

def title_off()
  Libxlsxwriter.chart_title_off(self)
end

#title_set_name(name) ⇒ nil

Parameters:

  • name (String)

Returns:

  • (nil)
[View source]

1753
1754
1755
 
# File 'lib/fast_excel/binding/chart.rb', line 1753

def title_set_name(name)
  Libxlsxwriter.chart_title_set_name(self, name)
end

#title_set_name_font(font) ⇒ nil

Parameters:

Returns:

  • (nil)
[View source]

1767
1768
1769
 
# File 'lib/fast_excel/binding/chart.rb', line 1767

def title_set_name_font(font)
  Libxlsxwriter.chart_title_set_name_font(self, font)
end

#title_set_name_range(sheetname, row, col) ⇒ nil

Parameters:

  • sheetname (String)
  • row (Integer)
  • col (Integer)

Returns:

  • (nil)
[View source]

1761
1762
1763
 
# File 'lib/fast_excel/binding/chart.rb', line 1761

def title_set_name_range(sheetname, row, col)
  Libxlsxwriter.chart_title_set_name_range(self, sheetname, row, col)
end