summaryrefslogtreecommitdiffhomepage
path: root/examples/borders_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/borders_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/borders_example.md')
-rw-r--r--examples/borders_example.md27
1 files changed, 27 insertions, 0 deletions
diff --git a/examples/borders_example.md b/examples/borders_example.md
new file mode 100644
index 00000000..d637681c
--- /dev/null
+++ b/examples/borders_example.md
@@ -0,0 +1,27 @@
+## Description
+
+Axlsx defines a thin border style, but you can easily create and use your own.
+
+## Code
+
+```ruby
+require 'axlsx'
+
+p = Axlsx::Package.new
+wb = p.workbook
+
+s = wb.styles
+red_border = s.add_style border: { style: :thick, color: 'FFFF0000', edges: [:left, :right] }
+blue_border = s.add_style border: { style: :thick, color: 'FF0000FF' }
+
+wb.add_worksheet(name: 'Custom Borders') do |sheet|
+ sheet.add_row ['wrap', 'me', 'up in red'], style: red_border
+ sheet.add_row [1, 2, 3], style: blue_border
+end
+
+p.serialize 'borders_example.xlsx'
+```
+
+## Output
+
+![Output](images/borders_example.png "Output")