Column

[ Interface ]

export interface Column {
    control: 'TextBlock' | 'TextBox' | 'CheckBox' | 'ComboBox' | 'Image';
    name: string;
    label: string;    editable?: boolean;
    dataDefinitions?: TcHmi.Controls.Beckhoff.DataGrid.DataDefinition[];
    resize?: boolean;
    cellBackground?: TcHmi.SolidColor;
    textColor?: TcHmi.SolidColor;
    width: number;
    widthUnit: TcHmi.DimensionUnit;
    minWidth?: number;
    minWidthUnit?: TcHmi.DimensionUnit;
    horizontalAlignment?: TcHmi.HorizontalAlignment;
    verticalAlignment?: TcHmi.VerticalAlignment;
    format?: TcHmi.IFunction;
}

Properties

Name

Type

Description

control

'TextBlock', 'TextBox', 'CheckBox', 'ComboBox', 'Image'

Display type

control (from version 1.12.750)

'TextBlock', 'TextBox', 'CheckBox', 'ComboBox', 'Image', 'PasswordInput', 'NumericInput', 'SpinboxInput', 'DataTimeInput', 'Button', 'ToggleButton'. 'ToggleSwitch', RadioButton'

Display type

name

string

Name of the column

label

string

Column legend

editable [optional]

boolean

Determines whether the user can change this value. Has no effect if the control is 'TextBlock' or 'Image'.

dataDefinitions [optional]

TcHmi.Controls.Beckhoff.DataGrid.DataDefinition

Datadefinition if the control is set to 'Combobox' or 'Image'.

resize [optional]

boolean

Determines whether the user can change the width of this column.

cellBackground

TcHmi.SolidColor

Background color

textColor

TcHmi.SolidColor

Text color

width

number

Numerical value of the width

widthUnit

TcHmi.DimensionUnit

Unit of the width

minWidth

number

Numerical value of the minimum width

minWidthUnit

TcHmi.DimensionUnit

Unit of the minimum width

horizontalAlignment [optional]

TcHmi.HorizontalAlignment

Horizontal alignment

verticalAlignment [optional]

TcHmi.VerticalAlignment

Vertical alignment

format [optional]

TcHmi.IFunction

Formatting function

Column 1:

Available from 1.8