NavigationItem

[ Interface ]

interface NavigationItem {
    name: string;
    id: string;
    content?: string;
    function: TcHmi.IFunction;
    subItems?: NavigationItem[];
    accessRights?: TcHmi.AccessControl[];
    icon?: string;
    iconPressed?: string;
    iconActive?: string;
    iconWidth?: number;
    iconWidthUnit?: 'px' | '%';
    iconHeight?: number;
    iconHeightUnit?: 'px' | '%';
}

Properties

Name	Type	Description
name	string	The text displayed in the navigation element.
id	string	A unique identifier for the navigation element.
content	string, undefined	The path or name of the content to be loaded into the target area when this element is chosen.
function	TcHmi.IFunction	A function definition that is executed when the element is clicked.
subItems	NavigationItem[], undefined	An array of subordinate navigation elements that enable nested/hierarchical navigation structures.
accessRights	TcHmi.AccessControl[], undefined	Defines user/group authorizations for this element.
icon	string, undefined	Path to the default icon image that is displayed next to the name of the element.
iconPressed	string, undefined	Path to an alternative icon that is displayed when the element is pressed/clicked.
iconActive	string, undefined	Path to an alternative icon that is displayed if this element is the currently active/selected navigation element.
iconWidth	number, undefined	The width of the icon.
iconWidthUnit	'px', '%'	The unit of the width of the icon.
iconHeight	number, undefined	The height of the icon.
iconHeightUnit	'px', '%'	The unit of the height of the icon.

Schema: tchmi:framework#/definitions/TcHmi.Controls.BaseTemplate.TcHmiAccordionNavigation.NavigationItem

	Available since version 1.14.1.15