{ "metadata": { "toolPackage": "@microsoft/api-extractor", "toolVersion": "7.52.10", "schemaVersion": 1011, "oldestForwardsCompatibleVersion": 1001, "tsdocConfig": { "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json", "noStandardTags": true, "tagDefinitions": [ { "tagName": "@alpha", "syntaxKind": "modifier" }, { "tagName": "@beta", "syntaxKind": "modifier" }, { "tagName": "@defaultValue", "syntaxKind": "block" }, { "tagName": "@decorator", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@deprecated", "syntaxKind": "block" }, { "tagName": "@eventProperty", "syntaxKind": "modifier" }, { "tagName": "@example", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@experimental", "syntaxKind": "modifier" }, { "tagName": "@inheritDoc", "syntaxKind": "inline" }, { "tagName": "@internal", "syntaxKind": "modifier" }, { "tagName": "@label", "syntaxKind": "inline" }, { "tagName": "@link", "syntaxKind": "inline", "allowMultiple": true }, { "tagName": "@override", "syntaxKind": "modifier" }, { "tagName": "@packageDocumentation", "syntaxKind": "modifier" }, { "tagName": "@param", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@privateRemarks", "syntaxKind": "block" }, { "tagName": "@public", "syntaxKind": "modifier" }, { "tagName": "@readonly", "syntaxKind": "modifier" }, { "tagName": "@remarks", "syntaxKind": "block" }, { "tagName": "@returns", "syntaxKind": "block" }, { "tagName": "@sealed", "syntaxKind": "modifier" }, { "tagName": "@see", "syntaxKind": "block" }, { "tagName": "@throws", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@typeParam", "syntaxKind": "block", "allowMultiple": true }, { "tagName": "@virtual", "syntaxKind": "modifier" }, { "tagName": "@betaDocumentation", "syntaxKind": "modifier" }, { "tagName": "@internalRemarks", "syntaxKind": "block" }, { "tagName": "@preapproved", "syntaxKind": "modifier" }, { "tagName": "@fires", "syntaxKind": "block", "allowMultiple": true } ], "supportForTags": { "@alpha": true, "@beta": true, "@defaultValue": true, "@decorator": true, "@deprecated": true, "@eventProperty": true, "@example": true, "@experimental": true, "@inheritDoc": true, "@internal": true, "@label": true, "@link": true, "@override": true, "@packageDocumentation": true, "@param": true, "@privateRemarks": true, "@public": true, "@readonly": true, "@remarks": true, "@returns": true, "@sealed": true, "@see": true, "@throws": true, "@typeParam": true, "@virtual": true, "@betaDocumentation": true, "@internalRemarks": true, "@preapproved": true, "@fires": true }, "reportUnsupportedHtmlElements": false } }, "kind": "Package", "canonicalReference": "@genesislcap/foundation-entity-management!", "docComment": "", "name": "@genesislcap/foundation-entity-management", "preserveMemberOrder": false, "members": [ { "kind": "EntryPoint", "canonicalReference": "@genesislcap/foundation-entity-management!", "name": "", "preserveMemberOrder": false, "members": [ { "kind": "Enum", "canonicalReference": "@genesislcap/foundation-entity-management!ActionsMenuStyle:enum", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare enum ActionsMenuStyle " } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "ActionsMenuStyle", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!ActionsMenuStyle.ActionsHorizontal:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "ActionsHorizontal = " }, { "kind": "Content", "text": "\"actions-horizontal\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "ActionsHorizontal" }, { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!ActionsMenuStyle.ActionsVertical:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "ActionsVertical = " }, { "kind": "Content", "text": "\"actions-vertical\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "ActionsVertical" }, { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!ActionsMenuStyle.Default:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "Default = " }, { "kind": "Content", "text": "\"default\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "Default" } ] }, { "kind": "TypeAlias", "canonicalReference": "@genesislcap/foundation-entity-management!AdditionalEntry:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type AdditionalEntry = " }, { "kind": "Content", "text": "string | " }, { "kind": "Reference", "text": "UiSchema", "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type" }, { "kind": "Content", "text": " | {\n type: 'Control';\n scope: string;\n label?: string;\n options?: {\n readonly?: boolean;\n hidden?: boolean;\n allOptionsResourceName?: string;\n valueField?: string;\n labelField?: string;\n };\n}" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "AdditionalEntry", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Function", "canonicalReference": "@genesislcap/foundation-entity-management!buttonCellRenderer:function(1)", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buttonCellRenderer: (title: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ", clickHandler: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ", contentTemplate: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ", tooltip?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ") => " }, { "kind": "Reference", "text": "ColDef", "canonicalReference": "@ag-grid-community/core!ColDef:interface" } ], "fileUrlPath": "src/utils/renderer.ts", "returnTypeTokenRange": { "startIndex": 9, "endIndex": 10 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "title", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "clickHandler", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false }, { "parameterName": "contentTemplate", "parameterTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "isOptional": false }, { "parameterName": "tooltip", "parameterTypeTokenRange": { "startIndex": 7, "endIndex": 8 }, "isOptional": true } ], "name": "buttonCellRenderer" }, { "kind": "Interface", "canonicalReference": "@genesislcap/foundation-entity-management!ConfirmSubmit:interface", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface ConfirmSubmit " } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "ConfirmSubmit", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!ConfirmSubmit#message:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "message: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "message", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!ConfirmSubmit#state:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "state: " }, { "kind": "Content", "text": "'enabled' | 'disabled'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "state", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Enum", "canonicalReference": "@genesislcap/foundation-entity-management!CrudAction:enum", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare enum CrudAction " } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "CrudAction", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!CrudAction.Create:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "Create = " }, { "kind": "Content", "text": "\"create\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "Create" }, { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!CrudAction.Delete:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "Delete = " }, { "kind": "Content", "text": "\"delete\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "Delete" }, { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!CrudAction.Read:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "Read = " }, { "kind": "Content", "text": "\"read\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "Read" }, { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!CrudAction.Update:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "Update = " }, { "kind": "Content", "text": "\"update\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "Update" } ] }, { "kind": "Enum", "canonicalReference": "@genesislcap/foundation-entity-management!CrudMenuPosition:enum", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare enum CrudMenuPosition " } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "CrudMenuPosition", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!CrudMenuPosition.Action:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "Action = " }, { "kind": "Content", "text": "\"action\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "Action" }, { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!CrudMenuPosition.Bottom:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "Bottom = " }, { "kind": "Content", "text": "\"bottom\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "Bottom" }, { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!CrudMenuPosition.Column:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "Column = " }, { "kind": "Content", "text": "\"column\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "Column" }, { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!CrudMenuPosition.None:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "None = " }, { "kind": "Content", "text": "\"none\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "None" }, { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!CrudMenuPosition.Top:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "Top = " }, { "kind": "Content", "text": "\"top\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "Top" } ] }, { "kind": "Interface", "canonicalReference": "@genesislcap/foundation-entity-management!CustomAction:interface", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface CustomAction " } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "CustomAction", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomAction#action:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "action: " }, { "kind": "Content", "text": "{\n type: 'event';\n event: string;\n hasForm: boolean;\n defaultValues?: " }, { "kind": "Reference", "text": "DefaultValues", "canonicalReference": "@genesislcap/foundation-entity-management!DefaultValues:interface" }, { "kind": "Content", "text": ";\n uiSchema?: " }, { "kind": "Reference", "text": "UiSchema", "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type" }, { "kind": "Content", "text": ";\n } | {\n type: 'callback';\n callback: (rowData: any) => void;\n }" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "action", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 6 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomAction#appearance:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "appearance?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "appearance", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomAction#confirmSubmit:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "confirmSubmit?: " }, { "kind": "Reference", "text": "ConfirmSubmit", "canonicalReference": "@genesislcap/foundation-entity-management!ConfirmSubmit:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "confirmSubmit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomAction#disabled:member", "docComment": "/**\n * Optional callback function to determine if the button should be disabled. Receives the selected entity (rowData) as a parameter. If provided, this takes precedence over `requiresSelection`.\n *\n * @param rowData - The currently selected row data, or null if no row is selected\n *\n * @returns true if the button should be disabled, false otherwise\n */\n", "excerptTokens": [ { "kind": "Content", "text": "disabled?: " }, { "kind": "Content", "text": "(rowData: any) => boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "disabled", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomAction#icon:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "icon?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "icon", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomAction#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomAction#position:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "position?: " }, { "kind": "Reference", "text": "CrudMenuPosition", "canonicalReference": "@genesislcap/foundation-entity-management!CrudMenuPosition:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "position", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomAction#requiresSelection:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "requiresSelection?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "requiresSelection", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomAction#setApprovalMessage:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "setApprovalMessage?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "setApprovalMessage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomAction#tooltip:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "tooltip?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "tooltip", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@genesislcap/foundation-entity-management!CustomActionError:interface", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface CustomActionError " } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "CustomActionError", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomActionError#errors:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "errors: " }, { "kind": "Content", "text": "{\n message?: string;\n CODE: string;\n TEXT: string;\n }[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "errors", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@genesislcap/foundation-entity-management!CustomActionEventDetail:interface", "docComment": "/**\n * Detail payload for the `custom-action` event, fired when a custom grid action button is clicked in {@link @genesislcap/foundation-entity-management#List | entity-list}.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface CustomActionEventDetail " } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "CustomActionEventDetail", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomActionEventDetail#actionName:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "actionName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "actionName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@genesislcap/foundation-entity-management!CustomActionState:interface", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface CustomActionState " } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "CustomActionState", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomActionState#event:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "event", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomActionState#name:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "name: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "name", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!CustomActionState#rowData:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "rowData: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rowData", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "TypeAlias", "canonicalReference": "@genesislcap/foundation-entity-management!DatasourceConfiguration:type", "docComment": "/**\n * The attribute which is set to configure the resource that the entity manager is working with\n *\n * Because this type is `Omit`, you can configure query behavior (filtering, sort, limits, polling, request payloads), while `resourceName` remains configured directly on `entity-management`.\n *\n * Supported properties: - `criteria`: filter expression applied to the datasource - `disablePolling`: disables polling for request/reply resources - `fields`: comma-separated fields to return (DATASERVER resources) - `isSnapshot`: treat datasource as a snapshot instead of streaming updates - `maxRows`: max rows returned - `maxView`: max rows tracked in the client-side view - `movingView`: controls behavior when real-time rows arrive - `offset`: starting row offset - `pollingInterval`: polling interval in milliseconds - `pollTriggerEvents`: event names that trigger an extra poll - `request`: payload sent to request/reply resources - `requestAutoSetup`: auto-generates request shape from metadata - `viewNumber`: current page/view number - `orderBy`: field used for sorting - `reverse`: reverse sort order\n *\n * @example\n * ```javascript\n * type DatasourceConfiguration = {\n * criteria?: string;\n * disablePolling?: boolean;\n * fields?: string;\n * isSnapshot?: boolean;\n * maxRows?: number;\n * maxView?: number;\n * movingView?: boolean;\n * offset?: number;\n * pollingInterval?: number;\n * pollTriggerEvents?: string[];\n * request?: any;\n * requestAutoSetup?: boolean;\n * viewNumber?: number;\n * orderBy?: string;\n * reverse?: boolean;\n * }\n * ```\n *\n * @example\n * ```typescript\n * ({\n * criteria: 'STATUS == \"OPEN\"',\n * orderBy: 'LAST_UPDATED',\n * reverse: true,\n * maxRows: 200,\n * })}\n * >\n * ```\n *\n * @example\n * ```typescript\n * ({\n * request: {\n * PROFILE_NAME: 'ADMIN',\n * RIGHT_CODE: '*',\n * },\n * requestAutoSetup: true,\n * disablePolling: true,\n * })}\n * >\n * ```\n *\n * @example\n * ```typescript\n * ({\n * pollingInterval: 10000,\n * pollTriggerEvents: [\n * 'EVENT_COUNTERPARTY_INSERT',\n * 'EVENT_COUNTERPARTY_MODIFY',\n * 'EVENT_COUNTERPARTY_DELETE',\n * 'EVENT_REFERENCE_DATA_REFRESHED',\n * ],\n * })}\n * >\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export type DatasourceConfiguration = " }, { "kind": "Reference", "text": "Omit", "canonicalReference": "!Omit:type" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "DatasourceOptions", "canonicalReference": "@genesislcap/foundation-comms!DatasourceOptions:interface" }, { "kind": "Content", "text": ", 'resourceName'>" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/entities/entities.ts", "releaseTag": "Public", "name": "DatasourceConfiguration", "typeTokenRange": { "startIndex": 1, "endIndex": 5 } }, { "kind": "TypeAlias", "canonicalReference": "@genesislcap/foundation-entity-management!DefaultValue:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type DefaultValue = " }, { "kind": "Content", "text": "string | number | boolean | null | " }, { "kind": "Reference", "text": "RecordTypeValue", "canonicalReference": "@genesislcap/foundation-entity-management!RecordTypeValue:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "DefaultValue", "typeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Interface", "canonicalReference": "@genesislcap/foundation-entity-management!DefaultValues:interface", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface DefaultValues " } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "DefaultValues", "preserveMemberOrder": false, "members": [ { "kind": "IndexSignature", "canonicalReference": "@genesislcap/foundation-entity-management!DefaultValues:index(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "[key: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "]: " }, { "kind": "Reference", "text": "DefaultValue", "canonicalReference": "@genesislcap/foundation-entity-management!DefaultValue:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "key", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ] } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-entity-management!ENTITY_NAME:var", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "ENTITY_NAME: " }, { "kind": "Content", "text": "import(\"@microsoft/fast-foundation\")." }, { "kind": "Reference", "text": "InterfaceSymbol", "canonicalReference": "@microsoft/fast-foundation!InterfaceSymbol:type" }, { "kind": "Content", "text": "" } ], "fileUrlPath": "src/types.ts", "isReadonly": true, "releaseTag": "Public", "name": "ENTITY_NAME", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Class", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement:class", "docComment": "/**\n * Main class which defines the entity management functionality\n *\n * @remarks\n *\n * Connects to a backend resource and wraps up a grid which is populated with entities from that resource. The different interactions that the user can perform with the entities can be configured, examples being able to update and delete entities.\n *\n * @example\n *\n * Example of using the entity management system to handle counterparties\n * ```\n * \n * ```\n *\n * Where:
- the title of the grid is `Counterparty Management`
- the name of the resource in the database to manage is `ALL_COUNTERPARTYS`
- the name of the event handler for update events is `EVENT_COUNTERPARTY_MODIFY`
- the name of the event handler for create events is `EVENT_COUNTERPARTY_INSERT`
- the name of the event handler for delete events is `EVENT_COUNTERPARTY_DELETE`
\n *\n * @fires\n *\n * request-changed - Fired when the request is changed. detail: `Record | null`\n *\n * @fires\n *\n * criteria-changed - Fired when the criteria is changed. detail: `string | null`\n *\n * @fires\n *\n * create-entity - Fired when an entity is created\n *\n * @fires\n *\n * edit-entity - Fired when an entity is edited\n *\n * @fires\n *\n * delete-entity - Fired when an entity is deleted\n *\n * Bubbled events from the child entity-list component\n *\n * @fires\n *\n * submit-failure - Fired when there is an error in a create, edit or delete operation. detail: `SubmitFailureEventDetail`\n *\n * @fires\n *\n * submit-success - Fired when a create, edit or delete operation is completed successfully. detail: `SubmitSuccessEventDetail`\n *\n * @fires\n *\n * rowClick - Fired when a row is clicked. detail: `Record | undefined`\n *\n * @fires\n *\n * rowDblClick - Fired when a row is double clicked. detail: `Record | undefined`\n *\n * @fires\n *\n * contextMenu - Fired when a row is right clicked. detail: `Record | undefined`\n *\n * @fires\n *\n * rowSelected - Fired when a row is selected. detail: `RowSelectedEvent`\n *\n * @fires\n *\n * selectionChanged - Fired when grid selection changes (bubbled from entity-list). detail: `SelectionChangedEvent`\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class EntityManagement extends " }, { "kind": "Reference", "text": "EntityManagement_base", "canonicalReference": "@genesislcap/foundation-entity-management!~EntityManagement_base" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/entities/entities.ts", "releaseTag": "Public", "isAbstract": false, "name": "EntityManagement", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#additionalFormRenderers:member", "docComment": "/**\n * Additional renderer entries to append to the form renderer registry. Use this to supply custom UI schema renderers without replacing defaults.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "additionalFormRenderers: " }, { "kind": "Reference", "text": "RendererEntry", "canonicalReference": "@genesislcap/foundation-forms!RendererEntry:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "additionalFormRenderers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#approvalMessageLabel:member", "docComment": "/**\n * Label for the approval message field in the approval dialog.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "approvalMessageLabel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "approvalMessageLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#columns:member", "docComment": "/**\n * Array which holds the column definitions.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "columns: " }, { "kind": "Reference", "text": "GridColDef", "canonicalReference": "@genesislcap/foundation-entity-management!GridColDef:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "columns", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#confirmationMessage:member", "docComment": "/**\n * Optional confirmation message to display before form submission. If set, a confirmation dialog will be shown when the user clicks submit.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "confirmationMessage: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "confirmationMessage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#createEvent:member", "docComment": "/**\n * Name of the event handler on the Genesis server which handles creating an entity\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createEvent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "createEvent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#createFormUiSchema:member", "docComment": "/**\n * Enables you to supply a schema to configure an insert form.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createFormUiSchema: " }, { "kind": "Reference", "text": "UiSchema", "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "createFormUiSchema", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#createLabel:member", "docComment": "/**\n * Custom label for the create button and modal title. When set, overrides the default \"Add {entityLabel}\" text.\n *\n * @example\n *\n * `create-label=\"Reject Price\"` renders a \"Reject Price\" button instead of \"+ Add\"\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "createLabel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "createLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#crudActionMenuName:member", "docComment": "/**\n * The label of the crud action menu\n */\n", "excerptTokens": [ { "kind": "Content", "text": "crudActionMenuName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "crudActionMenuName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#crudMenuPosition:member", "docComment": "/**\n * Determines where the buttons will appear\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "crudMenuPosition: " }, { "kind": "Reference", "text": "CrudMenuPosition", "canonicalReference": "@genesislcap/foundation-entity-management!CrudMenuPosition:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "crudMenuPosition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#crudMenuStyle:member", "docComment": "/**\n * Determines the style of the buttons\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "crudMenuStyle: " }, { "kind": "Reference", "text": "ActionsMenuStyle", "canonicalReference": "@genesislcap/foundation-entity-management!ActionsMenuStyle:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "crudMenuStyle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#customActions:member", "docComment": "/**\n * Array of custom actions that can be added to the entity management component\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "customActions: " }, { "kind": "Reference", "text": "CustomAction", "canonicalReference": "@genesislcap/foundation-entity-management!CustomAction:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "customActions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#datasourceConfig:member", "docComment": "/**\n * Get the configuration which is used when interacting with the resource on the backend\n *\n * @remarks\n *\n * Handles the configuration such as how many rows of entities to fetch at a time\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "set datasourceConfig(config: " }, { "kind": "Reference", "text": "DatasourceConfiguration", "canonicalReference": "@genesislcap/foundation-entity-management!DatasourceConfiguration:type" }, { "kind": "Content", "text": ");" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "datasourceConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#datasourceType:member", "docComment": "/**\n * If set to 'server' it will enable Server-Side Row Model and use `grid-pro-server-side-datasource` for the grid of the `entity-list` sub-component. By default `grid-pro-client-side-datasource` will be used.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "datasourceType: " }, { "kind": "Reference", "text": "DatasourceType", "canonicalReference": "@genesislcap/grid-pro!DatasourceType:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "datasourceType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#defaultEntityValues:member", "docComment": "/**\n * The default values to populate the form with when the user is adding an entity\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "defaultEntityValues: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "defaultEntityValues", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#deleteColumnState:member(1)", "docComment": "/**\n * Deletes the saved column state for the grid\n *\n * @param resetToDefault - Whether to reset columns to their default configuration. Defaults to true.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deleteColumnState(resetToDefault?: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "resetToDefault", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": true } ], "isOptional": false, "isAbstract": false, "name": "deleteColumnState" }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#deleteEvent:member", "docComment": "/**\n * Name of the event handler on the Genesis server which handles deleting the entity\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "deleteEvent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "deleteEvent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#enableAiCriteriaSearch:member", "docComment": "/**\n * Enables AI criteria search component. When true, fetches field metadata from resourceName and renders the AI search bar.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableAiCriteriaSearch: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enableAiCriteriaSearch", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#enableCellFlashing:member", "docComment": "/**\n * If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef\n *\n * @remarks\n *\n * Defaults to true\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableCellFlashing: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enableCellFlashing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#enableCsvExport:member", "docComment": "/**\n * Enabling this option will enable a download button in the top-right of the header which will export the data to a csv file when clicked.\n *\n * @remarks\n *\n * The default button is `Export` and the filename `export.csv`. You can optionally configure these values via this property to override them\n *\n * @example\n *\n * Enabling the feature and using the default configuration\n * ```ts\n * ({})}\"\n * >\n * \n * ```\n *\n * @example\n *\n * Enabling the feature and overriding the default values\n * ```ts\n * ({buttonName: 'Download', fileName: 'counterparty-export'})}\"\n * >\n * \n * ```\n *\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableCsvExport: " }, { "kind": "Content", "text": "{\n buttonName?: string;\n fileName?: string;\n } | null" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enableCsvExport", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#enableFilterBar:member", "docComment": "/**\n * Enables filter bar component\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableFilterBar: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enableFilterBar", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#enableFilters:member", "docComment": "/**\n * Enables foundation-filters with flyout UI\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableFilters: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enableFilters", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#enableRowFlashing:member", "docComment": "/**\n * If true, will enable row flashing for all rows for `add` transactions\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableRowFlashing: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enableRowFlashing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#enableSearchBar:member", "docComment": "/**\n * This attribute controls whether to enable the search-bar.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "enableSearchBar: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enableSearchBar", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#entityLabel:member", "docComment": "/**\n * Label for the entity which is used in the title of the modal when editing the entity, on CRUD buttons and on toast notifications\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "entityLabel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "entityLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#errorNotificationConfig:member", "docComment": "/**\n * Notification config used for submit failures. Defaults to an error snackbar but can be overridden while keeping title/body unchanged.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "errorNotificationConfig: " }, { "kind": "Reference", "text": "NotificationStructure", "canonicalReference": "@genesislcap/foundation-notifications!NotificationStructure:interface" }, { "kind": "Content", "text": "['config']" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "errorNotificationConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#filtersModalPosition:member", "docComment": "/**\n * Determines where the filters modal will appear on screen\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filtersModalPosition: " }, { "kind": "Content", "text": "'centre' | 'left' | 'right'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filtersModalPosition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#filtersUiSchema:member", "docComment": "/**\n * UI schema configuration for the filters component\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "filtersUiSchema: " }, { "kind": "Reference", "text": "UiSchema", "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "filtersUiSchema", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#formRenderers:member", "docComment": "/**\n * Array with renderers used by foundation-forms\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "formRenderers: " }, { "kind": "Reference", "text": "RendererEntry", "canonicalReference": "@genesislcap/foundation-forms!RendererEntry:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "formRenderers", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#gridAutosizing:member", "docComment": "/**\n * Controls automatic column sizing on interaction. Disables manual column widths and local storage persistence of widths.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "gridAutosizing: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "gridAutosizing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#gridOptions:member", "docComment": "/**\n * GridOptions to be passed down from application\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "gridOptions: " }, { "kind": "Reference", "text": "GridOptionsConfig", "canonicalReference": "@genesislcap/grid-pro!GridOptionsConfig:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "gridOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#headerCaseType:member", "docComment": "/**\n * The case type to use for the header names. If not set, the default CONSTANT_CASE will be used.\n *\n * @remarks\n *\n * Can be one of the following: camelCase, capitalCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "headerCaseType: " }, { "kind": "Reference", "text": "GridProCaseType", "canonicalReference": "@genesislcap/grid-pro!GridProCaseType:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "headerCaseType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#hideDelete:member", "docComment": "/**\n * Hides delete button\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hideDelete: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hideDelete", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#hideEdit:member", "docComment": "/**\n * Hides edit button\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "hideEdit: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hideEdit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#modalPosition:member", "docComment": "/**\n * Determines where the modal dialog will appear on screen\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "modalPosition: " }, { "kind": "Content", "text": "'centre' | 'left' | 'right'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "modalPosition", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#persistColumnStateKey:member", "docComment": "/**\n * This attribute controls whether and how the entity manager stores the state of the columns when the user edits them. Omit this attribute to disable the functionality, set it to a unique value to enable it.\n *\n * @remarks\n *\n * Setting this value will set the entity manager to persist the column states through page refreshes etc. An example of what is stored is when the user resizes or reorders columns. This value must be unique for each table in your app otherwise the persisted data will be corrupted. There is an option on the grid for the user to reset the table to the default layout if they wish. If you omit this attribute then nothing is persisted\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "persistColumnStateKey: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "persistColumnStateKey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#persistFilterModelKey:member", "docComment": "/**\n * The key to use for persisting the filter model in local browser or KV storage.\n *\n * @remarks\n *\n * Default behaviour when unset is to not save the filter config. This value must be unique for each table in your app otherwise the persisted data will be corrupted.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "persistFilterModelKey: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "persistFilterModelKey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#prefix:member", "docComment": "/**\n * Name of the design system prefix that will be used in renderers.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "prefix: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "prefix", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#readEvent:member", "docComment": "/**\n * Name of the request on the Genesis server which fetches data for the form, example usage could include fetching additional data that is not available in the grid but required for the selected entity\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readEvent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "readEvent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#readEventFn:member", "docComment": "/**\n * Similar to readEvent but allows to provide function that will be executed before opening the form and yields data to the form\n *\n * @param entity - selected entity from the grid\n *\n * @returns object with data which will be used to prefill the form similarly to `defaultEntityValues`\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "readEventFn: " }, { "kind": "Content", "text": "(entity: any) => any" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "readEventFn", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#resourceName:member", "docComment": "/**\n * Name of the backend resource which contain the entities to manage\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "resourceName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resourceName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#rowSelection:member", "docComment": "/**\n * This attribute allows you to change row-selection to 'single' or 'multiple' which will allow you to select single or multiple rows.\n *\n * @remarks\n *\n * Defaults to single\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "rowSelection: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rowSelection", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#searchBarConfig:member", "docComment": "/**\n * Allows configuration of the search bar component, if not provided it would build configuration based on columns in the grid *\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "searchBarConfig: " }, { "kind": "Reference", "text": "AvailableOption", "canonicalReference": "@genesislcap/foundation-ui!AvailableOption:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "searchBarConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#setApprovalMessage:member", "docComment": "/**\n * When enabled, adds an APPROVAL_MESSAGE field to the form schema. This field will be sent at root level alongside DETAILS when submitting. Can be overridden per custom action via the action's setApprovalMessage property.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setApprovalMessage: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "setApprovalMessage", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#setDSConfigWithoutUpdatingBaseCriteria:member(1)", "docComment": "/**\n * Usually when the datasource config is updated we need to cache the criteria so it can be combined with the searchbar, but this function allows you to set the datasource config without doing that (so we don't cache the search bar criteria)\n */\n", "excerptTokens": [ { "kind": "Content", "text": "setDSConfigWithoutUpdatingBaseCriteria(config: " }, { "kind": "Reference", "text": "DatasourceConfiguration", "canonicalReference": "@genesislcap/foundation-entity-management!DatasourceConfiguration:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "config", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "setDSConfigWithoutUpdatingBaseCriteria" }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#showFilterPersistenceControls:member", "docComment": "/**\n * Controls visibility of filter save/load UI in foundation-filters\n *\n * @remarks\n *\n * Defaults to true\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "showFilterPersistenceControls: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "showFilterPersistenceControls", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#sizeColumnsToContent:member", "docComment": "/**\n * Auto-sizes a column based on its contents\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sizeColumnsToContent: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sizeColumnsToContent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#sizeColumnsToFit:member", "docComment": "/**\n * Resizes columns to take available space\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sizeColumnsToFit: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sizeColumnsToFit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#statusBarConfig:member", "docComment": "/**\n * Configuration for the grid status bar components.\n *\n * @remarks\n *\n * This requires AG Grid Enterprise module to be enabled. The status bar will only be displayed if the Enterprise module is available.\n *\n * @see\n *\n * https://www.ag-grid.com/javascript-data-grid/component-status-bar/\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "statusBarConfig: " }, { "kind": "Reference", "text": "GridProStatusBarConfig", "canonicalReference": "@genesislcap/grid-pro!GridProStatusBarConfig:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "statusBarConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#successNotificationBody:member", "docComment": "/**\n * Overrides the success notification body shown after a successful form submission. When not set, the default \"The {label} was successfully added/updated/deleted\" body is used.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "successNotificationBody: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "successNotificationBody", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#successNotificationTitle:member", "docComment": "/**\n * Overrides the success notification title shown after a successful form submission. When not set, the default \"{label} Added / Updated / Deleted\" title is used.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "successNotificationTitle: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "successNotificationTitle", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#title:member", "docComment": "/**\n * Title of the grid\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#updateEvent:member", "docComment": "/**\n * Name of the event handler on the Genesis server which handles updating the entity\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateEvent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "updateEvent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement#updateFormUiSchema:member", "docComment": "/**\n * Enables you to supply a schema to configure an update form.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "updateFormUiSchema: " }, { "kind": "Reference", "text": "UiSchema", "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "updateFormUiSchema", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "@genesislcap/foundation-entity-management!getActionNotificationTitleAndBody:function(1)", "docComment": "/**\n * Returns the title and body for a notification based on the action type and entity label.\n *\n * @param type - The type of action performed (Create, Update, Delete, etc.)\n *\n * @param label - The label of the entity being managed.\n *\n * @returns An object containing the notification title and body.\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getActionNotificationTitleAndBody: (type: " }, { "kind": "Reference", "text": "ModalFormType", "canonicalReference": "@genesislcap/foundation-entity-management!ModalFormType:enum" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "CrudAction.Delete", "canonicalReference": "@genesislcap/foundation-entity-management!CrudAction.Delete:member" }, { "kind": "Content", "text": " | string" }, { "kind": "Content", "text": ", label: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ") => " }, { "kind": "Content", "text": "{\n title: string;\n body: string;\n}" } ], "fileUrlPath": "src/entities/entities.ts", "returnTypeTokenRange": { "startIndex": 8, "endIndex": 9 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "type", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false }, { "parameterName": "label", "parameterTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "isOptional": false } ], "name": "getActionNotificationTitleAndBody" }, { "kind": "Function", "canonicalReference": "@genesislcap/foundation-entity-management!getErrorFormat:function(1)", "docComment": "/**\n * Format the error as a string with a different format depending on whether `err` has a `FIELD` property or not\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "getErrorFormat: (err: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ") => " }, { "kind": "Content", "text": "string" } ], "fileUrlPath": "src/utils/formatting.ts", "returnTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "err", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "name": "getErrorFormat" }, { "kind": "TypeAlias", "canonicalReference": "@genesislcap/foundation-entity-management!GridColDef:type", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export type GridColDef = " }, { "kind": "Reference", "text": "ColDef", "canonicalReference": "ag-grid-community!ColDef:interface" }, { "kind": "Content", "text": " | " }, { "kind": "Reference", "text": "LegacyColDef", "canonicalReference": "@ag-grid-community/core!ColDef:interface" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "GridColDef", "typeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Class", "canonicalReference": "@genesislcap/foundation-entity-management!List:class", "docComment": "/**\n * Entity list grid with CRUD and selection events.\n *\n * @fires\n *\n * submit-failure - Fired when an inline update submit fails. detail: `SubmitFailureEventDetail`\n *\n * @fires\n *\n * submit-success - Fired when an inline update succeeds. detail: `SubmitSuccessEventDetail`\n *\n * @fires\n *\n * rowClick - Fired when a row is clicked. detail: `Record | undefined`\n *\n * @fires\n *\n * rowDblClick - Fired when a row is double-clicked. detail: `Record | undefined`\n *\n * @fires\n *\n * contextMenu - Fired when a row context menu is opened. detail: `Record | undefined`\n *\n * @fires\n *\n * rowSelected - Fired when row selection changes (single). detail: `RowSelectedEvent`\n *\n * @fires\n *\n * selectionChanged - Fired when grid selection changes. detail: `SelectionChangedEvent`\n *\n * @fires\n *\n * edit-entity - Fired when edit is requested\n *\n * @fires\n *\n * delete-entity - Fired when delete is requested\n *\n * @fires\n *\n * custom-action - Fired when a custom grid action runs. detail: `CustomActionEventDetail`\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class List extends " }, { "kind": "Reference", "text": "List_base", "canonicalReference": "@genesislcap/foundation-entity-management!~List_base" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/list/list.ts", "releaseTag": "Public", "isAbstract": false, "name": "List", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#actionButtonsConfig:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "actionButtonsConfig: " }, { "kind": "Content", "text": "any[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "actionButtonsConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#asyncAdd:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "asyncAdd: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "asyncAdd", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#asyncRemove:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "asyncRemove: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "asyncRemove", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#asyncUpdate:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "asyncUpdate: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "asyncUpdate", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#columns:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "columns: " }, { "kind": "Reference", "text": "GridColDef", "canonicalReference": "@genesislcap/foundation-entity-management!GridColDef:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "columns", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#connect:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "protected connect: " }, { "kind": "Reference", "text": "Connect", "canonicalReference": "@genesislcap/foundation-comms!Connect:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "connect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": true, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!List#connectedCallback:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "connectedCallback(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "connectedCallback" }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#createEvent:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "createEvent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "createEvent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#criteria:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get criteria(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "criteria", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#customActions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "customActions: " }, { "kind": "Reference", "text": "CustomAction", "canonicalReference": "@genesislcap/foundation-entity-management!CustomAction:interface" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "customActions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#datasource:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "datasource: " }, { "kind": "Reference", "text": "GridProGenesisDatasource", "canonicalReference": "@genesislcap/grid-pro!GridProGenesisDatasource:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "datasource", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#datasourceConfig:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "datasourceConfig: " }, { "kind": "Reference", "text": "DatasourceConfiguration", "canonicalReference": "@genesislcap/foundation-entity-management!DatasourceConfiguration:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "datasourceConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#datasourceType:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "datasourceType: " }, { "kind": "Reference", "text": "DatasourceType", "canonicalReference": "@genesislcap/grid-pro!DatasourceType:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "datasourceType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!List#delete:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "delete(e: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 3, "endIndex": 5 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "delete" }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#deleteEvent:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "deleteEvent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "deleteEvent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#disablePolling:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get disablePolling(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "disablePolling", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!List#disconnectedCallback:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "disconnectedCallback(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "disconnectedCallback" }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#enableCellFlashing:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "enableCellFlashing: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enableCellFlashing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#enableFilterBar:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "enableFilterBar: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enableFilterBar", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#enableRowFlashing:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "enableRowFlashing: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "enableRowFlashing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#fields:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get fields(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "fields", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#grid:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "grid: " }, { "kind": "Reference", "text": "ZeroGridPro", "canonicalReference": "@genesislcap/foundation-zero-grid-pro!ZeroGridPro:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "grid", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#gridAutosizing:member", "docComment": "/**\n * Controls automatic column sizing on interaction. Disables manual column widths and local storage persistence of widths.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "gridAutosizing: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "gridAutosizing", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#gridOptions:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "gridOptions: " }, { "kind": "Reference", "text": "GridOptionsConfig", "canonicalReference": "@genesislcap/grid-pro!GridOptionsConfig:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "gridOptions", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!List#handleCellEditRequest:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "handleCellEditRequest(event: " }, { "kind": "Reference", "text": "CustomEvent", "canonicalReference": "!CustomEvent:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CellEditRequestEvent", "canonicalReference": "@ag-grid-community/core!CellEditRequestEvent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "event", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "handleCellEditRequest" }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!List#handleRowClicked:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "handleRowClicked(e: " }, { "kind": "Reference", "text": "CustomEvent", "canonicalReference": "!CustomEvent:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "RowClickedEvent", "canonicalReference": "ag-grid-community!RowClickedEvent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "handleRowClicked" }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!List#handleRowContextMenu:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "handleRowContextMenu(e: " }, { "kind": "Reference", "text": "CustomEvent", "canonicalReference": "!CustomEvent:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "CellContextMenuEvent", "canonicalReference": "ag-grid-community!CellContextMenuEvent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "handleRowContextMenu" }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!List#handleRowDblClicked:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "handleRowDblClicked(e: " }, { "kind": "Reference", "text": "CustomEvent", "canonicalReference": "!CustomEvent:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "RowDoubleClickedEvent", "canonicalReference": "ag-grid-community!RowDoubleClickedEvent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "handleRowDblClicked" }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!List#handleRowSelected:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "handleRowSelected(e: " }, { "kind": "Reference", "text": "CustomEvent", "canonicalReference": "!CustomEvent:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "RowSelectedEvent", "canonicalReference": "ag-grid-community!RowSelectedEvent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "handleRowSelected" }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!List#handleSelectionChanged:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "handleSelectionChanged(e: " }, { "kind": "Reference", "text": "CustomEvent", "canonicalReference": "!CustomEvent:interface" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "SelectionChangedEvent", "canonicalReference": "ag-grid-community!SelectionChangedEvent:interface" }, { "kind": "Content", "text": ">" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 6, "endIndex": 7 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "e", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 5 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "handleSelectionChanged" }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#headerCaseType:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "headerCaseType: " }, { "kind": "Reference", "text": "GridProCaseType", "canonicalReference": "@genesislcap/grid-pro!GridProCaseType:enum" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "headerCaseType", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#hideDelete:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "hideDelete: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hideDelete", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#hideEdit:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "hideEdit: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "hideEdit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#isServerSideDatasource:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get isServerSideDatasource(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "isServerSideDatasource", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#isSnapshot:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get isSnapshot(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "isSnapshot", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#maxRows:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get maxRows(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "maxRows", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#maxView:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get maxView(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "maxView", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#movingView:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get movingView(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "movingView", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#orderBy:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get orderBy(): " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "orderBy", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#persistColumnStateKey:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "persistColumnStateKey: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "persistColumnStateKey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#persistFilterModelKey:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "persistFilterModelKey: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "persistFilterModelKey", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#pollingInterval:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get pollingInterval(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "pollingInterval", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#pollTriggerEvents:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get pollTriggerEvents(): " }, { "kind": "Content", "text": "string[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "pollTriggerEvents", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#prefix:member", "docComment": "/**\n * Name of the design system prefix that will be used in renderers.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "prefix: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "prefix", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#request:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get request(): " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "request", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#requestAutoSetup:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get requestAutoSetup(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "requestAutoSetup", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#resourceName:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "resourceName: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "resourceName", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#reverse:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get reverse(): " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "reverse", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#rowSelection:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "rowSelection: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "rowSelection", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#sizeColumnsToContent:member", "docComment": "/**\n * Auto-sizes a column based on its contents\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sizeColumnsToContent: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sizeColumnsToContent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#sizeColumnsToFit:member", "docComment": "/**\n * Resizes columns to take available space\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "sizeColumnsToFit: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "sizeColumnsToFit", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#statusBarConfig:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "statusBarConfig: " }, { "kind": "Reference", "text": "GridProStatusBarConfig", "canonicalReference": "@genesislcap/grid-pro!GridProStatusBarConfig:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "statusBarConfig", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#title:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "title: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "title", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#updateEvent:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "updateEvent: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "updateEvent", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!List#viewNumber:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "get viewNumber(): " }, { "kind": "Content", "text": "number" }, { "kind": "Content", "text": ";" } ], "isReadonly": true, "isOptional": false, "releaseTag": "Public", "name": "viewNumber", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-entity-management!logger:var", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "logger: " }, { "kind": "Content", "text": "import(\"@genesislcap/foundation-logger\")." }, { "kind": "Reference", "text": "Logger", "canonicalReference": "@genesislcap/foundation-logger!Logger:interface" } ], "fileUrlPath": "src/utils/logger.ts", "isReadonly": true, "releaseTag": "Public", "name": "logger", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "Class", "canonicalReference": "@genesislcap/foundation-entity-management!MainApplication:class", "docComment": "/**\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class MainApplication extends " }, { "kind": "Reference", "text": "GenesisElement", "canonicalReference": "@microsoft/fast-element!FASTElement:interface" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/main/main.ts", "releaseTag": "Public", "isAbstract": false, "name": "MainApplication", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!MainApplication#config:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "config: " }, { "kind": "Reference", "text": "MainRouterConfig", "canonicalReference": "@genesislcap/foundation-entity-management!~MainRouterConfig:class" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "config", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!MainApplication#connect:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "connect: " }, { "kind": "Reference", "text": "Connect", "canonicalReference": "@genesislcap/foundation-comms!Connect:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "connect", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!MainApplication#connectedCallback:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "connectedCallback(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "connectedCallback" }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!MainApplication#container:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "container: " }, { "kind": "Reference", "text": "Container", "canonicalReference": "@microsoft/fast-foundation!Container:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "container", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!MainApplication#loadRemotes:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "loadRemotes(): " }, { "kind": "Reference", "text": "Promise", "canonicalReference": "!Promise:interface" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "loadRemotes" }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!MainApplication#onLuminanceToggle:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "onLuminanceToggle(): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "onLuminanceToggle" }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!MainApplication#provider:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "provider: " }, { "kind": "Reference", "text": "HTMLElement", "canonicalReference": "!HTMLElement:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "provider", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!MainApplication#ready:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "ready: " }, { "kind": "Content", "text": "boolean" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "ready", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!MainApplication#selectTemplate:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "selectTemplate(): " }, { "kind": "Content", "text": "import(\"@microsoft/fast-element\")." }, { "kind": "Reference", "text": "ViewTemplate", "canonicalReference": "@microsoft/fast-element!ViewTemplate:class" }, { "kind": "Content", "text": "<" }, { "kind": "Reference", "text": "MainApplication", "canonicalReference": "@genesislcap/foundation-entity-management!MainApplication:class" }, { "kind": "Content", "text": ", any>" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 1, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [], "isOptional": false, "isAbstract": false, "name": "selectTemplate" }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!MainApplication#session:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "session: " }, { "kind": "Reference", "text": "Session", "canonicalReference": "@genesislcap/foundation-comms!Session:interface" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "session", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Function", "canonicalReference": "@genesislcap/foundation-entity-management!mapDefaultValues:function(1)", "docComment": "/**\n * Map default values for custom actions\n *\n * Transform default values object by replacing values with special type 'record' with corresponding values from the row data\n *\n * @param defaultValues - Object containing default values with potential record mappings\n *\n * @param rowData - The row data containing values to map from\n *\n * @returns Mapped object with record values replaced by corresponding row data values\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare function mapDefaultValues(defaultValues: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ", rowData: " }, { "kind": "Content", "text": "any" }, { "kind": "Content", "text": "): " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "fileUrlPath": "src/utils/custom-actions-utils.ts", "returnTypeTokenRange": { "startIndex": 6, "endIndex": 8 }, "releaseTag": "Public", "overloadIndex": 1, "parameters": [ { "parameterName": "defaultValues", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 3 }, "isOptional": false }, { "parameterName": "rowData", "parameterTypeTokenRange": { "startIndex": 4, "endIndex": 5 }, "isOptional": false } ], "name": "mapDefaultValues" }, { "kind": "Enum", "canonicalReference": "@genesislcap/foundation-entity-management!ModalFormType:enum", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export declare enum ModalFormType " } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "ModalFormType", "preserveMemberOrder": false, "members": [ { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!ModalFormType.Create:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "Create = " }, { "kind": "Content", "text": "\"create\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "Create" }, { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!ModalFormType.Read:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "Read = " }, { "kind": "Content", "text": "\"read\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "Read" }, { "kind": "EnumMember", "canonicalReference": "@genesislcap/foundation-entity-management!ModalFormType.Update:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "Update = " }, { "kind": "Content", "text": "\"update\"" } ], "initializerTokenRange": { "startIndex": 1, "endIndex": 2 }, "releaseTag": "Public", "name": "Update" } ] }, { "kind": "Interface", "canonicalReference": "@genesislcap/foundation-entity-management!RecordTypeValue:interface", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "export interface RecordTypeValue " } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "RecordTypeValue", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!RecordTypeValue#mapping:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "mapping?: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": true, "releaseTag": "Public", "name": "mapping", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!RecordTypeValue#type:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "type: " }, { "kind": "Content", "text": "'record'" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "type", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 } } ], "extendsTokenRanges": [] }, { "kind": "Variable", "canonicalReference": "@genesislcap/foundation-entity-management!RESOURCE_NAME:var", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "RESOURCE_NAME: " }, { "kind": "Content", "text": "import(\"@microsoft/fast-foundation\")." }, { "kind": "Reference", "text": "InterfaceSymbol", "canonicalReference": "@microsoft/fast-foundation!InterfaceSymbol:type" }, { "kind": "Content", "text": "" } ], "fileUrlPath": "src/types.ts", "isReadonly": true, "releaseTag": "Public", "name": "RESOURCE_NAME", "variableTypeTokenRange": { "startIndex": 1, "endIndex": 4 } }, { "kind": "Class", "canonicalReference": "@genesislcap/foundation-entity-management!SmartFormModal:class", "docComment": "/**\n * A focused form dialog component that renders a single trigger button which opens a modal containing an auto-generated form.\n *\n * @remarks\n *\n * `smart-form-modal` is a trimmed-down variant of {@link EntityManagement} intended for single-action use cases — approval submissions, bespoke inserts — where you want a button that opens a form modal without the accompanying data grid.\n *\n * The component inherits the full `entity-management` API but exposes a purpose-fit surface of its own:\n *\n * | `smart-form-modal` attr | Underlying property | Notes | |---|---|---| | `event` | `createEvent` | The Genesis event handler that processes the form submission | | `button-label` | `createLabel` | Button and modal title text; replaces the default \"Add {entityLabel}\" | | `form-ui-schema` (`:formUiSchema`) | `createFormUiSchema` | UI schema passed as a property binding | | `success-notification-title` | — | Overrides the toast title shown on successful submit | | `success-notification-body` | — | Overrides the toast body shown on successful submit |\n *\n * The underlying `entity-management` attributes (`createEvent`, `createFormUiSchema`, `create-label`, `confirmation-message`, `default-entity-values`, `design-system-prefix`, `set-approval-message`, `approval-message-label`, `form-renderers`, `additional-form-renderers`, `readonly`) all continue to work — the aliases listed above are simply the preferred vocabulary for this component.\n *\n * Attributes that belong to the grid (`updateEvent`, `deleteEvent`, `columns`, `gridOptions`, `datasource-config`, `resource-name`, `enable-search-bar`, `enable-filter-bar`, etc.) are inherited but have no effect because the grid is always hidden.\n *\n * **Defaults that differ from `entity-management`:** - `modalPosition` defaults to `'centre'` (entity-management defaults to `'right'`) - `crudMenuPosition` defaults to `'top'` (entity-management defaults to `'column'`)\n *\n * @example\n *\n * Minimal usage — form fields are auto-generated from the event schema:\n * ```html\n * \n * ```\n *\n * @example\n *\n * Custom action label with styled button via CSS part:\n * ```html\n * \n * ```\n *\n * ```css\n * smart-form-modal::part(create-button) {\n * background-color: #d32f2f;\n * color: #fff;\n * }\n * ```\n *\n * @example\n *\n * Controlled form layout via `formUiSchema` property binding:\n * ```html\n * myUiSchema}\"\n * >\n * ```\n *\n * @example\n *\n * Confirmation dialog before submit:\n * ```html\n * \n * ```\n *\n * @example\n *\n * Read-only view mode:\n * ```html\n * \n * ```\n *\n * @csspart create-button - The trigger button that opens the modal. Style via `::part(create-button)`.\n *\n * @fires\n *\n * submit-success - Fired when the form is submitted successfully. detail: `SubmitSuccessEventDetail`\n *\n * @fires\n *\n * submit-failure - Fired when the form submission returns an error. detail: `SubmitFailureEventDetail`\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export declare class SmartFormModal extends " }, { "kind": "Reference", "text": "EntityManagement", "canonicalReference": "@genesislcap/foundation-entity-management!EntityManagement:class" }, { "kind": "Content", "text": " " } ], "fileUrlPath": "src/entities/smartFormModal.ts", "releaseTag": "Public", "isAbstract": false, "name": "SmartFormModal", "preserveMemberOrder": false, "members": [ { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!SmartFormModal#buttonLabel:member", "docComment": "/**\n * Text displayed on the trigger button and as the modal title.\n *\n * @remarks\n *\n * Alias for `create-label`. When set, the default \"Add {entityLabel}\" text is replaced entirely and the `+` icon is hidden so the label stands alone.\n *\n * @example\n * ```html\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "buttonLabel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "buttonLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!SmartFormModal#buttonLabelChanged:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "buttonLabelChanged(_: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", next: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "_", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "next", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "buttonLabelChanged" }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!SmartFormModal#entityLabel:member", "docComment": "/**\n * Label appended to the default button text, producing \"Add {entity-label}\".\n *\n * @remarks\n *\n * Re-declares the inherited `entityLabel` attr explicitly so FAST observes it on this element. Has no effect when `button-label` is also set — `button-label` takes full precedence.\n *\n * @example\n * ```html\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "entityLabel: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "entityLabel", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!SmartFormModal#event:member", "docComment": "/**\n * The Genesis event handler that processes the form submission.\n *\n * @remarks\n *\n * Alias for `createEvent`. Prefer `event` when using `smart-form-modal` — it reads more naturally for single-action components where the CRUD framing of `createEvent` does not apply.\n *\n * @example\n * ```html\n * \n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "event: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "event", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!SmartFormModal#eventChanged:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "eventChanged(_: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": ", next: " }, { "kind": "Content", "text": "string" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "_", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "next", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "eventChanged" }, { "kind": "Property", "canonicalReference": "@genesislcap/foundation-entity-management!SmartFormModal#formUiSchema:member", "docComment": "/**\n * UI schema that controls the layout and visibility of form fields.\n *\n * @remarks\n *\n * Alias for `createFormUiSchema`. Must be set as a property binding (`:formUiSchema`) since it accepts a `UiSchema` object, not a plain string attribute.\n *\n * When omitted, the form is auto-generated from the event's server-side schema.\n *\n * @example\n * ```html\n * ({\n * type: 'VerticalLayout',\n * elements: [\n * { type: 'Control', scope: '#/properties/NAME' },\n * { type: 'Control', scope: '#/properties/ENABLED' },\n * ],\n * })}\"\n * >\n * ```\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "formUiSchema: " }, { "kind": "Reference", "text": "UiSchema", "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "formUiSchema", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isStatic": false, "isProtected": false, "isAbstract": false }, { "kind": "Method", "canonicalReference": "@genesislcap/foundation-entity-management!SmartFormModal#formUiSchemaChanged:member(1)", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "formUiSchemaChanged(_: " }, { "kind": "Reference", "text": "UiSchema", "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type" }, { "kind": "Content", "text": ", next: " }, { "kind": "Reference", "text": "UiSchema", "canonicalReference": "@genesislcap/foundation-forms!UiSchema:type" }, { "kind": "Content", "text": "): " }, { "kind": "Content", "text": "void" }, { "kind": "Content", "text": ";" } ], "isStatic": false, "returnTypeTokenRange": { "startIndex": 5, "endIndex": 6 }, "releaseTag": "Public", "isProtected": false, "overloadIndex": 1, "parameters": [ { "parameterName": "_", "parameterTypeTokenRange": { "startIndex": 1, "endIndex": 2 }, "isOptional": false }, { "parameterName": "next", "parameterTypeTokenRange": { "startIndex": 3, "endIndex": 4 }, "isOptional": false } ], "isOptional": false, "isAbstract": false, "name": "formUiSchemaChanged" } ], "extendsTokenRange": { "startIndex": 1, "endIndex": 2 }, "implementsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@genesislcap/foundation-entity-management!SubmitFailureEventDetail:interface", "docComment": "/**\n * Detail payload for the `submit-failure` event, fired when an inline cell edit fails to commit.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SubmitFailureEventDetail " } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "SubmitFailureEventDetail", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!SubmitFailureEventDetail#errors:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "errors: " }, { "kind": "Reference", "text": "MessageError", "canonicalReference": "@genesislcap/foundation-comms!MessageError:type" }, { "kind": "Content", "text": "[]" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "errors", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } }, { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!SubmitFailureEventDetail#payload:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "payload: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "payload", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] }, { "kind": "Interface", "canonicalReference": "@genesislcap/foundation-entity-management!SubmitSuccessEventDetail:interface", "docComment": "/**\n * Detail payload for the `submit-success` event, fired when an inline cell edit commits successfully.\n *\n * @public\n */\n", "excerptTokens": [ { "kind": "Content", "text": "export interface SubmitSuccessEventDetail " } ], "fileUrlPath": "src/types.ts", "releaseTag": "Public", "name": "SubmitSuccessEventDetail", "preserveMemberOrder": false, "members": [ { "kind": "PropertySignature", "canonicalReference": "@genesislcap/foundation-entity-management!SubmitSuccessEventDetail#payload:member", "docComment": "", "excerptTokens": [ { "kind": "Content", "text": "payload: " }, { "kind": "Reference", "text": "Record", "canonicalReference": "!Record:type" }, { "kind": "Content", "text": "" }, { "kind": "Content", "text": ";" } ], "isReadonly": false, "isOptional": false, "releaseTag": "Public", "name": "payload", "propertyTypeTokenRange": { "startIndex": 1, "endIndex": 3 } } ], "extendsTokenRanges": [] } ] } ] }