@adaptabletools/adaptable 11.2.4 → 11.3.0

package/src/metamodel/adaptable.metamodel.js

@@ -848,14 +848,15 @@ exports.ADAPTABLE_METAMODEL = {
             },
             {
                 "name": "fieldType",
-                "kind": "unknown",
+                "kind": "REFERENCE",
                 "description": "Field Type: text, date, number, checkbox, select, textOutput",
-                "uiLabel": "Field Type"
+                "uiLabel": "Field Type",
+                "reference": "unknown"
             },
             {
                 "name": "label",
                 "kind": "string",
-                "description": "Label to display in in the Field",
+                "description": "Label to display in the Field",
                 "uiLabel": "Label"
             },
             {
@@ -1009,7 +1010,7 @@ exports.ADAPTABLE_METAMODEL = {
     "AdaptableObjectTag": {
         "name": "AdaptableObjectTag",
         "kind": "TypeAlias",
-        "description": "Object Tag - defined as a label and a value"
+        "description": "AdaptableObjectTag Object Tague - currently supporting only plain string values, but open for future extensions, if ever needed."
     },
     "AdaptableOptions": {
         "name": "AdaptableOptions",
@@ -2287,7 +2288,7 @@ exports.ADAPTABLE_METAMODEL = {
     "BaseContext": {
         "name": "BaseContext",
         "kind": "Interface",
-        "description": "Base Context object used in many functions provided by AdapTable",
+        "description": "Base Context used in many functions provided by developers and invoked as needed by AdapTable",
         "properties": [
             {
                 "name": "adaptableApi",
@@ -2497,6 +2498,14 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Data Type",
                 "isOptional": true
             },
+            {
+                "name": "ExternallyEvaluatedExpression",
+                "kind": "boolean",
+                "description": "If true, the Calculated Column Expression will NOT be evaluated and the value is loaded from the row data property with the same name as the ColumnId",
+                "uiLabel": "Externally Evaluated Expression",
+                "isOptional": true,
+                "defaultValue": "false"
+            },
             {
                 "name": "ShowToolTip",
                 "kind": "boolean",
@@ -5076,6 +5085,21 @@ exports.ADAPTABLE_METAMODEL = {
                 "uiLabel": "Is Cell Editable",
                 "isOptional": true
             },
+            {
+                "name": "rowFormOptions",
+                "kind": "REFERENCE",
+                "description": "Options for editing (create/update/delete) row entries in the grid.",
+                "uiLabel": "Row Form Options",
+                "isOptional": true,
+                "reference": "RowFormOptions"
+            },
+            {
+                "name": "smartEditCustomOperations",
+                "kind": "unknown",
+                "description": "Custom Operations to use in Smart Edit",
+                "uiLabel": "Smart Edit Custom Operations",
+                "isOptional": true
+            },
             {
                 "name": "validateOnServer",
                 "kind": "unknown",
@@ -6779,6 +6803,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Publishes the CheckboxColumnClickedEvent - when the checkbox in an Checkbox Column is clicked",
                 "uiLabel": "Fire Checkbox Column Clicked Event"
             },
+            {
+                "name": "getActiveFormatColumnForColumn",
+                "kind": "function",
+                "description": "Gets an active Format Column, if any, for given Column",
+                "uiLabel": "Get Active Format Column For Column"
+            },
             {
                 "name": "getAllActiveFormatColumn",
                 "kind": "function",
@@ -7874,6 +7904,24 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Loads grid with given data",
                 "uiLabel": "Load Grid Data"
             },
+            {
+                "name": "openCloneRowForm",
+                "kind": "function",
+                "description": "Open create dialog for cloning an existing row",
+                "uiLabel": "Open Clone Row Form"
+            },
+            {
+                "name": "openCreateRowForm",
+                "kind": "function",
+                "description": "Open create dialog for a new row",
+                "uiLabel": "Open Create Row Form"
+            },
+            {
+                "name": "openEditRowForm",
+                "kind": "function",
+                "description": "Open edit dialog for row with the given primary key value",
+                "uiLabel": "Open Edit Row Form"
+            },
             {
                 "name": "redrawGrid",
                 "kind": "function",
@@ -10619,6 +10667,52 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "RowFormOptions": {
+        "name": "RowFormOptions",
+        "kind": "Interface",
+        "description": "Options for editing (create/update/delete) row entries in the grid",
+        "properties": [
+            {
+                "name": "formButtons",
+                "kind": "unknown",
+                "description": "Custom form buttons provider. If provided, the custom implementation is responsible for firing the 'RowFormSubmitted' and/or invoking the 'onFormSubmit' callback (if necessary).",
+                "uiLabel": "Form Buttons",
+                "isOptional": true
+            },
+            {
+                "name": "formDescription",
+                "kind": "unknown",
+                "description": "Custom form description provider",
+                "uiLabel": "Form Description",
+                "isOptional": true,
+                "defaultValue": "undefined"
+            },
+            {
+                "name": "formFieldLabel",
+                "kind": "unknown",
+                "description": "Custom form field label provider",
+                "uiLabel": "Form Field Label",
+                "isOptional": true,
+                "defaultValue": "undefined"
+            },
+            {
+                "name": "formTitle",
+                "kind": "unknown",
+                "description": "Custom form title provider",
+                "uiLabel": "Form Title",
+                "isOptional": true,
+                "defaultValue": "'Create New Row'/'Edit Row'"
+            },
+            {
+                "name": "onFormSubmit",
+                "kind": "unknown",
+                "description": "Function which is invoked when a row form is submitted via a standard button (provided by AdapTable). This is not invoked when custom form buttons are provided!",
+                "uiLabel": "On Form Submit",
+                "isOptional": true,
+                "defaultValue": "undefined"
+            }
+        ]
+    },
     "RowInfo": {
         "name": "RowInfo",
         "kind": "Interface",
@@ -11511,6 +11605,12 @@ exports.ADAPTABLE_METAMODEL = {
                 "description": "Applies a Smart Edit to given Cells",
                 "uiLabel": "Apply Smart Edit"
             },
+            {
+                "name": "getSmartEditCustomOperations",
+                "kind": "function",
+                "description": "Retrieves an Smart Edit Custom Operations (provided in Edit Options)",
+                "uiLabel": "Get Smart Edit Custom Operations"
+            },
             {
                 "name": "getSmartEditOperation",
                 "kind": "function",
@@ -11543,6 +11643,31 @@ exports.ADAPTABLE_METAMODEL = {
             }
         ]
     },
+    "SmartEditCustomOperation": {
+        "name": "SmartEditCustomOperation",
+        "kind": "TypeAlias",
+        "description": "Custom Operation used in Smart Edit Module"
+    },
+    "SmartEditOperationContext": {
+        "name": "SmartEditOperationContext",
+        "kind": "Interface",
+        "description": "Context used in Custom Smart Edit Operations",
+        "properties": [
+            {
+                "name": "currentCell",
+                "kind": "REFERENCE",
+                "description": "Current selected grid cell - contains column, row and cell value information",
+                "uiLabel": "Current Cell",
+                "reference": "GridCell"
+            },
+            {
+                "name": "smartEditValue",
+                "kind": "number",
+                "description": "Smart Edit value",
+                "uiLabel": "Smart Edit Value"
+            }
+        ]
+    },
     "SpecialColumnSettings": {
         "name": "SpecialColumnSettings",
         "kind": "Interface",
@@ -12525,6 +12650,22 @@ exports.ADAPTABLE_METAMODEL = {
                 "isOptional": true,
                 "reference": "AdaptableStyle"
             },
+            {
+                "name": "rowActionButtons",
+                "kind": "unknown",
+                "description": "Action buttons to display for each row.",
+                "uiLabel": "Row Action Buttons",
+                "isOptional": true,
+                "defaultValue": "undefined"
+            },
+            {
+                "name": "rowActionButtonsPosition",
+                "kind": "unknown",
+                "description": "Position of the action buttons",
+                "uiLabel": "Row Action Buttons Position",
+                "isOptional": true,
+                "defaultValue": "'pinnedLeft'"
+            },
             {
                 "name": "showAdapTableVersion",
                 "kind": "boolean",

package/src/types.d.ts

@@ -12,7 +12,7 @@ export type { FlashingCellOptions } from './AdaptableOptions/FlashingCellOptions
 export type { TOAST_POSITIONS, NotificationsOptions, } from './AdaptableOptions/NotificationsOptions';
 export type { AlertOptions, ActionHandler, AlertForm, AlertButtonContext, } from './AdaptableOptions/AlertOptions';
 export type { DashboardOptions, CustomToolbar, DashboardButtonContext, CustomToolbarButtonContext, } from './AdaptableOptions/DashboardOptions';
-export type { EditOptions, ValidationResult } from './AdaptableOptions/EditOptions';
+export type { EditOptions, RowFormOptions, FormParamContext, FormFieldLabelContext, RowFormContext, CreateRowFormContext, EditRowFormContext, ValidationResult, SmartEditCustomOperation, SmartEditOperation, SmartEditOperationContext, } from './AdaptableOptions/EditOptions';
 export type { ExportOptions, SystemExportDestination, SystemExportDestinations, CustomDestination, CustomReport, DataFormatType, ExportButtonContext, } from './AdaptableOptions/ExportOptions';
 export type { GeneralOptions, ColumnValuesComparer } from './AdaptableOptions/GeneralOptions';
 export type { Glue42PluginOptions } from './AdaptableOptions/Glue42PluginOptions';
@@ -29,7 +29,7 @@ export type { FilterActionOnDataChange } from './PredefinedConfig/Common/FilterA
 export type { ConfigState } from './PredefinedConfig/ConfigState';
 export type { TeamSharingOptions } from './AdaptableOptions/TeamSharingOptions';
 export type { ToolPanelOptions, CustomToolPanel, ToolPanelButtonContext, CustomToolPanelButtonContext, } from './AdaptableOptions/ToolPanelOptions';
-export type { UserInterfaceOptions, CellValuesList, ActionColumnButtonContext, ActionColumn, ActionColumnSettings, BasePermittedValues, PermittedValues, EditLookUpPermittedValues, FilterPermittedValues, CustomSortPermittedValues, BulkUpdatePermittedValues, EditLookUpContext, PermittedValuesContext, FilterPermittedValuesContext, BulkUpdatePermittedValuesContext, GridInfoSections, GridInfoSection, } from './AdaptableOptions/UserInterfaceOptions';
+export type { UserInterfaceOptions, CellValuesList, ActionColumnButtonContext, ActionColumn, ActionColumnSettings, BasePermittedValues, PermittedValues, EditLookUpPermittedValues, FilterPermittedValues, CustomSortPermittedValues, BulkUpdatePermittedValues, EditLookUpContext, PermittedValuesContext, FilterPermittedValuesContext, BulkUpdatePermittedValuesContext, GridInfoSections, GridInfoSection, ObjectTagsContext, } from './AdaptableOptions/UserInterfaceOptions';
 export type { MenuOptions } from './AdaptableOptions/MenuOptions';
 export type { CustomSettingsPanel, SettingsPanelOptions, } from './AdaptableOptions/SettingsPanelOptions';
 export type { EntitlementOptions } from './AdaptableOptions/EntitlementOptions';
@@ -88,6 +88,7 @@ export type { LayoutChangedInfo } from './Api/Events/LayoutChanged';
 export type { CheckboxColumnClickedInfo } from './Api/Events/ChexboxColumnClicked';
 export type { CustomToolbarConfiguredInfo } from './Api/Events/CustomToolbarConfigured';
 export type { LiveDataChangedInfo, LiveReport } from './Api/Events/LiveDataChanged';
+export type { RowFormSubmittedInfo, RowFormType } from './Api/Events/RowFormSubmitted';
 export type { AdaptableSearchState, AdaptableSortState, SearchChangedInfo, } from './Api/Events/SearchChanged';
 export type { SelectionChangedInfo } from './Api/Events/SelectionChanged';
 export type { ThemeChangedInfo } from './Api/Events/ThemeChanged';
@@ -123,7 +124,7 @@ export type { ColumnSort } from './PredefinedConfig/Common/ColumnSort';
 export type { CellDataChangedInfo } from './PredefinedConfig/Common/CellDataChangedInfo';
 export type { DataChangedScope } from './PredefinedConfig/Common/DataChangedScope';
 export type { DataUpdateConfig } from './PredefinedConfig/Common/DataUpdateConfig';
-export type { AdaptableFormData, AdaptableForm, AdaptableFormField, } from './PredefinedConfig/Common/AdaptableForm';
+export type { AdaptableFormData, AdaptableForm, AdaptableFormField, AdaptableFormFieldType, } from './PredefinedConfig/Common/AdaptableForm';
 export type { AdaptableButton } from './PredefinedConfig/Common/AdaptableButton';
 export type { AdaptableMenuItem, UserMenuItem, ColumnMenuContext, ContextMenuContext, } from './PredefinedConfig/Common/Menu';
 export type { BaseContext } from './PredefinedConfig/Common/BaseContext';

package/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "11.2.4";
+declare const _default: "11.3.0";
 export default _default;

package/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '11.2.4'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version
+exports.default = '11.3.0'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version

package/src/AdaptableOptions/SmartEdit.d.ts

@@ -1,34 +0,0 @@
-import { MathOperation } from '../PredefinedConfig/Common/Enums';
-import { AdaptableApi, AdaptableColumn, GridCell } from '../types';
-export declare type SmartEditCustomOperation = {
-    /**
-     * Name of the operation, appears in the UI
-     */
-    Name: string;
-    /**
-     * Custom operation function
-     */
-    Operation: (context: {
-        /**
-         * Selected Cell Value
-         */
-        value: number;
-        /**
-         * Smart edit cell value
-         */
-        smartEditValue: number;
-        /**
-         * Selected column
-         */
-        column: AdaptableColumn;
-        /**
-         * Adaptable Api
-         */
-        adaptableApi: AdaptableApi;
-        /**
-         * Current selected grid cell
-         */
-        currentCell: GridCell;
-    }) => number;
-};
-export declare type SmartEditOperation = SmartEditCustomOperation | MathOperation;

package/src/View/Components/Forms/AdaptableForm.d.ts

@@ -1,6 +0,0 @@
-import * as React from 'react';
-export declare type AdaptableFormProps = any;
-export declare class AdaptableForm extends React.Component<AdaptableFormProps, {}> {
-    render(): JSX.Element;
-    CancelOnFormSubmit: (e: React.FormEvent<any>) => void;
-}

package/src/View/Components/Forms/AdaptableForm.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AdaptableForm = void 0;
-const tslib_1 = require("tslib");
-const React = tslib_1.__importStar(require("react"));
-class AdaptableForm extends React.Component {
-    constructor() {
-        super(...arguments);
-        this.CancelOnFormSubmit = (e) => {
-            e.preventDefault();
-            if (this.props.onSubmit) {
-                this.props.onSubmit(null);
-            }
-        };
-    }
-    render() {
-        const _a = this.props, { children } = _a, attrs = tslib_1.__rest(_a, ["children"]);
-        return (React.createElement("form", Object.assign({}, attrs, { onSubmit: this.CancelOnFormSubmit }), children));
-    }
-}
-exports.AdaptableForm = AdaptableForm;