@adaptabletools/adaptable 15.4.1 → 15.4.2

package/src/metamodel/adaptable.metamodel.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ADAPTABLE_METAMODEL=void 0,exports.ADAPTABLE_METAMODEL={AccessLevel:{name:"AccessLevel",kind:"A",desc:"Defines Access Level for an Entitlement - can be `ReadOnly`, `Hidden` or `Full`"},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:"Additional optional properties for 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:"includeGroupedRows",kind:"b",desc:"Shows Action Column also in grouped rows",isOpt:!0}]},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"}]},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}]},ActionHandler:{name:"ActionHandler",kind:"A",desc:"Handles a Form Button Action"},ActionOptions:{name:"ActionOptions",kind:"I",desc:"Options related to Action Columns and Buttons in Adaptable.",props:[{name:"actionColumns",kind:"u",desc:"Columns which contain an AdapTable Button - used for performing Actions",isOpt:!0,defVal:"undefined"},{name:"actionRowButtonOptions",kind:"u",desc:"Additional options for managing Action Row Buttons",isOpt:!0,defVal:"undefined"},{name:"actionRowButtons",kind:"u",desc:"Action buttons to display for each row",isOpt:!0,defVal:"undefined"}]},ActionRowButtonConfigurationContext:{name:"ActionRowButtonConfigurationContext",kind:"I",desc:"Context used when adding custom configuration for Action Row Buttons",props:[{name:"actionRowButtonType",kind:"R",desc:"Type of Action Row Button: 'create', 'clone', 'edit' or 'delete'",ref:"ActionRowButtonType"}]},ActionRowButtonOptions:{name:"ActionRowButtonOptions",kind:"I",desc:"Options for managing the Buttons in Action Rows",props:[{name:"actionRowFormOptions",kind:"u",desc:"Options for managing the Form which the Action Row displays",isOpt:!0,defVal:"undefined"},{name:"autoHandle",kind:"b",desc:"If true, AdapTable will automatically update the AG Grid data model with the created/edited/deleted rows",isOpt:!0,defVal:"true"},{name:"customConfiguration",kind:"u",desc:"Optional configuration that merges with built-in action row button and overrides default configuration",isOpt:!0,defVal:"undefined"},{name:"disableInlineEditing",kind:"b",desc:"Prevents direct editing in Grid cells even for editable columns",isOpt:!0,defVal:"false"},{name:"position",kind:"'pinnedLeft' | 'pinnedRight'",desc:"Action Row Buttons position: 'pinnedLeft' | 'pinnedRight",isOpt:!0,defVal:"'pinnedLeft'"},{name:"setPrimaryKeyValue",kind:"u",desc:"Function called when auto-handling 'create' Action Row Button; returned row value should have a valid(unique) primary key value",isOpt:!0,defVal:"undefined"}]},ActionRowButtonsContext:{name:"ActionRowButtonsContext",kind:"I",desc:"Context passed to Action Row Buttons"},ActionRowButtonType:{name:"ActionRowButtonType",kind:"A",desc:"Type of Action Row Button: 'create' | 'clone' | 'edit' | 'delete'"},ActionRowFormContext:{name:"ActionRowFormContext",kind:"A",desc:"Context passed into a Row Form - can be `CreateActionRowContext` or `EditActionRowContext`"},ActionRowFormOptions:{name:"ActionRowFormOptions",kind:"I",desc:"Options for Form displayed when Action Row Button is clicked",props:[{name:"formButtons",kind:"u",desc:"Custom form buttons provider. If provided, the custom implementation is responsible for firing the 'ActionRowSubmitted' and/or invoking the 'onFormSubmit' callback (if necessary).",isOpt:!0},{name:"formDescription",kind:"u",desc:"Custom form description provider",isOpt:!0,defVal:"undefined"},{name:"formFieldLabel",kind:"u",desc:"Custom form field label provider",isOpt:!0,defVal:"undefined"},{name:"formTitle",kind:"u",desc:"Custom form title provider",isOpt:!0,defVal:"'Create New Row'/'Edit Row'"},{name:"onFormSubmit",kind:"u",desc:"Event published when the form in an Action Row is submitted via a standard button (provided by AdapTable). This is not invoked when custom form buttons are provided!",isOpt:!0,defVal:"undefined"}]},ActionRowParamContext:{name:"ActionRowParamContext",kind:"I",desc:"Context used for overriding Title and Description of Action Row Form"},ActionRowParamFieldContext:{name:"ActionRowParamFieldContext",kind:"I",desc:"Context used for overriding Field elements in Action Row Form"},AdaptableAggregatedBooleanQuery:{name:"AdaptableAggregatedBooleanQuery",kind:"I",desc:"Wraps an AdapTableQL Aggregated Boolean Expression"},AdaptableAggregatedScalarQuery:{name:"AdaptableAggregatedScalarQuery",kind:"I",desc:"Wraps an AdapTableQL Aggregated Scalar Expression"},AdaptableAlert:{name:"AdaptableAlert",kind:"A",desc:"Defines an Alert fired by AdapTable"},AdaptableAlertAction:{name:"AdaptableAlertAction",kind:"A",desc:"Actions available in an Alert"},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"}]},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"},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:"Allows clearing state when a custom persistState is used. Only called by configApi.reloadPredefinedConfig"},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:"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:"unknown"},{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:"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:"isExcludedFromQuickSearch",kind:"b",desc:"Has colummn been excluded from Quick Search results"},{name:"isFixed",kind:"b",desc:"Is Column pinned or locked into position"},{name:"isGrouped",kind:"b",desc:"Is Column currently Row-Grouped"},{name:"isPrimaryKey",kind:"b",desc:"Is this the Primary Key Column"},{name:"isSparkline",kind:"b",desc:"Is it a Sparkline Column"},{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 Grid"},{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:"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:"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"}]},AdaptableColumnDataType:{name:"AdaptableColumnDataType",kind:"A",desc:"Type of data stored in an Adaptable Column"},AdaptableColumnType:{name:"AdaptableColumnType",kind:"A",desc:"Column Types recognised by AdapTable; to be set in GridOptions"},AdaptableComparerFunction:{name:"AdaptableComparerFunction",kind:"A",desc:"Standard comparer function used to evaluate custom sorts, returns -1, 0, 1 as required"},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"}]},AdaptableDashboardToolbar:{name:"AdaptableDashboardToolbar",kind:"A",desc:"List of all the Toolbars that Adaptable provides"},AdaptableDataChangeHistoryAction:{name:"AdaptableDataChangeHistoryAction",kind:"A",desc:"Built in `undo` data change action"},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"}]},AdaptableExternalIcon:{name:"AdaptableExternalIcon",kind:"I",desc:"Defines an icon from an external source",props:[{name:"src",kind:"s",desc:"The URL of the icon to use"}]},AdaptableFDC3EventInfo:{name:"AdaptableFDC3EventInfo",kind:"I",desc:"EventInfo returned by `FDC3MessageSent` event",props:[{name:"context",kind:"R",desc:"Full FDC3 Context for the object related to the event",ref:"FDC3Context"},{name:"eventType",kind:"'RaiseIntent' | 'RaiseIntentForContext' | 'BroadcastMessage'",desc:"Type of Event: `RaiseIntent`, `RaiseIntentForContext` or `BroadcastMessage`"},{name:"intent",kind:"u",desc:"The FDC3 Intent which caused Event to fire (if type is `RaiseIntent`)",isOpt:!0}]},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 or React"},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.)"},AdaptableInternalIcon:{name:"AdaptableInternalIcon",kind:"I",desc:"Defines an icon from the internal AdapTable icon set",props:[{name:"name",kind:"R",desc:"The name of the icon to use (referencing the AdapTable Icon Library)",ref:"AdaptableInternalIconName"},{name:"size",kind:"n",desc:"The size (in pixels) of the SVG icon (defaults to `17px`)",isOpt:!0}]},AdaptableInternalIconName:{name:"AdaptableInternalIconName",kind:"A",desc:"All AdapTable internal icon names"},AdaptableLoadStateFunction:{name:"AdaptableLoadStateFunction",kind:"I",desc:"Allows customization of state loading - used by `loadState` function in StateOptions"},AdaptableMenuItem:{name:"AdaptableMenuItem",kind:"I",desc:"Menu item used by Adaptable in both Column and Context Menus",props:[{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:"Name that appears in the menu"},{name:"module",kind:"u",desc:"Adaptable Module associated with (Adaptable) menu item.",isOpt:!0},{name:"onClick",kind:"u",desc:"Function to invoke when (custom) menu item is clicked",isOpt:!0},{name:"reduxAction",kind:"R",desc:"Adaptable Redux Action to invoke when (Adaptable) menu item is clicked",isOpt:!0,ref:"unknown"},{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 Predefined Config"},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"},AdaptableObject:{name:"AdaptableObject",kind:"I",desc:"Base interface which all other Adaptable State-related objects extend",props:[{name:"IsReadOnly",kind:"b",desc:"Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')",isOpt:!0},{name:"Source",kind:"'Config' | 'User'",desc:"Source of state object: 'Config' if provided via `AdaptableOptions.predefinedConfig`, 'User' or undefined for runtime state.",isOpt:!0},{name:"Tags",kind:"a",desc:"List of Tags associated with the Object; often used for (but not limited to) managing Layout object scope",isOpt:!0},{name:"Uuid",kind:"R",desc:"Unique identifier for the Adaptable Object, generated and used internally by AdapTable",isOpt:!0,ref:"unknown"}]},AdaptableObjectLookupCriteria:{name:"AdaptableObjectLookupCriteria",kind:"I",desc:"Lookup criteria for finding specific AdaptableObjects. 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:"AdaptableScope",isOpt:!0,ref:"AdaptableScope"},{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 ever needed."},AdaptableObservableQuery:{name:"AdaptableObservableQuery",kind:"I",desc:"Wraps an AdapTableQL Observable Expression"},AdaptableOptions:{name:"AdaptableOptions",kind:"I",desc:"Group of property options enabling developers to set up AdapTable at design time to fit precise requirements - provides AG Grid, Predefined Config and other information required to ensure a full, rich user experience",props:[{name:"actionOptions",kind:"u",desc:"Options for managing Action Columns and Action Rows",isOpt:!0},{name:"adaptableId",kind:"s",desc:"Identifier for this instance of AdapTable",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"'adaptable_id'"},{name:"adaptableQLOptions",kind:"u",desc:"Options for managing AdapTableQL",isOpt:!0,noCode:"container"},{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:"chartingOptions",kind:"R",desc:"Options for managing AG Grid's Charting",isOpt:!0,noCode:"container",ref:"ChartingOptions"},{name:"columnOptions",kind:"R",desc:"Options related to Columns",isOpt:!0,noCode:"container",ref:"ColumnOptions"},{name:"containerOptions",kind:"R",desc:"Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed",isOpt:!0,ref:"ContainerOptions"},{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:"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:"R",desc:"Options for managing Exporting and Reports in AdapTable",isOpt:!0,gridInfo:"container",ref:"ExportOptions"},{name:"filterOptions",kind:"u",desc:"Options for managing Filtering in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container"},{name:"flashingCellOptions",kind:"R",desc:"Options for managing Flashing Cells - primarily default values",isOpt:!0,gridInfo:"container",ref:"FlashingCellOptions"},{name:"generalOptions",kind:"u",desc:"General options to manage AdapTable e.g. grouping behaviour, Primary Keys",isOpt:!0,gridInfo:"container",noCode:"container"},{name:"gridOptions",kind:"u",desc:"The AG Grid object which AdapTable interacts with. Note: if using AdapTable React or AdapTable Angular, no need to populate this property as AdapTable wires it up differently",isOpt:!0},{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:"menuOptions",kind:"u",desc:"Options for managing AdapTable menus",isOpt:!0,gridInfo:"container"},{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:"predefinedConfig",kind:"u",desc:"User State set at design-time and shipped with AdapTable for first use; can be `PredefinedConfig` object or url to file containing config",isOpt:!0,defVal:"undefined"},{name:"primaryKey",kind:"u",desc:"Name of Column in AdapTable guaranteed to contain unique values",gridInfo:"item",defVal:"n/a (Mandatory)"},{name:"searchOptions",kind:"u",desc:"Options for managing Search related functions in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container"},{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'"}]},AdaptablePersistentState:{name:"AdaptablePersistentState",kind:"I",desc:"The state object of Adaptable which is persisted"},AdaptablePersistStateFunction:{name:"AdaptablePersistStateFunction",kind:"I",desc:"Allows customization of state persistence - used `persistState` function in StateOptions"},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:"s",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:"AdaptableScope"},{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:"s",desc:"Unique Id for the object"},{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 the Predicate can run"},{name:"onlyQuickFilter",kind:"b",desc:"Display this predicate only in Quick Filter Bar (and NOT in Filter Form)",isOpt:!0},{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"},AdaptableQLOptions:{name:"AdaptableQLOptions",kind:"I",desc:"Options for managing AdapTableQL: AdapTable's Query Language which evaluates Predicates and Expressions",props:[{name:"caseSensitiveTextComparisons",kind:"b",desc:"Perform case-sensitive text comparisons when evaluating Predicates and Expressions",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"customPredicateDefs",kind:"a",desc:"Definitions for Custom provided Predicates",isOpt:!0},{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:"expressionOptions",kind:"R",desc:"Options for managing Expressions in AdapTableQL",isOpt:!0,ref:"ExpressionOptions"},{name:"predicateOptions",kind:"R",desc:"Options for managing Predicates in AdapTableQL",isOpt:!0,ref:"PredicateOptions"}]},AdaptableQuery:{name:"AdaptableQuery",kind:"A",desc:"An AdaptableQuery can be either a Boolean, Scalar, Observable, AggregatedBoolean, or AggregatedScalar expression"},AdaptableReportColumn:{name:"AdaptableReportColumn",kind:"I",desc:"Column which is included in a Report",props:[{name:"columnId",kind:"s",desc:"ColumnID"},{name:"dataType",kind:"R",desc:"DataType of the Column",ref:"AdaptableColumnDataType"},{name:"field",kind:"s",desc:"Field name to get the value from the row data (defaults to `columnId`)",isOpt:!0},{name:"friendlyName",kind:"s",desc:"Column Header"}]},AdaptableRowChangedAlert:{name:"AdaptableRowChangedAlert",kind:"I",desc:"Defines an Alert fired by AdapTable when a row is changed",props:[{name:"gridDataChangedInfo",kind:"u",desc:"Row DataChange which triggered Alert"}]},AdaptableSaveStateFunction:{name:"AdaptableSaveStateFunction",kind:"I",desc:"Allows the customization state persistence - used by `saveState` function in StateOptions"},AdaptableScalarQuery:{name:"AdaptableScalarQuery",kind:"I",desc:"Wraps an AdapTableQL Scalar Expression"},AdaptableScope:{name:"AdaptableScope",kind:"A",desc:"Defines where a given Object / Module is active"},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 between local state & Team Share)",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"},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 (except 'applyState')",props:[{name:"adaptableId",kind:"s",desc:"Id of current Adaptable instance"},{name:"adaptableStateKey",kind:"s",desc:"State Key being used"},{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 defined in AG Grid GridOptions - ensure keys are the same (Note: AG Grid statusPanel has a 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}]},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",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"}]},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'"}]},AlertButton:{name:"AlertButton",kind:"I",desc:"Defines a button that appears in an Alert Form",props:[{name:"Action",kind:"u",desc:"Predefined Action(s) to trigger when button is clicked; but the implementation in `actionHandlers` property of Alert Options",isOpt:!0},{name:"ButtonStyle",kind:"R",desc:"Style for the Button",isOpt:!0,ref:"ButtonStyle"},{name:"Label",kind:"s",desc:"Label to show in the Button"},{name:"Tooltip",kind:"s",desc:"ToolTip to display",isOpt:!0}]},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:"The Alert Title Message to display",isOpt:!0},{name:"MessageText",kind:"s",desc:"Alert Message; if not provided AdapTable creates dynamically using Rule & Scope (Note: can be provided as a function in AlertOptions)",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:"AdaptableScope"}]},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:"gridDataChangedInfo",kind:"u",desc:"Grid Data change that might have triggered the Alert (i.e. RowAdded / RowRemoved)",isOpt:!0}]},AlertOptions:{name:"AlertOptions",kind:"I",desc:"Options related to Alerts in Adaptable.",props:[{name:"actionHandlers",kind:"u",desc:"Custom onClick Handlers for Buttons (displayed in Alert Forms)",isOpt:!0},{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:"dataChangeDetectionPolicy",kind:"'rawValue' | 'formattedValue'",desc:"Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data",isOpt:!0,gridInfo:"item",defVal:"'rawValue'"},{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:"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 cell using `MessageType` property of triggering Alert Definition",isOpt:!0},{name:"HighlightRow",kind:"u",desc:"Colours updated cell using `MessageType` property 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, it 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:"Predefined Configuration 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:"Predefined Configuration 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}]},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"}]},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}]},BadgeStyleDefinition:{name:"BadgeStyleDefinition",kind:"I",desc:"Defines a Badge Style",props:[{name:"Icon",kind:"u",desc:"Icon to display in Badge",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"},BaseContext:{name:"BaseContext",kind:"I",desc:"Base Context used in many functions provided by developers and invoked as needed by AdapTable",props:[{name:"adaptableApi",kind:"R",desc:"The Adaptable Api - included as a convenience",ref:"unknown"}]},BulkUpdatePermittedValues:{name:"BulkUpdatePermittedValues",kind:"I",desc:"User to define permitted values when updating cells via bulk update",props:[{name:"values",kind:"u",desc:"Function returning Values to display in Bulk Update Wizard - can be async"}]},BulkUpdatePermittedValuesContext:{name:"BulkUpdatePermittedValuesContext",kind:"I",desc:"Context used when getting BulkUpdatePermittedValues via a function",props:[{name:"gridCells",kind:"u",desc:"Cells which will be modified in the Bulk Update"}]},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:"Predefined Configuration for Calculated Column Module",props:[{name:"CalculatedColumns",kind:"a",desc:"Collection of Calculated Columns",isOpt:!0}]},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:"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"},{name:"timeout",kind:"n",desc:"Time after which Cell should be unhighlighted",isOpt:!0}]},CellSummaryOperation:{name:"CellSummaryOperation",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"}]},CellSummaryOperationContext:{name:"CellSummaryOperationContext",kind:"I",desc:"Context provided to a custom Cell Summary Operation function",props:[{name:"allValues",kind:"a",desc:"All values of selected cells"},{name:"distinctCount",kind:"n",desc:"Count of currently selected cells"},{name:"numericColumns",kind:"a",desc:"Any numeric columns in current selection"},{name:"numericValues",kind:"a",desc:"Any numeric values in current selection"},{name:"selectedCellInfo",kind:"u",desc:"Currently selected cells"}]},CellSummmary:{name:"CellSummmary",kind:"I",desc:"Defines the Summary operations provides for Selected 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"},ChartContainer:{name:"ChartContainer",kind:"I",desc:"Describes Location to display an AG Grid Chart",props:[{name:"chartsDisplay",kind:"'single' | 'multiple'",desc:"Whether one 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 the 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:"saveStrategy",kind:"'auto' | 'manual' | 'none'",desc:"Behaviour for saving Charts: automatic, manual (via popup) or none",isOpt:!0,noCode:"item",defVal:"'none'"}]},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}]},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 or Column name"},{name:"MinValue",kind:"number | string",desc:"Start value - either numeric or Column name"}]},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:"Predicate",kind:"R",desc:"`AdaptablePredicate` which AdaptableQL will evaluate when the Filter is run",ref:"ColumnFilterPredicate"}]},ColumnFilterDef:{name:"ColumnFilterDef",kind:"I",desc:"Column Filter Definition for a specific Column"},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"}]},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"}]},ColumnOptions:{name:"ColumnOptions",kind:"I",desc:"Options related to managing Columns in Adaptable.",props:[{name:"autoOrderGroupedColumns",kind:"b",desc:"Order Grouped Column automatically, deriving from Adaptable State if available (CustomSort or Layout ColumnSort)",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"columnFriendlyName",kind:"f",desc:"Provide an alternative Friendly Name for a Column",isOpt:!0,defVal:"undefined"},{name:"columnTypes",kind:"a",desc:"Optional list of Column Types - used primarily for Calculated and FreeText Columns",isOpt:!0,defVal:"undefined"},{name:"hideColumnWhenGrouped",kind:"b",desc:"",isOpt:!0},{name:"showMissingColumnsWarning",kind:"b",desc:"Show warning if AdapTable cannot find a column",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"}]},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'"}]},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:"AdaptableScope"}]},ConfigState:{name:"ConfigState",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 Predefined Config while keeping others unchanged",isOpt:!0}]},ContactColumn:{name:"ContactColumn",kind:"I",desc:"A (String) Column which will be defined as an FDC3 Contact columnId and at least one other property is required",props:[{name:"emailColumnId",kind:"s",desc:"Column which holds the email address of a Contact",isOpt:!0},{name:"fds_idColumnId",kind:"s",desc:"Column which holds an FDS_ID value a Contact",isOpt:!0},{name:"intents",kind:"R",desc:"Contact-related FDC3 Intents; can be: `StartCall` `StartChat` `ViewContact`",isOpt:!0,ref:"ContactIntents"}]},ContactContext:{name:"ContactContext",kind:"I",desc:"FDC3 Context to define a Contact",props:[{name:"id",kind:"u",desc:"The Contact data: email, FDS_ID",isOpt:!0},{name:"name",kind:"s",desc:"Free text name of Contact",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `contact`"}]},ContactIntent:{name:"ContactIntent",kind:"A",desc:"FDC3 Intents available to a Contact Column"},ContactIntents:{name:"ContactIntents",kind:"A",desc:"All available Contact Intents"},ContactListContext:{name:"ContactListContext",kind:"I",desc:"FDC3 Context to define a list of Contacts",props:[{name:"contacts",kind:"a",desc:"The array of Contacts",isOpt:!0},{name:"id",kind:"u",desc:"Optional Id",isOpt:!0},{name:"name",kind:"s",desc:"Free text name of Contact list",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `contactList`"}]},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:"agGridContainerWaitTimeout",kind:"n",desc:"How long AdapTable waits for AG Grid before giving up connecting to it",isOpt:!0,gridInfo:"item",defVal:"60s"},{name:"alertContainer",kind:"u",desc:"Div to show Alerts - string Id or HTMLElement",isOpt:!0,gridInfo:"item",defVal:"undefined"},{name:"modalContainer",kind:"u",desc:"Name of div where modals appear (if null, will be centre of page)",isOpt:!0,gridInfo:"item",defVal:"undefined"},{name:"systemStatusContainer",kind:"u",desc:"Div to show System Status messages - string Id or HTMLElement",isOpt:!0,gridInfo:"item",defVal:"undefined"}]},ContextData:{name:"ContextData",kind:"A",desc:"Data used in FDC3 Contexts"},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"}]},CountryColumn:{name:"CountryColumn",kind:"I",desc:"A (String) Column which will be defined as an FDC3 Country",props:[{name:"intents",kind:"R",desc:"Country-related FDC3 Intents; can only be: `ViewChart`",isOpt:!0,ref:"CountryIntents"},{name:"isoalpha2ColumnId",kind:"s",desc:"Column which contains the ISOALPHA2 Standard",isOpt:!0},{name:"isoalpha3ColumnId",kind:"s",desc:"Column which contains the ISOALPHA3 Standard",isOpt:!0}]},CountryContext:{name:"CountryContext",kind:"I",desc:"FDC3 Context to define a Country",props:[{name:"id",kind:"u",desc:"The Country data: ISOALPHA2, ISOALPHA3",isOpt:!0},{name:"name",kind:"s",desc:"Free text name of Country",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `country`"}]},CountryIntent:{name:"CountryIntent",kind:"A",desc:"FDC3 Intents available to a Country Column"},CountryIntents:{name:"CountryIntents",kind:"A",desc:"All available Country Intents"},CreateActionRowFormContext:{name:"CreateActionRowFormContext",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"}]},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}]},CustomDisplayFormatter:{name:"CustomDisplayFormatter",kind:"I",desc:"Provides Custom Display Formats",props:[{name:"handler",kind:"f",desc:"Function used to perform the Custom Display Format"},{name:"id",kind:"s",desc:"Id of the Formatted"},{name:"label",kind:"s",desc:"Description",isOpt:!0},{name:"scope",kind:"R",desc:"Where the Custom Display Format can be applied",ref:"AdaptableScope"}]},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"}]},CustomFDC3Column:{name:"CustomFDC3Column",kind:"I",desc:"A Column which will be defined as Custom FDC3 (can be any datatype)",props:[{name:"createContext",kind:"u",desc:"Function which creates FDC3 context for the current column and row"},{name:"intents",kind:"a",desc:"Custom FDC3 Intents available to the column"}]},CustomFDC3Context:{name:"CustomFDC3Context",kind:"I",desc:"Context used when providing Custom FDC3 content"},CustomFDC3Intent:{name:"CustomFDC3Intent",kind:"A",desc:"Custom FDC3 Intent - just a string value"},CustomQueryVariableContext:{name:"CustomQueryVariableContext",kind:"I",desc:"Context passed when evaluating `ExpressionOptions.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:"Current Div Element",ref:"unknown"},{name:"visible",kind:"b",desc:"Whether Tool Panel is currently visible"}]},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 or React) 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}]},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:"a",desc:"Order of values by which Column will be sorted",isOpt:!0}]},CustomSortPermittedValues:{name:"CustomSortPermittedValues",kind:"I",desc:"Custom column values for Custom Sort",props:[{name:"values",kind:"u",desc:"Function returning Values to display in Custom Sort Wizard - can be async"}]},CustomSortState:{name:"CustomSortState",kind:"I",desc:"Predefined Configuration 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 or React) 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:"showCloseButton",kind:"b",desc:"Shows a Close button at the bottom of Custom Toolbar",isOpt:!0},{name:"showConfigureButton",kind:"b",desc:"Shows a Configure (wrench) button which when clicked fires `CustomToolbarConfigured` event",isOpt:!0},{name:"title",kind:"s",desc:"Title to display in Toolbar; if unset or empty string, nothing will show",isOpt:!0},{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 or React) 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}]},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"}]},DashboardOptions:{name:"DashboardOptions",kind:"I",desc:"Options related to the Dashboard in Adaptable.",props:[{name:"buttonsLocation",kind:"'left' | 'right'",desc:"Where in Dashboard to display Module and Custom Buttons",isOpt:!0,noCode:"item",defVal:"'right'"},{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:"Predefined Configuration 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:"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"}]},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:"dataChangedInfo",kind:"u",desc:"The initial data change"},{name:"isGroupNode",kind:"b",desc:"If the change references a group node."},{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:"Whether data change history should be 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)"}]},DataFormatType:{name:"DataFormatType",kind:"A",desc:"Format of exported Data - 'rawValue' or 'formattedValue'"},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"}]},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:"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'"},{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",props:[{name:"adaptableId",kind:"s",desc:"Id of current AdapTable instance"},{name:"userName",kind:"s",desc:"Name of Current User"}]},DetailInitContext:{name:"DetailInitContext",kind:"I",desc:"Context passed to Detail Grids when using Master Detail Plugin"},EditActionRowFormContext:{name:"EditActionRowFormContext",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"}]},EditLookUpContext:{name:"EditLookUpContext",kind:"I",desc:"Context used when getting EditLookUpPermittedValues via a function",props:[{name:"gridCell",kind:"u",desc:"Cell being edited",isOpt:!0}]},EditLookUpPermittedValues:{name:"EditLookUpPermittedValues",kind:"I",desc:"Used to define permitted values for inline column editor",props:[{name:"values",kind:"u",desc:"Values to display in Edit Look Up: either hardcoded list or a function that returns a list",isOpt:!0}]},EditOptions:{name:"EditOptions",kind:"I",desc:"Options related to Editing in AdapTable - includes Server Validation, Smart Edit Operations and Row Forms",props:[{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:"smartEditCustomOperations",kind:"u",desc:"Custom Operations to use in Smart Edit",isOpt:!0},{name:"validateOnServer",kind:"u",desc:"Function to validate AdapTable data edits on Server",isOpt:!0}]},EntitlementContext:{name:"EntitlementContext",kind:"I",desc:"Provided to moduleEntitlements function when setting Entitlements programatically",props:[{name:"adaptableId",kind:"s",desc:"Id of current AdapTable instance"},{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"},{name:"userName",kind:"s",desc:"Name of Current User"}]},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 `AdaptableQLOptions.evaluateExpressionExternally()`",props:[{name:"expression",kind:"s",desc:"Expression to evaluate",isOpt:!0},{name:"module",kind:"R",desc:"Module where Expression is being evaluated",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}]},ExportableColumnContext:{name:"ExportableColumnContext",kind:"I",desc:"Context used for setting whether a Column is exportable",props:[{name:"adaptableColumn",kind:"R",desc:"Column to be exported",ref:"AdaptableReportColumn"}]},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:"ReportData"}]},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:"customDestinations",kind:"a",desc:"User-provided Report Destinations (in addition to those shipped in AdapTable)",isOpt:!0},{name:"exportDateFormat",kind:"s",desc:"Optional custom format for Date columns when exporting",isOpt:!0,gridInfo:"item",defVal:"undefined"},{name:"exportFormatType",kind:"u",desc:"Format of exported values; can be set either for whole grid or specifically for each column type",isOpt:!0,defVal:"rawValue"},{name:"isColumnExportable",kind:"f",desc:"Whether a Column is included in System Reports and available in UI for selection",isOpt:!0,defVal:"true"},{name:"preProcessExport",kind:"u",desc:"Function invoked when a Report is run, enabling users to preload the data before it is exported",isOpt:!0},{name:"serverReports",kind:"a",desc:"Reports generated entirely by users (and not AdapTable)",isOpt:!0},{name:"systemExportDestinations",kind:"R",desc:"Export destinations to use; leave blank for all, empty array for none",isOpt:!0,gridInfo:"item",defVal:"'Excel', 'CSV', 'Clipboard', 'JSON, 'Table'",ref:"SystemExportDestinations"},{name:"systemReportNames",kind:"R",desc:"System Reports to use; leave blank for all, empty array for none",isOpt:!0,gridInfo:"item",defVal:"'Visual Data', 'All Data', 'Current Data', 'Selected Cells', 'Selected Rows',",ref:"SystemReportNames"}]},ExportState:{name:"ExportState",kind:"I",desc:"Predefined Configuration for Export Module",props:[{name:"CurrentDestination",kind:"u",desc:"Currently selected Report Destination in Export Toolbar & Tool Panel",isOpt:!0},{name:"CurrentReport",kind:"s",desc:"Currently selected Report - in Export Toolbar & Tool Panel",isOpt:!0},{name:"Reports",kind:"a",desc:"User-created Reports; each has Name and Row and Column Scope",isOpt:!0}]},ExpressionContext:{name:"ExpressionContext",kind:"I",desc:"Provides context to an Expression Function, including current row node and AdaptableApi",props:[{name:"evaluateCustomQueryVariable",kind:"u",desc:"Evaluate custom variables"},{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:"namedQueryCallStack",kind:"a",desc:"All Named Query evaluations: tracked in order to detect circular dependencies",isOpt:!0},{name:"node",kind:"u",desc:"Current AG Grid Row Node being evaluated"},{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:"unknown"},{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 eagerly (without handling inner AST nodes)",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"},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 using AdapTableQL",props:[{name:"customBooleanFunctions",kind:"u",desc:"Custom Boolean Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (none)"},{name:"customQueryVariables",kind:"u",desc:"Custom query variables allow 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. Variables are 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:"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)"}]},FDC3Column:{name:"FDC3Column",kind:"I",desc:"An FDC3 Column - will raise FDC3 intents and broadcast FDC3 messages",props:[{name:"broadcastContextMenuLabel",kind:"u",desc:"Label to display in Broadcast Context Menu Item",isOpt:!0},{name:"columnId",kind:"s",desc:"Id of Column defined as FDC3"},{name:"intentContextMenuLabel",kind:"u",desc:"Label to display in Intent Context Menu Item",isOpt:!0},{name:"intentIcon",kind:"u",desc:"Returns a custom icon to display in the Raise Intent Context Menu Item;",isOpt:!0},{name:"intents",kind:"a",desc:"FDC3 intents which the Column can raise",isOpt:!0},{name:"nameColumnId",kind:"s",desc:"If provided, will supply `name` property in FDC3 message",isOpt:!0},{name:"raiseIntentForContextMenuLabel",kind:"u",desc:"Label to display in RaiseIntentForContext Context Menu Item",isOpt:!0},{name:"showBroadcastContextMenu",kind:"b",desc:"Should Column display a 'Broadcast' context menu item",isOpt:!0},{name:"showRaiseIntentForContextMenu",kind:"b",desc:"Should Column display a 'Raise Intent for Context' context menu item",isOpt:!0}]},FDC3Context:{name:"FDC3Context",kind:"I",desc:"General-purpose context type, as defined by FDC3",props:[{name:"(indexer)",kind:"i",desc:"Custom properties and metadata. This can be extended in specific context object."},{name:"id",kind:"{\n        [key: string]: string | undefined;\n    }",desc:"Optional map of any equivalent identifiers for the context type, e.g. ISIN, CUSIP, etc. for Instrument",isOpt:!0},{name:"name",kind:"s",desc:"Name of the context data (optional) - a text string that describes the data being sent",isOpt:!0},{name:"type",kind:"R",desc:"Type of FDC3Context that uniquely identifies it, e.g. "instrument"; used to refer to the accepted context(s) when declaring intents",ref:"FDC3ContextType"}]},FDC3ContextType:{name:"FDC3ContextType",kind:"A",desc:"Defines which FDC3 context is being used"},FDC3Intent:{name:"FDC3Intent",kind:"A",desc:"Full list of FDC3 Intents available - each FDC3 Column can use a subset"},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:"'Always' | 'Never' | 'Throttle'",desc:"When to re-apply Filters: 'Always', 'Never' or 'Throttle'"},{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 Filtering in AdapTable",props:[{name:"autoApplyFilter",kind:"b",desc:"Apply selected filters (in Filter Form or Quick Filter Bar) as soon as they are clicked; if false an Apply Filter button is displayed",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"clearFiltersOnStartUp",kind:"b",desc:"Clears saved Column Filters when AdapTable loads",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"defaultDateColumnFilter",kind:"u",desc:"Default filter type for date Columns",isOpt:!0,gridInfo:"item",defVal:"On"},{name:"defaultFilterFormTab",kind:"'Values' | 'Predicates'",desc:"Whether to open the Filter Form on the Values or Predicates tab",isOpt:!0,gridInfo:"item",defVal:"'Values'"},{name:"defaultNumericColumnFilter",kind:"u",desc:"Default filter type for numeric Columns",isOpt:!0,gridInfo:"item",defVal:"Equals"},{name:"defaultStringColumnFilter",kind:"u",desc:"Default filter type for string Columns",isOpt:!0,gridInfo:"item",defVal:"Contains"},{name:"enableFilterOnSpecialColumns",kind:"b",desc:"Allows filtering on Calculated & FreeText columns",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"filterActionOnExternalDataChange",kind:"R",desc:"When to re-filter grid after data ticks: 'Always', 'Never' or 'Throttle' (which requires a 'ThrottleDelay')",isOpt:!0,defVal:"'Never'",ref:"FilterActionOnDataChange"},{name:"filterActionOnUserDataChange",kind:"R",desc:"When to re-filter grid after user edits data: 'Always', 'Never' or 'Throttle' (which requires a 'ThrottleDelay')",isOpt:!0,defVal:"'Always'",ref:"FilterActionOnDataChange"},{name:"hideQuickFilterDropdown",kind:"u",desc:"Hides the Dropdown in Quick Filter Bar for a given Column",isOpt:!0,defVal:"undefined"},{name:"hideQuickFilterInput",kind:"u",desc:"Hides the 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:"maxFilterValuesToDisplay",kind:"n",desc:"Distinct column items to display in Filter Form; useful with large datasource (though AdapTable offers virtualisation)",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"2,000"},{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:"Sets a height for Quick Filter Bar (if not provided AG Grid's default is used)",isOpt:!0,gridInfo:"item",defVal:"null"},{name:"quickFilterTrigger",kind:"'mouseenter' | 'click'",desc:"Whether to open Quick Filter dropdown with mouse hover or click",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"'mouseenter'"},{name:"quickFilterValuesTrigger",kind:"'mouseenter' | 'click'",desc:"Whether to open Quick Filter Values dropdown with mouse hover or click",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"'mouseenter'"},{name:"quickFilterValuesWidth",kind:"'auto' | number",desc:"Width of Values popup in Filter Bar - can be set width or same size as Column",isOpt:!0,defVal:"'180'"},{name:"quickFilterWildcards",kind:"u",desc:"Shortcut Keys to activate a Quick Filter Predicate",isOpt:!0},{name:"showClearFilterButton",kind:"b",desc:"Display Clear Filter button in Toolbar and Tool Panel",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"showDistinctFilteredValuesOnly",kind:"b",desc:"Display only currently filtered distinct values in Filter controls",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"showQuickFilter",kind:"b",desc:"Whether to display Quick Filter Bar between Column Header and the Grid (provided its been setup)",isOpt:!0,noCode:"item",defVal:"true"},{name:"showSuspendFilterButton",kind:"b",desc:"Display Suspend / Unsuspend Button in Toolbar and Tool Panel",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"showValuesCount",kind:"u",desc:"Show the count of each distinct item for given column in the Values (IN) Filter",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"sortColumnValuesInFilter",kind:"b",desc:"Whether column values in filter dropdown should apply column's current Sort Order for the column",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"useAdaptableFilterForm",kind:"boolean | string[]",desc:"Uses Adaptable's Filter Form in Column Menu for all columns if 'true' (the default) or those listed, in preference to AG Grid's Filter Form",isOpt:!0,noCode:"item",defVal:"true"},{name:"useAdaptableQuickFilter",kind:"boolean | string[]",desc:"Use Adaptable's Quick Filter Bar for all columns if 'true' (the default) or those listed, in preference to AG Grid's Floating Filter",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"useAgGridFilterFormStyle",kind:"b",desc:"Styles Adaptable Filter Form to match AG Grid's styling (if using Balham theme)",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"}]},FilterPermittedValues:{name:"FilterPermittedValues",kind:"I",desc:"Used to define values inside the Filter Bar and Filter Form",props:[{name:"suppressFilterSearchBar",kind:"b",desc:"Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed",isOpt:!0,defVal:"false"},{name:"values",kind:"u",desc:"Function returning Values to display in 'IN' Filter - can be async"}]},FilterPermittedValuesContext:{name:"FilterPermittedValuesContext",kind:"I",desc:"Context used when getting FilterPermittedValues via a function",props:[{name:"searchFilter",kind:"s",desc:"A search string"}]},FinancePluginOptions:{name:"FinancePluginOptions",kind:"I",desc:"Options required for when using the Finance plugin",props:[{name:"autoHandleFDC3AdaptableMessages",kind:"b",desc:"Whether `FDC3MessageSent` Adaptable events should be automatically delegated to the FDC3 API (either via `fdc3.raiseIntent(...)` or `fdc3.broadcast(...)` )",isOpt:!0,defVal:"TRUE"},{name:"availableFDC3Intents",kind:"u",desc:"Intents to which to subscribe.",isOpt:!0},{name:"fdc3Columns",kind:"u",desc:"Columns to be defined as FDC3-related",isOpt:!0},{name:"onFDC3Context",kind:"u",desc:"Called when a context changes.",isOpt:!0},{name:"onFDC3Intent",kind:"u",desc:"Called when an intent from `availableIntents` is raised.",isOpt:!0}]},FinsemblePluginOptions:{name:"FinsemblePluginOptions",kind:"I",desc:"Options required for when using the Finsemble plugin",props:[{name:"applicationName",kind:"s",desc:"Application name - used to identify the application in Finsemble console",isOpt:!0},{name:"showAdaptableAlertsAsNotifications",kind:"b",desc:"Should Adaptable's Alerts appear as Finsemble Notifications",isOpt:!0,defVal:"true"},{name:"stateOptions",kind:"R",desc:"Options for managing Adaptable State with Finsemble State",isOpt:!0,ref:"FinsemblePluginStateOptions"}]},FinsemblePluginStateOptions:{name:"FinsemblePluginStateOptions",kind:"I",desc:"Options for managing state while using Finsemble",props:[{name:"key",kind:"s",desc:"Key used to persist/load AdapTable State in Finsemble"},{name:"persistInFinsemble",kind:"b",desc:"Whether to persist AdapTable State inside Finsemble"},{name:"topic",kind:"s",desc:"Topic used to persist/load AdapTable State in Finsemble"}]},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:"Where Flashing Cell can display: Column[s] or DataType[s]",ref:"AdaptableScope"},{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:"'row' | 'cell'",desc:"Should a cell or whole row flash",isOpt:!0,defVal:"'cell'"},{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:"Predefined Configuration for Flashing Cell module",props:[{name:"FlashingCellDefinitions",kind:"a",desc:"Flashing Cell Definitions - will colour cells/rows when rule is met",isOpt:!0}]},FormatColumn:{name:"FormatColumn",kind:"I",desc:"Object used in Format Column function",props:[{name:"CellAlignment",kind:"'Left' | 'Right' | 'Center'",desc:"Aligns cells 'Left' or 'Right' or 'Center'",isOpt:!0},{name:"ColumnStyle",kind:"R",desc:"",isOpt:!0,ref:"unknown"},{name:"DisplayFormat",kind:"R",desc:"Display Format to apply to Column can be Numeric, String or Date",isOpt:!0,ref:"AdaptableFormat"},{name:"IncludeGroupedRows",kind:"b",desc:"Whether to Format the Column in Grouped Rows",isOpt:!0,defVal:"false"},{name:"Rule",kind:"R",desc:"Rule used to decide whether to apply the 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 all Columns of given DataType",ref:"AdaptableScope"},{name:"Style",kind:"R",desc:"Style to apply",isOpt:!0,ref:"AdaptableStyle"}]},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:"Predefined Configuration for Format Column Module",props:[{name:"FormatColumns",kind:"a",desc:"Collection of Format Columns",isOpt:!0}]},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:"Predefined Configuration 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"}]},GeneralOptions:{name:"GeneralOptions",kind:"I",desc:"General options for configuring AdapTable including managing Primary Keys",props:[{name:"alternativeModuleNames",kind:"a",desc:"Alternative names to use for Adaptable Modules in toolbars and menus",isOpt:!0,defVal:"null"},{name:"cellSummaryOperations",kind:"u",desc:"Custom Cell Summary Operations to add to shipped set",isOpt:!0},{name:"customSortComparers",kind:"u",desc:"CustomSort column comparer functions",isOpt:!0},{name:"dataSets",kind:"a",desc:"Collection of Data Sets to provide Data to AdapTable",isOpt:!0},{name:"disableDeleteConfirmation",kind:"b",desc:"Hides confirmation dialog which displays whenever an AdaptableObject is deleted",isOpt:!0,noCode:"item",defVal:"false"},{name:"englishVariant",kind:"'GB' | 'US'",desc:"English variant to use in UI labels",isOpt:!0,gridInfo:"item",defVal:"'GB'"},{name:"holidays",kind:"R",desc:"Holidays - used to determine Working Days",isOpt:!0,defVal:"null",ref:"Holidays"},{name:"restoreUngroupedColumns",kind:"b",desc:"Places ungrouped columns at pre-grouping indexed position",isOpt:!0,noCode:"item",defVal:"false"},{name:"showGroupingTotalsAsHeader",kind:"b",desc:"Show aggregated totals row at top of Grid when row grouping",isOpt:!0,gridInfo:"item",defVal:"false"},{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:"unbalancedGroupsKey",kind:"u",desc:"Value to use for 'Unbalanced Groups' (string columns)",isOpt:!0}]},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"}]},Glue42PluginOptions:{name:"Glue42PluginOptions",kind:"I",desc:"Options for using the Glue42 Desktop plugin",props:[{name:"gatewayURL",kind:"s",desc:"Gateway URL",isOpt:!0},{name:"glue",kind:"u",desc:"Main Glue desktop object",isOpt:!0},{name:"glue42Office",kind:"u",desc:"Main Glue42 Office object",isOpt:!0},{name:"password",kind:"s",desc:"Password to use to login to Glue42; typically sourced from PC Credentials",isOpt:!0},{name:"username",kind:"s",desc:"UserName to use to login to Glue42; typically sourced from PC Credentials",isOpt:!0}]},Glue42Report:{name:"Glue42Report",kind:"I",desc:"Glue42 report - currently just contains name of Report",props:[{name:"ReportName",kind:"s",desc:"The Report's name (as exists in Export State)"}]},Glue42Schedule:{name:"Glue42Schedule",kind:"I",desc:"Defines Glue42 Scheduled Report; used in Schedule Module (where State is stored)",props:[{name:"Glue42Report",kind:"R",desc:"The Glue42 Report which will be sent when the Schedule runs",ref:"Glue42Report"},{name:"Transmission",kind:"'Snapshot' | 'Live Data'",desc:"Whether its a one-off or 'streaming' transmission"}]},Glue42State:{name:"Glue42State",kind:"I",desc:"Internal State used by AdapTable for managing the Glue42 plugin",props:[{name:"CurrentLiveGlue42Report",kind:"R",desc:"Which Glue42 Report is currently live",isOpt:!0,ref:"Glue42Report"},{name:"Glue42LoginErrorMessage",kind:"s",desc:"Message to show when Login Fails",isOpt:!0},{name:"IsGlue42Available",kind:"b",desc:"Whether Glue42 is available",isOpt:!0},{name:"IsGlue42Running",kind:"b",desc:"Whether Glue42 is running",isOpt:!0}]},Glue42WebPluginOptions:{name:"Glue42WebPluginOptions",kind:"I",desc:"Options for using the Glue42 Web plugin",props:[{name:"showAdaptableAlertsAsNotifications",kind:"b",desc:"Converts AdapTable Alerts configured to display in popup as Glue42 Notifications",isOpt:!0,defVal:"true"}]},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:"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:"Actual raw value of cell"},{name:"rowNode",kind:"u",desc:"AG Grid Row Node that holds the cell"}]},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}]},GridInfoSection:{name:"GridInfoSection",kind:"A",desc:"Tabs available in the Grid Info Settings Panel"},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}]},HolidayContext:{name:"HolidayContext",kind:"I",desc:"Context used for isHoliday function",props:[{name:"adaptableId",kind:"s",desc:"Id of current AdapTable instance"},{name:"dateToCheck",kind:"d",desc:"Date being checked"},{name:"userName",kind:"s",desc:"Name of Current User"}]},Holidays:{name:"Holidays",kind:"I",desc:"Holidays - can be list or function (latter takes preference)",props:[{name:"isHoliday",kind:"f",desc:"Function which returns true if given date is a holiday",isOpt:!0},{name:"list",kind:"a",desc:"Holidays provided as valid ISO date strings",isOpt:!0}]},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"},InstrumentColumn:{name:"InstrumentColumn",kind:"I",desc:"A Column which will be defined as an FDC3 Instrument",props:[{name:"bbgColumnId",kind:"s",desc:"Column which holds a Bloomberg Ticker value as instrument data",isOpt:!0},{name:"cusipColumnId",kind:"s",desc:"Column which holds a CUSIP value as instrument data",isOpt:!0},{name:"figiColumnId",kind:"s",desc:"Column which holds a [FIGI](https://www.openfigi.com/about/figi) value as instrument data",isOpt:!0},{name:"intents",kind:"R",desc:"Instrument-related FDC3 Intents; can be: `ViewChart` `ViewQuote` `ViewNews` `ViewAnalysis` `ViewInstrument`",isOpt:!0,ref:"InstrumentIntents"},{name:"isinColumnId",kind:"s",desc:"Column which holds an ISIN value as instrument data",isOpt:!0},{name:"permidColumnId",kind:"s",desc:"Column which holds a PERMID value as instrument data",isOpt:!0},{name:"ricColumnId",kind:"s",desc:"Column which holds a Reuters Instrument Code value as instrument data",isOpt:!0},{name:"sedolColumnId",kind:"s",desc:"Column which holds a SEDOL value as instrument data",isOpt:!0},{name:"tickerColumnId",kind:"s",desc:"Column which holds a ticker value as instrument data",isOpt:!0}]},InstrumentContext:{name:"InstrumentContext",kind:"I",desc:"FDC3 Context to define a financial Instrument",props:[{name:"id",kind:"u",desc:"Instrument data: ticker, ISIN, CUSIP, SEDOL, RIC, BBG, PERMID, FIGI",isOpt:!0},{name:"name",kind:"s",desc:"Free text name of the Instrument",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `instrument`"}]},InstrumentIntent:{name:"InstrumentIntent",kind:"A",desc:"FDC3 Intents available to an Instrument Column"},InstrumentIntents:{name:"InstrumentIntents",kind:"A",desc:"All available Instrument Intents"},InstrumentListContext:{name:"InstrumentListContext",kind:"I",desc:"FDC3 Context to define an array of financial Instruments",props:[{name:"id",kind:"u",desc:"Optional Id",isOpt:!0},{name:"instruments",kind:"a",desc:"The instrument data",isOpt:!0},{name:"name",kind:"s",desc:"Free text name of list of Instruments (not set by AdapTable)",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `instrumentList`"}]},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"},Layout:{name:"Layout",kind:"I",desc:"Defines a Layout; contains everything required i.e. Columns, Sorts, Widths, Aggregations, Grouping & Pivoting",props:[{name:"AggregationColumns",kind:"R",desc:"Columns showing aggregated values in grouped 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:"unknown"},{name:"AutoSave",kind:"b",desc:"Whether Layout should automatically save or not - overrides `autoSaveLayouts` property in LayoutOptions",isOpt:!0},{name:"ColumnFilters",kind:"a",desc:"Collection of Column Filters.",isOpt:!0},{name:"ColumnHeadersMap",kind:"u",desc:"Set of custom header names for some (or all columns)",isOpt:!0},{name:"Columns",kind:"a",desc:"Which columns should be visible in the Layout and in which order"},{name:"ColumnSorts",kind:"a",desc:"Sorting to apply in the Layout",isOpt:!0},{name:"ColumnWidthMap",kind:"u",desc:"Set of widths for some (or all columns)",isOpt:!0},{name:"EnablePivot",kind:"b",desc:"Whether pivoting should be enabled in the Grid when this Layout loads",isOpt:!0},{name:"ExpandedRowGroupValues",kind:"a",desc:"Opened Row Groups - set if `displayRowGroups` in LayoutOptions is 'dynamic'",isOpt:!0},{name:"Name",kind:"s",desc:"Name of Layout as will appear in Layout toolbar and tool panel"},{name:"PinnedColumnsMap",kind:"{\n        [columnId: string]: 'left' | 'right';\n    }",desc:"Set of pinned Columns",isOpt:!0},{name:"PivotColumns",kind:"a",desc:"List of Columns which should be pivoted when grid is in pivot mode",isOpt:!0},{name:"RowGroupedColumns",kind:"a",desc:"Columns which are row-grouped when the Layout is applied",isOpt:!0},{name:"SuppressAggFuncInHeader",kind:"b",desc:"Whether to include the aggFunc name in the column header: e.g. 'sum(Bank Balance)' will just be 'Bank Balance'",isOpt:!0}]},LayoutAssociatedObject:{name:"LayoutAssociatedObject",kind:"A",desc:"Types of Adaptable Objects that can be associated with a Layout"},LayoutAvailableContext:{name:"LayoutAvailableContext",kind:"I",desc:"Context for `LayoutOptions.isObjectAvailableInLayout` functions",props:[{name:"adaptableObject",kind:"R",desc:"Object being checked",ref:"LayoutAssociatedObject"},{name:"layout",kind:"R",desc:"Current Layout",ref:"Layout"},{name:"module",kind:"R",desc:"Current Adaptable Module",ref:"AdaptableModule"}]},LayoutOptions:{name:"LayoutOptions",kind:"I",desc:"Options for configuring Layouts; these manage Column visibility, order, sorting, grouping and width",props:[{name:"autoSaveLayouts",kind:"b",desc:"Layouts save whenever Grid's column / sort info changes; if false, a Save button will display",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"autoSizeColumnsInLayout",kind:"b",desc:"Columns auto-size when Layout loads for first time",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"autoSizeColumnsInPivotLayout",kind:"b",desc:"Columns auto-size when Pivot Layout loads first time (overriding Layout width properties)",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"createDefaultLayout",kind:"b",desc:"Whether a "Default Layout" will be created in addition to Layouts provided in Config",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"displayRowGroups",kind:"'dynamic' | 'expanded' | 'closed'",desc:"Whether Row Groups display all as expanded, all as closed or dynamically (i.e. saved in Layout)",isOpt:!0,gridInfo:"item",defVal:"'closed'"},{name:"layoutTagOptions",kind:"R",desc:"Options for leveraging Object Tags to extend Layouts",isOpt:!0,ref:"unknown"},{name:"layoutViewOptions",kind:"R",desc:"Customize how Layouts are displayed in Settings Panel",isOpt:!0,ref:"LayoutViewOptions"},{name:"pivotPreviewColumns",kind:"u",desc:"Columns displayed in Table that opens when viewing contents of Pivot Cells",isOpt:!0}]},LayoutState:{name:"LayoutState",kind:"I",desc:"Predefined Configuration for the Layout Module",props:[{name:"CurrentLayout",kind:"s",desc:"Layout which will be loaded when AdapTable starts - must match `Name` property in Layout",isOpt:!0},{name:"Layouts",kind:"a",desc:"Collection of Layout objects - listed in Layout toolbar and Tool Panel",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"}]},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}]},MenuOptions:{name:"MenuOptions",kind:"I",desc:"Options for managing menus in AdapTable",props:[{name:"columnMenuItems",kind:"a",desc:"User-defined Menu Items to add to the Column Menu",isOpt:!0},{name:"columnMenuOrder",kind:"u",desc:"Order in which AG Grid, AdapTable and User Menu items will appear in Column Menu",isOpt:!0,gridInfo:"item",defVal:"'aggrid', 'adaptable', 'user'"},{name:"contextMenuItems",kind:"a",desc:"User-defined Menu Items to add to the Context Menu",isOpt:!0},{name:"contextMenuOrder",kind:"u",desc:"Order in which AG Grid, AdapTable and User Menu items will appear in Context Menu",isOpt:!0,gridInfo:"item",defVal:"'aggrid', 'adaptable', 'user'"},{name:"showAdaptableColumnMenu",kind:"u",desc:"Show Adaptable Column Menu (or specific items); can be boolean value or function invoked for each menu item",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"showAdaptableContextMenu",kind:"u",desc:"Show Adaptable Context Menu (or specific items); can be boolean value or function invoked for each menu item",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"showUngroupColumnMenuItem",kind:"b",desc:"Adds 'Ungroup' Column Menu item to a row grouped column",isOpt:!0,gridInfo:"item",defVal:"true"}]},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 ExpressionOptions.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 used in multiple AdapTable Modules",props:[{name:"Name",kind:"s",desc:"Name of the Query - how it will appear in Query dropdown"}]},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:"TOAST_POSITIONS"},{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 a number",isOpt:!0},{name:"Ceiling",kind:"b",desc:"Returns smallest integer  number",isOpt:!0},{name:"Content",kind:"string | number",desc:"Replaces cell value with supplied value",isOpt:!0},{name:"Floor",kind:"b",desc:"Returns largest intger  number",isOpt:!0},{name:"FractionDigits",kind:"n",desc:"Number of digits to show in fractions",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",isOpt:!0},{name:"IntegerSeparator",kind:"s",desc:"Separator to use in integers",isOpt:!0},{name:"Multiplier",kind:"n",desc:"Multiplier to use on the number",isOpt:!0},{name:"Parentheses",kind:"b",desc:"Shows negative numbers in parentheses",isOpt:!0},{name:"Prefix",kind:"s",desc:"Prefix to use before the number",isOpt:!0},{name:"Round",kind:"b",desc:"Rounds a Number",isOpt:!0},{name:"Suffix",kind:"s",desc:"Suffix to use after the number",isOpt:!0},{name:"Truncate",kind:"b",desc:"Truncates a number",isOpt:!0}]},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:"onFDC3MessageSent",kind:"f",desc:"Useful when you also use the finance plugin configured with fdc3 related columns - values in cells such columns can be broadcasted to fdc3, and this function will be called for broadcasting. It's your job to broadcast to the desired fdc3 channel",isOpt:!0},{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"},OrganizationColumn:{name:"OrganizationColumn",kind:"I",desc:"A (String) Column which will be defined as an FDC3 Organization",props:[{name:"fds_idColumnId",kind:"s",desc:"Column which contains an FDS_ID",isOpt:!0},{name:"intents",kind:"R",desc:"Organization-related FDC3 Intents; can be: `ViewNews` `ViewAnalysis`",isOpt:!0,ref:"unknown"},{name:"leiColumnId",kind:"s",desc:"Column which contains the LEI",isOpt:!0},{name:"permidColumnId",kind:"s",desc:"Column which contains a PermId",isOpt:!0}]},OrganizationContext:{name:"OrganizationContext",kind:"I",desc:"FDC3 Context to define an Organization",props:[{name:"id",kind:"u",desc:"The Organization data: LEI, PERMID, FDS_ID",isOpt:!0},{name:"name",kind:"s",desc:"Free text name of Organization",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `organization`"}]},OrganizationIntent:{name:"OrganizationIntent",kind:"A",desc:"FDC3 Intents available to an Organization Column"},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"}]},PermittedValues:{name:"PermittedValues",kind:"I",desc:"Permitted/possible values, when column values can be selected (e.g. sort, bulk-update)",props:[{name:"values",kind:"u",desc:"Values to display: either hardcoded list or a function that returns a list",isOpt:!0}]},PermittedValuesContext:{name:"PermittedValuesContext",kind:"I",desc:"Context used when getting PermittedValues via a function",props:[{name:"column",kind:"u",desc:"Column whose values are being displayed"}]},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"}]},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:"AdaptableScope"}]},PlusMinusState:{name:"PlusMinusState",kind:"I",desc:"Predefined Configuration for Plus Minus Module",props:[{name:"PlusMinusNudges",kind:"a",desc:"Array of Plus Minus Nudges",isOpt:!0}]},PortfolioContext:{name:"PortfolioContext",kind:"I",desc:"FDC3 Context to define a financial Portfolio (array of Positions)",props:[{name:"id",kind:"u",desc:"Optional Id",isOpt:!0},{name:"name",kind:"s",desc:"Free text name of portfolio",isOpt:!0},{name:"positions",kind:"a",desc:"The position data",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `portfolio`"}]},PositionColumn:{name:"PositionColumn",kind:"I",desc:"A (Numeric) Column which will be defined as an FDC3 Position",props:[{name:"instrumentColumnId",kind:"s",desc:"Column which contains the Instrument information of the FDC3 Message"},{name:"intents",kind:"R",desc:"Position-related FDC3 Intents; can be: `ViewChart` `ViewNews` `ViewAnalysis`",isOpt:!0,ref:"PositionIntents"}]},PositionContext:{name:"PositionContext",kind:"I",desc:"FDC3 Context to define a financial Position (requires an Instrument)",props:[{name:"holding",kind:"n",desc:"Holding in the Position (mandatory)"},{name:"id",kind:"u",desc:"Optional Id",isOpt:!0},{name:"instrument",kind:"R",desc:"The `InstrumentContext` of the relevant Instrument",ref:"InstrumentContext"},{name:"name",kind:"s",desc:"Free text name of Position",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `position`"}]},PositionIntent:{name:"PositionIntent",kind:"A",desc:"FDC3 Intents available to a Position Column"},PositionIntents:{name:"PositionIntents",kind:"A",desc:"All available Position Intents"},PredefinedConfig:{name:"PredefinedConfig",kind:"I",desc:"This is the main Predefined Config interface which developers will populate at design-time",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:"Supplies a 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:"ConditionalStyle",kind:"R",desc:"",isOpt:!0,ref:"unknown"},{name:"CustomSort",kind:"R",desc:"Supplies a 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:"Supplies a 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:"Supplies a 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:"Supplies a 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:"Supplies a collection of *Layout* objects to name and manage groups of column visibility, order and sorts.",isOpt:!0,ref:"LayoutState"},{name:"PlusMinus",kind:"R",desc:"Supplies a collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell",isOpt:!0,ref:"PlusMinusState"},{name:"Query",kind:"R",desc:"Named Queries available for use across multiple AdapTable Modules; and `CurrentQuery` - an Expression to run at start-up",isOpt:!0,ref:"QueryState"},{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:"Supplies a collection of *Schedule* objects",isOpt:!0,ref:"ScheduleState"},{name:"Shortcut",kind:"R",desc:"Supplies a 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:"Supplies a 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"}]},PredicateDefHandlerParams:{name:"PredicateDefHandlerParams",kind:"I",desc:"Object passed into an Adaptable Predicate Definition",props:[{name:"api",kind:"R",desc:"The Adaptable Api",ref:"unknown"},{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:"inputs",kind:"a",desc:"Any inputs required to perform evaluation"},{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:"value",kind:"u",desc:"Raw value in cell being evaluated"}]},PredicateOptions:{name:"PredicateOptions",kind:"I",desc:"Options for managing Adaptable Predicates using AdaptableQL",props:[{name:"systemAlertPredicates",kind:"u",desc:"Which System Alert Predicates are available",isOpt:!0},{name:"systemBadgeStylePredicates",kind:"u",desc:"Which System Badge Style Predicates are available",isOpt:!0},{name:"systemFilterPredicates",kind:"u",desc:"Which System Filter Predicates are available",isOpt:!0},{name:"systemFlashingCellPredicates",kind:"u",desc:"Which System Flashing Cell Predicates are available",isOpt:!0},{name:"systemFormatColumnPredicates",kind:"u",desc:"Which System Format Column Predicates are available",isOpt:!0}]},PreProcessExportContext:{name:"PreProcessExportContext",kind:"I",desc:"Context provided to `ExportOptions.processExport()` callback used when pre-processing Export",props:[{name:"getReportColumns",kind:"u",desc:"Returns Columns to export based on Report's `ReportColumnScope`"},{name:"getReportRowData",kind:"u",desc:"Returns row data which would typically be exported based on the Report's `ReportRowScope`"},{name:"report",kind:"R",desc:"Report being exported",ref:"Report"}]},QueryableColumnContext:{name:"QueryableColumnContext",kind:"I",desc:"Context passed when evaluating Queryable Columns",props:[{name:"adaptableColumn",kind:"R",desc:"Basic Column Info - just ColumnId, DataType and FriendlyName",ref:"AdaptableColumnBase"}]},QueryState:{name:"QueryState",kind:"I",desc:"Predefined Configuration for Query Module",props:[{name:"CurrentQuery",kind:"s",desc:"Expression used for the Query currently being run",isOpt:!0},{name:"NamedQueries",kind:"a",desc:"Named Queries - can be referenced in other Expressions",isOpt:!0}]},QuickSearchState:{name:"QuickSearchState",kind:"I",desc:"Predefined Configuration for Quick Search Module",props:[{name:"QuickSearchText",kind:"s",desc:"Last Quick Search that was run (and will run again at start up)",isOpt:!0},{name:"Style",kind:"R",desc:"Style to use to highlight matching cells - uses common `AdaptableStyle` object",isOpt:!0,ref:"AdaptableStyle"}]},RaiseFDC3IntentContext:{name:"RaiseFDC3IntentContext",kind:"I",desc:"Context passed into Raise FDC3 Intent functions (e.g. get label)",props:[{name:"intent",kind:"u",desc:"FDC3 Intent that was raised"}]},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:"u",desc:"Name of Report"},{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', 'SelectedCellRows', 'SelectedRows', 'ExpressionRows'",ref:"ReportRowScope"},{name:"Scope",kind:"R",desc:"Columns Scope; only required if `ReportColumnScope` is 'ScopeColumns'",isOpt:!0,ref:"AdaptableScope"}]},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:"report",kind:"R",desc:"Definition of Report being Run",ref:"Report"},{name:"reportData",kind:"R",desc:"Data being exported in the Report",ref:"ReportData"}]},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:"rows",kind:"u",desc:"Row Data in the Report"}]},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:"'Excel' | 'CSV' | 'Clipboard' | 'JSON' | string",desc:"Where report data will be exported"},{name:"ExportDestinationData",kind:"R",desc:"Additional data for a Custom Destination produced by a Dynamic Form",isOpt:!0,ref:"AdaptableFormData"},{name:"ReportName",kind:"s",desc:"Name of Report to run on Schedule"}]},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 the highlight is removed",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}]},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}]},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:"Predefined Configuration for the Schedule Module",props:[{name:"Glue42Schedules",kind:"a",desc:"Schedules connected to Glue42 exports - available if Glue42 plugin is running",isOpt:!0},{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}]},SearchOptions:{name:"SearchOptions",kind:"I",desc:"Search options section of Adaptable Options; includes options for running some (or all) search functions on the server",props:[{name:"clearSearchesOnStartUp",kind:"b",desc:"Clears saved searches when AdapTable loads",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"excludeColumnFromQuickSearch",kind:"u",desc:"Function enabling specific Columns to be excluded from Quick Search",isOpt:!0,defVal:"undefined"},{name:"filterResultsAfterQuickSearch",kind:"b",desc:"Filters the quick search results so only matching rows are displayed",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'"},{name:"runQuickSearchOnRowGroups",kind:"b",desc:"Include Aggregrated Columns in Grouped Rows when Quick Searching (highlight only)",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"}]},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:"Describes which Rows are currently selected in AdapTable",props:[{name:"gridRows",kind:"u",desc:"Array of Grid Rows containing full information about a row in AdapTable"}]},ServerReport:{name:"ServerReport",kind:"I",desc:"Defines a Report where all the data is provided entirely by the user",props:[{name:"name",kind:"s",desc:"Name of the Report"},{name:"onRunReport",kind:"f",desc:"Function invoked to return the data (in the form of a `ReportData` object)"}]},ServerValidationContext:{name:"ServerValidationContext",kind:"I",desc:"Context used when validating data edits on Server",props:[{name:"cellDataChangedInfo",kind:"u",desc:"Details of Cell Edit"}]},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:"Settings Panel Icon: `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:"'modal' | 'window'",desc:"How Settings Panel behaves: can be 'window' (movable, resizable no backdrop) or 'modal' (centre of screen with backdrop)",isOpt:!0,defVal:"'window'"},{name:"position",kind:"u",desc:"Initial position of Settings Panel window",isOpt:!0,defVal:"Middle of Screen"},{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",props:[{name:"adaptableId",kind:"s",desc:"`AdaptableOptions.adaptableId`"},{name:"userName",kind:"s",desc:"`AdaptableOptions.userName`"}]},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:"Predefined Configuration 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:"'String' | 'Number' | 'Boolean' | 'Date' | 'NumberArray'",desc:"Expression's return value DataType, only mandatory property"},{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 state loading with custom functionality",props:[{name:"applyState",kind:"u",desc:"Allows hooking into Adaptable State hydration",isOpt:!0},{name:"clearState",kind:"R",desc:"Allows clearing of remote Adaptable State",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:"Allows customization of Adaptable State loading",isOpt:!0,ref:"AdaptableLoadStateFunction"},{name:"persistState",kind:"R",desc:"Allows customization of Adaptable State persistence",isOpt:!0,ref:"AdaptablePersistStateFunction"},{name:"saveState",kind:"R",desc:"Allows customization of Adaptable State about to be persisted",isOpt:!0,ref:"AdaptableSaveStateFunction"}]},StatusBarState:{name:"StatusBarState",kind:"I",desc:"Predefined Configuration 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:"CheckBoxStyle",kind:"b",desc:"Renders a Checkbox in a boolean column",isOpt:!0},{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:"IncludeGroupedRows",kind:"b",desc:"Includes Styled Column in Grouped Rows",isOpt:!0,defVal:"false"},{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:"Predefined Configuration 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"},SystemExportDestinations:{name:"SystemExportDestinations",kind:"A",desc:"List of 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:"AdaptableScope"},{name:"moduleScope",kind:"R",desc:"Module for which Predicates are being retrieved",ref:"unknown"},{name:"systemPredicateDefs",kind:"a",desc:"AdapTable-provided System Predicate Definitions"}]},SystemReportName:{name:"SystemReportName",kind:"A",desc:"Names of Reports provided by AdapTable"},SystemReportNames:{name:"SystemReportNames",kind:"A",desc:"Array containing all 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}]},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:"suppressOverrideConfigWarning",kind:"b",desc:"Suppress warning when an Import overrides existing Config 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; this is internal so not designed to be provided as part of Predefined Config",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}]},TOAST_POSITIONS:{name:"TOAST_POSITIONS",kind:"A",desc:"Different positions offered by Notifications"},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:"Predefined Configuration 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"},UnbalancedGroupsKeyContext:{name:"UnbalancedGroupsKeyContext",kind:"I",desc:"Context used when setting a value for Unbalanced Row Groups",props:[{name:"adaptableColumn",kind:"u",desc:"Adaptable Column being grouped"},{name:"params",kind:"u",desc:"AG Grid's Key Creator Params"}]},UserInterfaceOptions:{name:"UserInterfaceOptions",kind:"I",desc:"Options for managing the User Interface of AdapTable",props:[{name:"applicationIcon",kind:"R",desc:"The application icon to appear in Dashboard and elsewhere (e.g. OpenFin notifications)",isOpt:!0,defVal:"null",ref:"AdaptableIcon"},{name:"bulkUpdatePermittedValues",kind:"u",desc:"Custom column values for editing via bulk-update; when not defined defaults to permittedValues",isOpt:!0},{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:"customDisplayFormatters",kind:"a",desc:"Custom Formatters to use in the Format Column Module",isOpt:!0},{name:"customSortPermittedValues",kind:"u",desc:"Custom column values for defining Custom Sort; when not defined defaults to permittedValues",isOpt:!0},{name:"dateInputOptions",kind:"R",desc:"Options for managing and customizing date inputs in AdapTable",isOpt:!0,ref:"DateInputOptions"},{name:"editableCellStyle",kind:"R",desc:"Style to set for editable cells",isOpt:!0,ref:"AdaptableStyle"},{name:"editLookUpItems",kind:"u",desc:"Dropdown values displayed when column is being edited; when not defined defaults to permittedValues",isOpt:!0},{name:"filterPermittedValues",kind:"u",desc:"Custom column values for 'IN' filter; when not defined defaults to permittedValues",isOpt:!0},{name:"gridInfoSections",kind:"R",desc:"Which sections to show in the Grid Info Screen",isOpt:!0,defVal:"['GridSummary', 'AdaptableOptions', 'ColumnInfo', 'AdaptableObjects']",ref:"unknown"},{name:"objectTags",kind:"u",desc:"Optional list of AdaptableObjectTags that can be associated with AdaptableObjects",isOpt:!0},{name:"permittedValues",kind:"u",desc:"List of values which are permitted (e.g. to show in Filter, Custom Sort etc.)",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:"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:"R",desc:"Optional icon to display",isOpt:!0,ref:"AdaptableIcon"},{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}]},ValidationResult:{name:"ValidationResult",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:"NewValue",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}]},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"}]}};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ADAPTABLE_METAMODEL=void 0,exports.ADAPTABLE_METAMODEL={AccessLevel:{name:"AccessLevel",kind:"A",desc:"Defines Access Level for an Entitlement - can be `ReadOnly`, `Hidden` or `Full`"},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:"Additional optional properties for 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:"includeGroupedRows",kind:"b",desc:"Shows Action Column also in grouped rows",isOpt:!0}]},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"}]},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}]},ActionHandler:{name:"ActionHandler",kind:"A",desc:"Handles a Form Button Action"},ActionOptions:{name:"ActionOptions",kind:"I",desc:"Options related to Action Columns and Buttons in Adaptable.",props:[{name:"actionColumns",kind:"u",desc:"Columns which contain an AdapTable Button - used for performing Actions",isOpt:!0,defVal:"undefined"},{name:"actionRowButtonOptions",kind:"u",desc:"Additional options for managing Action Row Buttons",isOpt:!0,defVal:"undefined"},{name:"actionRowButtons",kind:"u",desc:"Action buttons to display for each row",isOpt:!0,defVal:"undefined"}]},ActionRowButtonConfigurationContext:{name:"ActionRowButtonConfigurationContext",kind:"I",desc:"Context used when adding custom configuration for Action Row Buttons",props:[{name:"actionRowButtonType",kind:"R",desc:"Type of Action Row Button: 'create', 'clone', 'edit' or 'delete'",ref:"ActionRowButtonType"}]},ActionRowButtonOptions:{name:"ActionRowButtonOptions",kind:"I",desc:"Options for managing the Buttons in Action Rows",props:[{name:"actionRowFormOptions",kind:"u",desc:"Options for managing the Form which the Action Row displays",isOpt:!0,defVal:"undefined"},{name:"autoHandle",kind:"b",desc:"If true, AdapTable will automatically update the AG Grid data model with the created/edited/deleted rows",isOpt:!0,defVal:"true"},{name:"customConfiguration",kind:"u",desc:"Optional configuration that merges with built-in action row button and overrides default configuration",isOpt:!0,defVal:"undefined"},{name:"disableInlineEditing",kind:"b",desc:"Prevents direct editing in Grid cells even for editable columns",isOpt:!0,defVal:"false"},{name:"position",kind:"'pinnedLeft' | 'pinnedRight'",desc:"Action Row Buttons position: 'pinnedLeft' | 'pinnedRight",isOpt:!0,defVal:"'pinnedLeft'"},{name:"setPrimaryKeyValue",kind:"u",desc:"Function called when auto-handling 'create' Action Row Button; returned row value should have a valid(unique) primary key value",isOpt:!0,defVal:"undefined"}]},ActionRowButtonsContext:{name:"ActionRowButtonsContext",kind:"I",desc:"Context passed to Action Row Buttons"},ActionRowButtonType:{name:"ActionRowButtonType",kind:"A",desc:"Type of Action Row Button: 'create' | 'clone' | 'edit' | 'delete'"},ActionRowFormContext:{name:"ActionRowFormContext",kind:"A",desc:"Context passed into a Row Form - can be `CreateActionRowContext` or `EditActionRowContext`"},ActionRowFormOptions:{name:"ActionRowFormOptions",kind:"I",desc:"Options for Form displayed when Action Row Button is clicked",props:[{name:"formButtons",kind:"u",desc:"Custom form buttons provider. If provided, the custom implementation is responsible for firing the 'ActionRowSubmitted' and/or invoking the 'onFormSubmit' callback (if necessary).",isOpt:!0},{name:"formDescription",kind:"u",desc:"Custom form description provider",isOpt:!0,defVal:"undefined"},{name:"formFieldLabel",kind:"u",desc:"Custom form field label provider",isOpt:!0,defVal:"undefined"},{name:"formTitle",kind:"u",desc:"Custom form title provider",isOpt:!0,defVal:"'Create New Row'/'Edit Row'"},{name:"onFormSubmit",kind:"u",desc:"Event published when the form in an Action Row is submitted via a standard button (provided by AdapTable). This is not invoked when custom form buttons are provided!",isOpt:!0,defVal:"undefined"}]},ActionRowParamContext:{name:"ActionRowParamContext",kind:"I",desc:"Context used for overriding Title and Description of Action Row Form"},ActionRowParamFieldContext:{name:"ActionRowParamFieldContext",kind:"I",desc:"Context used for overriding Field elements in Action Row Form"},AdaptableAggregatedBooleanQuery:{name:"AdaptableAggregatedBooleanQuery",kind:"I",desc:"Wraps an AdapTableQL Aggregated Boolean Expression"},AdaptableAggregatedScalarQuery:{name:"AdaptableAggregatedScalarQuery",kind:"I",desc:"Wraps an AdapTableQL Aggregated Scalar Expression"},AdaptableAlert:{name:"AdaptableAlert",kind:"A",desc:"Defines an Alert fired by AdapTable"},AdaptableAlertAction:{name:"AdaptableAlertAction",kind:"A",desc:"Actions available in an Alert"},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"}]},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"},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:"Allows clearing state when a custom persistState is used. Only called by configApi.reloadPredefinedConfig"},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:"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:"unknown"},{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:"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:"isExcludedFromQuickSearch",kind:"b",desc:"Has colummn been excluded from Quick Search results"},{name:"isFixed",kind:"b",desc:"Is Column pinned or locked into position"},{name:"isGrouped",kind:"b",desc:"Is Column currently Row-Grouped"},{name:"isPrimaryKey",kind:"b",desc:"Is this the Primary Key Column"},{name:"isSparkline",kind:"b",desc:"Is it a Sparkline Column"},{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 Grid"},{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:"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:"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"}]},AdaptableColumnDataType:{name:"AdaptableColumnDataType",kind:"A",desc:"Type of data stored in an Adaptable Column"},AdaptableColumnType:{name:"AdaptableColumnType",kind:"A",desc:"Column Types recognised by AdapTable; to be set in GridOptions"},AdaptableComparerFunction:{name:"AdaptableComparerFunction",kind:"A",desc:"Standard comparer function used to evaluate custom sorts, returns -1, 0, 1 as required"},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"}]},AdaptableDashboardToolbar:{name:"AdaptableDashboardToolbar",kind:"A",desc:"List of all the Toolbars that Adaptable provides"},AdaptableDataChangeHistoryAction:{name:"AdaptableDataChangeHistoryAction",kind:"A",desc:"Built in `undo` data change action"},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"}]},AdaptableExternalIcon:{name:"AdaptableExternalIcon",kind:"I",desc:"Defines an icon from an external source",props:[{name:"src",kind:"s",desc:"The URL of the icon to use"}]},AdaptableFDC3EventInfo:{name:"AdaptableFDC3EventInfo",kind:"I",desc:"EventInfo returned by `FDC3MessageSent` event",props:[{name:"context",kind:"R",desc:"Full FDC3 Context for the object related to the event",ref:"FDC3Context"},{name:"eventType",kind:"'RaiseIntent' | 'RaiseIntentForContext' | 'BroadcastMessage'",desc:"Type of Event: `RaiseIntent`, `RaiseIntentForContext` or `BroadcastMessage`"},{name:"intent",kind:"u",desc:"The FDC3 Intent which caused Event to fire (if type is `RaiseIntent`)",isOpt:!0}]},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 or React"},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.)"},AdaptableInternalIcon:{name:"AdaptableInternalIcon",kind:"I",desc:"Defines an icon from the internal AdapTable icon set",props:[{name:"name",kind:"R",desc:"The name of the icon to use (referencing the AdapTable Icon Library)",ref:"AdaptableInternalIconName"},{name:"size",kind:"n",desc:"The size (in pixels) of the SVG icon (defaults to `17px`)",isOpt:!0}]},AdaptableInternalIconName:{name:"AdaptableInternalIconName",kind:"A",desc:"All AdapTable internal icon names"},AdaptableLoadStateFunction:{name:"AdaptableLoadStateFunction",kind:"I",desc:"Allows customization of state loading - used by `loadState` function in StateOptions"},AdaptableMenuItem:{name:"AdaptableMenuItem",kind:"I",desc:"Menu item used by Adaptable in both Column and Context Menus",props:[{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:"Name that appears in the menu"},{name:"module",kind:"u",desc:"Adaptable Module associated with (Adaptable) menu item.",isOpt:!0},{name:"onClick",kind:"u",desc:"Function to invoke when (custom) menu item is clicked",isOpt:!0},{name:"reduxAction",kind:"R",desc:"Adaptable Redux Action to invoke when (Adaptable) menu item is clicked",isOpt:!0,ref:"unknown"},{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 Predefined Config"},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"},AdaptableObject:{name:"AdaptableObject",kind:"I",desc:"Base interface which all other Adaptable State-related objects extend",props:[{name:"IsReadOnly",kind:"b",desc:"Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')",isOpt:!0},{name:"Source",kind:"'Config' | 'User'",desc:"Source of state object: 'Config' if provided via `AdaptableOptions.predefinedConfig`, 'User' or undefined for runtime state.",isOpt:!0},{name:"Tags",kind:"a",desc:"List of Tags associated with the Object; often used for (but not limited to) managing Layout object scope",isOpt:!0},{name:"Uuid",kind:"R",desc:"Unique identifier for the Adaptable Object, generated and used internally by AdapTable",isOpt:!0,ref:"unknown"}]},AdaptableObjectLookupCriteria:{name:"AdaptableObjectLookupCriteria",kind:"I",desc:"Lookup criteria for finding specific AdaptableObjects. 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:"AdaptableScope",isOpt:!0,ref:"AdaptableScope"},{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 ever needed."},AdaptableObservableQuery:{name:"AdaptableObservableQuery",kind:"I",desc:"Wraps an AdapTableQL Observable Expression"},AdaptableOptions:{name:"AdaptableOptions",kind:"I",desc:"Group of property options enabling developers to set up AdapTable at design time to fit precise requirements - provides AG Grid, Predefined Config and other information required to ensure a full, rich user experience",props:[{name:"actionOptions",kind:"u",desc:"Options for managing Action Columns and Action Rows",isOpt:!0},{name:"adaptableId",kind:"s",desc:"Identifier for this instance of AdapTable",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"'adaptable_id'"},{name:"adaptableQLOptions",kind:"u",desc:"Options for managing AdapTableQL",isOpt:!0,noCode:"container"},{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:"chartingOptions",kind:"R",desc:"Options for managing AG Grid's Charting",isOpt:!0,noCode:"container",ref:"ChartingOptions"},{name:"columnOptions",kind:"R",desc:"Options related to Columns",isOpt:!0,noCode:"container",ref:"ColumnOptions"},{name:"containerOptions",kind:"R",desc:"Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed",isOpt:!0,ref:"ContainerOptions"},{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:"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:"R",desc:"Options for managing Exporting and Reports in AdapTable",isOpt:!0,gridInfo:"container",ref:"ExportOptions"},{name:"filterOptions",kind:"u",desc:"Options for managing Filtering in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container"},{name:"flashingCellOptions",kind:"R",desc:"Options for managing Flashing Cells - primarily default values",isOpt:!0,gridInfo:"container",ref:"FlashingCellOptions"},{name:"generalOptions",kind:"u",desc:"General options to manage AdapTable e.g. grouping behaviour, Primary Keys",isOpt:!0,gridInfo:"container",noCode:"container"},{name:"gridOptions",kind:"u",desc:"The AG Grid object which AdapTable interacts with. Note: if using AdapTable React or AdapTable Angular, no need to populate this property as AdapTable wires it up differently",isOpt:!0},{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:"menuOptions",kind:"u",desc:"Options for managing AdapTable menus",isOpt:!0,gridInfo:"container"},{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:"predefinedConfig",kind:"u",desc:"User State set at design-time and shipped with AdapTable for first use; can be `PredefinedConfig` object or url to file containing config",isOpt:!0,defVal:"undefined"},{name:"primaryKey",kind:"u",desc:"Name of Column in AdapTable guaranteed to contain unique values",gridInfo:"item",defVal:"n/a (Mandatory)"},{name:"searchOptions",kind:"u",desc:"Options for managing Search related functions in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container"},{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'"}]},AdaptablePersistentState:{name:"AdaptablePersistentState",kind:"I",desc:"The state object of Adaptable which is persisted"},AdaptablePersistStateFunction:{name:"AdaptablePersistStateFunction",kind:"I",desc:"Allows customization of state persistence - used `persistState` function in StateOptions"},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:"s",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:"AdaptableScope"},{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:"s",desc:"Unique Id for the object"},{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 the Predicate can run"},{name:"onlyQuickFilter",kind:"b",desc:"Display this predicate only in Quick Filter Bar (and NOT in Filter Form)",isOpt:!0},{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"},AdaptableQLOptions:{name:"AdaptableQLOptions",kind:"I",desc:"Options for managing AdapTableQL: AdapTable's Query Language which evaluates Predicates and Expressions",props:[{name:"caseSensitiveTextComparisons",kind:"b",desc:"Perform case-sensitive text comparisons when evaluating Predicates and Expressions",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"customPredicateDefs",kind:"a",desc:"Definitions for Custom provided Predicates",isOpt:!0},{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:"expressionOptions",kind:"R",desc:"Options for managing Expressions in AdapTableQL",isOpt:!0,ref:"ExpressionOptions"},{name:"predicateOptions",kind:"R",desc:"Options for managing Predicates in AdapTableQL",isOpt:!0,ref:"PredicateOptions"}]},AdaptableQuery:{name:"AdaptableQuery",kind:"A",desc:"An AdaptableQuery can be either a Boolean, Scalar, Observable, AggregatedBoolean, or AggregatedScalar expression"},AdaptableReportColumn:{name:"AdaptableReportColumn",kind:"I",desc:"Column which is included in a Report",props:[{name:"columnId",kind:"s",desc:"ColumnID"},{name:"dataType",kind:"R",desc:"DataType of the Column",ref:"AdaptableColumnDataType"},{name:"field",kind:"s",desc:"Field name to get the value from the row data (defaults to `columnId`)",isOpt:!0},{name:"friendlyName",kind:"s",desc:"Column Header"}]},AdaptableRowChangedAlert:{name:"AdaptableRowChangedAlert",kind:"I",desc:"Defines an Alert fired by AdapTable when a row is changed",props:[{name:"gridDataChangedInfo",kind:"u",desc:"Row DataChange which triggered Alert"}]},AdaptableSaveStateFunction:{name:"AdaptableSaveStateFunction",kind:"I",desc:"Allows the customization state persistence - used by `saveState` function in StateOptions"},AdaptableScalarQuery:{name:"AdaptableScalarQuery",kind:"I",desc:"Wraps an AdapTableQL Scalar Expression"},AdaptableScope:{name:"AdaptableScope",kind:"A",desc:"Defines where a given Object / Module is active"},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 between local state & Team Share)",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"},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 (except 'applyState')",props:[{name:"adaptableId",kind:"s",desc:"Id of current Adaptable instance"},{name:"adaptableStateKey",kind:"s",desc:"State Key being used"},{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 defined in AG Grid GridOptions - ensure keys are the same (Note: AG Grid statusPanel has a 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}]},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",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"}]},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'"}]},AlertButton:{name:"AlertButton",kind:"I",desc:"Defines a button that appears in an Alert Form",props:[{name:"Action",kind:"u",desc:"Predefined Action(s) to trigger when button is clicked; but the implementation in `actionHandlers` property of Alert Options",isOpt:!0},{name:"ButtonStyle",kind:"R",desc:"Style for the Button",isOpt:!0,ref:"ButtonStyle"},{name:"Label",kind:"s",desc:"Label to show in the Button"},{name:"Tooltip",kind:"s",desc:"ToolTip to display",isOpt:!0}]},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:"The Alert Title Message to display",isOpt:!0},{name:"MessageText",kind:"s",desc:"Alert Message; if not provided AdapTable creates dynamically using Rule & Scope (Note: can be provided as a function in AlertOptions)",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:"AdaptableScope"}]},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:"gridDataChangedInfo",kind:"u",desc:"Grid Data change that might have triggered the Alert (i.e. RowAdded / RowRemoved)",isOpt:!0}]},AlertOptions:{name:"AlertOptions",kind:"I",desc:"Options related to Alerts in Adaptable.",props:[{name:"actionHandlers",kind:"u",desc:"Custom onClick Handlers for Buttons (displayed in Alert Forms)",isOpt:!0},{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:"dataChangeDetectionPolicy",kind:"'rawValue' | 'formattedValue'",desc:"Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data",isOpt:!0,gridInfo:"item",defVal:"'rawValue'"},{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:"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 cell using `MessageType` property of triggering Alert Definition",isOpt:!0},{name:"HighlightRow",kind:"u",desc:"Colours updated cell using `MessageType` property 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, it 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:"Predefined Configuration 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:"Predefined Configuration 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}]},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"}]},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}]},BadgeStyleDefinition:{name:"BadgeStyleDefinition",kind:"I",desc:"Defines a Badge Style",props:[{name:"Icon",kind:"u",desc:"Icon to display in Badge",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"},BaseContext:{name:"BaseContext",kind:"I",desc:"Base Context used in many functions provided by developers and invoked as needed by AdapTable",props:[{name:"adaptableApi",kind:"R",desc:"The Adaptable Api - included as a convenience",ref:"unknown"}]},BulkUpdatePermittedValues:{name:"BulkUpdatePermittedValues",kind:"I",desc:"User to define permitted values when updating cells via bulk update",props:[{name:"values",kind:"u",desc:"Function returning Values to display in Bulk Update Wizard - can be async"}]},BulkUpdatePermittedValuesContext:{name:"BulkUpdatePermittedValuesContext",kind:"I",desc:"Context used when getting BulkUpdatePermittedValues via a function",props:[{name:"gridCells",kind:"u",desc:"Cells which will be modified in the Bulk Update"}]},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:"Predefined Configuration for Calculated Column Module",props:[{name:"CalculatedColumns",kind:"a",desc:"Collection of Calculated Columns",isOpt:!0}]},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:"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"},{name:"timeout",kind:"n",desc:"Time after which Cell should be unhighlighted",isOpt:!0}]},CellSummaryOperation:{name:"CellSummaryOperation",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"}]},CellSummaryOperationContext:{name:"CellSummaryOperationContext",kind:"I",desc:"Context provided to a custom Cell Summary Operation function",props:[{name:"allValues",kind:"a",desc:"All values of selected cells"},{name:"distinctCount",kind:"n",desc:"Count of currently selected cells"},{name:"numericColumns",kind:"a",desc:"Any numeric columns in current selection"},{name:"numericValues",kind:"a",desc:"Any numeric values in current selection"},{name:"selectedCellInfo",kind:"u",desc:"Currently selected cells"}]},CellSummmary:{name:"CellSummmary",kind:"I",desc:"Defines the Summary operations provides for Selected 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 one 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 the 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:"saveStrategy",kind:"'auto' | 'manual' | 'none'",desc:"Behaviour for saving Charts: automatic, manual (via popup) or none",isOpt:!0,noCode:"item",defVal:"'none'"}]},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}]},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 or Column name"},{name:"MinValue",kind:"number | string",desc:"Start value - either numeric or Column name"}]},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:"Predicate",kind:"R",desc:"`AdaptablePredicate` which AdaptableQL will evaluate when the Filter is run",ref:"ColumnFilterPredicate"}]},ColumnFilterDef:{name:"ColumnFilterDef",kind:"I",desc:"Column Filter Definition for a specific Column"},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"}]},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"}]},ColumnOptions:{name:"ColumnOptions",kind:"I",desc:"Options related to managing Columns in Adaptable.",props:[{name:"autoOrderGroupedColumns",kind:"b",desc:"Order Grouped Column automatically, deriving from Adaptable State if available (CustomSort or Layout ColumnSort)",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"columnFriendlyName",kind:"f",desc:"Provide an alternative Friendly Name for a Column",isOpt:!0,defVal:"undefined"},{name:"columnTypes",kind:"a",desc:"Optional list of Column Types - used primarily for Calculated and FreeText Columns",isOpt:!0,defVal:"undefined"},{name:"hideColumnWhenGrouped",kind:"b",desc:"",isOpt:!0},{name:"showMissingColumnsWarning",kind:"b",desc:"Show warning if AdapTable cannot find a column",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"}]},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'"}]},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:"AdaptableScope"}]},ConfigState:{name:"ConfigState",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 Predefined Config while keeping others unchanged",isOpt:!0}]},ContactColumn:{name:"ContactColumn",kind:"I",desc:"A (String) Column which will be defined as an FDC3 Contact columnId and at least one other property is required",props:[{name:"emailColumnId",kind:"s",desc:"Column which holds the email address of a Contact",isOpt:!0},{name:"fds_idColumnId",kind:"s",desc:"Column which holds an FDS_ID value a Contact",isOpt:!0},{name:"intents",kind:"R",desc:"Contact-related FDC3 Intents; can be: `StartCall` `StartChat` `ViewContact`",isOpt:!0,ref:"ContactIntents"}]},ContactContext:{name:"ContactContext",kind:"I",desc:"FDC3 Context to define a Contact",props:[{name:"id",kind:"u",desc:"The Contact data: email, FDS_ID",isOpt:!0},{name:"name",kind:"s",desc:"Free text name of Contact",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `contact`"}]},ContactIntent:{name:"ContactIntent",kind:"A",desc:"FDC3 Intents available to a Contact Column"},ContactIntents:{name:"ContactIntents",kind:"A",desc:"All available Contact Intents"},ContactListContext:{name:"ContactListContext",kind:"I",desc:"FDC3 Context to define a list of Contacts",props:[{name:"contacts",kind:"a",desc:"The array of Contacts",isOpt:!0},{name:"id",kind:"u",desc:"Optional Id",isOpt:!0},{name:"name",kind:"s",desc:"Free text name of Contact list",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `contactList`"}]},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:"agGridContainerWaitTimeout",kind:"n",desc:"How long AdapTable waits for AG Grid before giving up connecting to it",isOpt:!0,gridInfo:"item",defVal:"60s"},{name:"alertContainer",kind:"u",desc:"Div to show Alerts - string Id or HTMLElement",isOpt:!0,gridInfo:"item",defVal:"undefined"},{name:"modalContainer",kind:"u",desc:"Name of div where modals appear (if null, will be centre of page)",isOpt:!0,gridInfo:"item",defVal:"undefined"},{name:"systemStatusContainer",kind:"u",desc:"Div to show System Status messages - string Id or HTMLElement",isOpt:!0,gridInfo:"item",defVal:"undefined"}]},ContextData:{name:"ContextData",kind:"A",desc:"Data used in FDC3 Contexts"},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"}]},CountryColumn:{name:"CountryColumn",kind:"I",desc:"A (String) Column which will be defined as an FDC3 Country",props:[{name:"intents",kind:"R",desc:"Country-related FDC3 Intents; can only be: `ViewChart`",isOpt:!0,ref:"CountryIntents"},{name:"isoalpha2ColumnId",kind:"s",desc:"Column which contains the ISOALPHA2 Standard",isOpt:!0},{name:"isoalpha3ColumnId",kind:"s",desc:"Column which contains the ISOALPHA3 Standard",isOpt:!0}]},CountryContext:{name:"CountryContext",kind:"I",desc:"FDC3 Context to define a Country",props:[{name:"id",kind:"u",desc:"The Country data: ISOALPHA2, ISOALPHA3",isOpt:!0},{name:"name",kind:"s",desc:"Free text name of Country",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `country`"}]},CountryIntent:{name:"CountryIntent",kind:"A",desc:"FDC3 Intents available to a Country Column"},CountryIntents:{name:"CountryIntents",kind:"A",desc:"All available Country Intents"},CreateActionRowFormContext:{name:"CreateActionRowFormContext",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"}]},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}]},CustomDisplayFormatter:{name:"CustomDisplayFormatter",kind:"I",desc:"Provides Custom Display Formats",props:[{name:"handler",kind:"f",desc:"Function used to perform the Custom Display Format"},{name:"id",kind:"s",desc:"Id of the Formatted"},{name:"label",kind:"s",desc:"Description",isOpt:!0},{name:"scope",kind:"R",desc:"Where the Custom Display Format can be applied",ref:"AdaptableScope"}]},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"}]},CustomFDC3Column:{name:"CustomFDC3Column",kind:"I",desc:"A Column which will be defined as Custom FDC3 (can be any datatype)",props:[{name:"createContext",kind:"u",desc:"Function which creates FDC3 context for the current column and row"},{name:"intents",kind:"a",desc:"Custom FDC3 Intents available to the column"}]},CustomFDC3Context:{name:"CustomFDC3Context",kind:"I",desc:"Context used when providing Custom FDC3 content"},CustomFDC3Intent:{name:"CustomFDC3Intent",kind:"A",desc:"Custom FDC3 Intent - just a string value"},CustomQueryVariableContext:{name:"CustomQueryVariableContext",kind:"I",desc:"Context passed when evaluating `ExpressionOptions.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:"Current Div Element",ref:"unknown"},{name:"visible",kind:"b",desc:"Whether Tool Panel is currently visible"}]},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 or React) 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}]},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:"a",desc:"Order of values by which Column will be sorted",isOpt:!0}]},CustomSortPermittedValues:{name:"CustomSortPermittedValues",kind:"I",desc:"Custom column values for Custom Sort",props:[{name:"values",kind:"u",desc:"Function returning Values to display in Custom Sort Wizard - can be async"}]},CustomSortState:{name:"CustomSortState",kind:"I",desc:"Predefined Configuration 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 or React) 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:"showCloseButton",kind:"b",desc:"Shows a Close button at the bottom of Custom Toolbar",isOpt:!0},{name:"showConfigureButton",kind:"b",desc:"Shows a Configure (wrench) button which when clicked fires `CustomToolbarConfigured` event",isOpt:!0},{name:"title",kind:"s",desc:"Title to display in Toolbar; if unset or empty string, nothing will show",isOpt:!0},{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 or React) 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}]},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"}]},DashboardOptions:{name:"DashboardOptions",kind:"I",desc:"Options related to the Dashboard in Adaptable.",props:[{name:"buttonsLocation",kind:"'left' | 'right'",desc:"Where in Dashboard to display Module and Custom Buttons",isOpt:!0,noCode:"item",defVal:"'right'"},{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:"Predefined Configuration 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:"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"}]},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:"dataChangedInfo",kind:"u",desc:"The initial data change"},{name:"isGroupNode",kind:"b",desc:"If the change references a group node."},{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:"Whether data change history should be 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)"}]},DataFormatType:{name:"DataFormatType",kind:"A",desc:"Format of exported Data - 'rawValue' or 'formattedValue'"},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"}]},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:"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'"},{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",props:[{name:"adaptableId",kind:"s",desc:"Id of current AdapTable instance"},{name:"userName",kind:"s",desc:"Name of Current User"}]},DetailInitContext:{name:"DetailInitContext",kind:"I",desc:"Context passed to Detail Grids when using Master Detail Plugin"},EditActionRowFormContext:{name:"EditActionRowFormContext",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"}]},EditLookUpContext:{name:"EditLookUpContext",kind:"I",desc:"Context used when getting EditLookUpPermittedValues via a function",props:[{name:"gridCell",kind:"u",desc:"Cell being edited",isOpt:!0}]},EditLookUpPermittedValues:{name:"EditLookUpPermittedValues",kind:"I",desc:"Used to define permitted values for inline column editor",props:[{name:"values",kind:"u",desc:"Values to display in Edit Look Up: either hardcoded list or a function that returns a list",isOpt:!0}]},EditOptions:{name:"EditOptions",kind:"I",desc:"Options related to Editing in AdapTable - includes Server Validation, Smart Edit Operations and Row Forms",props:[{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:"smartEditCustomOperations",kind:"u",desc:"Custom Operations to use in Smart Edit",isOpt:!0},{name:"validateOnServer",kind:"u",desc:"Function to validate AdapTable data edits on Server",isOpt:!0}]},EntitlementContext:{name:"EntitlementContext",kind:"I",desc:"Provided to moduleEntitlements function when setting Entitlements programatically",props:[{name:"adaptableId",kind:"s",desc:"Id of current AdapTable instance"},{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"},{name:"userName",kind:"s",desc:"Name of Current User"}]},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 `AdaptableQLOptions.evaluateExpressionExternally()`",props:[{name:"expression",kind:"s",desc:"Expression to evaluate",isOpt:!0},{name:"module",kind:"R",desc:"Module where Expression is being evaluated",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}]},ExportableColumnContext:{name:"ExportableColumnContext",kind:"I",desc:"Context used for setting whether a Column is exportable",props:[{name:"adaptableColumn",kind:"R",desc:"Column to be exported",ref:"AdaptableReportColumn"}]},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:"ReportData"}]},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:"customDestinations",kind:"a",desc:"User-provided Report Destinations (in addition to those shipped in AdapTable)",isOpt:!0},{name:"exportDateFormat",kind:"s",desc:"Optional custom format for Date columns when exporting",isOpt:!0,gridInfo:"item",defVal:"undefined"},{name:"exportFormatType",kind:"u",desc:"Format of exported values; can be set either for whole grid or specifically for each column type",isOpt:!0,defVal:"rawValue"},{name:"isColumnExportable",kind:"f",desc:"Whether a Column is included in System Reports and available in UI for selection",isOpt:!0,defVal:"true"},{name:"preProcessExport",kind:"u",desc:"Function invoked when a Report is run, enabling users to preload the data before it is exported",isOpt:!0},{name:"serverReports",kind:"a",desc:"Reports generated entirely by users (and not AdapTable)",isOpt:!0},{name:"systemExportDestinations",kind:"R",desc:"Export destinations to use; leave blank for all, empty array for none",isOpt:!0,gridInfo:"item",defVal:"'Excel', 'CSV', 'Clipboard', 'JSON, 'Table'",ref:"SystemExportDestinations"},{name:"systemReportNames",kind:"R",desc:"System Reports to use; leave blank for all, empty array for none",isOpt:!0,gridInfo:"item",defVal:"'Visual Data', 'All Data', 'Current Data', 'Selected Cells', 'Selected Rows',",ref:"SystemReportNames"}]},ExportState:{name:"ExportState",kind:"I",desc:"Predefined Configuration for Export Module",props:[{name:"CurrentDestination",kind:"u",desc:"Currently selected Report Destination in Export Toolbar & Tool Panel",isOpt:!0},{name:"CurrentReport",kind:"s",desc:"Currently selected Report - in Export Toolbar & Tool Panel",isOpt:!0},{name:"Reports",kind:"a",desc:"User-created Reports; each has Name and Row and Column Scope",isOpt:!0}]},ExpressionContext:{name:"ExpressionContext",kind:"I",desc:"Provides context to an Expression Function, including current row node and AdaptableApi",props:[{name:"evaluateCustomQueryVariable",kind:"u",desc:"Evaluate custom variables"},{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:"namedQueryCallStack",kind:"a",desc:"All Named Query evaluations: tracked in order to detect circular dependencies",isOpt:!0},{name:"node",kind:"u",desc:"Current AG Grid Row Node being evaluated"},{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:"unknown"},{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 eagerly (without handling inner AST nodes)",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"},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 using AdapTableQL",props:[{name:"customBooleanFunctions",kind:"u",desc:"Custom Boolean Expression Functions available in AdapTableQL",isOpt:!0,gridInfo:"item",defVal:"null (none)"},{name:"customQueryVariables",kind:"u",desc:"Custom query variables allow 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. Variables are 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:"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)"}]},FDC3Column:{name:"FDC3Column",kind:"I",desc:"An FDC3 Column - will raise FDC3 intents and broadcast FDC3 messages",props:[{name:"broadcastContextMenuLabel",kind:"u",desc:"Label to display in Broadcast Context Menu Item",isOpt:!0},{name:"columnId",kind:"s",desc:"Id of Column defined as FDC3"},{name:"intentContextMenuLabel",kind:"u",desc:"Label to display in Intent Context Menu Item",isOpt:!0},{name:"intentIcon",kind:"u",desc:"Returns a custom icon to display in the Raise Intent Context Menu Item;",isOpt:!0},{name:"intents",kind:"a",desc:"FDC3 intents which the Column can raise",isOpt:!0},{name:"nameColumnId",kind:"s",desc:"If provided, will supply `name` property in FDC3 message",isOpt:!0},{name:"raiseIntentForContextMenuLabel",kind:"u",desc:"Label to display in RaiseIntentForContext Context Menu Item",isOpt:!0},{name:"showBroadcastContextMenu",kind:"b",desc:"Should Column display a 'Broadcast' context menu item",isOpt:!0},{name:"showRaiseIntentForContextMenu",kind:"b",desc:"Should Column display a 'Raise Intent for Context' context menu item",isOpt:!0}]},FDC3Context:{name:"FDC3Context",kind:"I",desc:"General-purpose context type, as defined by FDC3",props:[{name:"(indexer)",kind:"i",desc:"Custom properties and metadata. This can be extended in specific context object."},{name:"id",kind:"{\n        [key: string]: string | undefined;\n    }",desc:"Optional map of any equivalent identifiers for the context type, e.g. ISIN, CUSIP, etc. for Instrument",isOpt:!0},{name:"name",kind:"s",desc:"Name of the context data (optional) - a text string that describes the data being sent",isOpt:!0},{name:"type",kind:"R",desc:"Type of FDC3Context that uniquely identifies it, e.g. "instrument"; used to refer to the accepted context(s) when declaring intents",ref:"FDC3ContextType"}]},FDC3ContextType:{name:"FDC3ContextType",kind:"A",desc:"Defines which FDC3 context is being used"},FDC3Intent:{name:"FDC3Intent",kind:"A",desc:"Full list of FDC3 Intents available - each FDC3 Column can use a subset"},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:"'Always' | 'Never' | 'Throttle'",desc:"When to re-apply Filters: 'Always', 'Never' or 'Throttle'"},{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 Filtering in AdapTable",props:[{name:"autoApplyFilter",kind:"b",desc:"Apply selected filters (in Filter Form or Quick Filter Bar) as soon as they are clicked; if false an Apply Filter button is displayed",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"clearFiltersOnStartUp",kind:"b",desc:"Clears saved Column Filters when AdapTable loads",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"defaultDateColumnFilter",kind:"u",desc:"Default filter type for date Columns",isOpt:!0,gridInfo:"item",defVal:"On"},{name:"defaultFilterFormTab",kind:"'Values' | 'Predicates'",desc:"Whether to open the Filter Form on the Values or Predicates tab",isOpt:!0,gridInfo:"item",defVal:"'Values'"},{name:"defaultNumericColumnFilter",kind:"u",desc:"Default filter type for numeric Columns",isOpt:!0,gridInfo:"item",defVal:"Equals"},{name:"defaultStringColumnFilter",kind:"u",desc:"Default filter type for string Columns",isOpt:!0,gridInfo:"item",defVal:"Contains"},{name:"enableFilterOnSpecialColumns",kind:"b",desc:"Allows filtering on Calculated & FreeText columns",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"filterActionOnExternalDataChange",kind:"R",desc:"When to re-filter grid after data ticks: 'Always', 'Never' or 'Throttle' (which requires a 'ThrottleDelay')",isOpt:!0,defVal:"'Never'",ref:"FilterActionOnDataChange"},{name:"filterActionOnUserDataChange",kind:"R",desc:"When to re-filter grid after user edits data: 'Always', 'Never' or 'Throttle' (which requires a 'ThrottleDelay')",isOpt:!0,defVal:"'Always'",ref:"FilterActionOnDataChange"},{name:"hideQuickFilterDropdown",kind:"u",desc:"Hides the Dropdown in Quick Filter Bar for a given Column",isOpt:!0,defVal:"undefined"},{name:"hideQuickFilterInput",kind:"u",desc:"Hides the 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:"maxFilterValuesToDisplay",kind:"n",desc:"Distinct column items to display in Filter Form; useful with large datasource (though AdapTable offers virtualisation)",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"2,000"},{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:"Sets a height for Quick Filter Bar (if not provided AG Grid's default is used)",isOpt:!0,gridInfo:"item",defVal:"null"},{name:"quickFilterTrigger",kind:"'mouseenter' | 'click'",desc:"Whether to open Quick Filter dropdown with mouse hover or click",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"'mouseenter'"},{name:"quickFilterValuesTrigger",kind:"'mouseenter' | 'click'",desc:"Whether to open Quick Filter Values dropdown with mouse hover or click",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"'mouseenter'"},{name:"quickFilterValuesWidth",kind:"'auto' | number",desc:"Width of Values popup in Filter Bar - can be set width or same size as Column",isOpt:!0,defVal:"'180'"},{name:"quickFilterWildcards",kind:"u",desc:"Shortcut Keys to activate a Quick Filter Predicate",isOpt:!0},{name:"showClearFilterButton",kind:"b",desc:"Display Clear Filter button in Toolbar and Tool Panel",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"showDistinctFilteredValuesOnly",kind:"b",desc:"Display only currently filtered distinct values in Filter controls",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"showQuickFilter",kind:"b",desc:"Whether to display Quick Filter Bar between Column Header and the Grid (provided its been setup)",isOpt:!0,noCode:"item",defVal:"true"},{name:"showSuspendFilterButton",kind:"b",desc:"Display Suspend / Unsuspend Button in Toolbar and Tool Panel",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"showValuesCount",kind:"u",desc:"Show the count of each distinct item for given column in the Values (IN) Filter",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"sortColumnValuesInFilter",kind:"b",desc:"Whether column values in filter dropdown should apply column's current Sort Order for the column",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"useAdaptableFilterForm",kind:"boolean | string[]",desc:"Uses Adaptable's Filter Form in Column Menu for all columns if 'true' (the default) or those listed, in preference to AG Grid's Filter Form",isOpt:!0,noCode:"item",defVal:"true"},{name:"useAdaptableQuickFilter",kind:"boolean | string[]",desc:"Use Adaptable's Quick Filter Bar for all columns if 'true' (the default) or those listed, in preference to AG Grid's Floating Filter",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"useAgGridFilterFormStyle",kind:"b",desc:"Styles Adaptable Filter Form to match AG Grid's styling (if using Balham theme)",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"}]},FilterPermittedValues:{name:"FilterPermittedValues",kind:"I",desc:"Used to define values inside the Filter Bar and Filter Form",props:[{name:"suppressFilterSearchBar",kind:"b",desc:"Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed",isOpt:!0,defVal:"false"},{name:"values",kind:"u",desc:"Function returning Values to display in 'IN' Filter - can be async"}]},FilterPermittedValuesContext:{name:"FilterPermittedValuesContext",kind:"I",desc:"Context used when getting FilterPermittedValues via a function",props:[{name:"searchFilter",kind:"s",desc:"A search string"}]},FinancePluginOptions:{name:"FinancePluginOptions",kind:"I",desc:"Options required for when using the Finance plugin",props:[{name:"autoHandleFDC3AdaptableMessages",kind:"b",desc:"Whether `FDC3MessageSent` Adaptable events should be automatically delegated to the FDC3 API (either via `fdc3.raiseIntent(...)` or `fdc3.broadcast(...)` )",isOpt:!0,defVal:"TRUE"},{name:"availableFDC3Intents",kind:"u",desc:"Intents to which to subscribe.",isOpt:!0},{name:"fdc3Columns",kind:"u",desc:"Columns to be defined as FDC3-related",isOpt:!0},{name:"onFDC3Context",kind:"u",desc:"Called when a context changes.",isOpt:!0},{name:"onFDC3Intent",kind:"u",desc:"Called when an intent from `availableIntents` is raised.",isOpt:!0}]},FinsemblePluginOptions:{name:"FinsemblePluginOptions",kind:"I",desc:"Options required for when using the Finsemble plugin",props:[{name:"applicationName",kind:"s",desc:"Application name - used to identify the application in Finsemble console",isOpt:!0},{name:"showAdaptableAlertsAsNotifications",kind:"b",desc:"Should Adaptable's Alerts appear as Finsemble Notifications",isOpt:!0,defVal:"true"},{name:"stateOptions",kind:"R",desc:"Options for managing Adaptable State with Finsemble State",isOpt:!0,ref:"FinsemblePluginStateOptions"}]},FinsemblePluginStateOptions:{name:"FinsemblePluginStateOptions",kind:"I",desc:"Options for managing state while using Finsemble",props:[{name:"key",kind:"s",desc:"Key used to persist/load AdapTable State in Finsemble"},{name:"persistInFinsemble",kind:"b",desc:"Whether to persist AdapTable State inside Finsemble"},{name:"topic",kind:"s",desc:"Topic used to persist/load AdapTable State in Finsemble"}]},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:"Where Flashing Cell can display: Column[s] or DataType[s]",ref:"AdaptableScope"},{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:"'row' | 'cell'",desc:"Should a cell or whole row flash",isOpt:!0,defVal:"'cell'"},{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:"Predefined Configuration for Flashing Cell module",props:[{name:"FlashingCellDefinitions",kind:"a",desc:"Flashing Cell Definitions - will colour cells/rows when rule is met",isOpt:!0}]},FormatColumn:{name:"FormatColumn",kind:"I",desc:"Object used in Format Column function",props:[{name:"CellAlignment",kind:"'Left' | 'Right' | 'Center'",desc:"Aligns cells 'Left' or 'Right' or 'Center'",isOpt:!0},{name:"ColumnStyle",kind:"R",desc:"",isOpt:!0,ref:"unknown"},{name:"DisplayFormat",kind:"R",desc:"Display Format to apply to Column can be Numeric, String or Date",isOpt:!0,ref:"AdaptableFormat"},{name:"IncludeGroupedRows",kind:"b",desc:"Whether to Format the Column in Grouped Rows",isOpt:!0,defVal:"false"},{name:"Rule",kind:"R",desc:"Rule used to decide whether to apply the 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 all Columns of given DataType",ref:"AdaptableScope"},{name:"Style",kind:"R",desc:"Style to apply",isOpt:!0,ref:"AdaptableStyle"}]},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:"Predefined Configuration for Format Column Module",props:[{name:"FormatColumns",kind:"a",desc:"Collection of Format Columns",isOpt:!0}]},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:"Predefined Configuration 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"}]},GeneralOptions:{name:"GeneralOptions",kind:"I",desc:"General options for configuring AdapTable including managing Primary Keys",props:[{name:"alternativeModuleNames",kind:"a",desc:"Alternative names to use for Adaptable Modules in toolbars and menus",isOpt:!0,defVal:"null"},{name:"cellSummaryOperations",kind:"u",desc:"Custom Cell Summary Operations to add to shipped set",isOpt:!0},{name:"customSortComparers",kind:"u",desc:"CustomSort column comparer functions",isOpt:!0},{name:"dataSets",kind:"a",desc:"Collection of Data Sets to provide Data to AdapTable",isOpt:!0},{name:"disableDeleteConfirmation",kind:"b",desc:"Hides confirmation dialog which displays whenever an AdaptableObject is deleted",isOpt:!0,noCode:"item",defVal:"false"},{name:"englishVariant",kind:"'GB' | 'US'",desc:"English variant to use in UI labels",isOpt:!0,gridInfo:"item",defVal:"'GB'"},{name:"holidays",kind:"R",desc:"Holidays - used to determine Working Days",isOpt:!0,defVal:"null",ref:"Holidays"},{name:"restoreUngroupedColumns",kind:"b",desc:"Places ungrouped columns at pre-grouping indexed position",isOpt:!0,noCode:"item",defVal:"false"},{name:"showGroupingTotalsAsHeader",kind:"b",desc:"Show aggregated totals row at top of Grid when row grouping",isOpt:!0,gridInfo:"item",defVal:"false"},{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:"unbalancedGroupsKey",kind:"u",desc:"Value to use for 'Unbalanced Groups' (string columns)",isOpt:!0}]},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"}]},Glue42PluginOptions:{name:"Glue42PluginOptions",kind:"I",desc:"Options for using the Glue42 Desktop plugin",props:[{name:"gatewayURL",kind:"s",desc:"Gateway URL",isOpt:!0},{name:"glue",kind:"u",desc:"Main Glue desktop object",isOpt:!0},{name:"glue42Office",kind:"u",desc:"Main Glue42 Office object",isOpt:!0},{name:"password",kind:"s",desc:"Password to use to login to Glue42; typically sourced from PC Credentials",isOpt:!0},{name:"username",kind:"s",desc:"UserName to use to login to Glue42; typically sourced from PC Credentials",isOpt:!0}]},Glue42Report:{name:"Glue42Report",kind:"I",desc:"Glue42 report - currently just contains name of Report",props:[{name:"ReportName",kind:"s",desc:"The Report's name (as exists in Export State)"}]},Glue42Schedule:{name:"Glue42Schedule",kind:"I",desc:"Defines Glue42 Scheduled Report; used in Schedule Module (where State is stored)",props:[{name:"Glue42Report",kind:"R",desc:"The Glue42 Report which will be sent when the Schedule runs",ref:"Glue42Report"},{name:"Transmission",kind:"'Snapshot' | 'Live Data'",desc:"Whether its a one-off or 'streaming' transmission"}]},Glue42State:{name:"Glue42State",kind:"I",desc:"Internal State used by AdapTable for managing the Glue42 plugin",props:[{name:"CurrentLiveGlue42Report",kind:"R",desc:"Which Glue42 Report is currently live",isOpt:!0,ref:"Glue42Report"},{name:"Glue42LoginErrorMessage",kind:"s",desc:"Message to show when Login Fails",isOpt:!0},{name:"IsGlue42Available",kind:"b",desc:"Whether Glue42 is available",isOpt:!0},{name:"IsGlue42Running",kind:"b",desc:"Whether Glue42 is running",isOpt:!0}]},Glue42WebPluginOptions:{name:"Glue42WebPluginOptions",kind:"I",desc:"Options for using the Glue42 Web plugin",props:[{name:"showAdaptableAlertsAsNotifications",kind:"b",desc:"Converts AdapTable Alerts configured to display in popup as Glue42 Notifications",isOpt:!0,defVal:"true"}]},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:"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:"Actual raw value of cell"},{name:"rowNode",kind:"u",desc:"AG Grid Row Node that holds the cell"}]},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}]},GridInfoSection:{name:"GridInfoSection",kind:"A",desc:"Tabs available in the Grid Info Settings Panel"},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}]},HolidayContext:{name:"HolidayContext",kind:"I",desc:"Context used for isHoliday function",props:[{name:"adaptableId",kind:"s",desc:"Id of current AdapTable instance"},{name:"dateToCheck",kind:"d",desc:"Date being checked"},{name:"userName",kind:"s",desc:"Name of Current User"}]},Holidays:{name:"Holidays",kind:"I",desc:"Holidays - can be list or function (latter takes preference)",props:[{name:"isHoliday",kind:"f",desc:"Function which returns true if given date is a holiday",isOpt:!0},{name:"list",kind:"a",desc:"Holidays provided as valid ISO date strings",isOpt:!0}]},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"},InstrumentColumn:{name:"InstrumentColumn",kind:"I",desc:"A Column which will be defined as an FDC3 Instrument",props:[{name:"bbgColumnId",kind:"s",desc:"Column which holds a Bloomberg Ticker value as instrument data",isOpt:!0},{name:"cusipColumnId",kind:"s",desc:"Column which holds a CUSIP value as instrument data",isOpt:!0},{name:"figiColumnId",kind:"s",desc:"Column which holds a [FIGI](https://www.openfigi.com/about/figi) value as instrument data",isOpt:!0},{name:"intents",kind:"R",desc:"Instrument-related FDC3 Intents; can be: `ViewChart` `ViewQuote` `ViewNews` `ViewAnalysis` `ViewInstrument`",isOpt:!0,ref:"InstrumentIntents"},{name:"isinColumnId",kind:"s",desc:"Column which holds an ISIN value as instrument data",isOpt:!0},{name:"permidColumnId",kind:"s",desc:"Column which holds a PERMID value as instrument data",isOpt:!0},{name:"ricColumnId",kind:"s",desc:"Column which holds a Reuters Instrument Code value as instrument data",isOpt:!0},{name:"sedolColumnId",kind:"s",desc:"Column which holds a SEDOL value as instrument data",isOpt:!0},{name:"tickerColumnId",kind:"s",desc:"Column which holds a ticker value as instrument data",isOpt:!0}]},InstrumentContext:{name:"InstrumentContext",kind:"I",desc:"FDC3 Context to define a financial Instrument",props:[{name:"id",kind:"u",desc:"Instrument data: ticker, ISIN, CUSIP, SEDOL, RIC, BBG, PERMID, FIGI",isOpt:!0},{name:"name",kind:"s",desc:"Free text name of the Instrument",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `instrument`"}]},InstrumentIntent:{name:"InstrumentIntent",kind:"A",desc:"FDC3 Intents available to an Instrument Column"},InstrumentIntents:{name:"InstrumentIntents",kind:"A",desc:"All available Instrument Intents"},InstrumentListContext:{name:"InstrumentListContext",kind:"I",desc:"FDC3 Context to define an array of financial Instruments",props:[{name:"id",kind:"u",desc:"Optional Id",isOpt:!0},{name:"instruments",kind:"a",desc:"The instrument data",isOpt:!0},{name:"name",kind:"s",desc:"Free text name of list of Instruments (not set by AdapTable)",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `instrumentList`"}]},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"},Layout:{name:"Layout",kind:"I",desc:"Defines a Layout; contains everything required i.e. Columns, Sorts, Widths, Aggregations, Grouping & Pivoting",props:[{name:"AggregationColumns",kind:"R",desc:"Columns showing aggregated values in grouped 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:"unknown"},{name:"AutoSave",kind:"b",desc:"Whether Layout should automatically save or not - overrides `autoSaveLayouts` property in LayoutOptions",isOpt:!0},{name:"ColumnFilters",kind:"a",desc:"Collection of Column Filters.",isOpt:!0},{name:"ColumnHeadersMap",kind:"u",desc:"Set of custom header names for some (or all columns)",isOpt:!0},{name:"Columns",kind:"a",desc:"Which columns should be visible in the Layout and in which order"},{name:"ColumnSorts",kind:"a",desc:"Sorting to apply in the Layout",isOpt:!0},{name:"ColumnWidthMap",kind:"u",desc:"Set of widths for some (or all columns)",isOpt:!0},{name:"EnablePivot",kind:"b",desc:"Whether pivoting should be enabled in the Grid when this Layout loads",isOpt:!0},{name:"ExpandedRowGroupValues",kind:"a",desc:"Opened Row Groups - set if `displayRowGroups` in LayoutOptions is 'dynamic'",isOpt:!0},{name:"Name",kind:"s",desc:"Name of Layout as will appear in Layout toolbar and tool panel"},{name:"PinnedColumnsMap",kind:"{\n        [columnId: string]: 'left' | 'right';\n    }",desc:"Set of pinned Columns",isOpt:!0},{name:"PivotColumns",kind:"a",desc:"List of Columns which should be pivoted when grid is in pivot mode",isOpt:!0},{name:"RowGroupedColumns",kind:"a",desc:"Columns which are row-grouped when the Layout is applied",isOpt:!0},{name:"SuppressAggFuncInHeader",kind:"b",desc:"Whether to include the aggFunc name in the column header: e.g. 'sum(Bank Balance)' will just be 'Bank Balance'",isOpt:!0}]},LayoutAssociatedObject:{name:"LayoutAssociatedObject",kind:"A",desc:"Types of Adaptable Objects that can be associated with a Layout"},LayoutAvailableContext:{name:"LayoutAvailableContext",kind:"I",desc:"Context for `LayoutOptions.isObjectAvailableInLayout` functions",props:[{name:"adaptableObject",kind:"R",desc:"Object being checked",ref:"LayoutAssociatedObject"},{name:"layout",kind:"R",desc:"Current Layout",ref:"Layout"},{name:"module",kind:"R",desc:"Current Adaptable Module",ref:"AdaptableModule"}]},LayoutOptions:{name:"LayoutOptions",kind:"I",desc:"Options for configuring Layouts; these manage Column visibility, order, sorting, grouping and width",props:[{name:"autoSaveLayouts",kind:"b",desc:"Layouts save whenever Grid's column / sort info changes; if false, a Save button will display",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"true"},{name:"autoSizeColumnsInLayout",kind:"b",desc:"Columns auto-size when Layout loads for first time",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"autoSizeColumnsInPivotLayout",kind:"b",desc:"Columns auto-size when Pivot Layout loads first time (overriding Layout width properties)",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"createDefaultLayout",kind:"b",desc:"Whether a "Default Layout" will be created in addition to Layouts provided in Config",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"displayRowGroups",kind:"'dynamic' | 'expanded' | 'closed'",desc:"Whether Row Groups display all as expanded, all as closed or dynamically (i.e. saved in Layout)",isOpt:!0,gridInfo:"item",defVal:"'closed'"},{name:"layoutTagOptions",kind:"R",desc:"Options for leveraging Object Tags to extend Layouts",isOpt:!0,ref:"unknown"},{name:"layoutViewOptions",kind:"R",desc:"Customize how Layouts are displayed in Settings Panel",isOpt:!0,ref:"LayoutViewOptions"},{name:"pivotPreviewColumns",kind:"u",desc:"Columns displayed in Table that opens when viewing contents of Pivot Cells",isOpt:!0}]},LayoutState:{name:"LayoutState",kind:"I",desc:"Predefined Configuration for the Layout Module",props:[{name:"CurrentLayout",kind:"s",desc:"Layout which will be loaded when AdapTable starts - must match `Name` property in Layout",isOpt:!0},{name:"Layouts",kind:"a",desc:"Collection of Layout objects - listed in Layout toolbar and Tool Panel",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"}]},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}]},MenuOptions:{name:"MenuOptions",kind:"I",desc:"Options for managing menus in AdapTable",props:[{name:"columnMenuItems",kind:"a",desc:"User-defined Menu Items to add to the Column Menu",isOpt:!0},{name:"columnMenuOrder",kind:"u",desc:"Order in which AG Grid, AdapTable and User Menu items will appear in Column Menu",isOpt:!0,gridInfo:"item",defVal:"'aggrid', 'adaptable', 'user'"},{name:"contextMenuItems",kind:"a",desc:"User-defined Menu Items to add to the Context Menu",isOpt:!0},{name:"contextMenuOrder",kind:"u",desc:"Order in which AG Grid, AdapTable and User Menu items will appear in Context Menu",isOpt:!0,gridInfo:"item",defVal:"'aggrid', 'adaptable', 'user'"},{name:"showAdaptableColumnMenu",kind:"u",desc:"Show Adaptable Column Menu (or specific items); can be boolean value or function invoked for each menu item",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"showAdaptableContextMenu",kind:"u",desc:"Show Adaptable Context Menu (or specific items); can be boolean value or function invoked for each menu item",isOpt:!0,gridInfo:"item",defVal:"true"},{name:"showUngroupColumnMenuItem",kind:"b",desc:"Adds 'Ungroup' Column Menu item to a row grouped column",isOpt:!0,gridInfo:"item",defVal:"true"}]},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 ExpressionOptions.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 used in multiple AdapTable Modules",props:[{name:"Name",kind:"s",desc:"Name of the Query - how it will appear in Query dropdown"}]},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:"TOAST_POSITIONS"},{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 a number",isOpt:!0},{name:"Ceiling",kind:"b",desc:"Returns smallest integer  number",isOpt:!0},{name:"Content",kind:"string | number",desc:"Replaces cell value with supplied value",isOpt:!0},{name:"Floor",kind:"b",desc:"Returns largest intger  number",isOpt:!0},{name:"FractionDigits",kind:"n",desc:"Number of digits to show in fractions",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",isOpt:!0},{name:"IntegerSeparator",kind:"s",desc:"Separator to use in integers",isOpt:!0},{name:"Multiplier",kind:"n",desc:"Multiplier to use on the number",isOpt:!0},{name:"Parentheses",kind:"b",desc:"Shows negative numbers in parentheses",isOpt:!0},{name:"Prefix",kind:"s",desc:"Prefix to use before the number",isOpt:!0},{name:"Round",kind:"b",desc:"Rounds a Number",isOpt:!0},{name:"Suffix",kind:"s",desc:"Suffix to use after the number",isOpt:!0},{name:"Truncate",kind:"b",desc:"Truncates a number",isOpt:!0}]},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:"onFDC3MessageSent",kind:"f",desc:"Useful when you also use the finance plugin configured with fdc3 related columns - values in cells such columns can be broadcasted to fdc3, and this function will be called for broadcasting. It's your job to broadcast to the desired fdc3 channel",isOpt:!0},{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"},OrganizationColumn:{name:"OrganizationColumn",kind:"I",desc:"A (String) Column which will be defined as an FDC3 Organization",props:[{name:"fds_idColumnId",kind:"s",desc:"Column which contains an FDS_ID",isOpt:!0},{name:"intents",kind:"R",desc:"Organization-related FDC3 Intents; can be: `ViewNews` `ViewAnalysis`",isOpt:!0,ref:"unknown"},{name:"leiColumnId",kind:"s",desc:"Column which contains the LEI",isOpt:!0},{name:"permidColumnId",kind:"s",desc:"Column which contains a PermId",isOpt:!0}]},OrganizationContext:{name:"OrganizationContext",kind:"I",desc:"FDC3 Context to define an Organization",props:[{name:"id",kind:"u",desc:"The Organization data: LEI, PERMID, FDS_ID",isOpt:!0},{name:"name",kind:"s",desc:"Free text name of Organization",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `organization`"}]},OrganizationIntent:{name:"OrganizationIntent",kind:"A",desc:"FDC3 Intents available to an Organization Column"},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"}]},PermittedValues:{name:"PermittedValues",kind:"I",desc:"Permitted/possible values, when column values can be selected (e.g. sort, bulk-update)",props:[{name:"values",kind:"u",desc:"Values to display: either hardcoded list or a function that returns a list",isOpt:!0}]},PermittedValuesContext:{name:"PermittedValuesContext",kind:"I",desc:"Context used when getting PermittedValues via a function",props:[{name:"column",kind:"u",desc:"Column whose values are being displayed"}]},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"}]},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:"AdaptableScope"}]},PlusMinusState:{name:"PlusMinusState",kind:"I",desc:"Predefined Configuration for Plus Minus Module",props:[{name:"PlusMinusNudges",kind:"a",desc:"Array of Plus Minus Nudges",isOpt:!0}]},PortfolioContext:{name:"PortfolioContext",kind:"I",desc:"FDC3 Context to define a financial Portfolio (array of Positions)",props:[{name:"id",kind:"u",desc:"Optional Id",isOpt:!0},{name:"name",kind:"s",desc:"Free text name of portfolio",isOpt:!0},{name:"positions",kind:"a",desc:"The position data",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `portfolio`"}]},PositionColumn:{name:"PositionColumn",kind:"I",desc:"A (Numeric) Column which will be defined as an FDC3 Position",props:[{name:"instrumentColumnId",kind:"s",desc:"Column which contains the Instrument information of the FDC3 Message"},{name:"intents",kind:"R",desc:"Position-related FDC3 Intents; can be: `ViewChart` `ViewNews` `ViewAnalysis`",isOpt:!0,ref:"PositionIntents"}]},PositionContext:{name:"PositionContext",kind:"I",desc:"FDC3 Context to define a financial Position (requires an Instrument)",props:[{name:"holding",kind:"n",desc:"Holding in the Position (mandatory)"},{name:"id",kind:"u",desc:"Optional Id",isOpt:!0},{name:"instrument",kind:"R",desc:"The `InstrumentContext` of the relevant Instrument",ref:"InstrumentContext"},{name:"name",kind:"s",desc:"Free text name of Position",isOpt:!0},{name:"type",kind:"u",desc:"Context type is always `position`"}]},PositionIntent:{name:"PositionIntent",kind:"A",desc:"FDC3 Intents available to a Position Column"},PositionIntents:{name:"PositionIntents",kind:"A",desc:"All available Position Intents"},PredefinedConfig:{name:"PredefinedConfig",kind:"I",desc:"This is the main Predefined Config interface which developers will populate at design-time",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:"Supplies a 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:"ConditionalStyle",kind:"R",desc:"",isOpt:!0,ref:"unknown"},{name:"CustomSort",kind:"R",desc:"Supplies a 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:"Supplies a 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:"Supplies a 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:"Supplies a 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:"Supplies a collection of *Layout* objects to name and manage groups of column visibility, order and sorts.",isOpt:!0,ref:"LayoutState"},{name:"PlusMinus",kind:"R",desc:"Supplies a collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell",isOpt:!0,ref:"PlusMinusState"},{name:"Query",kind:"R",desc:"Named Queries available for use across multiple AdapTable Modules; and `CurrentQuery` - an Expression to run at start-up",isOpt:!0,ref:"QueryState"},{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:"Supplies a collection of *Schedule* objects",isOpt:!0,ref:"ScheduleState"},{name:"Shortcut",kind:"R",desc:"Supplies a 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:"Supplies a 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"}]},PredicateDefHandlerParams:{name:"PredicateDefHandlerParams",kind:"I",desc:"Object passed into an Adaptable Predicate Definition",props:[{name:"api",kind:"R",desc:"The Adaptable Api",ref:"unknown"},{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:"inputs",kind:"a",desc:"Any inputs required to perform evaluation"},{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:"value",kind:"u",desc:"Raw value in cell being evaluated"}]},PredicateOptions:{name:"PredicateOptions",kind:"I",desc:"Options for managing Adaptable Predicates using AdaptableQL",props:[{name:"systemAlertPredicates",kind:"u",desc:"Which System Alert Predicates are available",isOpt:!0},{name:"systemBadgeStylePredicates",kind:"u",desc:"Which System Badge Style Predicates are available",isOpt:!0},{name:"systemFilterPredicates",kind:"u",desc:"Which System Filter Predicates are available",isOpt:!0},{name:"systemFlashingCellPredicates",kind:"u",desc:"Which System Flashing Cell Predicates are available",isOpt:!0},{name:"systemFormatColumnPredicates",kind:"u",desc:"Which System Format Column Predicates are available",isOpt:!0}]},PreProcessExportContext:{name:"PreProcessExportContext",kind:"I",desc:"Context provided to `ExportOptions.processExport()` callback used when pre-processing Export",props:[{name:"getReportColumns",kind:"u",desc:"Returns Columns to export based on Report's `ReportColumnScope`"},{name:"getReportRowData",kind:"u",desc:"Returns row data which would typically be exported based on the Report's `ReportRowScope`"},{name:"report",kind:"R",desc:"Report being exported",ref:"Report"}]},QueryableColumnContext:{name:"QueryableColumnContext",kind:"I",desc:"Context passed when evaluating Queryable Columns",props:[{name:"adaptableColumn",kind:"R",desc:"Basic Column Info - just ColumnId, DataType and FriendlyName",ref:"AdaptableColumnBase"}]},QueryState:{name:"QueryState",kind:"I",desc:"Predefined Configuration for Query Module",props:[{name:"CurrentQuery",kind:"s",desc:"Expression used for the Query currently being run",isOpt:!0},{name:"NamedQueries",kind:"a",desc:"Named Queries - can be referenced in other Expressions",isOpt:!0}]},QuickSearchState:{name:"QuickSearchState",kind:"I",desc:"Predefined Configuration for Quick Search Module",props:[{name:"QuickSearchText",kind:"s",desc:"Last Quick Search that was run (and will run again at start up)",isOpt:!0},{name:"Style",kind:"R",desc:"Style to use to highlight matching cells - uses common `AdaptableStyle` object",isOpt:!0,ref:"AdaptableStyle"}]},RaiseFDC3IntentContext:{name:"RaiseFDC3IntentContext",kind:"I",desc:"Context passed into Raise FDC3 Intent functions (e.g. get label)",props:[{name:"intent",kind:"u",desc:"FDC3 Intent that was raised"}]},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:"u",desc:"Name of Report"},{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', 'SelectedCellRows', 'SelectedRows', 'ExpressionRows'",ref:"ReportRowScope"},{name:"Scope",kind:"R",desc:"Columns Scope; only required if `ReportColumnScope` is 'ScopeColumns'",isOpt:!0,ref:"AdaptableScope"}]},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:"report",kind:"R",desc:"Definition of Report being Run",ref:"Report"},{name:"reportData",kind:"R",desc:"Data being exported in the Report",ref:"ReportData"}]},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:"rows",kind:"u",desc:"Row Data in the Report"}]},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:"'Excel' | 'CSV' | 'Clipboard' | 'JSON' | string",desc:"Where report data will be exported"},{name:"ExportDestinationData",kind:"R",desc:"Additional data for a Custom Destination produced by a Dynamic Form",isOpt:!0,ref:"AdaptableFormData"},{name:"ReportName",kind:"s",desc:"Name of Report to run on Schedule"}]},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 the highlight is removed",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}]},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}]},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:"Predefined Configuration for the Schedule Module",props:[{name:"Glue42Schedules",kind:"a",desc:"Schedules connected to Glue42 exports - available if Glue42 plugin is running",isOpt:!0},{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}]},SearchOptions:{name:"SearchOptions",kind:"I",desc:"Search options section of Adaptable Options; includes options for running some (or all) search functions on the server",props:[{name:"clearSearchesOnStartUp",kind:"b",desc:"Clears saved searches when AdapTable loads",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"excludeColumnFromQuickSearch",kind:"u",desc:"Function enabling specific Columns to be excluded from Quick Search",isOpt:!0,defVal:"undefined"},{name:"filterResultsAfterQuickSearch",kind:"b",desc:"Filters the quick search results so only matching rows are displayed",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'"},{name:"runQuickSearchOnRowGroups",kind:"b",desc:"Include Aggregrated Columns in Grouped Rows when Quick Searching (highlight only)",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"}]},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:"Describes which Rows are currently selected in AdapTable",props:[{name:"gridRows",kind:"u",desc:"Array of Grid Rows containing full information about a row in AdapTable"}]},ServerReport:{name:"ServerReport",kind:"I",desc:"Defines a Report where all the data is provided entirely by the user",props:[{name:"name",kind:"s",desc:"Name of the Report"},{name:"onRunReport",kind:"f",desc:"Function invoked to return the data (in the form of a `ReportData` object)"}]},ServerValidationContext:{name:"ServerValidationContext",kind:"I",desc:"Context used when validating data edits on Server",props:[{name:"cellDataChangedInfo",kind:"u",desc:"Details of Cell Edit"}]},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:"Settings Panel Icon: `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:"'modal' | 'window'",desc:"How Settings Panel behaves: can be 'window' (movable, resizable no backdrop) or 'modal' (centre of screen with backdrop)",isOpt:!0,defVal:"'window'"},{name:"position",kind:"u",desc:"Initial position of Settings Panel window",isOpt:!0,defVal:"Middle of Screen"},{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",props:[{name:"adaptableId",kind:"s",desc:"`AdaptableOptions.adaptableId`"},{name:"userName",kind:"s",desc:"`AdaptableOptions.userName`"}]},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:"Predefined Configuration 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:"'String' | 'Number' | 'Boolean' | 'Date' | 'NumberArray'",desc:"Expression's return value DataType, only mandatory property"},{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 state loading with custom functionality",props:[{name:"applyState",kind:"u",desc:"Allows hooking into Adaptable State hydration",isOpt:!0},{name:"clearState",kind:"R",desc:"Allows clearing of remote Adaptable State",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:"Allows customization of Adaptable State loading",isOpt:!0,ref:"AdaptableLoadStateFunction"},{name:"persistState",kind:"R",desc:"Allows customization of Adaptable State persistence",isOpt:!0,ref:"AdaptablePersistStateFunction"},{name:"saveState",kind:"R",desc:"Allows customization of Adaptable State about to be persisted",isOpt:!0,ref:"AdaptableSaveStateFunction"}]},StatusBarState:{name:"StatusBarState",kind:"I",desc:"Predefined Configuration 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:"CheckBoxStyle",kind:"b",desc:"Renders a Checkbox in a boolean column",isOpt:!0},{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:"IncludeGroupedRows",kind:"b",desc:"Includes Styled Column in Grouped Rows",isOpt:!0,defVal:"false"},{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:"Predefined Configuration 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"},SystemExportDestinations:{name:"SystemExportDestinations",kind:"A",desc:"List of 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:"AdaptableScope"},{name:"moduleScope",kind:"R",desc:"Module for which Predicates are being retrieved",ref:"unknown"},{name:"systemPredicateDefs",kind:"a",desc:"AdapTable-provided System Predicate Definitions"}]},SystemReportName:{name:"SystemReportName",kind:"A",desc:"Names of Reports provided by AdapTable"},SystemReportNames:{name:"SystemReportNames",kind:"A",desc:"Array containing all 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}]},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:"suppressOverrideConfigWarning",kind:"b",desc:"Suppress warning when an Import overrides existing Config 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; this is internal so not designed to be provided as part of Predefined Config",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}]},TOAST_POSITIONS:{name:"TOAST_POSITIONS",kind:"A",desc:"Different positions offered by Notifications"},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:"Predefined Configuration 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"},UnbalancedGroupsKeyContext:{name:"UnbalancedGroupsKeyContext",kind:"I",desc:"Context used when setting a value for Unbalanced Row Groups",props:[{name:"adaptableColumn",kind:"u",desc:"Adaptable Column being grouped"},{name:"params",kind:"u",desc:"AG Grid's Key Creator Params"}]},UserInterfaceOptions:{name:"UserInterfaceOptions",kind:"I",desc:"Options for managing the User Interface of AdapTable",props:[{name:"applicationIcon",kind:"R",desc:"The application icon to appear in Dashboard and elsewhere (e.g. OpenFin notifications)",isOpt:!0,defVal:"null",ref:"AdaptableIcon"},{name:"bulkUpdatePermittedValues",kind:"u",desc:"Custom column values for editing via bulk-update; when not defined defaults to permittedValues",isOpt:!0},{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:"customDisplayFormatters",kind:"a",desc:"Custom Formatters to use in the Format Column Module",isOpt:!0},{name:"customSortPermittedValues",kind:"u",desc:"Custom column values for defining Custom Sort; when not defined defaults to permittedValues",isOpt:!0},{name:"dateInputOptions",kind:"R",desc:"Options for managing and customizing date inputs in AdapTable",isOpt:!0,ref:"DateInputOptions"},{name:"editableCellStyle",kind:"R",desc:"Style to set for editable cells",isOpt:!0,ref:"AdaptableStyle"},{name:"editLookUpItems",kind:"u",desc:"Dropdown values displayed when column is being edited; when not defined defaults to permittedValues",isOpt:!0},{name:"filterPermittedValues",kind:"u",desc:"Custom column values for 'IN' filter; when not defined defaults to permittedValues",isOpt:!0},{name:"gridInfoSections",kind:"R",desc:"Which sections to show in the Grid Info Screen",isOpt:!0,defVal:"['GridSummary', 'AdaptableOptions', 'ColumnInfo', 'AdaptableObjects']",ref:"unknown"},{name:"objectTags",kind:"u",desc:"Optional list of AdaptableObjectTags that can be associated with AdaptableObjects",isOpt:!0},{name:"permittedValues",kind:"u",desc:"List of values which are permitted (e.g. to show in Filter, Custom Sort etc.)",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:"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:"R",desc:"Optional icon to display",isOpt:!0,ref:"AdaptableIcon"},{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}]},ValidationResult:{name:"ValidationResult",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:"NewValue",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}]},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"}]}};