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

アスキーテーブル

ビルドステータス devDependency Status NPMバージョン

ノードのデバッグ用の簡単なテーブル出力ですが、単なる文字列なので、おそらくそれでさらに多くを実行できます。

目次

使用法

Node.js

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

ブラウザ

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

:ブラウザーで使用している場合は、 window.AsciiTable下に配置されます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タイトル(オプション、デフォルトはnull
  • options -tableオプション(オプション)
    • prefix -stringプレフィックスは、レンダリング時に各行に追加します

注: 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(direction、val、len、[pad])

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

  • direction整列方向( AsciiTable.LEFTAsciiTable.CENTERAsciiTable.RIGHT
  • 整列するval -string
  • len作成された文字列の長さ-総
  • pad -padding / fill char(オプション、デフォルト' '

例:

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

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

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

例:

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

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

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

例:

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

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

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

例:

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

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

提供されたvalインテリジェントな配置を試みると、 String入力は左揃えになり、 Numberタイプは右揃えになります。

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

例:

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

AsciiTable.arrayFill(len、[val])

主に内部で使用される、指定された値で満たされた指定されたlenに新しい配列を作成

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

例:

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

Instance Methods

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

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

  • edge水平エッジ(オプション、デフォルト|
  • fill -エッジの垂直数フォ​​ーム(オプション、デフォルト-
  • top -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)

  • titleテーブルのタイトル

例:

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

instance.getTitle()

テーブルの現在のタイトルを取得します

例:

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

instance.setTitleAlign(direction)

  • directionテーブルの整列方向

例:

1

instance.setTitleAlignLeft()

instance.setTitleAlign(AsciiTable.LEFT)エイリアス

instance.setTitleAlignCenter()

instance.setTitleAlign(AsciiTable.CENTER)エイリアス

instance.setTitleAlignRight()

instance.setTitleAlign(AsciiTable.RIGHT)エイリアス

instance.sort(iterator)

  • 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列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(heading、[...])

テーブルの列見出しを設定し、 addRowと同じ方法で引数を取ります

  • heading - heading配列または引数

例:

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

instance.setHeadingAlign(direction)

  • direction

例:

1

instance.setHeadingAlignLeft()

instance.setHeadingAlignLeft(AsciiTable.LEFT)エイリアス

instance.setHeadingAlignCenter()

instance.setHeadingAlignLeft(AsciiTable.CENTER)エイリアス

instance.setHeadingAlignRight()

instance.setHeadingAlignLeft(AsciiTable.RIGHT)エイリアス

instance.addRow(row、[...])

行は、単一の配列引数、またはメソッドの呼び出し時に複数の引数が使用されている場合は引数を使用して追加できます。

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

一括addRow操作

  • rows- rows多次元配列

例:

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

instance.setJustify(有効)

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

  • enabled化-正当化をオンまたはオフにするブールundefinedundefinedはtrueと見な

例:

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

instance.toString()

インスタンスを出力用の文字列としてレンダリングします

エイリアス :[ valueOfrender ]

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 Beau Sorensen

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

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

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