summaryrefslogtreecommitdiffhomepage
path: root/examples/pivot_table_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/pivot_table_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/pivot_table_example.md')
-rw-r--r--examples/pivot_table_example.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/examples/pivot_table_example.md b/examples/pivot_table_example.md
new file mode 100644
index 00000000..21176a73
--- /dev/null
+++ b/examples/pivot_table_example.md
@@ -0,0 +1,40 @@
+## Description
+
+Pivot tables are cool.
+
+## Code
+
+```ruby
+require 'axlsx'
+
+p = Axlsx::Package.new
+wb = p.workbook
+
+wb.add_worksheet(name: 'Basic Worksheet') do |sheet|
+ sheet.add_row ['Month', 'Year', 'Type', 'Sales', 'Region']
+
+ # Generate some data
+ 30.times do
+ sheet.add_row [
+ ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'].sample,
+ [2010, 2011, 2012].sample,
+ ['Meat', 'Dairy', 'Beverages', 'Produce'].sample,
+ rand(5000),
+ ['East', 'West', 'North', 'South'].sample
+ ]
+ end
+
+ sheet.add_pivot_table 'G4:L17', 'A1:E31' do |pivot_table|
+ pivot_table.rows = ['Month', 'Year']
+ pivot_table.columns = ['Type']
+ pivot_table.data = ['Sales']
+ pivot_table.pages = ['Region']
+ end
+end
+
+p.serialize 'pivot_table_example.xlsx'
+```
+
+## Output
+
+![Output](images/pivot_table_example.png "Output")