Column

[ Interface ]

interface Column {
    cellBackground?: TcHmi.SolidColor | null;
    textColor?: TcHmi.SolidColor | null;
    columnData?: ColumnData | string;
    customMessage?: string;
    label?: string;
    width: number;
    widthUnit: TcHmi.Controls.Beckhoff.TcHmiDatagrid.DimensionUnitOrFactor;
    resize?: boolean;
    minWidth?: number;
    minWidthUnit?: TcHmi.DimensionUnit;
    horizontalAlignment?: TcHmi.HorizontalAlignment;
    verticalAlignment?: TcHmi.VerticalAlignment;
    format?: TcHmi.IFunction;
    headerHorizontalAlignment?: TcHmi.HorizontalAlignment;
    headerVerticalAlignment?: TcHmi.VerticalAlignment;
    ignoreEscapeSequences?: boolean;
}

Properties

Name

Type

Description

cellBackground

TcHmi.SolidColor, null, undefined

Background color of the cells in this column.

textColor

TcHmi.SolidColor, null, undefined

Text color of the cells in this column.

columnData

ColumnData, string, undefined

Data displayed in the column.

customMessage

string, undefined

User-defined message that is displayed in the column.

label

string, undefined

Name of the label for this column.

width

number

Width for this column.

widthUnit

TcHmi.Controls.Beckhoff.TcHmiDatagrid.DimensionUnitOrFactor

Unit of the width for this column.

resize

boolean, undefined

Whether the size of the column can be changed.

minWidth

number, undefined

Minimum width for this column.

minWidthUnit

TcHmi.DimensionUnit, undefined

Unit of the minimum width for this column.

horizontalAlignment

TcHmi.HorizontalAlignment, undefined

Horizontal alignment of this column.

verticalAlignment

TcHmi.VerticalAlignment, undefined

Vertical alignment of this column.

format

TcHmi.IFunction, undefined

A reference to a function that is called for each entry.

headerHorizontalAlignment

TcHmi.HorizontalAlignment, undefined

Horizontal alignment of this head cell.

headerVerticalAlignment

TcHmi.VerticalAlignment, undefined

Vertical alignment of this head cell.

ignoreEscapeSequences

boolean, undefined

If this option is set to "true", a backslash in a text is displayed unchanged in the HMI.

Column 1:

Available since version 1.14.3.130