Mòdul de comunitat impressionant

Taula Ascii

Estat de la compilació devDependency Status Versió NPM

Fàcil sortida de la taula per a la depuració de nodes, però probablement en podreu fer més, ja que només és una cadena.

Taula de continguts

Ús

Node.js

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

Navegador

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

Nota : si s’utilitza al navegador, es col·locarà a sotawindow.AsciiTable

Exemple

Ús bàsic

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 | '----------------'

També podem fer una taula senzilla sense títol ni encapçalaments.

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

Vegeu: AsciiTable.factoryper obtenir detalls sobre la instanciació

AsciiTable.factory ([títol], [opcions])

Creador d’instàncies de taula

  • title-títol de la taula (opcional, predeterminat null)
  • options -opcions de taula (opcional)
    • prefix -prefix de cadena per afegir a cada línia del render

Nota: Si es passa un objecte en lloc detitle,fromJSON es farà servirelmètode per omplir la taula.

Exemple:

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 (direcció, val, len, [pad])

Drecera a un dels tres mètodes següents

  • direction- direcció d'alineació ( AsciiTable.LEFT, AsciiTable.CENTER, AsciiTable.RIGHT)
  • val -cord per alinear
  • len -Longitud total de la cadena creada
  • pad-carregat de farciment / omplert (opcional, per defecte ' ')

Exemple:

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

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

  • val -cord per alinear
  • len -Longitud total de la cadena creada
  • pad-carregat de farciment / omplert (opcional, per defecte ' ')

Exemple:

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

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

  • val -cord per alinear
  • len -Longitud total de la cadena creada
  • pad-carregat de farciment / omplert (opcional, per defecte ' ')

Exemple:

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

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

  • val -cord per alinear
  • len -Longitud total de la cadena creada
  • pad-carregat de farciment / omplert (opcional, per defecte ' ')

Exemple:

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

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

Intenteu fer un alineament intel·ligent de la informació proporcionada val; l’ Stringentrada quedarà alineada a l’esquerra i els Numbertipus s’alinearan a la dreta.

  • val -cord per alinear
  • len -Longitud total de la cadena creada
  • pad-carregat de farciment / omplert (opcional, per defecte ' ')

Exemple:

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

AsciiTable.arrayFill (len, [val])

Creeu una nova matriu a la len donada, plena del valor donat, principalment utilitzada internament

  • len -largitud de la matriu
  • val valor de farciment (opcional)

Exemple:

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

Instance Methods

instance.setBorder ([vora], [omplir], [superior], [inferior])

Establiu els caràcters de la vora per a la representació, si no es passen arguments, es restabliran als valors predeterminats. Si edgees passa un argument únic , s'utilitzarà per a totes les vores.

  • edge-arestes horitzontals (opcional, per defecte |)
  • fill-arestes verticals (opcional, per defecte -)
  • top- cantonades superiors (opcional, per defecte .)
  • bottom-cantons inferiors (opcional, per defecte ')

Exemple:

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

Exemple:

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, direcció)

  • idx -índex de columna per alinear
  • direction- direcció d'alineació, ( AsciiTable.LEFT, AsciiTable.CENTER, AsciiTable.RIGHT)

Exemple:

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)

Àlies de instance.setAlign(idx, AsciiTable.LEFT)

instance.setAlignCenter (idx)

Àlies de instance.setAlign(idx, AsciiTable.CENTER)

instance.setAlignRight (idx)

Àlies de instance.setAlign(idx, AsciiTable.RIGHT)

instance.setTitle (títol)

  • title -títol de taula

Exemple:

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

instance.getTitle ()

Obteniu el títol actual de la taula

Exemple:

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

instance.setTitleAlign (direcció)

  • direction -direcció d'alineació de la taula

Exemple:

1

instance.setTitleAlignLeft ()

Àlies de instance.setTitleAlign(AsciiTable.LEFT)

instance.setTitleAlignCenter ()

Àlies de instance.setTitleAlign(AsciiTable.CENTER)

instance.setTitleAlignRight ()

Àlies de instance.setTitleAlign(AsciiTable.RIGHT)

instance.sort (iterador)

  • iterator -mètode de classificació per executar contra les files

Exemple:

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 (índex, iterador)

Drecera d'ordenació per orientar una columna específica

  • index -column idx per ordenar
  • iterator -mètode de classificació per executar contra valors de columna

Exemple:

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

instance.setHeading (encapçalament, [...])

Establiu els encapçalaments de columna de la taula i adopta els arguments de la mateixa manera que addRow

  • heading -matriu o arguments de capçalera

Exemple:

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

instance.setHeadingAlign (direcció)

  • direction -

Exemple:

1

instance.setHeadingAlignLeft ()

Àlies de instance.setHeadingAlignLeft(AsciiTable.LEFT)

instance.setHeadingAlignCenter ()

Àlies de instance.setHeadingAlignLeft(AsciiTable.CENTER)

instance.setHeadingAlignRight ()

Àlies de instance.setHeadingAlignLeft(AsciiTable.RIGHT)

instance.addRow (fila, [...])

Les files es poden afegir mitjançant un únic argument de matriu, o els arguments si s’utilitzen múltiples argumentacions quan es crida al mètode.

  • row -matriu o arguments de valors de columna

Exemple:

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

addRowFuncionament massiu

  • rows -Multidimentional array de files

Exemple:

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

instance.setJustify (activat)

Justifiqueu que totes les columnes tinguin la mateixa amplada

  • enabled-boole per activar o desactivar justify, undefinedconsiderat cert

Exemple:

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

instance.toString ()

Representeu la instància com una cadena de sortida

Àlies : [ valueOf, render]

instance.toJSON ()

Torneu la representació JSON de la taula, això també ens permet trucar JSON.stringifya la instància.

Exemple:

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)

Poblar la taula des de l'objecte json, hauria de coincidir amb la toJSONsortida anterior.

Àlies : [ parse]

Exemple:

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

Esborra / restableix totes les dades de la taula

Àlies : [ reset]

instance.clearRows ()

Restableix totes les dades de files, manté el títol i els encapçalaments.

Instal·la

Amb npm

1
npm install ascii-table

Col·laboradors

Matthew Oliveira Peter Daum

Llicència

(La llicència MIT)

Copyright (c) 2013 Beau Sorensen

Es concedeix, de manera gratuïta, permís a qualsevol persona que obtingui una còpia d’aquest programari i dels fitxers de documentació associats (el “programari”) per tractar el programari sense restriccions, inclosos, sense limitacions, els drets d’ús, còpia, modificació, combinació , publicar, distribuir, subllicenciar i / o vendre còpies del programari i permetre que les persones a les quals es proporciona el programari ho facin, amb les següents condicions:

L’avís de copyright anterior i aquest avís de permís s’inclouran a totes les còpies o parts importants del programari.

EL PROGRAMARI ES PROPORCIONA “SÓN”, SENSE GARANTIA DE NINGÚN TIPUS, EXPRESA O IMPLÍCITA, INCLOSA PERUT NO LIMITADA A LES GARANTIES DE COMERCIALITAT, IDONEITAT PER A UN PROPOSESIT PARTICULAR I NO INFRACCIÓ. DANYS O ALTRES RESPONSABILITATS, SIGUIN EN UNA ACCIÓ DE CONTRACTE, TORT O ALTRES, SORTIDES DE, FUENT O EN RELACIÓ AMB EL PROGRAMARI O L'ÚS O ALTRES TRACTAMENTS DEL PROGRAMARI.