Example of the model explorer

Explore your models from the dashboard

The model explorer provides a new way for you to experience your store's data model structures. View, organize, and interact with your models through a visual interface within the dashboard. All of your store's data models are represented in the model explorer, including store settings and custom models.

Features:

  • Canvas view that displays within the dashboard

  • Search for models, fields, and relationships (edges) between models

  • Displays field descriptions like name, type, and the field's definitions

  • Clicking a field displays the JSON representation directly from the database

  • Reflects changes to data models in real time

Accessing the model explorer

From your store's dashboard, the model explorer is listed under the Settings tab:

Swell settings tab with model explorer highlighted

Interacting with models in the explorer

You can move and arrange the models by selecting and dragging them within the model explorer. Any models that have a relation to another model keep their relationship intact while being moved.

Note: The arrangement of models does not persist beyond a current session, so reloading the model explorer will return your models to their original positions.

Navigation

You can move around the canvas by clicking and dragging. Alternatively, you can move vertically by scrolling. Holding Ctrl while scrolling up will zoom in, and holding Ctrl and scrolling down will zoom out.

The explorer also features navigation UI:

model explorer navigation

Bottom right navigation menu:

  • The plus sign zooms in closer

  • The minus sign will zoom out

  • The framed corners will fit the view to the entire screen

  • The lock icon will lock the currently selected model, preventing it from being moved until the model is unlocked

Bottom left map:

  • The explorer also features a mini-map in the bottom righthand side

Search

The search results are categorized and displayed by type. Results show models, fields, and edges–the relationships between models. All parts of a model are searchable and can be found through the search bar. Selecting a result will take you to that instance's location within the model explorer.

Relationships

Interrelated models are represented within the model explorer by a purple thread featuring a name based on the relation type.

Viewing a field description

When selecting a specific field, the model explorer displays the JSON field definition. This can be used as a reference to see the back end values for the different parameters that make up a particular field.

Did this answer your question?