Удивительный модуль сообщества

Ascii Table

Статус сборки Состояние devDependency Версия NPM

Простой вывод таблицы для отладки узлов, но вы, вероятно, могли бы сделать с ней больше, поскольку это всего лишь строка.

Оглавление

Применение

Node.js

1
var AsciiTable = require('ascii-table')

браузер

1
<script src="ascii-table.min.js"></script>

Примечание . При использовании в браузере он будет помещен в window.AsciiTable

пример

Основное использование

1 2 3 4 5 6 7 8
var table = new AsciiTable('A Title') table .setHeading('', 'Name', 'Age') .addRow(1, 'Bob', 52) .addRow(2, 'John', 34) .addRow(3, 'Jim', 83) console.log(table.toString())
1 2 3 4 5 6 7 8 9
.----------------. | A Title | |----------------| | | Name | Age | |---|------|-----| | 1 | Bob | 52 | | 2 | John | 34 | | 3 | Jim | 83 | '----------------'

Мы можем сделать простую таблицу без заголовка или заголовков.

1 2 3 4 5 6 7 8 9 10
var table = new AsciiTable() table .addRow('a', 'apple', 'Some longer string') .addRow('b', 'banana', 'hi') .addRow('c', 'carrot', 'meow') .addRow('e', 'elephants') console.log(table.toString())
1 2 3 4 5 6
.------------------------------------. | a | apple | Some longer string | | b | banana | hi | | c | carrot | meow | | e | elephants | | '------------------------------------'

API

Static Methods

AsciiTable

Смотрите: AsciiTable.factory для подробностей по реализации

AsciiTable.factory ([title], [options])

Создатель экземпляра таблицы

  • title -table title (необязательно, по умолчанию null )
  • options -table options (необязательно)
    • prefix -string префикс для добавления к каждой строке при рендеринге

Примечание. Если вместо title fromJSON , для заполнения таблицы будет использоваться метод fromJSON .

Пример:

1 2 3 4 5 6 7 8 9 10
var table = AsciiTable.factory('title') var table = AsciiTable.factory({ title: 'Title' , heading: [ 'id', 'name' ] , rows: [ [ 1, 'Bob' ] , [ 2, 'Steve' ] ] })

AsciiTable.align (direction, val, len, [pad])

Ярлык к одному из трех следующих методов

  • direction выравнивания ( AsciiTable.LEFT , AsciiTable.CENTER , AsciiTable.RIGHT )
  • val строка для выравнивания
  • len общая длина создаваемой строки
  • pad -padding / fill char (необязательно, по умолчанию ' ' )

Пример:

1
table.align(AsciiTable.LEFT, 'hey', 7) // 'hey '

AsciiTable.alignLeft (val, len, [pad])

  • val строка для выравнивания
  • len общая длина создаваемой строки
  • pad -padding / fill char (необязательно, по умолчанию ' ' )

Пример:

1
table.alignLeft('hey', 7, '-') // 'hey----'

AsciiTable.alignCenter (val, len, [pad])

  • val строка для выравнивания
  • len общая длина создаваемой строки
  • pad -padding / fill char (необязательно, по умолчанию ' ' )

Пример:

1
table.alignCenter('hey', 7) // ' hey '

AsciiTable.alignRight (val, len, [pad])

  • val строка для выравнивания
  • len общая длина создаваемой строки
  • pad -padding / fill char (необязательно, по умолчанию ' ' )

Пример:

1
table.alignRight('hey', 7) // ' hey'

AsciiTable.alignAuto (val, len, [pad])

Попытайтесь выполнить интеллектуальное выравнивание val , String ввод будет выровнен по левому краю, типы Number будут выровнены по правому краю.

  • val строка для выравнивания
  • len общая длина создаваемой строки
  • pad -padding / fill char (необязательно, по умолчанию ' ' )

Пример:

1
table.align(AsciiTable.LEFT, 'hey', 7) // 'hey '

AsciiTable.arrayFill (len, [val])

Создайте новый массив в данном len, заполненный данным значением, в основном используемый для внутренних целей.

  • len длина массива
  • val -fill value (необязательно)

Пример:

1
AsciiTable.arrayFill(4, 0) // [0, 0, 0, 0]

Instance Methods

instance.setBorder ([edge], [fill], [top], [bottom])

Установите символы границы для рендеринга, если аргументы не переданы, они будут сброшены к значениям по умолчанию. Если передан один аргумент edge , он будет использоваться для всех границ.

  • edge горизонтальные ребра (необязательно, по умолчанию | )
  • форма fill - Vertical Number of Edges (необязательно, по умолчанию - )
  • top углы (необязательно, по умолчанию . )
  • bottom нижний угол (необязательно, по умолчанию ' )

Пример:

1 2 3 4 5 6 7
var table = new AsciiTable('Stars') table .setBorder('*') .setHeading('oh', 'look') .addRow('so much', 'star power') console.log(table.toString())
1 2 3 4 5 6 7
************************ * Stars * ************************ * oh * look * ************************ * so much * star power * ************************

instance.removeBorder ()

Пример:

1 2 3
table.removeBorder() console.log('' + table)
1 2 3 4 5 6
# Fruit Thing --- ----------- -------------------- a apple Some longer string b banana hi c carrot meow e elephants

instance.setAlign (idx, direction)

  • idx -column index для выравнивания
  • direction -alignment direction, ( AsciiTable.LEFT , AsciiTable.CENTER , AsciiTable.RIGHT )

Пример:

1 2 3 4 5
table .setAlign(2, AsciiTable.RIGHT) .setAlign(1, AsciiTable.CENTER) console.log(table.toString())
1 2 3 4 5 6
.-------------------------------------. | a | apple | Some longer string | | b | banana | hi | | c | carrot | meow | | e | elephants | | '-------------------------------------'

instance.setAlignLeft (IDX)

Псевдоним instance.setAlign(idx, AsciiTable.LEFT)

instance.setAlignCenter (IDX)

Псевдоним instance.setAlign(idx, AsciiTable.CENTER)

instance.setAlignRight (IDX)

Псевдоним instance.setAlign(idx, AsciiTable.RIGHT)

instance.setTitle (название)

  • title -table title

Пример:

1 2 3
var table = new AsciiTable('Old Title') table.setTitle('New Title')

instance.getTitle ()

Получить текущий заголовок таблицы

Пример:

1
table.getTitle() // 'New Title'

instance.setTitleAlign (направление)

  • direction выравнивания

Пример:

1

instance.setTitleAlignLeft ()

Псевдоним instance.setTitleAlign(AsciiTable.LEFT)

instance.setTitleAlignCenter ()

Псевдоним instance.setTitleAlign(AsciiTable.CENTER)

instance.setTitleAlignRight ()

Псевдоним instance.setTitleAlign(AsciiTable.RIGHT)

instance.sort (итератор)

  • метод сортировки iterator для запуска по строкам

Пример:

1 2 3 4
table.sort(function(a, b) { return a[2] - b[2] }) console.log(table.toString())
1 2 3 4 5
.----------------. | 2 | John | 34 | | 1 | Bob | 52 | | 3 | Jim | 83 | '----------------'

instance.sortColumn (index, iterator)

Ярлык сортировки для таргетинга на определенный столбец

  • index -column idx для сортировки
  • метод сортировки iterator для запуска значений столбца

Пример:

1 2 3 4
// This is quivalent to the `sort` example above table.sortColumn(2, function(a, b) { return a - b })

instance.setHeading (заголовок, [...])

Установить заголовки столбцов для таблицы, принимает аргументы так же, как addRow

  • heading заголовочный массив или аргументы

Пример:

1 2 3 4 5
table.setHeading('ID', 'Key', 'Value') // or: table.setHeading(['ID', 'Key', 'Value'])

instance.setHeadingAlign (направление)

  • direction

Пример:

1

instance.setHeadingAlignLeft ()

Псевдоним instance.setHeadingAlignLeft(AsciiTable.LEFT)

instance.setHeadingAlignCenter ()

Псевдоним к instance.setHeadingAlignLeft(AsciiTable.CENTER)

instance.setHeadingAlignRight ()

Псевдоним instance.setHeadingAlignLeft(AsciiTable.RIGHT)

instance.addRow (строка, [...])

Строки могут быть добавлены с использованием одного аргумента массива или аргументов, если при вызове метода используется несколько аргументов.

  • row -array или аргументы значений столбцов

Пример:

1 2 3 4 5 6 7
var table = new AsciiTable() table .addRow(1, 'Bob', 52) .addRow([2, 'John', 34]) console.log(table.render())
1 2 3 4
.---------------. | 1 | Bob | 52 | | 2 | John | 34 | '---------------'

instance.addRowMatrix (строки)

Массовая операция addRow

  • rows -multidimentional массив строк

Пример:

1 2 3 4 5
table.addRowMatrix([ [2, 'John', 34] , [3, 'Jim', 83] ])

instance.setJustify (включен)

Обоснуйте все столбцы одинаковой ширины

  • enabled -boolean для включения или выключения выравнивания, undefined считается истинным

Пример:

1 2 3 4 5
table .addRow('1', 'two', 'three') .setJustify() console.log(table.toString())
1 2 3
.-----------------------. | 1 | two | three | '-----------------------'

instance.toString ()

Визуализировать экземпляр как строку для вывода

Псевдоним : [ valueOf , render ]

instance.toJSON ()

Возвращает JSON-представление таблицы, это также позволяет нам вызывать JSON.stringify для экземпляра.

Пример:

1 2 3 4 5 6 7 8 9
var table = new AsciiTable('Title') table .setHeading('id', 'name') .addRow(1, 'Bob') .addRow(2, 'Steve') console.log(table.toJSON()) console.log(JSON.stringify(table))
1 2 3 4 5 6 7 8
{ title: 'Title' , heading: [ 'id', 'name' ] , rows: [ [ 1, 'Bob' ] , [ 2, 'Steve' ] ] }
1
{"title":"Title","heading":["id","name"],"rows":[[1,"Bob"],[2,"Steve"]]}

instance.fromJSON (OBJ)

toJSON таблицу из объекта json, должно соответствовать toJSON выше.

Псевдоним : [ parse ]

Пример:

1 2 3 4 5 6 7 8
var table = new AsciiTable().fromJSON({ title: 'Title' , heading: [ 'id', 'name' ] , rows: [ [ 1, 'Bob' ] , [ 2, 'Steve' ] ] })

instance.clear ()

Очистить / сбросить все данные таблицы

Псевдоним : [ reset ]

instance.clearRows ()

Сбросить все данные строки, поддерживает заголовок и заголовки.

устанавливать

С нпм

1
npm install ascii-table

Авторы

Мэтью Оливейра Питер Даум

Лицензия

(Лицензия MIT)

Copyright (c) 2013 Бо Соренсен

Настоящим предоставляется бесплатное разрешение любому лицу, получающему копию этого программного обеспечения и связанных с ним файлов документации («Программное обеспечение»), осуществлять операции с Программным обеспечением без ограничений, включая, помимо прочего, права на использование, копирование, изменение, слияние. публиковать, распространять, сублицензировать и / или продавать копии Программного обеспечения, а также разрешать лицам, которым предоставляется Программное обеспечение, делать это при соблюдении следующих условий:

Вышеуказанное уведомление об авторских правах и это уведомление о разрешении должны быть включены во все копии или существенные части Программного обеспечения.

ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЯ ГАРАНТИЙ ТОРГОВЛИ, ФИТНЕСА ДЛЯ ОСОБЫХ ЦЕЛЕЙ И НЕТРАБОТКИ. ПРЕТЕНЗИИ, УЩЕРБ ИЛИ ДРУГОЙ ОТВЕТСТВЕННОСТИ, В СООТВЕТСТВИИ С ДЕЙСТВИЕМ ДОГОВОРА, ИСПРАВЛЕНИЯ ИЛИ ИНОГО, ПРОИЗВЕДЕНИЯ, ИЛИ В СВЯЗИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ, ИЛИ ИСПОЛЬЗОВАНИЕМ ИЛИ ДРУГИМИ УЧАСТКАМИ В ПРОГРАММНОМ ОБЕСПЕЧЕНИИ.