xlsxrb 0.1.5 → 0.1.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.gem_rbs_collection/nokogiri/1.11/.rbs_meta.yaml +9 -0
- data/.gem_rbs_collection/nokogiri/1.11/nokogiri.rbs +2332 -0
- data/.gem_rbs_collection/nokogiri/1.11/patch.rbs +4 -0
- data/.gem_rbs_collection/rubyzip/3.2/.rbs_meta.yaml +9 -0
- data/.gem_rbs_collection/rubyzip/3.2/manifest.yaml +8 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/central_directory.rbs +42 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/compressor.rbs +5 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/constants.rbs +47 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/crypto/aes_encryption.rbs +30 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/crypto/decrypted_io.rbs +9 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/crypto/encryption.rbs +7 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/crypto/null_encryption.rbs +19 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/crypto/traditional_encryption.rbs +31 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/decompressor.rbs +18 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/deflater.rbs +12 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/dirtyable.rbs +11 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/dos_time.rbs +13 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/entry.rbs +95 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/entry_set.rbs +31 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/errors.rbs +58 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/extra_field/aes.rbs +24 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/extra_field/generic.rbs +17 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/extra_field/ntfs.rbs +23 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/extra_field/old_unix.rbs +22 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/extra_field/universal_time.rbs +30 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/extra_field/unix.rbs +20 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/extra_field/unknown.rbs +15 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/extra_field/zip64.rbs +26 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/extra_field.rbs +21 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/file.rbs +131 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/file_split.rbs +14 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/filesystem/dir.rbs +33 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/filesystem/directory_iterator.rbs +21 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/filesystem/file.rbs +63 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/filesystem/file_stat.rbs +55 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/filesystem/zip_file_name_mapper.rbs +35 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/filesystem.rbs +7 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/inflater.rbs +10 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/input_stream.rbs +22 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/ioextras/abstract_input_stream.rbs +29 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/ioextras/abstract_output_stream.rbs +17 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/ioextras.rbs +13 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/null_compressor.rbs +10 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/null_decompressor.rbs +8 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/null_input_stream.rbs +6 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/output_stream.rbs +30 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/pass_thru_compressor.rbs +10 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/pass_thru_decompressor.rbs +10 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/streamable_directory.rbs +5 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/streamable_stream.rbs +15 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip/version.rbs +3 -0
- data/.gem_rbs_collection/rubyzip/3.2/zip.rbs +40 -0
- data/CHANGELOG.md +28 -0
- data/README.md +66 -44
- data/Rakefile +2 -1
- data/Steepfile +1 -2
- data/benchmark.rb +376 -0
- data/docs/ARCHITECTURE.md +12 -5
- data/docs/visual/VisualGallery.md +8 -0
- data/docs/wasm/ruby.wasm +0 -0
- data/lib/ruby_lsp/xlsxrb/addon.rb +43 -0
- data/lib/ruby_lsp/xlsxrb/completion_listener.rb +769 -0
- data/lib/xlsxrb/elements/cell.rb +137 -11
- data/lib/xlsxrb/elements/column.rb +22 -0
- data/lib/xlsxrb/elements/row.rb +98 -5
- data/lib/xlsxrb/elements/types.rb +40 -5
- data/lib/xlsxrb/elements/workbook.rb +73 -5
- data/lib/xlsxrb/elements/worksheet.rb +110 -1
- data/lib/xlsxrb/ooxml/shared_strings_parser.rb +104 -40
- data/lib/xlsxrb/ooxml/worksheet_parser.rb +144 -23
- data/lib/xlsxrb/ooxml/worksheet_writer.rb +160 -145
- data/lib/xlsxrb/ooxml/xml_builder.rb +16 -10
- data/lib/xlsxrb/ooxml/zip_reader.rb +104 -18
- data/lib/xlsxrb/ooxml/zip_writer.rb +63 -25
- data/lib/xlsxrb/style_builder.rb +158 -30
- data/lib/xlsxrb/version.rb +1 -1
- data/lib/xlsxrb.rb +892 -336
- data/rbs_collection.lock.yaml +28 -0
- data/sig/generated/xlsxrb/elements/cell.rbs +39 -0
- data/sig/generated/xlsxrb/elements/column.rbs +35 -0
- data/sig/generated/xlsxrb/elements/row.rbs +39 -0
- data/sig/generated/xlsxrb/elements/types.rbs +82 -0
- data/sig/generated/xlsxrb/elements/workbook.rbs +32 -0
- data/sig/generated/xlsxrb/elements/worksheet.rbs +34 -0
- data/sig/generated/xlsxrb/ooxml/reader.rbs +1412 -0
- data/sig/generated/xlsxrb/ooxml/shared_strings_parser.rbs +21 -0
- data/sig/generated/xlsxrb/ooxml/styles_parser.rbs +44 -0
- data/sig/generated/xlsxrb/ooxml/utils.rbs +40 -0
- data/sig/generated/xlsxrb/ooxml/workbook_parser.rbs +46 -0
- data/sig/generated/xlsxrb/ooxml/workbook_writer.rbs +66 -0
- data/sig/generated/xlsxrb/ooxml/worksheet_parser.rbs +67 -0
- data/sig/generated/xlsxrb/ooxml/worksheet_writer.rbs +92 -0
- data/sig/generated/xlsxrb/ooxml/writer.rbs +880 -0
- data/sig/generated/xlsxrb/ooxml/xml_builder.rbs +45 -0
- data/sig/generated/xlsxrb/ooxml/xml_parser.rbs +30 -0
- data/sig/generated/xlsxrb/ooxml/zip_generator.rbs +38 -0
- data/sig/generated/xlsxrb/ooxml/zip_reader.rbs +45 -0
- data/sig/generated/xlsxrb/ooxml/zip_writer.rbs +45 -0
- data/sig/generated/xlsxrb/style_builder.rbs +212 -50
- data/sig/generated/xlsxrb.rbs +1646 -0
- data/sig/rexml.rbs +4 -0
- metadata +78 -1
|
@@ -0,0 +1,880 @@
|
|
|
1
|
+
# Generated from lib/xlsxrb/ooxml/writer.rb with RBS::Inline
|
|
2
|
+
|
|
3
|
+
module Xlsxrb
|
|
4
|
+
module Ooxml
|
|
5
|
+
# Writes spreadsheet data into an XLSX file.
|
|
6
|
+
class Writer
|
|
7
|
+
XML_HEADER: ::String
|
|
8
|
+
|
|
9
|
+
CT_NS: ::String
|
|
10
|
+
|
|
11
|
+
REL_NS: ::String
|
|
12
|
+
|
|
13
|
+
SSML_NS: ::String
|
|
14
|
+
|
|
15
|
+
DOC_REL_NS: ::String
|
|
16
|
+
|
|
17
|
+
CP_NS: ::String
|
|
18
|
+
|
|
19
|
+
DC_NS: ::String
|
|
20
|
+
|
|
21
|
+
DCTERMS_NS: ::String
|
|
22
|
+
|
|
23
|
+
XSI_NS: ::String
|
|
24
|
+
|
|
25
|
+
APP_NS: ::String
|
|
26
|
+
|
|
27
|
+
VT_NS: ::String
|
|
28
|
+
|
|
29
|
+
CELL_ADDRESS_PATTERN: ::Regexp
|
|
30
|
+
|
|
31
|
+
MAX_ROW: ::Integer
|
|
32
|
+
|
|
33
|
+
MAX_COLUMN_INDEX: ::Integer
|
|
34
|
+
|
|
35
|
+
attr_reader fonts: untyped
|
|
36
|
+
|
|
37
|
+
attr_reader fills: untyped
|
|
38
|
+
|
|
39
|
+
attr_reader borders: untyped
|
|
40
|
+
|
|
41
|
+
attr_reader xf_entries: untyped
|
|
42
|
+
|
|
43
|
+
attr_reader num_fmts: untyped
|
|
44
|
+
|
|
45
|
+
# : () -> void
|
|
46
|
+
def initialize: () -> untyped
|
|
47
|
+
|
|
48
|
+
# Adds a new sheet. Raises if name is already taken.
|
|
49
|
+
# : (untyped name) -> untyped
|
|
50
|
+
def add_sheet: (untyped name) -> untyped
|
|
51
|
+
|
|
52
|
+
# Registers a cell value at the given address (e.g. "A1").
|
|
53
|
+
# : (untyped cell_address, untyped value, ?sheet: untyped?) -> untyped
|
|
54
|
+
def set_cell: (untyped cell_address, untyped value, ?sheet: untyped) -> untyped
|
|
55
|
+
|
|
56
|
+
# Returns the registered cells for the first (or given) sheet.
|
|
57
|
+
# : (?sheet: untyped?) -> untyped
|
|
58
|
+
def cells: (?sheet: untyped) -> untyped
|
|
59
|
+
|
|
60
|
+
# Sets the width for a column (e.g. "A", "BC").
|
|
61
|
+
# : (untyped col_letter, untyped width, ?sheet: untyped?) -> untyped
|
|
62
|
+
def set_column_width: (untyped col_letter, untyped width, ?sheet: untyped) -> untyped
|
|
63
|
+
|
|
64
|
+
# Returns column widths for the first (or given) sheet.
|
|
65
|
+
# : (?sheet: untyped?) -> untyped
|
|
66
|
+
def column_widths: (?sheet: untyped) -> untyped
|
|
67
|
+
|
|
68
|
+
# Sets a column attribute (e.g. :hidden, :best_fit, :outline_level, :collapsed, :style).
|
|
69
|
+
# : (untyped col_letter, untyped name, untyped value, ?sheet: untyped?) -> untyped
|
|
70
|
+
def set_column_attribute: (untyped col_letter, untyped name, untyped value, ?sheet: untyped) -> untyped
|
|
71
|
+
|
|
72
|
+
# Returns column attributes for the first (or given) sheet.
|
|
73
|
+
# : (?sheet: untyped?) -> untyped
|
|
74
|
+
def column_attributes: (?sheet: untyped) -> untyped
|
|
75
|
+
|
|
76
|
+
# Sets a row height.
|
|
77
|
+
# : (untyped row_num, untyped height, ?sheet: untyped?) -> untyped
|
|
78
|
+
def set_row_height: (untyped row_num, untyped height, ?sheet: untyped) -> untyped
|
|
79
|
+
|
|
80
|
+
# Hides a row.
|
|
81
|
+
# : (untyped row_num, ?hidden: bool, ?sheet: untyped?) -> untyped
|
|
82
|
+
def set_row_hidden: (untyped row_num, ?hidden: untyped, ?sheet: untyped) -> untyped
|
|
83
|
+
|
|
84
|
+
# Sets a row outline level.
|
|
85
|
+
# : (untyped row_num, untyped level, ?sheet: untyped?) -> untyped
|
|
86
|
+
def set_row_outline_level: (untyped row_num, untyped level, ?sheet: untyped) -> untyped
|
|
87
|
+
|
|
88
|
+
# Sets a row collapsed state.
|
|
89
|
+
# : (untyped row_num, ?collapsed: bool, ?sheet: untyped?) -> untyped
|
|
90
|
+
def set_row_collapsed: (untyped row_num, ?collapsed: untyped, ?sheet: untyped) -> untyped
|
|
91
|
+
|
|
92
|
+
# Sets a row default style index (cellXfs index).
|
|
93
|
+
# : (untyped row_num, untyped style_id, ?sheet: untyped?) -> untyped
|
|
94
|
+
def set_row_style: (untyped row_num, untyped style_id, ?sheet: untyped) -> untyped
|
|
95
|
+
|
|
96
|
+
# Sets a row thick top border flag.
|
|
97
|
+
# : (untyped row_num, ?thick: bool, ?sheet: untyped?) -> untyped
|
|
98
|
+
def set_row_thick_top: (untyped row_num, ?thick: untyped, ?sheet: untyped) -> untyped
|
|
99
|
+
|
|
100
|
+
# Sets a row thick bottom border flag.
|
|
101
|
+
# : (untyped row_num, ?thick: bool, ?sheet: untyped?) -> untyped
|
|
102
|
+
def set_row_thick_bot: (untyped row_num, ?thick: untyped, ?sheet: untyped) -> untyped
|
|
103
|
+
|
|
104
|
+
# Sets a row phonetic flag.
|
|
105
|
+
# : (untyped row_num, ?phonetic: bool, ?sheet: untyped?) -> untyped
|
|
106
|
+
def set_row_phonetic: (untyped row_num, ?phonetic: untyped, ?sheet: untyped) -> untyped
|
|
107
|
+
|
|
108
|
+
# Returns row attributes for the first (or given) sheet.
|
|
109
|
+
# : (?sheet: untyped?) -> untyped
|
|
110
|
+
def row_attributes: (?sheet: untyped) -> untyped
|
|
111
|
+
|
|
112
|
+
# Merges a range of cells (e.g. "A1:B2").
|
|
113
|
+
# : (untyped range, ?sheet: untyped?) -> untyped
|
|
114
|
+
def merge: (untyped range, ?sheet: untyped) -> untyped
|
|
115
|
+
|
|
116
|
+
# Returns merged cell ranges for the first (or given) sheet.
|
|
117
|
+
# : (?sheet: untyped?) -> untyped
|
|
118
|
+
def merged_cells: (?sheet: untyped) -> untyped
|
|
119
|
+
|
|
120
|
+
# Adds a hyperlink on a cell.
|
|
121
|
+
# : (untyped cell_address, ?untyped? url, ?sheet: untyped?, ?display: untyped?, ?tooltip: untyped?, ?location: untyped?) -> untyped
|
|
122
|
+
def hyperlink: (untyped cell_address, ?untyped url, ?sheet: untyped, ?display: untyped, ?tooltip: untyped, ?location: untyped) -> untyped
|
|
123
|
+
|
|
124
|
+
# Returns hyperlinks for the first (or given) sheet.
|
|
125
|
+
# : (?sheet: untyped?) -> untyped
|
|
126
|
+
def hyperlinks: (?sheet: untyped) -> untyped
|
|
127
|
+
|
|
128
|
+
# Sets an autoFilter range (e.g. "A1:B10") for the given sheet.
|
|
129
|
+
# : (untyped range, ?sheet: untyped?) -> untyped
|
|
130
|
+
def set_auto_filter: (untyped range, ?sheet: untyped) -> untyped
|
|
131
|
+
|
|
132
|
+
# Returns the autoFilter range for the first (or given) sheet.
|
|
133
|
+
# : (?sheet: untyped?) -> untyped
|
|
134
|
+
def auto_filter: (?sheet: untyped) -> untyped
|
|
135
|
+
|
|
136
|
+
# Adds a filter column to the autoFilter.
|
|
137
|
+
# col_id: 0-based column index within the autoFilter range.
|
|
138
|
+
# filter: hash describing the filter, e.g.
|
|
139
|
+
# { type: :filters, values: ["A", "B"] }
|
|
140
|
+
# { type: :filters, blank: true }
|
|
141
|
+
# { type: :custom, operator: "greaterThan", val: "100" }
|
|
142
|
+
# { type: :custom, filters: [{ operator: "greaterThan", val: "10" }, { operator: "lessThan", val: "100" }], and: true }
|
|
143
|
+
# { type: :dynamic, dynamic_type: "today" }
|
|
144
|
+
# { type: :top10, top: true, percent: false, val: 10 }
|
|
145
|
+
# : (untyped col_id, untyped filter, ?sheet: untyped?) -> untyped
|
|
146
|
+
def add_filter_column: (untyped col_id, untyped filter, ?sheet: untyped) -> untyped
|
|
147
|
+
|
|
148
|
+
# Returns filter columns for the first (or given) sheet.
|
|
149
|
+
# : (?sheet: untyped?) -> untyped
|
|
150
|
+
def filter_columns: (?sheet: untyped) -> untyped
|
|
151
|
+
|
|
152
|
+
# Sets a sort state for the sheet. ref: sort range, sort_conditions: array of { ref:, descending: }.
|
|
153
|
+
# Options: column_sort:, case_sensitive:, sort_method:
|
|
154
|
+
# : (untyped ref, untyped sort_conditions, ?sheet: untyped?, **untyped opts) -> untyped
|
|
155
|
+
def set_sort_state: (untyped ref, untyped sort_conditions, ?sheet: untyped, **untyped opts) -> untyped
|
|
156
|
+
|
|
157
|
+
# Returns sort state for the first (or given) sheet.
|
|
158
|
+
# : (?sheet: untyped?) -> untyped
|
|
159
|
+
def sort_state: (?sheet: untyped) -> untyped
|
|
160
|
+
|
|
161
|
+
# Registers a custom number format and returns its numFmtId (starting at 164).
|
|
162
|
+
# : (untyped format_code) -> untyped
|
|
163
|
+
def add_number_format: (untyped format_code) -> untyped
|
|
164
|
+
|
|
165
|
+
# Sets a number format on a cell. num_fmt_id is from add_number_format or a built-in id.
|
|
166
|
+
# : (untyped cell_address, untyped num_fmt_id, ?sheet: untyped?) -> untyped
|
|
167
|
+
def set_cell_format: (untyped cell_address, untyped num_fmt_id, ?sheet: untyped) -> untyped
|
|
168
|
+
|
|
169
|
+
# Registers a font and returns its font_id. Opts: bold, italic, sz, color, name.
|
|
170
|
+
# : (**untyped opts) -> untyped
|
|
171
|
+
def add_font: (**untyped opts) -> untyped
|
|
172
|
+
|
|
173
|
+
# Registers a fill and returns its fill_id. Opts: pattern, fg_color, bg_color.
|
|
174
|
+
# : (**untyped opts) -> untyped
|
|
175
|
+
def add_fill: (**untyped opts) -> untyped
|
|
176
|
+
|
|
177
|
+
# Registers a border and returns its border_id.
|
|
178
|
+
# Opts: left, right, top, bottom (each a hash with :style and optional :color).
|
|
179
|
+
# : (**untyped opts) -> untyped
|
|
180
|
+
def add_border: (**untyped opts) -> untyped
|
|
181
|
+
|
|
182
|
+
# Registers a cell style (xf entry) and returns its index for use with set_cell_style.
|
|
183
|
+
# Opts: font_id, fill_id, border_id, num_fmt_id, alignment (hash with horizontal, vertical, wrap_text, text_rotation, indent, shrink_to_fit).
|
|
184
|
+
# : (**untyped opts) -> untyped
|
|
185
|
+
def add_cell_style: (**untyped opts) -> untyped
|
|
186
|
+
|
|
187
|
+
# Registers a base style definition (cellStyleXf) and a named cellStyle.
|
|
188
|
+
# Returns the xfId for the new base style.
|
|
189
|
+
# : (name: untyped, ?num_fmt_id: ::Integer, ?font_id: ::Integer, ?fill_id: ::Integer, ?border_id: ::Integer, ?builtin_id: untyped?, ?i_level: untyped?, ?hidden: untyped?, ?custom_builtin: untyped?) -> untyped
|
|
190
|
+
def add_named_cell_style: (name: untyped, ?num_fmt_id: untyped, ?font_id: untyped, ?fill_id: untyped, ?border_id: untyped, ?builtin_id: untyped, ?i_level: untyped, ?hidden: untyped, ?custom_builtin: untyped) -> untyped
|
|
191
|
+
|
|
192
|
+
# Sets a cell style by xf index (from add_cell_style).
|
|
193
|
+
# : (untyped cell_address, untyped style_id, ?sheet: untyped?) -> untyped
|
|
194
|
+
def set_cell_style: (untyped cell_address, untyped style_id, ?sheet: untyped) -> untyped
|
|
195
|
+
|
|
196
|
+
# Marks a cell as containing phonetic text (ph="1" on the <c> element).
|
|
197
|
+
# : (untyped cell_address, ?sheet: untyped?) -> untyped
|
|
198
|
+
def set_cell_phonetic: (untyped cell_address, ?sheet: untyped) -> untyped
|
|
199
|
+
|
|
200
|
+
# Registers a differential format (dxf) for conditional formatting. Returns dxf_id.
|
|
201
|
+
# Opts: font (hash), fill (hash), border (hash), num_fmt (hash).
|
|
202
|
+
# : (**untyped opts) -> untyped
|
|
203
|
+
def add_dxf: (**untyped opts) -> untyped
|
|
204
|
+
|
|
205
|
+
# Sets the indexed colors palette (array of ARGB hex strings, e.g. ["FF000000", "FFFFFFFF"]).
|
|
206
|
+
# rubocop:disable Naming/AccessorMethodName
|
|
207
|
+
# : (untyped colors) -> untyped
|
|
208
|
+
def set_indexed_colors: (untyped colors) -> untyped
|
|
209
|
+
|
|
210
|
+
# Returns the indexed colors palette.
|
|
211
|
+
# : () -> untyped
|
|
212
|
+
def indexed_colors: () -> untyped
|
|
213
|
+
|
|
214
|
+
# Sets the MRU (most recently used) colors (array of color hashes, e.g. [{rgb: "FFFF0000"}]).
|
|
215
|
+
# rubocop:disable Naming/AccessorMethodName
|
|
216
|
+
# : (untyped colors) -> untyped
|
|
217
|
+
def set_mru_colors: (untyped colors) -> untyped
|
|
218
|
+
|
|
219
|
+
# Returns the MRU colors.
|
|
220
|
+
# : () -> untyped
|
|
221
|
+
def mru_colors: () -> untyped
|
|
222
|
+
|
|
223
|
+
# Sets table styles options (defaultTableStyle, defaultPivotStyle).
|
|
224
|
+
# : (untyped name, untyped value) -> untyped
|
|
225
|
+
def set_table_styles_option: (untyped name, untyped value) -> untyped
|
|
226
|
+
|
|
227
|
+
# Adds a table style definition. Returns the style name.
|
|
228
|
+
# elements: array of { type:, dxf_id:, size: }
|
|
229
|
+
# : (name: untyped, ?elements: untyped, ?pivot: untyped?, ?table: untyped?) -> untyped
|
|
230
|
+
def add_table_style: (name: untyped, ?elements: untyped, ?pivot: untyped, ?table: untyped) -> untyped
|
|
231
|
+
|
|
232
|
+
# Returns table styles configuration.
|
|
233
|
+
# : () -> untyped
|
|
234
|
+
def table_styles: () -> untyped
|
|
235
|
+
|
|
236
|
+
# Sets a core property.
|
|
237
|
+
# : (untyped name, untyped value) -> untyped
|
|
238
|
+
def core_property: (untyped name, untyped value) -> untyped
|
|
239
|
+
|
|
240
|
+
# Returns core properties hash.
|
|
241
|
+
# : () -> untyped
|
|
242
|
+
def core_properties: () -> untyped
|
|
243
|
+
|
|
244
|
+
# Sets an app property.
|
|
245
|
+
# : (untyped name, untyped value) -> untyped
|
|
246
|
+
def app_property: (untyped name, untyped value) -> untyped
|
|
247
|
+
|
|
248
|
+
# Returns app properties hash.
|
|
249
|
+
# : () -> untyped
|
|
250
|
+
def app_properties: () -> untyped
|
|
251
|
+
|
|
252
|
+
# Adds a custom document property. type: :string (default), :number, :bool, :date.
|
|
253
|
+
# : (untyped name, untyped value, ?type: ::Symbol) -> untyped
|
|
254
|
+
def custom_property: (untyped name, untyped value, ?type: untyped) -> untyped
|
|
255
|
+
|
|
256
|
+
# Returns custom properties array.
|
|
257
|
+
# : () -> untyped
|
|
258
|
+
def custom_properties: () -> untyped
|
|
259
|
+
|
|
260
|
+
# Sets a sheet-level property (e.g. :tab_color, :summary_below, :summary_right).
|
|
261
|
+
# : (untyped name, untyped value, ?sheet: untyped?) -> untyped
|
|
262
|
+
def set_sheet_property: (untyped name, untyped value, ?sheet: untyped) -> untyped
|
|
263
|
+
|
|
264
|
+
# Returns sheet properties for the first (or given) sheet.
|
|
265
|
+
# : (?sheet: untyped?) -> untyped
|
|
266
|
+
def sheet_properties: (?sheet: untyped) -> untyped
|
|
267
|
+
|
|
268
|
+
# Sets phonetic properties for a sheet (e.g. :font_id, :type, :alignment).
|
|
269
|
+
# : (untyped props, ?sheet: untyped?) -> untyped
|
|
270
|
+
def set_phonetic_properties: (untyped props, ?sheet: untyped) -> untyped
|
|
271
|
+
|
|
272
|
+
# Returns phonetic properties for the first (or given) sheet.
|
|
273
|
+
# : (?sheet: untyped?) -> untyped
|
|
274
|
+
def phonetic_properties: (?sheet: untyped) -> untyped
|
|
275
|
+
|
|
276
|
+
# Sets a sheet format property (e.g. :default_row_height, :default_col_width, :base_col_width).
|
|
277
|
+
# : (untyped name, untyped value, ?sheet: untyped?) -> untyped
|
|
278
|
+
def set_sheet_format: (untyped name, untyped value, ?sheet: untyped) -> untyped
|
|
279
|
+
|
|
280
|
+
# Returns sheet format properties for the first (or given) sheet.
|
|
281
|
+
# : (?sheet: untyped?) -> untyped
|
|
282
|
+
def sheet_format: (?sheet: untyped) -> untyped
|
|
283
|
+
|
|
284
|
+
# Sets a sheet view property (e.g. :show_grid_lines, :show_row_col_headers, :right_to_left, :zoom_scale).
|
|
285
|
+
# : (untyped name, untyped value, ?sheet: untyped?) -> untyped
|
|
286
|
+
def set_sheet_view: (untyped name, untyped value, ?sheet: untyped) -> untyped
|
|
287
|
+
|
|
288
|
+
# Returns sheet view properties for the first (or given) sheet.
|
|
289
|
+
# : (?sheet: untyped?) -> untyped
|
|
290
|
+
def sheet_view: (?sheet: untyped) -> untyped
|
|
291
|
+
|
|
292
|
+
# Sets a freeze pane. row: rows to freeze from top, col: columns to freeze from left.
|
|
293
|
+
# : (?row: ::Integer, ?col: ::Integer, ?sheet: untyped?) -> untyped
|
|
294
|
+
def set_freeze_pane: (?row: untyped, ?col: untyped, ?sheet: untyped) -> untyped
|
|
295
|
+
|
|
296
|
+
# Sets a split pane (non-frozen). x_split/y_split are in 1/20th of a point (twips).
|
|
297
|
+
# top_left_cell: the cell at top-left of the bottom-right pane.
|
|
298
|
+
# : (?x_split: ::Integer, ?y_split: ::Integer, ?top_left_cell: untyped?, ?sheet: untyped?) -> untyped
|
|
299
|
+
def set_split_pane: (?x_split: untyped, ?y_split: untyped, ?top_left_cell: untyped, ?sheet: untyped) -> untyped
|
|
300
|
+
|
|
301
|
+
# Returns freeze pane settings for the first (or given) sheet.
|
|
302
|
+
# : (?sheet: untyped?) -> untyped
|
|
303
|
+
def freeze_pane: (?sheet: untyped) -> untyped
|
|
304
|
+
|
|
305
|
+
# Sets the active cell selection.
|
|
306
|
+
# : (untyped active_cell, ?sqref: untyped?, ?pane: untyped?, ?active_cell_id: untyped?, ?sheet: untyped?) -> untyped
|
|
307
|
+
def set_selection: (untyped active_cell, ?sqref: untyped, ?pane: untyped, ?active_cell_id: untyped, ?sheet: untyped) -> untyped
|
|
308
|
+
|
|
309
|
+
# Returns selection for the first (or given) sheet.
|
|
310
|
+
# : (?sheet: untyped?) -> untyped
|
|
311
|
+
def selection: (?sheet: untyped) -> untyped
|
|
312
|
+
|
|
313
|
+
# Sets a print option (e.g. :grid_lines, :headings, :horizontal_centered, :vertical_centered).
|
|
314
|
+
# : (untyped name, untyped value, ?sheet: untyped?) -> untyped
|
|
315
|
+
def set_print_option: (untyped name, untyped value, ?sheet: untyped) -> untyped
|
|
316
|
+
|
|
317
|
+
# Returns print options for the first (or given) sheet.
|
|
318
|
+
# : (?sheet: untyped?) -> untyped
|
|
319
|
+
def print_options: (?sheet: untyped) -> untyped
|
|
320
|
+
|
|
321
|
+
# Sets page margins (all values in inches).
|
|
322
|
+
# : (?left: untyped?, ?right: untyped?, ?top: untyped?, ?bottom: untyped?, ?header: untyped?, ?footer: untyped?, ?sheet: untyped?) -> untyped
|
|
323
|
+
def set_page_margins: (?left: untyped, ?right: untyped, ?top: untyped, ?bottom: untyped, ?header: untyped, ?footer: untyped, ?sheet: untyped) -> untyped
|
|
324
|
+
|
|
325
|
+
# Returns page margins for the first (or given) sheet.
|
|
326
|
+
# : (?sheet: untyped?) -> untyped
|
|
327
|
+
def page_margins: (?sheet: untyped) -> untyped
|
|
328
|
+
|
|
329
|
+
# Sets a page setup property (e.g. :orientation, :paper_size, :scale, :fit_to_width, :fit_to_height).
|
|
330
|
+
# : (untyped name, untyped value, ?sheet: untyped?) -> untyped
|
|
331
|
+
def set_page_setup: (untyped name, untyped value, ?sheet: untyped) -> untyped
|
|
332
|
+
|
|
333
|
+
# Returns page setup for the first (or given) sheet.
|
|
334
|
+
# : (?sheet: untyped?) -> untyped
|
|
335
|
+
def page_setup: (?sheet: untyped) -> untyped
|
|
336
|
+
|
|
337
|
+
# Sets header/footer text (:odd_header, :odd_footer, :even_header, :even_footer).
|
|
338
|
+
# : (untyped name, untyped value, ?sheet: untyped?) -> untyped
|
|
339
|
+
def set_header_footer: (untyped name, untyped value, ?sheet: untyped) -> untyped
|
|
340
|
+
|
|
341
|
+
# Returns header/footer for the first (or given) sheet.
|
|
342
|
+
# : (?sheet: untyped?) -> untyped
|
|
343
|
+
def header_footer: (?sheet: untyped) -> untyped
|
|
344
|
+
|
|
345
|
+
# Adds a row break (page break before a given row number).
|
|
346
|
+
# : (untyped row_num, ?sheet: untyped?) -> untyped
|
|
347
|
+
def add_row_break: (untyped row_num, ?sheet: untyped) -> untyped
|
|
348
|
+
|
|
349
|
+
# Returns row breaks for the first (or given) sheet.
|
|
350
|
+
# : (?sheet: untyped?) -> untyped
|
|
351
|
+
def row_breaks: (?sheet: untyped) -> untyped
|
|
352
|
+
|
|
353
|
+
# Adds a column break (page break before a given column index, 1-based).
|
|
354
|
+
# : (untyped col_index, ?sheet: untyped?) -> untyped
|
|
355
|
+
def add_col_break: (untyped col_index, ?sheet: untyped) -> untyped
|
|
356
|
+
|
|
357
|
+
# Returns column breaks for the first (or given) sheet.
|
|
358
|
+
# : (?sheet: untyped?) -> untyped
|
|
359
|
+
def col_breaks: (?sheet: untyped) -> untyped
|
|
360
|
+
|
|
361
|
+
# Adds a data validation rule.
|
|
362
|
+
# sqref: cell range (e.g. "A1:A100")
|
|
363
|
+
# Options: type:, operator:, formula1:, formula2:, allow_blank:, show_input_message:,
|
|
364
|
+
# show_error_message:, error_style:, error_title:, error:, prompt_title:, prompt:
|
|
365
|
+
# : (untyped sqref, ?sheet: untyped?, **untyped opts) -> untyped
|
|
366
|
+
def add_data_validation: (untyped sqref, ?sheet: untyped, **untyped opts) -> untyped
|
|
367
|
+
|
|
368
|
+
# Returns data validations for the first (or given) sheet.
|
|
369
|
+
# : (?sheet: untyped?) -> untyped
|
|
370
|
+
def data_validations: (?sheet: untyped) -> untyped
|
|
371
|
+
|
|
372
|
+
# Sets a data validations container option (e.g. disable_prompts, x_window, y_window).
|
|
373
|
+
# : (untyped name, untyped value, ?sheet: untyped?) -> untyped
|
|
374
|
+
def set_data_validations_option: (untyped name, untyped value, ?sheet: untyped) -> untyped
|
|
375
|
+
|
|
376
|
+
# Adds a conditional formatting rule to the specified range.
|
|
377
|
+
# Options: type (:cell_is, :expression, :color_scale, :data_bar, :icon_set),
|
|
378
|
+
# operator, priority, formula/formulas, format_id, color_scale, data_bar, icon_set.
|
|
379
|
+
# : (untyped sqref, ?sheet: untyped?, **untyped opts) -> untyped
|
|
380
|
+
def add_conditional_format: (untyped sqref, ?sheet: untyped, **untyped opts) -> untyped
|
|
381
|
+
|
|
382
|
+
# Returns conditional formatting rules for the first (or given) sheet.
|
|
383
|
+
# : (?sheet: untyped?) -> untyped
|
|
384
|
+
def conditional_formats: (?sheet: untyped) -> untyped
|
|
385
|
+
|
|
386
|
+
# Adds a table definition to a sheet.
|
|
387
|
+
# columns: array of column name strings.
|
|
388
|
+
# : (untyped ref, columns: untyped, ?name: untyped?, ?display_name: untyped?, ?sheet: untyped?, ?totals_row_count: ::Integer, ?style: untyped?, **untyped opts) -> untyped
|
|
389
|
+
def add_table: (untyped ref, columns: untyped, ?name: untyped, ?display_name: untyped, ?sheet: untyped, ?totals_row_count: untyped, ?style: untyped, **untyped opts) -> untyped
|
|
390
|
+
|
|
391
|
+
# Returns table definitions for the first (or given) sheet.
|
|
392
|
+
# : (?sheet: untyped?) -> untyped
|
|
393
|
+
def tables: (?sheet: untyped) -> untyped
|
|
394
|
+
|
|
395
|
+
# Enables shared string table mode (strings stored in sharedStrings.xml).
|
|
396
|
+
# : () -> untyped
|
|
397
|
+
def use_shared_strings!: () -> untyped
|
|
398
|
+
|
|
399
|
+
# Sets a sheet's visibility state (:visible, :hidden, :very_hidden).
|
|
400
|
+
# : (untyped sheet_name, untyped state) -> untyped
|
|
401
|
+
def set_sheet_state: (untyped sheet_name, untyped state) -> untyped
|
|
402
|
+
|
|
403
|
+
# Returns the sheet state for a given sheet.
|
|
404
|
+
# : (untyped sheet_name) -> untyped
|
|
405
|
+
def sheet_state: (untyped sheet_name) -> untyped
|
|
406
|
+
|
|
407
|
+
# Adds a defined name. Options: sheet: (local scope), hidden: true, value: (formula or constant).
|
|
408
|
+
# : (untyped name, untyped value, ?sheet: untyped?, ?hidden: bool, **untyped opts) -> untyped
|
|
409
|
+
def add_defined_name: (untyped name, untyped value, ?sheet: untyped, ?hidden: untyped, **untyped opts) -> untyped
|
|
410
|
+
|
|
411
|
+
# Returns defined names array.
|
|
412
|
+
# : () -> untyped
|
|
413
|
+
def defined_names: () -> untyped
|
|
414
|
+
|
|
415
|
+
# Sets the print area for a sheet. range should be like "A1:D20".
|
|
416
|
+
# Generates the _xlnm.Print_Area defined name automatically.
|
|
417
|
+
# : (untyped range, ?sheet: untyped?) -> untyped
|
|
418
|
+
def set_print_area: (untyped range, ?sheet: untyped) -> untyped
|
|
419
|
+
|
|
420
|
+
# Sets print titles (rows and/or columns to repeat on each page).
|
|
421
|
+
# rows: "1:3" repeats rows 1-3, cols: "A:B" repeats columns A-B.
|
|
422
|
+
# : (?rows: untyped?, ?cols: untyped?, ?sheet: untyped?) -> untyped
|
|
423
|
+
def set_print_titles: (?rows: untyped, ?cols: untyped, ?sheet: untyped) -> untyped
|
|
424
|
+
|
|
425
|
+
# Sets a workbook property (e.g. :date1904, :default_theme_version).
|
|
426
|
+
# : (untyped name, untyped value) -> untyped
|
|
427
|
+
def set_workbook_property: (untyped name, untyped value) -> untyped
|
|
428
|
+
|
|
429
|
+
# Returns workbook properties hash.
|
|
430
|
+
# : () -> untyped
|
|
431
|
+
def workbook_properties: () -> untyped
|
|
432
|
+
|
|
433
|
+
# Sets a file version property (e.g. :app_name, :last_edited, :lowest_edited, :rup_build, :code_name).
|
|
434
|
+
# : (untyped name, untyped value) -> untyped
|
|
435
|
+
def set_file_version: (untyped name, untyped value) -> untyped
|
|
436
|
+
|
|
437
|
+
# Returns file version hash.
|
|
438
|
+
# : () -> untyped
|
|
439
|
+
def file_version: () -> untyped
|
|
440
|
+
|
|
441
|
+
# Sets a file sharing property (e.g. :read_only_recommended, :user_name).
|
|
442
|
+
# : (untyped name, untyped value) -> untyped
|
|
443
|
+
def set_file_sharing: (untyped name, untyped value) -> untyped
|
|
444
|
+
|
|
445
|
+
# Returns file sharing hash.
|
|
446
|
+
# : () -> untyped
|
|
447
|
+
def file_sharing: () -> untyped
|
|
448
|
+
|
|
449
|
+
# Sets a workbook view property (e.g. :active_tab, :first_sheet).
|
|
450
|
+
# : (untyped name, untyped value) -> untyped
|
|
451
|
+
def set_workbook_view: (untyped name, untyped value) -> untyped
|
|
452
|
+
|
|
453
|
+
# Returns workbook view properties hash.
|
|
454
|
+
# : () -> untyped
|
|
455
|
+
def workbook_views: () -> untyped
|
|
456
|
+
|
|
457
|
+
# Sets a calc property (e.g. :calc_id, :full_calc_on_load).
|
|
458
|
+
# : (untyped name, untyped value) -> untyped
|
|
459
|
+
def set_calc_property: (untyped name, untyped value) -> untyped
|
|
460
|
+
|
|
461
|
+
# Returns calc properties hash.
|
|
462
|
+
# : () -> untyped
|
|
463
|
+
def calc_properties: () -> untyped
|
|
464
|
+
|
|
465
|
+
# Sets a file recovery property (e.g. :auto_recover, :crash_save).
|
|
466
|
+
# : (untyped name, untyped value) -> untyped
|
|
467
|
+
def set_file_recovery_property: (untyped name, untyped value) -> untyped
|
|
468
|
+
|
|
469
|
+
# Returns file recovery properties hash.
|
|
470
|
+
# : () -> untyped
|
|
471
|
+
def file_recovery_properties: () -> untyped
|
|
472
|
+
|
|
473
|
+
# Sets sheet protection options.
|
|
474
|
+
# Options: :password, :sheet, :objects, :scenarios, :format_cells, :format_columns,
|
|
475
|
+
# :format_rows, :insert_columns, :insert_rows, :insert_hyperlinks,
|
|
476
|
+
# :delete_columns, :delete_rows, :select_locked_cells, :sort, :auto_filter,
|
|
477
|
+
# :pivot_tables, :select_unlocked_cells, :algorithm_name, :hash_value, :salt_value, :spin_count
|
|
478
|
+
# : (?sheet: untyped?, **untyped opts) -> untyped
|
|
479
|
+
def set_sheet_protection: (?sheet: untyped, **untyped opts) -> untyped
|
|
480
|
+
|
|
481
|
+
# Returns sheet protection settings for the given sheet.
|
|
482
|
+
# : (?sheet: untyped?) -> untyped
|
|
483
|
+
def sheet_protection: (?sheet: untyped) -> untyped
|
|
484
|
+
|
|
485
|
+
# Adds a protected range to the given sheet.
|
|
486
|
+
# Required: name:, sqref:
|
|
487
|
+
# Optional: algorithm_name:, hash_value:, salt_value:, spin_count:, security_descriptors: []
|
|
488
|
+
# : (?sheet: untyped?, **untyped opts) -> untyped
|
|
489
|
+
def add_protected_range: (?sheet: untyped, **untyped opts) -> untyped
|
|
490
|
+
|
|
491
|
+
# Returns protected ranges for the given sheet.
|
|
492
|
+
# : (?sheet: untyped?) -> untyped
|
|
493
|
+
def protected_ranges: (?sheet: untyped) -> untyped
|
|
494
|
+
|
|
495
|
+
# Adds a cell watch to the given sheet.
|
|
496
|
+
# : (untyped cell_ref, ?sheet: untyped?) -> untyped
|
|
497
|
+
def add_cell_watch: (untyped cell_ref, ?sheet: untyped) -> untyped
|
|
498
|
+
|
|
499
|
+
# Returns cell watches for the given sheet.
|
|
500
|
+
# : (?sheet: untyped?) -> untyped
|
|
501
|
+
def cell_watches: (?sheet: untyped) -> untyped
|
|
502
|
+
|
|
503
|
+
# Adds an ignored error entry for the given sheet.
|
|
504
|
+
# Options: sqref:, eval_error:, two_digit_text_year:, number_stored_as_text:, formula:,
|
|
505
|
+
# formula_range:, unlocked_formula:, empty_cell_reference:, list_data_validation:, calculated_column:
|
|
506
|
+
# : (?sheet: untyped?, **untyped opts) -> untyped
|
|
507
|
+
def add_ignored_error: (?sheet: untyped, **untyped opts) -> untyped
|
|
508
|
+
|
|
509
|
+
# Returns ignored errors for the given sheet.
|
|
510
|
+
# : (?sheet: untyped?) -> untyped
|
|
511
|
+
def ignored_errors: (?sheet: untyped) -> untyped
|
|
512
|
+
|
|
513
|
+
# Sets data consolidation options for the given sheet.
|
|
514
|
+
# Options: function:, start_labels:, top_labels:, link:, data_refs: [{ref:, name:, sheet:}]
|
|
515
|
+
# : (?sheet: untyped?, **untyped opts) -> untyped
|
|
516
|
+
def set_data_consolidate: (?sheet: untyped, **untyped opts) -> untyped
|
|
517
|
+
|
|
518
|
+
# Returns data consolidation settings for the given sheet.
|
|
519
|
+
# : (?sheet: untyped?) -> untyped
|
|
520
|
+
def data_consolidate: (?sheet: untyped) -> untyped
|
|
521
|
+
|
|
522
|
+
# Sets scenarios for the given sheet.
|
|
523
|
+
# Options: current:, show:, sqref:, scenarios: [{name:, input_cells: [{r:, val:, ...}], ...}]
|
|
524
|
+
# : (?sheet: untyped?, **untyped opts) -> untyped
|
|
525
|
+
def set_scenarios: (?sheet: untyped, **untyped opts) -> untyped
|
|
526
|
+
|
|
527
|
+
# Returns scenarios for the given sheet.
|
|
528
|
+
# : (?sheet: untyped?) -> untyped
|
|
529
|
+
def scenarios: (?sheet: untyped) -> untyped
|
|
530
|
+
|
|
531
|
+
# Sets workbook protection options.
|
|
532
|
+
# Options: :lock_structure, :lock_windows, :password, :algorithm_name, :hash_value, :salt_value, :spin_count
|
|
533
|
+
# : (**untyped opts) -> untyped
|
|
534
|
+
def set_workbook_protection: (**untyped opts) -> untyped
|
|
535
|
+
|
|
536
|
+
# Returns workbook protection settings.
|
|
537
|
+
# : () -> untyped
|
|
538
|
+
def workbook_protection: () -> untyped
|
|
539
|
+
|
|
540
|
+
# Returns ordered sheet names.
|
|
541
|
+
# : untyped
|
|
542
|
+
attr_reader sheet_order: untyped
|
|
543
|
+
|
|
544
|
+
# Adds a raw ZIP entry to be included in the output (for pass-through retention).
|
|
545
|
+
# : (untyped path, untyped content, ?content_type: untyped?) -> (nil | untyped)
|
|
546
|
+
def add_raw_entry: (untyped path, untyped content, ?content_type: untyped) -> untyped
|
|
547
|
+
|
|
548
|
+
# Copies all ZIP entries from an existing XLSX file as pass-through.
|
|
549
|
+
# Generated parts override pass-through parts with the same path.
|
|
550
|
+
# : (untyped filepath) -> untyped
|
|
551
|
+
def copy_entries_from: (untyped filepath) -> untyped
|
|
552
|
+
|
|
553
|
+
# Inserts an image from file data into the given sheet.
|
|
554
|
+
# file_data: raw image bytes. ext: file extension (e.g. "png").
|
|
555
|
+
# from_col/from_row: anchor start. to_col/to_row: anchor end.
|
|
556
|
+
# : (untyped file_data, ?ext: ::String, ?from_col: ::Integer, ?from_row: ::Integer, ?to_col: ::Integer, ?to_row: ::Integer, ?from_col_off: untyped?, ?from_row_off: untyped?, ?to_col_off: untyped?, ?to_row_off: untyped?, ?name: untyped?, ?description: untyped?, ?title: untyped?, ?hidden: untyped?, ?macro: untyped?, ?no_change_aspect: bool, ?no_crop: untyped?, ?line_color: untyped?, ?line_width: untyped?, ?rotation: untyped?, ?edit_as: untyped?, ?published: untyped?, ?locks_with_sheet: untyped?, ?prints_with_sheet: untyped?, ?src_rect: untyped?, ?alpha_mod_fix: untyped?, ?sheet: untyped?) -> untyped
|
|
557
|
+
def insert_image: (untyped file_data, ?ext: untyped, ?from_col: untyped, ?from_row: untyped, ?to_col: untyped, ?to_row: untyped, ?from_col_off: untyped, ?from_row_off: untyped, ?to_col_off: untyped, ?to_row_off: untyped, ?name: untyped, ?description: untyped, ?title: untyped, ?hidden: untyped, ?macro: untyped, ?no_change_aspect: untyped, ?no_crop: untyped, ?line_color: untyped, ?line_width: untyped, ?rotation: untyped, ?edit_as: untyped, ?published: untyped, ?locks_with_sheet: untyped, ?prints_with_sheet: untyped, ?src_rect: untyped, ?alpha_mod_fix: untyped, ?sheet: untyped) -> untyped
|
|
558
|
+
|
|
559
|
+
# Returns images for the first (or given) sheet.
|
|
560
|
+
# : (?sheet: untyped?) -> untyped
|
|
561
|
+
def images: (?sheet: untyped) -> untyped
|
|
562
|
+
|
|
563
|
+
# Adds a chart to the given sheet.
|
|
564
|
+
# type: :bar, :line, :pie. title: chart title string.
|
|
565
|
+
# data_ref: e.g. "Sheet1!$A$1:$B$4". cat_ref/val_ref for explicit series.
|
|
566
|
+
# : (?type: ::Symbol, ?title: untyped?, ?title_overlay: untyped?, ?title_font: untyped?, ?title_fill_color: untyped?, ?title_no_fill: untyped?, ?title_line_color: untyped?, ?title_line_width: untyped?, ?title_line_dash: untyped?, ?title_rotation: untyped?, ?auto_title_deleted: untyped?, ?cat_ref: untyped?, ?val_ref: untyped?, ?series: untyped?, ?legend: untyped?, ?data_labels: untyped?, ?cat_axis_title: untyped?, ?val_axis_title: untyped?, ?cat_axis_title_font: untyped?, ?cat_axis_title_fill: untyped?, ?cat_axis_title_no_fill: untyped?, ?cat_axis_title_line_color: untyped?, ?cat_axis_title_line_width: untyped?, ?cat_axis_title_line_dash: untyped?, ?cat_axis_title_rotation: untyped?, ?val_axis_title_font: untyped?, ?val_axis_title_fill: untyped?, ?val_axis_title_no_fill: untyped?, ?val_axis_title_line_color: untyped?, ?val_axis_title_line_width: untyped?, ?val_axis_title_line_dash: untyped?, ?val_axis_title_rotation: untyped?, ?cat_axis_tick_lbl_pos: untyped?, ?val_axis_tick_lbl_pos: untyped?, ?cat_axis_major_gridlines: untyped?, ?val_axis_major_gridlines: untyped?, ?cat_axis_minor_gridlines: untyped?, ?val_axis_minor_gridlines: untyped?, ?cat_axis_delete: untyped?, ?val_axis_delete: untyped?, ?cat_axis_orientation: untyped?, ?val_axis_orientation: untyped?, ?cat_axis_num_fmt: untyped?, ?val_axis_num_fmt: untyped?, ?cat_axis_major_tick_mark: untyped?, ?cat_axis_minor_tick_mark: untyped?, ?val_axis_major_tick_mark: untyped?, ?val_axis_minor_tick_mark: untyped?, ?cat_axis_crosses: untyped?, ?val_axis_crosses: untyped?, ?cat_axis_crosses_at: untyped?, ?val_axis_crosses_at: untyped?, ?cat_axis_tick_lbl_skip: untyped?, ?cat_axis_tick_mark_skip: untyped?, ?cat_axis_lbl_offset: untyped?, ?cat_axis_auto: untyped?, ?cat_axis_lbl_algn: untyped?, ?cat_axis_no_multi_lvl_lbl: untyped?, ?val_axis_cross_between: untyped?, ?val_axis_major_unit: untyped?, ?val_axis_minor_unit: untyped?, ?cat_axis_scaling_max: untyped?, ?cat_axis_scaling_min: untyped?, ?val_axis_scaling_max: untyped?, ?val_axis_scaling_min: untyped?, ?cat_axis_log_base: untyped?, ?val_axis_log_base: untyped?, ?val_axis_disp_units: untyped?, ?gap_width: untyped?, ?gap_depth: untyped?, ?overlap: untyped?, ?first_slice_ang: untyped?, ?hole_size: untyped?, ?smooth: untyped?, ?marker: untyped?, ?scatter_style: untyped?, ?radar_style: untyped?, ?bar_shape: untyped?, ?bubble_3d: untyped?, ?bubble_scale: untyped?, ?show_neg_bubbles: untyped?, ?size_represents: untyped?, ?wireframe: untyped?, ?grouping: untyped?, ?bar_dir: untyped?, ?vary_colors: untyped?, ?style: untyped?, ?rounded_corners: untyped?, ?view_3d: untyped?, ?cat_axis_pos: untyped?, ?val_axis_pos: untyped?, ?name: untyped?, ?description: untyped?, ?frame_title: untyped?, ?frame_hidden: untyped?, ?frame_macro: untyped?, ?frame_no_grp: untyped?, ?from_col: ::Integer, ?from_row: ::Integer, ?to_col: ::Integer, ?to_row: ::Integer, ?from_col_off: untyped?, ?from_row_off: untyped?, ?to_col_off: untyped?, ?to_row_off: untyped?, ?edit_as: untyped?, ?published: untyped?, ?locks_with_sheet: untyped?, ?prints_with_sheet: untyped?, ?plot_vis_only: untyped?, ?disp_blanks_as: untyped?, ?show_d_lbls_over_max: untyped?, ?data_table: untyped?, ?plot_area_fill: untyped?, ?plot_area_no_fill: untyped?, ?plot_area_line_color: untyped?, ?plot_area_line_width: untyped?, ?plot_area_line_dash: untyped?, ?plot_area_layout: untyped?, ?floor: untyped?, ?side_wall: untyped?, ?back_wall: untyped?, ?drop_lines: untyped?, ?hi_low_lines: untyped?, ?ser_lines: untyped?, ?up_down_bars: untyped?, ?band_fmts: untyped?, ?of_pie_type: untyped?, ?split_type: untyped?, ?split_pos: untyped?, ?cust_split: untyped?, ?second_pie_size: untyped?, ?cat_axis_label_rotation: untyped?, ?val_axis_label_rotation: untyped?, ?cat_axis_font: untyped?, ?val_axis_font: untyped?, ?cat_axis_line_color: untyped?, ?cat_axis_line_width: untyped?, ?cat_axis_line_dash: untyped?, ?val_axis_line_color: untyped?, ?val_axis_line_width: untyped?, ?val_axis_line_dash: untyped?, ?cat_axis_fill: untyped?, ?cat_axis_no_fill: untyped?, ?val_axis_fill: untyped?, ?val_axis_no_fill: untyped?, ?cat_axis_type: untyped?, ?cat_axis_base_time_unit: untyped?, ?cat_axis_major_time_unit: untyped?, ?cat_axis_minor_time_unit: untyped?, ?cat_axis_major_unit: untyped?, ?cat_axis_minor_unit: untyped?, ?chart_fill: untyped?, ?chart_no_fill: untyped?, ?chart_line_color: untyped?, ?chart_line_width: untyped?, ?chart_line_dash: untyped?, ?protection: untyped?, ?print_settings: untyped?, ?chart_font: untyped?, ?sheet: untyped?) -> untyped
|
|
567
|
+
def add_chart: (?type: untyped, ?title: untyped, ?title_overlay: untyped, ?title_font: untyped, ?title_fill_color: untyped, ?title_no_fill: untyped, ?title_line_color: untyped, ?title_line_width: untyped, ?title_line_dash: untyped, ?title_rotation: untyped, ?auto_title_deleted: untyped, ?cat_ref: untyped, ?val_ref: untyped, ?series: untyped, ?legend: untyped, ?data_labels: untyped, ?cat_axis_title: untyped, ?val_axis_title: untyped, ?cat_axis_title_font: untyped, ?cat_axis_title_fill: untyped, ?cat_axis_title_no_fill: untyped, ?cat_axis_title_line_color: untyped, ?cat_axis_title_line_width: untyped, ?cat_axis_title_line_dash: untyped, ?cat_axis_title_rotation: untyped, ?val_axis_title_font: untyped, ?val_axis_title_fill: untyped, ?val_axis_title_no_fill: untyped, ?val_axis_title_line_color: untyped, ?val_axis_title_line_width: untyped, ?val_axis_title_line_dash: untyped, ?val_axis_title_rotation: untyped, ?cat_axis_tick_lbl_pos: untyped, ?val_axis_tick_lbl_pos: untyped, ?cat_axis_major_gridlines: untyped, ?val_axis_major_gridlines: untyped, ?cat_axis_minor_gridlines: untyped, ?val_axis_minor_gridlines: untyped, ?cat_axis_delete: untyped, ?val_axis_delete: untyped, ?cat_axis_orientation: untyped, ?val_axis_orientation: untyped, ?cat_axis_num_fmt: untyped, ?val_axis_num_fmt: untyped, ?cat_axis_major_tick_mark: untyped, ?cat_axis_minor_tick_mark: untyped, ?val_axis_major_tick_mark: untyped, ?val_axis_minor_tick_mark: untyped, ?cat_axis_crosses: untyped, ?val_axis_crosses: untyped, ?cat_axis_crosses_at: untyped, ?val_axis_crosses_at: untyped, ?cat_axis_tick_lbl_skip: untyped, ?cat_axis_tick_mark_skip: untyped, ?cat_axis_lbl_offset: untyped, ?cat_axis_auto: untyped, ?cat_axis_lbl_algn: untyped, ?cat_axis_no_multi_lvl_lbl: untyped, ?val_axis_cross_between: untyped, ?val_axis_major_unit: untyped, ?val_axis_minor_unit: untyped, ?cat_axis_scaling_max: untyped, ?cat_axis_scaling_min: untyped, ?val_axis_scaling_max: untyped, ?val_axis_scaling_min: untyped, ?cat_axis_log_base: untyped, ?val_axis_log_base: untyped, ?val_axis_disp_units: untyped, ?gap_width: untyped, ?gap_depth: untyped, ?overlap: untyped, ?first_slice_ang: untyped, ?hole_size: untyped, ?smooth: untyped, ?marker: untyped, ?scatter_style: untyped, ?radar_style: untyped, ?bar_shape: untyped, ?bubble_3d: untyped, ?bubble_scale: untyped, ?show_neg_bubbles: untyped, ?size_represents: untyped, ?wireframe: untyped, ?grouping: untyped, ?bar_dir: untyped, ?vary_colors: untyped, ?style: untyped, ?rounded_corners: untyped, ?view_3d: untyped, ?cat_axis_pos: untyped, ?val_axis_pos: untyped, ?name: untyped, ?description: untyped, ?frame_title: untyped, ?frame_hidden: untyped, ?frame_macro: untyped, ?frame_no_grp: untyped, ?from_col: untyped, ?from_row: untyped, ?to_col: untyped, ?to_row: untyped, ?from_col_off: untyped, ?from_row_off: untyped, ?to_col_off: untyped, ?to_row_off: untyped, ?edit_as: untyped, ?published: untyped, ?locks_with_sheet: untyped, ?prints_with_sheet: untyped, ?plot_vis_only: untyped, ?disp_blanks_as: untyped, ?show_d_lbls_over_max: untyped, ?data_table: untyped, ?plot_area_fill: untyped, ?plot_area_no_fill: untyped, ?plot_area_line_color: untyped, ?plot_area_line_width: untyped, ?plot_area_line_dash: untyped, ?plot_area_layout: untyped, ?floor: untyped, ?side_wall: untyped, ?back_wall: untyped, ?drop_lines: untyped, ?hi_low_lines: untyped, ?ser_lines: untyped, ?up_down_bars: untyped, ?band_fmts: untyped, ?of_pie_type: untyped, ?split_type: untyped, ?split_pos: untyped, ?cust_split: untyped, ?second_pie_size: untyped, ?cat_axis_label_rotation: untyped, ?val_axis_label_rotation: untyped, ?cat_axis_font: untyped, ?val_axis_font: untyped, ?cat_axis_line_color: untyped, ?cat_axis_line_width: untyped, ?cat_axis_line_dash: untyped, ?val_axis_line_color: untyped, ?val_axis_line_width: untyped, ?val_axis_line_dash: untyped, ?cat_axis_fill: untyped, ?cat_axis_no_fill: untyped, ?val_axis_fill: untyped, ?val_axis_no_fill: untyped, ?cat_axis_type: untyped, ?cat_axis_base_time_unit: untyped, ?cat_axis_major_time_unit: untyped, ?cat_axis_minor_time_unit: untyped, ?cat_axis_major_unit: untyped, ?cat_axis_minor_unit: untyped, ?chart_fill: untyped, ?chart_no_fill: untyped, ?chart_line_color: untyped, ?chart_line_width: untyped, ?chart_line_dash: untyped, ?protection: untyped, ?print_settings: untyped, ?chart_font: untyped, ?sheet: untyped) -> untyped
|
|
568
|
+
|
|
569
|
+
# Returns chart definitions for the first (or given) sheet.
|
|
570
|
+
# : (?sheet: untyped?) -> untyped
|
|
571
|
+
def charts: (?sheet: untyped) -> untyped
|
|
572
|
+
|
|
573
|
+
# Adds a shape to the given sheet.
|
|
574
|
+
# preset: preset geometry name (e.g. "rect", "ellipse", "roundRect").
|
|
575
|
+
# text: optional text body string.
|
|
576
|
+
# from_col/from_row/to_col/to_row: anchor coordinates.
|
|
577
|
+
# : (?preset: ::String, ?text: untyped?, ?name: untyped?, ?description: untyped?, ?title: untyped?, ?hidden: untyped?, ?macro: untyped?, ?textlink: untyped?, ?f_locks_text: untyped?, ?no_grp: untyped?, ?no_rot: untyped?, ?fill_color: untyped?, ?fill_alpha: untyped?, ?fill_color_transforms: untyped?, ?no_fill: untyped?, ?gradient_fill: untyped?, ?pattern_fill: untyped?, ?line_color: untyped?, ?line_alpha: untyped?, ?line_color_transforms: untyped?, ?line_width: untyped?, ?no_line: untyped?, ?line_dash: untyped?, ?line_custom_dash: untyped?, ?line_cap: untyped?, ?line_align: untyped?, ?line_compound: untyped?, ?line_join: untyped?, ?line_miter_limit: untyped?, ?head_end: untyped?, ?tail_end: untyped?, ?rotation: untyped?, ?text_wrap: untyped?, ?text_anchor: untyped?, ?text_vert_overflow: untyped?, ?text_horz_overflow: untyped?, ?text_spc_first_last_para: untyped?, ?text_num_col: untyped?, ?text_spc_col: untyped?, ?text_rtl_col: untyped?, ?text_from_word_art: untyped?, ?text_upright: untyped?, ?text_compat_ln_spc: untyped?, ?text_force_aa: untyped?, ?text_warp: untyped?, ?text_vertical: untyped?, ?text_insets: untyped?, ?text_rot: untyped?, ?adjust_values: untyped?, ?text_font: untyped?, ?text_end_para_rpr: untyped?, ?text_def_rpr: untyped?, ?text_align: untyped?, ?text_font_align: untyped?, ?text_def_tab_sz: untyped?, ?text_indent: untyped?, ?text_anchor_ctr: untyped?, ?text_spacing: untyped?, ?text_rtl: untyped?, ?text_ea_ln_brk: untyped?, ?text_latin_ln_brk: untyped?, ?text_hanging_punct: untyped?, ?text_tab_stops: untyped?, ?text_bullet: untyped?, ?text_level: untyped?, ?text_paragraphs: untyped?, ?autofit: untyped?, ?outer_shadow: untyped?, ?inner_shadow: untyped?, ?glow: untyped?, ?soft_edge: untyped?, ?reflection: untyped?, ?blur: untyped?, ?from_col: ::Integer, ?from_row: ::Integer, ?to_col: ::Integer, ?to_row: ::Integer, ?from_col_off: untyped?, ?from_row_off: untyped?, ?to_col_off: untyped?, ?to_row_off: untyped?, ?edit_as: untyped?, ?published: untyped?, ?locks_with_sheet: untyped?, ?prints_with_sheet: untyped?, ?sheet: untyped?) -> untyped
|
|
578
|
+
def add_shape: (?preset: untyped, ?text: untyped, ?name: untyped, ?description: untyped, ?title: untyped, ?hidden: untyped, ?macro: untyped, ?textlink: untyped, ?f_locks_text: untyped, ?no_grp: untyped, ?no_rot: untyped, ?fill_color: untyped, ?fill_alpha: untyped, ?fill_color_transforms: untyped, ?no_fill: untyped, ?gradient_fill: untyped, ?pattern_fill: untyped, ?line_color: untyped, ?line_alpha: untyped, ?line_color_transforms: untyped, ?line_width: untyped, ?no_line: untyped, ?line_dash: untyped, ?line_custom_dash: untyped, ?line_cap: untyped, ?line_align: untyped, ?line_compound: untyped, ?line_join: untyped, ?line_miter_limit: untyped, ?head_end: untyped, ?tail_end: untyped, ?rotation: untyped, ?text_wrap: untyped, ?text_anchor: untyped, ?text_vert_overflow: untyped, ?text_horz_overflow: untyped, ?text_spc_first_last_para: untyped, ?text_num_col: untyped, ?text_spc_col: untyped, ?text_rtl_col: untyped, ?text_from_word_art: untyped, ?text_upright: untyped, ?text_compat_ln_spc: untyped, ?text_force_aa: untyped, ?text_warp: untyped, ?text_vertical: untyped, ?text_insets: untyped, ?text_rot: untyped, ?adjust_values: untyped, ?text_font: untyped, ?text_end_para_rpr: untyped, ?text_def_rpr: untyped, ?text_align: untyped, ?text_font_align: untyped, ?text_def_tab_sz: untyped, ?text_indent: untyped, ?text_anchor_ctr: untyped, ?text_spacing: untyped, ?text_rtl: untyped, ?text_ea_ln_brk: untyped, ?text_latin_ln_brk: untyped, ?text_hanging_punct: untyped, ?text_tab_stops: untyped, ?text_bullet: untyped, ?text_level: untyped, ?text_paragraphs: untyped, ?autofit: untyped, ?outer_shadow: untyped, ?inner_shadow: untyped, ?glow: untyped, ?soft_edge: untyped, ?reflection: untyped, ?blur: untyped, ?from_col: untyped, ?from_row: untyped, ?to_col: untyped, ?to_row: untyped, ?from_col_off: untyped, ?from_row_off: untyped, ?to_col_off: untyped, ?to_row_off: untyped, ?edit_as: untyped, ?published: untyped, ?locks_with_sheet: untyped, ?prints_with_sheet: untyped, ?sheet: untyped) -> untyped
|
|
579
|
+
|
|
580
|
+
# Returns shape definitions for the first (or given) sheet.
|
|
581
|
+
# : (?sheet: untyped?) -> untyped
|
|
582
|
+
def shapes: (?sheet: untyped) -> untyped
|
|
583
|
+
|
|
584
|
+
# Adds a comment on a cell.
|
|
585
|
+
# : (untyped cell_address, untyped text, ?author: ::String, ?sheet: untyped?, ?guid: untyped?, ?shape_id: untyped?) -> untyped
|
|
586
|
+
def add_comment: (untyped cell_address, untyped text, ?author: untyped, ?sheet: untyped, ?guid: untyped, ?shape_id: untyped) -> untyped
|
|
587
|
+
|
|
588
|
+
# Returns comment definitions for the first (or given) sheet.
|
|
589
|
+
# : (?sheet: untyped?) -> untyped
|
|
590
|
+
def comments: (?sheet: untyped) -> untyped
|
|
591
|
+
|
|
592
|
+
# Adds a pivot table to the given sheet.
|
|
593
|
+
# source_ref: data source range (e.g. "Sheet1!A1:C4").
|
|
594
|
+
# row_fields: array of 0-based field indices for row axis.
|
|
595
|
+
# data_fields: array of { fld:, name:, subtotal: } hashes.
|
|
596
|
+
# col_fields: array of 0-based field indices for column axis.
|
|
597
|
+
# field_names: array of field name strings (for cache definition).
|
|
598
|
+
# items: hash mapping field index to array of item values.
|
|
599
|
+
# : (untyped source_ref, row_fields: untyped, data_fields: untyped, ?col_fields: untyped, ?dest_ref: ::String, ?name: untyped?, ?field_names: untyped?, ?items: untyped?, ?sheet: untyped?, **untyped opts) -> untyped
|
|
600
|
+
def add_pivot_table: (untyped source_ref, row_fields: untyped, data_fields: untyped, ?col_fields: untyped, ?dest_ref: untyped, ?name: untyped, ?field_names: untyped, ?items: untyped, ?sheet: untyped, **untyped opts) -> untyped
|
|
601
|
+
|
|
602
|
+
# Returns pivot table definitions for the first (or given) sheet.
|
|
603
|
+
# : (?sheet: untyped?) -> untyped
|
|
604
|
+
def pivot_tables: (?sheet: untyped) -> untyped
|
|
605
|
+
|
|
606
|
+
# Adds an external link reference to another workbook.
|
|
607
|
+
# target: path or URI to the external workbook (e.g. "Book2.xlsx").
|
|
608
|
+
# sheet_names: array of sheet name strings in the external workbook.
|
|
609
|
+
# : (target: untyped, ?sheet_names: untyped) -> untyped
|
|
610
|
+
def add_external_link: (target: untyped, ?sheet_names: untyped) -> untyped
|
|
611
|
+
|
|
612
|
+
# Returns external link definitions.
|
|
613
|
+
# : () -> untyped
|
|
614
|
+
def external_links: () -> untyped
|
|
615
|
+
|
|
616
|
+
# Enables macro preservation mode. Required when copy_entries_from loads a .xlsm file.
|
|
617
|
+
# : () -> untyped
|
|
618
|
+
def preserve_macros!: () -> untyped
|
|
619
|
+
|
|
620
|
+
# Returns whether macro preservation is enabled.
|
|
621
|
+
# : () -> untyped
|
|
622
|
+
def preserve_macros?: () -> untyped
|
|
623
|
+
|
|
624
|
+
# Writes the workbook as an XLSX file to the given path.
|
|
625
|
+
# : (untyped filepath) -> untyped
|
|
626
|
+
def write: (untyped filepath) -> untyped
|
|
627
|
+
|
|
628
|
+
CF_TYPE_MAP: untyped
|
|
629
|
+
|
|
630
|
+
XDR_NS: ::String
|
|
631
|
+
|
|
632
|
+
A_NS: ::String
|
|
633
|
+
|
|
634
|
+
C_NS: ::String
|
|
635
|
+
|
|
636
|
+
CHART_TYPE_MAP: untyped
|
|
637
|
+
|
|
638
|
+
NO_AXIS_CHARTS: untyped
|
|
639
|
+
|
|
640
|
+
THREE_AXIS_CHARTS: untyped
|
|
641
|
+
|
|
642
|
+
GROUPING_CHARTS: untyped
|
|
643
|
+
|
|
644
|
+
private
|
|
645
|
+
|
|
646
|
+
# : (?::Hash[untyped, untyped] all_entries) -> untyped
|
|
647
|
+
def generate_content_types_xml: (?untyped all_entries) -> untyped
|
|
648
|
+
|
|
649
|
+
# : () -> untyped
|
|
650
|
+
def generate_rels_root: () -> untyped
|
|
651
|
+
|
|
652
|
+
# : (?::Integer pivot_cache_count) -> untyped
|
|
653
|
+
def generate_workbook_xml: (?untyped pivot_cache_count) -> untyped
|
|
654
|
+
|
|
655
|
+
# : (?has_calc_chain: bool) -> untyped
|
|
656
|
+
def generate_workbook_rels: (?has_calc_chain: untyped) -> untyped
|
|
657
|
+
|
|
658
|
+
# : () -> (nil | untyped)
|
|
659
|
+
def generate_calc_chain_xml: () -> untyped
|
|
660
|
+
|
|
661
|
+
# : (untyped sheet_cells, untyped sheet_col_widths, untyped sheet_col_attrs, untyped sheet_row_attrs, untyped sheet_auto_filter, untyped sheet_filter_cols, untyped sheet_sort, untyped sheet_merge_cells, untyped sheet_hyperlinks, untyped sheet_cell_styles, untyped sheet_props, untyped sheet_fmt, untyped sheet_sv, untyped sheet_fp, untyped sheet_sel, untyped sheet_po, untyped sheet_pm, untyped sheet_ps, untyped sheet_hf, untyped sheet_rb, untyped sheet_cb, untyped sheet_dv, untyped sheet_cf, ?untyped? sst, ?untyped sheet_tables, ?::Integer hyperlink_count, ?has_drawing: bool, ?has_comments: bool, ?sheet_prot: untyped?, ?vml_rid: untyped?, ?phonetic_pr: untyped?, ?dv_options: ::Hash[untyped, untyped], ?prot_ranges: untyped, ?cell_watches: untyped, ?ignored_errors: untyped, ?data_consol: untyped?, ?sheet_scenarios: untyped?, ?cell_phonetic: ::Hash[untyped, untyped]) -> untyped
|
|
662
|
+
def generate_worksheet_xml: (untyped sheet_cells, untyped sheet_col_widths, untyped sheet_col_attrs, untyped sheet_row_attrs, untyped sheet_auto_filter, untyped sheet_filter_cols, untyped sheet_sort, untyped sheet_merge_cells, untyped sheet_hyperlinks, untyped sheet_cell_styles, untyped sheet_props, untyped sheet_fmt, untyped sheet_sv, untyped sheet_fp, untyped sheet_sel, untyped sheet_po, untyped sheet_pm, untyped sheet_ps, untyped sheet_hf, untyped sheet_rb, untyped sheet_cb, untyped sheet_dv, untyped sheet_cf, ?untyped sst, ?untyped sheet_tables, ?untyped hyperlink_count, ?has_drawing: untyped, ?has_comments: untyped, ?sheet_prot: untyped, ?vml_rid: untyped, ?phonetic_pr: untyped, ?dv_options: untyped, ?prot_ranges: untyped, ?cell_watches: untyped, ?ignored_errors: untyped, ?data_consol: untyped, ?sheet_scenarios: untyped, ?cell_phonetic: untyped) -> untyped
|
|
663
|
+
|
|
664
|
+
# : () -> ::Array[untyped]
|
|
665
|
+
def build_shared_string_table: () -> untyped
|
|
666
|
+
|
|
667
|
+
# : (untyped sst) -> untyped
|
|
668
|
+
def generate_shared_strings_xml: (untyped sst) -> untyped
|
|
669
|
+
|
|
670
|
+
# : (untyped tbl) -> untyped
|
|
671
|
+
def generate_table_xml: (untyped tbl) -> untyped
|
|
672
|
+
|
|
673
|
+
# : (untyped sheet_hyperlinks, ?untyped sheet_tables, ?::Integer table_start_index) -> untyped
|
|
674
|
+
def generate_worksheet_rels: (untyped sheet_hyperlinks, ?untyped sheet_tables, ?untyped table_start_index) -> untyped
|
|
675
|
+
|
|
676
|
+
# : (untyped sheet_name, untyped sheet_tables, untyped table_start_index, untyped drawing_idx, untyped comment_idx, untyped pivot_start, untyped pivot_count) -> untyped
|
|
677
|
+
def build_sheet_rels_parts_v2: (untyped sheet_name, untyped sheet_tables, untyped table_start_index, untyped drawing_idx, untyped comment_idx, untyped pivot_start, untyped pivot_count) -> untyped
|
|
678
|
+
|
|
679
|
+
# : (untyped rels_data) -> untyped
|
|
680
|
+
def generate_generic_rels: (untyped rels_data) -> untyped
|
|
681
|
+
|
|
682
|
+
# : (untyped drawing_parts) -> untyped
|
|
683
|
+
def generate_drawing_xml: (untyped drawing_parts) -> untyped
|
|
684
|
+
|
|
685
|
+
# : (untyped para) -> ::String
|
|
686
|
+
def paragraph_xml: (untyped para) -> untyped
|
|
687
|
+
|
|
688
|
+
# : (untyped tag, untyped font) -> untyped
|
|
689
|
+
def text_char_props_xml: (untyped tag, untyped font) -> untyped
|
|
690
|
+
|
|
691
|
+
# : (untyped tag, untyped col, untyped row, ?col_off: ::Integer, ?row_off: ::Integer) -> ::String
|
|
692
|
+
def anchor_xml: (untyped tag, untyped col, untyped row, ?col_off: untyped, ?row_off: untyped) -> untyped
|
|
693
|
+
|
|
694
|
+
# : (untyped obj) -> ::String
|
|
695
|
+
def client_data_xml: (untyped obj) -> untyped
|
|
696
|
+
|
|
697
|
+
# : (untyped rels_data) -> untyped
|
|
698
|
+
def generate_drawing_rels: (untyped rels_data) -> untyped
|
|
699
|
+
|
|
700
|
+
# : (untyped title_spec, ?overlay: bool) -> untyped
|
|
701
|
+
def build_chart_title_xml: (untyped title_spec, ?overlay: untyped) -> untyped
|
|
702
|
+
|
|
703
|
+
# : (untyped title_spec, untyped chart, untyped prefix) -> untyped
|
|
704
|
+
def merge_flat_title_styling: (untyped title_spec, untyped chart, untyped prefix) -> untyped
|
|
705
|
+
|
|
706
|
+
# : (untyped spec) -> untyped
|
|
707
|
+
def build_title_sp_pr: (untyped spec) -> untyped
|
|
708
|
+
|
|
709
|
+
# : (untyped layout) -> ("" | untyped)
|
|
710
|
+
def build_title_layout_xml: (untyped layout) -> untyped
|
|
711
|
+
|
|
712
|
+
# : (untyped tag, untyped spec) -> ("" | untyped)
|
|
713
|
+
def gridlines_xml: (untyped tag, untyped spec) -> untyped
|
|
714
|
+
|
|
715
|
+
# Resolves a cell reference like "Sheet1!$A$1:$A$5" to an array of values from @sheets.
|
|
716
|
+
# : (untyped ref) -> (nil | untyped)
|
|
717
|
+
def resolve_sheet_ref: (untyped ref) -> untyped
|
|
718
|
+
|
|
719
|
+
# : (untyped start_cell, untyped end_cell) -> (::Array[untyped] | untyped)
|
|
720
|
+
def enumerate_cell_range: (untyped start_cell, untyped end_cell) -> untyped
|
|
721
|
+
|
|
722
|
+
# : (untyped ref) -> ("" | ::String)
|
|
723
|
+
def num_cache_xml: (untyped ref) -> untyped
|
|
724
|
+
|
|
725
|
+
# : (untyped ref) -> ("" | ::String)
|
|
726
|
+
def str_cache_xml: (untyped ref) -> untyped
|
|
727
|
+
|
|
728
|
+
# : (untyped color, ?alpha: untyped?, ?transforms: untyped?) -> untyped
|
|
729
|
+
def color_xml: (untyped color, ?alpha: untyped, ?transforms: untyped) -> untyped
|
|
730
|
+
|
|
731
|
+
# : (untyped color) -> untyped
|
|
732
|
+
def normalize_drawing_rgb: (untyped color) -> untyped
|
|
733
|
+
|
|
734
|
+
alias srgb_clr_xml color_xml
|
|
735
|
+
|
|
736
|
+
# : (untyped rotation, untyped font) -> ("" | ::String)
|
|
737
|
+
def build_axis_txpr: (untyped rotation, untyped font) -> untyped
|
|
738
|
+
|
|
739
|
+
# : (untyped chart) -> untyped
|
|
740
|
+
def generate_chart_xml: (untyped chart) -> untyped
|
|
741
|
+
|
|
742
|
+
# : (untyped sheet_comments) -> untyped
|
|
743
|
+
def generate_comments_xml: (untyped sheet_comments) -> untyped
|
|
744
|
+
|
|
745
|
+
# : (untyped sheet_comments) -> untyped
|
|
746
|
+
def generate_vml_drawing_xml: (untyped sheet_comments) -> untyped
|
|
747
|
+
|
|
748
|
+
# : (untyped cell_ref) -> (::Array[0] | ::Array[untyped])
|
|
749
|
+
def cell_to_col_row: (untyped cell_ref) -> untyped
|
|
750
|
+
|
|
751
|
+
# : (untyped pivot_table, untyped cache_id) -> untyped
|
|
752
|
+
def generate_pivot_table_xml: (untyped pivot_table, untyped cache_id) -> untyped
|
|
753
|
+
|
|
754
|
+
# : (untyped pivot_table, untyped _cache_id) -> untyped
|
|
755
|
+
def generate_pivot_cache_definition_xml: (untyped pivot_table, untyped _cache_id) -> untyped
|
|
756
|
+
|
|
757
|
+
# : (untyped pivot_table) -> untyped
|
|
758
|
+
def generate_pivot_cache_records_xml: (untyped pivot_table) -> untyped
|
|
759
|
+
|
|
760
|
+
# : (untyped cache_id) -> untyped
|
|
761
|
+
def generate_pivot_cache_rels: (untyped cache_id) -> untyped
|
|
762
|
+
|
|
763
|
+
# : (untyped cache_id) -> untyped
|
|
764
|
+
def generate_pivot_table_rels: (untyped cache_id) -> untyped
|
|
765
|
+
|
|
766
|
+
# : (untyped ext_link) -> untyped
|
|
767
|
+
def generate_external_link_xml: (untyped ext_link) -> untyped
|
|
768
|
+
|
|
769
|
+
# : (untyped ext_link) -> untyped
|
|
770
|
+
def generate_external_link_rels: (untyped ext_link) -> untyped
|
|
771
|
+
|
|
772
|
+
# : (untyped ct_xml) -> untyped
|
|
773
|
+
def parse_extra_content_types: (untyped ct_xml) -> untyped
|
|
774
|
+
|
|
775
|
+
# : (untyped element, untyped opts) -> ("" | ::String)
|
|
776
|
+
def build_line_end_xml: (untyped element, untyped opts) -> untyped
|
|
777
|
+
|
|
778
|
+
# : (untyped value) -> untyped
|
|
779
|
+
def xml_escape: (untyped value) -> untyped
|
|
780
|
+
|
|
781
|
+
# : (untyped rich_text) -> untyped
|
|
782
|
+
def rich_text_xml: (untyped rich_text) -> untyped
|
|
783
|
+
|
|
784
|
+
# : (untyped cell_ref, untyped value, untyped style_idx, ?untyped? sst, ?ph: untyped?) -> untyped
|
|
785
|
+
def cell_xml: (untyped cell_ref, untyped value, untyped style_idx, ?untyped sst, ?ph: untyped) -> untyped
|
|
786
|
+
|
|
787
|
+
# Returns the numFmtId for dates, registering it on first use.
|
|
788
|
+
# : () -> untyped
|
|
789
|
+
def date_num_fmt_id: () -> untyped
|
|
790
|
+
|
|
791
|
+
# Returns the numFmtId for datetime, registering it on first use.
|
|
792
|
+
# : () -> untyped
|
|
793
|
+
def datetime_num_fmt_id: () -> untyped
|
|
794
|
+
|
|
795
|
+
# Maps a numFmtId to a cellXfs index. Index 0 is the default (no format).
|
|
796
|
+
# : (untyped style_value) -> (nil | untyped)
|
|
797
|
+
def resolve_style_index: (untyped style_value) -> untyped
|
|
798
|
+
|
|
799
|
+
# : (untyped filter) -> untyped
|
|
800
|
+
def emit_filter_xml: (untyped filter) -> untyped
|
|
801
|
+
|
|
802
|
+
# : (untyped parts, untyped rule) -> untyped
|
|
803
|
+
def emit_cf_rule: (untyped parts, untyped rule) -> untyped
|
|
804
|
+
|
|
805
|
+
# Emits a <color> element for CF rules, accepting either a plain RGB string or a hash.
|
|
806
|
+
# : (untyped color) -> (untyped | ::String)
|
|
807
|
+
def emit_cf_color_xml: (untyped color) -> untyped
|
|
808
|
+
|
|
809
|
+
# : (untyped sheet_cells) -> ("A1" | ::String)
|
|
810
|
+
def compute_dimension: (untyped sheet_cells) -> untyped
|
|
811
|
+
|
|
812
|
+
# : (untyped index) -> untyped
|
|
813
|
+
def index_to_column_letter: (untyped index) -> untyped
|
|
814
|
+
|
|
815
|
+
# : () -> untyped
|
|
816
|
+
def generate_core_properties_xml: () -> untyped
|
|
817
|
+
|
|
818
|
+
# : () -> untyped
|
|
819
|
+
def generate_app_properties_xml: () -> untyped
|
|
820
|
+
|
|
821
|
+
# : () -> untyped
|
|
822
|
+
def generate_custom_properties_xml: () -> untyped
|
|
823
|
+
|
|
824
|
+
# : () -> untyped
|
|
825
|
+
def generate_styles_xml: () -> untyped
|
|
826
|
+
|
|
827
|
+
# : (untyped alignment) -> ::String
|
|
828
|
+
def emit_alignment_xml: (untyped alignment) -> untyped
|
|
829
|
+
|
|
830
|
+
# : (untyped protection) -> ::String
|
|
831
|
+
def emit_protection_xml: (untyped protection) -> untyped
|
|
832
|
+
|
|
833
|
+
# : (untyped source, ?tag: ::String) -> (::String | ::String | ::String | ::String | "")
|
|
834
|
+
def emit_color_xml: (untyped source, ?tag: untyped) -> untyped
|
|
835
|
+
|
|
836
|
+
# : (untyped font) -> untyped
|
|
837
|
+
def emit_font_xml: (untyped font) -> untyped
|
|
838
|
+
|
|
839
|
+
# : (untyped fill) -> (untyped | ::String)
|
|
840
|
+
def emit_fill_xml: (untyped fill) -> untyped
|
|
841
|
+
|
|
842
|
+
# : (untyped tag, untyped fill, untyped prefix) -> (::String | ::String | ::String | ::String | "")
|
|
843
|
+
def emit_fill_color_xml: (untyped tag, untyped fill, untyped prefix) -> untyped
|
|
844
|
+
|
|
845
|
+
# : (untyped gradient) -> untyped
|
|
846
|
+
def emit_gradient_fill_xml: (untyped gradient) -> untyped
|
|
847
|
+
|
|
848
|
+
# : (untyped brk, default_max: untyped) -> ::String
|
|
849
|
+
def emit_brk_xml: (untyped brk, default_max: untyped) -> untyped
|
|
850
|
+
|
|
851
|
+
# : (untyped bdr) -> untyped
|
|
852
|
+
def emit_border_xml: (untyped bdr) -> untyped
|
|
853
|
+
|
|
854
|
+
# : (untyped dxf) -> untyped
|
|
855
|
+
def emit_dxf_xml: (untyped dxf) -> untyped
|
|
856
|
+
|
|
857
|
+
# : (untyped cell_address) -> untyped
|
|
858
|
+
def validate_cell_address!: (untyped cell_address) -> untyped
|
|
859
|
+
|
|
860
|
+
# : (untyped letters) -> untyped
|
|
861
|
+
def column_letter_to_index: (untyped letters) -> untyped
|
|
862
|
+
|
|
863
|
+
# Extracts the column letter(s) from a cell address, e.g. "A" from "A1".
|
|
864
|
+
# : (untyped cell_address) -> untyped
|
|
865
|
+
def extract_column_letter: (untyped cell_address) -> untyped
|
|
866
|
+
|
|
867
|
+
# Extracts the row number from a cell address, e.g. 1 from "A1".
|
|
868
|
+
# : (untyped cell_address) -> untyped
|
|
869
|
+
def extract_row_number: (untyped cell_address) -> untyped
|
|
870
|
+
|
|
871
|
+
# Converts a range like "A1:D20" to absolute "$A$1:$D$20".
|
|
872
|
+
# : (untyped range) -> untyped
|
|
873
|
+
def absolute_range: (untyped range) -> untyped
|
|
874
|
+
|
|
875
|
+
# Converts "A1" to "$A$1".
|
|
876
|
+
# : (untyped cell_ref) -> ::String
|
|
877
|
+
def absolute_cell: (untyped cell_ref) -> untyped
|
|
878
|
+
end
|
|
879
|
+
end
|
|
880
|
+
end
|