diff options
| author | Weston Ganger <[email protected]> | 2019-10-28 16:54:54 -0700 |
|---|---|---|
| committer | Stefan Daschek <[email protected]> | 2019-10-29 01:23:33 +0100 |
| commit | 2cdaed0178d95c8f0e63ae60c94cfd8bd787e5c6 (patch) | |
| tree | 0090252d831ffd00729c5f4799fc5f0d2aa13700 | |
| parent | 76975a38e56b3cb3d13ed4e2b59afb0d2aaaef0f (diff) | |
| download | caxlsx-2cdaed0178d95c8f0e63ae60c94cfd8bd787e5c6.tar.gz caxlsx-2cdaed0178d95c8f0e63ae60c94cfd8bd787e5c6.zip | |
Add Style Reference
| -rw-r--r-- | README.md | 10 | ||||
| -rw-r--r-- | docs/header_and_footer_codes.md (renamed from notes_on_header_footer.md) | 0 | ||||
| -rw-r--r-- | docs/style_reference.md | 82 |
3 files changed, 89 insertions, 3 deletions
@@ -157,11 +157,15 @@ There is much, much more you can do with this gem. If you get stuck, grab me on Documentation -------------- -This gem is 100% documented with YARD, an exceptional documentation library. To see documentation for this, and all the gems installed on your system use: +Detailed documentation is available at: - gem install yard kramdown +[https://www.rubydoc.info/gems/caxlsx/](https://www.rubydoc.info/gems/caxlsx/) + +Additional documentation is listed below: + +- [Style Reference](https://github.com/caxlsx/caxlsx/blob/master/docs/style_reference.md) +- [Header and Footer Codes](https://github.com/caxlsx/caxlsx/blob/master/docs/header_and_footer_codes.md) - yard server -g Specs ------ diff --git a/notes_on_header_footer.md b/docs/header_and_footer_codes.md index 2be4459a..2be4459a 100644 --- a/notes_on_header_footer.md +++ b/docs/header_and_footer_codes.md diff --git a/docs/style_reference.md b/docs/style_reference.md new file mode 100644 index 00000000..01d7f008 --- /dev/null +++ b/docs/style_reference.md @@ -0,0 +1,82 @@ +# Basic Styling +- `b` (Boolean) - Bold +- `i` (Boolean) - Italic +- `u` (Boolean) - Underline +- `fg_color` (String) - Text Color - Ex: `000000` +- `bg_color` (String) - Cell background color - Ex: `CCCCCC` +- `alignment` (Hash) - Text alignment. + - Available sub-options are `:horizontal`, `:vertical`, `:wrap_text`. + - Example: `alignment: {horizontal: true, vertical: true, wrap_text: false}` +- `strike` (Boolean) - Indicates if the text should be rendered with a strikethrough +- `outline` (Boolean) - Indicates if the text should be rendered with a shadow +- `sz` (Integer) - Font Size +- `font_name` (String) - Font Name - Ex. `Arial` +- `family` (Integer) - The font family to use. Options are: + - `1` - Roman (Default) + - `2` - Swiss + - `3` - Modern + - `4` - Script + - `5` - Decorative +- `charset` (Integer) - The character set to use. Axlsx documentation says this setting is ignored most of the time. +- `type` (Symbol) - Type of the cell. Options are: `:xf` (Default) or `:dxf` +- `border` (Hash) - Borders support style, color and edges options. Example: `border: {style: :thin, color: "000000", edges: [:top, :bottom, :left, :right]}`. Available styles for the border are: + - `:none` + - `:thin` + - `:medium` + - `:dashed` + - `:dotted` + - `:thick` + - `:double` + - `:hair` + - `:mediumDashed` + - `:dashDot` + - `:mediumDashDot` + - `:dashDotDot` + - `:mediumDashDotDot` + - `:slantDashDot` +- `hidden` (Boolean) - Indicates if the cell should be hidden +- `locked` (Boolean) - Indicates if the cell should be locked +- `format_code` (String) - See section below +- `num_fmt` (Integer) - See section below + +# `format_code` and `num_fmt` +To output a dollar sign, comma's every three values, and minumum two decimal places use: +`format_code: '\$#,##0.00'` + +This will output a nicely formatted date/time: +`m/d/yyyy h:mm:ss AM/PM` + +I think its much more preferable to write out the `format_code` manually instead of using `num_fmt` however the option is there. + +Heres a list of the `num_fmt` code (left side) and corresponding `format_code` string (right side) + +- `1` - `'0'` +- `2` - `'0.00'` +- `3` - `'#,##0'` +- `4` - `'#,##0.00'` +- `5` - `'$#,##0_);($#,##0)'` +- `6` - `'$#,##0_);Red'` +- `7` - `'$#,##0.00_);($#,##0.00)'` +- `8` - `'$#,##0.00_);Red'` +- `9` - `'0%'` +- `10` - `'0.00%' ` +- `11` - `'0.00E+00'` +- `12` - `'# ?/?'` +- `13` - `'# ??/??'` +- `14` - `'m/d/yyyy'` +- `15` - `'d-mmm-yy'` +- `16` - `'d-mmm'` +- `17` - `'mmm-yy'` +- `18` - `'h:mm AM/PM'` +- `19` - `'h:mm:ss AM/PM'` +- `20` - `'h:mm'` +- `21` - `'h:mm:ss'` +- `22` - `'m/d/yyyy h:mm'` +- `37` - `'#,##0_);(#,##0) 38 #,##0_);Red'` +- `39` - `'#,##0.00_);(#,##0.00)'` +- `40` - `'#,##0.00_);Red'` +- `45` - `'mm:ss'` +- `46` - `'[h]:mm:ss'` +- `47` - `'mm:ss.0'` +- `48` - `'##0.0E+0'` +- `49` - `'@'` |
