Skip to main content
Version: 2025.1

NeonView

This page provides generated reference documentation for the NeonView data model.

A way to display your data in a context

Overview​

PropertySummary
childrenList of children in this container
commentProperty to store a developer comment in form of
dashletConfigurationsThe dashlet configurations of this view
descriptionDescription
documentationContains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different…
extensionPointThe name of the extension point of this data model.
filterableDetermines, if this view is filterable
iconImage.
iconProcessSpecifies the icon dynamically. If the icon has no effect, neither will the result of the process.
isOverlayDetermines if the View should be shown in an Overlay container instead of being embedded in the Main container. Some Layouts may be prohibited to be viewed in…
layoutType of layout which is used in this container. The layout defines a fundamental way in which the view-plates are arranged.
overlayOrientationDetermines the preferred orientation of the View when displayed as an Overlay. e.g. if set to PORTRAIT then the View will have a Portrait orientation when…
quickEntrySpecifies the index at which this model should be in the quick entry list
sizeDetermines the preferred size of the View. If set to SMALL the Editmode of the View will be shown in the Preview container.
titleTitle (speaking name. may contain spaces and special characters.) This has different effects depending on the entity:

children​

Type: Children

List of children in this container

comment​

Type: String

Property to store a developer comment in form of

/**
*
*/

In the past this was used in customizing for frame controls additional settings, such as the activation of rights, histories, or attributes. This should not be done anymore in the comment property, because therefor a metadata property exists.

dashletConfigurations​

Type: DashletConfigurations

The dashlet configurations of this view

description​

Type: String

Description

documentation​

Type: String

Contains the documentation of the data model in the popular AsciiDoc format (.adoc). The documentation should be set by the developer to explain different aspects (like purpose, concept, etc.) of the data model that they designed.

You may want to add the extension "AsciiDoc" to your ADITO Designer in order to modify AsciiDoc files.

<!--VSCODE_ONLY-->

extensionPoint​

Type: String

The name of the extension point of this data model.

To implement an element to this extension point, you can create a file {{extensionPointName}}.{{fileName}}.{{type}}.yaml. Otherwise, you can add your file {{fileName}}.{{type}}.yaml in the folder {{extensionPointName}}.

For instance, if your extension point name is CarEntityExtensionPoint and you want to add a field with the name CARID, then your filename would be CarEntityExtensionPoint.CARID.field.yaml. Also, you can create a folder CarEntityExtensionPoint and create a file with the name CARID.field.yaml.

filterable​

Type: Boolean
Default: false

Determines, if this view is filterable

icon​

Type: String

Image.

Depending on the datamodel, this has different effects:

  • Entity: used as symbol in the designer. Do not confuse this property with the iconId property
  • Context: used as symbol in the designer. If the contexts entity has an icon set, the entities icon is used
  • System, Language, Role, Application: icon that appears only in the designer.
  • Template: Same effect as on the respective component
  • Alias, User: no effect
  • Frame, Process, Report, NeonFrame: icon that appears in the designer and in the client for the frame.

<!--EOF-->

You can add a custom icon by placing an icon.png file in the folder of your data model.

iconProcess​

Type: String

Specifies the icon dynamically. If the icon has no effect, neither will the result of the process.

Depending on the datamodel, the result of the process has to be different:

  • When you can specify an icon-avatar-text (e.g. VAADIN:USERS): You've to return the icon-avatar.text with result.string(...)

  • When you can specify an image in the icon: This is returned as a string with the ID of the image in the ASYS_BINARIES via result.string().

Error messages from this process do not arrive at the client, they are only visible in the server log.

isOverlay​

Type: Boolean
Default: false
Constraints: Verification: OVERLAY_FLAG

Determines if the View should be shown in an Overlay container instead of being embedded in the Main container. Some Layouts may be prohibited to be viewed in Overlays, e.g., MasterDetailLayouts with detail areas are not permitted.

layout​

Type: ILayoutDataModel<?, ?>
Constraints: Verification: LAYOUT_CHANGE

Type of layout which is used in this container. The layout defines a fundamental way in which the view-plates are arranged.

overlayOrientation​

Type: EViewOverlayOrientation
Requires: isOverlay = true

Determines the preferred orientation of the View when displayed as an Overlay. e.g. if set to PORTRAIT then the View will have a Portrait orientation when shown as an Overlay.

quickEntry​

Type: Integer

Specifies the index at which this model should be in the quick entry list

size​

Type: EViewSize

Determines the preferred size of the View. If set to SMALL the Editmode of the View will be shown in the Preview container.

title​

Type: String
Constraints: Verification: TITLE_LENGTH

Title (speaking name. may contain spaces and special characters.) This has different effects depending on the entity:

  • System, Application, Template, Language and Alias: no effect
  • Frame, NeonFrame: Caption of the frame in the client
  • Process: Name of the process in system administration
  • Report: Labeling of the report in the client
  • Role: Name of the role as it appears in the client