caxlsx 2.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.yardopts +9 -0
- data/.yardopts_guide +19 -0
- data/CHANGELOG.md +239 -0
- data/LICENSE +22 -0
- data/README.md +256 -0
- data/Rakefile +31 -0
- data/examples/2010_comments.rb +17 -0
- data/examples/anchor_swapping.rb +28 -0
- data/examples/auto_filter.rb +16 -0
- data/examples/basic_charts.rb +58 -0
- data/examples/chart_colors.rb +88 -0
- data/examples/colored_links.rb +59 -0
- data/examples/conditional_formatting/example_conditional_formatting.rb +74 -0
- data/examples/conditional_formatting/getting_barred.rb +37 -0
- data/examples/conditional_formatting/hitting_the_high_notes.rb +37 -0
- data/examples/conditional_formatting/scaled_colors.rb +39 -0
- data/examples/conditional_formatting/stop_and_go.rb +37 -0
- data/examples/data_validation.rb +50 -0
- data/examples/example.rb +777 -0
- data/examples/extractive.rb +45 -0
- data/examples/image1.jpeg +0 -0
- data/examples/ios_preview.rb +14 -0
- data/examples/page_setup.rb +11 -0
- data/examples/pivot_table.rb +39 -0
- data/examples/sheet_protection.rb +10 -0
- data/examples/skydrive/real_example.rb +63 -0
- data/examples/styles.rb +66 -0
- data/examples/underline.rb +13 -0
- data/examples/wrap_text.rb +21 -0
- data/lib/axlsx.rb +152 -0
- data/lib/axlsx/content_type/abstract_content_type.rb +32 -0
- data/lib/axlsx/content_type/content_type.rb +26 -0
- data/lib/axlsx/content_type/default.rb +25 -0
- data/lib/axlsx/content_type/override.rb +25 -0
- data/lib/axlsx/doc_props/app.rb +235 -0
- data/lib/axlsx/doc_props/core.rb +39 -0
- data/lib/axlsx/drawing/ax_data_source.rb +26 -0
- data/lib/axlsx/drawing/axes.rb +61 -0
- data/lib/axlsx/drawing/axis.rb +187 -0
- data/lib/axlsx/drawing/bar_3D_chart.rb +151 -0
- data/lib/axlsx/drawing/bar_series.rb +82 -0
- data/lib/axlsx/drawing/cat_axis.rb +85 -0
- data/lib/axlsx/drawing/chart.rb +232 -0
- data/lib/axlsx/drawing/d_lbls.rb +90 -0
- data/lib/axlsx/drawing/drawing.rb +162 -0
- data/lib/axlsx/drawing/graphic_frame.rb +54 -0
- data/lib/axlsx/drawing/hyperlink.rb +102 -0
- data/lib/axlsx/drawing/line_3D_chart.rb +68 -0
- data/lib/axlsx/drawing/line_chart.rb +99 -0
- data/lib/axlsx/drawing/line_series.rb +81 -0
- data/lib/axlsx/drawing/marker.rb +84 -0
- data/lib/axlsx/drawing/num_data.rb +52 -0
- data/lib/axlsx/drawing/num_data_source.rb +62 -0
- data/lib/axlsx/drawing/num_val.rb +32 -0
- data/lib/axlsx/drawing/one_cell_anchor.rb +98 -0
- data/lib/axlsx/drawing/pic.rb +205 -0
- data/lib/axlsx/drawing/picture_locking.rb +44 -0
- data/lib/axlsx/drawing/pie_3D_chart.rb +48 -0
- data/lib/axlsx/drawing/pie_series.rb +74 -0
- data/lib/axlsx/drawing/scaling.rb +60 -0
- data/lib/axlsx/drawing/scatter_chart.rb +74 -0
- data/lib/axlsx/drawing/scatter_series.rb +65 -0
- data/lib/axlsx/drawing/ser_axis.rb +45 -0
- data/lib/axlsx/drawing/series.rb +69 -0
- data/lib/axlsx/drawing/series_title.rb +23 -0
- data/lib/axlsx/drawing/str_data.rb +42 -0
- data/lib/axlsx/drawing/str_val.rb +32 -0
- data/lib/axlsx/drawing/title.rb +78 -0
- data/lib/axlsx/drawing/two_cell_anchor.rb +92 -0
- data/lib/axlsx/drawing/val_axis.rb +37 -0
- data/lib/axlsx/drawing/view_3D.rb +115 -0
- data/lib/axlsx/drawing/vml_drawing.rb +42 -0
- data/lib/axlsx/drawing/vml_shape.rb +66 -0
- data/lib/axlsx/package.rb +352 -0
- data/lib/axlsx/rels/relationship.rb +129 -0
- data/lib/axlsx/rels/relationships.rb +29 -0
- data/lib/axlsx/stylesheet/border.rb +71 -0
- data/lib/axlsx/stylesheet/border_pr.rb +71 -0
- data/lib/axlsx/stylesheet/cell_alignment.rb +134 -0
- data/lib/axlsx/stylesheet/cell_protection.rb +43 -0
- data/lib/axlsx/stylesheet/cell_style.rb +74 -0
- data/lib/axlsx/stylesheet/color.rb +78 -0
- data/lib/axlsx/stylesheet/dxf.rb +79 -0
- data/lib/axlsx/stylesheet/fill.rb +35 -0
- data/lib/axlsx/stylesheet/font.rb +148 -0
- data/lib/axlsx/stylesheet/gradient_fill.rb +103 -0
- data/lib/axlsx/stylesheet/gradient_stop.rb +37 -0
- data/lib/axlsx/stylesheet/num_fmt.rb +79 -0
- data/lib/axlsx/stylesheet/pattern_fill.rb +73 -0
- data/lib/axlsx/stylesheet/styles.rb +420 -0
- data/lib/axlsx/stylesheet/table_style.rb +54 -0
- data/lib/axlsx/stylesheet/table_style_element.rb +79 -0
- data/lib/axlsx/stylesheet/table_styles.rb +46 -0
- data/lib/axlsx/stylesheet/xf.rb +147 -0
- data/lib/axlsx/util/accessors.rb +64 -0
- data/lib/axlsx/util/constants.rb +392 -0
- data/lib/axlsx/util/options_parser.rb +15 -0
- data/lib/axlsx/util/parser.rb +44 -0
- data/lib/axlsx/util/serialized_attributes.rb +79 -0
- data/lib/axlsx/util/simple_typed_list.rb +203 -0
- data/lib/axlsx/util/storage.rb +146 -0
- data/lib/axlsx/util/validators.rb +300 -0
- data/lib/axlsx/version.rb +5 -0
- data/lib/axlsx/workbook/defined_name.rb +129 -0
- data/lib/axlsx/workbook/defined_names.rb +21 -0
- data/lib/axlsx/workbook/shared_strings_table.rb +77 -0
- data/lib/axlsx/workbook/workbook.rb +354 -0
- data/lib/axlsx/workbook/worksheet/auto_filter/auto_filter.rb +77 -0
- data/lib/axlsx/workbook/worksheet/auto_filter/filter_column.rb +94 -0
- data/lib/axlsx/workbook/worksheet/auto_filter/filters.rb +246 -0
- data/lib/axlsx/workbook/worksheet/break.rb +37 -0
- data/lib/axlsx/workbook/worksheet/cell.rb +416 -0
- data/lib/axlsx/workbook/worksheet/cell_serializer.rb +144 -0
- data/lib/axlsx/workbook/worksheet/cfvo.rb +62 -0
- data/lib/axlsx/workbook/worksheet/cfvos.rb +15 -0
- data/lib/axlsx/workbook/worksheet/col.rb +144 -0
- data/lib/axlsx/workbook/worksheet/col_breaks.rb +35 -0
- data/lib/axlsx/workbook/worksheet/color_scale.rb +110 -0
- data/lib/axlsx/workbook/worksheet/cols.rb +20 -0
- data/lib/axlsx/workbook/worksheet/comment.rb +92 -0
- data/lib/axlsx/workbook/worksheet/comments.rb +85 -0
- data/lib/axlsx/workbook/worksheet/conditional_formatting.rb +82 -0
- data/lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb +220 -0
- data/lib/axlsx/workbook/worksheet/conditional_formattings.rb +25 -0
- data/lib/axlsx/workbook/worksheet/data_bar.rb +131 -0
- data/lib/axlsx/workbook/worksheet/data_validation.rb +244 -0
- data/lib/axlsx/workbook/worksheet/data_validations.rb +28 -0
- data/lib/axlsx/workbook/worksheet/date_time_converter.rb +30 -0
- data/lib/axlsx/workbook/worksheet/dimension.rb +64 -0
- data/lib/axlsx/workbook/worksheet/header_footer.rb +54 -0
- data/lib/axlsx/workbook/worksheet/icon_set.rb +83 -0
- data/lib/axlsx/workbook/worksheet/merged_cells.rb +35 -0
- data/lib/axlsx/workbook/worksheet/page_margins.rb +99 -0
- data/lib/axlsx/workbook/worksheet/page_set_up_pr.rb +44 -0
- data/lib/axlsx/workbook/worksheet/page_setup.rb +242 -0
- data/lib/axlsx/workbook/worksheet/pane.rb +141 -0
- data/lib/axlsx/workbook/worksheet/pivot_table.rb +273 -0
- data/lib/axlsx/workbook/worksheet/pivot_table_cache_definition.rb +66 -0
- data/lib/axlsx/workbook/worksheet/pivot_tables.rb +24 -0
- data/lib/axlsx/workbook/worksheet/print_options.rb +41 -0
- data/lib/axlsx/workbook/worksheet/protected_range.rb +49 -0
- data/lib/axlsx/workbook/worksheet/protected_ranges.rb +34 -0
- data/lib/axlsx/workbook/worksheet/row.rb +172 -0
- data/lib/axlsx/workbook/worksheet/row_breaks.rb +33 -0
- data/lib/axlsx/workbook/worksheet/selection.rb +103 -0
- data/lib/axlsx/workbook/worksheet/sheet_calc_pr.rb +29 -0
- data/lib/axlsx/workbook/worksheet/sheet_data.rb +25 -0
- data/lib/axlsx/workbook/worksheet/sheet_format_pr.rb +60 -0
- data/lib/axlsx/workbook/worksheet/sheet_pr.rb +69 -0
- data/lib/axlsx/workbook/worksheet/sheet_protection.rb +120 -0
- data/lib/axlsx/workbook/worksheet/sheet_view.rb +213 -0
- data/lib/axlsx/workbook/worksheet/table.rb +102 -0
- data/lib/axlsx/workbook/worksheet/table_style_info.rb +51 -0
- data/lib/axlsx/workbook/worksheet/tables.rb +31 -0
- data/lib/axlsx/workbook/worksheet/worksheet.rb +769 -0
- data/lib/axlsx/workbook/worksheet/worksheet_comments.rb +58 -0
- data/lib/axlsx/workbook/worksheet/worksheet_drawing.rb +58 -0
- data/lib/axlsx/workbook/worksheet/worksheet_hyperlink.rb +74 -0
- data/lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb +38 -0
- data/lib/schema/dc.xsd +118 -0
- data/lib/schema/dcmitype.xsd +52 -0
- data/lib/schema/dcterms.xsd +331 -0
- data/lib/schema/dml-chart.xsd +1499 -0
- data/lib/schema/dml-chartDrawing.xsd +146 -0
- data/lib/schema/dml-compatibility.xsd +14 -0
- data/lib/schema/dml-diagram.xsd +1091 -0
- data/lib/schema/dml-lockedCanvas.xsd +11 -0
- data/lib/schema/dml-main.xsd +3048 -0
- data/lib/schema/dml-picture.xsd +23 -0
- data/lib/schema/dml-spreadsheetDrawing.xsd +185 -0
- data/lib/schema/dml-wordprocessingDrawing.xsd +185 -0
- data/lib/schema/opc-contentTypes.xsd +42 -0
- data/lib/schema/opc-coreProperties.xsd +54 -0
- data/lib/schema/opc-digSig.xsd +49 -0
- data/lib/schema/opc-relationships.xsd +33 -0
- data/lib/schema/pml.xsd +1676 -0
- data/lib/schema/shared-additionalCharacteristics.xsd +28 -0
- data/lib/schema/shared-bibliography.xsd +144 -0
- data/lib/schema/shared-commonSimpleTypes.xsd +166 -0
- data/lib/schema/shared-customXmlDataProperties.xsd +25 -0
- data/lib/schema/shared-customXmlSchemaProperties.xsd +18 -0
- data/lib/schema/shared-documentPropertiesCustom.xsd +59 -0
- data/lib/schema/shared-documentPropertiesExtended.xsd +56 -0
- data/lib/schema/shared-documentPropertiesVariantTypes.xsd +195 -0
- data/lib/schema/shared-math.xsd +582 -0
- data/lib/schema/shared-relationshipReference.xsd +25 -0
- data/lib/schema/sml.xsd +4434 -0
- data/lib/schema/vml-main.xsd +569 -0
- data/lib/schema/vml-officeDrawing.xsd +509 -0
- data/lib/schema/vml-presentationDrawing.xsd +12 -0
- data/lib/schema/vml-spreadsheetDrawing.xsd +108 -0
- data/lib/schema/vml-wordprocessingDrawing.xsd +96 -0
- data/lib/schema/wml.xsd +3644 -0
- data/lib/schema/xml.xsd +116 -0
- data/test/benchmark.rb +72 -0
- data/test/content_type/tc_content_type.rb +76 -0
- data/test/content_type/tc_default.rb +16 -0
- data/test/content_type/tc_override.rb +14 -0
- data/test/doc_props/tc_app.rb +43 -0
- data/test/doc_props/tc_core.rb +42 -0
- data/test/drawing/tc_axes.rb +8 -0
- data/test/drawing/tc_axis.rb +85 -0
- data/test/drawing/tc_bar_3D_chart.rb +71 -0
- data/test/drawing/tc_bar_series.rb +37 -0
- data/test/drawing/tc_cat_axis.rb +31 -0
- data/test/drawing/tc_cat_axis_data.rb +27 -0
- data/test/drawing/tc_chart.rb +110 -0
- data/test/drawing/tc_d_lbls.rb +57 -0
- data/test/drawing/tc_data_source.rb +17 -0
- data/test/drawing/tc_drawing.rb +80 -0
- data/test/drawing/tc_graphic_frame.rb +27 -0
- data/test/drawing/tc_hyperlink.rb +64 -0
- data/test/drawing/tc_line_3d_chart.rb +47 -0
- data/test/drawing/tc_line_chart.rb +39 -0
- data/test/drawing/tc_line_series.rb +30 -0
- data/test/drawing/tc_marker.rb +44 -0
- data/test/drawing/tc_named_axis_data.rb +27 -0
- data/test/drawing/tc_num_data.rb +31 -0
- data/test/drawing/tc_num_val.rb +29 -0
- data/test/drawing/tc_one_cell_anchor.rb +66 -0
- data/test/drawing/tc_pic.rb +107 -0
- data/test/drawing/tc_picture_locking.rb +72 -0
- data/test/drawing/tc_pie_3D_chart.rb +28 -0
- data/test/drawing/tc_pie_series.rb +32 -0
- data/test/drawing/tc_scaling.rb +36 -0
- data/test/drawing/tc_scatter_chart.rb +48 -0
- data/test/drawing/tc_scatter_series.rb +21 -0
- data/test/drawing/tc_ser_axis.rb +31 -0
- data/test/drawing/tc_series.rb +23 -0
- data/test/drawing/tc_series_title.rb +33 -0
- data/test/drawing/tc_str_data.rb +18 -0
- data/test/drawing/tc_str_val.rb +21 -0
- data/test/drawing/tc_title.rb +49 -0
- data/test/drawing/tc_two_cell_anchor.rb +36 -0
- data/test/drawing/tc_val_axis.rb +24 -0
- data/test/drawing/tc_view_3D.rb +54 -0
- data/test/drawing/tc_vml_drawing.rb +25 -0
- data/test/drawing/tc_vml_shape.rb +106 -0
- data/test/profile.rb +24 -0
- data/test/rels/tc_relationship.rb +44 -0
- data/test/rels/tc_relationships.rb +37 -0
- data/test/stylesheet/tc_border.rb +37 -0
- data/test/stylesheet/tc_border_pr.rb +32 -0
- data/test/stylesheet/tc_cell_alignment.rb +81 -0
- data/test/stylesheet/tc_cell_protection.rb +29 -0
- data/test/stylesheet/tc_cell_style.rb +57 -0
- data/test/stylesheet/tc_color.rb +43 -0
- data/test/stylesheet/tc_dxf.rb +81 -0
- data/test/stylesheet/tc_fill.rb +18 -0
- data/test/stylesheet/tc_font.rb +121 -0
- data/test/stylesheet/tc_gradient_fill.rb +72 -0
- data/test/stylesheet/tc_gradient_stop.rb +31 -0
- data/test/stylesheet/tc_num_fmt.rb +30 -0
- data/test/stylesheet/tc_pattern_fill.rb +43 -0
- data/test/stylesheet/tc_styles.rb +235 -0
- data/test/stylesheet/tc_table_style.rb +44 -0
- data/test/stylesheet/tc_table_style_element.rb +45 -0
- data/test/stylesheet/tc_table_styles.rb +29 -0
- data/test/stylesheet/tc_xf.rb +120 -0
- data/test/tc_axlsx.rb +72 -0
- data/test/tc_helper.rb +10 -0
- data/test/tc_package.rb +227 -0
- data/test/util/tc_serialized_attributes.rb +19 -0
- data/test/util/tc_simple_typed_list.rb +78 -0
- data/test/util/tc_validators.rb +186 -0
- data/test/workbook/tc_defined_name.rb +41 -0
- data/test/workbook/tc_shared_strings_table.rb +44 -0
- data/test/workbook/tc_workbook.rb +125 -0
- data/test/workbook/worksheet/auto_filter/tc_auto_filter.rb +38 -0
- data/test/workbook/worksheet/auto_filter/tc_filter_column.rb +76 -0
- data/test/workbook/worksheet/auto_filter/tc_filters.rb +50 -0
- data/test/workbook/worksheet/tc_break.rb +49 -0
- data/test/workbook/worksheet/tc_cell.rb +319 -0
- data/test/workbook/worksheet/tc_cfvo.rb +31 -0
- data/test/workbook/worksheet/tc_col.rb +78 -0
- data/test/workbook/worksheet/tc_color_scale.rb +58 -0
- data/test/workbook/worksheet/tc_comment.rb +72 -0
- data/test/workbook/worksheet/tc_comments.rb +57 -0
- data/test/workbook/worksheet/tc_conditional_formatting.rb +224 -0
- data/test/workbook/worksheet/tc_data_bar.rb +46 -0
- data/test/workbook/worksheet/tc_data_validation.rb +265 -0
- data/test/workbook/worksheet/tc_date_time_converter.rb +124 -0
- data/test/workbook/worksheet/tc_header_footer.rb +151 -0
- data/test/workbook/worksheet/tc_icon_set.rb +45 -0
- data/test/workbook/worksheet/tc_page_margins.rb +97 -0
- data/test/workbook/worksheet/tc_page_set_up_pr.rb +15 -0
- data/test/workbook/worksheet/tc_page_setup.rb +143 -0
- data/test/workbook/worksheet/tc_pane.rb +54 -0
- data/test/workbook/worksheet/tc_pivot_table.rb +120 -0
- data/test/workbook/worksheet/tc_pivot_table_cache_definition.rb +54 -0
- data/test/workbook/worksheet/tc_print_options.rb +72 -0
- data/test/workbook/worksheet/tc_protected_range.rb +17 -0
- data/test/workbook/worksheet/tc_row.rb +117 -0
- data/test/workbook/worksheet/tc_selection.rb +55 -0
- data/test/workbook/worksheet/tc_sheet_calc_pr.rb +18 -0
- data/test/workbook/worksheet/tc_sheet_format_pr.rb +88 -0
- data/test/workbook/worksheet/tc_sheet_pr.rb +27 -0
- data/test/workbook/worksheet/tc_sheet_protection.rb +117 -0
- data/test/workbook/worksheet/tc_sheet_view.rb +214 -0
- data/test/workbook/worksheet/tc_table.rb +68 -0
- data/test/workbook/worksheet/tc_table_style_info.rb +53 -0
- data/test/workbook/worksheet/tc_worksheet.rb +538 -0
- data/test/workbook/worksheet/tc_worksheet_hyperlink.rb +55 -0
- metadata +546 -0
@@ -0,0 +1,24 @@
|
|
1
|
+
module Axlsx
|
2
|
+
|
3
|
+
# A simple, self serializing class for storing pivot tables
|
4
|
+
class PivotTables < SimpleTypedList
|
5
|
+
|
6
|
+
# creates a new Tables object
|
7
|
+
def initialize(worksheet)
|
8
|
+
raise ArgumentError, "you must provide a worksheet" unless worksheet.is_a?(Worksheet)
|
9
|
+
super PivotTable
|
10
|
+
@worksheet = worksheet
|
11
|
+
end
|
12
|
+
|
13
|
+
# The worksheet that owns this collection of pivot tables
|
14
|
+
# @return [Worksheet]
|
15
|
+
attr_reader :worksheet
|
16
|
+
|
17
|
+
# returns the relationships required by this collection
|
18
|
+
def relationships
|
19
|
+
return [] if empty?
|
20
|
+
map{ |pivot_table| Relationship.new(pivot_table, PIVOT_TABLE_R, "../#{pivot_table.pn}") }
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
end
|
@@ -0,0 +1,41 @@
|
|
1
|
+
module Axlsx
|
2
|
+
# Options for printing a worksheet. All options are boolean and false by default.
|
3
|
+
#
|
4
|
+
# @note The recommended way to manage print options is via Worksheet#print_options
|
5
|
+
# @see Worksheet#print_options
|
6
|
+
# @see Worksheet#initialize
|
7
|
+
class PrintOptions
|
8
|
+
|
9
|
+
include Axlsx::OptionsParser
|
10
|
+
include Axlsx::SerializedAttributes
|
11
|
+
include Axlsx::Accessors
|
12
|
+
# Creates a new PrintOptions object
|
13
|
+
# @option options [Boolean] grid_lines Whether grid lines should be printed
|
14
|
+
# @option options [Boolean] headings Whether row and column headings should be printed
|
15
|
+
# @option options [Boolean] horizontal_centered Whether the content should be centered horizontally
|
16
|
+
# @option options [Boolean] vertical_centered Whether the content should be centered vertically
|
17
|
+
def initialize(options = {})
|
18
|
+
@grid_lines = @headings = @horizontal_centered = @vertical_centered = false
|
19
|
+
set(options)
|
20
|
+
end
|
21
|
+
|
22
|
+
serializable_attributes :grid_lines, :headings, :horizontal_centered, :vertical_centered
|
23
|
+
boolean_attr_accessor :grid_lines, :headings, :horizontal_centered, :vertical_centered
|
24
|
+
|
25
|
+
# Set some or all options at once.
|
26
|
+
# @param [Hash] options The options to set (possible keys are :grid_lines, :headings, :horizontal_centered, and :vertical_centered).
|
27
|
+
def set(options)
|
28
|
+
parse_options options
|
29
|
+
end
|
30
|
+
|
31
|
+
# Serializes the page options element.
|
32
|
+
# @note As all attributes default to "false" according to the xml schema definition, the generated xml includes only those attributes that are set to true.
|
33
|
+
# @param [String] str
|
34
|
+
# @return [String]
|
35
|
+
def to_xml_string(str = '')
|
36
|
+
str << '<printOptions '
|
37
|
+
serialized_attributes str
|
38
|
+
str << '/>'
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
@@ -0,0 +1,49 @@
|
|
1
|
+
module Axlsx
|
2
|
+
# The Protected Range class represents a set of cells in the worksheet
|
3
|
+
# @note the recommended way to manage protected ranges with via Worksheet#protect_range
|
4
|
+
# @see Worksheet#protect_range
|
5
|
+
class ProtectedRange
|
6
|
+
|
7
|
+
include Axlsx::OptionsParser
|
8
|
+
include Axlsx::SerializedAttributes
|
9
|
+
|
10
|
+
# Initializes a new protected range object
|
11
|
+
# @option [String] sqref The cell range reference to protect. This can be an absolute or a relateve range however, it only applies to the current sheet.
|
12
|
+
# @option [String] name An optional name for the protected name.
|
13
|
+
def initialize(options={})
|
14
|
+
parse_options options
|
15
|
+
yield self if block_given?
|
16
|
+
end
|
17
|
+
|
18
|
+
serializable_attributes :sqref, :name
|
19
|
+
# The reference for the protected range
|
20
|
+
# @return [String]
|
21
|
+
attr_reader :sqref
|
22
|
+
|
23
|
+
# The name of the protected range
|
24
|
+
# @return [String]
|
25
|
+
attr_reader :name
|
26
|
+
|
27
|
+
# @see sqref
|
28
|
+
def sqref=(v)
|
29
|
+
Axlsx.validate_string(v)
|
30
|
+
@sqref = v
|
31
|
+
end
|
32
|
+
|
33
|
+
# @see name
|
34
|
+
def name=(v)
|
35
|
+
Axlsx.validate_string(v)
|
36
|
+
@name = v
|
37
|
+
end
|
38
|
+
|
39
|
+
# serializes the proteted range
|
40
|
+
# @param [String] str if this string object is provided we append
|
41
|
+
# our output to that object. Use this - it helps limit the number of
|
42
|
+
# objects created during serialization
|
43
|
+
def to_xml_string(str="")
|
44
|
+
str << '<protectedRange '
|
45
|
+
serialized_attributes str
|
46
|
+
str << '/>'
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,34 @@
|
|
1
|
+
module Axlsx
|
2
|
+
|
3
|
+
# A self serializing collection of ranges that should be protected in
|
4
|
+
# the worksheet
|
5
|
+
class ProtectedRanges < SimpleTypedList
|
6
|
+
|
7
|
+
attr_reader :worksheet
|
8
|
+
|
9
|
+
def initialize(worksheet)
|
10
|
+
raise ArgumentError, 'You must provide a worksheet' unless worksheet.is_a?(Worksheet)
|
11
|
+
super ProtectedRange
|
12
|
+
@worksheet = worksheet
|
13
|
+
end
|
14
|
+
|
15
|
+
# Adds a protected range
|
16
|
+
# @param [Array|String] cells A string range reference or array of cells that will be protected
|
17
|
+
def add_range(cells)
|
18
|
+
sqref = if cells.is_a?(String)
|
19
|
+
cells
|
20
|
+
elsif cells.is_a?(SimpleTypedList) || cells.is_a?(Array)
|
21
|
+
Axlsx::cell_range(cells, false)
|
22
|
+
end
|
23
|
+
@list << ProtectedRange.new(:sqref => sqref, :name => "Range#{size}")
|
24
|
+
last
|
25
|
+
end
|
26
|
+
|
27
|
+
def to_xml_string(str = '')
|
28
|
+
return if empty?
|
29
|
+
str << '<protectedRanges>'
|
30
|
+
each { |range| range.to_xml_string(str) }
|
31
|
+
str << '</protectedRanges>'
|
32
|
+
end
|
33
|
+
end
|
34
|
+
end
|
@@ -0,0 +1,172 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
module Axlsx
|
3
|
+
# A Row is a single row in a worksheet.
|
4
|
+
# @note The recommended way to manage rows and cells is to use Worksheet#add_row
|
5
|
+
# @see Worksheet#add_row
|
6
|
+
class Row
|
7
|
+
|
8
|
+
include SerializedAttributes
|
9
|
+
include Accessors
|
10
|
+
# No support is provided for the following attributes
|
11
|
+
# spans
|
12
|
+
# thickTop
|
13
|
+
# thickBottom
|
14
|
+
|
15
|
+
# Creates a new row. New Cell objects are created based on the values, types and style options.
|
16
|
+
# A new cell is created for each item in the values array. style and types options are applied as follows:
|
17
|
+
# If the types option is defined and is a symbol it is applied to all the cells created.
|
18
|
+
# If the types option is an array, cell types are applied by index for each cell
|
19
|
+
# If the types option is not set, the cell will automatically determine its type.
|
20
|
+
# If the style option is defined and is an Integer, it is applied to all cells created.
|
21
|
+
# If the style option is an array, style is applied by index for each cell.
|
22
|
+
# If the style option is not defined, the default style (0) is applied to each cell.
|
23
|
+
# @param [Worksheet] worksheet
|
24
|
+
# @option options [Array] values
|
25
|
+
# @option options [Array, Symbol] types
|
26
|
+
# @option options [Array, Integer] style
|
27
|
+
# @option options [Float] height the row's height (in points)
|
28
|
+
# @see Row#array_to_cells
|
29
|
+
# @see Cell
|
30
|
+
def initialize(worksheet, values=[], options={})
|
31
|
+
@ht = nil
|
32
|
+
self.worksheet = worksheet
|
33
|
+
@cells = SimpleTypedList.new Cell
|
34
|
+
@worksheet.rows << self
|
35
|
+
self.height = options.delete(:height) if options[:height]
|
36
|
+
array_to_cells(values, options)
|
37
|
+
end
|
38
|
+
|
39
|
+
# A list of serializable attributes.
|
40
|
+
serializable_attributes :hidden, :outline_level, :collapsed, :custom_format, :s, :ph, :custom_height, :ht
|
41
|
+
|
42
|
+
# Boolean row attribute accessors
|
43
|
+
boolean_attr_accessor :hidden, :collapsed, :custom_format, :ph, :custom_height
|
44
|
+
|
45
|
+
# The worksheet this row belongs to
|
46
|
+
# @return [Worksheet]
|
47
|
+
attr_reader :worksheet
|
48
|
+
|
49
|
+
# The cells this row holds
|
50
|
+
# @return [SimpleTypedList]
|
51
|
+
attr_reader :cells
|
52
|
+
|
53
|
+
# Row height measured in point size. There is no margin padding on row height.
|
54
|
+
# @return [Float]
|
55
|
+
def height
|
56
|
+
@ht
|
57
|
+
end
|
58
|
+
|
59
|
+
# Outlining level of the row, when outlining is on
|
60
|
+
# @return [Integer]
|
61
|
+
attr_reader :outline_level
|
62
|
+
alias :outlineLevel :outline_level
|
63
|
+
|
64
|
+
# The style applied ot the row. This affects the entire row.
|
65
|
+
# @return [Integer]
|
66
|
+
attr_reader :s
|
67
|
+
|
68
|
+
# @see Row#s
|
69
|
+
def s=(v)
|
70
|
+
Axlsx.validate_unsigned_numeric(v)
|
71
|
+
@custom_format = true
|
72
|
+
@s = v
|
73
|
+
end
|
74
|
+
|
75
|
+
# @see Row#outline
|
76
|
+
def outline_level=(v)
|
77
|
+
Axlsx.validate_unsigned_numeric(v)
|
78
|
+
@outline_level = v
|
79
|
+
end
|
80
|
+
alias :outlineLevel= :outline_level=
|
81
|
+
|
82
|
+
# The index of this row in the worksheet
|
83
|
+
# @return [Integer]
|
84
|
+
def index
|
85
|
+
worksheet.rows.index(self)
|
86
|
+
end
|
87
|
+
|
88
|
+
# Serializes the row
|
89
|
+
# @param [Integer] r_index The row index, 0 based.
|
90
|
+
# @param [String] str The string this rows xml will be appended to.
|
91
|
+
# @return [String]
|
92
|
+
def to_xml_string(r_index, str = '')
|
93
|
+
str << '<row '
|
94
|
+
serialized_attributes(str, { :r => r_index + 1 })
|
95
|
+
str << '>'
|
96
|
+
@cells.each_with_index { |cell, c_index| cell.to_xml_string(r_index, c_index, str) }
|
97
|
+
str << '</row>'
|
98
|
+
end
|
99
|
+
|
100
|
+
# Adds a single sell to the row based on the data provided and updates the worksheet's autofit data.
|
101
|
+
# @return [Cell]
|
102
|
+
def add_cell(value="", options={})
|
103
|
+
c = Cell.new(self, value, options)
|
104
|
+
worksheet.send(:update_column_info, self.cells, [])
|
105
|
+
c
|
106
|
+
end
|
107
|
+
|
108
|
+
# sets the style for every cell in this row
|
109
|
+
def style=(style)
|
110
|
+
cells.each_with_index do | cell, index |
|
111
|
+
s = style.is_a?(Array) ? style[index] : style
|
112
|
+
cell.style = s
|
113
|
+
end
|
114
|
+
end
|
115
|
+
|
116
|
+
# returns the cells in this row as an array
|
117
|
+
# This lets us transpose the rows into columns
|
118
|
+
# @return [Array]
|
119
|
+
def to_ary
|
120
|
+
@cells.to_ary
|
121
|
+
end
|
122
|
+
|
123
|
+
# @see height
|
124
|
+
def height=(v)
|
125
|
+
Axlsx::validate_unsigned_numeric(v)
|
126
|
+
unless v.nil?
|
127
|
+
@ht = v
|
128
|
+
@custom_height = true
|
129
|
+
end
|
130
|
+
@ht
|
131
|
+
end
|
132
|
+
|
133
|
+
private
|
134
|
+
|
135
|
+
# assigns the owning worksheet for this row
|
136
|
+
def worksheet=(v) DataTypeValidator.validate "Row.worksheet", Worksheet, v; @worksheet=v; end
|
137
|
+
|
138
|
+
# Converts values, types, and style options into cells and associates them with this row.
|
139
|
+
# A new cell is created for each item in the values array.
|
140
|
+
# If value option is defined and is a symbol it is applied to all the cells created.
|
141
|
+
# If the value option is an array, cell types are applied by index for each cell
|
142
|
+
# If the style option is defined and is an Integer, it is applied to all cells created.
|
143
|
+
# If the style option is an array, style is applied by index for each cell.
|
144
|
+
# @option options [Array] values
|
145
|
+
# @option options [Array, Symbol] types
|
146
|
+
# @option options [Array, Integer] style
|
147
|
+
def array_to_cells(values, options={})
|
148
|
+
values = values
|
149
|
+
DataTypeValidator.validate 'Row.array_to_cells', Array, values
|
150
|
+
types, style, formula_values = options.delete(:types), options.delete(:style), options.delete(:formula_values)
|
151
|
+
values.each_with_index do |value, index|
|
152
|
+
|
153
|
+
#WTF IS THIS PAP?
|
154
|
+
cell_style = style.is_a?(Array) ? style[index] : style
|
155
|
+
options[:style] = cell_style if cell_style
|
156
|
+
|
157
|
+
cell_type = types.is_a?(Array)? types[index] : types
|
158
|
+
options[:type] = cell_type if cell_type
|
159
|
+
|
160
|
+
formula_value = formula_values[index] if formula_values.is_a?(Array)
|
161
|
+
options[:formula_value] = formula_value if formula_value
|
162
|
+
|
163
|
+
Cell.new(self, value, options)
|
164
|
+
|
165
|
+
options.delete(:style)
|
166
|
+
options.delete(:type)
|
167
|
+
options.delete(:formula_value)
|
168
|
+
end
|
169
|
+
end
|
170
|
+
end
|
171
|
+
|
172
|
+
end
|
@@ -0,0 +1,33 @@
|
|
1
|
+
module Axlsx
|
2
|
+
|
3
|
+
# A collection of break objects that define row breaks (page breaks) for printing and preview
|
4
|
+
|
5
|
+
class RowBreaks < SimpleTypedList
|
6
|
+
|
7
|
+
def initialize
|
8
|
+
super Break
|
9
|
+
end
|
10
|
+
|
11
|
+
# Adds a row break
|
12
|
+
# @param [Hash] options The options for the break to be created.
|
13
|
+
# max and man values are fixed.
|
14
|
+
# @see Break
|
15
|
+
def add_break(options)
|
16
|
+
# force feed the excel default
|
17
|
+
@list << Break.new(options.merge(:max => 16383, :man => true))
|
18
|
+
last
|
19
|
+
end
|
20
|
+
|
21
|
+
# <rowBreaks count="3" manualBreakCount="3">
|
22
|
+
# <brk id="1" max="16383" man="1"/>
|
23
|
+
# <brk id="7" max="16383" man="1"/>
|
24
|
+
# <brk id="13" max="16383" man="1"/>
|
25
|
+
# </rowBreaks>
|
26
|
+
def to_xml_string(str='')
|
27
|
+
return if empty?
|
28
|
+
str << '<rowBreaks count="' << @list.size.to_s << '" manualBreakCount="' << @list.size.to_s << '">'
|
29
|
+
each { |brk| brk.to_xml_string(str) }
|
30
|
+
str << '</rowBreaks>'
|
31
|
+
end
|
32
|
+
end
|
33
|
+
end
|
@@ -0,0 +1,103 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
module Axlsx
|
3
|
+
# Selection options for worksheet panes.
|
4
|
+
#
|
5
|
+
# @note The recommended way to manage the selection pane options is via SheetView#add_selection
|
6
|
+
# @see SheetView#add_selection
|
7
|
+
class Selection
|
8
|
+
|
9
|
+
include Axlsx::OptionsParser
|
10
|
+
include Axlsx::SerializedAttributes
|
11
|
+
|
12
|
+
# Creates a new {Selection} object
|
13
|
+
# @option options [Cell, String] active_cell Active Cell Location
|
14
|
+
# @option options [Integer] active_cell_id Active Cell Index
|
15
|
+
# @option options [Symbol] pane Pane
|
16
|
+
# @option options [String] sqref Sequence of References
|
17
|
+
def initialize(options={})
|
18
|
+
@active_cell = @active_cell_id = @pane = @sqref = nil
|
19
|
+
parse_options options
|
20
|
+
end
|
21
|
+
|
22
|
+
serializable_attributes :active_cell, :active_cell_id, :pane, :sqref
|
23
|
+
# Active Cell Location
|
24
|
+
# Location of the active cell.
|
25
|
+
# @see type
|
26
|
+
# @return [String]
|
27
|
+
# default nil
|
28
|
+
attr_reader :active_cell
|
29
|
+
|
30
|
+
# Active Cell Index
|
31
|
+
# 0-based index of the range reference (in the array of references listed in sqref)
|
32
|
+
# containing the active cell. Only used when the selection in sqref is not contiguous.
|
33
|
+
# Therefore, this value needs to be aware of the order in which the range references are
|
34
|
+
# written in sqref.
|
35
|
+
# When this value is out of range then activeCell can be used.
|
36
|
+
# @see type
|
37
|
+
# @return [Integer]
|
38
|
+
# default nil
|
39
|
+
attr_reader :active_cell_id
|
40
|
+
|
41
|
+
# Pane
|
42
|
+
# The pane to which this selection belongs.
|
43
|
+
# Options are
|
44
|
+
# * bottom_left: Bottom left pane, when both vertical and horizontal
|
45
|
+
# splits are applied. This value is also used when only
|
46
|
+
# a horizontal split has been applied, dividing the pane
|
47
|
+
# into upper and lower regions. In that case, this value
|
48
|
+
# specifies the bottom pane.
|
49
|
+
# * bottom_right: Bottom right pane, when both vertical and horizontal
|
50
|
+
# splits are applied.
|
51
|
+
# * top_left: Top left pane, when both vertical and horizontal splits
|
52
|
+
# are applied. This value is also used when only a horizontal
|
53
|
+
# split has been applied, dividing the pane into upper and lower
|
54
|
+
# regions. In that case, this value specifies the top pane.
|
55
|
+
# This value is also used when only a vertical split has
|
56
|
+
# been applied, dividing the pane into right and left
|
57
|
+
# regions. In that case, this value specifies the left pane
|
58
|
+
# * top_right: Top right pane, when both vertical and horizontal
|
59
|
+
# splits are applied. This value is also used when only
|
60
|
+
# a vertical split has been applied, dividing the pane
|
61
|
+
# into right and left regions. In that case, this value
|
62
|
+
# specifies the right pane.
|
63
|
+
# @see type
|
64
|
+
# @return [Symbol]
|
65
|
+
# default nil
|
66
|
+
attr_reader :pane
|
67
|
+
|
68
|
+
# Sequence of References
|
69
|
+
# Range of the selection. Can be non-contiguous set of ranges.
|
70
|
+
# @see type
|
71
|
+
# @return [String]
|
72
|
+
# default nil
|
73
|
+
attr_reader :sqref
|
74
|
+
|
75
|
+
# @see active_cell
|
76
|
+
def active_cell=(v)
|
77
|
+
cell = (v.class == Axlsx::Cell ? v.r_abs : v)
|
78
|
+
Axlsx::validate_string(cell)
|
79
|
+
@active_cell = cell
|
80
|
+
end
|
81
|
+
|
82
|
+
# @see active_cell_id
|
83
|
+
def active_cell_id=(v); Axlsx::validate_unsigned_int(v); @active_cell_id = v end
|
84
|
+
|
85
|
+
# @see pane
|
86
|
+
def pane=(v)
|
87
|
+
Axlsx::validate_pane_type(v)
|
88
|
+
@pane = Axlsx::camel(v, false)
|
89
|
+
end
|
90
|
+
|
91
|
+
# @see sqref
|
92
|
+
def sqref=(v); Axlsx::validate_string(v); @sqref = v end
|
93
|
+
|
94
|
+
# Serializes the data validation
|
95
|
+
# @param [String] str
|
96
|
+
# @return [String]
|
97
|
+
def to_xml_string(str = '')
|
98
|
+
str << '<selection '
|
99
|
+
serialized_attributes str
|
100
|
+
str << '/>'
|
101
|
+
end
|
102
|
+
end
|
103
|
+
end
|