@adaptabletools/adaptable 13.1.0-canary.0 → 13.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adaptabletools/adaptable",
-  "version": "13.1.0-canary.0",
+  "version": "13.1.0",
   "description": "Powerful data-agnostic HTML5 datagrid add-on that sits on top of an underlying grid component and provides all the rich functionality that advanced users expect from their DataGrids and Data Tables",
   "keywords": [
     "web-components",

package/publishTimestamp.d.ts

@@ -1,2 +1,2 @@
-declare const _default: 1668604193432;
+declare const _default: 1668692878576;
 export default _default;

package/publishTimestamp.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = 1668604193432;
+exports.default = 1668692878576;

package/src/AdaptableOptions/ActionOptions.d.ts

@@ -16,33 +16,9 @@ export interface ActionOptions {
     actionRowButtons?: ActionRowButtonType[];
     /**
      * Additional options for managing Action Row Buttons
+     * @defaultValue undefined
      */
-    actionRowButtonOptions?: {
-        /**
-         * Optional configuration that merges with built-in action row button and overrides default configuration
-         * @defaultValue undefined
-         */
-        customConfiguration?: (context: ActionRowButtonConfigurationContext) => Partial<AdaptableButton<ActionColumnContext>>;
-        /**
-         * Position of Action Row Buttons
-         * @defaultValue 'pinnedLeft'
-         */
-        position?: 'pinnedLeft' | 'pinnedRight';
-        /**
-         * If true, Action Row Buttons will be handled by AdapTable and the grid data model will be automatically updated with the created/edited/deleted rows
-         * @defaultValue true
-         */
-        autoHandle?: boolean;
-        /**
-         * Function called when auto-handling 'create' Action Row Button; returned row value should have a valid(unique) primary key value
-         * @defaultValue undefined
-         */
-        setPrimaryKeyValue?: (context: SetPrimaryKeyValueContext) => any;
-        /**
-         * Options for managing the Form which the Action Row displays
-         */
-        actionRowFormOptions?: ActionRowFormOptions;
-    };
+    actionRowButtonOptions?: ActionRowButtonOptions;
 }
 /**
  * The context for the SetPrimaryKeyValueContext function
@@ -120,6 +96,33 @@ export interface ActionColumnSettings {
      */
     suppressMovable?: boolean;
 }
+export interface ActionRowButtonOptions {
+    /**
+     * Optional configuration that merges with built-in action row button and overrides default configuration
+     * @defaultValue undefined
+     */
+    customConfiguration?: (context: ActionRowButtonConfigurationContext) => Partial<AdaptableButton<ActionColumnContext>>;
+    /**
+     * Action Row Buttons position: 'pinnedLeft' | 'pinnedRight
+     * @defaultValue 'pinnedLeft'
+     */
+    position?: 'pinnedLeft' | 'pinnedRight';
+    /**
+     * If true, Action Row Buttons will be handled by AdapTable and the grid data model will be automatically updated with the created/edited/deleted rows
+     * @defaultValue true
+     */
+    autoHandle?: boolean;
+    /**
+     * Function called when auto-handling 'create' Action Row Button; returned row value should have a valid(unique) primary key value
+     * @defaultValue undefined
+     */
+    setPrimaryKeyValue?: (context: SetPrimaryKeyValueContext) => any;
+    /**
+     * Options for managing the Form which the Action Row displays
+     * @defaultValue undefined
+     */
+    actionRowFormOptions?: ActionRowFormOptions;
+}
 /**
  * Options for Form displayed when Action Row Button is clicked
  */

package/src/AdaptableOptions/ChartingOptions.d.ts

@@ -4,14 +4,24 @@
 export interface ChartingOptions {
     /**
      * Behaviour for saving Charts, can be automatic, manual (via popup) or none
-     * @defaultValue 'manual'
+     * @defaultValue 'none'
      */
     saveStrategy?: 'auto' | 'manual' | 'none';
     /**
-     * Used when restoring Charts; doesnt override AG Grid gridOptions.createChartContainer
+     * Locations to display saved Charts
      */
-    chartContainers?: {
-        name: string;
-        element: HTMLElement | string;
-    }[];
+    chartContainers?: ChartContainer[];
+}
+/**
+ * Describes a location to display an AG Grid Chart
+ */
+export interface ChartContainer {
+    /**
+     * Name of the Location - used in Dropdowns
+     */
+    name: string;
+    /**
+     * Location - can be HTMLElement or Id of Div
+     */
+    element: HTMLElement | string;
 }

package/src/AdaptableOptions/ChartingOptions.js

@@ -1,6 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-// Put in docs
-//* - auto: all created charts are saved automatically in Adaptable state
-//* - manual: a popup is shown to the user to save the chart
-//* - none: charts are not saved

package/src/Api/ColumnApi.d.ts

@@ -303,8 +303,7 @@ export interface ColumnApi {
      */
     isColumnReferencedInExpression(columnId: string, expression: string): boolean;
     /**
-     * Checks if a column is a ActionRowButton column (see UserInterfaceOptions.ActionOptions)
-     *
+     * Checks if a column is a ActionRowButton column
      * @param columnId Column to Check
      */
     isActionRowButtonColumn(columnId: string): boolean;

package/src/PredefinedConfig/Common/AdaptableStyle.d.ts

@@ -3,13 +3,17 @@
  */
 export interface AdaptableStyle {
     /**
-     * Colour background of cell: provide hex value or name
+     * Colour background of cell: hex, rgb(a) or name
      */
     BackColor?: string;
     /**
-     * Font colour in cell: provide hex value or name
+     * Font colour in cell: hex, rgb(a) or name
      */
     ForeColor?: string;
+    /**
+     * Colour of cell border: hex, rgb(a) or name
+     */
+    BorderColor?: string;
     /**
      * Weight of font: `Normal` or `Bold`
      */
@@ -22,10 +26,6 @@ export interface AdaptableStyle {
      * Size of font: `XSmall`, `Small`, `Medium`, `Large` or `XLarge`
      */
     FontSize?: 'XSmall' | 'Small' | 'Medium' | 'Large' | 'XLarge';
-    /**
-     * Colour of cell border: provide hex value or name
-     */
-    BorderColor?: string;
     /**
      * Existing CSS Class; use instead of setting other object properties
      */

package/src/Strategy/FlashingCellModule.js

@@ -94,10 +94,12 @@ class FlashingCellModule extends AdaptableModuleBase_1.AdaptableModuleBase {
             if (menuContext.adaptableColumn && menuContext.rowNode) {
                 const flashingCellForRow = this.api.internalApi.getAdaptableFlashingCellFor(menuContext.primaryKeyValue);
                 const flashingCellForCell = this.api.internalApi.getAdaptableFlashingCellFor(menuContext.primaryKeyValue, menuContext.adaptableColumn.columnId);
-                if (flashingCellForRow &&
-                    (flashingCellForRow.flashTarget === 'row' ||
-                        flashingCellForRow.flashTarget.includes('row'))) {
-                    items.push(this.createColumnMenuItemReduxAction('Clear Flashing Row', this.moduleInfo.Glyph, SystemRedux.SystemFlashingCellDelete(flashingCellForRow)));
+                if (flashingCellForRow) {
+                    if (flashingCellForRow.flashTarget === 'row' ||
+                        (Array.isArray(flashingCellForRow.flashTarget) &&
+                            flashingCellForRow.flashTarget.includes('row'))) {
+                        items.push(this.createColumnMenuItemReduxAction('Clear Flashing Row', this.moduleInfo.Glyph, SystemRedux.SystemFlashingCellDelete(flashingCellForRow)));
+                    }
                 }
                 else if (flashingCellForCell && flashingCellForCell.flashTarget === 'cell') {
                     items.push(this.createColumnMenuItemReduxAction('Clear Flashing Cell', this.moduleInfo.Glyph, SystemRedux.SystemFlashingCellDelete(flashingCellForCell)));

package/src/Utilities/Defaults/DefaultAdaptableOptions.js

@@ -275,6 +275,6 @@ exports.DefaultAdaptableOptions = {
         alwaysShowInToolPanel: false,
     },
     chartingOptions: {
-        saveStrategy: 'manual',
+        saveStrategy: 'none',
     },
 };

package/src/Utilities/Helpers/AdaptableHelper.js

@@ -39,6 +39,7 @@ function assignAdaptableOptions(adaptableOptions) {
     returnedAdaptableOptions.teamSharingOptions = Object.assign({}, DefaultAdaptableOptions_1.DefaultAdaptableOptions.teamSharingOptions, adaptableOptions.teamSharingOptions);
     returnedAdaptableOptions.toolPanelOptions = Object.assign({}, DefaultAdaptableOptions_1.DefaultAdaptableOptions.toolPanelOptions, adaptableOptions.toolPanelOptions);
     returnedAdaptableOptions.dataChangeHistoryOptions = Object.assign({}, DefaultAdaptableOptions_1.DefaultAdaptableOptions.dataChangeHistoryOptions, adaptableOptions.dataChangeHistoryOptions);
+    returnedAdaptableOptions.chartingOptions = Object.assign({}, DefaultAdaptableOptions_1.DefaultAdaptableOptions.chartingOptions, adaptableOptions.chartingOptions);
     returnedAdaptableOptions.settingsPanelOptions = Object.assign({}, DefaultAdaptableOptions_1.DefaultAdaptableOptions.settingsPanelOptions, adaptableOptions.settingsPanelOptions);
     const { predefinedConfig } = returnedAdaptableOptions;
     if (predefinedConfig) {

package/src/metamodel/adaptable.metamodel.d.ts

@@ -96,13 +96,15 @@ export declare const ADAPTABLE_METAMODEL: {
             uiLabel: string;
             isOptional: boolean;
             defaultValue: string;
+            reference?: undefined;
         } | {
             name: string;
             kind: string;
             description: string;
             uiLabel: string;
             isOptional: boolean;
-            defaultValue?: undefined;
+            defaultValue: string;
+            reference: string;
         })[];
     };
     ActionRowButtonConfigurationContext: {
@@ -1491,6 +1493,17 @@ export declare const ADAPTABLE_METAMODEL: {
         kind: string;
         description: string;
     };
+    ChartContainer: {
+        name: string;
+        kind: string;
+        description: string;
+        properties: {
+            name: string;
+            kind: string;
+            description: string;
+            uiLabel: string;
+        }[];
+    };
     ChartDefinition: {
         name: string;
         kind: string;