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,94 @@
|
|
1
|
+
module Axlsx
|
2
|
+
# The filterColumn collection identifies a particular column in the AutoFilter
|
3
|
+
# range and specifies filter information that has been applied to this column.
|
4
|
+
# If a column in the AutoFilter range has no criteria specified,
|
5
|
+
# then there is no corresponding filterColumn collection expressed for that column.
|
6
|
+
class FilterColumn
|
7
|
+
|
8
|
+
include Axlsx::OptionsParser
|
9
|
+
include Axlsx::SerializedAttributes
|
10
|
+
|
11
|
+
# Creates a new FilterColumn object
|
12
|
+
# @note This class yeilds its filter object as that is where the vast majority of processing will be done
|
13
|
+
# @param [Integer|Cell] col_id The zero based index for the column to which this filter will be applied
|
14
|
+
# @param [Symbol] filter_type The symbolized class name of the filter to apply to this column.
|
15
|
+
# @param [Hash] options options for this object and the filter
|
16
|
+
# @option [Boolean] hidden_button @see hidden_button
|
17
|
+
# @option [Boolean] show_button @see show_button
|
18
|
+
def initialize(col_id, filter_type, options = {})
|
19
|
+
RestrictionValidator.validate 'FilterColumn.filter', FILTERS, filter_type
|
20
|
+
#Axlsx::validate_unsigned_int(col_id)
|
21
|
+
self.col_id = col_id
|
22
|
+
parse_options options
|
23
|
+
@filter = Axlsx.const_get(Axlsx.camel(filter_type)).new(options)
|
24
|
+
yield @filter if block_given?
|
25
|
+
end
|
26
|
+
|
27
|
+
serializable_attributes :col_id, :hidden_button, :show_button
|
28
|
+
|
29
|
+
# Allowed filters
|
30
|
+
FILTERS = [:filters] #, :top10, :custom_filters, :dynamic_filters, :color_filters, :icon_filters]
|
31
|
+
|
32
|
+
# Zero-based index indicating the AutoFilter column to which this filter information applies.
|
33
|
+
# @return [Integer]
|
34
|
+
attr_reader :col_id
|
35
|
+
|
36
|
+
# The actual filter being dealt with here
|
37
|
+
# This could be any one of the allowed filter types
|
38
|
+
attr_reader :filter
|
39
|
+
|
40
|
+
# Flag indicating whether the filter button is visible.
|
41
|
+
# When the cell containing the filter button is merged with another cell,
|
42
|
+
# the filter button can be hidden, and not drawn.
|
43
|
+
# @return [Boolean]
|
44
|
+
def show_button
|
45
|
+
@show_button ||= true
|
46
|
+
end
|
47
|
+
|
48
|
+
# Flag indicating whether the AutoFilter button for this column is hidden.
|
49
|
+
# @return [Boolean]
|
50
|
+
def hidden_button
|
51
|
+
@hidden_button ||= false
|
52
|
+
end
|
53
|
+
|
54
|
+
# Sets the col_id attribute for this filter column.
|
55
|
+
# @param [Integer | Cell] column_index The zero based index of the column to which this filter applies.
|
56
|
+
# When you specify a cell, the column index will be read off the cell
|
57
|
+
# @return [Integer]
|
58
|
+
def col_id=(column_index)
|
59
|
+
column_index = column_index.col if column_index.is_a?(Cell)
|
60
|
+
Axlsx.validate_unsigned_int column_index
|
61
|
+
@col_id = column_index
|
62
|
+
end
|
63
|
+
|
64
|
+
# Apply the filters for this column
|
65
|
+
# @param [Array] row A row from a worksheet that needs to be
|
66
|
+
# filtered.
|
67
|
+
def apply(row, offset)
|
68
|
+
row.hidden = @filter.apply(row.cells[offset+col_id.to_i])
|
69
|
+
end
|
70
|
+
# @param [Boolean] hidden Flag indicating whether the AutoFilter button for this column is hidden.
|
71
|
+
# @return [Boolean]
|
72
|
+
def hidden_button=(hidden)
|
73
|
+
Axlsx.validate_boolean hidden
|
74
|
+
@hidden_button = hidden
|
75
|
+
end
|
76
|
+
|
77
|
+
# Flag indicating whether the AutoFilter button is show. This is
|
78
|
+
# undocumented in the spec, but exists in the schema file as an
|
79
|
+
# optional attribute.
|
80
|
+
# @param [Boolean] show Show or hide the button
|
81
|
+
# @return [Boolean]
|
82
|
+
def show_button=(show)
|
83
|
+
Axlsx.validate_boolean show
|
84
|
+
@show_botton = show
|
85
|
+
end
|
86
|
+
|
87
|
+
# Serialize the object to xml
|
88
|
+
def to_xml_string(str='')
|
89
|
+
str << "<filterColumn #{serialized_attributes}>"
|
90
|
+
@filter.to_xml_string(str)
|
91
|
+
str << "</filterColumn>"
|
92
|
+
end
|
93
|
+
end
|
94
|
+
end
|
@@ -0,0 +1,246 @@
|
|
1
|
+
module Axlsx
|
2
|
+
|
3
|
+
# When multiple values are chosen to filter by, or when a group of date values are chosen to filter by,
|
4
|
+
# this object groups those criteria together.
|
5
|
+
class Filters
|
6
|
+
include Axlsx::OptionsParser
|
7
|
+
include Axlsx::SerializedAttributes
|
8
|
+
|
9
|
+
# Creates a new Filters object
|
10
|
+
# @param [Hash] options Options used to set this objects attributes and
|
11
|
+
# create filter and/or date group items
|
12
|
+
# @option [Boolean] blank @see blank
|
13
|
+
# @option [String] calendar_type @see calendar_type
|
14
|
+
# @option [Array] filter_items An array of values that will be used to create filter objects.
|
15
|
+
# @option [Array] date_group_items An array of hases defining date group item filters to apply.
|
16
|
+
# @note The recommended way to interact with filter objects is via AutoFilter#add_column
|
17
|
+
# @example
|
18
|
+
# ws.auto_filter.add_column(0, :filters, :blank => true, :calendar_type => 'japan', :filter_items => [100, 'a'])
|
19
|
+
def initialize(options={})
|
20
|
+
parse_options options
|
21
|
+
end
|
22
|
+
|
23
|
+
serializable_attributes :blank, :calendar_type
|
24
|
+
|
25
|
+
# Allowed calendar types
|
26
|
+
CALENDAR_TYPES = %w(gregorian gregorianUs gregorianMeFrench gregorianArabic hijri hebrew taiwan japan thai korea saka gregorianXlitEnglish gregorianXlitFrench none)
|
27
|
+
|
28
|
+
# Flag indicating whether to filter by blank.
|
29
|
+
# @return [Boolean]
|
30
|
+
attr_reader :blank
|
31
|
+
|
32
|
+
# Calendar type for date grouped items.
|
33
|
+
# Used to interpret the values in dateGroupItem.
|
34
|
+
# This is the calendar type used to evaluate all dates in the filter column,
|
35
|
+
# even when those dates are not using the same calendar system / date formatting.
|
36
|
+
attr_reader :calendar_type
|
37
|
+
|
38
|
+
# Tells us if the row of the cell provided should be filterd as it
|
39
|
+
# does not meet any of the specified filter_items or
|
40
|
+
# date_group_items restrictions.
|
41
|
+
# @param [Cell] cell The cell to test against items
|
42
|
+
# TODO implement this for date filters as well!
|
43
|
+
def apply(cell)
|
44
|
+
return false unless cell
|
45
|
+
filter_items.each do |filter|
|
46
|
+
return false if cell.value == filter.val
|
47
|
+
end
|
48
|
+
true
|
49
|
+
end
|
50
|
+
|
51
|
+
# The filter values in this filters object
|
52
|
+
def filter_items
|
53
|
+
@filter_items ||= []
|
54
|
+
end
|
55
|
+
|
56
|
+
# the date group values in this filters object
|
57
|
+
def date_group_items
|
58
|
+
@date_group_items ||= []
|
59
|
+
end
|
60
|
+
|
61
|
+
# @see calendar_type
|
62
|
+
# @param [String] calendar The calendar type to use. This must be one of the types defined in CALENDAR_TYPES
|
63
|
+
# @return [String]
|
64
|
+
def calendar_type=(calendar)
|
65
|
+
RestrictionValidator.validate 'Filters.calendar_type', CALENDAR_TYPES, calendar
|
66
|
+
@calendar_type = calendar
|
67
|
+
end
|
68
|
+
|
69
|
+
# Set the value for blank
|
70
|
+
# @see blank
|
71
|
+
def blank=(use_blank)
|
72
|
+
Axlsx.validate_boolean use_blank
|
73
|
+
@blank = use_blank
|
74
|
+
end
|
75
|
+
|
76
|
+
# Serialize the object to xml
|
77
|
+
def to_xml_string(str = '')
|
78
|
+
str << "<filters #{serialized_attributes}>"
|
79
|
+
filter_items.each { |filter| filter.to_xml_string(str) }
|
80
|
+
date_group_items.each { |date_group_item| date_group_item.to_xml_string(str) }
|
81
|
+
str << '</filters>'
|
82
|
+
end
|
83
|
+
|
84
|
+
# not entirely happy with this.
|
85
|
+
# filter_items should be a simple typed list that overrides << etc
|
86
|
+
# to create Filter objects from the inserted values. However this
|
87
|
+
# is most likely so rarely used...(really? do you know that?)
|
88
|
+
def filter_items=(values)
|
89
|
+
values.each do |value|
|
90
|
+
filter_items << Filter.new(value)
|
91
|
+
end
|
92
|
+
end
|
93
|
+
|
94
|
+
# Date group items are date group filter items where you specify the
|
95
|
+
# date_group and a value for that option as part of the auto_filter
|
96
|
+
# @note This can be specified, but will not be applied to the date
|
97
|
+
# values in your workbook at this time.
|
98
|
+
def date_group_items=(options)
|
99
|
+
options.each do |date_group|
|
100
|
+
raise ArgumentError, "date_group_items should be an array of hashes specifying the options for each date_group_item" unless date_group.is_a?(Hash)
|
101
|
+
date_group_items << DateGroupItem.new(date_group)
|
102
|
+
end
|
103
|
+
end
|
104
|
+
|
105
|
+
# This class expresses a filter criteria value.
|
106
|
+
class Filter
|
107
|
+
|
108
|
+
# Creates a new filter value object
|
109
|
+
# @param [Any] value The value of the filter. This is not restricted, but
|
110
|
+
# will be serialized via to_s so if you are passing an object
|
111
|
+
# be careful.
|
112
|
+
def initialize(value)
|
113
|
+
@val = value
|
114
|
+
end
|
115
|
+
|
116
|
+
|
117
|
+
#Filter value used in the criteria.
|
118
|
+
attr_accessor :val
|
119
|
+
|
120
|
+
# Serializes the filter value object
|
121
|
+
# @param [String] str The string to concact the serialization information to.
|
122
|
+
def to_xml_string(str = '')
|
123
|
+
str << "<filter val='#{@val.to_s}' />"
|
124
|
+
end
|
125
|
+
end
|
126
|
+
|
127
|
+
|
128
|
+
# This collection is used to express a group of dates or times which are
|
129
|
+
# used in an AutoFilter criteria. Values are always written in the calendar
|
130
|
+
# type of the first date encountered in the filter range, so that all
|
131
|
+
# subsequent dates, even when formatted or represented by other calendar
|
132
|
+
# types, can be correctly compared for the purposes of filtering.
|
133
|
+
class DateGroupItem
|
134
|
+
include Axlsx::OptionsParser
|
135
|
+
include Axlsx::SerializedAttributes
|
136
|
+
|
137
|
+
# Creates a new DateGroupItem
|
138
|
+
# @param [Hash] options A hash of options to use when
|
139
|
+
# instanciating the object
|
140
|
+
# @option [String] date_time_grouping the part of the date this
|
141
|
+
# filter should apply for grouping
|
142
|
+
# @option [Integer|String] year @see year
|
143
|
+
# @option [Integer] month @see month
|
144
|
+
# @option [Integer] day @see day
|
145
|
+
# @option [Integer] hour @see hour
|
146
|
+
# @option [Integer] minute @see minute
|
147
|
+
# @option [Integer] second @see second
|
148
|
+
def initialize(options={})
|
149
|
+
raise ArgumentError, "You must specify a year for date time grouping" unless options[:year]
|
150
|
+
raise ArgumentError, "You must specify a date_time_grouping when creating a DateGroupItem for auto filter" unless options[:date_time_grouping]
|
151
|
+
parse_options options
|
152
|
+
end
|
153
|
+
|
154
|
+
serializable_attributes :date_time_grouping, :year, :month, :day, :hour, :minute, :second
|
155
|
+
|
156
|
+
# Allowed date time groupings
|
157
|
+
DATE_TIME_GROUPING = %w(year month day hour minute second)
|
158
|
+
|
159
|
+
# Grouping level
|
160
|
+
# This must be one of year, month, day, hour, minute or second.
|
161
|
+
# @return [String]
|
162
|
+
attr_reader :date_time_grouping
|
163
|
+
|
164
|
+
# Year (4 digits)
|
165
|
+
# @return [Integer|String]
|
166
|
+
attr_reader :year
|
167
|
+
|
168
|
+
# Month (1..12)
|
169
|
+
# @return [Integer]
|
170
|
+
attr_reader :month
|
171
|
+
|
172
|
+
# Day (1-31)
|
173
|
+
# @return [Integer]
|
174
|
+
attr_reader :day
|
175
|
+
|
176
|
+
# Hour (0..23)
|
177
|
+
# @return [Integer]
|
178
|
+
attr_reader :hour
|
179
|
+
|
180
|
+
# Minute (0..59(
|
181
|
+
# @return [Integer]
|
182
|
+
attr_reader :minute
|
183
|
+
|
184
|
+
# Second (0..59)
|
185
|
+
# @return [Integer]
|
186
|
+
attr_reader :second
|
187
|
+
|
188
|
+
# The year value for the date group item
|
189
|
+
# This must be a four digit value
|
190
|
+
def year=(value)
|
191
|
+
RegexValidator.validate "DateGroupItem.year", /\d{4}/, value
|
192
|
+
@year = value
|
193
|
+
end
|
194
|
+
|
195
|
+
# The month value for the date group item
|
196
|
+
# This must be between 1 and 12
|
197
|
+
def month=(value)
|
198
|
+
RangeValidator.validate "DateGroupItem.month", 0, 12, value
|
199
|
+
@month = value
|
200
|
+
end
|
201
|
+
|
202
|
+
# The day value for the date group item
|
203
|
+
# This must be between 1 and 31
|
204
|
+
# @note no attempt is made to ensure the date value is valid for any given month
|
205
|
+
def day=(value)
|
206
|
+
RangeValidator.validate "DateGroupItem.day", 0, 31, value
|
207
|
+
@day = value
|
208
|
+
end
|
209
|
+
|
210
|
+
# The hour value for the date group item
|
211
|
+
# # this must be between 0 and 23
|
212
|
+
def hour=(value)
|
213
|
+
RangeValidator.validate "DateGroupItem.hour", 0, 23, value
|
214
|
+
@hour = value
|
215
|
+
end
|
216
|
+
|
217
|
+
# The minute value for the date group item
|
218
|
+
# This must be between 0 and 59
|
219
|
+
def minute=(value)
|
220
|
+
RangeValidator.validate "DateGroupItem.minute", 0, 59, value
|
221
|
+
@minute = value
|
222
|
+
end
|
223
|
+
|
224
|
+
# The second value for the date group item
|
225
|
+
# This must be between 0 and 59
|
226
|
+
def second=(value)
|
227
|
+
RangeValidator.validate "DateGroupItem.second", 0, 59, value
|
228
|
+
@second = value
|
229
|
+
end
|
230
|
+
|
231
|
+
# The date time grouping for this filter.
|
232
|
+
def date_time_grouping=(grouping)
|
233
|
+
RestrictionValidator.validate 'DateGroupItem.date_time_grouping', DATE_TIME_GROUPING, grouping.to_s
|
234
|
+
@date_time_grouping = grouping.to_s
|
235
|
+
end
|
236
|
+
|
237
|
+
# Serialize the object to xml
|
238
|
+
# @param [String] str The string object this serialization will be concatenated to.
|
239
|
+
def to_xml_string(str = '')
|
240
|
+
str << '<dateGroupItem '
|
241
|
+
serialized_attributes str
|
242
|
+
str << '/>'
|
243
|
+
end
|
244
|
+
end
|
245
|
+
end
|
246
|
+
end
|
@@ -0,0 +1,37 @@
|
|
1
|
+
module Axlsx
|
2
|
+
|
3
|
+
# The Break class stores the details for row and column page breaks.
|
4
|
+
# @see RowBreaks, ColBreaks
|
5
|
+
class Break
|
6
|
+
|
7
|
+
include Axlsx::OptionsParser
|
8
|
+
include Axlsx::Accessors
|
9
|
+
include Axlsx::SerializedAttributes
|
10
|
+
|
11
|
+
# Creates a new Break object
|
12
|
+
# @param options A hash of attribute options for this break.
|
13
|
+
# @option options [Integer] id Zero-based row or column Id of the page break. Breaks occur above the specified row and left of the specified column.
|
14
|
+
# @option options [Integer] min Zero-based index of start row or column of the break. For row breaks, specifies column index; for column breaks, specifies row index.
|
15
|
+
# @option options [Integer] max Zero-based index of end row or column of the break. For row breaks, specifies column index; for column breaks, specifies row index.
|
16
|
+
# @option options [Boolean] man Manual Break flag. 1 means the break is a manually inserted break.
|
17
|
+
# @option option [Boolean] pt Flag indicating that a PivotTable created this break.
|
18
|
+
def initialize(options={})
|
19
|
+
parse_options options
|
20
|
+
yield self if block_given?
|
21
|
+
end
|
22
|
+
|
23
|
+
unsigned_int_attr_accessor :id, :min, :max
|
24
|
+
|
25
|
+
boolean_attr_accessor :man, :pt
|
26
|
+
|
27
|
+
serializable_attributes :id, :min, :max, :man, :pt
|
28
|
+
|
29
|
+
# serializes the break to xml
|
30
|
+
def to_xml_string(str='')
|
31
|
+
str << '<brk '
|
32
|
+
serialized_attributes str
|
33
|
+
str << '></brk>'
|
34
|
+
end
|
35
|
+
end
|
36
|
+
end
|
37
|
+
|
@@ -0,0 +1,416 @@
|
|
1
|
+
# encoding: UTF-8
|
2
|
+
require 'cgi'
|
3
|
+
module Axlsx
|
4
|
+
# A cell in a worksheet.
|
5
|
+
# Cell stores inforamation requried to serialize a single worksheet cell to xml. You must provde the Row that the cell belongs to and the cells value. The data type will automatically be determed if you do not specify the :type option. The default style will be applied if you do not supply the :style option. Changing the cell's type will recast the value to the type specified. Altering the cell's value via the property accessor will also automatically cast the provided value to the cell's type.
|
6
|
+
# @note The recommended way to generate cells is via Worksheet#add_row
|
7
|
+
#
|
8
|
+
# @see Worksheet#add_row
|
9
|
+
class Cell
|
10
|
+
|
11
|
+
include Axlsx::OptionsParser
|
12
|
+
|
13
|
+
# @param [Row] row The row this cell belongs to.
|
14
|
+
# @param [Any] value The value associated with this cell.
|
15
|
+
# @option options [Symbol] type The intended data type for this cell. If not specified the data type will be determined internally based on the vlue provided.
|
16
|
+
# @option options [Integer] style The index of the cellXfs item to be applied to this cell. If not specified, the default style (0) will be applied.
|
17
|
+
# @option options [String] font_name
|
18
|
+
# @option options [Integer] charset
|
19
|
+
# @option options [String] family
|
20
|
+
# @option options [Boolean] b
|
21
|
+
# @option options [Boolean] i
|
22
|
+
# @option options [Boolean] strike
|
23
|
+
# @option options [Boolean] outline
|
24
|
+
# @option options [Boolean] shadow
|
25
|
+
# @option options [Boolean] condense
|
26
|
+
# @option options [Boolean] extend
|
27
|
+
# @option options [Boolean] u
|
28
|
+
# @option options [Symbol] vertAlign must be one of :baseline, :subscript, :superscript
|
29
|
+
# @option options [Integer] sz
|
30
|
+
# @option options [String] color an 8 letter rgb specification
|
31
|
+
# @option options [Number] formula_value The value to cache for a formula cell.
|
32
|
+
# @option options [Symbol] scheme must be one of :none, major, :minor
|
33
|
+
def initialize(row, value="", options={})
|
34
|
+
self.row=row
|
35
|
+
@value = nil
|
36
|
+
#@value = @font_name = @charset = @family = @b = @i = @strike = @outline = @shadow = nil
|
37
|
+
#@formula_value = @condense = @u = @vertAlign = @sz = @color = @scheme = @extend = @ssti = nil
|
38
|
+
@styles = row.worksheet.workbook.styles
|
39
|
+
@row.cells << self
|
40
|
+
parse_options options
|
41
|
+
@style ||= 0
|
42
|
+
@type ||= cell_type_from_value(value)
|
43
|
+
@value = cast_value(value)
|
44
|
+
end
|
45
|
+
|
46
|
+
# this is the cached value for formula cells. If you want the values to render in iOS/Mac OSX preview
|
47
|
+
# you need to set this.
|
48
|
+
attr_accessor :formula_value
|
49
|
+
|
50
|
+
# An array of available inline styes.
|
51
|
+
# TODO change this to a hash where each key defines attr name and validator (and any info the validator requires)
|
52
|
+
# then move it out to a module so we can re-use in in other classes.
|
53
|
+
# needs to define bla=(v) and bla methods on the class that hook into a
|
54
|
+
# set_attr method that kicks the suplied validator and updates the instance_variable
|
55
|
+
# for the key
|
56
|
+
INLINE_STYLES = ['value', 'type', 'font_name', 'charset',
|
57
|
+
'family', 'b', 'i', 'strike','outline',
|
58
|
+
'shadow', 'condense', 'extend', 'u',
|
59
|
+
'vertAlign', 'sz', 'color', 'scheme']
|
60
|
+
|
61
|
+
# The index of the cellXfs item to be applied to this cell.
|
62
|
+
# @return [Integer]
|
63
|
+
# @see Axlsx::Styles
|
64
|
+
attr_reader :style
|
65
|
+
|
66
|
+
# The row this cell belongs to.
|
67
|
+
# @return [Row]
|
68
|
+
attr_reader :row
|
69
|
+
|
70
|
+
# The cell's data type. Currently only six types are supported, :date, :time, :float, :integer, :string and :boolean.
|
71
|
+
# Changing the type for a cell will recast the value into that type. If no type option is specified in the constructor, the type is
|
72
|
+
# automatically determed.
|
73
|
+
# @see Cell#cell_type_from_value
|
74
|
+
# @return [Symbol] The type of data this cell's value is cast to.
|
75
|
+
# @raise [ArgumentExeption] Cell.type must be one of [:date, time, :float, :integer, :string, :boolean]
|
76
|
+
# @note
|
77
|
+
# If the value provided cannot be cast into the type specified, type is changed to :string and the following logic is applied.
|
78
|
+
# :string to :integer or :float, type conversions always return 0 or 0.0
|
79
|
+
# :string, :integer, or :float to :time conversions always return the original value as a string and set the cells type to :string.
|
80
|
+
# No support is currently implemented for parsing time strings.
|
81
|
+
attr_reader :type
|
82
|
+
# @see type
|
83
|
+
def type=(v)
|
84
|
+
RestrictionValidator.validate "Cell.type", [:date, :time, :float, :integer, :string, :boolean, :iso_8601], v
|
85
|
+
@type=v
|
86
|
+
self.value = @value unless @value.nil?
|
87
|
+
end
|
88
|
+
|
89
|
+
|
90
|
+
# The value of this cell.
|
91
|
+
# @return [String, Integer, Float, Time, Boolean] casted value based on cell's type attribute.
|
92
|
+
attr_reader :value
|
93
|
+
# @see value
|
94
|
+
def value=(v)
|
95
|
+
#TODO: consider doing value based type determination first?
|
96
|
+
@value = cast_value(v)
|
97
|
+
end
|
98
|
+
|
99
|
+
# Indicates that the cell has one or more of the custom cell styles applied.
|
100
|
+
# @return [Boolean]
|
101
|
+
def is_text_run?
|
102
|
+
@is_text_run ||= false
|
103
|
+
end
|
104
|
+
|
105
|
+
# Indicates if the cell is good for shared string table
|
106
|
+
def plain_string?
|
107
|
+
@type == :string && # String typed
|
108
|
+
!is_text_run? && # No inline styles
|
109
|
+
!@value.nil? && # Not nil
|
110
|
+
!@value.empty? && # Not empty
|
111
|
+
!@value.start_with?('=') # Not a formula
|
112
|
+
end
|
113
|
+
|
114
|
+
# The inline font_name property for the cell
|
115
|
+
# @return [String]
|
116
|
+
attr_reader :font_name
|
117
|
+
# @see font_name
|
118
|
+
def font_name=(v) set_run_style :validate_string, :font_name, v; end
|
119
|
+
|
120
|
+
# The inline charset property for the cell
|
121
|
+
# As far as I can tell, this is pretty much ignored. However, based on the spec it should be one of the following:
|
122
|
+
# 0  ANSI_CHARSET
|
123
|
+
# 1 DEFAULT_CHARSET
|
124
|
+
# 2 SYMBOL_CHARSET
|
125
|
+
# 77 MAC_CHARSET
|
126
|
+
# 128 SHIFTJIS_CHARSET
|
127
|
+
# 129  HANGUL_CHARSET
|
128
|
+
# 130  JOHAB_CHARSET
|
129
|
+
# 134  GB2312_CHARSET
|
130
|
+
# 136  CHINESEBIG5_CHARSET
|
131
|
+
# 161  GREEK_CHARSET
|
132
|
+
# 162  TURKISH_CHARSET
|
133
|
+
# 163  VIETNAMESE_CHARSET
|
134
|
+
# 177  HEBREW_CHARSET
|
135
|
+
# 178  ARABIC_CHARSET
|
136
|
+
# 186  BALTIC_CHARSET
|
137
|
+
# 204  RUSSIAN_CHARSET
|
138
|
+
# 222  THAI_CHARSET
|
139
|
+
# 238  EASTEUROPE_CHARSET
|
140
|
+
# 255  OEM_CHARSET
|
141
|
+
# @return [String]
|
142
|
+
attr_reader :charset
|
143
|
+
# @see charset
|
144
|
+
def charset=(v) set_run_style :validate_unsigned_int, :charset, v; end
|
145
|
+
|
146
|
+
# The inline family property for the cell
|
147
|
+
# @return [Integer]
|
148
|
+
# 1 Roman
|
149
|
+
# 2 Swiss
|
150
|
+
# 3 Modern
|
151
|
+
# 4 Script
|
152
|
+
# 5 Decorative
|
153
|
+
attr_reader :family
|
154
|
+
# @see family
|
155
|
+
def family=(v)
|
156
|
+
set_run_style :validate_family, :family, v.to_i
|
157
|
+
end
|
158
|
+
|
159
|
+
# The inline bold property for the cell
|
160
|
+
# @return [Boolean]
|
161
|
+
attr_reader :b
|
162
|
+
# @see b
|
163
|
+
def b=(v) set_run_style :validate_boolean, :b, v; end
|
164
|
+
|
165
|
+
# The inline italic property for the cell
|
166
|
+
# @return [Boolean]
|
167
|
+
attr_reader :i
|
168
|
+
# @see i
|
169
|
+
def i=(v) set_run_style :validate_boolean, :i, v; end
|
170
|
+
|
171
|
+
# The inline strike property for the cell
|
172
|
+
# @return [Boolean]
|
173
|
+
attr_reader :strike
|
174
|
+
# @see strike
|
175
|
+
def strike=(v) set_run_style :validate_boolean, :strike, v; end
|
176
|
+
|
177
|
+
# The inline outline property for the cell
|
178
|
+
# @return [Boolean]
|
179
|
+
attr_reader :outline
|
180
|
+
# @see outline
|
181
|
+
def outline=(v) set_run_style :validate_boolean, :outline, v; end
|
182
|
+
|
183
|
+
# The inline shadow property for the cell
|
184
|
+
# @return [Boolean]
|
185
|
+
attr_reader :shadow
|
186
|
+
# @see shadow
|
187
|
+
def shadow=(v) set_run_style :validate_boolean, :shadow, v; end
|
188
|
+
|
189
|
+
# The inline condense property for the cell
|
190
|
+
# @return [Boolean]
|
191
|
+
attr_reader :condense
|
192
|
+
# @see condense
|
193
|
+
def condense=(v) set_run_style :validate_boolean, :condense, v; end
|
194
|
+
|
195
|
+
# The inline extend property for the cell
|
196
|
+
# @return [Boolean]
|
197
|
+
attr_reader :extend
|
198
|
+
# @see extend
|
199
|
+
def extend=(v) set_run_style :validate_boolean, :extend, v; end
|
200
|
+
|
201
|
+
# The inline underline property for the cell.
|
202
|
+
# It must be one of :none, :single, :double, :singleAccounting, :doubleAccounting, true
|
203
|
+
# @return [Boolean]
|
204
|
+
# @return [String]
|
205
|
+
# @note true is for backwards compatability and is reassigned to :single
|
206
|
+
attr_reader :u
|
207
|
+
# @see u
|
208
|
+
def u=(v)
|
209
|
+
v = :single if (v == true || v == 1 || v == :true || v == 'true')
|
210
|
+
set_run_style :validate_cell_u, :u, v
|
211
|
+
end
|
212
|
+
|
213
|
+
# The inline color property for the cell
|
214
|
+
# @return [Color]
|
215
|
+
attr_reader :color
|
216
|
+
# @param [String] v The 8 character representation for an rgb color #FFFFFFFF"
|
217
|
+
def color=(v)
|
218
|
+
@color = v.is_a?(Color) ? v : Color.new(:rgb=>v)
|
219
|
+
@is_text_run = true
|
220
|
+
end
|
221
|
+
|
222
|
+
# The inline sz property for the cell
|
223
|
+
# @return [Inteter]
|
224
|
+
attr_reader :sz
|
225
|
+
# @see sz
|
226
|
+
def sz=(v) set_run_style :validate_unsigned_int, :sz, v; end
|
227
|
+
|
228
|
+
# The inline vertical alignment property for the cell
|
229
|
+
# this must be one of [:baseline, :subscript, :superscript]
|
230
|
+
# @return [Symbol]
|
231
|
+
attr_reader :vertAlign
|
232
|
+
# @see vertAlign
|
233
|
+
def vertAlign=(v)
|
234
|
+
RestrictionValidator.validate "Cell.vertAlign", [:baseline, :subscript, :superscript], v
|
235
|
+
set_run_style nil, :vertAlign, v
|
236
|
+
end
|
237
|
+
|
238
|
+
# The inline scheme property for the cell
|
239
|
+
# this must be one of [:none, major, minor]
|
240
|
+
# @return [Symbol]
|
241
|
+
attr_reader :scheme
|
242
|
+
# @see scheme
|
243
|
+
def scheme=(v)
|
244
|
+
RestrictionValidator.validate "Cell.schema", [:none, :major, :minor], v
|
245
|
+
set_run_style nil, :scheme, v
|
246
|
+
end
|
247
|
+
|
248
|
+
# The Shared Strings Table index for this cell
|
249
|
+
# @return [Integer]
|
250
|
+
attr_reader :ssti
|
251
|
+
|
252
|
+
# @return [Integer] The index of the cell in the containing row.
|
253
|
+
def index
|
254
|
+
@row.cells.index(self)
|
255
|
+
end
|
256
|
+
|
257
|
+
# @return [String] The alpha(column)numeric(row) reference for this sell.
|
258
|
+
# @example Relative Cell Reference
|
259
|
+
# ws.rows.first.cells.first.r #=> "A1"
|
260
|
+
def r
|
261
|
+
Axlsx::cell_r index, @row.index
|
262
|
+
end
|
263
|
+
|
264
|
+
# @return [String] The absolute alpha(column)numeric(row) reference for this sell.
|
265
|
+
# @example Absolute Cell Reference
|
266
|
+
# ws.rows.first.cells.first.r #=> "$A$1"
|
267
|
+
def r_abs
|
268
|
+
"$#{r.match(%r{([A-Z]+)([0-9]+)})[1,2].join('$')}"
|
269
|
+
end
|
270
|
+
|
271
|
+
# @return [Integer] The cellXfs item index applied to this cell.
|
272
|
+
# @raise [ArgumentError] Invalid cellXfs id if the value provided is not within cellXfs items range.
|
273
|
+
def style=(v)
|
274
|
+
Axlsx::validate_unsigned_int(v)
|
275
|
+
count = @styles.cellXfs.size
|
276
|
+
raise ArgumentError, "Invalid cellXfs id" unless v < count
|
277
|
+
@style = v
|
278
|
+
end
|
279
|
+
|
280
|
+
# @return [Array] of x/y coordinates in the cheet for this cell.
|
281
|
+
def pos
|
282
|
+
[index, row.index]
|
283
|
+
end
|
284
|
+
|
285
|
+
# Merges all the cells in a range created between this cell and the cell or string name for a cell provided
|
286
|
+
# @see worksheet.merge_cells
|
287
|
+
# @param [Cell, String] target The last cell, or str ref for the cell in the merge range
|
288
|
+
def merge(target)
|
289
|
+
range_end = if target.is_a?(String)
|
290
|
+
target
|
291
|
+
elsif(target.is_a?(Cell))
|
292
|
+
target.r
|
293
|
+
end
|
294
|
+
self.row.worksheet.merge_cells "#{self.r}:#{range_end}" unless range_end.nil?
|
295
|
+
end
|
296
|
+
|
297
|
+
# Serializes the cell
|
298
|
+
# @param [Integer] r_index The row index for the cell
|
299
|
+
# @param [Integer] c_index The cell index in the row.
|
300
|
+
# @param [String] str The string index the cell content will be appended to. Defaults to empty string.
|
301
|
+
# @return [String] xml text for the cell
|
302
|
+
def to_xml_string(r_index, c_index, str = '')
|
303
|
+
CellSerializer.to_xml_string r_index, c_index, self, str
|
304
|
+
end
|
305
|
+
|
306
|
+
def is_formula?
|
307
|
+
@type == :string && @value.to_s.start_with?('=')
|
308
|
+
end
|
309
|
+
|
310
|
+
# This is still not perfect...
|
311
|
+
# - scaling is not linear as font sizes increst
|
312
|
+
# - different fonts have different mdw and char widths
|
313
|
+
def autowidth
|
314
|
+
return if is_formula? || value == nil
|
315
|
+
mdw = 1.78 #This is the widest width of 0..9 in arial@10px)
|
316
|
+
font_scale = (font_size/10.0).to_f
|
317
|
+
((value.to_s.count(Worksheet.thin_chars) * mdw + 5) / mdw * 256) / 256.0 * font_scale
|
318
|
+
end
|
319
|
+
|
320
|
+
# returns the absolute or relative string style reference for
|
321
|
+
# this cell.
|
322
|
+
# @param [Boolean] absolute -when false a relative reference will be
|
323
|
+
# returned.
|
324
|
+
# @return [String]
|
325
|
+
def reference(absolute=true)
|
326
|
+
absolute ? r_abs : r
|
327
|
+
end
|
328
|
+
|
329
|
+
private
|
330
|
+
|
331
|
+
# we scale the font size if bold style is applied to either the style font or
|
332
|
+
# the cell itself. Yes, it is a bit of a hack, but it is much better than using
|
333
|
+
# imagemagick and loading metrics for every character.
|
334
|
+
def font_size
|
335
|
+
font = @styles.fonts[@styles.cellXfs[style].fontId] || @styles.fonts[0]
|
336
|
+
size_from_styles = (font.b || b) ? font.sz * 1.5 : font.sz
|
337
|
+
sz || size_from_styles
|
338
|
+
end
|
339
|
+
|
340
|
+
# Utility method for setting inline style attributes
|
341
|
+
def set_run_style( validator, attr, value)
|
342
|
+
return unless INLINE_STYLES.include?(attr.to_s)
|
343
|
+
Axlsx.send(validator, value) unless validator == nil
|
344
|
+
self.instance_variable_set :"@#{attr.to_s}", value
|
345
|
+
@is_text_run = true
|
346
|
+
end
|
347
|
+
|
348
|
+
# @see ssti
|
349
|
+
def ssti=(v)
|
350
|
+
Axlsx::validate_unsigned_int(v)
|
351
|
+
@ssti = v
|
352
|
+
end
|
353
|
+
|
354
|
+
# assigns the owning row for this cell.
|
355
|
+
def row=(v) @row=v end
|
356
|
+
|
357
|
+
# Determines the cell type based on the cell value.
|
358
|
+
# @note This is only used when a cell is created but no :type option is specified, the following rules apply:
|
359
|
+
# 1. If the value is an instance of Date, the type is set to :date
|
360
|
+
# 2. If the value is an instance of Time, the type is set to :time
|
361
|
+
# 3. If the value is an instance of TrueClass or FalseClass, the type is set to :boolean
|
362
|
+
# 4. :float and :integer types are determined by regular expression matching.
|
363
|
+
# 5. Anything that does not meet either of the above is determined to be :string.
|
364
|
+
# @return [Symbol] The determined type
|
365
|
+
def cell_type_from_value(v)
|
366
|
+
if v.is_a?(Date)
|
367
|
+
:date
|
368
|
+
elsif v.is_a?(Time)
|
369
|
+
:time
|
370
|
+
elsif v.is_a?(TrueClass) || v.is_a?(FalseClass)
|
371
|
+
:boolean
|
372
|
+
elsif v.to_s =~ /\A[+-]?\d+?\Z/ #numeric
|
373
|
+
:integer
|
374
|
+
elsif v.to_s =~ /\A[-+]?[0-9]*\.?[0-9]+([eE][-+]?[0-9]+)?\Z/ #float
|
375
|
+
:float
|
376
|
+
# \A(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])
|
377
|
+
# T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?
|
378
|
+
# (Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?\Z
|
379
|
+
elsif v.to_s =~/\A(-?(?:[1-9][0-9]*)?[0-9]{4})-(1[0-2]|0[1-9])-(3[0-1]|0[1-9]|[1-2][0-9])T(2[0-3]|[0-1][0-9]):([0-5][0-9]):([0-5][0-9])(\.[0-9]+)?(Z|[+-](?:2[0-3]|[0-1][0-9]):[0-5][0-9])?\Z/
|
380
|
+
:iso_8601
|
381
|
+
else
|
382
|
+
:string
|
383
|
+
end
|
384
|
+
end
|
385
|
+
|
386
|
+
# Cast the value into this cells data type.
|
387
|
+
# @note
|
388
|
+
# About Time - Time in OOXML is *different* from what you might expect. The history as to why is interesting, but you can safely assume that if you are generating docs on a mac, you will want to specify Workbook.1904 as true when using time typed values.
|
389
|
+
# @see Axlsx#date1904
|
390
|
+
def cast_value(v)
|
391
|
+
return nil if v.nil?
|
392
|
+
if @type == :date
|
393
|
+
self.style = STYLE_DATE if self.style == 0
|
394
|
+
v
|
395
|
+
elsif (@type == :time && v.is_a?(Time)) || (@type == :time && v.respond_to?(:to_time))
|
396
|
+
self.style = STYLE_DATE if self.style == 0
|
397
|
+
v.respond_to?(:to_time) ? v.to_time : v
|
398
|
+
elsif @type == :float
|
399
|
+
v.to_f
|
400
|
+
elsif @type == :integer
|
401
|
+
v.to_i
|
402
|
+
elsif @type == :boolean
|
403
|
+
v ? 1 : 0
|
404
|
+
elsif @type == :iso_8601
|
405
|
+
#consumer is responsible for ensuring the iso_8601 format when specifying this type
|
406
|
+
v
|
407
|
+
else
|
408
|
+
@type = :string
|
409
|
+
# TODO find a better way to do this as it accounts for 30% of
|
410
|
+
# processing time in benchmarking...
|
411
|
+
Axlsx::trust_input ? v.to_s : ::CGI.escapeHTML(v.to_s)
|
412
|
+
end
|
413
|
+
end
|
414
|
+
|
415
|
+
end
|
416
|
+
end
|