Button

[ Interface ]

export interface Button {
    name: string;
    value?: any;
    width: number;
    height: number;
    widthMode?: 'Value' | 'Content';
    heightMode?: 'Value' | 'Content';
    minWidth?: number;
    maxWidth?: number;
    minHeight?: number;
    maxHeight?: number;
    textPadding?: TcHmi.FourSidedCss;
    text: string;
    tooltip?: string;
    keepPopupOpen?: boolean;
    actions?: TcHmi.Trigger.Action[];
}

Properties

Name

Type

Description

name

string

Name of the button

value

any, undefined

Value of the button

width

number

Width of the button

height

number

Height of the button

widthMode

'Value', 'Content', undefined

Determines whether the width is taken from the width value (Value) or determined based on the text length (Content).

heightMode

'Value', 'Content', undefined

Determines whether the height is taken from the height value (Value) or determined based on the text length (Content).

minWidth

number, undefined

The minimum width of the button

maxWidth

number, undefined

The maximum width of the button

minHeight

number, undefined

The minimum height of the button

maxHeight

number, undefined

The maximum height of the button

textPadding

FourSidedCss, undefined

Text padding of the button

text

string

Text of the button

tooltip

string, undefined

Tooltip of the button

keepPopupOpen

boolean, undefined

Value that specifies whether the popup should remain open.

actions

Trigger.Action[]

List of actions of the button

Schema: tchmi:framework#/definitions/TcHmi.Controls.System.TcHmiPopup.ButtonList

Button 1:

Available since version 1.12.760