| Accordion | Accordion control with collapsible/expandable panes. Samples: https://public.datagrok.ai/js/samples/ui/accordion |
| AccordionPane | A pane in the Accordion control. |
| ActivityDataSource | Common functionality for handling collections of entities stored on the server. Works with Datagrok REST API, allows to get filtered and paginated lists of entities, Can be extended with specific methods. (i.e. UsersDataSource) |
| AdminDataSource | - |
| AlterTableBuilder | Single-action ALTER TABLE operations, obtained via DdlBuilder.alterTable. Each method returns a DdlCommand for exactly one alteration (many databases auto-commit DDL, so batching alterations would fake an atomicity that isn't there) — run several alterations as sequential commands. |
| AnnotationRegionsHelper | - |
| Balloon | Balloon-style visual notifications. |
| BarChartViewer | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers |
| BigIntColumn | Strongly-typed column. Use get and set to access elements by index. |
| BitSet | Efficient bit storage and manipulation. See samples: https://public.datagrok.ai/js/samples/data-frame/aggregation |
| BoxPlot | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers |
| Breadcrumbs | - |
| BrowsePanel | JS wrapper for the widget implemented in Dart. |
| CalendarViewer | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers |
| CanvasRenderer | - |
| CardView | Base view for working with a collection of objects that reside on the server. Typically, results are filtered by applying AND operation between two filters: permanentFilter (which is set programmatically and is not visible) and searchValue entered by the user. |
| Cell | Represents a table cell. |
| ChoiceInput | Input control base. Could be used for editing Property values as well. The root is a div that consists of captionLabel and input. |
| ClientCache | Client caching service that caches results of function invocations and stores them in the IndexedDb. |
| CodeEditor | Class for code input editor. |
| CodeInput | Input control base. Could be used for editing Property values as well. The root is a div that consists of captionLabel and input. |
| Color | Color-related routines. |
| Column | Strongly-typed column. Use get and set to access elements by index. |
| ColumnColorHelper | - |
| ColumnComboBox | A combo box with columns as item. Supports sorting, searching, custom tooltips, column-specific rendering, drag-and-drop, etc |
| ColumnDialogHelper | - |
| ColumnGrid | Proxy class for the Dart-based column grid. |
| ColumnInfo | - |
| ColumnList | Columns in a [DataFrame]. |
| ColumnMarkerHelper | - |
| ColumnMetaHelper | - |
| ColumnsArgs | - |
| Completer | - |
| ComponentBuildInfo | - |
| ConfusionMatrix | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers |
| ConnectionDataSource | Represents data source, such as PostgreSQL, Oracle, S3, etc. |
| Context | - |
| CorrelationPlot | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers |
| Credentials | Represents connection credentials Usually it is a login and a password pair Passwords are stored in the secured credentials storage See also: https://datagrok.ai/help/datagrok/solutions/enterprise/security#credentials |
| CredentialsDataSource | Functionality for handling credentials collection from server and working with credentials remote endpoint Allows to manage Credentials See also: https://datagrok.ai/help/datagrok/solutions/enterprise/security#credentials |
| CustomCardView | Base view for working with a collection of objects that reside on the server. Typically, results are filtered by applying AND operation between two filters: permanentFilter (which is set programmatically and is not visible) and searchValue entered by the user. |
| Dapi | Exposes Datagrok's server-side functionality. |
| DartList | A proxy to a Dart List<T>. |
| DartWidget | JS wrapper for the widget implemented in Dart. |
| DartWrapper | - |
| Data | Creating, loading, querying, manipulating, joining tables. |
| DataConnection | Represents a data connection |
| DataConnectionsDataSource | Functionality for handling connections collection from server and working with credentials remote endpoint Allows to manage DataConnection See also: https://datagrok.ai/help/datagrok/solutions/enterprise/security |
| DataFrame | DataFrame is a high-performance, easy to use tabular structure with strongly-typed columns of different types. |
| DataFrameAnnotationRegionsHelper | - |
| DataFrameColumn | Column of type [DataFrame]. |
| DataFrameDialogHelper | - |
| DataFrameFormulaLinesHelper | FormulaLinesHelper provides methods for working with Formula Lines. Primarily intended for use in Viewer and DataFrame metadata. Documentation: https://datagrok.ai/help/develop/how-to/show-formula-lines |
| DataFrameMetaHelper | - |
| DataFramePlotHelper | - |
| DataJob | Represents a data job |
| DataQuery | Represents a data query |
| DataQueryView | A view is typically docked in the main document area of the Grok platform. See [TableView], [SketchView], etc |
| DataSourceType | - |
| DateInput | Input control base. Could be used for editing Property values as well. The root is a div that consists of captionLabel and input. |
| DateTimeColumn | Strongly-typed column. Use get and set to access elements by index. |
| Db | - |
| DbInfo | Represents metadata for a database/catalog in Datagrok. |
| DbRelationInfo | Represents metadata for a database relation in Datagrok. |
| DbSchemaInfo | Represents metadata for a specific database schema in Datagrok. |
| DbTable | Structured write access to one database table, obtained via Db.table. All operations return a MutationResult; the matching fine-grained saved-connection privilege (DataConnection.AddRows for insert, ChangeValues for update, RemoveRows for delete, AddRows+ChangeValues for upsert) and per-provider write capability are enforced server-side (unsupported operations reject with a structured capability error, never a 500). An operation that fails as a whole (rolled back, nothing applied) REJECTS the returned promise with the SQL error; per-row errors under allOrNothing: false resolve with errors/errorCount in the MutationResult. Values are always sent as bound parameters — never interpolated SQL. |
| DdlBuilder | Fluent builder for structured DDL against one connection, obtained via grok.data.db.ddl(connectionId). Mirrors TableMutationBuilder; every terminal returns a DdlCommand carrying exactly one operation. |
| DdlCommand | A single addressed DDL operation, built by DdlBuilder. dryRun() returns the plan without executing; execute() recomputes the plan server-side and refuses destructive actions with DdlConfirmationRequiredError unless confirmed. |
| DdlConfirmationRequiredError | Thrown by DdlCommand.execute when the recomputed plan has destructive actions and confirmDestructive was not set. Carries the plan so the caller can render a confirmation without a second round trip, then re-run execute({confirmDestructive: true}). |
| DemoDatasets | Provides convenient access to demo datasets. |
| DensityPlotViewer | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers |
| Detector | - |
| Dialog | A non-modal dialog. Sample: https://public.datagrok.ai/js/samples/ui/dialogs |
| DockContainer | Represents a dockable window. See also DockContainer, DockNode. Samples: https://public.datagrok.ai/js/samples/ui/docking/docking |
| DockerContainer | Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path |
| DockerContainersDataSource | Functionality to work with Docker containers. See help: https://datagrok.ai/help/develop/how-to/docker_containers. |
| DockerDataSource | - |
| DockerImage | Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path |
| DockerImagesDataSource | Functionality to work with Docker images. See also DockerContainersDataSource. |
| DockManager | Window docking manager. |
| DockNode | Dock node. See also DockContainer, DockManager. Samples: https://public.datagrok.ai/js/samples/ui/docking/docking |
| DockView | A view is typically docked in the main document area of the Grok platform. See [TableView], [SketchView], etc |
| DomainError | Base of all structured /domains failures; [body] is the server's error envelope. |
| DomainFilterError | Base of all structured /domains failures; [body] is the server's error envelope. |
| DomainForbiddenError | Base of all structured /domains failures; [body] is the server's error envelope. |
| DomainFrameEditor | THE single writer of a domain frame's editing state. |
| DomainGrid | An editable grid over one domain table. |
| DomainManifestValidationError | Base of all structured /domains failures; [body] is the server's error envelope. |
| DomainNotFoundError | Base of all structured /domains failures; [body] is the server's error envelope. |
| DomainObjectHandler | The per-table ObjectHandler for domain rows: reflective (it takes columns, labels, choices and capabilities from the runtime registry, so it works on ANY table without codegen) and delegating (every render member falls through to the platform's Dart meta for that table). |
| DomainQuery | What the user is looking at, as ONE serializable object: the parameters of the platform's DomainQuery function (filters, joins, aggregations, groupBy, orderBy, projection, limit, offset). URL routing, deep links, saved filters, "open in Table View" and data-synced dashboards all serialize exactly this — there is no parallel query-state vocabulary. |
| DomainQueryBuilder | Thenable query builder (returned by no-arg query()): build with .where/.orderBy/.select/.expand/.top/.skip, then await it (rows), or finish with .df()/.first()/.count()/.exists(). Prefer the condition forms of where (and the cond/and/or helpers) over template-built filter strings — condition values are bound server-side, so any string value is safe (apostrophes included). Without .top() the server's default limit (100) applies; page larger sets with .top()/.skip(). Immutable-ish: expand()/select() return a re-typed builder; other methods mutate and return this. Invariants: the builder is PromiseLike only — there is no .catch()/.finally(), use try { await b } catch; EVERY await (or terminal) re-executes the query — two awaits are two round trips, cache the rows instead. |
| DomainRegistryClient | Reflection over the client-side domain registry (see DomainsDataSource.registry): schemas → tables → columns → Property metadata, loaded once per session and shared with the built-in domain UI. Tables are addressed as '<schema>.<table>'. |
| DomainRestrictError | Base of all structured /domains failures; [body] is the server's error envelope. |
| DomainRow | A single row of a DomainTable. Its semantic type is the row's entity type name, '<schema>.<table>' — the string an ObjectHandler keys on to override rendering per table (see Grit's grit.issue handler). |
| DomainSavedFilter | A saved filter preset of a domain table — a small shareable entity carrying the filter panel's state maps (entity-filters §7). Managed through grok.dapi.domains.table(...).filters; wrapped here so preset entities work with the standard entity machinery (sharing, favorites, Dapi.getEntities). |
| DomainSavedFiltersClient | Saved filter presets of one domain table (see DomainTableClient.filters): small shareable entities carrying the filter panel's state maps. Sharing uses the standard entity permission machinery (Dapi.permissions); the server scopes list to what the caller can see. |
| DomainSchema | A registered domain schema declared by a plugin manifest (databases//schema.json). |
| DomainSchemaClient | Lifecycle handle for one registered domain schema (see DomainsDataSource.schema): manifest export, partial applies with dry-run change plans, whole-schema audit, and full purge. Mutations apply to user-managed schemas only (package schemas deploy on publish). |
| DomainsDataSource | Generic client for domain tables — entity-mapped PostgreSQL schemas that plugins declare via databases/<schema>/schema.json manifests. Rows are plain JSON objects; column metadata and security come from the server-side schema registry. |
| DomainTable | A securable table inside a DomainSchema; its rows are typed by a per-table entity type named '.'.
| DomainTableClient | Row CRUD for one domain table. Reads return only rows and columns the current user can see; writes are validated, permission-checked, and audited server-side. Pass a row interface as TRow for typed reads/writes, and an insert interface as TInsert so insert enforces required columns (grok api-generated clients pass both; see DomainsDataSource.table). | | DomainValidationError | Base of all structured /domains failures; [body] is the server's error envelope. | | DomainVersionConflictError | Base of all structured /domains failures; [body] is the server's error envelope. | | DomainView | The platform's Domain View for one domain table — the /domains/<schema>/<table> page, creatable programmatically and embeddable: card / brief / grid modes, search, sort, paging, the server-backed filter panel, in-grid editing with one-transaction save, and the per-table ObjectHandler's rendering and commands. Show it with grok.shell.addView(v), or mount v.root anywhere. | | DragDropArgs | Arguments passed to drag-and-drop callbacks (see DG.ui.makeDroppable). Wraps the Dart DragDropArgs handle exposed via the GrokJsObject mixin. | | DropDown | Base class for controls that have a visual root and a set of properties. | | EmailDialog | Generic markdown-body email dialog with attachments. | | EntitiesDataSource | Functionality for handling entities collection from server Allows to manage Entity | | Entity | Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path | | EntityProperty | A dynamic property associated with the entity. | | EntityType | - | | EventBus | Central event hub. | | EventData | - | | Events | Global platform events. | | EventType | Descriptor for a named event that can be fired on an EventBus. Wraps a Dart EventType<T> instance. | | Favorites | JS wrapper for the widget implemented in Dart. | | FileInfo | - | | Files | Provides convenient file shares access * | | FilesDataSource | Provides access to file operations in the Datagrok file system. | | FilesView | File browser view. Contains the file tree, search panel and preview components. | | FilesWidget | File browser widget | | Filter | Base class for DataFrame-bound filtering controls. Supports collaborative filtering by efficiently working together with other filters. | | FilterGroup | Represents a group of filters that are located together. | | FloatColumn | Strongly-typed column. Use get and set to access elements by index. | | Form | Represents a form that can be user-designed or edited. | | FormulaLinesHelper | FormulaLinesHelper provides methods for working with Formula Lines. Primarily intended for use in Viewer and DataFrame metadata. Documentation: https://datagrok.ai/help/develop/how-to/show-formula-lines | | FormViewer | DataFrame-bound viewer that contains Form | | Func | Represents a function | | FuncCall | Represents a function call https://datagrok.ai/help/datagrok/concepts/functions/function-call | | FuncCallEditor | Base class for widgets or views that serve as editors for FuncCall. Extend it and use it in editor functions. Editor functions should return an implementation of this class for the platform to handle validation correctly. An editor function can be attached to another function using the editor tag: editor: Plugin:EditorFuncName. | | FuncCallParam | Represents a parameter of a function. | | FuncOptions | - | | FuncParamOptions | - | | FuncsDataSource | Functionality for handling functions collection from server Allows managing Func | | Functions | Grok functions | | FunctionsWidget | JS wrapper for the widget implemented in Dart. | | Grid | High-performance, flexible spreadsheet control | | GridCell | Represents a grid cell | | GridCellRenderArgs | Grid cell rendering args. | | GridCellRenderer | - | | GridCellRendererProxy | Proxy class for the Dart-based grid cell renderers. | | GridCellStyle | Represents grid cell style. | | GridCellStyleEx | - | | GridCellWidget | Renders the content of the specified [gridCell], and provides interactivity as well. | | GridColumn | Represents a grid column | | GridColumnList | Represents grid columns. | | GridFilterBase | JS wrapper for the widget implemented in Dart. | | GridTooltipArgs | - | | Group | - | | GroupByBuilder | Fluid API for building an aggregation query against a DataFrame. Build a query by calling the following methods: key, pivot, count, uniqueCount, missingValueCount, valueCount, min, max, sum, avg, stdev, variance, q1, q2, q3. | | GroupsDataSource | Functionality for handling groups collection from server Allows to manage Group | | HistogramViewer | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers | | HistoryEntry | - | | HtmlTable | JS wrapper for the widget implemented in Dart. | | HttpDataSource | Common functionality for handling collections of entities stored on the server. Works with Datagrok REST API, allows to get filtered and paginated lists of entities, Can be extended with specific methods. (i.e. UsersDataSource) | | InfoDataSource | - | | InputBase | Input control base. Could be used for editing Property values as well. The root is a div that consists of captionLabel and input. | | InputForm | A form with multiple inputs inside | | InputType | - | | JsInputBase | Base class for JS value editors | | JsViewer | Subclass JsViewer to implement a DataFrame-bound Datagrok viewer in JavaScript. See an example on github: https://github.com/datagrok-ai/labs/tree/master/packages/Leaflet | | LayoutsDataSource | Functionality for handling layouts collection from server Allows to manage ViewLayout | | Legend | Column legend for viewers | | LineChartViewer | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers | | LogDataSource | Common functionality for handling collections of entities stored on the server. Works with Datagrok REST API, allows to get filtered and paginated lists of entities, Can be extended with specific methods. (i.e. UsersDataSource) | | LogEvent | Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path | | LogEventParameter | Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path | | LogEventParameterValue | Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path | | LogEventType | Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path | | Logger | - | | LruCache | Least recently used cache. Inspired by https://github.com/Yomguithereal/mnemonist/blob/master/lru-cache.js | | MarkdownInput | Base class for JS value editors | | MatrixPlot | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers | | Menu | Menu (either top menu or popup menu). Top menu sample: https://public.datagrok.ai/js/samples/ui/menu Popup menu sample: https://public.datagrok.ai/js/samples/ui/popup-menu | | Model | Represents a predictive model | | MultiChoiceInput | Input control base. Could be used for editing Property values as well. The root is a div that consists of captionLabel and input. | | MultiView | Subclass ViewBase to implement a Datagrok view in JavaScript. | | NetworkDiagramViewer | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers | | Notebook | - | | NotificationsDataSource | Common functionality for handling collections of entities stored on the server. Works with Datagrok REST API, allows to get filtered and paginated lists of entities, Can be extended with specific methods. (i.e. UsersDataSource) | | ObjectColumn | Strongly-typed column. Use get and set to access elements by index. | | ObjectPropertyBag | A dynamic property bag that provides convenient access to an object's properties. | | Package | Represents a package, which is a unit of distribution of content in the Datagrok platform. | | PackageLogger | - | | PcPlot | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers | | Permission | - | | PermissionsDataSource | - | | PieChartViewer | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers | | PivotViewer | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers | | Point | Represents a point. | | ProgressIndicator | - | | Project | Represents a project | | ProjectsDataSource | Functionality for working with remote projects | | ProjectsView | Projects view | | Property | Strongly-typed property associated with an object. Used for reflection, serialization, UI generation, and other introspection-dependent tasks. | | PropertyGrid | JS wrapper for the widget implemented in Dart. | | Qnum | A set of static methods for working with qualified numbers. The internal representation of a qualified number is a regular double precision floating point number (IEEE 754), except the two least significant bits in mantissa are reserved for holding the qualifier ([LESS], [EXACT], [GREATER]). | | RangeSlider | A slider that lets user control both min and max values. | | Rect | Represents a rectangle. | | RocCurve | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers | | Row | Represents a row in a DataFrame. | | RowGroup | - | | RowList | Represents rows of the [DataFrame]. | | RowMatcher | Row matcher. | | ScatterPlotViewer | 2D scatter plot | | Schema | Represents dynamic property schema, associated with the entity type. | | Script | - | | ScriptEnvironment | Represents a script environment | | ScriptLanguage | - | | ScriptsView | Scripts view | | ScriptView | Script view | | SearchResult | - | | SemanticValue | - | | ServerMessageTypes | - | | Settings | User-specific platform settings. | | Shell | Grok visual shell, use it to get access to top-level views, tables, methods, etc. | | ShellContextPanel | Represents context panel that shows properties for the current object and is toggleable by pressing F1 | | ShellHelpPanel | Represents help panel that shows help for the current object and is toggleable by pressing F1 | | SpaceChildrenClient | Client for querying and filtering children of a space. Children can include subspaces (Projects), files (FileInfo), and various entities like scripts, queries, and connections. | | SpaceClient | Client for working with a specific space. Provides methods for managing subspaces, entities (scripts, queries, connections), and files. | | SpaceFilesClient | Client for file operations within a space's storage. Files in a space are stored in the space's dedicated storage connection. Directory operations are synchronized with the space hierarchy - creating a directory creates a corresponding subspace, and renaming a directory renames the subspace. | | SpacesDataSource | Data source for working with Spaces - hierarchical containers for organizing entities and files. Spaces support nested subspaces, file storage, and can contain various entities like scripts, queries, etc. | | SpaceView | Hierarchical view of a Datagrok Space — the same widget the Browse tree opens when you click a Space (a Project where isSpace == true). Includes the search box, the "+" ribbon button to add a child space, and the card grid of children (subspaces, files, entities). | | Stats | Represents basic descriptive statistics calculated for a Column. See samples: https://public.datagrok.ai/js/samples/data-frame/stats | | StickyMeta | API for Sticky meta. Allows attaching arbitrary metadata on custom entities. Can be applied to a column of entities based on semtype or column tags. | | StreamSubscription | Subscription to an event stream. Call [cancel] to stop listening. | | StringUtils | - | | TabControl | Tab control that hosts panes inside. See also TabPane | | TableInfo | - | | TableMutationBuilder | Fluent builder for structured UPDATE/DELETE mutations. A thin wrapper over DbTable that accumulates SET assignments and WHERE conditions. In phase A a WHERE condition is equality by value; a string value may use string patterns (e.g. contains foo). Numeric/date range grammar (> 5, 10-20) in where is phase B. Build via grok.data.db.buildMutation(...). | | TableQuery | Represents a table query | | TableQueryBuilder | Table query builder that works with database tables | | TablesDataSource | Functionality for working with remote tables | | TableView | A View that is associated with a DataFrame and exposes exploratory data analysis functionality. This view gets opened whenever a new table is added to the workspace when a user drag-and-drops a CSV file, or opens a table in any other way. | | TabPane | Represents a pane of either TabControl or Accordion | | TagEditor | - | | TagElement | - | | Tags | - | | TaskBarProgressIndicator | - | | TileViewer | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers | | ToolboxPage | - | | TreeMap | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers | | TreeViewGroup | Tree view node. Sample: https://public.datagrok.ai/js/samples/ui/tree-view | | TreeViewNode | Tree view node. Sample: https://public.datagrok.ai/js/samples/ui/tree-view | | TrellisPlotViewer | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers | | TypeAhead | Input control base. Could be used for editing Property values as well. The root is a div that consists of captionLabel and input. | | TypedEventArgs | - | | UndoService | Multi-level undo/redo. Records are kept in memory only, are bounded by count and by size, and are dropped when the table or view they belong to is closed. | | UsageType | - | | User | Represents a user of the Datagrok platform. | UserDataStorage | - | | UserNotification | - | | UserReport | Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path | | UserReportsDataSource | Common functionality for handling collections of entities stored on the server. Works with Datagrok REST API, allows to get filtered and paginated lists of entities, Can be extended with specific methods. (i.e. UsersDataSource) | | UserReportsRule | Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path | | UserReportsRulesDataSource | Common functionality for handling collections of entities stored on the server. Works with Datagrok REST API, allows to get filtered and paginated lists of entities, Can be extended with specific methods. (i.e. UsersDataSource) | | UsersDataSource | Functionality for handling Users collection from server and working with Users remote endpoint Allows to load current user and list of all Datagrok users with filtering and pagination See example: https://public.datagrok.ai/js/samples/dapi/who-am-i | | UserSession | Represents a user session in the Datagrok platform. | | Utils | - | | ValueMatcher | Value matcher. See usage example: https://public.datagrok.ai/js/samples/data-frame/value-matching/value-matcher | | View | A view is typically docked in the main document area of the Grok platform. See [TableView], [SketchView], etc | | ViewBase | Subclass ViewBase to implement a Datagrok view in JavaScript. | | Viewer | Represents a viewer. See also https://datagrok.ai/help/develop/how-to/manipulate-viewers | | ViewerAnnotationRegionsHelper | - | | ViewerEvent | - | | ViewerFormulaLinesHelper | FormulaLinesHelper provides methods for working with Formula Lines. Primarily intended for use in Viewer and DataFrame metadata. Documentation: https://datagrok.ai/help/develop/how-to/show-formula-lines | | ViewerMetaHelper | - | | ViewInfo | Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path | | ViewLayout | Base class for system objects stored in the database in a structured manner. Contains base properties: id, name and path | | ViewsDataSource | Functionality for handling views information from server Allows to manage ViewInfo | | VirtualView | Represents a virtual view, where visual elements are created only when user scrolls them into view. | | VisualDbQueryEditor | JS wrapper for the widget implemented in Dart. | | Widget | Base class for controls that have a visual root and a set of properties. | | WidgetDescriptor | Provides metadata about the widget (such as name, description, available events and properties) without having to instantiate it. Used for command palettes, AI, etc | | Windows | Controls tool windows visibility | | Wizard | EXPERIMENTAL - USE AT YOUR OWN RISK - API might change |
Interfaces
| Interface | Description |
|---|
| AnnotationRegion | Represents a core annotation region parameters. | | AreaAnnotationRegion | Represents an area annotation region (defined by polygon points) parameters. | | BalloonOptions | - | | CellChangeArgs | - | | CellRangeArgs | - | | ColumnChangeArgs | - | | ColumnsFormatCsvExportOptions | Column name -> format | | CsvExportOptions | Csv export options to be used in DataFrame.toCsv | | DatabaseConnectionProperties | Represents basic properties of database connection. | | DataConnectionCacheProperties | Represents connection cache properties. See also: https://datagrok.ai/help/develop/how-to/function_results_cache | | DataConnectionProperties | Represents data connection properties. | | DataFrameArgs | - | | DbColumnProperties | - | | DbRelationProperties | - | | DbTableProperties | - | | DdlColumn | Column definition for DdlBuilder.createTable / alterTable(...).addColumn. type is a dg type (string, int, bigint, float, bool, datetime) mapped to the provider's native type server-side. | | DdlIndex | Index definition for DdlBuilder.createTable. | | DdlPlan | The execution plan of a DDL operation (DdlCommand.dryRun, or riding a DdlConfirmationRequiredError): the exact per-provider SQL plus live-data pre-checks. The apply path always recomputes the plan server-side — an earlier dry run is informational, never trusted. | | DestructiveAction | One destructive (or refused) action of a DdlPlan. | | DomainAction | A declarative action offered for a domain row (see DomainObjectHandler.getRibbonActions) — the JS mirror of the Entity View ribbon icons. Only actions the current user may perform are returned, so a consumer renders the list as-is without any permission checks of its own. | | DomainAggregateMeasure | One measure of DomainAggregateSpec: fn over column (count needs no column); the output name is as (defaults to fn or <fn>_<column>). | | DomainAggregateSpec | Spec for domain table aggregate. | | DomainAuditEntry | Wire shape of _audit rows (repository.dart rowAudit/tableAudit/schemaAudit selects). | | DomainBatchOptions | Options for domain table batch. | | DomainBatchReport | Batch upload report of domain table batch. | | DomainBatchRowResult | Per-row outcome inside a DomainBatchReport. | | DomainCellError | One cell-level problem, as stored in DomainFrameEditor.ERRORS_COLUMN: 'error' blocks DomainFrameEditor.save, 'conflict' (a dismissed version conflict) only marks the cell. | | DomainChildTableRef | FK-inverted reference to a child (detail) table — drives detail-table links and entity-view child tabs (see DomainRegistryClient.tableInfo). | | DomainColumnError | One per-column failure of a validation-failed write. | | DomainCondition | One condition node. value may be a list (= ANY / != ALL), null (IS NULL / IS NOT NULL under '='/'is'), or '@current' for the current user on user columns. Values are ALWAYS bound server-side — never interpolate values into filter strings. | | DomainDatetimeColumns | Resolved datetime columns of a table: its own plus those of its 'details:' child tables, keyed by the result field (see DomainTableClient). | | DomainDeleteReport | Report of domain table deleteWhere: rows actually soft-deleted in this call, and whether more matching deletable rows remain (loop while hasMore). | | DomainDeleteResult | Result of one deleted row. | | DomainDetailTab | One FK-inverted child ("detail") table of a domain row — what the built-in Entity View shows as a child tab (see DomainObjectHandler.getDetailTabs). | | DomainFacetCategoriesResult | Result of a 'categories' facet; hasMore set when the category cap was hit. | | DomainFacetCategory | One category bucket of a 'categories' facet: total ignores the filter, filtered respects it (minus the facet's own column); ref columns group by id and carry the referenced row's display name in display. | | DomainFacetCountResult | Result of a 'count' facet: the filtered row count. | | DomainFacetHistogramResult | Result of a 'histogram' facet: buckets respect the filter, totalBuckets ignore it. | | DomainFacetMinMaxResult | Result of a 'minMax' facet (row predicate only — the stable-axis rule ignores the filter). | | DomainFacetPlanResult | Result of a 'plan' facet: per-column profile for choosing filter-control types. | | DomainFacetSpec | One facet request of DomainFacetsSpec; id keys its result in the response. | | DomainFacetsSpec | Spec for domain table facets: one request computes every facet in a single round trip. Category counts, histogram buckets, and 'count' are computed under filter with the conditions on that facet's own column stripped, so a filter control shows counts under all OTHER filters (classic faceted search). Exception: 'minMax', 'plan', and histogram BOUNDS are computed under the row predicate only — the stable-axis rule ignores filter so a narrowing filter never re-derives the axis. At most 32 facets per request. | | DomainFrameEditorOptions | Options of DomainFrameEditor.attach / DomainFrameEditor.create. | | DomainGrant | One direct permission row on a domain registry entity (see DomainTableClient.grants). | | DomainGridOptions | Options of DomainGrid.create. | | DomainInsertResult | Result of one inserted row. | | DomainPendingOp | One pending write of DomainFrameEditor.buildOps, with the frame row it came from (how a failing opIndex finds its row). | | DomainPickerOptions | Options of DomainObjectHandler.pickRow. | | DomainQueryParams | Parameter values of the DomainQuery function — the serializable representation of what a domain view is showing (filter elements, ordering, cap), as DomainView.query reports it. Feeding it back to the function (DomainQuery.run) reproduces the subset as a DataFrame, with the creation script recorded. | | DomainQuerySpec | Query options for domain table query/queryDf. | | DomainRelationLink | One link of an expanded many-to-many relation: the target row's id and its display name (name column → dash-joined business key → id, exactly as the row renders everywhere else). A relation expand (expand: ['labels']) returns these arrays under the relation's own name, capped at 100 and ordered by display name; the array is [], never null, for an owner with no visible links. | | DomainRowErrors | Per-row failure list of a validation-failed write (DomainValidationError.rows). | | DomainSavedFilterInfo | A saved filter preset of a domain table — a small shareable entity carrying the filter panel's state maps verbatim (see DomainSavedFiltersClient). | | DomainSaveResult | What one DomainFrameEditor.save wrote (all of it in ONE transaction). Ids and versions the server returned are written back into the frame; a host that keeps its own row objects re-queries after a successful save. | | DomainTableCapabilities | Effective capabilities of the CURRENT user on one domain table (see DomainTableClient.capabilities). Composed client-side from server-truth permission probes on the FINAL securing entity through the master delegate chain, plus the writable-column mirror of column security. | | DomainTableClientOptions | Options of DomainsDataSource.table. Datetime columns resolve from the domain registry by default — these overrides exist for legacy generated clients and for callers that must avoid the registry. | | DomainTableInfo | Registry metadata of one domain table (see grok.dapi.domains.registry). | | DomainTransactionOp | One operation of DomainsDataSource.transaction. | | DomainUpdateResult | Result of one updated row: version is the new (incremented) row version. | | DomainViewOptions | Options of DomainView.create. | | DropDownListOptions | Options for dropdown with list items | | DropDownOptions | Options for dropdown | | Email | Email that can be sent using the configured SMTP service | | EmailAttachment | Attachment for an [Email]. | | EmailDialogOptions | - | | EmailDialogResult | Final values produced by [EmailDialog] when SEND is pressed. Map directly into grok.dapi.admin.sendEmail (html/text/attachments). | | EventArgs | - | | FilterState | - | | FormulaAnnotationRegion | Represents a formula annotation region (defined by two formula lines) parameters. | | FormulaLine | FormulaLine available parameters. | | FormulaLineMeta | FormulaLine meta information. | | FuncRoleDescription | - | | GridCellArgs | - | | IBarChartSettings | - | | IBoxPlotSettings | - | | ICalendarSettings | - | | ICardSettings | - | | IConfusionMatrixSettings | - | | ICorrelationPlotSettings | - | | IDensityPlotSettings | - | | IDomainQueryExecutor | Minimal structural client the builder executes against (avoids a domains.ts → dapi.ts cycle). | | IDomainTableContext | The prefetched table context a SYNCHRONOUS widget factory needs: the typed client plus the registry metadata and capabilities, resolved once by domains.table(...) (which is why form(), grid() and friends need no await). | | IEditorHost | A widget or page that answers for a set of DomainFrameEditors. | | IEventType | Event type descriptor as returned by IWidgetStatus.events. | | IFiltersSettings | - | | IFormSettings | - | | IFunctionCallOptions | - | | IFunctionRegistrationData | - | | IGridCellStyle | - | | IGridSettings | - | | IHistogramSettings | - | | IInputStatus | Live state of ONE named input of a widget, as reported by IWidgetStatus.inputs — the machine-readable counterpart of what the user sees in a form. Values and validation are read on demand, never cached: a widget reports whatever it holds at the moment Widget.getWidgetStatus is called. | | ILineChartSettings | - | | IMapViewerSettings | - | | IMarkupViewerSettings | - | | IMatrixPlotSettings | - | | IMenuColorPaletteOptions | See Menu.colorPalette | | IMenuColumnSelectorOptions | See IMenuSingleColumnSelectorOptions and IMenuMultiColumnSelectorOptions | | IMenuFontEditorOptions | See Menu.fontEditor | | IMenuHeaderOptions | See Menu.header | | IMenuItemOptions | - | | IMenuItemsOptions | See Menu.items | | IMenuMultiColumnSelectorOptions | See Menu.multiColumnSelector | | IMenuSingleColumnSelectorOptions | See Menu.singleColumnSelector | | INetworkDiagramSettings | - | | InputArgs | - | | IPcPlotSettings | - | | IPieChartSettings | - | | IPivotViewerSettings | - | | IPoint | - | | IPointsViewerSettings | - | | IProperty | Represents a property. See also Property. | | IRectBounds | Bounding rectangle returned by IWidgetStatus.hitAreas. | | IRocCurveSettings | - | | IScatterPlot3dSettings | - | | IScatterPlotSettings | - | | IServerMessageEventArgs | - | | IShowMenuOptions | - | | ISparklinesSettings | - | | IStatsViewerSettings | - | | ISummarySettings | - | | ITabControlOptions | See TabControl.create and ui.tabControl | | ITileViewerSettings | - | | ITreeMapSettings | - | | ITrellisPlotSettings | - | | IViewStateApplicationOptions | - | | IWidgetActions | What a widget must implement to be acted on by the vocabulary. Every member is optional: a widget offers the actions it can perform (see DomainForm.getFunctions), and one that cannot is simply not offered. | | IWidgetStatus | Runtime snapshot of a widget's structure, used by the automated testing system. Returned by Widget.getWidgetStatus. | | MapChangeArgs | - | | MultiViewOptions | - | | MutationResult | The structured result of a database write (DbTable insert/upsert/update/delete). Mutations never return a DataFrame. inserted/updated/skipped are best-effort — some dialects cannot tell inserts from updates on an upsert and leave the split null. | | ProjectOpenOptions | - | | PropertyChangeArgs | - | | QnumColumnCreationOptions | Options for ColumnList.addNewQnum. | | RowChangeArgs | - | | RowError | One failed row of a MutationResult. | | SemTypeInfo | Metadata associated with the semantic type. | | ServiceInfo | - | | Size | - | | UndoRecordArgs | - | | UnsavedPromptOptions | Wording of promptUnsavedChanges. | | ViewArgs | - | | ViewChangeArgs | - | | ViewerArgs | - | | WizardPage | EXPERIMENTAL - USE AT YOUR OWN RISK - API might change |
Type Aliases
| Type Alias | Description |
|---|
| AggregationType | - | | AnyDomainTableClient | A domain client with its row/insert/column/expand/update generics erased — what the REFLECTIVE widgets take. A TYPED client fits it, so a generated <Table>Ui (or a DomainTable handle) keeps its own generics and is still usable here. The update generic must be erased explicitly: its Partial<TRow> default is a real object type, and update() would then reject a typed client's payload. | | CategoryDataArgs | - | | CodeConfig | - | | ColorCodingType | - | | ColorType | - | | ColumnAggregationType | - | | ColumnId | - | | ColumnType | - | | ColumnTypeFilter | - | | Comparer | - | | CorrPlotCellArgs | - | | CsvImportColumnOptions | - | | CsvImportOptions | - | | DemoDatasetName | - | | DockerContainerStatus | - | | DockType | - | | DomainAggregateRow | One result row of aggregate — keys are the group columns and measure aliases. | | DomainColumnRef | Column reference: a declared column of the table, a system column, or a dotted FK path ('project_id.name', up to 3 forward hops). Used by the condition, sort, and aggregate column slots — those accept system columns even when a hand-written [TColumn] union omits them (generated <Table>Column unions include them). Other slots (equality-map where, columns, select(), fetchFields(), column security) stay TColumn-typed. | | DomainConditionNode | Inside a tree, a bare string is a connector; an omitted connector means 'and' (sticky — the last seen connector repeats). | | DomainConditionOperator | Operators of the canonical condition tree (server: filter_compiler.dart:149-153 + fuzzy). | | DomainConditionTree | The canonical condition tree: conditions and nested trees joined by connector strings. | | DomainFacetKind | The facet kinds of DomainFacetSpec. | | DomainFacetResultOf | Maps a facet kind to its result type (keys the typed facets() response). | | DomainFilter | Every filter slot accepts the smart-filter string (human shorthand), a single condition, or the canonical condition tree — uniformly across query, queryDf, aggregate, facets, count, exists, and deleteWhere (server: DomainFilterCompiler.toTree). | | DomainFilterValue | Value of one condition: scalar, list (= ANY / != ALL), null (IS [NOT] NULL), or dayjs (sent as ISO-8601). Always bound server-side. | | DomainOpResult | Result of one transaction op (see DomainOpResultFor for the typed-tuple form). | | DomainOpResultFor | Result type of one transaction op, keyed on its op discriminant — powers the mapped-tuple transaction() signatures (per-op result types, no positional casts). | | DomainPermission | Grantable permission on a domain registry entity (table, schema, or column schema). 'Extend' is grantable on SCHEMA entities only — it lets the holder add their own tables and columns to a package-managed schema the plugin opted in to. | | DomainRowInsert | Insert payload for domain table insert: row values plus an optional idempotency key (for tables that declare "idempotency": true). | | DomainRowState | Per-row editing state, as stored in DomainFrameEditor.STATE_COLUMN. | | DomainSystemColumn | The system columns every domain table carries (always projected on reads). | | DomainTxValues | Typed transaction-op values: each column also accepts a '$<ref>' back-reference. | | DropDownMenuBuilder | Builder function for full Menu control (separators, headers, etc.) | | DropDownMenuItems | Menu items definition: functions for items, objects for nested groups. | | ElementOptions | - | | FieldOrder | - | | FieldPredicate | - | | FileImportArgs | - | | fileShares | - | | GridColumnTooltipType | - | | GroupAggregation | - | | GroupDescription | - | | GroupsDescription | - | | HorzAlign | - | | ICodeEditorOptions | - | | IndexPredicate | - | | IndexSetter | - | | JoinType | - | | JsonArray | - | | JsonObject | - | | JsonPrimitive | - | | JsonValue | - | | LegendPosition | - | | LineChartLineArgs | - | | LogMessage | - | | MarkdownConfig | - | | MarkerCodingType | - | | MatchType | - | | ObjectType | - | | PropertyGetter | - | | PropertySetter | - | | RangeSliderStyle | - | | RowDataArgs | - | | RowPredicate | - | | ScriptingLanguage | - | | SearchProvider | the home view should be under the name home and rest should match the views that they are applicable to | | SemType | - | | SimilarityMetric | - | | SliderOptions | - | | StringPredicate | - | | StructureFilterType | - | | SyncType | - | | TableJoin | - | | TextWrap | - | | Type | - | | TypeAheadCallbackSource | Async suggestion callback for TypeAheadConfig.source: receives the typed query and resolves to suggestions — strings or objects with a label (extra fields ride along and are passed to onSubmit intact, e.g. {label, value} for lookups resolving to an id). | | TypeAheadConfig | - | | UnsavedOutcome | What the user chose in promptUnsavedChanges (dismissing it is 'cancel'). | | ValueValidator | - | | VertAlign | - | | ViewerPropertyType | - | | ViewerType | - | | ViewSpecificSearchProvider | - | | ViewType | - |
Variables
Functions
| Function | Description |
|---|
| __obs | Creates an RxJS Observable from a Dart event stream. | | _getIterator | Creates a JavaScript iterator from a Dart iterator. | | _identityInt32 | - | | _isDartium | - | | _options | - | | _propsToDart | Converts entity properties between JavaScript and Dart. See also: include | | _sub | Wraps a Dart stream subscription as a JavaScript StreamSubscription. | | _toIterable | Wraps a Dart iterable as a JavaScript Iterable. Allows using Dart collections in for...of loops. | | _toJson | Converts a value to JSON string, handling null. | | acquireDomainContext | Resolves [client]'s registry metadata and the caller's capabilities in ONE round of requests — the async boundary every synchronous widget factory sits behind (domains.table(), DomainGrid.create(), EntityListWidget.create()). | | and | AND-combined condition tree: and(a, b, c) → [a, 'and', b, 'and', c]. | | applyDomainGridStyles | Adds the grid stylesheet to the document once — safe to call per component. | | callFuncWithDartParameters | - | | cond | Bound condition node: cond('name', '=', "O'Brien"). The value travels in the condition tree and is bound server-side — NEVER interpolated into a filter string, so any string value is expressible (apostrophes included, which the smart-filter grammar cannot quote). | | confirmDiscardChanges | THE gate an app puts in front of a rebuild: resolves to whether the caller may proceed, having saved or discarded whatever was pending. | | debounce | - | | delay | - | | domainActionFunc | Wraps a custom DomainAction as a widget-action Func, through the same idempotent registration — a plugin's extra action is as discoverable as Save. | | domainCall | Awaits [p], rethrowing interop-marked failures as typed DomainErrors. | | format | - | | histogram | - | | identity | Returns an 'identity' array where the element in idx-th position is equals to idx. | | observeStream | Converts Dart stream to rxjs.Observable. | | or | OR-combined condition tree: or(a, b, c) → [a, 'or', b, 'or', c]. | | paramsToJs | Converts a list of Dart objects to JavaScript objects. Iterates through the array and calls toJs on non-scalar types. | | promptUnsavedChanges | Asks what to do with the pending changes of [editors] before something that would discard them. Resolves to the user's decision WITHOUT applying it — confirmDiscardChanges is the one that saves or discards. | | range | Generates [count] increasing integer numbers, starting with 0. | | renderMultipleHistograms | - | | retryOnVersionConflict | Runs [action], retrying on DomainVersionConflictError (for transaction-based read-modify-write flows — put the fresh read INSIDE [action]); rethrows anything else and the final conflict. maxRetries counts retries AFTER the initial attempt (default 5 retries = up to 6 attempts). Retries run immediately, without backoff — conflicts resolve by re-reading, not waiting; add your own delay for high-contention hot rows. | | splitDomainTable | Splits the '<schema>.<table>' address every domain client and UI component takes, throwing on a malformed one — the single spelling of that contract. | | time | Times the execution of function f | | timeAsync | Times the execution of asyncronous function f | | toDart | Converts a JavaScript object to its Dart representation. | | toDomainError | Maps the interop's '#domainError' plain object to a typed class; passes anything else through. | | toJs | Converts a Dart object to its JavaScript wrapper or native JS value. |
References
Re-exports EntityMetaDartProxy
ObjectHandler
Re-exports ObjectHandler
|