Description

class Axlsx::Pane
Note:

The recommended way to manage the pane options is via SheetView#pane

Pane options for a worksheet.

Creates a new Axlsx::Pane object

Parameters:

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

    a customizable set of options

Options Hash (options):

  • active_pane (Symbol)

    Active Pane

  • state (Symbol)

    Split State

  • top_left_cell (Cell, String)

    Top Left Visible Cell

  • x_split (Integer)

    Horizontal Split Position

  • y_split (Integer)

    Vertical Split Position

Active Pane The pane that is active. Options are

* bottom_left:  Bottom left pane, when both vertical and horizontal
                splits are applied. This value is also used when only
                a horizontal split has been applied, dividing the pane 
                into upper and lower regions. In that case, this value 
                specifies the bottom pane.
* bottom_right: Bottom right pane, when both vertical and horizontal
                splits are applied.
* top_left:     Top left pane, when both vertical and horizontal splits
                are applied. This value is also used when only a horizontal 
                split has been applied, dividing the pane into upper and lower
                regions. In that case, this value specifies the top pane.
                This value is also used when only a vertical split has
                been applied, dividing the pane into right and left
                regions. In that case, this value specifies the left pane
* top_right:    Top right pane, when both vertical and horizontal
                splits are applied. This value is also used when only
                a vertical split has been applied, dividing the pane 
                into right and left regions. In that case, this value 
                specifies the right pane.

default nil

Split State Indicates whether the pane has horizontal / vertical splits, and whether those splits are frozen. Options are

* frozen:       Panes are frozen, but were not split being frozen. In
                this state, when the panes are unfrozen again, a single
                pane results, with no split. In this state, the split 
                bars are not adjustable.
* frozen_split: Panes are frozen and were split before being frozen. In
                this state, when the panes are unfrozen again, the split
                remains, but is adjustable.
* split:        Panes are split, but not frozen. In this state, the split
                bars are adjustable by the user.

default nil

Serializes the data validation

Parameters:

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

Top Left Visible Cell Location of the top left visible cell in the bottom right pane (when in Left-To-Right mode). default nil

Horizontal Split Position Horizontal position of the split, in 1/20th of a point; 0 (zero) if none. If the pane is frozen, this value indicates the number of columns visible in the top pane. default 0

Vertical Split Position Vertical position of the split, in 1/20th of a point; 0 (zero) if none. If the pane is frozen, this value indicates the number of rows visible in the left pane. default 0

Pane is referenced in 0 repositories