write_xlsx 0.0.2

data/examples/comments1.rb

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('comments1.xlsx')
+worksheet = workbook.add_worksheet
+
+worksheet.write('A1', 'Hello')
+worksheet.write_comment('A1', 'This is a comment')
+
+workbook.close

data/examples/comments2.rb

@@ -0,0 +1,335 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+require 'rubygems'
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('comments2.xlsx')
+
+text_wrap  = workbook.add_format( :text_wrap => 1, :valign => 'top' )
+worksheet1 = workbook.add_worksheet
+worksheet2 = workbook.add_worksheet
+worksheet3 = workbook.add_worksheet
+worksheet4 = workbook.add_worksheet
+worksheet5 = workbook.add_worksheet
+worksheet6 = workbook.add_worksheet
+worksheet7 = workbook.add_worksheet
+worksheet8 = workbook.add_worksheet
+
+
+# Variables that we will use in each example.
+cell_text = ''
+comment   = ''
+
+
+###############################################################################
+#
+# Example 1. Demonstrates a simple cell comments without formatting.
+#            comments.
+#
+
+# Set up some formatting.
+worksheet1.set_column( 'C:C', 25 )
+worksheet1.set_row( 2, 50 )
+worksheet1.set_row( 5, 50 )
+
+
+# Simple ascii string.
+cell_text = 'Hold the mouse over this cell to see the comment.'
+
+comment = 'This is a comment.'
+
+worksheet1.write( 'C3', cell_text, text_wrap )
+worksheet1.write_comment( 'C3', comment )
+
+cell_text = 'This is a UTF-8 string.'
+comment   = '☺'
+
+worksheet1.write( 'C6', cell_text, text_wrap )
+worksheet1.write_comment( 'C6', comment )
+
+
+
+###############################################################################
+#
+# Example 2. Demonstrates visible and hidden comments.
+#
+
+# Set up some formatting.
+worksheet2.set_column( 'C:C', 25 )
+worksheet2.set_row( 2, 50 )
+worksheet2.set_row( 5, 50 )
+
+
+cell_text = 'This cell comment is visible.'
+
+comment = 'Hello.'
+
+worksheet2.write( 'C3', cell_text, text_wrap )
+worksheet2.write_comment( 'C3', comment, :visible => 1 )
+
+
+cell_text = "This cell comment isn't visible (the default)."
+
+comment = 'Hello.'
+
+worksheet2.write( 'C6', cell_text, text_wrap )
+worksheet2.write_comment( 'C6', comment )
+
+
+###############################################################################
+#
+# Example 3. Demonstrates visible and hidden comments set at the worksheet
+#            level.
+#
+
+# Set up some formatting.
+worksheet3.set_column( 'C:C', 25 )
+worksheet3.set_row( 2, 50 )
+worksheet3.set_row( 5, 50 )
+worksheet3.set_row( 8, 50 )
+
+# Make all comments on the worksheet visible.
+worksheet3.show_comments
+
+cell_text = 'This cell comment is visible, explicitly.'
+
+comment = 'Hello.'
+
+worksheet3.write( 'C3', cell_text, text_wrap )
+worksheet3.write_comment( 'C3', comment, :visible => 1 )
+
+
+cell_text =
+  'This cell comment is also visible because we used show_comments().'
+
+comment = 'Hello.'
+
+worksheet3.write( 'C6', cell_text, text_wrap )
+worksheet3.write_comment( 'C6', comment )
+
+
+cell_text = 'However, we can still override it locally.'
+
+comment = 'Hello.'
+
+worksheet3.write( 'C9', cell_text, text_wrap )
+worksheet3.write_comment( 'C9', comment, :visible => 0 )
+
+
+###############################################################################
+#
+# Example 4. Demonstrates changes to the comment box dimensions.
+#
+
+# Set up some formatting.
+worksheet4.set_column( 'C:C', 25 )
+worksheet4.set_row( 2,  50 )
+worksheet4.set_row( 5,  50 )
+worksheet4.set_row( 8,  50 )
+worksheet4.set_row( 15, 50 )
+
+worksheet4.show_comments
+
+cell_text = 'This cell comment is default size.'
+
+comment = 'Hello.'
+
+worksheet4.write( 'C3', cell_text, text_wrap )
+worksheet4.write_comment( 'C3', comment )
+
+
+cell_text = 'This cell comment is twice as wide.'
+
+comment = 'Hello.'
+
+worksheet4.write( 'C6', cell_text, text_wrap )
+worksheet4.write_comment( 'C6', comment, :x_scale => 2 )
+
+
+cell_text = 'This cell comment is twice as high.'
+
+comment = 'Hello.'
+
+worksheet4.write( 'C9', cell_text, text_wrap )
+worksheet4.write_comment( 'C9', comment, :y_scale => 2 )
+
+
+cell_text = 'This cell comment is scaled in both directions.'
+
+comment = 'Hello.'
+
+worksheet4.write( 'C16', cell_text, text_wrap )
+worksheet4.write_comment( 'C16', comment, :x_scale => 1.2, :y_scale => 0.8 )
+
+
+cell_text = 'This cell comment has width and height specified in pixels.'
+
+comment = 'Hello.'
+
+worksheet4.write( 'C19', cell_text, text_wrap )
+worksheet4.write_comment( 'C19', comment, :width => 200, :height => 20 )
+
+
+###############################################################################
+#
+# Example 5. Demonstrates changes to the cell comment position.
+#
+
+worksheet5.set_column( 'C:C', 25 )
+worksheet5.set_row( 2,  50 )
+worksheet5.set_row( 5,  50 )
+worksheet5.set_row( 8,  50 )
+worksheet5.set_row( 11, 50 )
+
+worksheet5.show_comments
+
+cell_text = 'This cell comment is in the default position.'
+
+comment = 'Hello.'
+
+worksheet5.write( 'C3', cell_text, text_wrap )
+worksheet5.write_comment( 'C3', comment )
+
+
+cell_text = 'This cell comment has been moved to another cell.'
+
+comment = 'Hello.'
+
+worksheet5.write( 'C6', cell_text, text_wrap )
+worksheet5.write_comment( 'C6', comment, :start_cell => 'E4' )
+
+
+cell_text = 'This cell comment has been moved to another cell.'
+
+comment = 'Hello.'
+
+worksheet5.write( 'C9', cell_text, text_wrap )
+worksheet5.write_comment( 'C9', comment, :start_row => 8, :start_col => 4 )
+
+
+cell_text = 'This cell comment has been shifted within its default cell.'
+
+comment = 'Hello.'
+
+worksheet5.write( 'C12', cell_text, text_wrap )
+worksheet5.write_comment( 'C12', comment, :x_offset => 30, :y_offset => 12 )
+
+
+###############################################################################
+#
+# Example 6. Demonstrates changes to the comment background colour.
+#
+
+worksheet6.set_column( 'C:C', 25 )
+worksheet6.set_row( 2, 50 )
+worksheet6.set_row( 5, 50 )
+worksheet6.set_row( 8, 50 )
+
+worksheet6.show_comments
+
+cell_text = 'This cell comment has a different colour.'
+
+comment = 'Hello.'
+
+worksheet6.write( 'C3', cell_text, text_wrap )
+worksheet6.write_comment( 'C3', comment, :color => 'green' )
+
+
+cell_text = 'This cell comment has the default colour.'
+
+comment = 'Hello.'
+
+worksheet6.write( 'C6', cell_text, text_wrap )
+worksheet6.write_comment( 'C6', comment )
+
+
+cell_text = 'This cell comment has a different colour.'
+
+comment = 'Hello.'
+
+worksheet6.write( 'C9', cell_text, text_wrap )
+worksheet6.write_comment( 'C9', comment, :color => 0x35 )
+
+
+###############################################################################
+#
+# Example 7. Demonstrates how to set the cell comment author.
+#
+
+worksheet7.set_column( 'C:C', 30 )
+worksheet7.set_row( 2,  50 )
+worksheet7.set_row( 5,  50 )
+worksheet7.set_row( 8,  50 )
+
+author = ''
+cell   = 'C3'
+
+cell_text = "Move the mouse over this cell and you will see 'Cell commented " +
+  "by #{author}' (blank) in the status bar at the bottom"
+
+comment = 'Hello.'
+
+worksheet7.write( cell, cell_text, text_wrap )
+worksheet7.write_comment( cell, comment )
+
+
+author    = 'Ruby'
+cell      = 'C6'
+cell_text = "Move the mouse over this cell and you will see 'Cell commented " +
+  "by #{author}' in the status bar at the bottom"
+
+comment = 'Hello.'
+
+worksheet7.write( cell, cell_text, text_wrap )
+worksheet7.write_comment( cell, comment, :author => author )
+
+
+author    = '€'
+cell      = 'C9'
+cell_text = "Move the mouse over this cell and you will see 'Cell commented " +
+  "by #{author}' in the status bar at the bottom"
+comment = 'Hello.'
+
+worksheet7.write( cell, cell_text, text_wrap )
+worksheet7.write_comment( cell, comment, :author => author )
+
+
+
+
+###############################################################################
+#
+# Example 8. Demonstrates the need to explicitly set the row height.
+#
+
+# Set up some formatting.
+worksheet8.set_column( 'C:C', 25 )
+worksheet8.set_row( 2, 80 )
+
+worksheet8.show_comments
+
+
+cell_text =
+    'The height of this row has been adjusted explicitly using ' +
+  'set_row(). The size of the comment box is adjusted ' +
+  'accordingly by Excel::Writer::XLSX.'
+
+comment = 'Hello.'
+
+worksheet8.write( 'C3', cell_text, text_wrap )
+worksheet8.write_comment( 'C3', comment )
+
+
+cell_text =
+    'The height of this row has been adjusted by Excel due to the ' +
+  'text wrap property being set. Unfortunately this means that ' +
+  'the height of the row is unknown to Excel::Writer::XLSX at ' +
+  "run time and thus the comment box is stretched as well.\n\n" +
+  'Use set_row() to specify the row height explicitly to avoid ' +
+  'this problem.'
+
+comment = 'Hello.'
+
+worksheet8.write( 'C6', cell_text, text_wrap )
+worksheet8.write_comment( 'C6', comment )
+
+workbook.close

data/examples/conditional_format.rb

@@ -0,0 +1,67 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+require 'rubygems'
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('conditional_format.xlsx')
+worksheet1 = workbook.add_worksheet
+
+# Light red fill with dark red text.
+format1 = workbook.add_format(
+    :bg_color => '#FFC7CE',
+    :color    => '#9C0006'
+)
+
+# Green fill with dark green text.
+format2 = workbook.add_format(
+    :bg_color => '#C6EFCE',
+    :color    => '#006100'
+)
+
+# Some sample data to run the conditional formatting against.
+data = [
+    [ 90, 80,  50, 10,  20,  90,  40, 90,  30,  40 ],
+    [ 20, 10,  90, 100, 30,  60,  70, 60,  50,  90 ],
+    [ 10, 50,  60, 50,  20,  50,  80, 30,  40,  60 ],
+    [ 10, 90,  20, 40,  10,  40,  50, 70,  90,  50 ],
+    [ 70, 100, 10, 90,  10,  10,  20, 100, 100, 40 ],
+    [ 20, 60,  10, 100, 30,  10,  20, 60,  100, 10 ],
+    [ 10, 60,  10, 80,  100, 80,  30, 30,  70,  40 ],
+    [ 30, 90,  60, 10,  10,  100, 40, 40,  30,  40 ],
+    [ 80, 90,  10, 20,  20,  50,  80, 20,  60,  90 ],
+    [ 60, 80,  30, 30,  10,  50,  80, 60,  50,  30 ]
+]
+
+
+# This example below highlights cells that have a value greater than or
+# equal to 50 in red and cells below that value in green.
+
+caption = 'Cells with values >= 50 are in light red. ' +
+          'Values < 50 are in light green'
+
+# Write the data.
+worksheet1.write('A1', caption)
+worksheet1.write_col('B3', data)
+
+# Write a conditional format over a range.
+worksheet1.conditional_formatting('B3:K12',
+    {
+        :type     => 'cell',
+        :format   => format1,
+        :criteria => '>=',
+        :value    => 50
+    }
+)
+
+# Write another conditional format over the same range.
+worksheet1.conditional_formatting('B3:K12',
+    {
+        :type     => 'cell',
+        :format   => format2,
+        :criteria => '<',
+        :value    => 50
+    }
+)
+
+workbook.close

data/examples/data_validate.rb

@@ -0,0 +1,279 @@
+#!/usr/bin/env ruby
+# -*- coding: utf-8 -*-
+
+###############################################################################
+#
+# Example of how to add data validation and dropdown lists to a
+# WriteExcel file.
+#
+# reverse('©'), August 2008, John McNamara, jmcnamara@cpan.org
+#
+# original written in Perl by John McNamara
+# converted to Ruby by Hideo Nakamura, cxn03651@msj.biglobe.ne.jp
+#
+
+require 'rubygems'
+require 'write_xlsx'
+
+workbook  = WriteXLSX.new('data_validate.xlsx')
+worksheet = workbook.add_worksheet
+
+# Add a format for the header cells.
+header_format = workbook.add_format(
+                                            :border      => 1,
+                                            :bg_color    => 43,
+                                            :bold        => 1,
+                                            :text_wrap   => 1,
+                                            :valign      => 'vcenter',
+                                            :indent      => 1
+                                         )
+
+# Set up layout of the worksheet.
+worksheet.set_column('A:A', 68)
+worksheet.set_column('B:B', 15)
+worksheet.set_column('D:D', 15)
+worksheet.set_row(0, 36)
+worksheet.set_selection('B3')
+
+
+# Write the header cells and some data that will be used in the examples.
+row = 0
+heading1 = 'Some examples of data validation in Excel::Writer::XLSX'
+heading2 = 'Enter values in this column'
+heading3 = 'Sample Data'
+
+worksheet.write('A1', heading1, header_format)
+worksheet.write('B1', heading2, header_format)
+worksheet.write('D1', heading3, header_format)
+
+worksheet.write('D3', ['Integers',   1, 10])
+worksheet.write('D4', ['List data', 'open', 'high', 'close'])
+worksheet.write('D5', ['Formula',   '=AND(F5=50,G5=60)', 50, 60])
+
+
+#
+# Example 1. Limiting input to an integer in a fixed range.
+#
+txt = 'Enter an integer between 1 and 10'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'integer',
+        :criteria        => 'between',
+        :minimum         => 1,
+        :maximum         => 10
+    })
+
+
+#
+# Example 2. Limiting input to an integer outside a fixed range.
+#
+txt = 'Enter an integer that is not between 1 and 10 (using cell references)'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'integer',
+        :criteria        => 'not between',
+        :minimum         => '=E3',
+        :maximum         => '=F3'
+    })
+
+
+#
+# Example 3. Limiting input to an integer greater than a fixed value.
+#
+txt = 'Enter an integer greater than 0'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'integer',
+        :criteria        => '>',
+        :value           => 0
+    })
+
+
+#
+# Example 4. Limiting input to an integer less than a fixed value.
+#
+txt = 'Enter an integer less than 10'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'integer',
+        :criteria        => '<',
+        :value           => 10
+    })
+
+
+#
+# Example 5. Limiting input to a decimal in a fixed range.
+#
+txt = 'Enter a decimal between 0.1 and 0.5'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'decimal',
+        :criteria        => 'between',
+        :minimum         => 0.1,
+        :maximum         => 0.5
+    })
+
+
+#
+# Example 6. Limiting input to a value in a dropdown list.
+#
+txt = 'Select a value from a drop down list'
+row += 2
+bp=1
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'list',
+        :source          => ['open', 'high', 'close']
+    })
+
+
+#
+# Example 6. Limiting input to a value in a dropdown list.
+#
+txt = 'Select a value from a drop down list (using a cell range)'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'list',
+        :source          => '=$E$4:$G$4'
+    })
+
+
+#
+# Example 7. Limiting input to a date in a fixed range.
+#
+txt = 'Enter a date between 1/1/2008 and 12/12/2008'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'date',
+        :criteria        => 'between',
+        :minimum         => '2008-01-01T',
+        :maximum         => '2008-12-12T'
+    })
+
+
+#
+# Example 8. Limiting input to a time in a fixed range.
+#
+txt = 'Enter a time between 6:00 and 12:00'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'time',
+        :criteria        => 'between',
+        :minimum         => 'T06:00',
+        :maximum         => 'T12:00'
+    })
+
+
+#
+# Example 9. Limiting input to a string greater than a fixed length.
+#
+txt = 'Enter a string longer than 3 characters'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'length',
+        :criteria        => '>',
+        :value           => 3
+    })
+
+
+#
+# Example 10. Limiting input based on a formula.
+#
+txt = 'Enter a value if the following is true "=AND(F5=50,G5=60)"'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate        => 'custom',
+        :value           => '=AND(F5=50,G5=60)'
+    })
+
+
+#
+# Example 11. Displaying and modify data validation messages.
+#
+txt = 'Displays a message when you select the cell'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate      => 'integer',
+        :criteria      => 'between',
+        :minimum       => 1,
+        :maximum       => 100,
+        :input_title   => 'Enter an integer:',
+        :input_message => 'between 1 and 100'
+    })
+
+
+#
+# Example 12. Displaying and modify data validation messages.
+#
+txt = 'Display a custom error message when integer isn\'t between 1 and 100'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate      => 'integer',
+        :criteria      => 'between',
+        :minimum       => 1,
+        :maximum       => 100,
+        :input_title   => 'Enter an integer:',
+        :input_message => 'between 1 and 100',
+        :error_title   => 'Input value is not valid!',
+        :error_message => 'It should be an integer between 1 and 100'
+    })
+
+
+#
+# Example 13. Displaying and modify data validation messages.
+#
+txt = 'Display a custom information message when integer isn\'t between 1 and 100'
+row += 2
+
+worksheet.write(row, 0, txt)
+worksheet.data_validation(row, 1,
+    {
+        :validate      => 'integer',
+        :criteria      => 'between',
+        :minimum       => 1,
+        :maximum       => 100,
+        :input_title   => 'Enter an integer:',
+        :input_message => 'between 1 and 100',
+        :error_title   => 'Input value is not valid!',
+        :error_message => 'It should be an integer between 1 and 100',
+        :error_type    => 'information'
+    })
+
+workbook.close