summaryrefslogtreecommitdiffhomepage
path: root/examples/panes_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/panes_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/panes_example.md')
-rw-r--r--examples/panes_example.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/examples/panes_example.md b/examples/panes_example.md
new file mode 100644
index 00000000..49d4b81f
--- /dev/null
+++ b/examples/panes_example.md
@@ -0,0 +1,32 @@
+## Description
+
+You can split the sheet into panes. `pane.state` could have three options: `split`, `frozen` or `frozen_split`
+
+## Code
+
+```ruby
+require 'axlsx'
+
+p = Axlsx::Package.new
+wb = p.workbook
+
+wb.add_worksheet(name: 'Panes') do |sheet|
+ # Generate a big dataset
+ sheet.add_row [''] + (0..99).map { |i| "column header #{i}" }
+ 100.times { |index| sheet.add_row ['row header'] + (0..index).to_a }
+
+ sheet.sheet_view.pane do |pane|
+ pane.top_left_cell = 'B2'
+ pane.state = :frozen_split
+ pane.y_split = 1
+ pane.x_split = 1
+ pane.active_pane = :bottom_right
+ end
+end
+
+p.serialize 'panes_example.xlsx'
+```
+
+## Output
+
+![Output](images/panes_example.png "Output")