evCreate API 5.7 Help

Tables

The Tables subsection of the Object section of the evCreate API includes type aliases, interfaces, and functions to create and update table items.

table namespace

The Tables subsection of the Object evCreate API section is accessed with the table namespace inside the object namespace:

evCreate.object.table.Function()

Type aliases

EvTableCellIndex

A type alias for an array of the row and column indices of a cell in a table.

Interfaces

EvTableAttributes

An interface that specifies the cells included in a table item.

EvTableCellAttributes

An interface that defines a table cell.

EvTableCellRange

An interface that specifies a continuous range of cells in the table.

Functions

ClearCellFormatting(tableObj: EvItem, cell: EvTableCellIndex, span?: EvCharSpan): Promise<void>

A function to restore the default text formatting of the characters specified by a given continuous range in a given cell of a given table item.

ClearCellRangeFormatting(tableObj: EvItem, cells: EvTableCellRange): Promise<void>

A function to restore the default text formatting of the text contents of the cells specified by a given continuous cell range in a given table item.

Create(rows: number, columns: number, bounds: EvRect, zOrder?: EvObjectZOrder, cellTexts?: string[], font?: EvFontStyle, withMarkdown?: boolean): Promise<EvItem>

A function to create a new table item of given dimensions in a given bounding box, either empty or prepopulated with given content and formatting.

GetCellTextAttributes(tableObj: EvItem, cell: EvTableCellIndex, span?: EvCharSpan): Promise<EvTextAttributes>

A function to get the text content and formatting of the characters specified by a given continuous range in a given cell of a given table item.

RemoveCellHyperlinks(tableObj: EvItem, cell: EvTableCellIndex, span?: EvCharSpan): Promise<void>

A function to remove hyperlinks from the characters specified by a given continuous range in a given cell of a given table item.

SetCellAlignment(tableObj: EvItem, cell: EvTableCellIndex, alignment: EvTextAlignment, span?: EvCharSpan): Promise<void>

A function to apply a given new text alignment to the characters specified by a given continuous range in a given cell of a given table item.

SetCellFont(tableObj: EvItem, cell: EvTableCellIndex, font: EvFontStyle, span?: EvCharSpan): Promise<void>

A function to apply a given new text formatting to the characters specified by a given continuous range in a given cell of a given table item.

SetCellHyperlink(tableObj: EvItem, cell: EvTableCellIndex, link: EvHyperlink, span?: EvCharSpan): Promise<void>

A function to attach a given hyperlink to the characters specified by a given continuous range in a given cell of a given table item.

SetCellRangeAlignment(tableObj: EvItem, cells: EvTableCellRange, alignment: EvTextAlignment): Promise<void>

A function to apply a given new text alignment to the text contents of the cells specified by a given continuous cell range in a given table item.

SetCellRangeBackground(tableObj: EvItem, cells: EvTableCellRange, background: EvFill): Promise<void>

A function to apply a given new fill to the background of the cells specified by a given continuous cell range in a given table item.

SetCellRangeFont(tableObj: EvItem, cells: EvTableCellRange, font: EvFontStyle): Promise<void>

A function to apply a given new text formatting to the text contents of the cells specified by a given continuous cell range in a given table item.

SetCellRangeText(tableObj: EvItem, cells: EvTableCellRange, texts: string[], withMarkdown?: boolean): Promise<void>

A function to replace the contents of the cells specified by a given continuous cell range in a given table item with given new text contents and Markdown formatting.

SetCellText(tableObj: EvItem, cell: EvTableCellIndex, text: string, span?: EvCharSpan, withMarkdown?: boolean): Promise<void>

A function to replace the characters specified by a given continuous range in a given cell of a given table item with given new text and Markdown formatting.

17 April 2025