@adaptabletools/adaptable 22.0.0-canary.1 → 22.0.0-canary.10

package/src/AdaptableOptions/ContainerOptions.d.ts

@@ -1,40 +1,80 @@
+import type { BaseContext } from '../AdaptableState/Common/BaseContext';
+/**
+ * CSS Selector used to target elements by CSS selectors (e.g. class, attribute, etc.) rather than elementID
+ */
+export interface AdaptableCSSSelector {
+    /**
+     * CSS Selector that locates DOM element
+     */
+    selector: string;
+}
+/**
+ * A resolved (non-function) container reference
+ *
+ * - `string` — an element ID (resolved via `document.getElementById`)
+ * - `AdaptableCSSSelector` — a CSS selector (resolved via `document.querySelector`)
+ * - `HTMLElement` — a direct reference to a DOM element
+ */
+export type AdaptableContainerValue = string | AdaptableCSSSelector | HTMLElement;
+/**
+ * Context available to `adaptableContainer` and `agGridContainer` function callbacks (resolve **before** AdapTable initialises, so `adaptableApi` not available)
+ */
+export interface InitContainerContext {
+    /**
+     * Id of current AdapTable instance
+     */
+    adaptableId: string;
+    /**
+     * Current Adaptable State Key
+     */
+    adaptableStateKey: string;
+    /**
+     * Custom application Context provided in `AdaptableOptions.adaptableContext`
+     */
+    adaptableContext: any;
+}
+/**
+ * Context available to `modalContainer`, `systemStatusContainer`, `alertContainer` and `transposedViewContainer` function callbacks
+ */
+export type ContainerContext = BaseContext;
 /**
  * Options for managing the different div elements required by AdapTable
  */
 export interface ContainerOptions {
     /**
-     * Div containing AdapTable; string Id or HTMLElement
-     *
+     * Div containing AdapTable; element Id, CSS Selector, HTMLElement, or function returning one of these
      * @defaultValue "adaptable"
      * @gridInfoItem
      */
-    adaptableContainer?: string | HTMLElement;
+    adaptableContainer?: AdaptableContainerValue | ((context: InitContainerContext) => AdaptableContainerValue);
     /**
-     * Div containing AG Grid instance; string Id or HTMLElement
-     *
+     * Div containing AG Grid instance; element Id, CSS Selector, HTMLElement, or function returning one of these.
      * @defaultValue "grid"
      * @gridInfoItem
      */
-    agGridContainer?: string | HTMLElement;
+    agGridContainer?: AdaptableContainerValue | ((context: InitContainerContext) => AdaptableContainerValue);
     /**
-     * Name of div where popups appear
-     *
+     * Name of div where popups appear;element Id, CSS Selector, HTMLElement, or function returning one of these
      * @defaultValue undefined (centre of screen)
      * @gridInfoItem
      */
-    modalContainer?: string | HTMLElement;
+    modalContainer?: AdaptableContainerValue | ((context: ContainerContext) => AdaptableContainerValue);
     /**
-     * Div to show System Status messages; string Id or HTMLElement
-     *
+     * Div to show System Status Messages; elementId, CSS Selector, HTMLElement, or function returning one of these
      * @defaultValue undefined
      * @gridInfoItem
      */
-    systemStatusContainer?: string | HTMLElement;
+    systemStatusContainer?: AdaptableContainerValue | ((context: ContainerContext) => AdaptableContainerValue);
     /**
-     * Div to display Alert messages; string Id or HTMLElement
-     *
+     * Div to display Alerts; elementId, CSS Selector, HTMLElement, or function returning one of these
      * @defaultValue undefined
      * @gridInfoItem
      */
-    alertContainer?: string | HTMLElement;
+    alertContainer?: AdaptableContainerValue | ((context: ContainerContext) => AdaptableContainerValue);
+    /**
+     * Div to render a Transposed View; elementId, CSS Selector, HTMLElement, or function returning one of these
+     * @defaultValue undefined (rendered in a draggable popup window)
+     * @gridInfoItem
+     */
+    transposedViewContainer?: AdaptableContainerValue | ((context: ContainerContext) => AdaptableContainerValue);
 }

package/src/AdaptableOptions/CustomSortOptions.d.ts

@@ -13,6 +13,10 @@ export interface CustomSortOptions<TData = any> {
  * Comparer object for Column Values - used for custom sorting
  */
 export interface ColumnValuesComparer<TData = any> {
+    /**
+     * Name of the CustomSort Comparer
+     */
+    name: string;
     /**
      * Column for which to compare values
      */

package/src/AdaptableOptions/DashboardOptions.d.ts

@@ -1,5 +1,4 @@
 import { AdaptableButton } from '../AdaptableState/Common/AdaptableButton';
-import { AdaptableObject } from '../AdaptableState/Common/AdaptableObject';
 import { DashboardState } from '../AdaptableState/DashboardState';
 import { BaseContext, CustomRenderContext } from '../types';
 import { AdaptableFrameworkComponent } from '../agGrid/AdaptableFrameworkComponent';
@@ -41,7 +40,7 @@ export interface DashboardOptions {
 /**
  * Custom Toolbar (which AdapTable will manage) enabling devs to populate Dashboard with bepoke content
  */
-export interface CustomToolbar extends AdaptableObject {
+export interface CustomToolbar {
     /**
      * How Toolbar is referenced (e.g. in Dashboard Popup when managing toolbars)
      */

package/src/AdaptableOptions/ExportOptions.d.ts

@@ -363,8 +363,7 @@ export interface DataFormatDataType {
     date?: DataFormatType;
 }
 /**
- * Custom Export Parameters which extend AG Grid's base export parameters, allowing overriding of AdapTable's default export behaviour.
- * Use `ExcelExportParams` for Excel format exports and `CsvExportParams` for CSV, JSON and any custom format exports
+ * Custom Export Params extending AG Grid's base export params; allows overriding AdapTable default export
  */
 export type CustomExportParams = ExcelExportParams | CsvExportParams;
 /**

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -174,6 +174,9 @@ export interface IsRowFilterableContext<TData = any> extends BaseContext {
      */
     data: TData;
 }
+/**
+ * AdapTable's Filter components: FilterBar or FilterForm
+ */
 export type AdaptableFilterComponentLocation = 'FilterBar' | 'FilterForm';
 /**
  * Context used for setting default Predicates for Column Filters

package/src/AdaptableOptions/ToolPanelOptions.d.ts

@@ -1,4 +1,3 @@
-import { AdaptableObject } from '../AdaptableState/Common/AdaptableObject';
 import { AdaptableFrameworkComponent } from '../agGrid/AdaptableFrameworkComponent';
 import { AdaptableButton } from '../AdaptableState/Common/AdaptableButton';
 import { ToolPanelState } from '../AdaptableState/ToolPanelState';
@@ -27,7 +26,7 @@ export interface ToolPanelOptions {
 /**
  * Defines a Custom ToolPanel - provided by Users and contains custom content
  */
-export interface CustomToolPanel extends AdaptableObject {
+export interface CustomToolPanel {
     /**
      * Name of Custom ToolPanel - should be unique
      */

package/src/AdaptableState/AdaptableState.d.ts

@@ -24,6 +24,7 @@ import { StyledColumnState } from './StyledColumnState';
 import { NoteState } from './NoteState';
 import { NamedQueryState } from './NamedQueryState';
 import { CommentState } from './CommentState';
+import { UserInterfaceState } from './UserInterfaceState';
 /**
  * The main state object of Adaptable
  */
@@ -56,6 +57,7 @@ export interface AdaptablePersistentState {
     TeamSharing: TeamSharingState;
     Theme: ThemeState;
     ToolPanel: ToolPanelState;
+    UserInterface: UserInterfaceState;
 }
 /**
  * The state which is available in the internal Redux store but never persisted

package/src/AdaptableState/AlertState.d.ts

@@ -5,12 +5,11 @@ import { TypeHint } from './Common/Types';
 import { AdaptableMessageType } from './Common/AdaptableMessageType';
 import { AdaptableForm } from './Common/AdaptableForm';
 import { AdaptableButton } from './Common/AdaptableButton';
-import { SuspendableObject } from './Common/SuspendableObject';
 import { AdaptableStyle } from './Common/AdaptableStyle';
 import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { AdaptableAggregatedBooleanQuery, AdaptableBooleanQuery, AdaptableObservableQuery } from './Common/AdaptableQuery';
 import { ButtonStyle } from './Common/ButtonStyle';
-import { AlertFormContext, BaseContext, NotificationsOptions } from '../types';
+import { AlertFormContext, BaseContext, NotificationsOptions, SuspendableObject } from '../types';
 /**
  * Adaptable State section for Alert Module
  */
@@ -24,6 +23,10 @@ export interface AlertState extends BaseState {
  * The Alert Definition object used in the Alert function
  */
 export interface AlertDefinition extends SuspendableObject {
+    /**
+     * Name of the Alert Definition
+     */
+    Name: string;
     /**
      * Where Alert can be triggered: one, some or all columns or DataTypes
      */

package/src/AdaptableState/ChartingState.d.ts

@@ -9,7 +9,7 @@ export declare const isAgChartDefinition: (chartDefinition: ChartDefinition | Ex
  */
 export interface ExternalChartDefinition<T = unknown> extends AdaptableObject {
     /**
-     * The name needs to be unique.
+     * Name of the external chart
      */
     Name: string;
     /**
@@ -27,7 +27,7 @@ export interface ExternalChartDefinition<T = unknown> extends AdaptableObject {
  */
 export interface ChartDefinition extends AdaptableObject {
     /**
-     * Name of the Chart
+     * Name of the chart definition
      */
     Name: string;
     /**

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

@@ -1,4 +1,4 @@
-import { AdaptableObject } from './AdaptableObject';
+import { Identifiable } from './AdaptableObject';
 import { CellDataChangedInfo } from './CellDataChangedInfo';
 import { AlertDefinition } from '../AlertState';
 import { RowDataChangedInfo } from './RowDataChangedInfo';
@@ -36,7 +36,7 @@ export interface AdaptableRowChangedAlert<TData = any> extends AdaptableAlertBas
 /**
  * Defines the base(common) properties of an Alert fired by AdapTable, regardless of the type of change
  */
-export interface AdaptableAlertBase<T> extends AdaptableObject {
+export interface AdaptableAlertBase<T> extends Identifiable {
     /**
      * The type of Alert
      */

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

@@ -1,11 +1,11 @@
 import { ButtonStyle } from './ButtonStyle';
-import { AdaptableObject } from './AdaptableObject';
+import { Identifiable } from './AdaptableObject';
 import { AdaptableIcon } from './AdaptableIcon';
 import { BaseContext } from '../../types';
 /**
  * Defines a Button that appears in numerous places including Adaptable Form
  */
-export interface AdaptableButton<CONTEXT_TYPE extends BaseContext> extends AdaptableObject {
+export interface AdaptableButton<CONTEXT_TYPE extends BaseContext> extends Identifiable {
     /**
      * Label for Button - can be string or function that provides string
      */

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

@@ -9,17 +9,17 @@ export type AdaptableColumnDataType = 'text' | 'number' | 'boolean' | 'date' | '
 /**
  * Column Types recognised by AdapTable; to be set in GridOptions
  */
-export type AdaptableColumnType = 'hiddenColumn' | 'calculatedColumn' | 'freeTextColumn' | 'actionColumn' | 'fdc3Column' | 'pivotAnyTotal' | 'pivotGrandTotal' | 'pivotColumnTotal' | 'pivotAggregationTotal';
-export declare const HIDDEN_COLUMN_TYPE: AdaptableColumnType;
+export type AdaptableColumnTypeName = 'hiddenColumn' | 'calculatedColumn' | 'freeTextColumn' | 'actionColumn' | 'fdc3Column' | 'pivotAnyTotal' | 'pivotGrandTotal' | 'pivotColumnTotal' | 'pivotAggregationTotal';
+export declare const HIDDEN_COLUMN_TYPE: AdaptableColumnTypeName;
 export declare const hiddenColDefConfig: ColDef;
-export declare const CALCULATED_COLUMN_TYPE: AdaptableColumnType;
-export declare const FREE_TEXT_COLUMN_TYPE: AdaptableColumnType;
-export declare const ACTION_COLUMN_TYPE: AdaptableColumnType;
-export declare const FDC3_COLUMN_TYPE: AdaptableColumnType;
-export declare const PIVOT_ANY_TOTAL_COLUMN_TYPE: AdaptableColumnType;
-export declare const PIVOT_GRAND_TOTAL_COLUMN_TYPE: AdaptableColumnType;
-export declare const PIVOT_COLUMN_TOTAL_COLUMN_TYPE: AdaptableColumnType;
-export declare const PIVOT_AGGREGATION_TOTAL_COLUMN_TYPE: AdaptableColumnType;
+export declare const CALCULATED_COLUMN_TYPE: AdaptableColumnTypeName;
+export declare const FREE_TEXT_COLUMN_TYPE: AdaptableColumnTypeName;
+export declare const ACTION_COLUMN_TYPE: AdaptableColumnTypeName;
+export declare const FDC3_COLUMN_TYPE: AdaptableColumnTypeName;
+export declare const PIVOT_ANY_TOTAL_COLUMN_TYPE: AdaptableColumnTypeName;
+export declare const PIVOT_GRAND_TOTAL_COLUMN_TYPE: AdaptableColumnTypeName;
+export declare const PIVOT_COLUMN_TOTAL_COLUMN_TYPE: AdaptableColumnTypeName;
+export declare const PIVOT_AGGREGATION_TOTAL_COLUMN_TYPE: AdaptableColumnTypeName;
 export declare function getColumnTypeFriendlyName(columnType: string): string;
 /**
  * Base class for AdapTable Column containing most important properties
@@ -204,6 +204,9 @@ export interface AdaptableColumn<TData = any> extends AdaptableColumnBase {
      */
     isPivotTotalColumn: boolean;
 }
+/**
+ * Key properties of a Column (used in Layout Editor)
+ */
 export interface AdaptableColumnProperties {
     sortable: boolean;
     filterable: boolean;
@@ -212,6 +215,9 @@ export interface AdaptableColumnProperties {
     pivotable: boolean;
     aggregatable: boolean;
 }
+/**
+ * Summary of a Column including filters and all unique values
+ */
 export interface AdaptableColumnSummary {
     column: AdaptableColumn;
     columnFilter: ColumnFilter;

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

@@ -9,3 +9,12 @@ export interface AdaptableColumnContext<TData = any> extends BaseContext {
      */
     column: AdaptableColumn<TData>;
 }
+/**
+ * Context provided for callbacks involving multiple Columns
+ */
+export interface AdaptableColumnsContext<TData = any> extends BaseContext {
+    /**
+     * All Columns
+     */
+    columns: AdaptableColumn<TData>[];
+}

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

@@ -1,10 +1,10 @@
-import { AdaptableObject } from './AdaptableObject';
+import { Identifiable } from './AdaptableObject';
 import { CellDataChangedInfo } from '../../types';
 import { FlashingCellDefinition } from '../../../types';
 /**
  * Defines an Alert fired by AdapTable
  */
-export interface AdaptableFlashingCell extends AdaptableObject {
+export interface AdaptableFlashingCell extends Identifiable {
     /**
      * Rule that caused the FlashingCell to fire
      */

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

@@ -5,13 +5,18 @@ import { ColumnScope } from './ColumnScope';
  */
 export type AdaptableVersion = `${string}.${string}.${string}`;
 /**
- * Base interface which all other Adaptable State-related objects extend
+ * Interface for objects that can be uniquely identified by a UUID
  */
-export interface AdaptableObject {
+export interface Identifiable {
     /**
      * Unique identifier for the Object, generated and used internally by AdapTable
      */
     Uuid?: TypeUuid;
+}
+/**
+ * Base interface which all other Adaptable State-related objects extend
+ */
+export interface AdaptableObject extends Identifiable {
     /**
      * Source of state object: 'InitialState' if provided via `AdaptableOptions.initialState`, 'User' or undefined for runtime state
      */
@@ -22,6 +27,8 @@ export interface AdaptableObject {
     AdaptableVersion?: AdaptableVersion;
     /**
      * Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')
+     *
+     * @inheritedDoc
      */
     IsReadOnly?: boolean;
     /**
@@ -57,3 +64,14 @@ export interface AdaptableObjectLookupCriteria {
 export interface AdaptableObjectWithScope extends AdaptableObject {
     Scope: ColumnScope;
 }
+/**
+ * Interface that extends Adaptable Object for those config items that can be suspended at run-time
+ */
+export interface SuspendableObject extends AdaptableObject {
+    /**
+     * Suspends (i.e. turns off) an Adaptable Object
+     *
+     * @inheritedDoc
+     */
+    IsSuspended?: boolean;
+}

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

@@ -0,0 +1,11 @@
+import type { IRowNode } from 'ag-grid-enterprise';
+import { BaseContext } from './BaseContext';
+/**
+ * Context provided for per Row callbacks
+ */
+export interface AdaptableRowContext<TData = any> extends BaseContext {
+    /**
+     * The current Row
+     */
+    rowNode: IRowNode<TData>;
+}

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

@@ -38,4 +38,12 @@ export interface AdaptableStyle {
      * Existing CSS Class; use instead of setting other object properties
      */
     ClassName?: string;
+    /**
+     * Align to `Left`, `Right` or `Center`
+     */
+    Alignment?: Alignment;
 }
+/**
+ * Behaviour for aligning Cell contents
+ */
+export type Alignment = 'Left' | 'Right' | 'Center' | 'Default';

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

@@ -17,6 +17,8 @@ export interface BaseContext {
     adaptableId: string;
     /**
      * Custom application Context provided in `AdaptableOptions.adaptableContext`
+     *
+     * @inheritedDoc
      */
     adaptableContext: any;
     /**

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

@@ -0,0 +1,18 @@
+import { AdaptableStyle } from '../../../types';
+/**
+ * Defines how a given Column in AdapTable should be highlighted
+ */
+export interface ColumnHighlightInfo {
+    /**
+     * Id of Column being highlighted
+     */
+    columnId: string;
+    /**
+     * Time after which Column should be unhighlighted
+     */
+    timeout?: number;
+    /**
+     * Adaptable Style to use in the Column Highlight
+     */
+    highlightStyle: AdaptableStyle;
+}

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

@@ -19,3 +19,20 @@ export interface DataUpdateConfig {
      */
     addIndex?: number;
 }
+/**
+ * Config object using for passing in rows to manageGridData function
+ */
+export interface DataRowConfig {
+    /**
+     * Rows to add
+     */
+    addRows?: any[];
+    /**
+     * Rows to update
+     */
+    updateRows?: any[];
+    /**
+     * Rows to delete
+     */
+    deleteRows?: any[];
+}

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

@@ -0,0 +1,10 @@
+import { AdaptableObject } from './AdaptableObject';
+/**
+ * Interface that extends Adaptable Object for those config items that have a Name
+ */
+export interface NamedObject extends AdaptableObject {
+    /**
+     * Name of the Adaptable Object
+     */
+    Name: string;
+}

package/src/AdaptableState/Common/NamedObject.js

@@ -0,0 +1 @@
+export {};

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

@@ -3,6 +3,9 @@ import { IRowNode } from 'ag-grid-enterprise';
  * What row action triggered the Row Change: 'Add', 'Update', 'Delete' or 'Load'
  */
 export type RowDataChangeTrigger = 'Add' | 'Update' | 'Delete' | 'Load';
+/**
+ * Info for RowDataChangedEvent, which rows changed and why
+ */
 export interface RowDataChangedInfo<TData = any> {
     /**
      * Timestamp of change occurrence (in milliseconds)

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

@@ -1,5 +1,5 @@
-import { SuspendableObject } from './SuspendableObject';
 import { TypeHint } from './Types';
+import { SuspendableObject } from './SuspendableObject';
 export declare const ROW_SUMMARY_ROW_ID = "__ROW_SUMMARY_ROW_ID";
 export declare const WEIGHTED_AVERAGE_AGGREGATED_FUNCTION = "WEIGHTED_AVERAGE";
 export declare const summarySupportedExpressions: readonly ["MIN", "MAX", "SUM", "AVG", "COUNT", "MEDIAN", "MODE", "DISTINCT", "ONLY", "STD_DEVIATION", "WEIGHTED_AVERAGE"];

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

@@ -1,9 +1,8 @@
-import { AdaptableObject } from './AdaptableObject';
-import { SuspendableObject } from './SuspendableObject';
+import { AdaptableObject, SuspendableObject } from '../../types';
 /**
  * Defines when an action will be run - either one-off or recurring
  */
-export interface Schedule extends AdaptableObject {
+export interface Schedule {
     /**
      * Hour the Schedule will run
      */
@@ -22,9 +21,13 @@ export interface Schedule extends AdaptableObject {
     DaysOfWeek?: Weekdays;
 }
 /**
- * Base Schedule object - typically overriden by Functions
+ * Base Schedule object
  */
-export interface BaseSchedule extends SuspendableObject {
+export interface BaseSchedule extends AdaptableObject, SuspendableObject {
+    /**
+     * Name of the Schedule
+     */
+    Name: string;
     /**
      * The Schedule to run
      */

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

@@ -1,9 +1,9 @@
 import { AdaptableMessageType } from './AdaptableMessageType';
-import { AdaptableObject } from '../../types';
+import { Identifiable } from '../../types';
 /**
  * Wraps a System Status Message
  */
-export interface SystemStatusMessageInfo extends AdaptableObject {
+export interface SystemStatusMessageInfo extends Identifiable {
     /**
      * The Message to be displayed
      */

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

@@ -1,9 +1,11 @@
+import type { AdaptableColumnsContext } from '../../types';
+import type { TypeHint } from './Types';
 /**
  * Config used when transposing a Grid
  */
 export interface TransposeConfig {
     /**
-     * Column to use to do transposition
+     * Column to use to do Transposition
      * @defaultValue Primary Key Column
      */
     transposedColumnId?: string;
@@ -13,18 +15,18 @@ export interface TransposeConfig {
      */
     hideTransposedColumn?: boolean;
     /**
-     * Only show curerntly visible Columns
-     * @defaultValue false
+     * Autosize columns in Transposed View
+     * @defaultValue true
      */
-    visibleColumns?: boolean;
+    autosize?: boolean;
     /**
-     * Only show curerntly visible Rows
-     * @defaultValue false
+     * Ids of Columns to Transpose
+     * @defaultValue all Grid Columns
      */
-    visibleRows?: boolean;
+    columnsToTranspose?: string[] | ((context: AdaptableColumnsContext) => string[]);
     /**
-     * Autosize columns in transposed view
-     * @defaultValue true
+     * Rows to Transpose: All, Visible or via Expression
+     * @defaultValue All
      */
-    autosize?: boolean;
+    rowsToTranspose?: TypeHint<string, 'VisibleOnly' | 'All'>;
 }

package/src/AdaptableState/CustomSortState.d.ts

@@ -1,5 +1,5 @@
 import { BaseState } from './BaseState';
-import { SuspendableObject } from './Common/SuspendableObject';
+import { SuspendableObject } from '../types';
 /**
  * Adaptable State Section for Custom Sort Module
  */
@@ -13,6 +13,10 @@ export interface CustomSortState extends BaseState {
  * Custom Sort object used in Custom Sort function.
  */
 export interface CustomSort extends SuspendableObject {
+    /**
+     * Name of the Custom Sort definition
+     */
+    Name: string;
     /**
      * Id of Column on which Custom Sort will be applied
      */

package/src/AdaptableState/DashboardState.d.ts

@@ -58,7 +58,7 @@ export interface DashboardState extends BaseState {
  */
 export interface DashboardTab extends AdaptableObject {
     /**
-     * Name of the tab - as appears in the Dashboard
+     * Name of the Dashboard Tab as it appears in the Dashboard header
      */
     Name: string;
     /**

package/src/AdaptableState/ExportState.d.ts

@@ -28,7 +28,7 @@ export interface ExportState extends BaseState {
  */
 export interface Report extends AdaptableObject {
     /**
-     * Name of Report
+     * Name of the Report as displayed in the Export toolbar and tool panel
      */
     Name: ReportNameType;
     /**

package/src/AdaptableState/FlashingCellState.d.ts

@@ -4,7 +4,7 @@ import { AdaptableColumnPredicate, ColumnScope } from '../types';
 import { XOR } from '../Utilities/Extensions/TypeExtensions';
 import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
 import { TypeHint } from './Common/Types';
-import { SuspendableObject } from '../../types';
+import { AdaptableObject, SuspendableObject } from '../../types';
 /**
  * Adaptable State Section for Flashing Cell module
  */
@@ -33,7 +33,11 @@ export type FlashTargetTypes = 'row' | 'cell' | 'aggFuncCell';
 /**
  * The Flashing Cell Definition
  */
-export interface FlashingCellDefinition extends SuspendableObject {
+export interface FlashingCellDefinition extends AdaptableObject, SuspendableObject {
+    /**
+     * Name of the Flashing Cell Definition
+     */
+    Name: string;
     /**
      * Which Columns, DataTypes or Column Types can Flash
      */