Class: Axlsx::Selection

Inherits:
Object
  • Object
show all
Includes:
OptionsParser, SerializedAttributes
Defined in:
lib/axlsx/workbook/worksheet/selection.rb

Overview

Note:

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

Selection options for worksheet panes.

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from SerializedAttributes

included, #serialized_attributes, #serialized_element_attributes, #serialized_tag

Methods included from OptionsParser

#parse_options

Constructor Details

#initialize(options = {}) ⇒ Selection

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



17
18
19
20
 
# File 'lib/axlsx/workbook/worksheet/selection.rb', line 17

def initialize(options = {})
  @active_cell = @active_cell_id = @pane = @sqref = nil
  parse_options options
end

Instance Attribute Details

#active_cell ⇒ String

Active Cell Location Location of the active cell. default nil

Returns:

  • (String)

See Also:

  • type


28
29
30
 
# File 'lib/axlsx/workbook/worksheet/selection.rb', line 28

def active_cell
  @active_cell
end

#active_cell_id ⇒ Integer

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

Returns:

  • (Integer)

See Also:

  • type


39
40
41
 
# File 'lib/axlsx/workbook/worksheet/selection.rb', line 39

def active_cell_id
  @active_cell_id
end

#pane ⇒ Symbol

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

Returns:

  • (Symbol)

See Also:

  • type


66
67
68
 
# File 'lib/axlsx/workbook/worksheet/selection.rb', line 66

def pane
  @pane
end

#sqref ⇒ String

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

Returns:

  • (String)

See Also:

  • type


73
74
75
 
# File 'lib/axlsx/workbook/worksheet/selection.rb', line 73

def sqref
  @sqref
end

Instance Method Details

#to_xml_string(str = +'')) ⇒ String

Serializes the data validation

Parameters:

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

Returns:

  • (String) 


103
104
105
 
# File 'lib/axlsx/workbook/worksheet/selection.rb', line 103

def to_xml_string(str = +'')
  serialized_tag 'selection', str
end