Description

class Axlsx::Xf

The Xf class defines a formatting record for use in Styles. The recommended way to manage styles for your workbook is with Styles#add_style

Creates a new Xf object

Parameters:

  • options (Hash) (defaults to: {})

    a customizable set of options

Options Hash (options):

  • numFmtId (Integer)
  • fontId (Integer)
  • fillId (Integer)
  • borderId (Integer)
  • xfId (Integer)
  • quotePrefix (Boolean)
  • pivotButton (Boolean)
  • applyNumberFormat (Boolean)
  • applyFont (Boolean)
  • applyFill (Boolean)
  • applyBorder (Boolean)
  • applyAlignment (Boolean)
  • applyProtection (Boolean)
  • alignment (CellAlignment)
  • protection (CellProtection)

The cell alignment for this style

Indicates if the alignment options should be applied

indicates if the borderId should be applied

indicates if the fillId should be applied

indicates if the fontId should be applied

indicates if the numFmtId should be applied

Indicates if the protection options should be applied

index (0 based) of the border to be used in this style

index (0 based) of the fill to be used in this style

index (0 based) of the font to be used in this style

id of the numFmt to apply to this style

indicates if the cell has a pivot table drop down button

The cell protection for this style

indecates if text should be prefixed by a single quote in the cell

Serializes the object

Parameters:

  • str (String) (defaults to: '')

index (0 based) of cellStylesXfs item to be used in this style. Only applies to cellXfs items

Xf is referenced in 0 repositories