Description

class Axlsx::Selection
Note:

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

Selection options for worksheet panes.

Creates a new Axlsx::Selection object

Parameters:

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

    a customizable set of options

Options Hash (options):

  • active_cell (Cell, String)

    Active Cell Location

  • active_cell_id (Integer)

    Active Cell Index

  • pane (Symbol)

    Pane

  • sqref (String)

    Sequence of References

Active Cell Location Location of the active cell. default nil

Active Cell Index 0-based index of the range reference (in the array of references listed in sqref) containing the active cell. Only used when the selection in sqref is not contiguous. Therefore, this value needs to be aware of the order in which the range references are written in sqref. When this value is out of range then activeCell can be used. default nil

Pane The pane to which this selection belongs. 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

Sequence of References Range of the selection. Can be non-contiguous set of ranges. default nil

Serializes the data validation

Parameters:

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

Selection is referenced in 0 repositories