Aspect Model Editor UI overview

This section gives a brief overview of the UI and its features.

Numbered UI overview

 

menu file

Icon Name Action

add

New…​

Create, import, duplicate Aspect Models, or use a template.

note add

New Window

Work on a different Aspect Model in a new window.

open in new

Import Model

Bring an existing Model into the current workspace.

folder zip

Import Package

Add a packaged Model (ZIP) to the workspace.

conntent

Copy to Clipboard

Copy the current Model’s information for use elsewhere.

save

Save to Workspace

Store the current Model in the workspace for future use.

download

Export Model

Download the current Model as a TTL file.

download fill

Export Package

Download Model namespaces in a ZIP format.

 

 

menu view

Icon Name Action

build

Toggle Toolbar

Switch the Toolbar on or off to better tailor your workspace environment, allowing you to focus on the aspects of the model that matter most to you.

map

Toggle Minimap

Show or hide the Minimap to enhance or simplify navigation within your model, enabling you to quickly move to different sections of your work.

filter list

Filter Model by…​

Apply filters to the model based on none, Properties, or other criteria, simplifying your view to concentrate on specific elements or relationships.

zoom in

Zoom in

Increase the level of detail you see in the model, allowing for closer examination of intricate parts or to fine-tune specific areas.

zoom out

Zoom out

Broaden your view of the model to gain a better understanding of the overall structure and how individual components fit together.

fit screen

Zoom to Fit

Adjust your perspective to encompass the entire model within your screen, ensuring you have a comprehensive overview of all elements at once.

pageless

Zoom to 100%

Reset your viewpoint to the model’s actual size, offering a standard scale for assessing dimensions and spatial relationships accurately.

 

 

menu edit

Icon Name Action

jump

Open Selected Element

Launch the Edit dialog for the selected element, providing a direct path to modify its attributes or review its details.

delete

Remove Selected Element

Delete the currently selected element from your model, streamlining your workspace by removing unnecessary or redundant components.

collapse

Collapse/Expand Model

Toggle the view of your model between collapsed and expanded states, aiding in focusing on specific sections or understanding the model’s overall structure.

schema

Format Model

Automatically adjust the layout and appearance of your model, enhancing readability and maintaining consistent styling throughout.

commit

Connect Selected Elements

Create a linkage between two selected elements, establishing a relationship or flow that reflects their interaction within the model.

 

 

menu validate

Icon Name Action

fact check

Current Model

Validate the current model.

 

 

menu generate

Icon Name Action

html

HTML Documentation

Generate HTML documentation.

api

OpenApi Specification

Generate OpenAPI specification.

data array

AASX/XML

Generate AASX/XML.

description

Sample JSON Payload

Generate sample JSON payload.

data object

JSON Schema

Generate json schema.

 

 

menu search

Icon Name Action

view comfy alt

Elements

Search for elements.

topic

Files

Search for files.

2. Toolbar

Icon Name Action

jump

Edit highligted cell

Open the Edit dialog of the selected element (alternative: double-click an element inside the model).

delete

Delete

Delete selected element(s).

commit

Connect

Connect two selected elements.

collapse

Collapse all/Expand all

Expands/Collapses elements.

schema

Format

Automatically format the Aspect Model.

validate

Validate

Validate the Aspect Model.

zoom in

Zoom in

Zoom in the Aspect Model.

zoom out

Zoom out

Zoom out the Aspect Model.

3. Workspace sidebar

The Workspace sidebar – see screenshot below – allows you to access namespaces (2) and to drag and drop elements to the graph area canvas (1).

ame ui overview workspace numbers

Expand the Workspace sidebar to view the description of each element.

To add an element to your model drag and drop it on the graph area canvas, edit its details, and connect it with the rest of the graph.

For more information, see Edit models.

 

Bottom workspace sidebar

Icon Name Action

settings

Settings

Open settings. Allows for defining the general configuration of the Aspect Model Editor, language settings, and namespace settings.

To access the Settings dialog, click the Settings icon Settings icon.

For more information, see Settings.

notifications

Notifications

Open notifications. Shows the validation results for your Aspect Model. Further, you can find there info messages (e.g., Aspect Model was loaded) and warning messages (e.g., if elements cannot be connected to each other).

To access the Notifications dialog, click the Notifications icon Notifications icon.

For more information, see Validation and notifications.

info

Help

Open help dialog. It displays details about the application and provides a link to the documentation.

4. Graph area canvas

This is the space where your Aspect Model is visualized. You can easily navigate it in the graph area canvas using the Minimap.

To show or hide it, click the Toggle Minimap icon Map toggle icon in the upper right corner of the graph area canvas.

Alternatively, you can also use the Toggle Minimap option in the View Menu.

Map toggle icon

For more information, see Navigate models.

 

5. Edit dialog

Edit the attributes of a selected element of your Aspect Model with the Edit dialog.

How to access the details of an element in the Edit dialog:

  • Double-click the element.

  • Select the element and right-click to open the context menu. Then select Open in detail view Edit icon.

  • Select the element and click the Edit highlighted cell button Edit icon on the toolbar.

For more information, see Edit elements.