IHeaderItems

[ Schnittstelle ]

export interface IHeaderItems {
    control: TcHmi.Controls.System.baseTcHmiControl| undefined;
    id: string | undefined;
    displayed: boolean;
    itemType: string;
    priority: string;
    itemAlign: ‘Left’ | ‘Right’;
    prefWidth: number;
    prefWidthUnit: DimensionUnit;
    prefHeight: number;
    prefHeightUnit: DimensionUnit;
    minWidht: number;
    minWidhtUnit: DimensionUnit;
    classList: string[];
    accessRight: AccessControl[];

    timeDisplayLayout?: ‘Time’ | ‘Date’ | ‘TimeDateSingleLine’ | ‘TimeDateMultiLine’ | ‘DateTimeSingleLine’ | ‘DateTimeMultiLine’ [];
    filter?: Filer[];
    targetRegion?: string;
    targetControl?: string;
    text?: string;
    image?: string;
    altText?: string;
    textPosition?: ‘Left’ | ‘Right’;
    textElement?: HTMLElement;
    stateList?: TcHmi.Controls.Beckhoff.TcHmiStateImage.IStateStructure[];
    stateVar?: any;
    localizationMapping?: TcHmi.Controls.Beckhoff.TcHmiLocalizationSelect.ListItem[];
    adsRuntime?: string;
    serverInterval?: number;
    serverDomain?: string;
    stateImages?: TcHmi.Controls.Beckhoff.TcHmiAdsState.IStateImages;
    iconWidth?: number;
    iconWidthUnit?: DimensionUnit;
    allowLogout?: boolean;
    allowSwitchUser?: boolean;
    eventDestroyFunction?: DestroyFunction;
    targetRegionSymbol?: Symbol<TcHmi.Controls.System.TcHmiRegion>;

}

Eigenschaften

Name

Typ

Beschreibung

control

TcHmi.Controls.System.baseTcHmiControl

Control welches anhand des Attributs „ItemType“ erstellt wird.

id

string

Id des Header-Elements

displayed

boolean

Anzeige Status des Header-Elements

itemType

string

Typ des Header-Elements

priority

string

Priorität des Header-Elements

itemAlign

‚Left‘ | ‚Right‘

Ausrichtung des Header-Elements

prefWidth

number

Bevorzugte Breite des Header-Elements

prefWidthUnit

DimensionUnit

Einheit der bevorzugten Breite

prefHeight

number

Bevorzugte Höhe des Header-Elements

prefHeightUnit

DimensionUnit

Einheit der bevorzugten Höhe

minWidth

number

Mindestbreite des Header-Elements

minWidthUnit

DimensionUnit

Einheit der Mindestbreite

classList

string[]

Liste der Klassen des Header-Elements

accessRight

AccessControl[]

Liste der Rechte des Header-Elements

timeDisplayLayout

‚Time‘ | ‚Date‘ | ‚TimeDateSingleLine‘ | ‚TimeDateMultiLine‘ | ‚DateTimeSingleLine‘ | ‚DateTimeMultiLine‘

Formatierung eines Uhr-Elements

filter

Filter

Filter des EventLine Controls

targetRegion

string

Ziel Region Control

targetContent

string

Ziel Content-Seite

text

string

Dargestellter Text des “Text”-Elements

image

string

Dargestelltes Bild des “Image”-Elements

altText

string

Alternativer Text des “Image”-Elements.

textPosition

‚Left‘ | ‚Right‘

Position des Texts des “Text“-Elements

textElement

HTMLElement

HTMLElement des „Text“-Elements

stateList

TcHmi.Controls.Beckhoff.TcHmiStateImage.IStateStructure[]

Statusliste des “StateImage”-Elements

stateVar

any

Status des “StateImage”-Elements

localizationMapping

TcHmi.Controls.Beckhoff.TcHmiLocalizationSelect.ListItem[]

Liste von Lokalisationsbeschreibungen

adsRuntime

string

Laufzeit des “AdsState”-Elements

serverInterval

number

Interval einer Subscription

serverDomain

string

Domain einer Subscription

stateImages

TcHmi.Control.Beckhoff.TcHmiAdsState.IStateImages

Liste der Ads Status Bilder

iconWidth

number

Icon-Breite

iconWidthUnit

DimensionUnit

Einheit der Icon-Breite

allowLogout

boolean

Erlaubt Logout bei einem „UserManagement“-Element

allowSwitchUser

boolean

Erlaubt Switch bei einem „UserManagement“-Element

eventDestroyFunction

DestroyFunction

DestroyFunction zur Event-Behandlung

targetRegionSymbol

Symbol<TcHmi.Controls.System.TcHmiRegion>

Symbol der Zeil Region

IHeaderItems 1:

Verfügbar ab Version 1.12.750