DocTable class

Represents table, similar to an HTML <table> element.

DocTable

Summary

Represents table, similar to an HTML <table> element.

Signature

export declare class DocTable extends DocNode 

Constructors

constructor

Constructs a new instance of the class

Properties

header

Modifiers: readonly Type:readonly header: DocTableRow; Default: “

kind

Modifiers: readonly Type:get kind(): string; Default: “

rows

Modifiers: readonly Type:get rows(): ReadonlyArray<DocTableRow>; Default: “

Methods

addRow

createAndAddRow

onGetChildNodes

Modifiers: protected

Events

No events defined.

Remarks

Tables must have a header with at least one cell. Rows are optional during construction but tables are typically rendered with data rows. Use [object Object] or [object Object] to add rows after construction.

Examples

Example 1

Related Documentation

• Custom AST nodes architecture
• TSDoc reference