table/tablecolumnresize/utils

Clamps the number within the inclusive lower (min) and upper (max) bounds. Returned number is rounded using the toPrecision() function.

Parameters

number : number

A number to be clamped.

min : number

A lower bound.

max : number

An upper bound.

Returns

number

The clamped number.

Creates an array with defined length and fills all elements with defined value.

Type parameters

T

Parameters

length : number

The length of the array.

value : T

The value to fill the array with.

Returns

Array<T>

An array with defined length and filled with defined value.

Returns all the inserted or changed table model elements in a given change set. Only the tables with 'columnsWidth' attribute are taken into account. The returned set may be empty.

Most notably if an entire table is removed it will not be included in returned set.

Parameters

model : Model

The model to collect the affected elements from.

Returns

Set<ModelElement>

A set of table model elements.

Returns the column indexes on the left and right edges of a cell. They differ if the cell spans across multiple columns.

Parameters

cell : ModelElement

A table cell model element.

tableUtils : TableUtils

The Table Utils plugin instance.

Returns

object

An object containing the indexes of the left and right edges of the cell.

Returns a 'tableColumnGroup' element from the 'table'.

Parameters

element : ModelElement

A 'table' or 'tableColumnGroup' element.

Returns

ModelElement

A 'tableColumnGroup' element.

Calculates the percentage of the minimum column width given in pixels for a given table.

Parameters

modelTable : ModelElement

A table model element.

editor : Editor

The editor instance.

Returns

number

The minimal column width in percentage.

Calculates the total horizontal space taken by the cell. That includes:

• width,
• left and red padding,
• border width.

Parameters

domCell : HTMLElement

A DOM cell element.

Returns

number

Width in pixels without px at the end.

Returns the inner pixel width of a given editing root, or null if the root has no DOM element attached yet (e.g. it hasn't been rendered for the first time).

Parameters

editor : Editor

rootName : string

Returns

number | null

Returns the computed width (in pixels) of the DOM element without padding and borders.

Parameters

domElement : HTMLElement

A DOM element.

Returns

number

The width of the DOM element in pixels.

Returns an array of 'tableColumn' elements. It may be empty if there's no tableColumnGroup element.

Parameters

element : ModelElement

A 'table' or 'tableColumnGroup' element.

Returns

Array<ModelElement>

An array of 'tableColumn' elements.

Returns an array of table column widths.

Parameters

element : ModelElement

A 'table' or 'tableColumnGroup' element.

Returns

Array<string>

An array of table column widths.

Calculates the table width in pixels.

Parameters

modelTable : ModelElement

A table model element.

editor : Editor

The editor instance.

Returns

number

The width of the table in pixels.

Tells whether the given column widths are expressed in pixels.

Parameters

columnWidths : Array<string>

An array of column widths.

Returns

boolean

Tells whether a table is in the pixel width mode, that is, its tableWidth attribute is expressed in pixels. The tableWidth unit is the single source of truth for the whole table's width mode.

Parameters

table : ModelElement

A 'table' model element.

Returns

boolean

Makes sure that the sum of the widths from all columns is 100%. If the sum of all the widths is not equal 100%, all the widths are changed proportionally so that they all sum back to 100%. If there are columns without specified width, the amount remaining after assigning the known widths will be distributed equally between them.

Parameters

columnWidths : Array<string>

An array of column widths.

Returns

Array<string>

An array of column widths guaranteed to sum up to 100%.

Removes the tableCellWidth attribute from every cell of the given table. Once a column is resized (with the resize handler or the column-width command), a per-cell width is obsolete - the column width governs the layout - so it is dropped to keep the model clean.

Parameters

writer : ModelWriter

table : ModelElement

Returns

void

Sums all array values that can be parsed to a float.

Parameters

array : Array<string | number>

An array of numbers.

Returns

number

The sum of all array values.

Rounds the provided value to a fixed-point number with defined number of digits after the decimal point.

Parameters

value : string | number

A number to be rounded.

Returns

number

The rounded number.

Translates the colSpan model attribute into additional column widths and returns the resulting array.

Parameters

element : ModelElement

A 'table' or 'tableColumnGroup' element.

writer : ModelWriter

A writer instance.

Returns

Array<string>

An array of table column widths.

Updates column elements to match columns widths.

Parameters

columns : Array<ModelElement>

tableColumnGroup : ModelElement

normalizedWidths : Array<string>

writer : ModelWriter

Returns

void