IHeaderItems

[ Interface ]

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>;

}

Properties

Name	Type	Description
control	TcHmi.Controls.System.baseTcHmiControl	Control which is created based on the "ItemType" attribute.
id	string	Id of the header element
displayed	boolean	Display state of the header element
itemType	string	Type of the header element
priority	string	Priority of the header element
itemAlign	‚Left‘ \| ‚Right‘	Alignment of the header element
prefWidth	number	Preferred width of the header element
prefWidthUnit	DimensionUnit	Unit of preferred width
prefHeight	number	Preferred height of the header element
prefHeightUnit	DimensionUnit	Unit of preferred height
minWidth	number	Minimum width of the header element
minWidthUnit	DimensionUnit	Unit of the minimum width
classList	string[]	List of classes of the header element
accessRight	AccessControl[]	List of rights of the header element
timeDisplayLayout	‚Time‘ \| ‚Date‘ \| ‚TimeDateSingleLine‘ \| ‚TimeDateMultiLine‘ \| ‚DateTimeSingleLine‘ \| ‚DateTimeMultiLine‘	Formatting a clock element
filter	Filter	Filter of the EventLine control
targetRegion	string	Target Region control
targetContent	string	Target Content page
text	string	Displayed text of the "Text" element
image	string	Displayed image of the "Image" element
altText	string	Alternative text of the "Image" element.
textPosition	‚Left‘ \| ‚Right‘	Position of the text of the "Text" element
textElement	HTMLElement	HTMLElement of the "Text" element
stateList	TcHmi.Controls.Beckhoff.TcHmiStateImage.IStateStructure[]	State list of the "StateImage" element
stateVar	any	State of the "StateImage" element
localizationMapping	TcHmi.Controls.Beckhoff.TcHmiLocalizationSelect.ListItem[]	List of localization descriptions
adsRuntime	string	Runtime of the "AdsState" element
serverInterval	number	Interval of a subscription
serverDomain	string	Domain of a subscription
stateImages	TcHmi.Control.Beckhoff.TcHmiAdsState.IStateImages	List of Ads State images
iconWidth	number	Icon width
iconWidthUnit	DimensionUnit	Unit of the icon width
allowLogout	boolean	Allows logout from a "UserManagement" element
allowSwitchUser	boolean	Allows Switch for a "UserManagement" element
eventDestroyFunction	DestroyFunction	DestroyFunction for event handling
targetRegionSymbol	Symbol<TcHmi.Controls.System.TcHmiRegion>	Target Region symbol

	Available from version 1.12.750