summaryrefslogtreecommitdiffhomepage
path: root/examples/custom_styles_example.md
diff options
context:
space:
mode:
authorZsolt Kozaroczy <[email protected]>2020-09-11 00:36:29 +0200
committerGitHub <[email protected]>2020-09-11 00:36:29 +0200
commit282eec44ef01746ee25931fa6cd287ad083fd40b (patch)
tree14504bf429ca264812679ca971c1592853d3f762 /examples/custom_styles_example.md
parent317e8244e4d17c394c1e181f86df3974623fb865 (diff)
downloadcaxlsx-282eec44ef01746ee25931fa6cd287ad083fd40b.tar.gz
caxlsx-282eec44ef01746ee25931fa6cd287ad083fd40b.zip
Restructure examples folder (#47)
Split examples into separate markdown files, each containing a description, sample code, and a screenshot of the resulting xlsx document. The script `generate.rb` is provided to actually generate the example documents by executing the sample code contained in the markdown files.
Diffstat (limited to 'examples/custom_styles_example.md')
-rw-r--r--examples/custom_styles_example.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/examples/custom_styles_example.md b/examples/custom_styles_example.md
new file mode 100644
index 00000000..aa602ea1
--- /dev/null
+++ b/examples/custom_styles_example.md
@@ -0,0 +1,31 @@
+## Description
+
+Each cell allows a single, predefined style. When using `add_row`, the value in the `style` array at the same index as the cell's column will be applied to that cell. Alternatively, you can apply a style to an entire row by using an integer value for `style`.
+
+
+## Code
+
+```ruby
+require 'axlsx'
+
+p = Axlsx::Package.new
+wb = p.workbook
+
+s = wb.styles
+black_cell = s.add_style bg_color: '00', fg_color: 'FF', sz: 14, alignment: { horizontal: :center }
+blue_cell = s.add_style bg_color: '0000FF', fg_color: 'FF', sz: 20, alignment: { horizontal: :center }
+
+wb.add_worksheet(name: 'Custom Styles') do |sheet|
+ # Applies the black_cell style to the first and third cell, and the blue_cell style to the second.
+ sheet.add_row ['Text Autowidth', 'Second', 'Third'], style: [black_cell, blue_cell, black_cell]
+
+ # Applies the thin border to all three cells
+ sheet.add_row [1, 2, 3], style: Axlsx::STYLE_THIN_BORDER
+end
+
+p.serialize 'custom_styles_example.xlsx'
+```
+
+## Output
+
+![Output](images/custom_styles_example.png "Output")