Interface DataFieldWithIntentBasedNavigation

A piece of data that allows triggering intent-based UI navigation

The navigation intent is is expressed as a Semantic Object and optionally an Action on that object.

It is tied to a data value which should be rendered as a hyperlink. This is in contrast to DataFieldForIntentBasedNavigation which is not tied to a specific data value.

interface DataFieldWithIntentBasedNavigation {
    action: string;
    criticality?: CriticalityType;
    criticalityRepresentation?: CriticalityRepresentationType;
    iconUrl?: URL;
    label?: string;
    mapping: SemanticObjectMappingType[];
    semanticObject: string;
    value: PrimitiveType;
}

Hierarchy

Properties

action criticality? criticalityRepresentation? iconUrl? label? mapping semanticObject value

Properties

action

action: string

Name of the Action on the Semantic Object. If not specified, let user choose which of the available actions to trigger.

Optional criticality

criticality?: CriticalityType

Criticality of the data field value

Optional criticalityRepresentation

criticalityRepresentation?: CriticalityRepresentationType

Decides if criticality is visualized in addition by means of an icon

Optional iconUrl

iconUrl?: URL

Optional icon

Optional label

label?: string

A short, human-readable text suitable for labels and captions in UIs

mapping

mapping: SemanticObjectMappingType[]

Maps properties of the annotated entity type to properties of the Semantic Object

semanticObject

semanticObject: string

Name of the Semantic Object

value

value: PrimitiveType

The data field's value

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc