summaryrefslogtreecommitdiffhomepage
path: root/examples/styles.rb
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/styles.rb
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/styles.rb')
-rw-r--r--examples/styles.rb66
1 files changed, 0 insertions, 66 deletions
diff --git a/examples/styles.rb b/examples/styles.rb
deleted file mode 100644
index 7a589e2e..00000000
--- a/examples/styles.rb
+++ /dev/null
@@ -1,66 +0,0 @@
-$LOAD_PATH.unshift "#{File.dirname(__FILE__)}/../lib"
-require 'axlsx'
-require 'date'
-
-p = Axlsx::Package.new
-wb = p.workbook
-wb.styles do |style|
-
- # Date/Time Styles
- #
- # The most important thing to remember about OOXML styles is that they are
- # exclusive. This means that each style must define all the components it
- # requires to render the cell the way you want. A good example of this is
- # changing the font size for a date. You cannot specify just the font size,
- # you must also specify the number format or format code so that renders
- # know how to display the serialized date float value
- #
- # The parts that make up a custom styles are:
- #
- # fonts(Font), fills(Fill), borders(Border) and number formats(NumFmt).
- # Getting to know those classes will help you make the most out of custom
- # styling. However axlsx certainly does not expect you to create all those
- # objects manually.
- #
- # workbook.styles.add_style provides a helper method 'add_style' for defining
- # styles in one go. The docs for that method are definitely worth a read.
- # @see Style#add_style
-
- # When no style is applied to a cell, axlsx will automatically apply date/time
- # formatting to Date and Time objects for you. However, if you are defining
- # custom styles, you define all aspects of the style you want to apply.
- #
- # An aside on styling and auto-width. Auto-width calculations do not
- # currently take into account any style or formatting you have applied to the
- # data in your cells as it would require the creation of a rendering engine,
- # and frankly kill performance. If you are doing a lot of custom formatting,
- # you are going to be better served by specifying fixed column widths.
- #
- # Let's look at an example:
- #
- # A style that only applies a font size
- large_font = wb.styles.add_style :sz => 20
-
- # A style that applies both a font size and a predefined number format.
- # @see NumFmt
- predefined_format = wb.styles.add_style :sz => 20, :num_fmt => 14
-
- # A style that a applies a font size and a custom formatting code
- custom_format = wb.styles.add_style :sz => 20, :format_code => 'yyyy-mm-dd'
-
- # A style that overrides top and left border style
- override_border = wb.styles.add_style :border => { :style => :thin, :color =>"FAAC58", :edges => [:right, :top, :left] }, :border_top => { :style => :thick, :color => "01DF74" }, :border_left => { :color => "0101DF" }
-
-
- wb.add_worksheet do |sheet|
-
- # We then apply those styles positionally
- sheet.add_row [123, "123", Time.now], style: [nil, large_font, predefined_format]
- sheet.add_row [123, "123", Date.new(2012, 9, 14)], style: [large_font, nil, custom_format]
- sheet.add_row [123, "123", Date.new(2000, 9, 12)] # This uses the axlsx default format_code (14)
- sheet.add_row [123, "123", Time.now], style: [large_font, override_border, predefined_format]
- end
-
-end
-p.serialize 'styles.xlsx'
-