Class Tablur

Hierarchy

Tablur

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Tablur(options?: ITablurOptions | boolean, debug?: boolean): Tablur

- Defined in tablur.ts:141
Parameters
- Optional options: ITablurOptions | boolean
- Optional debug: boolean
Returns Tablur

Properties

border

border: ITablurBorder

colurs

colurs: IColurs

debug

debug: boolean

options

options: ITablurOptions

rows

rows: ITablurColumn[][] = []

tokens

tokens: ITablurTokens

Methods

break

break(): this

- Defined in tablur.ts:761
Returns this

build

build(): string[]
build(width: number): string[]
build(row: ITablurColumn[], width?: number): string[]
build(rows: ITablurColumn[][], width?: number): string[]

- Defined in tablur.ts:775
Returns string[]
- Defined in tablur.ts:776
Parameters
- width: number
Returns string[]
- Defined in tablur.ts:777
Parameters
- row: ITablurColumn[]
- Optional width: number
Returns string[]
- Defined in tablur.ts:778
Parameters
- rows: ITablurColumn[][]
- Optional width: number
Returns string[]

clear

clear(): this

- Defined in tablur.ts:869
Returns this

columnize

columnize(cols: ITablurColumn[], maxWidth: number, maxColumns: number[]): object

- Defined in tablur.ts:448
Parameters
- cols: ITablurColumn[]
- maxWidth: number
- maxColumns: number[]
Returns object
- padRow: string
- row: string

Private ensureString

ensureString(val: any): any

- Defined in tablur.ts:228
Parameters
- val: any
Returns any

getBorders

getBorders(width: number, border: TablurBorder | ITablurBorder): object

- Defined in tablur.ts:252
Parameters
- width: number
- border: TablurBorder | ITablurBorder
Returns object
- bottom: string
- horizontal: string
- top: string

getMaxRow

getMaxRow(rows: ITablurColumn[] | ITablurColumn[][], widthOnly?: boolean): object

- Defined in tablur.ts:280
Parameters
- rows: ITablurColumn[] | ITablurColumn[][]
- Optional widthOnly: boolean
Returns object
- adjustment: number
- columns: undefined[]
- count: number
- width: number

Private init

init(options: ITablurOptions | boolean, debug: boolean): void

- Defined in tablur.ts:147
Parameters
- options: ITablurOptions | boolean
- debug: boolean
Returns void

normalize

normalize(column: ITablurColumn): ITablurColumn[]
normalize(columns: TablurType[] | ITablurColumn[], globals?: ITablurColumnGlobal): ITablurColumn[]
normalize(text: TablurType): ITablurColumn[]
normalize(text: TablurType, align: TablurAlign, padding?: TablurPadding): ITablurColumn[]
normalize(text: TablurType, width: number, align?: TablurAlign, padding?: TablurPadding): ITablurColumn[]

- Defined in tablur.ts:334
Parameters
- column: ITablurColumn
Returns ITablurColumn[]
- Defined in tablur.ts:335
Parameters
- columns: TablurType[] | ITablurColumn[]
- Optional globals: ITablurColumnGlobal
Returns ITablurColumn[]
- Defined in tablur.ts:336
Parameters
- text: TablurType
Returns ITablurColumn[]
- Defined in tablur.ts:337
Parameters
- text: TablurType
- align: TablurAlign
- Optional padding: TablurPadding
Returns ITablurColumn[]
- Defined in tablur.ts:338
Parameters
- text: TablurType
- width: number
- Optional align: TablurAlign
- Optional padding: TablurPadding
Returns ITablurColumn[]

Private pad

pad(str: string, dir: TablurAlign, width: number, char?: string): string

- Defined in tablur.ts:172
Parameters
- str: string
- dir: TablurAlign
- width: number
- Default value char: string = " "
Returns string

padCenter

padCenter(str: string, width: number, char: string): string

- Defined in tablur.ts:244
Parameters
- str: string
- width: number
- char: string
Returns string

padLeft

padLeft(str: string, width: number, char: string): string

- Defined in tablur.ts:240
Parameters
- str: string
- width: number
- char: string
Returns string

padRight

padRight(str: string, width: number, char: string): string

- Defined in tablur.ts:248
Parameters
- str: string
- width: number
- char: string
Returns string

render

render(wrap?: boolean): this

- Defined in tablur.ts:861
Parameters
- Optional wrap: boolean
Returns this

repeat

repeat(text: string): Tablur
repeat(column: ITablurColumn): Tablur
repeat(text: string, padding: TablurPadding): Tablur
repeat(text: string, align: TablurAlign, padding?: TablurPadding): Tablur

- Defined in tablur.ts:724
Parameters
- text: string
Returns Tablur
- Defined in tablur.ts:725
Parameters
- column: ITablurColumn
Returns Tablur
- Defined in tablur.ts:726
Parameters
- text: string
- padding: TablurPadding
Returns Tablur
- Defined in tablur.ts:727
Parameters
- text: string
- align: TablurAlign
- Optional padding: TablurPadding
Returns Tablur

reset

reset(options?: ITablurOptions | boolean, debug?: boolean): this

- Defined in tablur.ts:874
Parameters
- Optional options: ITablurOptions | boolean
- Optional debug: boolean
Returns this

row

row(column: ITablurColumn): Tablur
row(columns: TablurType[] | ITablurColumn[], globals?: ITablurColumnGlobal): Tablur
row(text: TablurType): Tablur
row(text: TablurType, align: TablurAlign, padding?: TablurPadding): Tablur
row(text: TablurType, width: number, align?: TablurAlign, padding?: TablurPadding): Tablur

- Defined in tablur.ts:671
Parameters
- column: ITablurColumn
Returns Tablur
- Defined in tablur.ts:672
Parameters
- columns: TablurType[] | ITablurColumn[]
- Optional globals: ITablurColumnGlobal
Returns Tablur
- Defined in tablur.ts:673
Parameters
- text: TablurType
Returns Tablur
- Defined in tablur.ts:674
Parameters
- text: TablurType
- align: TablurAlign
- Optional padding: TablurPadding
Returns Tablur
- Defined in tablur.ts:675
Parameters
- text: TablurType
- width: number
- Optional align: TablurAlign
- Optional padding: TablurPadding
Returns Tablur

section

section(column: ITablurColumn): Tablur
section(text: TablurType): Tablur
section(text: TablurType, padding: TablurPadding): Tablur
section(text: TablurType, align: TablurAlign, padding?: TablurPadding): Tablur

- Defined in tablur.ts:684
Parameters
- column: ITablurColumn
Returns Tablur
- Defined in tablur.ts:685
Parameters
- text: TablurType
Returns Tablur
- Defined in tablur.ts:686
Parameters
- text: TablurType
- padding: TablurPadding
Returns Tablur
- Defined in tablur.ts:687
Parameters
- text: TablurType
- align: TablurAlign
- Optional padding: TablurPadding
Returns Tablur

Private shiftLine

shiftLine(text: string, align: string): string

- Defined in tablur.ts:195
Parameters
- text: string
- align: string
Returns string

Private stringLength

stringLength(str: string): number

- Defined in tablur.ts:216
Parameters
- str: string
Returns number

toString

toString(): string

- Defined in tablur.ts:856
Returns string

Generated using TypeDoc