TableToken (EN)

Table of Contents

• Introduction
• Properties
  • closed ✅
• Methods
  • lint ✅
  • getAllRows ✅
  • getNthRow ✅
  • getRowCount ✅
  • getNthCol ✅
  • close
  • cloneNode
  • escape
  • getColCount
  • getNextRow
  • toHtml

Other Languages

• 简体中文

Introduction

Table.

✅ Available in the Mini and Browser versions.

Properties

closed

✅ Expand

type: boolean
Whether the table is closed.

// closed
var {firstChild} = Parser.parse('{|\n!a');
assert.equal(firstChild, '{|\n!a');
assert(!firstChild.closed);

// closed (main)
var {firstChild} = Parser.parse('{|\n!a');
firstChild.closed = true;
assert.equal(firstChild, '{|\n!a\n|}');

Methods

lint

✅ Expand

returns: LintError[]
Report potential grammar errors.

// lint
var {firstChild} = Parser.parse('{|\na\n|a\n|-\n|b||c');
assert.equal(firstChild, '{|\na\n|a\n|-\n|b||c');
assert.deepStrictEqual(firstChild.lint(), [
	{
		rule: 'fostered-content',
		severity: 'error',
		message: 'content to be moved out from the table',
		startLine: 1,
		startCol: 0,
		startIndex: 3,
		endLine: 1,
		endCol: 1,
		endIndex: 4,
	},
	{
		rule: 'unclosed-table',
		severity: 'error',
		message: 'unclosed table',
		startLine: 0,
		startCol: 0,
		startIndex: 0,
		endLine: 0,
		endCol: 2,
		endIndex: 2,
	},
	{
		rule: 'table-layout',
		severity: 'warning',
		message: 'inconsistent table layout',
		startLine: 3,
		startCol: 0,
		startIndex: 8,
		endLine: 4,
		endCol: 5,
		endIndex: 16,
	},
]);

getAllRows

✅ Expand

returns: TdToken[]
Get all rows.

// getAllRows
var {firstChild} = Parser.parse('{|\n!a\n|-\n|b\n|}'),
	tr = firstChild.querySelector('tr');
assert.equal(firstChild, '{|\n!a\n|-\n|b\n|}');
assert.deepStrictEqual(firstChild.getAllRows(), [firstChild, tr]);

getNthRow

✅ Expand

param: number Row number
returns: TrToken
Get the nth row.

// getNthRow
var {firstChild} = Parser.parse('{|\n!a\n|-\n|b\n|}'),
	tr = firstChild.querySelector('tr');
assert.equal(firstChild, '{|\n!a\n|-\n|b\n|}');
assert.strictEqual(firstChild.getNthRow(0), firstChild);
assert.strictEqual(firstChild.getNthRow(1), tr);

getRowCount

✅ Expand

returns: number
Get the number of rows.

// getRowCount
var {firstChild} = Parser.parse('{|\n|a\n|-\n|}');
assert.equal(firstChild, '{|\n|a\n|-\n|}');
// The first row can be the table itself. Empty rows are not counted.
assert.strictEqual(firstChild.getRowCount(), 1);

getNthCol

✅ Expand

param: number Column number
returns: TdToken
Get the nth column. Only for TableToken itself when used as a row.

// getNthCol
var {firstChild} = Parser.parse('{|\n!a\n|}'),
	td = firstChild.querySelector('td');
assert.equal(firstChild, '{|\n!a\n|}');
assert.strictEqual(firstChild.getNthCol(0), td);

close

Expand

Close the table.

// close (main)
var {firstChild} = Parser.parse('{|\n!a');
assert.equal(firstChild, '{|\n!a');
firstChild.close();
assert.equal(firstChild, '{|\n!a\n|}');

cloneNode

Expand

returns: this
Deep clone the node.

// cloneNode (main)
var {firstChild} = Parser.parse('{|\n!a');
assert.equal(firstChild, '{|\n!a');
assert.deepStrictEqual(firstChild.cloneNode(), firstChild);

escape

Expand

Escape table syntax.

// escape (main)
var {firstChild} = Parser.parse('{|\n|-\n|a\n|}');
assert.equal(firstChild, '{|\n|-\n|a\n|}');
firstChild.escape();
assert.equal(firstChild, '{{{!}}\n{{!}}-\n{{!}}a\n{{!}}}');

getColCount

Expand

returns: number
Get the number of columns. Only for TableToken itself when used as a row.

// getColCount (main)
var {firstChild} = Parser.parse('{|\n|a\n|}');
assert.equal(firstChild, '{|\n|a\n|}');
assert.strictEqual(firstChild.getColCount(), 1);

getNextRow

Expand

returns: TrToken
Get the next row (the row directly after the table itself).

// getNextRow (main)
var {firstChild} = Parser.parse('{|\n|-\n|a\n|}'),
	tr = firstChild.querySelector('tr');
assert.equal(firstChild, '{|\n|-\n|a\n|}');
assert.strictEqual(firstChild.getNextRow(), tr);

toHtml

Expand

version added: 1.10.0

returns: string
Convert to HTML.

// toHtml (main)
var {firstChild} = Parser.parse('{|id=t\na\nb\n|c\n|-\nd\ne\n|-\n|f\n|}');
assert.strictEqual(
	firstChild.toHtml(),
	`a b d e<table id="t">\n<tbody><tr>\n<td >c\n</td></tr><tr >\n<td >f\n</td></tr></tbody></table>`,
);