@adaptabletools/adaptable 20.3.0 → 21.0.0-canary.1

package/src/AdaptableOptions/ColumnOptions.d.ts

@@ -41,36 +41,36 @@ export interface ColumnOptions {
  */
 export interface BaseColumnHeaderContext extends BaseContext {
     /**
-     * The default header name for the column
+     * Default header name for Column
      */
     defaultHeaderName: string;
     /**
-     * The mame of the current Layout
+     * Name of Current Layout
      */
     currentLayoutName: string;
     /**
-     * The type (table/pivot) of the current Layout
+     * Type (table/pivot) of Current Layout
      */
     currentLayoutType: 'table' | 'pivot';
     /**
-     * The current Layout
+     * Current Layout
      */
     currentLayout: Layout;
 }
 /**
- * Context for Columns created automatically by AG Grid when grouping
+ * Context for Columns created automatically by AG Grid when Row Grouping
  */
 export interface AutoGroupColumnHeaderContext extends BaseColumnHeaderContext {
     /**
-     * Auto-generated Group Column when GroupDisplayType is `single` column
+     * Auto-generated Row Group Column (when RowGroupDisplayType is `single`)
      */
     columnType: 'autoGroupColumn';
     /**
-     * Technical ID of the Column
+     * Id of the Column
      */
     columnId: string;
     /**
-     * IDs of the Columns that are grouped
+     * Ids of all Row Grouped Columns
      */
     groupedColumnIds: string[];
 }
@@ -79,15 +79,15 @@ export interface AutoGroupColumnHeaderContext extends BaseColumnHeaderContext {
  */
 export interface RowGroupColumnHeaderContext extends BaseColumnHeaderContext {
     /**
-     * A Row Grouped Column - see `TableLayout.RowGroupedColumns` or `PivotLayout.PivotGroupedColumns`
+     * A Row Grouped Column (created in both Table and Pivot Layout)
      */
     columnType: 'rowGroupColumn';
     /**
-     * Technical ID of the Column
+     * Id of the Column
      */
     columnId: string;
     /**
-     * ID of the grouped Column
+     * Id of Row Grouped Column
      */
     groupColumnId: string;
 }
@@ -96,15 +96,15 @@ export interface RowGroupColumnHeaderContext extends BaseColumnHeaderContext {
  */
 export interface TableColumnHeaderContext extends BaseColumnHeaderContext {
     /**
-     *  Table Column - see `TableLayout.TableColumns`
+     *  Table Column (created in Table Layouts)
      */
     columnType: 'tableColumn';
     /**
-     * Technical ID of the Column
+     * Id of the Column
      */
     columnId: string;
     /**
-     * Optional Aggregation function of the Column - see `TableLayout.TableAggregationColumns`
+     * Aggregation function of Column (optional)
      */
     aggregation?: string;
 }
@@ -113,19 +113,19 @@ export interface TableColumnHeaderContext extends BaseColumnHeaderContext {
  */
 export interface TableColumnGroupHeaderContext extends BaseColumnHeaderContext {
     /**
-     * Column Group (used when Column Grouping)
+     * Table Column Group (used when Column Grouping in Table Layouts)
      */
     columnType: 'tableColumnGroup';
     /**
-     * Technical ID of the Column Group - see `ColGroupDef.groupId`
+     * Id of Column Group
      */
     groupId: string;
     /**
-     * IDs of the Column Group children - see `ColGroupDef.children`
+     * Ids of Column Group's children
      */
     childrenColumnIds: string[];
     /**
-     * State of the Column Group
+     * Expanded / Collapsed state of Column Group
      */
     state: 'expanded' | 'collapsed';
 }
@@ -134,19 +134,19 @@ export interface TableColumnGroupHeaderContext extends BaseColumnHeaderContext {
  */
 export interface PivotColumnGroupHeaderContext extends BaseColumnHeaderContext {
     /**
-     * Pivot Column Column - created by `PivotLayout.PivotColumns`
+     * Pivot Column Group (created for each distinct value in a PivotColumn)
      */
     columnType: 'pivotColumnGroup';
     /**
-     * Technical ID of the generated Column Group
+     * Id of generated Column Group
      */
     groupId: string;
     /**
-     * Pivot Keys for the current Column Group
+     * Pivot Keys for Column Group
      */
     pivotKeys: string[];
     /**
-     * State of the Column Group
+     * Expanded / Collapsed state of Column Group
      */
     state: 'expanded' | 'collapsed';
 }
@@ -155,11 +155,11 @@ export interface PivotColumnGroupHeaderContext extends BaseColumnHeaderContext {
  */
 export interface PivotResultColumnHeaderContext extends BaseColumnHeaderContext {
     /**
-     * Pivot Result Column - intersecton of `PivotLayout.PivotAggregationColumns` and `PivotLayout.PivotColumns`
+     * Pivot Result Column (unique intersection of PivotAggregationColumn and PivotColumn)
      */
     columnType: 'pivotResultColumn';
     /**
-     * Technical ID of the generated Column
+     * Id of generated Column
      */
     columnId: string;
     /**
@@ -167,11 +167,11 @@ export interface PivotResultColumnHeaderContext extends BaseColumnHeaderContext
      */
     pivotKeys: string[];
     /**
-     * ID of the Aggregated Column - see `PivotLayout.PivotAggregationColumns`
+     * Id of Pivot Aggregated Column
      */
     aggregatedColumnId: string;
     /**
-     *  Aggregation function of the Column - see `PivotLayout.PivotAggregationColumns.AggregationColumnValue`
+     *  Aggregation function of Column
      */
     aggregation: string;
 }
@@ -180,15 +180,15 @@ export interface PivotResultColumnHeaderContext extends BaseColumnHeaderContext
  */
 export interface PivotGrandTotalHeaderContext extends BaseColumnHeaderContext {
     /**
-     * Pivot Grand Total - see `PivotLayout.PivotGrandTotal`
+     * Pivot Grand Total Column
      */
     columnType: 'pivotGrandTotal';
     /**
-     * ID of the Aggregated Column - see `PivotLayout.PivotAggregationColumns`
+     * Id of Pivot Aggregated Column
      */
     aggregatedColumnId: string;
     /**
-     *  Aggregation function of the Column - see `PivotLayout.PivotAggregationColumns.AggregationColumnValue`
+     *  Aggregation function of Column
      */
     aggregation: string;
 }
@@ -197,19 +197,19 @@ export interface PivotGrandTotalHeaderContext extends BaseColumnHeaderContext {
  */
 export interface PivotColumnTotalHeaderContext extends BaseColumnHeaderContext {
     /**
-     * Pivot Column Total - see `PivotLayout.PivotColumnTotal`
+     * Pivot Column Total
      */
     columnType: 'pivotColumnTotal';
     /**
-     * Current Pivot Keys
+     * Key (i.e. column value) of Pivot Column
      */
     pivotKey: string;
     /**
-     * ID of the Pivot Column - see `PivotLayout.PivotColumns`
+     * Id of Pivot Column
      */
     pivotColumnId: string;
     /**
-     *  Aggregation function of the Column - see `PivotLayout.PivotAggregationColumns.AggregationColumnValue`
+     *  Aggregation function of Column
      */
     aggregation: string;
 }
@@ -218,23 +218,23 @@ export interface PivotColumnTotalHeaderContext extends BaseColumnHeaderContext {
  */
 export interface PivotAggregationTotalHeaderContext extends BaseColumnHeaderContext {
     /**
-     * Pivot Aggregation Total Column - see `PivotLayout.PivotAggregationColumns.TotalColumn`
+     * Pivot Aggregation Total Column
      */
     columnType: 'pivotAggregationTotal';
     /**
-     * ID of the Aggregated Column - see `PivotLayout.PivotAggregationColumns`
+     * Id of Aggregated Column
      */
     aggregatedColumnId: string;
     /**
-     *  Aggregation function of the Column - see `PivotLayout.PivotAggregationColumns.AggregationColumnValue`
+     *  Aggregation function of Column
      */
     aggregation: string;
     /**
-     * ID of the Pivot Column - see `PivotLayout.PivotColumns`
+     * Id of Pivot Column
      */
     pivotColumnId: string;
     /**
-     * Current Pivot Keys
+     * Key (i.e. column value) of Pivot Column
      */
     pivotKey: string;
 }

package/src/AdaptableOptions/DefaultAdaptableOptions.js

@@ -150,6 +150,7 @@ const DefaultAdaptableOptions = {
         columnFilterOptions: {
             indicateFilteredColumns: true,
             autoApplyColumnFilter: true,
+            cacheInFilterValues: true,
             defaultNumericColumnFilter: 'Equals',
             defaultTextColumnFilter: 'Contains',
             defaultDateColumnFilter: 'On',
@@ -187,7 +188,7 @@ const DefaultAdaptableOptions = {
         },
         layoutTagOptions: {
             autoGenerateTagsForLayouts: false,
-            isObjectAvailableInLayout: undefined,
+            isObjectExtendedInLayout: undefined,
             autoCheckTagsForLayouts: false,
         },
     },
@@ -216,7 +217,7 @@ const DefaultAdaptableOptions = {
         systemFlashingCellPredicates: SystemFlashingCellPredicateIds,
         systemBadgeStylePredicates: SystemBadgeStylePredicateIds,
         caseSensitivePredicates: false,
-        evaluateValuesPredicateUsingTime: true,
+        evaluateInPredicateUsingTime: true,
     },
     quickSearchOptions: {
         clearQuickSearchOnStartUp: false,

package/src/AdaptableOptions/EditOptions.d.ts

@@ -54,14 +54,11 @@ export interface CustomEditColumnValuesContext<TData = any> extends AdaptableCol
 /**
  * Information about items in the Edit Controls
  */
-export interface CustomEditColumnValueInfo {
-    /**
-     * Item's label
-     */ label?: string;
-    /**
-     * Value of Item being shown
-     */
+export interface EditColumnValueInfo {
     value: any;
+    label?: string;
+}
+export interface CustomEditColumnValueInfo extends EditColumnValueInfo {
 }
 /**
  * Used for Server Validation ie. after an edit in AG Grid which must be checked on Server

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -1,5 +1,6 @@
 import { FilterActionOnDataChange } from '../AdaptableState/Common/FilterActionOnDataChange';
 import { BaseContext } from '../../types';
+import { AdaptableColumn } from '../AdaptableState/Common/AdaptableColumn';
 import { SystemAlertPredicateId, SystemFilterPredicateId } from '../../types';
 import { StrictExtract } from '../Utilities/Extensions/TypeExtensions';
 import { AdaptableColumnContext } from '../AdaptableState/Common/AdaptableColumnContext';
@@ -78,41 +79,48 @@ export interface ColumnFilterOptions<TData = any> {
      */
     indicateFilteredColumns?: boolean;
     /**
-     * Apply selected Column Filters as soon as they are clicked; if false an Apply Filter button is displayed
+     * Apply Column Filters immediately; if false an Apply Filter button is displayed and Quick Filter is disabled
      *
      * @defaultValue true
      * @gridInfoItem
      * @noCodeItem
      */
-    autoApplyColumnFilter?: boolean;
+    autoApplyColumnFilter?: boolean | ((context: AdaptableColumnContext) => boolean);
+    /**
+     * Whether to cache the values in the IN Filter component
+     * @defaultValue true
+     * @gridInfoItem
+     * @noCodeItem
+     */
+    cacheInFilterValues?: boolean | ((context: AdaptableColumnContext) => boolean);
     /**
      * Default filter type for numeric Columns
      *
      * @defaultValue Equals
      * @gridInfoItem
      */
-    defaultNumericColumnFilter?: StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'In'> | ((adaptableColumnContext: AdaptableColumnContext<TData>) => StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'In'>);
+    defaultNumericColumnFilter?: StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'In'> | ((adaptableColumnContext: DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'In'>);
     /**
      * Default filter type for text Columns
      *
      * @defaultValue Contains
      * @gridInfoItem
      */
-    defaultTextColumnFilter?: StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'In'> | ((adaptableColumnContext: AdaptableColumnContext<TData>) => StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'In'>);
+    defaultTextColumnFilter?: StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'In'> | ((adaptableColumnContext: DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'In'>);
     /**
      * Default filter type for date Columns
      *
      * @defaultValue On
      * @gridInfoItem
      */
-    defaultDateColumnFilter?: StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'In'> | ((adaptableColumnContext: AdaptableColumnContext<TData>) => StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'In'>);
+    defaultDateColumnFilter?: StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'In'> | ((adaptableColumnContext: DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'In'>);
     /**
      * Default filter type for array Columns ('textArray', 'numberArray', etc.)
      *
      * @defaultValue In
      * @gridInfoItem
      */
-    defaultArrayColumnFilter?: StrictExtract<SystemFilterPredicateId, 'In' | 'NotIn' | 'Blanks' | 'NonBlanks'> | ((adaptableColumnContext: AdaptableColumnContext<TData>) => StrictExtract<SystemFilterPredicateId, 'In' | 'NotIn' | 'Blanks' | 'NonBlanks'>);
+    defaultArrayColumnFilter?: StrictExtract<SystemFilterPredicateId, 'In' | 'NotIn' | 'Blanks' | 'NonBlanks'> | ((adaptableColumnContext: DefaultPredicateFilterContext) => StrictExtract<SystemFilterPredicateId, 'In' | 'NotIn' | 'Blanks' | 'NonBlanks'>);
     /**
      * Hides Dropdown in Quick Filter Bar for a given Column
      *
@@ -173,32 +181,55 @@ export interface IsRowFilterableContext<TData = any> extends BaseContext {
      */
     data: TData;
 }
+export type AdaptableFilterComponentLocation = 'FilterBar' | 'FilterForm';
 /**
- * Information about items in the IN Column Filter
+ * Context used for setting default Predicates for Column Filters
  */
-export interface InFilterValueInfo {
+export interface DefaultPredicateFilterContext<TData = any> extends BaseContext {
     /**
-     * The value of the item being shown
+     * Filter Component being displayed: FilterBar or FilterForm
      */
-    value: any;
+    filterComponent: AdaptableFilterComponentLocation;
+    /**
+     * Current Column
+     */
+    column: AdaptableColumn<TData>;
+}
+/**
+ * Item in the IN Column Filter
+ */
+export interface InFilterValue<ValueType = any> {
     /**
      * Item's label
      */
-    label?: string;
+    label: string;
     /**
-     * Whether item is currently selected
+     * The value of Item being shown
+     */
+    value: ValueType;
+    /**
+     * Tooltip for Item (if true, the label is used as tooltip)
+     */
+    tooltip?: boolean | string;
+}
+/**
+ * Information about items in the IN Column Filter
+ */
+export interface InFilterValueInfo extends InFilterValue {
+    /**
+     * Whether Item is currently selected
      */
     isSelected?: boolean;
     /**
-     * How many times the item appears in the column
+     * How many times Item appears in the column
      */
     count?: number;
     /**
-     * How many times the item appears in the column in filtered rows
+     * How many times Item appears in the column in filtered rows
      */
     visibleCount?: number;
     /**
-     * Whether the item is currently visible in the Grid (i.e. in filtered rows)
+     * Whether Item is currently visible in Grid (i.e. in filtered rows)
      */
     visible?: boolean;
 }
@@ -214,6 +245,10 @@ export interface CustomInFilterValuesContext<TData = any> extends AdaptableColum
      * Default values but Sorted based on Column's sort
      */
     sortedValues: Required<InFilterValueInfo>[];
+    /**
+     * Default values but in the order in which they are currently listed in the grid - (after all the sorting has been applied, or, if no sorting, in their natural order)
+     */
+    orderedValues: Required<InFilterValueInfo>[];
     /**
      * Search text in the IN Filter component - used when filtering on server
      */

package/src/AdaptableOptions/LayoutOptions.d.ts

@@ -1,15 +1,6 @@
-import { AlertDefinition } from '../AdaptableState/AlertState';
-import { CustomSort } from '../AdaptableState/CustomSortState';
-import { FlashingCellDefinition } from '../AdaptableState/FlashingCellState';
-import { FormatColumn } from '../AdaptableState/FormatColumnState';
-import { PlusMinusNudge } from '../AdaptableState/PlusMinusState';
-import { Shortcut } from '../AdaptableState/ShortcutState';
-import { StyledColumn } from '../AdaptableState/StyledColumnState';
-import { BaseSchedule } from '../AdaptableState/Common/Schedule';
-import { Layout } from '../AdaptableState/LayoutState';
-import { AdaptableModule } from '../AdaptableState/Common/Types';
+import { Layout, PivotLayout, TableLayout } from '../AdaptableState/LayoutState';
 import { AdaptableObjectTag } from '../AdaptableState/Common/AdaptableObject';
-import { BaseContext } from '../../types';
+import { BaseContext, LayoutExtensionModule, LayoutExtensionObject } from '../../types';
 /**
  * Options for configuring Layouts; manage Column visibility, order, sorting, grouping, width etc.
  */
@@ -26,6 +17,10 @@ export interface LayoutOptions {
      * Columns to display in Table that opens when viewing Pivot Cell contents
      */
     pivotPreviewColumns?: string[] | ((context: PivotPreviewColumnsContext) => string[]);
+    /**
+     * Default properties to apply when creating a new Layout (Table or Pivot)
+     */
+    defaultLayoutProperties?: DefaultLayoutProperties | ((context: DefaultLayoutPropertiesContext) => DefaultTableLayoutProperties | DefaultPivotLayoutProperties);
 }
 /**
  * Options for managing Tags in Layouts (used to enhance Layouts)
@@ -38,15 +33,15 @@ export interface LayoutTagOptions {
      */
     autoGenerateTagsForLayouts?: boolean | ((context: AutoGenerateTagsForLayoutsContext) => AdaptableObjectTag[]);
     /**
-     * Automatically assumes that any `LayoutAssociatedObject` is available in the current Layout if it has a tag with the Layouts name (or no tags at all)
+     * Automatically assumes that any `LayoutExtensionObject` is available in the current Layout if it has a tag with the Layouts name (or no tags at all)
      *
      * @defaultValue false
      */
     autoCheckTagsForLayouts?: boolean;
     /**
-     * Checks if provided Adaptable Object is available in given Layout
+     * Checks if provided Adaptable Object is extended in given Layout
      */
-    isObjectAvailableInLayout?: (layoutAvailableContext: LayoutAvailableContext) => boolean;
+    isObjectExtendedInLayout?: (layoutExtendedContext: LayoutExtendedContext) => boolean;
 }
 /**
  * Customize how Layouts are displayed in Settings Panel
@@ -60,26 +55,22 @@ export interface LayoutViewOptions {
     maxColumnsToDisplay?: number;
 }
 /**
- * Context for `LayoutOptions.isObjectAvailableInLayout` function
+ * Context for `LayoutOptions.isObjectExtendedInLayout` function
  */
-export interface LayoutAvailableContext extends BaseContext {
+export interface LayoutExtendedContext extends BaseContext {
     /**
      * Object being checked
      */
-    adaptableObject: LayoutAssociatedObject;
+    adaptableObject: LayoutExtensionObject;
     /**
      * Current Adaptable Module
      */
-    module: AdaptableModule;
+    module: LayoutExtensionModule;
     /**
      * Current Layout
      */
     layout: Layout;
 }
-/**
- * Types of Adaptable Objects that can be associated with a Layout
- */
-export type LayoutAssociatedObject = AlertDefinition | CustomSort | FlashingCellDefinition | FormatColumn | PlusMinusNudge | StyledColumn | Shortcut | BaseSchedule;
 /**
  * Context for `LayoutOptions.autoGenerateTagsForLayouts` method
  */
@@ -106,3 +97,30 @@ export interface PivotPreviewColumnsContext extends BaseContext {
      */
     columnId: string;
 }
+/**
+ * Default properties to apply when creating a new Table Layout
+ */
+export type DefaultTableLayoutProperties = Partial<Omit<TableLayout, 'Name'>>;
+/**
+ * Default properties to apply when creating a new Pivot Layout
+ */
+export type DefaultPivotLayoutProperties = Partial<Omit<PivotLayout, 'Name'>>;
+/**
+ * Default properties to apply when creating a new Layout (Table or Pivot)
+ */
+export interface DefaultLayoutProperties {
+    /**
+     * Default properties to apply when creating a new Table Layout
+     */
+    tableLayout?: DefaultTableLayoutProperties;
+    /**
+     * Default properties to apply when creating a new Pivot Layout
+     */
+    pivotLayout?: DefaultPivotLayoutProperties;
+}
+/**
+ * Context for `LayoutOptions.defaultLayoutProperties` function
+ */
+export interface DefaultLayoutPropertiesContext extends BaseContext {
+    layoutType: 'table' | 'pivot';
+}

package/src/AdaptableOptions/PredicateOptions.d.ts

@@ -41,7 +41,7 @@ export interface PredicateOptions {
      * @defaultValue  true
      * @noCodeItem
      */
-    evaluateValuesPredicateUsingTime?: boolean;
+    evaluateInPredicateUsingTime?: boolean;
 }
 /**
  * Context used for setting which System Predicates are available

package/src/AdaptableOptions/UserInterfaceOptions.d.ts

@@ -23,7 +23,7 @@ export interface UserInterfaceOptions<TData = any> {
     /**
      * Bespoke icons that can be used in AdapTable (e.g. Badge Styles and Buttons)
      */
-    customIcons?: CustomIcon[];
+    customIcons?: CustomIcon[] | (() => CustomIcon[]);
     /**
      * Options for managing and customizing date inputs in AdapTable
      */

package/src/AdaptableState/Common/AdaptableColumn.d.ts

@@ -1,5 +1,7 @@
 import { AdaptableObject } from './AdaptableObject';
 import { BaseCellDataType, ColDef } from 'ag-grid-enterprise';
+import { UniqueGridCell } from '../Selection/GridCell';
+import { ColumnFilter } from './ColumnFilter';
 /**
  * Defines data type of a Column; can be an AG Grid BaseCellDataType or an AdapTable array-related one
  */
@@ -210,3 +212,8 @@ export interface AdaptableColumnProperties {
     pivotable: boolean;
     aggregatable: boolean;
 }
+export interface AdaptableColumnSummary {
+    column: AdaptableColumn;
+    columnFilter: ColumnFilter;
+    uniqueGridCells: UniqueGridCell[];
+}

package/src/AdaptableState/Common/AdaptablePredicate.js

@@ -51,7 +51,7 @@ export const SystemPredicateDefs = [
             }
             if (column.dataType === 'date') {
                 return inputs.some((input) => {
-                    if (adaptableApi.optionsApi.getPredicateOptions().evaluateValuesPredicateUsingTime) {
+                    if (adaptableApi.optionsApi.getPredicateOptions().evaluateInPredicateUsingTime) {
                         return isEqual(input, value);
                     }
                     else {
@@ -125,7 +125,7 @@ export const SystemPredicateDefs = [
                 return true;
             }
             if (column.dataType === 'date') {
-                if (adaptableApi.optionsApi.getPredicateOptions().evaluateValuesPredicateUsingTime) {
+                if (adaptableApi.optionsApi.getPredicateOptions().evaluateInPredicateUsingTime) {
                     return inputs.every((input) => {
                         return !isEqual(input, value);
                     });

package/src/AdaptableState/Common/CustomWindowConfig.d.ts

@@ -17,7 +17,7 @@ export interface CustomWindowConfig {
      */
     icon?: AdaptableSystemIconName;
     /**
-     * Render function to display content in Custom Window(if not using a framework component)
+     * Render function to display content in Custom Window (if not using a framework component)
      */
     render?: (customRenderContext: CustomRenderContext) => string | null;
     /**
@@ -25,7 +25,7 @@ export interface CustomWindowConfig {
      */
     frameworkComponent?: AdaptableFrameworkComponent;
     /**
-     * Callback function to be called when the framework component is destroyed
+     * Callback function invoked when framework component is destroyed
      */
     onFrameworkComponentDestroyed?: () => void;
     /**

package/src/AdaptableState/Common/ExtendedLayout.d.ts

@@ -0,0 +1,50 @@
+import { Layout } from '../LayoutState';
+import { AlertDefinition } from '../AlertState';
+import { CustomSort } from '../CustomSortState';
+import { FlashingCellDefinition } from '../FlashingCellState';
+import { FormatColumn } from '../FormatColumnState';
+import { PlusMinusNudge } from '../PlusMinusState';
+import { Shortcut } from '../ShortcutState';
+import { StyledColumn } from '../StyledColumnState';
+import { BaseSchedule } from './Schedule';
+/**
+ * Defines an Extended Layout - provides a Layout and all objects that refer to it
+ */
+export interface ExtendedLayout {
+    /**
+     * Layout being extended
+     */
+    Layout: Layout;
+    /**
+     * Object to be included in the Layout
+     */
+    Extensions: LayoutExtension[];
+}
+/**
+ * Defines an object being extended in a Layout
+ */
+export interface LayoutExtension {
+    /**
+     * Module to which Extended Object belongs
+     */
+    Module: LayoutExtensionModule;
+    /**
+     * Object being Extended
+     */
+    Object: LayoutExtensionObject;
+}
+/**
+ * Types of Adaptable Objects that can added to Extended Layouts
+ */
+export type LayoutExtensionObject = AlertDefinition | CustomSort | FlashingCellDefinition | FormatColumn | PlusMinusNudge | StyledColumn | Shortcut | BaseSchedule;
+/**
+ * Modules which can provide objects in Extended Layouts
+ */
+export type LayoutExtensionModule = 'Alert' | 'CustomSort' | 'FlashingCell' | 'FormatColumn' | 'FreeTextColumn' | 'PlusMinus' | 'Schedule' | 'Shortcut' | 'StyledColumn';
+/**
+ * Configuration for API methods which load objects that can be Layout extensions
+ */
+export interface LayoutExtendedConfig {
+    includeLayoutNotExtendedObjects?: boolean;
+    extendedLayoutName?: string;
+}