NavigationItem

[ Schnittstelle ]

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' | '%';
}

Eigenschaften

Name

Typ

Beschreibung

name

string

Der im Navigationselement angezeigte Text.

id

string

Eine eindeutige Kennung für das Navigationselement.

content

string, undefined

Der Pfad oder Name des Inhalts, der in den Zielbereich geladen werden soll, wenn dieses Element ausgewählt wird.

function

TcHmi.IFunction

Eine Funktionsdefinition, die ausgeführt wird, wenn auf das Element geklickt wird.

subItems

NavigationItem[], undefined

Ein Array von untergeordneten Navigationselementen, die verschachtelte/hierarchische Navigationsstrukturen ermöglichen.

accessRights

TcHmi.AccessControl[], undefined

Definiert Benutzer-/Gruppenberechtigungen für dieses Element.

icon

string, undefined

Pfad zum Standard-Symbolbild, das neben dem Namen des Elements angezeigt wird.

iconPressed

string, undefined

Pfad zu einem alternativen Icon, das angezeigt wird, wenn das Element gedrückt/angeklickt wird.

iconActive

string, undefined

Pfad zu einem alternativen Icon, das angezeigt wird, wenn dieses Element das aktuell aktive/ausgewählte Navigationselement ist.

iconWidth

number, undefined

Die Breite des Icons.

iconWidthUnit

'px', '%'

Die Einheit der Breite des Icons.

iconHeight

number, undefined

Die Höhe des Icons.

iconHeightUnit

'px', '%'

Die Einheit der Höhe des Icons.

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

NavigationItem 1:

Verfügbar ab Version 1.14.1.15