Table of Contents

Getting to know Tabular Editor 3's User Interface

This article describes the user interface of Tabular Editor 3.

Basic user interface elements

With a semantic model loaded, Tabular Editor 3 shows the default layout below.

Basic user interface

  1. Title bar: the name of the loaded file, or of the Analysis Services database or Power BI semantic model you're connected to.
  2. Menu bar: all features of Tabular Editor 3. See Menus for each menu.
  3. Toolbars: the most used features. Every toolbar command is also in the menus. Customize the toolbars and their buttons under Tools > Customize....
  4. TOM Explorer view: a tree of the model's objects, built from the Tabular Object Model (TOM) metadata. The toggle buttons at the top filter which object types are shown, and the search box filters objects by name.
  5. Expression Editor: edits the DAX, SQL or M expressions of the object selected in the TOM Explorer. If you close it, double-click an object in the TOM Explorer to open it again. If the object has more than one expression property, the dropdown at the top switches between them. For example, a KPI has a target, a status and a trend expression.
  6. Properties view: all TOM properties of the objects selected in the TOM Explorer. You can edit most properties in the grid, also with several objects selected. Some properties, such as Format String, Connection String and Role Members, open a dialog or collection editor from the ellipsis button in the value cell.
  7. Messages view: semantic errors found by the continuous analysis of the model's DAX expressions, plus messages from C# scripts and errors reported by Analysis Services.
  8. Status bar: information about the current selection, Best Practice Analyzer findings and more. The connection item shows the database and server you're connected to as <database>@<server>, or <host>:<port> for Power BI Desktop, and (No connection) for a model loaded without a connection. When the MCP server is available, an indicator at the right-hand end reads MCP Started or MCP Stopped, and its tooltip shows the address the server listens on. Click the indicator to open the MCP Server dialog, or right-click it to start or stop the server, copy a registration configuration for your agent or open the preferences page.

The View menu opens the other views.

Customizing the user interface

You can resize and rearrange all UI elements, and drag views out of the main window, for example onto another monitor. Tabular Editor 3 saves the layout when you close the application and restores it at the next launch.

Choosing a different layout

Choose Window > Default layout to reset the application to the default layout, or Window > Classic layout to place the TOM Explorer on the left and the Properties view below the Expression Editor, as in Tabular Editor 2.x.

To switch between your own layouts, save the current one with Window > Capture Layout, and it becomes an option in the Window menu. Window > Layouts... lists all layouts, where you apply, load, remove and save them. A layout saved to disk is an .xml file that you can share with other Tabular Editor 3 users.

Manage Layouts

Window docking options

When you drag a view or document, docking indicators show where you can dock it.

Window Docking Options

Where you drop the window decides how it behaves:

Document tab docking (center indicator): a window dropped on the center indicator becomes a document tab in the main document area, next to documents such as DAX queries, scripts and diagrams. Document tabs:

  • are included when you cycle with Ctrl+Tab
  • have no auto-hide

Tool window docking (edge indicators): a window dropped on the left, right, top or bottom indicator is docked as a tool window, like the TOM Explorer and the Messages view. Tool windows:

  • aren't included in Ctrl+Tab
  • have a pin icon that turns on auto-hide, which collapses the window when it isn't in use
  • dock at any side of the main document area
Tip

The size of a docked window depends on the space available where you dock it, and you resize it by dragging the dividers between windows.

Changing themes and palettes

Choose a theme under Window > Theme:

  • Basic and Bezier are vector-based and scale on high-DPI displays.
  • Blue, Dark and Light are raster-based and don't scale well on high-DPI displays.

For Basic and Bezier, Window > Default palette changes the theme's colors.

Palettes

This section describes each menu.

The active document is the document that has the cursor, such as the Expression Editor or the "DAX Script 1" tab in the screenshot below. Some shortcuts and menu items depend on whether a document is active, and on its type.

Note

Menus and toolbars are locked in place by default. To unlock them, clear Lock menus and toolbars under Tools > Customize... > Options.

Active Document

File

The File menu loads and saves model metadata, supporting files and documents.

File Menu

  • New: creates a new blank model (Ctrl+N), or a supporting file such as a DAX query, a DAX script (text files) or a diagram (JSON file). Supporting files other than C# scripts require a loaded model.

    File Menu New

Important

New > Model... isn't available in Tabular Editor 3 Desktop Edition, which works only as an External Tool for Power BI Desktop. See Compare editions.

  • Open: loads a model from one of these sources, or opens any other supported file:

    File Menu Open

    • Model from file... opens model metadata from a file such as a .bim or .pbit file.

    • Model from DB... loads the metadata of a deployed model. Enter Analysis Services or Power BI XMLA connection details, or connect to a local instance such as Visual Studio's Integrated Workspace server or Power BI Desktop. Right-click a server in the Server list to pin it to the top of the list or delete it. See XMLA / Analysis Services connectivity.

    • Model from folder... opens model metadata from a folder structure saved by any version of Tabular Editor.

    • File... opens any file type Tabular Editor 3 supports, by file name extension. See Supported file types.

    • Import from Metric View YAML... imports model metadata from a Databricks Metric View YAML file.

      Supported File Types

Important

In Tabular Editor 3 Desktop Edition, Open > Model from file... and Open > Model from folder... aren't available, and Open > File... opens only supporting files.

  • Reload from disk / Reload from server: reloads the model metadata from its source and discards all unsaved changes. The command reads Reload from disk for a model loaded from a file or folder, and Reload from server for a model opened from Analysis Services or Power BI. If Tabular Editor 3 runs as an External Tool for Power BI Desktop and the model changes in Power BI Desktop, use this command to reload the model metadata without reconnecting. Models loaded from a file or folder reload automatically when the files change. See Auto-reload from disk. Open DAX Query and Pivot Grid documents stay open during a reload and connect to the reloaded model.
  • Close Document (Ctrl+W): closes the active document or panel in the main area, such as a DAX query, a C# script or a diagram. If the document has unsaved changes, a prompt to save them appears.
  • Close Model: unloads the model metadata. If you changed the metadata, a prompt to save the changes appears. Open DAX Query and Pivot Grid documents close with the model, and a save prompt appears for each one with unsaved changes.
  • Save: saves the active document to its source file. If no document is active, it saves the model metadata to its source: a Model.bim file, a Database.json folder structure, an Analysis Services instance (including Power BI Desktop) or the Power BI XMLA endpoint.
  • Save as... saves the active document as a new file. If no document is active, it saves the model metadata as a new .bim (JSON) file.
  • Save to folder... saves the model metadata as a folder structure.
  • Save all: saves all unsaved documents and the model metadata.
  • Recent files: lists recently used supporting files.
  • Recent tabular models: lists recently used model metadata files and folders.

With Model source detail set to Name only or Hidden, the hover text of the recent files and models menus shows file names without directories.

Important

In Tabular Editor 3 Desktop Edition, Save to folder and Recent tabular models are disabled, and Save as is enabled only for supporting files.

  • Exit: closes Tabular Editor 3. A prompt to save unsaved files or model metadata appears first.

Edit

The Edit menu edits the active document or the loaded model metadata.

Edit Menu

  • Undo: undoes the last change in the part of the window that has focus. In a text control, such as a document or the Expression Editor, it undoes typing and reads Undo typing. Elsewhere, it undoes the last change to the model metadata. Ctrl+Z runs this command.
  • Redo: redoes the last undone change, following the same rules as Undo. Ctrl+Y runs this command.
  • Undo / Redo followed by the name of a model change, for example Undo C# script (MCP): appear only when a text control has focus, and undo or redo the last change to the model metadata. See Undo in text editors.
  • Find: opens the "Find and replace" dialog on the "Find" tab. See Find.
  • Replace: opens the "Find and replace" dialog on the "Replace" tab. See Replace.
  • Cut / Copy / Paste: when a text control has focus, these apply to the selected text. When the TOM Explorer has focus, they apply to the selected objects. For example, to duplicate several measures, select them with Shift or Ctrl in the TOM Explorer and press Ctrl+C, then Ctrl+V.
  • Delete: deletes the selected text when a text control has focus, or the selected objects when the TOM Explorer has focus.
Note

A deletion prompt appears only when several objects are selected, or when other objects depend on the ones you delete. Undo (Ctrl+Z) restores deleted objects.

  • Select all: selects all text in the active document, or all objects with the same parent in the TOM Explorer.
  • Code assist: shortcuts to the code assist features for DAX. Available while you edit DAX. See DAX editor.
  • Word Wrap: toggles word wrap in the active text document.

View

The View menu opens and focuses the views of Tabular Editor 3, including hidden ones. Documents aren't listed; switch between them with the Window menu.

View Menu

  • TOM Explorer: a tree of the Tabular Object Model (TOM) of the loaded model. See TOM Explorer view.
  • AI Assistant: a chat with an AI assistant for modeling tasks.
  • DAX Package Manager: browses DAX user-defined function packages and installs them into the model.
  • Best Practice Analyzer: validates the model against best practice rules that you define. See Best Practice Analyzer view.
  • Messages: errors, warnings and informational messages from sources such as the Tabular Editor 3 Semantic Analyzer. See Messages view.
  • Data Refresh: tracks refresh operations running in the background. See Data Refresh view.
  • Expression Editor: edits the DAX, M or SQL expressions of the object selected in the TOM Explorer. See DAX Editor.
  • Macros: manages the macros you created from C# Scripts. See Creating macros.
  • VertiPaq Analyzer: collects, imports and exports statistics about the data in the model, for DAX performance tuning. VertiPaq Analyzer is created and maintained by Marco Russo of SQLBI under MIT license. See the GitHub project page.
  • Dependencies: the DAX Dependencies view shows the dependencies between the selected object and other objects in the model. Select Track TOM Explorer to make it follow the TOM Explorer selection.
  • DAX Optimizer: analyzes the model for DAX performance issues with DAX Optimizer.
  • Calendar Editor: defines and manages calendars for the modern time intelligence feature.
  • Perspective Editor: a matrix of which objects each perspective of the model includes.
  • Metadata Translation Editor: a grid for editing the metadata translations (cultures) of model objects.
  • Toolbars / Properties: toggles toolbar visibility and opens the Properties view (F4).

Model

The Model menu has actions on the Model object, the root of the TOM Explorer.

View Menu

Important

Deploy isn't available in Tabular Editor 3 Desktop Edition. See Compare editions.

  • Serialization options... sets how model metadata is serialized when saved to a file or folder structure.
  • Import tables... opens the Tabular Editor 3 Import Table Wizard. See Importing Tables.
  • Update schema (all tables)... compares the columns of all tables with their data sources and detects schema changes. See Updating table schema.
  • Script DAX: generates a DAX script for the selected objects, or for all DAX objects in the model if nothing is selected. See DAX Scripts.
  • Refresh model: starts a background refresh of the model when Tabular Editor is connected to Analysis Services. See Refresh command (TMSL). The submenu has these options:
    • Automatic (model): Analysis Services refreshes only the objects that aren't in the "Ready" state.
    • Full refresh (model): Analysis Services performs a full refresh of the model.
    • Calculate (model): Analysis Services recalculates all calculated tables, calculated columns, calculation groups and relationships. No data is read from the data sources.
  • Add [object type]: the remaining items create model child objects, such as tables, data sources and perspectives.

Tools

The Tools menu has the Tabular Editor 3 preferences and customizations.

View Menu

  • Customize... opens the User Interface Layout customization dialog, where you create toolbars and rearrange and edit menus and toolbar buttons.
  • Preferences... opens the Preferences dialog, with settings such as update checks, proxy settings, query row limits and request timeouts. See Controlling preferences.
  • Manage BPA rules... opens the Best Practice Analyzer rule manager, where you view and edit rules and rule collections. See Best Practice Analyzer view.
  • MCP Server... opens the MCP Server dialog, where you start and stop the server that lets an external AI agent work on the open model, review the permissions the agent gets and copy a registration configuration for your agent. See MCP server. The item is hidden when the AI features component isn't installed, when Enable MCP Server is cleared or when an administrator has disabled it by policy.

Window

The Window menu manages and switches between the views and documents of the application, together called windows, and also has the theme and palette settings.

View Menu

  • New... creates supporting files. The options are the same as under File > New.

  • Float undocks the current view or document into a floating window.

  • Pin tab pins a tab to the left end of the document tabs. The tab right-click menu has commands that close only unpinned tabs.

    View Menu

  • New Horizontal/Vertical Tab Group: divides the main document area into tab groups, to show several documents side by side or one above the other.

  • Close All: closes all document tabs. A prompt to save unsaved changes appears first.

  • Reset Window Layout: resets all customization of the main document area.

  • 1..N [document]: the first 10 open documents. Ctrl+Tab also switches between open documents and views:

    View Menu

  • Windows...: opens a dialog that lists all open documents, where you switch to or close each one.

    View Menu

  • Capture Layout / Layouts... / Default layout / Classic layout: see Choosing a different layout.

  • Theme / Default palette: see Changing themes and palettes.

  • Language: changes the display language of the Tabular Editor 3 user interface.

Help

The Help menu links to online resources.

View Menu

  • Online Documentation: opens docs.tabulareditor.com in your default web browser.
  • Onboarding Guide: opens the Tabular Editor 3 onboarding guide for new users.
  • Community Support: opens the public community support site.
  • Dedicated Support: sends an e-mail to the dedicated support hotline.
  • Get Started: opens the Get Started page, which collects courses, demos and documentation for Tabular Editor. Before Tabular Editor 3.27.0, this item was called What's New. For release notes, see Full release history.
Note

Dedicated support is for Tabular Editor 3 Enterprise Edition customers. Other customers use the public community support site for technical and product questions.

  • About Tabular Editor: shows the version, installation and licensing details, and lets you change your license key.

Dynamic menus (context dependent)

Extra menus appear depending on which UI element has focus and which object is selected in the TOM Explorer. For example, if you select a table, a Table menu appears with the same items as the table's right-click menu in the TOM Explorer.

Each document type, such as DAX queries, Pivot Grids and diagrams, also adds a menu while a document of that type has focus. For example, a focused diagram adds a Diagram menu with an item for adding tables to the diagram.

Set the behavior of these dynamic menus under Tools > Preferences > Tabular Editor > User Interface.

Next steps