@adaptabletools/adaptable 21.2.2-canary.0 → 21.2.2

package/src/metamodel/adaptable.metamodel.js

@@ -1 +1 @@
-export const ADAPTABLE_METAMODEL={AccessLevel:{name:"AccessLevel",kind:"A",desc:"Whether an Entitlement is `ReadOnly`, `Hidden` or `Full`"},ActionButtonCommand:{name:"ActionButtonCommand",kind:"A",desc:"Commands to assign to Action Buttons that open Row Forms: 'create', 'clone', 'edit' or 'delete'"},ActionColumn:{name:"ActionColumn",kind:"I",desc:"A Special Column that wraps an AdapTable Button",props:[{name:"actionColumnButton",kind:"u",desc:"Button (or list of buttons) to display in the Column"},{name:"actionColumnSettings",kind:"R",desc:"Optional properties to configure the Column (e.g. filterable, resizable)",isOpt:!0,ref:"ActionColumnSettings"},{name:"columnId",kind:"s",desc:"Mandatory 'Id'; if no value set for `FriendlyName`, this will also be Column name"},{name:"friendlyName",kind:"s",desc:"How Column appears in Column Header, Menus; if no value set, `ColumnId` is used",isOpt:!0},{name:"rowScope",kind:"R",desc:"Which types of Rows should contain buttons (i.e. data, grouped, summary)",isOpt:!0,ref:"RowScope"}]},ActionColumnButton:{name:"ActionColumnButton",kind:"I",desc:"Button that is displayed inside an Action Column",props:[{name:"command",kind:"R",desc:"Command to assign to Action Column Button that displays a Row Form",isOpt:!0,ref:"ActionButtonCommand"}]},ActionColumnContext:{name:"ActionColumnContext",kind:"I",desc:"Context required by functions when using an Action Column Button",props:[{name:"actionColumn",kind:"u",desc:"Action Column in question"},{name:"data",kind:"u",desc:"The current row's data"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key Value in current row"},{name:"rowNode",kind:"u",desc:"Current AG Grid Row Node"}]},ActionColumnDefaultConfiguration:{name:"ActionColumnDefaultConfiguration",kind:"I",desc:"Default configuration to use for an FDC3 Action Column",props:[{name:"columnId",kind:"s",desc:"Column Id",isOpt:!0,defVal:"'fdc3ActionColumn'"},{name:"headerName",kind:"s",desc:"Column Header",isOpt:!0,defVal:"'FDC3 Actions'"},{name:"movable",kind:"b",desc:"If Column is movable",isOpt:!0,defVal:"true"},{name:"resizable",kind:"b",desc:"If Column is resizable",isOpt:!0,defVal:"true"},{name:"rowScope",kind:"R",desc:"Which rows button appears in",isOpt:!0,defVal:"data rows only",ref:"RowScope"},{name:"width",kind:"n",desc:"Column Width in pixels",isOpt:!0,defVal:"200"}]},ActionColumnOptions:{name:"ActionColumnOptions",kind:"I",desc:"Options related to Action Columns in AdapTable",props:[{name:"actionColumns",kind:"u",desc:"Columns which contain an AdapTable Button - used for performing Actions",isOpt:!0,defVal:"undefined"}]},ActionColumnSettings:{name:"ActionColumnSettings",kind:"I",desc:"Set of optional properties that define an Action Columns behaviour",props:[{name:"resizable",kind:"b",desc:"Whether Column can be resized (by dragging column header edges)",isOpt:!0,defVal:"true"},{name:"suppressMenu",kind:"b",desc:"Whether no menu should be shown for this Column header.",isOpt:!0,defVal:"false"},{name:"suppressMovable",kind:"b",desc:"Whether if this Column should be movable via dragging",isOpt:!0,defVal:"false"},{name:"width",kind:"n",desc:"Preferred width (in pixels) for Column; if unset, calculated dynamically by AG Grid",isOpt:!0}]},AdaptableAggregatedBooleanQuery:{name:"AdaptableAggregatedBooleanQuery",kind:"I",desc:"Wraps an AdapTableQL Aggregated Boolean Expression",props:[{name:"AggregatedBooleanExpression",kind:"s",desc:"AdapTableQL Expression that returns true / false based on multiple rows"}]},AdaptableAggregatedScalarQuery:{name:"AdaptableAggregatedScalarQuery",kind:"I",desc:"Wraps an AdapTableQL Aggregated Scalar Expression",props:[{name:"AggregatedScalarExpression",kind:"s",desc:"AdapTableQL Expression that returns any value based on multiple rows"}]},AdaptableAlert:{name:"AdaptableAlert",kind:"A",desc:"Defines an Alert fired by AdapTable"},AdaptableAlertBase:{name:"AdaptableAlertBase",kind:"I",desc:"Defines the base(common) properties of an Alert fired by AdapTable, regardless of the type of change",props:[{name:"alertDefinition",kind:"R",desc:"Rule that caused Alert to fire",ref:"AlertDefinition"},{name:"alertType",kind:"u",desc:"The type of Alert"},{name:"header",kind:"s",desc:"Alert Header text"},{name:"message",kind:"s",desc:"Alert Body text"}]},AdaptableAlertCommand:{name:"AdaptableAlertCommand",kind:"A",desc:"Commands available in an Alert"},AdaptableAlertQuery:{name:"AdaptableAlertQuery",kind:"A",desc:"Alert Query which may be either a Boolean, Observable or AggregatedBoolean Expression"},AdaptableAlertType:{name:"AdaptableAlertType",kind:"A",desc:"Type of AdapTable Alert: generic, cellChange or rowChange"},AdaptableBaseIcon:{name:"AdaptableBaseIcon",kind:"I",desc:"Base interface for AdaptableIcon",props:[{name:"className",kind:"s",desc:"The class name of the icon",isOpt:!0},{name:"style",kind:"R",desc:"CSS Properties",isOpt:!0,ref:"unknown"}]},AdaptableBooleanQuery:{name:"AdaptableBooleanQuery",kind:"I",desc:"Wraps an AdapTableQL Boolean Expression",props:[{name:"BooleanExpression",kind:"s",desc:"AdapTableQL Expression that returns true / false"}]},AdaptableButton:{name:"AdaptableButton",kind:"I",desc:"Defines a Button that appears in numerous places including Adaptable Form",props:[{name:"buttonStyle",kind:"u",desc:"Style for Button - can be object or function that provides a `ButtonStyle` object",isOpt:!0},{name:"disabled",kind:"u",desc:"Function that disables / enables the button based on its evaluation result",isOpt:!0},{name:"hidden",kind:"u",desc:"Function which sets whether Button is hidden",isOpt:!0},{name:"icon",kind:"u",desc:"Icon for Button - can be object or function that provides a `AdaptableIcon` object",isOpt:!0},{name:"label",kind:"u",desc:"Label for Button - can be string or function that provides string",isOpt:!0},{name:"onClick",kind:"u",desc:"Function to invoke when button is clicked",isOpt:!0},{name:"tooltip",kind:"u",desc:"Tooltip for Button - can be string or function that provides string",isOpt:!0}]},AdaptableCalculatedColumnQuery:{name:"AdaptableCalculatedColumnQuery",kind:"A",desc:"Calculated Column Query which may be a Scalar or an AggregatedScalar Expression"},AdaptableCellChangedAlert:{name:"AdaptableCellChangedAlert",kind:"I",desc:"Defines an Alert fired by AdapTable when a cell is changed",props:[{name:"cellDataChangedInfo",kind:"u",desc:"Cell DataChange which triggered Alert"}]},AdaptableClearStateFunction:{name:"AdaptableClearStateFunction",kind:"I",desc:"Function that clears persisted state from the storage system. Only invoked during `StateApi.reloadInitialState()` operations."},AdaptableColumn:{name:"AdaptableColumn",kind:"I",desc:"Defines an AdapTable Column - created at run-time based on AG Grid ColDef",props:[{name:"aggregatable",kind:"b",desc:"Is Column able to display aggregations (e.g. 'sum') when grouped"},{name:"aggregationFunction",kind:"s",desc:"Custom Aggregation function for the Column",isOpt:!0},{name:"alwaysHidden",kind:"b",desc:"Whether the Column is always hidden in the UI but still available programmatically"},{name:"availableAggregationFunctions",kind:"a",desc:"Available Aggregations for the Column",isOpt:!0},{name:"columnGroup",kind:"R",desc:"The parent Column group (if Column belongs to one)",isOpt:!0,ref:"AdaptableColumnGroup"},{name:"exportable",kind:"b",desc:"Whether the Column can be included in Reports"},{name:"field",kind:"u",desc:"Field in the row to get cell data from",isOpt:!0},{name:"fieldOnly",kind:"b",desc:"Is the Column ONLY available as a field and never visible"},{name:"filterable",kind:"b",desc:"Is Column able to be filtered"},{name:"flex",kind:"n",desc:"Flex details of the Column",isOpt:!0},{name:"groupable",kind:"b",desc:"Can Column form a Row Group"},{name:"hideable",kind:"b",desc:"Can Column be removed from the grid"},{name:"isActionColumn",kind:"b",desc:"Is Column an Action Column"},{name:"isCalculatedColumn",kind:"b",desc:"Is Column a Calculated Column"},{name:"isFixed",kind:"b",desc:"Is Column pinned or locked into position"},{name:"isFreeTextColumn",kind:"b",desc:"Is Column a Free Text Column"},{name:"isGeneratedPivotResultColumn",kind:"b",desc:"Is Column a generated Pivot Result Column"},{name:"isGeneratedRowGroupColumn",kind:"b",desc:"Is Column a generated Row Group Column"},{name:"isGeneratedSelectionColumn",kind:"b",desc:"Is Column a generated Selection Column"},{name:"isGrouped",kind:"b",desc:"Is Column currently Row-Grouped"},{name:"isPivotTotalColumn",kind:"b",desc:"Is Column a Pivot Total Column (GrandTotal, GroupTotal, AggregationTotal)"},{name:"isPrimaryKey",kind:"b",desc:"Is this the Primary Key Column"},{name:"isSparkline",kind:"b",desc:"Is it a Sparkline Column"},{name:"isTreeColumn",kind:"b",desc:"Whether the Column is the Tree Column (in Tree View)"},{name:"moveable",kind:"b",desc:"Can Column be moved at run-time to a new position"},{name:"pinned",kind:"'left' | 'right' | false",desc:"The pinned position of the Column"},{name:"pivotable",kind:"b",desc:"Can Column be used in a Pivot Layout"},{name:"queryable",kind:"b",desc:"Can the Column be in included in Queries / Expressions"},{name:"readOnly",kind:"b",desc:"Is Column editable; returns FALSE if Column has conditional/dynamic editability, assuming some rows are editable"},{name:"resizable",kind:"b",desc:"Is Column resizable"},{name:"sortable",kind:"b",desc:"Is Column sortable"},{name:"visible",kind:"b",desc:"Is Column currently visible"},{name:"width",kind:"n",desc:"Column width",isOpt:!0}]},AdaptableColumnBase:{name:"AdaptableColumnBase",kind:"I",desc:"Base class for AdapTable Column containing most important properties",props:[{name:"columnId",kind:"s",desc:"Name of Column in AG Grid (e.g. field or colId)"},{name:"columnTypes",kind:"a",desc:"Column Types of the Column",isOpt:!0},{name:"dataType",kind:"R",desc:"DataType of the Column",ref:"AdaptableColumnDataType"},{name:"friendlyName",kind:"s",desc:"How Column is referred to in Adaptable UI; `Caption` property in AG Grid"}]},AdaptableColumnContext:{name:"AdaptableColumnContext",kind:"I",desc:"Context provided for per Column callbacks",props:[{name:"column",kind:"u",desc:"The current Column"}]},AdaptableColumnDataType:{name:"AdaptableColumnDataType",kind:"A",desc:"Defines data type of a Column; can be an AG Grid BaseCellDataType or an AdapTable array-related one"},AdaptableColumnGroup:{name:"AdaptableColumnGroup",kind:"I",desc:"Defines a Column Group",props:[{name:"allowGroupSplit",kind:"b",desc:"Whether the Group can be split"},{name:"columnGroupId",kind:"s",desc:"Id for the Column Group"},{name:"friendlyName",kind:"s",desc:"Friendly name for the Group"},{name:"groupCount",kind:"n",desc:"Number of Columns in the the Group"}]},AdaptableColumnMenuItem:{name:"AdaptableColumnMenuItem",kind:"A",desc:"Menu item used by Adaptable in Column Menus"},AdaptableColumnMenuItemName:{name:"AdaptableColumnMenuItemName",kind:"A",desc:"Name of Column Menu Item provided by AdapTable"},AdaptableColumnPredicate:{name:"AdaptableColumnPredicate",kind:"I",desc:"Restricts a Predicate to a given Column",props:[{name:"ColumnId",kind:"s",desc:"Id of Column which will be evaluated by the Predicate",isOpt:!0}]},AdaptableColumnType:{name:"AdaptableColumnType",kind:"A",desc:"Column Types recognised by AdapTable; to be set in GridOptions"},AdaptableComment:{name:"AdaptableComment",kind:"I",desc:"Comment that can be applied to a Cell in AdapTable",props:[{name:"AdaptableId",kind:"s",desc:"Id of this AdapTable instance",isOpt:!0},{name:"Author",kind:"u",desc:"Author of the Comment",isOpt:!0},{name:"Timestamp",kind:"n",desc:"When Comment was made"},{name:"Uuid",kind:"R",desc:"Unique identifier for the Comment",isOpt:!0,ref:"unknown"},{name:"Value",kind:"s",desc:"Content of the Comment"}]},AdaptableComparerFunction:{name:"AdaptableComparerFunction",kind:"A",desc:"Standard comparer function used to evaluate custom sorts, returns -1, 0, 1 as required"},AdaptableConfig:{name:"AdaptableConfig",kind:"I",desc:"Config used by No Code Plugin to set up AdapTable",props:[{name:"adaptableOptions",kind:"R",desc:"Adaptable Options object",ref:"AdaptableOptions"},{name:"gridOptions",kind:"R",desc:"AG Grid Grid Options object",ref:"unknown"}]},AdaptableContextMenuItem:{name:"AdaptableContextMenuItem",kind:"A",desc:"Menu item used by Adaptable in Context Menus"},AdaptableContextMenuItemName:{name:"AdaptableContextMenuItemName",kind:"A",desc:"Name of Context Menu Item provided by AdapTable"},AdaptableCoordinate:{name:"AdaptableCoordinate",kind:"I",desc:"Used by AdapTable to remember position of Floating Dashboard",props:[{name:"x",kind:"n",desc:"x axis number"},{name:"y",kind:"n",desc:"y axis number"}]},AdaptableCustomIcon:{name:"AdaptableCustomIcon",kind:"I",desc:"Defines an icon from an external source",props:[{name:"src",kind:"s",desc:"The URL of the icon to use"}]},AdaptableDashboardToolbar:{name:"AdaptableDashboardToolbar",kind:"A",desc:"List of all the Toolbars that Adaptable provides"},AdaptableDataChangeHistoryAction:{name:"AdaptableDataChangeHistoryAction",kind:"A",desc:"Built in `undo` or `clear` data change action"},AdaptableDateEditorParams:{name:"AdaptableDateEditorParams",kind:"I",desc:"Params used by the AdapTable Date Editor"},AdaptableElementIcon:{name:"AdaptableElementIcon",kind:"I",desc:"Defines an icon as a provided DOM element or HTML string",props:[{name:"element",kind:"u",desc:"The icon to display, either a DOM element or HTML string"}]},AdaptableField:{name:"AdaptableField",kind:"I",desc:"Used in Expressions to reference row values which are not a column definition",props:[{name:"dataType",kind:"R",desc:"Data Type of field, used to validate and show correctly in UI",ref:"AdaptableColumnDataType"},{name:"label",kind:"s",desc:"Label for field (optional - defaults to name)",isOpt:!0},{name:"name",kind:"s",desc:"Name of field in data source, e.g. 'rowId', 'parentObject.childObject.value'"}]},AdaptableFieldContext:{name:"AdaptableFieldContext",kind:"I",desc:"Context used when providing Fields programatically"},AdaptableFilterState:{name:"AdaptableFilterState",kind:"I",desc:"Current Filters in AdapTable",props:[{name:"columnFilterDefs",kind:"u",desc:"Column Filter definitions for currently applied Column Filters"},{name:"columnFilters",kind:"u",desc:"Currently applied Column Filters"},{name:"gridFilter",kind:"string | undefined",desc:"Current Grid Filter"},{name:"gridFilterAST",kind:"u",desc:"AST for Current Grid Filter"}]},AdaptableFlashingCell:{name:"AdaptableFlashingCell",kind:"I",desc:"Defines an Alert fired by AdapTable",props:[{name:"cellDataChangedInfo",kind:"R",desc:"Data change which triggered the FlashingCell",isOpt:!0,ref:"CellDataChangedInfo"},{name:"direction",kind:"'up' | 'down' | 'neutral'",desc:"Direction of the change: 'up', 'down' or 'neutral'"},{name:"flashColumnIds",kind:"u",desc:"Column Ids that are flashing"},{name:"flashingCellDefinition",kind:"R",desc:"Rule that caused the FlashingCell to fire",ref:"FlashingCellDefinition"},{name:"flashTarget",kind:"u",desc:"What will flash (e.g. Cell, Row)"},{name:"rowPrimaryKey",kind:"s",desc:"Primary Key Value of Row which is flashing"}]},AdaptableForm:{name:"AdaptableForm",kind:"I",desc:"Defines a form which appears dynamically; used by Alerts & Export Custom Destinations",props:[{name:"buttons",kind:"a",desc:"Buttons to include in the Form",isOpt:!0},{name:"description",kind:"s",desc:"Additional information to appear in the Form",isOpt:!0},{name:"fields",kind:"u",desc:"Collection of Dynamic Fields to display",isOpt:!0},{name:"title",kind:"s",desc:"Title to appear in the Form",isOpt:!0}]},AdaptableFormat:{name:"AdaptableFormat",kind:"A",desc:"Object containing formatting information for Numeric and Date Columns"},AdaptableFormData:{name:"AdaptableFormData",kind:"A",desc:"Data which appears in an AdapTable Form"},AdaptableFormField:{name:"AdaptableFormField",kind:"I",desc:"Defines a Field that appears in an Adaptable Form",props:[{name:"defaultValue",kind:"string | boolean | number",desc:"Field Default Value - can be of type string, boolean, number",isOpt:!0},{name:"fieldType",kind:"R",desc:"Field Type: text, date, number, checkbox, select, textOutput",ref:"AdaptableFormFieldType"},{name:"label",kind:"s",desc:"Label to display in the Field"},{name:"name",kind:"s",desc:"Name of the Field"},{name:"options",kind:"u",desc:"Items to populate the Select input",isOpt:!0}]},AdaptableFormFieldType:{name:"AdaptableFormFieldType",kind:"A",desc:"Types of Controls used in an AdapTable Form"},AdaptableFrameworkComponent:{name:"AdaptableFrameworkComponent",kind:"A",desc:"Base Component for Bespoke Components: can be Angular, React or Vue"},AdaptableGenericAlert:{name:"AdaptableGenericAlert",kind:"I",desc:"Defines a generic AdapTable Alert"},AdaptableIcon:{name:"AdaptableIcon",kind:"A",desc:"Defines an icon to be used in AdapTable (e.g. in Dashboard Header, Buttons, Menu, etc.)"},AdaptableLoadStateFunction:{name:"AdaptableLoadStateFunction",kind:"I",desc:"Function that retrieves Adaptable state from storage or external source. Called during initialization to hydrate the application state."},AdaptableMenuItem:{name:"AdaptableMenuItem",kind:"I",desc:"Generic Menu item used by Adaptable in Column or Context Menus",props:[{name:"category",kind:"R",desc:"Category of Adaptable Menu Item: Module, General, Group or CustomSettingsPanel",ref:"MenuCategory"},{name:"icon",kind:"R",desc:"Icon to display in Menu Item",isOpt:!0,ref:"AdaptableIcon"},{name:"isVisible",kind:"b",desc:"Whether menu item is visible"},{name:"label",kind:"s",desc:"Text that appears in the menu"},{name:"name",kind:"u",desc:"Unique name for the Menu Item"},{name:"onClick",kind:"u",desc:"Function to invoke when (custom) menu item is clicked",isOpt:!0},{name:"subItems",kind:"a",desc:"Sub Menu Items to display",isOpt:!0}]},AdaptableMessageType:{name:"AdaptableMessageType",kind:"A",desc:"Defines a Message Types: 'Success', 'Info', 'Warning' or 'Error'"},AdaptableModule:{name:"AdaptableModule",kind:"A",desc:"Modules provided by AdapTable, subject to Entitlements and usually have Initial Adaptable State"},AdaptableModuleButton:{name:"AdaptableModuleButton",kind:"A",desc:"List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button"},AdaptableNoCodeWizardOptions:{name:"AdaptableNoCodeWizardOptions",kind:"I",desc:"Adaptable Options used by the No Code Wizard"},AdaptableNote:{name:"AdaptableNote",kind:"I",desc:"Note that can be applied to a Cell in AdapTable",props:[{name:"ColumnId",kind:"s",desc:"Id of Column containing the Note"},{name:"PrimaryKeyValue",kind:"u",desc:"Value in Grid's Primary Key Column"},{name:"Text",kind:"s",desc:"Content of the Note"},{name:"Timestamp",kind:"n",desc:"When Note was made",isOpt:!0}]},AdaptableNotes:{name:"AdaptableNotes",kind:"A",desc:"Collection of Cell Notes"},AdaptableNumberCellEditorParams:{name:"AdaptableNumberCellEditorParams",kind:"I",desc:"Adaptable number editor parameters extending the AG Grid .",props:[{name:"emptyValue",kind:"s",desc:"Value to set for the cell, when the clear button is pressed",defVal:"'' (empty string)"},{name:"showClearButton",kind:"b",desc:"Whether to show the clear button. If `true`, it works together with `cellEditorParams.emptyValue`",defVal:"true"}]},AdaptableObject:{name:"AdaptableObject",kind:"I",desc:"Base interface which all other Adaptable State-related objects extend",props:[{name:"AdaptableVersion",kind:"R",desc:"Current AdapTable version",isOpt:!0,ref:"AdaptableVersion"},{name:"IsReadOnly",kind:"b",desc:"Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')",isOpt:!0},{name:"Metadata",kind:"u",desc:"Optional metadata associated with the object; can be used to store additional information or configuration",isOpt:!0},{name:"Source",kind:"'InitialState' | 'User'",desc:"Source of state object: 'InitialState' if provided via `AdaptableOptions.initialState`, 'User' or undefined for runtime state",isOpt:!0},{name:"Tags",kind:"a",desc:"List of Tags associated with the Object; often used for extending Layouts",isOpt:!0},{name:"Uuid",kind:"R",desc:"Unique identifier for the Object, generated and used internally by AdapTable",isOpt:!0,ref:"unknown"}]},AdaptableObjectLookupCriteria:{name:"AdaptableObjectLookupCriteria",kind:"I",desc:"Lookup criteria for finding specific Adaptable Objects; all given criteria will be composed with an AND operator",props:[{name:"ids",kind:"u",desc:"Technical IDs of Adaptable Objects",isOpt:!0},{name:"scope",kind:"R",desc:"ColumnScope",isOpt:!0,ref:"ColumnScope"},{name:"tag",kind:"R",desc:"AdaptableObjectTag",isOpt:!0,ref:"AdaptableObjectTag"}]},AdaptableObjectTag:{name:"AdaptableObjectTag",kind:"A",desc:"AdaptableObjectTag Object Tag - currently supporting only plain string values, but open for future extensions, if needed"},AdaptableObservableQuery:{name:"AdaptableObservableQuery",kind:"I",desc:"Wraps an AdapTableQL Observable Expression",props:[{name:"ObservableExpression",kind:"s",desc:"AdapTableQL Expression that observes the Grid or given rows"}]},AdaptableOptions:{name:"AdaptableOptions",kind:"I",desc:"Large group of options enabling developers to set up AdapTable at design time to fit precise requirements",props:[{name:"actionColumnOptions",kind:"u",desc:"Options for managing Action Columns",isOpt:!0},{name:"adaptableContext",kind:"u",desc:"Application-specific context object - is included by AdapTable in all callbacks and Events",isOpt:!0},{name:"adaptableId",kind:"s",desc:"Identifier for this instance of AdapTable",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"'adaptable_id_$random_number'"},{name:"adaptableStateKey",kind:"s",desc:"Identifier used as localStorage persistence key for AdaptableState",isOpt:!0,gridInfo:"item",defVal:"`adaptableId` value"},{name:"alertOptions",kind:"u",desc:"Options for managing Alerts in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container"},{name:"autogeneratePrimaryKey",kind:"b",desc:"Will autogenerate a Primary Key; only use as a last resort if no unique column is available, as limits some Adaptable functionalities",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"calendarOptions",kind:"R",desc:"Options for managing Holidays and Working Days",isOpt:!0,ref:"CalendarOptions"},{name:"cellSummaryOptions",kind:"u",desc:"Options for adding custom Cell Summaries",isOpt:!0},{name:"chartingOptions",kind:"R",desc:"Options for managing AG Grid's Charting",isOpt:!0,noCode:"container",ref:"ChartingOptions"},{name:"columnMenuOptions",kind:"u",desc:"Options for managing AdapTable Column Menu",isOpt:!0,gridInfo:"container"},{name:"columnOptions",kind:"R",desc:"Options related to Columns",isOpt:!0,noCode:"container",ref:"ColumnOptions"},{name:"commentOptions",kind:"u",desc:"Options for managing collaborative Comments",isOpt:!0},{name:"containerOptions",kind:"R",desc:"Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed",isOpt:!0,ref:"ContainerOptions"},{name:"contextMenuOptions",kind:"u",desc:"Options for managing AdapTable Context Menu",isOpt:!0,gridInfo:"container"},{name:"customSortOptions",kind:"R",desc:"Options for using Custom Sort",isOpt:!0,ref:"CustomSortOptions"},{name:"dashboardOptions",kind:"R",desc:"Options for managing the Dashboard in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container",ref:"DashboardOptions"},{name:"dataChangeHistoryOptions",kind:"u",desc:"Options to manage Data Change History Module which provides an overview of all data changes",isOpt:!0,gridInfo:"container",noCode:"container"},{name:"dataImportOptions",kind:"R",desc:"Options for managing the Data Import function",isOpt:!0,ref:"DataImportOptions"},{name:"dataSetOptions",kind:"u",desc:"Options to manage Data Sets",isOpt:!0},{name:"editOptions",kind:"u",desc:"Options related to Editing in AdapTable including Server Validation",isOpt:!0,gridInfo:"container"},{name:"entitlementOptions",kind:"R",desc:"Options for managing Entitlements",isOpt:!0,gridInfo:"container",ref:"EntitlementOptions"},{name:"exportOptions",kind:"u",desc:"Options for managing Exporting and Reports in AdapTable",isOpt:!0,gridInfo:"container"},{name:"expressionOptions",kind:"u",desc:"Options for managing AdapTableQL Expressions",isOpt:!0,noCode:"container"},{name:"fdc3Options",kind:"R",desc:"Options for managing FDC3 in AdapTable",isOpt:!0,ref:"Fdc3Options"},{name:"filterOptions",kind:"u",desc:"Filtering Options - both Column Filters and the Grid Filter",isOpt:!0},{name:"flashingCellOptions",kind:"R",desc:"Options for managing Flashing Cells - primarily default values",isOpt:!0,gridInfo:"container",ref:"FlashingCellOptions"},{name:"formatColumnOptions",kind:"R",desc:"Options for providing Custom Display Formats",isOpt:!0,ref:"FormatColumnOptions"},{name:"initialState",kind:"R",desc:"Initial State set at design-time and shipped with AdapTable for first use; must include at least one Layout",defVal:"undefined",ref:"InitialState"},{name:"layoutOptions",kind:"R",desc:"Options related to Layouts",isOpt:!0,gridInfo:"container",noCode:"container",ref:"LayoutOptions"},{name:"licenseKey",kind:"s",desc:"Commercial license key. If the license is not provided or is expired, various visual information notes will be displayed and some functionality may be limited.",isOpt:!0},{name:"noteOptions",kind:"R",desc:"Options for managing personal Notes",isOpt:!0,ref:"NoteOptions"},{name:"notificationsOptions",kind:"R",desc:"Options for managing Notifications in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container",ref:"NotificationsOptions"},{name:"plugins",kind:"a",desc:"Used for managing the AdapTable Plugins",isOpt:!0},{name:"predicateOptions",kind:"R",desc:"Options for managing Predicates in AdapTableQL",isOpt:!0,ref:"PredicateOptions"},{name:"primaryKey",kind:"s",desc:"Name of Column in AdapTable guaranteed to contain unique values",gridInfo:"item",defVal:"n/a (Mandatory)"},{name:"quickSearchOptions",kind:"u",desc:"Options for managing Search related functions in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container"},{name:"rowFormOptions",kind:"u",desc:"Options for managing Row Forms",isOpt:!0},{name:"settingsPanelOptions",kind:"R",desc:"Setting panel options",isOpt:!0,gridInfo:"container",noCode:"container",ref:"SettingsPanelOptions"},{name:"stateOptions",kind:"R",desc:"Options related to state hydration / dehydration - allows users to intercept state persistence and state loading and change default behaviour of saving to local storage",isOpt:!0,ref:"StateOptions"},{name:"teamSharingOptions",kind:"R",desc:"Options for managing 'Team Sharing' which allows users to create Adaptable Objects and share with colleagues",isOpt:!0,gridInfo:"container",ref:"TeamSharingOptions"},{name:"toolPanelOptions",kind:"R",desc:"Options related to managing the Tool Panel elements in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container",ref:"ToolPanelOptions"},{name:"userInterfaceOptions",kind:"u",desc:"Options for managing the User Interface elements of AdapTable, i.e. Action Columns, Color Palette etc.",isOpt:!0,gridInfo:"container"},{name:"userName",kind:"s",desc:"Name of current AdapTable user",isOpt:!0,gridInfo:"item",defVal:"'anonymous'"}]},AdaptablePercentageCellEditorParams:{name:"AdaptablePercentageCellEditorParams",kind:"I",desc:"AdapTablePercentageCellEditor parameters - extends AdaptableNumberCellEditorParams"},AdaptablePersistentState:{name:"AdaptablePersistentState",kind:"I",desc:"The state object of Adaptable which is persisted"},AdaptablePersistStateFunction:{name:"AdaptablePersistStateFunction",kind:"I",desc:"Function that handles persisting state to storage systems (localStorage, server, etc.). Called after `saveState()` to store the prepared state."},AdaptablePlugin:{name:"AdaptablePlugin",kind:"C",desc:"Base class for all AdapTable Plugins"},AdaptablePredicate:{name:"AdaptablePredicate",kind:"I",desc:"Predicate object used by AdapTableQL - essentially a boolean function",props:[{name:"Inputs",kind:"a",desc:"Optional Inputs that might be needed for evaluation",isOpt:!0},{name:"PredicateId",kind:"u",desc:"Id of Predicate (e.g. `Equals`, `GreaterThan`)"}]},AdaptablePredicateDef:{name:"AdaptablePredicateDef",kind:"I",desc:"Defines a Predicate - include where it can run and what it does",props:[{name:"columnScope",kind:"R",desc:"Columns (or DataTypes) where Predicate is active",ref:"ColumnScope"},{name:"handler",kind:"f",desc:"Actual boolean function invoked when evaluating the Predicate"},{name:"icon",kind:"u",desc:"Icon to show (primarily used in Filter dropdown)",isOpt:!0},{name:"id",kind:"u",desc:"Predicate Id"},{name:"inputs",kind:"a",desc:"Inputs the Predicate can take",isOpt:!0},{name:"label",kind:"s",desc:"Name of the Predicate"},{name:"moduleScope",kind:"a",desc:"Modules where Predicate can run"},{name:"shortcuts",kind:"a",desc:"Keyboard shortcuts to initiate predicate - used in Quick Filter bar",isOpt:!0},{name:"toString",kind:"f",desc:"String representation of the Predicate",isOpt:!0}]},AdaptableQLModule:{name:"AdaptableQLModule",kind:"A",desc:"Modules which leverage AdapTableQL; can be used to set remote evaluation"},AdaptableQuery:{name:"AdaptableQuery",kind:"A",desc:"An AdaptableQuery can be either a Boolean, Scalar, Observable, AggregatedBoolean, or AggregatedScalar expression"},AdaptableRowChangedAlert:{name:"AdaptableRowChangedAlert",kind:"I",desc:"Defines an Alert fired by AdapTable when a row is changed",props:[{name:"rowDataChangedInfo",kind:"u",desc:"Row DataChange which triggered Alert"}]},AdaptableSaveStateFunction:{name:"AdaptableSaveStateFunction",kind:"I",desc:"Function that transforms state before persistence. Called first in the persistence flow, before `persistState()`."},AdaptableScalarQuery:{name:"AdaptableScalarQuery",kind:"I",desc:"Wraps an AdapTableQL Scalar Expression",props:[{name:"ScalarExpression",kind:"s",desc:"AdapTableQL Expression that returns any value"}]},AdaptableSettingsPanel:{name:"AdaptableSettingsPanel",kind:"A",desc:"Modules which can appear in the Settings Panel"},AdaptableSharedEntity:{name:"AdaptableSharedEntity",kind:"I",desc:"Defines an AdaptableObject shared with Team Sharing",props:[{name:"ChangedAt",kind:"n",desc:"Last time when the object was changed"},{name:"ChangedBy",kind:"s",desc:"Last User who changed the object"},{name:"Description",kind:"s",desc:"Description of object being shared"},{name:"Entity",kind:"R",desc:"Actual Adaptable Object being shared",ref:"AdaptableObject"},{name:"EntityDependencyIds",kind:"a",desc:"Ids of direct entity dependencies"},{name:"EntityType",kind:"u",desc:"Type of shared entity (either Adaptable specific or custom object)"},{name:"Module",kind:"R",desc:"Adaptable Module to which object belongs",ref:"AdaptableModule"},{name:"Revision",kind:"n",desc:"Revision - incremental for 'Active', always 1 for 'Snapshot'"},{name:"Timestamp",kind:"n",desc:"When the object was shared"},{name:"Type",kind:"R",desc:"'Snapshot' (for 1-time sharing) or 'Active' (for continuous sharing)",ref:"SharedEntityType"},{name:"UserName",kind:"s",desc:"User who shared the object"}]},AdaptableSharedEntityConfig:{name:"AdaptableSharedEntityConfig",kind:"I",desc:"Describes an AdaptableObject which is being Team Shared"},AdaptableSortState:{name:"AdaptableSortState",kind:"I",desc:"Overview of current, live, sorting state in grid",props:[{name:"columnSorts",kind:"a",desc:"Columns currently being sorted (with direction)"},{name:"customSortComparers",kind:"a",desc:"Custom Sort Comparers which are currently applied"},{name:"customSorts",kind:"a",desc:"Custom Sorts which are currently applied"}]},AdaptableState:{name:"AdaptableState",kind:"I",desc:"The main state object of Adaptable"},AdaptableStateFunctionConfig:{name:"AdaptableStateFunctionConfig",kind:"I",desc:"State Function Config object passed into all State Options functions",props:[{name:"actionName",kind:"s",desc:"Name of the action that triggered the state change.",isOpt:!0},{name:"adaptableApi",kind:"R",desc:"Adaptable API",ref:"unknown"},{name:"adaptableContext",kind:"u",desc:"Custom application Context provided in `AdaptableOptions.adaptableContext`"},{name:"adaptableId",kind:"s",desc:"Id of current Adaptable instance"},{name:"adaptableStateKey",kind:"s",desc:"State Key being used"},{name:"previousState",kind:"R",desc:"Previous state before the action was applied. This is useful for comparing changes or reverting if necessary.",isOpt:!0,ref:"AdaptableState"},{name:"userName",kind:"s",desc:"current Adaptable user"}]},AdaptableStatusBar:{name:"AdaptableStatusBar",kind:"I",desc:"Defines an Adaptable Status Bar",props:[{name:"Key",kind:"s",desc:"Key of Status Bar Panel as defined in AG Grid GridOptions - ensure keys are the same (note: AG Grid statusPanel is lowercase 'key')"},{name:"StatusBarPanels",kind:"a",desc:"Module Status Panels to render inside Adaptable Status Bar",isOpt:!0}]},AdaptableStatusBarPanel:{name:"AdaptableStatusBarPanel",kind:"A",desc:"Modules which can appear in the AdapTable Status Bar"},AdaptableStyle:{name:"AdaptableStyle",kind:"I",desc:"Style object used in numerous AdapTable Modules",props:[{name:"BackColor",kind:"s",desc:"Colour background of cell: hex, rgb(a) or name",isOpt:!0},{name:"BorderColor",kind:"s",desc:"Colour of cell border: hex, rgb(a) or name",isOpt:!0},{name:"BorderRadius",kind:"n",desc:"Rounds corners of an element's outer border edge; equivalent of CSS border-radius",isOpt:!0},{name:"ClassName",kind:"s",desc:"Existing CSS Class; use instead of setting other object properties",isOpt:!0},{name:"FontSize",kind:"'XSmall' | 'Small' | 'Medium' | 'Large' | 'XLarge'",desc:"Size of font: `XSmall`, `Small`, `Medium`, `Large` or `XLarge`",isOpt:!0},{name:"FontStyle",kind:"'Normal' | 'Italic'",desc:"Style of font: `Normal` or `Italic`",isOpt:!0},{name:"FontWeight",kind:"'Normal' | 'Bold'",desc:"Weight of font: `Normal` or `Bold`",isOpt:!0},{name:"ForeColor",kind:"s",desc:"Font colour in cell: hex, rgb(a) or name",isOpt:!0},{name:"TextDecoration",kind:"'None' | 'Underline' | 'Overline' | 'LineThrough'",desc:"Decoration of font: `None`, `Underline`, `Overline` or `LineThrough`",isOpt:!0}]},AdaptableSystemColumnMenuItem:{name:"AdaptableSystemColumnMenuItem",kind:"I",desc:"System Menu Item that is provided by AdapTable",props:[{name:"menuType",kind:"u",desc:"Type of Menu - always 'Adaptable'"}]},AdaptableSystemContextMenuItem:{name:"AdaptableSystemContextMenuItem",kind:"I",desc:"System Menu Item that is provided by AdapTable",props:[{name:"menuType",kind:"u",desc:"Type of Menu - always 'Adaptable'"}]},AdaptableSystemIcon:{name:"AdaptableSystemIcon",kind:"I",desc:"Defines an icon from the System AdapTable icon set",props:[{name:"name",kind:"u",desc:"The name of the icon to use (referencing the AdapTable Icon Library)"},{name:"size",kind:"n",desc:"The size (in pixels) of the SVG icon (defaults to `17px`)",isOpt:!0}]},AdaptableSystemIconName:{name:"AdaptableSystemIconName",kind:"A",desc:"All AdapTable System Icon names"},AdaptableTheme:{name:"AdaptableTheme",kind:"I",desc:"Used for creating User (i.e. Custom) Themes",props:[{name:"AgGridClassName",kind:"s",desc:"Ag Grid theme to apply when loading theme; relevant only when using the legacy AG Grid themes",isOpt:!0},{name:"AgThemeMode",kind:"u",desc:"AG Grid theme mode to apply when this theme is selected. Valid values are `light`, `dark`, `dark-blue` or any custom theme mode defined in AG Grid. When set, adds a data-ag-theme-mode attribute to the document body.",isOpt:!0},{name:"CSSVariables",kind:"u",desc:"Variables to be applied at runtime",isOpt:!0},{name:"Description",kind:"s",desc:"Description of Theme - will appear in Theme Toolbar and Toolpanel"},{name:"Name",kind:"s",desc:"Name of the Theme"},{name:"Variant",kind:"'light' | 'dark'",desc:"Base theme variant to derive custom theme from. Use `light` to inherit from Adaptable Light Theme or `dark` for Adaptable Dark Theme. When creating custom themes, specifying a variant ensures proper inheritance of base theme styles.",isOpt:!0}]},AdaptableToolPanel:{name:"AdaptableToolPanel",kind:"A",desc:"Modules which can appear as AdapTable Tool Panels"},AdaptableToolPanelDefinition:{name:"AdaptableToolPanelDefinition",kind:"I",desc:"Defines a ToolPanel - Name and VisibilityMode (Expanded / Collapsed)",props:[{name:"Name",kind:"u",desc:"ToolPanel name - either an Adaptable Module or a Custom ToolPanel (defined in ToolPanel Options)"},{name:"VisibilityMode",kind:"'expanded' | 'collapsed'",desc:"Whether the ToolPanel is 'expanded' or 'collapsed'",isOpt:!0,defVal:"'collapsed'"}]},AdaptableVersion:{name:"AdaptableVersion",kind:"A",desc:"The current version of AdapTable being used"},AggregatedExpressionFilterRowContext:{name:"AggregatedExpressionFilterRowContext",kind:"I",desc:"Context used when applying a filter to Rows before Reducer is called",props:[{name:"aggColumnId",kind:"s",desc:"Column Id of the column being aggregated Usually the first Col argument, e.g. [colId]"},{name:"args",kind:"a",desc:"Arguments passed to the function"},{name:"getValueForColId",kind:"u",desc:"Utility function to get the value of a column"},{name:"groupByColumnIds",kind:"a",desc:"Column Id(s) of the column(s) being grouped by",isOpt:!0},{name:"rowNode",kind:"R",desc:"Current row node",ref:"unknown"}]},AggregatedExpressionFunction:{name:"AggregatedExpressionFunction",kind:"I",desc:"Defines an AdapTableQL function that aggregates data",props:[{name:"description",kind:"s",desc:"Description of the Aggregated Expression Function",isOpt:!0},{name:"examples",kind:"a",desc:"Examples to use the Aggregated Expression Function",isOpt:!0},{name:"filterRow",kind:"f",desc:"Optional filter which is applied to each row before the reducer is called. If the filter returns false, the row is NOT included in the aggregation.",isOpt:!0},{name:"initialValue",kind:"u",desc:"Mandatory Initial Value for the aggregation"},{name:"inputTypes",kind:"a",desc:"Optional argument types.",isOpt:!0},{name:"prepareRowValue",kind:"u",desc:"Called for each row AFTER the reducer() and processAggregatedValue() functions Can be used when each row has a different aggregated value (e.g. percentage = row value / aggregated value). Returns return value for each individual row",isOpt:!0},{name:"processAggregatedValue",kind:"f",desc:"Called AFTER the reducer() has processed all values / rows Can be used to change result of reducer based on the values array (e.g. average = aggregated value / count)",isOpt:!0},{name:"reducer",kind:"f",desc:"Mandatory Reducer function which is called for each value(row) in the Column Data"},{name:"signatures",kind:"a",desc:"Example Signatures for the Aggregated Expression Function",isOpt:!0}]},AggregatedExpressionPrepareRowValueContext:{name:"AggregatedExpressionPrepareRowValueContext",kind:"I",desc:"Context used by prepareRowValue property in Aggregated Expressions",props:[{name:"aggColumnId",kind:"s",desc:"Column Id of the column being aggregated"},{name:"aggregatedValue",kind:"u",desc:"Result of the reducer"},{name:"args",kind:"a",desc:"Arguments passed to the function"},{name:"getValueForColId",kind:"u",desc:"Helper function to get the value of a column"},{name:"groupByColumnIds",kind:"a",desc:"Column Id(s) of the column(s) being grouped by",isOpt:!0},{name:"rowNode",kind:"R",desc:"Current Row Node",ref:"unknown"}]},AggregatedExpressionProcessAggValueContext:{name:"AggregatedExpressionProcessAggValueContext",kind:"I",desc:"Context used by processAggregatedValue property in Aggregated Expressions",props:[{name:"aggColumnId",kind:"s",desc:"Column Id of the column being aggregated"},{name:"aggregatedValue",kind:"u",desc:"Result of the reducer"},{name:"args",kind:"a",desc:"Arguments passed to the function"},{name:"groupByColumnIds",kind:"a",desc:"Column Id(s) of the column(s) being grouped by",isOpt:!0},{name:"rowNodes",kind:"a",desc:"Array of row nodes; if aggregation is grouped, this will be the array of row nodes for the group"}]},AggregatedExpressionReducerContext:{name:"AggregatedExpressionReducerContext",kind:"I",desc:"Context used by the reducer property in Aggregated Expressions",props:[{name:"accumulator",kind:"u",desc:"Value returned by the previous call to the reducer function, or the initialValue if this is the first call. You return the new accumulator value from this function."},{name:"aggColumnId",kind:"s",desc:"Column Id of the column being aggregated"},{name:"args",kind:"a",desc:"Arguments passed to the function"},{name:"currentValue",kind:"u",desc:"Current value being processed in the Column Data"},{name:"getValueForColId",kind:"u",desc:"Helper function to get the value of a column"},{name:"groupByColumnIds",kind:"a",desc:"Column Id(s) of the column(s) being grouped by",isOpt:!0},{name:"index",kind:"n",desc:"Index of the current value in the Column Data"},{name:"rowNode",kind:"R",desc:"Current row node",ref:"unknown"}]},AgGridColumnMenuItemType:{name:"AgGridColumnMenuItemType",kind:"A",desc:"Defines AG Grid Column Menu Items"},AgGridConfig:{name:"AgGridConfig",kind:"I",desc:"Contains AG Grid Options and Modules - used when instantiating AdapTable vanilla",props:[{name:"gridOptions",kind:"R",desc:"AG Grid GridOptions object",ref:"unknown"},{name:"modules",kind:"a",desc:"AG Grid Modules to use; provide empty array if using CJS"}]},AgGridContextMenuItemType:{name:"AgGridContextMenuItemType",kind:"A",desc:"Defines AG Grid Context Menu Items"},AgGridMenuItem:{name:"AgGridMenuItem",kind:"I",desc:"Menu Item that is provided by AG Grid",props:[{name:"menuType",kind:"u",desc:"Type of Menu - always 'AgGrid'"},{name:"name",kind:"u",desc:"Name of the Menu Type"}]},AlertButton:{name:"AlertButton",kind:"I",desc:"Defines a button that appears in an Alert Form",props:[{name:"ButtonStyle",kind:"R",desc:"Style for the Button",isOpt:!0,ref:"ButtonStyle"},{name:"Command",kind:"u",desc:"Predefined Command(s) to trigger when button is clicked; implemented in `commandHandlers` property of Alert Options",isOpt:!0},{name:"Label",kind:"s",desc:"Label to show in the Button"},{name:"Tooltip",kind:"s",desc:"ToolTip to display",isOpt:!0}]},AlertButtonForm:{name:"AlertButtonForm",kind:"A",desc:"Form triggered by an Alert which contains only Buttons"},AlertDefinition:{name:"AlertDefinition",kind:"I",desc:"The Alert Definition object used in the Alert function",props:[{name:"AlertForm",kind:"u",desc:"Form to display in Alert with buttons and inputs",isOpt:!0},{name:"AlertProperties",kind:"R",desc:"Series of properties which set what happens when Alert is triggered",isOpt:!0,ref:"AlertProperties"},{name:"MessageHeader",kind:"s",desc:"Title of displayed Alert Message",isOpt:!0},{name:"MessageText",kind:"s",desc:"Title of displayed Alert Message; if null, AdapTable creates dynamically using Rule & Scope",isOpt:!0},{name:"MessageType",kind:"R",desc:"Type of Alert: 'Info', 'Success', 'Warning', 'Error'; influences Alert colour, icon and logging",ref:"AdaptableMessageType"},{name:"Rule",kind:"R",desc:"When Alert should be triggered",ref:"AlertRule"},{name:"Scope",kind:"R",desc:"Where Alert can be triggered: one, some or all columns or DataTypes",ref:"ColumnScope"}]},AlertDefinitionPredicate:{name:"AlertDefinitionPredicate",kind:"I",desc:"Predicate used when creating a Predicate-based Rule for an Alert"},AlertForm:{name:"AlertForm",kind:"A",desc:"Form to show in an Alert"},AlertFormContext:{name:"AlertFormContext",kind:"I",desc:"Context required by functions when using an Alert Button",props:[{name:"alert",kind:"u",desc:"Alert that has been triggered"}]},AlertMessageContext:{name:"AlertMessageContext",kind:"I",desc:"Context used for creating bespoke Alert messages",props:[{name:"alertDefinition",kind:"R",desc:"Current Alert Definition",ref:"AlertDefinition"},{name:"cellDataChangedInfo",kind:"u",desc:"Cell Data change that might have triggered the Alert",isOpt:!0},{name:"rowDataChangedInfo",kind:"u",desc:"Row Data change that might have triggered the Alert (e.g. Row Added or Removed)",isOpt:!0}]},AlertOptions:{name:"AlertOptions",kind:"I",desc:"Options related to Alerts in Adaptable.",props:[{name:"alertForms",kind:"u",desc:"Full definitions of Alert Forms - the names of which are provided in Alert State",isOpt:!0},{name:"alertMessageHeader",kind:"u",desc:"Function providing Header to display in Alert; if empty, AdapTable provides dynamically",isOpt:!0},{name:"alertMessageText",kind:"u",desc:"Function providing Message to display in Alert; if empty, AdapTable provides dynamically",isOpt:!0},{name:"cellHighlightDuration",kind:"n",desc:"How long (in ms) a Cell will be highlighted when an Alert fires",isOpt:!0,gridInfo:"item",defVal:"2000"},{name:"commandHandlers",kind:"u",desc:"Custom onClick Handlers for Buttons (displayed in Alert Forms)",isOpt:!0},{name:"dataChangeDetectionPolicy",kind:"R",desc:"Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data",isOpt:!0,gridInfo:"item",defVal:"'rawValue'",ref:"DataChangeDetectionPolicy"},{name:"maxAlertsInStore",kind:"n",desc:"How many alerts held in State at any one time; when limit is breached, oldest alert will be removed",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"20"},{name:"rowHighlightDuration",kind:"n",desc:"How long (in ms) a Row will be highlighted when an Alert Fires",isOpt:!0,gridInfo:"item",defVal:"4000"},{name:"showMissingPrimaryKeyAlert",kind:"b",desc:"Shows Alert if Primary Key column in Adaptable Options is not present or incorrect",uiLabel:"Show Missing Primary Key Warning",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"statusbarHighlightDuration",kind:"n",desc:"How long (in ms) Alert panel in Status Bar highlights when an Alert Fires",isOpt:!0,defVal:"2000"}]},AlertProperties:{name:"AlertProperties",kind:"I",desc:"Additional properties that specify how a particular Alert will ALWAYS behave",props:[{name:"DisplayNotification",kind:"b",desc:"Displays a notification when Alert is triggered",isOpt:!0},{name:"HighlightCell",kind:"u",desc:"Colours updated Row using `MessageType` of triggering Alert Definition",isOpt:!0},{name:"HighlightRow",kind:"u",desc:"Colours updated Row using `MessageType` of triggering Alert Definition",isOpt:!0},{name:"JumpToCell",kind:"b",desc:"Grid will 'jump' to the changed cell which triggered the Alert",isOpt:!0},{name:"JumpToRow",kind:"b",desc:"Grid will 'jump' to the newly added row which triggered the Alert",isOpt:!0},{name:"LogToConsole",kind:"b",desc:"Logs the Alert message to the console",isOpt:!0},{name:"NotificationDuration",kind:"u",desc:"Notifiction duration(defaults to `NotificationOptions.duration`)",isOpt:!0},{name:"PreventEdit",kind:"b",desc:"Automatically prevent any cell edit which triggered the Alert (i.e. validation)",isOpt:!0,defVal:"false"},{name:"ShowInDiv",kind:"b",desc:"Shows Alert text in the div specificed in `alertContainer` property of Container Options",isOpt:!0}]},AlertRule:{name:"AlertRule",kind:"A",desc:"The Alert Rule defined by either an AdaptablePredicate or an AdaptableQuery"},AlertState:{name:"AlertState",kind:"I",desc:"Adaptable State section for Alert Module",props:[{name:"AlertDefinitions",kind:"a",desc:"Alert Definitions - will trigger Alerts when rule is met",isOpt:!0}]},AlternativeModuleName:{name:"AlternativeModuleName",kind:"I",desc:"Defines a new name for an Adaptable Module (e.g. change Dashboard to Grid Manager)",props:[{name:"adaptableModule",kind:"R",desc:"Adaptable Module to rename",ref:"AdaptableModule"},{name:"newName",kind:"s",desc:"New name to use"}]},AngularFrameworkComponent:{name:"AngularFrameworkComponent",kind:"A",desc:"Angular component defined by its type and (optional) initialisation callback"},ApplicationDataEntry:{name:"ApplicationDataEntry",kind:"I",desc:"Simple Key / Value pair object used to store custom - stringifiable - data in Adaptable State.",props:[{name:"Key",kind:"s",desc:"Key of Key / Value pair - always stored as a string"},{name:"Value",kind:"u",desc:"Value of Key / Value pair (actual data being stored) - needs to stringifiable"}]},ApplicationState:{name:"ApplicationState",kind:"I",desc:"Adaptable State Section for the Application Module",props:[{name:"ApplicationDataEntries",kind:"a",desc:"Array of Key / Value pairs enabling custom data to be stored in Adaptable State.",isOpt:!0}]},ApplyFilterAction:{name:"ApplyFilterAction",kind:"A",desc:"When to apply a Filter: 'Always', 'Never' or 'Throttle'"},AST_Expression:{name:"AST_Expression",kind:"A",desc:"Defines AST of an Expressoin"},AST_Function:{name:"AST_Function",kind:"A",desc:"Defines AST of an Expression Function"},AST:{name:"AST",kind:"A",desc:"An AST Expression"},AutoGenerateTagsForLayoutsContext:{name:"AutoGenerateTagsForLayoutsContext",kind:"I",desc:"Context for `LayoutOptions.autoGenerateTagsForLayouts` method",props:[{name:"layouts",kind:"a",desc:"Layouts currently in Adaptable State"},{name:"objectTags",kind:"a",desc:"Object Tags provided in User Interface Options"}]},AutoGroupColumnHeaderContext:{name:"AutoGroupColumnHeaderContext",kind:"I",desc:"Context for Columns created automatically by AG Grid when Row Grouping",props:[{name:"columnId",kind:"s",desc:"Id of the Column"},{name:"columnType",kind:"u",desc:"Auto-generated Row Group Column (when RowGroupDisplayType is `single`)"},{name:"groupedColumnIds",kind:"a",desc:"Ids of all Row Grouped Columns"}]},BadgeStyle:{name:"BadgeStyle",kind:"I",desc:"Collection of Badge Style Definitions to display in a Badge Styled Column",props:[{name:"Badges",kind:"a",desc:"Collection of Badge Style Definitions",isOpt:!0},{name:"RowScope",kind:"R",desc:"Which types of Rows should contain a Badge (data, grouped, summary)",isOpt:!0,ref:"RowScope"}]},BadgeStyleDefinition:{name:"BadgeStyleDefinition",kind:"I",desc:"Defines a Badge Style",props:[{name:"Icon",kind:"R",desc:"Icon to display in Badge",isOpt:!0,ref:"AdaptableIcon"},{name:"IconOnly",kind:"b",desc:"Only show an Icon and no Cell text",isOpt:!0},{name:"IconPosition",kind:"'Start' | 'End'",desc:"Position of Icon in the Badge - 'Start' or 'End'",isOpt:!0},{name:"Predicate",kind:"R",desc:"Optional Rule for deciding whether Badge is displayed",isOpt:!0,ref:"BadgeStylePredicate"},{name:"Style",kind:"R",desc:"Style for the Badge",isOpt:!0,ref:"AdaptableStyle"}]},BadgeStylePredicate:{name:"BadgeStylePredicate",kind:"I",desc:"System Predicate definition for Badge Style"},BaseColumnHeaderContext:{name:"BaseColumnHeaderContext",kind:"I",desc:"Common properties for Column Header Context",props:[{name:"currentLayout",kind:"R",desc:"Current Layout",ref:"Layout"},{name:"currentLayoutName",kind:"s",desc:"Name of Current Layout"},{name:"currentLayoutType",kind:"'table' | 'pivot'",desc:"Type (table/pivot) of Current Layout"},{name:"defaultHeaderName",kind:"s",desc:"Default header name for Column"}]},BaseContext:{name:"BaseContext",kind:"I",desc:"Base class for all AdapTable callbacks and Events",props:[{name:"adaptableApi",kind:"R",desc:"Adaptable Api object",ref:"unknown"},{name:"adaptableContext",kind:"u",desc:"Custom application Context provided in `AdaptableOptions.adaptableContext`"},{name:"adaptableId",kind:"s",desc:"Id of current AdapTable instance"},{name:"adaptableStateKey",kind:"s",desc:"Current Adaptable State Key"},{name:"clientTimestamp",kind:"d",desc:"Time on user's computer"},{name:"userName",kind:"s",desc:"Name of Current User"}]},BaseExportContext:{name:"BaseExportContext",kind:"I",desc:"Context information available in all Export-related functions",props:[{name:"exportDestination",kind:"R",desc:"Export Destination for the Report",isOpt:!0,ref:"ExportDestinationType"},{name:"report",kind:"R",desc:"The Report Configuration being run",ref:"Report"},{name:"reportFormat",kind:"R",desc:"Format of the Report being run",ref:"ReportFormatType"},{name:"reportName",kind:"R",desc:"Name of the Report being run",ref:"ReportNameType"}]},BaseState:{name:"BaseState",kind:"I",desc:"Base Interface for all Adaptable State objects; contains`Revision` property, used for versioning",props:[{name:"Revision",kind:"number | {\n        Key: number;\n        UpdateStrategy: 'Override' | 'KeepUserDefined';\n    }",desc:"Version number of the Item - allows developers to update one section in Initial Adaptable State while keeping others unchanged",isOpt:!0}]},BroadcastConfig:{name:"BroadcastConfig",kind:"I",desc:"Config used when broadcasting FDC3 Context",props:[{name:"actionButton",kind:"R",desc:"Definition of Action Button (to be put in default FDC3 Action Column)",isOpt:!0,ref:"Fdc3AdaptableButton"},{name:"actionColumn",kind:"R",desc:"Custom FDC3 Action Column definition to broadcast the Context",isOpt:!0,ref:"FDC3ActionColumn"},{name:"contextMenu",kind:"u",desc:"Columns to display a 'Broadcast' Context Menu item",isOpt:!0}]},BroadcastConfiguration:{name:"BroadcastConfiguration",kind:"I",desc:"Defines config options for Broadcasting FDC3 Context"},ButtonStyle:{name:"ButtonStyle",kind:"I",desc:"Defines the look and feel of an Adaptable Button",props:[{name:"className",kind:"s",desc:"CSS Classname to use for the Button",isOpt:!0},{name:"tone",kind:"'success' | 'error' | 'neutral' | 'none' | 'warning' | 'info' | 'accent'",desc:"Button's Tone - values: 'success', 'error', 'neutral', 'none', 'warning', 'info', 'accent'",isOpt:!0,defVal:"'neutral'"},{name:"variant",kind:"'text' | 'outlined' | 'raised'",desc:"How Button appears - values: 'text', 'outlined', 'raised'",isOpt:!0,defVal:"'outlined'"}]},CalculatedColumn:{name:"CalculatedColumn",kind:"I",desc:"Defines a Column where the display value is derived from other values in row, and the definition is stored in State.",props:[{name:"CalculatedColumnSettings",kind:"R",desc:"Additional optional properties for Column (e.g. filterable, resizable)",ref:"CalculatedColumnSettings"},{name:"ColumnId",kind:"s",desc:"Name of Calculated Column"},{name:"FriendlyName",kind:"s",desc:"Name to be used in Column Header; if blank `ColumnId` is used",isOpt:!0},{name:"Query",kind:"R",desc:"Scalar/AggregatedScalar Query used by AdapTableQL to evaluate Column's value",ref:"AdaptableCalculatedColumnQuery"}]},CalculatedColumnSettings:{name:"CalculatedColumnSettings",kind:"I",desc:"Set properties that define Calculated Column's behaviour (all optional except DataType)",props:[{name:"ShowToolTip",kind:"b",desc:"Show underlying Expression as ToolTip when hovering over a cell",isOpt:!0,defVal:"false"}]},CalculatedColumnState:{name:"CalculatedColumnState",kind:"I",desc:"Adaptable State Section for Calculated Column Module",props:[{name:"CalculatedColumns",kind:"a",desc:"Collection of Calculated Columns",isOpt:!0}]},CalendarOptions:{name:"CalendarOptions",kind:"I",desc:"Options for managing Holidays and Working Days in AdapTable",props:[{name:"holidays",kind:"u",desc:"Holidays for current User",isOpt:!0,defVal:"null"}]},CellAddress:{name:"CellAddress",kind:"A",desc:"Very lightweight object to define an AdapTable Cell"},CellAlignment:{name:"CellAlignment",kind:"A",desc:"Behaviour for aligning Cell contents"},CellColorRange:{name:"CellColorRange",kind:"I",desc:"Defines which Colours to show in Gradient and Percent Bar Styles",props:[{name:"Color",kind:"s",desc:"Cell colour to use for values that fall inside Range"},{name:"Max",kind:"number | 'Col-Max'",desc:"End number of Range"},{name:"Min",kind:"number | 'Col-Min'",desc:"Start number of Range"},{name:"ReverseGradient",kind:"b",desc:"Reverses the Gradient so the lower the cell value the darker the colour",isOpt:!0}]},CellDataChangedInfo:{name:"CellDataChangedInfo",kind:"I",desc:"Defines a Cell Edit - includes full details of old and new values, the column and the enclosing Row",props:[{name:"changedAt",kind:"n",desc:"Timestamp of change occurrence (in milliseconds)"},{name:"column",kind:"u",desc:"Column in which cell is situated"},{name:"newValue",kind:"u",desc:"New value for the cell"},{name:"oldValue",kind:"u",desc:"Value in the Cell before the edit"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key Column's value for the row where edited cell is situated"},{name:"rowData",kind:"u",desc:"Data in the Row",isOpt:!0},{name:"rowNode",kind:"u",desc:"AG Grid RowNode that contains the cell",isOpt:!0},{name:"trigger",kind:"'edit' | 'tick' | 'undo' | 'aggChange'",desc:"What triggered the change - user, background change or a reverted change?",isOpt:!0}]},CellEditableContext:{name:"CellEditableContext",kind:"I",desc:"Context used when checking Cell editability",props:[{name:"defaultColDefEditableValue",kind:"b",desc:"Default editability according to the AG Grid Column Definition (`ColDef.editable`)"},{name:"gridCell",kind:"u",desc:"Cell being edited"}]},CellHighlightInfo:{name:"CellHighlightInfo",kind:"I",desc:"Defines how a given Cell in AdapTable should be highlighted",props:[{name:"columnId",kind:"s",desc:"Id of Column containing Cell"},{name:"highlightStyle",kind:"R",desc:"Adaptable Style to use in the Cell Highlight",ref:"AdaptableStyle"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key Value of row containing Cell",isOpt:!0},{name:"timeout",kind:"n",desc:"Time after which Cell should be unhighlighted",isOpt:!0}]},CellSummaryOptions:{name:"CellSummaryOptions",kind:"I",desc:"Options to provide custom Cell Summary Operations & Display Formats",props:[{name:"customCellSummaryOperations",kind:"u",desc:"Custom Numeric Cell Summary Operations to add to set shipped by AdapTable",isOpt:!0},{name:"numericDisplayFormat",kind:"u",desc:"Numeric format to use for summary value; a Format Column DisplayFormat will take precedence",isOpt:!0}]},CellSummmaryInfo:{name:"CellSummmaryInfo",kind:"I",desc:"Defines the Summary operations which AdapTable provides for Selected Numeric Cells"},CellTextOption:{name:"CellTextOption",kind:"A",desc:"Text optionally to show in a Special Column Style special style: 'CellValue' or 'PercentageValue'"},CellTextOptions:{name:"CellTextOptions",kind:"A",desc:"Array of CellTextOption available in Special Column Styles"},CellUpdateRequest:{name:"CellUpdateRequest",kind:"I",desc:"Lightweight object used for identifying a Cell to be updated",props:[{name:"columnId",kind:"s",desc:"Id of Column in which edited cell is situated"},{name:"newValue",kind:"u",desc:"New Value for the cell"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key column's value in row - how Adaptable locates the cell",isOpt:!0},{name:"rowNode",kind:"u",desc:"AG Grid Row Node that contains the cell (optional)",isOpt:!0}]},ChartContainer:{name:"ChartContainer",kind:"I",desc:"Describes Location to display an AG Grid Chart",props:[{name:"chartsDisplay",kind:"'single' | 'multiple'",desc:"Whether 1 or more Charts can be displayed in same location",isOpt:!0,defVal:"'single'"},{name:"element",kind:"u",desc:"Location - can be HTMLElement or CSS Selector"},{name:"name",kind:"s",desc:"Name of Container's Location - used in Dropdowns"}]},ChartDefinition:{name:"ChartDefinition",kind:"I",desc:"Wraps an AG Grid Chart Model",props:[{name:"Model",kind:"R",desc:"AG Grid Chart Model",ref:"unknown"},{name:"Name",kind:"s",desc:"Name of the Chart"}]},ChartingAggFunc:{name:"ChartingAggFunc",kind:"A",desc:"Aggregation function used in the Chart"},ChartingOptions:{name:"ChartingOptions",kind:"I",desc:"Options for managing AG Grid's Charts",props:[{name:"agGridContainerName",kind:"s",desc:"Name of AG Grid Chart Container",isOpt:!0,defVal:"'AG Grid Window'"},{name:"chartContainers",kind:"a",desc:"Locations to display saved Charts",isOpt:!0},{name:"externalChartingOptions",kind:"R",desc:"Set of properties for managing behaviour of external (i.e non AG Grid) charts",isOpt:!0,ref:"ExternalChartingOptions"},{name:"saveChartBehaviour",kind:"R",desc:"Behaviour for saving Charts: auto, manual (via popup) or none",isOpt:!0,noCode:"item",defVal:"'none'",ref:"SaveChartBehaviour"}]},ChartingState:{name:"ChartingState",kind:"I",desc:"Persists AG Grid Charts in Adaptable State",props:[{name:"ChartDefinitions",kind:"a",desc:"Wrappers around AG Grid Chart Models",isOpt:!0},{name:"ExternalChartDefinitions",kind:"u",desc:"Definitions of External Charts",isOpt:!0}]},ColumnBooleanFalseMap:{name:"ColumnBooleanFalseMap",kind:"A",desc:"Defines a map of Columns with a Boolean value"},ColumnComparison:{name:"ColumnComparison",kind:"I",desc:"Enables a Percent Bar or Gradient Style to use another column in its calculations",props:[{name:"Color",kind:"s",desc:"Colour to use for the Comparison"},{name:"MaxValue",kind:"number | string",desc:"End value - either numeric value or Column name"},{name:"MinValue",kind:"number | string",desc:"Start value - either numeric value or Column name"}]},ColumnDirectionMap:{name:"ColumnDirectionMap",kind:"A",desc:"Defines a map of Columns with a Left / Right direction value"},ColumnFilter:{name:"ColumnFilter",kind:"I",desc:"Defines a Filter applied on a Column using a Predicate",props:[{name:"ColumnId",kind:"s",desc:"Column where Filter should be applied"},{name:"Predicates",kind:"a",desc:"`AdaptablePredicate` which AdaptableQL will evaluate when the Filter is run"},{name:"PredicatesOperator",kind:"R",desc:"Logic used when combining multiple Predicates ('AND'|'OR')",isOpt:!0,defVal:"'AND'",ref:"PredicatesOperator"}]},ColumnFilterDef:{name:"ColumnFilterDef",kind:"I",desc:"Column Filter Definition for a specific Column"},ColumnFilterOptions:{name:"ColumnFilterOptions",kind:"I",desc:"Options for managing Column Filtering in AdapTable",props:[{name:"defaultArrayColumnFilter",kind:"u",desc:"Default filter type for array Columns ('textArray', 'numberArray', etc.)",isOpt:!0,gridInfo:"item",defVal:"In"},{name:"defaultDateColumnFilter",kind:"u",desc:"Default filter type for date Columns",isOpt:!0,gridInfo:"item",defVal:"On"},{name:"defaultNumericColumnFilter",kind:"u",desc:"Default filter type for numeric Columns",isOpt:!0,gridInfo:"item",defVal:"Equals"},{name:"defaultTextColumnFilter",kind:"u",desc:"Default filter type for text Columns",isOpt:!0,gridInfo:"item",defVal:"Contains"},{name:"hideQuickFilterDropdown",kind:"u",desc:"Hides Dropdown in Quick Filter Bar for a given Column",isOpt:!0,defVal:"undefined"},{name:"hideQuickFilterInput",kind:"u",desc:"Hides Input in Quick Filter Bar for a given Column",isOpt:!0,defVal:"undefined"},{name:"indicateFilteredColumns",kind:"b",desc:"Make Column Header distinctive for filtered columns, helps users see currently filtered columns",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"manuallyApplyColumnFilter",kind:"u",desc:"Manually apply Column Filters; an Apply Filter button is displayed and Quick Filter is disabled",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"quickFilterDebounce",kind:"n",desc:"Time to wait (in ms) before Filter Bar reacts to new value",isOpt:!0,gridInfo:"item",defVal:"250"},{name:"quickFilterHeight",kind:"n",desc:"Height of Quick Filter Bar (if not provided, AG Grid default is used)",isOpt:!0,gridInfo:"item",defVal:"null"},{name:"quickFilterWildcards",kind:"u",desc:"Shortcut Keys to activate a Quick Filter Predicate",isOpt:!0},{name:"showQuickFilter",kind:"b",desc:"Display Quick Filter Bar between Column Header and Grid (provided its been setup)",isOpt:!0,noCode:"item",defVal:"true"}]},ColumnFilterPredicate:{name:"ColumnFilterPredicate",kind:"I",desc:"A Predicate used in Column Filtering"},ColumnFriendlyNameContext:{name:"ColumnFriendlyNameContext",kind:"I",desc:"Context used when setting a Column Friendly Name",props:[{name:"agColumn",kind:"R",desc:"AG Grid ColDef for the Column",ref:"unknown"},{name:"colId",kind:"s",desc:"Id of the Column"},{name:"columnGroup",kind:"R",desc:"Column Group Information",ref:"AdaptableColumnGroup"},{name:"displayName",kind:"s",desc:"AG Grid Display Name"}]},ColumnGroupScope:{name:"ColumnGroupScope",kind:"A",desc:"Defines Column Group Scope"},ColumnGroupValues:{name:"ColumnGroupValues",kind:"A",desc:"Manages Column Group expand / collapse behaviour, including exceptions"},ColumnGroupValuesWithExceptionKeys:{name:"ColumnGroupValuesWithExceptionKeys",kind:"A",desc:"Defines which Column Groups are expanded or collapsed"},ColumnHeaderContext:{name:"ColumnHeaderContext",kind:"A",desc:"Context provided to columnHeader function custom Headers to be provided for any type of AG Grid Column"},ColumnMenuContext:{name:"ColumnMenuContext",kind:"I",desc:"Provides full details about the Column in which the Column Menu will appear",props:[{name:"adaptableColumn",kind:"u",desc:"Current AdapTable Column"},{name:"agGridColumn",kind:"R",desc:"Current AG Grid Column",ref:"unknown"},{name:"isRowGroupColumn",kind:"b",desc:"Whether current Column is Row Group"}]},ColumnMenuOptions:{name:"ColumnMenuOptions",kind:"I",desc:"Options for managing menus in AdapTable – provided using 2 collections",props:[{name:"customColumnMenu",kind:"u",desc:"Customises Column Menu (default column menu items are available in the provided context)",isOpt:!0}]},ColumnNumberMap:{name:"ColumnNumberMap",kind:"A",desc:"Defines a map of Columns with a Number value"},ColumnOptions:{name:"ColumnOptions",kind:"I",desc:"Options related to managing Columns in Adaptable.",props:[{name:"addColumnGroupToColumnFriendlyName",kind:"b",desc:"Appends the name of the Column Group to a Column's Friendly Name",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"columnFriendlyName",kind:"f",desc:"Provide an alternative Friendly Name for a Column",isOpt:!0,defVal:"undefined"},{name:"columnHeader",kind:"f",desc:"Provide a custom Header Name for a Table or Pivot Column",isOpt:!0},{name:"columnTypes",kind:"u",desc:"Optional list of Column Types - used for Scope and creating Special Columns",isOpt:!0,defVal:"Empty Array"},{name:"showMissingColumnsWarning",kind:"b",desc:"Log warning to console if AdapTable cannot find a column",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"}]},ColumnScope:{name:"ColumnScope",kind:"A",desc:"Defines where a given Object / Module is active"},ColumnSizingDefinition:{name:"ColumnSizingDefinition",kind:"A",desc:"State & behaviour for column sizing (must set `width` or `flex` but not both); all other props optional"},ColumnSizingMap:{name:"ColumnSizingMap",kind:"A",desc:"Defines a map of Columns with Sizing information"},ColumnSort:{name:"ColumnSort",kind:"I",desc:"Defines how a Column is sorted",props:[{name:"ColumnId",kind:"s",desc:"Id of Column being sorted"},{name:"SortOrder",kind:"'Asc' | 'Desc'",desc:"How Column is sorted - either 'Asc' or 'Desc'"}]},ColumnStringMap:{name:"ColumnStringMap",kind:"A",desc:"Defines a map of Columns with a String value"},ColumnTypesContext:{name:"ColumnTypesContext",kind:"I",desc:"Context used when retrieving Column Types",props:[{name:"types",kind:"a",desc:"Current Column Types"}]},ColumnValuesComparer:{name:"ColumnValuesComparer",kind:"I",desc:"Comparer object for Column Values - used for custom sorting",props:[{name:"comparer",kind:"u",desc:"Comparer function to use"},{name:"scope",kind:"R",desc:"Column for which to compare values",ref:"ColumnScope"}]},CommandHandler:{name:"CommandHandler",kind:"A",desc:"Handles an Alert Form Command"},CommentableCellContext:{name:"CommentableCellContext",kind:"I",desc:"Context used when determining if a cell can show Comments",props:[{name:"gridCell",kind:"R",desc:"Grid Cell in AdapTable which has been clicked",ref:"GridCell"}]},CommentLoadContext:{name:"CommentLoadContext",kind:"I",desc:"Context used when loading Comments"},CommentOptions:{name:"CommentOptions",kind:"I",desc:"Options for managing Comments and Comment Threads in AdapTable",props:[{name:"dateFormat",kind:"u",desc:"Date Format string for Comments timestamp",isOpt:!0,defVal:"'dd-MM-yyyy HH:mm:ss'"},{name:"isCellCommentable",kind:"f",desc:"Function to configure if a cell can contain Comments",isOpt:!0},{name:"loadCommentThreads",kind:"f",desc:"Loads the Comment Threads",isOpt:!0},{name:"persistCommentThreads",kind:"f",desc:"Persists the current Comment Threads",isOpt:!0},{name:"showPopupCloseButton",kind:"b",desc:"Show the Close Button in the Comments Popup",isOpt:!0,defVal:"true"}]},CommentState:{name:"CommentState",kind:"I",desc:"Internal State used for Comments Module",props:[{name:"CommentThreads",kind:"a",desc:"Collection of AdapTable Comments",isOpt:!0}]},CommentThread:{name:"CommentThread",kind:"I",desc:"Thread of Comments for an Adaptable Cell",props:[{name:"Comments",kind:"a",desc:"Collection of Comments for this Cell"},{name:"Uuid",kind:"R",desc:"Unique identifier for Comment",isOpt:!0,ref:"unknown"}]},ContainerOptions:{name:"ContainerOptions",kind:"I",desc:"Options for managing the different div elements required by AdapTable",props:[{name:"adaptableContainer",kind:"u",desc:"Div containing AdapTable; string Id or HTMLElement",isOpt:!0,gridInfo:"item",defVal:""adaptable""},{name:"agGridContainer",kind:"u",desc:"Div containing AG Grid instance; string Id or HTMLElement",isOpt:!0,gridInfo:"item",defVal:""grid""},{name:"alertContainer",kind:"u",desc:"Div to display Alert messages; string Id or HTMLElement",isOpt:!0,gridInfo:"item",defVal:"undefined"},{name:"modalContainer",kind:"u",desc:"Name of div where popups appear",isOpt:!0,gridInfo:"item",defVal:"undefined (centre of screen)"},{name:"systemStatusContainer",kind:"u",desc:"Div to show System Status messages; string Id or HTMLElement",isOpt:!0,gridInfo:"item",defVal:"undefined"}]},ContextMenuContext:{name:"ContextMenuContext",kind:"I",desc:"Provides full details about current cell (and selected cells) where the Context Menu will appear",props:[{name:"adaptableColumn",kind:"u",desc:"Current AdapTable Column"},{name:"agGridColumn",kind:"R",desc:"Current AG Grid Column",ref:"unknown"},{name:"gridCell",kind:"u",desc:"Cell that has been clicked; contains cell value"},{name:"isGroupedNode",kind:"b",desc:"Whether current AG Grid row node is grouped"},{name:"isRowGroupColumn",kind:"b",desc:"Whether current Column is Row Grouped"},{name:"isSelectedCell",kind:"b",desc:"Whether cell that was clicked is also currently selected"},{name:"isSelectedRow",kind:"b",desc:"Whether cell that was clicked is in a Row that is currently selected"},{name:"isSingleSelectedCell",kind:"b",desc:"Whether the clicked cell is the only selected cell"},{name:"isSingleSelectedColumn",kind:"b",desc:"Whether Column that was clicked is only column with selected cells"},{name:"primaryKeyValue",kind:"u",desc:"Value of Primary Key column in current row"},{name:"rowNode",kind:"u",desc:"Current AG Grid row node"},{name:"selectedCellInfo",kind:"u",desc:"Currently selected cells in the grid"},{name:"selectedRowInfo",kind:"u",desc:"Currently selected rows in the grid"}]},ContextMenuOptions:{name:"ContextMenuOptions",kind:"I",desc:"Options for managing menus in AdapTable – provided using 2 collections",props:[{name:"customContextMenu",kind:"u",desc:"Customises Context Menu (default context menu items are available in provided context)",isOpt:!0}]},CreateRowFormContext:{name:"CreateRowFormContext",kind:"I",desc:"Context used in a Create Row Form",props:[{name:"clonedRowNode",kind:"u",desc:"The RowNode being cloned",isOpt:!0},{name:"type",kind:"u",desc:"Type of the Context"}]},CustomCellSummaryOperation:{name:"CustomCellSummaryOperation",kind:"I",desc:"Defines a Custom Cell Summary operation provided by a user",props:[{name:"operationFunction",kind:"u",desc:"Function to run when a summary result is required"},{name:"operationName",kind:"s",desc:"Name of the Operation - will be displayed in the Cell Summary components"}]},CustomCellSummaryOperationContext:{name:"CustomCellSummaryOperationContext",kind:"I",desc:"Context provided to a custom Cell Summary Operation function",props:[{name:"selectedCellInfo",kind:"u",desc:"Currently selected cells"},{name:"selectedColumn",kind:"R",desc:"Currently selected Column",ref:"AdaptableColumn"}]},CustomColumnMenuContext:{name:"CustomColumnMenuContext",kind:"I",desc:"Context info provided when building Custom Column Menus",props:[{name:"defaultAdaptableMenuItems",kind:"a",desc:"Flat list of all available AdapTable Menu Items"},{name:"defaultAdaptableMenuStructure",kind:"u",desc:"Default structure of Adaptable Menu Items"},{name:"defaultAgGridMenuItems",kind:"a",desc:"Flat list of all available AG Grid Menu Items"},{name:"defaultAgGridMenuStructure",kind:"u",desc:"Default structure of AG Grid Menu Items"}]},CustomColumnMenuItem:{name:"CustomColumnMenuItem",kind:"A",desc:"Custom Column Menu Item"},CustomContextMenuContext:{name:"CustomContextMenuContext",kind:"I",desc:"Context info provided when building Custom Context Menus",props:[{name:"defaultAdaptableMenuItems",kind:"a",desc:"Flat list of all available AdapTable Menu Items"},{name:"defaultAdaptableMenuStructure",kind:"R",desc:"Default structure of Adaptable Menu Items",ref:"DefaultAdaptableMenuStructure"},{name:"defaultAgGridMenuItems",kind:"a",desc:"Flat list of all available AG Grid Menu Items"},{name:"defaultAgGridMenuStructure",kind:"R",desc:"Default structure of AG Grid Menu Items",ref:"DefaultAgGridMenuStructure"}]},CustomContextMenuItem:{name:"CustomContextMenuItem",kind:"A",desc:"Custom Context Menu Item"},CustomDestination:{name:"CustomDestination",kind:"I",desc:"Defines a custom Export destination",props:[{name:"form",kind:"u",desc:"Optional Adaptable Form; if provided, it must include Buttons that will execute the Export",isOpt:!0},{name:"name",kind:"s",desc:"Name of Custom Destination (mandatory)"},{name:"onExport",kind:"f",desc:"Optional Function invoked when Export is applied (used if no form is supplied)",isOpt:!0}]},CustomDestinationsContext:{name:"CustomDestinationsContext",kind:"I",desc:"Context provided to `ExportOptions.customDestinations` callback",props:[{name:"currentLayoutName",kind:"s",desc:"Name of current Layout"},{name:"currentReportFormat",kind:"R",desc:"Format of current Report",isOpt:!0,ref:"ReportFormatType"},{name:"currentReportName",kind:"R",desc:"Name of current Report",isOpt:!0,ref:"ReportNameType"}]},CustomDisplayFormatter:{name:"CustomDisplayFormatter",kind:"I",desc:"Defines a Custom Display Format",props:[{name:"handler",kind:"f",desc:"Function used to render the Custom Display Format"},{name:"id",kind:"s",desc:"Custom Format Id"},{name:"label",kind:"s",desc:"Custom Format Description",isOpt:!0},{name:"scope",kind:"R",desc:"Used by Format Columns wizard to show where Custom Display Format can be applied",ref:"ColumnScope"}]},CustomDisplayFormatterContext:{name:"CustomDisplayFormatterContext",kind:"I",desc:"Context used in handler of CustomDisplayFormatter",props:[{name:"adaptableColumn",kind:"R",desc:"Column where Custom Display Format will apply",ref:"AdaptableColumn"},{name:"cellValue",kind:"u",desc:"Non-formatted Cell Value"},{name:"rowNode",kind:"R",desc:"Node where Custom Display Format will apply",ref:"unknown"}]},CustomEditColumnValueInfo:{name:"CustomEditColumnValueInfo",kind:"I",desc:"Information about items in the custom Edit Controls"},CustomEditColumnValuesContext:{name:"CustomEditColumnValuesContext",kind:"I",desc:"Context used when getting Distinct Column Values for Editing",props:[{name:"currentSearchValue",kind:"s",desc:"Search text in Edit - used when fetching values from server"},{name:"defaultValues",kind:"a",desc:"Current distinct values in Column"},{name:"gridCell",kind:"R",desc:"Currently edited Grid Cell",ref:"GridCell"}]},CustomExportParams:{name:"CustomExportParams",kind:"A",desc:"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"},CustomGroupColumnMenuItem:{name:"CustomGroupColumnMenuItem",kind:"A",desc:"Defines a Grouped Menu Item in the Column Menu"},CustomGroupContextMenuItem:{name:"CustomGroupContextMenuItem",kind:"A",desc:"Defines a Grouped Menu Item in the Context Menu"},CustomIcon:{name:"CustomIcon",kind:"I",desc:"Defines a bespoke Icon provided by a developer",props:[{name:"icon",kind:"R",desc:"AdapTable Icon definition",ref:"AdaptableIcon"},{name:"name",kind:"s",desc:"Name of Icon"}]},CustomInFilterValuesContext:{name:"CustomInFilterValuesContext",kind:"I",desc:"Context used when providing values for the IN Column Filter",props:[{name:"currentSearchValue",kind:"s",desc:"Search text in the IN Filter component - used when filtering on server"},{name:"defaultValues",kind:"a",desc:"Default list of values that will be displayed"},{name:"orderedValues",kind:"a",desc:"Default values in order which currently listed in the grid"},{name:"previousFilterResult",kind:"R",desc:"Last filter result; avoids expensive recomputations (eg if async or server-side filtering)",isOpt:!0,ref:"InFilterValueResult"},{name:"sortedValues",kind:"a",desc:"Default values but sorted (if Column is sorted)"}]},CustomQueryVariableContext:{name:"CustomQueryVariableContext",kind:"I",desc:"Context passed when evaluating customQueryVariables",props:[{name:"args",kind:"a",desc:"Optional variable arguments",isOpt:!0}]},CustomRenderContext:{name:"CustomRenderContext",kind:"I",desc:"Context provided for any custom rendering",props:[{name:"element",kind:"R",desc:"Container Div Element",ref:"unknown"},{name:"phase",kind:"'onMount' | 'onDestroy'",desc:"Phase of DOM Element lifecycle"}]},CustomRenderFunction:{name:"CustomRenderFunction",kind:"I",desc:"Function which is called when rendering/destroying a custom framework-agnostic component",props:[{name:"(call)",kind:"f",desc:"Function to provide bespoke content when NOT using a Framework wrapper"}]},CustomSettingsPanel:{name:"CustomSettingsPanel",kind:"I",desc:"Definition of a Custom Panel to add to the Adaptable Settings Panel",props:[{name:"frameworkComponent",kind:"R",desc:"Framework-specific (Angular, React or Vue) component to be rendered",isOpt:!0,ref:"AdaptableFrameworkComponent"},{name:"icon",kind:"R",desc:"Icon rendered inside settings-panel name, inside the navigation",isOpt:!0,ref:"AdaptableIcon"},{name:"name",kind:"s",desc:"Appears in Settings Panel Navigation and must be included in settingsPanelOptions.navigation for it to be displayed (by default added to the end)"},{name:"render",kind:"f",desc:"Function to provide bespoke content when NOT using a Framework wrapper",isOpt:!0}]},CustomSharedEntity:{name:"CustomSharedEntity",kind:"I",desc:"Defines a Custom object that will be shared using Team Sharing",props:[{name:"ChangedAt",kind:"n",desc:"Last time when the object was changed"},{name:"ChangedBy",kind:"s",desc:"Last User who changed the object"},{name:"Description",kind:"s",desc:"Description of object being shared"},{name:"Entity",kind:"u",desc:"Custom Object being shared"},{name:"EntityType",kind:"u",desc:"Type of shared entity (either Adaptable specific or custom object)"},{name:"IsReadOnly",kind:"b",desc:"Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')",isOpt:!0},{name:"Name",kind:"s",desc:"Name of object being shared"},{name:"Tags",kind:"a",desc:"List of Tags associated with the Object",isOpt:!0},{name:"Timestamp",kind:"n",desc:"When the object was shared"},{name:"UserName",kind:"s",desc:"User who shared the object"},{name:"Uuid",kind:"R",desc:"Unique identifier for the Custom Shared Entity",ref:"unknown"}]},CustomSharedEntityConfig:{name:"CustomSharedEntityConfig",kind:"I",desc:"Describes a custom Object which is being Team Shared",props:[{name:"Description",kind:"s",desc:"Description of object being shared"},{name:"Name",kind:"s",desc:"Name of object being shared"},{name:"Tags",kind:"a",desc:"List of Tags associated with the Object",isOpt:!0},{name:"Uuid",kind:"s",desc:"Optional technical ID; if not provided, it will be auto-generated by Adaptable",isOpt:!0}]},CustomSort:{name:"CustomSort",kind:"I",desc:"Custom Sort object used in Custom Sort function.",props:[{name:"ColumnId",kind:"s",desc:"Id of Column on which Custom Sort will be applied"},{name:"SortedValues",kind:"u",desc:"Order of values by which Column will be sorted; Date values are persisted as ISO strings ('yyyy-MM-dd')",isOpt:!0}]},CustomSortOptions:{name:"CustomSortOptions",kind:"I",desc:"Used to provide Custom Sorts comparers",props:[{name:"customSortComparers",kind:"u",desc:"CustomSort column comparer functions",isOpt:!0}]},CustomSortState:{name:"CustomSortState",kind:"I",desc:"Adaptable State Section for Custom Sort Module",props:[{name:"CustomSorts",kind:"a",desc:"Collection of Custom Sort objects.",isOpt:!0}]},CustomToolbar:{name:"CustomToolbar",kind:"I",desc:"Custom Toolbar (which AdapTable will manage) enabling devs to populate Dashboard with bepoke content",props:[{name:"frameworkComponent",kind:"R",desc:"The Framework-specific (Angular, React or Vue) component to be rendered",isOpt:!0,ref:"AdaptableFrameworkComponent"},{name:"name",kind:"s",desc:"How Toolbar is referenced (e.g. in Dashboard Popup when managing toolbars)"},{name:"render",kind:"f",desc:"Function to provide custom content when NOT using a Framework wrapper",isOpt:!0},{name:"title",kind:"s",desc:"Title to display in Toolbar; if unset or empty string, nothing will show",isOpt:!0},{name:"toolbarActions",kind:"R",desc:"Actions available in a Custom Dashboard Toolbar",isOpt:!0,ref:"ToolbarActions"},{name:"toolbarButtons",kind:"a",desc:"Optional set of buttons to show in the Toolbar",isOpt:!0}]},CustomToolbarButtonContext:{name:"CustomToolbarButtonContext",kind:"I",desc:"Context required by functions when using a Custom Toolbar Button",props:[{name:"customToolbar",kind:"R",desc:"Custom Toolbar which hosts the Button",ref:"CustomToolbar"}]},CustomToolPanel:{name:"CustomToolPanel",kind:"I",desc:"Defines a Custom ToolPanel - provided by Users and contains custom content",props:[{name:"buttons",kind:"a",desc:"Optional set of buttons to show in the ToolPanel",isOpt:!0},{name:"frameworkComponent",kind:"R",desc:"Framework-specific (Angular, React or Vue) component to be rendered",isOpt:!0,ref:"AdaptableFrameworkComponent"},{name:"name",kind:"s",desc:"Name of Custom ToolPanel - should be unique"},{name:"render",kind:"f",desc:"Function to provide bespoke content when using AdapTable Vanilla",isOpt:!0},{name:"title",kind:"s",desc:"Title to display in Custom ToolPanel; if undefined, will default to `name` property",isOpt:!0}]},CustomToolPanelButtonContext:{name:"CustomToolPanelButtonContext",kind:"I",desc:"Context used for Custom Tool Panels containing Buttons",props:[{name:"customToolPanel",kind:"R",desc:"The Custom ToolPanel which contains the button",ref:"CustomToolPanel"}]},CustomWindowConfig:{name:"CustomWindowConfig",kind:"I",desc:"Config used to open a Custom Window",props:[{name:"frameworkComponent",kind:"R",desc:"React, Angular or Vue Framework component to use for Custom Window content",isOpt:!0,ref:"AdaptableFrameworkComponent"},{name:"icon",kind:"R",desc:"Icon to display in Custom Window header",isOpt:!0,ref:"AdaptableSystemIconName"},{name:"id",kind:"s",desc:"Unique identifier for Custom Window"},{name:"onFrameworkComponentDestroyed",kind:"u",desc:"Callback function invoked when framework component is destroyed",isOpt:!0},{name:"position",kind:"R",desc:"Position of window in pixels (provided as x, y)",isOpt:!0,ref:"WindowPosition"},{name:"render",kind:"f",desc:"Render function to display content in Custom Window (if not using a framework component)",isOpt:!0},{name:"size",kind:"R",desc:"Size of window in pixels (provided as width, height)",isOpt:!0,ref:"WindowSize"},{name:"title",kind:"s",desc:"Title of Custom Window",isOpt:!0}]},DashboardButtonContext:{name:"DashboardButtonContext",kind:"I",desc:"Context required by functions when using a Dashboard Button",props:[{name:"dashboardState",kind:"R",desc:"Current Dashboard State",ref:"DashboardState"}]},DashboardButtonsLocation:{name:"DashboardButtonsLocation",kind:"A",desc:"Where Dashboard Buttons are displayed"},DashboardOptions:{name:"DashboardOptions",kind:"I",desc:"Options related to the Dashboard in Adaptable.",props:[{name:"buttonsLocation",kind:"R",desc:"Where in Dashboard to display Module and Custom Buttons",isOpt:!0,noCode:"item",defVal:"'right'",ref:"DashboardButtonsLocation"},{name:"canFloat",kind:"b",desc:"Whether the Dashboard can be floated; if true (the default), double-clicking Dashboard puts it in float mode",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"customDashboardButtons",kind:"a",desc:"Custom Adaptable Buttons to appear in Dashboard (alongside Module Buttons)",isOpt:!0},{name:"customToolbars",kind:"a",desc:"Toolbars provided by Users which contain custom content",isOpt:!0},{name:"showQuickSearchInHeader",kind:"b",desc:"Shows Quick Search textbox in the Dashboard Header",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"}]},DashboardState:{name:"DashboardState",kind:"I",desc:"Adaptable State Section for the AdapTable Dashboard",props:[{name:"ActiveTabIndex",kind:"n",desc:"Index of Active Tab (in Tabs collection)",isOpt:!0},{name:"DashboardTitle",kind:"s",desc:"Title displayed in Dashboard Header",isOpt:!0,defVal:"`adaptableId` in Adaptable Options"},{name:"FloatingPosition",kind:"R",desc:"Position of Dashboard when in Floating mode",isOpt:!0,ref:"AdaptableCoordinate"},{name:"IsCollapsed",kind:"b",desc:"Is Dashboard collapsed; if true, header is visible (but not Tabs' contents)",isOpt:!0,defVal:"false"},{name:"IsFloating",kind:"b",desc:"Is Dashboard floating; if true, appears in draggable, minmised form (double-click to revert to default position)",isOpt:!0,defVal:"false"},{name:"IsHidden",kind:"b",desc:"Whether Dashboard is completely hidden - can be made visible again in Column Menu and Tool Panel",isOpt:!0,defVal:"false"},{name:"IsInline",kind:"b",desc:"Alternative way of rendering Dashboard, with headers section to left of Toolbars",isOpt:!0,defVal:"false"},{name:"ModuleButtons",kind:"R",desc:"Buttons which open the Settings Panel screen for associated AdapTable Module",isOpt:!0,defVal:"['SettingsPanel']",ref:"unknown"},{name:"PinnedToolbars",kind:"u",desc:"Toolbars displayed above Grid (and not in Tab)",isOpt:!0},{name:"Tabs",kind:"a",desc:"Named group of Toolbars",isOpt:!0,defVal:"Empty Array"}]},DashboardTab:{name:"DashboardTab",kind:"I",desc:"Defines a named set of Toolbars in the AdapTable Dashboard",props:[{name:"Name",kind:"s",desc:"Name of the tab - as appears in the Dashboard"},{name:"Toolbars",kind:"u",desc:"List of Toolbars to show in the Tab"}]},DataChangeDetectionPolicy:{name:"DataChangeDetectionPolicy",kind:"A",desc:"Cell Change that will trigger an Alert: can be 'rawValue' or 'formattedValue'"},DataChangedScope:{name:"DataChangedScope",kind:"I",desc:"Defines where a Data Change should be monitored",props:[{name:"columnIds",kind:"u",desc:"Scopes a group of Column Ids"},{name:"wholeRow",kind:"b",desc:"Scopes every Column in the Row"}]},DataChangeHistoryButton:{name:"DataChangeHistoryButton",kind:"I",desc:"A custom AdaptableButton which provides a build in `undo` action"},DataChangeHistoryContext:{name:"DataChangeHistoryContext",kind:"I",desc:"The context for the DataChangeHistoryButton",props:[{name:"clearRow",kind:"u",desc:"Helper function to row from Grid"},{name:"dataChangedInfo",kind:"u",desc:"The initial data change"},{name:"isGroupNode",kind:"b",desc:"If the change references a group node."},{name:"parentAdapTableApi",kind:"R",desc:"AdapTable API of underlying Grid (not from Data History Monitor)",ref:"unknown"},{name:"undoDataChange",kind:"u",desc:"Helper function to undo the change."}]},DataChangeHistoryOptions:{name:"DataChangeHistoryOptions",kind:"I",desc:"Options to manage the 'Data Change History Module', which provides an overview of all previous changes, giving the possibility to undo specific changes",props:[{name:"activeByDefault",kind:"b",desc:"Make Data Change History active by default",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"changeHistoryButton",kind:"u",desc:"Action button definition; can be used to implement undo functionality",isOpt:!0,defVal:"undefined"},{name:"showDataChange",kind:"u",desc:"Function specifying which data changes to include in Data Change History",isOpt:!0,gridInfo:"item",defVal:"undefined (all data changes are logged)"},{name:"showLastDataChangeOnly",kind:"b",desc:"Show all changes for a Cell or just the last one",isOpt:!0,defVal:"true"}]},DataFormatDataType:{name:"DataFormatDataType",kind:"I",desc:"Defines the Format Data Types for all Data Types",props:[{name:"date",kind:"R",desc:"Data Format type for Date columns",isOpt:!0,ref:"DataFormatType"},{name:"number",kind:"R",desc:"Data Format type for Number columns",isOpt:!0,ref:"DataFormatType"},{name:"text",kind:"R",desc:"Data Format type for String / Text columns",isOpt:!0,ref:"DataFormatType"}]},DataFormatType:{name:"DataFormatType",kind:"A",desc:"Format of exported Data - 'rawValue' or 'formattedValue'"},DataImportFileHandler:{name:"DataImportFileHandler",kind:"I",desc:"Files that can be handled by Data Import",props:[{name:"fileExtension",kind:"s",desc:"Name of File Extension",isOpt:!0},{name:"handleFile",kind:"u",desc:"Async function which handles the import returning a Data Record"}]},DataImportOptions:{name:"DataImportOptions",kind:"I",desc:"Options for managing the Data Import function",props:[{name:"_getPrimaryKeyValue",kind:"u",desc:"Function to get the Primary Key value for a data row (defaults to value of the primaryKey column)",isOpt:!0},{name:"_preprocessRowData",kind:"u",desc:"Function to pre-process the data before it is imported",isOpt:!0},{name:"fileHandlers",kind:"a",desc:"Custom File Handlers to use for Data Import",isOpt:!0},{name:"handleImportedData",kind:"u",desc:"Function to handle the Imported Data and apply it to the Grid. If not provided then the Data will be applied to the Grid automatically.",isOpt:!0},{name:"textHandler",kind:"u",desc:"Handles Importing Data using text",isOpt:!0},{name:"validate",kind:"u",desc:"Function to validate the Imported Data",isOpt:!0}]},DataImportValidateContext:{name:"DataImportValidateContext",kind:"I",desc:"Context passed to the `validate` function",props:[{name:"rowData",kind:"u",desc:"Imported Row Data"}]},DataImportValidationError:{name:"DataImportValidationError",kind:"I",desc:"Defines a Validation Error",props:[{name:"columnId",kind:"s",desc:"Column which contains the Error"},{name:"error",kind:"s",desc:"The validatoin error text"}]},DataSet:{name:"DataSet",kind:"I",desc:"Defines a Data Set object that can provide data to AdapTable",props:[{name:"description",kind:"s",desc:"Describes the Data Set"},{name:"form",kind:"u",desc:"Params for Data Set popup form",isOpt:!0},{name:"info",kind:"u",desc:"Additional info for Data Set",isOpt:!0},{name:"name",kind:"s",desc:"Name of Data Set"}]},DataSetFormContext:{name:"DataSetFormContext",kind:"I",desc:"Used when a DataSet displays a Form",props:[{name:"dataSet",kind:"R",desc:"The DataSet which triggered the Form",ref:"DataSet"}]},DataSetOptions:{name:"DataSetOptions",kind:"I",desc:"Options to provide Data Sets",props:[{name:"dataSets",kind:"a",desc:"Collection of Data Sets to provide data to AdapTable",isOpt:!0}]},DataUpdateConfig:{name:"DataUpdateConfig",kind:"I",desc:"Object passed into Adaptable Grid Api data management methods",props:[{name:"addIndex",kind:"n",desc:"Index where to add new rows",isOpt:!0},{name:"callback",kind:"u",desc:"Callback function invoked when a batch successfully updates",isOpt:!0},{name:"flushAsync",kind:"b",desc:"Whether to flush async updates",isOpt:!0},{name:"runAsync",kind:"b",desc:"Whether data should be updated asynchronously",isOpt:!0}]},DateFormatterOptions:{name:"DateFormatterOptions",kind:"I",desc:"Formatter Options for Date Columns - contains a single `Pattern` property",props:[{name:"Pattern",kind:"s",desc:"Pattern to use for Date Format",isOpt:!0}]},DateInputOptions:{name:"DateInputOptions",kind:"I",desc:"Options for managing and customizing the date inputs.",props:[{name:"dateFormat",kind:"s",desc:"Format string for formatting date input field",isOpt:!0,defVal:"'yyyy-MM-dd' (ISO 8601 format)"},{name:"datepickerButtons",kind:"a",desc:"List of buttons which are displayed in the datepicker overlay in the given order (provide empty array to display no buttons); custom button layout and positioning is achievable with the special elements `-` and `|`",isOpt:!0,defVal:"['close','today']"},{name:"locale",kind:"u",desc:"Locale object (to localize Date Picker)",isOpt:!0,defVal:"`en-US`"},{name:"showOutsideDays",kind:"b",desc:"Display outside days (i.e. those falling in next or previous month)",isOpt:!0,defVal:"true"},{name:"showWeekNumber",kind:"b",desc:"Display the week numbers column",isOpt:!0,defVal:"false"},{name:"useNativeInput",kind:"b",desc:"Use browser specific date input instead of AdapTable's Date Picker",isOpt:!0,defVal:"false"}]},DefaultAccessLevelContext:{name:"DefaultAccessLevelContext",kind:"I",desc:"Provided to defaultAccessLevel function when setting Default Entitlement value programatically"},DefaultAdaptableMenuStructure:{name:"DefaultAdaptableMenuStructure",kind:"A",desc:"The Context Menu provided by AadapTable by default"},DefaultAgGridMenuStructure:{name:"DefaultAgGridMenuStructure",kind:"A",desc:"AG Grid section of Context Menu provided by AadapTable by default"},DefaultPredicateFilterContext:{name:"DefaultPredicateFilterContext",kind:"I",desc:"Context used for setting default Predicates for Column Filters",props:[{name:"column",kind:"u",desc:"Current Column"},{name:"filterComponent",kind:"R",desc:"Filter Component being displayed: FilterBar or FilterForm",ref:"unknown"}]},DetailInitContext:{name:"DetailInitContext",kind:"I",desc:"Context passed to Detail Grids when using Master Detail Plugin",props:[{name:"data",kind:"u",desc:"The data in the Master Grid Row that was opened"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key Value of Master Grid Row that was opened"},{name:"rowNode",kind:"R",desc:"Row Node in the Master Grid that was opened",ref:"unknown"}]},EditColumnValueInfo:{name:"EditColumnValueInfo",kind:"I",desc:"Information about items in the Edit Controls"},EditOptions:{name:"EditOptions",kind:"I",desc:"Options related to Editing in AdapTable - includes Server Validation, Smart Edit Operations and Cell Editabiility",props:[{name:"customEditColumnValues",kind:"u",desc:"List of Column values to display when Editing (i.e. in Edit Lookups, Bulk Update)",isOpt:!0},{name:"displayServerValidationMessages",kind:"b",desc:"Whether to display message after Server Validation runs",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"isCellEditable",kind:"u",desc:"Function which checks if a given Grid Cell is editable",isOpt:!0},{name:"showSelectCellEditor",kind:"u",desc:"Columns that will display a Select dropdown when editing",isOpt:!0},{name:"smartEditCustomOperations",kind:"u",desc:"Custom Operations to use in Smart Edit",isOpt:!0},{name:"validateOnServer",kind:"u",desc:"Function to validate AdapTable data edits remotely",isOpt:!0}]},EditRowFormContext:{name:"EditRowFormContext",kind:"I",desc:"Context used in an Edit Row Form",props:[{name:"rowNode",kind:"u",desc:"The RowNode being edited"},{name:"type",kind:"u",desc:"Type of the Context"}]},Entitlement:{name:"Entitlement",kind:"I",desc:"Defines a Permission in AdapTable - Module and Access Level",props:[{name:"accessLevel",kind:"R",desc:"Access Level for an Entitlement; options are: `Full` `ReadOnly` `Hidden`",ref:"AccessLevel"},{name:"adaptableModule",kind:"R",desc:"Name of Adaptable Module that has the Entitlement applied",ref:"AdaptableModule"}]},EntitlementContext:{name:"EntitlementContext",kind:"I",desc:"Provided to moduleEntitlements function when setting Entitlements programatically",props:[{name:"adaptableModule",kind:"R",desc:"Module being entitled",ref:"AdaptableModule"},{name:"defaultAccessLevel",kind:"R",desc:"The default Access Level for the current instance",ref:"AccessLevel"}]},EntitlementOptions:{name:"EntitlementOptions",kind:"I",desc:"Options for managing Entitlements in AdapTable, ie. which Modules are available to the User and whether as *Full*, *ReadOnly* or *Hidden*.",props:[{name:"defaultAccessLevel",kind:"u",desc:"AccessLevel to use when an Entitlement is not explicitly set; can be hardcoded value or a function to invoke",isOpt:!0,gridInfo:"item",defVal:"'Full'"},{name:"moduleEntitlements",kind:"u",desc:"Returns either collection of `Entitlements`, or a function to invoke when an Entitlement is required",isOpt:!0,gridInfo:"item"}]},EvaluateExpressionExternallyContext:{name:"EvaluateExpressionExternallyContext",kind:"I",desc:"Context passed when evaluating `expressionOptions.evaluateExpressionExternally()`",props:[{name:"expression",kind:"s",desc:"Expression to evaluate",isOpt:!0},{name:"module",kind:"R",desc:"Module being evaluated: Alert, CalculatedColumn, ColumnFilter, GridFilter",ref:"AdaptableQLModule"},{name:"object",kind:"R",desc:"AdapTable Object which contains the Expression or Predicates",isOpt:!0,ref:"AdaptableObject"},{name:"predicates",kind:"a",desc:"Any Predicates to evaluate",isOpt:!0},{name:"referencedColumns",kind:"u",desc:"Columns contained in Expression",isOpt:!0}]},ExportConfig:{name:"ExportConfig",kind:"I",desc:"Config used when Exporting via API, allows fine grained exporting",props:[{name:"exportParams",kind:"u",desc:"Function to modify export params; receives default params & returns modified params",isOpt:!0},{name:"showProgressIndicator",kind:"b",desc:"Whether to show progress indicator",isOpt:!0}]},ExportDataFormatContext:{name:"ExportDataFormatContext",kind:"I",desc:"Context provided to `ExportOptions.exportDataFormat` callback",props:[{name:"column",kind:"u",desc:"The column being exported"}]},ExportDateFormatContext:{name:"ExportDateFormatContext",kind:"I",desc:"Context provided to `ExportOptions.exportDateFormat` callback",props:[{name:"column",kind:"u",desc:"The column being exported"}]},ExportDestinationType:{name:"ExportDestinationType",kind:"A",desc:"Configures which destination Reports get exported to"},ExportFormContext:{name:"ExportFormContext",kind:"I",desc:"Context required by functions when using an Export Button",props:[{name:"customDestination",kind:"R",desc:"Custom Export destination",ref:"CustomDestination"},{name:"report",kind:"R",desc:"The exported report",ref:"Report"},{name:"reportData",kind:"R",desc:"The data in the report",ref:"ExportResultData"}]},ExportOptions:{name:"ExportOptions",kind:"I",desc:"Options regarding Exporting data from AdapTable",props:[{name:"appendFileTimestamp",kind:"b",desc:"Whether to add a timestamp as a suffix to exported file name",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"csvSeparator",kind:"u",desc:"Separator for CSV exports",isOpt:!0,gridInfo:"item",defVal:"','"},{name:"customDestinations",kind:"u",desc:"User-provided Report Destinations (in addition to those shipped in AdapTable)",isOpt:!0},{name:"excelSheetName",kind:"u",desc:"Provides a custom name for the Excel sheet when exporting to Excel",isOpt:!0,defVal:"'Sheet1'"},{name:"exportDataFormat",kind:"u",desc:"Sets 'rawValue' or 'formattedValue' as Data format in Reports; can be set for whole grid, per Data Type, or per Column (via a function)",isOpt:!0,defVal:"rawValue"},{name:"exportDateFormat",kind:"u",desc:"Optional custom format for Date columns when exporting",isOpt:!0,gridInfo:"item",defVal:"undefined"},{name:"getDetailRows",kind:"u",desc:"Function to provide the Detail Rows when exporting in Master-Detail grids. This function will be invoked for each master row node.",isOpt:!0},{name:"isColumnExportable",kind:"f",desc:"Whether a Column is included in System Reports and available in UI for selection",isOpt:!0,defVal:"true"},{name:"processExport",kind:"u",desc:"Provides custom handling of the Export process before the default export is executed.",isOpt:!0},{name:"reportFilename",kind:"f",desc:"Provide a bespoke file name for the Report",isOpt:!0},{name:"skipColumnHeaders",kind:"u",desc:"Whether to exclude Column Headers from the exported data",isOpt:!0,defVal:"false"},{name:"systemExportDestinations",kind:"u",desc:"Export destinations to use; leave unset for all, empty array for none",isOpt:!0,gridInfo:"item",defVal:"'Download', 'Clipboard'"},{name:"systemReportFormats",kind:"u",desc:"System Report Formats to use; leave unset for all, empty array for none",isOpt:!0,gridInfo:"item",defVal:"'Excel', 'VisualExcel', 'CSV', 'JSON'"},{name:"systemReportNames",kind:"u",desc:"System Reports to use; leave unset for all, empty array for none",isOpt:!0,gridInfo:"item",defVal:"'All Data', 'Current Layout', 'Selected Data',"}]},ExportResultData:{name:"ExportResultData",kind:"A",desc:"Type of Export result data: string (CSV), ReportData (JSON), or Blob (Excel)"},ExportState:{name:"ExportState",kind:"I",desc:"Adaptable State Section for Export Module",props:[{name:"CurrentFormat",kind:"R",desc:"Selected Report Format - in Export Toolbar & Tool Panel",isOpt:!0,ref:"ReportFormatType"},{name:"CurrentReport",kind:"R",desc:"Selected Report Type - in Export Toolbar & Tool Panel",isOpt:!0,ref:"ReportNameType"},{name:"Reports",kind:"a",desc:"User-created Reports; each has Name and Row and Column Scope",isOpt:!0}]},ExpressionCategory:{name:"ExpressionCategory",kind:"A",desc:"Categories for Expression Functions"},ExpressionContext:{name:"ExpressionContext",kind:"I",desc:"Provides context to an Expression Function, including current row node and AdaptableApi",props:[{name:"dataChangedEvent",kind:"R",desc:"Changed cell data",isOpt:!0,ref:"CellDataChangedInfo"},{name:"evaluateCustomQueryVariable",kind:"u",desc:"Evaluate custom variables",isOpt:!0},{name:"filterFn",kind:"u",desc:"Optional filter function to be applied before evaluating the expression",isOpt:!0},{name:"functions",kind:"u",desc:"All Expression Functions available to AdaptableQL"},{name:"getRowNodes",kind:"u",desc:"Get custom list rows",isOpt:!0},{name:"namedQueryCallStack",kind:"a",desc:"All Named Query evaluations: tracked in order to detect circular dependencies",isOpt:!0},{name:"node",kind:"R",desc:"Current AG Grid Row Node being evaluated",ref:"unknown"},{name:"pivotResultColumn",kind:"R",desc:"Pivot Result Column when evaluating a Pivoted Column",isOpt:!0,ref:"unknown"},{name:"whereClauseFunctions",kind:"u",desc:"Expression Functions available to AdaptableQL in (optional) WHERE clause",isOpt:!0}]},ExpressionFunction:{name:"ExpressionFunction",kind:"I",desc:"Defines an AdaptableQL Function used in an Adaptable Expression",props:[{name:"category",kind:"R",desc:"Used to group Functions Expression Editor dropdown",isOpt:!0,ref:"ExpressionCategory"},{name:"description",kind:"s",desc:"What the AdaptableQL Function does",isOpt:!0},{name:"examples",kind:"a",desc:"Examples that demonstrate the AdaptableQL Function",isOpt:!0},{name:"handler",kind:"R",desc:"Actual AdaptableQL Function called by the Expression (mandatory prop)",ref:"ExpressionFunctionHandler"},{name:"hasEagerEvaluation",kind:"b",desc:"Whether Expression is evaluated without handling inner AST nodes",isOpt:!0},{name:"inputs",kind:"u",desc:"Data Types of Inputs required by Expression",isOpt:!0},{name:"isHiddenFromMenu",kind:"b",desc:"Removes entry from Expression Editor's Functions dropdown",isOpt:!0},{name:"returnType",kind:"'boolean' | 'number' | 'string' | 'date' | 'null' | 'any'",desc:"Type returned by Function: boolean, number, string, date, any",isOpt:!0},{name:"signatures",kind:"a",desc:"How the AdaptableQL Function should be called",isOpt:!0}]},ExpressionFunctionDocBlock:{name:"ExpressionFunctionDocBlock",kind:"A",desc:"Defines how an AdaptableQL Function is described in Expression Editor"},ExpressionFunctionHandler:{name:"ExpressionFunctionHandler",kind:"A",desc:"The javascript function which is invoked by an AdaptableQL Function"},ExpressionFunctionInputType:{name:"ExpressionFunctionInputType",kind:"A",desc:"Data Types of Inputs used by Expression (test, number, date, boolean)"},ExpressionFunctionMap:{name:"ExpressionFunctionMap",kind:"A",desc:"Key-Value map of Expression Names and their implementation"},ExpressionOptions:{name:"ExpressionOptions",kind:"I",desc:"Options for managing Expressions in AdapTable's Query Language",props:[{name:"caseSensitiveExpressions",kind:"b",desc:"Perform case-sensitive text comparisons when evaluating Expressions",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"customAggregatedFunctions",kind:"u",desc:"Bespoke Aggregated functions - to complement those provided by AdapTable",isOpt:!0},{name:"customBooleanFunctions",kind:"u",desc:"Custom Boolean Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (none)"},{name:"customQueryVariables",kind:"u",desc:"Values to be attached to variables so that a single value can easily be expressed multiple times within a query, or quickly changed to affect the results of a query; evaluated synchronously with each expression evaluation",isOpt:!0},{name:"customScalarFunctions",kind:"u",desc:"Custom Scalar Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (none)"},{name:"displayColumnFriendlyNamesForExpressions",kind:"b",desc:"Reference a Column's Header (i.e. FriendlyName) in all Expression overviews (instead of ColumnId)",isOpt:!0,noCode:"item",defVal:"true"},{name:"evaluateAdaptableQLExternally",kind:"u",desc:"Whether a Module (or specific expression) should be evaluated by AdapTableQL",isOpt:!0,defVal:"All Modules are evaluated by AdapTable"},{name:"fields",kind:"u",desc:"Fields are items in Data Source that are NOT columns but can be used in Expressions (via FIELD keyword)",isOpt:!0},{name:"isColumnQueryable",kind:"f",desc:"Can a given column be included in Expressions",isOpt:!0},{name:"maxTimeframeSize",kind:"n",desc:"Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe",isOpt:!0,gridInfo:"item",defVal:"28800000 (~8 hours)"},{name:"moduleExpressionFunctions",kind:"u",desc:"Module-specific Expression Functions available",isOpt:!0,gridInfo:"item",defVal:"undefined (defaults to available System & Custom values)"},{name:"performExpressionValidation",kind:"b",desc:"Validate Expressions before they can be run or saved",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"systemAggregatedBooleanFunctions",kind:"u",desc:"System AggregatedBoolean Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"},{name:"systemAggregatedScalarFunctions",kind:"u",desc:"System AggregatedScalar Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"undefined (sets all)"},{name:"systemBooleanFunctions",kind:"u",desc:"System Boolean Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"},{name:"systemObservableFunctions",kind:"u",desc:"System Observable Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"},{name:"systemScalarFunctions",kind:"u",desc:"System Scalar Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"}]},ExtendedLayout:{name:"ExtendedLayout",kind:"I",desc:"Defines an Extended Layout - provides a Layout and all objects that refer to it",props:[{name:"Extensions",kind:"a",desc:"Object to be included in the Layout"},{name:"Layout",kind:"R",desc:"Layout being extended",ref:"Layout"}]},ExternalChartingContext:{name:"ExternalChartingContext",kind:"I",desc:"Context passed to External Charting Options functions",props:[{name:"chartDefinition",kind:"u",desc:"Definition of External Chart"},{name:"container",kind:"R",desc:"Chart's Container",isOpt:!0,ref:"ChartContainer"}]},ExternalChartingOptions:{name:"ExternalChartingOptions",kind:"I",desc:"Options for managing External (i.e. non AG Grid) Charts",props:[{name:"isChartOpened",kind:"f",desc:"Needs to be implemented to specify if Chart is opened; used to set Show Button's highlighting",isOpt:!0},{name:"onDeleteChart",kind:"f",desc:"Called when User deletes a persisted Chart",isOpt:!0},{name:"onHideChart",kind:"f",desc:"Called when User clicks on Hide button next to Chart",isOpt:!0},{name:"onPreviewChart",kind:"u",desc:"Shows Chart in Settings Panel preview (not saved into State); returned definition will be passed to 'onHideChart' when Preview closes",isOpt:!0},{name:"onShowChart",kind:"f",desc:"Called when User clicks on Show button next to Chart",isOpt:!0}]},FDC3ActionColumn:{name:"FDC3ActionColumn",kind:"I",desc:"Action Column used for FDC3 workflows",props:[{name:"button",kind:"R",desc:"FDC3 Button to display",ref:"Fdc3AdaptableButton"},{name:"columnId",kind:"s",desc:"Id of the Column"},{name:"defaultWidth",kind:"n",desc:"Default Width of column",isOpt:!0},{name:"friendlyName",kind:"s",desc:"Column's friendly name",isOpt:!0}]},Fdc3AdaptableButton:{name:"Fdc3AdaptableButton",kind:"I",desc:"Button used in FDC3 Action Columns",props:[{name:"buttonStyle",kind:"u",desc:"Button's Style; can be object or function that provides `ButtonStyle` object",isOpt:!0},{name:"disabled",kind:"u",desc:"Function to disable / enable button based on evaluation result",isOpt:!0},{name:"hidden",kind:"u",desc:"Function to hide the Button",isOpt:!0},{name:"icon",kind:"u",desc:"Button's Icon; can be object or function that provides `AdaptableIcon` object",isOpt:!0},{name:"id",kind:"s",desc:"Unique id for the button"},{name:"label",kind:"u",desc:"Button's Label; can be string or function that provides string",isOpt:!0},{name:"tooltip",kind:"u",desc:"Button's Tooltip; can be string or function that provides string",isOpt:!0}]},Fdc3ButtonContext:{name:"Fdc3ButtonContext",kind:"I",desc:"Context provided in dynamic FDC3 Buttons",props:[{name:"context",kind:"R",desc:"The FDC3 Context",ref:"unknown"},{name:"intent",kind:"R",desc:"The FDC3 Intent",isOpt:!0,ref:"unknown"},{name:"primaryKeyValue",kind:"u",desc:"Primary key value of row"},{name:"rowData",kind:"u",desc:"The row data which is the source of the context data"},{name:"rowNode",kind:"R",desc:"The row node which is the source of the context data",ref:"unknown"}]},Fdc3ContextOptions:{name:"Fdc3ContextOptions",kind:"I",desc:"Options for configuring FDC3 Context Behaviour in AdapTable",props:[{name:"broadcasts",kind:"R",desc:"Broadcasts given standard Context(s) on various Grid Actions",isOpt:!0,ref:"BroadcastConfiguration"},{name:"handleContext",kind:"f",desc:"Handles incoming Contexts (standard and custom)",isOpt:!0},{name:"listensFor",kind:"a",desc:"Subscribe to given standard Context(s)",isOpt:!0}]},Fdc3IntentOptions:{name:"Fdc3IntentOptions",kind:"I",desc:"Options for configuring FDC3 Intent Behaviour in AdapTable",props:[{name:"handleIntent",kind:"u",desc:"Handles incoming Intents (standard and custom)",isOpt:!0},{name:"handleIntentResolution",kind:"u",desc:"Handles the IntentResolution that a raised Intent might return",isOpt:!0},{name:"listensFor",kind:"a",desc:"Subscribe to given standard Intent(s)",isOpt:!0},{name:"raises",kind:"R",desc:"Raises given standard Intent(s) on various Grid Actions",isOpt:!0,ref:"RaiseIntentConfiguration"}]},Fdc3Options:{name:"Fdc3Options",kind:"I",desc:"Options for configuring FDC3 in AdapTable",props:[{name:"actionColumnDefaultConfiguration",kind:"R",desc:"Configures the default FDC3 Actions column",isOpt:!0,ref:"ActionColumnDefaultConfiguration"},{name:"contexts",kind:"R",desc:"Configures FDC3 standard Contexts that AdapTable will listen for and broadcast",isOpt:!0,ref:"Fdc3ContextOptions"},{name:"enableLogging",kind:"b",desc:"Enable logging message exchanges to Console",isOpt:!0,defVal:"false"},{name:"gridDataContextMapping",kind:"R",desc:"Maps Context Type to AdapTable Grid Data",isOpt:!0,ref:"GridDataContextMapping"},{name:"intents",kind:"R",desc:"Configures FDC3 standard Intents that AdapTable will listen for and raise",isOpt:!0,ref:"Fdc3IntentOptions"},{name:"resolveContextData",kind:"u",desc:"Builds Context Data (useful for postprocessing Context Data mapped from Grid data)",isOpt:!0},{name:"uiControlsDefaultConfiguration",kind:"u",desc:"Customises FDC3 UI Controls",isOpt:!0}]},FilterActionOnDataChange:{name:"FilterActionOnDataChange",kind:"I",desc:"Whether Adaptable re-applies filtering after data edits; if `applyFilter` value is 'Throttle', `throttleDelay` should be set",props:[{name:"applyFilter",kind:"R",desc:"When to re-apply Filters: 'Always', 'Never' or 'Throttle'",ref:"ApplyFilterAction"},{name:"throttleDelay",kind:"n",desc:"Delay in ms (when `applyFilter` is set to 'Throttle')",isOpt:!0}]},FilterOptions:{name:"FilterOptions",kind:"I",desc:"Options for managing Column & Grid Filters in AdapTable",props:[{name:"clearFiltersOnStartUp",kind:"b",desc:"Clear Grid and Column Filters when AdapTable loads",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"columnFilterOptions",kind:"R",desc:"Options for managing Column Filters",isOpt:!0,ref:"ColumnFilterOptions"},{name:"customInFilterValues",kind:"u",desc:"Provide custom values (or sorting / count info) when using `In` Predicate in Column or Grid Filter",isOpt:!0},{name:"enableFilterOnSpecialColumns",kind:"b",desc:"Allow filtering on Calculated & FreeText columns",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"filterActionOnDataChange",kind:"R",desc:"When to re-filter grid after data changes: 'Always', 'Never' or 'Throttle' (with a delay value)",isOpt:!0,defVal:"'Always'",ref:"FilterActionOnDataChange"},{name:"gridFilterOptions",kind:"R",desc:"Options for managing the Grid Filter",isOpt:!0,ref:"GridFilterOptions"},{name:"isRowFilterable",kind:"f",desc:"Configures whether Rows will be evaluated when filtering",isOpt:!0},{name:"showDatePicker",kind:"b",desc:"Show Date Picker (or Date Input) in Filter controls",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"useAdaptableFiltering",kind:"b",desc:"Use Adaptable's Column & Grid Filters in preference to AG Grid's filtering",isOpt:!0,noCode:"item",defVal:"true"}]},FlashingCellDefinition:{name:"FlashingCellDefinition",kind:"I",desc:"The Flashing Cell Definition",props:[{name:"DownChangeStyle",kind:"R",desc:"Style for 'Down' value changes",isOpt:!0,defVal:"Red BackColour",ref:"AdaptableStyle"},{name:"FlashDuration",kind:"number | 'always'",desc:"Duration of Flash - can be number (in ms) or 'always'",isOpt:!0,defVal:"500ms"},{name:"FlashTarget",kind:"u",desc:"Should a cell or whole row flash",isOpt:!0,defVal:"'cell'"},{name:"NeutralChangeStyle",kind:"R",desc:"Style for 'Neutral' value changes",isOpt:!0,defVal:"Gray BackColour",ref:"AdaptableStyle"},{name:"Rule",kind:"R",desc:"When Flashing Cell should be triggered",ref:"unknown"},{name:"Scope",kind:"R",desc:"Which Columns, DataTypes or Column Types can Flash",ref:"ColumnScope"},{name:"UpChangeStyle",kind:"R",desc:"Style for 'Up' value changes",isOpt:!0,defVal:"Green BackColour",ref:"AdaptableStyle"}]},FlashingCellOptions:{name:"FlashingCellOptions",kind:"I",desc:"Properties for Flashing Cell",props:[{name:"defaultDownChangeStyle",kind:"R",desc:"Style for 'Down' value changes",isOpt:!0,defVal:"Red BackColour",ref:"AdaptableStyle"},{name:"defaultFlashDuration",kind:"number | 'always'",desc:"Duration of Flash - can be number (in ms) or 'always'",isOpt:!0,defVal:"500ms"},{name:"defaultFlashTarget",kind:"R",desc:"Should a cell or whole row flash",isOpt:!0,defVal:"'cell'",ref:"FlashTarget"},{name:"defaultNeutralChangeStyle",kind:"R",desc:"Style for 'Neutral' value changes",isOpt:!0,defVal:"Gray BackColour",ref:"AdaptableStyle"},{name:"defaultUpChangeStyle",kind:"R",desc:"Style for 'Up' value changes",isOpt:!0,defVal:"Green BackColour",ref:"AdaptableStyle"}]},FlashingCellState:{name:"FlashingCellState",kind:"I",desc:"Adaptable State Section for Flashing Cell module",props:[{name:"FlashingCellDefinitions",kind:"a",desc:"Flashing Cell Definitions - will flash cells/rows when rule is met",isOpt:!0}]},FlashTarget:{name:"FlashTarget",kind:"A",desc:"Where a Flash can happen"},FormatColumn:{name:"FormatColumn",kind:"I",desc:"Object used in Format Column function",props:[{name:"CellAlignment",kind:"R",desc:"Align cells 'Left' or 'Right' or 'Center'",isOpt:!0,ref:"CellAlignment"},{name:"ColumnGroupScope",kind:"R",desc:"When to format Columns in Column Groups ('Expanded', 'Collapsed', 'Both')",isOpt:!0,ref:"ColumnGroupScope"},{name:"DisplayFormat",kind:"R",desc:"Display Format to apply to Column can be Numeric, String or Date",isOpt:!0,ref:"AdaptableFormat"},{name:"RowScope",kind:"R",desc:"Which types of Rows to apply format (data, grouped, summary, total)",isOpt:!0,ref:"RowScope"},{name:"Rule",kind:"R",desc:"Rule to decide whether to apply Format; if undefined Format is always applied",isOpt:!0,ref:"FormatColumnRule"},{name:"Scope",kind:"R",desc:"Where Format will be applied: whole Row, some Columns, or Columns of DataType",ref:"ColumnScope"},{name:"Style",kind:"R",desc:"AdapTable Style to apply",isOpt:!0,ref:"AdaptableStyle"},{name:"Target",kind:"R",desc:"Where in Column to apply Format (`cell` or `columnHeader`)",isOpt:!0,defVal:"'cell'",ref:"FormatColumnTarget"}]},FormatColumnConfig:{name:"FormatColumnConfig",kind:"I",desc:"Config for api methods that get Format Columns"},FormatColumnOptions:{name:"FormatColumnOptions",kind:"I",desc:"Provides Custom Formats used in Format Column Module",props:[{name:"customDisplayFormatters",kind:"a",desc:"Custom Formatters to use in Format Column Module",isOpt:!0}]},FormatColumnPredicate:{name:"FormatColumnPredicate",kind:"I",desc:"Predicate used when creating a Format Column"},FormatColumnRule:{name:"FormatColumnRule",kind:"A",desc:"The Format Column Rule - can be either a Predicate or a BooleanExpression"},FormatColumnState:{name:"FormatColumnState",kind:"I",desc:"Adaptable State Section for Format Column Module",props:[{name:"FormatColumns",kind:"a",desc:"Collection of Format Columns",isOpt:!0}]},FormatColumnTarget:{name:"FormatColumnTarget",kind:"A",desc:"Specifies whether Column's cells or header is formatted"},FormContext:{name:"FormContext",kind:"I",desc:"Context supplied to Buttons that appear in an Adaptable Form",props:[{name:"formData",kind:"R",desc:"Adaptable Form Data",ref:"AdaptableFormData"}]},FreeTextColumn:{name:"FreeTextColumn",kind:"I",desc:"The FreeTextColumn object used in the Free Text Column function",props:[{name:"ColumnId",kind:"s",desc:"Id of Column"},{name:"DefaultValue",kind:"u",desc:"Initial value to use for each cell in the Column",isOpt:!0},{name:"FreeTextColumnSettings",kind:"R",desc:"Additional optional properties for Column (e.g. filterable, resizable)",ref:"FreeTextColumnSettings"},{name:"FreeTextStoredValues",kind:"a",desc:"Collection of Stored Values to aplly in the Column",isOpt:!0},{name:"FriendlyName",kind:"s",desc:"Friendly Name to use to refer to Column; if unset `ColumnId` is used",isOpt:!0},{name:"TextEditor",kind:"'Inline' | 'Large'",desc:"Cell editor to use when editing a string Free Text Column",isOpt:!0,defVal:"'Inline'"}]},FreeTextColumnSettings:{name:"FreeTextColumnSettings",kind:"I",desc:"Set of optional properties that define a FreeText Columns behaviour"},FreeTextColumnState:{name:"FreeTextColumnState",kind:"I",desc:"Adaptable State Section for the Free Text Column Module",props:[{name:"FreeTextColumns",kind:"a",desc:"Collection of Free Text Columns",isOpt:!0}]},FreeTextStoredValue:{name:"FreeTextStoredValue",kind:"I",desc:"Defines a cell value stored in a Free Text Column",props:[{name:"FreeText",kind:"u",desc:"Value to store in the cell"},{name:"PrimaryKey",kind:"u",desc:"Primary Key Column value for the row"}]},GetDetailRowsContext:{name:"GetDetailRowsContext",kind:"I",desc:"Context provided to `ExportOptions.getDetailRows()` callback used when exporting Detail Rows",props:[{name:"adaptableColumn",kind:"u",desc:"Column of Master Row Node"},{name:"createCellCsv",kind:"u",desc:"Factory function to create a CSV Cell"},{name:"createCellExcel",kind:"u",desc:"Factory function to create an Excel Cell"},{name:"createCellHeader",kind:"u",desc:"Factory function to create an Header Cell (either CSV or Excel)"},{name:"isExpanded",kind:"b",desc:"Whether the Master Row Node is expanded"},{name:"masterRowData",kind:"u",desc:"Data of Master Row Node"},{name:"masterRowNode",kind:"u",desc:"Master Row Node"}]},GetPrimaryKeyValueContext:{name:"GetPrimaryKeyValueContext",kind:"I",desc:"Context passed to the `getPrimaryKeyValue` function",props:[{name:"rowData",kind:"u",desc:"Data being imported"}]},GlobalExpressionFunctionsContext:{name:"GlobalExpressionFunctionsContext",kind:"I",desc:"Context provided to global expression functions properties property callback",props:[{name:"availableExpressionFunctionNames",kind:"u",desc:"The names of all expression functions available in this context"}]},GradientStyle:{name:"GradientStyle",kind:"I",desc:"Used to display Gradient Styles in Special Column Style"},GridCell:{name:"GridCell",kind:"I",desc:"Defines a Cell in Adaptable - every cell is an intersection of a Column Id and a Primary Key Value",props:[{name:"column",kind:"u",desc:"Column in which Cell is situated"},{name:"displayValue",kind:"u",desc:"Display value of Cell (e.g. if formatted)"},{name:"isPivotCell",kind:"b",desc:"Is Cell in a Pivot Column"},{name:"isRowGroupCell",kind:"b",desc:"Is Cell in a Row Group Column"},{name:"normalisedValue",kind:"u",desc:"Normalised value of Cell"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key column's value in row - how Adaptable locates the Cell",isOpt:!0},{name:"rawValue",kind:"u",desc:"Raw value of Cell"},{name:"rowNode",kind:"u",desc:"AG Grid Row Node that holds the Cell"},{name:"visible",kind:"b",desc:"Is Cell in a currently filtered Row",isOpt:!0}]},GridCellRange:{name:"GridCellRange",kind:"I",desc:"Defines a range of Cell - used in Grid Api Selection methods Typically use either PrimaryKey Values or Row Indexes",props:[{name:"columnIds",kind:"a",desc:"Columns to select"},{name:"primaryKeyValueEnd",kind:"u",desc:"Primary Key value of row at end of range",isOpt:!0},{name:"primaryKeyValueStart",kind:"u",desc:"Primary Key value of row at start of range",isOpt:!0},{name:"rowIndexEnd",kind:"u",desc:"Index of row at end of range",isOpt:!0},{name:"rowIndexStart",kind:"u",desc:"Index of row at start of range",isOpt:!0}]},GridDataContextMapping:{name:"GridDataContextMapping",kind:"I",desc:"Mapping of FDC3 Context Types to Grid Data/Columns"},GridFilter:{name:"GridFilter",kind:"I",desc:"Defines a Grid Filter (essentially a Boolean Expression)",props:[{name:"Expression",kind:"s",desc:"The (boolean) Expression to run",isOpt:!0}]},GridFilterEditors:{name:"GridFilterEditors",kind:"A",desc:"List of Editors that can be used when creating the Grid Filter"},GridFilterOptions:{name:"GridFilterOptions",kind:"I",desc:"Options for managing the Grid Filter in AdapTable",props:[{name:"availableFilterEditors",kind:"R",desc:"Which UI Components can be used to edit a Grid Filter: Expression Editor, Query Builder (or both)",isOpt:!0,defVal:"['ExpressionEditor', 'QueryBuilder']",ref:"GridFilterEditors"}]},GridRow:{name:"GridRow",kind:"I",desc:"Detailed information about a Row in AdapTable",props:[{name:"primaryKeyValue",kind:"u",desc:"Primary Key column's value for Row - how Adaptable locates a cell"},{name:"rowData",kind:"u",desc:"Actual data in the Row",isOpt:!0},{name:"rowInfo",kind:"R",desc:"Object which provides 'meta data' about the Row",isOpt:!0,ref:"RowInfo"},{name:"rowNode",kind:"u",desc:"AG Grid Row Node object for the Row",isOpt:!0}]},GroupKeys:{name:"GroupKeys",kind:"I",desc:"Enables setting Row Group behaviour with exceptions",props:[{name:"ExceptionGroupKeys",kind:"u",desc:"Exceptions to default behaviour, provided as array or arrays",isOpt:!0},{name:"RowGroupedColumns",kind:"a",desc:"Columns that are Row Grouped"}]},HandleFdc3Context:{name:"HandleFdc3Context",kind:"I",desc:"Context used when handling incoming FDC3 messages",props:[{name:"context",kind:"R",desc:"The FDC3 Context",ref:"unknown"},{name:"metadata",kind:"R",desc:"The FDC3 Context Metadata related to the context",isOpt:!0,ref:"unknown"}]},HandleFdc3IntentContext:{name:"HandleFdc3IntentContext",kind:"I",desc:"Context used when handling incoming FDC3 Intents",props:[{name:"intent",kind:"R",desc:"The FDC3 Intent",ref:"unknown"}]},HandleFdc3IntentResolutionContext:{name:"HandleFdc3IntentResolutionContext",kind:"I",desc:"Context provided in `handleIntentResolution` callback",props:[{name:"intentResolution",kind:"R",desc:"The FDC3 Intent Resolution",ref:"unknown"}]},HandleImportedDataContext:{name:"HandleImportedDataContext",kind:"I",desc:"Context used when importing Data",props:[{name:"data",kind:"u",desc:"Data which has been imported"}]},HandleImportedDataResolution:{name:"HandleImportedDataResolution",kind:"I",desc:"Resolution returned by the `handleImportedData` function",props:[{name:"addedRows",kind:"a",desc:"Rows that were added"},{name:"emitDataImportedEvent",kind:"b",desc:"Whether to emit the `DataImported` event"},{name:"updatedRows",kind:"a",desc:"Rows that were updated"}]},IAdaptableNoCodeWizard:{name:"IAdaptableNoCodeWizard",kind:"I",desc:"When you want to configure an Adaptable via json file D&D, use this instead of the normal Adaptable constructor"},InFilterValue:{name:"InFilterValue",kind:"I",desc:"Item in the IN Column Filter",props:[{name:"label",kind:"s",desc:"Item's label"},{name:"tooltip",kind:"boolean | string",desc:"Tooltip for Item (if true, the label is used as tooltip)",isOpt:!0},{name:"value",kind:"u",desc:"The value of Item being shown"}]},InFilterValueInfo:{name:"InFilterValueInfo",kind:"I",desc:"Information about items in the IN Column Filter",props:[{name:"count",kind:"n",desc:"How many times Item appears in the column",isOpt:!0},{name:"isSelected",kind:"b",desc:"Whether Item is currently selected",isOpt:!0},{name:"leafChildrenCount",kind:"n",desc:"For the grouping scenario, how many leafs are there under this item",isOpt:!0},{name:"visible",kind:"b",desc:"Whether Item is currently visible in Grid (i.e. in filtered rows)",isOpt:!0},{name:"visibleCount",kind:"n",desc:"How many times Item appears in the column in filtered rows",isOpt:!0}]},InFilterValueResult:{name:"InFilterValueResult",kind:"I",desc:"Result when providing custom values for the IN Column Filter",props:[{name:"skipDefaultSearch",kind:"b",desc:"If true, AdapTable will not filter the list using the current search value",isOpt:!0},{name:"values",kind:"a",desc:"List of Items to display in the IN Column Filter"}]},InitialState:{name:"InitialState",kind:"I",desc:"The initial state of Adaptable which is populated at design-time and used to create the Adaptable State - must include at least one Layout.",props:[{name:"Alert",kind:"R",desc:"Collection of `AlertDefinitions` which will fire Alerts when the rule is met",isOpt:!0,ref:"AlertState"},{name:"Application",kind:"R",desc:"Empty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.",isOpt:!0,ref:"ApplicationState"},{name:"CalculatedColumn",kind:"R",desc:"Collection of *CalculatedColumn* objects that will display a value based on other cells in the row (using a Calculated Column Expression)",isOpt:!0,ref:"CalculatedColumnState"},{name:"Charting",kind:"R",desc:"Named Charts (wrapping Chart models)",isOpt:!0,ref:"ChartingState"},{name:"CustomSort",kind:"R",desc:"Collection of *Custom Sort* objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways",isOpt:!0,ref:"CustomSortState"},{name:"Dashboard",kind:"R",desc:"Large series of properties to give users full control over the look and feel of the *Dashboard* - the section above the grid with toolbars and buttons",isOpt:!0,ref:"DashboardState"},{name:"Export",kind:"R",desc:"Collection of *Report* objects, together with name of the Current Report, as part of AdapTable export Module",isOpt:!0,ref:"ExportState"},{name:"FlashingCell",kind:"R",desc:"Definitions of which cells flash in response to data changes",isOpt:!0,ref:"FlashingCellState"},{name:"FormatColumn",kind:"R",desc:"Collection of *FormatColumn* objects that will style an entire column either fully or using a Condition",isOpt:!0,ref:"FormatColumnState"},{name:"FreeTextColumn",kind:"R",desc:"Collection of *FreeText* objects so users can make their own notes in bespoke columns that will get stored with their state (and not with the DataSource). Useful if needing a 'Comments' column.",isOpt:!0,ref:"FreeTextColumnState"},{name:"Layout",kind:"R",desc:"Collection of *Layouts* to name (and manage) sets of column visibility, order, grouping, sorts, aggregations, filters etc.",ref:"LayoutState"},{name:"NamedQuery",kind:"R",desc:"Named Queries available for use across multiple AdapTable Modules; and `CurrentQuery` - an Expression to run at start-up",isOpt:!0,ref:"NamedQueryState"},{name:"Note",kind:"R",desc:"Collection of personal Notes that are edited at Cell level",isOpt:!0,ref:"NoteState"},{name:"PlusMinus",kind:"R",desc:"Collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell",isOpt:!0,ref:"PlusMinusState"},{name:"QuickSearch",kind:"R",desc:"Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows",isOpt:!0,ref:"QuickSearchState"},{name:"Schedule",kind:"R",desc:"Collection of *Schedule* objects",isOpt:!0,ref:"ScheduleState"},{name:"Shortcut",kind:"R",desc:"Collection of *Shortcut* objects to aid data entry and prevent 'fat finger' issues",isOpt:!0,ref:"ShortcutState"},{name:"StatusBar",kind:"R",desc:"Configures the Adaptable Status Bar",isOpt:!0,ref:"StatusBarState"},{name:"StyledColumn",kind:"R",desc:"Collection of Special Column Styles",isOpt:!0,ref:"StyledColumnState"},{name:"Theme",kind:"R",desc:"Specifies current Theme and lists User and System themes available for selection",isOpt:!0,ref:"ThemeState"},{name:"ToolPanel",kind:"R",desc:"Sets order & visibility of Tool Panel controls in AdapTable ToolPanel (on right of grid)",isOpt:!0,ref:"ToolPanelState"}]},InteropioPluginOptions:{name:"InteropioPluginOptions",kind:"I",desc:"Options for using the Interop plugin",props:[{name:"showAdaptableAlertsAsNotifications",kind:"b",desc:"Converts AdapTable Alerts configured to display in popup as Interop Notifications",isOpt:!0,defVal:"true"}]},IPushPullDomain:{name:"IPushPullDomain",kind:"I",desc:"Internal object that maps an IPushPull Domain object",props:[{name:"FolderId",kind:"n",desc:"the Id of the Folder"},{name:"Name",kind:"s",desc:"the Name of the Domain / Folder"},{name:"Pages",kind:"a",desc:"The names of the pages within the (Folder)"}]},IPushPullPluginOptions:{name:"IPushPullPluginOptions",kind:"I",desc:"Options available in ipushpull plugin; allows users to collborate and share data in powerful ways",props:[{name:"autoLogin",kind:"b",desc:"Whether AdapTable should try log in to ipushpull automatically at start-up",isOpt:!0,defVal:"false"},{name:"includeSystemReports",kind:"b",desc:"Whether AdapTable will include System Reports (e.g. 'All Data', 'Selected Cells' etc) in the ipushpull toolbar dropdown",isOpt:!0,defVal:"true"},{name:"ippConfig",kind:"u",desc:"The config required to run ipushpull; use your ipushpull credentials",isOpt:!0},{name:"password",kind:"s",desc:"The user's ipushpull password; if supplied, pre-populates the login screen's password textbox",isOpt:!0},{name:"throttleTime",kind:"n",desc:"How many miliseconds AdapTable should throttle when sending data updates to ipushpull",isOpt:!0,defVal:"2000"},{name:"username",kind:"s",desc:"User's ipushpull user name (usually email address); if supplied, pre-populates the login screen's username textbox",isOpt:!0}]},IPushPullReport:{name:"IPushPullReport",kind:"I",desc:"An ipushpull report",props:[{name:"Folder",kind:"s",desc:"ipushpull Folder which contains the Page"},{name:"Page",kind:"s",desc:"ipushpull Page which will contain the data"},{name:"ReportName",kind:"s",desc:"Name of the Report"}]},IPushPullSchedule:{name:"IPushPullSchedule",kind:"I",desc:"Defines an ipushpull Schedule",props:[{name:"IPushPullReport",kind:"R",desc:"The report being exported to Excel (via ipushpull)",ref:"IPushPullReport"},{name:"Transmission",kind:"'Snapshot' | 'Live Data'",desc:"How data is sent: 'Snapshot' or 'Live Data'"}]},IPushPullState:{name:"IPushPullState",kind:"I",desc:"Internal State used by AdapTable for managing the ipushpull plugin"},IsRowFilterableContext:{name:"IsRowFilterableContext",kind:"I",desc:"Context used for setting whether a Row can be Column Filtered",props:[{name:"data",kind:"u",desc:"The data in the Row Node"},{name:"rowNode",kind:"R",desc:"The Row Node about to be evaluated",ref:"unknown"}]},Layout:{name:"Layout",kind:"A",desc:"Base Layout Type - Pivot or Table"},LayoutArray:{name:"LayoutArray",kind:"A",desc:"Array of Layouts - must contain at least one item"},LayoutBase:{name:"LayoutBase",kind:"I",desc:"Base object for both Table and Pivot Layouts",props:[{name:"AutoSizeColumns",kind:"b",desc:"Whether Columns should autosize when Layout first loads",isOpt:!0},{name:"ColumnFilters",kind:"a",desc:"Collection of Column Filters to apply in Layout",isOpt:!0},{name:"ColumnGroupValues",kind:"R",desc:"Defines which Column Groups are expanded / collapsed",isOpt:!0,ref:"ColumnGroupValues"},{name:"ColumnHeaders",kind:"R",desc:"Set of custom header names for some (or all) Columns",isOpt:!0,ref:"ColumnStringMap"},{name:"ColumnPinning",kind:"R",desc:"Details of which Columns are pinned",isOpt:!0,ref:"ColumnDirectionMap"},{name:"ColumnSizing",kind:"R",desc:"Controls size (width or flex & min/max) for Columns",isOpt:!0,ref:"ColumnSizingMap"},{name:"ColumnSorts",kind:"a",desc:"Sorting to apply in the Layout",isOpt:!0},{name:"GrandTotalRow",kind:"'top' | 'bottom' | 'pinnedTop' | 'pinnedBottom' | boolean",desc:"Position of the Grand Total Row in the Layout",isOpt:!0},{name:"GridFilter",kind:"R",desc:"Grid Filter to apply in Layout",isOpt:!0,ref:"GridFilter"},{name:"Name",kind:"s",desc:"Name of Layout as will appear in Layout toolbar and tool panel"},{name:"RowGroupDisplayType",kind:"'single' | 'multi'",desc:"Display Row Grouped Columns as 'single' or 'multi' column",isOpt:!0},{name:"RowGroupValues",kind:"R",desc:"Defines which Row Groups are expanded / collapsed",isOpt:!0,ref:"RowGroupValues"},{name:"SuppressAggFuncInHeader",kind:"b",desc:"Hides the aggFunc in Column header: e.g. 'sum(Price)' becomes 'Price'",isOpt:!0}]},LayoutCreationDefaultProperties:{name:"LayoutCreationDefaultProperties",kind:"I",desc:"Default properties to apply when creating a new Layout (Table or Pivot)",props:[{name:"pivotLayout",kind:"R",desc:"Default properties to apply when creating a new Pivot Layout",isOpt:!0,ref:"PivotLayoutCreationDefaultProperties"},{name:"tableLayout",kind:"R",desc:"Default properties to apply when creating a new Table Layout",isOpt:!0,ref:"TableLayoutCreationDefaultProperties"}]},LayoutCreationDefaultPropertiesContext:{name:"LayoutCreationDefaultPropertiesContext",kind:"I",desc:"Context for `LayoutOptions.layoutCreationDefaultProperties` function",props:[{name:"layoutType",kind:"'table' | 'pivot'",desc:"Type of Layout ('table' | 'pivot')"}]},LayoutExtendedConfig:{name:"LayoutExtendedConfig",kind:"I",desc:"Configuration for API methods which load objects that can be Layout extensions"},LayoutExtendedContext:{name:"LayoutExtendedContext",kind:"I",desc:"Context for `LayoutOptions.isObjectExtendedInLayout` function",props:[{name:"adaptableObject",kind:"R",desc:"Object being checked",ref:"LayoutExtensionObject"},{name:"layout",kind:"R",desc:"Current Layout",ref:"Layout"},{name:"module",kind:"R",desc:"Current Adaptable Module",ref:"LayoutExtensionModule"}]},LayoutExtension:{name:"LayoutExtension",kind:"I",desc:"Defines an object being extended in a Layout",props:[{name:"Module",kind:"R",desc:"Module to which Extended Object belongs",ref:"LayoutExtensionModule"},{name:"Object",kind:"R",desc:"Object being Extended",ref:"LayoutExtensionObject"}]},LayoutExtensionModule:{name:"LayoutExtensionModule",kind:"A",desc:"Modules which can provide objects in Extended Layouts"},LayoutExtensionObject:{name:"LayoutExtensionObject",kind:"A",desc:"Types of Adaptable Objects that can added to Extended Layouts"},LayoutOptions:{name:"LayoutOptions",kind:"I",desc:"Options for configuring Layouts; manage Column visibility, order, sorting, grouping, width etc.",props:[{name:"layoutCreationDefaultProperties",kind:"u",desc:"Default properties to apply when creating a new Layout (Table or Pivot)",isOpt:!0},{name:"layoutTagOptions",kind:"R",desc:"Set of options for leveraging Object Tags to extend Layouts",isOpt:!0,ref:"LayoutTagOptions"},{name:"layoutViewOptions",kind:"R",desc:"Set of options for how Layouts are displayed in Settings Panel",isOpt:!0,ref:"LayoutViewOptions"},{name:"pivotPreviewColumns",kind:"u",desc:"Columns to display in Table that opens when viewing Pivot Cell contents",isOpt:!0}]},LayoutState:{name:"LayoutState",kind:"I",desc:"Adaptable State Section for Layout Module, containing collection of Layouts and name of Current Layout",props:[{name:"CurrentLayout",kind:"s",desc:"Layout to be loaded when AdapTable starts (using `Name` property in Layout); if not provided the first Layout is used",isOpt:!0},{name:"Layouts",kind:"R",desc:"Collection of Layouts - can be Table or Pivot",ref:"LayoutArray"}]},LayoutTagOptions:{name:"LayoutTagOptions",kind:"I",desc:"Options for managing Tags in Layouts (used to enhance Layouts)",props:[{name:"autoCheckTagsForLayouts",kind:"b",desc:"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)",isOpt:!0,defVal:"false"},{name:"autoGenerateTagsForLayouts",kind:"u",desc:"Automatically generate an AdaptableObjectTag for each Layout",isOpt:!0,defVal:"false"},{name:"isObjectExtendedInLayout",kind:"f",desc:"Checks if provided Adaptable Object is extended in given Layout",isOpt:!0}]},LayoutViewOptions:{name:"LayoutViewOptions",kind:"I",desc:"Customize how Layouts are displayed in Settings Panel",props:[{name:"maxColumnsToDisplay",kind:"n",desc:"How many Column Names to display in inline Layout preview",isOpt:!0,defVal:"10"}]},LoadingScreenOptions:{name:"LoadingScreenOptions",kind:"I",desc:"Options for the Loading Screen shown when AdapTable is initialising",props:[{name:"loadingScreenDelay",kind:"n",desc:"Delay in ms before Loading Screen appears (`showLoadingScreen` must be true)",isOpt:!0,defVal:"200"},{name:"loadingScreenText",kind:"s",desc:"Text to display in Loading Screen.",isOpt:!0,defVal:"'Retrieving your settings and setting up Grid...'"},{name:"loadingScreenTitle",kind:"s",desc:"Title to display in Loading Screen.",isOpt:!0,defVal:"'Initialising Grid'"},{name:"showLoadingScreen",kind:"b",desc:"Display Loading message when AdapTable initialises",isOpt:!0,noCode:"item",defVal:"true"}]},MasterDetailPluginOptions:{name:"MasterDetailPluginOptions",kind:"I",desc:"Plugin Options used when creating a Master / Detail grid - passed into the plugin as the only argument.",props:[{name:"detailAdaptableOptions",kind:"R",desc:"`AdaptableOptions` used in Detail Grids; all share same behaviour & State",ref:"AdaptableOptions"},{name:"onDetailInit",kind:"f",desc:"Function called when a Detail Grid is initialised, receives context including Adaptable Api",isOpt:!0}]},MenuCategory:{name:"MenuCategory",kind:"A",desc:"Defines the Category of for a Menu Item"},MenuSeparator:{name:"MenuSeparator",kind:"A",desc:"A separator to add to Column or Context Menu"},ModuleExpressionFunctions:{name:"ModuleExpressionFunctions",kind:"I",desc:"Type specific Expression Functions",props:[{name:"customBooleanFunctions",kind:"u",desc:"Custom Boolean Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (none)"},{name:"customScalarFunctions",kind:"u",desc:"Custom Scalar Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (none)"},{name:"systemAggregatedBooleanFunctions",kind:"u",desc:"System AggregatedBoolean Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"},{name:"systemAggregatedScalarFunctions",kind:"u",desc:"System AggregatedScalar Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"},{name:"systemBooleanFunctions",kind:"u",desc:"System Boolean Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"},{name:"systemObservableFunctions",kind:"u",desc:"System Observable Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"},{name:"systemScalarFunctions",kind:"u",desc:"System Scalar Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"}]},ModuleExpressionFunctionsContext:{name:"ModuleExpressionFunctionsContext",kind:"I",desc:"Context provided to moduleExpressionFunctions property callback",props:[{name:"availableAggregatedBooleanFunctionNames",kind:"a",desc:"The global aggregated boolean expression functions"},{name:"availableAggregatedScalarFunctionNames",kind:"a",desc:"The global aggregated scalar expression functions"},{name:"availableBooleanFunctionNames",kind:"a",desc:"The global boolean expression functions"},{name:"availableObservableFunctionNames",kind:"a",desc:"The global observable expression functions"},{name:"availableScalarFunctionNames",kind:"a",desc:"The global scalar expression functions"},{name:"module",kind:"R",desc:"The Adaptable Module requesting the expression functions",ref:"AdaptableModule"}]},ModuleExpressionFunctionsMap:{name:"ModuleExpressionFunctionsMap",kind:"A",desc:"Module specific Expression Functions"},NamedQuery:{name:"NamedQuery",kind:"I",desc:"Defines a Query which can be referenced in AdaptableQL Expressions",props:[{name:"Name",kind:"s",desc:"Name of the Query - how it will appear in the Expression"}]},NamedQueryState:{name:"NamedQueryState",kind:"I",desc:"Adaptable State Section for Named Query Module",props:[{name:"NamedQueries",kind:"a",desc:"Named Queries which can be referenced in other Expressions",isOpt:!0}]},NotableCellContext:{name:"NotableCellContext",kind:"I",desc:"Context used when determining if a Note can be added to a Cell",props:[{name:"gridCell",kind:"R",desc:"Grid Cell in AdapTable which has been clicked",ref:"GridCell"}]},NoteOptions:{name:"NoteOptions",kind:"I",desc:"Options for managing AdapTable Notes",props:[{name:"dateFormat",kind:"u",desc:"Date Format string for Notes timestamp",isOpt:!0,defVal:"'dd-MM-yyyy HH:mm:ss'"},{name:"isCellNotable",kind:"f",desc:"Whether a cell can contain Notes",isOpt:!0},{name:"showPopupCloseButton",kind:"b",desc:"Show the Close Button in the Notes Popup",isOpt:!0,defVal:"true"}]},NoteState:{name:"NoteState",kind:"I",desc:"Adaptable State Section for Note Module",props:[{name:"Notes",kind:"R",desc:"Collection of AdapTable Notes",isOpt:!0,ref:"AdaptableNotes"}]},NotificationsOptions:{name:"NotificationsOptions",kind:"I",desc:"Options related to System Status Messages and Notifications in Adaptable.",props:[{name:"closeWhenClicked",kind:"b",desc:"Closes Notification automatically when its clicked",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"duration",kind:"number | 'always'",desc:"How long (in ms) Notifications display for",isOpt:!0,gridInfo:"item",defVal:"3000"},{name:"isDraggable",kind:"b",desc:"Can Notification be dragged",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"maxNotifications",kind:"n",desc:"How many Notifications can be displayed at one time",isOpt:!0,gridInfo:"item",defVal:"3"},{name:"maxSystemMessagesInStore",kind:"n",desc:"How many System Status Messages to hold in State; when limit is reached, oldest Message is removed",isOpt:!0,gridInfo:"item",defVal:"100"},{name:"pauseWhenHovering",kind:"b",desc:"Pauses the Notification when mouse hovers over it",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"position",kind:"R",desc:"Where Notification will appear (if anywhere)",isOpt:!0,gridInfo:"item",defVal:"'BottomRight'",ref:"ToastPositions"},{name:"showApplicationIcon",kind:"b",desc:"Displays the application icon in Notifications",isOpt:!0,defVal:"false"},{name:"showProgressBar",kind:"b",desc:"Shows a Progress Bar in the Notification",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"showSystemStatusMessageNotifications",kind:"b",desc:"Display System Status Messages as Notifications",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"transition",kind:"'Bounce' | 'Slide' | 'Zoom' | 'Flip'",desc:"How Notification will appear: Bounce, Slide, Zoom or Flip",isOpt:!0,gridInfo:"item",defVal:"'Slide'"}]},NumberFormatterOptions:{name:"NumberFormatterOptions",kind:"I",desc:"Formatter Options for Numeric Columns",props:[{name:"Abs",kind:"b",desc:"Returns absolute value of cell value",isOpt:!0},{name:"Ceiling",kind:"b",desc:"Returns smallest integer greater than cell value",isOpt:!0},{name:"Content",kind:"string | number",desc:"Replaces cell value with supplied value (that can contain Template Literals)",isOpt:!0},{name:"Empty",kind:"b",desc:"Show nothing in cell (but underlying value remains)",isOpt:!0},{name:"Floor",kind:"b",desc:"Returns largest integer cell value",isOpt:!0},{name:"FractionDigits",kind:"n",desc:"Number of digits to show in Fractions (up to 20)",isOpt:!0},{name:"FractionSeparator",kind:"s",desc:"Separator to use in fractions",isOpt:!0},{name:"IntegerDigits",kind:"n",desc:"Number of digits to show for Integers (up to 20)",isOpt:!0},{name:"IntegerSeparator",kind:"s",desc:"Separator to use in Integers",isOpt:!0},{name:"Multiplier",kind:"n",desc:"Multiplier to use on cell value",isOpt:!0},{name:"Parentheses",kind:"b",desc:"Shows negative numbers in parentheses",isOpt:!0},{name:"Prefix",kind:"s",desc:"Prefix to use before cell value",isOpt:!0},{name:"Round",kind:"b",desc:"Rounds cell value",isOpt:!0},{name:"Suffix",kind:"s",desc:"Suffix to use after cell value",isOpt:!0},{name:"Truncate",kind:"b",desc:"Truncates cell value",isOpt:!0}]},NumericStyledColumn:{name:"NumericStyledColumn",kind:"I",desc:"Base type for Numeric Styled Columns (i.e. Gradient and Percent Bar)",props:[{name:"CellRanges",kind:"a",desc:"Ranges (e.g. to create traffic light effect)",isOpt:!0},{name:"ColumnComparison",kind:"R",desc:"Compares Cell values to another Column",isOpt:!0,ref:"ColumnComparison"},{name:"RangeValueType",kind:"R",desc:"Used with Ranges; can be Number (any number or Col-Min/Col-Max) or 'Percentage' (values 0-100)",isOpt:!0,defVal:"Number",ref:"RangeValueType"}]},ObjectTagsContext:{name:"ObjectTagsContext",kind:"I",desc:"Context used when evaluating Object Tags"},OpenFinPluginOptions:{name:"OpenFinPluginOptions",kind:"I",desc:"Options required for when using the OpenFin plugin",props:[{name:"notificationTimeout",kind:"number | false",desc:"Timeout (in ms) for OpenFin Notifications to expire; set false for notifications not to auto-dismiss",isOpt:!0,defVal:"5000"},{name:"onNotificationAction",kind:"u",desc:"Function which is invoked when a button in OpenFin notification is clicked",isOpt:!0},{name:"onShowNotification",kind:"f",desc:"Updates OpenFin Notification object before it's displayed (just add/remove properties); return false to stop Notification showing",isOpt:!0},{name:"onValidationFailureInExcel",kind:"'override' | 'show-notification' | 'show-undo-notification'",desc:"Action to perform when a data change in Live Excel report triggers Prevent Edit Alert failure",isOpt:!0},{name:"showAdaptableAlertsAsNotifications",kind:"b",desc:"Converts AdapTable Alerts configured to display in popup as OpenFin Notifications",isOpt:!0,defVal:"true"},{name:"showAppIconInNotifications",kind:"u",desc:"Icon to show in Notification - uses the value supplied in UserInterfaceOptions",isOpt:!0,defVal:"true"},{name:"throttleTime",kind:"n",desc:"How long (in ms) AdapTable throttles when sending data update to OpenFin",isOpt:!0,defVal:"2000"}]},OpenFinReport:{name:"OpenFinReport",kind:"I",desc:"An OpenFin report",props:[{name:"ReportName",kind:"s",desc:"Name of Report (which will exist in the Export State)"}]},OpenFinSchedule:{name:"OpenFinSchedule",kind:"I",desc:"Defines a OpenFin Schedule - used in Schedule Module",props:[{name:"OpenFinReport",kind:"R",desc:"Report being exported to Excel (via OpenFin)",ref:"OpenFinReport"},{name:"Transmission",kind:"u",desc:"Whether Snapshot or Live Data (currently only the latter is supported)"}]},OpenFinState:{name:"OpenFinState",kind:"I",desc:"Internal State used by AdapTable for managing the OpenFin plugin"},PercentBarStyle:{name:"PercentBarStyle",kind:"I",desc:"Style used to display Percent Bars in Special Column Style",props:[{name:"BackColor",kind:"s",desc:"Background colour for 'Percent Bar'; leave unset if none required",isOpt:!0,defVal:"undefined"},{name:"CellText",kind:"R",desc:"Whether Cell shows Cell Value, Percent Value, both or none",isOpt:!0,ref:"CellTextOptions"},{name:"CellTextPosition",kind:"'Above' | 'Below' | 'Merged'",desc:"Position of text in Cell relative to Percent Bar, "Above", "Below" or "Merged"",isOpt:!0,defVal:"Below"},{name:"ToolTipText",kind:"R",desc:"Whether Tooltip shows Cell Value, Percent Value, both or none",isOpt:!0,ref:"CellTextOptions"}]},PivotAggregationColumns:{name:"PivotAggregationColumns",kind:"A",desc:"Defines an Aggregated Column in a Pivot Layout"},PivotAggregationTotalHeaderContext:{name:"PivotAggregationTotalHeaderContext",kind:"I",desc:"Context for Pivot Aggregation Totals",props:[{name:"aggregatedColumnId",kind:"s",desc:"Id of Aggregated Column"},{name:"aggregation",kind:"s",desc:"Aggregation function of Column"},{name:"columnType",kind:"u",desc:"Pivot Aggregation Total Column"},{name:"pivotColumnId",kind:"s",desc:"Id of Pivot Column"},{name:"pivotKey",kind:"s",desc:"Key (i.e. column value) of Pivot Column"}]},PivotColumnGroupHeaderContext:{name:"PivotColumnGroupHeaderContext",kind:"I",desc:"Context for Pivot Column Groups",props:[{name:"columnType",kind:"u",desc:"Pivot Column Group (created for each distinct value in a PivotColumn)"},{name:"groupId",kind:"s",desc:"Id of generated Column Group"},{name:"pivotKeys",kind:"a",desc:"Pivot Keys for Column Group"},{name:"state",kind:"'expanded' | 'collapsed'",desc:"Expanded / Collapsed state of Column Group"}]},PivotColumnTotalHeaderContext:{name:"PivotColumnTotalHeaderContext",kind:"I",desc:"Context for Pivot Total Columns",props:[{name:"aggregation",kind:"s",desc:"Aggregation function of Column"},{name:"columnType",kind:"u",desc:"Pivot Column Total"},{name:"pivotColumnId",kind:"s",desc:"Id of Pivot Column"},{name:"pivotKey",kind:"s",desc:"Key (i.e. column value) of Pivot Column"}]},PivotGrandTotalHeaderContext:{name:"PivotGrandTotalHeaderContext",kind:"I",desc:"Context for Pivot Grand Total Columns",props:[{name:"aggregatedColumnId",kind:"s",desc:"Id of Pivot Aggregated Column"},{name:"aggregation",kind:"s",desc:"Aggregation function of Column"},{name:"columnType",kind:"u",desc:"Pivot Grand Total Column"}]},PivotLayout:{name:"PivotLayout",kind:"I",desc:"Defines a Pivot-based Layout",props:[{name:"PivotAggregationColumns",kind:"R",desc:"Columns showing aggregated values in Group Rows; 1st value in record is Column name, 2nd is either aggfunc (e.g. sum, avg etc.) or 'true' (to use default aggfunc)",isOpt:!0,ref:"PivotAggregationColumns"},{name:"PivotColumns",kind:"a",desc:"Mandatory list of Columns to pivot (provide empty array if just displaying Aggregations)"},{name:"PivotColumnTotal",kind:"R",desc:"Display automatically calculated Totals within EACH Pivot Column Group, in the position specified",isOpt:!0,ref:"PivotTotalPosition"},{name:"PivotExpandLevel",kind:"n",desc:"How deep to expand Pivot Columns (0 for none, 1 for 1st level only etc, -1 to expand all)",isOpt:!0},{name:"PivotGrandTotal",kind:"R",desc:"Display automatically calculated Totals of all Pivot Columns, in the position specified",isOpt:!0,ref:"PivotTotalPosition"},{name:"PivotGroupedColumns",kind:"a",desc:"Columns which are row-grouped when the Layout is applied",isOpt:!0},{name:"RowGroupedColumns",kind:"u",desc:"Row Grouped Columns Columns - must NOT be provided",isOpt:!0},{name:"TableAggregationColumns",kind:"u",desc:"Table Aggregation Columns - must NOT be provided",isOpt:!0},{name:"TableColumns",kind:"u",desc:"Table Columns - must NOT be provided",isOpt:!0}]},PivotLayoutCreationDefaultProperties:{name:"PivotLayoutCreationDefaultProperties",kind:"A",desc:"Default properties to apply when creating a new Pivot Layout"},PivotPreviewColumnsContext:{name:"PivotPreviewColumnsContext",kind:"I",desc:"Context uses for pivotPreviewColumns function in Layout Options",props:[{name:"columnId",kind:"s",desc:"Column being opened"},{name:"layout",kind:"R",desc:"Current Layout",ref:"Layout"}]},PivotResultColumnHeaderContext:{name:"PivotResultColumnHeaderContext",kind:"I",desc:"Context for Pivot Result Columns",props:[{name:"aggregatedColumnId",kind:"s",desc:"Id of Pivot Aggregated Column"},{name:"aggregation",kind:"s",desc:"Aggregation function of Column"},{name:"columnId",kind:"s",desc:"Id of generated Column"},{name:"columnType",kind:"u",desc:"Pivot Result Column (unique intersection of PivotAggregationColumn and PivotColumn)"},{name:"pivotKeys",kind:"a",desc:"Current Pivot Keys"}]},PivotTotalPosition:{name:"PivotTotalPosition",kind:"A",desc:"Defines the position of Pivot Total position - 'before' or 'after' the Value Column(s)"},PlusMinusNudge:{name:"PlusMinusNudge",kind:"I",desc:"Defines a Plus Minus Rule - used in the Plus Minus Module",props:[{name:"NudgeValue",kind:"n",desc:"Amount by which to update cell when Rule is applied"},{name:"Rule",kind:"R",desc:"(Optional) Boolean Expression to determine whether to apply the Nudge",isOpt:!0,ref:"AdaptableBooleanQuery"},{name:"Scope",kind:"R",desc:"Where Rule is applied",ref:"ColumnScope"}]},PlusMinusState:{name:"PlusMinusState",kind:"I",desc:"Adaptable State Section for Plus Minus Module",props:[{name:"PlusMinusNudges",kind:"a",desc:"Array of Plus Minus Nudges",isOpt:!0}]},PopupType:{name:"PopupType",kind:"A",desc:"Type of Popup"},PredefinedConfig:{name:"PredefinedConfig",kind:"I",desc:"Deprecated initial state object (now replaced by InitialState)",props:[{name:"Alert",kind:"R",desc:"Collection of `AlertDefinitions` which will fire Alerts when the rule is met",isOpt:!0,ref:"AlertState"},{name:"Application",kind:"R",desc:"Empty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.",isOpt:!0,ref:"ApplicationState"},{name:"CalculatedColumn",kind:"R",desc:"Collection of *CalculatedColumn* objects that will display a value based on other cells in the row (using a Calculated Column Expression)",isOpt:!0,ref:"CalculatedColumnState"},{name:"Charting",kind:"R",desc:"Named Charts (wrapping Chart models)",isOpt:!0,ref:"ChartingState"},{name:"CustomSort",kind:"R",desc:"Collection of *Custom Sort* objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways",isOpt:!0,ref:"CustomSortState"},{name:"Dashboard",kind:"R",desc:"Large series of properties to give users full control over the look and feel of the *Dashboard* - the section above the grid with toolbars and buttons",isOpt:!0,ref:"DashboardState"},{name:"Export",kind:"R",desc:"Collection of *Report* objects, together with name of the Current Report, as part of AdapTable export Module",isOpt:!0,ref:"ExportState"},{name:"FlashingCell",kind:"R",desc:"* Objects which define which cells flash in response to data changes",isOpt:!0,ref:"FlashingCellState"},{name:"FormatColumn",kind:"R",desc:"Collection of *FormatColumn* objects that will style an entire column either fully or using a Condition",isOpt:!0,ref:"FormatColumnState"},{name:"FreeTextColumn",kind:"R",desc:"Collection of *FreeText* objects so users can make their own notes in bespoke columns that will get stored with their state (and not with the DataSource). Useful if needing a 'Comments' column.",isOpt:!0,ref:"FreeTextColumnState"},{name:"Layout",kind:"R",desc:"Collection of *Layouts* to name (and manage) sets of column visibility, order, grouping, sorts, aggregations, filters etc.",ref:"LayoutState"},{name:"NamedQuery",kind:"R",desc:"Named Queries available for use across multiple AdapTable Modules",isOpt:!0,ref:"NamedQueryState"},{name:"Note",kind:"R",desc:"Collection of personal Notes that are edited at Cell level",isOpt:!0,ref:"NoteState"},{name:"PlusMinus",kind:"R",desc:"Collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell",isOpt:!0,ref:"PlusMinusState"},{name:"QuickSearch",kind:"R",desc:"Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows",isOpt:!0,ref:"QuickSearchState"},{name:"Schedule",kind:"R",desc:"Collection of *Schedule* objects",isOpt:!0,ref:"ScheduleState"},{name:"Shortcut",kind:"R",desc:"Collection of *Shortcut* objects to aid data entry and prevent 'fat finger' issues",isOpt:!0,ref:"ShortcutState"},{name:"StatusBar",kind:"R",desc:"Configures the Adaptable Status Bar",isOpt:!0,ref:"StatusBarState"},{name:"StyledColumn",kind:"R",desc:"Collection of Special Column Styles",isOpt:!0,ref:"StyledColumnState"},{name:"Theme",kind:"R",desc:"Specifies the current Theme and lists the User and System themes available for selection.",isOpt:!0,ref:"ThemeState"},{name:"ToolPanel",kind:"R",desc:"Sets the order and visibility of the Tool Panel controls in the AdapTable ToolPanel (on right of grid)",isOpt:!0,ref:"ToolPanelState"}]},PredicateDefHandlerContext:{name:"PredicateDefHandlerContext",kind:"I",desc:"Object passed into an Adaptable Predicate Definition",props:[{name:"column",kind:"R",desc:"AdapTable Column which contains the cell",ref:"AdaptableColumn"},{name:"displayValue",kind:"u",desc:"Display value in cell being evaluated"},{name:"groupValues",kind:"a",desc:"For grouped columns, the array with all the values starting from the root group to the current node",isOpt:!0},{name:"inputs",kind:"a",desc:"Any (optional) inputs required to perform evaluation",isOpt:!0},{name:"node",kind:"R",desc:"AG Grid Row node which contains the cell",ref:"unknown"},{name:"oldValue",kind:"u",desc:"Previous value in cell (e.g. if evaluating an edit)"},{name:"predicatesOperator",kind:"u",desc:"Logic used when combining multiple Predicates ('AND'|'OR')",isOpt:!0},{name:"rawValue",kind:"u",desc:"Raw value in cell being evaluated (as per underlying data source)"},{name:"treeSelectionState",kind:"R",desc:"Optional TreeSelectionState - used for `In` predicate, when evaluating the grouped column. If this is not provided, another valid implementation is used.",isOpt:!0,ref:"unknown"},{name:"value",kind:"u",desc:"Value in cell being evaluated (normalized as per Column DataType)"}]},PredicateDefInput:{name:"PredicateDefInput",kind:"I",desc:"Defines an Input to a Predicate"},PredicateDefToStringParams:{name:"PredicateDefToStringParams",kind:"I",desc:"Inputs required for a Predicate"},PredicateModuleScope:{name:"PredicateModuleScope",kind:"A",desc:"Defines which Modules use the Predicate"},PredicateOptions:{name:"PredicateOptions",kind:"I",desc:"Options for managing Adaptable Predicates using AdaptableQL",props:[{name:"caseSensitivePredicates",kind:"u",desc:"Perform case-sensitive text comparisons when evaluating Predicates",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"customPredicateDefs",kind:"u",desc:"Definitions for Custom provided Predicates",isOpt:!0},{name:"evaluateInPredicateUsingTime",kind:"u",desc:"Should In Predicate evaluate using datetime, rather than date (the default)",isOpt:!0,noCode:"item",defVal:"false"},{name:"systemAlertPredicates",kind:"u",desc:"Which System Predicates are available in Alert Module",isOpt:!0},{name:"systemBadgeStylePredicates",kind:"u",desc:"Which System Predicates are available for Badge Styles",isOpt:!0},{name:"systemFilterPredicates",kind:"u",desc:"Which System Predicates are available when Filtering",isOpt:!0},{name:"systemFlashingCellPredicates",kind:"u",desc:"Which System Predicates are available in Flashing Cell Module",isOpt:!0},{name:"systemFormatColumnPredicates",kind:"u",desc:"Which System Predicates are available in Format Column Module",isOpt:!0}]},PredicatesOperator:{name:"PredicatesOperator",kind:"A",desc:"Logic used to join multiple Predicates"},PreprocessRowDataContext:{name:"PreprocessRowDataContext",kind:"I",desc:"Context used when pre-processing Import Data",props:[{name:"rowData",kind:"u",desc:"Data which has been imported"}]},ProcessExportContext:{name:"ProcessExportContext",kind:"I",desc:"Context used by the processExport function",props:[{name:"convertToCsv",kind:"f",desc:"Converts the Report Data to CSV format"},{name:"convertToExcel",kind:"u",desc:"Converts the Report Data to Excel format"},{name:"getReportColumns",kind:"u",desc:"Returns Columns to export based on Report's `ReportColumnScope`"}]},ProgressIndicatorConfig:{name:"ProgressIndicatorConfig",kind:"I",desc:"Config when displaying a Progress Indicator",props:[{name:"delay",kind:"n",desc:"Length of Delay",isOpt:!0},{name:"frameworkComponent",kind:"R",desc:"A React, Angular or Vue Framework component to use",isOpt:!0,ref:"AdaptableFrameworkComponent"},{name:"render",kind:"R",desc:"Render function",isOpt:!0,ref:"CustomRenderFunction"},{name:"renderMode",kind:"'content' | 'dialog'",desc:"Determines whether custom component is rendered as "content" (inside window) or "dialog" (replacing window)",isOpt:!0},{name:"text",kind:"s",desc:"Text to display",isOpt:!0}]},QueryableColumnContext:{name:"QueryableColumnContext",kind:"I",desc:"Context passed when evaluating Queryable Columns"},QuickSearchContext:{name:"QuickSearchContext",kind:"I",desc:"Context used when applying Quick Search in bespoke fashion",props:[{name:"gridCell",kind:"R",desc:"Cell being checked",ref:"GridCell"},{name:"quickSearchValue",kind:"s",desc:"Current Quick Search Text"}]},QuickSearchOptions:{name:"QuickSearchOptions",kind:"I",desc:"Options for configuring Quick Search",props:[{name:"clearQuickSearchOnStartUp",kind:"b",desc:"Clears saved searches when AdapTable loads",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"filterGridAfterQuickSearch",kind:"b",desc:"Filters Grid after quick search so only matching rows are displayed",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"getCellSearchText",kind:"f",desc:"Allows a different value to be used for a cell when searching (instead of its raw value)",isOpt:!0},{name:"isCellSearchable",kind:"f",desc:"Determines whether Quick Search should be applied to a given cell",isOpt:!0},{name:"isQuickSearchCaseSensitive",kind:"b",desc:"Run Quick Search using Case Sensitivity",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"quickSearchPlaceholder",kind:"s",desc:"Value to use as placeholder in QuickSearch controls (e.g. in Dashboard)",isOpt:!0,gridInfo:"item",defVal:"'Search'"}]},QuickSearchState:{name:"QuickSearchState",kind:"I",desc:"Adaptable State Section for Quick Search Module",props:[{name:"CellMatchStyle",kind:"u",desc:"Style used to highlight matching cells",isOpt:!0},{name:"CurrentTextMatchStyle",kind:"u",desc:"Style used to highlight matching text within current match (not availale in SSRM)",isOpt:!0},{name:"QuickSearchText",kind:"s",desc:"Last Quick Search that was run (and will be applied at start-up)",isOpt:!0},{name:"TextMatchStyle",kind:"u",desc:"Style used to highlight matching text within a cell (not availale in SSRM)",isOpt:!0}]},RaiseIntentConfig:{name:"RaiseIntentConfig",kind:"I",desc:"Config used when raising an FDC3 Intent",props:[{name:"actionButton",kind:"R",desc:"Definition of Action Button (to be put in default FDC3 Action Column)",isOpt:!0,ref:"Fdc3AdaptableButton"},{name:"actionColumn",kind:"u",desc:"Custom FDC3 Action Column definition for the Intent",isOpt:!0},{name:"contextMenu",kind:"u",desc:"Columns to display a 'Raise Intent' Context Menu item",isOpt:!0},{name:"contextType",kind:"R",desc:"Key of Context being Raised",ref:"unknown"},{name:"handleIntentResolution",kind:"u",desc:"Handles the IntentResolution for this specific raise intent configuration",isOpt:!0}]},RaiseIntentConfiguration:{name:"RaiseIntentConfiguration",kind:"I",desc:"Defines config options for Raising FDC3 Intents"},RangeValueType:{name:"RangeValueType",kind:"A",desc:"Whether the Range is Number or Percent based"},ReactFrameworkComponent:{name:"ReactFrameworkComponent",kind:"A",desc:"A function that returns a ReactNode"},ReminderSchedule:{name:"ReminderSchedule",kind:"I",desc:"Schedules a Reminder to appear at a given point in time",props:[{name:"DisplayNotification",kind:"b",desc:"Displays Reminder as a Toast Notification"},{name:"DisplaySystemStatusMessage",kind:"b",desc:"Shows Reminder as System Status Message",isOpt:!0},{name:"Header",kind:"s",desc:"Reminder header text"},{name:"Message",kind:"s",desc:"Reminder body text"},{name:"MessageType",kind:"R",desc:"Type of Message - 'Success', 'Info', 'Warning' or 'Error'",ref:"AdaptableMessageType"}]},Report:{name:"Report",kind:"I",desc:"A Report which can export data from AdapTable",props:[{name:"Name",kind:"R",desc:"Name of Report",ref:"ReportNameType"},{name:"Query",kind:"R",desc:"Query to use; only required if `ReportRowScope` is 'ExpressionRows'",isOpt:!0,ref:"AdaptableBooleanQuery"},{name:"ReportColumnScope",kind:"R",desc:"Columns to display: `AllColumns`, `VisibleColumns`, `SelectedColumns`, `ScopeColumns`",ref:"ReportColumnScope"},{name:"ReportRowScope",kind:"R",desc:"Rows to export: `AllRows`, `VisibleRows`, `SelectedRows`, `ExpressionRows`",ref:"ReportRowScope"},{name:"Scope",kind:"R",desc:"Columns Scope; only required if `ReportColumnScope` is 'ScopeColumns'",isOpt:!0,ref:"ColumnScope"}]},ReportColumn:{name:"ReportColumn",kind:"I",desc:"A Column exported in a Report",props:[{name:"field",kind:"s",desc:"Field in the row to get cell data from; defaults to `columnId`",isOpt:!0}]},ReportColumnScope:{name:"ReportColumnScope",kind:"A",desc:"Columns to be included in a Report"},ReportContext:{name:"ReportContext",kind:"I",desc:"Report Context sent when using Custom Export Destinations",props:[{name:"reportData",kind:"R",desc:"Export Data for the Report",ref:"ExportResultData"}]},ReportData:{name:"ReportData",kind:"I",desc:"Defines the data in a Report run by AdapTable",props:[{name:"columns",kind:"a",desc:"Columns in the Report"},{name:"groupColumnIds",kind:"a",desc:"Group columns IDs in the Report",isOpt:!0},{name:"pivotColumnIds",kind:"a",desc:"Pivot columns IDs in the Report",isOpt:!0},{name:"rows",kind:"u",desc:"Row Data in the Report"}]},ReportFileNameContext:{name:"ReportFileNameContext",kind:"I",desc:"Context used for providing a custom filename for a Report",props:[{name:"fileName",kind:"s",desc:"Default File Name to use"}]},ReportFormatType:{name:"ReportFormatType",kind:"A",desc:"Type of Report Format"},ReportNameType:{name:"ReportNameType",kind:"A",desc:"Type of Report Name"},ReportRowScope:{name:"ReportRowScope",kind:"A",desc:"AG Grid Row Data to be included in a Report"},ReportSchedule:{name:"ReportSchedule",kind:"I",desc:"Defines a Scheduled Report - used in Schedule Module (where State is stored)",props:[{name:"ExportDestination",kind:"R",desc:"Destination of Report to run on Schedule",isOpt:!0,ref:"ExportDestinationType"},{name:"ReportFormat",kind:"R",desc:"Format of Report to run on Schedule",ref:"ReportFormatType"},{name:"ReportName",kind:"s",desc:"Name of Report to run on Schedule"}]},ResolveContextDataContext:{name:"ResolveContextDataContext",kind:"I",desc:"Used to build Context Data",props:[{name:"contextMappedFromGridData",kind:"R",desc:"FDC3 Context Data which has been mapped from the grid data based on the given configuration in `gridDataContextMapping`",isOpt:!0,ref:"unknown"},{name:"contextType",kind:"R",desc:"FDC3 Context Type",ref:"unknown"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key value of row"},{name:"rowData",kind:"u",desc:"Row data which is the source of the context data"},{name:"rowNode",kind:"R",desc:"Row Node which is source of the context data",ref:"unknown"}]},RowDataChangeTrigger:{name:"RowDataChangeTrigger",kind:"A",desc:"What row action triggered the Row Change: 'Add', 'Update', 'Delete' or 'Load'"},RowFormColumnContext:{name:"RowFormColumnContext",kind:"I",desc:"Context used when decided if column should be included in a Row Form",props:[{name:"adaptableColumn",kind:"R",desc:"Column to be displayed",ref:"AdaptableColumn"},{name:"rowFormType",kind:"R",desc:"Type of Row Form",ref:"RowFormType"}]},RowFormContext:{name:"RowFormContext",kind:"A",desc:"Context passed into a Row Form - can be `CreateRowFormContext` or `EditRowFormContext`"},RowFormFieldContext:{name:"RowFormFieldContext",kind:"I",desc:"Context used for overriding Field elements in Row Form"},RowFormOptions:{name:"RowFormOptions",kind:"I",desc:"Options related to Dynamic Row Forms in AdapTable",props:[{name:"autoHandle",kind:"b",desc:"Whether AdapTable automatically updates AG Grid data model with created/edited/deleted rows",isOpt:!0,defVal:"true"},{name:"disableInlineEditing",kind:"b",desc:"Prevents direct editing in Grid cells even for editable columns",isOpt:!0,defVal:"false"},{name:"includeColumnInRowForm",kind:"f",desc:"Is given Column displayed in Row Form",isOpt:!0,defVal:"true"},{name:"onRowFormSubmit",kind:"u",desc:"Event fired when a Row Form is submitted via a standard button provided by AdapTable; this is not invoked when custom form buttons are provided",isOpt:!0,defVal:"undefined"},{name:"rowFormButtons",kind:"u",desc:"Custom form buttons; if provided, need to handle form submission explicitly",isOpt:!0},{name:"rowFormDescription",kind:"u",desc:"Custom form description provider",isOpt:!0,defVal:"undefined"},{name:"rowFormFieldLabel",kind:"u",desc:"Custom form field label provider",isOpt:!0,defVal:"undefined"},{name:"rowFormTitle",kind:"u",desc:"Custom form title provider",isOpt:!0,defVal:"'Create New Row'/'Edit Row'"},{name:"setPrimaryKeyValue",kind:"u",desc:"Function called when auto-handling 'create' or 'clone' Command Button; returned value should be valid for Primary Key column",isOpt:!0,defVal:"undefined"}]},RowFormTitleContext:{name:"RowFormTitleContext",kind:"I",desc:"Context used for overriding Title and Description of Row Form"},RowFormType:{name:"RowFormType",kind:"A",desc:"Type of RowForm: 'rowCreated' | 'rowEdited' | 'rowDeleted'"},RowGroupColumnHeaderContext:{name:"RowGroupColumnHeaderContext",kind:"I",desc:"Context for Columns created when Row Grouping",props:[{name:"columnId",kind:"s",desc:"Id of the Column"},{name:"columnType",kind:"u",desc:"A Row Grouped Column (created in both Table and Pivot Layout)"},{name:"groupColumnId",kind:"s",desc:"Id of Row Grouped Column"}]},RowGroupValues:{name:"RowGroupValues",kind:"A",desc:"Manages Row Group expand / collapse behaviour, including exceptions"},RowGroupValuesWithExceptionKeys:{name:"RowGroupValuesWithExceptionKeys",kind:"A",desc:"Defines which Row Groups are expanded or collapsed"},RowHighlightInfo:{name:"RowHighlightInfo",kind:"I",desc:"Define how to highlight a Row",props:[{name:"highlightStyle",kind:"R",desc:"Highlight style",ref:"AdaptableStyle"},{name:"primaryKeyValue",kind:"u",desc:"Primary key value for the row to be highlighted"},{name:"timeout",kind:"n",desc:"Timeout after which Row should be unhighlighted",isOpt:!0}]},RowInfo:{name:"RowInfo",kind:"I",desc:"Provides meta data about a Row in Adaptable",props:[{name:"isDisplayed",kind:"b",desc:"Is Row displayed (ie. filtered, not necessarily in viewport)",isOpt:!0},{name:"isExpanded",kind:"b",desc:"Is Row expanded (if a group row)",isOpt:!0},{name:"isGroup",kind:"b",desc:"Is Row grouped",isOpt:!0},{name:"isMaster",kind:"b",desc:"Is Row a Master Row (in a Master-Detail grid)",isOpt:!0},{name:"isSelected",kind:"b",desc:"Is Row selected",isOpt:!0},{name:"rowGroupLevel",kind:"n",desc:"What level the Row is (if Row Grouping is active)",isOpt:!0}]},RowScope:{name:"RowScope",kind:"I",desc:"Defines which types of Rows to exclude when rendering Format Columns, Action Columns and Badges",props:[{name:"ExcludeDataRows",kind:"b",desc:"Exclude regular data rows",isOpt:!0},{name:"ExcludeGroupRows",kind:"b",desc:"Exclude Group Rows",isOpt:!0},{name:"ExcludeSummaryRows",kind:"b",desc:"Exclude Summary Rows (used in Row Summaries)",isOpt:!0},{name:"ExcludeTotalRows",kind:"b",desc:"Exclude Grand Total Rows (used in Aggregations)",isOpt:!0}]},RowsHighlightInfo:{name:"RowsHighlightInfo",kind:"I",desc:"Defines how to highlight a set of Rows",props:[{name:"highlightStyle",kind:"R",desc:"Highlight style",ref:"AdaptableStyle"},{name:"primaryKeyValues",kind:"a",desc:"Primary key valuse for the rows to be highlighted"},{name:"timeout",kind:"n",desc:"Timeout after which the highlight is removed",isOpt:!0}]},RowSummary:{name:"RowSummary",kind:"I",desc:"Defines a Row Summary used in a Layout",props:[{name:"ColumnsMap",kind:"u",desc:"Map of Columns with Summary Expressions"},{name:"IncludeOnlyFilteredRows",kind:"b",desc:"Evaluates only currently filtered rows in the summary",isOpt:!0,defVal:"true"},{name:"Position",kind:"R",desc:"Where Row Summary appears - 'Top' or 'Bottom'",isOpt:!0,ref:"RowSummaryPosition"}]},RowSummaryPosition:{name:"RowSummaryPosition",kind:"A",desc:"Position of Row Summary - 'Top' or 'Bottom'"},SaveChartBehaviour:{name:"SaveChartBehaviour",kind:"A",desc:"How Charts are saved"},Schedule:{name:"Schedule",kind:"I",desc:"Defines when an action will be run - either one-off or recurring",props:[{name:"DaysOfWeek",kind:"R",desc:"Days on which Schedule will run",isOpt:!0,ref:"unknown"},{name:"Hour",kind:"n",desc:"Hour the Schedule will run"},{name:"Minute",kind:"n",desc:"Minute the Schedule will run"},{name:"OneOffDate",kind:"s",desc:"A one off date on which the Schedule will run",isOpt:!0}]},ScheduleState:{name:"ScheduleState",kind:"I",desc:"Adaptable State Section for the Schedule Module",props:[{name:"IPushPullSchedules",kind:"a",desc:"Schedules connected to ipushpull Reports - available if ipushpull plugin is running",isOpt:!0},{name:"OpenFinSchedules",kind:"a",desc:"Schedules connected to OpenFin exports - available if OpenFin plugin is running",isOpt:!0},{name:"Reminders",kind:"a",desc:"Schedules connected to Reminders - Alerts that fire at set times",isOpt:!0},{name:"ReportSchedules",kind:"a",desc:"Schedules connected to Reports (created in the Export function)",isOpt:!0}]},SelectedCellInfo:{name:"SelectedCellInfo",kind:"I",desc:"Describes which Cells are currently selected in AdapTable",props:[{name:"columns",kind:"u",desc:"Array of Columns which have selected cells"},{name:"gridCells",kind:"u",desc:"Array of GridCells (which provide cell value, primary kev value and other info)"}]},SelectedRowInfo:{name:"SelectedRowInfo",kind:"I",desc:"Description of currently selected Rows in AdapTable",props:[{name:"gridRows",kind:"u",desc:"Array of Grid Rows containing full information about a row in AdapTable"}]},ServerValidationContext:{name:"ServerValidationContext",kind:"I",desc:"Context used when validating data edits on Server",props:[{name:"cellDataChangedInfo",kind:"u",desc:"Details of Cell Edit"}]},ServerValidationResult:{name:"ServerValidationResult",kind:"I",desc:"Used for Server Validation ie. after an edit in AG Grid which must be checked on Server",props:[{name:"messageType",kind:"R",desc:"Type of Message to Display",isOpt:!0,defVal:"Info",ref:"AdaptableMessageType"},{name:"newCellValue",kind:"u",desc:"Cell Value to use for after Server Validation",isOpt:!0},{name:"validationHeader",kind:"s",desc:"Header to diplay with validation",isOpt:!0,defVal:"'Server Validation Message',"},{name:"validationMessage",kind:"s",desc:"Message to diplay with validation",isOpt:!0}]},SetPrimaryKeyValueContext:{name:"SetPrimaryKeyValueContext",kind:"I",desc:"Context for the setPrimaryKeyValue function",props:[{name:"rowData",kind:"u",desc:"Data in the row being created or cloned"}]},SettingsPanelOptions:{name:"SettingsPanelOptions",kind:"I",desc:"Options for managing the AdapTable Settings Panel",props:[{name:"alwaysShowInDashboard",kind:"b",desc:"Whether a Settings Panel button should always be displayed in `ModuleButtons` area of Dashboard",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"alwaysShowInToolPanel",kind:"b",desc:"Whether a Settings Panel button should always be displayed in `ModuleButtons` area of ToolPanel",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"customSettingsPanels",kind:"a",desc:"Custom Settings Panels provided by developers at design-time",isOpt:!0},{name:"icon",kind:"u",desc:"Icon shown in top left of Settings Panel: Can be `ConfigurationIcon`, `ApplicationIcon` or custom Icon",isOpt:!0,defVal:"`ConfigurationIcon`"},{name:"navigation",kind:"u",desc:"Ordered items to display at side of Settings Panel",isOpt:!0,defVal:"all available AdapTable modules"},{name:"popupType",kind:"R",desc:"Whether Settings Panel is 'window' (i.e. movable, resizable, no backdrop) or 'modal' (centre of screen with backdrop)",isOpt:!0,defVal:"'window'",ref:"PopupType"},{name:"position",kind:"u",desc:"Initial position of Settings Panel window",isOpt:!0,defVal:"Middle of Screen"},{name:"showModuleIcons",kind:"b",desc:"Whether to show Icons for each Module in the Setting Panel",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"size",kind:"u",desc:"Initial size of Settings Panel",isOpt:!0,defVal:"Computed based on size of screen"},{name:"title",kind:"s",desc:"Title for the Settings Panel",isOpt:!0,gridInfo:"item",defVal:"'Settings Panel'"}]},SharedEntitiesContext:{name:"SharedEntitiesContext",kind:"I",desc:"Context provided to `TeamSharingOptions.loadSharedEntities()` callback"},SharedEntity:{name:"SharedEntity",kind:"A",desc:"Defines an object used in Team Sharing. The union type is discriminated by the `EntityType` property (`adaptableEntity` / `customEntity`)."},SharedEntityType:{name:"SharedEntityType",kind:"A",desc:"Type of Shared Entity - Snapshot or Active"},Shortcut:{name:"Shortcut",kind:"I",desc:"Used to define a Shortcut as used in Shortcut State",props:[{name:"Scope",kind:"u",desc:"Numeric Columns where Shortcut is applied"},{name:"ShortcutKey",kind:"s",desc:"Key which triggers the Shortcut when pressed"},{name:"ShortcutOperation",kind:"'Add' | 'Subtract' | 'Multiply' | 'Divide'",desc:"The Operation: 'Add', 'Subtract', 'Multiply', 'Divide'"},{name:"ShortcutValue",kind:"n",desc:"Value acting as 2nd operand for ShortcutOperation (1st operand is the cell value)"}]},ShortcutScopeDataType:{name:"ShortcutScopeDataType",kind:"A",desc:"Shortcut scope data type."},ShortcutState:{name:"ShortcutState",kind:"I",desc:"Adaptable State Section for Shortcut Module",props:[{name:"Shortcuts",kind:"a",desc:"Collection of Shortcuts - designed to speed up data entry",isOpt:!0}]},SmartEditCustomOperation:{name:"SmartEditCustomOperation",kind:"A",desc:"Custom Operation used in Smart Edit Module"},SmartEditOperation:{name:"SmartEditOperation",kind:"A",desc:"Operation used by Smart Edit - either System or Custom"},SmartEditOperationContext:{name:"SmartEditOperationContext",kind:"I",desc:"Context used in Custom Smart Edit Operations",props:[{name:"currentCell",kind:"u",desc:"Current selected grid cell - contains column, row and cell value information"},{name:"smartEditValue",kind:"n",desc:"Smart Edit value"}]},SparklineStyle:{name:"SparklineStyle",kind:"A",desc:"Style to show for a Sparkline Column"},SpecialColumnSettings:{name:"SpecialColumnSettings",kind:"I",desc:"Base Settings for both Calculated and FreeText Columns",props:[{name:"Aggregatable",kind:"b",desc:"Whether Column can be used in an aggregation when grouping",isOpt:!0,defVal:"false"},{name:"ColumnTypes",kind:"a",desc:"Custom column types added to AG Grid Column Types when object is created",isOpt:!0},{name:"DataType",kind:"R",desc:"Expression's return value DataType, only mandatory property",ref:"AdaptableColumnDataType"},{name:"Filterable",kind:"b",desc:"Whether Column is filterable",isOpt:!0,defVal:"false"},{name:"Groupable",kind:"b",desc:"Whether Column can be grouped",isOpt:!0,defVal:"false"},{name:"HeaderToolTip",kind:"s",desc:"Tooltip to show in the Column Header (not cells)",isOpt:!0},{name:"Pivotable",kind:"b",desc:"Whether Column can be used when grid is in pivot mode",isOpt:!0,defVal:"false"},{name:"Resizable",kind:"b",desc:"Whether Column can be resized (by dragging column header edges)",isOpt:!0,defVal:"false"},{name:"Sortable",kind:"b",desc:"Whether Column is sortable",isOpt:!0,defVal:"false"},{name:"SuppressMenu",kind:"b",desc:"Whether if no menu should be shown for this Column header.",isOpt:!0,defVal:"false"},{name:"SuppressMovable",kind:"b",desc:"Whether if this Column should be movable via dragging",isOpt:!0,defVal:"false"},{name:"Width",kind:"n",desc:"Preferred (pixel) Column Width; if unset, calculated dynamically by AG Grid",isOpt:!0}]},StateOptions:{name:"StateOptions",kind:"I",desc:"Options related to Adaptable State hydration / dehydration; allows users to intercept state persistence and loading with custom functionality",props:[{name:"applyState",kind:"R",desc:"Transforms state before applying it to the application. Called after `loadState()` but before the state is used.",isOpt:!0,ref:"unknown"},{name:"autoMigrateState",kind:"b",desc:"Automatically migrate State from previous AdapTable version to current one",isOpt:!0,defVal:"true"},{name:"clearState",kind:"R",desc:"Allows clearing of remote Adaptable State. Only invoked during `StateApi.reloadInitialState()` operations.",isOpt:!0,defVal:"undefined",ref:"AdaptableClearStateFunction"},{name:"debounceStateDelay",kind:"n",desc:"Delay (in ms) to debounce `saveState` / `persistState` calls enabling grouping multiple sequential calls in single one (e.g. elevator doors)",isOpt:!0,defVal:"400"},{name:"loadState",kind:"R",desc:"Retrieves saved Adaptable State from storage or external source",isOpt:!0,ref:"AdaptableLoadStateFunction"},{name:"persistState",kind:"R",desc:"Handles the actual storage of state to localStorage, server, etc. Called after `saveState()` to store the prepared state.",isOpt:!0,ref:"AdaptablePersistStateFunction"},{name:"saveState",kind:"R",desc:"Transforms state before saving to storage. Called before `persistState()`.",isOpt:!0,ref:"AdaptableSaveStateFunction"}]},StatusBarState:{name:"StatusBarState",kind:"I",desc:"Adaptable State Section for the Adaptable Status Bar",props:[{name:"StatusBars",kind:"a",desc:"Adaptable Status Bars to display - can be unlimited and displayed in 3 locations",isOpt:!0,defVal:"null"}]},StringFormatterOptions:{name:"StringFormatterOptions",kind:"I",desc:"Formatter Options for String Columns",props:[{name:"Case",kind:"'Upper' | 'Lower' | 'Sentence'",desc:"Sets text to Upper or Lower case",isOpt:!0},{name:"Content",kind:"s",desc:"Replaces cell value; useful when using Condition (e.g. replace null with 'N/A')",isOpt:!0},{name:"Empty",kind:"b",desc:"Show nothing in cell (but underlying value remains)",isOpt:!0},{name:"Prefix",kind:"s",desc:"Prefix to use before the cell text",isOpt:!0},{name:"Suffix",kind:"s",desc:"Suffix to use after the cell text",isOpt:!0},{name:"Trim",kind:"b",desc:"Trims text (both start and end)",isOpt:!0}]},StyledColumn:{name:"StyledColumn",kind:"I",desc:"Object used in Special Column Style function",props:[{name:"BadgeStyle",kind:"R",desc:"Displays cell values in Column as a Badge",isOpt:!0,ref:"BadgeStyle"},{name:"ColumnId",kind:"s",desc:"Column being styled"},{name:"GradientStyle",kind:"R",desc:"Styles a numeric column with a Gradient",isOpt:!0,ref:"GradientStyle"},{name:"PercentBarStyle",kind:"R",desc:"Styles a numeric column so each cell displays a 'Bar'",isOpt:!0,ref:"PercentBarStyle"},{name:"SparklineStyle",kind:"R",desc:"Displays a Sparkline Chart in an array column",isOpt:!0,ref:"SparklineStyle"}]},StyledColumnState:{name:"StyledColumnState",kind:"I",desc:"Adaptable State Section for Styled Column Module",props:[{name:"StyledColumns",kind:"a",desc:"Collection of Special Column Styles",isOpt:!0}]},SuspendableObject:{name:"SuspendableObject",kind:"I",desc:"Interface that extends Adaptable Object for those config items that can be suspended at run-time",props:[{name:"IsSuspended",kind:"b",desc:"Suspends (i.e. turns off) an Adaptable Object",isOpt:!0}]},SystemAlertPredicateId:{name:"SystemAlertPredicateId",kind:"A",desc:"List of System Predicates available for Alerts"},SystemAlertPredicateIds:{name:"SystemAlertPredicateIds",kind:"A",desc:"Array containing all System Alert Predicates"},SystemBadgeStylePredicateId:{name:"SystemBadgeStylePredicateId",kind:"A",desc:"Predicates available when creating a Badge Style Rule"},SystemBadgeStylePredicateIds:{name:"SystemBadgeStylePredicateIds",kind:"A",desc:"System Predicate Ids available for Badge Style"},SystemExportDestination:{name:"SystemExportDestination",kind:"A",desc:"Export Destinations provided by AdapTable"},SystemExportDestinationsContext:{name:"SystemExportDestinationsContext",kind:"I",desc:"Context provided to `ExportOptions.systemExportDestinations` callback",props:[{name:"currentLayoutName",kind:"s",desc:"Name of current Layout"},{name:"currentReportFormat",kind:"R",desc:"Format of current Report",isOpt:!0,ref:"ReportFormatType"},{name:"currentReportName",kind:"R",desc:"Name of current Report",isOpt:!0,ref:"ReportNameType"},{name:"defaultSystemExportDestinations",kind:"a",desc:"Default System Export Destinations"}]},SystemFilterPredicateId:{name:"SystemFilterPredicateId",kind:"A",desc:"List of System Predicates available for Filters"},SystemFilterPredicateIds:{name:"SystemFilterPredicateIds",kind:"A",desc:"Array containing all System Filter Predicates"},SystemFlashingCellPredicateId:{name:"SystemFlashingCellPredicateId",kind:"A",desc:"List of System Predicates available for Flashing Cells"},SystemFlashingCellPredicateIds:{name:"SystemFlashingCellPredicateIds",kind:"A",desc:"Array containing all System Flashing Cell Predicates"},SystemFormatColumnPredicateId:{name:"SystemFormatColumnPredicateId",kind:"A",desc:"List of System Predicates available for Format Columns"},SystemFormatColumnPredicateIds:{name:"SystemFormatColumnPredicateIds",kind:"A",desc:"Array containing all System Format Column Predicates"},SystemPredicatesContext:{name:"SystemPredicatesContext",kind:"I",desc:"Context used for setting which System Predicates are available",props:[{name:"columnScope",kind:"R",desc:"Current Scope where Predicates are being used",ref:"ColumnScope"},{name:"moduleScope",kind:"R",desc:"Module for which Predicates are being retrieved",ref:"PredicateModuleScope"},{name:"systemPredicateDefs",kind:"u",desc:"AdapTable-provided System Predicate Definitions"}]},SystemReportFormat:{name:"SystemReportFormat",kind:"A",desc:"System report formats provided by AdapTable"},SystemReportFormatsContext:{name:"SystemReportFormatsContext",kind:"I",desc:"Context provided to `ExportOptions.systemReportFormats` callback",props:[{name:"currentLayoutName",kind:"s",desc:"Name of current Layout"},{name:"currentReportName",kind:"R",desc:"Name of current Report",isOpt:!0,ref:"ReportNameType"},{name:"defaultSystemReportFormats",kind:"a",desc:"Default System Report Formats"}]},SystemReportName:{name:"SystemReportName",kind:"A",desc:"System report names provided by AdapTable"},SystemReportNames:{name:"SystemReportNames",kind:"A",desc:"Array containing all System Report names"},SystemReportNamesContext:{name:"SystemReportNamesContext",kind:"I",desc:"Context provided to `ExportOptions.systemReportNames` callback",props:[{name:"currentLayoutName",kind:"s",desc:"Name of current Layout"},{name:"defaultSystemReportNames",kind:"a",desc:"Default System Report Names"}]},SystemStatusMessageInfo:{name:"SystemStatusMessageInfo",kind:"I",desc:"Wraps a System Status Message",props:[{name:"statusFurtherInformation",kind:"s",desc:"Additional information to display (optional)",isOpt:!0},{name:"statusMessage",kind:"s",desc:"The Message to be displayed"},{name:"statusType",kind:"R",desc:"Type of Message i.e. Succcess, Warning, Error, Info",ref:"AdaptableMessageType"},{name:"timestamp",kind:"d",desc:"When Message was sent",isOpt:!0}]},TableAggregationColumns:{name:"TableAggregationColumns",kind:"A",desc:"Defines an Aggregated Column in a Table Layout"},TableColumnGroupHeaderContext:{name:"TableColumnGroupHeaderContext",kind:"I",desc:"Context for Column Group headers",props:[{name:"childrenColumnIds",kind:"a",desc:"Ids of Column Group's children"},{name:"columnType",kind:"u",desc:"Table Column Group (used when Column Grouping in Table Layouts)"},{name:"groupId",kind:"s",desc:"Id of Column Group"},{name:"state",kind:"'expanded' | 'collapsed'",desc:"Expanded / Collapsed state of Column Group"}]},TableColumnHeaderContext:{name:"TableColumnHeaderContext",kind:"I",desc:"Context for standard Table Layout Columns",props:[{name:"aggregation",kind:"s",desc:"Aggregation function of Column (optional)",isOpt:!0},{name:"columnId",kind:"s",desc:"Id of the Column"},{name:"columnType",kind:"u",desc:"Table Column (created in Table Layouts)"}]},TableLayout:{name:"TableLayout",kind:"I",desc:"Defines a Table-based Layout",props:[{name:"ColumnVisibility",kind:"R",desc:"Map of Table Column Visibility",isOpt:!0,ref:"ColumnBooleanFalseMap"},{name:"PivotAggregationColumns",kind:"u",desc:"Pivot Aggregation Columns - must NOT be provided",isOpt:!0},{name:"PivotColumns",kind:"u",desc:"Pivot Columns - must NOT be provided",isOpt:!0},{name:"PivotExpandLevel",kind:"u",desc:"Pivot Expansions - must NOT be provided",isOpt:!0},{name:"PivotGroupedColumns",kind:"u",desc:"Pivot Group Columns - must NOT be provided",isOpt:!0},{name:"RowGroupedColumns",kind:"a",desc:"Columns which are row-grouped when the Layout is applied",isOpt:!0},{name:"RowSummaries",kind:"a",desc:"Pinned Rows that display Aggregation Info for a whole Column",isOpt:!0},{name:"TableAggregationColumns",kind:"R",desc:"Columns showing aggregated values in Grouped Rows; a record of ColumnId and aggfunc (e.g. sum) or 'true' (to use default aggfunc)",isOpt:!0,ref:"TableAggregationColumns"},{name:"TableColumns",kind:"a",desc:"List of Column Ids to include in Table Layout"}]},TableLayoutCreationDefaultProperties:{name:"TableLayoutCreationDefaultProperties",kind:"A",desc:"Default properties to apply when creating a new Table Layout"},TeamSharingOptions:{name:"TeamSharingOptions",kind:"I",desc:"Options for managing Team Sharing - which enables Adaptable Objects to be shared between colleagues",props:[{name:"applySharedEntities",kind:"u",desc:"Allows hooking into Shared Entities loading process",isOpt:!0},{name:"enableTeamSharing",kind:"b",desc:"Whether Team Sharing is enabled",gridInfo:"item",defVal:"false"},{name:"handleCustomSharedEntityImport",kind:"u",desc:"Handles import of Custom Shared Entities",isOpt:!0},{name:"loadSharedEntities",kind:"u",desc:"(Async) Loads available Shared Entities - user can download and auto-merge with Adaptable State",defVal:"null"},{name:"persistSharedEntities",kind:"u",desc:"(Async) Persists Shared Entities so that they can be downloaded by other team members",defVal:"null"},{name:"saveSharedEntities",kind:"u",desc:"Allows hooking into Shared Entities persistence process",isOpt:!0},{name:"showUpdateNotificationOncePerUpdate",kind:"b",desc:"Whether to show update notification once per update",isOpt:!0,defVal:"false"},{name:"suppressOverrideConfigWarning",kind:"b",desc:"Suppress warning when an Import overrides existing Adaptable State item",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"updateInterval",kind:"n",desc:"Frequency (in minutes) to check if Active Shared Entities have a newer revision",isOpt:!0,gridInfo:"item",defVal:"0 (never)"},{name:"updateNotification",kind:"'Alert' | 'AlertWithNotification' | 'SystemStatus'",desc:"How user is informed when Active Shared Entities have newer revisions",isOpt:!0,gridInfo:"item",defVal:"null (none)"}]},TeamSharingState:{name:"TeamSharingState",kind:"I",desc:"State for Team Sharing; internal so not designed to be provided as part of Initial Adaptable State",props:[{name:"ActiveSharedEntityMap",kind:"u",desc:"Mapping of active AdaptableObjects which are shared with the local state. Maps UUIDs of local AdaptableObjects to a snapshot of the latest synchronized SharedEntity"},{name:"importProcessInProgress",kind:"b",desc:"TRUE if an import is in progress, FALSE otherwise. This is required to skip the TEAMSHARING_UPDATE_ITEM action as a result of the import"},{name:"SharedEntities",kind:"a",desc:"List of objects currently being Team Shared"}]},ThemeState:{name:"ThemeState",kind:"I",desc:"Theme section of Adaptable State",props:[{name:"CurrentTheme",kind:"u",desc:"Name of current theme (or theme to set at startup); leave blank if using 'Light Theme', set to 'dark' for 'Dark Theme' or provide name of Custom Theme",isOpt:!0},{name:"SystemThemes",kind:"u",desc:"Which, if any, of the 2 themes shipped by Adaptable should be available; leave unset to provide both, or an empty array to provide neither.",isOpt:!0},{name:"UserThemes",kind:"a",desc:"Custom themes (of type AdaptableTheme) provided by developers",isOpt:!0}]},ToastPositions:{name:"ToastPositions",kind:"A",desc:"Different positions offered by Notifications"},ToastTransitions:{name:"ToastTransitions",kind:"A",desc:"Different transitions offered by Notifications"},Token:{name:"Token",kind:"A",desc:"Token used by the AdapTableQL parser"},ToolbarAction:{name:"ToolbarAction",kind:"A",desc:"Action available in Custom Toolbar - Close or Configure"},ToolbarActions:{name:"ToolbarActions",kind:"A",desc:"List of Actions available in Custom Toolbar"},ToolPanelButtonContext:{name:"ToolPanelButtonContext",kind:"I",desc:"Context required by functions when using a ToolPanel Button",props:[{name:"toolPanelState",kind:"R",desc:"Current ToolPanel State",ref:"ToolPanelState"}]},ToolPanelOptions:{name:"ToolPanelOptions",kind:"I",desc:"Options related to managing the AdapTable ToolPanel Component",props:[{name:"customButtons",kind:"a",desc:"ToolPanel Buttons provided by Users which perform custom behaviour",isOpt:!0},{name:"customToolPanels",kind:"a",desc:"ToolPanels provided by Users which contain custom content",isOpt:!0},{name:"showToolPanelsDropdown",kind:"b",desc:"Display the Tool Panels dropdown",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"}]},ToolPanelState:{name:"ToolPanelState",kind:"I",desc:"Adaptable State Section for the AdapTable ToolPanel",props:[{name:"ModuleButtons",kind:"R",desc:"AdapTable Module Buttons visible in ToolPanel",isOpt:!0,defVal:"Empty Array",ref:"unknown"},{name:"ToolPanels",kind:"a",desc:"Adaptable Tool Panels which are viaible",isOpt:!0,defVal:"ToolPanels for all available Modules (subject to Entitlement rules)"}]},ToolPanelVisibilityMode:{name:"ToolPanelVisibilityMode",kind:"A",desc:"Whether a ToolPanel displays as expanded or collapsed"},TransposeConfig:{name:"TransposeConfig",kind:"I",desc:"Config used when transposing a Grid",props:[{name:"autosize",kind:"b",desc:"Autosize columns in transposed view",isOpt:!0,defVal:"true"},{name:"hideTransposedColumn",kind:"b",desc:"Hide the Transposed Column",isOpt:!0,defVal:"true"},{name:"transposedColumnId",kind:"s",desc:"Column to use to do transposition",isOpt:!0,defVal:"Primary Key Column"},{name:"visibleColumns",kind:"b",desc:"Only show curerntly visible Columns",isOpt:!0,defVal:"false"},{name:"visibleRows",kind:"b",desc:"Only show curerntly visible Rows",isOpt:!0,defVal:"false"}]},UIControlConfig:{name:"UIControlConfig",kind:"I",desc:"Used to customise FDC3 controls (e.g. Action Columns)",props:[{name:"icon",kind:"R",desc:"Icon to display",isOpt:!0,ref:"AdaptableIcon"}]},UpgradeConfig:{name:"UpgradeConfig",kind:"I",desc:"Config object used by State Auto-migration Wizard",props:[{name:"fromVersion",kind:"n",desc:"AdapTable version to upgrade from"},{name:"logger",kind:"R",desc:"The logger object",isOpt:!0,defVal:"The console object",ref:"unknown"},{name:"toVersion",kind:"n",desc:"AdapTable version to upgrade to",isOpt:!0,defVal:"The current version"}]},UserColumnMenuItem:{name:"UserColumnMenuItem",kind:"I",desc:"Column Menu Item that is provided by User",props:[{name:"disabled",kind:"b",desc:"Whether menu item is disabled",isOpt:!0},{name:"hidden",kind:"b",desc:"Whether menu item is hidden",isOpt:!0},{name:"icon",kind:"R",desc:"Optional icon to display",isOpt:!0,ref:"AdaptableIcon"},{name:"label",kind:"s",desc:"Text to appear in the Menu Item"},{name:"menuType",kind:"u",desc:"Type of Menu - always 'User'"},{name:"onClick",kind:"f",desc:"Function invoked when the Menu Item is clicked",isOpt:!0},{name:"subMenuItems",kind:"a",desc:"Array of Menu Items, enabling limitless levels of menus",isOpt:!0}]},UserContextMenuItem:{name:"UserContextMenuItem",kind:"I",desc:"Context Menu Item that is provided by User",props:[{name:"disabled",kind:"b",desc:"Whether menu item is disabled",isOpt:!0},{name:"hidden",kind:"b",desc:"Whether menu item is hidden",isOpt:!0},{name:"icon",kind:"R",desc:"Optional icon to display",isOpt:!0,ref:"AdaptableIcon"},{name:"label",kind:"s",desc:"Text to appear in the Menu Item"},{name:"menuType",kind:"u",desc:"Type of Menu - always 'User'"},{name:"onClick",kind:"f",desc:"Function invoked when the Menu Item is clicked",isOpt:!0},{name:"subMenuItems",kind:"a",desc:"Array of Menu Items, enabling limitless levels of menus",isOpt:!0}]},UserInterfaceOptions:{name:"UserInterfaceOptions",kind:"I",desc:"Options for managing the User Interface of AdapTable",props:[{name:"alternativeModuleNames",kind:"a",desc:"Alternative names to use for Adaptable Modules in the UI",isOpt:!0,defVal:"null"},{name:"applicationIcon",kind:"R",desc:"The application icon to appear in Dashboard and elsewhere (e.g. in Notifications)",isOpt:!0,defVal:"null",ref:"AdaptableIcon"},{name:"colorPalette",kind:"u",desc:"Colours to display in Colour Picker (in place of AdapTable's default set); can be hardcoded list or function",isOpt:!0},{name:"customIcons",kind:"u",desc:"Bespoke icons that can be used in AdapTable (e.g. Badge Styles and Buttons)",isOpt:!0},{name:"dateInputOptions",kind:"R",desc:"Options for managing and customizing date inputs in AdapTable",isOpt:!0,ref:"DateInputOptions"},{name:"disableDeleteConfirmation",kind:"b",desc:"Hides confirmation dialog which displays whenever an AdaptableObject is deleted",isOpt:!0,noCode:"item",defVal:"false"},{name:"editableCellStyle",kind:"R",desc:"Style to set for editable Cells",isOpt:!0,ref:"AdaptableStyle"},{name:"editedCellStyle",kind:"R",desc:"Style to set for Cells which have been edited",isOpt:!0,ref:"AdaptableStyle"},{name:"englishVariant",kind:"'GB' | 'US'",desc:"English variant to use in AdapTable UI",isOpt:!0,gridInfo:"item",defVal:"'GB'"},{name:"loadingScreenOptions",kind:"R",desc:"Options for showing Loading Screen (during initialisation)",isOpt:!0,ref:"LoadingScreenOptions"},{name:"objectTags",kind:"u",desc:"Optional list of AdaptableObjectTags that can be associated with AdaptableObjects",isOpt:!0},{name:"readOnlyCellStyle",kind:"R",desc:"Style to set for non-editable Cells",isOpt:!0,ref:"AdaptableStyle"},{name:"showAdapTableVersion",kind:"b",desc:"Displays the AdapTable version in Grid Info section of Settings Panel",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"showAgGridVersion",kind:"b",desc:"Displays the AG Grid version in Grid Info section of Settings Panel",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"showDocumentationLinks",kind:"b",desc:"Provide links to AdapTable documentation (in Module popups and Expression Editor)",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"styleClassNames",kind:"a",desc:"Optional list of CSS styles that can be used when creating Adaptable Styles in Adaptable (e.g. in Format Column and other Modules)",isOpt:!0,gridInfo:"item"},{name:"useCustomMacLikeScrollbars",kind:"b",desc:"Show Mac-like scrollbars; size is configurable via CSS variable `--ab-custom-scrollbar-size` (default: `10px`)",isOpt:!0,gridInfo:"item",defVal:"false"}]},UserMenuItem:{name:"UserMenuItem",kind:"I",desc:"Menu Item which is added to Column or Context Menu - can contain sub items",props:[{name:"disabled",kind:"u",desc:"Function evaluating whether Menu Item is enabled",isOpt:!0},{name:"hidden",kind:"u",desc:"Function evaluating whether Menu Item is visible",isOpt:!0},{name:"icon",kind:"u",desc:"Optional icon to display",isOpt:!0},{name:"label",kind:"u",desc:"Text to appear in the Menu Item"},{name:"onClick",kind:"u",desc:"Function invoked when the Menu Item is clicked",isOpt:!0},{name:"subMenuItems",kind:"u",desc:"Array of Menu Items, enabling limitless levels of menus",isOpt:!0}]},VueFrameworkComponent:{name:"VueFrameworkComponent",kind:"A",desc:"Creates a Vue Component to be used in AdapTable UI controls"},WeightedAverageAggregation:{name:"WeightedAverageAggregation",kind:"I",desc:"Defines a Weighted Average Agg",props:[{name:"type",kind:"u",desc:"Type is always 'weightedAverage'"},{name:"weightedColumnId",kind:"s",desc:"Column which is weighted"}]},WindowPosition:{name:"WindowPosition",kind:"I",desc:"Defines position of a Custom Window"},WindowSize:{name:"WindowSize",kind:"I",desc:"Defines size of a Custom Window"}};
+export const ADAPTABLE_METAMODEL={AccessLevel:{name:"AccessLevel",kind:"A",desc:"Whether an Entitlement is `ReadOnly`, `Hidden` or `Full`"},ActionButtonCommand:{name:"ActionButtonCommand",kind:"A",desc:"Commands to assign to Action Buttons that open Row Forms: 'create', 'clone', 'edit' or 'delete'"},ActionColumn:{name:"ActionColumn",kind:"I",desc:"A Special Column that wraps an AdapTable Button",props:[{name:"actionColumnButton",kind:"u",desc:"Button (or list of buttons) to display in the Column"},{name:"actionColumnSettings",kind:"R",desc:"Optional properties to configure the Column (e.g. filterable, resizable)",isOpt:!0,ref:"ActionColumnSettings"},{name:"columnId",kind:"s",desc:"Mandatory 'Id'; if no value set for `FriendlyName`, this will also be Column name"},{name:"friendlyName",kind:"s",desc:"How Column appears in Column Header, Menus; if no value set, `ColumnId` is used",isOpt:!0},{name:"rowScope",kind:"R",desc:"Which types of Rows should contain buttons (i.e. data, grouped, summary)",isOpt:!0,ref:"RowScope"}]},ActionColumnButton:{name:"ActionColumnButton",kind:"I",desc:"Button that is displayed inside an Action Column",props:[{name:"command",kind:"R",desc:"Command to assign to Action Column Button that displays a Row Form",isOpt:!0,ref:"ActionButtonCommand"}]},ActionColumnContext:{name:"ActionColumnContext",kind:"I",desc:"Context required by functions when using an Action Column Button",props:[{name:"actionColumn",kind:"u",desc:"Action Column in question"},{name:"data",kind:"u",desc:"The current row's data"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key Value in current row"},{name:"rowNode",kind:"u",desc:"Current AG Grid Row Node"}]},ActionColumnDefaultConfiguration:{name:"ActionColumnDefaultConfiguration",kind:"I",desc:"Default configuration to use for an FDC3 Action Column",props:[{name:"columnId",kind:"s",desc:"Column Id",isOpt:!0,defVal:"'fdc3ActionColumn'"},{name:"headerName",kind:"s",desc:"Column Header",isOpt:!0,defVal:"'FDC3 Actions'"},{name:"movable",kind:"b",desc:"If Column is movable",isOpt:!0,defVal:"true"},{name:"resizable",kind:"b",desc:"If Column is resizable",isOpt:!0,defVal:"true"},{name:"rowScope",kind:"R",desc:"Which rows button appears in",isOpt:!0,defVal:"data rows only",ref:"RowScope"},{name:"width",kind:"n",desc:"Column Width in pixels",isOpt:!0,defVal:"200"}]},ActionColumnOptions:{name:"ActionColumnOptions",kind:"I",desc:"Options related to Action Columns in AdapTable",props:[{name:"actionColumns",kind:"u",desc:"Columns which contain an AdapTable Button - used for performing Actions",isOpt:!0,defVal:"undefined"}]},ActionColumnSettings:{name:"ActionColumnSettings",kind:"I",desc:"Set of optional properties that define an Action Columns behaviour",props:[{name:"resizable",kind:"b",desc:"Whether Column can be resized (by dragging column header edges)",isOpt:!0,defVal:"true"},{name:"suppressMenu",kind:"b",desc:"Whether no menu should be shown for this Column header.",isOpt:!0,defVal:"false"},{name:"suppressMovable",kind:"b",desc:"Whether if this Column should be movable via dragging",isOpt:!0,defVal:"false"},{name:"width",kind:"n",desc:"Preferred width (in pixels) for Column; if unset, calculated dynamically by AG Grid",isOpt:!0}]},AdaptableAggregatedBooleanQuery:{name:"AdaptableAggregatedBooleanQuery",kind:"I",desc:"Wraps an AdapTableQL Aggregated Boolean Expression",props:[{name:"AggregatedBooleanExpression",kind:"s",desc:"AdapTableQL Expression that returns true / false based on multiple rows"}]},AdaptableAggregatedScalarQuery:{name:"AdaptableAggregatedScalarQuery",kind:"I",desc:"Wraps an AdapTableQL Aggregated Scalar Expression",props:[{name:"AggregatedScalarExpression",kind:"s",desc:"AdapTableQL Expression that returns any value based on multiple rows"}]},AdaptableAlert:{name:"AdaptableAlert",kind:"A",desc:"Defines an Alert fired by AdapTable"},AdaptableAlertBase:{name:"AdaptableAlertBase",kind:"I",desc:"Defines the base(common) properties of an Alert fired by AdapTable, regardless of the type of change",props:[{name:"alertDefinition",kind:"R",desc:"Rule that caused Alert to fire",ref:"AlertDefinition"},{name:"alertType",kind:"u",desc:"The type of Alert"},{name:"header",kind:"s",desc:"Alert Header text"},{name:"message",kind:"s",desc:"Alert Body text"}]},AdaptableAlertCommand:{name:"AdaptableAlertCommand",kind:"A",desc:"Commands available in an Alert"},AdaptableAlertQuery:{name:"AdaptableAlertQuery",kind:"A",desc:"Alert Query which may be either a Boolean, Observable or AggregatedBoolean Expression"},AdaptableAlertType:{name:"AdaptableAlertType",kind:"A",desc:"Type of AdapTable Alert: generic, cellChange or rowChange"},AdaptableBaseIcon:{name:"AdaptableBaseIcon",kind:"I",desc:"Base interface for AdaptableIcon",props:[{name:"className",kind:"s",desc:"The class name of the icon",isOpt:!0},{name:"style",kind:"R",desc:"CSS Properties",isOpt:!0,ref:"unknown"}]},AdaptableBooleanQuery:{name:"AdaptableBooleanQuery",kind:"I",desc:"Wraps an AdapTableQL Boolean Expression",props:[{name:"BooleanExpression",kind:"s",desc:"AdapTableQL Expression that returns true / false"}]},AdaptableButton:{name:"AdaptableButton",kind:"I",desc:"Defines a Button that appears in numerous places including Adaptable Form",props:[{name:"buttonStyle",kind:"u",desc:"Style for Button - can be object or function that provides a `ButtonStyle` object",isOpt:!0},{name:"disabled",kind:"u",desc:"Function that disables / enables the button based on its evaluation result",isOpt:!0},{name:"hidden",kind:"u",desc:"Function which sets whether Button is hidden",isOpt:!0},{name:"icon",kind:"u",desc:"Icon for Button - can be object or function that provides a `AdaptableIcon` object",isOpt:!0},{name:"label",kind:"u",desc:"Label for Button - can be string or function that provides string",isOpt:!0},{name:"onClick",kind:"u",desc:"Function to invoke when button is clicked",isOpt:!0},{name:"tooltip",kind:"u",desc:"Tooltip for Button - can be string or function that provides string",isOpt:!0}]},AdaptableCalculatedColumnQuery:{name:"AdaptableCalculatedColumnQuery",kind:"A",desc:"Calculated Column Query which may be a Scalar or an AggregatedScalar Expression"},AdaptableCellChangedAlert:{name:"AdaptableCellChangedAlert",kind:"I",desc:"Defines an Alert fired by AdapTable when a cell is changed",props:[{name:"cellDataChangedInfo",kind:"u",desc:"Cell DataChange which triggered Alert"}]},AdaptableClearStateFunction:{name:"AdaptableClearStateFunction",kind:"I",desc:"Function that clears persisted state from the storage system. Only invoked during `StateApi.reloadInitialState()` operations."},AdaptableColumn:{name:"AdaptableColumn",kind:"I",desc:"Defines an AdapTable Column - created at run-time based on AG Grid ColDef",props:[{name:"aggregatable",kind:"b",desc:"Is Column able to display aggregations (e.g. 'sum') when grouped"},{name:"aggregationFunction",kind:"s",desc:"Custom Aggregation function for the Column",isOpt:!0},{name:"alwaysHidden",kind:"b",desc:"Whether the Column is always hidden in the UI but still available programmatically"},{name:"availableAggregationFunctions",kind:"a",desc:"Available Aggregations for the Column",isOpt:!0},{name:"columnGroup",kind:"R",desc:"The parent Column group (if Column belongs to one)",isOpt:!0,ref:"AdaptableColumnGroup"},{name:"exportable",kind:"b",desc:"Whether the Column can be included in Reports"},{name:"field",kind:"u",desc:"Field in the row to get cell data from",isOpt:!0},{name:"fieldOnly",kind:"b",desc:"Is the Column ONLY available as a field and never visible"},{name:"filterable",kind:"b",desc:"Is Column able to be filtered"},{name:"flex",kind:"n",desc:"Flex details of the Column",isOpt:!0},{name:"groupable",kind:"b",desc:"Can Column form a Row Group"},{name:"hideable",kind:"b",desc:"Can Column be removed from the grid"},{name:"isActionColumn",kind:"b",desc:"Is Column an Action Column"},{name:"isCalculatedColumn",kind:"b",desc:"Is Column a Calculated Column"},{name:"isFixed",kind:"b",desc:"Is Column pinned or locked into position"},{name:"isFreeTextColumn",kind:"b",desc:"Is Column a Free Text Column"},{name:"isGeneratedPivotResultColumn",kind:"b",desc:"Is Column a generated Pivot Result Column"},{name:"isGeneratedRowGroupColumn",kind:"b",desc:"Is Column a generated Row Group Column"},{name:"isGeneratedSelectionColumn",kind:"b",desc:"Is Column a generated Selection Column"},{name:"isGrouped",kind:"b",desc:"Is Column currently Row-Grouped"},{name:"isPivotTotalColumn",kind:"b",desc:"Is Column a Pivot Total Column (GrandTotal, GroupTotal, AggregationTotal)"},{name:"isPrimaryKey",kind:"b",desc:"Is this the Primary Key Column"},{name:"isSparkline",kind:"b",desc:"Is it a Sparkline Column"},{name:"isTreeColumn",kind:"b",desc:"Whether the Column is the Tree Column (in Tree View)"},{name:"moveable",kind:"b",desc:"Can Column be moved at run-time to a new position"},{name:"pinned",kind:"'left' | 'right' | false",desc:"The pinned position of the Column"},{name:"pivotable",kind:"b",desc:"Can Column be used in a Pivot Layout"},{name:"queryable",kind:"b",desc:"Can the Column be in included in Queries / Expressions"},{name:"readOnly",kind:"b",desc:"Is Column editable; returns FALSE if Column has conditional/dynamic editability, assuming some rows are editable"},{name:"resizable",kind:"b",desc:"Is Column resizable"},{name:"sortable",kind:"b",desc:"Is Column sortable"},{name:"visible",kind:"b",desc:"Is Column currently visible"},{name:"width",kind:"n",desc:"Column width",isOpt:!0}]},AdaptableColumnBase:{name:"AdaptableColumnBase",kind:"I",desc:"Base class for AdapTable Column containing most important properties",props:[{name:"columnId",kind:"s",desc:"Name of Column in AG Grid (e.g. field or colId)"},{name:"columnTypes",kind:"a",desc:"Column Types of the Column",isOpt:!0},{name:"dataType",kind:"R",desc:"DataType of the Column",ref:"AdaptableColumnDataType"},{name:"friendlyName",kind:"s",desc:"How Column is referred to in Adaptable UI; `Caption` property in AG Grid"}]},AdaptableColumnContext:{name:"AdaptableColumnContext",kind:"I",desc:"Context provided for per Column callbacks",props:[{name:"column",kind:"u",desc:"The current Column"}]},AdaptableColumnDataType:{name:"AdaptableColumnDataType",kind:"A",desc:"Defines data type of a Column; can be an AG Grid BaseCellDataType or an AdapTable array-related one"},AdaptableColumnGroup:{name:"AdaptableColumnGroup",kind:"I",desc:"Defines a Column Group",props:[{name:"allowGroupSplit",kind:"b",desc:"Whether the Group can be split"},{name:"columnGroupId",kind:"s",desc:"Id for the Column Group"},{name:"friendlyName",kind:"s",desc:"Friendly name for the Group"},{name:"groupCount",kind:"n",desc:"Number of Columns in the the Group"}]},AdaptableColumnMenuItem:{name:"AdaptableColumnMenuItem",kind:"A",desc:"Menu item used by Adaptable in Column Menus"},AdaptableColumnMenuItemName:{name:"AdaptableColumnMenuItemName",kind:"A",desc:"Name of Column Menu Item provided by AdapTable"},AdaptableColumnPredicate:{name:"AdaptableColumnPredicate",kind:"I",desc:"Restricts a Predicate to a given Column",props:[{name:"ColumnId",kind:"s",desc:"Id of Column which will be evaluated by the Predicate",isOpt:!0}]},AdaptableColumnSummary:{name:"AdaptableColumnSummary",kind:"I",desc:"Summary of a Column including filters and all unique values"},AdaptableColumnType:{name:"AdaptableColumnType",kind:"A",desc:"Column Types recognised by AdapTable; to be set in GridOptions"},AdaptableComment:{name:"AdaptableComment",kind:"I",desc:"Comment that can be applied to a Cell in AdapTable",props:[{name:"AdaptableId",kind:"s",desc:"Id of this AdapTable instance",isOpt:!0},{name:"Author",kind:"u",desc:"Author of the Comment",isOpt:!0},{name:"Timestamp",kind:"n",desc:"When Comment was made"},{name:"Uuid",kind:"R",desc:"Unique identifier for the Comment",isOpt:!0,ref:"unknown"},{name:"Value",kind:"s",desc:"Content of the Comment"}]},AdaptableComparerFunction:{name:"AdaptableComparerFunction",kind:"A",desc:"Standard comparer function used to evaluate custom sorts, returns -1, 0, 1 as required"},AdaptableConfig:{name:"AdaptableConfig",kind:"I",desc:"Config used by No Code Plugin to set up AdapTable",props:[{name:"adaptableOptions",kind:"R",desc:"Adaptable Options object",ref:"AdaptableOptions"},{name:"gridOptions",kind:"R",desc:"AG Grid Grid Options object",ref:"unknown"}]},AdaptableContextMenuItem:{name:"AdaptableContextMenuItem",kind:"A",desc:"Menu item used by Adaptable in Context Menus"},AdaptableContextMenuItemName:{name:"AdaptableContextMenuItemName",kind:"A",desc:"Name of Context Menu Item provided by AdapTable"},AdaptableCoordinate:{name:"AdaptableCoordinate",kind:"I",desc:"Used by AdapTable to remember position of Floating Dashboard",props:[{name:"x",kind:"n",desc:"x axis number"},{name:"y",kind:"n",desc:"y axis number"}]},AdaptableCustomIcon:{name:"AdaptableCustomIcon",kind:"I",desc:"Defines an icon from an external source",props:[{name:"src",kind:"s",desc:"The URL of the icon to use"}]},AdaptableDashboardToolbar:{name:"AdaptableDashboardToolbar",kind:"A",desc:"List of all the Toolbars that Adaptable provides"},AdaptableDataChangeHistoryAction:{name:"AdaptableDataChangeHistoryAction",kind:"A",desc:"Built in `undo` or `clear` data change action"},AdaptableDateEditorParams:{name:"AdaptableDateEditorParams",kind:"I",desc:"Params used by the AdapTable Date Editor"},AdaptableElementIcon:{name:"AdaptableElementIcon",kind:"I",desc:"Defines an icon as a provided DOM element or HTML string",props:[{name:"element",kind:"u",desc:"The icon to display, either a DOM element or HTML string"}]},AdaptableField:{name:"AdaptableField",kind:"I",desc:"Used in Expressions to reference row values which are not a column definition",props:[{name:"dataType",kind:"R",desc:"Data Type of field, used to validate and show correctly in UI",ref:"AdaptableColumnDataType"},{name:"label",kind:"s",desc:"Label for field (optional - defaults to name)",isOpt:!0},{name:"name",kind:"s",desc:"Name of field in data source, e.g. 'rowId', 'parentObject.childObject.value'"}]},AdaptableFieldContext:{name:"AdaptableFieldContext",kind:"I",desc:"Context used when providing Fields programatically"},AdaptableFilterComponentLocation:{name:"AdaptableFilterComponentLocation",kind:"A",desc:"AdapTable's Filter components: FilterBar or FilterForm"},AdaptableFilterState:{name:"AdaptableFilterState",kind:"I",desc:"Current Filters in AdapTable",props:[{name:"columnFilterDefs",kind:"u",desc:"Column Filter definitions for currently applied Column Filters"},{name:"columnFilters",kind:"u",desc:"Currently applied Column Filters"},{name:"gridFilter",kind:"string | undefined",desc:"Current Grid Filter"},{name:"gridFilterAST",kind:"u",desc:"AST for Current Grid Filter"}]},AdaptableFlashingCell:{name:"AdaptableFlashingCell",kind:"I",desc:"Defines an Alert fired by AdapTable",props:[{name:"cellDataChangedInfo",kind:"R",desc:"Data change which triggered the FlashingCell",isOpt:!0,ref:"CellDataChangedInfo"},{name:"direction",kind:"'up' | 'down' | 'neutral'",desc:"Direction of the change: 'up', 'down' or 'neutral'"},{name:"flashColumnIds",kind:"u",desc:"Column Ids that are flashing"},{name:"flashingCellDefinition",kind:"R",desc:"Rule that caused the FlashingCell to fire",ref:"FlashingCellDefinition"},{name:"flashTarget",kind:"u",desc:"What will flash (e.g. Cell, Row)"},{name:"rowPrimaryKey",kind:"s",desc:"Primary Key Value of Row which is flashing"}]},AdaptableForm:{name:"AdaptableForm",kind:"I",desc:"Defines a form which appears dynamically; used by Alerts & Export Custom Destinations",props:[{name:"buttons",kind:"a",desc:"Buttons to include in the Form",isOpt:!0},{name:"description",kind:"s",desc:"Additional information to appear in the Form",isOpt:!0},{name:"fields",kind:"u",desc:"Collection of Dynamic Fields to display",isOpt:!0},{name:"title",kind:"s",desc:"Title to appear in the Form",isOpt:!0}]},AdaptableFormat:{name:"AdaptableFormat",kind:"A",desc:"Object containing formatting information for Numeric and Date Columns"},AdaptableFormData:{name:"AdaptableFormData",kind:"A",desc:"Data which appears in an AdapTable Form"},AdaptableFormField:{name:"AdaptableFormField",kind:"I",desc:"Defines a Field that appears in an Adaptable Form",props:[{name:"defaultValue",kind:"string | boolean | number",desc:"Field Default Value - can be of type string, boolean, number",isOpt:!0},{name:"fieldType",kind:"R",desc:"Field Type: text, date, number, checkbox, select, textOutput",ref:"AdaptableFormFieldType"},{name:"label",kind:"s",desc:"Label to display in the Field"},{name:"name",kind:"s",desc:"Name of the Field"},{name:"options",kind:"u",desc:"Items to populate the Select input",isOpt:!0}]},AdaptableFormFieldType:{name:"AdaptableFormFieldType",kind:"A",desc:"Types of Controls used in an AdapTable Form"},AdaptableFrameworkComponent:{name:"AdaptableFrameworkComponent",kind:"A",desc:"Base Component for Bespoke Components: can be Angular, React or Vue"},AdaptableGenericAlert:{name:"AdaptableGenericAlert",kind:"I",desc:"Defines a generic AdapTable Alert"},AdaptableIcon:{name:"AdaptableIcon",kind:"A",desc:"Defines an icon to be used in AdapTable (e.g. in Dashboard Header, Buttons, Menu, etc.)"},AdaptableLoadStateFunction:{name:"AdaptableLoadStateFunction",kind:"I",desc:"Function that retrieves Adaptable state from storage or external source. Called during initialization to hydrate the application state."},AdaptableLogger:{name:"AdaptableLogger",kind:"C",desc:"AdapTable's Logger"},AdaptableMenuItem:{name:"AdaptableMenuItem",kind:"I",desc:"Generic Menu item used by Adaptable in Column or Context Menus",props:[{name:"category",kind:"R",desc:"Category of Adaptable Menu Item: Module, General, Group or CustomSettingsPanel",ref:"MenuCategory"},{name:"icon",kind:"R",desc:"Icon to display in Menu Item",isOpt:!0,ref:"AdaptableIcon"},{name:"isVisible",kind:"b",desc:"Whether menu item is visible"},{name:"label",kind:"s",desc:"Text that appears in the menu"},{name:"name",kind:"u",desc:"Unique name for the Menu Item"},{name:"onClick",kind:"u",desc:"Function to invoke when (custom) menu item is clicked",isOpt:!0},{name:"subItems",kind:"a",desc:"Sub Menu Items to display",isOpt:!0}]},AdaptableMessageType:{name:"AdaptableMessageType",kind:"A",desc:"Defines a Message Types: 'Success', 'Info', 'Warning' or 'Error'"},AdaptableModule:{name:"AdaptableModule",kind:"A",desc:"Modules provided by AdapTable, subject to Entitlements and usually have Initial Adaptable State"},AdaptableModuleButton:{name:"AdaptableModuleButton",kind:"A",desc:"List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button"},AdaptableNoCodeWizardOptions:{name:"AdaptableNoCodeWizardOptions",kind:"I",desc:"Adaptable Options used by the No Code Wizard"},AdaptableNote:{name:"AdaptableNote",kind:"I",desc:"Note that can be applied to a Cell in AdapTable",props:[{name:"ColumnId",kind:"s",desc:"Id of Column containing the Note"},{name:"PrimaryKeyValue",kind:"u",desc:"Value in Grid's Primary Key Column"},{name:"Text",kind:"s",desc:"Content of the Note"},{name:"Timestamp",kind:"n",desc:"When Note was made",isOpt:!0}]},AdaptableNotes:{name:"AdaptableNotes",kind:"A",desc:"Collection of Cell Notes"},AdaptableNumberCellEditorParams:{name:"AdaptableNumberCellEditorParams",kind:"I",desc:"Adaptable number editor parameters extending the AG Grid .",props:[{name:"emptyValue",kind:"s",desc:"Value to set for the cell, when the clear button is pressed",defVal:"'' (empty string)"},{name:"showClearButton",kind:"b",desc:"Whether to show the clear button. If `true`, it works together with `cellEditorParams.emptyValue`",defVal:"true"}]},AdaptableObject:{name:"AdaptableObject",kind:"I",desc:"Base interface which all other Adaptable State-related objects extend",props:[{name:"AdaptableVersion",kind:"R",desc:"Current AdapTable version",isOpt:!0,ref:"AdaptableVersion"},{name:"IsReadOnly",kind:"b",desc:"Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')",isOpt:!0},{name:"Metadata",kind:"u",desc:"Optional metadata associated with the object; can be used to store additional information or configuration",isOpt:!0},{name:"Source",kind:"'InitialState' | 'User'",desc:"Source of state object: 'InitialState' if provided via `AdaptableOptions.initialState`, 'User' or undefined for runtime state",isOpt:!0},{name:"Tags",kind:"a",desc:"List of Tags associated with the Object; often used for extending Layouts",isOpt:!0},{name:"Uuid",kind:"R",desc:"Unique identifier for the Object, generated and used internally by AdapTable",isOpt:!0,ref:"unknown"}]},AdaptableObjectLookupCriteria:{name:"AdaptableObjectLookupCriteria",kind:"I",desc:"Lookup criteria for finding specific Adaptable Objects; all given criteria will be composed with an AND operator",props:[{name:"ids",kind:"u",desc:"Technical IDs of Adaptable Objects",isOpt:!0},{name:"scope",kind:"R",desc:"ColumnScope",isOpt:!0,ref:"ColumnScope"},{name:"tag",kind:"R",desc:"AdaptableObjectTag",isOpt:!0,ref:"AdaptableObjectTag"}]},AdaptableObjectTag:{name:"AdaptableObjectTag",kind:"A",desc:"AdaptableObjectTag Object Tag - currently supporting only plain string values, but open for future extensions, if needed"},AdaptableObservableQuery:{name:"AdaptableObservableQuery",kind:"I",desc:"Wraps an AdapTableQL Observable Expression",props:[{name:"ObservableExpression",kind:"s",desc:"AdapTableQL Expression that observes the Grid or given rows"}]},AdaptableOptions:{name:"AdaptableOptions",kind:"I",desc:"Large group of options enabling developers to set up AdapTable at design time to fit precise requirements",props:[{name:"actionColumnOptions",kind:"u",desc:"Options for managing Action Columns",isOpt:!0},{name:"adaptableContext",kind:"u",desc:"Application-specific context object - is included by AdapTable in all callbacks and Events",isOpt:!0},{name:"adaptableId",kind:"s",desc:"Identifier for this instance of AdapTable",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"'adaptable_id_$random_number'"},{name:"adaptableStateKey",kind:"s",desc:"Identifier used as localStorage persistence key for AdaptableState",isOpt:!0,gridInfo:"item",defVal:"`adaptableId` value"},{name:"alertOptions",kind:"u",desc:"Options for managing Alerts in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container"},{name:"autogeneratePrimaryKey",kind:"b",desc:"Will autogenerate a Primary Key; only use as a last resort if no unique column is available, as limits some Adaptable functionalities",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"calendarOptions",kind:"R",desc:"Options for managing Holidays and Working Days",isOpt:!0,ref:"CalendarOptions"},{name:"cellSummaryOptions",kind:"u",desc:"Options for adding custom Cell Summaries",isOpt:!0},{name:"chartingOptions",kind:"R",desc:"Options for managing AG Grid's Charting",isOpt:!0,noCode:"container",ref:"ChartingOptions"},{name:"columnMenuOptions",kind:"u",desc:"Options for managing AdapTable Column Menu",isOpt:!0,gridInfo:"container"},{name:"columnOptions",kind:"R",desc:"Options related to Columns",isOpt:!0,noCode:"container",ref:"ColumnOptions"},{name:"commentOptions",kind:"u",desc:"Options for managing collaborative Comments",isOpt:!0},{name:"containerOptions",kind:"R",desc:"Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed",isOpt:!0,ref:"ContainerOptions"},{name:"contextMenuOptions",kind:"u",desc:"Options for managing AdapTable Context Menu",isOpt:!0,gridInfo:"container"},{name:"customSortOptions",kind:"R",desc:"Options for using Custom Sort",isOpt:!0,ref:"CustomSortOptions"},{name:"dashboardOptions",kind:"R",desc:"Options for managing the Dashboard in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container",ref:"DashboardOptions"},{name:"dataChangeHistoryOptions",kind:"u",desc:"Options to manage Data Change History Module which provides an overview of all data changes",isOpt:!0,gridInfo:"container",noCode:"container"},{name:"dataImportOptions",kind:"R",desc:"Options for managing the Data Import function",isOpt:!0,ref:"DataImportOptions"},{name:"dataSetOptions",kind:"u",desc:"Options to manage Data Sets",isOpt:!0},{name:"editOptions",kind:"u",desc:"Options related to Editing in AdapTable including Server Validation",isOpt:!0,gridInfo:"container"},{name:"entitlementOptions",kind:"R",desc:"Options for managing Entitlements",isOpt:!0,gridInfo:"container",ref:"EntitlementOptions"},{name:"exportOptions",kind:"u",desc:"Options for managing Exporting and Reports in AdapTable",isOpt:!0,gridInfo:"container"},{name:"expressionOptions",kind:"u",desc:"Options for managing AdapTableQL Expressions",isOpt:!0,noCode:"container"},{name:"fdc3Options",kind:"R",desc:"Options for managing FDC3 in AdapTable",isOpt:!0,ref:"Fdc3Options"},{name:"filterOptions",kind:"u",desc:"Filtering Options - both Column Filters and the Grid Filter",isOpt:!0},{name:"flashingCellOptions",kind:"R",desc:"Options for managing Flashing Cells - primarily default values",isOpt:!0,gridInfo:"container",ref:"FlashingCellOptions"},{name:"formatColumnOptions",kind:"R",desc:"Options for providing Custom Display Formats",isOpt:!0,ref:"FormatColumnOptions"},{name:"initialState",kind:"R",desc:"Initial State set at design-time and shipped with AdapTable for first use; must include at least one Layout",defVal:"undefined",ref:"InitialState"},{name:"layoutOptions",kind:"R",desc:"Options related to Layouts",isOpt:!0,gridInfo:"container",noCode:"container",ref:"LayoutOptions"},{name:"licenseKey",kind:"s",desc:"Commercial license key. If the license is not provided or is expired, various visual information notes will be displayed and some functionality may be limited.",isOpt:!0},{name:"noteOptions",kind:"R",desc:"Options for managing personal Notes",isOpt:!0,ref:"NoteOptions"},{name:"notificationsOptions",kind:"R",desc:"Options for managing Notifications in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container",ref:"NotificationsOptions"},{name:"plugins",kind:"a",desc:"Used for managing the AdapTable Plugins",isOpt:!0},{name:"predicateOptions",kind:"R",desc:"Options for managing Predicates in AdapTableQL",isOpt:!0,ref:"PredicateOptions"},{name:"primaryKey",kind:"s",desc:"Name of Column in AdapTable guaranteed to contain unique values",gridInfo:"item",defVal:"n/a (Mandatory)"},{name:"quickSearchOptions",kind:"u",desc:"Options for managing Search related functions in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container"},{name:"rowFormOptions",kind:"u",desc:"Options for managing Row Forms",isOpt:!0},{name:"settingsPanelOptions",kind:"R",desc:"Setting panel options",isOpt:!0,gridInfo:"container",noCode:"container",ref:"SettingsPanelOptions"},{name:"stateOptions",kind:"R",desc:"Options related to state hydration / dehydration - allows users to intercept state persistence and state loading and change default behaviour of saving to local storage",isOpt:!0,ref:"StateOptions"},{name:"teamSharingOptions",kind:"R",desc:"Options for managing 'Team Sharing' which allows users to create Adaptable Objects and share with colleagues",isOpt:!0,gridInfo:"container",ref:"TeamSharingOptions"},{name:"toolPanelOptions",kind:"R",desc:"Options related to managing the Tool Panel elements in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container",ref:"ToolPanelOptions"},{name:"userInterfaceOptions",kind:"u",desc:"Options for managing the User Interface elements of AdapTable, i.e. Action Columns, Color Palette etc.",isOpt:!0,gridInfo:"container"},{name:"userName",kind:"s",desc:"Name of current AdapTable user",isOpt:!0,gridInfo:"item",defVal:"'anonymous'"}]},AdaptablePercentageCellEditorParams:{name:"AdaptablePercentageCellEditorParams",kind:"I",desc:"AdapTablePercentageCellEditor parameters - extends AdaptableNumberCellEditorParams"},AdaptablePersistentState:{name:"AdaptablePersistentState",kind:"I",desc:"The state object of Adaptable which is persisted"},AdaptablePersistStateFunction:{name:"AdaptablePersistStateFunction",kind:"I",desc:"Function that handles persisting state to storage systems (localStorage, server, etc.). Called after `saveState()` to store the prepared state."},AdaptablePlugin:{name:"AdaptablePlugin",kind:"C",desc:"Base class for all AdapTable Plugins"},AdaptablePredicate:{name:"AdaptablePredicate",kind:"I",desc:"Predicate object used by AdapTableQL - essentially a boolean function",props:[{name:"Inputs",kind:"a",desc:"Optional Inputs that might be needed for evaluation",isOpt:!0},{name:"PredicateId",kind:"u",desc:"Id of Predicate (e.g. `Equals`, `GreaterThan`)"}]},AdaptablePredicateDef:{name:"AdaptablePredicateDef",kind:"I",desc:"Defines a Predicate - include where it can run and what it does",props:[{name:"columnScope",kind:"R",desc:"Columns (or DataTypes) where Predicate is active",ref:"ColumnScope"},{name:"handler",kind:"f",desc:"Actual boolean function invoked when evaluating the Predicate"},{name:"icon",kind:"u",desc:"Icon to show (primarily used in Filter dropdown)",isOpt:!0},{name:"id",kind:"u",desc:"Predicate Id"},{name:"inputs",kind:"a",desc:"Inputs the Predicate can take",isOpt:!0},{name:"label",kind:"s",desc:"Name of the Predicate"},{name:"moduleScope",kind:"a",desc:"Modules where Predicate can run"},{name:"shortcuts",kind:"a",desc:"Keyboard shortcuts to initiate predicate - used in Quick Filter bar",isOpt:!0},{name:"toString",kind:"f",desc:"String representation of the Predicate",isOpt:!0}]},AdaptableQLModule:{name:"AdaptableQLModule",kind:"A",desc:"Modules which leverage AdapTableQL; can be used to set remote evaluation"},AdaptableQuery:{name:"AdaptableQuery",kind:"A",desc:"An AdaptableQuery can be either a Boolean, Scalar, Observable, AggregatedBoolean, or AggregatedScalar expression"},AdaptableRowChangedAlert:{name:"AdaptableRowChangedAlert",kind:"I",desc:"Defines an Alert fired by AdapTable when a row is changed",props:[{name:"rowDataChangedInfo",kind:"u",desc:"Row DataChange which triggered Alert"}]},AdaptableSaveStateFunction:{name:"AdaptableSaveStateFunction",kind:"I",desc:"Function that transforms state before persistence. Called first in the persistence flow, before `persistState()`."},AdaptableScalarQuery:{name:"AdaptableScalarQuery",kind:"I",desc:"Wraps an AdapTableQL Scalar Expression",props:[{name:"ScalarExpression",kind:"s",desc:"AdapTableQL Expression that returns any value"}]},AdaptableSettingsPanel:{name:"AdaptableSettingsPanel",kind:"A",desc:"Modules which can appear in the Settings Panel"},AdaptableSharedEntity:{name:"AdaptableSharedEntity",kind:"I",desc:"Defines an AdaptableObject shared with Team Sharing",props:[{name:"ChangedAt",kind:"n",desc:"Last time when the object was changed"},{name:"ChangedBy",kind:"s",desc:"Last User who changed the object"},{name:"Description",kind:"s",desc:"Description of object being shared"},{name:"Entity",kind:"R",desc:"Actual Adaptable Object being shared",ref:"AdaptableObject"},{name:"EntityDependencyIds",kind:"a",desc:"Ids of direct entity dependencies"},{name:"EntityType",kind:"u",desc:"Type of shared entity (either Adaptable specific or custom object)"},{name:"Module",kind:"R",desc:"Adaptable Module to which object belongs",ref:"AdaptableModule"},{name:"Revision",kind:"n",desc:"Revision - incremental for 'Active', always 1 for 'Snapshot'"},{name:"Timestamp",kind:"n",desc:"When the object was shared"},{name:"Type",kind:"R",desc:"'Snapshot' (for 1-time sharing) or 'Active' (for continuous sharing)",ref:"SharedEntityType"},{name:"UserName",kind:"s",desc:"User who shared the object"}]},AdaptableSharedEntityConfig:{name:"AdaptableSharedEntityConfig",kind:"I",desc:"Describes an AdaptableObject which is being Team Shared"},AdaptableSortState:{name:"AdaptableSortState",kind:"I",desc:"Overview of current, live, sorting state in grid",props:[{name:"columnSorts",kind:"a",desc:"Columns currently being sorted (with direction)"},{name:"customSortComparers",kind:"a",desc:"Custom Sort Comparers which are currently applied"},{name:"customSorts",kind:"a",desc:"Custom Sorts which are currently applied"}]},AdaptableState:{name:"AdaptableState",kind:"I",desc:"The main state object of Adaptable"},AdaptableStateFunctionConfig:{name:"AdaptableStateFunctionConfig",kind:"I",desc:"State Function Config object passed into all State Options functions",props:[{name:"actionName",kind:"s",desc:"Name of the action that triggered the state change.",isOpt:!0},{name:"adaptableApi",kind:"R",desc:"Adaptable API",ref:"unknown"},{name:"adaptableContext",kind:"u",desc:"Custom application Context provided in `AdaptableOptions.adaptableContext`"},{name:"adaptableId",kind:"s",desc:"Id of current Adaptable instance"},{name:"adaptableStateKey",kind:"s",desc:"State Key being used"},{name:"previousState",kind:"R",desc:"Previous state before the action was applied. This is useful for comparing changes or reverting if necessary.",isOpt:!0,ref:"AdaptableState"},{name:"userName",kind:"s",desc:"current Adaptable user"}]},AdaptableStatusBar:{name:"AdaptableStatusBar",kind:"I",desc:"Defines an Adaptable Status Bar",props:[{name:"Key",kind:"s",desc:"Key of Status Bar Panel as defined in AG Grid GridOptions - ensure keys are the same (note: AG Grid statusPanel is lowercase 'key')"},{name:"StatusBarPanels",kind:"a",desc:"Module Status Panels to render inside Adaptable Status Bar",isOpt:!0}]},AdaptableStatusBarPanel:{name:"AdaptableStatusBarPanel",kind:"A",desc:"Modules which can appear in the AdapTable Status Bar"},AdaptableStyle:{name:"AdaptableStyle",kind:"I",desc:"Style object used in numerous AdapTable Modules",props:[{name:"BackColor",kind:"s",desc:"Colour background of cell: hex, rgb(a) or name",isOpt:!0},{name:"BorderColor",kind:"s",desc:"Colour of cell border: hex, rgb(a) or name",isOpt:!0},{name:"BorderRadius",kind:"n",desc:"Rounds corners of an element's outer border edge; equivalent of CSS border-radius",isOpt:!0},{name:"ClassName",kind:"s",desc:"Existing CSS Class; use instead of setting other object properties",isOpt:!0},{name:"FontSize",kind:"'XSmall' | 'Small' | 'Medium' | 'Large' | 'XLarge'",desc:"Size of font: `XSmall`, `Small`, `Medium`, `Large` or `XLarge`",isOpt:!0},{name:"FontStyle",kind:"'Normal' | 'Italic'",desc:"Style of font: `Normal` or `Italic`",isOpt:!0},{name:"FontWeight",kind:"'Normal' | 'Bold'",desc:"Weight of font: `Normal` or `Bold`",isOpt:!0},{name:"ForeColor",kind:"s",desc:"Font colour in cell: hex, rgb(a) or name",isOpt:!0},{name:"TextDecoration",kind:"'None' | 'Underline' | 'Overline' | 'LineThrough'",desc:"Decoration of font: `None`, `Underline`, `Overline` or `LineThrough`",isOpt:!0}]},AdaptableSystemColumnMenuItem:{name:"AdaptableSystemColumnMenuItem",kind:"I",desc:"System Menu Item that is provided by AdapTable",props:[{name:"menuType",kind:"u",desc:"Type of Menu - always 'Adaptable'"}]},AdaptableSystemContextMenuItem:{name:"AdaptableSystemContextMenuItem",kind:"I",desc:"System Menu Item that is provided by AdapTable",props:[{name:"menuType",kind:"u",desc:"Type of Menu - always 'Adaptable'"}]},AdaptableSystemIcon:{name:"AdaptableSystemIcon",kind:"I",desc:"Defines an icon from the System AdapTable icon set",props:[{name:"name",kind:"u",desc:"The name of the icon to use (referencing the AdapTable Icon Library)"},{name:"size",kind:"n",desc:"The size (in pixels) of the SVG icon (defaults to `17px`)",isOpt:!0}]},AdaptableSystemIconName:{name:"AdaptableSystemIconName",kind:"A",desc:"All AdapTable System Icon names"},AdaptableTheme:{name:"AdaptableTheme",kind:"I",desc:"Used for creating User (i.e. Custom) Themes",props:[{name:"AgGridClassName",kind:"s",desc:"Ag Grid theme to apply when loading theme; relevant only when using the legacy AG Grid themes",isOpt:!0},{name:"AgThemeMode",kind:"u",desc:"AG Grid theme mode to apply when this theme is selected. Valid values are `light`, `dark`, `dark-blue` or any custom theme mode defined in AG Grid. When set, adds a data-ag-theme-mode attribute to the document body.",isOpt:!0},{name:"CSSVariables",kind:"u",desc:"Variables to be applied at runtime",isOpt:!0},{name:"Description",kind:"s",desc:"Description of Theme - will appear in Theme Toolbar and Toolpanel"},{name:"Name",kind:"s",desc:"Name of the Theme"},{name:"Variant",kind:"'light' | 'dark'",desc:"Base theme variant to derive custom theme from. Use `light` to inherit from Adaptable Light Theme or `dark` for Adaptable Dark Theme. When creating custom themes, specifying a variant ensures proper inheritance of base theme styles.",isOpt:!0}]},AdaptableToolPanel:{name:"AdaptableToolPanel",kind:"A",desc:"Modules which can appear as AdapTable Tool Panels"},AdaptableToolPanelDefinition:{name:"AdaptableToolPanelDefinition",kind:"I",desc:"Defines a ToolPanel - Name and VisibilityMode (Expanded / Collapsed)",props:[{name:"Name",kind:"u",desc:"ToolPanel name - either an Adaptable Module or a Custom ToolPanel (defined in ToolPanel Options)"},{name:"VisibilityMode",kind:"'expanded' | 'collapsed'",desc:"Whether the ToolPanel is 'expanded' or 'collapsed'",isOpt:!0,defVal:"'collapsed'"}]},AdaptableVersion:{name:"AdaptableVersion",kind:"A",desc:"The current version of AdapTable being used"},AggregatedExpressionFilterRowContext:{name:"AggregatedExpressionFilterRowContext",kind:"I",desc:"Context used when applying a filter to Rows before Reducer is called",props:[{name:"aggColumnId",kind:"s",desc:"Column Id of the column being aggregated Usually the first Col argument, e.g. [colId]"},{name:"args",kind:"a",desc:"Arguments passed to the function"},{name:"getValueForColId",kind:"u",desc:"Utility function to get the value of a column"},{name:"groupByColumnIds",kind:"a",desc:"Column Id(s) of the column(s) being grouped by",isOpt:!0},{name:"rowNode",kind:"R",desc:"Current row node",ref:"unknown"}]},AggregatedExpressionFunction:{name:"AggregatedExpressionFunction",kind:"I",desc:"Defines an AdapTableQL function that aggregates data",props:[{name:"description",kind:"s",desc:"Description of the Aggregated Expression Function",isOpt:!0},{name:"examples",kind:"a",desc:"Examples to use the Aggregated Expression Function",isOpt:!0},{name:"filterRow",kind:"f",desc:"Optional filter which is applied to each row before the reducer is called. If the filter returns false, the row is NOT included in the aggregation.",isOpt:!0},{name:"initialValue",kind:"u",desc:"Mandatory Initial Value for the aggregation"},{name:"inputTypes",kind:"a",desc:"Optional argument types.",isOpt:!0},{name:"prepareRowValue",kind:"u",desc:"Called for each row AFTER the reducer() and processAggregatedValue() functions Can be used when each row has a different aggregated value (e.g. percentage = row value / aggregated value). Returns return value for each individual row",isOpt:!0},{name:"processAggregatedValue",kind:"f",desc:"Called AFTER the reducer() has processed all values / rows Can be used to change result of reducer based on the values array (e.g. average = aggregated value / count)",isOpt:!0},{name:"reducer",kind:"f",desc:"Mandatory Reducer function which is called for each value(row) in the Column Data"},{name:"signatures",kind:"a",desc:"Example Signatures for the Aggregated Expression Function",isOpt:!0}]},AggregatedExpressionPrepareRowValueContext:{name:"AggregatedExpressionPrepareRowValueContext",kind:"I",desc:"Context used by prepareRowValue property in Aggregated Expressions",props:[{name:"aggColumnId",kind:"s",desc:"Column Id of the column being aggregated"},{name:"aggregatedValue",kind:"u",desc:"Result of the reducer"},{name:"args",kind:"a",desc:"Arguments passed to the function"},{name:"getValueForColId",kind:"u",desc:"Helper function to get the value of a column"},{name:"groupByColumnIds",kind:"a",desc:"Column Id(s) of the column(s) being grouped by",isOpt:!0},{name:"rowNode",kind:"R",desc:"Current Row Node",ref:"unknown"}]},AggregatedExpressionProcessAggValueContext:{name:"AggregatedExpressionProcessAggValueContext",kind:"I",desc:"Context used by processAggregatedValue property in Aggregated Expressions",props:[{name:"aggColumnId",kind:"s",desc:"Column Id of the column being aggregated"},{name:"aggregatedValue",kind:"u",desc:"Result of the reducer"},{name:"args",kind:"a",desc:"Arguments passed to the function"},{name:"groupByColumnIds",kind:"a",desc:"Column Id(s) of the column(s) being grouped by",isOpt:!0},{name:"rowNodes",kind:"a",desc:"Array of row nodes; if aggregation is grouped, this will be the array of row nodes for the group"}]},AggregatedExpressionReducerContext:{name:"AggregatedExpressionReducerContext",kind:"I",desc:"Context used by the reducer property in Aggregated Expressions",props:[{name:"accumulator",kind:"u",desc:"Value returned by the previous call to the reducer function, or the initialValue if this is the first call. You return the new accumulator value from this function."},{name:"aggColumnId",kind:"s",desc:"Column Id of the column being aggregated"},{name:"args",kind:"a",desc:"Arguments passed to the function"},{name:"currentValue",kind:"u",desc:"Current value being processed in the Column Data"},{name:"getValueForColId",kind:"u",desc:"Helper function to get the value of a column"},{name:"groupByColumnIds",kind:"a",desc:"Column Id(s) of the column(s) being grouped by",isOpt:!0},{name:"index",kind:"n",desc:"Index of the current value in the Column Data"},{name:"rowNode",kind:"R",desc:"Current row node",ref:"unknown"}]},AgGridColumnMenuItemType:{name:"AgGridColumnMenuItemType",kind:"A",desc:"Defines AG Grid Column Menu Items"},AgGridConfig:{name:"AgGridConfig",kind:"I",desc:"Contains AG Grid Options and Modules - used when instantiating AdapTable vanilla",props:[{name:"gridOptions",kind:"R",desc:"AG Grid GridOptions object",ref:"unknown"},{name:"modules",kind:"a",desc:"AG Grid Modules to use; provide empty array if using CJS"}]},AgGridContextMenuItemType:{name:"AgGridContextMenuItemType",kind:"A",desc:"Defines AG Grid Context Menu Items"},AgGridMenuItem:{name:"AgGridMenuItem",kind:"I",desc:"Menu Item that is provided by AG Grid",props:[{name:"menuType",kind:"u",desc:"Type of Menu - always 'AgGrid'"},{name:"name",kind:"u",desc:"Name of the Menu Type"}]},AlertButton:{name:"AlertButton",kind:"I",desc:"Defines a button that appears in an Alert Form",props:[{name:"ButtonStyle",kind:"R",desc:"Style for the Button",isOpt:!0,ref:"ButtonStyle"},{name:"Command",kind:"u",desc:"Predefined Command(s) to trigger when button is clicked; implemented in `commandHandlers` property of Alert Options",isOpt:!0},{name:"Label",kind:"s",desc:"Label to show in the Button"},{name:"Tooltip",kind:"s",desc:"ToolTip to display",isOpt:!0}]},AlertButtonForm:{name:"AlertButtonForm",kind:"A",desc:"Form triggered by an Alert which contains only Buttons"},AlertDefinition:{name:"AlertDefinition",kind:"I",desc:"The Alert Definition object used in the Alert function",props:[{name:"AlertForm",kind:"u",desc:"Form to display in Alert with buttons and inputs",isOpt:!0},{name:"AlertProperties",kind:"R",desc:"Series of properties which set what happens when Alert is triggered",isOpt:!0,ref:"AlertProperties"},{name:"MessageHeader",kind:"s",desc:"Title of displayed Alert Message",isOpt:!0},{name:"MessageText",kind:"s",desc:"Title of displayed Alert Message; if null, AdapTable creates dynamically using Rule & Scope",isOpt:!0},{name:"MessageType",kind:"R",desc:"Type of Alert: 'Info', 'Success', 'Warning', 'Error'; influences Alert colour, icon and logging",ref:"AdaptableMessageType"},{name:"Rule",kind:"R",desc:"When Alert should be triggered",ref:"AlertRule"},{name:"Scope",kind:"R",desc:"Where Alert can be triggered: one, some or all columns or DataTypes",ref:"ColumnScope"}]},AlertDefinitionPredicate:{name:"AlertDefinitionPredicate",kind:"I",desc:"Predicate used when creating a Predicate-based Rule for an Alert"},AlertForm:{name:"AlertForm",kind:"A",desc:"Form to show in an Alert"},AlertFormContext:{name:"AlertFormContext",kind:"I",desc:"Context required by functions when using an Alert Button",props:[{name:"alert",kind:"u",desc:"Alert that has been triggered"}]},AlertMessageContext:{name:"AlertMessageContext",kind:"I",desc:"Context used for creating bespoke Alert messages",props:[{name:"alertDefinition",kind:"R",desc:"Current Alert Definition",ref:"AlertDefinition"},{name:"cellDataChangedInfo",kind:"u",desc:"Cell Data change that might have triggered the Alert",isOpt:!0},{name:"rowDataChangedInfo",kind:"u",desc:"Row Data change that might have triggered the Alert (e.g. Row Added or Removed)",isOpt:!0}]},AlertOptions:{name:"AlertOptions",kind:"I",desc:"Options related to Alerts in Adaptable.",props:[{name:"alertForms",kind:"u",desc:"Full definitions of Alert Forms - the names of which are provided in Alert State",isOpt:!0},{name:"alertMessageHeader",kind:"u",desc:"Function providing Header to display in Alert; if empty, AdapTable provides dynamically",isOpt:!0},{name:"alertMessageText",kind:"u",desc:"Function providing Message to display in Alert; if empty, AdapTable provides dynamically",isOpt:!0},{name:"cellHighlightDuration",kind:"n",desc:"How long (in ms) a Cell will be highlighted when an Alert fires",isOpt:!0,gridInfo:"item",defVal:"2000"},{name:"commandHandlers",kind:"u",desc:"Custom onClick Handlers for Buttons (displayed in Alert Forms)",isOpt:!0},{name:"dataChangeDetectionPolicy",kind:"R",desc:"Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data",isOpt:!0,gridInfo:"item",defVal:"'rawValue'",ref:"DataChangeDetectionPolicy"},{name:"maxAlertsInStore",kind:"n",desc:"How many alerts held in State at any one time; when limit is breached, oldest alert will be removed",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"20"},{name:"rowHighlightDuration",kind:"n",desc:"How long (in ms) a Row will be highlighted when an Alert Fires",isOpt:!0,gridInfo:"item",defVal:"4000"},{name:"showMissingPrimaryKeyAlert",kind:"b",desc:"Shows Alert if Primary Key column in Adaptable Options is not present or incorrect",uiLabel:"Show Missing Primary Key Warning",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"statusbarHighlightDuration",kind:"n",desc:"How long (in ms) Alert panel in Status Bar highlights when an Alert Fires",isOpt:!0,defVal:"2000"}]},AlertProperties:{name:"AlertProperties",kind:"I",desc:"Additional properties that specify how a particular Alert will ALWAYS behave",props:[{name:"DisplayNotification",kind:"b",desc:"Displays a notification when Alert is triggered",isOpt:!0},{name:"HighlightCell",kind:"u",desc:"Colours updated Row using `MessageType` of triggering Alert Definition",isOpt:!0},{name:"HighlightRow",kind:"u",desc:"Colours updated Row using `MessageType` of triggering Alert Definition",isOpt:!0},{name:"JumpToCell",kind:"b",desc:"Grid will 'jump' to the changed cell which triggered the Alert",isOpt:!0},{name:"JumpToRow",kind:"b",desc:"Grid will 'jump' to the newly added row which triggered the Alert",isOpt:!0},{name:"LogToConsole",kind:"b",desc:"Logs the Alert message to the console",isOpt:!0},{name:"NotificationDuration",kind:"u",desc:"Notifiction duration(defaults to `NotificationOptions.duration`)",isOpt:!0},{name:"PreventEdit",kind:"b",desc:"Automatically prevent any cell edit which triggered the Alert (i.e. validation)",isOpt:!0,defVal:"false"},{name:"ShowInDiv",kind:"b",desc:"Shows Alert text in the div specificed in `alertContainer` property of Container Options",isOpt:!0}]},AlertRule:{name:"AlertRule",kind:"A",desc:"The Alert Rule defined by either an AdaptablePredicate or an AdaptableQuery"},AlertState:{name:"AlertState",kind:"I",desc:"Adaptable State section for Alert Module",props:[{name:"AlertDefinitions",kind:"a",desc:"Alert Definitions - will trigger Alerts when rule is met",isOpt:!0}]},AlternativeModuleName:{name:"AlternativeModuleName",kind:"I",desc:"Defines a new name for an Adaptable Module (e.g. change Dashboard to Grid Manager)",props:[{name:"adaptableModule",kind:"R",desc:"Adaptable Module to rename",ref:"AdaptableModule"},{name:"newName",kind:"s",desc:"New name to use"}]},AngularFrameworkComponent:{name:"AngularFrameworkComponent",kind:"A",desc:"Angular component defined by its type and (optional) initialisation callback"},ApplicationDataEntry:{name:"ApplicationDataEntry",kind:"I",desc:"Simple Key / Value pair object used to store custom - stringifiable - data in Adaptable State.",props:[{name:"Key",kind:"s",desc:"Key of Key / Value pair - always stored as a string"},{name:"Value",kind:"u",desc:"Value of Key / Value pair (actual data being stored) - needs to stringifiable"}]},ApplicationState:{name:"ApplicationState",kind:"I",desc:"Adaptable State Section for the Application Module",props:[{name:"ApplicationDataEntries",kind:"a",desc:"Array of Key / Value pairs enabling custom data to be stored in Adaptable State.",isOpt:!0}]},ApplyFilterAction:{name:"ApplyFilterAction",kind:"A",desc:"When to apply a Filter: 'Always', 'Never' or 'Throttle'"},AST_Expression:{name:"AST_Expression",kind:"A",desc:"Defines AST of an Expressoin"},AST_Function:{name:"AST_Function",kind:"A",desc:"Defines AST of an Expression Function"},AST:{name:"AST",kind:"A",desc:"An AST Expression"},AutoGenerateTagsForLayoutsContext:{name:"AutoGenerateTagsForLayoutsContext",kind:"I",desc:"Context for `LayoutOptions.autoGenerateTagsForLayouts` method",props:[{name:"layouts",kind:"a",desc:"Layouts currently in Adaptable State"},{name:"objectTags",kind:"a",desc:"Object Tags provided in User Interface Options"}]},AutoGroupColumnHeaderContext:{name:"AutoGroupColumnHeaderContext",kind:"I",desc:"Context for Columns created automatically by AG Grid when Row Grouping",props:[{name:"columnId",kind:"s",desc:"Id of the Column"},{name:"columnType",kind:"u",desc:"Auto-generated Row Group Column (when RowGroupDisplayType is `single`)"},{name:"groupedColumnIds",kind:"a",desc:"Ids of all Row Grouped Columns"}]},BadgeStyle:{name:"BadgeStyle",kind:"I",desc:"Collection of Badge Style Definitions to display in a Badge Styled Column",props:[{name:"Badges",kind:"a",desc:"Collection of Badge Style Definitions",isOpt:!0},{name:"RowScope",kind:"R",desc:"Which types of Rows should contain a Badge (data, grouped, summary)",isOpt:!0,ref:"RowScope"}]},BadgeStyleDefinition:{name:"BadgeStyleDefinition",kind:"I",desc:"Defines a Badge Style",props:[{name:"Icon",kind:"R",desc:"Icon to display in Badge",isOpt:!0,ref:"AdaptableIcon"},{name:"IconOnly",kind:"b",desc:"Only show an Icon and no Cell text",isOpt:!0},{name:"IconPosition",kind:"'Start' | 'End'",desc:"Position of Icon in the Badge - 'Start' or 'End'",isOpt:!0},{name:"Predicate",kind:"R",desc:"Optional Rule for deciding whether Badge is displayed",isOpt:!0,ref:"BadgeStylePredicate"},{name:"Style",kind:"R",desc:"Style for the Badge",isOpt:!0,ref:"AdaptableStyle"}]},BadgeStylePredicate:{name:"BadgeStylePredicate",kind:"I",desc:"System Predicate definition for Badge Style"},BaseColumnHeaderContext:{name:"BaseColumnHeaderContext",kind:"I",desc:"Common properties for Column Header Context",props:[{name:"currentLayout",kind:"R",desc:"Current Layout",ref:"Layout"},{name:"currentLayoutName",kind:"s",desc:"Name of Current Layout"},{name:"currentLayoutType",kind:"'table' | 'pivot'",desc:"Type (table/pivot) of Current Layout"},{name:"defaultHeaderName",kind:"s",desc:"Default header name for Column"}]},BaseContext:{name:"BaseContext",kind:"I",desc:"Base class for all AdapTable callbacks and Events",props:[{name:"adaptableApi",kind:"R",desc:"Adaptable Api object",ref:"unknown"},{name:"adaptableContext",kind:"u",desc:"Custom application Context provided in `AdaptableOptions.adaptableContext`"},{name:"adaptableId",kind:"s",desc:"Id of current AdapTable instance"},{name:"adaptableStateKey",kind:"s",desc:"Current Adaptable State Key"},{name:"clientTimestamp",kind:"d",desc:"Time on user's computer"},{name:"userName",kind:"s",desc:"Name of Current User"}]},BaseExportContext:{name:"BaseExportContext",kind:"I",desc:"Context information available in all Export-related functions",props:[{name:"exportDestination",kind:"R",desc:"Export Destination for the Report",isOpt:!0,ref:"ExportDestinationType"},{name:"report",kind:"R",desc:"The Report Configuration being run",ref:"Report"},{name:"reportFormat",kind:"R",desc:"Format of the Report being run",ref:"ReportFormatType"},{name:"reportName",kind:"R",desc:"Name of the Report being run",ref:"ReportNameType"}]},BaseState:{name:"BaseState",kind:"I",desc:"Base Interface for all Adaptable State objects; contains`Revision` property, used for versioning",props:[{name:"Revision",kind:"number | {\n        Key: number;\n        UpdateStrategy: 'Override' | 'KeepUserDefined';\n    }",desc:"Version number of the Item - allows developers to update one section in Initial Adaptable State while keeping others unchanged",isOpt:!0}]},BroadcastConfig:{name:"BroadcastConfig",kind:"I",desc:"Config used when broadcasting FDC3 Context",props:[{name:"actionButton",kind:"R",desc:"Definition of Action Button (to be put in default FDC3 Action Column)",isOpt:!0,ref:"Fdc3AdaptableButton"},{name:"actionColumn",kind:"R",desc:"Custom FDC3 Action Column definition to broadcast the Context",isOpt:!0,ref:"FDC3ActionColumn"},{name:"contextMenu",kind:"u",desc:"Columns to display a 'Broadcast' Context Menu item",isOpt:!0}]},BroadcastConfiguration:{name:"BroadcastConfiguration",kind:"I",desc:"Defines config options for Broadcasting FDC3 Context"},ButtonStyle:{name:"ButtonStyle",kind:"I",desc:"Defines the look and feel of an Adaptable Button",props:[{name:"className",kind:"s",desc:"CSS Classname to use for the Button",isOpt:!0},{name:"tone",kind:"'success' | 'error' | 'neutral' | 'none' | 'warning' | 'info' | 'accent'",desc:"Button's Tone - values: 'success', 'error', 'neutral', 'none', 'warning', 'info', 'accent'",isOpt:!0,defVal:"'neutral'"},{name:"variant",kind:"'text' | 'outlined' | 'raised'",desc:"How Button appears - values: 'text', 'outlined', 'raised'",isOpt:!0,defVal:"'outlined'"}]},CalculatedColumn:{name:"CalculatedColumn",kind:"I",desc:"Defines a Column where the display value is derived from other values in row, and the definition is stored in State.",props:[{name:"CalculatedColumnSettings",kind:"R",desc:"Additional optional properties for Column (e.g. filterable, resizable)",ref:"CalculatedColumnSettings"},{name:"ColumnId",kind:"s",desc:"Name of Calculated Column"},{name:"FriendlyName",kind:"s",desc:"Name to be used in Column Header; if blank `ColumnId` is used",isOpt:!0},{name:"Query",kind:"R",desc:"Scalar/AggregatedScalar Query used by AdapTableQL to evaluate Column's value",ref:"AdaptableCalculatedColumnQuery"}]},CalculatedColumnSettings:{name:"CalculatedColumnSettings",kind:"I",desc:"Set properties that define Calculated Column's behaviour (all optional except DataType)",props:[{name:"ShowToolTip",kind:"b",desc:"Show underlying Expression as ToolTip when hovering over a cell",isOpt:!0,defVal:"false"}]},CalculatedColumnState:{name:"CalculatedColumnState",kind:"I",desc:"Adaptable State Section for Calculated Column Module",props:[{name:"CalculatedColumns",kind:"a",desc:"Collection of Calculated Columns",isOpt:!0}]},CalendarOptions:{name:"CalendarOptions",kind:"I",desc:"Options for managing Holidays and Working Days in AdapTable",props:[{name:"holidays",kind:"u",desc:"Holidays for current User",isOpt:!0,defVal:"null"}]},CellAddress:{name:"CellAddress",kind:"A",desc:"Very lightweight object to define an AdapTable Cell"},CellAlignment:{name:"CellAlignment",kind:"A",desc:"Behaviour for aligning Cell contents"},CellColorRange:{name:"CellColorRange",kind:"I",desc:"Defines which Colours to show in Gradient and Percent Bar Styles",props:[{name:"Color",kind:"s",desc:"Cell colour to use for values that fall inside Range"},{name:"Max",kind:"number | 'Col-Max'",desc:"End number of Range"},{name:"Min",kind:"number | 'Col-Min'",desc:"Start number of Range"},{name:"ReverseGradient",kind:"b",desc:"Reverses the Gradient so the lower the cell value the darker the colour",isOpt:!0}]},CellDataChangedInfo:{name:"CellDataChangedInfo",kind:"I",desc:"Defines a Cell Edit - includes full details of old and new values, the column and the enclosing Row",props:[{name:"changedAt",kind:"n",desc:"Timestamp of change occurrence (in milliseconds)"},{name:"column",kind:"u",desc:"Column in which cell is situated"},{name:"newValue",kind:"u",desc:"New value for the cell"},{name:"oldValue",kind:"u",desc:"Value in the Cell before the edit"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key Column's value for the row where edited cell is situated"},{name:"rowData",kind:"u",desc:"Data in the Row",isOpt:!0},{name:"rowNode",kind:"u",desc:"AG Grid RowNode that contains the cell",isOpt:!0},{name:"trigger",kind:"'edit' | 'tick' | 'undo' | 'aggChange'",desc:"What triggered the change - user, background change or a reverted change?",isOpt:!0}]},CellEditableContext:{name:"CellEditableContext",kind:"I",desc:"Context used when checking Cell editability",props:[{name:"defaultColDefEditableValue",kind:"b",desc:"Default editability according to the AG Grid Column Definition (`ColDef.editable`)"},{name:"gridCell",kind:"u",desc:"Cell being edited"}]},CellHighlightInfo:{name:"CellHighlightInfo",kind:"I",desc:"Defines how a given Cell in AdapTable should be highlighted",props:[{name:"columnId",kind:"s",desc:"Id of Column containing Cell"},{name:"highlightStyle",kind:"R",desc:"Adaptable Style to use in the Cell Highlight",ref:"AdaptableStyle"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key Value of row containing Cell",isOpt:!0},{name:"timeout",kind:"n",desc:"Time after which Cell should be unhighlighted",isOpt:!0}]},CellSummaryOptions:{name:"CellSummaryOptions",kind:"I",desc:"Options to provide custom Cell Summary Operations & Display Formats",props:[{name:"customCellSummaryOperations",kind:"u",desc:"Custom Numeric Cell Summary Operations to add to set shipped by AdapTable",isOpt:!0},{name:"numericDisplayFormat",kind:"u",desc:"Numeric format to use for summary value; a Format Column DisplayFormat will take precedence",isOpt:!0}]},CellSummmaryInfo:{name:"CellSummmaryInfo",kind:"I",desc:"Defines the Summary operations which AdapTable provides for Selected Numeric Cells"},CellTextOption:{name:"CellTextOption",kind:"A",desc:"Text optionally to show in a Special Column Style special style: 'CellValue' or 'PercentageValue'"},CellTextOptions:{name:"CellTextOptions",kind:"A",desc:"Array of CellTextOption available in Special Column Styles"},CellUpdateRequest:{name:"CellUpdateRequest",kind:"I",desc:"Lightweight object used for identifying a Cell to be updated",props:[{name:"columnId",kind:"s",desc:"Id of Column in which edited cell is situated"},{name:"newValue",kind:"u",desc:"New Value for the cell"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key column's value in row - how Adaptable locates the cell",isOpt:!0},{name:"rowNode",kind:"u",desc:"AG Grid Row Node that contains the cell (optional)",isOpt:!0}]},ChartContainer:{name:"ChartContainer",kind:"I",desc:"Describes Location to display an AG Grid Chart",props:[{name:"chartsDisplay",kind:"'single' | 'multiple'",desc:"Whether 1 or more Charts can be displayed in same location",isOpt:!0,defVal:"'single'"},{name:"element",kind:"u",desc:"Location - can be HTMLElement or CSS Selector"},{name:"name",kind:"s",desc:"Name of Container's Location - used in Dropdowns"}]},ChartDefinition:{name:"ChartDefinition",kind:"I",desc:"Wraps an AG Grid Chart Model",props:[{name:"Model",kind:"R",desc:"AG Grid Chart Model",ref:"unknown"},{name:"Name",kind:"s",desc:"Name of the Chart"}]},ChartingAggFunc:{name:"ChartingAggFunc",kind:"A",desc:"Aggregation function used in the Chart"},ChartingOptions:{name:"ChartingOptions",kind:"I",desc:"Options for managing AG Grid's Charts",props:[{name:"agGridContainerName",kind:"s",desc:"Name of AG Grid Chart Container",isOpt:!0,defVal:"'AG Grid Window'"},{name:"chartContainers",kind:"a",desc:"Locations to display saved Charts",isOpt:!0},{name:"externalChartingOptions",kind:"R",desc:"Set of properties for managing behaviour of external (i.e non AG Grid) charts",isOpt:!0,ref:"ExternalChartingOptions"},{name:"saveChartBehaviour",kind:"R",desc:"Behaviour for saving Charts: auto, manual (via popup) or none",isOpt:!0,noCode:"item",defVal:"'none'",ref:"SaveChartBehaviour"}]},ChartingState:{name:"ChartingState",kind:"I",desc:"Persists AG Grid Charts in Adaptable State",props:[{name:"ChartDefinitions",kind:"a",desc:"Wrappers around AG Grid Chart Models",isOpt:!0},{name:"ExternalChartDefinitions",kind:"u",desc:"Definitions of External Charts",isOpt:!0}]},ColumnBooleanFalseMap:{name:"ColumnBooleanFalseMap",kind:"A",desc:"Defines a map of Columns with a Boolean value"},ColumnComparison:{name:"ColumnComparison",kind:"I",desc:"Enables a Percent Bar or Gradient Style to use another column in its calculations",props:[{name:"Color",kind:"s",desc:"Colour to use for the Comparison"},{name:"MaxValue",kind:"number | string",desc:"End value - either numeric value or Column name"},{name:"MinValue",kind:"number | string",desc:"Start value - either numeric value or Column name"}]},ColumnDirectionMap:{name:"ColumnDirectionMap",kind:"A",desc:"Defines a map of Columns with a Left / Right direction value"},ColumnFilter:{name:"ColumnFilter",kind:"I",desc:"Defines a Filter applied on a Column using a Predicate",props:[{name:"ColumnId",kind:"s",desc:"Column where Filter should be applied"},{name:"Predicates",kind:"a",desc:"`AdaptablePredicate` which AdaptableQL will evaluate when the Filter is run"},{name:"PredicatesOperator",kind:"R",desc:"Logic used when combining multiple Predicates ('AND'|'OR')",isOpt:!0,defVal:"'AND'",ref:"PredicatesOperator"}]},ColumnFilterDef:{name:"ColumnFilterDef",kind:"I",desc:"Column Filter Definition for a specific Column"},ColumnFilterOptions:{name:"ColumnFilterOptions",kind:"I",desc:"Options for managing Column Filtering in AdapTable",props:[{name:"defaultArrayColumnFilter",kind:"u",desc:"Default filter type for array Columns ('textArray', 'numberArray', etc.)",isOpt:!0,gridInfo:"item",defVal:"In"},{name:"defaultDateColumnFilter",kind:"u",desc:"Default filter type for date Columns",isOpt:!0,gridInfo:"item",defVal:"On"},{name:"defaultNumericColumnFilter",kind:"u",desc:"Default filter type for numeric Columns",isOpt:!0,gridInfo:"item",defVal:"Equals"},{name:"defaultTextColumnFilter",kind:"u",desc:"Default filter type for text Columns",isOpt:!0,gridInfo:"item",defVal:"Contains"},{name:"hideQuickFilterDropdown",kind:"u",desc:"Hides Dropdown in Quick Filter Bar for a given Column",isOpt:!0,defVal:"undefined"},{name:"hideQuickFilterInput",kind:"u",desc:"Hides Input in Quick Filter Bar for a given Column",isOpt:!0,defVal:"undefined"},{name:"indicateFilteredColumns",kind:"b",desc:"Make Column Header distinctive for filtered columns, helps users see currently filtered columns",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"manuallyApplyColumnFilter",kind:"u",desc:"Manually apply Column Filters; an Apply Filter button is displayed and Quick Filter is disabled",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"quickFilterDebounce",kind:"n",desc:"Time to wait (in ms) before Filter Bar reacts to new value",isOpt:!0,gridInfo:"item",defVal:"250"},{name:"quickFilterHeight",kind:"n",desc:"Height of Quick Filter Bar (if not provided, AG Grid default is used)",isOpt:!0,gridInfo:"item",defVal:"null"},{name:"quickFilterWildcards",kind:"u",desc:"Shortcut Keys to activate a Quick Filter Predicate",isOpt:!0},{name:"showQuickFilter",kind:"b",desc:"Display Quick Filter Bar between Column Header and Grid (provided its been setup)",isOpt:!0,noCode:"item",defVal:"true"}]},ColumnFilterPredicate:{name:"ColumnFilterPredicate",kind:"I",desc:"A Predicate used in Column Filtering"},ColumnFriendlyNameContext:{name:"ColumnFriendlyNameContext",kind:"I",desc:"Context used when setting a Column Friendly Name",props:[{name:"agColumn",kind:"R",desc:"AG Grid ColDef for the Column",ref:"unknown"},{name:"colId",kind:"s",desc:"Id of the Column"},{name:"columnGroup",kind:"R",desc:"Column Group Information",ref:"AdaptableColumnGroup"},{name:"displayName",kind:"s",desc:"AG Grid Display Name"}]},ColumnGroupScope:{name:"ColumnGroupScope",kind:"A",desc:"Defines Column Group Scope"},ColumnGroupValues:{name:"ColumnGroupValues",kind:"A",desc:"Manages Column Group expand / collapse behaviour, including exceptions"},ColumnGroupValuesWithExceptionKeys:{name:"ColumnGroupValuesWithExceptionKeys",kind:"A",desc:"Defines which Column Groups are expanded or collapsed"},ColumnHeaderContext:{name:"ColumnHeaderContext",kind:"A",desc:"Context provided to columnHeader function custom Headers to be provided for any type of AG Grid Column"},ColumnMenuContext:{name:"ColumnMenuContext",kind:"I",desc:"Provides full details about the Column in which the Column Menu will appear",props:[{name:"adaptableColumn",kind:"u",desc:"Current AdapTable Column"},{name:"agGridColumn",kind:"R",desc:"Current AG Grid Column",ref:"unknown"},{name:"isRowGroupColumn",kind:"b",desc:"Whether current Column is Row Group"}]},ColumnMenuOptions:{name:"ColumnMenuOptions",kind:"I",desc:"Options for managing menus in AdapTable – provided using 2 collections",props:[{name:"customColumnMenu",kind:"u",desc:"Customises Column Menu (default column menu items are available in the provided context)",isOpt:!0}]},ColumnNumberMap:{name:"ColumnNumberMap",kind:"A",desc:"Defines a map of Columns with a Number value"},ColumnOptions:{name:"ColumnOptions",kind:"I",desc:"Options related to managing Columns in Adaptable.",props:[{name:"addColumnGroupToColumnFriendlyName",kind:"b",desc:"Appends the name of the Column Group to a Column's Friendly Name",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"columnFriendlyName",kind:"f",desc:"Provide an alternative Friendly Name for a Column",isOpt:!0,defVal:"undefined"},{name:"columnHeader",kind:"f",desc:"Provide a custom Header Name for a Table or Pivot Column",isOpt:!0},{name:"columnTypes",kind:"u",desc:"Optional list of Column Types - used for Scope and creating Special Columns",isOpt:!0,defVal:"Empty Array"},{name:"showMissingColumnsWarning",kind:"b",desc:"Log warning to console if AdapTable cannot find a column",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"}]},ColumnScope:{name:"ColumnScope",kind:"A",desc:"Defines where a given Object / Module is active"},ColumnSizingDefinition:{name:"ColumnSizingDefinition",kind:"A",desc:"State & behaviour for column sizing (must set `width` or `flex` but not both); all other props optional"},ColumnSizingMap:{name:"ColumnSizingMap",kind:"A",desc:"Defines a map of Columns with Sizing information"},ColumnSort:{name:"ColumnSort",kind:"I",desc:"Defines how a Column is sorted",props:[{name:"ColumnId",kind:"s",desc:"Id of Column being sorted"},{name:"SortOrder",kind:"'Asc' | 'Desc'",desc:"How Column is sorted - either 'Asc' or 'Desc'"}]},ColumnStringMap:{name:"ColumnStringMap",kind:"A",desc:"Defines a map of Columns with a String value"},ColumnTypesContext:{name:"ColumnTypesContext",kind:"I",desc:"Context used when retrieving Column Types",props:[{name:"types",kind:"a",desc:"Current Column Types"}]},ColumnValuesComparer:{name:"ColumnValuesComparer",kind:"I",desc:"Comparer object for Column Values - used for custom sorting",props:[{name:"comparer",kind:"u",desc:"Comparer function to use"},{name:"scope",kind:"R",desc:"Column for which to compare values",ref:"ColumnScope"}]},CommandHandler:{name:"CommandHandler",kind:"A",desc:"Handles an Alert Form Command"},CommentableCellContext:{name:"CommentableCellContext",kind:"I",desc:"Context used when determining if a cell can show Comments",props:[{name:"gridCell",kind:"R",desc:"Grid Cell in AdapTable which has been clicked",ref:"GridCell"}]},CommentLoadContext:{name:"CommentLoadContext",kind:"I",desc:"Context used when loading Comments"},CommentOptions:{name:"CommentOptions",kind:"I",desc:"Options for managing Comments and Comment Threads in AdapTable",props:[{name:"dateFormat",kind:"u",desc:"Date Format string for Comments timestamp",isOpt:!0,defVal:"'dd-MM-yyyy HH:mm:ss'"},{name:"isCellCommentable",kind:"f",desc:"Function to configure if a cell can contain Comments",isOpt:!0},{name:"loadCommentThreads",kind:"f",desc:"Loads the Comment Threads",isOpt:!0},{name:"persistCommentThreads",kind:"f",desc:"Persists the current Comment Threads",isOpt:!0},{name:"showPopupCloseButton",kind:"b",desc:"Show the Close Button in the Comments Popup",isOpt:!0,defVal:"true"}]},CommentState:{name:"CommentState",kind:"I",desc:"Internal State used for Comments Module",props:[{name:"CommentThreads",kind:"a",desc:"Collection of AdapTable Comments",isOpt:!0}]},CommentThread:{name:"CommentThread",kind:"I",desc:"Thread of Comments for an Adaptable Cell",props:[{name:"Comments",kind:"a",desc:"Collection of Comments for this Cell"},{name:"Uuid",kind:"R",desc:"Unique identifier for Comment",isOpt:!0,ref:"unknown"}]},ContainerOptions:{name:"ContainerOptions",kind:"I",desc:"Options for managing the different div elements required by AdapTable",props:[{name:"adaptableContainer",kind:"u",desc:"Div containing AdapTable; string Id or HTMLElement",isOpt:!0,gridInfo:"item",defVal:""adaptable""},{name:"agGridContainer",kind:"u",desc:"Div containing AG Grid instance; string Id or HTMLElement",isOpt:!0,gridInfo:"item",defVal:""grid""},{name:"alertContainer",kind:"u",desc:"Div to display Alert messages; string Id or HTMLElement",isOpt:!0,gridInfo:"item",defVal:"undefined"},{name:"modalContainer",kind:"u",desc:"Name of div where popups appear",isOpt:!0,gridInfo:"item",defVal:"undefined (centre of screen)"},{name:"systemStatusContainer",kind:"u",desc:"Div to show System Status messages; string Id or HTMLElement",isOpt:!0,gridInfo:"item",defVal:"undefined"}]},ContextMenuContext:{name:"ContextMenuContext",kind:"I",desc:"Provides full details about current cell (and selected cells) where the Context Menu will appear",props:[{name:"adaptableColumn",kind:"u",desc:"Current AdapTable Column"},{name:"agGridColumn",kind:"R",desc:"Current AG Grid Column",ref:"unknown"},{name:"gridCell",kind:"u",desc:"Cell that has been clicked; contains cell value"},{name:"isGroupedNode",kind:"b",desc:"Whether current AG Grid row node is grouped"},{name:"isRowGroupColumn",kind:"b",desc:"Whether current Column is Row Grouped"},{name:"isSelectedCell",kind:"b",desc:"Whether cell that was clicked is also currently selected"},{name:"isSelectedRow",kind:"b",desc:"Whether cell that was clicked is in a Row that is currently selected"},{name:"isSingleSelectedCell",kind:"b",desc:"Whether the clicked cell is the only selected cell"},{name:"isSingleSelectedColumn",kind:"b",desc:"Whether Column that was clicked is only column with selected cells"},{name:"primaryKeyValue",kind:"u",desc:"Value of Primary Key column in current row"},{name:"rowNode",kind:"u",desc:"Current AG Grid row node"},{name:"selectedCellInfo",kind:"u",desc:"Currently selected cells in the grid"},{name:"selectedRowInfo",kind:"u",desc:"Currently selected rows in the grid"}]},ContextMenuOptions:{name:"ContextMenuOptions",kind:"I",desc:"Options for managing menus in AdapTable – provided using 2 collections",props:[{name:"customContextMenu",kind:"u",desc:"Customises Context Menu (default context menu items are available in provided context)",isOpt:!0}]},CreateRowFormContext:{name:"CreateRowFormContext",kind:"I",desc:"Context used in a Create Row Form",props:[{name:"clonedRowNode",kind:"u",desc:"The RowNode being cloned",isOpt:!0},{name:"type",kind:"u",desc:"Type of the Context"}]},CustomCellSummaryOperation:{name:"CustomCellSummaryOperation",kind:"I",desc:"Defines a Custom Cell Summary operation provided by a user",props:[{name:"operationFunction",kind:"u",desc:"Function to run when a summary result is required"},{name:"operationName",kind:"s",desc:"Name of the Operation - will be displayed in the Cell Summary components"}]},CustomCellSummaryOperationContext:{name:"CustomCellSummaryOperationContext",kind:"I",desc:"Context provided to a custom Cell Summary Operation function",props:[{name:"selectedCellInfo",kind:"u",desc:"Currently selected cells"},{name:"selectedColumn",kind:"R",desc:"Currently selected Column",ref:"AdaptableColumn"}]},CustomColumnMenuContext:{name:"CustomColumnMenuContext",kind:"I",desc:"Context info provided when building Custom Column Menus",props:[{name:"defaultAdaptableMenuItems",kind:"a",desc:"Flat list of all available AdapTable Menu Items"},{name:"defaultAdaptableMenuStructure",kind:"u",desc:"Default structure of Adaptable Menu Items"},{name:"defaultAgGridMenuItems",kind:"a",desc:"Flat list of all available AG Grid Menu Items"},{name:"defaultAgGridMenuStructure",kind:"u",desc:"Default structure of AG Grid Menu Items"}]},CustomColumnMenuItem:{name:"CustomColumnMenuItem",kind:"A",desc:"Custom Column Menu Item"},CustomContextMenuContext:{name:"CustomContextMenuContext",kind:"I",desc:"Context info provided when building Custom Context Menus",props:[{name:"defaultAdaptableMenuItems",kind:"a",desc:"Flat list of all available AdapTable Menu Items"},{name:"defaultAdaptableMenuStructure",kind:"R",desc:"Default structure of Adaptable Menu Items",ref:"DefaultAdaptableMenuStructure"},{name:"defaultAgGridMenuItems",kind:"a",desc:"Flat list of all available AG Grid Menu Items"},{name:"defaultAgGridMenuStructure",kind:"R",desc:"Default structure of AG Grid Menu Items",ref:"DefaultAgGridMenuStructure"}]},CustomContextMenuItem:{name:"CustomContextMenuItem",kind:"A",desc:"Custom Context Menu Item"},CustomDestination:{name:"CustomDestination",kind:"I",desc:"Defines a custom Export destination",props:[{name:"form",kind:"u",desc:"Optional Adaptable Form; if provided, it must include Buttons that will execute the Export",isOpt:!0},{name:"name",kind:"s",desc:"Name of Custom Destination (mandatory)"},{name:"onExport",kind:"f",desc:"Optional Function invoked when Export is applied (used if no form is supplied)",isOpt:!0}]},CustomDestinationsContext:{name:"CustomDestinationsContext",kind:"I",desc:"Context provided to `ExportOptions.customDestinations` callback",props:[{name:"currentLayoutName",kind:"s",desc:"Name of current Layout"},{name:"currentReportFormat",kind:"R",desc:"Format of current Report",isOpt:!0,ref:"ReportFormatType"},{name:"currentReportName",kind:"R",desc:"Name of current Report",isOpt:!0,ref:"ReportNameType"}]},CustomDisplayFormatter:{name:"CustomDisplayFormatter",kind:"I",desc:"Defines a Custom Display Format",props:[{name:"handler",kind:"f",desc:"Function used to render the Custom Display Format"},{name:"id",kind:"s",desc:"Custom Format Id"},{name:"label",kind:"s",desc:"Custom Format Description",isOpt:!0},{name:"scope",kind:"R",desc:"Used by Format Columns wizard to show where Custom Display Format can be applied",ref:"ColumnScope"}]},CustomDisplayFormatterContext:{name:"CustomDisplayFormatterContext",kind:"I",desc:"Context used in handler of CustomDisplayFormatter",props:[{name:"adaptableColumn",kind:"R",desc:"Column where Custom Display Format will apply",ref:"AdaptableColumn"},{name:"cellValue",kind:"u",desc:"Non-formatted Cell Value"},{name:"rowNode",kind:"R",desc:"Node where Custom Display Format will apply",ref:"unknown"}]},CustomEditColumnValueInfo:{name:"CustomEditColumnValueInfo",kind:"I",desc:"Information about items in the custom Edit Controls"},CustomEditColumnValuesContext:{name:"CustomEditColumnValuesContext",kind:"I",desc:"Context used when getting Distinct Column Values for Editing",props:[{name:"currentSearchValue",kind:"s",desc:"Search text in Edit - used when fetching values from server"},{name:"defaultValues",kind:"a",desc:"Current distinct values in Column"},{name:"gridCell",kind:"R",desc:"Currently edited Grid Cell",ref:"GridCell"}]},CustomExportParams:{name:"CustomExportParams",kind:"A",desc:"Custom Export Params extending AG Grid's base export params; allows overriding AdapTable default export"},CustomGroupColumnMenuItem:{name:"CustomGroupColumnMenuItem",kind:"A",desc:"Defines a Grouped Menu Item in the Column Menu"},CustomGroupContextMenuItem:{name:"CustomGroupContextMenuItem",kind:"A",desc:"Defines a Grouped Menu Item in the Context Menu"},CustomIcon:{name:"CustomIcon",kind:"I",desc:"Defines a bespoke Icon provided by a developer",props:[{name:"icon",kind:"R",desc:"AdapTable Icon definition",ref:"AdaptableIcon"},{name:"name",kind:"s",desc:"Name of Icon"}]},CustomInFilterValuesContext:{name:"CustomInFilterValuesContext",kind:"I",desc:"Context used when providing values for the IN Column Filter",props:[{name:"currentSearchValue",kind:"s",desc:"Search text in the IN Filter component - used when filtering on server"},{name:"defaultValues",kind:"a",desc:"Default list of values that will be displayed"},{name:"orderedValues",kind:"a",desc:"Default values in order which currently listed in the grid"},{name:"previousFilterResult",kind:"R",desc:"Last filter result; avoids expensive recomputations (eg if async or server-side filtering)",isOpt:!0,ref:"InFilterValueResult"},{name:"sortedValues",kind:"a",desc:"Default values but sorted (if Column is sorted)"}]},CustomQueryVariableContext:{name:"CustomQueryVariableContext",kind:"I",desc:"Context passed when evaluating customQueryVariables",props:[{name:"args",kind:"a",desc:"Optional variable arguments",isOpt:!0}]},CustomRenderContext:{name:"CustomRenderContext",kind:"I",desc:"Context provided for any custom rendering",props:[{name:"element",kind:"R",desc:"Container Div Element",ref:"unknown"},{name:"phase",kind:"'onMount' | 'onDestroy'",desc:"Phase of DOM Element lifecycle"}]},CustomRenderFunction:{name:"CustomRenderFunction",kind:"I",desc:"Function which is called when rendering/destroying a custom framework-agnostic component",props:[{name:"(call)",kind:"f",desc:"Function to provide bespoke content when NOT using a Framework wrapper"}]},CustomSettingsPanel:{name:"CustomSettingsPanel",kind:"I",desc:"Definition of a Custom Panel to add to the Adaptable Settings Panel",props:[{name:"frameworkComponent",kind:"R",desc:"Framework-specific (Angular, React or Vue) component to be rendered",isOpt:!0,ref:"AdaptableFrameworkComponent"},{name:"icon",kind:"R",desc:"Icon rendered inside settings-panel name, inside the navigation",isOpt:!0,ref:"AdaptableIcon"},{name:"name",kind:"s",desc:"Appears in Settings Panel Navigation and must be included in settingsPanelOptions.navigation for it to be displayed (by default added to the end)"},{name:"render",kind:"f",desc:"Function to provide bespoke content when NOT using a Framework wrapper",isOpt:!0}]},CustomSharedEntity:{name:"CustomSharedEntity",kind:"I",desc:"Defines a Custom object that will be shared using Team Sharing",props:[{name:"ChangedAt",kind:"n",desc:"Last time when the object was changed"},{name:"ChangedBy",kind:"s",desc:"Last User who changed the object"},{name:"Description",kind:"s",desc:"Description of object being shared"},{name:"Entity",kind:"u",desc:"Custom Object being shared"},{name:"EntityType",kind:"u",desc:"Type of shared entity (either Adaptable specific or custom object)"},{name:"IsReadOnly",kind:"b",desc:"Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')",isOpt:!0},{name:"Name",kind:"s",desc:"Name of object being shared"},{name:"Tags",kind:"a",desc:"List of Tags associated with the Object",isOpt:!0},{name:"Timestamp",kind:"n",desc:"When the object was shared"},{name:"UserName",kind:"s",desc:"User who shared the object"},{name:"Uuid",kind:"R",desc:"Unique identifier for the Custom Shared Entity",ref:"unknown"}]},CustomSharedEntityConfig:{name:"CustomSharedEntityConfig",kind:"I",desc:"Describes a custom Object which is being Team Shared",props:[{name:"Description",kind:"s",desc:"Description of object being shared"},{name:"Name",kind:"s",desc:"Name of object being shared"},{name:"Tags",kind:"a",desc:"List of Tags associated with the Object",isOpt:!0},{name:"Uuid",kind:"s",desc:"Optional technical ID; if not provided, it will be auto-generated by Adaptable",isOpt:!0}]},CustomSort:{name:"CustomSort",kind:"I",desc:"Custom Sort object used in Custom Sort function.",props:[{name:"ColumnId",kind:"s",desc:"Id of Column on which Custom Sort will be applied"},{name:"SortedValues",kind:"u",desc:"Order of values by which Column will be sorted; Date values are persisted as ISO strings ('yyyy-MM-dd')",isOpt:!0}]},CustomSortOptions:{name:"CustomSortOptions",kind:"I",desc:"Used to provide Custom Sorts comparers",props:[{name:"customSortComparers",kind:"u",desc:"CustomSort column comparer functions",isOpt:!0}]},CustomSortState:{name:"CustomSortState",kind:"I",desc:"Adaptable State Section for Custom Sort Module",props:[{name:"CustomSorts",kind:"a",desc:"Collection of Custom Sort objects.",isOpt:!0}]},CustomToolbar:{name:"CustomToolbar",kind:"I",desc:"Custom Toolbar (which AdapTable will manage) enabling devs to populate Dashboard with bepoke content",props:[{name:"frameworkComponent",kind:"R",desc:"The Framework-specific (Angular, React or Vue) component to be rendered",isOpt:!0,ref:"AdaptableFrameworkComponent"},{name:"name",kind:"s",desc:"How Toolbar is referenced (e.g. in Dashboard Popup when managing toolbars)"},{name:"render",kind:"f",desc:"Function to provide custom content when NOT using a Framework wrapper",isOpt:!0},{name:"title",kind:"s",desc:"Title to display in Toolbar; if unset or empty string, nothing will show",isOpt:!0},{name:"toolbarActions",kind:"R",desc:"Actions available in a Custom Dashboard Toolbar",isOpt:!0,ref:"ToolbarActions"},{name:"toolbarButtons",kind:"a",desc:"Optional set of buttons to show in the Toolbar",isOpt:!0}]},CustomToolbarButtonContext:{name:"CustomToolbarButtonContext",kind:"I",desc:"Context required by functions when using a Custom Toolbar Button",props:[{name:"customToolbar",kind:"R",desc:"Custom Toolbar which hosts the Button",ref:"CustomToolbar"}]},CustomToolPanel:{name:"CustomToolPanel",kind:"I",desc:"Defines a Custom ToolPanel - provided by Users and contains custom content",props:[{name:"buttons",kind:"a",desc:"Optional set of buttons to show in the ToolPanel",isOpt:!0},{name:"frameworkComponent",kind:"R",desc:"Framework-specific (Angular, React or Vue) component to be rendered",isOpt:!0,ref:"AdaptableFrameworkComponent"},{name:"name",kind:"s",desc:"Name of Custom ToolPanel - should be unique"},{name:"render",kind:"f",desc:"Function to provide bespoke content when using AdapTable Vanilla",isOpt:!0},{name:"title",kind:"s",desc:"Title to display in Custom ToolPanel; if undefined, will default to `name` property",isOpt:!0}]},CustomToolPanelButtonContext:{name:"CustomToolPanelButtonContext",kind:"I",desc:"Context used for Custom Tool Panels containing Buttons",props:[{name:"customToolPanel",kind:"R",desc:"The Custom ToolPanel which contains the button",ref:"CustomToolPanel"}]},CustomWindowConfig:{name:"CustomWindowConfig",kind:"I",desc:"Config used to open a Custom Window",props:[{name:"frameworkComponent",kind:"R",desc:"React, Angular or Vue Framework component to use for Custom Window content",isOpt:!0,ref:"AdaptableFrameworkComponent"},{name:"icon",kind:"R",desc:"Icon to display in Custom Window header",isOpt:!0,ref:"AdaptableSystemIconName"},{name:"id",kind:"s",desc:"Unique identifier for Custom Window"},{name:"onFrameworkComponentDestroyed",kind:"u",desc:"Callback function invoked when framework component is destroyed",isOpt:!0},{name:"position",kind:"R",desc:"Position of window in pixels (provided as x, y)",isOpt:!0,ref:"WindowPosition"},{name:"render",kind:"f",desc:"Render function to display content in Custom Window (if not using a framework component)",isOpt:!0},{name:"size",kind:"R",desc:"Size of window in pixels (provided as width, height)",isOpt:!0,ref:"WindowSize"},{name:"title",kind:"s",desc:"Title of Custom Window",isOpt:!0}]},DashboardButtonContext:{name:"DashboardButtonContext",kind:"I",desc:"Context required by functions when using a Dashboard Button",props:[{name:"dashboardState",kind:"R",desc:"Current Dashboard State",ref:"DashboardState"}]},DashboardButtonsLocation:{name:"DashboardButtonsLocation",kind:"A",desc:"Where Dashboard Buttons are displayed"},DashboardOptions:{name:"DashboardOptions",kind:"I",desc:"Options related to the Dashboard in Adaptable.",props:[{name:"buttonsLocation",kind:"R",desc:"Where in Dashboard to display Module and Custom Buttons",isOpt:!0,noCode:"item",defVal:"'right'",ref:"DashboardButtonsLocation"},{name:"canFloat",kind:"b",desc:"Whether the Dashboard can be floated; if true (the default), double-clicking Dashboard puts it in float mode",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"customDashboardButtons",kind:"a",desc:"Custom Adaptable Buttons to appear in Dashboard (alongside Module Buttons)",isOpt:!0},{name:"customToolbars",kind:"a",desc:"Toolbars provided by Users which contain custom content",isOpt:!0},{name:"showQuickSearchInHeader",kind:"b",desc:"Shows Quick Search textbox in the Dashboard Header",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"}]},DashboardState:{name:"DashboardState",kind:"I",desc:"Adaptable State Section for the AdapTable Dashboard",props:[{name:"ActiveTabIndex",kind:"n",desc:"Index of Active Tab (in Tabs collection)",isOpt:!0},{name:"DashboardTitle",kind:"s",desc:"Title displayed in Dashboard Header",isOpt:!0,defVal:"`adaptableId` in Adaptable Options"},{name:"FloatingPosition",kind:"R",desc:"Position of Dashboard when in Floating mode",isOpt:!0,ref:"AdaptableCoordinate"},{name:"IsCollapsed",kind:"b",desc:"Is Dashboard collapsed; if true, header is visible (but not Tabs' contents)",isOpt:!0,defVal:"false"},{name:"IsFloating",kind:"b",desc:"Is Dashboard floating; if true, appears in draggable, minmised form (double-click to revert to default position)",isOpt:!0,defVal:"false"},{name:"IsHidden",kind:"b",desc:"Whether Dashboard is completely hidden - can be made visible again in Column Menu and Tool Panel",isOpt:!0,defVal:"false"},{name:"IsInline",kind:"b",desc:"Alternative way of rendering Dashboard, with headers section to left of Toolbars",isOpt:!0,defVal:"false"},{name:"ModuleButtons",kind:"R",desc:"Buttons which open the Settings Panel screen for associated AdapTable Module",isOpt:!0,defVal:"['SettingsPanel']",ref:"unknown"},{name:"PinnedToolbars",kind:"u",desc:"Toolbars displayed above Grid (and not in Tab)",isOpt:!0},{name:"Tabs",kind:"a",desc:"Named group of Toolbars",isOpt:!0,defVal:"Empty Array"}]},DashboardTab:{name:"DashboardTab",kind:"I",desc:"Defines a named set of Toolbars in the AdapTable Dashboard",props:[{name:"Name",kind:"s",desc:"Name of the tab - as appears in the Dashboard"},{name:"Toolbars",kind:"u",desc:"List of Toolbars to show in the Tab"}]},DataChangeDetectionPolicy:{name:"DataChangeDetectionPolicy",kind:"A",desc:"Cell Change that will trigger an Alert: can be 'rawValue' or 'formattedValue'"},DataChangedScope:{name:"DataChangedScope",kind:"I",desc:"Defines where a Data Change should be monitored",props:[{name:"columnIds",kind:"u",desc:"Scopes a group of Column Ids"},{name:"wholeRow",kind:"b",desc:"Scopes every Column in the Row"}]},DataChangeHistoryButton:{name:"DataChangeHistoryButton",kind:"I",desc:"A custom AdaptableButton which provides a build in `undo` action"},DataChangeHistoryContext:{name:"DataChangeHistoryContext",kind:"I",desc:"The context for the DataChangeHistoryButton",props:[{name:"clearRow",kind:"u",desc:"Helper function to row from Grid"},{name:"dataChangedInfo",kind:"u",desc:"The initial data change"},{name:"isGroupNode",kind:"b",desc:"If the change references a group node."},{name:"parentAdapTableApi",kind:"R",desc:"AdapTable API of underlying Grid (not from Data History Monitor)",ref:"unknown"},{name:"undoDataChange",kind:"u",desc:"Helper function to undo the change."}]},DataChangeHistoryOptions:{name:"DataChangeHistoryOptions",kind:"I",desc:"Options to manage the 'Data Change History Module', which provides an overview of all previous changes, giving the possibility to undo specific changes",props:[{name:"activeByDefault",kind:"b",desc:"Make Data Change History active by default",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"changeHistoryButton",kind:"u",desc:"Action button definition; can be used to implement undo functionality",isOpt:!0,defVal:"undefined"},{name:"showDataChange",kind:"u",desc:"Function specifying which data changes to include in Data Change History",isOpt:!0,gridInfo:"item",defVal:"undefined (all data changes are logged)"},{name:"showLastDataChangeOnly",kind:"b",desc:"Show all changes for a Cell or just the last one",isOpt:!0,defVal:"true"}]},DataFormatDataType:{name:"DataFormatDataType",kind:"I",desc:"Defines the Format Data Types for all Data Types",props:[{name:"date",kind:"R",desc:"Data Format type for Date columns",isOpt:!0,ref:"DataFormatType"},{name:"number",kind:"R",desc:"Data Format type for Number columns",isOpt:!0,ref:"DataFormatType"},{name:"text",kind:"R",desc:"Data Format type for String / Text columns",isOpt:!0,ref:"DataFormatType"}]},DataFormatType:{name:"DataFormatType",kind:"A",desc:"Format of exported Data - 'rawValue' or 'formattedValue'"},DataImportFileHandler:{name:"DataImportFileHandler",kind:"I",desc:"Files that can be handled by Data Import",props:[{name:"fileExtension",kind:"s",desc:"Name of File Extension",isOpt:!0},{name:"handleFile",kind:"u",desc:"Async function which handles the import returning a Data Record"}]},DataImportOptions:{name:"DataImportOptions",kind:"I",desc:"Options for managing the Data Import function",props:[{name:"_getPrimaryKeyValue",kind:"u",desc:"Function to get the Primary Key value for a data row (defaults to value of the primaryKey column)",isOpt:!0},{name:"_preprocessRowData",kind:"u",desc:"Function to pre-process the data before it is imported",isOpt:!0},{name:"fileHandlers",kind:"a",desc:"Custom File Handlers to use for Data Import",isOpt:!0},{name:"handleImportedData",kind:"u",desc:"Function to handle the Imported Data and apply it to the Grid. If not provided then the Data will be applied to the Grid automatically.",isOpt:!0},{name:"textHandler",kind:"u",desc:"Handles Importing Data using text",isOpt:!0},{name:"validate",kind:"u",desc:"Function to validate the Imported Data",isOpt:!0}]},DataImportValidateContext:{name:"DataImportValidateContext",kind:"I",desc:"Context passed to the `validate` function",props:[{name:"rowData",kind:"u",desc:"Imported Row Data"}]},DataImportValidationError:{name:"DataImportValidationError",kind:"I",desc:"Defines a Validation Error",props:[{name:"columnId",kind:"s",desc:"Column which contains the Error"},{name:"error",kind:"s",desc:"The validatoin error text"}]},DataSet:{name:"DataSet",kind:"I",desc:"Defines a Data Set object that can provide data to AdapTable",props:[{name:"description",kind:"s",desc:"Describes the Data Set"},{name:"form",kind:"u",desc:"Params for Data Set popup form",isOpt:!0},{name:"info",kind:"u",desc:"Additional info for Data Set",isOpt:!0},{name:"name",kind:"s",desc:"Name of Data Set"}]},DataSetFormContext:{name:"DataSetFormContext",kind:"I",desc:"Used when a DataSet displays a Form",props:[{name:"dataSet",kind:"R",desc:"The DataSet which triggered the Form",ref:"DataSet"}]},DataSetOptions:{name:"DataSetOptions",kind:"I",desc:"Options to provide Data Sets",props:[{name:"dataSets",kind:"a",desc:"Collection of Data Sets to provide data to AdapTable",isOpt:!0}]},DataUpdateConfig:{name:"DataUpdateConfig",kind:"I",desc:"Object used to configure GridApi row management methods",props:[{name:"addIndex",kind:"n",desc:"Index where to add new rows",isOpt:!0},{name:"callback",kind:"u",desc:"Callback function invoked when a batch successfully concludes",isOpt:!0},{name:"flushAsync",kind:"b",desc:"Whether to flush async operations",isOpt:!0},{name:"runAsync",kind:"b",desc:"Whether row operation should happen asynchronously",isOpt:!0}]},DateFormatterOptions:{name:"DateFormatterOptions",kind:"I",desc:"Formatter Options for Date Columns - contains a single `Pattern` property",props:[{name:"Pattern",kind:"s",desc:"Pattern to use for Date Format",isOpt:!0}]},DateInputOptions:{name:"DateInputOptions",kind:"I",desc:"Options for managing and customizing the date inputs.",props:[{name:"dateFormat",kind:"s",desc:"Format string for formatting date input field",isOpt:!0,defVal:"'yyyy-MM-dd' (ISO 8601 format)"},{name:"datepickerButtons",kind:"a",desc:"List of buttons which are displayed in the datepicker overlay in the given order (provide empty array to display no buttons); custom button layout and positioning is achievable with the special elements `-` and `|`",isOpt:!0,defVal:"['close','today']"},{name:"locale",kind:"u",desc:"Locale object (to localize Date Picker)",isOpt:!0,defVal:"`en-US`"},{name:"showOutsideDays",kind:"b",desc:"Display outside days (i.e. those falling in next or previous month)",isOpt:!0,defVal:"true"},{name:"showWeekNumber",kind:"b",desc:"Display the week numbers column",isOpt:!0,defVal:"false"},{name:"useNativeInput",kind:"b",desc:"Use browser specific date input instead of AdapTable's Date Picker",isOpt:!0,defVal:"false"}]},DefaultAccessLevelContext:{name:"DefaultAccessLevelContext",kind:"I",desc:"Provided to defaultAccessLevel function when setting Default Entitlement value programatically"},DefaultAdaptableMenuStructure:{name:"DefaultAdaptableMenuStructure",kind:"A",desc:"The Context Menu provided by AadapTable by default"},DefaultAgGridMenuStructure:{name:"DefaultAgGridMenuStructure",kind:"A",desc:"AG Grid section of Context Menu provided by AadapTable by default"},DefaultPredicateFilterContext:{name:"DefaultPredicateFilterContext",kind:"I",desc:"Context used for setting default Predicates for Column Filters",props:[{name:"column",kind:"u",desc:"Current Column"},{name:"filterComponent",kind:"R",desc:"Filter Component being displayed: FilterBar or FilterForm",ref:"AdaptableFilterComponentLocation"}]},DetailInitContext:{name:"DetailInitContext",kind:"I",desc:"Context passed to Detail Grids when using Master Detail Plugin",props:[{name:"data",kind:"u",desc:"The data in the Master Grid Row that was opened"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key Value of Master Grid Row that was opened"},{name:"rowNode",kind:"R",desc:"Row Node in the Master Grid that was opened",ref:"unknown"}]},EditColumnValueInfo:{name:"EditColumnValueInfo",kind:"I",desc:"Information about items in the Edit Controls"},EditOptions:{name:"EditOptions",kind:"I",desc:"Options related to Editing in AdapTable - includes Server Validation, Smart Edit Operations and Cell Editabiility",props:[{name:"customEditColumnValues",kind:"u",desc:"List of Column values to display when Editing (i.e. in Edit Lookups, Bulk Update)",isOpt:!0},{name:"displayServerValidationMessages",kind:"b",desc:"Whether to display message after Server Validation runs",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"isCellEditable",kind:"u",desc:"Function which checks if a given Grid Cell is editable",isOpt:!0},{name:"showSelectCellEditor",kind:"u",desc:"Columns that will display a Select dropdown when editing",isOpt:!0},{name:"smartEditCustomOperations",kind:"u",desc:"Custom Operations to use in Smart Edit",isOpt:!0},{name:"validateOnServer",kind:"u",desc:"Function to validate AdapTable data edits remotely",isOpt:!0}]},EditRowFormContext:{name:"EditRowFormContext",kind:"I",desc:"Context used in an Edit Row Form",props:[{name:"rowNode",kind:"u",desc:"The RowNode being edited"},{name:"type",kind:"u",desc:"Type of the Context"}]},Entitlement:{name:"Entitlement",kind:"I",desc:"Defines a Permission in AdapTable - Module and Access Level",props:[{name:"accessLevel",kind:"R",desc:"Access Level for an Entitlement; options are: `Full` `ReadOnly` `Hidden`",ref:"AccessLevel"},{name:"adaptableModule",kind:"R",desc:"Name of Adaptable Module that has the Entitlement applied",ref:"AdaptableModule"}]},EntitlementContext:{name:"EntitlementContext",kind:"I",desc:"Provided to moduleEntitlements function when setting Entitlements programatically",props:[{name:"adaptableModule",kind:"R",desc:"Module being entitled",ref:"AdaptableModule"},{name:"defaultAccessLevel",kind:"R",desc:"The default Access Level for the current instance",ref:"AccessLevel"}]},EntitlementOptions:{name:"EntitlementOptions",kind:"I",desc:"Options for managing Entitlements in AdapTable, ie. which Modules are available to the User and whether as *Full*, *ReadOnly* or *Hidden*.",props:[{name:"defaultAccessLevel",kind:"u",desc:"AccessLevel to use when an Entitlement is not explicitly set; can be hardcoded value or a function to invoke",isOpt:!0,gridInfo:"item",defVal:"'Full'"},{name:"moduleEntitlements",kind:"u",desc:"Returns either collection of `Entitlements`, or a function to invoke when an Entitlement is required",isOpt:!0,gridInfo:"item"}]},EvaluateExpressionExternallyContext:{name:"EvaluateExpressionExternallyContext",kind:"I",desc:"Context passed when evaluating `expressionOptions.evaluateExpressionExternally()`",props:[{name:"expression",kind:"s",desc:"Expression to evaluate",isOpt:!0},{name:"module",kind:"R",desc:"Module being evaluated: Alert, CalculatedColumn, ColumnFilter, GridFilter",ref:"AdaptableQLModule"},{name:"object",kind:"R",desc:"AdapTable Object which contains the Expression or Predicates",isOpt:!0,ref:"AdaptableObject"},{name:"predicates",kind:"a",desc:"Any Predicates to evaluate",isOpt:!0},{name:"referencedColumns",kind:"u",desc:"Columns contained in Expression",isOpt:!0}]},ExportConfig:{name:"ExportConfig",kind:"I",desc:"Config used when Exporting via API, allows fine grained exporting",props:[{name:"exportParams",kind:"u",desc:"Function to modify export params; receives default params & returns modified params",isOpt:!0},{name:"showProgressIndicator",kind:"b",desc:"Whether to show progress indicator",isOpt:!0}]},ExportDataFormatContext:{name:"ExportDataFormatContext",kind:"I",desc:"Context provided to `ExportOptions.exportDataFormat` callback",props:[{name:"column",kind:"u",desc:"The column being exported"}]},ExportDateFormatContext:{name:"ExportDateFormatContext",kind:"I",desc:"Context provided to `ExportOptions.exportDateFormat` callback",props:[{name:"column",kind:"u",desc:"The column being exported"}]},ExportDestinationType:{name:"ExportDestinationType",kind:"A",desc:"Configures which destination Reports get exported to"},ExportFormContext:{name:"ExportFormContext",kind:"I",desc:"Context required by functions when using an Export Button",props:[{name:"customDestination",kind:"R",desc:"Custom Export destination",ref:"CustomDestination"},{name:"report",kind:"R",desc:"The exported report",ref:"Report"},{name:"reportData",kind:"R",desc:"The data in the report",ref:"ExportResultData"}]},ExportOptions:{name:"ExportOptions",kind:"I",desc:"Options regarding Exporting data from AdapTable",props:[{name:"appendFileTimestamp",kind:"b",desc:"Whether to add a timestamp as a suffix to exported file name",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"csvSeparator",kind:"u",desc:"Separator for CSV exports",isOpt:!0,gridInfo:"item",defVal:"','"},{name:"customDestinations",kind:"u",desc:"User-provided Report Destinations (in addition to those shipped in AdapTable)",isOpt:!0},{name:"excelSheetName",kind:"u",desc:"Provides a custom name for the Excel sheet when exporting to Excel",isOpt:!0,defVal:"'Sheet1'"},{name:"exportDataFormat",kind:"u",desc:"Sets 'rawValue' or 'formattedValue' as Data format in Reports; can be set for whole grid, per Data Type, or per Column (via a function)",isOpt:!0,defVal:"rawValue"},{name:"exportDateFormat",kind:"u",desc:"Optional custom format for Date columns when exporting",isOpt:!0,gridInfo:"item",defVal:"undefined"},{name:"getDetailRows",kind:"u",desc:"Function to provide the Detail Rows when exporting in Master-Detail grids. This function will be invoked for each master row node.",isOpt:!0},{name:"isColumnExportable",kind:"f",desc:"Whether a Column is included in System Reports and available in UI for selection",isOpt:!0,defVal:"true"},{name:"processExport",kind:"u",desc:"Provides custom handling of the Export process before the default export is executed.",isOpt:!0},{name:"reportFilename",kind:"f",desc:"Provide a bespoke file name for the Report",isOpt:!0},{name:"skipColumnHeaders",kind:"u",desc:"Whether to exclude Column Headers from the exported data",isOpt:!0,defVal:"false"},{name:"systemExportDestinations",kind:"u",desc:"Export destinations to use; leave unset for all, empty array for none",isOpt:!0,gridInfo:"item",defVal:"'Download', 'Clipboard'"},{name:"systemReportFormats",kind:"u",desc:"System Report Formats to use; leave unset for all, empty array for none",isOpt:!0,gridInfo:"item",defVal:"'Excel', 'VisualExcel', 'CSV', 'JSON'"},{name:"systemReportNames",kind:"u",desc:"System Reports to use; leave unset for all, empty array for none",isOpt:!0,gridInfo:"item",defVal:"'All Data', 'Current Layout', 'Selected Data',"}]},ExportResultData:{name:"ExportResultData",kind:"A",desc:"Type of Export result data: string (CSV), ReportData (JSON), or Blob (Excel)"},ExportState:{name:"ExportState",kind:"I",desc:"Adaptable State Section for Export Module",props:[{name:"CurrentFormat",kind:"R",desc:"Selected Report Format - in Export Toolbar & Tool Panel",isOpt:!0,ref:"ReportFormatType"},{name:"CurrentReport",kind:"R",desc:"Selected Report Type - in Export Toolbar & Tool Panel",isOpt:!0,ref:"ReportNameType"},{name:"Reports",kind:"a",desc:"User-created Reports; each has Name and Row and Column Scope",isOpt:!0}]},ExpressionCategory:{name:"ExpressionCategory",kind:"A",desc:"Categories for Expression Functions"},ExpressionContext:{name:"ExpressionContext",kind:"I",desc:"Provides context to an Expression Function, including current row node and AdaptableApi",props:[{name:"dataChangedEvent",kind:"R",desc:"Changed cell data",isOpt:!0,ref:"CellDataChangedInfo"},{name:"evaluateCustomQueryVariable",kind:"u",desc:"Evaluate custom variables",isOpt:!0},{name:"filterFn",kind:"u",desc:"Optional filter function to be applied before evaluating the expression",isOpt:!0},{name:"functions",kind:"u",desc:"All Expression Functions available to AdaptableQL"},{name:"getRowNodes",kind:"u",desc:"Get custom list rows",isOpt:!0},{name:"namedQueryCallStack",kind:"a",desc:"All Named Query evaluations: tracked in order to detect circular dependencies",isOpt:!0},{name:"node",kind:"R",desc:"Current AG Grid Row Node being evaluated",ref:"unknown"},{name:"pivotResultColumn",kind:"R",desc:"Pivot Result Column when evaluating a Pivoted Column",isOpt:!0,ref:"unknown"},{name:"whereClauseFunctions",kind:"u",desc:"Expression Functions available to AdaptableQL in (optional) WHERE clause",isOpt:!0}]},ExpressionFunction:{name:"ExpressionFunction",kind:"I",desc:"Defines an AdaptableQL Function used in an Adaptable Expression",props:[{name:"category",kind:"R",desc:"Used to group Functions Expression Editor dropdown",isOpt:!0,ref:"ExpressionCategory"},{name:"description",kind:"s",desc:"What the AdaptableQL Function does",isOpt:!0},{name:"examples",kind:"a",desc:"Examples that demonstrate the AdaptableQL Function",isOpt:!0},{name:"handler",kind:"R",desc:"Actual AdaptableQL Function called by the Expression (mandatory prop)",ref:"ExpressionFunctionHandler"},{name:"hasEagerEvaluation",kind:"b",desc:"Whether Expression is evaluated without handling inner AST nodes",isOpt:!0},{name:"inputs",kind:"u",desc:"Data Types of Inputs required by Expression",isOpt:!0},{name:"isHiddenFromMenu",kind:"b",desc:"Removes entry from Expression Editor's Functions dropdown",isOpt:!0},{name:"returnType",kind:"'boolean' | 'number' | 'string' | 'date' | 'null' | 'any'",desc:"Type returned by Function: boolean, number, string, date, any",isOpt:!0},{name:"signatures",kind:"a",desc:"How the AdaptableQL Function should be called",isOpt:!0}]},ExpressionFunctionDocBlock:{name:"ExpressionFunctionDocBlock",kind:"A",desc:"Defines how an AdaptableQL Function is described in Expression Editor"},ExpressionFunctionHandler:{name:"ExpressionFunctionHandler",kind:"A",desc:"The javascript function which is invoked by an AdaptableQL Function"},ExpressionFunctionInputType:{name:"ExpressionFunctionInputType",kind:"A",desc:"Data Types of Inputs used by Expression (test, number, date, boolean)"},ExpressionFunctionMap:{name:"ExpressionFunctionMap",kind:"A",desc:"Key-Value map of Expression Names and their implementation"},ExpressionOptions:{name:"ExpressionOptions",kind:"I",desc:"Options for managing Expressions in AdapTable's Query Language",props:[{name:"caseSensitiveExpressions",kind:"b",desc:"Perform case-sensitive text comparisons when evaluating Expressions",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"customAggregatedFunctions",kind:"u",desc:"Bespoke Aggregated functions - to complement those provided by AdapTable",isOpt:!0},{name:"customBooleanFunctions",kind:"u",desc:"Custom Boolean Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (none)"},{name:"customQueryVariables",kind:"u",desc:"Values to be attached to variables so that a single value can easily be expressed multiple times within a query, or quickly changed to affect the results of a query; evaluated synchronously with each expression evaluation",isOpt:!0},{name:"customScalarFunctions",kind:"u",desc:"Custom Scalar Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (none)"},{name:"displayColumnFriendlyNamesForExpressions",kind:"b",desc:"Reference a Column's Header (i.e. FriendlyName) in all Expression overviews (instead of ColumnId)",isOpt:!0,noCode:"item",defVal:"true"},{name:"evaluateAdaptableQLExternally",kind:"u",desc:"Whether a Module (or specific expression) should be evaluated by AdapTableQL",isOpt:!0,defVal:"All Modules are evaluated by AdapTable"},{name:"fields",kind:"u",desc:"Fields are items in Data Source that are NOT columns but can be used in Expressions (via FIELD keyword)",isOpt:!0},{name:"isColumnQueryable",kind:"f",desc:"Can a given column be included in Expressions",isOpt:!0},{name:"maxTimeframeSize",kind:"n",desc:"Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe",isOpt:!0,gridInfo:"item",defVal:"28800000 (~8 hours)"},{name:"moduleExpressionFunctions",kind:"u",desc:"Module-specific Expression Functions available",isOpt:!0,gridInfo:"item",defVal:"undefined (defaults to available System & Custom values)"},{name:"performExpressionValidation",kind:"b",desc:"Validate Expressions before they can be run or saved",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"systemAggregatedBooleanFunctions",kind:"u",desc:"System AggregatedBoolean Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"},{name:"systemAggregatedScalarFunctions",kind:"u",desc:"System AggregatedScalar Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"undefined (sets all)"},{name:"systemBooleanFunctions",kind:"u",desc:"System Boolean Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"},{name:"systemObservableFunctions",kind:"u",desc:"System Observable Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"},{name:"systemScalarFunctions",kind:"u",desc:"System Scalar Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"}]},ExtendedLayout:{name:"ExtendedLayout",kind:"I",desc:"Defines an Extended Layout - provides a Layout and all objects that refer to it",props:[{name:"Extensions",kind:"a",desc:"Object to be included in the Layout"},{name:"Layout",kind:"R",desc:"Layout being extended",ref:"Layout"}]},ExternalChartingContext:{name:"ExternalChartingContext",kind:"I",desc:"Context passed to External Charting Options functions",props:[{name:"chartDefinition",kind:"u",desc:"Definition of External Chart"},{name:"container",kind:"R",desc:"Chart's Container",isOpt:!0,ref:"ChartContainer"}]},ExternalChartingOptions:{name:"ExternalChartingOptions",kind:"I",desc:"Options for managing External (i.e. non AG Grid) Charts",props:[{name:"isChartOpened",kind:"f",desc:"Needs to be implemented to specify if Chart is opened; used to set Show Button's highlighting",isOpt:!0},{name:"onDeleteChart",kind:"f",desc:"Called when User deletes a persisted Chart",isOpt:!0},{name:"onHideChart",kind:"f",desc:"Called when User clicks on Hide button next to Chart",isOpt:!0},{name:"onPreviewChart",kind:"u",desc:"Shows Chart in Settings Panel preview (not saved into State); returned definition will be passed to 'onHideChart' when Preview closes",isOpt:!0},{name:"onShowChart",kind:"f",desc:"Called when User clicks on Show button next to Chart",isOpt:!0}]},FDC3ActionColumn:{name:"FDC3ActionColumn",kind:"I",desc:"Action Column used for FDC3 workflows",props:[{name:"button",kind:"R",desc:"FDC3 Button to display",ref:"Fdc3AdaptableButton"},{name:"columnId",kind:"s",desc:"Id of the Column"},{name:"defaultWidth",kind:"n",desc:"Default Width of column",isOpt:!0},{name:"friendlyName",kind:"s",desc:"Column's friendly name",isOpt:!0}]},Fdc3AdaptableButton:{name:"Fdc3AdaptableButton",kind:"I",desc:"Button used in FDC3 Action Columns",props:[{name:"buttonStyle",kind:"u",desc:"Button's Style; can be object or function that provides `ButtonStyle` object",isOpt:!0},{name:"disabled",kind:"u",desc:"Function to disable / enable button based on evaluation result",isOpt:!0},{name:"hidden",kind:"u",desc:"Function to hide the Button",isOpt:!0},{name:"icon",kind:"u",desc:"Button's Icon; can be object or function that provides `AdaptableIcon` object",isOpt:!0},{name:"id",kind:"s",desc:"Unique id for the button"},{name:"label",kind:"u",desc:"Button's Label; can be string or function that provides string",isOpt:!0},{name:"tooltip",kind:"u",desc:"Button's Tooltip; can be string or function that provides string",isOpt:!0}]},Fdc3ButtonContext:{name:"Fdc3ButtonContext",kind:"I",desc:"Context provided in dynamic FDC3 Buttons",props:[{name:"context",kind:"R",desc:"The FDC3 Context",ref:"unknown"},{name:"intent",kind:"R",desc:"The FDC3 Intent",isOpt:!0,ref:"unknown"},{name:"primaryKeyValue",kind:"u",desc:"Primary key value of row"},{name:"rowData",kind:"u",desc:"The row data which is the source of the context data"},{name:"rowNode",kind:"R",desc:"The row node which is the source of the context data",ref:"unknown"}]},Fdc3ContextOptions:{name:"Fdc3ContextOptions",kind:"I",desc:"Options for configuring FDC3 Context Behaviour in AdapTable",props:[{name:"broadcasts",kind:"R",desc:"Broadcasts given standard Context(s) on various Grid Actions",isOpt:!0,ref:"BroadcastConfiguration"},{name:"handleContext",kind:"f",desc:"Handles incoming Contexts (standard and custom)",isOpt:!0},{name:"listensFor",kind:"a",desc:"Subscribe to given standard Context(s)",isOpt:!0}]},Fdc3IntentOptions:{name:"Fdc3IntentOptions",kind:"I",desc:"Options for configuring FDC3 Intent Behaviour in AdapTable",props:[{name:"handleIntent",kind:"u",desc:"Handles incoming Intents (standard and custom)",isOpt:!0},{name:"handleIntentResolution",kind:"u",desc:"Handles the IntentResolution that a raised Intent might return",isOpt:!0},{name:"listensFor",kind:"a",desc:"Subscribe to given standard Intent(s)",isOpt:!0},{name:"raises",kind:"R",desc:"Raises given standard Intent(s) on various Grid Actions",isOpt:!0,ref:"RaiseIntentConfiguration"}]},Fdc3Options:{name:"Fdc3Options",kind:"I",desc:"Options for configuring FDC3 in AdapTable",props:[{name:"actionColumnDefaultConfiguration",kind:"R",desc:"Configures the default FDC3 Actions column",isOpt:!0,ref:"ActionColumnDefaultConfiguration"},{name:"contexts",kind:"R",desc:"Configures FDC3 standard Contexts that AdapTable will listen for and broadcast",isOpt:!0,ref:"Fdc3ContextOptions"},{name:"enableLogging",kind:"b",desc:"Enable logging message exchanges to Console",isOpt:!0,defVal:"false"},{name:"gridDataContextMapping",kind:"R",desc:"Maps Context Type to AdapTable Grid Data",isOpt:!0,ref:"GridDataContextMapping"},{name:"intents",kind:"R",desc:"Configures FDC3 standard Intents that AdapTable will listen for and raise",isOpt:!0,ref:"Fdc3IntentOptions"},{name:"resolveContextData",kind:"u",desc:"Builds Context Data (useful for postprocessing Context Data mapped from Grid data)",isOpt:!0},{name:"uiControlsDefaultConfiguration",kind:"u",desc:"Customises FDC3 UI Controls",isOpt:!0}]},FilterActionOnDataChange:{name:"FilterActionOnDataChange",kind:"I",desc:"Whether Adaptable re-applies filtering after data edits; if `applyFilter` value is 'Throttle', `throttleDelay` should be set",props:[{name:"applyFilter",kind:"R",desc:"When to re-apply Filters: 'Always', 'Never' or 'Throttle'",ref:"ApplyFilterAction"},{name:"throttleDelay",kind:"n",desc:"Delay in ms (when `applyFilter` is set to 'Throttle')",isOpt:!0}]},FilterOptions:{name:"FilterOptions",kind:"I",desc:"Options for managing Column & Grid Filters in AdapTable",props:[{name:"clearFiltersOnStartUp",kind:"b",desc:"Clear Grid and Column Filters when AdapTable loads",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"columnFilterOptions",kind:"R",desc:"Options for managing Column Filters",isOpt:!0,ref:"ColumnFilterOptions"},{name:"customInFilterValues",kind:"u",desc:"Provide custom values (or sorting / count info) when using `In` Predicate in Column or Grid Filter",isOpt:!0},{name:"enableFilterOnSpecialColumns",kind:"b",desc:"Allow filtering on Calculated & FreeText columns",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"filterActionOnDataChange",kind:"R",desc:"When to re-filter grid after data changes: 'Always', 'Never' or 'Throttle' (with a delay value)",isOpt:!0,defVal:"'Always'",ref:"FilterActionOnDataChange"},{name:"gridFilterOptions",kind:"R",desc:"Options for managing the Grid Filter",isOpt:!0,ref:"GridFilterOptions"},{name:"isRowFilterable",kind:"f",desc:"Configures whether Rows will be evaluated when filtering",isOpt:!0},{name:"showDatePicker",kind:"b",desc:"Show Date Picker (or Date Input) in Filter controls",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"useAdaptableFiltering",kind:"b",desc:"Use Adaptable's Column & Grid Filters in preference to AG Grid's filtering",isOpt:!0,noCode:"item",defVal:"true"}]},FlashingCellDefinition:{name:"FlashingCellDefinition",kind:"I",desc:"The Flashing Cell Definition",props:[{name:"DownChangeStyle",kind:"R",desc:"Style for 'Down' value changes",isOpt:!0,defVal:"Red BackColour",ref:"AdaptableStyle"},{name:"FlashDuration",kind:"number | 'always'",desc:"Duration of Flash - can be number (in ms) or 'always'",isOpt:!0,defVal:"500ms"},{name:"FlashTarget",kind:"u",desc:"Should a cell or whole row flash",isOpt:!0,defVal:"'cell'"},{name:"NeutralChangeStyle",kind:"R",desc:"Style for 'Neutral' value changes",isOpt:!0,defVal:"Gray BackColour",ref:"AdaptableStyle"},{name:"Rule",kind:"R",desc:"When Flashing Cell should be triggered",ref:"unknown"},{name:"Scope",kind:"R",desc:"Which Columns, DataTypes or Column Types can Flash",ref:"ColumnScope"},{name:"UpChangeStyle",kind:"R",desc:"Style for 'Up' value changes",isOpt:!0,defVal:"Green BackColour",ref:"AdaptableStyle"}]},FlashingCellOptions:{name:"FlashingCellOptions",kind:"I",desc:"Properties for Flashing Cell",props:[{name:"defaultDownChangeStyle",kind:"R",desc:"Style for 'Down' value changes",isOpt:!0,defVal:"Red BackColour",ref:"AdaptableStyle"},{name:"defaultFlashDuration",kind:"number | 'always'",desc:"Duration of Flash - can be number (in ms) or 'always'",isOpt:!0,defVal:"500ms"},{name:"defaultFlashTarget",kind:"R",desc:"Should a cell or whole row flash",isOpt:!0,defVal:"'cell'",ref:"FlashTarget"},{name:"defaultNeutralChangeStyle",kind:"R",desc:"Style for 'Neutral' value changes",isOpt:!0,defVal:"Gray BackColour",ref:"AdaptableStyle"},{name:"defaultUpChangeStyle",kind:"R",desc:"Style for 'Up' value changes",isOpt:!0,defVal:"Green BackColour",ref:"AdaptableStyle"}]},FlashingCellState:{name:"FlashingCellState",kind:"I",desc:"Adaptable State Section for Flashing Cell module",props:[{name:"FlashingCellDefinitions",kind:"a",desc:"Flashing Cell Definitions - will flash cells/rows when rule is met",isOpt:!0}]},FlashTarget:{name:"FlashTarget",kind:"A",desc:"Where a Flash can happen"},FormatColumn:{name:"FormatColumn",kind:"I",desc:"Object used in Format Column function",props:[{name:"CellAlignment",kind:"R",desc:"Align cells 'Left' or 'Right' or 'Center'",isOpt:!0,ref:"CellAlignment"},{name:"ColumnGroupScope",kind:"R",desc:"When to format Columns in Column Groups ('Expanded', 'Collapsed', 'Both')",isOpt:!0,ref:"ColumnGroupScope"},{name:"DisplayFormat",kind:"R",desc:"Display Format to apply to Column can be Numeric, String or Date",isOpt:!0,ref:"AdaptableFormat"},{name:"RowScope",kind:"R",desc:"Which types of Rows to apply format (data, grouped, summary, total)",isOpt:!0,ref:"RowScope"},{name:"Rule",kind:"R",desc:"Rule to decide whether to apply Format; if undefined Format is always applied",isOpt:!0,ref:"FormatColumnRule"},{name:"Scope",kind:"R",desc:"Where Format will be applied: whole Row, some Columns, or Columns of DataType",ref:"ColumnScope"},{name:"Style",kind:"R",desc:"AdapTable Style to apply",isOpt:!0,ref:"AdaptableStyle"},{name:"Target",kind:"R",desc:"Where in Column to apply Format (`cell` or `columnHeader`)",isOpt:!0,defVal:"'cell'",ref:"FormatColumnTarget"}]},FormatColumnConfig:{name:"FormatColumnConfig",kind:"I",desc:"Config for api methods that get Format Columns"},FormatColumnOptions:{name:"FormatColumnOptions",kind:"I",desc:"Provides Custom Formats used in Format Column Module",props:[{name:"customDisplayFormatters",kind:"a",desc:"Custom Formatters to use in Format Column Module",isOpt:!0}]},FormatColumnPredicate:{name:"FormatColumnPredicate",kind:"I",desc:"Predicate used when creating a Format Column"},FormatColumnRule:{name:"FormatColumnRule",kind:"A",desc:"The Format Column Rule - can be either a Predicate or a BooleanExpression"},FormatColumnState:{name:"FormatColumnState",kind:"I",desc:"Adaptable State Section for Format Column Module",props:[{name:"FormatColumns",kind:"a",desc:"Collection of Format Columns",isOpt:!0}]},FormatColumnTarget:{name:"FormatColumnTarget",kind:"A",desc:"Specifies whether Column's cells or header is formatted"},FormContext:{name:"FormContext",kind:"I",desc:"Context supplied to Buttons that appear in an Adaptable Form",props:[{name:"formData",kind:"R",desc:"Adaptable Form Data",ref:"AdaptableFormData"}]},FreeTextColumn:{name:"FreeTextColumn",kind:"I",desc:"The FreeTextColumn object used in the Free Text Column function",props:[{name:"ColumnId",kind:"s",desc:"Id of Column"},{name:"DefaultValue",kind:"u",desc:"Initial value to use for each cell in the Column",isOpt:!0},{name:"FreeTextColumnSettings",kind:"R",desc:"Additional optional properties for Column (e.g. filterable, resizable)",ref:"FreeTextColumnSettings"},{name:"FreeTextStoredValues",kind:"a",desc:"Collection of Stored Values to aplly in the Column",isOpt:!0},{name:"FriendlyName",kind:"s",desc:"Friendly Name to use to refer to Column; if unset `ColumnId` is used",isOpt:!0},{name:"TextEditor",kind:"'Inline' | 'Large'",desc:"Cell editor to use when editing a string Free Text Column",isOpt:!0,defVal:"'Inline'"}]},FreeTextColumnSettings:{name:"FreeTextColumnSettings",kind:"I",desc:"Set of optional properties that define a FreeText Columns behaviour"},FreeTextColumnState:{name:"FreeTextColumnState",kind:"I",desc:"Adaptable State Section for the Free Text Column Module",props:[{name:"FreeTextColumns",kind:"a",desc:"Collection of Free Text Columns",isOpt:!0}]},FreeTextStoredValue:{name:"FreeTextStoredValue",kind:"I",desc:"Defines a cell value stored in a Free Text Column",props:[{name:"FreeText",kind:"u",desc:"Value to store in the cell"},{name:"PrimaryKey",kind:"u",desc:"Primary Key Column value for the row"}]},GetDetailRowsContext:{name:"GetDetailRowsContext",kind:"I",desc:"Context provided to `ExportOptions.getDetailRows()` callback used when exporting Detail Rows",props:[{name:"adaptableColumn",kind:"u",desc:"Column of Master Row Node"},{name:"createCellCsv",kind:"u",desc:"Factory function to create a CSV Cell"},{name:"createCellExcel",kind:"u",desc:"Factory function to create an Excel Cell"},{name:"createCellHeader",kind:"u",desc:"Factory function to create an Header Cell (either CSV or Excel)"},{name:"isExpanded",kind:"b",desc:"Whether the Master Row Node is expanded"},{name:"masterRowData",kind:"u",desc:"Data of Master Row Node"},{name:"masterRowNode",kind:"u",desc:"Master Row Node"}]},GetPrimaryKeyValueContext:{name:"GetPrimaryKeyValueContext",kind:"I",desc:"Context passed to the `getPrimaryKeyValue` function",props:[{name:"rowData",kind:"u",desc:"Data being imported"}]},GlobalExpressionFunctionsContext:{name:"GlobalExpressionFunctionsContext",kind:"I",desc:"Context provided to global expression functions properties property callback",props:[{name:"availableExpressionFunctionNames",kind:"u",desc:"The names of all expression functions available in this context"}]},GradientStyle:{name:"GradientStyle",kind:"I",desc:"Used to display Gradient Styles in Special Column Style"},GridCell:{name:"GridCell",kind:"I",desc:"Defines a Cell in Adaptable - every cell is an intersection of a Column Id and a Primary Key Value",props:[{name:"column",kind:"u",desc:"Column in which Cell is situated"},{name:"displayValue",kind:"u",desc:"Display value of Cell (e.g. if formatted)"},{name:"isPivotCell",kind:"b",desc:"Is Cell in a Pivot Column"},{name:"isRowGroupCell",kind:"b",desc:"Is Cell in a Row Group Column"},{name:"normalisedValue",kind:"u",desc:"Normalised value of Cell"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key column's value in row - how Adaptable locates the Cell",isOpt:!0},{name:"rawValue",kind:"u",desc:"Raw value of Cell"},{name:"rowNode",kind:"u",desc:"AG Grid Row Node that holds the Cell"},{name:"visible",kind:"b",desc:"Is Cell in a currently filtered Row",isOpt:!0}]},GridCellRange:{name:"GridCellRange",kind:"I",desc:"Defines a range of Cell - used in Grid Api Selection methods Typically use either PrimaryKey Values or Row Indexes",props:[{name:"columnIds",kind:"a",desc:"Columns to select"},{name:"primaryKeyValueEnd",kind:"u",desc:"Primary Key value of row at end of range",isOpt:!0},{name:"primaryKeyValueStart",kind:"u",desc:"Primary Key value of row at start of range",isOpt:!0},{name:"rowIndexEnd",kind:"u",desc:"Index of row at end of range",isOpt:!0},{name:"rowIndexStart",kind:"u",desc:"Index of row at start of range",isOpt:!0}]},GridCellWithCount:{name:"GridCellWithCount",kind:"I",desc:"Extended GridCell, props to show how often appears in data source and how often visible",props:[{name:"count",kind:"n",desc:"How many times Cell appears in Data Source"},{name:"visibleCount",kind:"n",desc:"How many times Cell appears in Visible Rows",isOpt:!0}]},GridDataContextMapping:{name:"GridDataContextMapping",kind:"I",desc:"Mapping of FDC3 Context Types to Grid Data/Columns"},GridFilter:{name:"GridFilter",kind:"I",desc:"Defines a Grid Filter (essentially a Boolean Expression)",props:[{name:"Expression",kind:"s",desc:"The (boolean) Expression to run",isOpt:!0}]},GridFilterEditors:{name:"GridFilterEditors",kind:"A",desc:"List of Editors that can be used when creating the Grid Filter"},GridFilterOptions:{name:"GridFilterOptions",kind:"I",desc:"Options for managing the Grid Filter in AdapTable",props:[{name:"availableFilterEditors",kind:"R",desc:"Which UI Components can be used to edit a Grid Filter: Expression Editor, Query Builder (or both)",isOpt:!0,defVal:"['ExpressionEditor', 'QueryBuilder']",ref:"GridFilterEditors"}]},GridRow:{name:"GridRow",kind:"I",desc:"Detailed information about a Row in AdapTable",props:[{name:"primaryKeyValue",kind:"u",desc:"Primary Key column's value for Row - how Adaptable locates a cell"},{name:"rowData",kind:"u",desc:"Actual data in the Row",isOpt:!0},{name:"rowInfo",kind:"R",desc:"Object which provides 'meta data' about the Row",isOpt:!0,ref:"RowInfo"},{name:"rowNode",kind:"u",desc:"AG Grid Row Node object for the Row",isOpt:!0}]},GroupKeys:{name:"GroupKeys",kind:"I",desc:"Enables setting Row Group behaviour with exceptions",props:[{name:"ExceptionGroupKeys",kind:"u",desc:"Exceptions to default behaviour, provided as array or arrays",isOpt:!0},{name:"RowGroupedColumns",kind:"a",desc:"Columns that are Row Grouped"}]},HandleFdc3Context:{name:"HandleFdc3Context",kind:"I",desc:"Context used when handling incoming FDC3 messages",props:[{name:"context",kind:"R",desc:"The FDC3 Context",ref:"unknown"},{name:"metadata",kind:"R",desc:"The FDC3 Context Metadata related to the context",isOpt:!0,ref:"unknown"}]},HandleFdc3IntentContext:{name:"HandleFdc3IntentContext",kind:"I",desc:"Context used when handling incoming FDC3 Intents",props:[{name:"intent",kind:"R",desc:"The FDC3 Intent",ref:"unknown"}]},HandleFdc3IntentResolutionContext:{name:"HandleFdc3IntentResolutionContext",kind:"I",desc:"Context provided in `handleIntentResolution` callback",props:[{name:"intentResolution",kind:"R",desc:"The FDC3 Intent Resolution",ref:"unknown"}]},HandleImportedDataContext:{name:"HandleImportedDataContext",kind:"I",desc:"Context used when importing Data",props:[{name:"data",kind:"u",desc:"Data which has been imported"}]},HandleImportedDataResolution:{name:"HandleImportedDataResolution",kind:"I",desc:"Resolution returned by the `handleImportedData` function",props:[{name:"addedRows",kind:"a",desc:"Rows that were added"},{name:"emitDataImportedEvent",kind:"b",desc:"Whether to emit the `DataImported` event"},{name:"updatedRows",kind:"a",desc:"Rows that were updated"}]},IAdaptableNoCodeWizard:{name:"IAdaptableNoCodeWizard",kind:"I",desc:"When you want to configure an Adaptable via json file D&D, use this instead of the normal Adaptable constructor"},InFilterValue:{name:"InFilterValue",kind:"I",desc:"Item in the IN Column Filter",props:[{name:"label",kind:"s",desc:"Item's label"},{name:"tooltip",kind:"boolean | string",desc:"Tooltip for Item (if true, the label is used as tooltip)",isOpt:!0},{name:"value",kind:"u",desc:"The value of Item being shown"}]},InFilterValueInfo:{name:"InFilterValueInfo",kind:"I",desc:"Information about items in the IN Column Filter",props:[{name:"count",kind:"n",desc:"How many times Item appears in the column",isOpt:!0},{name:"isSelected",kind:"b",desc:"Whether Item is currently selected",isOpt:!0},{name:"leafChildrenCount",kind:"n",desc:"For the grouping scenario, how many leafs are there under this item",isOpt:!0},{name:"visible",kind:"b",desc:"Whether Item is currently visible in Grid (i.e. in filtered rows)",isOpt:!0},{name:"visibleCount",kind:"n",desc:"How many times Item appears in the column in filtered rows",isOpt:!0}]},InFilterValueResult:{name:"InFilterValueResult",kind:"I",desc:"Result when providing custom values for the IN Column Filter",props:[{name:"skipDefaultSearch",kind:"b",desc:"If true, AdapTable will not filter the list using the current search value",isOpt:!0},{name:"values",kind:"a",desc:"List of Items to display in the IN Column Filter"}]},InitialState:{name:"InitialState",kind:"I",desc:"The initial state of Adaptable which is populated at design-time and used to create the Adaptable State - must include at least one Layout.",props:[{name:"Alert",kind:"R",desc:"Collection of `AlertDefinitions` which will fire Alerts when the rule is met",isOpt:!0,ref:"AlertState"},{name:"Application",kind:"R",desc:"Empty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.",isOpt:!0,ref:"ApplicationState"},{name:"CalculatedColumn",kind:"R",desc:"Collection of *CalculatedColumn* objects that will display a value based on other cells in the row (using a Calculated Column Expression)",isOpt:!0,ref:"CalculatedColumnState"},{name:"Charting",kind:"R",desc:"Named Charts (wrapping Chart models)",isOpt:!0,ref:"ChartingState"},{name:"CustomSort",kind:"R",desc:"Collection of *Custom Sort* objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways",isOpt:!0,ref:"CustomSortState"},{name:"Dashboard",kind:"R",desc:"Large series of properties to give users full control over the look and feel of the *Dashboard* - the section above the grid with toolbars and buttons",isOpt:!0,ref:"DashboardState"},{name:"Export",kind:"R",desc:"Collection of *Report* objects, together with name of the Current Report, as part of AdapTable export Module",isOpt:!0,ref:"ExportState"},{name:"FlashingCell",kind:"R",desc:"Definitions of which cells flash in response to data changes",isOpt:!0,ref:"FlashingCellState"},{name:"FormatColumn",kind:"R",desc:"Collection of *FormatColumn* objects that will style an entire column either fully or using a Condition",isOpt:!0,ref:"FormatColumnState"},{name:"FreeTextColumn",kind:"R",desc:"Collection of *FreeText* objects so users can make their own notes in bespoke columns that will get stored with their state (and not with the DataSource). Useful if needing a 'Comments' column.",isOpt:!0,ref:"FreeTextColumnState"},{name:"Layout",kind:"R",desc:"Collection of *Layouts* to name (and manage) sets of column visibility, order, grouping, sorts, aggregations, filters etc.",ref:"LayoutState"},{name:"NamedQuery",kind:"R",desc:"Named Queries available for use across multiple AdapTable Modules; and `CurrentQuery` - an Expression to run at start-up",isOpt:!0,ref:"NamedQueryState"},{name:"Note",kind:"R",desc:"Collection of personal Notes that are edited at Cell level",isOpt:!0,ref:"NoteState"},{name:"PlusMinus",kind:"R",desc:"Collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell",isOpt:!0,ref:"PlusMinusState"},{name:"QuickSearch",kind:"R",desc:"Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows",isOpt:!0,ref:"QuickSearchState"},{name:"Schedule",kind:"R",desc:"Collection of *Schedule* objects",isOpt:!0,ref:"ScheduleState"},{name:"Shortcut",kind:"R",desc:"Collection of *Shortcut* objects to aid data entry and prevent 'fat finger' issues",isOpt:!0,ref:"ShortcutState"},{name:"StatusBar",kind:"R",desc:"Configures the Adaptable Status Bar",isOpt:!0,ref:"StatusBarState"},{name:"StyledColumn",kind:"R",desc:"Collection of Special Column Styles",isOpt:!0,ref:"StyledColumnState"},{name:"Theme",kind:"R",desc:"Specifies current Theme and lists User and System themes available for selection",isOpt:!0,ref:"ThemeState"},{name:"ToolPanel",kind:"R",desc:"Sets order & visibility of Tool Panel controls in AdapTable ToolPanel (on right of grid)",isOpt:!0,ref:"ToolPanelState"}]},InteropioPluginOptions:{name:"InteropioPluginOptions",kind:"I",desc:"Options for using the Interop plugin",props:[{name:"showAdaptableAlertsAsNotifications",kind:"b",desc:"Converts AdapTable Alerts configured to display in popup as Interop Notifications",isOpt:!0,defVal:"true"}]},IPushPullDomain:{name:"IPushPullDomain",kind:"I",desc:"Internal object that maps an IPushPull Domain object",props:[{name:"FolderId",kind:"n",desc:"the Id of the Folder"},{name:"Name",kind:"s",desc:"the Name of the Domain / Folder"},{name:"Pages",kind:"a",desc:"The names of the pages within the (Folder)"}]},IPushPullPluginOptions:{name:"IPushPullPluginOptions",kind:"I",desc:"Options available in ipushpull plugin; allows users to collborate and share data in powerful ways",props:[{name:"autoLogin",kind:"b",desc:"Whether AdapTable should try log in to ipushpull automatically at start-up",isOpt:!0,defVal:"false"},{name:"includeSystemReports",kind:"b",desc:"Whether AdapTable will include System Reports (e.g. 'All Data', 'Selected Cells' etc) in the ipushpull toolbar dropdown",isOpt:!0,defVal:"true"},{name:"ippConfig",kind:"u",desc:"The config required to run ipushpull; use your ipushpull credentials",isOpt:!0},{name:"password",kind:"s",desc:"The user's ipushpull password; if supplied, pre-populates the login screen's password textbox",isOpt:!0},{name:"throttleTime",kind:"n",desc:"How many miliseconds AdapTable should throttle when sending data updates to ipushpull",isOpt:!0,defVal:"2000"},{name:"username",kind:"s",desc:"User's ipushpull user name (usually email address); if supplied, pre-populates the login screen's username textbox",isOpt:!0}]},IPushPullReport:{name:"IPushPullReport",kind:"I",desc:"An ipushpull report",props:[{name:"Folder",kind:"s",desc:"ipushpull Folder which contains the Page"},{name:"Page",kind:"s",desc:"ipushpull Page which will contain the data"},{name:"ReportName",kind:"s",desc:"Name of the Report"}]},IPushPullSchedule:{name:"IPushPullSchedule",kind:"I",desc:"Defines an ipushpull Schedule",props:[{name:"IPushPullReport",kind:"R",desc:"The report being exported to Excel (via ipushpull)",ref:"IPushPullReport"},{name:"Transmission",kind:"'Snapshot' | 'Live Data'",desc:"How data is sent: 'Snapshot' or 'Live Data'"}]},IPushPullState:{name:"IPushPullState",kind:"I",desc:"Internal State used by AdapTable for managing the ipushpull plugin"},IsRowFilterableContext:{name:"IsRowFilterableContext",kind:"I",desc:"Context used for setting whether a Row can be Column Filtered",props:[{name:"data",kind:"u",desc:"The data in the Row Node"},{name:"rowNode",kind:"R",desc:"The Row Node about to be evaluated",ref:"unknown"}]},Layout:{name:"Layout",kind:"A",desc:"Base Layout Type - Pivot or Table"},LayoutArray:{name:"LayoutArray",kind:"A",desc:"Array of Layouts - must contain at least one item"},LayoutBase:{name:"LayoutBase",kind:"I",desc:"Base object for both Table and Pivot Layouts",props:[{name:"AutoSizeColumns",kind:"b",desc:"Whether Columns should autosize when Layout first loads",isOpt:!0},{name:"ColumnFilters",kind:"a",desc:"Collection of Column Filters to apply in Layout",isOpt:!0},{name:"ColumnGroupValues",kind:"R",desc:"Defines which Column Groups are expanded / collapsed",isOpt:!0,ref:"ColumnGroupValues"},{name:"ColumnHeaders",kind:"R",desc:"Set of custom header names for some (or all) Columns",isOpt:!0,ref:"ColumnStringMap"},{name:"ColumnPinning",kind:"R",desc:"Details of which Columns are pinned",isOpt:!0,ref:"ColumnDirectionMap"},{name:"ColumnSizing",kind:"R",desc:"Controls size (width or flex & min/max) for Columns",isOpt:!0,ref:"ColumnSizingMap"},{name:"ColumnSorts",kind:"a",desc:"Sorting to apply in the Layout",isOpt:!0},{name:"GrandTotalRow",kind:"'top' | 'bottom' | 'pinnedTop' | 'pinnedBottom' | boolean",desc:"Position of the Grand Total Row in the Layout",isOpt:!0},{name:"GridFilter",kind:"R",desc:"Grid Filter to apply in Layout",isOpt:!0,ref:"GridFilter"},{name:"Name",kind:"s",desc:"Name of Layout as will appear in Layout toolbar and tool panel"},{name:"RowGroupDisplayType",kind:"'single' | 'multi'",desc:"Display Row Grouped Columns as 'single' or 'multi' column",isOpt:!0},{name:"RowGroupValues",kind:"R",desc:"Defines which Row Groups are expanded / collapsed",isOpt:!0,ref:"RowGroupValues"},{name:"SuppressAggFuncInHeader",kind:"b",desc:"Hides the aggFunc in Column header: e.g. 'sum(Price)' becomes 'Price'",isOpt:!0}]},LayoutCreationDefaultProperties:{name:"LayoutCreationDefaultProperties",kind:"I",desc:"Default properties to apply when creating a new Layout (Table or Pivot)",props:[{name:"pivotLayout",kind:"R",desc:"Default properties to apply when creating a new Pivot Layout",isOpt:!0,ref:"PivotLayoutCreationDefaultProperties"},{name:"tableLayout",kind:"R",desc:"Default properties to apply when creating a new Table Layout",isOpt:!0,ref:"TableLayoutCreationDefaultProperties"}]},LayoutCreationDefaultPropertiesContext:{name:"LayoutCreationDefaultPropertiesContext",kind:"I",desc:"Context for `LayoutOptions.layoutCreationDefaultProperties` function",props:[{name:"layoutType",kind:"'table' | 'pivot'",desc:"Type of Layout ('table' | 'pivot')"}]},LayoutExtendedConfig:{name:"LayoutExtendedConfig",kind:"I",desc:"Configuration for API methods which load objects that can be Layout extensions"},LayoutExtendedContext:{name:"LayoutExtendedContext",kind:"I",desc:"Context for `LayoutOptions.isObjectExtendedInLayout` function",props:[{name:"adaptableObject",kind:"R",desc:"Object being checked",ref:"LayoutExtensionObject"},{name:"layout",kind:"R",desc:"Current Layout",ref:"Layout"},{name:"module",kind:"R",desc:"Current Adaptable Module",ref:"LayoutExtensionModule"}]},LayoutExtension:{name:"LayoutExtension",kind:"I",desc:"Defines an object being extended in a Layout",props:[{name:"Module",kind:"R",desc:"Module to which Extended Object belongs",ref:"LayoutExtensionModule"},{name:"Object",kind:"R",desc:"Object being Extended",ref:"LayoutExtensionObject"}]},LayoutExtensionModule:{name:"LayoutExtensionModule",kind:"A",desc:"Modules which can provide objects in Extended Layouts"},LayoutExtensionObject:{name:"LayoutExtensionObject",kind:"A",desc:"Types of Adaptable Objects that can added to Extended Layouts"},LayoutOptions:{name:"LayoutOptions",kind:"I",desc:"Options for configuring Layouts; manage Column visibility, order, sorting, grouping, width etc.",props:[{name:"layoutCreationDefaultProperties",kind:"u",desc:"Default properties to apply when creating a new Layout (Table or Pivot)",isOpt:!0},{name:"layoutTagOptions",kind:"R",desc:"Set of options for leveraging Object Tags to extend Layouts",isOpt:!0,ref:"LayoutTagOptions"},{name:"layoutViewOptions",kind:"R",desc:"Set of options for how Layouts are displayed in Settings Panel",isOpt:!0,ref:"LayoutViewOptions"},{name:"pivotPreviewColumns",kind:"u",desc:"Columns to display in Table that opens when viewing Pivot Cell contents",isOpt:!0}]},LayoutState:{name:"LayoutState",kind:"I",desc:"Adaptable State Section for Layout Module, containing collection of Layouts and name of Current Layout",props:[{name:"CurrentLayout",kind:"s",desc:"Layout to be loaded when AdapTable starts (using `Name` property in Layout); if not provided the first Layout is used",isOpt:!0},{name:"Layouts",kind:"R",desc:"Collection of Layouts - can be Table or Pivot",ref:"LayoutArray"}]},LayoutTagOptions:{name:"LayoutTagOptions",kind:"I",desc:"Options for managing Tags in Layouts (used to enhance Layouts)",props:[{name:"autoCheckTagsForLayouts",kind:"b",desc:"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)",isOpt:!0,defVal:"false"},{name:"autoGenerateTagsForLayouts",kind:"u",desc:"Automatically generate an AdaptableObjectTag for each Layout",isOpt:!0,defVal:"false"},{name:"isObjectExtendedInLayout",kind:"f",desc:"Checks if provided Adaptable Object is extended in given Layout",isOpt:!0}]},LayoutViewOptions:{name:"LayoutViewOptions",kind:"I",desc:"Customize how Layouts are displayed in Settings Panel",props:[{name:"maxColumnsToDisplay",kind:"n",desc:"How many Column Names to display in inline Layout preview",isOpt:!0,defVal:"10"}]},LoadingScreenOptions:{name:"LoadingScreenOptions",kind:"I",desc:"Options for the Loading Screen shown when AdapTable is initialising",props:[{name:"loadingScreenDelay",kind:"n",desc:"Delay in ms before Loading Screen appears (`showLoadingScreen` must be true)",isOpt:!0,defVal:"200"},{name:"loadingScreenText",kind:"s",desc:"Text to display in Loading Screen.",isOpt:!0,defVal:"'Retrieving your settings and setting up Grid...'"},{name:"loadingScreenTitle",kind:"s",desc:"Title to display in Loading Screen.",isOpt:!0,defVal:"'Initialising Grid'"},{name:"showLoadingScreen",kind:"b",desc:"Display Loading message when AdapTable initialises",isOpt:!0,noCode:"item",defVal:"true"}]},MasterDetailPluginOptions:{name:"MasterDetailPluginOptions",kind:"I",desc:"Plugin Options used when creating a Master / Detail grid - passed into the plugin as the only argument.",props:[{name:"detailAdaptableOptions",kind:"R",desc:"`AdaptableOptions` used in Detail Grids; all share same behaviour & State",ref:"AdaptableOptions"},{name:"onDetailInit",kind:"f",desc:"Function called when a Detail Grid is initialised, receives context including Adaptable Api",isOpt:!0}]},MenuCategory:{name:"MenuCategory",kind:"A",desc:"Defines the Category of for a Menu Item"},MenuSeparator:{name:"MenuSeparator",kind:"A",desc:"A separator to add to Column or Context Menu"},ModuleExpressionFunctions:{name:"ModuleExpressionFunctions",kind:"I",desc:"Type specific Expression Functions",props:[{name:"customBooleanFunctions",kind:"u",desc:"Custom Boolean Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (none)"},{name:"customScalarFunctions",kind:"u",desc:"Custom Scalar Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (none)"},{name:"systemAggregatedBooleanFunctions",kind:"u",desc:"System AggregatedBoolean Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"},{name:"systemAggregatedScalarFunctions",kind:"u",desc:"System AggregatedScalar Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"},{name:"systemBooleanFunctions",kind:"u",desc:"System Boolean Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"},{name:"systemObservableFunctions",kind:"u",desc:"System Observable Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"},{name:"systemScalarFunctions",kind:"u",desc:"System Scalar Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (sets all)"}]},ModuleExpressionFunctionsContext:{name:"ModuleExpressionFunctionsContext",kind:"I",desc:"Context provided to moduleExpressionFunctions property callback",props:[{name:"availableAggregatedBooleanFunctionNames",kind:"a",desc:"The global aggregated boolean expression functions"},{name:"availableAggregatedScalarFunctionNames",kind:"a",desc:"The global aggregated scalar expression functions"},{name:"availableBooleanFunctionNames",kind:"a",desc:"The global boolean expression functions"},{name:"availableObservableFunctionNames",kind:"a",desc:"The global observable expression functions"},{name:"availableScalarFunctionNames",kind:"a",desc:"The global scalar expression functions"},{name:"module",kind:"R",desc:"The Adaptable Module requesting the expression functions",ref:"AdaptableModule"}]},ModuleExpressionFunctionsMap:{name:"ModuleExpressionFunctionsMap",kind:"A",desc:"Module specific Expression Functions"},NamedQuery:{name:"NamedQuery",kind:"I",desc:"Defines a Query which can be referenced in AdaptableQL Expressions",props:[{name:"Name",kind:"s",desc:"Name of the Query - how it will appear in the Expression"}]},NamedQueryState:{name:"NamedQueryState",kind:"I",desc:"Adaptable State Section for Named Query Module",props:[{name:"NamedQueries",kind:"a",desc:"Named Queries which can be referenced in other Expressions",isOpt:!0}]},NotableCellContext:{name:"NotableCellContext",kind:"I",desc:"Context used when determining if a Note can be added to a Cell",props:[{name:"gridCell",kind:"R",desc:"Grid Cell in AdapTable which has been clicked",ref:"GridCell"}]},NoteOptions:{name:"NoteOptions",kind:"I",desc:"Options for managing AdapTable Notes",props:[{name:"dateFormat",kind:"u",desc:"Date Format string for Notes timestamp",isOpt:!0,defVal:"'dd-MM-yyyy HH:mm:ss'"},{name:"isCellNotable",kind:"f",desc:"Whether a cell can contain Notes",isOpt:!0},{name:"showPopupCloseButton",kind:"b",desc:"Show the Close Button in the Notes Popup",isOpt:!0,defVal:"true"}]},NoteState:{name:"NoteState",kind:"I",desc:"Adaptable State Section for Note Module",props:[{name:"Notes",kind:"R",desc:"Collection of AdapTable Notes",isOpt:!0,ref:"AdaptableNotes"}]},NotificationsOptions:{name:"NotificationsOptions",kind:"I",desc:"Options related to System Status Messages and Notifications in Adaptable.",props:[{name:"closeWhenClicked",kind:"b",desc:"Closes Notification automatically when its clicked",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"duration",kind:"number | 'always'",desc:"How long (in ms) Notifications display for",isOpt:!0,gridInfo:"item",defVal:"3000"},{name:"isDraggable",kind:"b",desc:"Can Notification be dragged",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"maxNotifications",kind:"n",desc:"How many Notifications can be displayed at one time",isOpt:!0,gridInfo:"item",defVal:"3"},{name:"maxSystemMessagesInStore",kind:"n",desc:"How many System Status Messages to hold in State; when limit is reached, oldest Message is removed",isOpt:!0,gridInfo:"item",defVal:"100"},{name:"pauseWhenHovering",kind:"b",desc:"Pauses the Notification when mouse hovers over it",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"position",kind:"R",desc:"Where Notification will appear (if anywhere)",isOpt:!0,gridInfo:"item",defVal:"'BottomRight'",ref:"ToastPositions"},{name:"showApplicationIcon",kind:"b",desc:"Displays the application icon in Notifications",isOpt:!0,defVal:"false"},{name:"showProgressBar",kind:"b",desc:"Shows a Progress Bar in the Notification",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"showSystemStatusMessageNotifications",kind:"b",desc:"Display System Status Messages as Notifications",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"transition",kind:"'Bounce' | 'Slide' | 'Zoom' | 'Flip'",desc:"How Notification will appear: Bounce, Slide, Zoom or Flip",isOpt:!0,gridInfo:"item",defVal:"'Slide'"}]},NumberFormatterOptions:{name:"NumberFormatterOptions",kind:"I",desc:"Formatter Options for Numeric Columns",props:[{name:"Abs",kind:"b",desc:"Returns absolute value of cell value",isOpt:!0},{name:"Ceiling",kind:"b",desc:"Returns smallest integer greater than cell value",isOpt:!0},{name:"Content",kind:"string | number",desc:"Replaces cell value with supplied value (that can contain Template Literals)",isOpt:!0},{name:"Empty",kind:"b",desc:"Show nothing in cell (but underlying value remains)",isOpt:!0},{name:"Floor",kind:"b",desc:"Returns largest integer cell value",isOpt:!0},{name:"FractionDigits",kind:"n",desc:"Number of digits to show in Fractions (up to 20)",isOpt:!0},{name:"FractionSeparator",kind:"s",desc:"Separator to use in fractions",isOpt:!0},{name:"IntegerDigits",kind:"n",desc:"Number of digits to show for Integers (up to 20)",isOpt:!0},{name:"IntegerSeparator",kind:"s",desc:"Separator to use in Integers",isOpt:!0},{name:"Multiplier",kind:"n",desc:"Multiplier to use on cell value",isOpt:!0},{name:"Parentheses",kind:"b",desc:"Shows negative numbers in parentheses",isOpt:!0},{name:"Prefix",kind:"s",desc:"Prefix to use before cell value",isOpt:!0},{name:"Round",kind:"b",desc:"Rounds cell value",isOpt:!0},{name:"Suffix",kind:"s",desc:"Suffix to use after cell value",isOpt:!0},{name:"Truncate",kind:"b",desc:"Truncates cell value",isOpt:!0}]},NumericStyledColumn:{name:"NumericStyledColumn",kind:"I",desc:"Base type for Numeric Styled Columns (i.e. Gradient and Percent Bar)",props:[{name:"CellRanges",kind:"a",desc:"Ranges (e.g. to create traffic light effect)",isOpt:!0},{name:"ColumnComparison",kind:"R",desc:"Compares Cell values to another Column",isOpt:!0,ref:"ColumnComparison"},{name:"RangeValueType",kind:"R",desc:"Used with Ranges; can be Number (any number or Col-Min/Col-Max) or 'Percentage' (values 0-100)",isOpt:!0,defVal:"Number",ref:"RangeValueType"}]},ObjectTagsContext:{name:"ObjectTagsContext",kind:"I",desc:"Context used when evaluating Object Tags"},OpenFinPluginOptions:{name:"OpenFinPluginOptions",kind:"I",desc:"Options required for when using the OpenFin plugin",props:[{name:"notificationTimeout",kind:"number | false",desc:"Timeout (in ms) for OpenFin Notifications to expire; set false for notifications not to auto-dismiss",isOpt:!0,defVal:"5000"},{name:"onNotificationAction",kind:"u",desc:"Function which is invoked when a button in OpenFin notification is clicked",isOpt:!0},{name:"onShowNotification",kind:"f",desc:"Updates OpenFin Notification object before it's displayed (just add/remove properties); return false to stop Notification showing",isOpt:!0},{name:"onValidationFailureInExcel",kind:"'override' | 'show-notification' | 'show-undo-notification'",desc:"Action to perform when a data change in Live Excel report triggers Prevent Edit Alert failure",isOpt:!0},{name:"showAdaptableAlertsAsNotifications",kind:"b",desc:"Converts AdapTable Alerts configured to display in popup as OpenFin Notifications",isOpt:!0,defVal:"true"},{name:"showAppIconInNotifications",kind:"u",desc:"Icon to show in Notification - uses the value supplied in UserInterfaceOptions",isOpt:!0,defVal:"true"},{name:"throttleTime",kind:"n",desc:"How long (in ms) AdapTable throttles when sending data update to OpenFin",isOpt:!0,defVal:"2000"}]},OpenFinReport:{name:"OpenFinReport",kind:"I",desc:"An OpenFin report",props:[{name:"ReportName",kind:"s",desc:"Name of Report (which will exist in the Export State)"}]},OpenFinSchedule:{name:"OpenFinSchedule",kind:"I",desc:"Defines a OpenFin Schedule - used in Schedule Module",props:[{name:"OpenFinReport",kind:"R",desc:"Report being exported to Excel (via OpenFin)",ref:"OpenFinReport"},{name:"Transmission",kind:"u",desc:"Whether Snapshot or Live Data (currently only the latter is supported)"}]},OpenFinState:{name:"OpenFinState",kind:"I",desc:"Internal State used by AdapTable for managing the OpenFin plugin"},PercentBarStyle:{name:"PercentBarStyle",kind:"I",desc:"Style used to display Percent Bars in Special Column Style",props:[{name:"BackColor",kind:"s",desc:"Background colour for 'Percent Bar'; leave unset if none required",isOpt:!0,defVal:"undefined"},{name:"CellText",kind:"R",desc:"Whether Cell shows Cell Value, Percent Value, both or none",isOpt:!0,ref:"CellTextOptions"},{name:"CellTextPosition",kind:"'Above' | 'Below' | 'Merged'",desc:"Position of text in Cell relative to Percent Bar, "Above", "Below" or "Merged"",isOpt:!0,defVal:"Below"},{name:"ToolTipText",kind:"R",desc:"Whether Tooltip shows Cell Value, Percent Value, both or none",isOpt:!0,ref:"CellTextOptions"}]},PivotAggregationColumns:{name:"PivotAggregationColumns",kind:"A",desc:"Defines an Aggregated Column in a Pivot Layout"},PivotAggregationTotalHeaderContext:{name:"PivotAggregationTotalHeaderContext",kind:"I",desc:"Context for Pivot Aggregation Totals",props:[{name:"aggregatedColumnId",kind:"s",desc:"Id of Aggregated Column"},{name:"aggregation",kind:"s",desc:"Aggregation function of Column"},{name:"columnType",kind:"u",desc:"Pivot Aggregation Total Column"},{name:"pivotColumnId",kind:"s",desc:"Id of Pivot Column"},{name:"pivotKey",kind:"s",desc:"Key (i.e. column value) of Pivot Column"}]},PivotColumnGroupHeaderContext:{name:"PivotColumnGroupHeaderContext",kind:"I",desc:"Context for Pivot Column Groups",props:[{name:"columnType",kind:"u",desc:"Pivot Column Group (created for each distinct value in a PivotColumn)"},{name:"groupId",kind:"s",desc:"Id of generated Column Group"},{name:"pivotKeys",kind:"a",desc:"Pivot Keys for Column Group"},{name:"state",kind:"'expanded' | 'collapsed'",desc:"Expanded / Collapsed state of Column Group"}]},PivotColumnTotalHeaderContext:{name:"PivotColumnTotalHeaderContext",kind:"I",desc:"Context for Pivot Total Columns",props:[{name:"aggregation",kind:"s",desc:"Aggregation function of Column"},{name:"columnType",kind:"u",desc:"Pivot Column Total"},{name:"pivotColumnId",kind:"s",desc:"Id of Pivot Column"},{name:"pivotKey",kind:"s",desc:"Key (i.e. column value) of Pivot Column"}]},PivotGrandTotalHeaderContext:{name:"PivotGrandTotalHeaderContext",kind:"I",desc:"Context for Pivot Grand Total Columns",props:[{name:"aggregatedColumnId",kind:"s",desc:"Id of Pivot Aggregated Column"},{name:"aggregation",kind:"s",desc:"Aggregation function of Column"},{name:"columnType",kind:"u",desc:"Pivot Grand Total Column"}]},PivotLayout:{name:"PivotLayout",kind:"I",desc:"Defines a Pivot-based Layout",props:[{name:"PivotAggregationColumns",kind:"R",desc:"Columns showing aggregated values in Group Rows; 1st value in record is Column name, 2nd is either aggfunc (e.g. sum, avg etc.) or 'true' (to use default aggfunc)",isOpt:!0,ref:"PivotAggregationColumns"},{name:"PivotColumns",kind:"a",desc:"Mandatory list of Columns to pivot (provide empty array if just displaying Aggregations)"},{name:"PivotColumnTotal",kind:"R",desc:"Display automatically calculated Totals within EACH Pivot Column Group, in the position specified",isOpt:!0,ref:"PivotTotalPosition"},{name:"PivotExpandLevel",kind:"n",desc:"How deep to expand Pivot Columns (0 for none, 1 for 1st level only etc, -1 to expand all)",isOpt:!0},{name:"PivotGrandTotal",kind:"R",desc:"Display automatically calculated Totals of all Pivot Columns, in the position specified",isOpt:!0,ref:"PivotTotalPosition"},{name:"PivotGroupedColumns",kind:"a",desc:"Columns which are row-grouped when the Layout is applied",isOpt:!0},{name:"RowGroupedColumns",kind:"u",desc:"Row Grouped Columns Columns - must NOT be provided",isOpt:!0},{name:"TableAggregationColumns",kind:"u",desc:"Table Aggregation Columns - must NOT be provided",isOpt:!0},{name:"TableColumns",kind:"u",desc:"Table Columns - must NOT be provided",isOpt:!0}]},PivotLayoutCreationDefaultProperties:{name:"PivotLayoutCreationDefaultProperties",kind:"A",desc:"Default properties to apply when creating a new Pivot Layout"},PivotPreviewColumnsContext:{name:"PivotPreviewColumnsContext",kind:"I",desc:"Context uses for pivotPreviewColumns function in Layout Options",props:[{name:"columnId",kind:"s",desc:"Column being opened"},{name:"layout",kind:"R",desc:"Current Layout",ref:"Layout"}]},PivotResultColumnHeaderContext:{name:"PivotResultColumnHeaderContext",kind:"I",desc:"Context for Pivot Result Columns",props:[{name:"aggregatedColumnId",kind:"s",desc:"Id of Pivot Aggregated Column"},{name:"aggregation",kind:"s",desc:"Aggregation function of Column"},{name:"columnId",kind:"s",desc:"Id of generated Column"},{name:"columnType",kind:"u",desc:"Pivot Result Column (unique intersection of PivotAggregationColumn and PivotColumn)"},{name:"pivotKeys",kind:"a",desc:"Current Pivot Keys"}]},PivotTotalPosition:{name:"PivotTotalPosition",kind:"A",desc:"Defines the position of Pivot Total position - 'before' or 'after' the Value Column(s)"},PlusMinusNudge:{name:"PlusMinusNudge",kind:"I",desc:"Defines a Plus Minus Rule - used in the Plus Minus Module",props:[{name:"NudgeValue",kind:"n",desc:"Amount by which to update cell when Rule is applied"},{name:"Rule",kind:"R",desc:"(Optional) Boolean Expression to determine whether to apply the Nudge",isOpt:!0,ref:"AdaptableBooleanQuery"},{name:"Scope",kind:"R",desc:"Where Rule is applied",ref:"ColumnScope"}]},PlusMinusState:{name:"PlusMinusState",kind:"I",desc:"Adaptable State Section for Plus Minus Module",props:[{name:"PlusMinusNudges",kind:"a",desc:"Array of Plus Minus Nudges",isOpt:!0}]},PopupType:{name:"PopupType",kind:"A",desc:"Type of Popup"},PredefinedConfig:{name:"PredefinedConfig",kind:"I",desc:"Deprecated initial state object (now replaced by InitialState)",props:[{name:"Alert",kind:"R",desc:"Collection of `AlertDefinitions` which will fire Alerts when the rule is met",isOpt:!0,ref:"AlertState"},{name:"Application",kind:"R",desc:"Empty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.",isOpt:!0,ref:"ApplicationState"},{name:"CalculatedColumn",kind:"R",desc:"Collection of *CalculatedColumn* objects that will display a value based on other cells in the row (using a Calculated Column Expression)",isOpt:!0,ref:"CalculatedColumnState"},{name:"Charting",kind:"R",desc:"Named Charts (wrapping Chart models)",isOpt:!0,ref:"ChartingState"},{name:"CustomSort",kind:"R",desc:"Collection of *Custom Sort* objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways",isOpt:!0,ref:"CustomSortState"},{name:"Dashboard",kind:"R",desc:"Large series of properties to give users full control over the look and feel of the *Dashboard* - the section (typically above the grid) with toolbars and buttons",isOpt:!0,ref:"DashboardState"},{name:"Export",kind:"R",desc:"Collection of *Report* objects, together with name of the Current Report, as part of AdapTable export Module",isOpt:!0,ref:"ExportState"},{name:"FlashingCell",kind:"R",desc:"* Objects which define which cells flash in response to data changes",isOpt:!0,ref:"FlashingCellState"},{name:"FormatColumn",kind:"R",desc:"Collection of *FormatColumn* objects that will style an entire column either fully or using a Condition",isOpt:!0,ref:"FormatColumnState"},{name:"FreeTextColumn",kind:"R",desc:"Collection of *FreeText* objects so users can make their own notes in bespoke columns that will get stored with their state (and not with the DataSource). Useful if needing a 'Comments' column.",isOpt:!0,ref:"FreeTextColumnState"},{name:"Layout",kind:"R",desc:"Collection of *Layouts* to name (and manage) sets of column visibility, order, grouping, sorts, aggregations, filters etc.",ref:"LayoutState"},{name:"NamedQuery",kind:"R",desc:"Named Queries available for use across multiple AdapTable Modules",isOpt:!0,ref:"NamedQueryState"},{name:"Note",kind:"R",desc:"Collection of personal Notes that are edited at Cell level",isOpt:!0,ref:"NoteState"},{name:"PlusMinus",kind:"R",desc:"Collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell",isOpt:!0,ref:"PlusMinusState"},{name:"QuickSearch",kind:"R",desc:"Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows",isOpt:!0,ref:"QuickSearchState"},{name:"Schedule",kind:"R",desc:"Collection of *Schedule* objects",isOpt:!0,ref:"ScheduleState"},{name:"Shortcut",kind:"R",desc:"Collection of *Shortcut* objects to aid data entry and prevent 'fat finger' issues",isOpt:!0,ref:"ShortcutState"},{name:"StatusBar",kind:"R",desc:"Configures the Adaptable Status Bar",isOpt:!0,ref:"StatusBarState"},{name:"StyledColumn",kind:"R",desc:"Collection of Special Column Styles",isOpt:!0,ref:"StyledColumnState"},{name:"Theme",kind:"R",desc:"Specifies the current Theme and lists the User and System themes available for selection.",isOpt:!0,ref:"ThemeState"},{name:"ToolPanel",kind:"R",desc:"Sets the order and visibility of the Tool Panel controls in the AdapTable ToolPanel (on right of grid)",isOpt:!0,ref:"ToolPanelState"}]},PredicateDefHandlerContext:{name:"PredicateDefHandlerContext",kind:"I",desc:"Object passed into an Adaptable Predicate Definition",props:[{name:"column",kind:"R",desc:"AdapTable Column which contains the cell",ref:"AdaptableColumn"},{name:"displayValue",kind:"u",desc:"Display value in cell being evaluated"},{name:"groupValues",kind:"a",desc:"For grouped columns, the array with all the values starting from the root group to the current node",isOpt:!0},{name:"inputs",kind:"a",desc:"Any (optional) inputs required to perform evaluation",isOpt:!0},{name:"node",kind:"R",desc:"AG Grid Row node which contains the cell",ref:"unknown"},{name:"oldValue",kind:"u",desc:"Previous value in cell (e.g. if evaluating an edit)"},{name:"predicatesOperator",kind:"u",desc:"Logic used when combining multiple Predicates ('AND'|'OR')",isOpt:!0},{name:"rawValue",kind:"u",desc:"Raw value in cell being evaluated (as per underlying data source)"},{name:"treeSelectionState",kind:"R",desc:"Optional TreeSelectionState - used for `In` predicate, when evaluating the grouped column. If this is not provided, another valid implementation is used.",isOpt:!0,ref:"unknown"},{name:"value",kind:"u",desc:"Value in cell being evaluated (normalized as per Column DataType)"}]},PredicateDefInput:{name:"PredicateDefInput",kind:"I",desc:"Defines an Input to a Predicate"},PredicateDefToStringParams:{name:"PredicateDefToStringParams",kind:"I",desc:"Inputs required for a Predicate"},PredicateModuleScope:{name:"PredicateModuleScope",kind:"A",desc:"Defines which Modules use the Predicate"},PredicateOptions:{name:"PredicateOptions",kind:"I",desc:"Options for managing Adaptable Predicates using AdaptableQL",props:[{name:"caseSensitivePredicates",kind:"u",desc:"Perform case-sensitive text comparisons when evaluating Predicates",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"customPredicateDefs",kind:"u",desc:"Definitions for Custom provided Predicates",isOpt:!0},{name:"evaluateInPredicateUsingTime",kind:"u",desc:"Should In Predicate evaluate using datetime, rather than date (the default)",isOpt:!0,noCode:"item",defVal:"false"},{name:"systemAlertPredicates",kind:"u",desc:"Which System Predicates are available in Alert Module",isOpt:!0},{name:"systemBadgeStylePredicates",kind:"u",desc:"Which System Predicates are available for Badge Styles",isOpt:!0},{name:"systemFilterPredicates",kind:"u",desc:"Which System Predicates are available when Filtering",isOpt:!0},{name:"systemFlashingCellPredicates",kind:"u",desc:"Which System Predicates are available in Flashing Cell Module",isOpt:!0},{name:"systemFormatColumnPredicates",kind:"u",desc:"Which System Predicates are available in Format Column Module",isOpt:!0}]},PredicatesOperator:{name:"PredicatesOperator",kind:"A",desc:"Logic used to join multiple Predicates"},PreprocessRowDataContext:{name:"PreprocessRowDataContext",kind:"I",desc:"Context used when pre-processing Import Data",props:[{name:"rowData",kind:"u",desc:"Data which has been imported"}]},ProcessExportContext:{name:"ProcessExportContext",kind:"I",desc:"Context used by the processExport function",props:[{name:"convertToCsv",kind:"f",desc:"Converts the Report Data to CSV format"},{name:"convertToExcel",kind:"u",desc:"Converts the Report Data to Excel format"},{name:"getReportColumns",kind:"u",desc:"Returns Columns to export based on Report's `ReportColumnScope`"}]},ProgressIndicatorConfig:{name:"ProgressIndicatorConfig",kind:"I",desc:"Config when displaying a Progress Indicator",props:[{name:"delay",kind:"n",desc:"Length of Delay",isOpt:!0},{name:"frameworkComponent",kind:"R",desc:"A React, Angular or Vue Framework component to use",isOpt:!0,ref:"AdaptableFrameworkComponent"},{name:"render",kind:"R",desc:"Render function",isOpt:!0,ref:"CustomRenderFunction"},{name:"renderMode",kind:"'content' | 'dialog'",desc:"Determines whether custom component is rendered as "content" (inside window) or "dialog" (replacing window)",isOpt:!0},{name:"text",kind:"s",desc:"Text to display",isOpt:!0}]},QueryableColumnContext:{name:"QueryableColumnContext",kind:"I",desc:"Context passed when evaluating Queryable Columns"},QuickSearchContext:{name:"QuickSearchContext",kind:"I",desc:"Context used when applying Quick Search in bespoke fashion",props:[{name:"gridCell",kind:"R",desc:"Cell being checked",ref:"GridCell"},{name:"quickSearchValue",kind:"s",desc:"Current Quick Search Text"}]},QuickSearchOptions:{name:"QuickSearchOptions",kind:"I",desc:"Options for configuring Quick Search",props:[{name:"clearQuickSearchOnStartUp",kind:"b",desc:"Clears saved searches when AdapTable loads",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"filterGridAfterQuickSearch",kind:"b",desc:"Filters Grid after quick search so only matching rows are displayed",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"getCellSearchText",kind:"f",desc:"Allows a different value to be used for a cell when searching (instead of its raw value)",isOpt:!0},{name:"isCellSearchable",kind:"f",desc:"Determines whether Quick Search should be applied to a given cell",isOpt:!0},{name:"isQuickSearchCaseSensitive",kind:"b",desc:"Run Quick Search using Case Sensitivity",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"quickSearchPlaceholder",kind:"s",desc:"Value to use as placeholder in QuickSearch controls (e.g. in Dashboard)",isOpt:!0,gridInfo:"item",defVal:"'Search'"}]},QuickSearchState:{name:"QuickSearchState",kind:"I",desc:"Adaptable State Section for Quick Search Module",props:[{name:"CellMatchStyle",kind:"u",desc:"Style used to highlight matching cells",isOpt:!0},{name:"CurrentTextMatchStyle",kind:"u",desc:"Style used to highlight matching text within current match (not availale in SSRM)",isOpt:!0},{name:"QuickSearchText",kind:"s",desc:"Last Quick Search that was run (and will be applied at start-up)",isOpt:!0},{name:"TextMatchStyle",kind:"u",desc:"Style used to highlight matching text within a cell (not availale in SSRM)",isOpt:!0}]},RaiseIntentConfig:{name:"RaiseIntentConfig",kind:"I",desc:"Config used when raising an FDC3 Intent",props:[{name:"actionButton",kind:"R",desc:"Definition of Action Button (to be put in default FDC3 Action Column)",isOpt:!0,ref:"Fdc3AdaptableButton"},{name:"actionColumn",kind:"u",desc:"Custom FDC3 Action Column definition for the Intent",isOpt:!0},{name:"contextMenu",kind:"u",desc:"Columns to display a 'Raise Intent' Context Menu item",isOpt:!0},{name:"contextType",kind:"R",desc:"Key of Context being Raised",ref:"unknown"},{name:"handleIntentResolution",kind:"u",desc:"Handles the IntentResolution for this specific raise intent configuration",isOpt:!0}]},RaiseIntentConfiguration:{name:"RaiseIntentConfiguration",kind:"I",desc:"Defines config options for Raising FDC3 Intents"},RangeValueType:{name:"RangeValueType",kind:"A",desc:"Whether the Range is Number or Percent based"},ReactFrameworkComponent:{name:"ReactFrameworkComponent",kind:"A",desc:"A function that returns a ReactNode"},ReminderSchedule:{name:"ReminderSchedule",kind:"I",desc:"Schedules a Reminder to appear at a given point in time",props:[{name:"DisplayNotification",kind:"b",desc:"Displays Reminder as a Toast Notification"},{name:"DisplaySystemStatusMessage",kind:"b",desc:"Shows Reminder as System Status Message",isOpt:!0},{name:"Header",kind:"s",desc:"Reminder header text"},{name:"Message",kind:"s",desc:"Reminder body text"},{name:"MessageType",kind:"R",desc:"Type of Message - 'Success', 'Info', 'Warning' or 'Error'",ref:"AdaptableMessageType"}]},Report:{name:"Report",kind:"I",desc:"A Report which can export data from AdapTable",props:[{name:"Name",kind:"R",desc:"Name of Report",ref:"ReportNameType"},{name:"Query",kind:"R",desc:"Query to use; only required if `ReportRowScope` is 'ExpressionRows'",isOpt:!0,ref:"AdaptableBooleanQuery"},{name:"ReportColumnScope",kind:"R",desc:"Columns to display: `AllColumns`, `VisibleColumns`, `SelectedColumns`, `ScopeColumns`",ref:"ReportColumnScope"},{name:"ReportRowScope",kind:"R",desc:"Rows to export: `AllRows`, `VisibleRows`, `SelectedRows`, `ExpressionRows`",ref:"ReportRowScope"},{name:"Scope",kind:"R",desc:"Columns Scope; only required if `ReportColumnScope` is 'ScopeColumns'",isOpt:!0,ref:"ColumnScope"}]},ReportColumn:{name:"ReportColumn",kind:"I",desc:"A Column exported in a Report",props:[{name:"field",kind:"s",desc:"Field in the row to get cell data from; defaults to `columnId`",isOpt:!0}]},ReportColumnScope:{name:"ReportColumnScope",kind:"A",desc:"Columns to be included in a Report"},ReportContext:{name:"ReportContext",kind:"I",desc:"Report Context sent when using Custom Export Destinations",props:[{name:"reportData",kind:"R",desc:"Export Data for the Report",ref:"ExportResultData"}]},ReportData:{name:"ReportData",kind:"I",desc:"Defines the data in a Report run by AdapTable",props:[{name:"columns",kind:"a",desc:"Columns in the Report"},{name:"groupColumnIds",kind:"a",desc:"Group columns IDs in the Report",isOpt:!0},{name:"pivotColumnIds",kind:"a",desc:"Pivot columns IDs in the Report",isOpt:!0},{name:"rows",kind:"u",desc:"Row Data in the Report"}]},ReportFileNameContext:{name:"ReportFileNameContext",kind:"I",desc:"Context used for providing a custom filename for a Report",props:[{name:"fileName",kind:"s",desc:"Default File Name to use"}]},ReportFormatType:{name:"ReportFormatType",kind:"A",desc:"Type of Report Format"},ReportNameType:{name:"ReportNameType",kind:"A",desc:"Type of Report Name"},ReportRowScope:{name:"ReportRowScope",kind:"A",desc:"AG Grid Row Data to be included in a Report"},ReportSchedule:{name:"ReportSchedule",kind:"I",desc:"Defines a Scheduled Report - used in Schedule Module (where State is stored)",props:[{name:"ExportDestination",kind:"R",desc:"Destination of Report to run on Schedule",isOpt:!0,ref:"ExportDestinationType"},{name:"ReportFormat",kind:"R",desc:"Format of Report to run on Schedule",ref:"ReportFormatType"},{name:"ReportName",kind:"s",desc:"Name of Report to run on Schedule"}]},ResolveContextDataContext:{name:"ResolveContextDataContext",kind:"I",desc:"Used to build Context Data",props:[{name:"contextMappedFromGridData",kind:"R",desc:"FDC3 Context Data which has been mapped from the grid data based on the given configuration in `gridDataContextMapping`",isOpt:!0,ref:"unknown"},{name:"contextType",kind:"R",desc:"FDC3 Context Type",ref:"unknown"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key value of row"},{name:"rowData",kind:"u",desc:"Row data which is the source of the context data"},{name:"rowNode",kind:"R",desc:"Row Node which is source of the context data",ref:"unknown"}]},RowDataChangedInfo:{name:"RowDataChangedInfo",kind:"I",desc:"Info for RowDataChangedEvent, which rows changed and why",props:[{name:"changedAt",kind:"n",desc:"Timestamp of change occurrence (in milliseconds)"},{name:"dataRows",kind:"u",desc:"Data rows that have been added, updated, or deleted"},{name:"rowNodes",kind:"u",desc:"Row Nodes that were affected by this change"},{name:"rowTrigger",kind:"R",desc:"Trigger for row change: Load, Add, Update, or Delete",ref:"RowDataChangeTrigger"}]},RowDataChangeTrigger:{name:"RowDataChangeTrigger",kind:"A",desc:"What row action triggered the Row Change: 'Add', 'Update', 'Delete' or 'Load'"},RowFormColumnContext:{name:"RowFormColumnContext",kind:"I",desc:"Context used when decided if column should be included in a Row Form",props:[{name:"adaptableColumn",kind:"R",desc:"Column to be displayed",ref:"AdaptableColumn"},{name:"rowFormType",kind:"R",desc:"Type of Row Form",ref:"RowFormType"}]},RowFormContext:{name:"RowFormContext",kind:"A",desc:"Context passed into a Row Form - can be `CreateRowFormContext` or `EditRowFormContext`"},RowFormFieldContext:{name:"RowFormFieldContext",kind:"I",desc:"Context used for overriding Field elements in Row Form"},RowFormOptions:{name:"RowFormOptions",kind:"I",desc:"Options related to Dynamic Row Forms in AdapTable",props:[{name:"autoHandle",kind:"b",desc:"Whether AdapTable automatically updates AG Grid data model with created/edited/deleted rows",isOpt:!0,defVal:"true"},{name:"disableInlineEditing",kind:"b",desc:"Prevents direct editing in Grid cells even for editable columns",isOpt:!0,defVal:"false"},{name:"includeColumnInRowForm",kind:"f",desc:"Is given Column displayed in Row Form",isOpt:!0,defVal:"true"},{name:"onRowFormSubmit",kind:"u",desc:"Event fired when a Row Form is submitted via a standard button provided by AdapTable; this is not invoked when custom form buttons are provided",isOpt:!0,defVal:"undefined"},{name:"rowFormButtons",kind:"u",desc:"Custom form buttons; if provided, need to handle form submission explicitly",isOpt:!0},{name:"rowFormDescription",kind:"u",desc:"Custom form description provider",isOpt:!0,defVal:"undefined"},{name:"rowFormFieldLabel",kind:"u",desc:"Custom form field label provider",isOpt:!0,defVal:"undefined"},{name:"rowFormTitle",kind:"u",desc:"Custom form title provider",isOpt:!0,defVal:"'Create New Row'/'Edit Row'"},{name:"setPrimaryKeyValue",kind:"u",desc:"Function called when auto-handling 'create' or 'clone' Command Button; returned value should be valid for Primary Key column",isOpt:!0,defVal:"undefined"}]},RowFormTitleContext:{name:"RowFormTitleContext",kind:"I",desc:"Context used for overriding Title and Description of Row Form"},RowFormType:{name:"RowFormType",kind:"A",desc:"Type of RowForm: 'rowCreated' | 'rowEdited' | 'rowDeleted'"},RowGroupColumnHeaderContext:{name:"RowGroupColumnHeaderContext",kind:"I",desc:"Context for Columns created when Row Grouping",props:[{name:"columnId",kind:"s",desc:"Id of the Column"},{name:"columnType",kind:"u",desc:"A Row Grouped Column (created in both Table and Pivot Layout)"},{name:"groupColumnId",kind:"s",desc:"Id of Row Grouped Column"}]},RowGroupValues:{name:"RowGroupValues",kind:"A",desc:"Manages Row Group expand / collapse behaviour, including exceptions"},RowGroupValuesWithExceptionKeys:{name:"RowGroupValuesWithExceptionKeys",kind:"A",desc:"Defines which Row Groups are expanded or collapsed"},RowHighlightInfo:{name:"RowHighlightInfo",kind:"I",desc:"Define how to highlight a Row",props:[{name:"highlightStyle",kind:"R",desc:"Highlight style",ref:"AdaptableStyle"},{name:"primaryKeyValue",kind:"u",desc:"Primary key value for the row to be highlighted"},{name:"timeout",kind:"n",desc:"Timeout after which Row should be unhighlighted",isOpt:!0}]},RowInfo:{name:"RowInfo",kind:"I",desc:"Provides meta data about a Row in Adaptable",props:[{name:"isDisplayed",kind:"b",desc:"Is Row displayed (ie. filtered, not necessarily in viewport)",isOpt:!0},{name:"isExpanded",kind:"b",desc:"Is Row expanded (if a group row)",isOpt:!0},{name:"isGroup",kind:"b",desc:"Is Row grouped",isOpt:!0},{name:"isMaster",kind:"b",desc:"Is Row a Master Row (in a Master-Detail grid)",isOpt:!0},{name:"isSelected",kind:"b",desc:"Is Row selected",isOpt:!0},{name:"rowGroupLevel",kind:"n",desc:"What level the Row is (if Row Grouping is active)",isOpt:!0}]},RowScope:{name:"RowScope",kind:"I",desc:"Defines which types of Rows to exclude when rendering Format Columns, Action Columns and Badges",props:[{name:"ExcludeDataRows",kind:"b",desc:"Exclude regular data rows",isOpt:!0},{name:"ExcludeGroupRows",kind:"b",desc:"Exclude Group Rows",isOpt:!0},{name:"ExcludeSummaryRows",kind:"b",desc:"Exclude Summary Rows (used in Row Summaries)",isOpt:!0},{name:"ExcludeTotalRows",kind:"b",desc:"Exclude Grand Total Rows (used in Aggregations)",isOpt:!0}]},RowsHighlightInfo:{name:"RowsHighlightInfo",kind:"I",desc:"Defines how to highlight a set of Rows",props:[{name:"highlightStyle",kind:"R",desc:"Highlight style",ref:"AdaptableStyle"},{name:"primaryKeyValues",kind:"a",desc:"Primary key valuse for the rows to be highlighted"},{name:"timeout",kind:"n",desc:"Timeout after which the highlight is removed",isOpt:!0}]},RowSummary:{name:"RowSummary",kind:"I",desc:"Defines a Row Summary used in a Layout",props:[{name:"ColumnsMap",kind:"u",desc:"Map of Columns with Summary Expressions"},{name:"IncludeOnlyFilteredRows",kind:"b",desc:"Evaluates only currently filtered rows in the summary",isOpt:!0,defVal:"true"},{name:"Position",kind:"R",desc:"Where Row Summary appears - 'Top' or 'Bottom'",isOpt:!0,ref:"RowSummaryPosition"}]},RowSummaryPosition:{name:"RowSummaryPosition",kind:"A",desc:"Position of Row Summary - 'Top' or 'Bottom'"},SaveChartBehaviour:{name:"SaveChartBehaviour",kind:"A",desc:"How Charts are saved"},Schedule:{name:"Schedule",kind:"I",desc:"Defines when an action will be run - either one-off or recurring",props:[{name:"DaysOfWeek",kind:"R",desc:"Days on which Schedule will run",isOpt:!0,ref:"unknown"},{name:"Hour",kind:"n",desc:"Hour the Schedule will run"},{name:"Minute",kind:"n",desc:"Minute the Schedule will run"},{name:"OneOffDate",kind:"s",desc:"A one off date on which the Schedule will run",isOpt:!0}]},ScheduleState:{name:"ScheduleState",kind:"I",desc:"Adaptable State Section for the Schedule Module",props:[{name:"IPushPullSchedules",kind:"a",desc:"Schedules connected to ipushpull Reports - available if ipushpull plugin is running",isOpt:!0},{name:"OpenFinSchedules",kind:"a",desc:"Schedules connected to OpenFin exports - available if OpenFin plugin is running",isOpt:!0},{name:"Reminders",kind:"a",desc:"Schedules connected to Reminders - Alerts that fire at set times",isOpt:!0},{name:"ReportSchedules",kind:"a",desc:"Schedules connected to Reports (created in the Export function)",isOpt:!0}]},SelectedCellInfo:{name:"SelectedCellInfo",kind:"I",desc:"Describes which Cells are currently selected in AdapTable",props:[{name:"columns",kind:"u",desc:"Array of Columns which have selected cells"},{name:"gridCells",kind:"u",desc:"Array of GridCells (which provide cell value, primary kev value and other info)"}]},SelectedRowInfo:{name:"SelectedRowInfo",kind:"I",desc:"Description of currently selected Rows in AdapTable",props:[{name:"gridRows",kind:"u",desc:"Array of Grid Rows containing full information about a row in AdapTable"}]},ServerValidationContext:{name:"ServerValidationContext",kind:"I",desc:"Context used when validating data edits on Server",props:[{name:"cellDataChangedInfo",kind:"u",desc:"Details of Cell Edit"}]},ServerValidationResult:{name:"ServerValidationResult",kind:"I",desc:"Used for Server Validation ie. after an edit in AG Grid which must be checked on Server",props:[{name:"messageType",kind:"R",desc:"Type of Message to Display",isOpt:!0,defVal:"Info",ref:"AdaptableMessageType"},{name:"newCellValue",kind:"u",desc:"Cell Value to use for after Server Validation",isOpt:!0},{name:"validationHeader",kind:"s",desc:"Header to diplay with validation",isOpt:!0,defVal:"'Server Validation Message',"},{name:"validationMessage",kind:"s",desc:"Message to diplay with validation",isOpt:!0}]},SetPrimaryKeyValueContext:{name:"SetPrimaryKeyValueContext",kind:"I",desc:"Context for the setPrimaryKeyValue function",props:[{name:"rowData",kind:"u",desc:"Data in the row being created or cloned"}]},SettingsPanelOptions:{name:"SettingsPanelOptions",kind:"I",desc:"Options for managing the AdapTable Settings Panel",props:[{name:"alwaysShowInDashboard",kind:"b",desc:"Whether a Settings Panel button should always be displayed in `ModuleButtons` area of Dashboard",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"alwaysShowInToolPanel",kind:"b",desc:"Whether a Settings Panel button should always be displayed in `ModuleButtons` area of ToolPanel",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"customSettingsPanels",kind:"a",desc:"Custom Settings Panels provided by developers at design-time",isOpt:!0},{name:"icon",kind:"u",desc:"Icon shown in top left of Settings Panel: Can be `ConfigurationIcon`, `ApplicationIcon` or custom Icon",isOpt:!0,defVal:"`ConfigurationIcon`"},{name:"navigation",kind:"u",desc:"Ordered items to display at side of Settings Panel",isOpt:!0,defVal:"all available AdapTable modules"},{name:"popupType",kind:"R",desc:"Whether Settings Panel is 'window' (i.e. movable, resizable, no backdrop) or 'modal' (centre of screen with backdrop)",isOpt:!0,defVal:"'window'",ref:"PopupType"},{name:"position",kind:"u",desc:"Initial position of Settings Panel window",isOpt:!0,defVal:"Middle of Screen"},{name:"showModuleIcons",kind:"b",desc:"Whether to show Icons for each Module in the Setting Panel",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"size",kind:"u",desc:"Initial size of Settings Panel",isOpt:!0,defVal:"Computed based on size of screen"},{name:"title",kind:"s",desc:"Title for the Settings Panel",isOpt:!0,gridInfo:"item",defVal:"'Settings Panel'"}]},SharedEntitiesContext:{name:"SharedEntitiesContext",kind:"I",desc:"Context provided to `TeamSharingOptions.loadSharedEntities()` callback"},SharedEntity:{name:"SharedEntity",kind:"A",desc:"Defines an object used in Team Sharing. The union type is discriminated by the `EntityType` property (`adaptableEntity` / `customEntity`)."},SharedEntityType:{name:"SharedEntityType",kind:"A",desc:"Type of Shared Entity - Snapshot or Active"},Shortcut:{name:"Shortcut",kind:"I",desc:"Used to define a Shortcut as used in Shortcut State",props:[{name:"Scope",kind:"u",desc:"Numeric Columns where Shortcut is applied"},{name:"ShortcutKey",kind:"s",desc:"Key which triggers the Shortcut when pressed"},{name:"ShortcutOperation",kind:"'Add' | 'Subtract' | 'Multiply' | 'Divide'",desc:"The Operation: 'Add', 'Subtract', 'Multiply', 'Divide'"},{name:"ShortcutValue",kind:"n",desc:"Value acting as 2nd operand for ShortcutOperation (1st operand is the cell value)"}]},ShortcutScopeDataType:{name:"ShortcutScopeDataType",kind:"A",desc:"Shortcut scope data type."},ShortcutState:{name:"ShortcutState",kind:"I",desc:"Adaptable State Section for Shortcut Module",props:[{name:"Shortcuts",kind:"a",desc:"Collection of Shortcuts - designed to speed up data entry",isOpt:!0}]},SmartEditCustomOperation:{name:"SmartEditCustomOperation",kind:"A",desc:"Custom Operation used in Smart Edit Module"},SmartEditOperation:{name:"SmartEditOperation",kind:"A",desc:"Operation used by Smart Edit - either System or Custom"},SmartEditOperationContext:{name:"SmartEditOperationContext",kind:"I",desc:"Context used in Custom Smart Edit Operations",props:[{name:"currentCell",kind:"u",desc:"Current selected grid cell - contains column, row and cell value information"},{name:"smartEditValue",kind:"n",desc:"Smart Edit value"}]},SparklineStyle:{name:"SparklineStyle",kind:"A",desc:"Style to show for a Sparkline Column"},SpecialColumnSettings:{name:"SpecialColumnSettings",kind:"I",desc:"Base Settings for both Calculated and FreeText Columns",props:[{name:"Aggregatable",kind:"b",desc:"Whether Column can be used in an aggregation when grouping",isOpt:!0,defVal:"false"},{name:"ColumnTypes",kind:"a",desc:"Custom column types added to AG Grid Column Types when object is created",isOpt:!0},{name:"DataType",kind:"R",desc:"Expression's return value DataType, only mandatory property",ref:"AdaptableColumnDataType"},{name:"Filterable",kind:"b",desc:"Whether Column is filterable",isOpt:!0,defVal:"false"},{name:"Groupable",kind:"b",desc:"Whether Column can be grouped",isOpt:!0,defVal:"false"},{name:"HeaderToolTip",kind:"s",desc:"Tooltip to show in the Column Header (not cells)",isOpt:!0},{name:"Pivotable",kind:"b",desc:"Whether Column can be used when grid is in pivot mode",isOpt:!0,defVal:"false"},{name:"Resizable",kind:"b",desc:"Whether Column can be resized (by dragging column header edges)",isOpt:!0,defVal:"false"},{name:"Sortable",kind:"b",desc:"Whether Column is sortable",isOpt:!0,defVal:"false"},{name:"SuppressMenu",kind:"b",desc:"Whether if no menu should be shown for this Column header.",isOpt:!0,defVal:"false"},{name:"SuppressMovable",kind:"b",desc:"Whether if this Column should be movable via dragging",isOpt:!0,defVal:"false"},{name:"Width",kind:"n",desc:"Preferred (pixel) Column Width; if unset, calculated dynamically by AG Grid",isOpt:!0}]},StateOptions:{name:"StateOptions",kind:"I",desc:"Options related to Adaptable State hydration / dehydration; allows users to intercept state persistence and loading with custom functionality",props:[{name:"applyState",kind:"R",desc:"Transforms state before applying it to the application. Called after `loadState()` but before the state is used.",isOpt:!0,ref:"unknown"},{name:"autoMigrateState",kind:"b",desc:"Automatically migrate State from previous AdapTable version to current one",isOpt:!0,defVal:"true"},{name:"clearState",kind:"R",desc:"Allows clearing of remote Adaptable State. Only invoked during `StateApi.reloadInitialState()` operations.",isOpt:!0,defVal:"undefined",ref:"AdaptableClearStateFunction"},{name:"debounceStateDelay",kind:"n",desc:"Delay (in ms) to debounce `saveState` / `persistState` calls enabling grouping multiple sequential calls in single one (e.g. elevator doors)",isOpt:!0,defVal:"400"},{name:"loadState",kind:"R",desc:"Retrieves saved Adaptable State from storage or external source",isOpt:!0,ref:"AdaptableLoadStateFunction"},{name:"persistState",kind:"R",desc:"Handles the actual storage of state to localStorage, server, etc. Called after `saveState()` to store the prepared state.",isOpt:!0,ref:"AdaptablePersistStateFunction"},{name:"saveState",kind:"R",desc:"Transforms state before saving to storage. Called before `persistState()`.",isOpt:!0,ref:"AdaptableSaveStateFunction"}]},StatusBarState:{name:"StatusBarState",kind:"I",desc:"Adaptable State Section for the Adaptable Status Bar",props:[{name:"StatusBars",kind:"a",desc:"Adaptable Status Bars to display - can be unlimited and displayed in 3 locations",isOpt:!0,defVal:"null"}]},StringFormatterOptions:{name:"StringFormatterOptions",kind:"I",desc:"Formatter Options for String Columns",props:[{name:"Case",kind:"'Upper' | 'Lower' | 'Sentence'",desc:"Sets text to Upper or Lower case",isOpt:!0},{name:"Content",kind:"s",desc:"Replaces cell value; useful when using Condition (e.g. replace null with 'N/A')",isOpt:!0},{name:"Empty",kind:"b",desc:"Show nothing in cell (but underlying value remains)",isOpt:!0},{name:"Prefix",kind:"s",desc:"Prefix to use before the cell text",isOpt:!0},{name:"Suffix",kind:"s",desc:"Suffix to use after the cell text",isOpt:!0},{name:"Trim",kind:"b",desc:"Trims text (both start and end)",isOpt:!0}]},StyledColumn:{name:"StyledColumn",kind:"I",desc:"Object used in Special Column Style function",props:[{name:"BadgeStyle",kind:"R",desc:"Displays cell values in Column as a Badge",isOpt:!0,ref:"BadgeStyle"},{name:"ColumnId",kind:"s",desc:"Column being styled"},{name:"GradientStyle",kind:"R",desc:"Styles a numeric column with a Gradient",isOpt:!0,ref:"GradientStyle"},{name:"PercentBarStyle",kind:"R",desc:"Styles a numeric column so each cell displays a 'Bar'",isOpt:!0,ref:"PercentBarStyle"},{name:"SparklineStyle",kind:"R",desc:"Displays a Sparkline Chart in an array column",isOpt:!0,ref:"SparklineStyle"}]},StyledColumnState:{name:"StyledColumnState",kind:"I",desc:"Adaptable State Section for Styled Column Module",props:[{name:"StyledColumns",kind:"a",desc:"Collection of Special Column Styles",isOpt:!0}]},SuspendableObject:{name:"SuspendableObject",kind:"I",desc:"Interface that extends Adaptable Object for those config items that can be suspended at run-time",props:[{name:"IsSuspended",kind:"b",desc:"Suspends (i.e. turns off) an Adaptable Object",isOpt:!0}]},SystemAlertPredicateId:{name:"SystemAlertPredicateId",kind:"A",desc:"List of System Predicates available for Alerts"},SystemAlertPredicateIds:{name:"SystemAlertPredicateIds",kind:"A",desc:"Array containing all System Alert Predicates"},SystemBadgeStylePredicateId:{name:"SystemBadgeStylePredicateId",kind:"A",desc:"Predicates available when creating a Badge Style Rule"},SystemBadgeStylePredicateIds:{name:"SystemBadgeStylePredicateIds",kind:"A",desc:"System Predicate Ids available for Badge Style"},SystemExportDestination:{name:"SystemExportDestination",kind:"A",desc:"Export Destinations provided by AdapTable"},SystemExportDestinationsContext:{name:"SystemExportDestinationsContext",kind:"I",desc:"Context provided to `ExportOptions.systemExportDestinations` callback",props:[{name:"currentLayoutName",kind:"s",desc:"Name of current Layout"},{name:"currentReportFormat",kind:"R",desc:"Format of current Report",isOpt:!0,ref:"ReportFormatType"},{name:"currentReportName",kind:"R",desc:"Name of current Report",isOpt:!0,ref:"ReportNameType"},{name:"defaultSystemExportDestinations",kind:"a",desc:"Default System Export Destinations"}]},SystemFilterPredicateId:{name:"SystemFilterPredicateId",kind:"A",desc:"List of System Predicates available for Filters"},SystemFilterPredicateIds:{name:"SystemFilterPredicateIds",kind:"A",desc:"Array containing all System Filter Predicates"},SystemFlashingCellPredicateId:{name:"SystemFlashingCellPredicateId",kind:"A",desc:"List of System Predicates available for Flashing Cells"},SystemFlashingCellPredicateIds:{name:"SystemFlashingCellPredicateIds",kind:"A",desc:"Array containing all System Flashing Cell Predicates"},SystemFormatColumnPredicateId:{name:"SystemFormatColumnPredicateId",kind:"A",desc:"List of System Predicates available for Format Columns"},SystemFormatColumnPredicateIds:{name:"SystemFormatColumnPredicateIds",kind:"A",desc:"Array containing all System Format Column Predicates"},SystemPredicatesContext:{name:"SystemPredicatesContext",kind:"I",desc:"Context used for setting which System Predicates are available",props:[{name:"columnScope",kind:"R",desc:"Current Scope where Predicates are being used",ref:"ColumnScope"},{name:"moduleScope",kind:"R",desc:"Module for which Predicates are being retrieved",ref:"PredicateModuleScope"},{name:"systemPredicateDefs",kind:"u",desc:"AdapTable-provided System Predicate Definitions"}]},SystemReportFormat:{name:"SystemReportFormat",kind:"A",desc:"System report formats provided by AdapTable"},SystemReportFormatsContext:{name:"SystemReportFormatsContext",kind:"I",desc:"Context provided to `ExportOptions.systemReportFormats` callback",props:[{name:"currentLayoutName",kind:"s",desc:"Name of current Layout"},{name:"currentReportName",kind:"R",desc:"Name of current Report",isOpt:!0,ref:"ReportNameType"},{name:"defaultSystemReportFormats",kind:"a",desc:"Default System Report Formats"}]},SystemReportName:{name:"SystemReportName",kind:"A",desc:"System report names provided by AdapTable"},SystemReportNames:{name:"SystemReportNames",kind:"A",desc:"Array containing all System Report names"},SystemReportNamesContext:{name:"SystemReportNamesContext",kind:"I",desc:"Context provided to `ExportOptions.systemReportNames` callback",props:[{name:"currentLayoutName",kind:"s",desc:"Name of current Layout"},{name:"defaultSystemReportNames",kind:"a",desc:"Default System Report Names"}]},SystemStatusMessageInfo:{name:"SystemStatusMessageInfo",kind:"I",desc:"Wraps a System Status Message",props:[{name:"statusFurtherInformation",kind:"s",desc:"Additional information to display (optional)",isOpt:!0},{name:"statusMessage",kind:"s",desc:"The Message to be displayed"},{name:"statusType",kind:"R",desc:"Type of Message i.e. Succcess, Warning, Error, Info",ref:"AdaptableMessageType"},{name:"timestamp",kind:"d",desc:"When Message was sent",isOpt:!0}]},TableAggregationColumns:{name:"TableAggregationColumns",kind:"A",desc:"Defines an Aggregated Column in a Table Layout"},TableColumnGroupHeaderContext:{name:"TableColumnGroupHeaderContext",kind:"I",desc:"Context for Column Group headers",props:[{name:"childrenColumnIds",kind:"a",desc:"Ids of Column Group's children"},{name:"columnType",kind:"u",desc:"Table Column Group (used when Column Grouping in Table Layouts)"},{name:"groupId",kind:"s",desc:"Id of Column Group"},{name:"state",kind:"'expanded' | 'collapsed'",desc:"Expanded / Collapsed state of Column Group"}]},TableColumnHeaderContext:{name:"TableColumnHeaderContext",kind:"I",desc:"Context for standard Table Layout Columns",props:[{name:"aggregation",kind:"s",desc:"Aggregation function of Column (optional)",isOpt:!0},{name:"columnId",kind:"s",desc:"Id of the Column"},{name:"columnType",kind:"u",desc:"Table Column (created in Table Layouts)"}]},TableLayout:{name:"TableLayout",kind:"I",desc:"Defines a Table-based Layout",props:[{name:"ColumnVisibility",kind:"R",desc:"Map of Table Column Visibility",isOpt:!0,ref:"ColumnBooleanFalseMap"},{name:"PivotAggregationColumns",kind:"u",desc:"Pivot Aggregation Columns - must NOT be provided",isOpt:!0},{name:"PivotColumns",kind:"u",desc:"Pivot Columns - must NOT be provided",isOpt:!0},{name:"PivotExpandLevel",kind:"u",desc:"Pivot Expansions - must NOT be provided",isOpt:!0},{name:"PivotGroupedColumns",kind:"u",desc:"Pivot Group Columns - must NOT be provided",isOpt:!0},{name:"RowGroupedColumns",kind:"a",desc:"Columns which are row-grouped when the Layout is applied",isOpt:!0},{name:"RowSummaries",kind:"a",desc:"Pinned Rows that display Aggregation Info for a whole Column",isOpt:!0},{name:"TableAggregationColumns",kind:"R",desc:"Columns showing aggregated values in Grouped Rows; a record of ColumnId and aggfunc (e.g. sum) or 'true' (to use default aggfunc)",isOpt:!0,ref:"TableAggregationColumns"},{name:"TableColumns",kind:"a",desc:"List of Column Ids to include in Table Layout"}]},TableLayoutCreationDefaultProperties:{name:"TableLayoutCreationDefaultProperties",kind:"A",desc:"Default properties to apply when creating a new Table Layout"},TeamSharingOptions:{name:"TeamSharingOptions",kind:"I",desc:"Options for managing Team Sharing - which enables Adaptable Objects to be shared between colleagues",props:[{name:"applySharedEntities",kind:"u",desc:"Allows hooking into Shared Entities loading process",isOpt:!0},{name:"enableTeamSharing",kind:"b",desc:"Whether Team Sharing is enabled",gridInfo:"item",defVal:"false"},{name:"handleCustomSharedEntityImport",kind:"u",desc:"Handles import of Custom Shared Entities",isOpt:!0},{name:"loadSharedEntities",kind:"u",desc:"(Async) Loads available Shared Entities - user can download and auto-merge with Adaptable State",defVal:"null"},{name:"persistSharedEntities",kind:"u",desc:"(Async) Persists Shared Entities so that they can be downloaded by other team members",defVal:"null"},{name:"saveSharedEntities",kind:"u",desc:"Allows hooking into Shared Entities persistence process",isOpt:!0},{name:"showUpdateNotificationOncePerUpdate",kind:"b",desc:"Whether to show update notification once per update",isOpt:!0,defVal:"false"},{name:"suppressOverrideConfigWarning",kind:"b",desc:"Suppress warning when an Import overrides existing Adaptable State item",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"updateInterval",kind:"n",desc:"Frequency (in minutes) to check if Active Shared Entities have a newer revision",isOpt:!0,gridInfo:"item",defVal:"0 (never)"},{name:"updateNotification",kind:"'Alert' | 'AlertWithNotification' | 'SystemStatus'",desc:"How user is informed when Active Shared Entities have newer revisions",isOpt:!0,gridInfo:"item",defVal:"null (none)"}]},TeamSharingState:{name:"TeamSharingState",kind:"I",desc:"State for Team Sharing; internal so not designed to be provided as part of Initial Adaptable State",props:[{name:"ActiveSharedEntityMap",kind:"u",desc:"Mapping of active AdaptableObjects which are shared with the local state. Maps UUIDs of local AdaptableObjects to a snapshot of the latest synchronized SharedEntity"},{name:"importProcessInProgress",kind:"b",desc:"TRUE if an import is in progress, FALSE otherwise. This is required to skip the TEAMSHARING_UPDATE_ITEM action as a result of the import"},{name:"SharedEntities",kind:"a",desc:"List of objects currently being Team Shared"}]},ThemeState:{name:"ThemeState",kind:"I",desc:"Theme section of Adaptable State",props:[{name:"CurrentTheme",kind:"u",desc:"Name of current theme (or theme to set at startup); leave blank if using 'Light Theme', set to 'dark' for 'Dark Theme' or provide name of Custom Theme",isOpt:!0},{name:"SystemThemes",kind:"u",desc:"Which, if any, of the 2 themes shipped by Adaptable should be available; leave unset to provide both, or an empty array to provide neither.",isOpt:!0},{name:"UserThemes",kind:"a",desc:"Custom themes (of type AdaptableTheme) provided by developers",isOpt:!0}]},ToastPositions:{name:"ToastPositions",kind:"A",desc:"Different positions offered by Notifications"},ToastTransitions:{name:"ToastTransitions",kind:"A",desc:"Different transitions offered by Notifications"},Token:{name:"Token",kind:"A",desc:"Token used by the AdapTableQL parser"},ToolbarAction:{name:"ToolbarAction",kind:"A",desc:"Action available in Custom Toolbar - Close or Configure"},ToolbarActions:{name:"ToolbarActions",kind:"A",desc:"List of Actions available in Custom Toolbar"},ToolPanelButtonContext:{name:"ToolPanelButtonContext",kind:"I",desc:"Context required by functions when using a ToolPanel Button",props:[{name:"toolPanelState",kind:"R",desc:"Current ToolPanel State",ref:"ToolPanelState"}]},ToolPanelOptions:{name:"ToolPanelOptions",kind:"I",desc:"Options related to managing the AdapTable ToolPanel Component",props:[{name:"customButtons",kind:"a",desc:"ToolPanel Buttons provided by Users which perform custom behaviour",isOpt:!0},{name:"customToolPanels",kind:"a",desc:"ToolPanels provided by Users which contain custom content",isOpt:!0},{name:"showToolPanelsDropdown",kind:"b",desc:"Display the Tool Panels dropdown",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"}]},ToolPanelState:{name:"ToolPanelState",kind:"I",desc:"Adaptable State Section for the AdapTable ToolPanel",props:[{name:"ModuleButtons",kind:"R",desc:"AdapTable Module Buttons visible in ToolPanel",isOpt:!0,defVal:"Empty Array",ref:"unknown"},{name:"ToolPanels",kind:"a",desc:"Adaptable Tool Panels which are viaible",isOpt:!0,defVal:"ToolPanels for all available Modules (subject to Entitlement rules)"}]},ToolPanelVisibilityMode:{name:"ToolPanelVisibilityMode",kind:"A",desc:"Whether a ToolPanel displays as expanded or collapsed"},TransposeConfig:{name:"TransposeConfig",kind:"I",desc:"Config used when transposing a Grid",props:[{name:"autosize",kind:"b",desc:"Autosize columns in transposed view",isOpt:!0,defVal:"true"},{name:"hideTransposedColumn",kind:"b",desc:"Hide the Transposed Column",isOpt:!0,defVal:"true"},{name:"transposedColumnId",kind:"s",desc:"Column to use to do transposition",isOpt:!0,defVal:"Primary Key Column"},{name:"visibleColumns",kind:"b",desc:"Only show curerntly visible Columns",isOpt:!0,defVal:"false"},{name:"visibleRows",kind:"b",desc:"Only show curerntly visible Rows",isOpt:!0,defVal:"false"}]},UIControlConfig:{name:"UIControlConfig",kind:"I",desc:"Used to customise FDC3 controls (e.g. Action Columns)",props:[{name:"icon",kind:"R",desc:"Icon to display",isOpt:!0,ref:"AdaptableIcon"}]},UniqueGridCell:{name:"UniqueGridCell",kind:"I",desc:"Defines a Unique Cell Value (incl. how many times it appears in Grid)",props:[{name:"count",kind:"n",desc:"How many times Cell appears in Data Source"},{name:"displayValue",kind:"u",desc:"Display value of Cell (e.g. if formatted)"},{name:"normalisedValue",kind:"u",desc:"Normalised value of Cell"},{name:"rawValue",kind:"u",desc:"Raw value of Cell"},{name:"visible",kind:"b",desc:"Is Cell in a currently filtered Row"},{name:"visibleCount",kind:"n",desc:"How many times Cell appears in filtered Rows"}]},UpgradeConfig:{name:"UpgradeConfig",kind:"I",desc:"Config object used by State Auto-migration Wizard",props:[{name:"fromVersion",kind:"n",desc:"AdapTable version to upgrade from"},{name:"logger",kind:"R",desc:"The logger object",isOpt:!0,defVal:"The console object",ref:"unknown"},{name:"toVersion",kind:"n",desc:"AdapTable version to upgrade to",isOpt:!0,defVal:"The current version"}]},UserColumnMenuItem:{name:"UserColumnMenuItem",kind:"I",desc:"Column Menu Item that is provided by User",props:[{name:"disabled",kind:"b",desc:"Whether menu item is disabled",isOpt:!0},{name:"hidden",kind:"b",desc:"Whether menu item is hidden",isOpt:!0},{name:"icon",kind:"R",desc:"Optional icon to display",isOpt:!0,ref:"AdaptableIcon"},{name:"label",kind:"s",desc:"Text to appear in the Menu Item"},{name:"menuType",kind:"u",desc:"Type of Menu - always 'User'"},{name:"onClick",kind:"f",desc:"Function invoked when the Menu Item is clicked",isOpt:!0},{name:"subMenuItems",kind:"a",desc:"Array of Menu Items, enabling limitless levels of menus",isOpt:!0}]},UserContextMenuItem:{name:"UserContextMenuItem",kind:"I",desc:"Context Menu Item that is provided by User",props:[{name:"disabled",kind:"b",desc:"Whether menu item is disabled",isOpt:!0},{name:"hidden",kind:"b",desc:"Whether menu item is hidden",isOpt:!0},{name:"icon",kind:"R",desc:"Optional icon to display",isOpt:!0,ref:"AdaptableIcon"},{name:"label",kind:"s",desc:"Text to appear in the Menu Item"},{name:"menuType",kind:"u",desc:"Type of Menu - always 'User'"},{name:"onClick",kind:"f",desc:"Function invoked when the Menu Item is clicked",isOpt:!0},{name:"subMenuItems",kind:"a",desc:"Array of Menu Items, enabling limitless levels of menus",isOpt:!0}]},UserInterfaceOptions:{name:"UserInterfaceOptions",kind:"I",desc:"Options for managing the User Interface of AdapTable",props:[{name:"alternativeModuleNames",kind:"a",desc:"Alternative names to use for Adaptable Modules in the UI",isOpt:!0,defVal:"null"},{name:"applicationIcon",kind:"R",desc:"The application icon to appear in Dashboard and elsewhere (e.g. in Notifications)",isOpt:!0,defVal:"null",ref:"AdaptableIcon"},{name:"colorPalette",kind:"u",desc:"Colours to display in Colour Picker (in place of AdapTable's default set); can be hardcoded list or function",isOpt:!0},{name:"customIcons",kind:"u",desc:"Bespoke icons that can be used in AdapTable (e.g. Badge Styles and Buttons)",isOpt:!0},{name:"dateInputOptions",kind:"R",desc:"Options for managing and customizing date inputs in AdapTable",isOpt:!0,ref:"DateInputOptions"},{name:"disableDeleteConfirmation",kind:"b",desc:"Hides confirmation dialog which displays whenever an AdaptableObject is deleted",isOpt:!0,noCode:"item",defVal:"false"},{name:"editableCellStyle",kind:"R",desc:"Style to set for editable Cells",isOpt:!0,ref:"AdaptableStyle"},{name:"editedCellStyle",kind:"R",desc:"Style to set for Cells which have been edited",isOpt:!0,ref:"AdaptableStyle"},{name:"englishVariant",kind:"'GB' | 'US'",desc:"English variant to use in AdapTable UI",isOpt:!0,gridInfo:"item",defVal:"'GB'"},{name:"loadingScreenOptions",kind:"R",desc:"Options for showing Loading Screen (during initialisation)",isOpt:!0,ref:"LoadingScreenOptions"},{name:"objectTags",kind:"u",desc:"Optional list of AdaptableObjectTags that can be associated with AdaptableObjects",isOpt:!0},{name:"readOnlyCellStyle",kind:"R",desc:"Style to set for non-editable Cells",isOpt:!0,ref:"AdaptableStyle"},{name:"showAdapTableVersion",kind:"b",desc:"Displays the AdapTable version in Grid Info section of Settings Panel",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"showAgGridVersion",kind:"b",desc:"Displays the AG Grid version in Grid Info section of Settings Panel",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"showDocumentationLinks",kind:"b",desc:"Provide links to AdapTable documentation (in Module popups and Expression Editor)",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"styleClassNames",kind:"a",desc:"Optional list of CSS styles that can be used when creating Adaptable Styles in Adaptable (e.g. in Format Column and other Modules)",isOpt:!0,gridInfo:"item"},{name:"useCustomMacLikeScrollbars",kind:"b",desc:"Show Mac-like scrollbars; size is configurable via CSS variable `--ab-custom-scrollbar-size` (default: `10px`)",isOpt:!0,gridInfo:"item",defVal:"false"}]},UserMenuItem:{name:"UserMenuItem",kind:"I",desc:"Menu Item which is added to Column or Context Menu - can contain sub items",props:[{name:"disabled",kind:"u",desc:"Function evaluating whether Menu Item is enabled",isOpt:!0},{name:"hidden",kind:"u",desc:"Function evaluating whether Menu Item is visible",isOpt:!0},{name:"icon",kind:"u",desc:"Optional icon to display",isOpt:!0},{name:"label",kind:"u",desc:"Text to appear in the Menu Item"},{name:"onClick",kind:"u",desc:"Function invoked when the Menu Item is clicked",isOpt:!0},{name:"subMenuItems",kind:"u",desc:"Array of Menu Items, enabling limitless levels of menus",isOpt:!0}]},VueFrameworkComponent:{name:"VueFrameworkComponent",kind:"A",desc:"Creates a Vue Component to be used in AdapTable UI controls"},WeightedAverageAggregation:{name:"WeightedAverageAggregation",kind:"I",desc:"Defines a Weighted Average Agg",props:[{name:"type",kind:"u",desc:"Type is always 'weightedAverage'"},{name:"weightedColumnId",kind:"s",desc:"Column which is weighted"}]},WindowPosition:{name:"WindowPosition",kind:"I",desc:"Defines position of a Custom Window"},WindowSize:{name:"WindowSize",kind:"I",desc:"Defines size of a Custom Window"}};