caxlsx 3.2.0 → 3.4.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.yardopts +9 -9
- data/.yardopts_guide +18 -18
- data/CHANGELOG.md +394 -354
- data/LICENSE +21 -21
- data/README.md +184 -168
- data/Rakefile +28 -29
- data/examples/generate.rb +15 -15
- data/lib/axlsx/content_type/abstract_content_type.rb +29 -32
- data/lib/axlsx/content_type/content_type.rb +22 -26
- data/lib/axlsx/content_type/default.rb +21 -25
- data/lib/axlsx/content_type/override.rb +21 -25
- data/lib/axlsx/doc_props/app.rb +230 -235
- data/lib/axlsx/doc_props/core.rb +34 -39
- data/lib/axlsx/drawing/area_chart.rb +96 -99
- data/lib/axlsx/drawing/area_series.rb +107 -110
- data/lib/axlsx/drawing/ax_data_source.rb +21 -26
- data/lib/axlsx/drawing/axes.rb +60 -61
- data/lib/axlsx/drawing/axis.rb +185 -190
- data/lib/axlsx/drawing/bar_3D_chart.rb +145 -148
- data/lib/axlsx/drawing/bar_chart.rb +135 -138
- data/lib/axlsx/drawing/bar_series.rb +91 -97
- data/lib/axlsx/drawing/bubble_chart.rb +56 -59
- data/lib/axlsx/drawing/bubble_series.rb +60 -63
- data/lib/axlsx/drawing/cat_axis.rb +80 -85
- data/lib/axlsx/drawing/chart.rb +294 -276
- data/lib/axlsx/drawing/d_lbls.rb +92 -90
- data/lib/axlsx/drawing/drawing.rb +163 -167
- data/lib/axlsx/drawing/graphic_frame.rb +51 -54
- data/lib/axlsx/drawing/hyperlink.rb +97 -100
- data/lib/axlsx/drawing/line_3D_chart.rb +64 -68
- data/lib/axlsx/drawing/line_chart.rb +96 -99
- data/lib/axlsx/drawing/line_series.rb +107 -110
- data/lib/axlsx/drawing/marker.rb +80 -84
- data/lib/axlsx/drawing/num_data.rb +47 -52
- data/lib/axlsx/drawing/num_data_source.rb +58 -62
- data/lib/axlsx/drawing/num_val.rb +31 -34
- data/lib/axlsx/drawing/one_cell_anchor.rb +97 -99
- data/lib/axlsx/drawing/pic.rb +244 -211
- data/lib/axlsx/drawing/picture_locking.rb +39 -42
- data/lib/axlsx/drawing/pie_3D_chart.rb +42 -47
- data/lib/axlsx/drawing/pie_series.rb +69 -74
- data/lib/axlsx/drawing/scaling.rb +57 -60
- data/lib/axlsx/drawing/scatter_chart.rb +71 -74
- data/lib/axlsx/drawing/scatter_series.rb +126 -129
- data/lib/axlsx/drawing/ser_axis.rb +41 -45
- data/lib/axlsx/drawing/series.rb +67 -69
- data/lib/axlsx/drawing/series_title.rb +23 -25
- data/lib/axlsx/drawing/str_data.rb +37 -42
- data/lib/axlsx/drawing/str_val.rb +31 -34
- data/lib/axlsx/drawing/title.rb +104 -97
- data/lib/axlsx/drawing/two_cell_anchor.rb +95 -97
- data/lib/axlsx/drawing/val_axis.rb +34 -37
- data/lib/axlsx/drawing/view_3D.rb +115 -115
- data/lib/axlsx/drawing/vml_drawing.rb +39 -42
- data/lib/axlsx/drawing/vml_shape.rb +63 -66
- data/lib/axlsx/package.rb +397 -388
- data/lib/axlsx/rels/relationship.rb +127 -130
- data/lib/axlsx/rels/relationships.rb +29 -32
- data/lib/axlsx/stylesheet/border.rb +70 -73
- data/lib/axlsx/stylesheet/border_pr.rb +69 -71
- data/lib/axlsx/stylesheet/cell_alignment.rb +124 -132
- data/lib/axlsx/stylesheet/cell_protection.rb +38 -41
- data/lib/axlsx/stylesheet/cell_style.rb +68 -72
- data/lib/axlsx/stylesheet/color.rb +77 -76
- data/lib/axlsx/stylesheet/dxf.rb +75 -79
- data/lib/axlsx/stylesheet/fill.rb +31 -35
- data/lib/axlsx/stylesheet/font.rb +157 -156
- data/lib/axlsx/stylesheet/gradient_fill.rb +101 -103
- data/lib/axlsx/stylesheet/gradient_stop.rb +36 -37
- data/lib/axlsx/stylesheet/num_fmt.rb +83 -86
- data/lib/axlsx/stylesheet/pattern_fill.rb +71 -73
- data/lib/axlsx/stylesheet/styles.rb +543 -494
- data/lib/axlsx/stylesheet/table_style.rb +51 -54
- data/lib/axlsx/stylesheet/table_style_element.rb +74 -77
- data/lib/axlsx/stylesheet/table_styles.rb +42 -46
- data/lib/axlsx/stylesheet/xf.rb +144 -147
- data/lib/axlsx/util/accessors.rb +62 -64
- data/lib/axlsx/util/constants.rb +414 -410
- data/lib/axlsx/util/mime_type_utils.rb +24 -11
- data/lib/axlsx/util/options_parser.rb +15 -16
- data/lib/axlsx/util/serialized_attributes.rb +88 -89
- data/lib/axlsx/util/simple_typed_list.rb +180 -179
- data/lib/axlsx/util/storage.rb +142 -146
- data/lib/axlsx/util/validators.rb +315 -312
- data/lib/axlsx/util/zip_command.rb +71 -73
- data/lib/axlsx/version.rb +4 -5
- data/lib/axlsx/workbook/defined_name.rb +129 -128
- data/lib/axlsx/workbook/defined_names.rb +20 -21
- data/lib/axlsx/workbook/shared_strings_table.rb +74 -77
- data/lib/axlsx/workbook/workbook.rb +430 -395
- data/lib/axlsx/workbook/workbook_view.rb +75 -80
- data/lib/axlsx/workbook/workbook_views.rb +20 -22
- data/lib/axlsx/workbook/worksheet/auto_filter/auto_filter.rb +78 -77
- data/lib/axlsx/workbook/worksheet/auto_filter/filter_column.rb +94 -94
- data/lib/axlsx/workbook/worksheet/auto_filter/filters.rb +243 -244
- data/lib/axlsx/workbook/worksheet/border_creator.rb +79 -0
- data/lib/axlsx/workbook/worksheet/break.rb +32 -35
- data/lib/axlsx/workbook/worksheet/cell.rb +552 -506
- data/lib/axlsx/workbook/worksheet/cell_serializer.rb +164 -164
- data/lib/axlsx/workbook/worksheet/cfvo.rb +60 -60
- data/lib/axlsx/workbook/worksheet/cfvos.rb +16 -18
- data/lib/axlsx/workbook/worksheet/col.rb +142 -145
- data/lib/axlsx/workbook/worksheet/col_breaks.rb +34 -35
- data/lib/axlsx/workbook/worksheet/color_scale.rb +108 -110
- data/lib/axlsx/workbook/worksheet/cols.rb +23 -23
- data/lib/axlsx/workbook/worksheet/comment.rb +90 -91
- data/lib/axlsx/workbook/worksheet/comments.rb +78 -82
- data/lib/axlsx/workbook/worksheet/conditional_formatting.rb +81 -82
- data/lib/axlsx/workbook/worksheet/conditional_formatting_rule.rb +216 -220
- data/lib/axlsx/workbook/worksheet/conditional_formattings.rb +23 -25
- data/lib/axlsx/workbook/worksheet/data_bar.rb +127 -129
- data/lib/axlsx/workbook/worksheet/data_validation.rb +266 -246
- data/lib/axlsx/workbook/worksheet/data_validations.rb +25 -28
- data/lib/axlsx/workbook/worksheet/date_time_converter.rb +28 -30
- data/lib/axlsx/workbook/worksheet/dimension.rb +65 -64
- data/lib/axlsx/workbook/worksheet/header_footer.rb +51 -52
- data/lib/axlsx/workbook/worksheet/icon_set.rb +80 -81
- data/lib/axlsx/workbook/worksheet/merged_cells.rb +37 -37
- data/lib/axlsx/workbook/worksheet/outline_pr.rb +32 -33
- data/lib/axlsx/workbook/worksheet/page_margins.rb +97 -97
- data/lib/axlsx/workbook/worksheet/page_set_up_pr.rb +42 -44
- data/lib/axlsx/workbook/worksheet/page_setup.rb +237 -240
- data/lib/axlsx/workbook/worksheet/pane.rb +138 -139
- data/lib/axlsx/workbook/worksheet/pivot_table.rb +332 -296
- data/lib/axlsx/workbook/worksheet/pivot_table_cache_definition.rb +63 -66
- data/lib/axlsx/workbook/worksheet/pivot_tables.rb +23 -24
- data/lib/axlsx/workbook/worksheet/print_options.rb +38 -39
- data/lib/axlsx/workbook/worksheet/protected_range.rb +46 -47
- data/lib/axlsx/workbook/worksheet/protected_ranges.rb +37 -37
- data/lib/axlsx/workbook/worksheet/rich_text.rb +53 -55
- data/lib/axlsx/workbook/worksheet/rich_text_run.rb +266 -250
- data/lib/axlsx/workbook/worksheet/row.rb +173 -164
- data/lib/axlsx/workbook/worksheet/row_breaks.rb +32 -33
- data/lib/axlsx/workbook/worksheet/selection.rb +99 -101
- data/lib/axlsx/workbook/worksheet/sheet_calc_pr.rb +28 -29
- data/lib/axlsx/workbook/worksheet/sheet_data.rb +25 -27
- data/lib/axlsx/workbook/worksheet/sheet_format_pr.rb +18 -18
- data/lib/axlsx/workbook/worksheet/sheet_pr.rb +87 -87
- data/lib/axlsx/workbook/worksheet/sheet_protection.rb +117 -118
- data/lib/axlsx/workbook/worksheet/sheet_view.rb +206 -213
- data/lib/axlsx/workbook/worksheet/table.rb +100 -102
- data/lib/axlsx/workbook/worksheet/table_style_info.rb +48 -49
- data/lib/axlsx/workbook/worksheet/tables.rb +34 -34
- data/lib/axlsx/workbook/worksheet/worksheet.rb +857 -786
- data/lib/axlsx/workbook/worksheet/worksheet_comments.rb +58 -58
- data/lib/axlsx/workbook/worksheet/worksheet_drawing.rb +59 -58
- data/lib/axlsx/workbook/worksheet/worksheet_hyperlink.rb +73 -74
- data/lib/axlsx/workbook/worksheet/worksheet_hyperlinks.rb +38 -38
- data/lib/axlsx.rb +218 -185
- data/lib/caxlsx.rb +1 -2
- data/lib/schema/dc.xsd +118 -118
- data/lib/schema/dcmitype.xsd +51 -51
- data/lib/schema/dcterms.xsd +331 -331
- data/lib/schema/dml-chartDrawing.xsd +146 -146
- data/lib/schema/dml-compatibility.xsd +14 -14
- data/lib/schema/dml-lockedCanvas.xsd +11 -11
- data/lib/schema/dml-main.xsd +3048 -3048
- data/lib/schema/dml-picture.xsd +23 -23
- data/lib/schema/dml-spreadsheetDrawing.xsd +185 -185
- data/lib/schema/dml-wordprocessingDrawing.xsd +185 -185
- data/lib/schema/shared-additionalCharacteristics.xsd +28 -28
- data/lib/schema/shared-bibliography.xsd +144 -144
- data/lib/schema/shared-commonSimpleTypes.xsd +166 -166
- data/lib/schema/shared-customXmlDataProperties.xsd +25 -25
- data/lib/schema/shared-customXmlSchemaProperties.xsd +18 -18
- data/lib/schema/shared-documentPropertiesCustom.xsd +59 -59
- data/lib/schema/shared-documentPropertiesExtended.xsd +56 -56
- data/lib/schema/shared-documentPropertiesVariantTypes.xsd +195 -195
- data/lib/schema/shared-relationshipReference.xsd +25 -25
- data/lib/schema/vml-main.xsd +569 -569
- data/lib/schema/vml-officeDrawing.xsd +509 -509
- data/lib/schema/vml-presentationDrawing.xsd +12 -12
- data/lib/schema/vml-spreadsheetDrawing.xsd +108 -108
- data/lib/schema/vml-wordprocessingDrawing.xsd +96 -96
- data/lib/schema/xml.xsd +116 -116
- metadata +5 -252
- data/test/benchmark.rb +0 -72
- data/test/content_type/tc_content_type.rb +0 -76
- data/test/content_type/tc_default.rb +0 -16
- data/test/content_type/tc_override.rb +0 -14
- data/test/doc_props/tc_app.rb +0 -43
- data/test/doc_props/tc_core.rb +0 -42
- data/test/drawing/tc_area_chart.rb +0 -39
- data/test/drawing/tc_area_series.rb +0 -71
- data/test/drawing/tc_axes.rb +0 -8
- data/test/drawing/tc_axis.rb +0 -112
- data/test/drawing/tc_bar_3D_chart.rb +0 -86
- data/test/drawing/tc_bar_chart.rb +0 -86
- data/test/drawing/tc_bar_series.rb +0 -46
- data/test/drawing/tc_bubble_chart.rb +0 -44
- data/test/drawing/tc_bubble_series.rb +0 -21
- data/test/drawing/tc_cat_axis.rb +0 -31
- data/test/drawing/tc_cat_axis_data.rb +0 -27
- data/test/drawing/tc_chart.rb +0 -123
- data/test/drawing/tc_d_lbls.rb +0 -57
- data/test/drawing/tc_data_source.rb +0 -23
- data/test/drawing/tc_drawing.rb +0 -80
- data/test/drawing/tc_graphic_frame.rb +0 -27
- data/test/drawing/tc_hyperlink.rb +0 -64
- data/test/drawing/tc_line_3d_chart.rb +0 -47
- data/test/drawing/tc_line_chart.rb +0 -39
- data/test/drawing/tc_line_series.rb +0 -71
- data/test/drawing/tc_marker.rb +0 -44
- data/test/drawing/tc_named_axis_data.rb +0 -27
- data/test/drawing/tc_num_data.rb +0 -31
- data/test/drawing/tc_num_val.rb +0 -29
- data/test/drawing/tc_one_cell_anchor.rb +0 -66
- data/test/drawing/tc_pic.rb +0 -103
- data/test/drawing/tc_picture_locking.rb +0 -72
- data/test/drawing/tc_pie_3D_chart.rb +0 -28
- data/test/drawing/tc_pie_series.rb +0 -33
- data/test/drawing/tc_scaling.rb +0 -36
- data/test/drawing/tc_scatter_chart.rb +0 -48
- data/test/drawing/tc_scatter_series.rb +0 -74
- data/test/drawing/tc_ser_axis.rb +0 -31
- data/test/drawing/tc_series.rb +0 -23
- data/test/drawing/tc_series_title.rb +0 -54
- data/test/drawing/tc_str_data.rb +0 -18
- data/test/drawing/tc_str_val.rb +0 -30
- data/test/drawing/tc_title.rb +0 -70
- data/test/drawing/tc_two_cell_anchor.rb +0 -36
- data/test/drawing/tc_val_axis.rb +0 -24
- data/test/drawing/tc_view_3D.rb +0 -54
- data/test/drawing/tc_vml_drawing.rb +0 -25
- data/test/drawing/tc_vml_shape.rb +0 -106
- data/test/fixtures/image1.gif +0 -0
- data/test/fixtures/image1.jpeg +0 -0
- data/test/fixtures/image1.jpg +0 -0
- data/test/fixtures/image1.png +0 -0
- data/test/fixtures/image1_fake.jpg +0 -0
- data/test/profile.rb +0 -24
- data/test/rels/tc_relationship.rb +0 -52
- data/test/rels/tc_relationships.rb +0 -37
- data/test/stylesheet/tc_border.rb +0 -37
- data/test/stylesheet/tc_border_pr.rb +0 -32
- data/test/stylesheet/tc_cell_alignment.rb +0 -81
- data/test/stylesheet/tc_cell_protection.rb +0 -29
- data/test/stylesheet/tc_cell_style.rb +0 -57
- data/test/stylesheet/tc_color.rb +0 -43
- data/test/stylesheet/tc_dxf.rb +0 -81
- data/test/stylesheet/tc_fill.rb +0 -18
- data/test/stylesheet/tc_font.rb +0 -133
- data/test/stylesheet/tc_gradient_fill.rb +0 -72
- data/test/stylesheet/tc_gradient_stop.rb +0 -31
- data/test/stylesheet/tc_num_fmt.rb +0 -30
- data/test/stylesheet/tc_pattern_fill.rb +0 -43
- data/test/stylesheet/tc_styles.rb +0 -309
- data/test/stylesheet/tc_table_style.rb +0 -44
- data/test/stylesheet/tc_table_style_element.rb +0 -45
- data/test/stylesheet/tc_table_styles.rb +0 -29
- data/test/stylesheet/tc_xf.rb +0 -120
- data/test/tc_axlsx.rb +0 -109
- data/test/tc_helper.rb +0 -10
- data/test/tc_package.rb +0 -317
- data/test/util/tc_mime_type_utils.rb +0 -13
- data/test/util/tc_serialized_attributes.rb +0 -19
- data/test/util/tc_simple_typed_list.rb +0 -77
- data/test/util/tc_validators.rb +0 -210
- data/test/workbook/tc_defined_name.rb +0 -49
- data/test/workbook/tc_shared_strings_table.rb +0 -59
- data/test/workbook/tc_workbook.rb +0 -165
- data/test/workbook/tc_workbook_view.rb +0 -50
- data/test/workbook/worksheet/auto_filter/tc_auto_filter.rb +0 -38
- data/test/workbook/worksheet/auto_filter/tc_filter_column.rb +0 -76
- data/test/workbook/worksheet/auto_filter/tc_filters.rb +0 -50
- data/test/workbook/worksheet/tc_break.rb +0 -49
- data/test/workbook/worksheet/tc_cell.rb +0 -465
- data/test/workbook/worksheet/tc_cfvo.rb +0 -31
- data/test/workbook/worksheet/tc_col.rb +0 -93
- data/test/workbook/worksheet/tc_color_scale.rb +0 -58
- data/test/workbook/worksheet/tc_comment.rb +0 -72
- data/test/workbook/worksheet/tc_comments.rb +0 -57
- data/test/workbook/worksheet/tc_conditional_formatting.rb +0 -224
- data/test/workbook/worksheet/tc_data_bar.rb +0 -46
- data/test/workbook/worksheet/tc_data_validation.rb +0 -265
- data/test/workbook/worksheet/tc_date_time_converter.rb +0 -124
- data/test/workbook/worksheet/tc_header_footer.rb +0 -151
- data/test/workbook/worksheet/tc_icon_set.rb +0 -45
- data/test/workbook/worksheet/tc_outline_pr.rb +0 -19
- data/test/workbook/worksheet/tc_page_margins.rb +0 -97
- data/test/workbook/worksheet/tc_page_set_up_pr.rb +0 -15
- data/test/workbook/worksheet/tc_page_setup.rb +0 -143
- data/test/workbook/worksheet/tc_pane.rb +0 -54
- data/test/workbook/worksheet/tc_pivot_table.rb +0 -180
- data/test/workbook/worksheet/tc_pivot_table_cache_definition.rb +0 -62
- data/test/workbook/worksheet/tc_print_options.rb +0 -72
- data/test/workbook/worksheet/tc_protected_range.rb +0 -17
- data/test/workbook/worksheet/tc_rich_text.rb +0 -44
- data/test/workbook/worksheet/tc_rich_text_run.rb +0 -173
- data/test/workbook/worksheet/tc_row.rb +0 -160
- data/test/workbook/worksheet/tc_selection.rb +0 -55
- data/test/workbook/worksheet/tc_sheet_calc_pr.rb +0 -18
- data/test/workbook/worksheet/tc_sheet_format_pr.rb +0 -88
- data/test/workbook/worksheet/tc_sheet_pr.rb +0 -49
- data/test/workbook/worksheet/tc_sheet_protection.rb +0 -117
- data/test/workbook/worksheet/tc_sheet_view.rb +0 -214
- data/test/workbook/worksheet/tc_table.rb +0 -77
- data/test/workbook/worksheet/tc_table_style_info.rb +0 -53
- data/test/workbook/worksheet/tc_worksheet.rb +0 -632
- data/test/workbook/worksheet/tc_worksheet_hyperlink.rb +0 -55
@@ -1,240 +1,237 @@
|
|
1
|
-
module Axlsx
|
2
|
-
# Page setup settings for printing a worksheet. All settings are optional.
|
3
|
-
#
|
4
|
-
# @note The recommended way to manage print options is via Worksheet#page_setup
|
5
|
-
# @see Worksheet#print_options
|
6
|
-
# @see Worksheet#initialize
|
7
|
-
class PageSetup
|
8
|
-
|
9
|
-
include Axlsx::
|
10
|
-
|
11
|
-
|
12
|
-
#
|
13
|
-
# @option options [Integer]
|
14
|
-
# @option options [
|
15
|
-
# @option options [
|
16
|
-
# @option options [String]
|
17
|
-
# @option options [
|
18
|
-
# @option options [Integer]
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
|
26
|
-
#
|
27
|
-
# *
|
28
|
-
# *
|
29
|
-
# *
|
30
|
-
# *
|
31
|
-
# *
|
32
|
-
# *
|
33
|
-
# *
|
34
|
-
# *
|
35
|
-
# *
|
36
|
-
# *
|
37
|
-
|
38
|
-
|
39
|
-
#
|
40
|
-
#
|
41
|
-
#
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
#
|
46
|
-
#
|
47
|
-
#
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
#
|
52
|
-
|
53
|
-
|
54
|
-
|
55
|
-
#
|
56
|
-
|
57
|
-
|
58
|
-
|
59
|
-
#
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
#
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
#
|
68
|
-
#
|
69
|
-
#
|
70
|
-
#
|
71
|
-
#
|
72
|
-
#
|
73
|
-
#
|
74
|
-
#
|
75
|
-
#
|
76
|
-
#
|
77
|
-
#
|
78
|
-
#
|
79
|
-
#
|
80
|
-
#
|
81
|
-
#
|
82
|
-
#
|
83
|
-
#
|
84
|
-
#
|
85
|
-
#
|
86
|
-
#
|
87
|
-
#
|
88
|
-
#
|
89
|
-
#
|
90
|
-
#
|
91
|
-
#
|
92
|
-
#
|
93
|
-
#
|
94
|
-
#
|
95
|
-
#
|
96
|
-
#
|
97
|
-
#
|
98
|
-
#
|
99
|
-
#
|
100
|
-
#
|
101
|
-
#
|
102
|
-
#
|
103
|
-
#
|
104
|
-
#
|
105
|
-
#
|
106
|
-
#
|
107
|
-
#
|
108
|
-
#
|
109
|
-
#
|
110
|
-
#
|
111
|
-
#
|
112
|
-
#
|
113
|
-
#
|
114
|
-
#
|
115
|
-
#
|
116
|
-
#
|
117
|
-
#
|
118
|
-
#
|
119
|
-
#
|
120
|
-
#
|
121
|
-
#
|
122
|
-
#
|
123
|
-
#
|
124
|
-
#
|
125
|
-
#
|
126
|
-
#
|
127
|
-
#
|
128
|
-
#
|
129
|
-
#
|
130
|
-
#
|
131
|
-
#
|
132
|
-
#
|
133
|
-
#
|
134
|
-
#
|
135
|
-
#
|
136
|
-
#
|
137
|
-
#
|
138
|
-
#
|
139
|
-
#
|
140
|
-
#
|
141
|
-
#
|
142
|
-
#
|
143
|
-
#
|
144
|
-
#
|
145
|
-
#
|
146
|
-
#
|
147
|
-
#
|
148
|
-
#
|
149
|
-
#
|
150
|
-
#
|
151
|
-
#
|
152
|
-
#
|
153
|
-
#
|
154
|
-
#
|
155
|
-
#
|
156
|
-
#
|
157
|
-
#
|
158
|
-
#
|
159
|
-
#
|
160
|
-
#
|
161
|
-
#
|
162
|
-
#
|
163
|
-
#
|
164
|
-
#
|
165
|
-
#
|
166
|
-
#
|
167
|
-
#
|
168
|
-
#
|
169
|
-
#
|
170
|
-
#
|
171
|
-
#
|
172
|
-
#
|
173
|
-
#
|
174
|
-
#
|
175
|
-
#
|
176
|
-
#
|
177
|
-
#
|
178
|
-
#
|
179
|
-
#
|
180
|
-
#
|
181
|
-
#
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
#
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
|
191
|
-
|
192
|
-
|
193
|
-
|
194
|
-
|
195
|
-
|
196
|
-
|
197
|
-
|
198
|
-
|
199
|
-
|
200
|
-
# @see
|
201
|
-
def
|
202
|
-
# @see
|
203
|
-
def
|
204
|
-
# @see
|
205
|
-
def
|
206
|
-
# @see
|
207
|
-
def
|
208
|
-
# @see
|
209
|
-
def
|
210
|
-
|
211
|
-
|
212
|
-
|
213
|
-
#
|
214
|
-
#
|
215
|
-
# @
|
216
|
-
|
217
|
-
|
218
|
-
|
219
|
-
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
|
238
|
-
end
|
239
|
-
end
|
240
|
-
end
|
1
|
+
module Axlsx
|
2
|
+
# Page setup settings for printing a worksheet. All settings are optional.
|
3
|
+
#
|
4
|
+
# @note The recommended way to manage print options is via Worksheet#page_setup
|
5
|
+
# @see Worksheet#print_options
|
6
|
+
# @see Worksheet#initialize
|
7
|
+
class PageSetup
|
8
|
+
include Axlsx::OptionsParser
|
9
|
+
include Axlsx::SerializedAttributes
|
10
|
+
|
11
|
+
# Creates a new PageSetup object
|
12
|
+
# @option options [Integer] fit_to_height Number of vertical pages to fit on
|
13
|
+
# @option options [Integer] fit_to_width Number of horizontal pages to fit on
|
14
|
+
# @option options [Symbol] orientation Orientation of the page (:default, :landscape, :portrait)
|
15
|
+
# @option options [String] paper_height Height of paper (number followed by unit identifier: "297mm", "11in")
|
16
|
+
# @option options [String] paper_width Width of paper (number followed by unit identifier: "210mm", "8.5in")
|
17
|
+
# @option options [Integer] scale Print scaling (percent value, integer ranging from 10 to 400)
|
18
|
+
# @option options [Integer] paper_size - the size of paper to use
|
19
|
+
def initialize(options = {})
|
20
|
+
parse_options options
|
21
|
+
end
|
22
|
+
|
23
|
+
serializable_attributes :fit_to_height, :fit_to_width, :orientation, :paper_height, :paper_width, :scale, :paper_size
|
24
|
+
|
25
|
+
# TODO: Attributes defined by Open XML spec that are not implemented yet:
|
26
|
+
# * blackAndWhite
|
27
|
+
# * cellComments
|
28
|
+
# * copies
|
29
|
+
# * draft
|
30
|
+
# * errors
|
31
|
+
# * firstPageNumber
|
32
|
+
# * horizontalDpi
|
33
|
+
# * pageOrder
|
34
|
+
# * useFirstPageNumber
|
35
|
+
# * usePrinterDefaults
|
36
|
+
# * verticalDpi
|
37
|
+
|
38
|
+
# Number of vertical pages to fit on.
|
39
|
+
# @note PageSetup#fit_to is the recomended way to manage page fitting as only specifying one of fit_to_width/fit_to_height will result in the counterpart
|
40
|
+
# being set to 1.
|
41
|
+
# @return [Integer]
|
42
|
+
attr_reader :fit_to_height
|
43
|
+
|
44
|
+
# Number of horizontal pages to fit on.
|
45
|
+
# @note PageSetup#fit_to is the recomended way to manage page fitting as only specifying one of width/height will result in the counterpart
|
46
|
+
# being set to 1.
|
47
|
+
# @return [Integer]
|
48
|
+
attr_reader :fit_to_width
|
49
|
+
|
50
|
+
# Orientation of the page (:default, :landscape, :portrait)
|
51
|
+
# @return [Symbol]
|
52
|
+
attr_reader :orientation
|
53
|
+
|
54
|
+
# Height of paper (string containing a number followed by a unit identifier: "297mm", "11in")
|
55
|
+
# @return [String]
|
56
|
+
attr_reader :paper_height
|
57
|
+
|
58
|
+
# Width of paper (string containing a number followed by a unit identifier: "210mm", "8.5in")
|
59
|
+
# @return [String]
|
60
|
+
attr_reader :paper_width
|
61
|
+
|
62
|
+
# Print scaling (percent value, given as integer ranging from 10 to 400)
|
63
|
+
# @return [Integer]
|
64
|
+
attr_reader :scale
|
65
|
+
|
66
|
+
# The paper size to use in printing
|
67
|
+
# 1 = Letter paper (8.5 in. by 11 in.)
|
68
|
+
# 2 = Letter small paper (8.5 in. by 11 in.)
|
69
|
+
# 3 = Tabloid paper (11 in. by 17 in.)
|
70
|
+
# 4 = Ledger paper (17 in. by 11 in.)
|
71
|
+
# 5 = Legal paper (8.5 in. by 14 in.)
|
72
|
+
# 6 = Statement paper (5.5 in. by 8.5 in.)
|
73
|
+
# 7 = Executive paper (7.25 in. by 10.5 in.)
|
74
|
+
# 8 = A3 paper (297 mm by 420 mm)
|
75
|
+
# 9 = A4 paper (210 mm by 297 mm)
|
76
|
+
# 10 = A4 small paper (210 mm by 297 mm)
|
77
|
+
# 11 = A5 paper (148 mm by 210 mm)
|
78
|
+
# 12 = B4 paper (250 mm by 353 mm)
|
79
|
+
# 13 = B5 paper (176 mm by 250 mm)
|
80
|
+
# 14 = Folio paper (8.5 in. by 13 in.)
|
81
|
+
# 15 = Quarto paper (215 mm by 275 mm)
|
82
|
+
# 16 = Standard paper (10 in. by 14 in.)
|
83
|
+
# 17 = Standard paper (11 in. by 17 in.)
|
84
|
+
# 18 = Note paper (8.5 in. by 11 in.)
|
85
|
+
# 19 = #9 envelope (3.875 in. by 8.875 in.)
|
86
|
+
# 20 = #10 envelope (4.125 in. by 9.5 in.)
|
87
|
+
# 21 = #11 envelope (4.5 in. by 10.375 in.)
|
88
|
+
# 22 = #12 envelope (4.75 in. by 11 in.)
|
89
|
+
# 23 = #14 envelope (5 in. by 11.5 in.) 24 = C paper (17 in. by 22 in.)
|
90
|
+
# 25 = D paper (22 in. by 34 in.)
|
91
|
+
# 26 = E paper (34 in. by 44 in.)
|
92
|
+
# 27 = DL envelope (110 mm by 220 mm)
|
93
|
+
# 28 = C5 envelope (162 mm by 229 mm)
|
94
|
+
# 29 = C3 envelope (324 mm by 458 mm)
|
95
|
+
# 30 = C4 envelope (229 mm by 324 mm)
|
96
|
+
# 31 = C6 envelope (114 mm by 162 mm)
|
97
|
+
# 32 = C65 envelope (114 mm by 229 mm)
|
98
|
+
# 33 = B4 envelope (250 mm by 353 mm)
|
99
|
+
# 34 = B5 envelope (176 mm by 250 mm)
|
100
|
+
# 35 = B6 envelope (176 mm by 125 mm)
|
101
|
+
# 36 = Italy envelope (110 mm by 230 mm)
|
102
|
+
# 37 = Monarch envelope (3.875 in. by 7.5 in.). 38 = 6 3/4 envelope (3.625 in. by 6.5 in.)
|
103
|
+
# 39 = US standard fanfold (14.875 in. by 11 in.)
|
104
|
+
# 40 = German standard fanfold (8.5 in. by 12 in.)
|
105
|
+
# 41 = German legal fanfold (8.5 in. by 13 in.)
|
106
|
+
# 42 = ISO B4 (250 mm by 353 mm)
|
107
|
+
# 43 = Japanese double postcard (200 mm by 148 mm)
|
108
|
+
# 44 = Standard paper (9 in. by 11 in.)
|
109
|
+
# 45 = Standard paper (10 in. by 11 in.)
|
110
|
+
# 46 = Standard paper (15 in. by 11 in.)
|
111
|
+
# 47 = Invite envelope (220 mm by 220 mm)
|
112
|
+
# 50 = Letter extra paper (9.275 in. by 12 in.)
|
113
|
+
# 51 = Legal extra paper (9.275 in. by 15 in.)
|
114
|
+
# 52 = Tabloid extra paper (11.69 in. by 18 in.)
|
115
|
+
# 53 = A4 extra paper (236 mm by 322 mm)
|
116
|
+
# 54 = Letter transverse paper (8.275 in. by 11 in.)
|
117
|
+
# 55 = A4 transverse paper (210 mm by 297 mm)
|
118
|
+
# 56 = Letter extra transverse paper (9.275 in. by 12 in.)
|
119
|
+
# 57 = SuperA/SuperA/A4 paper (227 mm by 356 mm)
|
120
|
+
# 58 = SuperB/SuperB/A3 paper (305 mm by 487 mm)
|
121
|
+
# 59 = Letter plus paper (8.5 in. by 12.69 in.)
|
122
|
+
# 60 = A4 plus paper (210 mm by 330 mm)
|
123
|
+
# 61 = A5 transverse paper (148 mm by 210 mm)
|
124
|
+
# 62 = JIS B5 transverse paper (182 mm by 257 mm)
|
125
|
+
# 63 = A3 extra paper (322 mm by 445 mm)
|
126
|
+
# 64 = A5 extra paper (174 mm by 235 mm)
|
127
|
+
# 65 = ISO B5 extra paper (201 mm by 276 mm)
|
128
|
+
# 66 = A2 paper (420 mm by 594 mm)
|
129
|
+
# 67 = A3 transverse paper (297 mm by 420 mm)
|
130
|
+
# 68 = A3 extra transverse paper (322 mm by 445 mm)
|
131
|
+
# 69 = Japanese Double Postcard (200 mm x 148 mm)
|
132
|
+
# 70 = A6 (105 mm x 148 mm
|
133
|
+
# 71 = Japanese Envelope Kaku #2
|
134
|
+
# 72 = Japanese Envelope Kaku #3
|
135
|
+
# 73 = Japanese Envelope Chou #3
|
136
|
+
# 74 = Japanese Envelope Chou #4
|
137
|
+
# 75 = Letter Rotated (11in x 8 1/2 11 in)
|
138
|
+
# 76 = A3 Rotated (420 mm x 297 mm)
|
139
|
+
# 77 = A4 Rotated (297 mm x 210 mm)
|
140
|
+
# 78 = A5 Rotated (210 mm x 148 mm)
|
141
|
+
# 79 = B4 (JIS) Rotated (364 mm x 257 mm)
|
142
|
+
# 80 = B5 (JIS) Rotated (257 mm x 182 mm)
|
143
|
+
# 81 = Japanese Postcard Rotated (148 mm x 100 mm)
|
144
|
+
# 82 = Double Japanese Postcard Rotated (148 mm x 200 mm)
|
145
|
+
# 83 = A6 Rotated (148 mm x 105 mm)
|
146
|
+
# 84 = Japanese Envelope Kaku #2 Rotated
|
147
|
+
# 85 = Japanese Envelope Kaku #3 Rotated
|
148
|
+
# 86 = Japanese Envelope Chou #3 Rotated
|
149
|
+
# 87 = Japanese Envelope Chou #4 Rotated
|
150
|
+
# 88 = B6 (JIS) (128 mm x 182 mm)
|
151
|
+
# 89 = B6 (JIS) Rotated (182 mm x 128 mm)
|
152
|
+
# 90 = (12 in x 11 in)
|
153
|
+
# 91 = Japanese Envelope You #4
|
154
|
+
# 92 = Japanese Envelope You #4 Rotated
|
155
|
+
# 93 = PRC 16K (146 mm x 215 mm)
|
156
|
+
# 94 = PRC 32K (97 mm x 151 mm)
|
157
|
+
# 95 = PRC 32K(Big) (97 mm x 151 mm)
|
158
|
+
# 96 = PRC Envelope #1 (102 mm x 165 mm)
|
159
|
+
# 97 = PRC Envelope #2 (102 mm x 176 mm)
|
160
|
+
# 98 = PRC Envelope #3 (125 mm x 176 mm)
|
161
|
+
# 99 = PRC Envelope #4 (110 mm x 208 mm)
|
162
|
+
# 100 = PRC Envelope #5 (110 mm x 220 mm)
|
163
|
+
# 101 = PRC Envelope #6 (120 mm x 230 mm)
|
164
|
+
# 102 = PRC Envelope #7 (160 mm x 230 mm)
|
165
|
+
# 103 = PRC Envelope #8 (120 mm x 309 mm)
|
166
|
+
# 104 = PRC Envelope #9 (229 mm x 324 mm)
|
167
|
+
# 105 = PRC Envelope #10 (324 mm x 458 mm)
|
168
|
+
# 106 = PRC 16K Rotated
|
169
|
+
# 107 = PRC 32K Rotated
|
170
|
+
# 108 = PRC 32K(Big) Rotated
|
171
|
+
# 109 = PRC Envelope #1 Rotated (165 mm x 102 mm)
|
172
|
+
# 110 = PRC Envelope #2 Rotated (176 mm x 102 mm)
|
173
|
+
# 111 = PRC Envelope #3 Rotated (176 mm x 125 mm)
|
174
|
+
# 112 = PRC Envelope #4 Rotated (208 mm x 110 mm)
|
175
|
+
# 113 = PRC Envelope #5 Rotated (220 mm x 110 mm)
|
176
|
+
# 114 = PRC Envelope #6 Rotated (230 mm x 120 mm)
|
177
|
+
# 115 = PRC Envelope #7 Rotated (230 mm x 160 mm)
|
178
|
+
# 116 = PRC Envelope #8 Rotated (309 mm x 120 mm)
|
179
|
+
# 117 = PRC Envelope #9 Rotated (324 mm x 229 mm)
|
180
|
+
# 118 = PRC Envelope #10 Rotated (458 mm x 324 mm)
|
181
|
+
# @return [Integer]
|
182
|
+
attr_reader :paper_size
|
183
|
+
|
184
|
+
# Sets the paper size for printing.
|
185
|
+
# @see PageSetup#paper_size
|
186
|
+
# @return integer
|
187
|
+
def paper_size=(size)
|
188
|
+
RestrictionValidator.validate 'paper_size', (1..118), size
|
189
|
+
@paper_size = size
|
190
|
+
end
|
191
|
+
|
192
|
+
# Set some or all page settings at once.
|
193
|
+
# @param [Hash] options The page settings to set (possible keys are :fit_to_height, :fit_to_width, :orientation, :paper_height, :paper_width, and :scale).
|
194
|
+
def set(options)
|
195
|
+
parse_options options
|
196
|
+
end
|
197
|
+
|
198
|
+
# @see fit_to_height
|
199
|
+
def fit_to_height=(v); Axlsx::validate_unsigned_int(v); @fit_to_height = v; end
|
200
|
+
# @see fit_to_width
|
201
|
+
def fit_to_width=(v); Axlsx::validate_unsigned_int(v); @fit_to_width = v; end
|
202
|
+
# @see orientation
|
203
|
+
def orientation=(v); Axlsx::validate_page_orientation(v); @orientation = v; end
|
204
|
+
# @see paper_height
|
205
|
+
def paper_height=(v); Axlsx::validate_number_with_unit(v); @paper_height = v; end
|
206
|
+
# @see paper_width
|
207
|
+
def paper_width=(v); Axlsx::validate_number_with_unit(v); @paper_width = v; end
|
208
|
+
# @see scale
|
209
|
+
def scale=(v); Axlsx::validate_scale_10_400(v); @scale = v; end
|
210
|
+
|
211
|
+
# convenience method to achieve sanity when setting fit_to_width and fit_to_height
|
212
|
+
# as they both default to 1 if only their counterpart is specified.
|
213
|
+
# @note This method will overwrite any value you explicitly set via the fit_to_height or fit_to_width methods.
|
214
|
+
# @option options [Integer] width The number of pages to fit this worksheet on horizontally. Default 999
|
215
|
+
# @option options [Integer] height The number of pages to fit this worksheet on vertically. Default 999
|
216
|
+
def fit_to(options = {})
|
217
|
+
self.fit_to_width = options[:width] || 999
|
218
|
+
self.fit_to_height = options[:height] || 999
|
219
|
+
[@fit_to_width, @fit_to_height]
|
220
|
+
end
|
221
|
+
|
222
|
+
# helper method for worksheet to determine if the page setup is configured for fit to page printing
|
223
|
+
# We treat any page set up that has a value set for fit_to_width or fit_to_height value as fit_to_page.
|
224
|
+
# @return [Boolean]
|
225
|
+
def fit_to_page?
|
226
|
+
# is there some better what to express this?
|
227
|
+
(fit_to_width != nil || fit_to_height != nil)
|
228
|
+
end
|
229
|
+
|
230
|
+
# Serializes the page settings element.
|
231
|
+
# @param [String] str
|
232
|
+
# @return [String]
|
233
|
+
def to_xml_string(str = '')
|
234
|
+
serialized_tag('pageSetup', str)
|
235
|
+
end
|
236
|
+
end
|
237
|
+
end
|