素晴らしいコミュニティモジュール

アスキーテーブル

ビルドステータス 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-テーブルのタイトル (オプション、デフォルトnull)
  • options -table オプション (オプション)
    • prefix -レンダリング時に各行に追加する文字列プレフィックス

注: の代わりにオブジェクトが渡されるtitleと、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(方向, val, len, [パッド])

次の 3 つの方法のいずれかへのショートカット

  • direction- 整列方向 ( AsciiTable.LEFTAsciiTable.CENTERAsciiTable.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])

提供のインテリジェントなアライメントを行うしようとvalString入力は、左詰めされるNumberタイプが右揃えされます。

  • val -整列する文字列
  • len -作成された文字列の合計の長さ
  • pad-padding / fill char (オプション、デフォルト' ')

例:

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

AsciiTable.arrayFill(len, [val])

与えられたlenに新しい配列を作成し、与えられた値を入れ、主に内部的に使用します

  • len -配列の長さ
  • val -fill 値 (オプション)

例:

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

Instance Methods

instance.setBorder([エッジ]、[フィル]、[トップ]、[ボトム])

レンダリングする境界線の文字を設定します.引数が渡されない場合はデフォルトにリセットされます.単一のedge引数が渡された場合,すべての境界線に使用されます.

  • edge-水平エッジ (オプション、デフォルト|)
  • fill-垂直エッジ (オプション、デフォルト-)
  • 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 -整列する列インデックス
  • direction- 整列方向 ( AsciiTable.LEFTAsciiTable.CENTERAsciiTable.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 -表のタイトル

例:

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 - ソートする列 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 -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 -配列または列値の引数

例:

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 -行の多次元配列

例:

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

instance.setJustify(有効)

すべての列を同じ幅に揃える

  • enabled-正当化をオンまたはオフにするためのブール値。trueundefinedと見なされます

例:

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)

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()

すべての行データをリセットし、タイトルと見出しを維持します。

インストール

NPM

1
npm install ascii-table

貢献者

マシュー・オリベイラ ・ピーター・ダウム

ライセンス

(MITライセンス)

Copyright (c) 2013 ボー・ソレンセン

これにより、このソフトウェアおよび関連するドキュメント ファイル (「ソフトウェア」) のコピーを取得するすべての人に、使用、コピー、変更、マージの権利を含むがこれらに限定されない、制限なしにソフトウェアを取り扱うことを無料で許可します。 、公開、配布、サブライセンス、および/またはソフトウェアのコピーを販売し、ソフトウェアが提供される人に、次の条件に従って、そのようなことを許可すること:

上記の著作権表示およびこの許可通知は、本ソフトウェアのすべてのコピーまたは実質的な部分に含まれるものとします。

本ソフトウェアは「現状有姿」で提供され、明示または黙示を問わず、商品性、特定目的への適合性、および非侵害の保証を含むがこれらに限定されない、いかなる種類の保証もなしに提供されます。契約、不法行為またはその他の行為のいずれにおいても、本ソフトウェアまたは本ソフトウェアの使用またはその他の取引に起因または関連して生じる損害またはその他の責任。