Class: TTY::Table::Operation::AlignmentSet

Inherits:
Vector
  • Object
show all
Defined in:
lib/tty/table/operation/alignment_set.rb

Overview

A class which responsiblity is to align table rows and header.

Instance Attribute Summary

Attributes included from Equatable

#comparison_attrs

Instance Method Summary collapse

Methods inherited from Vector

[], #[]=, #each, #empty?, #initialize, #size, #to_a, #to_ary

Methods included from Equatable

#attr_reader, included, #inherited

Methods included from Conversion

#convert_to_array

Constructor Details

This class inherits a constructor from TTY::Vector

Instance Method Details

#[](index) ⇒ Symbol

Lookup an alignment by index

Parameters:

  • (Integer)

Returns:

  • (Symbol)

    alignment



17
18
19
# File 'lib/tty/table/operation/alignment_set.rb', line 17

def [](index)
  elements.fetch(index, :left)
end

#align_header(header, options = {}) ⇒ Array[String]

Align table header

Returns:

  • (Array[String])


35
36
37
# File 'lib/tty/table/operation/alignment_set.rb', line 35

def align_header(header, options={})
  align_row(header, options)
end

#align_rows(rows, options = {}) ⇒ Array[Array]

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Align the supplied rows with the correct alignment.

Parameters:

  • rows (Array)

Returns:

  • (Array[Array])

    the aligned rows



47
48
49
# File 'lib/tty/table/operation/alignment_set.rb', line 47

def align_rows(rows, options={})
  rows.map { |row| align_row(row, options) }
end

#alignmentsArray

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Return each alignment in an Array

Returns:

  • (Array)


26
27
28
# File 'lib/tty/table/operation/alignment_set.rb', line 26

def alignments
  map { |alignment| alignment }
end