module Tablo::Config::Defaults

Overview

Default values for Table and/or Column initialization, with associated getters and setters.

Defined in:

config.cr

Constant Summary

BODY_ALIGNMENT = nil

A default value of nil makes alignment dependent on data source type

BODY_FORMATTER = DEFAULT_FORMATTER

(see DEFAULT_FORMATTER)

BODY_STYLER = DEFAULT_STYLER

(see DEFAULT_STYLER)

BODY_WRAP = nil

Defaut wrapping value for multiline bodies
nil = no limit, n = limit to n lines

BORDER_DEFINITION = Border::PreSet::Ascii

Default value for Border definition

BORDER_STYLER = DEFAULT_STYLER

(see DEFAULT_STYLER)

COLUMN_WIDTH = 12

Defaut column width

FOOTER = Heading.new

Creates an instance of Heading struct with default parameters, where the value attribute is nil, so there is nothing to display

GROUP_ALIGNMENT = DEFAULT_HEADING_ALIGNMENT

(see DEFAULT_HEADING_ALIGNMENT)

GROUP_FORMATTER = DEFAULT_FORMATTER

(see DEFAULT_FORMATTER)

GROUP_STYLER = DEFAULT_STYLER

(see DEFAULT_STYLER)

HEADER_ALIGNMENT = nil

A default value of nil makes alignment dependent on data source type

HEADER_FORMATTER = DEFAULT_FORMATTER

(see DEFAULT_FORMATTER)

HEADER_FREQUENCY = 0

Defaut header frequency (see header_frequency parameter in Table.new)

HEADER_STYLER = DEFAULT_STYLER

(see DEFAULT_STYLER)

HEADER_WRAP = nil

Defaut wrapping value for multiline headers nil = no limit, n = limit to n lines

HEADING_ALIGNMENT = DEFAULT_HEADING_ALIGNMENT

(see DEFAULT_HEADING_ALIGNMENT)

HEADING_FORMATTER = DEFAULT_FORMATTER

(see DEFAULT_FORMATTER)

HEADING_STYLER = DEFAULT_STYLER

(see DEFAULT_STYLER)

LEFT_PADDING = 1

Default left padding

MASKED_HEADERS = false

Defaut value for masked headers

OMIT_GROUP_HEADER_RULE = false

Defaut value for omit_group_header_rule

OMIT_LAST_RULE = false

Defaut value for omit_last_rule
Omitting last rule allows joining of parent and child tables

PADDING_CHARACTER = " "

Default padding character (a String, size 1)

RIGHT_PADDING = 1

Default right padding

ROW_DIVIDER_FREQUENCY = nil

Defaut row divider frequency

SUBTITLE = Heading.new

Creates an instance of Heading struct with default parameters, where the value attribute is nil, so there is nothing to display

TITLE = Heading.new

Creates an instance of Heading struct with default parameters, where the value attribute is nil, so there is nothing to display

TRUNCATION_INDICATOR = "~"

Defaut truncation indicator (a string, size 1)

WRAP_MODE = WrapMode::Word

Defaut wrap mode (see WrapMode)

Class Method Summary

Class Method Detail

def self.body_alignment : Justify | Nil #

(Default: see BODY_ALIGNMENT)


[View source]
def self.body_alignment=(body_alignment : Justify | Nil) #

(Default: see BODY_ALIGNMENT)


[View source]
def self.body_formatter : Cell::Data::Formatter #

(Default: see BODY_FORMATTER)


[View source]
def self.body_formatter=(body_formatter : Cell::Data::Formatter) #

(Default: see BODY_FORMATTER)


[View source]
def self.body_styler : Cell::Data::Styler #

(Default: see BODY_STYLER)


[View source]
def self.body_styler=(body_styler : Cell::Data::Styler) #

(Default: see BODY_STYLER)


[View source]
def self.body_wrap : Int32 | Nil #

(Default: see BODY_WRAP)


[View source]
def self.body_wrap=(body_wrap : Int32 | Nil) #

(Default: see BODY_WRAP)


[View source]
def self.border_definition : String | Border::PreSet #

(Default: see BORDER_DEFINITION)


[View source]
def self.border_definition=(border_definition : String | Border::PreSet) #

(Default: see BORDER_DEFINITION)


[View source]
def self.border_styler : Border::Styler #

Default: see BORDER_STYLER)


[View source]
def self.border_styler=(border_styler : Border::Styler) #

Default: see BORDER_STYLER)


[View source]
def self.column_width : Int32 #

(Default: see COLUMN_WIDTH)


[View source]
def self.column_width=(column_width : Int32) #

(Default: see COLUMN_WIDTH)


[View source]
def self.footer : Heading #

(Default: see FOOTER)


[View source]
def self.footer=(footer : Heading) #

(Default: see FOOTER)


[View source]
def self.group_alignment : Justify #

Default: see GROUP_ALIGNMENT)


[View source]
def self.group_alignment=(group_alignment : Justify) #

Default: see GROUP_ALIGNMENT)


[View source]
def self.group_formatter : Cell::Text::Formatter #

Default: see GROUP_FORMATTER)


[View source]
def self.group_formatter=(group_formatter : Cell::Text::Formatter) #

Default: see GROUP_FORMATTER)


[View source]
def self.group_styler : Cell::Text::Styler #

Default: see GROUP_STYLER)


[View source]
def self.group_styler=(group_styler : Cell::Text::Styler) #

Default: see GROUP_STYLER)


[View source]
def self.header_alignment : Justify | Nil #

(Default: see HEADER_ALIGNMENT)


[View source]
def self.header_alignment=(header_alignment : Justify | Nil) #

(Default: see HEADER_ALIGNMENT)


[View source]
def self.header_formatter : Cell::Data::Formatter #

Default: see HEADER_FORMATTER)


[View source]
def self.header_formatter=(header_formatter : Cell::Data::Formatter) #

Default: see HEADER_FORMATTER)


[View source]
def self.header_frequency : Int32 | Nil #

(Default: see HEADER_FREQUENCY)


[View source]
def self.header_frequency=(header_frequency : Int32 | Nil) #

(Default: see HEADER_FREQUENCY)


[View source]
def self.header_styler : Cell::Data::Styler #

Default: see HEADER_STYLER)


[View source]
def self.header_styler=(header_styler : Cell::Data::Styler) #

Default: see HEADER_STYLER)


[View source]
def self.header_wrap : Int32 | Nil #

(Default: see HEADER_WRAP)


[View source]
def self.header_wrap=(header_wrap : Int32 | Nil) #

(Default: see HEADER_WRAP)


[View source]
def self.heading_alignment : Justify #

Default: see HEADING_ALIGNMENT)


[View source]
def self.heading_alignment=(heading_alignment : Justify) #

Default: see HEADING_ALIGNMENT)


[View source]
def self.heading_formatter : Cell::Text::Formatter #

Default: see HEADING_FORMATTER)


[View source]
def self.heading_formatter=(heading_formatter : Cell::Text::Formatter) #

Default: see HEADING_FORMATTER)


[View source]
def self.heading_styler : Cell::Text::Styler #

Default: see HEADING_STYLER)


[View source]
def self.heading_styler=(heading_styler : Cell::Text::Styler) #

Default: see HEADING_STYLER)


[View source]
def self.left_padding : Int32 #

(Default: see LEFT_PADDING)


[View source]
def self.left_padding=(left_padding : Int32) #

(Default: see LEFT_PADDING)


[View source]
def self.masked_headers=(masked_headers : Bool) #

(Default: see MASKED_HEADERS)


[View source]
def self.masked_headers? : Bool #

(Default: see MASKED_HEADERS)


[View source]
def self.omit_group_header_rule=(omit_group_header_rule : Bool) #

(Default: see OMIT_GROUP_HEADER_RULE


[View source]
def self.omit_group_header_rule? : Bool #

(Default: see OMIT_GROUP_HEADER_RULE


[View source]
def self.omit_last_rule=(omit_last_rule : Bool) #

Default: see OMIT_LAST_RULE)


[View source]
def self.omit_last_rule? : Bool #

Default: see OMIT_LAST_RULE)


[View source]
def self.padding_character : String #

(Default: see PADDING_CHARACTER)


[View source]
def self.padding_character=(padding_character : String) #

(Default: see PADDING_CHARACTER)


[View source]
def self.right_padding : Int32 #

(Default: see RIGHT_PADDING)


[View source]
def self.right_padding=(right_padding : Int32) #

(Default: see RIGHT_PADDING)


[View source]
def self.row_divider_frequency : Int32 | Nil #

(Default: see ROW_DIVIDER_FREQUENCY)


[View source]
def self.row_divider_frequency=(row_divider_frequency : Int32 | Nil) #

(Default: see ROW_DIVIDER_FREQUENCY)


[View source]
def self.subtitle : Heading #

(Default: see SUBTITLE)


[View source]
def self.subtitle=(subtitle : Heading) #

(Default: see SUBTITLE)


[View source]
def self.title : Heading #

(Default: see TITLE)


[View source]
def self.title=(title : Heading) #

(Default: see TITLE)


[View source]
def self.truncation_indicator : String #

(Default: see TRUNCATION_INDICATOR)


[View source]
def self.truncation_indicator=(truncation_indicator : String) #

(Default: see TRUNCATION_INDICATOR)


[View source]
def self.wrap_mode : WrapMode #

(Default: see WRAP_MODE)


[View source]
def self.wrap_mode=(wrap_mode : WrapMode) #

(Default: see WRAP_MODE)


[View source]