Size of the bottom area as a percentage (0-100) for angular-split. Used by CodeGen-generated templates with as-split.
Tree dropdown config for Query Categories
Layout the container resolved for this form. Set by <mj-record-form-container>; read by panel hosts.
Last composition snapshot the container published — what is actually on this form: sections, related grids, contributions and slots. Consumers: agent context (so Skip can target a real slot and section key) and Form Studio.
Per-instance presentation config (toolbar visibility, related-entity
sections, collapsibility, width, in-form navigation). Set by the form host
(MjEntityFormHostComponent) or any consumer that instantiates the form
directly. Read back by MjRecordFormContainerComponent and the collapsible
panels through the FormComponent reference, so it takes effect WITHOUT
regenerating the CodeGen-produced template. Null means "use the container's
own defaults" (the classic full-page tab behavior).
ID of the currently-rendered variant (null when no override is active and the form is the CodeGen /
Emitted whenever edit mode starts (true) or ends (false). The Explorer
shell uses the true edge to PROMOTE a records preview tab — pin it — the
moment the user starts editing (VS Code's promote-on-modify), so a record
being edited is neither replaceable by the next plain open nor italic.
Fires on every call, not only on transitions: a new record's ngOnInit
re-asserts edit mode and the shell's pin is idempotent.
ProtectedelementCallback supplied by MjEntityFormHostComponent when the entity has both a
custom form and a CodeGen standard form, allowing the toolbar's phone View
sheet to switch between them.
ProtectedformEmitted when navigation is requested (record link, external link, email, new record, etc.)
Emitted when a user-facing notification should be shown
Hook called when the user picks a different variant from the picker.
Default is a no-op; the Explorer-level single-record component replaces
this on the form instance to wire FormResolverService.SetSelectedVariant
and reload the record. Kept as a method (not an EventEmitter) so the host
doesn't need to subscribe — assignment is enough.
ProtectedplacementThe placement dialog's unsaved panel, when this form is the dialog's preview.
If specified, this provider will be used for communication and for all metadata purposes. By default, if not provided, the Metadata and RunView classes are used for this and the default GraphQLDataProvider is used which is connected to the same back-end MJAPI instance as the Metadata and RunView classes. If you want to have this component connect to a different MJAPI back-end, create an instance of a ProviderBase sub-class like GraphQLDataProvider/etc, and configure it as appropriate to connect to the MJAPI back-end you want to use, and then pass it in here.
Emitted after a record is deleted successfully
Emitted when a record delete fails
Emitted once after ngOnInit completes and the record is fully initialized (favorites loaded, form state initialized). This is the safe point for the container to start loading badge counts and other record-dependent data.
Emitted after a record is refreshed from the database successfully
Emitted after a record is saved successfully
Emitted when a record save fails
Why the last save was refused, one finding per rule the SQL broke; empty after a successful save.
The refusal's headline, e.g. Query "X" was not saved:.
Fires when a section's known row count changes — from the container's batched
count prefetch, a related grid load (including a manual grid refresh), or a
contribution reporting its own count. The container re-resolves empty-section
chrome (whenEmpty) when a count crosses zero.
ProtectedsectionsReadonlyToolbarHeight of the top area when a splitter layout is used. Referenced by CodeGen-generated templates for entities with "top area" sections.
Size of the top area as a percentage (0-100) for angular-split. Used by CodeGen-generated templates with as-split.
Emitted when validation fails before save
Variants applicable to the current (entity, user) tuple, supplied by the Explorer-level form resolver. When more than one entry is present, the record-form-container shows a picker that lets the user switch between variants. Empty / single-entry arrays hide the picker.
The container reads this via its EffectiveVariants accessor — generated
form templates do NOT need to bind it explicitly.
StaticɵdirStaticɵfacReturns all organic key related entities across all organic keys, flattened and sorted.
Whether the user may refresh this query's metadata: a saved query, not being edited, and Update permission on queries.
Use Categories.
CategoryID as CompositeKey for tree dropdown binding
Use CategoryOptions.
Use CategoryPathDisplay.
Use CategoryTreeData.
Gets queries that depend on (reference) this query via composition.
Use DetailsPanelExpanded.
The entry-time duplicate check. While a person enters a new record it asks the server, after
each pause in editing, whether the values duplicate existing records, and holds the ones to
flag. It only flags: saving is never blocked and nothing is merged. mj-record-form-container
shows the notice.
The findings of the query's last metadata extraction (ExtractionMessage), one per line.
How serious the extraction message is, for the diagnostics list.
CSS modifier for the extraction status badge.
The extraction status as the badge shows it.
Use FieldsPanelExpanded.
Context handed to every field, panel and slot in the form.
Returns the SAME object while nothing in it has changed. Templates bind this getter in dozens of places per form, and Angular evaluates each binding on every change-detection pass — so allocating a fresh object per access handed every child a new reference each pass, defeating input-identity checks and cascading re-renders through the whole form. Building the candidate is cheap (the expensive part, hidden section keys, is memoized); the identity comparison below is what stops the cascade.
Unsaved changes a form holds OUTSIDE its record's fields and pending records.
A form whose sections own editors — a flow canvas, a designer, a grid — accumulates edits that
neither record.Dirty nor PendingRecordsDirty() can see, because nothing on the entity
changed. Without this the toolbar reports "no changes" while the user is looking at their own
work, and the navigate-away guard lets them lose it silently.
Default false, so no existing form changes behaviour. Override to consult whatever holds the
extra state.
Whether the current entity has any active organic keys with related entities configured.
Use HasUnsavedChanges.
Whether the form holds unsaved work that its record's own fields don't show: pending related
records (a child grid's edits or deletes) or HasAdditionalUnsavedChanges. Hosts consult
it before tearing the form down (e.g. the standard-form switch); combine with record.Dirty
for the full picture.
A pure read, unlike PendingRecordsDirty: that path raises EDITING_COMPLETE (child grids
commit in-progress cell edits on it) and rebuilds _pendingRecords, which the save pipeline
owns. Here descendants only report their pending changes into a throwaway event, so asking
changes nothing. An edit still open in a grid cell (not yet committed to its entity) is not seen.
Entries the form itself already holds in PendingRecords count too, but only while editing:
some forms add related-record changes there directly instead of reporting them on the event
(the AI Agent form's "Remove action", added actions and prompts), and CancelEdit reverts
saves but leaves delete entries in the list, so outside edit mode they are stale.
Use IsLoadingEntities.
Use IsLoadingFields.
Use IsLoadingParameters.
Use IsLoadingPermissions.
Returns all active organic keys for the current entity, or an empty array if none.
Custom-layout form owns its entire body; suppress auto-filled relationship sections.
ProtectedPendingReturns either the default Metadata provider or the one specified in the Provider property, if it was specified
Use QueryEntities.
Use QueryFields.
Use QueryParameters.
Use QueryPermissions.
This query, as the refresh dialog's scope.
Names this query in the refresh dialog.
Returns all dynamically registered toolbar items.
Returns either the default RunQuery provider or the one specified in the Provider property, if it was specified
Returns either the default RunView provider or the one specified in the Provider property, if it was specified
Whether the possible-duplicate notice shows: a new record with flagged candidates not dismissed.
Use ShowFiltersHelp.
Use ShowRunDialog.
Use SqlEditor.
Use SqlFilters.
Use SqlPanelExpanded.
Use StatusOptions.
Returns the map of toolbar item overrides.
Use AddEntity.
Adds an entity link the user declares. It is written with the query when the query is saved.
Use AddField.
Adds a field the user declares, by name. Its facts (type, nullability, source) come from the database server when the query is saved; the user supplies the annotations.
Use AddParameter.
Adds a parameter the user declares. It is written with the query when the query is saved.
Builds RunViewParams for a specific organic key related entity.
Convenience method to build organic key view params by organic key name and related entity name.
OptionalrelatedEntityJoinField: stringOne grid over several FKs to the same related entity (Bill-To OR Ship-To).
ProtectedCheckAsks the server whether the values being entered duplicate existing records. A form on a
provider that is not a GraphQLDataProvider has no server to ask, so the check reports
NotConfigured and stops for the entity. Override to send the check elsewhere.
Configures overrides for any toolbar item (standard built-in items like 'edit', 'delete', 'favorite', 'history', etc., or custom items). Allows dynamically changing visibility, disabled state, tooltips, order, icon, etc.
Use CreateCategory.
Create a new Query Category in a slide-in via the generic MJFormPresenterService. A new record opens in edit mode automatically. On save, refresh the category tree and select the new category.
Removes an entity link. A stored one is deleted when the query is saved.
Removes a field. A stored one is deleted when the query is saved.
Removes a parameter. A stored one is deleted when the query is saved.
Dynamically disables a toolbar item by key, with an optional reason string for the tooltip.
Optionalreason: stringThe person dismissed the possible-duplicate notice.
Use EditSelectedCategory.
Edit the currently-selected category in a slide-in via the generic
MJFormPresenterService. StartInEditMode opens the existing record
editable. On save, refresh the category tree.
Format date for display
Optionaldecimals: numberOptionalcurrency: stringOptionaldecimals: numberOptionalcurrency: stringUse GetCategoryPath.
Custom-layout Query form looks best full-width on first open.
Use GetEntityOptions.
Get entity options for dropdown
OptionalrelatedEntityJoinField: stringProtectedgetWhere this key sits in the section order, or null when it is not in it at all.
getSectionDisplayOrder cannot answer that: it returns the section count for an unknown key, which is indistinguishable from a real last position. A contribution panel is not in the form's declared sections, so a caller has to be able to tell "the user placed this here" from "nobody has said where this goes".
The row count shown as a section's badge. undefined until known, and always
undefined for a section whose badge is turned off (showCount: false) — use
PeekSectionRowCount for the underlying number.
Use GetStatusBadgeColor.
Use GetStatusBannerIcon.
Get the grid edit mode based on component edit mode
ProtectedinitProtectedInternalSaves the query with its declared parameters, fields and entity links as one graph save, then any permission rows the permissions grid queued, in a transaction group of their own.
The base form enrols the record in a transaction group whenever rows are queued, and a graph save cannot run inside one (the group defers the query's own write, so its children would be written against a row that does not exist yet). The query is therefore written first; if a permission row then fails, the query stays saved and the save reports the failure.
Use IsFormReadOnly.
OptionaldefaultExpanded: booleanUse LoadCategories.
Use LoadQueryEntities.
Use LoadQueryFields.
Use LoadQueryParameters.
Use LoadQueryPermissions.
Default values for a new related-entity record so it links back here.
Pass relatedEntityJoinField when more than one relationship targets the
same entity (Bill-To vs Ship-To). When omitted and several matches exist,
every matching FK is set — same fields the related grid is filtering on.
OptionalrelatedEntityJoinField: stringDefault values for a new related record, setting every listed join field to this record's key. Pair with BuildRelationshipViewParamsForJoinFields.
Handle tree dropdown category selection
A child row's annotation changed in a grid.
Handle composition token click — navigate to the referenced query
Hook invoked when a custom or dynamic toolbar item is clicked. Subclasses can override this method to handle custom button clicks.
Handles delete requests from the form container. Emits RecordDeleted on success, RecordDeleteFailed on failure. Generated form templates bind this as: (DeleteRequested)="OnDeleteRequested()"
A finding's location was clicked: show that place in the SQL editor.
Handles favorite toggle from the form container. Generated form templates bind this as: (FavoriteToggled)="OnFavoriteToggled()"
A person edited a field on this form. For a new record this restarts the entry-time duplicate
check. mj-record-form-container calls it for every mj-form-field edit; a custom editor that
changes the record some other way can call it too.
A user who cannot read the entity (one who may only create its records) never starts a check: the server would refuse it, and a flagged record is one they could not open anyway.
Handles navigation events from the form container and related entity grids. Relays the event upward via the Navigate
Handles history view requests from the form container. Generated form templates bind this as: (HistoryRequested)="OnHistoryRequested()"
Handles list management requests from the form container. Generated form templates bind this as: (ListManagementRequested)="OnListManagementRequested()"
Opens the entity field a query column comes from.
A refresh was applied: reload the query row (its extraction status) and its child rows.
Opens a query named in the refresh report.
Use OnRunDialogClose.
Handle run dialog close
Handle SQL value changes from the code editor
Opens a flagged candidate the way the form opens any record: a Navigate event the host
handles, never a router call. It asks for a new tab, so the record being entered is kept.
The last known row count for a section, regardless of whether its badge shows.
ProtectedPendingProtectedPopulateProtectedRaiseRe-fetches the current record from the database, updating field values in-place and resetting dirty flags. No-op in edit mode or on an unsaved record. Related-entity grids are notified via the form container's FormRecordRefreshCoordinator after this emits RecordRefreshed.
Optionaloptions: RefreshRecordOptionsShowSuccessNotification: false skips the "Record refreshed" notification;
failure notifications still show.
true if the record was reloaded from the database.
Slot hosts register every mounted panel so validation can include panel-owned checks.
Registers a dynamic toolbar action item / button. Can be called during ngOnInit or at runtime.
Use RunQuery.
Run the query with parameter dialog
Show or hide a section's row-count badge (metadata showCount). The count itself is still tracked.
Sets the numeric display order for a toolbar item (lower numbers appear earlier).
Called when the splitter layout changes (for entities with "top area" sections). No-op in the generic version; override in host application if splitter resizing is needed.
Use ToggleFiltersHelp.
Unregisters a previously registered dynamic toolbar item by key.
Record + pending-record validation, merged with whatever panel validity is already known.
Synchronous, and therefore blind to a panel validator that has not reported yet — any path that gates a save must use ValidateAsync. The signature stays synchronous because this is published API with external callers.
Validate, merged with every mounted panel's validator, awaited. This is what
SaveRecord() calls.
It starts from Validate(), so a subclass that overrides Validate() still gates the
save; the panels' last-known state is left out of that call, because their awaited
results replace it.
A panel's Validate() may be async — anything checking server state will be — and
reading such a result synchronously yields a Promise, which tests as "no opinion"
and lets an invalid record save with no error and no log.
ProtectedValidate
Emitted when the user clicks the "Ask AI" action in the form toolbar to open the AI chat overlay with this record's live context.