@adaptabletools/adaptable 13.0.6 → 13.0.7

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:"TypeAlias",description:"Defines Access Level for an Entitlement - can be `ReadOnly`, `Hidden` or `Full`"},ActionApi:{name:"ActionApi",kind:"Interface",description:"A large range of column-related functions in AdapTable",properties:[{name:"displayCloneActionRow",kind:"function",description:"Open create dialog for cloning an existing row",uiLabel:"Display Clone Action Row"},{name:"displayCreateActionRow",kind:"function",description:"Open create dialog for a new row",uiLabel:"Display Create Action Row"},{name:"displayEditActionRow",kind:"function",description:"Open edit dialog for row with the given primary key value",uiLabel:"Display Edit Action Row"},{name:"getAllActionColumn",kind:"function",description:"Retrieves any Action Columns (provided in User Interface Options)",uiLabel:"Get All Action Column"}]},ActionColumn:{name:"ActionColumn",kind:"Interface",description:"A Special Column that wraps an AdapTable Button",properties:[{name:"actionColumnButton",kind:"unknown",description:"Button (or list of buttons) to display in the Column",uiLabel:"Action Column Button"},{name:"actionColumnSettings",kind:"REFERENCE",description:"Additional optional properties for Column (e.g. filterable, resizable)",uiLabel:"Action Column Settings",isOptional:!0,reference:"ActionColumnSettings"},{name:"columnId",kind:"string",description:"Mandatory 'Id'; if no value set for `FriendlyName`, this will also be Column name",uiLabel:"Column Id"},{name:"friendlyName",kind:"string",description:"How Column appears in Column Header, Menus; if no value set, `ColumnId` is used",uiLabel:"Friendly Name",isOptional:!0},{name:"includeGroupedRows",kind:"boolean",description:"Shows Action Column also in grouped rows",uiLabel:"Include Grouped Rows",isOptional:!0}]},ActionColumnContext:{name:"ActionColumnContext",kind:"Interface",description:"Context required by functions when using an Action Column Button",properties:[{name:"actionColumn",kind:"REFERENCE",description:"Action Column in question",uiLabel:"Action Column",reference:"ActionColumn"},{name:"data",kind:"unknown",description:"The row's data",uiLabel:"Data"},{name:"primaryKeyValue",kind:"unknown",description:"Primary Key Value in current row",uiLabel:"Primary Key Value"},{name:"rowNode",kind:"REFERENCE",description:"Current AG Grid Row Node",uiLabel:"Row Node",reference:"unknown"}]},ActionColumnSettings:{name:"ActionColumnSettings",kind:"Interface",description:"Set of optional properties that define an Action Columns behaviour",properties:[{name:"resizable",kind:"boolean",description:"Whether Column can be resized (by dragging column header edges)",uiLabel:"Resizable",isOptional:!0,defaultValue:"true"},{name:"suppressMenu",kind:"boolean",description:"Whether no menu should be shown for this Column header.",uiLabel:"Suppress Menu",isOptional:!0,defaultValue:"false"},{name:"suppressMovable",kind:"boolean",description:"Whether if this Column should be movable via dragging",uiLabel:"Suppress Movable",isOptional:!0,defaultValue:"false"},{name:"width",kind:"number",description:"Preferred width (in pixels) for Column; if unset, calculated dynamically by AG Grid",uiLabel:"Width",isOptional:!0}]},ActionHandler:{name:"ActionHandler",kind:"TypeAlias",description:"Handles a Form Button Action"},ActionOptions:{name:"ActionOptions",kind:"Interface",description:"Options related to Action Columns and Buttons in Adaptable.",properties:[{name:"actionColumns",kind:"array",description:"Columns which contain an AdapTable Button - used for performing Actions",uiLabel:"Action Columns",isOptional:!0},{name:"actionRowButtonCustomConfiguration",kind:"unknown",description:"Optional custom configuration that, when specified, merges with the built-in action row button and overrides the default configuration",uiLabel:"Action Row Button Custom Configuration",isOptional:!0,defaultValue:"undefined"},{name:"actionRowButtons",kind:"array",description:"Action buttons to display for each row.",uiLabel:"Action Row Buttons",isOptional:!0,defaultValue:"undefined"},{name:"actionRowButtonsPosition",kind:"'pinnedLeft' | 'pinnedRight'",description:"Position of supplied Action Buttons",uiLabel:"Action Row Buttons Position",isOptional:!0,defaultValue:"'pinnedLeft'"},{name:"actionRowFormOptions",kind:"REFERENCE",description:"Options for managing the Form which the Action Row displays",uiLabel:"Action Row Form Options",isOptional:!0,reference:"ActionRowFormOptions"},{name:"autoHandleActionRowButtons",kind:"boolean",description:"If set to true, the Action Row Buttons will be handled by AdapTable and the grid data model will be automatically updated with the created/edited/deleted rows",uiLabel:"Auto Handle Action Row Buttons",isOptional:!0,defaultValue:"true"},{name:"setPrimaryKeyValue",kind:"function",description:"Function which is called when auto-handling the 'create' Action Row Button. The returned row value should have a valid(unique) primary key value.",uiLabel:"Set Primary Key Value",isOptional:!0,defaultValue:"undefined"}]},ActionRowContext:{name:"ActionRowContext",kind:"TypeAlias",description:"Context passed into a Row Form - can be `CreateActionRowContext` or `EditActionRowContext`"},ActionRowFormOptions:{name:"ActionRowFormOptions",kind:"Interface",description:"Options for editing (create/update/delete) row entries in the grid",properties:[{name:"formButtons",kind:"array",description:"Custom form buttons provider. If provided, the custom implementation is responsible for firing the 'ActionRowSubmitted' and/or invoking the 'onFormSubmit' callback (if necessary).",uiLabel:"Form Buttons",isOptional:!0},{name:"formDescription",kind:"unknown",description:"Custom form description provider",uiLabel:"Form Description",isOptional:!0,defaultValue:"undefined"},{name:"formFieldLabel",kind:"function",description:"Custom form field label provider",uiLabel:"Form Field Label",isOptional:!0,defaultValue:"undefined"},{name:"formTitle",kind:"unknown",description:"Custom form title provider",uiLabel:"Form Title",isOptional:!0,defaultValue:"'Create New Row'/'Edit Row'"},{name:"onFormSubmit",kind:"function",description:"Function which is invoked 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!",uiLabel:"On Form Submit",isOptional:!0,defaultValue:"undefined"}]},ActionRowSubmittedInfo:{name:"ActionRowSubmittedInfo",kind:"TypeAlias",description:"Info passed into ActionRowSubmitted Event - can be `CreatedActionRowInfo` or `EditedActionRowInfo` or `DeletedActionRowInfo`"},ActionRowType:{name:"ActionRowType",kind:"TypeAlias",description:"Type of Action Row - Created, Edited or Deleted"},AdaptableAlert:{name:"AdaptableAlert",kind:"TypeAlias",description:"Defines an Alert fired by AdapTable"},AdaptableAlertBase:{name:"AdaptableAlertBase",kind:"Interface",description:"Defines the base(common) properties of an Alert fired by AdapTable, regardless of the type of change",properties:[{name:"alertDefinition",kind:"REFERENCE",description:"Rule that caused Alert to fire",uiLabel:"Alert Definition",reference:"AlertDefinition"},{name:"alertType",kind:"unknown",description:"The type of Alert",uiLabel:"Alert Type"},{name:"header",kind:"string",description:"Alert Header text",uiLabel:"Header"},{name:"message",kind:"string",description:"Alert Body text",uiLabel:"Message"}]},AdaptableAlertQuery:{name:"AdaptableAlertQuery",kind:"TypeAlias",description:"Alert Query which may be either a Boolean, Observable or AggregatedBoolean Expression"},AdaptableApi:{name:"AdaptableApi",kind:"Interface",description:"The `AdaptableApi` provides developers with run-time access to AdapTable.",properties:[{name:"actionApi",kind:"REFERENCE",description:"Provides access to Action Rows and Columns",uiLabel:"Action Api",reference:"ActionApi"},{name:"alertApi",kind:"REFERENCE",description:"Provides access to the Alert Module",uiLabel:"Alert Api",reference:"AlertApi"},{name:"applicationApi",kind:"REFERENCE",description:"Provides access to the Application Module",uiLabel:"Application Api",reference:"ApplicationApi"},{name:"bulkUpdateApi",kind:"REFERENCE",description:"Provides access to the Bulk Update Module",uiLabel:"Bulk Update Api",reference:"BulkUpdateApi"},{name:"calculatedColumnApi",kind:"REFERENCE",description:"Provides access to the Calculated Column Module",uiLabel:"Calculated Column Api",reference:"CalculatedColumnApi"},{name:"calendarApi",kind:"REFERENCE",description:"Functions for managing Holidays",uiLabel:"Calendar Api",reference:"CalendarApi"},{name:"cellSummaryApi",kind:"REFERENCE",description:"Provides access to the Cell Summary Module",uiLabel:"Cell Summary Api",reference:"CellSummaryApi"},{name:"chartingApi",kind:"REFERENCE",description:"Provides run-time access to Charting Module and state",uiLabel:"Charting Api",reference:"ChartingApi"},{name:"columnApi",kind:"REFERENCE",description:"Provides a number of column-related methods",uiLabel:"Column Api",reference:"ColumnApi"},{name:"configApi",kind:"REFERENCE",description:"Methods giving access to Adaptable State",uiLabel:"Config Api",reference:"ConfigApi"},{name:"customSortApi",kind:"REFERENCE",description:"Provides access to the Custom Sort Module",uiLabel:"Custom Sort Api",reference:"CustomSortApi"},{name:"dashboardApi",kind:"REFERENCE",description:"Provides access to the Dashboard",uiLabel:"Dashboard Api",reference:"DashboardApi"},{name:"dataChangeHistoryApi",kind:"REFERENCE",description:"Provides run-time access to the Data Changes Module",uiLabel:"Data Change History Api",reference:"DataChangeHistoryApi"},{name:"dataSetApi",kind:"REFERENCE",description:"Provides access to Data Sets",uiLabel:"Data Set Api",reference:"DataSetApi"},{name:"destroy",kind:"unknown",description:"Cleanup method - should be called only when using the vanilla javascript component, as framework components cleanup is performed when the component is destroyed/unmounted. This destroys the Adaptable instance.",uiLabel:"Destroy"},{name:"eventApi",kind:"REFERENCE",description:"Used for listenning / subscribing to the various Events published by AdapTable",uiLabel:"Event Api",reference:"EventApi"},{name:"exportApi",kind:"REFERENCE",description:"Provides access to the Export Module and Reports",uiLabel:"Export Api",reference:"ExportApi"},{name:"filterApi",kind:"REFERENCE",description:"Provides access to AdapTable's filtering functionality",uiLabel:"Filter Api",reference:"FilterApi"},{name:"flashingCellApi",kind:"REFERENCE",description:"Provides access to the Flashing Cell Module",uiLabel:"Flashing Cell Api",reference:"FlashingCellApi"},{name:"formatColumnApi",kind:"REFERENCE",description:"Provides access to the Format Column Module",uiLabel:"Format Column Api",reference:"FormatColumnApi"},{name:"freeTextColumnApi",kind:"REFERENCE",description:"Provides access to the FreeText Column Module",uiLabel:"Free Text Column Api",reference:"FreeTextColumnApi"},{name:"gridApi",kind:"REFERENCE",description:"Provides methods for managing the Grid, and Grid data, directly",uiLabel:"Grid Api",reference:"GridApi"},{name:"internalDestroySelf",kind:"unknown",description:"Cleanup method that only cleans up this api instance (clears event listeners and sets every property to null), but does not destroy the Adaptable instance.",uiLabel:"Internal Destroy Self"},{name:"isDestroyed",kind:"unknown",description:"Whether the Adaptable instance has been destroyed",uiLabel:"Is Destroyed"},{name:"layoutApi",kind:"REFERENCE",description:"Provides access to the Layout Module",uiLabel:"Layout Api",reference:"LayoutApi"},{name:"pluginsApi",kind:"REFERENCE",description:"Offers access to AdapTable Plugin (e.g. ipushpull, OpenFin etc)",uiLabel:"Plugins Api",reference:"PluginsApi"},{name:"plusMinusApi",kind:"REFERENCE",description:"Provides access to the Plus Minus Module",uiLabel:"Plus Minus Api",reference:"PlusMinusApi"},{name:"predicateApi",kind:"REFERENCE",description:"Manages the Predicate - a boolean-return function used in Filters and Alerts",uiLabel:"Predicate Api",reference:"PredicateApi"},{name:"queryApi",kind:"REFERENCE",description:"Provides access to functions related to the Query Module",uiLabel:"Query Api",reference:"QueryApi"},{name:"queryLanguageApi",kind:"REFERENCE",description:"Mangages AdapTableQL (Query Language)",uiLabel:"Query Language Api",reference:"QueryLanguageApi"},{name:"quickSearchApi",kind:"REFERENCE",description:"Provides access to the Quick Search Module",uiLabel:"Quick Search Api",reference:"QuickSearchApi"},{name:"scheduleApi",kind:"REFERENCE",description:"Provides access to the Schedule Module",uiLabel:"Schedule Api",reference:"ScheduleApi"},{name:"scopeApi",kind:"REFERENCE",description:"Manages the `Scope` object - used widely to determine where objects are applied",uiLabel:"Scope Api",reference:"ScopeApi"},{name:"settingsPanelApi",kind:"REFERENCE",description:"Provides access to the Settings Panel",uiLabel:"Settings Panel Api",reference:"SettingsPanelApi"},{name:"shortcutApi",kind:"REFERENCE",description:"Provides access to the Shortcut Module",uiLabel:"Shortcut Api",reference:"ShortcutApi"},{name:"smartEditApi",kind:"REFERENCE",description:"Provides access to the Smart Edit Module",uiLabel:"Smart Edit Api",reference:"SmartEditApi"},{name:"statusBarApi",kind:"REFERENCE",description:"Provides run-time access to the AdapTable Status Bar",uiLabel:"Status Bar Api",reference:"StatusBarApi"},{name:"systemStatusApi",kind:"REFERENCE",description:"Methods related to displaying System Status and application health messages",uiLabel:"System Status Api",reference:"SystemStatusApi"},{name:"teamSharingApi",kind:"REFERENCE",description:"Functions related to run-time Team Sharing of AdapTable objects between colleagues",uiLabel:"Team Sharing Api",reference:"TeamSharingApi"},{name:"themeApi",kind:"REFERENCE",description:"Api methods related to Theme management",uiLabel:"Theme Api",reference:"ThemeApi"},{name:"toolPanelApi",kind:"REFERENCE",description:"Provides access to the AdapTable Tool Panel on the right hand side of the grid",uiLabel:"Tool Panel Api",reference:"ToolPanelApi"},{name:"userInterfaceApi",kind:"REFERENCE",description:"Manages User Interface Options where colours, styles and permitted values are configured",uiLabel:"User Interface Api",reference:"UserInterfaceApi"}]},AdaptableBaseIcon:{name:"AdaptableBaseIcon",kind:"Interface",description:"Base interface for AdaptableIcon",properties:[{name:"className",kind:"string",description:"The class name of the icon",uiLabel:"Class Name",isOptional:!0},{name:"style",kind:"REFERENCE",description:"CSS Properties",uiLabel:"Style",isOptional:!0,reference:"unknown"}]},AdaptableButton:{name:"AdaptableButton",kind:"Interface",description:"Defines a Button that appears in numerous places including Adaptable Form",properties:[{name:"buttonStyle",kind:"unknown",description:"Style for Button - can be object or function that provides a `ButtonStyle` object",uiLabel:"Button Style",isOptional:!0},{name:"disabled",kind:"unknown",description:"Function that disables / enables the button based on its evaluation result",uiLabel:"Disabled",isOptional:!0},{name:"hidden",kind:"unknown",description:"Function which sets whether Button is hidden",uiLabel:"Hidden",isOptional:!0},{name:"icon",kind:"unknown",description:"Icon for Button - can be object or function that provides a `AdaptableIcon` object",uiLabel:"Icon",isOptional:!0},{name:"label",kind:"unknown",description:"Label for Button - can be string or function that provides string",uiLabel:"Label",isOptional:!0},{name:"onClick",kind:"unknown",description:"Function to invoke when button is clicked",uiLabel:"On Click",isOptional:!0},{name:"tooltip",kind:"unknown",description:"Tooltip for Button - can be string or function that provides string",uiLabel:"Tooltip",isOptional:!0}]},AdaptableCalculatedColumnQuery:{name:"AdaptableCalculatedColumnQuery",kind:"TypeAlias",description:"Calculated Column Query which may be a Scalar or an AggregatedScalar Expression"},AdaptableCellChangedAlert:{name:"AdaptableCellChangedAlert",kind:"Interface",description:"Defines an Alert fired by AdapTable when a cell is changed",properties:[{name:"cellDataChangedInfo",kind:"REFERENCE",description:"Cell DataChange which triggered Alert",uiLabel:"Cell Data Changed Info",reference:"CellDataChangedInfo"}]},AdaptableClearStateFunction:{name:"AdaptableClearStateFunction",kind:"Interface",description:"Allows clearing state when a custom persistState is used. Only called by configApi.reloadPredefinedConfig"},AdaptableColumn:{name:"AdaptableColumn",kind:"Interface",description:"Defines an Adaptable Column - created at run-time based on AG Grid column definition",properties:[{name:"aggregatable",kind:"boolean",description:"Is Column able to display aggregations (e.g. 'sum') when grouped",uiLabel:"Aggregatable"},{name:"aggregationFunction",kind:"string",description:"Custom aggregation function for the Column",uiLabel:"Aggregation Function",isOptional:!0},{name:"availableAggregationFunctions",kind:"array",description:"Available aggregations for the Column",uiLabel:"Available Aggregation Functions",isOptional:!0},{name:"columnGroup",kind:"REFERENCE",description:"The parent column group, if the column belongs to one",uiLabel:"Column Group",isOptional:!0,reference:"unknown"},{name:"field",kind:"string",description:"Is the field of the row to get the cell data from",uiLabel:"Field",isOptional:!0},{name:"filterable",kind:"boolean",description:"Is Column able to be filtered",uiLabel:"Filterable"},{name:"flex",kind:"number",description:"Flex details of the column",uiLabel:"Flex",isOptional:!0},{name:"groupable",kind:"boolean",description:"Can Column form a Row Group",uiLabel:"Groupable"},{name:"hideable",kind:"boolean",description:"Can Column be removed from the grid",uiLabel:"Hideable"},{name:"isExcludedFromQuickSearch",kind:"boolean",description:"Has colummn been excluded from Quick Search results",uiLabel:"Is Excluded From Quick Search"},{name:"isFixed",kind:"boolean",description:"Is Column pinned or locked into position",uiLabel:"Is Fixed"},{name:"isGrouped",kind:"boolean",description:"Is Column currently grouped",uiLabel:"Is Grouped"},{name:"isPrimaryKey",kind:"boolean",description:"Is this the Primary Key column",uiLabel:"Is Primary Key"},{name:"isSparkline",kind:"boolean",description:"Is it a Sparkline Column",uiLabel:"Is Sparkline"},{name:"moveable",kind:"boolean",description:"Can Column be moved at run-time to a new position",uiLabel:"Moveable"},{name:"pinned",kind:"'left' | 'right' | false",description:"The pinned position of the column",uiLabel:"Pinned"},{name:"pivotable",kind:"boolean",description:"Can Column be used in a Pivot Grid",uiLabel:"Pivotable"},{name:"queryable",kind:"boolean",description:"Can the Column be in included in Queries / Expressions",uiLabel:"Queryable"},{name:"readOnly",kind:"boolean",description:"Is the column editable; returns FALSE if the column has conditional/dynamic editability, assuming some rows are editable",uiLabel:"Read Only"},{name:"sortable",kind:"boolean",description:"Is Column sortable",uiLabel:"Sortable"},{name:"visible",kind:"boolean",description:"Is Column currently visible",uiLabel:"Visible"},{name:"width",kind:"number",description:"Column width",uiLabel:"Width",isOptional:!0}]},AdaptableColumnBase:{name:"AdaptableColumnBase",kind:"Interface",description:"Base class for Adaptable Column containing most important properties",properties:[{name:"columnId",kind:"string",description:"Name of Column in AG Grid (e.g. field or colId)",uiLabel:"Column Id"},{name:"dataType",kind:"REFERENCE",description:"DataType of the column",uiLabel:"Data Type",reference:"AdaptableColumnDataType"},{name:"friendlyName",kind:"string",description:"How Column is referred to in Adaptable UI; `Caption` property in AG Grid",uiLabel:"Friendly Name"}]},AdaptableColumnDataType:{name:"AdaptableColumnDataType",kind:"TypeAlias",description:"Type of data stored in an Adaptable Column"},AdaptableComparerFunction:{name:"AdaptableComparerFunction",kind:"TypeAlias",description:"Standard comparer function used to evaluate custom sorts, returns -1, 0, 1 as required"},AdaptableCoordinate:{name:"AdaptableCoordinate",kind:"Interface",description:"Used by AdapTable to remember position of Floating Dashboard",properties:[{name:"x",kind:"number",description:"x axis number",uiLabel:"X"},{name:"y",kind:"number",description:"y axis number",uiLabel:"Y"}]},AdaptableDashboardToolbar:{name:"AdaptableDashboardToolbar",kind:"TypeAlias",description:"List of all the Toolbars that Adaptable provides"},AdaptableDataChangeHistoryAction:{name:"AdaptableDataChangeHistoryAction",kind:"TypeAlias",description:"Built in `undo` data change action"},AdaptableElementIcon:{name:"AdaptableElementIcon",kind:"Interface",description:"Defines an icon as a provided DOM element or HTML string",properties:[{name:"element",kind:"unknown",description:"The icon to display, either a DOM element or HTML string",uiLabel:"Element"}]},AdaptableExternalIcon:{name:"AdaptableExternalIcon",kind:"Interface",description:"Defines an icon from an external source",properties:[{name:"src",kind:"string",description:"The URL of the icon to use",uiLabel:"Src"}]},AdaptableFDC3EventInfo:{name:"AdaptableFDC3EventInfo",kind:"Interface",description:"EventInfo returned by `FDC3MessageSent` event",properties:[{name:"context",kind:"REFERENCE",description:"Full FDC3 Context for the object related to the event",uiLabel:"Context",reference:"FDC3Context"},{name:"eventType",kind:"'RaiseIntent' | 'BroadcastMessage'",description:"Type of Event: `RaiseIntent` or `BroadcastMessage`",uiLabel:"Event Type"},{name:"intent",kind:"unknown",description:"The FDC3 Intent which caused Event to fire (if type is `RaiseIntent`)",uiLabel:"Intent",isOptional:!0}]},AdaptableFlashingCell:{name:"AdaptableFlashingCell",kind:"Interface",description:"Defines an Alert fired by AdapTable",properties:[{name:"cellDataChangedInfo",kind:"REFERENCE",description:"Data change which triggered the FlashingCell",uiLabel:"Cell Data Changed Info",isOptional:!0,reference:"CellDataChangedInfo"},{name:"direction",kind:"'up' | 'down' | 'neutral'",description:"Direction of the change: 'up', 'down' or 'neutral'",uiLabel:"Direction"},{name:"flashColumnIds",kind:"unknown",description:"Column Ids that are flashing",uiLabel:"Flash Column Ids"},{name:"flashingCellDefinition",kind:"REFERENCE",description:"Rule that caused the FlashingCell to fire",uiLabel:"Flashing Cell Definition",reference:"FlashingCellDefinition"},{name:"flashTarget",kind:"unknown",description:"What will flash (e.g. Cell, Row)",uiLabel:"Flash Target"},{name:"rowPrimaryKey",kind:"string",description:"Primary Key Value of Row which is flashing",uiLabel:"Row Primary Key"}]},AdaptableForm:{name:"AdaptableForm",kind:"Interface",description:"Defines a form which appears dynamically; used by Alerts & Export Custom Destinations",properties:[{name:"buttons",kind:"array",description:"Buttons to include in the Form",uiLabel:"Buttons",isOptional:!0},{name:"description",kind:"string",description:"Additional information to appear in the Form",uiLabel:"Description",isOptional:!0},{name:"fields",kind:"unknown",description:"Collection of Dynamic Fields to display",uiLabel:"Fields",isOptional:!0},{name:"title",kind:"string",description:"Title to appear in the Form",uiLabel:"Title",isOptional:!0}]},AdaptableFormat:{name:"AdaptableFormat",kind:"TypeAlias",description:"Object containing formatting information for Numeric and Date Columns"},AdaptableFormField:{name:"AdaptableFormField",kind:"Interface",description:"Defines a Field that appears in an Adaptable Form",properties:[{name:"defaultValue",kind:"string | boolean | number",description:"Field Default Value - can be of type string, boolean, number",uiLabel:"Default Value",isOptional:!0},{name:"fieldType",kind:"REFERENCE",description:"Field Type: text, date, number, checkbox, select, textOutput",uiLabel:"Field Type",reference:"unknown"},{name:"label",kind:"string",description:"Label to display in the Field",uiLabel:"Label"},{name:"name",kind:"string",description:"Name of the Field",uiLabel:"Name"},{name:"options",kind:"unknown",description:"Items to populate the Select input",uiLabel:"Options",isOptional:!0}]},AdaptableIcon:{name:"AdaptableIcon",kind:"TypeAlias",description:"Defines an icon to be used in AdapTable (e.g. in Dashboard Header, Buttons, Menu, etc.)"},AdaptableInternalIcon:{name:"AdaptableInternalIcon",kind:"Interface",description:"Defines an icon from the internal AdapTable icon set",properties:[{name:"name",kind:"REFERENCE",description:"The name of the icon to use (referencing the AdapTable Icon Library)",uiLabel:"Name",reference:"AdaptableInternalIconName"},{name:"size",kind:"number",description:"The size (in pixels) of the SVG icon (defaults to `17px`)",uiLabel:"Size",isOptional:!0}]},AdaptableInternalIconName:{name:"AdaptableInternalIconName",kind:"TypeAlias",description:"All AdapTable internal icon names"},AdaptableLoadStateFunction:{name:"AdaptableLoadStateFunction",kind:"Interface",description:"Allows customization of state loading - used by `loadState` function in StateOptions"},AdaptableMenuItem:{name:"AdaptableMenuItem",kind:"Interface",description:"Menu item used by Adaptable in both Column and Context Menus",properties:[{name:"icon",kind:"REFERENCE",description:"Icon to display in Menu Item",uiLabel:"Icon",isOptional:!0,reference:"AdaptableIcon"},{name:"isVisible",kind:"boolean",description:"Whether menu item is visible",uiLabel:"Is Visible"},{name:"label",kind:"string",description:"Name that appears in the menu",uiLabel:"Label"},{name:"module",kind:"unknown",description:"Adaptable Module associated with (Adaptable) menu item.",uiLabel:"Module",isOptional:!0},{name:"onClick",kind:"unknown",description:"Function to invoke when (custom) menu item is clicked",uiLabel:"On Click",isOptional:!0},{name:"reduxAction",kind:"unknown",description:"Adaptable Redux Action to invoke when (Adaptable) menu item is clicked",uiLabel:"Redux Action",isOptional:!0},{name:"subItems",kind:"array",description:"Sub Menu Items to display",uiLabel:"Sub Items",isOptional:!0}]},AdaptableMessageType:{name:"AdaptableMessageType",kind:"TypeAlias",description:"Defines a Message Types: 'Success', 'Info', 'Warning' or 'Error'"},AdaptableModule:{name:"AdaptableModule",kind:"TypeAlias",description:"Modules provided by AdapTable, subject to Entitlements and usually have Predefined Config"},AdaptableObject:{name:"AdaptableObject",kind:"Interface",description:"Base interface which all other Adaptable State-related objects extend",properties:[{name:"IsReadOnly",kind:"boolean",description:"Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')",uiLabel:"Is Read Only",isOptional:!0},{name:"Source",kind:"'Config' | 'User'",description:"Source of state object: 'Config' if provided via `AdaptableOptions.predefinedConfig`, 'User' or undefined for runtime state.",uiLabel:"Source",isOptional:!0},{name:"Tags",kind:"array",description:"List of Tags associated with the Object; often used for (but not limited to) managing Layout object scope",uiLabel:"Tags",isOptional:!0},{name:"Uuid",kind:"REFERENCE",description:"Unique identifier for the Adaptable Object, generated and used internally by AdapTable",uiLabel:"Uuid",isOptional:!0,reference:"unknown"}]},AdaptableObjectTag:{name:"AdaptableObjectTag",kind:"TypeAlias",description:"AdaptableObjectTag Object Tague - currently supporting only plain string values, but open for future extensions, if ever needed."},AdaptableOptions:{name:"AdaptableOptions",kind:"Interface",description:"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",properties:[{name:"actionOptions",kind:"REFERENCE",description:"Options for managing Action Columns and Action Rows",uiLabel:"Action Options",isOptional:!0,reference:"ActionOptions"},{name:"adaptableId",kind:"string",description:"Identifier for this instance of AdapTable",uiLabel:"Adaptable Id",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"'adaptable_id'"},{name:"adaptableQLOptions",kind:"REFERENCE",description:"Options for managing AdapTableQL",uiLabel:"Adaptable QL Options",isOptional:!0,reference:"AdaptableQLOptions"},{name:"adaptableStateKey",kind:"string",description:"Identifier used as localStorage persistence key for AdaptableState",uiLabel:"Adaptable State Key",isOptional:!0,gridInfo:"item",defaultValue:"`adaptableId` value"},{name:"alertOptions",kind:"REFERENCE",description:"Options for managing Alerts in AdapTable",uiLabel:"Alert Options",isOptional:!0,gridInfo:"container",reference:"AlertOptions"},{name:"autogeneratePrimaryKey",kind:"boolean",description:"Will autogenerate a Primary Key; only use as a last resort if no unique column is available, as limits some Adaptable functionalities",uiLabel:"Autogenerate Primary Key",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"columnOptions",kind:"REFERENCE",description:"Options for managing Columns",uiLabel:"Column Options",isOptional:!0,reference:"ColumnOptions"},{name:"containerOptions",kind:"REFERENCE",description:"Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed",uiLabel:"Container Options",isOptional:!0,reference:"ContainerOptions"},{name:"dashboardOptions",kind:"REFERENCE",description:"Options related to managing the Dashboard in AdapTable",uiLabel:"Dashboard Options",isOptional:!0,gridInfo:"container",reference:"DashboardOptions"},{name:"dataChangeHistoryOptions",kind:"REFERENCE",description:"Options to manage Data Change History Module which provides an overview of all data changes",uiLabel:"Data Change History Options",isOptional:!0,gridInfo:"container",reference:"DataChangeHistoryOptions"},{name:"editOptions",kind:"REFERENCE",description:"Options related to Editing in AdapTable including Server Validation",uiLabel:"Edit Options",isOptional:!0,gridInfo:"container",reference:"EditOptions"},{name:"entitlementOptions",kind:"REFERENCE",description:"Options for managing Entitlements",uiLabel:"Entitlement Options",isOptional:!0,gridInfo:"container",reference:"EntitlementOptions"},{name:"exportOptions",kind:"REFERENCE",description:"Options for managing Exporting and Reports in AdapTable",uiLabel:"Export Options",isOptional:!0,gridInfo:"container",reference:"ExportOptions"},{name:"filterOptions",kind:"REFERENCE",description:"Options for managing Filtering in AdapTable",uiLabel:"Filter Options",isOptional:!0,gridInfo:"container",reference:"FilterOptions"},{name:"flashingCellOptions",kind:"REFERENCE",description:"Options for managing Flashing Cells - primarily default values",uiLabel:"Flashing Cell Options",isOptional:!0,gridInfo:"container",reference:"FlashingCellOptions"},{name:"generalOptions",kind:"REFERENCE",description:"General options to manage AdapTable e.g. grouping behaviour, Primary Keys",uiLabel:"General Options",isOptional:!0,gridInfo:"container",reference:"GeneralOptions"},{name:"gridOptions",kind:"REFERENCE",description:"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",uiLabel:"Grid Options",isOptional:!0,reference:"unknown"},{name:"layoutOptions",kind:"REFERENCE",description:"Options related to Layouts",uiLabel:"Layout Options",isOptional:!0,gridInfo:"container",reference:"LayoutOptions"},{name:"licenseKey",kind:"string",description:"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.",uiLabel:"License Key",isOptional:!0},{name:"menuOptions",kind:"REFERENCE",description:"Options for managing AdapTable menus",uiLabel:"Menu Options",isOptional:!0,gridInfo:"container",reference:"MenuOptions"},{name:"notificationsOptions",kind:"REFERENCE",description:"Options for managing Notifications in AdapTable",uiLabel:"Notifications Options",isOptional:!0,gridInfo:"container",reference:"NotificationsOptions"},{name:"plugins",kind:"array",description:"Used for managing the AdapTable Plugins",uiLabel:"Plugins",isOptional:!0},{name:"predefinedConfig",kind:"unknown",description:"User State set at design-time and shipped with AdapTable for first use; can be `PredefinedConfig` object or url to file containing config",uiLabel:"Predefined Config",isOptional:!0,defaultValue:"undefined"},{name:"primaryKey",kind:"string",description:"Name of Column in AdapTable guaranteed to contain unique values",uiLabel:"Primary Key",gridInfo:"item",defaultValue:"n/a (Mandatory)"},{name:"searchOptions",kind:"REFERENCE",description:"Options for managing Search related functions in AdapTable",uiLabel:"Search Options",isOptional:!0,gridInfo:"container",reference:"SearchOptions"},{name:"settingsPanelOptions",kind:"REFERENCE",description:"Setting panel options",uiLabel:"Settings Panel Options",isOptional:!0,gridInfo:"container",reference:"unknown"},{name:"stateOptions",kind:"REFERENCE",description:"Options related to state hydration / dehydration - allows users to intercept state persistence and state loading and change default behaviour of saving to local storage",uiLabel:"State Options",isOptional:!0,reference:"StateOptions"},{name:"teamSharingOptions",kind:"REFERENCE",description:"Options for managing 'Team Sharing' which allows users to create Adaptable Objects and share with colleagues",uiLabel:"Team Sharing Options",isOptional:!0,gridInfo:"container",reference:"TeamSharingOptions"},{name:"toolPanelOptions",kind:"REFERENCE",description:"Options related to managing the Tool Panel elements in AdapTable",uiLabel:"Tool Panel Options",isOptional:!0,gridInfo:"container",reference:"ToolPanelOptions"},{name:"userInterfaceOptions",kind:"REFERENCE",description:"Options for managing the User Interface elements of AdapTable, i.e. Action Columns, Color Palette etc.",uiLabel:"User Interface Options",isOptional:!0,gridInfo:"container",reference:"UserInterfaceOptions"},{name:"userName",kind:"string",description:"Name of current AdapTable user",uiLabel:"User Name",isOptional:!0,gridInfo:"item",defaultValue:"'anonymous'"}]},AdaptablePersistentState:{name:"AdaptablePersistentState",kind:"Interface",description:"The state object of Adaptable which is persisted"},AdaptablePersistStateFunction:{name:"AdaptablePersistStateFunction",kind:"Interface",description:"Allows customization of state persistence - used `persistState` function in StateOptions"},AdaptablePredicate:{name:"AdaptablePredicate",kind:"Interface",description:"Predicate object used by AdapTableQL - essentially a boolean function",properties:[{name:"Inputs",kind:"array",description:"Optional Inputs that might be needed for evaluation",uiLabel:"Inputs",isOptional:!0},{name:"PredicateId",kind:"string",description:"Id of Predicate (e.g. `Equals`, `GreaterThan`)",uiLabel:"Predicate Id"}]},AdaptablePredicateDef:{name:"AdaptablePredicateDef",kind:"Interface",description:"Defines a Predicate - include where it can run and what it does",properties:[{name:"columnScope",kind:"REFERENCE",description:"Columns (or DataTypes) where Predicate is active",uiLabel:"Column Scope",reference:"AdaptableScope"},{name:"handler",kind:"function",description:"Actual boolean function invoked when evaluating the Predicate",uiLabel:"Handler"},{name:"icon",kind:"unknown",description:"Icon to show (primarily used in Filter dropdown)",uiLabel:"Icon",isOptional:!0},{name:"id",kind:"string",description:"Unique Id for the object",uiLabel:"Id"},{name:"inputs",kind:"array",description:"Inputs the Predicate can take",uiLabel:"Inputs",isOptional:!0},{name:"label",kind:"string",description:"Name of the Predicate",uiLabel:"Label"},{name:"moduleScope",kind:"array",description:"Modules where the Predicate can run",uiLabel:"Module Scope"},{name:"onlyQuickFilter",kind:"boolean",description:"Display this predicate only in Quick Filter Bar (and NOT in Filter Form)",uiLabel:"Only Quick Filter",isOptional:!0},{name:"shortcuts",kind:"array",description:"Keyboard shortcuts to initiate predicate - used in Quick Filter bar",uiLabel:"Shortcuts",isOptional:!0},{name:"toString",kind:"function",description:"String representation of the Predicate",uiLabel:"To String",isOptional:!0}]},AdaptableQLOptions:{name:"AdaptableQLOptions",kind:"Interface",description:"Options for managing AdaptableQL - the Adaptable Query Language which evaluates Predicates and Expressions",properties:[{name:"caseSensitiveTextComparisons",kind:"boolean",description:"Perform case-sensitive text comparisons in all search and filter operations: QuickSearch, Filters, Query, Predicates",uiLabel:"Case Sensitive Text Comparisons",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"false"},{name:"customPredicateDefs",kind:"array",description:"Definitions for Custom provided Predicates",uiLabel:"Custom Predicate Defs",isOptional:!0},{name:"displayColumnFriendlyNamesForExpressions",kind:"boolean",description:"Reference a Column's Header (FriendlyName) in all Expression overviews (instead of ColumnId)",uiLabel:"Display Column Friendly Names For Expressions",isOptional:!0,defaultValue:"true"},{name:"evaluateAdaptableQLExternally",kind:"function",description:"Whether a specific expression (or all expressions in a given module) must be evaluated on the server",uiLabel:"Evaluate Adaptable QL Externally",isOptional:!0},{name:"expressionOptions",kind:"REFERENCE",description:"Options for managing Expressions in AdaptableQL",uiLabel:"Expression Options",isOptional:!0,reference:"ExpressionOptions"},{name:"externallyEvaluatedModules",kind:"REFERENCE",description:"Which searching and filtering Modules should take place on server",uiLabel:"Externally Evaluated Modules",isOptional:!0,gridInfo:"item",defaultValue:"undefined",reference:"unknown"}]},AdaptableQuery:{name:"AdaptableQuery",kind:"TypeAlias",description:"An AdaptableQuery can be either a Boolean, Scalar, Observable, AggregatedBoolean, or AggregatedScalar expression"},AdaptableReadyInfo:{name:"AdaptableReadyInfo",kind:"Interface",description:"Object returned by `AdaptableReady` event - fired when AdapTable has loaded",properties:[{name:"gridOptions",kind:"REFERENCE",description:"Underlying AG Grid GridOptions object",uiLabel:"Grid Options",reference:"unknown"}]},AdaptableRowChangedAlert:{name:"AdaptableRowChangedAlert",kind:"Interface",description:"Defines an Alert fired by AdapTable when a row is changed",properties:[{name:"gridDataChangedInfo",kind:"REFERENCE",description:"Row DataChange which triggered Alert",uiLabel:"Grid Data Changed Info",reference:"GridDataChangedInfo"}]},AdaptableSaveStateFunction:{name:"AdaptableSaveStateFunction",kind:"Interface",description:"Allows the customization state persistence - used by `saveState` function in StateOptions"},AdaptableScope:{name:"AdaptableScope",kind:"TypeAlias",description:"Defines where a given Object / Module is active"},AdaptableSearchState:{name:"AdaptableSearchState",kind:"Interface",description:"Current Searches and Filter in AdapTable",properties:[{name:"columnFilters",kind:"unknown",description:"Currently applied Column Filters",uiLabel:"Column Filters"},{name:"currentQuery",kind:"string | undefined",description:"Current Query",uiLabel:"Current Query"},{name:"dataSet",kind:"unknown",description:"Current DataSet (if one selected)",uiLabel:"Data Set"},{name:"queryAST",kind:"unknown",description:"AST for Current Query",uiLabel:"Query AST"}]},AdaptableSortState:{name:"AdaptableSortState",kind:"Interface",description:"Overview of current sorting state in the grid",properties:[{name:"columnSorts",kind:"array",description:"Which columns have sorting applied and,if so, which direction",uiLabel:"Column Sorts"},{name:"customSorts",kind:"array",description:"All the Custom Sorts in State; this is always sent even if no custom sorts are active",uiLabel:"Custom Sorts"}]},AdaptableState:{name:"AdaptableState",kind:"Interface",description:"The main state object of Adaptable"},AdaptableStateChangedInfo:{name:"AdaptableStateChangedInfo",kind:"Interface",description:"Object returned by the `AdaptableStateChanged` event",properties:[{name:"action",kind:"unknown",description:"The Redux Action that was invoked",uiLabel:"Action"},{name:"actionName",kind:"string",description:"Name of the Action",uiLabel:"Action Name"},{name:"adaptableId",kind:"string",description:"Current AdapTableId",uiLabel:"Adaptable Id"},{name:"adaptableStateKey",kind:"string",description:"Current Adaptable State Key",uiLabel:"Adaptable State Key"},{name:"clientTimestamp",kind:"date",description:"Time on user's computer when message was sent",uiLabel:"Client Timestamp"},{name:"newState",kind:"REFERENCE",description:"Adaptable State after the Action",uiLabel:"New State",reference:"AdaptableState"},{name:"oldState",kind:"REFERENCE",description:"Adaptable State before the Action",uiLabel:"Old State",reference:"AdaptableState"},{name:"userName",kind:"string",description:"Name of current AdapTable user",uiLabel:"User Name"}]},AdaptableStateFunctionConfig:{name:"AdaptableStateFunctionConfig",kind:"Interface",description:"State Function Config object passed into all State Options functions (except 'applyState')",properties:[{name:"adaptableId",kind:"string",description:"Id of current Adaptable instance",uiLabel:"Adaptable Id"},{name:"adaptableStateKey",kind:"string",description:"State Key being used",uiLabel:"Adaptable State Key"},{name:"url",kind:"string",description:"",uiLabel:"Url",isOptional:!0},{name:"userName",kind:"string",description:"current Adaptable user",uiLabel:"User Name"}]},AdaptableStateReloadedInfo:{name:"AdaptableStateReloadedInfo",kind:"Interface",description:"Object returned by the `AdaptableStateReloaded` event",properties:[{name:"adaptableId",kind:"string",description:"Current AdapTableId",uiLabel:"Adaptable Id"},{name:"adaptableStateKey",kind:"string",description:"Current Adaptable State Key",uiLabel:"Adaptable State Key"},{name:"newState",kind:"REFERENCE",description:"Adaptable State after the reload",uiLabel:"New State",reference:"AdaptablePersistentState"},{name:"oldState",kind:"REFERENCE",description:"Adaptable State before the reload",uiLabel:"Old State",reference:"AdaptablePersistentState"}]},AdaptableStatusBar:{name:"AdaptableStatusBar",kind:"Interface",description:"Defines an Adaptable Status Bar",properties:[{name:"Key",kind:"string",description:"Key of Status Bar Panel defined in AG Grid GridOptions - ensure keys are the same (Note: AG Grid statusPanel has a lowercase 'key')",uiLabel:"Key"},{name:"StatusBarPanels",kind:"array",description:"Module Status Panels to render inside Adaptable Status Bar",uiLabel:"Status Bar Panels",isOptional:!0}]},AdaptableStyle:{name:"AdaptableStyle",kind:"Interface",description:"Style object used in numerous AdapTable Modules",properties:[{name:"BackColor",kind:"string",description:"Colour background of cell: provide hex value or name",uiLabel:"Back Color",isOptional:!0},{name:"BorderColor",kind:"string",description:"Colour of cell border: provide hex value or name",uiLabel:"Border Color",isOptional:!0},{name:"ClassName",kind:"string",description:"Existing CSS Class; use instead of setting other object properties",uiLabel:"Class Name",isOptional:!0},{name:"FontSize",kind:"'XSmall' | 'Small' | 'Medium' | 'Large' | 'XLarge'",description:"Size of font: `XSmall`, `Small`, `Medium`, `Large` or `XLarge`",uiLabel:"Font Size",isOptional:!0},{name:"FontStyle",kind:"'Normal' | 'Italic'",description:"Style of font: `Normal` or `Italic`",uiLabel:"Font Style",isOptional:!0},{name:"FontWeight",kind:"'Normal' | 'Bold'",description:"Weight of font: `Normal` or `Bold`",uiLabel:"Font Weight",isOptional:!0},{name:"ForeColor",kind:"string",description:"Font colour in cell: provide hex value or name",uiLabel:"Fore Color",isOptional:!0}]},AdaptableTheme:{name:"AdaptableTheme",kind:"Interface",description:"Used for creating User (i.e. Custom) Themes",properties:[{name:"AgGridClassName",kind:"string",description:"Ag Grid theme to apply when loading theme",uiLabel:"Ag Grid Class Name",isOptional:!0},{name:"Description",kind:"string",description:"Description of Theme - will appear in Theme Toolbar and Toolpanel",uiLabel:"Description"},{name:"Name",kind:"string",description:"Name of the Theme",uiLabel:"Name"},{name:"VendorGridClassName",kind:"string",description:"deprecated use `AgGridClassName` property instead",uiLabel:"Vendor Grid Class Name",isOptional:!0}]},AdaptableToolPanelDefinition:{name:"AdaptableToolPanelDefinition",kind:"Interface",description:"Defines a ToolPanel - Name and VisibilityMode (Expanded / Collapsed)",properties:[{name:"Name",kind:"unknown",description:"ToolPanel name - either an Adaptable Module or a Custom ToolPanel (defined in ToolPanel Options)",uiLabel:"Name"},{name:"VisibilityMode",kind:"'expanded' | 'collapsed'",description:"Whether the ToolPanel is 'expanded' or 'collapsed'",uiLabel:"Visibility Mode",isOptional:!0,defaultValue:"'collapsed'"}]},AggregatedBooleanFunctionName:{name:"AggregatedBooleanFunctionName",kind:"TypeAlias",description:"List of all the Aggregation Functions available in AdaptableQL"},AggregatedScalarFunctionName:{name:"AggregatedScalarFunctionName",kind:"TypeAlias",description:"List of all the AggregatedScalar Functions available in AdaptableQL"},AlertApi:{name:"AlertApi",kind:"Interface",description:"Provides run-time access to Alert function and associated State",properties:[{name:"addAlertDefinition",kind:"function",description:"Adds new Alert Definition",uiLabel:"Add Alert Definition"},{name:"displayAlert",kind:"function",description:"Displays (fully formed) inputted Alert to the User",uiLabel:"Display Alert"},{name:"displayMessageAlertPopup",kind:"function",description:"Displays given Alert as a Popup",uiLabel:"Display Message Alert Popup"},{name:"editAlertDefinition",kind:"function",description:"Edits Alert in State with given one",uiLabel:"Edit Alert Definition"},{name:"executeAlertAction",kind:"function",description:"Runs after an Alert Action is invoked",uiLabel:"Execute Alert Action"},{name:"executeAlertButton",kind:"function",description:"Runs after a button in an Alert Form is clicked",uiLabel:"Execute Alert Button"},{name:"getActiveNonReactiveAlertDefinitions",kind:"function",description:"Retrieves all active (non-suspended) Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)",uiLabel:"Get Active Non Reactive Alert Definitions"},{name:"getActiveReactiveAlertDefinitions",kind:"function",description:"Retrieves all active (non-suspended) Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)",uiLabel:"Get Active Reactive Alert Definitions"},{name:"getAdaptableFormByName",kind:"function",description:"Retrieeves the Adaptable Form with the given name",uiLabel:"Get Adaptable Form By Name"},{name:"getAlertDefinitionById",kind:"function",description:"Retrieves alert definition by id",uiLabel:"Get Alert Definition By Id"},{name:"getAlertDefinitions",kind:"function",description:"Retrieves all Alert Definitions in Alert State",uiLabel:"Get Alert Definitions"},{name:"getAlertDefinitionsWithAllowEdit",kind:"function",description:"Retrieves all Alert Definitions which allow a Cell Edit",uiLabel:"Get Alert Definitions With Allow Edit"},{name:"getAlertDefinitionsWithPreventEdit",kind:"function",description:"Retrieves all Alert Definitions which prevent a Cell Edit",uiLabel:"Get Alert Definitions With Prevent Edit"},{name:"getAlertDescription",kind:"function",description:"Returns a description of an Alert Definition",uiLabel:"Get Alert Description"},{name:"getAlertPredicateDefs",kind:"function",description:"Retrieves all Predicate Defs with Module Scope of Alert",uiLabel:"Get Alert Predicate Defs"},{name:"getAlertPredicateDefsForScope",kind:"function",description:"Retrieves all Predicate Defs that match given Scope",uiLabel:"Get Alert Predicate Defs For Scope"},{name:"getAlertRuleDescription",kind:"function",description:"Returns a description of an Alert Definition's Rule",uiLabel:"Get Alert Rule Description"},{name:"getAlertState",kind:"function",description:"Retrieves Alert section from Adaptable State",uiLabel:"Get Alert State"},{name:"getNonReactiveAlertDefinitions",kind:"function",description:"Retrieves all Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)",uiLabel:"Get Non Reactive Alert Definitions"},{name:"getReactiveAlertDefinitions",kind:"function",description:"Retrieves all Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)",uiLabel:"Get Reactive Alert Definitions"},{name:"publishAlertFiredEvent",kind:"function",description:"Publishes an event when an Alert is triggered",uiLabel:"Publish Alert Fired Event"},{name:"showAlert",kind:"function",description:"Creates Alert formed from inputted values and displays it.",uiLabel:"Show Alert"},{name:"showAlertError",kind:"function",description:"Creates Alert formed from inputted values and displays it as Error Alert.",uiLabel:"Show Alert Error"},{name:"showAlertInfo",kind:"function",description:"Creates Alert formed from inputted values and displays it as Info Alert.",uiLabel:"Show Alert Info"},{name:"showAlertPopup",kind:"function",description:"Opens Settings Panel with Alert section selected and visible",uiLabel:"Show Alert Popup"},{name:"showAlertSuccess",kind:"function",description:"Creates Alert formed from inputted values and displays it as Succcess Alert.",uiLabel:"Show Alert Success"},{name:"showAlertWarning",kind:"function",description:"Creates Alert formed from inputted values and displays it as Warning Alert.",uiLabel:"Show Alert Warning"},{name:"suspendAlertDefinition",kind:"function",description:"Suspends Alert Definition",uiLabel:"Suspend Alert Definition"},{name:"unSuspendAlertDefinition",kind:"function",description:"Activates a suspended Alert Definition",uiLabel:"Un Suspend Alert Definition"}]},AlertButton:{name:"AlertButton",kind:"Interface",description:"Defines a button that appears in an Alert Form",properties:[{name:"Action",kind:"unknown",description:"Predefined Action(s) to trigger when button is clicked; but the implementation in `actionHandlers` property of Alert Options",uiLabel:"Action",isOptional:!0},{name:"ButtonStyle",kind:"REFERENCE",description:"Style for the Button",uiLabel:"Button Style",isOptional:!0,reference:"ButtonStyle"},{name:"Label",kind:"string",description:"Label to show in the Button",uiLabel:"Label"},{name:"Tooltip",kind:"string",description:"ToolTip to display",uiLabel:"Tooltip",isOptional:!0}]},AlertDefinition:{name:"AlertDefinition",kind:"Interface",description:"The Alert Definition object used in the Alert function",properties:[{name:"AlertForm",kind:"unknown",description:"Form to display in Alert with buttons and inputs",uiLabel:"Alert Form",isOptional:!0},{name:"AlertProperties",kind:"REFERENCE",description:"Series of properties which set what happens when Alert is triggered",uiLabel:"Alert Properties",isOptional:!0,reference:"AlertProperties"},{name:"MessageText",kind:"string",description:"Alert Message; if not provided AdapTable creates dynamically using Rule & Scope (Note: can be provided as a function in AlertOptions)",uiLabel:"Message Text",isOptional:!0},{name:"MessageType",kind:"REFERENCE",description:"Type of Alert: 'Info', 'Success', 'Warning', 'Error'; influences Alert colour, icon and logging",uiLabel:"Message Type",reference:"AdaptableMessageType"},{name:"Rule",kind:"REFERENCE",description:"When Alert should be triggered",uiLabel:"Rule",reference:"AlertRule"},{name:"Scope",kind:"REFERENCE",description:"Where Alert can be triggered: one, some or all columns or DataTypes",uiLabel:"Scope",reference:"AdaptableScope"}]},AlertFiredInfo:{name:"AlertFiredInfo",kind:"Interface",description:"Object returned by the `AlertFired` event",properties:[{name:"alert",kind:"REFERENCE",description:"Alert which has been fired",uiLabel:"Alert",reference:"AdaptableAlert"}]},AlertForm:{name:"AlertForm",kind:"TypeAlias",description:"Form to show in an Alert"},AlertFormContext:{name:"AlertFormContext",kind:"Interface",description:"Context required by functions when using an Alert Button",properties:[{name:"alert",kind:"REFERENCE",description:"Alert that has been triggered",uiLabel:"Alert",reference:"AdaptableAlert"}]},AlertMessageContext:{name:"AlertMessageContext",kind:"Interface",description:"Context used for creating bespoke Alert messages",properties:[{name:"alertDefinition",kind:"REFERENCE",description:"Current Alert Definition",uiLabel:"Alert Definition",reference:"AlertDefinition"},{name:"cellDataChangedInfo",kind:"REFERENCE",description:"Data change that might have triggered the Alert",uiLabel:"Cell Data Changed Info",isOptional:!0,reference:"CellDataChangedInfo"}]},AlertOptions:{name:"AlertOptions",kind:"Interface",description:"Options related to Alerts in Adaptable.",properties:[{name:"actionHandlers",kind:"array",description:"Custom onClick Handlers for Buttons (displayed in Alert Forms)",uiLabel:"Action Handlers",isOptional:!0},{name:"alertForms",kind:"array",description:"Full definitions of Alert Forms - the names of which are provided in Alert State",uiLabel:"Alert Forms",isOptional:!0},{name:"alertMessageText",kind:"function",description:"Function providing Message to display in Alert; if empty, AdapTable provides dynamically",uiLabel:"Alert Message Text",isOptional:!0},{name:"cellHighlightDuration",kind:"number",description:"How long (in ms) a Cell will be highlighted when an Alert fires",uiLabel:"Cell Highlight Duration",isOptional:!0,gridInfo:"item",defaultValue:"2000"},{name:"dataChangeDetectionPolicy",kind:"'rawValue' | 'formattedValue'",description:"Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data",uiLabel:"Data Change Detection Policy",isOptional:!0,gridInfo:"item",defaultValue:"'rawValue'"},{name:"maxAlertsInStore",kind:"number",description:"How many alerts held in State at any one time; when limit is breached, oldest alert will be removed",uiLabel:"Max Alerts In Store",isOptional:!0,gridInfo:"item",defaultValue:"20"},{name:"rowHighlightDuration",kind:"number",description:"How long (in ms) a Row will be highlighted when an Alert Fires",uiLabel:"Row Highlight Duration",isOptional:!0,gridInfo:"item",defaultValue:"4000"},{name:"statusbarHighlightDuration",kind:"number",description:"How long (in ms) the status-panel will be highlighted when an Alert Fires",uiLabel:"Statusbar Highlight Duration",isOptional:!0,defaultValue:"2000"}]},AlertProperties:{name:"AlertProperties",kind:"Interface",description:"Additional properties that specify how a particular Alert will ALWAYS behave",properties:[{name:"DisplayNotification",kind:"boolean",description:"Displays a notification when Alert is triggered",uiLabel:"Display Notification",isOptional:!0},{name:"HighlightCell",kind:"unknown",description:"Colours updated cell using `MessageType` property of triggering Alert Definition",uiLabel:"Highlight Cell",isOptional:!0},{name:"HighlightRow",kind:"unknown",description:"Colours updated cell using `MessageType` property of triggering Alert Definition",uiLabel:"Highlight Row",isOptional:!0},{name:"JumpToCell",kind:"boolean",description:"Grid will 'jump' to the changed cell which triggered the Alert",uiLabel:"Jump To Cell",isOptional:!0},{name:"JumpToRow",kind:"boolean",description:"Grid will 'jump' to the newly added row which triggered the Alert",uiLabel:"Jump To Row",isOptional:!0},{name:"LogToConsole",kind:"boolean",description:"Logs the Alert message to the console",uiLabel:"Log To Console",isOptional:!0},{name:"PreventEdit",kind:"boolean",description:"Automatically prevent any cell edit which triggered the Alert (i.e. validation)",uiLabel:"Prevent Edit",isOptional:!0,defaultValue:"false"},{name:"ShowInDiv",kind:"boolean",description:"Shows Alert text in the div specificed in `alertContainer` property of Container Options",uiLabel:"Show In Div",isOptional:!0}]},AlertRule:{name:"AlertRule",kind:"TypeAlias",description:"The Alert Rule defined by either an AdaptablePredicate or an AdaptableQuery"},AlertState:{name:"AlertState",kind:"Interface",description:"Predefined Configuration for Alert Module",properties:[{name:"AlertDefinitions",kind:"array",description:"Alert Definitions - will trigger Alerts when rule is met",uiLabel:"Alert Definitions",isOptional:!0}]},AlternativeModuleName:{name:"AlternativeModuleName",kind:"Interface",description:"Defines a new name for an Adaptable Module (e.g. change Dashboard to Grid Manager)",properties:[{name:"adaptableModule",kind:"REFERENCE",description:"Adaptable Module to rename",uiLabel:"Adaptable Module",reference:"AdaptableModule"},{name:"newName",kind:"string",description:"New name to use",uiLabel:"New Name"}]},AngularFrameworkComponent:{name:"AngularFrameworkComponent",kind:"TypeAlias",description:"An Angular component defined by its type and an optional initialisation callback."},ApplicationApi:{name:"ApplicationApi",kind:"Interface",description:"Provides run-time access to the Application Module",properties:[{name:"addApplicationDataEntry",kind:"function",description:"Adds new Application Data Entry",uiLabel:"Add Application Data Entry"},{name:"createApplicationDataEntry",kind:"function",description:"Creates new Application Data Entry with given Key and Value",uiLabel:"Create Application Data Entry"},{name:"deleteApplicationDataEntry",kind:"function",description:"Deletes given Application Data Entry",uiLabel:"Delete Application Data Entry"},{name:"editApplicationDataEntry",kind:"function",description:"Edits given Application Data Entry",uiLabel:"Edit Application Data Entry"},{name:"getApplicationDataEntries",kind:"function",description:"Retrieves all Key Value Pairs in Application state",uiLabel:"Get Application Data Entries"},{name:"getApplicationDataEntriesByValue",kind:"function",description:"Gets Application Data Entry with given value",uiLabel:"Get Application Data Entries By Value"},{name:"getApplicationDataEntryByKey",kind:"function",description:"Gets Application Data Entry with given key",uiLabel:"Get Application Data Entry By Key"},{name:"getApplicationState",kind:"function",description:"Retrieves Application section from Adaptable State",uiLabel:"Get Application State"}]},ApplicationDataEntry:{name:"ApplicationDataEntry",kind:"Interface",description:"Simple Key / Value pair object used to store custom - stringifiable - data in Adaptable State.",properties:[{name:"Key",kind:"string",description:"Key of Key / Value pair - always stored as a string",uiLabel:"Key"},{name:"Value",kind:"unknown",description:"Value of Key / Value pair (actual data being stored) - needs to stringifiable",uiLabel:"Value"}]},ApplicationState:{name:"ApplicationState",kind:"Interface",description:"Predefined Configuration for the Application Module",properties:[{name:"ApplicationDataEntries",kind:"array",description:"Array of Key / Value pairs enabling custom data to be stored in Adaptable State.",uiLabel:"Application Data Entries",isOptional:!0}]},AutoGenerateTagsForLayoutsContext:{name:"AutoGenerateTagsForLayoutsContext",kind:"Interface",description:"Context for `LayoutOptions.autoGenerateTagsForLayouts` method",properties:[{name:"layouts",kind:"array",description:"Layouts currently in Adaptable State",uiLabel:"Layouts"},{name:"objectTags",kind:"array",description:"Object Tags provided in User Interface Options",uiLabel:"Object Tags"}]},BaseContext:{name:"BaseContext",kind:"Interface",description:"Base Context used in many functions provided by developers and invoked as needed by AdapTable",properties:[{name:"adaptableApi",kind:"REFERENCE",description:"The Adaptable Api - included as a convenience",uiLabel:"Adaptable Api",reference:"AdaptableApi"}]},BooleanFunctionName:{name:"BooleanFunctionName",kind:"TypeAlias",description:"List of all the Boolean Functions available in AdaptableQL"},BulkUpdateApi:{name:"BulkUpdateApi",kind:"Interface",description:"Provides run-time access to the Bulk Update Module",properties:[{name:"applyBulkUpdate",kind:"function",description:"Applies a Bulk Update to given Cells",uiLabel:"Apply Bulk Update"},{name:"getBulkUpdateValue",kind:"function",description:"Returns current Bulk Update value",uiLabel:"Get Bulk Update Value"},{name:"setBulkUpdateValue",kind:"function",description:"Sets Bulk Update value",uiLabel:"Set Bulk Update Value"},{name:"showBulkUpdatePopup",kind:"function",description:"Opens Settings Panel with Bulk Update section selected and visible",uiLabel:"Show Bulk Update Popup"}]},BulkUpdatePermittedValues:{name:"BulkUpdatePermittedValues",kind:"Interface",description:"User to define permitted values when updating cells via bulk update",properties:[{name:"values",kind:"unknown",description:"Values to display in Bulk Update Wizard: either hardcoded list or a function that returns a list",uiLabel:"Values"}]},BulkUpdatePermittedValuesContext:{name:"BulkUpdatePermittedValuesContext",kind:"Interface",description:"Context used when getting BulkUpdatePermittedValues via a function",properties:[{name:"gridCells",kind:"array",description:"Cells which will be modified in the Bulk Update",uiLabel:"Grid Cells"}]},ButtonStyle:{name:"ButtonStyle",kind:"Interface",description:"Defines the look and feel of an Adaptable Button",properties:[{name:"className",kind:"string",description:"CSS Classname to use for the Button",uiLabel:"Class Name",isOptional:!0},{name:"tone",kind:"'success' | 'error' | 'neutral' | 'none' | 'warning' | 'info' | 'accent'",description:"Button's Tone - values: 'success', 'error', 'neutral', 'none', 'warning', 'info', 'accent'",uiLabel:"Tone",isOptional:!0,defaultValue:"'neutral'"},{name:"variant",kind:"'text' | 'outlined' | 'raised'",description:"How Button appears - values: 'text', 'outlined', 'raised'",uiLabel:"Variant",isOptional:!0,defaultValue:"'outlined'"}]},CalculatedColumn:{name:"CalculatedColumn",kind:"Interface",description:"Defines a Column where the display value is derived from other values in row, and the definition is stored in State.",properties:[{name:"CalculatedColumnSettings",kind:"REFERENCE",description:"Additional optional properties for Column (e.g. filterable, resizable)",uiLabel:"Calculated Column Settings",isOptional:!0,reference:"CalculatedColumnSettings"},{name:"ColumnId",kind:"string",description:"Name of Calculated Column",uiLabel:"Column Id"},{name:"FriendlyName",kind:"string",description:"Name to be used in Column Header; if blank `ColumnId` is used",uiLabel:"Friendly Name",isOptional:!0},{name:"Query",kind:"REFERENCE",description:"Scalar/AggregatedScalar Query used by AdapTableQL to evaluate Column's value",uiLabel:"Query",reference:"AdaptableCalculatedColumnQuery"}]},CalculatedColumnApi:{name:"CalculatedColumnApi",kind:"Interface",description:"Provides run-time access to the Calculated Column Module",properties:[{name:"addCalculatedColumn",kind:"function",description:"Adds new Calculated Column",uiLabel:"Add Calculated Column"},{name:"deleteCalculatedColumn",kind:"function",description:"Removes Calculated Column from State",uiLabel:"Delete Calculated Column"},{name:"editCalculatedColumn",kind:"function",description:"Edits given Calculated Column",uiLabel:"Edit Calculated Column"},{name:"editCalculatedColumns",kind:"function",description:"Edits given Calculated Columns",uiLabel:"Edit Calculated Columns"},{name:"getAllCalculatedColumn",kind:"function",description:"Retrieves all Calculated Columns in Adaptable State",uiLabel:"Get All Calculated Column"},{name:"getCalculatedColumnById",kind:"function",description:"Retrieves Calculated Column by the unique identifier of the Adaptable Object in the CalculatedColumnState",uiLabel:"Get Calculated Column By Id"},{name:"getCalculatedColumnForColumnId",kind:"function",description:"Gets Calculated Column, if any, for given ColumnId",uiLabel:"Get Calculated Column For Column Id"},{name:"getCalculatedColumnModuleReferences",kind:"function",description:"Returns all the references in the AdaptableState of the given CalculatedColumn",uiLabel:"Get Calculated Column Module References"},{name:"getCalculatedColumnsReferencingColumnId",kind:"function",description:"Returns all Calculated Columns whose Expression contains the ColumnId",uiLabel:"Get Calculated Columns Referencing Column Id"},{name:"getCalculatedColumnState",kind:"function",description:"Retrieves Calculated Column section from Adaptable State",uiLabel:"Get Calculated Column State"},{name:"getReferencedColumnIdsForCalculatedColumn",kind:"function",description:"Gets any ColumnIds referenced in a Calculated Column",uiLabel:"Get Referenced Column Ids For Calculated Column"},{name:"getReferencedColumnIdsForCalculatedColumnId",kind:"function",description:"Gets any ColumnIds referenced in a Calculated Column",uiLabel:"Get Referenced Column Ids For Calculated Column Id"},{name:"showCalculatedColumnPopup",kind:"function",description:"Opens Settings Panel with Calculated Column section selected and visible",uiLabel:"Show Calculated Column Popup"}]},CalculatedColumnSettings:{name:"CalculatedColumnSettings",kind:"Interface",description:"Set of optional properties that define a Calculated Column's behaviour",properties:[{name:"DataType",kind:"'String' | 'Number' | 'Boolean' | 'Date'",description:"Expression's return value DataType; inferred by AdapTable but settable by User",uiLabel:"Data Type"},{name:"ShowToolTip",kind:"boolean",description:"Show underlying Expression as ToolTip when hovering over a cell",uiLabel:"Show Tool Tip",isOptional:!0,defaultValue:"false"}]},CalculatedColumnState:{name:"CalculatedColumnState",kind:"Interface",description:"Predefined Configuration for Calculated Column Module",properties:[{name:"CalculatedColumns",kind:"array",description:"Collection of Calculated Columns",uiLabel:"Calculated Columns",isOptional:!0}]},CalendarApi:{name:"CalendarApi",kind:"Interface",description:"Calendar, Holiday and Working Day related functions, using supplied Calendars in General Options",properties:[{name:"getNextWorkingDay",kind:"function",description:"Returns the next Working Day",uiLabel:"Get Next Working Day"},{name:"getPreviousWorkingDay",kind:"function",description:"Returns the previous Working Day",uiLabel:"Get Previous Working Day"},{name:"isHoliday",kind:"function",description:"Checks if given data is a Holiday",uiLabel:"Is Holiday"},{name:"isSameDay",kind:"function",description:"Returns true if both Dates are the same, ignoring the time portions",uiLabel:"Is Same Day"},{name:"isWorkingDay",kind:"function",description:"Checks if given date is a Working Day",uiLabel:"Is Working Day"}]},CellChangedInfo:{name:"CellChangedInfo",kind:"Interface",description:"EventInfo returned by CellChanged event",properties:[{name:"cellChange",kind:"REFERENCE",description:"Object providing full information of the cell (and column and row) that changed",uiLabel:"Cell Change",reference:"CellDataChangedInfo"}]},CellColorRange:{name:"CellColorRange",kind:"Interface",description:"Defines which Colours to show in Gradient and Percent Bar Styles",properties:[{name:"Color",kind:"string",description:"Cell colour to use for values that fall inside Range",uiLabel:"Color"},{name:"Max",kind:"number | 'Col-Max'",description:"End number of Range",uiLabel:"Max"},{name:"Min",kind:"number | 'Col-Min'",description:"Start number of Range",uiLabel:"Min"},{name:"ReverseGradient",kind:"boolean",description:"Reverses the Gradient so the lower the cell value the darker the colour",uiLabel:"Reverse Gradient",isOptional:!0}]},CellDataChangedInfo:{name:"CellDataChangedInfo",kind:"Interface",description:"Defines a Cell Edit - includes full details of old and new values, the column and the enclosing Row",properties:[{name:"changedAt",kind:"number",description:"Timestamp of change occurrence (in milliseconds)",uiLabel:"Changed At"},{name:"column",kind:"REFERENCE",description:"Column in which cell is situated",uiLabel:"Column",reference:"AdaptableColumn"},{name:"newValue",kind:"unknown",description:"New value for the cell",uiLabel:"New Value"},{name:"oldValue",kind:"unknown",description:"Value in the Cell before the edit",uiLabel:"Old Value"},{name:"primaryKeyValue",kind:"unknown",description:"Primary Key Column's value for the row where edited cell is situated",uiLabel:"Primary Key Value"},{name:"rowData",kind:"unknown",description:"Data in the Row",uiLabel:"Row Data",isOptional:!0},{name:"rowNode",kind:"REFERENCE",description:"AG Grid RowNode that contains the cell",uiLabel:"Row Node",isOptional:!0,reference:"unknown"},{name:"trigger",kind:"'edit' | 'tick' | 'undo' | 'aggChange'",description:"What triggered the change - user, background change or a reverted change?",uiLabel:"Trigger",isOptional:!0}]},CellHighlightInfo:{name:"CellHighlightInfo",kind:"Interface",description:"Defines how a given Cell in AdapTable should be highlighted",properties:[{name:"columnId",kind:"string",description:"Id of Column containing Cell",uiLabel:"Column Id"},{name:"highlightStyle",kind:"REFERENCE",description:"Adaptable Style to use in the Cell Highlight",uiLabel:"Highlight Style",reference:"AdaptableStyle"},{name:"primaryKeyValue",kind:"unknown",description:"Primary Key Value of row containing Cell",uiLabel:"Primary Key Value"},{name:"timeout",kind:"number",description:"Time after which Cell should be unhighlighted",uiLabel:"Timeout",isOptional:!0}]},CellSummaryApi:{name:"CellSummaryApi",kind:"Interface",description:"Provides run-time access to the Cell Summary Module",properties:[{name:"getCellSummaryOperationDefinitions",kind:"function",description:"Retrieves all Cell Summary Definitions from Cell Summary State",uiLabel:"Get Cell Summary Operation Definitions"},{name:"getCellSummaryOperationValue",kind:"function",description:"Retrieves the value of the current selected operation",uiLabel:"Get Cell Summary Operation Value"},{name:"getCurrentCellSummaryOperation",kind:"function",description:"Retrieves currently selected Cell Summary Operation",uiLabel:"Get Current Cell Summary Operation"},{name:"getCurrentCellSummaryOperationValue",kind:"function",description:"Retrieves the value of the current selected operation",uiLabel:"Get Current Cell Summary Operation Value"},{name:"setCurrentCellSummaryOperation",kind:"function",description:"Sets the currently selected Cell Summary Operation",uiLabel:"Set Current Cell Summary Operation"},{name:"showCellSummaryPopup",kind:"function",description:"Opens Settings Panel with Cell Summary section selected and visible",uiLabel:"Show Cell Summary Popup"}]},CellSummaryOperation:{name:"CellSummaryOperation",kind:"Interface",description:"Defines a Custom Cell Summary operation provided by a user",properties:[{name:"operationFunction",kind:"function",description:"Function to run when a summary result is required",uiLabel:"Operation Function"},{name:"operationName",kind:"string",description:"Name of the Operation - will be displayed in the Cell Summary components",uiLabel:"Operation Name"}]},CellSummaryOperationContext:{name:"CellSummaryOperationContext",kind:"Interface",description:"Context provided to a custom Cell Summary Operation function",properties:[{name:"allValues",kind:"array",description:"All values of selected cells",uiLabel:"All Values"},{name:"distinctCount",kind:"number",description:"Count of currently selected cells",uiLabel:"Distinct Count"},{name:"numericColumns",kind:"array",description:"Any numeric columns in current selection",uiLabel:"Numeric Columns"},{name:"numericValues",kind:"array",description:"Any numeric values in current selection",uiLabel:"Numeric Values"},{name:"selectedCellInfo",kind:"REFERENCE",description:"Currently selected cells",uiLabel:"Selected Cell Info",reference:"SelectedCellInfo"}]},CellSummmary:{name:"CellSummmary",kind:"Interface",description:"Defines the Summary operations provides for Selected Cells"},CellTextOption:{name:"CellTextOption",kind:"TypeAlias",description:"Text optionally to show in a Special Column Style special style: 'CellValue' or 'PercentageValue'"},CellTextOptions:{name:"CellTextOptions",kind:"TypeAlias",description:"Array of CellTextOption available in Special Column Styles"},ChartDefinition:{name:"ChartDefinition",kind:"Interface",description:"Wraps an AG Grid Chart Model",properties:[{name:"model",kind:"REFERENCE",description:"AG Grid Chart Model",uiLabel:"Model",reference:"unknown"}]},ChartingApi:{name:"ChartingApi",kind:"Interface",description:"Provides run-time access to Charting Module and related State",properties:[{name:"getCurrentCharts",kind:"function",description:"Retrieves current user-generated Charts",uiLabel:"Get Current Charts"},{name:"getPersistedCharts",kind:"function",description:"Retrieves persisted Charts from Adaptable State",uiLabel:"Get Persisted Charts"},{name:"isChartingEnabled",kind:"function",description:"Whether AdapTable's charting functionality is available",uiLabel:"Is Charting Enabled"},{name:"saveCurrentCharts",kind:"function",description:"Saves all current Charts into Adaptable State",uiLabel:"Save Current Charts"},{name:"showPersistedCharts",kind:"function",description:"Displays all persisted Charts",uiLabel:"Show Persisted Charts"}]},ChartingState:{name:"ChartingState",kind:"Interface",description:"Used for persisting AG Grids in Adaptable State",properties:[{name:"ChartDefinitions",kind:"array",description:"Charting Definitions - wrap AG Grid Chart Models",uiLabel:"Chart Definitions",isOptional:!0}]},CheckboxColumnClickedInfo:{name:"CheckboxColumnClickedInfo",kind:"Interface",description:"Event Info published by CheckboxColumnClicked event",properties:[{name:"column",kind:"REFERENCE",description:"Name of Column where Checkbox was clicked",uiLabel:"Column",reference:"AdaptableColumn"},{name:"isChecked",kind:"boolean",description:"Whether or not the Checkbox is checked",uiLabel:"Is Checked"},{name:"primaryKeyValue",kind:"unknown",description:"Value in Primary Key Column for row where Checkbox was clicked",uiLabel:"Primary Key Value"},{name:"rowData",kind:"unknown",description:"Data in the row where the Checkbox was clicked",uiLabel:"Row Data"}]},ColumnApi:{name:"ColumnApi",kind:"Interface",description:"A large range of column-related functions in AdapTable",properties:[{name:"addColumnsToSelection",kind:"function",description:"Adds (highlights) a group of Columns to any existing selection",uiLabel:"Add Columns To Selection"},{name:"addColumnToSelection",kind:"function",description:"Adds (highlights) a Column to any existing selection",uiLabel:"Add Column To Selection"},{name:"autosizeAllColumns",kind:"function",description:"Autosizes all Columns in the Grid",uiLabel:"Autosize All Columns"},{name:"autosizeColumn",kind:"function",description:"AutoSizes a Column",uiLabel:"Autosize Column"},{name:"autosizeColumns",kind:"function",description:"Autosizes given Columns",uiLabel:"Autosize Columns"},{name:"doesColumnExist",kind:"function",description:"Returns true if the given Column exists in the Grid",uiLabel:"Does Column Exist"},{name:"getAggregetableColumns",kind:"function",description:"Returns all Aggregatable Columns",uiLabel:"Get Aggregetable Columns"},{name:"getAgGridColumnFieldForAdaptableColumn",kind:"function",description:"Retrieves AG Grid's field property for the column",uiLabel:"Get Ag Grid Column Field For Adaptable Column"},{name:"getAgGridColumnForAdaptableColumn",kind:"function",description:"Retrieves AG Grid's column for an Adaptable column",uiLabel:"Get Ag Grid Column For Adaptable Column"},{name:"getAgGridColumnType",kind:"function",description:"Retrieves 'ColumnType' property for a given Column",uiLabel:"Get Ag Grid Column Type"},{name:"getAllColumnFriendlyNames",kind:"function",description:"Retrieves a list providing the Friendly Name / Caption for all columns",uiLabel:"Get All Column Friendly Names"},{name:"getBooleanColumns",kind:"function",description:"Returns all boolean Columns",uiLabel:"Get Boolean Columns"},{name:"getColumnDataTypeFromColumnId",kind:"function",description:"Returns Data Type for a Column",uiLabel:"Get Column Data Type From Column Id"},{name:"getColumnFromFriendlyName",kind:"function",description:"Retrieves Adaptable Column with given Friendly name",uiLabel:"Get Column From Friendly Name"},{name:"getColumnFromId",kind:"function",description:"Retrieves Adaptable Column with given ColumnId",uiLabel:"Get Column From Id"},{name:"getColumnIdFromFriendlyName",kind:"function",description:"Retrieves ColumnId for Column with given Friendly Name",uiLabel:"Get Column Id From Friendly Name"},{name:"getColumnIdsFromFriendlyNames",kind:"function",description:"Retrieves ColumnIds for Columns with given Friendly Names",uiLabel:"Get Column Ids From Friendly Names"},{name:"getColumnIdsFromId",kind:"function",description:"Returns the ColumnId if regular, otherwise referenced columns if Calculated Column",uiLabel:"Get Column Ids From Id"},{name:"getColumns",kind:"function",description:"Returns all Columns",uiLabel:"Get Columns"},{name:"getColumnsFromFriendlyNames",kind:"function",description:"Retrieves Adaptable Columns with given Friendly names",uiLabel:"Get Columns From Friendly Names"},{name:"getColumnsFromIds",kind:"function",description:"Retrieves Adaptable Columns with given ColumnIds",uiLabel:"Get Columns From Ids"},{name:"getColumnsOfType",kind:"function",description:"Returns all Columns that have given DataType",uiLabel:"Get Columns Of Type"},{name:"getDateColumns",kind:"function",description:"Returns all Date Columns",uiLabel:"Get Date Columns"},{name:"getDefaultAggFunc",kind:"function",description:"Returns the default Aggregation Function for a Column",uiLabel:"Get Default Agg Func"},{name:"getDistinctBulkUpdateDisplayValuesForColumn",kind:"function",description:"Gets all distinct column display values for bulk update.",uiLabel:"Get Distinct Bulk Update Display Values For Column"},{name:"getDistinctCustomSortDisplayValuesForColumn",kind:"function",description:"Gets all distinct column display values in for custom sort.",uiLabel:"Get Distinct Custom Sort Display Values For Column"},{name:"getDistinctDisplayValuesForColumn",kind:"function",description:"Gets all distinct display values in the Column",uiLabel:"Get Distinct Display Values For Column"},{name:"getDistinctFilterDisplayValuesForColumn",kind:"function",description:"Gets all distinct display values in for filter column, used for Floating Filter and Column Header filter",uiLabel:"Get Distinct Filter Display Values For Column"},{name:"getDistinctRawValuesForColumn",kind:"function",description:"Gets all distinct raw values in Column. Values are sorted.",uiLabel:"Get Distinct Raw Values For Column"},{name:"getDistinctVisibleDisplayValuesForColumn",kind:"function",description:"Gets all distinct visible display values in the Column",uiLabel:"Get Distinct Visible Display Values For Column"},{name:"getDistinctVisibleRawValuesForColumn",kind:"function",description:"Gets all distinct visible raw values in the Column",uiLabel:"Get Distinct Visible Raw Values For Column"},{name:"getFiltrableColumns",kind:"function",description:"Returns all Sortable Columns",uiLabel:"Get Filtrable Columns"},{name:"getFriendlyNameFromColumn",kind:"function",description:"Retrieves Friendly Name for a given Column",uiLabel:"Get Friendly Name From Column"},{name:"getFriendlyNameFromColumnId",kind:"function",description:"Retrieves Friendly Name for a given ColumnId",uiLabel:"Get Friendly Name From Column Id"},{name:"getFriendlyNamesFromColumnIds",kind:"function",description:"Retrieves Friendly Names for given ColumnIds",uiLabel:"Get Friendly Names From Column Ids"},{name:"getGroupableColumns",kind:"function",description:"Returns all Groupable Columns",uiLabel:"Get Groupable Columns"},{name:"getNumericColumns",kind:"function",description:"Returns all numeric Columns",uiLabel:"Get Numeric Columns"},{name:"getPivotableColumns",kind:"function",description:"Returns all Pivotable Columns",uiLabel:"Get Pivotable Columns"},{name:"getPrimaryKeyColumn",kind:"function",description:"Retrieves current Primary Key Column in AdapTable",uiLabel:"Get Primary Key Column"},{name:"getQueryableColumns",kind:"function",description:"Returns all Queryable Columns",uiLabel:"Get Queryable Columns"},{name:"getSortableColumns",kind:"function",description:"Returns all Sortable Columns",uiLabel:"Get Sortable Columns"},{name:"getStringColumns",kind:"function",description:"Returns all string Columns",uiLabel:"Get String Columns"},{name:"getTypesForColumn",kind:"function",description:"Returns the `types` property for a given Column",uiLabel:"Get Types For Column"},{name:"getUnsortedDistinctRawValuesForColumn",kind:"function",description:"Gets all distinct raw values in Column. Values are un-sorted.",uiLabel:"Get Unsorted Distinct Raw Values For Column"},{name:"getVisibleColumns",kind:"function",description:"Returns all visible Columns",uiLabel:"Get Visible Columns"},{name:"hideColumn",kind:"function",description:"Hides a Column from Grid",uiLabel:"Hide Column"},{name:"isActionColumn",kind:"function",description:"Is Column an Action Column",uiLabel:"Is Action Column"},{name:"isActionRowButtonColumn",kind:"function",description:"Checks if a column is a ActionRowButton column (see UserInterfaceOptions.ActionOptions)",uiLabel:"Is Action Row Button Column"},{name:"isAutoPivotColumn",kind:"function",description:"Is Column pivoted",uiLabel:"Is Auto Pivot Column"},{name:"isAutoRowGroupColumn",kind:"function",description:"Is Column row-grouped",uiLabel:"Is Auto Row Group Column"},{name:"isBooleanColumn",kind:"function",description:"Is Column Boolean",uiLabel:"Is Boolean Column"},{name:"isCalculatedColumn",kind:"function",description:"Is Column a Calculated Column",uiLabel:"Is Calculated Column"},{name:"isColumnReferencedInExpression",kind:"function",description:"Checks if a column is referenced in a given Expression",uiLabel:"Is Column Referenced In Expression"},{name:"isDateColumn",kind:"function",description:"Is Column a Date",uiLabel:"Is Date Column"},{name:"isFreeTextColumn",kind:"function",description:"Is Column a Free Text Column",uiLabel:"Is Free Text Column"},{name:"isNumericColumn",kind:"function",description:"Is Column Numeric",uiLabel:"Is Numeric Column"},{name:"isStyledNumericColumn",kind:"function",description:"Does Column have a numeric style (e.g. Percent Bar or Gradient)",uiLabel:"Is Styled Numeric Column"},{name:"selectAllColumns",kind:"function",description:"Selects all Columns",uiLabel:"Select All Columns"},{name:"selectColumn",kind:"function",description:"Selects (highlights) a Column",uiLabel:"Select Column"},{name:"selectColumns",kind:"function",description:"Selects (highlights) group of Columns",uiLabel:"Select Columns"},{name:"showColumn",kind:"function",description:"Makes a Column visible",uiLabel:"Show Column"},{name:"usesAdaptableFilterForm",kind:"function",description:"Does Column use AdapTable's Filter Form",uiLabel:"Uses Adaptable Filter Form"},{name:"usesAdaptableQuickFilter",kind:"function",description:"Does Column use AdapTable's Quick Filter",uiLabel:"Uses Adaptable Quick Filter"}]},ColumnComparison:{name:"ColumnComparison",kind:"Interface",description:"Enables a Percent Bar or Gradient Style to use another column in its calculations",properties:[{name:"Color",kind:"string",description:"Colour to use for the Comparison",uiLabel:"Color"},{name:"MaxValue",kind:"number | string",description:"End value - either numeric or Column name",uiLabel:"Max Value"},{name:"MinValue",kind:"number | string",description:"Start value - either numeric or Column name",uiLabel:"Min Value"}]},ColumnFilter:{name:"ColumnFilter",kind:"Interface",description:"Defines a Filter applied on a Column using a Predicate",properties:[{name:"ColumnId",kind:"string",description:"Column where Filter should be applied",uiLabel:"Column Id"},{name:"Predicate",kind:"REFERENCE",description:"`AdaptablePredicate` which AdaptableQL will evaluate when the Filter is run",uiLabel:"Predicate",reference:"ColumnFilterPredicate"}]},ColumnFilterPredicate:{name:"ColumnFilterPredicate",kind:"Interface",description:"A Predicate used in Column Filtering"},ColumnFriendlyNameContext:{name:"ColumnFriendlyNameContext",kind:"Interface",description:"Context used when setting a Column Friendly Name",properties:[{name:"agColumn",kind:"REFERENCE",description:"AG Grid ColDef for the Column",uiLabel:"Ag Column",reference:"unknown"},{name:"colId",kind:"string",description:"Id of the Column",uiLabel:"Col Id"}]},ColumnMenuContext:{name:"ColumnMenuContext",kind:"Interface",description:"Provides full details about the Column in which the Column Menu will appear",properties:[{name:"adaptableColumn",kind:"REFERENCE",description:"Current Adaptable Column",uiLabel:"Adaptable Column",reference:"AdaptableColumn"},{name:"agGridColumn",kind:"REFERENCE",description:"Current AG Grid Column",uiLabel:"Ag Grid Column",reference:"unknown"},{name:"isRowGroupColumn",kind:"boolean",description:"Whether current Column is Row Group",uiLabel:"Is Row Group Column"}]},ColumnOptions:{name:"ColumnOptions",kind:"Interface",description:"Options related to managing Columns in Adaptable.",properties:[{name:"autoOrderGroupedColumns",kind:"boolean",description:"Order Grouped Column automatically, deriving from Adaptable State if available (CustomSort or Layout ColumnSort)",uiLabel:"Auto Order Grouped Columns",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"columnFriendlyName",kind:"function",description:"Provide an alternative Friendly Name for a Column",uiLabel:"Column Friendly Name",isOptional:!0,defaultValue:"undefined"},{name:"columnTypes",kind:"array",description:"Optional list of Column Types - used primarily for Calculated and FreeText Columns",uiLabel:"Column Types",isOptional:!0,defaultValue:"undefined"},{name:"hideColumnWhenGrouped",kind:"boolean",description:"Automatically removes a column from the grid when it becomes Row Grouped",uiLabel:"Hide Column When Grouped",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"showMissingColumnsWarning",kind:"boolean",description:"Show warning if AdapTable cannot find a column",uiLabel:"Show Missing Columns Warning",isOptional:!0,gridInfo:"item",defaultValue:"true"}]},ColumnSort:{name:"ColumnSort",kind:"Interface",description:"Defines how a Column is sorted",properties:[{name:"ColumnId",kind:"string",description:"Id of Column being sorted",uiLabel:"Column Id"},{name:"SortOrder",kind:"'Asc' | 'Desc'",description:"How Column is sorted - either 'Asc' or 'Desc'",uiLabel:"Sort Order"}]},ColumnValuesComparer:{name:"ColumnValuesComparer",kind:"Interface",description:"Comparer object for Column Values - used for custom sorting",properties:[{name:"comparer",kind:"REFERENCE",description:"Comparer function to use",uiLabel:"Comparer",reference:"AdaptableComparerFunction"},{name:"scope",kind:"REFERENCE",description:"Column for which to compare values",uiLabel:"Scope",reference:"AdaptableScope"}]},ConfigApi:{name:"ConfigApi",kind:"Interface",description:"Range of functions to access Predefined Config and Adaptable State",properties:[{name:"configInit",kind:"function",description:"Initialised Adaptable State (for internal use only)",uiLabel:"Config Init"},{name:"copyAllStateToClipboard",kind:"function",description:"Copies all Adaptable state to clipboard",uiLabel:"Copy All State To Clipboard"},{name:"copyUserStateToClipboard",kind:"function",description:"Copies User State sections of Adaptable State to clipboard",uiLabel:"Copy User State To Clipboard"},{name:"dispatchStateReadyAction",kind:"function",description:"Sent by each Module when it is Ready",uiLabel:"Dispatch State Ready Action"},{name:"getAdaptableSearchState",kind:"function",description:"Gets search-related sections of Adaptable State",uiLabel:"Get Adaptable Search State"},{name:"getAdaptableSortState",kind:"function",description:"Gets sort-related sections of Adaptable State",uiLabel:"Get Adaptable Sort State"},{name:"getAlertState",kind:"function",description:"Returns Alert section of Adaptable State",uiLabel:"Get Alert State"},{name:"getAllState",kind:"function",description:"Retrieves ALL state which is currently stored by Adaptable (both persistent and transient/internal)",uiLabel:"Get All State"},{name:"getAllUserState",kind:"function",description:"Retrieves the PERSISTED state in Adaptable",uiLabel:"Get All User State"},{name:"getApplicationState",kind:"function",description:"Returns Application section of Adaptable State",uiLabel:"Get Application State"},{name:"getCalculatedColumnState",kind:"function",description:"Returns Calculated Column section of Adaptable State",uiLabel:"Get Calculated Column State"},{name:"getCustomSortState",kind:"function",description:"Returns Custom Sort section of Adaptable State",uiLabel:"Get Custom Sort State"},{name:"getDashboardState",kind:"function",description:"Returns Dashboard section of Adaptable State",uiLabel:"Get Dashboard State"},{name:"getDescriptionForModule",kind:"function",description:"Retrieves a brief description of an AdapTable Module",uiLabel:"Get Description For Module"},{name:"getExportState",kind:"function",description:"Returns Export section of Adaptable State",uiLabel:"Get Export State"},{name:"getFormatColumnState",kind:"function",description:"Returns Formt Column section of Adaptable State",uiLabel:"Get Format Column State"},{name:"getFreeTextColumnState",kind:"function",description:"Returns FreeText Column section of Adaptable State",uiLabel:"Get Free Text Column State"},{name:"getHelpPageForModule",kind:"function",description:"Retrieves the help page for an AdapTable Module",uiLabel:"Get Help Page For Module"},{name:"getLayoutState",kind:"function",description:"Returns Layout section of Adaptable State",uiLabel:"Get Layout State"},{name:"getPersistedState",kind:"function",description:"Retrieves the persisted state in Adaptable. This is the state that was last stored with the `StatusOptions.persistState()` function.",uiLabel:"Get Persisted State"},{name:"getPlusMinusState",kind:"function",description:"Returns Plus Minus section of Adaptable State",uiLabel:"Get Plus Minus State"},{name:"getPredefinedConfig",kind:"function",description:"Returns current Predefined Config",uiLabel:"Get Predefined Config"},{name:"getQueryState",kind:"function",description:"Returns Query section of Adaptable State",uiLabel:"Get Query State"},{name:"getQuickSearchState",kind:"function",description:"Returns Quick Search section of Adaptable State",uiLabel:"Get Quick Search State"},{name:"getScheduleState",kind:"function",description:"Returns Schedule section of Adaptable State",uiLabel:"Get Schedule State"},{name:"getShortcutState",kind:"function",description:"Returns Shortcut section of Adaptable State",uiLabel:"Get Shortcut State"},{name:"getThemeState",kind:"function",description:"Returns Theme section of Adaptable State",uiLabel:"Get Theme State"},{name:"getToolPanelState",kind:"function",description:"Returns Tool Panel section of Adaptable State",uiLabel:"Get Tool Panel State"},{name:"getUserStateByStateKey",kind:"function",description:"Returns given section of Adaptable State (as JSON or object)",uiLabel:"Get User State By State Key"},{name:"incrementUserStateRevision",kind:"function",description:"Adds '1' to current revision number of State element",uiLabel:"Increment User State Revision"},{name:"loadUserState",kind:"function",description:"Loads supplied user state, replacing (NOT merging) existing User(persisted) State.",uiLabel:"Load User State"},{name:"reloadPredefinedConfig",kind:"function",description:"Reloads either existing or supplied Predefined Config; clears persistent state by calling `StateOptions.clearState()` function for remote storage removal",uiLabel:"Reload Predefined Config"},{name:"setAdaptableStateKey",kind:"function",description:"Changes the key used for persisting the Adaptablestate into localStorage",uiLabel:"Set Adaptable State Key"}]},ConfigState:{name:"ConfigState",kind:"Interface",description:"Base Interface for all Adaptable State objects; contains`Revision` property, used for versioning",properties:[{name:"Revision",kind:"number | {\n        Key: number;\n        UpdateStrategy: 'Override' | 'KeepUserDefined';\n    }",description:"Version number of the Item - allows developers to update one section in Predefined Config while keeping others unchanged",uiLabel:"Revision",isOptional:!0}]},ContactColumn:{name:"ContactColumn",kind:"Interface",description:"A (String) Column which will be defined as an FDC3 Contact columnId and at least one other property is required",properties:[{name:"emailColumnId",kind:"string",description:"Column which holds the email address of a Contact",uiLabel:"Email Column Id",isOptional:!0},{name:"fds_idColumnId",kind:"string",description:"Column which holds an FDS_ID value a Contact",uiLabel:"Fds_id Column Id",isOptional:!0},{name:"intents",kind:"REFERENCE",description:"Contact-related FDC3 Intents; can be: `StartCall` `StartChat` `ViewContact`",uiLabel:"Intents",isOptional:!0,reference:"ContactIntents"}]},ContactContext:{name:"ContactContext",kind:"Interface",description:"FDC3 Context to define a Contact",properties:[{name:"id",kind:"unknown",description:"The Contact data: email, FDS_ID",uiLabel:"Id",isOptional:!0},{name:"name",kind:"string",description:"Free text name of Contact",uiLabel:"Name",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `contact`",uiLabel:"Type"}]},ContactIntent:{name:"ContactIntent",kind:"TypeAlias",description:"FDC3 Intents available to a Contact Column"},ContactIntents:{name:"ContactIntents",kind:"TypeAlias",description:"All available Contact Intents"},ContactListContext:{name:"ContactListContext",kind:"Interface",description:"FDC3 Context to define a list of Contacts",properties:[{name:"contacts",kind:"array",description:"The array of Contacts",uiLabel:"Contacts",isOptional:!0},{name:"id",kind:"unknown",description:"Optional Id",uiLabel:"Id",isOptional:!0},{name:"name",kind:"string",description:"Free text name of Contact list",uiLabel:"Name",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `contactList`",uiLabel:"Type"}]},ContainerOptions:{name:"ContainerOptions",kind:"Interface",description:"Options for managing the different div elements required by AdapTable",properties:[{name:"adaptableContainer",kind:"unknown",description:"Div containing AdapTable - string Id or HTMLElement",uiLabel:"Adaptable Container",isOptional:!0,gridInfo:"item",defaultValue:""adaptable""},{name:"agGridContainer",kind:"unknown",description:"Div containing AG Grid instance - string Id or HTMLElement",uiLabel:"Ag Grid Container",isOptional:!0,gridInfo:"item",defaultValue:""grid""},{name:"agGridContainerWaitTimeout",kind:"number",description:"How long AdapTable waits for AG Grid before giving up connecting to it",uiLabel:"Ag Grid Container Wait Timeout",isOptional:!0,gridInfo:"item",defaultValue:"60s"},{name:"alertContainer",kind:"unknown",description:"Div to show Alerts - string Id or HTMLElement",uiLabel:"Alert Container",isOptional:!0,gridInfo:"item",defaultValue:"undefined"},{name:"modalContainer",kind:"unknown",description:"Name of div where modals appear (if null, will be centre of page)",uiLabel:"Modal Container",isOptional:!0,gridInfo:"item",defaultValue:"undefined"},{name:"systemStatusContainer",kind:"unknown",description:"Div to show System Status messages - string Id or HTMLElement",uiLabel:"System Status Container",isOptional:!0,gridInfo:"item",defaultValue:"undefined"}]},ContextMenuContext:{name:"ContextMenuContext",kind:"Interface",description:"Provides full details about current cell (and selected cells) where the Context Menu will appear",properties:[{name:"adaptableColumn",kind:"REFERENCE",description:"Current Adaptable Column",uiLabel:"Adaptable Column",reference:"AdaptableColumn"},{name:"agGridColumn",kind:"REFERENCE",description:"Current AG Grid Column",uiLabel:"Ag Grid Column",reference:"unknown"},{name:"gridCell",kind:"REFERENCE",description:"Cell that has been clicked; contains cell value",uiLabel:"Grid Cell",reference:"GridCell"},{name:"isGroupedNode",kind:"boolean",description:"Whether current AG Grid row node is grouped",uiLabel:"Is Grouped Node"},{name:"isRowGroupColumn",kind:"boolean",description:"Whether current Column is Row Grouped",uiLabel:"Is Row Group Column"},{name:"isSelectedCell",kind:"boolean",description:"Whether cell that was clicked is also currently selected",uiLabel:"Is Selected Cell"},{name:"isSingleSelectedCell",kind:"boolean",description:"Whether the clicked cell is the only selected cell",uiLabel:"Is Single Selected Cell"},{name:"isSingleSelectedColumn",kind:"boolean",description:"Whether Column that was clicked is only column with selected cells",uiLabel:"Is Single Selected Column"},{name:"primaryKeyValue",kind:"unknown",description:"Value of Primary Key column in current row",uiLabel:"Primary Key Value"},{name:"rowNode",kind:"REFERENCE",description:"Current AG Grid row node",uiLabel:"Row Node",reference:"unknown"},{name:"selectedCellInfo",kind:"REFERENCE",description:"Currently selected cells in the grid",uiLabel:"Selected Cell Info",reference:"SelectedCellInfo"},{name:"selectedRowInfo",kind:"REFERENCE",description:"Currently selected rows in the grid",uiLabel:"Selected Row Info",reference:"SelectedRowInfo"}]},CountryColumn:{name:"CountryColumn",kind:"Interface",description:"A (String) Column which will be defined as an FDC3 Country",properties:[{name:"intents",kind:"REFERENCE",description:"Country-related FDC3 Intents; can only be: `ViewChart`",uiLabel:"Intents",isOptional:!0,reference:"CountryIntents"},{name:"isoalpha2ColumnId",kind:"string",description:"Column which contains the ISOALPHA2 Standard",uiLabel:"Isoalpha2Column Id",isOptional:!0},{name:"isoalpha3ColumnId",kind:"string",description:"Column which contains the ISOALPHA3 Standard",uiLabel:"Isoalpha3Column Id",isOptional:!0}]},CountryContext:{name:"CountryContext",kind:"Interface",description:"FDC3 Context to define a Country",properties:[{name:"id",kind:"unknown",description:"The Country data: ISOALPHA2, ISOALPHA3",uiLabel:"Id",isOptional:!0},{name:"name",kind:"string",description:"Free text name of Country",uiLabel:"Name",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `country`",uiLabel:"Type"}]},CountryIntent:{name:"CountryIntent",kind:"TypeAlias",description:"FDC3 Intents available to a Country Column"},CountryIntents:{name:"CountryIntents",kind:"TypeAlias",description:"All available Country Intents"},CreateActionRowContext:{name:"CreateActionRowContext",kind:"Interface",description:"Context used in a Create Row Form",properties:[{name:"clonedRowNode",kind:"REFERENCE",description:"The RowNode being cloned",uiLabel:"Cloned Row Node",isOptional:!0,reference:"unknown"},{name:"type",kind:"unknown",description:"Type of the Context",uiLabel:"Type"}]},CreatedActionRowInfo:{name:"CreatedActionRowInfo",kind:"Interface",description:"Info passed into ActionRowSubmitted Event for Created Rows",properties:[{name:"clonedRowNode",kind:"REFERENCE",description:"Node being cloned",uiLabel:"Cloned Row Node",isOptional:!0,reference:"unknown"},{name:"formData",kind:"REFERENCE",description:"Data entered in the Form",uiLabel:"Form Data",reference:"unknown"},{name:"type",kind:"unknown",description:"Specifies its a Created Action Row",uiLabel:"Type"}]},CustomDestination:{name:"CustomDestination",kind:"Interface",description:"Defines a custom Export destination",properties:[{name:"form",kind:"unknown",description:"Optional Adaptable Form; if provided, it must include Buttons that will execute the Export",uiLabel:"Form",isOptional:!0},{name:"name",kind:"string",description:"Name of Custom Destination (mandatory)",uiLabel:"Name"},{name:"onExport",kind:"function",description:"Optional Function invoked when Export is applied (used if no form is supplied)",uiLabel:"On Export",isOptional:!0}]},CustomDisplayFormatter:{name:"CustomDisplayFormatter",kind:"Interface",description:"Provides Custom Display Formats",properties:[{name:"handler",kind:"function",description:"Function used to perform the Custom Display Format",uiLabel:"Handler"},{name:"id",kind:"string",description:"Id of the Formatted",uiLabel:"Id"},{name:"label",kind:"string",description:"Description",uiLabel:"Label",isOptional:!0},{name:"scope",kind:"REFERENCE",description:"Where the Custom Display Format can be applied",uiLabel:"Scope",reference:"AdaptableScope"}]},CustomDisplayFormatterContext:{name:"CustomDisplayFormatterContext",kind:"Interface",description:"Context used in handler of CustomDisplayFormatter",properties:[{name:"adaptableColumn",kind:"REFERENCE",description:"Column where Custom Display Format will apply",uiLabel:"Adaptable Column",reference:"AdaptableColumn"},{name:"cellValue",kind:"unknown",description:"Non-formatted Cell Value",uiLabel:"Cell Value"},{name:"rowNode",kind:"REFERENCE",description:"Node where Custom Display Format will apply",uiLabel:"Row Node",reference:"unknown"}]},CustomFDC3Column:{name:"CustomFDC3Column",kind:"Interface",description:"A Column which will be defined as Custom FDC3 (can be any datatype)",properties:[{name:"createContext",kind:"unknown",description:"Function which creates FDC3 context for the current column and row",uiLabel:"Create Context"},{name:"intents",kind:"array",description:"Custom FDC3 Intents available to the column",uiLabel:"Intents"}]},CustomFDC3Context:{name:"CustomFDC3Context",kind:"Interface",description:"Context used when providing Custom FDC3 content"},CustomFDC3Intent:{name:"CustomFDC3Intent",kind:"TypeAlias",description:"Custom FDC3 Intent - just a string value"},CustomQueryVariableContext:{name:"CustomQueryVariableContext",kind:"Interface",description:"Context passed when evaluating `ExpressionOptions.customQueryVariables`",properties:[{name:"args",kind:"array",description:"Optional variable arguments",uiLabel:"Args",isOptional:!0}]},CustomRenderContext:{name:"CustomRenderContext",kind:"Interface",description:"Context provided for any custom rendering"},CustomSettingsPanel:{name:"CustomSettingsPanel",kind:"Interface",description:"Definition of a Custom Panel to add to the Adaptable Settings Panel",properties:[{name:"frameworkComponent",kind:"REFERENCE",description:"Framework-specific (Angular or React) component to be rendered",uiLabel:"Framework Component",isOptional:!0,reference:"unknown"},{name:"icon",kind:"REFERENCE",description:"Icon rendered inside settings-panel name, inside the navigation",uiLabel:"Icon",isOptional:!0,reference:"AdaptableIcon"},{name:"name",kind:"string",description:"Appears in Settings Panel Navigation and must be included in settingsPanelOptions.navigation for it to be displayed (by default added to the end)",uiLabel:"Name"},{name:"render",kind:"function",description:"Function to provide bespoke content when NOT using a Framework wrapper",uiLabel:"Render",isOptional:!0}]},CustomSort:{name:"CustomSort",kind:"Interface",description:"Custom Sort object used in Custom Sort function.",properties:[{name:"ColumnId",kind:"string",description:"Id of Column on which Custom Sort will be applied",uiLabel:"Column Id"},{name:"SortedValues",kind:"array",description:"Order of values by which Column will be sorted",uiLabel:"Sorted Values",isOptional:!0}]},CustomSortApi:{name:"CustomSortApi",kind:"Interface",description:"Provides run-time access to the Custom Sort function",properties:[{name:"addCustomSort",kind:"function",description:"Adds a Custom Sort to Custom Sort collection in Adaptable State",uiLabel:"Add Custom Sort"},{name:"createCustomSort",kind:"function",description:"Creates new Custom Sort based on given values",uiLabel:"Create Custom Sort"},{name:"deleteCustomSort",kind:"function",description:"Removes Custom Sort for a given ColumnId",uiLabel:"Delete Custom Sort"},{name:"editCustomSort",kind:"function",description:"Updates existing Custom Sort with new set of Sorted Values",uiLabel:"Edit Custom Sort"},{name:"getAllActiveCustomSort",kind:"function",description:"Retrieves all Custom Sorts that are active (not-suspended) in Adaptable State",uiLabel:"Get All Active Custom Sort"},{name:"getAllCustomSort",kind:"function",description:"Retrieves all Custom Sorts in Adaptable State",uiLabel:"Get All Custom Sort"},{name:"getAllSuspendedCustomSort",kind:"function",description:"Retrieves all Custom Sorts that are suspended in Adaptable State",uiLabel:"Get All Suspended Custom Sort"},{name:"getCustomSortByColumn",kind:"function",description:"Retrieves Custom Sort from Adaptable State for given ColumnId",uiLabel:"Get Custom Sort By Column"},{name:"getCustomSortById",kind:"function",description:"Retrieves Custom Sort by id",uiLabel:"Get Custom Sort By Id"},{name:"getCustomSortState",kind:"function",description:"Retrieves Custom Sort section from Adaptable State",uiLabel:"Get Custom Sort State"},{name:"showCustomSortPopup",kind:"function",description:"Opens Settings Panel with Custom Sort section selected and visible",uiLabel:"Show Custom Sort Popup"},{name:"suspendCustomSort",kind:"function",description:"Suspends Custom Sort",uiLabel:"Suspend Custom Sort"},{name:"unSuspendCustomSort",kind:"function",description:"Un-suspends or activates a suspended Custom Sort",uiLabel:"Un Suspend Custom Sort"}]},CustomSortPermittedValues:{name:"CustomSortPermittedValues",kind:"Interface",description:"Custom column values for Custom Sort",properties:[{name:"values",kind:"unknown",description:"Values to display in Custom Sort Wizard: either hardcoded list or a function that returns a list",uiLabel:"Values"}]},CustomSortState:{name:"CustomSortState",kind:"Interface",description:"Predefined Configuration for Custom Sort Module",properties:[{name:"CustomSorts",kind:"array",description:"Collection of Custom Sort objects.",uiLabel:"Custom Sorts",isOptional:!0}]},CustomToolbar:{name:"CustomToolbar",kind:"Interface",description:"Custom Toolbar (which AdapTable will manage) enabling devs to populate Dashboard with bepoke content",properties:[{name:"frameworkComponent",kind:"REFERENCE",description:"The Framework-specific (Angular or React) component to be rendered",uiLabel:"Framework Component",isOptional:!0,reference:"unknown"},{name:"name",kind:"string",description:"How Toolbar is referenced (e.g. in Dashboard Popup when managing toolbars)",uiLabel:"Name"},{name:"render",kind:"function",description:"Function to provide custom content when NOT using a Framework wrapper",uiLabel:"Render",isOptional:!0},{name:"showCloseButton",kind:"boolean",description:"Shows a Close button at the bottom of Custom Toolbar",uiLabel:"Show Close Button",isOptional:!0},{name:"showConfigureButton",kind:"boolean",description:"Shows a Configure (wrench) button which when clicked fires `CustomToolbarConfigured` event",uiLabel:"Show Configure Button",isOptional:!0},{name:"title",kind:"string",description:"Title to display in Toolbar; if unset or empty string, nothing will show",uiLabel:"Title",isOptional:!0},{name:"toolbarButtons",kind:"array",description:"Optional set of buttons to show in the Toolbar",uiLabel:"Toolbar Buttons",isOptional:!0}]},CustomToolbarButtonContext:{name:"CustomToolbarButtonContext",kind:"Interface",description:"Context required by functions when using a Custom Toolbar Button",properties:[{name:"customToolbar",kind:"REFERENCE",description:"Custom Toolbar which hosts the Button",uiLabel:"Custom Toolbar",reference:"CustomToolbar"}]},CustomToolbarConfiguredInfo:{name:"CustomToolbarConfiguredInfo",kind:"Interface",description:"EventInfo returned by the CustomToolbarConfigured event",properties:[{name:"customToolbar",kind:"REFERENCE",description:"Custom Toolbar in which the 'Configure' button has been clicked",uiLabel:"Custom Toolbar",reference:"CustomToolbar"}]},CustomToolPanel:{name:"CustomToolPanel",kind:"Interface",description:"Defines a Custom ToolPanel - provided by Users and contains custom content",properties:[{name:"buttons",kind:"array",description:"Optional set of buttons to show in the ToolPanel",uiLabel:"Buttons",isOptional:!0},{name:"frameworkComponent",kind:"REFERENCE",description:"Framework-specific (Angular or React) component to be rendered",uiLabel:"Framework Component",isOptional:!0,reference:"unknown"},{name:"name",kind:"string",description:"Name of Custom ToolPanel - should be unique",uiLabel:"Name"},{name:"render",kind:"function",description:"Function to provide bespoke content when NOT using a Framework wrapper",uiLabel:"Render",isOptional:!0},{name:"title",kind:"string",description:"Title to display in Custom ToolPanel; if undefined, will default to `name` property",uiLabel:"Title",isOptional:!0}]},DashboardApi:{name:"DashboardApi",kind:"Interface",description:"Functions relating to the AdapTable Dashboard.",properties:[{name:"collapseDashboard",kind:"function",description:"Collapses Dashboard so only Dashboard Header is visible (and not Toolbars' contents)",uiLabel:"Collapse Dashboard"},{name:"dockDashboard",kind:"function",description:"Docks Dashboard so it 'snaps back' into its customary position above the grid",uiLabel:"Dock Dashboard"},{name:"expandDashboard",kind:"function",description:"Expands Dashboard so Toolbars in Active Tab are fully visible",uiLabel:"Expand Dashboard"},{name:"fireDashboardChangedEvent",kind:"function",description:"Fires Dashboard Changed Event",uiLabel:"Fire Dashboard Changed Event"},{name:"floatDashboard",kind:"function",description:"Floats Dashboard so only Dashboard Header is visible (in reduced size); can be dragged to a new location",uiLabel:"Float Dashboard"},{name:"getActiveTab",kind:"function",description:"Returns current Active Tab (if there is one)",uiLabel:"Get Active Tab"},{name:"getActiveTabIndex",kind:"function",description:"Returns current Active Tab index (if there is one)",uiLabel:"Get Active Tab Index"},{name:"getCurrentToolbars",kind:"function",description:"Retrieves all Toolbars in Active Tab",uiLabel:"Get Current Toolbars"},{name:"getCustomDashboardButtonByLabel",kind:"function",description:"Retrieves first Custom Button with given Label",uiLabel:"Get Custom Dashboard Button By Label"},{name:"getCustomDashboardButtons",kind:"function",description:"Retrieves all Custom Buttons",uiLabel:"Get Custom Dashboard Buttons"},{name:"getCustomToolbarByName",kind:"function",description:"Returns Custom Toolbar with the given name",uiLabel:"Get Custom Toolbar By Name"},{name:"getCustomToolbarContentsDiv",kind:"function",description:"Returns 'div' element for given Custom Toolbar",uiLabel:"Get Custom Toolbar Contents Div"},{name:"getCustomToolbars",kind:"function",description:"Retrieves all Custom Toolbars",uiLabel:"Get Custom Toolbars"},{name:"getDashboardState",kind:"function",description:"Retrieves Dashboard section from Adaptable State",uiLabel:"Get Dashboard State"},{name:"getTabByName",kind:"function",description:"Retrieves the Tab from State that matches inputted name",uiLabel:"Get Tab By Name"},{name:"hasCustomToolbarChanged",kind:"function",description:"Has a custom toolbar become visible or",uiLabel:"Has Custom Toolbar Changed"},{name:"hideDashboard",kind:"function",description:"Hides the Dashboard so cannot be seen",uiLabel:"Hide Dashboard"},{name:"isDashboardCollapsed",kind:"function",description:"Is Dashboard Collapsed",uiLabel:"Is Dashboard Collapsed"},{name:"isDashboardDocked",kind:"function",description:"Is Dashboard Docked",uiLabel:"Is Dashboard Docked"},{name:"isDashboardExpanded",kind:"function",description:"Is Dashboard Expanded",uiLabel:"Is Dashboard Expanded"},{name:"isDashboardFloating",kind:"function",description:"Is Dashboard Floating",uiLabel:"Is Dashboard Floating"},{name:"isDashboardHidden",kind:"function",description:"Is Dashboard Hidden",uiLabel:"Is Dashboard Hidden"},{name:"isDashboardVisible",kind:"function",description:"Is Dashboard Visible",uiLabel:"Is Dashboard Visible"},{name:"isToolbarVisible",kind:"function",description:"Checks if a given Toolbar is visible",uiLabel:"Is Toolbar Visible"},{name:"refreshDashboard",kind:"function",description:"Refreshes the entire Dashboard section, including Toolbars and Buttons; this is particularly relevant for AdapTable built-in elements, as framework components are dependent on the framework specific change detection mechanisms",uiLabel:"Refresh Dashboard"},{name:"setActiveTab",kind:"function",description:"Sets Active Tab in Dashboard",uiLabel:"Set Active Tab"},{name:"setActiveTabIndex",kind:"function",description:"Sets Active Tab in Dashboard",uiLabel:"Set Active Tab Index"},{name:"setCustomToolbarContents",kind:"function",description:"Populates a Custom Toolbar with content",uiLabel:"Set Custom Toolbar Contents"},{name:"setDashboardTitle",kind:"function",description:"Sets title of Dashboard Header",uiLabel:"Set Dashboard Title"},{name:"setModuleButtons",kind:"function",description:"Sets which Module Buttons are visible",uiLabel:"Set Module Buttons"},{name:"showDashboard",kind:"function",description:"Makes the Dashboard visible",uiLabel:"Show Dashboard"},{name:"showDashboardPopup",kind:"function",description:"Opens Settings Panel with Dashboard section selected and visible",uiLabel:"Show Dashboard Popup"}]},DashboardButtonContext:{name:"DashboardButtonContext",kind:"Interface",description:"Context required by functions when using a Dashboard Button",properties:[{name:"dashboardState",kind:"REFERENCE",description:"Current Dashboard State",uiLabel:"Dashboard State",reference:"DashboardState"}]},DashboardChangedInfo:{name:"DashboardChangedInfo",kind:"Interface",description:"Object returned by the `DashboardChanged` event",properties:[{name:"actionName",kind:"string",description:"What caused Dashboard State to change",uiLabel:"Action Name"},{name:"newDashboardState",kind:"REFERENCE",description:"Current Dashboard State",uiLabel:"New Dashboard State",reference:"DashboardState"},{name:"oldDashboardState",kind:"REFERENCE",description:"Previous Dashboard State",uiLabel:"Old Dashboard State",reference:"DashboardState"}]},DashboardOptions:{name:"DashboardOptions",kind:"Interface",description:"Options related to the Dashboard in Adaptable.",properties:[{name:"buttonsLocation",kind:"'left' | 'right'",description:"Where in Dashboard to display Module and Custom Buttons",uiLabel:"Buttons Location",isOptional:!0,defaultValue:"'right'"},{name:"canFloat",kind:"boolean",description:"Whether the Dashboard can be floated; if true (the default), double-clicking Dashboard puts it in float mode",uiLabel:"Can Float",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"customDashboardButtons",kind:"array",description:"Custom Adaptable Buttons to appear in Dashboard (alongside Module Buttons)",uiLabel:"Custom Dashboard Buttons",isOptional:!0},{name:"customToolbars",kind:"array",description:"Toolbars provided by Users which contain custom content",uiLabel:"Custom Toolbars",isOptional:!0},{name:"showQuickSearchInHeader",kind:"boolean",description:"Shows Quick Search textbox in the Dashboard Header",uiLabel:"Show Quick Search In Header",isOptional:!0,gridInfo:"item",defaultValue:"true"}]},DashboardState:{name:"DashboardState",kind:"Interface",description:"Predefined Configuration for the AdapTable Dashboard",properties:[{name:"ActiveTabIndex",kind:"number",description:"The index of the Active Tab (in Tabs collection)",uiLabel:"Active Tab Index",isOptional:!0},{name:"DashboardTitle",kind:"string",description:"Title to display in Dashboard Header",uiLabel:"Dashboard Title",isOptional:!0,defaultValue:"`adaptableId` in Adaptable Options"},{name:"FloatingPosition",kind:"REFERENCE",description:"Position of Dashboard when in 'floating mode'",uiLabel:"Floating Position",isOptional:!0,reference:"AdaptableCoordinate"},{name:"IsCollapsed",kind:"boolean",description:"Whether Dashboard is collapsed; if true, header is visible (but not tabs' contents)",uiLabel:"Is Collapsed",isOptional:!0,defaultValue:"false"},{name:"IsFloating",kind:"boolean",description:"Whether Dashboard is floating; if true, appears in draggable, minmised form (double-click to revert to default position)",uiLabel:"Is Floating",isOptional:!0,defaultValue:"false"},{name:"IsHidden",kind:"boolean",description:"Whether Dashboard is completely hidden - can be made visible again in Column menu and toolpanel",uiLabel:"Is Hidden",isOptional:!0,defaultValue:"false"},{name:"IsInline",kind:"boolean",description:"Alternative way of showing Expanded Dashboard where headers section is to left of Toolbars",uiLabel:"Is Inline",isOptional:!0,defaultValue:"false"},{name:"ModuleButtons",kind:"REFERENCE",description:"Module Buttons which open screen in Settings Panel for associated AdapTable Module",uiLabel:"Module Buttons",isOptional:!0,defaultValue:"['SettingsPanel']",reference:"unknown"},{name:"Tabs",kind:"array",description:"Named group of Toolbars",uiLabel:"Tabs",isOptional:!0,defaultValue:"Empty Array"}]},DashboardTab:{name:"DashboardTab",kind:"Interface",description:"Defines a named set of Toolbars in the AdapTable Dashboard",properties:[{name:"Name",kind:"string",description:"Name of the tab - as appears in the Dashboard",uiLabel:"Name"},{name:"Toolbars",kind:"unknown",description:"List of Toolbars to show in the Tab",uiLabel:"Toolbars"}]},DataChangeHistoryApi:{name:"DataChangeHistoryApi",kind:"Interface",description:"Provides run-time access to the Data Change History Module",properties:[{name:"activateDataChangeHistory",kind:"function",description:"Activates Data Change History tracking (or resumes it, if it is currently suspended)",uiLabel:"Activate Data Change History"},{name:"deactivateDataChangeHistory",kind:"function",description:"Deactivates Data Change History tracking and flushes the cache",uiLabel:"Deactivate Data Change History"},{name:"getDataChangeHistoryLog",kind:"function",description:"Retrieves all data changes which are currently available",uiLabel:"Get Data Change History Log"},{name:"getDataChangeHistoryMode",kind:"function",description:"Retrieves current Data Change History mode: 'ACTIVE', 'INACTIVE', 'SUSPENDED'",uiLabel:"Get Data Change History Mode"},{name:"showDataChangeHistoryPopup",kind:"function",description:"Opens Data Change History screen",uiLabel:"Show Data Change History Popup"},{name:"suspendDataChangeHistory",kind:"function",description:"Suspends data change history tracking",uiLabel:"Suspend Data Change History"},{name:"undoDataChangeHistoryEntry",kind:"function",description:"Reverts the provided data change to its previous value",uiLabel:"Undo Data Change History Entry"}]},DataChangeHistoryButton:{name:"DataChangeHistoryButton",kind:"Interface",description:"A custom AdaptableButton which provides a build in `undo` action"},DataChangeHistoryContext:{name:"DataChangeHistoryContext",kind:"Interface",description:"The context for the DataChangeHistoryButton",properties:[{name:"dataChangedInfo",kind:"REFERENCE",description:"The initial data change",uiLabel:"Data Changed Info",reference:"CellDataChangedInfo"},{name:"isGroupNode",kind:"boolean",description:"If the change references a group node.",uiLabel:"Is Group Node"},{name:"undoDataChange",kind:"unknown",description:"Helper function to undo the change.",uiLabel:"Undo Data Change"}]},DataChangeHistoryOptions:{name:"DataChangeHistoryOptions",kind:"Interface",description:"Options to manage the 'Data Change History Module', which provides an overview of all previous changes, giving the possibility to undo specific changes",properties:[{name:"activeByDefault",kind:"boolean",description:"Whether data change history should be active by default",uiLabel:"Active By Default",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"changeHistoryButton",kind:"unknown",description:"Action button definition. Can be used to implement undo functionality.",uiLabel:"Change History Button",isOptional:!0,defaultValue:"undefined"},{name:"showDataChange",kind:"function",description:"Function specifying which data changes to include in Data Change History",uiLabel:"Show Data Change",isOptional:!0,gridInfo:"item",defaultValue:"undefined (all data changes are logged)"}]},DataSet:{name:"DataSet",kind:"Interface",description:"Defines a Data Set object that can provide data to AdapTable",properties:[{name:"description",kind:"string",description:"Describes the Data Set",uiLabel:"Description"},{name:"form",kind:"unknown",description:"Params for Data Set popup form",uiLabel:"Form",isOptional:!0},{name:"name",kind:"string",description:"Name of Data Set",uiLabel:"Name"}]},DataSetApi:{name:"DataSetApi",kind:"Interface",description:"Provides run-time access to Data Sets",properties:[{name:"clearCurrentDataSet",kind:"function",description:"Clears currently selected Data Set",uiLabel:"Clear Current Data Set"},{name:"fireDataSetSelectedEvent",kind:"function",description:"Fires the DataSet Selected Event",uiLabel:"Fire Data Set Selected Event"},{name:"getAllDataSets",kind:"function",description:"Retrieves the Data Sets from General Options",uiLabel:"Get All Data Sets"},{name:"getCurrentDataSet",kind:"function",description:"Retrieves the currently applied Data Set",uiLabel:"Get Current Data Set"},{name:"getDataSetByName",kind:"function",description:"Retreives Data Set from State with given name",uiLabel:"Get Data Set By Name"},{name:"setDataSet",kind:"function",description:"Makes given Data Set current",uiLabel:"Set Data Set"},{name:"showDataSetPopup",kind:"function",description:"Opens Settings Panel with Data Set section selected and visible",uiLabel:"Show Data Set Popup"}]},DataSetFormContext:{name:"DataSetFormContext",kind:"Interface",description:"Used when a DataSet displays a Form",properties:[{name:"dataSet",kind:"REFERENCE",description:"The DataSet which triggered the Form",uiLabel:"Data Set",reference:"DataSet"}]},DataSetSelectedInfo:{name:"DataSetSelectedInfo",kind:"Interface",description:"Object returned by the `DataSetSelected` event",properties:[{name:"dataSet",kind:"REFERENCE",description:"The DataSet that has been selected",uiLabel:"Data Set",reference:"DataSet"}]},DataUpdateConfig:{name:"DataUpdateConfig",kind:"Interface",description:"Object passed into Adaptable Grid Api data management methods",properties:[{name:"addIndex",kind:"number",description:"Index where to add new rows",uiLabel:"Add Index",isOptional:!0},{name:"callback",kind:"unknown",description:"Callback function invoked when a batch successfully updates",uiLabel:"Callback",isOptional:!0},{name:"runAsync",kind:"boolean",description:"Whether data should be updated asynchronously",uiLabel:"Run Async",isOptional:!0}]},DateFormatterOptions:{name:"DateFormatterOptions",kind:"Interface",description:"Formatter Options for Date Columns - contains a single `Pattern` property",properties:[{name:"Pattern",kind:"string",description:"Pattern to use for Date Format",uiLabel:"Pattern",isOptional:!0}]},DateInputOptions:{name:"DateInputOptions",kind:"Interface",description:"Options for managing and customizing the date inputs.",properties:[{name:"dateFormat",kind:"string",description:"Format string for formatting date input field",uiLabel:"Date Format",isOptional:!0,defaultValue:"'yyyy-MM-dd'"},{name:"datepickerButtons",kind:"array",description:"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 `|`",uiLabel:"Datepicker Buttons",isOptional:!0,defaultValue:"['close','today']"},{name:"locale",kind:"unknown",description:"Locale object (to localize Date Picker)",uiLabel:"Locale",isOptional:!0,defaultValue:"`en-US`"},{name:"showOutsideDays",kind:"boolean",description:"Display outside days (i.e. those falling in next or previous month)",uiLabel:"Show Outside Days",isOptional:!0,defaultValue:"true"},{name:"showWeekNumber",kind:"boolean",description:"Display the week numbers column",uiLabel:"Show Week Number",isOptional:!0,defaultValue:"false"},{name:"useNativeInput",kind:"boolean",description:"Use browser specific date input instead of AdapTable's Date Picker",uiLabel:"Use Native Input",isOptional:!0,defaultValue:"false"}]},DefaultAccessLevelContext:{name:"DefaultAccessLevelContext",kind:"Interface",description:"Provided to defaultAccessLevel function when setting Default Entitlement value programatically",properties:[{name:"adaptableId",kind:"string",description:"Id of current AdapTable instance",uiLabel:"Adaptable Id"},{name:"userName",kind:"string",description:"Name of Current User",uiLabel:"User Name"}]},DeletedActionRowInfo:{name:"DeletedActionRowInfo",kind:"Interface",description:"Info passed into ActionRowSubmitted Event for Deleted Rows",properties:[{name:"rowNode",kind:"REFERENCE",description:"Node being deleted",uiLabel:"Row Node",reference:"unknown"},{name:"type",kind:"unknown",description:"Specifies its a Deleted Action Row",uiLabel:"Type"}]},EditActionRowContext:{name:"EditActionRowContext",kind:"Interface",description:"Context used in an Edit Row Form",properties:[{name:"rowNode",kind:"REFERENCE",description:"The RowNode being edited",uiLabel:"Row Node",reference:"unknown"},{name:"type",kind:"unknown",description:"Type of the Context",uiLabel:"Type"}]},EditedActionRowInfo:{name:"EditedActionRowInfo",kind:"Interface",description:"Info passed into ActionRowSubmitted Event for Edited Rows",properties:[{name:"formData",kind:"REFERENCE",description:"Data entered in the Form",uiLabel:"Form Data",reference:"unknown"},{name:"rowNode",kind:"REFERENCE",description:"Node being edited",uiLabel:"Row Node",reference:"unknown"},{name:"type",kind:"unknown",description:"Specifies its an Edited Action Row",uiLabel:"Type"}]},EditLookUpContext:{name:"EditLookUpContext",kind:"Interface",description:"Context used when getting EditLookUpPermittedValues via a function",properties:[{name:"gridCell",kind:"REFERENCE",description:"Cell being edited",uiLabel:"Grid Cell",isOptional:!0,reference:"GridCell"}]},EditLookUpPermittedValues:{name:"EditLookUpPermittedValues",kind:"Interface",description:"Used to define permitted values for inline column editor",properties:[{name:"values",kind:"unknown",description:"Values to display in Edit Look Up: either hardcoded list or a function that returns a list",uiLabel:"Values",isOptional:!0}]},EditOptions:{name:"EditOptions",kind:"Interface",description:"Options related to Editing in Adaptable - includes Server Validation, Smart Edit Operations and Row Forms",properties:[{name:"displayServerValidationMessages",kind:"boolean",description:"Whether to display message after Server Validation runs",uiLabel:"Display Server Validation Messages",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"isCellEditable",kind:"function",description:"Function which checks if a given Grid Cell is editable",uiLabel:"Is Cell Editable",isOptional:!0},{name:"smartEditCustomOperations",kind:"array",description:"Custom Operations to use in Smart Edit",uiLabel:"Smart Edit Custom Operations",isOptional:!0},{name:"validateOnServer",kind:"unknown",description:"Function to validate Adaptable data edits on Server",uiLabel:"Validate On Server",isOptional:!0}]},EntitlementContext:{name:"EntitlementContext",kind:"Interface",description:"Provided to moduleEntitlements function when setting Entitlements programatically",properties:[{name:"adaptableId",kind:"string",description:"Id of current AdapTable instance",uiLabel:"Adaptable Id"},{name:"adaptableModule",kind:"REFERENCE",description:"Module being entitled",uiLabel:"Adaptable Module",reference:"AdaptableModule"},{name:"defaultAccessLevel",kind:"REFERENCE",description:"The default Access Level for the current instance",uiLabel:"Default Access Level",reference:"AccessLevel"},{name:"userName",kind:"string",description:"Name of Current User",uiLabel:"User Name"}]},EntitlementOptions:{name:"EntitlementOptions",kind:"Interface",description:"Options for managing Entitlements in AdapTable, ie. which Modules are available to the User and whether as *Full*, *ReadOnly* or *Hidden*.",properties:[{name:"defaultAccessLevel",kind:"unknown",description:"AccessLevel to use when an Entitlement is not explicitly set; can be hardcoded value or a function to invoke",uiLabel:"Default Access Level",isOptional:!0,gridInfo:"item",defaultValue:"'Full'"},{name:"moduleEntitlements",kind:"unknown",description:"Returns either collection of `Entitlements`, or a function to invoke when an Entitlement is required",uiLabel:"Module Entitlements",isOptional:!0,gridInfo:"item"}]},EvaluateExpressionExternallyContext:{name:"EvaluateExpressionExternallyContext",kind:"Interface",description:"Context passed when evaluating `AdaptableQLOptions.evaluateExpressionExternally()`",properties:[{name:"expression",kind:"string",description:"Expression to evlauate",uiLabel:"Expression",isOptional:!0},{name:"module",kind:"REFERENCE",description:"Module where the Expression is being evaluated",uiLabel:"Module",reference:"unknown"},{name:"referencedColumns",kind:"array",description:"Columns contained in the Expression",uiLabel:"Referenced Columns",isOptional:!0}]},EventApi:{name:"EventApi",kind:"Interface",description:"Responsible for publishing the many Events that AdapTable fires",properties:[{name:"off",kind:"function",description:"",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from SystemStatusMessageDisplayed",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from AlertFired",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from FlashingCellDisplayed",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from CheckboCxolumnClicked",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from LayoutChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from CustomToolbarConfigured",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from DashboardChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from AdaptableStateChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from AdaptableStateReloaded",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from LiveDataChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from GridSorted",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from ActionRowSubmitted",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from DataSetSelected",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from AdaptableReady",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from FDC3MessageSent",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from QueryRun",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from FilterApplied",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from CellChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from TeamSharingEntityChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from GridDataChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from SelectionChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from ThemeChanged",uiLabel:"Off"},{name:"on",kind:"function",description:"",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever a **System Status Message is displayed** in AdapTable",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever an **Alert is triggered** in AdapTable.",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever **Cell Flashing** is triggered in AdapTable.",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever the **Button in a Checkbox Column is clicked**.",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever the current Layout updates in AdapTable",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever **Configure Button is clicked in a Custom Toolbar**",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever **Dashboard State changes** Primarily used for rendering Custom toolbars.",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever **Adaptable State changes**",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever **Adaptable State is reloaded**",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever **a change occurs relating to live reports / data** Used in conjunction with AdapTable's partners OpenFin, ipushpull or Glue42",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever AdapTable is Sorted",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired when an Action Row is submitted",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired when a DataSet is Selected",uiLabel:"On"},{name:"on",kind:"function",description:"Fired when Adaptable is up and running - has no arguments.",uiLabel:"On"},{name:"on",kind:"function",description:"Fired when Adaptable is destroyed",uiLabel:"On"},{name:"on",kind:"function",description:"Fired when an FDC3Message is sent",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever a Query is run in AdapTable",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever a Filter is Applied in AdapTable",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever a cell changes in the Grid",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever a Shared Entity in Team Sharing changes",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired when a row is added, deleted or updated in the Grid",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever the Cell or Row **Selection in AdapTable changes**.",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever the **selected theme of AdapTable is changed**.",uiLabel:"On"}]},ExportApi:{name:"ExportApi",kind:"Interface",description:"Provides run-time access to the Export Module and Report state",properties:[{name:"canExportToExcel",kind:"function",description:"If this AdapTable instance can to export to Excel; if false, the Export to Excel option will not be visible",uiLabel:"Can Export To Excel"},{name:"editReport",kind:"function",description:"Edits an existing report",uiLabel:"Edit Report"},{name:"editReports",kind:"function",description:"Edits existing reports",uiLabel:"Edit Reports"},{name:"exportDataToExcel",kind:"function",description:"Exports data to Excel",uiLabel:"Export Data To Excel"},{name:"exportVisualDataToExcel",kind:"function",description:"Exports data currently in grid to Excel as What-You-See-Is-What-You-Get",uiLabel:"Export Visual Data To Excel"},{name:"getAllCustomDestination",kind:"function",description:"Retrieves all Custom Destinations from Export Options",uiLabel:"Get All Custom Destination"},{name:"getAllReports",kind:"function",description:"Retrieves all Reports in State - both System and User-created Reports",uiLabel:"Get All Reports"},{name:"getAllServerReports",kind:"function",description:"Returns any Custom Reports that have been provided to Export Options",uiLabel:"Get All Server Reports"},{name:"getAvailableExportDestinations",kind:"function",description:"Retrieves the available export destinations",uiLabel:"Get Available Export Destinations"},{name:"getAvailableSystemReports",kind:"function",description:"Retrieves System Reports section of Export State",uiLabel:"Get Available System Reports"},{name:"getCurrentDestination",kind:"function",description:"Retrieves the current Export destination",uiLabel:"Get Current Destination"},{name:"getCurrentReport",kind:"function",description:"Retrieves currently selected Report",uiLabel:"Get Current Report"},{name:"getCurrentReportName",kind:"function",description:"Retrieves name of currently selected Report",uiLabel:"Get Current Report Name"},{name:"getDestinationByName",kind:"function",description:"Retrieves Destination with the given name",uiLabel:"Get Destination By Name"},{name:"getExportDestinationForm",kind:"function",description:"Form Data entered by the User in the UI for a Custom Destination",uiLabel:"Get Export Destination Form"},{name:"getExportState",kind:"function",description:"Retrieves Export section from Adaptable State",uiLabel:"Get Export State"},{name:"getReportById",kind:"function",description:"Retrieves Report by Id",uiLabel:"Get Report By Id"},{name:"getReportByName",kind:"function",description:"Retrieves Report with the given name",uiLabel:"Get Report By Name"},{name:"getReportDataForReport",kind:"function",description:"Returns the ReportData for the Report with the given name",uiLabel:"Get Report Data For Report"},{name:"getReportSchedules",kind:"function",description:"Retrieves all Report Schedules",uiLabel:"Get Report Schedules"},{name:"isDataChangeInReport",kind:"function",description:"Whether given data change affects given report",uiLabel:"Is Data Change In Report"},{name:"isExportDestinationCustom",kind:"function",description:"If the given destination is a Custom one",uiLabel:"Is Export Destination Custom"},{name:"isServerReport",kind:"function",description:"Whether a Report is a Custom Report",uiLabel:"Is Server Report"},{name:"runServerReport",kind:"function",description:"Runs the report function of the ServerReport with the given reportName",uiLabel:"Run Server Report"},{name:"selectDestination",kind:"function",description:"Selects the report destination in the dashboard and statusbar UI",uiLabel:"Select Destination"},{name:"selectReport",kind:"function",description:"Selects the report in the dashboard and statusbar UI",uiLabel:"Select Report"},{name:"sendReport",kind:"function",description:"Sends a Report to a given destination",uiLabel:"Send Report"},{name:"showExportPopup",kind:"function",description:"Opens Settings Panel with Export section selected and visible",uiLabel:"Show Export Popup"}]},ExportFormContext:{name:"ExportFormContext",kind:"Interface",description:"Context required by functions when using an Export Button",properties:[{name:"customDestination",kind:"REFERENCE",description:"Custom Export destination",uiLabel:"Custom Destination",reference:"CustomDestination"},{name:"report",kind:"REFERENCE",description:"The exported report",uiLabel:"Report",reference:"unknown"},{name:"reportData",kind:"REFERENCE",description:"The data in the report",uiLabel:"Report Data",reference:"ReportData"}]},ExportOptions:{name:"ExportOptions",kind:"Interface",description:"Options regarding Exporting data from AdapTable",properties:[{name:"appendFileTimestamp",kind:"boolean",description:"Whether to add a timestamp as a suffix to exported file name",uiLabel:"Append File Timestamp",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"customDestinations",kind:"array",description:"User-provided Report Destinations (in addition to those shipped in AdapTable)",uiLabel:"Custom Destinations",isOptional:!0},{name:"exportDateFormat",kind:"string",description:"Optional custom format for Date columns when exporting",uiLabel:"Export Date Format",isOptional:!0,gridInfo:"item",defaultValue:"undefined"},{name:"exportFormatType",kind:"unknown",description:"Format of exported values; can be set either for whole grid or specifically for each column type",uiLabel:"Export Format Type",isOptional:!0,defaultValue:"rawValue"},{name:"serverReports",kind:"array",description:"Reports run entirely by users (and not AdapTable)",uiLabel:"Server Reports",isOptional:!0},{name:"systemExportDestinations",kind:"REFERENCE",description:"Export destinations to use; leave blank for all, empty array for none",uiLabel:"System Export Destinations",isOptional:!0,gridInfo:"item",defaultValue:"'Excel', 'CSV', 'Clipboard', 'JSON'",reference:"SystemExportDestinations"},{name:"systemReportNames",kind:"REFERENCE",description:"System Reports to use; leave blank for all, empty array for none",uiLabel:"System Report Names",isOptional:!0,gridInfo:"item",defaultValue:"'Visual Data', 'All Data', 'Current Data', 'Selected Cells', 'Selected Rows',",reference:"SystemReportNames"}]},ExportState:{name:"ExportState",kind:"Interface",description:"Predefined Configuration for Export Module",properties:[{name:"CurrentDestination",kind:"unknown",description:"Currently selected Report Destination in Export Toolbar & Tool Panel",uiLabel:"Current Destination",isOptional:!0},{name:"CurrentReport",kind:"string",description:"Currently selected Report - in Export Toolbar & Tool Panel",uiLabel:"Current Report",isOptional:!0},{name:"Reports",kind:"array",description:"User-created Reports; each has Name and Row and Column Scope",uiLabel:"Reports",isOptional:!0}]},ExpressionContext:{name:"ExpressionContext",kind:"Interface",description:"Provides context to an Expression Function, including current row node and AdaptableApi",properties:[{name:"evaluateCustomQueryVariable",kind:"unknown",description:"Evaluate custom variables",uiLabel:"Evaluate Custom Query Variable"},{name:"filterFn",kind:"unknown",description:"Optional filter function to be applied before evaluating the expression",uiLabel:"Filter Fn",isOptional:!0},{name:"functions",kind:"unknown",description:"All Expression Functions available to AdaptableQL",uiLabel:"Functions"},{name:"namedQueryCallStack",kind:"array",description:"All Named Query evaluations: tracked in order to detect circular dependencies",uiLabel:"Named Query Call Stack",isOptional:!0},{name:"node",kind:"unknown",description:"Current AG Grid Row Node being evaluated",uiLabel:"Node"},{name:"whereClauseFunctions",kind:"unknown",description:"Expression Functions available to AdaptableQL in (optional) WHERE clause",uiLabel:"Where Clause Functions",isOptional:!0}]},ExpressionFunction:{name:"ExpressionFunction",kind:"Interface",description:"Defines an AdaptableQL Function used in an Adaptable Expression",properties:[{name:"description",kind:"string",description:"What the AdaptableQL Function does",uiLabel:"Description",isOptional:!0},{name:"examples",kind:"array",description:"Examples that use the AdaptableQL Function",uiLabel:"Examples",isOptional:!0},{name:"handler",kind:"REFERENCE",description:"Actual AdaptableQL Function called by the Expression (mandatory prop)",uiLabel:"Handler",reference:"ExpressionFunctionHandler"},{name:"hasEagerEvaluation",kind:"boolean",description:"Whether Expression is evaluated eagerly (without handling inner AST nodes)",uiLabel:"Has Eager Evaluation",isOptional:!0},{name:"isHiddenFromMenu",kind:"boolean",description:"Removes entry from Expression Editor's Functions dropdown",uiLabel:"Is Hidden From Menu",isOptional:!0},{name:"isPredicate",kind:"boolean",description:"Whether the AdaptableQL Function returns true, if so can be used as Query",uiLabel:"Is Predicate",isOptional:!0},{name:"signatures",kind:"array",description:"How the AdaptableQL Function should be called",uiLabel:"Signatures",isOptional:!0}]},ExpressionFunctionDocBlock:{name:"ExpressionFunctionDocBlock",kind:"TypeAlias",description:"Defines how an AdaptableQL Function is described in Expression Editor"},ExpressionFunctionHandler:{name:"ExpressionFunctionHandler",kind:"TypeAlias",description:"The javascript function which is invoked by an AdaptableQL Function"},ExpressionFunctionMap:{name:"ExpressionFunctionMap",kind:"TypeAlias",description:"Key-Value map of Expression Names and their implementation"},ExpressionOptions:{name:"ExpressionOptions",kind:"Interface",description:"Options for managing Expressions using AdaptableQL",properties:[{name:"customBooleanFunctions",kind:"unknown",description:"Custom (user defined) Boolean Expression Functions available in AdaptableQL",uiLabel:"Custom Boolean Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (none)"},{name:"customQueryVariables",kind:"unknown",description:"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.",uiLabel:"Custom Query Variables",isOptional:!0},{name:"customScalarFunctions",kind:"unknown",description:"Custom (user defined) Scalar Expression Functions available in AdaptableQL",uiLabel:"Custom Scalar Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (none)"},{name:"isColumnQueryable",kind:"function",description:"Specifies if a given column can be included in Queries",uiLabel:"Is Column Queryable",isOptional:!0},{name:"maxTimeframeSize",kind:"number",description:"Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe (see observableExpressionFunctions); value is capped at 86400000 (~24 hours) for performance reasons",uiLabel:"Max Timeframe Size",isOptional:!0,gridInfo:"item",defaultValue:"28800000 (~8 hours)"},{name:"moduleExpressionFunctions",kind:"unknown",description:"Module specific ExpressionFunctions; if not defined, it falls back to the generally defined system and custom values",uiLabel:"Module Expression Functions",isOptional:!0,gridInfo:"item",defaultValue:"undefined (defaults to available system & custom values)"},{name:"performExpressionValidation",kind:"boolean",description:"Validate Expressions before they can be run or saved",uiLabel:"Perform Expression Validation",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"systemAggregatedBooleanFunctions",kind:"unknown",description:"System (built-in) AggregatedBoolean Expression Functions available in AdaptableQL",uiLabel:"System Aggregated Boolean Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"},{name:"systemAggregatedScalarFunctions",kind:"unknown",description:"System (built-in) AggregatedScalar Expression Functions available in AdaptableQL",uiLabel:"System Aggregated Scalar Functions",isOptional:!0,gridInfo:"item",defaultValue:"undefined (sets all)"},{name:"systemBooleanFunctions",kind:"unknown",description:"System (built-in) Boolean Expression Functions available in AdaptableQL",uiLabel:"System Boolean Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"},{name:"systemObservableFunctions",kind:"unknown",description:"System (built-in) Observable Expression Functions available in AdaptableQL",uiLabel:"System Observable Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"},{name:"systemScalarFunctions",kind:"unknown",description:"System (built-in) Scalar Expression Functions available in AdaptableQL",uiLabel:"System Scalar Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"}]},FDC3Column:{name:"FDC3Column",kind:"Interface",description:"An FDC3 Column - will raise FDC3 intents and broadcast FDC3 messages",properties:[{name:"broadcastContextMenuLabel",kind:"unknown",description:"Label to display in Broadcast Context Menu Item",uiLabel:"Broadcast Context Menu Label",isOptional:!0},{name:"columnId",kind:"string",description:"Id of Column defined as FDC3",uiLabel:"Column Id"},{name:"intentContextMenuLabel",kind:"unknown",description:"Label to display in Intent Context Menu Item",uiLabel:"Intent Context Menu Label",isOptional:!0},{name:"intentIcon",kind:"unknown",description:"Returns a custom icon to display in the Raise Intent Context Menu Item;",uiLabel:"Intent Icon",isOptional:!0},{name:"intents",kind:"array",description:"FDC3 intents which the Column can raise",uiLabel:"Intents",isOptional:!0},{name:"nameColumnId",kind:"string",description:"If provided, will supply `name` property in FDC3 message",uiLabel:"Name Column Id",isOptional:!0},{name:"showBroadcastContextMenu",kind:"boolean",description:"Should Column display a 'Broadcast' context menu item",uiLabel:"Show Broadcast Context Menu",isOptional:!0}]},FDC3Context:{name:"FDC3Context",kind:"Interface",description:"General-purpose context type, as defined by FDC3",properties:[{name:"id",kind:"{\n        [key: string]: string | undefined;\n    }",description:"Optional map of any equivalent identifiers for the context type, e.g. ISIN, CUSIP, etc. for Instrument",uiLabel:"Id",isOptional:!0},{name:"name",kind:"string",description:"Name of the context data (optional) - a text string that describes the data being sent",uiLabel:"Name",isOptional:!0},{name:"type",kind:"REFERENCE",description:"Type of FDC3Context that uniquely identifies it, e.g. "instrument"; used to refer to the accepted context(s) when declaring intents",uiLabel:"Type",reference:"FDC3ContextType"}]},FDC3ContextType:{name:"FDC3ContextType",kind:"TypeAlias",description:"Defines which FDC3 context is being used"},FDC3Intent:{name:"FDC3Intent",kind:"TypeAlias",description:"Full list of FDC3 Intents available - each FDC3 Column can use a subset"},FilterActionOnDataChange:{name:"FilterActionOnDataChange",kind:"Interface",description:"Whether Adaptable re-applies filtering after data edits; if `applyFilter` value is 'Throttle', `throttleDelay` should be set",properties:[{name:"applyFilter",kind:"'Always' | 'Never' | 'Throttle'",description:"When to re-apply Filters: 'Always', 'Never' or 'Throttle'",uiLabel:"Apply Filter"},{name:"throttleDelay",kind:"number",description:"Delay in ms (when `applyFilter` is set to 'Throttle')",uiLabel:"Throttle Delay",isOptional:!0}]},FilterApi:{name:"FilterApi",kind:"Interface",description:"Provides run-time access to Filter section of Adaptable State.",properties:[{name:"areColumnFiltersDifferent",kind:"function",description:"Compares to sets of Column Filters to see if they are identical",uiLabel:"Are Column Filters Different"},{name:"clearAndSetColumnFilter",kind:"function",description:"Clears existing Column Filters and sets new ones",uiLabel:"Clear And Set Column Filter"},{name:"clearColumnFilter",kind:"function",description:"Clears given Column Filter",uiLabel:"Clear Column Filter"},{name:"clearColumnFilterByColumn",kind:"function",description:"Clears Column Filter for given Column",uiLabel:"Clear Column Filter By Column"},{name:"clearColumnFilterByColumns",kind:"function",description:"Clears Column Filters for given set of Columns",uiLabel:"Clear Column Filter By Columns"},{name:"clearColumnFilters",kind:"function",description:"Clears all Column Filters in the Current Layout",uiLabel:"Clear Column Filters"},{name:"columnFiltersToString",kind:"function",description:"Retrieves descriptions of given Column Filters",uiLabel:"Column Filters To String"},{name:"columnFilterToString",kind:"function",description:"Retrieves description of given Column Filter",uiLabel:"Column Filter To String"},{name:"createEqualityColumnFilterForCell",kind:"function",description:"Creates an Equality Filter based on given Grid Cell",uiLabel:"Create Equality Column Filter For Cell"},{name:"createValuesColumnFilterForCells",kind:"function",description:"Creates an Equality Filter based on given Grid Cells",uiLabel:"Create Values Column Filter For Cells"},{name:"evaluateColumnFilter",kind:"function",description:"Calls AdapTableQL to evaluate Filter for given Row",uiLabel:"Evaluate Column Filter"},{name:"findPredicateDefByShortcut",kind:"function",description:"Returns Predicate Definition for given Column and Quick Filter shortcut",uiLabel:"Find Predicate Def By Shortcut"},{name:"fireFilterAppliedEvent",kind:"function",description:"Fires Filter Applied Event - typically used to enable filtering on the server",uiLabel:"Fire Filter Applied Event"},{name:"getActiveColumnFilters",kind:"function",description:"Retrieves all active/no-suspedned Column Filters in currently applied Layout",uiLabel:"Get Active Column Filters"},{name:"getAllColumnFilterForColumn",kind:"function",description:"Retrieves all Column Filters for given Column",uiLabel:"Get All Column Filter For Column"},{name:"getAllSystemFilterIds",kind:"function",description:"Retrieves Ids for all System Filters",uiLabel:"Get All System Filter Ids"},{name:"getColumnFilter",kind:"function",description:"Retrieves the Column Filter for the specified Column.",uiLabel:"Get Column Filter"},{name:"getColumnFilters",kind:"function",description:"Retrieves all Column Filters in currently applied Layout",uiLabel:"Get Column Filters"},{name:"getColumnFiltersForLayout",kind:"function",description:"Retrieves all Column Filters in a given Layout",uiLabel:"Get Column Filters For Layout"},{name:"getFilterPredicateDefsForColumn",kind:"function",description:"Gets all Filter Predicates available for a given Column",uiLabel:"Get Filter Predicate Defs For Column"},{name:"getFilterPredicateDefsForColumnId",kind:"function",description:"Gets all Filter Predicates available for a given ColumnId",uiLabel:"Get Filter Predicate Defs For Column Id"},{name:"hideQuickFilterBar",kind:"function",description:"Hides Quick Filter bar",uiLabel:"Hide Quick Filter Bar"},{name:"isFilterActive",kind:"function",description:"Checks if a filter is active or applied. It is applied when: - filter predicate does not have inputs - filter predicate has inputs with values",uiLabel:"Is Filter Active"},{name:"isQuickFilterAvailable",kind:"function",description:"Whether Quick Filter is available for use",uiLabel:"Is Quick Filter Available"},{name:"isQuickFilterVisible",kind:"function",description:"Whether Quick Filter Form is currently visible",uiLabel:"Is Quick Filter Visible"},{name:"setColumnFilter",kind:"function",description:"Sets Column Filters - will replace filters for existing column and leave other column filters in place",uiLabel:"Set Column Filter"},{name:"shouldNewColumnFilterTriggerGridFiltering",kind:"function",description:"Checks if the filter action should trigger grid filtering.",uiLabel:"Should New Column Filter Trigger Grid Filtering"},{name:"showQuickFilterBar",kind:"function",description:"Makes Quick Filter Bar appear",uiLabel:"Show Quick Filter Bar"},{name:"suspendAllColumnFilters",kind:"function",description:"Suspends all Column Filters",uiLabel:"Suspend All Column Filters"},{name:"suspendColumnFilter",kind:"function",description:"Suspends a Column Filter",uiLabel:"Suspend Column Filter"},{name:"unSuspendAllColumnFilters",kind:"function",description:"Unsuspends all Column Filters",uiLabel:"Un Suspend All Column Filters"},{name:"unSuspendColumnFilter",kind:"function",description:"Unsuspends a Column Filter",uiLabel:"Un Suspend Column Filter"}]},FilterAppliedInfo:{name:"FilterAppliedInfo",kind:"Interface",description:"EventInfo returned by the Filter Applied event",properties:[{name:"columnFilters",kind:"unknown",description:"Currently applied Column Filters",uiLabel:"Column Filters"}]},FilterOptions:{name:"FilterOptions",kind:"Interface",description:"Options for managing Filtering in AdapTable",properties:[{name:"autoApplyFilter",kind:"boolean",description:"Apply selected filters (in Filter Form or Quick Filter Bar) as soon as they are clicked; if false an Apply Filter button is displayed",uiLabel:"Auto Apply Filter",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"true"},{name:"clearFiltersOnStartUp",kind:"boolean",description:"Clears saved Column Filters when AdapTable loads",uiLabel:"Clear Filters On Start Up",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"defaultDateColumnFilter",kind:"unknown",description:"Default filter type for date Columns",uiLabel:"Default Date Column Filter",isOptional:!0,gridInfo:"item",defaultValue:"On"},{name:"defaultFilterFormTab",kind:"'Values' | 'Predicates'",description:"Whether to open the Filter Form on the Values or Predicates tab",uiLabel:"Default Filter Form Tab",isOptional:!0,gridInfo:"item",defaultValue:"'Values'"},{name:"defaultNumericColumnFilter",kind:"unknown",description:"Default filter type for numeric Columns",uiLabel:"Default Numeric Column Filter",isOptional:!0,gridInfo:"item",defaultValue:"Equals"},{name:"defaultStringColumnFilter",kind:"unknown",description:"Default filter type for string Columns",uiLabel:"Default String Column Filter",isOptional:!0,gridInfo:"item",defaultValue:"Contains"},{name:"enableFilterOnSpecialColumns",kind:"boolean",description:"Allows filtering on Calculated & FreeText columns",uiLabel:"Enable Filter On Special Columns",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"filterActionOnExternalDataChange",kind:"REFERENCE",description:"When to re-filter grid after data ticks: 'Always', 'Never' or 'Throttle' (which requires a 'ThrottleDelay')",uiLabel:"Filter Action On External Data Change",isOptional:!0,defaultValue:"'Never'",reference:"FilterActionOnDataChange"},{name:"filterActionOnUserDataChange",kind:"REFERENCE",description:"When to re-filter grid after user edits data: 'Always', 'Never' or 'Throttle' (which requires a 'ThrottleDelay')",uiLabel:"Filter Action On User Data Change",isOptional:!0,defaultValue:"'Always'",reference:"FilterActionOnDataChange"},{name:"hideQuickFilterDropdown",kind:"function",description:"Hides the Dropdown in Quick Filter Bar for a given Column",uiLabel:"Hide Quick Filter Dropdown",isOptional:!0,defaultValue:"undefined"},{name:"hideQuickFilterInput",kind:"function",description:"Hides the Input in Quick Filter Bar for a given Column",uiLabel:"Hide Quick Filter Input",isOptional:!0,defaultValue:"undefined"},{name:"indicateFilteredColumns",kind:"boolean",description:"Make Column header distinctive for filtered columns, helps users see currently filtered columns",uiLabel:"Indicate Filtered Columns",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"true"},{name:"maxFilterValuesToDisplay",kind:"number",description:"Distinct column items to display in Filter Form; useful with large datasource (though AdapTable offers virtualisation)",uiLabel:"Max Filter Values To Display",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"2,000"},{name:"quickFilterHeight",kind:"number",description:"Sets a height for Quick Filter Bar (if not provided AG Grid's default is used)",uiLabel:"Quick Filter Height",isOptional:!0,gridInfo:"item",defaultValue:"null"},{name:"quickFilterTrigger",kind:"'mouseenter' | 'click'",description:"Whether to open Quick Filter dropdown with mouse hover or click",uiLabel:"Quick Filter Trigger",isOptional:!0,gridInfo:"item",defaultValue:"'mouseenter'"},{name:"quickFilterValuesTrigger",kind:"'mouseenter' | 'click'",description:"Whether to open Quick Filter Values dropdown with mouse hover or click",uiLabel:"Quick Filter Values Trigger",isOptional:!0,gridInfo:"item",defaultValue:"'mouseenter'"},{name:"showClearFilterButton",kind:"boolean",description:"Display Clear Filter button in Toolbar and Toolpanel",uiLabel:"Show Clear Filter Button",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"showDistinctFilteredValuesOnly",kind:"boolean",description:"Display only currently filtered distinct values in Filter controls",uiLabel:"Show Distinct Filtered Values Only",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"showQuickFilter",kind:"boolean",description:"Whether to display Quick Filter Bar between Column Header and the Grid (provided its been setup)",uiLabel:"Show Quick Filter",isOptional:!0,defaultValue:"true"},{name:"showSuspendFilterButton",kind:"boolean",description:"Display Suspend / Unsuspend Button in Toolbar and Toolpanel",uiLabel:"Show Suspend Filter Button",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"sortColumnValuesInFilter",kind:"boolean",description:"Whether column values in filter dropdown should apply column's current Sort Order for the column",uiLabel:"Sort Column Values In Filter",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"systemFilters",kind:"REFERENCE",description:"Which Adaptable System Filter Predicates are available",uiLabel:"System Filters",isOptional:!0,reference:"SystemFilterPredicateIds"},{name:"useAdaptableFilterForm",kind:"boolean | string[]",description:"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",uiLabel:"Use Adaptable Filter Form",isOptional:!0,noCode:"item",defaultValue:"true"},{name:"useAdaptableQuickFilter",kind:"boolean | string[]",description:"Use Adaptable's Quick Filter Bar for all columns if 'true' (the default) or those listed, in preference to AG Grid's Floating Filter",uiLabel:"Use Adaptable Quick Filter",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"true"},{name:"useAgGridFilterFormStyle",kind:"boolean",description:"Styles Adaptable Filter Form to match AG Grid's styling (if using Balham theme)",uiLabel:"Use Ag Grid Filter Form Style",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"true"}]},FilterPermittedValues:{name:"FilterPermittedValues",kind:"Interface",description:"Used to define values inside the floating filter and floating filter (quick filter)",properties:[{name:"suppressFilterSearchBar",kind:"boolean",description:"Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed",uiLabel:"Suppress Filter Search Bar",isOptional:!0,defaultValue:"false"},{name:"values",kind:"unknown",description:"Values to display in 'IN' Filter: either hardcoded list or a function that returns a list",uiLabel:"Values"}]},FilterPermittedValuesContext:{name:"FilterPermittedValuesContext",kind:"Interface",description:"Context used when getting FilterPermittedValues via a function",properties:[{name:"searchFilter",kind:"string",description:"A search string",uiLabel:"Search Filter"}]},FinanceApi:{name:"FinanceApi",kind:"Interface",description:"Provides run-time access to the Finance Plugin",properties:[{name:"createFDC3ContactContext",kind:"function",description:"Creates FDC3 Contact Context",uiLabel:"Create FDC3Contact Context"},{name:"createFDC3ContactListContext",kind:"function",description:"Creates FDC3 Contact List Context",uiLabel:"Create FDC3Contact List Context"},{name:"createFDC3CountryContext",kind:"function",description:"Creates FDC3 Country Context",uiLabel:"Create FDC3Country Context"},{name:"createFDC3InstrumentContext",kind:"function",description:"Creates FDC3 Instrument Context",uiLabel:"Create FDC3Instrument Context"},{name:"createFDC3InstrumentListContext",kind:"function",description:"Creates FDC3 Instrumentlist Context",uiLabel:"Create FDC3Instrument List Context"},{name:"createFDC3OrganizationContext",kind:"function",description:"Creates FDC3 Organization Context",uiLabel:"Create FDC3Organization Context"},{name:"createFDC3PortfolioContext",kind:"function",description:"Creates FDC3 Portfolio Context",uiLabel:"Create FDC3Portfolio Context"},{name:"createFDC3PositionContext",kind:"function",description:"Creates FDC3 Position Context",uiLabel:"Create FDC3Position Context"},{name:"getContactColumnById",kind:"function",description:"Gets Contact Column with given Id",uiLabel:"Get Contact Column By Id"},{name:"getCountryColumnById",kind:"function",description:"Gets Country Column with given Id",uiLabel:"Get Country Column By Id"},{name:"getInstrumentColumnById",kind:"function",description:"Gets Instrument Column with given Id",uiLabel:"Get Instrument Column By Id"},{name:"getOrganizationColumnById",kind:"function",description:"Gets Organization Column with given Id",uiLabel:"Get Organization Column By Id"},{name:"getPluginOptions",kind:"function",description:"Retrieves the FinancePlugOptions provided in the Finance Plugin",uiLabel:"Get Plugin Options"},{name:"getPositionColumnById",kind:"function",description:"Gets Position Column with given Id",uiLabel:"Get Position Column By Id"},{name:"isValidContactlistIntent",kind:"function",description:"Checks whether the Contact Intent is valid for Contact Lists",uiLabel:"Is Valid Contactlist Intent"},{name:"isValidInstrumentlistIntent",kind:"function",description:"Checks whether the Instrument Intent is valid for Instrument Lists",uiLabel:"Is Valid Instrumentlist Intent"},{name:"isValidPositionIntent",kind:"function",description:"Checks whether the Position Intent is valid for single Positions (and not Portfolios)",uiLabel:"Is Valid Position Intent"},{name:"publishBroadcastFDC3MessageEvent",kind:"function",description:"Publishes an FDC3 Message Event of type `Broadcast`",uiLabel:"Publish Broadcast FDC3Message Event"},{name:"publishRaiseFDC3IntentEvent",kind:"function",description:"Publishes an FDC3 Message Event of type `Raise Event`",uiLabel:"Publish Raise FDC3Intent Event"}]},FinancePluginOptions:{name:"FinancePluginOptions",kind:"Interface",description:"Options required for when using the Finance plugin",properties:[{name:"availableFDC3Intents",kind:"unknown",description:"Intents to which to subscribe.",uiLabel:"Available FDC3Intents",isOptional:!0},{name:"fdc3Columns",kind:"unknown",description:"Columns to be defined as FDC3-related",uiLabel:"Fdc3Columns",isOptional:!0},{name:"onFDC3Context",kind:"unknown",description:"Called when a context changes.",uiLabel:"On FDC3Context",isOptional:!0},{name:"onFDC3Intent",kind:"unknown",description:"Called when an intent from `availableIntents` is raised.",uiLabel:"On FDC3Intent",isOptional:!0},{name:"weightedAverageColumns",kind:"array",description:"",uiLabel:"Weighted Average Columns",isOptional:!0}]},FinsembleApi:{name:"FinsembleApi",kind:"Interface",description:"Provides run-time access to the Finsemble Plugin",properties:[{name:"getPluginOptions",kind:"function",description:"Retrieves the FinsemblePlugOptions provided in Finsemble Plugin",uiLabel:"Get Plugin Options"}]},FinsemblePluginOptions:{name:"FinsemblePluginOptions",kind:"Interface",description:"Options required for when using the Finsemble plugin",properties:[{name:"applicationName",kind:"string",description:"Application name - used to identify the application in Finsemble console",uiLabel:"Application Name",isOptional:!0},{name:"showAdaptableAlertsAsNotifications",kind:"boolean",description:"Should Adaptable's Alerts appear as Finsemble Notifications",uiLabel:"Show Adaptable Alerts As Notifications",isOptional:!0,defaultValue:"true"},{name:"stateOptions",kind:"REFERENCE",description:"Options for managing Adaptable State with Finsemble State",uiLabel:"State Options",isOptional:!0,reference:"unknown"}]},FlashingCellApi:{name:"FlashingCellApi",kind:"Interface",description:"Provides run-time access to Flashing Cell functionality and associated State",properties:[{name:"addFlashingCellDefinition",kind:"function",description:"Adds a Flashing cell Definition to State",uiLabel:"Add Flashing Cell Definition"},{name:"addFlashingCellDefinitions",kind:"function",description:"Adds provided Flashing cell Definitions",uiLabel:"Add Flashing Cell Definitions"},{name:"clearGridFlashing",kind:"function",description:"Clears all Cells and Rows which have been flashed (primarily used if duration is 'Always')",uiLabel:"Clear Grid Flashing"},{name:"editFlashingCellDefinition",kind:"function",description:"Edits Flashing Cell Definition in State with given one",uiLabel:"Edit Flashing Cell Definition"},{name:"editFlashingCellDefinitions",kind:"function",description:"Edits provided Flashing cell Definitions",uiLabel:"Edit Flashing Cell Definitions"},{name:"getActiveFlashingCellDefinitions",kind:"function",description:"Retrieves all active (non-suspended) cell Definitions in Flashing Cell State",uiLabel:"Get Active Flashing Cell Definitions"},{name:"getFlashingCellDefinitionById",kind:"function",description:"Retrieves Flashing cell Definition By Id",uiLabel:"Get Flashing Cell Definition By Id"},{name:"getFlashingCellDefinitions",kind:"function",description:"Retrieves all Flashing cell Definitions in Flashing Cell State",uiLabel:"Get Flashing Cell Definitions"},{name:"getFlashingCellFlashTarget",kind:"function",description:"Returns where a Flashing cell Definition will flash a single cell or a whole row",uiLabel:"Get Flashing Cell Flash Target"},{name:"getFlashingCellPredicateDefs",kind:"function",description:"Retrieves all Predicate Defs with Module Scope of Flashing Cell",uiLabel:"Get Flashing Cell Predicate Defs"},{name:"getFlashingCellPredicateDefsForScope",kind:"function",description:"Retrieves all Predicate Defs that match given Scope",uiLabel:"Get Flashing Cell Predicate Defs For Scope"},{name:"getFlashingCellState",kind:"function",description:"Retrieves Flashing Cell section from Adaptable State",uiLabel:"Get Flashing Cell State"},{name:"mergeFlashingCellDefinitionWithDefaults",kind:"function",description:"Merges a Flashing Cell Definition with default values",uiLabel:"Merge Flashing Cell Definition With Defaults"},{name:"setFlashingCellDefinitions",kind:"function",description:"Sets a collection of Flashing Cell Definitions into State",uiLabel:"Set Flashing Cell Definitions"},{name:"showFlashingCell",kind:"function",description:"Displays a Flashing Cell Definition",uiLabel:"Show Flashing Cell"},{name:"suspendFlashingCellDefinition",kind:"function",description:"Suspends a Flashing cell Definition",uiLabel:"Suspend Flashing Cell Definition"},{name:"unSuspendFlashingCellDefinition",kind:"function",description:"Activates a suspended Flashing cell Definition",uiLabel:"Un Suspend Flashing Cell Definition"}]},FlashingCellDefinition:{name:"FlashingCellDefinition",kind:"Interface",description:"The Flashing Cell Definition",properties:[{name:"DownChangeStyle",kind:"REFERENCE",description:"Style for 'Down' value changes",uiLabel:"Down Change Style",isOptional:!0,defaultValue:"Red BackColour",reference:"AdaptableStyle"},{name:"FlashDuration",kind:"number | 'always'",description:"Duration of Flash - can be number (in ms) or 'always'",uiLabel:"Flash Duration",isOptional:!0,defaultValue:"500ms"},{name:"FlashTarget",kind:"unknown",description:"Should a cell or whole row flash",uiLabel:"Flash Target",isOptional:!0,defaultValue:"'cell'"},{name:"NeutralChangeStyle",kind:"REFERENCE",description:"Style for 'Neutral' value changes",uiLabel:"Neutral Change Style",isOptional:!0,defaultValue:"Gray BackColour",reference:"AdaptableStyle"},{name:"Rule",kind:"REFERENCE",description:"When Flashing Cell should be triggered",uiLabel:"Rule",reference:"unknown"},{name:"Scope",kind:"REFERENCE",description:"Where Flashing Cell can display: Column[s] or DataType[s]",uiLabel:"Scope",reference:"AdaptableScope"},{name:"UpChangeStyle",kind:"REFERENCE",description:"Style for 'Up' value changes",uiLabel:"Up Change Style",isOptional:!0,defaultValue:"Green BackColour",reference:"AdaptableStyle"}]},FlashingCellDisplayedInfo:{name:"FlashingCellDisplayedInfo",kind:"Interface",description:"Object returned by the `FlashingCellDisplayed` event",properties:[{name:"flashingCell",kind:"REFERENCE",description:"Details of the Cell (or row) which has just flashed",uiLabel:"Flashing Cell",reference:"AdaptableFlashingCell"}]},FlashingCellOptions:{name:"FlashingCellOptions",kind:"Interface",description:"Properties for Flashing Cell",properties:[{name:"defaultDownChangeStyle",kind:"REFERENCE",description:"Style for 'Down' value changes",uiLabel:"Default Down Change Style",isOptional:!0,defaultValue:"Red BackColour",reference:"AdaptableStyle"},{name:"defaultFlashDuration",kind:"number | 'always'",description:"Duration of Flash - can be number (in ms) or 'always'",uiLabel:"Default Flash Duration",isOptional:!0,defaultValue:"500ms"},{name:"defaultFlashTarget",kind:"'row' | 'cell'",description:"Should a cell or whole row flash",uiLabel:"Default Flash Target",isOptional:!0,defaultValue:"'cell'"},{name:"defaultNeutralChangeStyle",kind:"REFERENCE",description:"Style for 'Neutral' value changes",uiLabel:"Default Neutral Change Style",isOptional:!0,defaultValue:"Gray BackColour",reference:"AdaptableStyle"},{name:"defaultUpChangeStyle",kind:"REFERENCE",description:"Style for 'Up' value changes",uiLabel:"Default Up Change Style",isOptional:!0,defaultValue:"Green BackColour",reference:"AdaptableStyle"}]},FlashingCellState:{name:"FlashingCellState",kind:"Interface",description:"Predefined Configuration for Flashing Cell module",properties:[{name:"FlashingCellDefinitions",kind:"array",description:"Flashing Cell Definitions - will colour cells/rows when rule is met",uiLabel:"Flashing Cell Definitions",isOptional:!0}]},FormatColumn:{name:"FormatColumn",kind:"Interface",description:"Object used in Format Column function",properties:[{name:"CellAlignment",kind:"'Left' | 'Right' | 'Center'",description:"Aligns cells 'Left' or 'Right' or 'Center'",uiLabel:"Cell Alignment",isOptional:!0},{name:"ColumnStyle",kind:"REFERENCE",description:"",uiLabel:"Column Style",isOptional:!0,reference:"unknown"},{name:"DisplayFormat",kind:"REFERENCE",description:"Display Format to apply to Column can be Numeric, String or Date",uiLabel:"Display Format",isOptional:!0,reference:"AdaptableFormat"},{name:"IncludeGroupedRows",kind:"boolean",description:"Whether to Format the Column in Grouped Rows",uiLabel:"Include Grouped Rows",isOptional:!0,defaultValue:"false"},{name:"Rule",kind:"REFERENCE",description:"Predicate-based Rule to use for deciding if a format column needs to be applied. When not defined the format column is always applied.",uiLabel:"Rule",isOptional:!0,reference:"FormatColumnRule"},{name:"Scope",kind:"REFERENCE",description:"Where Format will be applied - whole Row, some Columns or all Columns of given DataType",uiLabel:"Scope",reference:"AdaptableScope"},{name:"Style",kind:"REFERENCE",description:"Style to apply",uiLabel:"Style",isOptional:!0,reference:"AdaptableStyle"}]},FormatColumnApi:{name:"FormatColumnApi",kind:"Interface",description:"Provides run-time access to the Format Column Module and associated state",properties:[{name:"addFormatColumn",kind:"function",description:"Adds a Format Column to Format Column State",uiLabel:"Add Format Column"},{name:"addFormatColumns",kind:"function",description:"Adds Format Columns to Format Column State",uiLabel:"Add Format Columns"},{name:"applyFormatColumnDisplayFormats",kind:"function",description:"Applies display format for all Format Columns in AdapTable State",uiLabel:"Apply Format Column Display Formats"},{name:"decrementFormatColumnPrecedence",kind:"function",description:"Decrement the precedence of the given FormatColumn",uiLabel:"Decrement Format Column Precedence"},{name:"deleteAllFormatColumn",kind:"function",description:"Deletes all Format Columns in Adaptable State",uiLabel:"Delete All Format Column"},{name:"deleteFormatColumn",kind:"function",description:"Deletes an existing Format Column",uiLabel:"Delete Format Column"},{name:"editFormatColumn",kind:"function",description:"Edits the Format Column",uiLabel:"Edit Format Column"},{name:"getAllActiveFormatColumn",kind:"function",description:"Retrieves all active (not-suspended) Format Columns in Adaptable State",uiLabel:"Get All Active Format Column"},{name:"getAllFormatColumn",kind:"function",description:"Retrieves all Format Columns in Adaptable State",uiLabel:"Get All Format Column"},{name:"getAllFormatColumnWithCellAlignment",kind:"function",description:"Retrieves all Format Columns in Adaptable State with `CellAlignment` property set",uiLabel:"Get All Format Column With Cell Alignment"},{name:"getAllFormatColumnWithDisplayFormat",kind:"function",description:"Retrieves all Format Columns in Adaptable State with `DisplayFormat` property set",uiLabel:"Get All Format Column With Display Format"},{name:"getAllFormatColumnWithStyle",kind:"function",description:"Retrieves all Format Columns in Adaptable State with the `Style` property set",uiLabel:"Get All Format Column With Style"},{name:"getAllFormatColumnWithStyleAndCellAlignment",kind:"function",description:"Retrieves all Format Columns in Adaptable State with the `Style` or the `CellAlignment` property set",uiLabel:"Get All Format Column With Style And Cell Alignment"},{name:"getAllSuspendedFormatColumn",kind:"function",description:"Retrieves all suspended Format Columns in Adaptable State",uiLabel:"Get All Suspended Format Column"},{name:"getDateFormattedValue",kind:"function",description:"Format value according to format options.",uiLabel:"Get Date Formatted Value"},{name:"getFormatColumnById",kind:"function",description:"Retrieves Format Column by Id",uiLabel:"Get Format Column By Id"},{name:"getFormatColumnDefsForScope",kind:"function",description:"Returns all Predicates appropriate for the given Scope",uiLabel:"Get Format Column Defs For Scope"},{name:"getFormatColumnPredicateDefs",kind:"function",description:"Returns all Predicates usable in Format Columns",uiLabel:"Get Format Column Predicate Defs"},{name:"getFormatColumnsForColumn",kind:"function",description:"Gets all FormatColumns which are defined for the given column",uiLabel:"Get Format Columns For Column"},{name:"getFormatColumnsForColumnId",kind:"function",description:"Gets all FormatColumns which are defined for the column with the given columnId",uiLabel:"Get Format Columns For Column Id"},{name:"getFormatColumnsRelevantForColumn",kind:"function",description:"Extract from the given FormatColumns only the ones which are relevant for a given cell (intersection of given AdaptableColumn and RowNode)",uiLabel:"Get Format Columns Relevant For Column"},{name:"getFormatColumnState",kind:"function",description:"Retrieves Format Column section from Adaptable State",uiLabel:"Get Format Column State"},{name:"getFormatColumnsWithDisplayFormatForColumn",kind:"function",description:"Get all FormatColumns which are defined for this column and have a custom DisplayFormat",uiLabel:"Get Format Columns With Display Format For Column"},{name:"getFormatColumnsWithExpression",kind:"function",description:"Retrieves all Format Columns which have an Expression",uiLabel:"Get Format Columns With Expression"},{name:"getFormatColumnsWithStyleForColumn",kind:"function",description:"Get all FormatColumns which are defined for this column and have a custom AdaptableStyle",uiLabel:"Get Format Columns With Style For Column"},{name:"getFormatColumnWithSingleColumnScope",kind:"function",description:"Get Format Column which has Scope of Single Column, if any, for given ColumnId",uiLabel:"Get Format Column With Single Column Scope"},{name:"getFormatColumnWithStyleClassNameForColumn",kind:"function",description:"Gets Format Column if any for given Column which includes Style element with ClassName",uiLabel:"Get Format Column With Style Class Name For Column"},{name:"getNumberFormattedValue",kind:"function",description:"Format value according to format options.",uiLabel:"Get Number Formatted Value"},{name:"getStringFormattedValue",kind:"function",description:"Format value according to format options.",uiLabel:"Get String Formatted Value"},{name:"hasCustomDisplayFormatter",kind:"function",description:"Checks if a Format Column contains a Custom Display Formatter",uiLabel:"Has Custom Display Formatter"},{name:"hasStyleFormatColumns",kind:"function",description:"Returns true if Format State includes Format Columns with a Style property",uiLabel:"Has Style Format Columns"},{name:"incrementFormatColumnPrecedence",kind:"function",description:"Increment the precedence of the given FormatColumn",uiLabel:"Increment Format Column Precedence"},{name:"isFormatColumnRelevantForColumn",kind:"function",description:"Checks if format column is relevant for a given cell (intersection of given AdaptableColumn and RowNode)",uiLabel:"Is Format Column Relevant For Column"},{name:"showFormatColumnPopup",kind:"function",description:"Opens Settings Panel with Format Column section selected and visible",uiLabel:"Show Format Column Popup"},{name:"suspendFormatColumn",kind:"function",description:"Suspends an Format column",uiLabel:"Suspend Format Column"},{name:"unSuspendFormatColumn",kind:"function",description:"Suspends an Format column",uiLabel:"Un Suspend Format Column"}]},FormatColumnRule:{name:"FormatColumnRule",kind:"TypeAlias",description:"The Format Column Rule - can be either a Predicate or a BooleanExpression"},FormatColumnState:{name:"FormatColumnState",kind:"Interface",description:"Predefined Configuration for Format Column Module",properties:[{name:"FormatColumns",kind:"array",description:"Collection of Format Columns",uiLabel:"Format Columns",isOptional:!0}]},FormContext:{name:"FormContext",kind:"Interface",description:"Context supplied to Buttons that appear in an Adaptable Form",properties:[{name:"formData",kind:"REFERENCE",description:"Adaptable Form Data",uiLabel:"Form Data",reference:"unknown"}]},FreeTextColumn:{name:"FreeTextColumn",kind:"Interface",description:"The FreeTextColumn object used in the Free Text Column function",properties:[{name:"ColumnId",kind:"string",description:"Id of Column",uiLabel:"Column Id"},{name:"DataType",kind:"'String' | 'Number' | 'Boolean' | 'Date'",description:"Whether Column is String, Number, Boolean or Date",uiLabel:"Data Type",defaultValue:"'String'"},{name:"DefaultValue",kind:"unknown",description:"Initial value to use for each cell in the Column",uiLabel:"Default Value",isOptional:!0},{name:"FreeTextColumnSettings",kind:"REFERENCE",description:"Additional optional properties for Column (e.g. filterable, resizable)",uiLabel:"Free Text Column Settings",isOptional:!0,reference:"FreeTextColumnSettings"},{name:"FreeTextStoredValues",kind:"array",description:"Collection of Stored Values to aplly in the Column",uiLabel:"Free Text Stored Values",isOptional:!0},{name:"FriendlyName",kind:"string",description:"Friendly Name to use to refer to Column; if unset `ColumnId` is used",uiLabel:"Friendly Name",isOptional:!0},{name:"TextEditor",kind:"'Inline' | 'Large'",description:"Cell editor to use when editing a string Free Text Column *",uiLabel:"Text Editor",isOptional:!0,defaultValue:"'Inline'"}]},FreeTextColumnApi:{name:"FreeTextColumnApi",kind:"Interface",description:"Provides run-time access to FreeTextColumn Module and associated state",properties:[{name:"addEditFreeTextColumnStoredValue",kind:"function",description:"Adds FreeTextStoredValue for a FreeTextColumn (replaces existing one if exists)",uiLabel:"Add Edit Free Text Column Stored Value"},{name:"addFreeTextColumn",kind:"function",description:"Adds new FreeTextColumn to Adaptable State",uiLabel:"Add Free Text Column"},{name:"addStoredValuesToFreeTextColumn",kind:"function",description:"Adds Stored Values to Existing FreeTextColumn",uiLabel:"Add Stored Values To Free Text Column"},{name:"checkFreeTextColumnForDataChange",kind:"function",description:"Checks if a User Edit was in a Free Text Column",uiLabel:"Check Free Text Column For Data Change"},{name:"deleteFreeTextColumn",kind:"function",description:"Deletes existing FreeTextColumn from Adaptable State",uiLabel:"Delete Free Text Column"},{name:"editFreeTextColumn",kind:"function",description:"Edits existing FreeTextColumn in Adaptable State",uiLabel:"Edit Free Text Column"},{name:"getAllFreeTextColumn",kind:"function",description:"Gets all FreeTextColumns in Adaptable State",uiLabel:"Get All Free Text Column"},{name:"getFreeTextColumnById",kind:"function",description:"Retrieves FreeTextColumn for given ColumnId",uiLabel:"Get Free Text Column By Id"},{name:"getFreeTextColumnModuleReferences",kind:"function",description:"Returns all the references in the AdaptableState of the given FreeTextColumn",uiLabel:"Get Free Text Column Module References"},{name:"getFreeTextColumnState",kind:"function",description:"Retrieves FreeTextColumn section of Adaptable State",uiLabel:"Get Free Text Column State"},{name:"getFreeTextColumnValueFromRowNode",kind:"function",description:"Retrieves a Free Text Column value from a row",uiLabel:"Get Free Text Column Value From Row Node"},{name:"showFreeTextColumnPopup",kind:"function",description:"Opens Settings Panel with Free Text Column section selected and visible",uiLabel:"Show Free Text Column Popup"}]},FreeTextColumnSettings:{name:"FreeTextColumnSettings",kind:"Interface",description:"Set of optional properties that define a FreeText Columns behaviour"},FreeTextColumnState:{name:"FreeTextColumnState",kind:"Interface",description:"Predefined Configuration for the Free Text Column Module",properties:[{name:"FreeTextColumns",kind:"array",description:"Collection of Free Text Columns",uiLabel:"Free Text Columns",isOptional:!0}]},FreeTextStoredValue:{name:"FreeTextStoredValue",kind:"Interface",description:"Defines a cell value stored in a Free Text Column",properties:[{name:"FreeText",kind:"unknown",description:"Value to store in the cell",uiLabel:"Free Text"},{name:"PrimaryKey",kind:"unknown",description:"Primary Key Column value for the row",uiLabel:"Primary Key"}]},GeneralOptions:{name:"GeneralOptions",kind:"Interface",description:"General options for configuring AdapTable including managing Primary Keys",properties:[{name:"alternativeModuleNames",kind:"array",description:"Alternative names to use for Adaptable Modules in toolbars and menus",uiLabel:"Alternative Module Names",isOptional:!0,defaultValue:"null"},{name:"cellSummaryOperations",kind:"array",description:"Custom Cell Summary Operations to add to shipped set",uiLabel:"Cell Summary Operations",isOptional:!0},{name:"customSortComparers",kind:"array",description:"CustomSort column comparer functions",uiLabel:"Custom Sort Comparers",isOptional:!0},{name:"dataSets",kind:"array",description:"Collection of Data Sets to provide Data to AdapTable",uiLabel:"Data Sets",isOptional:!0},{name:"englishVariant",kind:"'GB' | 'US'",description:"English variant to use in UI labels",uiLabel:"English Variant",isOptional:!0,gridInfo:"item",defaultValue:"'GB'"},{name:"hideEmptyGroupRows",kind:"boolean",description:"Hides any grouped rows if there are no columns visible",uiLabel:"Hide Empty Group Rows",isOptional:!0,defaultValue:"false"},{name:"holidays",kind:"REFERENCE",description:"Holidays - used to determine Working Days",uiLabel:"Holidays",isOptional:!0,defaultValue:"null",reference:"Holidays"},{name:"showGroupingTotalsAsHeader",kind:"boolean",description:"Show aggregated totals row at top of Grid when row grouping",uiLabel:"Show Grouping Totals As Header",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"showMissingPrimaryKeyAlert",kind:"boolean",description:"Shows Alert if Primary Key column in Adaptable Options is not present or incorrect",uiLabel:"Show Missing Primary Key Warning",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"false"},{name:"unbalancedGroupsKey",kind:"unknown",description:"Value to use for 'Unbalanced Groups' (string columns)",uiLabel:"Unbalanced Groups Key",isOptional:!0}]},GlobalExpressionFunctionsContext:{name:"GlobalExpressionFunctionsContext",kind:"Interface",description:"Context provided to global expression functions properties property callback",properties:[{name:"availableExpressionFunctionNames",kind:"unknown",description:"The names of all expression functions available in this context",uiLabel:"Available Expression Function Names"}]},Glue42Api:{name:"Glue42Api",kind:"Interface",description:"Provides run-time access to the Glue42 Plugin.",properties:[{name:"clearGlue42InternalState",kind:"function",description:"Clears all Gluee42 Internal State",uiLabel:"Clear Glue42Internal State"},{name:"getCurrentLiveGlue42Report",kind:"function",description:"Retrieves the current Live Report",uiLabel:"Get Current Live Glue42Report"},{name:"getGlue42Schedules",kind:"function",description:"Retrieves all the Glue42 Schedules in from the Schedule section of AdapTable State",uiLabel:"Get Glue42Schedules"},{name:"getGlue42State",kind:"function",description:"Retrieves the Glue42 section of Adaptable State",uiLabel:"Get Glue42State"},{name:"getPluginOptions",kind:"function",description:"Retrieves the Glue42PluginOptions provided in Glue42 Plugin",uiLabel:"Get Plugin Options"},{name:"isGlue42Available",kind:"function",description:"Returns true if the Glue42 plugin is loaded",uiLabel:"Is Glue42Available"},{name:"isGlue42Running",kind:"function",description:"Returns true if the Glue42 plugin is loaded AND the user has logged into Glue42",uiLabel:"Is Glue42Running"},{name:"loginToGlue42",kind:"function",description:"Logs in the User to Glue42 using the given UserName and Password",uiLabel:"Login To Glue42"},{name:"logoutFromGlue42",kind:"function",description:"Logs out the currently logged in User from Glue42",uiLabel:"Logout From Glue42"},{name:"sendSnapshotToDo",kind:"function",description:"Starts a Snapshot as opposed to a Live report",uiLabel:"Send Snapshot To Do"},{name:"setGlue42AvailableOff",kind:"function",description:"Sets Glue42 Availability Off",uiLabel:"Set Glue42Available Off"},{name:"setGlue42AvailableOn",kind:"function",description:"Sets Glue42 Availability On",uiLabel:"Set Glue42Available On"},{name:"setGlue42LoginErrorMessage",kind:"function",description:"Sets an Error Message returned from Glue42 if login fails",uiLabel:"Set Glue42Login Error Message"},{name:"setGlue42RunningOff",kind:"function",description:"Sets Glue42 Running Off",uiLabel:"Set Glue42Running Off"},{name:"setGlue42RunningOn",kind:"function",description:"Sets Glue42 Running On",uiLabel:"Set Glue42Running On"},{name:"showNotification",kind:"function",description:"Shows a notification in Glue42",uiLabel:"Show Notification"},{name:"showNotificationForAlert",kind:"function",description:"Displays Alert as a Glue42 Notification",uiLabel:"Show Notification For Alert"},{name:"startLiveData",kind:"function",description:"Starts a "Live" report (ie. one which updates as the data ticks)",uiLabel:"Start Live Data"},{name:"stopLiveData",kind:"function",description:"Stops a "Live" report (ie. one which updates as the data ticks)",uiLabel:"Stop Live Data"}]},Glue42PluginOptions:{name:"Glue42PluginOptions",kind:"Interface",description:"Options for using the Glue42 plugin",properties:[{name:"gatewayURL",kind:"string",description:"Gateway URL",uiLabel:"Gateway URL",isOptional:!0},{name:"glue",kind:"unknown",description:"Main Glue desktop object",uiLabel:"Glue",isOptional:!0},{name:"glue42Office",kind:"unknown",description:"Main Glue42 Office object",uiLabel:"Glue42Office",isOptional:!0},{name:"password",kind:"string",description:"Password to use to login to Glue42; typically sourced from PC Credentials",uiLabel:"Password",isOptional:!0},{name:"username",kind:"string",description:"UserName to use to login to Glue42; typically sourced from PC Credentials",uiLabel:"Username",isOptional:!0}]},Glue42Report:{name:"Glue42Report",kind:"Interface",description:"Glue42 report - currently just contains name of Report",properties:[{name:"ReportName",kind:"string",description:"The Report's name (as exists in Export State)",uiLabel:"Report Name"}]},Glue42Schedule:{name:"Glue42Schedule",kind:"Interface",description:"Defines Glue42 Scheduled Report; used in Schedule Module (where State is stored)",properties:[{name:"Glue42Report",kind:"REFERENCE",description:"The Glue42 Report which will be sent when the Schedule runs",uiLabel:"Glue42Report",reference:"Glue42Report"},{name:"Transmission",kind:"'Snapshot' | 'Live Data'",description:"Whether its a one-off or 'streaming' transmission",uiLabel:"Transmission"}]},Glue42State:{name:"Glue42State",kind:"Interface",description:"Internal State used by AdapTable for managing the Glue42 plugin",properties:[{name:"CurrentLiveGlue42Report",kind:"REFERENCE",description:"Which Glue42 Report is currently live",uiLabel:"Current Live Glue42Report",isOptional:!0,reference:"Glue42Report"},{name:"Glue42LoginErrorMessage",kind:"string",description:"Message to show when Login Fails",uiLabel:"Glue42Login Error Message",isOptional:!0},{name:"IsGlue42Available",kind:"boolean",description:"Whether Glue42 is available",uiLabel:"Is Glue42Available",isOptional:!0},{name:"IsGlue42Running",kind:"boolean",description:"Whether Glue42 is running",uiLabel:"Is Glue42Running",isOptional:!0}]},GradientStyle:{name:"GradientStyle",kind:"Interface",description:"Used to display Gradient Styles in Special Column Style"},GridApi:{name:"GridApi",kind:"Interface",description:"Provides access to important properites of AdapTable e.g. sorting, selected cells etc.",properties:[{name:"addGridData",kind:"function",description:"Adds rows to Adaptable (and AG Grid)",uiLabel:"Add Grid Data"},{name:"applyGridFiltering",kind:"function",description:"Applies current Filtering and Searching in AdapTable",uiLabel:"Apply Grid Filtering"},{name:"areCellsEditable",kind:"function",description:"Checks if given set of Grid Cells are editable",uiLabel:"Are Cells Editable"},{name:"clearAdaptableSorting",kind:"function",description:"Removes Column Sorts in AdapTable",uiLabel:"Clear Adaptable Sorting"},{name:"clearGridFiltering",kind:"function",description:"Removes all current Filters and Searches in AdapTable",uiLabel:"Clear Grid Filtering"},{name:"clearRowGroupColumns",kind:"function",description:"Clears Row Grouping in the Grid",uiLabel:"Clear Row Group Columns"},{name:"closeAllRowGroups",kind:"function",description:"Close all open groups in Row Grouping",uiLabel:"Close All Row Groups"},{name:"deleteGridData",kind:"function",description:"Deletes rows from Adaptable (and AG Grid)",uiLabel:"Delete Grid Data"},{name:"deselectAll",kind:"function",description:"Deselects all selected rows, cells and ranges",uiLabel:"Deselect All"},{name:"deSelectNode",kind:"function",description:"Deselects the AG Grid Row Node in AdapTable",uiLabel:"De Select Node"},{name:"deSelectNodes",kind:"function",description:"AG Grid Row Nodes in AdapTable",uiLabel:"De Select Nodes"},{name:"deSelectRow",kind:"function",description:"Deselects Row with given Primary Key Value",uiLabel:"De Select Row"},{name:"deSelectRows",kind:"function",description:"Deselects Row with given Primary Key Values",uiLabel:"De Select Rows"},{name:"destroy",kind:"function",description:"Destroys current AdapTable instance",uiLabel:"Destroy"},{name:"expandAllRowGroups",kind:"function",description:"Expands all closed groups in Row Grouping",uiLabel:"Expand All Row Groups"},{name:"expandRowGroupsForValues",kind:"function",description:"Expands Row Groups that contain given keys",uiLabel:"Expand Row Groups For Values"},{name:"fireCellChangedEvent",kind:"function",description:"Fires Cell Changed Changed Event - when any data in AG Grid's dataset has changed",uiLabel:"Fire Cell Changed Event"},{name:"fireGridDataChangedEvent",kind:"function",description:"Fires Grid Data Changed Event - when a row has changed in AG Grid",uiLabel:"Fire Grid Data Changed Event"},{name:"fireGridSortedEvent",kind:"function",description:"Fires Grid Sorted Event",uiLabel:"Fire Grid Sorted Event"},{name:"fireSearchChangedEvent",kind:"function",description:"Fires Search Changed Event - typically used to enable server searching and filtering This is now deprecated and will be removed in AdapTable 13",uiLabel:"Fire Search Changed Event"},{name:"getAgGridInstance",kind:"function",description:"Returns Ag Grid instance (passed into Adaptable Options at start-up)",uiLabel:"Get Ag Grid Instance"},{name:"getAllRowNodes",kind:"function",description:"Retrieves all Row Nodes currently in the Grid (by default excluding the group rows)",uiLabel:"Get All Row Nodes"},{name:"getCellDisplayValue",kind:"function",description:"Retrieves Display Value for a given cell",uiLabel:"Get Cell Display Value"},{name:"getCellNormalisedValue",kind:"function",description:"Retrieves Normalised Value for a given cell",uiLabel:"Get Cell Normalised Value"},{name:"getCellRawValue",kind:"function",description:"Retrieves Raw Value for a given cell",uiLabel:"Get Cell Raw Value"},{name:"getColumnCount",kind:"function",description:"Returns number of columns in Data Source",uiLabel:"Get Column Count"},{name:"getColumnSortForColumn",kind:"function",description:"Retrieves ColumnSort for a given Column",uiLabel:"Get Column Sort For Column"},{name:"getColumnSorts",kind:"function",description:"Returns Column Sort information in Adaptable",uiLabel:"Get Column Sorts"},{name:"getDisplayValueFromRawValue",kind:"function",description:"Retrieves Formatted Value for a given Raw Value in given Column",uiLabel:"Get Display Value From Raw Value"},{name:"getDisplayValueFromRowNode",kind:"function",description:"Retrieves Display Value for Cell in given Row and Column",uiLabel:"Get Display Value From Row Node"},{name:"getEntitlementAccessLevelForModule",kind:"function",description:"Retrieves the Entitlement Access Level for a given Adaptable Module",uiLabel:"Get Entitlement Access Level For Module"},{name:"getExpandRowGroupsKeys",kind:"function",description:"Get keys for any open rows in Row Grouping",uiLabel:"Get Expand Row Groups Keys"},{name:"getFilteredData",kind:"function",description:"Retrieves filtered data from the grid",uiLabel:"Get Filtered Data"},{name:"getFirstDisplayedRowNode",kind:"function",description:"Retrieves the first Displayed Row Node in AdapTable",uiLabel:"Get First Displayed Row Node"},{name:"getFirstRowNode",kind:"function",description:"Retrieves the first Row Node in AdapTable",uiLabel:"Get First Row Node"},{name:"getGridCellFromRowNode",kind:"function",description:"Retrieves Cell in given Row and Column",uiLabel:"Get Grid Cell From Row Node"},{name:"getGridContainerElement",kind:"function",description:"Returns the Grid Container in which the Adaptable Instance is present",uiLabel:"Get Grid Container Element"},{name:"getGridData",kind:"function",description:"Retrieves all data from the grid",uiLabel:"Get Grid Data"},{name:"getGridState",kind:"function",description:"Returns Grid section from Adaptable State",uiLabel:"Get Grid State"},{name:"getNormalisedValueFromRowNode",kind:"function",description:"Retrieves Normalised Value for Cell in given Row and Column",uiLabel:"Get Normalised Value From Row Node"},{name:"getPrimaryKeyValueForRowNode",kind:"function",description:"Returns the Primary Kev Value for a given Row Node",uiLabel:"Get Primary Key Value For Row Node"},{name:"getPrimaryKeyValuesForRowNodes",kind:"function",description:"Returns the Primary Kev Values for a given Row Node collection",uiLabel:"Get Primary Key Values For Row Nodes"},{name:"getRawValueFromRowNode",kind:"function",description:"Retrieves Raw Value for Cell in given Row and Column",uiLabel:"Get Raw Value From Row Node"},{name:"getRowCount",kind:"function",description:"Returns number of rows in Data Source",uiLabel:"Get Row Count"},{name:"getRowNodeForPrimaryKey",kind:"function",description:"Retrieves Row Node that contains given Primary Key",uiLabel:"Get Row Node For Primary Key"},{name:"getRowNodesForPrimaryKeys",kind:"function",description:"Retrieves Row Nodes that contain given Primary Keys",uiLabel:"Get Row Nodes For Primary Keys"},{name:"getSelectedCellInfo",kind:"function",description:"Returns all current Selected Cells in AdapTable",uiLabel:"Get Selected Cell Info"},{name:"getSelectedRowInfo",kind:"function",description:"Returns all current Selected Rows in AdapTable",uiLabel:"Get Selected Row Info"},{name:"getVisibleColumnCount",kind:"function",description:"Returns number of visible columns in Data Source",uiLabel:"Get Visible Column Count"},{name:"getVisibleRowCount",kind:"function",description:"Returns number of visible rows in Data Source",uiLabel:"Get Visible Row Count"},{name:"getVisibleRowNodes",kind:"function",description:"Retrieves all filtered Row Nodes currently in the Grid (i.e. after applying the current filter)",uiLabel:"Get Visible Row Nodes"},{name:"hideFilterForm",kind:"function",description:"Hides the AdapTable Filter Form",uiLabel:"Hide Filter Form"},{name:"highlightCell",kind:"function",description:"Highlights a Cell in AdapTable",uiLabel:"Highlight Cell"},{name:"highlightRow",kind:"function",description:"Highlight a row using an adaptable style",uiLabel:"Highlight Row"},{name:"highlightRows",kind:"function",description:"Highlight rows using an adaptable style",uiLabel:"Highlight Rows"},{name:"isGridGroupable",kind:"function",description:"Whether AdapTable instance can be Row Grouped",uiLabel:"Is Grid Groupable"},{name:"isGridPivotable",kind:"function",description:"Whether AdapTable instance can be pivoted",uiLabel:"Is Grid Pivotable"},{name:"isGridRowGrouped",kind:"function",description:"Whether Grid is currently showing Row Groups",uiLabel:"Is Grid Row Grouped"},{name:"isGridSelectable",kind:"function",description:"Whether AdapTable instance offers cell selection",uiLabel:"Is Grid Selectable"},{name:"isGroupRowNode",kind:"function",description:"Whether given Row Node is a Row Group",uiLabel:"Is Group Row Node"},{name:"isQuickFilterAvailable",kind:"function",description:"Whether Quick Filter is available in the Grid",uiLabel:"Is Quick Filter Available"},{name:"jumpToCell",kind:"function",description:"Grid will jump to cell in a given Row and Column",uiLabel:"Jump To Cell"},{name:"jumpToColumn",kind:"function",description:"Grid will jump to Column that has given ColumnId",uiLabel:"Jump To Column"},{name:"jumpToRow",kind:"function",description:"Grid will jump to Row containing given Primary Kev Value",uiLabel:"Jump To Row"},{name:"loadGridData",kind:"function",description:"Loads grid with given data",uiLabel:"Load Grid Data"},{name:"redrawGrid",kind:"function",description:"Redraws AdapTable (expensive operation so use sparingly)",uiLabel:"Redraw Grid"},{name:"refreshCells",kind:"function",description:"Refresh Cells in AdapTable",uiLabel:"Refresh Cells"},{name:"refreshRowByPrimaryKey",kind:"function",description:"Forces a re-render of the row with the given primary key value",uiLabel:"Refresh Row By Primary Key"},{name:"refreshRowNode",kind:"function",description:"Forces a re-render of the given row",uiLabel:"Refresh Row Node"},{name:"refreshRowNodes",kind:"function",description:"Forces a re-render of the given rows",uiLabel:"Refresh Row Nodes"},{name:"selectAll",kind:"function",description:"Select the whole Grid",uiLabel:"Select All"},{name:"selectCellRange",kind:"function",description:"Selects a group of cells in a given range - provide either primary keys or row indexes",uiLabel:"Select Cell Range"},{name:"selectColumn",kind:"function",description:"Selects a Column in AG Grid",uiLabel:"Select Column"},{name:"selectColumns",kind:"function",description:"Selects Columns in AG Grid",uiLabel:"Select Columns"},{name:"selectNode",kind:"function",description:"Selects the AG Grid Row Node in AdapTable",uiLabel:"Select Node"},{name:"selectNodes",kind:"function",description:"Selects the AG Grid Row Nodes in AdapTable",uiLabel:"Select Nodes"},{name:"selectRow",kind:"function",description:"Selects Row with given Primary Key Value",uiLabel:"Select Row"},{name:"selectRows",kind:"function",description:"Selects Rows with given Primary Key Values",uiLabel:"Select Rows"},{name:"setAdaptableSorting",kind:"function",description:"Sorts AdapTable using given Column Sorts",uiLabel:"Set Adaptable Sorting"},{name:"setCellsValue",kind:"function",description:"Updates multiple cells",uiLabel:"Set Cells Value"},{name:"setCellValue",kind:"function",description:"Updates cell in Adaptable (first performs Cell & Server Validation)",uiLabel:"Set Cell Value"},{name:"setColumnSorts",kind:"function",description:"Sets Column Sorts in Grid",uiLabel:"Set Column Sorts"},{name:"setGridData",kind:"function",description:"Repopulates grid with given data",uiLabel:"Set Grid Data"},{name:"setRowGroupColumns",kind:"function",description:"Sets the grid to Row Group",uiLabel:"Set Row Group Columns"},{name:"showGridInfoPopup",kind:"function",description:"Opens Settings Panel with Grid Info section selected and visible",uiLabel:"Show Grid Info Popup"},{name:"undoCellEdit",kind:"function",description:"Reverses a data change (if triggered by cell edit)",uiLabel:"Undo Cell Edit"},{name:"unHighlightAllCells",kind:"function",description:"Unhighlights all highlighted Cells in AdapTable",uiLabel:"Un Highlight All Cells"},{name:"unHighlightAllRows",kind:"function",description:"Remove all highlighted rows",uiLabel:"Un Highlight All Rows"},{name:"unHighlightCell",kind:"function",description:"Unhighlights a Cell in AdapTable",uiLabel:"Un Highlight Cell"},{name:"unHighlightRow",kind:"function",description:"Remove highlight from row",uiLabel:"Un Highlight Row"},{name:"unHighlightRows",kind:"function",description:"Remove highlight from row",uiLabel:"Un Highlight Rows"},{name:"updateGridData",kind:"function",description:"Updates Adaptable (and AG Grid) with rows that have changed",uiLabel:"Update Grid Data"}]},GridCell:{name:"GridCell",kind:"Interface",description:"Defines a Cell in Adaptable - every cell is an intersection of a Column Id and a Primary Key Value",properties:[{name:"column",kind:"REFERENCE",description:"Column in which cell is situated",uiLabel:"Column",reference:"AdaptableColumn"},{name:"displayValue",kind:"unknown",description:"Display value of cell (e.g. if formatted)",uiLabel:"Display Value"},{name:"normalisedValue",kind:"unknown",description:"Normalised value of cell",uiLabel:"Normalised Value"},{name:"primaryKeyValue",kind:"unknown",description:"Primary Key column's value in row - how Adaptable locates the cell",uiLabel:"Primary Key Value",isOptional:!0},{name:"rawValue",kind:"unknown",description:"Actual raw value of cell",uiLabel:"Raw Value"},{name:"rowNode",kind:"REFERENCE",description:"AG Grid Row Node that holds the cell",uiLabel:"Row Node",reference:"unknown"}]},GridCellRange:{name:"GridCellRange",kind:"Interface",description:"Defines a range of Cell - used in Grid Api Selection methods Typically use either PrimaryKey Values or Row Indexes",properties:[{name:"columnIds",kind:"array",description:"Columns to select",uiLabel:"Column Ids"},{name:"primaryKeyValueEnd",kind:"unknown",description:"Primary Key value of row at end of range",uiLabel:"Primary Key Value End",isOptional:!0},{name:"primaryKeyValueStart",kind:"unknown",description:"Primary Key value of row at start of range",uiLabel:"Primary Key Value Start",isOptional:!0},{name:"rowIndexEnd",kind:"unknown",description:"Index of row at end of range",uiLabel:"Row Index End",isOptional:!0},{name:"rowIndexStart",kind:"unknown",description:"Index of row at start of range",uiLabel:"Row Index Start",isOptional:!0}]},GridDataChangedInfo:{name:"GridDataChangedInfo",kind:"Interface",description:"EventInfo returned by GridDataChanged event",properties:[{name:"changedAt",kind:"number",description:"Timestamp of change occurrence (in milliseconds)",uiLabel:"Changed At"},{name:"dataRows",kind:"array",description:"Data rows that have been added, updated, or deleted",uiLabel:"Data Rows"},{name:"rowNodes",kind:"array",description:"Row Nodes that were affected by this change",uiLabel:"Row Nodes"},{name:"rowTrigger",kind:"'Add' | 'Edit' | 'Delete'",description:"Trigger for row change: 'Add', 'Edit' or 'Delete'",uiLabel:"Row Trigger"}]},GridRow:{name:"GridRow",kind:"Interface",description:"Detailed information about a Row in AdapTable",properties:[{name:"primaryKeyValue",kind:"unknown",description:"Primary Key column's value for Row - how Adaptable locates a cell",uiLabel:"Primary Key Value"},{name:"rowData",kind:"unknown",description:"Actual data in the Row",uiLabel:"Row Data",isOptional:!0},{name:"rowInfo",kind:"REFERENCE",description:"Object which provides 'meta data' about the Row",uiLabel:"Row Info",isOptional:!0,reference:"RowInfo"},{name:"rowNode",kind:"REFERENCE",description:"AG Grid Row Node object for the Row",uiLabel:"Row Node",isOptional:!0,reference:"unknown"}]},GridSortedInfo:{name:"GridSortedInfo",kind:"Interface",description:"EventInfo returned by GridSorted event",properties:[{name:"adaptableSortState",kind:"REFERENCE",description:"Current sort state in the Grid",uiLabel:"Adaptable Sort State",reference:"AdaptableSortState"}]},HolidayContext:{name:"HolidayContext",kind:"Interface",description:"Context used for isHoliday function",properties:[{name:"adaptableId",kind:"string",description:"Id of current AdapTable instance",uiLabel:"Adaptable Id"},{name:"dateToCheck",kind:"date",description:"Date being checked",uiLabel:"Date To Check"},{name:"userName",kind:"string",description:"Name of Current User",uiLabel:"User Name"}]},Holidays:{name:"Holidays",kind:"Interface",description:"Holidays - can be list or function (latter takes preference)",properties:[{name:"isHoliday",kind:"function",description:"Function which returns true if given date is a holiday",uiLabel:"Is Holiday",isOptional:!0},{name:"list",kind:"array",description:"Holidays provided as valid ISO date strings",uiLabel:"List",isOptional:!0}]},IAdaptableNoCodeWizard:{name:"IAdaptableNoCodeWizard",kind:"Interface",description:"When you want to configure an Adaptable via json file D&D, use this instead of the normal Adaptable constructor"},InstrumentColumn:{name:"InstrumentColumn",kind:"Interface",description:"A Column which will be defined as an FDC3 Instrument",properties:[{name:"bbgColumnId",kind:"string",description:"Column which holds a Bloomberg Ticker value as instrument data",uiLabel:"Bbg Column Id",isOptional:!0},{name:"cusipColumnId",kind:"string",description:"Column which holds a CUSIP value as instrument data",uiLabel:"Cusip Column Id",isOptional:!0},{name:"figiColumnId",kind:"string",description:"Column which holds a [FIGI](https://www.openfigi.com/about/figi) value as instrument data",uiLabel:"Figi Column Id",isOptional:!0},{name:"intents",kind:"REFERENCE",description:"Instrument-related FDC3 Intents; can be: `ViewChart` `ViewQuote` `ViewNews` `ViewAnalysis` `ViewInstrument`",uiLabel:"Intents",isOptional:!0,reference:"InstrumentIntents"},{name:"isinColumnId",kind:"string",description:"Column which holds an ISIN value as instrument data",uiLabel:"Isin Column Id",isOptional:!0},{name:"permidColumnId",kind:"string",description:"Column which holds a PERMID value as instrument data",uiLabel:"Permid Column Id",isOptional:!0},{name:"ricColumnId",kind:"string",description:"Column which holds a Reuters Instrument Code value as instrument data",uiLabel:"Ric Column Id",isOptional:!0},{name:"sedolColumnId",kind:"string",description:"Column which holds a SEDOL value as instrument data",uiLabel:"Sedol Column Id",isOptional:!0},{name:"tickerColumnId",kind:"string",description:"Column which holds a ticker value as instrument data",uiLabel:"Ticker Column Id",isOptional:!0}]},InstrumentContext:{name:"InstrumentContext",kind:"Interface",description:"FDC3 Context to define a financial Instrument",properties:[{name:"id",kind:"unknown",description:"Instrument data: ticker, ISIN, CUSIP, SEDOL, RIC, BBG, PERMID, FIGI",uiLabel:"Id",isOptional:!0},{name:"name",kind:"string",description:"Free text name of the Instrument",uiLabel:"Name",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `instrument`",uiLabel:"Type"}]},InstrumentIntent:{name:"InstrumentIntent",kind:"TypeAlias",description:"FDC3 Intents available to an Instrument Column"},InstrumentIntents:{name:"InstrumentIntents",kind:"TypeAlias",description:"All available Instrument Intents"},InstrumentListContext:{name:"InstrumentListContext",kind:"Interface",description:"FDC3 Context to define an array of financial Instruments",properties:[{name:"id",kind:"unknown",description:"Optional Id",uiLabel:"Id",isOptional:!0},{name:"instruments",kind:"array",description:"The instrument data",uiLabel:"Instruments",isOptional:!0},{name:"name",kind:"string",description:"Free text name of list of Instruments (not set by AdapTable)",uiLabel:"Name",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `instrumentList`",uiLabel:"Type"}]},IPushPullApi:{name:"IPushPullApi",kind:"Interface",description:"Provides run-time access to ipushpull Plugin",properties:[{name:"addNewIPushPullPage",kind:"function",description:"Adds a new page to ipushpull using given name in the supplied folder",uiLabel:"Add New IPush Pull Page"},{name:"clearIPushPullInternalState",kind:"function",description:"Internal method which clears out ipushpull State",uiLabel:"Clear IPush Pull Internal State"},{name:"getAutoLogin",kind:"function",description:"Retrieves `AutoLogin` from ipushpull options; if `true` AdapTable will automatically log user in to ipushpull at start-up",uiLabel:"Get Auto Login"},{name:"getCurrentIPushPullPassword",kind:"function",description:"Retrieves `Password` from ipushpull state -- AFTER someone logs in",uiLabel:"Get Current IPush Pull Password"},{name:"getCurrentIPushPullUsername",kind:"function",description:"Retrieves `Username` from ipushpull state - AFTER someone logs in",uiLabel:"Get Current IPush Pull Username"},{name:"getCurrentLiveIPushPullReport",kind:"function",description:"Retrieves current ipushpull Report from ipushpull state; A Report contains Name, Folder and ipushpull Page",uiLabel:"Get Current Live IPush Pull Report"},{name:"getFolderIdForName",kind:"function",description:"Gets the Id of the ipushpull folder / Domain with the given name",uiLabel:"Get Folder Id For Name"},{name:"getIPushPullDomains",kind:"function",description:"Retrieves all the ipushpull domain to which the current user has access",uiLabel:"Get IPush Pull Domains"},{name:"getIPushPullInstance",kind:"function",description:"Retrieves the current ipushpull instance (if one has been provided by the User at design time in ipushpull state)",uiLabel:"Get IPush Pull Instance"},{name:"getIPushPullPassword",kind:"function",description:"Retrieves `Password` from ipushpull options (if provided)",uiLabel:"Get IPush Pull Password"},{name:"getIPushPullSchedules",kind:"function",description:"Gets ipushpull schedules ie. reports set to run at particular times",uiLabel:"Get IPush Pull Schedules"},{name:"getIPushPullThrottleTime",kind:"function",description:"Retrieves Throttle Time from ipushpull State; how often a Live report will update ipushpull (if data changes)",uiLabel:"Get IPush Pull Throttle Time"},{name:"getIPushPullUsername",kind:"function",description:"Retrieves `Username` from ipushpull options (if provided)",uiLabel:"Get IPush Pull Username"},{name:"getPagesForIPushPullDomain",kind:"function",description:"Retrieves all pages in given ipushpull domain",uiLabel:"Get Pages For IPush Pull Domain"},{name:"includeSystemReports",kind:"function",description:"Whether to dispaly System Reports in ipushpull toolbar",uiLabel:"Include System Reports"},{name:"isIPushPullAvailable",kind:"function",description:"Checks if an ipushpull instance has been provided by the user",uiLabel:"Is IPush Pull Available"},{name:"isIPushPullLiveDataRunning",kind:"function",description:"Checks if a report is sending Live Data to ipushpull",uiLabel:"Is IPush Pull Live Data Running"},{name:"isIPushPullReportLive",kind:"function",description:"Checks if given report is currently 'live' (i.e. sending updates as data changes)",uiLabel:"Is IPush Pull Report Live"},{name:"isIPushPullRunning",kind:"function",description:"Checks to see if ipushpull is running (i.e. a user has successfully logged in)",uiLabel:"Is IPush Pull Running"},{name:"loginToIPushPull",kind:"function",description:"Logins in user to ipushpull with given credentials; if successful ipushpull toolbar will display full set of controls",uiLabel:"Login To IPush Pull"},{name:"logoutFromIPushPull",kind:"function",description:"Logs out the current user from ipushpull (changes ipushpull toolbar to show Login button)",uiLabel:"Logout From IPush Pull"},{name:"retrieveIPushPullDomainsFromIPushPull",kind:"function",description:"Internal AdapTable method used to manage domains",uiLabel:"Retrieve IPush Pull Domains From IPush Pull"},{name:"sendSnapshot",kind:"function",description:"Publishes an ipushpull Report as a one-off export (i.e. with no live data)",uiLabel:"Send Snapshot"},{name:"setIPushPullAvailableOff",kind:"function",description:"Internal method which sets ipushpull is unavailable",uiLabel:"Set IPush Pull Available Off"},{name:"setIPushPullAvailableOn",kind:"function",description:"Internal method which sets ipushpull is available",uiLabel:"Set IPush Pull Available On"},{name:"setIPushPullDomains",kind:"function",description:"Sets given Domains as those for the current User",uiLabel:"Set IPush Pull Domains"},{name:"setIPushPullInstance",kind:"function",description:"Sets the current ipushpull instance - this method should not generally be used.",uiLabel:"Set IPush Pull Instance"},{name:"setIPushPullLoginErrorMessage",kind:"function",description:"Internal method which displays given message in ipushpull login page",uiLabel:"Set IPush Pull Login Error Message"},{name:"setIPushPullRunningOff",kind:"function",description:"Internal method which sets ipushpull is not running",uiLabel:"Set IPush Pull Running Off"},{name:"setIPushPullRunningOn",kind:"function",description:"Internal method which sets ipushpull is running",uiLabel:"Set IPush Pull Running On"},{name:"setIPushPullThrottleTime",kind:"function",description:"Sets Throttle time for ipushpull; how often a Live report will update ipushpull (if data changes)",uiLabel:"Set IPush Pull Throttle Time"},{name:"showIPushPullPopup",kind:"function",description:"Opens iPushPullPopup (though its currently empty!)",uiLabel:"Show IPush Pull Popup"},{name:"startLiveData",kind:"function",description:"Publishes ipushpull Report as Live Data; any changes to underlying data in report will be sent to ipushpull",uiLabel:"Start Live Data"},{name:"stopLiveData",kind:"function",description:"Pauses current Live Data report",uiLabel:"Stop Live Data"}]},IPushPullDomain:{name:"IPushPullDomain",kind:"Interface",description:"Internal object that maps an IPushPull Domain object",properties:[{name:"FolderId",kind:"number",description:"the Id of the Folder",uiLabel:"Folder Id"},{name:"Name",kind:"string",description:"the Name of the Domain / Folder",uiLabel:"Name"},{name:"Pages",kind:"array",description:"The names of the pages within the (Folder)",uiLabel:"Pages"}]},IPushPullPluginOptions:{name:"IPushPullPluginOptions",kind:"Interface",description:"Options available in ipushpull plugin; allows users to collborate and share data in powerful ways",properties:[{name:"autoLogin",kind:"boolean",description:"Whether AdapTable should try log in to ipushpull automatically at start-up",uiLabel:"Auto Login",isOptional:!0,defaultValue:"false"},{name:"includeSystemReports",kind:"boolean",description:"Whether AdapTable will include System Reports (e.g. 'All Data', 'Selected Cells' etc) in the ipushpull toolbar dropdown",uiLabel:"Include System Reports",isOptional:!0,defaultValue:"true"},{name:"ippConfig",kind:"unknown",description:"The config required to run ipushpull; use your ipushpull credentials",uiLabel:"Ipp Config",isOptional:!0},{name:"password",kind:"string",description:"The user's ipushpull password; if supplied, pre-populates the login screen's password textbox",uiLabel:"Password",isOptional:!0},{name:"throttleTime",kind:"number",description:"How many miliseconds AdapTable should throttle when sending data updates to ipushpull",uiLabel:"Throttle Time",isOptional:!0,defaultValue:"2000"},{name:"username",kind:"string",description:"User's ipushpull user name (usually email address); if supplied, pre-populates the login screen's username textbox",uiLabel:"Username",isOptional:!0}]},IPushPullReport:{name:"IPushPullReport",kind:"Interface",description:"An ipushpull report",properties:[{name:"Folder",kind:"string",description:"ipushpull Folder which contains the Page",uiLabel:"Folder"},{name:"Page",kind:"string",description:"ipushpull Page which will contain the data",uiLabel:"Page"},{name:"ReportName",kind:"string",description:"Name of the Report",uiLabel:"Report Name"}]},IPushPullSchedule:{name:"IPushPullSchedule",kind:"Interface",description:"Defines an ipushpull Schedule",properties:[{name:"IPushPullReport",kind:"REFERENCE",description:"The report being exported to Excel (via ipushpull)",uiLabel:"I Push Pull Report",reference:"IPushPullReport"},{name:"Transmission",kind:"'Snapshot' | 'Live Data'",description:"How data is sent: 'Snapshot' or 'Live Data'",uiLabel:"Transmission"}]},IPushPullState:{name:"IPushPullState",kind:"Interface",description:"Internal State used by AdapTable for managing the ipushpull plugin"},Layout:{name:"Layout",kind:"Interface",description:"Defines a Layout; contains everything required i.e. Columns, Sorts, Widths, Aggregations, Grouping & Pivoting",properties:[{name:"AggregationColumns",kind:"REFERENCE",description:"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)",uiLabel:"Aggregation Columns",isOptional:!0,reference:"unknown"},{name:"AutoSave",kind:"boolean",description:"Whether Layout should automatically save or not - overrides `autoSaveLayouts` property in LayoutOptions",uiLabel:"Auto Save",isOptional:!0},{name:"ColumnFilters",kind:"array",description:"Collection of Column Filters.",uiLabel:"Column Filters",isOptional:!0},{name:"ColumnHeadersMap",kind:"unknown",description:"Set of custom header names for some (or all columns)",uiLabel:"Column Headers Map",isOptional:!0},{name:"Columns",kind:"array",description:"Which columns should be visible in the Layout and in which order",uiLabel:"Columns"},{name:"ColumnSorts",kind:"array",description:"Sorting to apply in the Layout",uiLabel:"Column Sorts",isOptional:!0},{name:"ColumnWidthMap",kind:"unknown",description:"Set of widths for some (or all columns)",uiLabel:"Column Width Map",isOptional:!0},{name:"EnablePivot",kind:"boolean",description:"Whether pivoting should be enabled in the Grid when this Layout loads",uiLabel:"Enable Pivot",isOptional:!0},{name:"ExpandedRowGroupValues",kind:"array",description:"Opened Row Groups - set if `displayRowGroups` in LayoutOptions is 'dynamic'",uiLabel:"Expanded Row Group Values",isOptional:!0},{name:"Name",kind:"string",description:"Name of Layout as will appear in Layout toolbar and tool panel",uiLabel:"Name"},{name:"PinnedColumnsMap",kind:"{\n        [columnId: string]: 'left' | 'right';\n    }",description:"Set of pinned Columns",uiLabel:"Pinned Columns Map",isOptional:!0},{name:"PivotColumns",kind:"array",description:"List of Columns which should be pivoted when grid is in pivot mode",uiLabel:"Pivot Columns",isOptional:!0},{name:"RowGroupedColumns",kind:"array",description:"Columns which are row-grouped when the Layout is applied",uiLabel:"Row Grouped Columns",isOptional:!0},{name:"SuppressAggFuncInHeader",kind:"boolean",description:"Whether to include the aggFunc name in the column header: e.g. 'sum(Bank Balance)' will just be 'Bank Balance'",uiLabel:"Suppress Agg Func In Header",isOptional:!0}]},LayoutApi:{name:"LayoutApi",kind:"Interface",description:"Provides run-time access to the Layout Module and associated state",properties:[{name:"areDraftAndCurrentLayoutEqual",kind:"function",description:"Checks if the draft layout and the current layout are the same. Useful when `autoSaveLayouts=true`",uiLabel:"Are Draft And Current Layout Equal"},{name:"areExpandedRowGroupsSavedInLayouts",kind:"function",description:"Returns true if Layouts will contain Expanded Row Groups information",uiLabel:"Are Expanded Row Groups Saved In Layouts"},{name:"areLayoutsEqual",kind:"function",description:"Compares 2 Layouts for equality",uiLabel:"Are Layouts Equal"},{name:"cloneAndSetLayout",kind:"function",description:"Creates new Layout based on given Layout but with name provided and then loads it into Grid",uiLabel:"Clone And Set Layout"},{name:"cloneLayout",kind:"function",description:"Creates new Layout based on given Layout but with name provided",uiLabel:"Clone Layout"},{name:"createAndSetLayout",kind:"function",description:"Creates new Layout in the state and then loads it into Grid",uiLabel:"Create And Set Layout"},{name:"createDefaultLayoutIfNeeded",kind:"function",description:"Creates a Default Layout (when none provided in Config)",uiLabel:"Create Default Layout If Needed"},{name:"createLayout",kind:"function",description:"Creates new Layout in the state",uiLabel:"Create Layout"},{name:"createOrUpdateLayout",kind:"function",description:"Creates new Layout into Adaptable State or updates an existing Layout (with same name or id)",uiLabel:"Create Or Update Layout"},{name:"deleteLayout",kind:"function",description:"Deletes an existing Layout (if not Default or only existing Layout)",uiLabel:"Delete Layout"},{name:"deleteLayoutByName",kind:"function",description:"Deletes an existing Layout provided by Name (if not Default or only existing Layout)",uiLabel:"Delete Layout By Name"},{name:"doesLayoutExist",kind:"function",description:"Checks whether this Layout exists in the Adaptable State (by comparing Uuid property)",uiLabel:"Does Layout Exist"},{name:"fireLayoutChangedEvent",kind:"function",description:"Fires the `LayoutChanged` event",uiLabel:"Fire Layout Changed Event"},{name:"getAllLayout",kind:"function",description:"Retrieves all Layouts in Adaptable State",uiLabel:"Get All Layout"},{name:"getCurrentLayout",kind:"function",description:"Retrieves Current Layout from Layout State",uiLabel:"Get Current Layout"},{name:"getCurrentLayoutColumnSort",kind:"function",description:"Retrieves the sort order of a column from the current layout",uiLabel:"Get Current Layout Column Sort"},{name:"getCurrentLayoutName",kind:"function",description:"Retrieves name of current Layout",uiLabel:"Get Current Layout Name"},{name:"getCurrentVisibleColumnIds",kind:"function",description:"Retrieves array of visible ColumnIds in current Layout",uiLabel:"Get Current Visible Column Ids"},{name:"getCurrentVisibleColumnIdsMap",kind:"function",description:"Retrieves map with visible columns in current Layout",uiLabel:"Get Current Visible Column Ids Map"},{name:"getLayoutById",kind:"function",description:"Retrieves Layout by id",uiLabel:"Get Layout By Id"},{name:"getLayoutByName",kind:"function",description:"Retrieves Layout with the given name",uiLabel:"Get Layout By Name"},{name:"getLayoutDescription",kind:"function",description:"Get a string description of a Layout",uiLabel:"Get Layout Description"},{name:"getLayoutState",kind:"function",description:"Retrieves Layout section from Adaptable State",uiLabel:"Get Layout State"},{name:"getLayoutSupportedFeatures",kind:"function",description:"Returns whant the layout supports. This takes into account the data-source.",uiLabel:"Get Layout Supported Features"},{name:"isCurrentLayoutDefault",kind:"function",description:"Checks if the Current Layout is Default Layout",uiLabel:"Is Current Layout Default"},{name:"isCurrentLayoutReadOnly",kind:"function",description:"Specifies where Current Layout is editable",uiLabel:"Is Current Layout Read Only"},{name:"isDefaultLayout",kind:"function",description:"Checks if the given Layout is Default Layout",uiLabel:"Is Default Layout"},{name:"removeColumnFromAllLayouts",kind:"function",description:"Removes a Column from all Layouts",uiLabel:"Remove Column From All Layouts"},{name:"removeColumnFromCurrentLayout",kind:"function",description:"Removes a Column from the Current Layout",uiLabel:"Remove Column From Current Layout"},{name:"removeColumnFromLayout",kind:"function",description:"Removes a Column from a given Layout",uiLabel:"Remove Column From Layout"},{name:"saveCurrentLayout",kind:"function",description:"Saves current Layout - using column order, visibility, sorting etc. currently in use in the grid",uiLabel:"Save Current Layout"},{name:"saveLayout",kind:"function",description:"Saves given Layout into Adaptable State (creates new Layout if it doesn't exist)",uiLabel:"Save Layout"},{name:"setColumnCaption",kind:"function",description:"Sets a new Caption / Header for a Column (this Layout only)",uiLabel:"Set Column Caption"},{name:"setLayout",kind:"function",description:"Sets (i.e. selects) the Layout",uiLabel:"Set Layout"},{name:"shouldAutoSaveLayout",kind:"function",description:"Whether this Layout should be auto saved (based on Layout State and Layout Options)",uiLabel:"Should Auto Save Layout"},{name:"showChangeColumnCaption",kind:"function",description:"Opens Change Column Caption popup",uiLabel:"Show Change Column Caption"},{name:"showLayoutEditor",kind:"function",description:"Opens Layout Editor - for Current or a named Layout",uiLabel:"Show Layout Editor"},{name:"showLayoutPopup",kind:"function",description:"Opens Settings Panel with Layout section selected",uiLabel:"Show Layout Popup"}]},LayoutAssociatedObject:{name:"LayoutAssociatedObject",kind:"TypeAlias",description:"Types of Adaptable Objects that can be associated with a Layout"},LayoutAssociatedObjectLoadConfig:{name:"LayoutAssociatedObjectLoadConfig",kind:"Interface",description:"Configuration for API methods which load `LayoutAssociatedObject`"},LayoutAvailableContext:{name:"LayoutAvailableContext",kind:"Interface",description:"Context for `LayoutOptions.isObjectAvailableInLayout` functions",properties:[{name:"adaptableObject",kind:"REFERENCE",description:"Object being checked",uiLabel:"Adaptable Object",reference:"LayoutAssociatedObject"},{name:"layout",kind:"REFERENCE",description:"Current Layout",uiLabel:"Layout",reference:"Layout"},{name:"module",kind:"REFERENCE",description:"Current Adaptable Module",uiLabel:"Module",reference:"AdaptableModule"}]},LayoutChangedInfo:{name:"LayoutChangedInfo",kind:"Interface",description:"EventInfo returned by LayoutChanged event",properties:[{name:"actionName",kind:"string",description:"What caused Layout State to change",uiLabel:"Action Name"},{name:"newLayoutState",kind:"REFERENCE",description:"Current Layout State",uiLabel:"New Layout State",reference:"LayoutState"},{name:"oldLayoutState",kind:"unknown",description:"Previous Layout State",uiLabel:"Old Layout State"}]},LayoutOptions:{name:"LayoutOptions",kind:"Interface",description:"Options for configuring Layouts; these manage Column visibility, order, sorting, grouping and width",properties:[{name:"autoSaveLayouts",kind:"boolean",description:"Layouts save whenever Grid's column / sort info changes; if false, a Save button will display",uiLabel:"Auto Save Layouts",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"true"},{name:"autoSizeColumnsInLayout",kind:"boolean",description:"Columns auto-size when Layout loads for first time",uiLabel:"Auto Size Columns In Layout",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"autoSizeColumnsInPivotLayout",kind:"boolean",description:"Columns auto-size when Pivot-based Layout loads first time",uiLabel:"Auto Size Columns In Pivot Layout",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"createDefaultLayout",kind:"boolean",description:"Whether a "Default Layout" will be created in addition to Layouts provided in Config",uiLabel:"Create Default Layout",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"displayRowGroups",kind:"'dynamic' | 'expanded' | 'closed'",description:"Whether Row Groups display all as expanded, all as closed or dynamically (i.e. saved in Layout)",uiLabel:"Display Row Groups",isOptional:!0,gridInfo:"item",defaultValue:"'closed'"},{name:"includeExpandedRowGroups",kind:"boolean",description:"Layouts will include details of expanded grouped rows; if true these will be re-applied at start-up",uiLabel:"Include Expanded Row Groups",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"layoutTagOptions",kind:"REFERENCE",description:"Options for leveraging Object Tags to extend Layouts",uiLabel:"Layout Tag Options",isOptional:!0,reference:"unknown"},{name:"layoutViewOptions",kind:"REFERENCE",description:"Customize how Layouts are displayed in Settings Panel",uiLabel:"Layout View Options",isOptional:!0,reference:"LayoutViewOptions"},{name:"pivotPreviewColumns",kind:"unknown",description:"Columns displayed in Table that opens when viewing contents of Pivot Cells",uiLabel:"Pivot Preview Columns",isOptional:!0}]},LayoutState:{name:"LayoutState",kind:"Interface",description:"Predefined Configuration for the Layout Module",properties:[{name:"CurrentLayout",kind:"string",description:"Layout which will be loaded when AdapTable starts - must match `Name` property in Layout",uiLabel:"Current Layout",isOptional:!0},{name:"Layouts",kind:"array",description:"Collection of Layout objects - listed in Layout toolbar and Tool Panel",uiLabel:"Layouts",isOptional:!0}]},LayoutViewOptions:{name:"LayoutViewOptions",kind:"Interface",description:"Customize how Layouts are displayed in Settings Panel",properties:[{name:"maxColumnsToDisplay",kind:"number",description:"How many Column Names to display in inline Layout preview",uiLabel:"Max Columns To Display",isOptional:!0,defaultValue:"10"}]},LiveDataChangedInfo:{name:"LiveDataChangedInfo",kind:"Interface",description:"EventInfo returned by LiveDataChanged event",properties:[{name:"liveDataTrigger",kind:"'Connected' | 'Disconnected' | 'LiveDataStarted' | 'LiveDataStopped' | 'LiveDataUpdated'",description:"What triggered the event to fire",uiLabel:"Live Data Trigger"},{name:"liveReport",kind:"unknown",description:"The Report which is currently live - only used if the Trigger is LiveData related",uiLabel:"Live Report",isOptional:!0},{name:"reportDestination",kind:"'OpenFin' | 'ipushpull' | 'Glue42'",description:"Which Adaptable partner is the export destination for the live data",uiLabel:"Report Destination"}]},LiveReport:{name:"LiveReport",kind:"Interface",description:"Defines which Adaptable Reports are 'Live' (i.e. they will update the destination as the data in Adaptable ticks or changes)",properties:[{name:"pageName",kind:"string",description:"for OpenFin this will be the workbook name; for iPushpull the page name; for Glue42 the Spreadsheet name.",uiLabel:"Page Name"},{name:"report",kind:"REFERENCE",description:"The underlying report",uiLabel:"Report",reference:"unknown"},{name:"reportDestination",kind:"'OpenfinExcel' | 'ipushpull' | 'Glue42'",description:"Where the live data is being sent",uiLabel:"Report Destination"}]},MasterDetailPluginOptions:{name:"MasterDetailPluginOptions",kind:"Interface",description:"Plugin Options used when creating a Master / Detail grid - passed into the plugin as the only argument.",properties:[{name:"detailAdaptableOptions",kind:"REFERENCE",description:"`AdaptableOptions` object to use for child Data Grids; **all** will share the same behaviour and State",uiLabel:"Detail Adaptable Options",reference:"AdaptableOptions"},{name:"onDetailInit",kind:"function",description:"Function called when Detail Grid is initialised (i.e. opens) receives an Adaptable Api object",uiLabel:"On Detail Init",isOptional:!0}]},MenuOptions:{name:"MenuOptions",kind:"Interface",description:"Options for managing menus in AdapTable",properties:[{name:"columnMenuItems",kind:"array",description:"User-defined Menu Items to add to the Column Menu",uiLabel:"Column Menu Items",isOptional:!0},{name:"columnMenuOrder",kind:"unknown",description:"Order in which AG Grid, AdapTable and User Menu items will appear in Column Menu",uiLabel:"Column Menu Order",isOptional:!0,gridInfo:"item",defaultValue:"'aggrid', 'adaptable', 'user'"},{name:"contextMenuItems",kind:"array",description:"User-defined Menu Items to add to the Context Menu",uiLabel:"Context Menu Items",isOptional:!0},{name:"contextMenuOrder",kind:"unknown",description:"Order in which AG grid, AdapTable and User Menu items will appear in Context Menu",uiLabel:"Context Menu Order",isOptional:!0,gridInfo:"item",defaultValue:"'aggrid', 'adaptable', 'user'"},{name:"showAdaptableColumnMenu",kind:"unknown",description:"Show Adaptable Column Menu (or specific items); can be boolean value or function invoked for each menu item",uiLabel:"Show Adaptable Column Menu",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"showAdaptableContextMenu",kind:"unknown",description:"Show Adaptable Context Menu (or specific items); can be boolean value or function invoked for each menu item",uiLabel:"Show Adaptable Context Menu",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"showUngroupColumnMenuItem",kind:"boolean",description:"Adds 'Ungroup' Column Menu item to a row grouped column",uiLabel:"Show Ungroup Column Menu Item",isOptional:!0,gridInfo:"item",defaultValue:"true"}]},ModuleExpressionFunctions:{name:"ModuleExpressionFunctions",kind:"Interface",description:"Type specific Expression Functions",properties:[{name:"customBooleanFunctions",kind:"unknown",description:"Custom (user defined) Boolean Expression Functions available in AdaptableQL",uiLabel:"Custom Boolean Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (none)"},{name:"customScalarFunctions",kind:"unknown",description:"Custom (user defined) Scalar Expression Functions available in AdaptableQL",uiLabel:"Custom Scalar Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (none)"},{name:"systemAggregatedBooleanFunctions",kind:"unknown",description:"System (built-in) AggregatedBoolean Expression Functions available in AdaptableQL",uiLabel:"System Aggregated Boolean Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"},{name:"systemAggregatedScalarFunctions",kind:"unknown",description:"System (built-in) AggregatedScalar Expression Functions available in AdaptableQL",uiLabel:"System Aggregated Scalar Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"},{name:"systemBooleanFunctions",kind:"unknown",description:"System (built-in) Boolean Expression Functions available in AdaptableQL",uiLabel:"System Boolean Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"},{name:"systemObservableFunctions",kind:"unknown",description:"System (built-in) Observable Expression Functions available in AdaptableQL",uiLabel:"System Observable Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"},{name:"systemScalarFunctions",kind:"unknown",description:"System (built-in) Scalar Expression Functions available in AdaptableQL",uiLabel:"System Scalar Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"}]},ModuleExpressionFunctionsContext:{name:"ModuleExpressionFunctionsContext",kind:"Interface",description:"Context provided to ExpressionOptions.moduleExpressionFunctions property callback",properties:[{name:"availableAggregatedBooleanFunctionNames",kind:"array",description:"The global aggregated boolean expression functions",uiLabel:"Available Aggregated Boolean Function Names"},{name:"availableAggregatedScalarFunctionNames",kind:"array",description:"The global aggregated scalar expression functions",uiLabel:"Available Aggregated Scalar Function Names"},{name:"availableBooleanFunctionNames",kind:"array",description:"The global boolean expression functions",uiLabel:"Available Boolean Function Names"},{name:"availableObservableFunctionNames",kind:"array",description:"The global observable expression functions",uiLabel:"Available Observable Function Names"},{name:"availableScalarFunctionNames",kind:"array",description:"The global scalar expression functions",uiLabel:"Available Scalar Function Names"},{name:"module",kind:"REFERENCE",description:"The Adaptable Module requesting the expression functions",uiLabel:"Module",reference:"AdaptableModule"}]},ModuleExpressionFunctionsMap:{name:"ModuleExpressionFunctionsMap",kind:"TypeAlias",description:"Module specific Expression Functions"},NamedQuery:{name:"NamedQuery",kind:"Interface",description:"Defines a Query which can be used in multiple AdapTable Modules",properties:[{name:"Name",kind:"string",description:"Name of the Query - how it will appear in Query dropdown",uiLabel:"Name"}]},NotificationsOptions:{name:"NotificationsOptions",kind:"Interface",description:"Options related to System Status Messages and Notifications in Adaptable.",properties:[{name:"closeWhenClicked",kind:"boolean",description:"Closes Notification automatically when its clicked",uiLabel:"Close When Clicked",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"duration",kind:"number | 'always'",description:"How long (in ms) Notifications display for",uiLabel:"Duration",isOptional:!0,gridInfo:"item",defaultValue:"3000"},{name:"isDraggable",kind:"boolean",description:"Can Notification be dragged",uiLabel:"Is Draggable",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"maxNotifications",kind:"number",description:"How many Notifications can be displayed at one time",uiLabel:"Max Notifications",isOptional:!0,gridInfo:"item",defaultValue:"3"},{name:"maxSystemMessagesInStore",kind:"number",description:"How many System Status Messages to hold in State; when limit is reached, oldest Message is removed",uiLabel:"Max System Messages In Store",isOptional:!0,gridInfo:"item",defaultValue:"100"},{name:"pauseWhenHovering",kind:"boolean",description:"Pauses the Notification when mouse hovers over it",uiLabel:"Pause When Hovering",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"position",kind:"REFERENCE",description:"Where Notification will appear (if anywhere)",uiLabel:"Position",isOptional:!0,gridInfo:"item",defaultValue:"'BottomRight'",reference:"TOAST_POSITIONS"},{name:"showApplicationIcon",kind:"boolean",description:"Displays the application icon in Notifications",uiLabel:"Show Application Icon",isOptional:!0,defaultValue:"false"},{name:"showProgressBar",kind:"boolean",description:"Shows a Progress Bar in the Notification",uiLabel:"Show Progress Bar",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"showSystemStatusMessageNotifications",kind:"boolean",description:"Display System Status Messages as Notifications",uiLabel:"Show System Status Message Notifications",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"transition",kind:"'Bounce' | 'Slide' | 'Zoom' | 'Flip'",description:"How Notification will appear: Bounce, Slide, Zoom or Flip",uiLabel:"Transition",isOptional:!0,gridInfo:"item",defaultValue:"'Slide'"}]},NumberFormatterOptions:{name:"NumberFormatterOptions",kind:"Interface",description:"Formatter Options for Numeric Columns",properties:[{name:"FractionDigits",kind:"number",description:"Number of digits to show in fractions",uiLabel:"Fraction Digits",isOptional:!0},{name:"FractionSeparator",kind:"string",description:"Separator to use in fractions",uiLabel:"Fraction Separator",isOptional:!0},{name:"IntegerDigits",kind:"number",description:"Number of digits to show for integers",uiLabel:"Integer Digits",isOptional:!0},{name:"IntegerSeparator",kind:"string",description:"Separator to use in integers",uiLabel:"Integer Separator",isOptional:!0},{name:"Multiplier",kind:"number",description:"Multiplier to use on the number",uiLabel:"Multiplier",isOptional:!0},{name:"Parentheses",kind:"boolean",description:"Shows negative numbers in parentheses",uiLabel:"Parentheses",isOptional:!0},{name:"Prefix",kind:"string",description:"Prefix to use before the number",uiLabel:"Prefix",isOptional:!0},{name:"Suffix",kind:"string",description:"Suffix to use after the number",uiLabel:"Suffix",isOptional:!0},{name:"Truncate",kind:"boolean",description:"Truncates a number",uiLabel:"Truncate",isOptional:!0}]},ObservableFunctionName:{name:"ObservableFunctionName",kind:"TypeAlias",description:"List of all the Observable Functions available in AdaptableQL"},OpenFinApi:{name:"OpenFinApi",kind:"Interface",description:"Provides run-time access to the OpenFin Plugin",properties:[{name:"clearOpenFinInternalState",kind:"function",description:"Clears any objects in internal OpenFin state created by AdapTable",uiLabel:"Clear Open Fin Internal State"},{name:"getAlertOptions",kind:"function",description:"Gets the Alert section from Adaptable Options",uiLabel:"Get Alert Options"},{name:"getCurrentLiveOpenFinReport",kind:"function",description:"Retrieves the OpenFin currently sending live data to Excel",uiLabel:"Get Current Live Open Fin Report"},{name:"getNotificationsOptions",kind:"function",description:"Gets the Notification section from Adaptable Options",uiLabel:"Get Notifications Options"},{name:"getOpenFinSchedules",kind:"function",description:"Retrieves all Schedules that send data to Excel via OpenFin",uiLabel:"Get Open Fin Schedules"},{name:"getOpenFinState",kind:"function",description:"Retrieves the OpenFin section of System State",uiLabel:"Get Open Fin State"},{name:"getOpenFinThrottleTime",kind:"function",description:"Retrieves the Throttle time for live updates",uiLabel:"Get Open Fin Throttle Time"},{name:"getPluginOptions",kind:"function",description:"Retrieves the OpenFinPlugOptions provided in OpenFin Plugin",uiLabel:"Get Plugin Options"},{name:"isOpenFinAvailable",kind:"function",description:"Whether OpenFin is available",uiLabel:"Is Open Fin Available"},{name:"isOpenFinRunning",kind:"function",description:"Whether OpenFin is currently running",uiLabel:"Is Open Fin Running"},{name:"showNotification",kind:"function",description:"Shows a notification in OpenFin",uiLabel:"Show Notification"},{name:"showNotificationForAlert",kind:"function",description:"Displays Alert as an OpenFin Notification",uiLabel:"Show Notification For Alert"},{name:"startLiveData",kind:"function",description:"Runs Report in Excel as Live Report (so updates as AdapTable ticks)",uiLabel:"Start Live Data"},{name:"stopLiveData",kind:"function",description:"Stops live data; data will no longer be sent from AdapTable to Excel",uiLabel:"Stop Live Data"}]},OpenFinPluginOptions:{name:"OpenFinPluginOptions",kind:"Interface",description:"Options required for when using the OpenFin plugin",properties:[{name:"notificationTimeout",kind:"number | false",description:"Timeout (in ms) for OpenFin Notifications to expire; set false for notifications not to auto-dismiss",uiLabel:"Notification Timeout",isOptional:!0,defaultValue:"5000"},{name:"onFDC3MessageSent",kind:"function",description:"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",uiLabel:"On FDC3Message Sent",isOptional:!0},{name:"onNotificationAction",kind:"unknown",description:"Function which is invoked when a button in OpenFin notification is clicked",uiLabel:"On Notification Action",isOptional:!0},{name:"onShowNotification",kind:"function",description:"Updates OpenFin Notification object before it's displayed (just add/remove properties); return false to stop Notification showing",uiLabel:"On Show Notification",isOptional:!0},{name:"onValidationFailureInExcel",kind:"'override' | 'show-notification' | 'show-undo-notification'",description:"Action to perform when a data change in Live Excel report triggers Prevent Edit Alert failure",uiLabel:"On Validation Failure In Excel",isOptional:!0},{name:"showAdaptableAlertsAsNotifications",kind:"boolean",description:"Converts AdapTable Alerts configured to display in popup as OpenFin Notifications",uiLabel:"Show Adaptable Alerts As Notifications",isOptional:!0,defaultValue:"true"},{name:"showAppIconInNotifications",kind:"unknown",description:"Icon to show in Notification - uses the value supplied in UserInterfaceOptions",uiLabel:"Show App Icon In Notifications",isOptional:!0,defaultValue:"true"},{name:"throttleTime",kind:"number",description:"How long (in ms) AdapTable throttles when sending data update to OpenFin",uiLabel:"Throttle Time",isOptional:!0,defaultValue:"2000"}]},OpenFinReport:{name:"OpenFinReport",kind:"Interface",description:"An OpenFin report",properties:[{name:"ReportName",kind:"string",description:"Name of Report (which will exist in the Export State)",uiLabel:"Report Name"}]},OpenFinSchedule:{name:"OpenFinSchedule",kind:"Interface",description:"Defines a OpenFin Schedule - used in Schedule Module",properties:[{name:"OpenFinReport",kind:"REFERENCE",description:"Report being exported to Excel (via OpenFin)",uiLabel:"Open Fin Report",reference:"OpenFinReport"},{name:"Transmission",kind:"unknown",description:"Whether Snapshot or Live Data (currently only the latter is supported)",uiLabel:"Transmission"}]},OpenFinState:{name:"OpenFinState",kind:"Interface",description:"Internal State used by AdapTable for managing the OpenFin plugin"},OrganizationColumn:{name:"OrganizationColumn",kind:"Interface",description:"A (String) Column which will be defined as an FDC3 Organization",properties:[{name:"fds_idColumnId",kind:"string",description:"Column which contains an FDS_ID",uiLabel:"Fds_id Column Id",isOptional:!0},{name:"intents",kind:"REFERENCE",description:"Organization-related FDC3 Intents; can be: `ViewNews` `ViewAnalysis`",uiLabel:"Intents",isOptional:!0,reference:"unknown"},{name:"leiColumnId",kind:"string",description:"Column which contains the LEI",uiLabel:"Lei Column Id",isOptional:!0},{name:"permidColumnId",kind:"string",description:"Column which contains a PermId",uiLabel:"Permid Column Id",isOptional:!0}]},OrganizationContext:{name:"OrganizationContext",kind:"Interface",description:"FDC3 Context to define an Organization",properties:[{name:"id",kind:"unknown",description:"The Organization data: LEI, PERMID, FDS_ID",uiLabel:"Id",isOptional:!0},{name:"name",kind:"string",description:"Free text name of Organization",uiLabel:"Name",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `organization`",uiLabel:"Type"}]},OrganizationIntent:{name:"OrganizationIntent",kind:"TypeAlias",description:"FDC3 Intents available to an Organization Column"},PercentBarStyle:{name:"PercentBarStyle",kind:"Interface",description:"Style used to display Percent Bars in Special Column Style",properties:[{name:"BackColor",kind:"string",description:"Background colour for 'Percent Bar'; leave unset if none required",uiLabel:"Back Color",isOptional:!0,defaultValue:"Gray"},{name:"CellText",kind:"REFERENCE",description:"Whether Cell shows Cell Value, Percent Value, both or none",uiLabel:"Cell Text",isOptional:!0,reference:"CellTextOptions"},{name:"ToolTipText",kind:"REFERENCE",description:"Whether Tooltip shows Cell Value, Percent Value, both or none",uiLabel:"Tool Tip Text",isOptional:!0,reference:"CellTextOptions"}]},PermittedValues:{name:"PermittedValues",kind:"Interface",description:"Permitted/possible values, when column values can be selected (e.g. sort, bulk-update)",properties:[{name:"values",kind:"unknown",description:"Values to display: either hardcoded list or a function that returns a list",uiLabel:"Values",isOptional:!0}]},PermittedValuesContext:{name:"PermittedValuesContext",kind:"Interface",description:"Context used when getting PermittedValues via a function",properties:[{name:"column",kind:"REFERENCE",description:"Column whose values are being displayed",uiLabel:"Column",reference:"AdaptableColumn"}]},PivotPreviewColumnsContext:{name:"PivotPreviewColumnsContext",kind:"Interface",description:"Context uses for pivotPreviewColumns function in Layout Options",properties:[{name:"columnId",kind:"string",description:"Column being opened",uiLabel:"Column Id"},{name:"layout",kind:"REFERENCE",description:"Current Layout",uiLabel:"Layout",reference:"Layout"}]},PluginsApi:{name:"PluginsApi",kind:"Interface",description:"API methods dealing with AdapTable plugins",properties:[{name:"getFinancePluginApi",kind:"function",description:"Returns Finance API class in Adaptable API",uiLabel:"Get Finance Plugin Api"},{name:"getFinsemblePluginApi",kind:"function",description:"Returns Finsemble API class in Adaptable API",uiLabel:"Get Finsemble Plugin Api"},{name:"getGlue42PluginApi",kind:"function",description:"Returns Glue42 API class in Adaptable API",uiLabel:"Get Glue42Plugin Api"},{name:"getipushpullPluginApi",kind:"function",description:"Returns ipushpull API class in Adaptable API",uiLabel:"Getipushpull Plugin Api"},{name:"getOpenFinPluginApi",kind:"function",description:"Returns OpenFin API class in Adaptable API",uiLabel:"Get Open Fin Plugin Api"},{name:"getPluginsState",kind:"function",description:"Retrieves the Plugin State (internal only)",uiLabel:"Get Plugins State"},{name:"getPluginState",kind:"function",description:"Gets the State for a given Plugin",uiLabel:"Get Plugin State"},{name:"registerPlugin",kind:"function",description:"Registers a Plugin (internal method)",uiLabel:"Register Plugin"},{name:"setPluginState",kind:"function",description:"Sets the initial state for a given plugin (internal method)",uiLabel:"Set Plugin State"}]},PlusMinusApi:{name:"PlusMinusApi",kind:"Interface",description:"Provides run-time access to the Plus / Minus Module and associated state",properties:[{name:"addPlusMinusNudge",kind:"function",description:"Adds new Plus Minus Rule to State",uiLabel:"Add Plus Minus Nudge"},{name:"applyPlusMinus",kind:"function",description:"Applies a Plus Minus to given cells",uiLabel:"Apply Plus Minus"},{name:"editPlusMinusNudge",kind:"function",description:"Replaces Plus Minus Rule in State with given one",uiLabel:"Edit Plus Minus Nudge"},{name:"getAllActivePlusMinus",kind:"function",description:"Retrieves all active (not-suspended) Plus Minus Rules in Adaptable State with those with expressions first",uiLabel:"Get All Active Plus Minus"},{name:"getAllPlusMinus",kind:"function",description:"Retrieves all Plus Minus Rules in Adaptable State with those with expressions first",uiLabel:"Get All Plus Minus"},{name:"getAllSuspendedPlusMinus",kind:"function",description:"Retrieves all suspended Plus Minus Rules in Adaptable State with those with expressions first",uiLabel:"Get All Suspended Plus Minus"},{name:"getPlusMinusById",kind:"function",description:"Retrieves Plus Minus Rule by Id",uiLabel:"Get Plus Minus By Id"},{name:"getPlusMinusState",kind:"function",description:"Retrieves Plus Minus section from Adaptable State",uiLabel:"Get Plus Minus State"},{name:"runPlusMinusNudge",kind:"function",description:"Applies a Plus Minus Rule to given cells",uiLabel:"Run Plus Minus Nudge"},{name:"showPlusMinusPopup",kind:"function",description:"Opens Settings Panel with Plus Minus section selected and visible",uiLabel:"Show Plus Minus Popup"},{name:"suspendPlusMinusNudge",kind:"function",description:"Suspends Plus Minus Rule",uiLabel:"Suspend Plus Minus Nudge"},{name:"unSuspendPlusMinusNudge",kind:"function",description:"Activates a suspended Plus Minus Rule",uiLabel:"Un Suspend Plus Minus Nudge"}]},PlusMinusNudge:{name:"PlusMinusNudge",kind:"Interface",description:"Defines a Plus Minus Rule - used in the Plus Minus Module",properties:[{name:"NudgeValue",kind:"number",description:"Amount by which to update cell when Rule is applied",uiLabel:"Nudge Value"},{name:"Rule",kind:"REFERENCE",description:"(Optional) Boolean Expression to determine whether to apply the Nudge",uiLabel:"Rule",isOptional:!0,reference:"unknown"},{name:"Scope",kind:"REFERENCE",description:"Where Rule is applied",uiLabel:"Scope",reference:"AdaptableScope"}]},PlusMinusState:{name:"PlusMinusState",kind:"Interface",description:"Predefined Configuration for Plus Minus Module",properties:[{name:"PlusMinusNudges",kind:"array",description:"Array of Plus Minus Nudges",uiLabel:"Plus Minus Nudges",isOptional:!0}]},PortfolioContext:{name:"PortfolioContext",kind:"Interface",description:"FDC3 Context to define a financial Portfolio (array of Positions)",properties:[{name:"id",kind:"unknown",description:"Optional Id",uiLabel:"Id",isOptional:!0},{name:"name",kind:"string",description:"Free text name of portfolio",uiLabel:"Name",isOptional:!0},{name:"positions",kind:"array",description:"The position data",uiLabel:"Positions",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `portfolio`",uiLabel:"Type"}]},PositionColumn:{name:"PositionColumn",kind:"Interface",description:"A (Numeric) Column which will be defined as an FDC3 Position",properties:[{name:"instrumentColumnId",kind:"string",description:"Column which contains the Instrument information of the FDC3 Message",uiLabel:"Instrument Column Id"},{name:"intents",kind:"REFERENCE",description:"Position-related FDC3 Intents; can be: `ViewChart` `ViewNews` `ViewAnalysis`",uiLabel:"Intents",isOptional:!0,reference:"PositionIntents"}]},PositionContext:{name:"PositionContext",kind:"Interface",description:"FDC3 Context to define a financial Position (requires an Instrument)",properties:[{name:"holding",kind:"number",description:"Holding in the Position (mandatory)",uiLabel:"Holding"},{name:"id",kind:"unknown",description:"Optional Id",uiLabel:"Id",isOptional:!0},{name:"instrument",kind:"REFERENCE",description:"The `InstrumentContext` of the relevant Instrument",uiLabel:"Instrument",reference:"InstrumentContext"},{name:"name",kind:"string",description:"Free text name of Position",uiLabel:"Name",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `position`",uiLabel:"Type"}]},PositionIntent:{name:"PositionIntent",kind:"TypeAlias",description:"FDC3 Intents available to a Position Column"},PositionIntents:{name:"PositionIntents",kind:"TypeAlias",description:"All available Position Intents"},PredefinedConfig:{name:"PredefinedConfig",kind:"Interface",description:"This is the main Predefined Config interface which developers will populate at design-time",properties:[{name:"Alert",kind:"REFERENCE",description:"Collection of `AlertDefinitions` which will fire Alerts when the rule is met",uiLabel:"Alert",isOptional:!0,reference:"AlertState"},{name:"Application",kind:"REFERENCE",description:"Empty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.",uiLabel:"Application",isOptional:!0,reference:"ApplicationState"},{name:"CalculatedColumn",kind:"REFERENCE",description:"Supplies a collection of *CalculatedColumn* objects that will display a value based on other cells in the row (using a Calculated Column Expression)",uiLabel:"Calculated Column",isOptional:!0,reference:"CalculatedColumnState"},{name:"Charting",kind:"REFERENCE",description:"Predefine charting models",uiLabel:"Charting",isOptional:!0,reference:"ChartingState"},{name:"ConditionalStyle",kind:"REFERENCE",description:"Supplies a collection of *ConditionalStyle* objects to provides columns and rows with a particular style when the data matches a given rule",uiLabel:"Conditional Style",isOptional:!0,reference:"unknown"},{name:"CustomSort",kind:"REFERENCE",description:"Supplies a collection of *Custom Sort* objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways",uiLabel:"Custom Sort",isOptional:!0,reference:"CustomSortState"},{name:"Dashboard",kind:"REFERENCE",description:"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",uiLabel:"Dashboard",isOptional:!0,reference:"DashboardState"},{name:"Export",kind:"REFERENCE",description:"Supplies a collection of *Report* objects, together with name of the Current Report, as part of AdapTable export Module",uiLabel:"Export",isOptional:!0,reference:"ExportState"},{name:"FlashingCell",kind:"REFERENCE",description:"* Objects which define which cells flash in response to data changes",uiLabel:"Flashing Cell",isOptional:!0,reference:"FlashingCellState"},{name:"FormatColumn",kind:"REFERENCE",description:"Supplies a collection of *FormatColumn* objects that will style an entire column in a single way (and not subject to a rule like with Conditional Style).",uiLabel:"Format Column",isOptional:!0,reference:"FormatColumnState"},{name:"FreeTextColumn",kind:"REFERENCE",description:"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.",uiLabel:"Free Text Column",isOptional:!0,reference:"FreeTextColumnState"},{name:"Layout",kind:"REFERENCE",description:"Supplies a collection of *Layout* objects to name and manage groups of column visibility, order and sorts.",uiLabel:"Layout",isOptional:!0,reference:"LayoutState"},{name:"PlusMinus",kind:"REFERENCE",description:"Supplies a collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell",uiLabel:"Plus Minus",isOptional:!0,reference:"PlusMinusState"},{name:"Query",kind:"REFERENCE",description:"Named Queries available for use across multiple AdapTable Modules; and `CurrentQuery` - an Expression to run at start-up",uiLabel:"Query",isOptional:!0,reference:"QueryState"},{name:"QuickSearch",kind:"REFERENCE",description:"Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows",uiLabel:"Quick Search",isOptional:!0,reference:"QuickSearchState"},{name:"Schedule",kind:"REFERENCE",description:"Supplies a collection of *Schedule* objects",uiLabel:"Schedule",isOptional:!0,reference:"ScheduleState"},{name:"Shortcut",kind:"REFERENCE",description:"Supplies a collection of *Shortcut* objects to aid data entry and prevent 'fat finger' issues",uiLabel:"Shortcut",isOptional:!0,reference:"ShortcutState"},{name:"StatusBar",kind:"REFERENCE",description:"Configures the Adaptable Status Bar",uiLabel:"Status Bar",isOptional:!0,reference:"StatusBarState"},{name:"StyledColumn",kind:"REFERENCE",description:"Supplies a collection of Special Column Styles",uiLabel:"Styled Column",isOptional:!0,reference:"StyledColumnState"},{name:"Theme",kind:"REFERENCE",description:"Specifies the current Theme and lists the User and System themes available for selection.",uiLabel:"Theme",isOptional:!0,reference:"ThemeState"},{name:"ToolPanel",kind:"REFERENCE",description:"Sets the order and visibility of the Tool Panel controls in the AdapTable ToolPanel (on right of grid)",uiLabel:"Tool Panel",isOptional:!0,reference:"ToolPanelState"}]},PredicateApi:{name:"PredicateApi",kind:"Interface",description:"Functions which manage the Predicate object in AdapTable",properties:[{name:"getCustomPredicateDefById",kind:"function",description:"Gets Predicate Definition provided by users for given Id",uiLabel:"Get Custom Predicate Def By Id"},{name:"getCustomPredicateDefs",kind:"function",description:"Returns Predicate Definitions provided by users",uiLabel:"Get Custom Predicate Defs"},{name:"getEqualityPredicateForDataType",kind:"function",description:"Gets the correct Equality-type System Predicate for a particular DataType",uiLabel:"Get Equality Predicate For Data Type"},{name:"getPredicateDefById",kind:"function",description:"Gets the Predicate Definition for a given Id",uiLabel:"Get Predicate Def By Id"},{name:"getPredicateDefs",kind:"function",description:"Returns all current Predicate Definitions",uiLabel:"Get Predicate Defs"},{name:"getPredicateDefsByModuleScope",kind:"function",description:"Retrieves all Predicate Definitions for given Module Scope",uiLabel:"Get Predicate Defs By Module Scope"},{name:"getSystemPredicateDefById",kind:"function",description:"Gets Predicate Definition provided by AdapTable for given Id",uiLabel:"Get System Predicate Def By Id"},{name:"getSystemPredicateDefs",kind:"function",description:"Returns Predicate Definitions provided by AdapTable",uiLabel:"Get System Predicate Defs"},{name:"handlePredicate",kind:"function",description:"Main Handler function for a Predicate Definition - used by AdapTableQL",uiLabel:"Handle Predicate"},{name:"hasPredicateValues",kind:"function",description:"Returns true if the predicate has a dropdown.",uiLabel:"Has Predicate Values"},{name:"isValidPredicate",kind:"function",description:"Checks whether a given Predicate Definition is valid",uiLabel:"Is Valid Predicate"},{name:"predicateToString",kind:"function",description:"Stringifies a given Predicate Definition",uiLabel:"Predicate To String"}]},PredicateDefHandlerParams:{name:"PredicateDefHandlerParams",kind:"Interface",description:"Object passed into an Adaptable Predicate Definition",properties:[{name:"api",kind:"REFERENCE",description:"The Adaptable Api",uiLabel:"Api",reference:"AdaptableApi"},{name:"column",kind:"REFERENCE",description:"Adaptable Column which contains the cell",uiLabel:"Column",reference:"AdaptableColumn"},{name:"displayValue",kind:"unknown",description:"Display value in cell being evaluated",uiLabel:"Display Value"},{name:"inputs",kind:"array",description:"Any inputs required to perform evaluation",uiLabel:"Inputs"},{name:"node",kind:"REFERENCE",description:"AG Grid Row node which contains the cell",uiLabel:"Node",reference:"unknown"},{name:"oldValue",kind:"unknown",description:"Previous value in cell (e.g. if evaluating an edit)",uiLabel:"Old Value"},{name:"value",kind:"unknown",description:"Raw value in cell being evaluated",uiLabel:"Value"}]},QueryableColumnContext:{name:"QueryableColumnContext",kind:"Interface",description:"Context passed when evaluating Queryable Columns",properties:[{name:"adaptableColumn",kind:"REFERENCE",description:"Basic Column Info - just ColumnId, DataType and FriendlyName",uiLabel:"Adaptable Column",reference:"AdaptableColumnBase"}]},QueryApi:{name:"QueryApi",kind:"Interface",description:"Provides run-time access to Named and Current Queries",properties:[{name:"clearCurrentQuery",kind:"function",description:"Clears the Current Query",uiLabel:"Clear Current Query"},{name:"expandCurrentQuery",kind:"function",description:"Opens current query editor",uiLabel:"Expand Current Query"},{name:"fireQueryRunEvent",kind:"function",description:"Fires Query Run Event - typically used to enable querying on the server",uiLabel:"Fire Query Run Event"},{name:"getAllNamedQuery",kind:"function",description:"Gets all Named Queries in Adaptable State",uiLabel:"Get All Named Query"},{name:"getCurrentQuery",kind:"function",description:"Returns the Current Query",uiLabel:"Get Current Query"},{name:"getNamedQueryByName",kind:"function",description:"Retrieves Named Query with given name from State",uiLabel:"Get Named Query By Name"},{name:"getNamedQueryModuleReferences",kind:"function",description:"Returns all the references in the AdaptableState of the NamedQuery with the given name",uiLabel:"Get Named Query Module References"},{name:"getQueryState",kind:"function",description:"Retrieves Query section from Adaptable State",uiLabel:"Get Query State"},{name:"getReferencedNamedQueryNames",kind:"function",description:"Returns the name of all the referenced Named Queries as an array of strings",uiLabel:"Get Referenced Named Query Names"},{name:"isValidNamedQueryName",kind:"function",description:"Checks if the given Named Query has a valid name",uiLabel:"Is Valid Named Query Name"},{name:"setCurrentQuery",kind:"function",description:"Set a Query as Current Query",uiLabel:"Set Current Query"},{name:"showExpandedQueryPopup",kind:"function",description:"Opens Expanded Query Popup screen",uiLabel:"Show Expanded Query Popup"},{name:"showQueryPopup",kind:"function",description:"Opens Settings Panel with Query section selected and visible",uiLabel:"Show Query Popup"}]},QueryLanguageApi:{name:"QueryLanguageApi",kind:"Interface",description:"Functions related to AdapTableQL (the Adaptable Query Language)",properties:[{name:"getAdaptableQueryExpression",kind:"function",description:"Returns the Expression string of the given AdaptableQuery: can be Boolean, AggregatedBoolean, Scalar, AggregatedScalar or Observable Expression",uiLabel:"Get Adaptable Query Expression"},{name:"getAdaptableQueryExpressionWithColumnFriendlyNames",kind:"function",description:"Returns the Expression string of the given AdaptableQuery with the column friendly names (instead of their technical IDs)",uiLabel:"Get Adaptable Query Expression With Column Friendly Names"},{name:"getASTForExpression",kind:"function",description:"Runs the AST that AdapTableQL creates for an Expression - useful when evaluating remotely",uiLabel:"Get AST For Expression"},{name:"getColumnsFromExpression",kind:"function",description:"Returns all Columns referenced in an Expression",uiLabel:"Get Columns From Expression"},{name:"isColumnQueryable",kind:"function",description:"Returns whether a Column is Queryable",uiLabel:"Is Column Queryable"},{name:"isValidAggregatedBooleanExpression",kind:"function",description:"Whether the given AggregatedBooleanExpression is valid",uiLabel:"Is Valid Aggregated Boolean Expression"},{name:"isValidAggregatedScalarExpression",kind:"function",description:"Whether the given AggregatedScalarExpression is valid",uiLabel:"Is Valid Aggregated Scalar Expression"},{name:"isValidBooleanExpression",kind:"function",description:"Whether the given BooleanExpression is valid",uiLabel:"Is Valid Boolean Expression"},{name:"isValidObservableExpression",kind:"function",description:"Whether the given ObservableExpression is valid",uiLabel:"Is Valid Observable Expression"}]},QueryRunInfo:{name:"QueryRunInfo",kind:"Interface",description:"EventInfo returned by the QueryRun event",properties:[{name:"currentQuery",kind:"string | undefined",description:"Current Query",uiLabel:"Current Query"},{name:"queryAST",kind:"unknown",description:"AST for Current Query",uiLabel:"Query AST"}]},QueryState:{name:"QueryState",kind:"Interface",description:"Predefined Configuration for Query Module",properties:[{name:"CurrentQuery",kind:"string",description:"Expression used for the Query currently being run",uiLabel:"Current Query",isOptional:!0},{name:"NamedQueries",kind:"array",description:"Named Queries - can be referenced in other Expressions",uiLabel:"Named Queries",isOptional:!0}]},QuickSearchApi:{name:"QuickSearchApi",kind:"Interface",description:"Provides run-time access to Quick Search Module",properties:[{name:"clearQuickSearch",kind:"function",description:"Clears Quick Search",uiLabel:"Clear Quick Search"},{name:"getQuickSearchState",kind:"function",description:"Retrieves Quick Search section from Adaptable State",uiLabel:"Get Quick Search State"},{name:"getQuickSearchStyle",kind:"function",description:"Retrieves current Quick Search style",uiLabel:"Get Quick Search Style"},{name:"getQuickSearchValue",kind:"function",description:"Retrieves current Quick Search text",uiLabel:"Get Quick Search Value"},{name:"runQuickSearch",kind:"function",description:"Runs Quick Search using supplied text",uiLabel:"Run Quick Search"},{name:"setQuickSearchStyle",kind:"function",description:"Sets style for Quick Search; can be name of (a provided) css style",uiLabel:"Set Quick Search Style"},{name:"showQuickSearchPopup",kind:"function",description:"Opens Settings Panel with Quick Search section selected and visible",uiLabel:"Show Quick Search Popup"}]},QuickSearchState:{name:"QuickSearchState",kind:"Interface",description:"Predefined Configuration for Quick Search Module",properties:[{name:"QuickSearchText",kind:"string",description:"Last Quick Search that was run (and will run again at start up)",uiLabel:"Quick Search Text",isOptional:!0},{name:"Style",kind:"REFERENCE",description:"Style to use to highlight matching cells - uses common `AdaptableStyle` object",uiLabel:"Style",isOptional:!0,reference:"AdaptableStyle"}]},RaiseFDC3IntentContext:{name:"RaiseFDC3IntentContext",kind:"Interface",description:"Context passed into Raise FDC3 Intent functions (e.g. get label)",properties:[{name:"intent",kind:"unknown",description:"FDC3 Intent that was raised",uiLabel:"Intent"}]},RangeValueType:{name:"RangeValueType",kind:"TypeAlias",description:"Whether the Range is Number or Percent based"},ReactFrameworkComponent:{name:"ReactFrameworkComponent",kind:"TypeAlias",description:"A function that returns a ReactNode"},ReminderSchedule:{name:"ReminderSchedule",kind:"Interface",description:"Schedules a Reminder to appear at a given point in time",properties:[{name:"DisplayNotification",kind:"boolean",description:"Displays Reminder as a Toast Notification",uiLabel:"Display Notification"},{name:"DisplaySystemStatusMessage",kind:"boolean",description:"Shows Reminder as System Status Message",uiLabel:"Display System Status Message",isOptional:!0},{name:"Header",kind:"string",description:"Reminder header text",uiLabel:"Header"},{name:"Message",kind:"string",description:"Reminder body text",uiLabel:"Message"},{name:"MessageType",kind:"REFERENCE",description:"Type of Message - 'Success', 'Info', 'Warning' or 'Error'",uiLabel:"Message Type",reference:"AdaptableMessageType"}]},ReportColumnScope:{name:"ReportColumnScope",kind:"TypeAlias",description:"Columns to be included in a Report"},ReportContext:{name:"ReportContext",kind:"Interface",description:"Report Context sent when using Custom Export Destinations",properties:[{name:"report",kind:"REFERENCE",description:"Definition of Report being Run",uiLabel:"Report",reference:"unknown"},{name:"reportData",kind:"REFERENCE",description:"Data being exported in the Report",uiLabel:"Report Data",reference:"ReportData"}]},ReportData:{name:"ReportData",kind:"Interface",description:"Defines the data in a Report run by AdapTable",properties:[{name:"columns",kind:"array",description:"Columns in the Report",uiLabel:"Columns"},{name:"rows",kind:"unknown",description:"Rows in the Report",uiLabel:"Rows"}]},ReportRowScope:{name:"ReportRowScope",kind:"TypeAlias",description:"AG Grid Row Data to be included in a Report"},ReportSchedule:{name:"ReportSchedule",kind:"Interface",description:"Defines a Scheduled Report - used in Schedule Module (where State is stored)",properties:[{name:"ExportDestination",kind:"'Excel' | 'CSV' | 'Clipboard' | 'JSON' | string",description:"Where report data will be exported",uiLabel:"Export Destination"},{name:"ExportDestinationData",kind:"REFERENCE",description:"Additional data for a Custom Destination produced by a Dynamic Form",uiLabel:"Export Destination Data",isOptional:!0,reference:"unknown"},{name:"ReportName",kind:"string",description:"Name of Report to run on Schedule",uiLabel:"Report Name"}]},RowInfo:{name:"RowInfo",kind:"Interface",description:"Provides meta data about a Row in Adaptable",properties:[{name:"isDisplayed",kind:"boolean",description:"Is Row displayed (ie. filtered, not necessarily in viewport)",uiLabel:"Is Displayed",isOptional:!0},{name:"isExpanded",kind:"boolean",description:"Is Row expanded (if a group row)",uiLabel:"Is Expanded",isOptional:!0},{name:"isGroup",kind:"boolean",description:"Is Row grouped",uiLabel:"Is Group",isOptional:!0},{name:"isMaster",kind:"boolean",description:"Is Row a Master Row (in a Master-Detail grid)",uiLabel:"Is Master",isOptional:!0},{name:"isSelected",kind:"boolean",description:"Is Row selected",uiLabel:"Is Selected",isOptional:!0},{name:"rowGroupLevel",kind:"number",description:"What level the Row is (if Row Grouping is active)",uiLabel:"Row Group Level",isOptional:!0}]},ScalarFunctionName:{name:"ScalarFunctionName",kind:"TypeAlias",description:"List of all the Scalar Functions available in AdaptableQL"},Schedule:{name:"Schedule",kind:"Interface",description:"Defines when an action will be run - either one-off or recurring",properties:[{name:"DaysOfWeek",kind:"REFERENCE",description:"Days on which Schedule will run",uiLabel:"Days Of Week",isOptional:!0,reference:"unknown"},{name:"Hour",kind:"number",description:"Hour the Schedule will run",uiLabel:"Hour"},{name:"Minute",kind:"number",description:"Minute the Schedule will run",uiLabel:"Minute"},{name:"OneOffDate",kind:"string",description:"A one off date on which the Schedule will run",uiLabel:"One Off Date",isOptional:!0}]},ScheduleApi:{name:"ScheduleApi",kind:"Interface",description:"Provides run-time access to the Schedule Module and associated state",properties:[{name:"addGlue42Schedule",kind:"function",description:"Add Glue42-based Schedule",uiLabel:"Add Glue42Schedule"},{name:"addIPushPullSchedule",kind:"function",description:"Add ipushpull-based Schedule",uiLabel:"Add IPush Pull Schedule"},{name:"addOpenFinSchedule",kind:"function",description:"Add OpenFin-based Schedule",uiLabel:"Add Open Fin Schedule"},{name:"addReminderSchedule",kind:"function",description:"Adds Reminder-based Schedule",uiLabel:"Add Reminder Schedule"},{name:"addReportSchedule",kind:"function",description:"Adds Report / Export Schedule",uiLabel:"Add Report Schedule"},{name:"applySchedule",kind:"function",description:"Applies the Schedule of given type",uiLabel:"Apply Schedule"},{name:"deleteGlue42Schedule",kind:"function",description:"Delete Glue42-based Schedule",uiLabel:"Delete Glue42Schedule"},{name:"deleteIPushPullSchedule",kind:"function",description:"Delete ipushpull-based Schedule",uiLabel:"Delete IPush Pull Schedule"},{name:"deleteOpenFinSchedule",kind:"function",description:"Delete OpenFin-based Schedule",uiLabel:"Delete Open Fin Schedule"},{name:"deleteReminderSchedule",kind:"function",description:"Deletes Reminder-based Schedule",uiLabel:"Delete Reminder Schedule"},{name:"deleteReportSchedule",kind:"function",description:"Deletes Report / Export Schedule",uiLabel:"Delete Report Schedule"},{name:"editGlue42Schedule",kind:"function",description:"Edit Glue42-based Schedule",uiLabel:"Edit Glue42Schedule"},{name:"editIPushPullSchedule",kind:"function",description:"Edit ipushpull-based Schedule",uiLabel:"Edit IPush Pull Schedule"},{name:"editOpenFinSchedule",kind:"function",description:"Edit OpenFin-based Schedule",uiLabel:"Edit Open Fin Schedule"},{name:"editReminderSchedule",kind:"function",description:"Edits Reminder-based Schedule",uiLabel:"Edit Reminder Schedule"},{name:"editReportSchedule",kind:"function",description:"Edits Report / Export Schedule",uiLabel:"Edit Report Schedule"},{name:"getAllActiveGlue42Schedule",kind:"function",description:"Retrieves all active (not-suspended) Glue42-based Schedules from Schedule State",uiLabel:"Get All Active Glue42Schedule"},{name:"getAllActiveIPushPullSchedule",kind:"function",description:"Retrieves all active (not-suspended) ipushpull-based Schedules from Schedule State",uiLabel:"Get All Active IPush Pull Schedule"},{name:"getAllActiveOpenFinSchedule",kind:"function",description:"Retrieves all active (not-suspended) OpenFin-based Schedules from Schedule State",uiLabel:"Get All Active Open Fin Schedule"},{name:"getAllActiveReminderSchedule",kind:"function",description:"Retrieves all active (not-suspended) Reminder-based Schedules from Schedule State",uiLabel:"Get All Active Reminder Schedule"},{name:"getAllActiveReportSchedule",kind:"function",description:"Retrieves all active (not-suspended) Report / Export Schedules from Schedule State",uiLabel:"Get All Active Report Schedule"},{name:"getAllGlue42Schedule",kind:"function",description:"Retrieves all Glue42-based Schedules from Schedule State",uiLabel:"Get All Glue42Schedule"},{name:"getAllIPushPullSchedule",kind:"function",description:"Retrieves all ipushpull-based Schedules from Schedule State",uiLabel:"Get All IPush Pull Schedule"},{name:"getAllOpenFinSchedule",kind:"function",description:"Retrieves all OpenFin-based Schedules from Schedule State",uiLabel:"Get All Open Fin Schedule"},{name:"getAllReminderSchedule",kind:"function",description:"Retrieves all Reminder-based Schedules from Schedule State",uiLabel:"Get All Reminder Schedule"},{name:"getAllReportSchedule",kind:"function",description:"Retrieves all Report / Export Schedules from Schedule State",uiLabel:"Get All Report Schedule"},{name:"getAllSchedule",kind:"function",description:"Retrieves the Schedule section from Adaptable State",uiLabel:"Get All Schedule"},{name:"getAllSuspendedGlue42Schedule",kind:"function",description:"Retrieves all suspended Glue42-based Schedules from Schedule State",uiLabel:"Get All Suspended Glue42Schedule"},{name:"getAllSuspendedIPushPullSchedule",kind:"function",description:"Retrieves all suspended ipushpull-based Schedules from Schedule State",uiLabel:"Get All Suspended IPush Pull Schedule"},{name:"getAllSuspendedOpenFinSchedule",kind:"function",description:"Retrieves all suspended OpenFin-based Schedules from Schedule State",uiLabel:"Get All Suspended Open Fin Schedule"},{name:"getAllSuspendedReminderSchedule",kind:"function",description:"Retrieves all suspended Reminder-based Schedules from Schedule State",uiLabel:"Get All Suspended Reminder Schedule"},{name:"getAllSuspendedReportSchedule",kind:"function",description:"Retrieves all suspended Report / Export Schedules from Schedule State",uiLabel:"Get All Suspended Report Schedule"},{name:"getScheduleById",kind:"function",description:"Retrieves Schedule by id",uiLabel:"Get Schedule By Id"},{name:"getScheduleState",kind:"function",description:"Retrieves Schedule section from Adaptable State",uiLabel:"Get Schedule State"},{name:"showSchedulePopup",kind:"function",description:"Opens Settings Panel with Schedule section selected and visible",uiLabel:"Show Schedule Popup"},{name:"suspendGlue42Schedule",kind:"function",description:"Suspends Glue42-based Schedule",uiLabel:"Suspend Glue42Schedule"},{name:"suspendIPushPullSchedule",kind:"function",description:"Suspends ipushpull-based Schedule",uiLabel:"Suspend IPush Pull Schedule"},{name:"suspendOpenFinSchedule",kind:"function",description:"Suspends OpenFin-based Schedule",uiLabel:"Suspend Open Fin Schedule"},{name:"suspendReminderSchedule",kind:"function",description:"Suspends Reminder-based Schedule",uiLabel:"Suspend Reminder Schedule"},{name:"suspendReportSchedule",kind:"function",description:"Suspends Report / Export Schedule",uiLabel:"Suspend Report Schedule"},{name:"unSuspendGlue42Schedule",kind:"function",description:"Activates a suspended Glue42-based Schedule",uiLabel:"Un Suspend Glue42Schedule"},{name:"unSuspendIPushPullSchedule",kind:"function",description:"Activates a suspended ipushpull-based Schedule",uiLabel:"Un Suspend IPush Pull Schedule"},{name:"unSuspendOpenFinSchedule",kind:"function",description:"Activates a suspended OpenFin-based Schedule",uiLabel:"Un Suspend Open Fin Schedule"},{name:"unSuspendReminderSchedule",kind:"function",description:"Activates a suspended Reminder-based Schedule",uiLabel:"Un Suspend Reminder Schedule"},{name:"unSuspendReportSchedule",kind:"function",description:"Activates a suspended Report / Export Schedule",uiLabel:"Un Suspend Report Schedule"}]},ScheduleState:{name:"ScheduleState",kind:"Interface",description:"Predefined Configuration for the Schedule Module",properties:[{name:"Glue42Schedules",kind:"array",description:"Schedules connected to Glue42 exports - available if Glue42 plugin is running",uiLabel:"Glue42Schedules",isOptional:!0},{name:"IPushPullSchedules",kind:"array",description:"Schedules connected to ipushpull Reports - available if ipushpull plugin is running",uiLabel:"I Push Pull Schedules",isOptional:!0},{name:"OpenFinSchedules",kind:"array",description:"Schedules connected to OpenFin exports - available if OpenFin plugin is running",uiLabel:"Open Fin Schedules",isOptional:!0},{name:"Reminders",kind:"array",description:"Schedules connected to Reminders - Alerts that fire at set times",uiLabel:"Reminders",isOptional:!0},{name:"ReportSchedules",kind:"array",description:"Schedules connected to Reports (created in the Export function)",uiLabel:"Report Schedules",isOptional:!0}]},ScopeApi:{name:"ScopeApi",kind:"Interface",description:"Provides access to a suite of functions related to the `Scope` object",properties:[{name:"areAllBooleanColumnsInScope",kind:"function",description:"True if all selected columns are boolean",uiLabel:"Are All Boolean Columns In Scope"},{name:"createCellColorRangesForScope",kind:"function",description:"Creates Cell Color Ranges (used in Format Column) for given Scope",uiLabel:"Create Cell Color Ranges For Scope"},{name:"getColumnIdsInScope",kind:"function",description:"Returns all the ColumnIds in the Scope",uiLabel:"Get Column Ids In Scope"},{name:"getColumnsForScope",kind:"function",description:"Returns list of all Columns in the given Scope",uiLabel:"Get Columns For Scope"},{name:"getDataTypesInScope",kind:"function",description:"Returns all the DataTypes in the Scope",uiLabel:"Get Data Types In Scope"},{name:"getScopeDescription",kind:"function",description:"Provides a description for the Scope",uiLabel:"Get Scope Description"},{name:"getScopeToString",kind:"function",description:"Gets string representation of the Scope",uiLabel:"Get Scope To String"},{name:"getSingleColumnInScope",kind:"function",description:"Gets the only Column in given Scope",uiLabel:"Get Single Column In Scope"},{name:"isColumnInDateScope",kind:"function",description:"True if Scope has Data DataType which contains Column",uiLabel:"Is Column In Date Scope"},{name:"isColumnInNumericScope",kind:"function",description:"True if Scope has Numeric DataType containing Column",uiLabel:"Is Column In Numeric Scope"},{name:"isColumnInScope",kind:"function",description:"True if Column is in given Scope",uiLabel:"Is Column In Scope"},{name:"isColumnInScopeColumns",kind:"function",description:"True if Column is in Scope's 'ColumnIds' section",uiLabel:"Is Column In Scope Columns"},{name:"isColumnInStringsScope",kind:"function",description:"True if Scope has String DataType containing Column",uiLabel:"Is Column In Strings Scope"},{name:"isPrimaryKeyColumnInScopeColumns",kind:"function",description:"Whether PK column is included in Scope's column section",uiLabel:"Is Primary Key Column In Scope Columns"},{name:"isScopeInScope",kind:"function",description:"True if first scope is in second Scope",uiLabel:"Is Scope In Scope"},{name:"isSingleBooleanColumnScope",kind:"function",description:"True if Scope contains just 1 boolean Column",uiLabel:"Is Single Boolean Column Scope"},{name:"isSingleColumnScope",kind:"function",description:"True if Scope contains just 1 ColumnId",uiLabel:"Is Single Column Scope"},{name:"isSingleNumericColumnScope",kind:"function",description:"True if Scope contains just 1 numeric Column",uiLabel:"Is Single Numeric Column Scope"},{name:"scopeHasColumns",kind:"function",description:"True if Scope contains ColumnIds",uiLabel:"Scope Has Columns"},{name:"scopeHasDataType",kind:"function",description:"True if Scope contains DataTypes",uiLabel:"Scope Has Data Type"},{name:"scopeHasOnlyBooleanDataType",kind:"function",description:"True if the Scope is DataTypes and contains only Boolean",uiLabel:"Scope Has Only Boolean Data Type"},{name:"scopeIsAll",kind:"function",description:"True if Scope is 'All'",uiLabel:"Scope Is All"},{name:"scopeIsEmpty",kind:"function",description:"True if Scope is empty",uiLabel:"Scope Is Empty"}]},SearchChangedInfo:{name:"SearchChangedInfo",kind:"Interface",description:"Deprecated Search Changed Event - use `QueryRun` or `FilterApplied` instead"},SearchOptions:{name:"SearchOptions",kind:"Interface",description:"Search options section of Adaptable Options; includes options for running some (or all) search functions on the server",properties:[{name:"clearSearchesOnStartUp",kind:"boolean",description:"Clears saved searches when AdapTable loads",uiLabel:"Clear Searches On Start Up",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"excludeColumnFromQuickSearch",kind:"function",description:"Function enabling specific Columns to be excluded from Quick Search",uiLabel:"Exclude Column From Quick Search",isOptional:!0,defaultValue:"undefined"},{name:"filterResultsAfterQuickSearch",kind:"boolean",description:"Filters the quick search results so only matching rows are displayed",uiLabel:"Filter Results After Quick Search",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"quickSearchPlaceholder",kind:"string",description:"Value to use as placeholder in QuickSearch controls (e.g. in Dashboard)",uiLabel:"Quick Search Placeholder",isOptional:!0,gridInfo:"item",defaultValue:"'Search'"}]},SelectedCellInfo:{name:"SelectedCellInfo",kind:"Interface",description:"Describes which Cells are currently selected in AdapTable",properties:[{name:"columns",kind:"array",description:"Array of Columns which have selected cells",uiLabel:"Columns"},{name:"gridCells",kind:"array",description:"Array of GridCells (which provide cell value, primary kev value and other info)",uiLabel:"Grid Cells"}]},SelectedRowInfo:{name:"SelectedRowInfo",kind:"Interface",description:"Describes which Rows are currently selected in AdapTable",properties:[{name:"gridRows",kind:"array",description:"Array of Grid Rows containing full information about a row in AdapTable",uiLabel:"Grid Rows"}]},SelectionChangedInfo:{name:"SelectionChangedInfo",kind:"Interface",description:"Event Info published by SelectionChanged event",properties:[{name:"selectedCellInfo",kind:"REFERENCE",description:"Details of cells currently selected in the Grid",uiLabel:"Selected Cell Info",reference:"SelectedCellInfo"},{name:"selectedRowInfo",kind:"REFERENCE",description:"Details of rows currently selected in the Grid",uiLabel:"Selected Row Info",reference:"SelectedRowInfo"}]},ServerReport:{name:"ServerReport",kind:"Interface",description:"Defines a Report where all the data is provided entirely by the user",properties:[{name:"name",kind:"string",description:"Name of the Report",uiLabel:"Name"},{name:"onRunReport",kind:"function",description:"Function invoked to return the data (in the form of a `ReportData` object)",uiLabel:"On Run Report"}]},SettingsPanelApi:{name:"SettingsPanelApi",kind:"Interface",description:"Provides run-time access to the Settings Panel",properties:[{name:"showCustomSettingsPanel",kind:"function",description:"Opens Settings Panel with the Custom Settings Panel, provided by name, displayed",uiLabel:"Show Custom Settings Panel"},{name:"showSettingsPanel",kind:"function",description:"Opens Settings Panel and displays specified Module (if provided) or first available one",uiLabel:"Show Settings Panel"}]},SharedEntity:{name:"SharedEntity",kind:"Interface",description:"Defines an object used in Team Sharing",properties:[{name:"ChangedAt",kind:"number",description:"Last time when the object was changed",uiLabel:"Changed At"},{name:"ChangedBy",kind:"string",description:"Last User who changed the object",uiLabel:"Changed By"},{name:"Description",kind:"string",description:"Description of object being shared",uiLabel:"Description"},{name:"Entity",kind:"REFERENCE",description:"Actual Adaptable Object being shared",uiLabel:"Entity",reference:"AdaptableObject"},{name:"EntityDependencyIds",kind:"array",description:"Ids of direct entity dependencies",uiLabel:"Entity Dependency Ids"},{name:"Module",kind:"REFERENCE",description:"Adaptable Module to which object belongs",uiLabel:"Module",reference:"AdaptableModule"},{name:"Revision",kind:"number",description:"Revision - incremental for 'Active', always 1 for 'Snapshot'",uiLabel:"Revision"},{name:"Timestamp",kind:"number",description:"When the object was shared",uiLabel:"Timestamp"},{name:"Type",kind:"REFERENCE",description:"'Snapshot' (for 1-time sharing) or 'Active' (for continuous sharing between local state & Team Share)",uiLabel:"Type",reference:"unknown"},{name:"UserName",kind:"string",description:"User who shared the object",uiLabel:"User Name"}]},SharedEntityConfig:{name:"SharedEntityConfig",kind:"Interface",description:"Describes an Object which is being Team Shared"},Shortcut:{name:"Shortcut",kind:"Interface",description:"Used to define a Shortcut as used in Shortcut State",properties:[{name:"Scope",kind:"unknown",description:"Numeric Columns where Shortcut is applied",uiLabel:"Scope"},{name:"ShortcutKey",kind:"string",description:"Key which triggers the Shortcut when pressed",uiLabel:"Shortcut Key"},{name:"ShortcutOperation",kind:"'Add' | 'Subtract' | 'Multiply' | 'Divide'",description:"The Operation: 'Add', 'Subtract', 'Multiply', 'Divide'",uiLabel:"Shortcut Operation"},{name:"ShortcutValue",kind:"number",description:"Value acting as 2nd operand for ShortcutOperation (1st operand is the cell value)",uiLabel:"Shortcut Value"}]},ShortcutApi:{name:"ShortcutApi",kind:"Interface",description:"Provides run-time access to Shortcut Module and associated state",properties:[{name:"addShortcut",kind:"function",description:"Adds new Shortcut to the state",uiLabel:"Add Shortcut"},{name:"deleteAllShortcut",kind:"function",description:"Deletes all Shortcuts in Adaptable State",uiLabel:"Delete All Shortcut"},{name:"deleteShortcut",kind:"function",description:"Deletes Shortcut from the state",uiLabel:"Delete Shortcut"},{name:"getAllActiveShortcut",kind:"function",description:"Gets all active (not-suspended) Shortcuts in Adaptable State",uiLabel:"Get All Active Shortcut"},{name:"getAllShortcut",kind:"function",description:"Gets all Shortcuts in Adaptable State",uiLabel:"Get All Shortcut"},{name:"getAllSuspendedShortcut",kind:"function",description:"Gets all suspended Shortcuts in Adaptable State",uiLabel:"Get All Suspended Shortcut"},{name:"getShortcutById",kind:"function",description:"Retrieves Shortcut by Id",uiLabel:"Get Shortcut By Id"},{name:"getShortcutState",kind:"function",description:"Retrieves Shortcut section from Adaptable State",uiLabel:"Get Shortcut State"},{name:"showShortcutPopup",kind:"function",description:"Opens Settings Panel with Shortcut section selected and visible",uiLabel:"Show Shortcut Popup"},{name:"suspendShortcut",kind:"function",description:"Suspends Shortcut definition",uiLabel:"Suspend Shortcut"},{name:"unSuspendShortcut",kind:"function",description:"Activates a suspended Shortcut definition",uiLabel:"Un Suspend Shortcut"}]},ShortcutScopeDataType:{name:"ShortcutScopeDataType",kind:"TypeAlias",description:"Shortcut scope data type."},ShortcutState:{name:"ShortcutState",kind:"Interface",description:"Predefined Configuration for Shortcut Module",properties:[{name:"Shortcuts",kind:"array",description:"Collection of Shortcuts - designed to speed up data entry",uiLabel:"Shortcuts",isOptional:!0}]},SmartEditApi:{name:"SmartEditApi",kind:"Interface",description:"Provides run-time access to the Smart Edit Module",properties:[{name:"applySmartEdit",kind:"function",description:"Applies a Smart Edit to given Cells",uiLabel:"Apply Smart Edit"},{name:"getSmartEditCustomOperations",kind:"function",description:"Retrieves an Smart Edit Custom Operations (provided in Edit Options)",uiLabel:"Get Smart Edit Custom Operations"},{name:"getSmartEditOperation",kind:"function",description:"Gets current Smart Edit Operation",uiLabel:"Get Smart Edit Operation"},{name:"getSmartEditValue",kind:"function",description:"Returns current Smart Edit Value",uiLabel:"Get Smart Edit Value"},{name:"setCustomSmartEditOperation",kind:"function",description:"Sets current Smart Edit Operation to a Custom Operation",uiLabel:"Set Custom Smart Edit Operation"},{name:"setSmartEditOperation",kind:"function",description:"Sets (shipped) Smart Edit Operation: 'Add','Subtract','Multiply','Divide'",uiLabel:"Set Smart Edit Operation"},{name:"setSmartEditValue",kind:"function",description:"Sets Smart Edit Value",uiLabel:"Set Smart Edit Value"},{name:"showSmartEditPopup",kind:"function",description:"Opens Settings Panel with Smart Edit section selected and visible",uiLabel:"Show Smart Edit Popup"}]},SmartEditCustomOperation:{name:"SmartEditCustomOperation",kind:"TypeAlias",description:"Custom Operation used in Smart Edit Module"},SmartEditOperation:{name:"SmartEditOperation",kind:"TypeAlias",description:"Operation used by Smart Edit - either System or Custom"},SmartEditOperationContext:{name:"SmartEditOperationContext",kind:"Interface",description:"Context used in Custom Smart Edit Operations",properties:[{name:"currentCell",kind:"REFERENCE",description:"Current selected grid cell - contains column, row and cell value information",uiLabel:"Current Cell",reference:"GridCell"},{name:"smartEditValue",kind:"number",description:"Smart Edit value",uiLabel:"Smart Edit Value"}]},SpecialColumnSettings:{name:"SpecialColumnSettings",kind:"Interface",description:"Base Settings for Calculated Columns and FreeText Columns",properties:[{name:"Aggregatable",kind:"boolean",description:"Whether Column can be used in an aggregation when grouping",uiLabel:"Aggregatable",isOptional:!0,defaultValue:"false"},{name:"ColumnTypes",kind:"array",description:"Custom column types to be added to AG Grid Column Types when object is created",uiLabel:"Column Types",isOptional:!0},{name:"Filterable",kind:"boolean",description:"Whether Column is filterable",uiLabel:"Filterable",isOptional:!0,defaultValue:"false"},{name:"Groupable",kind:"boolean",description:"Whether Column can be grouped",uiLabel:"Groupable",isOptional:!0,defaultValue:"false"},{name:"HeaderToolTip",kind:"string",description:"Tooltip to show in the Column Header (not cells)",uiLabel:"Header Tool Tip",isOptional:!0},{name:"Pivotable",kind:"boolean",description:"Whether Column can be used when grid is in pivot mode",uiLabel:"Pivotable",isOptional:!0,defaultValue:"false"},{name:"Resizable",kind:"boolean",description:"Whether Column can be resized (by dragging column header edges)",uiLabel:"Resizable",isOptional:!0,defaultValue:"false"},{name:"Sortable",kind:"boolean",description:"Whether Column is sortable",uiLabel:"Sortable",isOptional:!0,defaultValue:"false"},{name:"SuppressMenu",kind:"boolean",description:"Whether if no menu should be shown for this Column header.",uiLabel:"Suppress Menu",isOptional:!0,defaultValue:"false"},{name:"SuppressMovable",kind:"boolean",description:"Whether if this Column should be movable via dragging",uiLabel:"Suppress Movable",isOptional:!0,defaultValue:"false"},{name:"Width",kind:"number",description:"Preferred (pixel) Column Width; if unset, calculated dynamically by AG Grid",uiLabel:"Width",isOptional:!0}]},StateOptions:{name:"StateOptions",kind:"Interface",description:"Options related to Adaptable State hydration/dehydration - allows users to intercept state persistence and state loading with custom functionality",properties:[{name:"applyState",kind:"unknown",description:"Allows hooking into Adaptable State hydration",uiLabel:"Apply State",isOptional:!0},{name:"clearState",kind:"REFERENCE",description:"Allows clearing of remote Adaptable State",uiLabel:"Clear State",isOptional:!0,defaultValue:"undefined",reference:"AdaptableClearStateFunction"},{name:"debounceStateDelay",kind:"number",description:"Delay (in ms) to debounce `saveState` / `persistState` calls enabling grouping multiple sequential calls in single one (e.g. elevator doors)",uiLabel:"Debounce State Delay",isOptional:!0,defaultValue:"400"},{name:"loadState",kind:"REFERENCE",description:"Allows customization of Adaptable State loading",uiLabel:"Load State",isOptional:!0,reference:"AdaptableLoadStateFunction"},{name:"persistState",kind:"REFERENCE",description:"Allows customization of Adaptable State persistence",uiLabel:"Persist State",isOptional:!0,reference:"AdaptablePersistStateFunction"},{name:"saveState",kind:"REFERENCE",description:"Allows customization of Adaptable State about to be persisted",uiLabel:"Save State",isOptional:!0,reference:"AdaptableSaveStateFunction"}]},StatusBarApi:{name:"StatusBarApi",kind:"Interface",description:"Methods for managaing the Adaptable Status Bar",properties:[{name:"getAdaptableStatusBars",kind:"unknown",description:"Retrieves the current Adaptable Status Bar Panels",uiLabel:"Get Adaptable Status Bars"},{name:"getAgGridStatusPanels",kind:"function",description:"Retrieves the current AG Grid Status Bar Panels",uiLabel:"Get Ag Grid Status Panels"},{name:"setStatusBarPanels",kind:"unknown",description:"Sets the current Adaptable Status Bar Panels",uiLabel:"Set Status Bar Panels"}]},StatusBarState:{name:"StatusBarState",kind:"Interface",description:"Predefined Configuration for the Adaptable Status Bar",properties:[{name:"StatusBars",kind:"array",description:"Adaptable Status Bars to display - can be unlimited and displayed in 3 locations",uiLabel:"Status Bars",isOptional:!0,defaultValue:"null"}]},StringFormatterOptions:{name:"StringFormatterOptions",kind:"Interface",description:"Formatter Options for String Columns",properties:[{name:"Case",kind:"'Upper' | 'Lower' | 'Sentence'",description:"Sets text to Upper or Lower case",uiLabel:"Case",isOptional:!0},{name:"Prefix",kind:"string",description:"Prefix to use before the cell text",uiLabel:"Prefix",isOptional:!0},{name:"Suffix",kind:"string",description:"Suffix to use after the cell text",uiLabel:"Suffix",isOptional:!0},{name:"Trim",kind:"boolean",description:"Trims text (both start and end)",uiLabel:"Trim",isOptional:!0}]},StyledColumn:{name:"StyledColumn",kind:"Interface",description:"Object used in Special Column Style function",properties:[{name:"CheckBoxStyle",kind:"boolean",description:"Renders a Checkbox in a boolean column",uiLabel:"Check Box Style",isOptional:!0},{name:"ColumnId",kind:"string",description:"Column being styled",uiLabel:"Column Id"},{name:"GradientStyle",kind:"REFERENCE",description:"Styles a numeric column with a Gradient",uiLabel:"Gradient Style",isOptional:!0,reference:"GradientStyle"},{name:"IncludeGroupedRows",kind:"boolean",description:"Includes the Styled Column in Grouped Rows",uiLabel:"Include Grouped Rows",isOptional:!0,defaultValue:"false"},{name:"PercentBarStyle",kind:"REFERENCE",description:"Styles a numeric column so each cell displays a 'bar'",uiLabel:"Percent Bar Style",isOptional:!0,reference:"PercentBarStyle"}]},StyledColumnApi:{name:"StyledColumnApi",kind:"Interface",description:"Provides run-time access to Styled Column Module and associated state",properties:[{name:"addStyledColumn",kind:"function",description:"Create a Styled column",uiLabel:"Add Styled Column"},{name:"deleteStyledColumn",kind:"function",description:"Delete a Styled column",uiLabel:"Delete Styled Column"},{name:"findRangeForColumn",kind:"function",description:"Returns last range that matches the cell value.",uiLabel:"Find Range For Column"},{name:"fireCheckboxColumnClickedEvent",kind:"function",description:"Publishes the CheckboxColumnClickedEvent - when the checkbox in an Checkbox Column is clicked",uiLabel:"Fire Checkbox Column Clicked Event"},{name:"getActiveStyledColumnForColumn",kind:"function",description:"Returns a Styled Column for a given column",uiLabel:"Get Active Styled Column For Column"},{name:"getAllActiveStyledColumn",kind:"function",description:"Retrieves all active (not-suspended) Styled Columns in Adaptable State",uiLabel:"Get All Active Styled Column"},{name:"getAllStyledColumn",kind:"function",description:"Retrieves all Styled Columns in Adaptable State",uiLabel:"Get All Styled Column"},{name:"getAllSuspendedStyledColumn",kind:"function",description:"Retrieves all suspended Styled Columns in Adaptable State",uiLabel:"Get All Suspended Styled Column"},{name:"getCellColorRangeMaxValue",kind:"function",description:"Returns the largest number in a Range",uiLabel:"Get Cell Color Range Max Value"},{name:"getCellColorRangeMinValue",kind:"function",description:"Returns the smallest number in a Range",uiLabel:"Get Cell Color Range Min Value"},{name:"getCheckBoxStyleStyledColumn",kind:"function",description:"Returns first Styled Column that contains checkbox style",uiLabel:"Get Check Box Style Styled Column"},{name:"getColumnComparisonForStyledColumn",kind:"function",description:"Retrieves the ColumnComparison property, if there, from a Styled Column",uiLabel:"Get Column Comparison For Styled Column"},{name:"getColumnIdsFromColumnComparison",kind:"function",description:"Returns any ColumnIds referenced in a Column Comparison",uiLabel:"Get Column Ids From Column Comparison"},{name:"getNumericStyleMaxValue",kind:"function",description:"Gets the Maximum Value to display for a Styled Column",uiLabel:"Get Numeric Style Max Value"},{name:"getNumericStyleMinValue",kind:"function",description:"Gets the Minimum Value to display for a Styled Column",uiLabel:"Get Numeric Style Min Value"},{name:"getStyledColumnByColumnId",kind:"function",description:"Retrieves Styled Column by Column Id",uiLabel:"Get Styled Column By Column Id"},{name:"getStyledColumnById",kind:"function",description:"Retrieves Styled Column by Id",uiLabel:"Get Styled Column By Id"},{name:"getStyledColumnState",kind:"function",description:"Retrieves Styled Column section from Adaptable State",uiLabel:"Get Styled Column State"},{name:"hasStyledColumnRelativeCellRange",kind:"function",description:"Checks if the styled column has a range with a relative value",uiLabel:"Has Styled Column Relative Cell Range"},{name:"isCheckBoxStyleStyledColumn",kind:"function",description:"Whether given column is a (boolean) checkbox column",uiLabel:"Is Check Box Style Styled Column"}]},StyledColumnState:{name:"StyledColumnState",kind:"Interface",description:"Predefined Configuration for Styled Column Module",properties:[{name:"StyledColumns",kind:"array",description:"Collection of Special Column Styles",uiLabel:"Styled Columns",isOptional:!0}]},SuspendableObject:{name:"SuspendableObject",kind:"Interface",description:"Interface that extends Adaptable Object for those config items that can be suspended at run-time",properties:[{name:"IsSuspended",kind:"boolean",description:"Suspends (i.e. turns off) an Adaptable Object",uiLabel:"Is Suspended",isOptional:!0}]},SystemExportDestination:{name:"SystemExportDestination",kind:"TypeAlias",description:"Export Destinations provided by AdapTable"},SystemExportDestinations:{name:"SystemExportDestinations",kind:"TypeAlias",description:"List of System Export Destinations"},SystemFilterPredicateId:{name:"SystemFilterPredicateId",kind:"TypeAlias",description:"List of all the Filter Predicates shipped by AdapTable"},SystemFilterPredicateIds:{name:"SystemFilterPredicateIds",kind:"TypeAlias",description:"Array containing all System Filter Predicates"},SystemReportName:{name:"SystemReportName",kind:"TypeAlias",description:"Names of Reports provided by AdapTable"},SystemReportNames:{name:"SystemReportNames",kind:"TypeAlias",description:"Array containing all System Report names"},SystemStatusApi:{name:"SystemStatusApi",kind:"Interface",description:"Provides access to System Status Module and associated state",properties:[{name:"deleteAllSystemStatusMessages",kind:"function",description:"Deletes all System Status messages",uiLabel:"Delete All System Status Messages"},{name:"fireSystemStatusMessageDisplayedEvent",kind:"function",description:"Fires SystemStatusMessageDisplayed Event",uiLabel:"Fire System Status Message Displayed Event"},{name:"getCurrentSystemStatusMessageInfo",kind:"function",description:"Retrieves current System Status Message",uiLabel:"Get Current System Status Message Info"},{name:"setErrorSystemStatus",kind:"function",description:"Sets an **Error** System Status Message",uiLabel:"Set Error System Status"},{name:"setInfoSystemStatus",kind:"function",description:"Sets an **Info** System Status Message",uiLabel:"Set Info System Status"},{name:"setSuccessSystemStatus",kind:"function",description:"Sets a **Success** System Status Message",uiLabel:"Set Success System Status"},{name:"setSystemStatus",kind:"function",description:"Sets a new System Status message; appears in System Status toolbar, tool panel (and popup).",uiLabel:"Set System Status"},{name:"setWarningSystemStatus",kind:"function",description:"Sets a **Warning** System Status Message",uiLabel:"Set Warning System Status"},{name:"showSystemStatusPopup",kind:"function",description:"Opens Settings Panel with System Status section selected and visible",uiLabel:"Show System Status Popup"}]},SystemStatusMessageDisplayedInfo:{name:"SystemStatusMessageDisplayedInfo",kind:"Interface",description:"Object returned by the `SystemStatusMessageDisplayed` event",properties:[{name:"systemStatusMessageInfo",kind:"REFERENCE",description:"Details of the System Status Message and Type",uiLabel:"System Status Message Info",reference:"SystemStatusMessageInfo"}]},SystemStatusMessageInfo:{name:"SystemStatusMessageInfo",kind:"Interface",description:"Wraps a System Status Message",properties:[{name:"statusFurtherInformation",kind:"string",description:"Additional information to display (optional)",uiLabel:"Status Further Information",isOptional:!0},{name:"statusMessage",kind:"string",description:"The Message to be displayed",uiLabel:"Status Message"},{name:"statusType",kind:"REFERENCE",description:"Type of Message i.e. Succcess, Warning, Error, Info",uiLabel:"Status Type",reference:"AdaptableMessageType"},{name:"timestamp",kind:"date",description:"When Message was sent",uiLabel:"Timestamp",isOptional:!0}]},TeamSharingApi:{name:"TeamSharingApi",kind:"Interface",description:"Provides run-time access to Team Sharing Module and associated state",properties:[{name:"checkForUpdates",kind:"function",description:"Checks if active Shared Entities have updates (higher revisions than the local counterpart objects)",uiLabel:"Check For Updates"},{name:"fireTeamSharingEntityChangedEvent",kind:"function",description:"Fires the Team Sharing Entity Changed Event",uiLabel:"Fire Team Sharing Entity Changed Event"},{name:"getLoadedSharedEntities",kind:"function",description:"Retrieves already loaded shared entries.",uiLabel:"Get Loaded Shared Entities"},{name:"getSharedEntities",kind:"function",description:"Retrieves all shared entities which are currently shared. It is an asynchronous operation as it leverages the `TeamSharingOptions.getSharedEntities(...)` method.",uiLabel:"Get Shared Entities"},{name:"getSharedEntryDependencies",kind:"function",description:"Retrieves shared entry dependencies.",uiLabel:"Get Shared Entry Dependencies"},{name:"hasTeamSharingFullRights",kind:"function",description:"Whether current user has full Team Sharing rights (for creating & updating shared items)",uiLabel:"Has Team Sharing Full Rights"},{name:"importSharedEntry",kind:"function",description:"Import shared entry.",uiLabel:"Import Shared Entry"},{name:"isTeamSharingActivated",kind:"function",description:"Whether Team Sharing is Activated",uiLabel:"Is Team Sharing Activated"},{name:"isTeamSharingAvailable",kind:"function",description:"Whether Team Sharing is Available to use",uiLabel:"Is Team Sharing Available"},{name:"setSharedEntities",kind:"function",description:"Sets the shared entities which are currently shared. It is an asynchronous operation as it leverages the `TeamSharingOptions.setSharedEntities(...)` method.",uiLabel:"Set Shared Entities"},{name:"shareEntity",kind:"function",description:"Puts an Adaptable Object into Team Share",uiLabel:"Share Entity"},{name:"showTeamSharingPopup",kind:"function",description:"Opens Settings Panel with Team Sharing section selected and visible",uiLabel:"Show Team Sharing Popup"},{name:"triggerLoadingTeamSharingEntries",kind:"function",description:"Trigger loading of shared entries. By default shared entries are loaded when the Team Sharing popup is visible.",uiLabel:"Trigger Loading Team Sharing Entries"},{name:"unshareEntity",kind:"function",description:"Removes an Adaptable Object from the Team Share.",uiLabel:"Unshare Entity"}]},TeamSharingEntityChangedInfo:{name:"TeamSharingEntityChangedInfo",kind:"Interface",description:"EventInfo returned by TeamSharingEntityChanged event",properties:[{name:"sharedEntity",kind:"REFERENCE",description:"Object containing the Shared Entity that has changed",uiLabel:"Shared Entity",reference:"SharedEntity"}]},TeamSharingImportInfo:{name:"TeamSharingImportInfo",kind:"Interface",description:"Defines Objects which have been imported into Team Sharing"},TeamSharingOptions:{name:"TeamSharingOptions",kind:"Interface",description:"Options for managing Team Sharing - which enables Adaptable Objects to be shared between colleagues",properties:[{name:"enableTeamSharing",kind:"boolean",description:"Whether Team Sharing is enabled",uiLabel:"Enable Team Sharing",gridInfo:"item",defaultValue:"false"},{name:"getSharedEntities",kind:"unknown",description:"Async function which retrieves available Shared Entities that user can download and merge automatically with Adaptable State",uiLabel:"Get Shared Entities",defaultValue:"null"},{name:"setSharedEntities",kind:"unknown",description:"Async function which uploads Shared Entities so they can be downloaded by other members of the team",uiLabel:"Set Shared Entities",defaultValue:"null"},{name:"updateInterval",kind:"number",description:"Frequency (in minutes) to check if Active Shared Entities have a newer revision",uiLabel:"Update Interval",isOptional:!0,gridInfo:"item",defaultValue:"0 (never)"},{name:"updateNotification",kind:"'Alert' | 'AlertWithNotification' | 'SystemStatus'",description:"How user is informed when Active Shared Entities have newer revisions",uiLabel:"Update Notification",isOptional:!0,gridInfo:"item",defaultValue:"null (none)"}]},TeamSharingState:{name:"TeamSharingState",kind:"Interface",description:"State for Team Sharing; this is internal so not designed to be provided as part of Predefined Config",properties:[{name:"ActiveSharedEntityMap",kind:"unknown",description:"Mapping of active AdaptableObjects which are shared with the local state. Maps UUIDs of local AdaptableObjects to a snapshot of the latest synchronized SharedEntity",uiLabel:"Active Shared Entity Map"},{name:"importProcessInProgress",kind:"boolean",description:"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",uiLabel:"Import Process In Progress"},{name:"SharedEntities",kind:"array",description:"List of objects currently being Team Shared",uiLabel:"Shared Entities"}]},ThemeApi:{name:"ThemeApi",kind:"Interface",description:"Provides run-time access to the Theme Module and associated state",properties:[{name:"applyCurrentTheme",kind:"function",description:"Applies the Current Theme",uiLabel:"Apply Current Theme"},{name:"getAgGridCurrentThemeName",kind:"function",description:"Get the name of the current AG Grid theme",uiLabel:"Get Ag Grid Current Theme Name"},{name:"getAllSystemTheme",kind:"function",description:"Retrieves System Themes in State",uiLabel:"Get All System Theme"},{name:"getAllTheme",kind:"function",description:"Retrieves all Themes (both System User) in State",uiLabel:"Get All Theme"},{name:"getAllUserTheme",kind:"function",description:"Retrieves User Themes in State",uiLabel:"Get All User Theme"},{name:"getCurrentTheme",kind:"function",description:"Retrieves name of Current Theme",uiLabel:"Get Current Theme"},{name:"getThemeState",kind:"function",description:"Retrieves Theme section from Adaptable State",uiLabel:"Get Theme State"},{name:"loadDarkTheme",kind:"function",description:"Sets AdapTable Dark Theme - updates the AG Grid theme to match",uiLabel:"Load Dark Theme"},{name:"loadLightTheme",kind:"function",description:"Sets AdapTable Light Theme - updates the AG Grid theme to match",uiLabel:"Load Light Theme"},{name:"loadTheme",kind:"function",description:"Sets Adaptable to use a given theme",uiLabel:"Load Theme"},{name:"setSystemThemes",kind:"function",description:"Sets available System Themes; if empty array is passed none will be",uiLabel:"Set System Themes"},{name:"setUserThemes",kind:"function",description:"Sets available User Themes",uiLabel:"Set User Themes"},{name:"showThemePopup",kind:"function",description:"Opens Settings Panel with Theme section selected and visible",uiLabel:"Show Theme Popup"}]},ThemeChangedInfo:{name:"ThemeChangedInfo",kind:"Interface",description:"Object returned by the `ThemeChanged` event",properties:[{name:"theme",kind:"unknown",description:"Selected Theme: either name of a (System) theme or the (Custom) Theme itself",uiLabel:"Theme"}]},ThemeState:{name:"ThemeState",kind:"Interface",description:"Theme section of Adaptable State",properties:[{name:"CurrentTheme",kind:"unknown",description:"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",uiLabel:"Current Theme",isOptional:!0},{name:"SystemThemes",kind:"unknown",description:"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.",uiLabel:"System Themes",isOptional:!0},{name:"UserThemes",kind:"array",description:"Custom themes (of type AdaptableTheme) provided by developers",uiLabel:"User Themes",isOptional:!0}]},TOAST_POSITIONS:{name:"TOAST_POSITIONS",kind:"TypeAlias",description:"Different positions offered by Notifications"},ToolPanelApi:{name:"ToolPanelApi",kind:"Interface",description:"Functions for managing the AdapTable ToolPanel Component (at side of grid)",properties:[{name:"closeAdapTableToolPanel",kind:"function",description:"Closes the Tool Panel section (irrespective of which toolpanel is showing)",uiLabel:"Close Adap Table Tool Panel"},{name:"getCustomToolPanelButtons",kind:"function",description:"Retrieves all Custom Tool Panel Buttons defined in ToolPanelOptions",uiLabel:"Get Custom Tool Panel Buttons"},{name:"getCustomToolPanelByName",kind:"function",description:"Retrieves the CustomToolPanel with the given name (or undefined if no match is found)",uiLabel:"Get Custom Tool Panel By Name"},{name:"getCustomToolPanels",kind:"function",description:"Retrieves all Custom Tool Panels defined in ToolPanelOptions",uiLabel:"Get Custom Tool Panels"},{name:"getModuleButtons",kind:"function",description:"Sets the Module buttons from the Adaptable ToolPanel",uiLabel:"Get Module Buttons"},{name:"getToolPanelState",kind:"function",description:"Retrieves Tool Panel section from Tool Panel State",uiLabel:"Get Tool Panel State"},{name:"openAdapTableToolPanel",kind:"function",description:"Opens the Adaptable ToolPanel Component",uiLabel:"Open Adap Table Tool Panel"},{name:"setAdaptableToolPanelVisibilityMode",kind:"function",description:"Sets the given Adaptable ToolPanel with the provided visibilityMode (expanded / collapsed)",uiLabel:"Set Adaptable Tool Panel Visibility Mode"},{name:"setCustomToolPanelVisibilityMode",kind:"function",description:"Sets the Custom ToolPanel with the given name with the provided visibilityMode (expanded / collapsed)",uiLabel:"Set Custom Tool Panel Visibility Mode"},{name:"setModuleButtons",kind:"function",description:"Sets the Module buttons in the Adaptable ToolPanel",uiLabel:"Set Module Buttons"},{name:"showToolPanelPopup",kind:"function",description:"Opens Settings Panel with Tool Panel section selected and visible",uiLabel:"Show Tool Panel Popup"}]},ToolPanelButtonContext:{name:"ToolPanelButtonContext",kind:"Interface",description:"Context required by functions when using a ToolPanel Button",properties:[{name:"toolPanelState",kind:"REFERENCE",description:"Current ToolPanel State",uiLabel:"Tool Panel State",reference:"ToolPanelState"}]},ToolPanelOptions:{name:"ToolPanelOptions",kind:"Interface",description:"Options related to managing the AdapTable ToolPanel Component",properties:[{name:"customButtons",kind:"array",description:"ToolPanel Buttons provided by Users which perform custom behaviour",uiLabel:"Custom Buttons",isOptional:!0},{name:"customToolPanels",kind:"array",description:"ToolPanels provided by Users which contain custom content",uiLabel:"Custom Tool Panels",isOptional:!0},{name:"showToolPanelsDropdown",kind:"boolean",description:"Display the Tool Panels dropdown",uiLabel:"Show Tool Panels Dropdown",isOptional:!0,gridInfo:"item",defaultValue:"true"}]},ToolPanelState:{name:"ToolPanelState",kind:"Interface",description:"Predefined Configuration for the Adaptable ToolPanel",properties:[{name:"ModuleButtons",kind:"REFERENCE",description:"AdapTable Module Buttons visible in ToolPanel",uiLabel:"Module Buttons",isOptional:!0,defaultValue:"Empty Array",reference:"unknown"},{name:"ToolPanels",kind:"array",description:"Adaptable Tool Panels which are viaible",uiLabel:"Tool Panels",isOptional:!0,defaultValue:"ToolPanels for all available Modules (subject to Entitlement rules)"}]},ToolPanelVisibilityMode:{name:"ToolPanelVisibilityMode",kind:"TypeAlias",description:"Whether a ToolPanel displays as expanded or collapsed"},UnbalancedGroupsKeyContext:{name:"UnbalancedGroupsKeyContext",kind:"Interface",description:"Context used when setting a value for Unbalanced Row Groups",properties:[{name:"adaptableColumn",kind:"REFERENCE",description:"Adaptable Column being grouped",uiLabel:"Adaptable Column",reference:"AdaptableColumn"},{name:"params",kind:"REFERENCE",description:"AG Grid's Key Creator Params",uiLabel:"Params",reference:"unknown"}]},UserInterfaceApi:{name:"UserInterfaceApi",kind:"Interface",description:"Functions relating to User Interface section of Adaptable State",properties:[{name:"addColumnMenuItem",kind:"function",description:"Adds menu item to Column Menu",uiLabel:"Add Column Menu Item"},{name:"addContextMenuItem",kind:"function",description:"Adds menu item to Context Menu",uiLabel:"Add Context Menu Item"},{name:"getAdaptableObjectTags",kind:"function",description:"Retrieves any Object Tags (provided in User Interface Options)",uiLabel:"Get Adaptable Object Tags"},{name:"getAllEditLookUpItems",kind:"function",description:"Retrieves `editLookUpItems` property from User Interface Options",uiLabel:"Get All Edit Look Up Items"},{name:"getAllPermittedValuesItems",kind:"function",description:"Retrieves `permittedValues` property from User Interface Options",uiLabel:"Get All Permitted Values Items"},{name:"getBulkUpdatePermittedValuesForColumn",kind:"function",description:"Retrieves Permitted values for Bulk Update Module",uiLabel:"Get Bulk Update Permitted Values For Column"},{name:"getColorPalette",kind:"function",description:"Retrieves Color Palette currently being used",uiLabel:"Get Color Palette"},{name:"getCustomSortPermittedValuesForColumn",kind:"function",description:"Retrieves Permitted values for Custom Sort Module",uiLabel:"Get Custom Sort Permitted Values For Column"},{name:"getEditableCellStyle",kind:"function",description:"Returns Style set for Editable cells",uiLabel:"Get Editable Cell Style"},{name:"getEditLookUpItemForColumn",kind:"function",description:"Retrieves EditLookUpItems for a given Column",uiLabel:"Get Edit Look Up Item For Column"},{name:"getEditLookUpValuesForEditLookUpItem",kind:"function",description:"Retrieves actual Look Up Values from an EditLookUpItem",uiLabel:"Get Edit Look Up Values For Edit Look Up Item"},{name:"getFilterPermittedValuesForColumn",kind:"function",description:"Retrieves Permitted values for filtering by column values in Floating Filter and Quick Filter Bar",uiLabel:"Get Filter Permitted Values For Column"},{name:"getPermittedValuesForColumn",kind:"function",description:"Retrieves Permitted Values for a given Column",uiLabel:"Get Permitted Values For Column"},{name:"getReadOnlyCellStyle",kind:"function",description:"Returns Style set for ReadOnly cells",uiLabel:"Get Read Only Cell Style"},{name:"getStyleClassNames",kind:"function",description:"Retrieves any Style Class Names from User Interface Options",uiLabel:"Get Style Class Names"}]},UserInterfaceOptions:{name:"UserInterfaceOptions",kind:"Interface",description:"Options for managing the User Interface of AdapTable",properties:[{name:"applicationIcon",kind:"REFERENCE",description:"The application icon to appear in Dashboard and elsewhere (e.g. OpenFin notifications)",uiLabel:"Application Icon",isOptional:!0,defaultValue:"null",reference:"AdaptableIcon"},{name:"bulkUpdatePermittedValues",kind:"array",description:"Custom column values for editing via bulk-update; when not defined defaults to permittedValues",uiLabel:"Bulk Update Permitted Values",isOptional:!0},{name:"colorPalette",kind:"unknown",description:"Colours to display in Colour Picker (in place of AdapTable's default set); can be hardcoded list or function",uiLabel:"Color Palette",isOptional:!0},{name:"customDisplayFormatters",kind:"array",description:"Custom Formatters to use in the Format Column Module",uiLabel:"Custom Display Formatters",isOptional:!0},{name:"customSortPermittedValues",kind:"array",description:"Custom column values for defining Custom Sort; when not defined defaults to permittedValues",uiLabel:"Custom Sort Permitted Values",isOptional:!0},{name:"dateInputOptions",kind:"REFERENCE",description:"Options for managing and customizing date inputs in AdapTable",uiLabel:"Date Input Options",isOptional:!0,reference:"DateInputOptions"},{name:"editableCellStyle",kind:"REFERENCE",description:"Style to set for editable cells",uiLabel:"Editable Cell Style",isOptional:!0,reference:"AdaptableStyle"},{name:"editLookUpItems",kind:"array",description:"Dropdown values displayed when column is being edited; when not defined defaults to permittedValues",uiLabel:"Edit Look Up Items",isOptional:!0},{name:"filterPermittedValues",kind:"array",description:"Custom column values for 'IN' filter; when not defined defaults to permittedValues",uiLabel:"Filter Permitted Values",isOptional:!0},{name:"gridInfoSections",kind:"REFERENCE",description:"Which sections to show in the Grid Info Screen",uiLabel:"Grid Info Sections",isOptional:!0,defaultValue:"['GridSummary', 'AdaptableOptions', 'ColumnInfo']",reference:"unknown"},{name:"objectTags",kind:"unknown",description:"Optional list of AdaptableObjectTags that can be associated with AdaptableObjects",uiLabel:"Object Tags",isOptional:!0},{name:"permittedValues",kind:"array",description:"List of values which are permitted (e.g. to show in filter)",uiLabel:"Permitted Values",isOptional:!0},{name:"readOnlyCellStyle",kind:"REFERENCE",description:"Style to set for non-editable cells",uiLabel:"Read Only Cell Style",isOptional:!0,reference:"AdaptableStyle"},{name:"showAdapTableVersion",kind:"boolean",description:"Displays the AdapTable version in Grid Info section of Settings Panel",uiLabel:"Show Adap Table Version",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"showDocumentationLinks",kind:"boolean",description:"Provide links to AdapTable documentation (in Module popups and Expression Editor)",uiLabel:"Show Documentation Links",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"styleClassNames",kind:"array",description:"Optional list of CSS styles that can be used when creating Adaptable Styles in Adaptable (e.g. in Conditional Style, Format Column and other Modules)",uiLabel:"Style Class Names",isOptional:!0,gridInfo:"item"},{name:"useCustomMacLikeScrollbars",kind:"boolean",description:"Show Mac-like scrollbars; size is configurable via CSS variable `--ab-custom-scrollbar-size` (default: `10px`)",uiLabel:"Use Custom Mac Like Scrollbars",isOptional:!0,gridInfo:"item",defaultValue:"false"}]},UserMenuItem:{name:"UserMenuItem",kind:"Interface",description:"Menu Item which is added to Column Header or Context Menu, and can contain sub items",properties:[{name:"disabled",kind:"unknown",description:"Function to evaluate whether Menu Item is enabled",uiLabel:"Disabled",isOptional:!0},{name:"hidden",kind:"unknown",description:"Function to evaluate whether Menu Item is visible",uiLabel:"Hidden",isOptional:!0},{name:"icon",kind:"REFERENCE",description:"Optional icon to display",uiLabel:"Icon",isOptional:!0,reference:"AdaptableIcon"},{name:"label",kind:"unknown",description:"Text that will appear in the Menu Item",uiLabel:"Label"},{name:"onClick",kind:"unknown",description:"Function to invoke when the Menu Item is clicked",uiLabel:"On Click",isOptional:!0},{name:"subMenuItems",kind:"unknown",description:"Array of Menu Items, enabling limitless levels of menus",uiLabel:"Sub Menu Items",isOptional:!0}]},ValidationResult:{name:"ValidationResult",kind:"Interface",description:"Used for Server Validation ie. after an edit has been made in Adaptable which should be checked on the Server",properties:[{name:"NewValue",kind:"unknown",description:"Cell Value to use for after Server Validation",uiLabel:"New Value",isOptional:!0},{name:"ValidationMessage",kind:"string",description:"Message to diplay with validation",uiLabel:"Validation Message",isOptional:!0}]},WeightedAverageColumn:{name:"WeightedAverageColumn",kind:"Interface",description:""}};
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.ADAPTABLE_METAMODEL=void 0,exports.ADAPTABLE_METAMODEL={AccessLevel:{name:"AccessLevel",kind:"TypeAlias",description:"Defines Access Level for an Entitlement - can be `ReadOnly`, `Hidden` or `Full`"},ActionApi:{name:"ActionApi",kind:"Interface",description:"A large range of column-related functions in AdapTable",properties:[{name:"displayCloneActionRow",kind:"function",description:"Open create dialog for cloning an existing row",uiLabel:"Display Clone Action Row"},{name:"displayCreateActionRow",kind:"function",description:"Open create dialog for a new row",uiLabel:"Display Create Action Row"},{name:"displayEditActionRow",kind:"function",description:"Open edit dialog for row with the given primary key value",uiLabel:"Display Edit Action Row"},{name:"getAllActionColumn",kind:"function",description:"Retrieves any Action Columns (provided in User Interface Options)",uiLabel:"Get All Action Column"}]},ActionColumn:{name:"ActionColumn",kind:"Interface",description:"A Special Column that wraps an AdapTable Button",properties:[{name:"actionColumnButton",kind:"unknown",description:"Button (or list of buttons) to display in the Column",uiLabel:"Action Column Button"},{name:"actionColumnSettings",kind:"REFERENCE",description:"Additional optional properties for Column (e.g. filterable, resizable)",uiLabel:"Action Column Settings",isOptional:!0,reference:"ActionColumnSettings"},{name:"columnId",kind:"string",description:"Mandatory 'Id'; if no value set for `FriendlyName`, this will also be Column name",uiLabel:"Column Id"},{name:"friendlyName",kind:"string",description:"How Column appears in Column Header, Menus; if no value set, `ColumnId` is used",uiLabel:"Friendly Name",isOptional:!0},{name:"includeGroupedRows",kind:"boolean",description:"Shows Action Column also in grouped rows",uiLabel:"Include Grouped Rows",isOptional:!0}]},ActionColumnContext:{name:"ActionColumnContext",kind:"Interface",description:"Context required by functions when using an Action Column Button",properties:[{name:"actionColumn",kind:"REFERENCE",description:"Action Column in question",uiLabel:"Action Column",reference:"ActionColumn"},{name:"data",kind:"unknown",description:"The row's data",uiLabel:"Data"},{name:"primaryKeyValue",kind:"unknown",description:"Primary Key Value in current row",uiLabel:"Primary Key Value"},{name:"rowNode",kind:"REFERENCE",description:"Current AG Grid Row Node",uiLabel:"Row Node",reference:"unknown"}]},ActionColumnSettings:{name:"ActionColumnSettings",kind:"Interface",description:"Set of optional properties that define an Action Columns behaviour",properties:[{name:"resizable",kind:"boolean",description:"Whether Column can be resized (by dragging column header edges)",uiLabel:"Resizable",isOptional:!0,defaultValue:"true"},{name:"suppressMenu",kind:"boolean",description:"Whether no menu should be shown for this Column header.",uiLabel:"Suppress Menu",isOptional:!0,defaultValue:"false"},{name:"suppressMovable",kind:"boolean",description:"Whether if this Column should be movable via dragging",uiLabel:"Suppress Movable",isOptional:!0,defaultValue:"false"},{name:"width",kind:"number",description:"Preferred width (in pixels) for Column; if unset, calculated dynamically by AG Grid",uiLabel:"Width",isOptional:!0}]},ActionHandler:{name:"ActionHandler",kind:"TypeAlias",description:"Handles a Form Button Action"},ActionOptions:{name:"ActionOptions",kind:"Interface",description:"Options related to Action Columns and Buttons in Adaptable.",properties:[{name:"actionColumns",kind:"array",description:"Columns which contain an AdapTable Button - used for performing Actions",uiLabel:"Action Columns",isOptional:!0},{name:"actionRowButtonCustomConfiguration",kind:"unknown",description:"Optional custom configuration that, when specified, merges with the built-in action row button and overrides the default configuration",uiLabel:"Action Row Button Custom Configuration",isOptional:!0,defaultValue:"undefined"},{name:"actionRowButtons",kind:"array",description:"Action buttons to display for each row.",uiLabel:"Action Row Buttons",isOptional:!0,defaultValue:"undefined"},{name:"actionRowButtonsPosition",kind:"'pinnedLeft' | 'pinnedRight'",description:"Position of supplied Action Buttons",uiLabel:"Action Row Buttons Position",isOptional:!0,defaultValue:"'pinnedLeft'"},{name:"actionRowFormOptions",kind:"REFERENCE",description:"Options for managing the Form which the Action Row displays",uiLabel:"Action Row Form Options",isOptional:!0,reference:"ActionRowFormOptions"},{name:"autoHandleActionRowButtons",kind:"boolean",description:"If set to true, the Action Row Buttons will be handled by AdapTable and the grid data model will be automatically updated with the created/edited/deleted rows",uiLabel:"Auto Handle Action Row Buttons",isOptional:!0,defaultValue:"true"},{name:"setPrimaryKeyValue",kind:"function",description:"Function which is called when auto-handling the 'create' Action Row Button. The returned row value should have a valid(unique) primary key value.",uiLabel:"Set Primary Key Value",isOptional:!0,defaultValue:"undefined"}]},ActionRowContext:{name:"ActionRowContext",kind:"TypeAlias",description:"Context passed into a Row Form - can be `CreateActionRowContext` or `EditActionRowContext`"},ActionRowFormOptions:{name:"ActionRowFormOptions",kind:"Interface",description:"Options for editing (create/update/delete) row entries in the grid",properties:[{name:"formButtons",kind:"array",description:"Custom form buttons provider. If provided, the custom implementation is responsible for firing the 'ActionRowSubmitted' and/or invoking the 'onFormSubmit' callback (if necessary).",uiLabel:"Form Buttons",isOptional:!0},{name:"formDescription",kind:"unknown",description:"Custom form description provider",uiLabel:"Form Description",isOptional:!0,defaultValue:"undefined"},{name:"formFieldLabel",kind:"function",description:"Custom form field label provider",uiLabel:"Form Field Label",isOptional:!0,defaultValue:"undefined"},{name:"formTitle",kind:"unknown",description:"Custom form title provider",uiLabel:"Form Title",isOptional:!0,defaultValue:"'Create New Row'/'Edit Row'"},{name:"onFormSubmit",kind:"function",description:"Function which is invoked 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!",uiLabel:"On Form Submit",isOptional:!0,defaultValue:"undefined"}]},ActionRowSubmittedInfo:{name:"ActionRowSubmittedInfo",kind:"TypeAlias",description:"Info passed into ActionRowSubmitted Event - can be `CreatedActionRowInfo` or `EditedActionRowInfo` or `DeletedActionRowInfo`"},ActionRowType:{name:"ActionRowType",kind:"TypeAlias",description:"Type of Action Row - Created, Edited or Deleted"},AdaptableAlert:{name:"AdaptableAlert",kind:"TypeAlias",description:"Defines an Alert fired by AdapTable"},AdaptableAlertBase:{name:"AdaptableAlertBase",kind:"Interface",description:"Defines the base(common) properties of an Alert fired by AdapTable, regardless of the type of change",properties:[{name:"alertDefinition",kind:"REFERENCE",description:"Rule that caused Alert to fire",uiLabel:"Alert Definition",reference:"AlertDefinition"},{name:"alertType",kind:"unknown",description:"The type of Alert",uiLabel:"Alert Type"},{name:"header",kind:"string",description:"Alert Header text",uiLabel:"Header"},{name:"message",kind:"string",description:"Alert Body text",uiLabel:"Message"}]},AdaptableAlertQuery:{name:"AdaptableAlertQuery",kind:"TypeAlias",description:"Alert Query which may be either a Boolean, Observable or AggregatedBoolean Expression"},AdaptableApi:{name:"AdaptableApi",kind:"Interface",description:"The `AdaptableApi` provides developers with run-time access to AdapTable.",properties:[{name:"actionApi",kind:"REFERENCE",description:"Provides access to Action Rows and Columns",uiLabel:"Action Api",reference:"ActionApi"},{name:"alertApi",kind:"REFERENCE",description:"Provides access to the Alert Module",uiLabel:"Alert Api",reference:"AlertApi"},{name:"applicationApi",kind:"REFERENCE",description:"Provides access to the Application Module",uiLabel:"Application Api",reference:"ApplicationApi"},{name:"bulkUpdateApi",kind:"REFERENCE",description:"Provides access to the Bulk Update Module",uiLabel:"Bulk Update Api",reference:"BulkUpdateApi"},{name:"calculatedColumnApi",kind:"REFERENCE",description:"Provides access to the Calculated Column Module",uiLabel:"Calculated Column Api",reference:"CalculatedColumnApi"},{name:"calendarApi",kind:"REFERENCE",description:"Functions for managing Holidays",uiLabel:"Calendar Api",reference:"CalendarApi"},{name:"cellSummaryApi",kind:"REFERENCE",description:"Provides access to the Cell Summary Module",uiLabel:"Cell Summary Api",reference:"CellSummaryApi"},{name:"chartingApi",kind:"REFERENCE",description:"Provides run-time access to Charting Module and state",uiLabel:"Charting Api",reference:"ChartingApi"},{name:"columnApi",kind:"REFERENCE",description:"Provides a number of column-related methods",uiLabel:"Column Api",reference:"ColumnApi"},{name:"configApi",kind:"REFERENCE",description:"Methods giving access to Adaptable State",uiLabel:"Config Api",reference:"ConfigApi"},{name:"customSortApi",kind:"REFERENCE",description:"Provides access to the Custom Sort Module",uiLabel:"Custom Sort Api",reference:"CustomSortApi"},{name:"dashboardApi",kind:"REFERENCE",description:"Provides access to the Dashboard",uiLabel:"Dashboard Api",reference:"DashboardApi"},{name:"dataChangeHistoryApi",kind:"REFERENCE",description:"Provides run-time access to the Data Changes Module",uiLabel:"Data Change History Api",reference:"DataChangeHistoryApi"},{name:"dataSetApi",kind:"REFERENCE",description:"Provides access to Data Sets",uiLabel:"Data Set Api",reference:"DataSetApi"},{name:"destroy",kind:"unknown",description:"Cleanup method - should be called only when using the vanilla javascript component, as framework components cleanup is performed when the component is destroyed/unmounted. This destroys the Adaptable instance.",uiLabel:"Destroy"},{name:"eventApi",kind:"REFERENCE",description:"Used for listenning / subscribing to the various Events published by AdapTable",uiLabel:"Event Api",reference:"EventApi"},{name:"exportApi",kind:"REFERENCE",description:"Provides access to the Export Module and Reports",uiLabel:"Export Api",reference:"ExportApi"},{name:"filterApi",kind:"REFERENCE",description:"Provides access to AdapTable's filtering functionality",uiLabel:"Filter Api",reference:"FilterApi"},{name:"flashingCellApi",kind:"REFERENCE",description:"Provides access to the Flashing Cell Module",uiLabel:"Flashing Cell Api",reference:"FlashingCellApi"},{name:"formatColumnApi",kind:"REFERENCE",description:"Provides access to the Format Column Module",uiLabel:"Format Column Api",reference:"FormatColumnApi"},{name:"freeTextColumnApi",kind:"REFERENCE",description:"Provides access to the FreeText Column Module",uiLabel:"Free Text Column Api",reference:"FreeTextColumnApi"},{name:"gridApi",kind:"REFERENCE",description:"Provides methods for managing the Grid, and Grid data, directly",uiLabel:"Grid Api",reference:"GridApi"},{name:"internalDestroySelf",kind:"unknown",description:"Cleanup method that only cleans up this api instance (clears event listeners and sets every property to null), but does not destroy the Adaptable instance.",uiLabel:"Internal Destroy Self"},{name:"isDestroyed",kind:"unknown",description:"Whether the Adaptable instance has been destroyed",uiLabel:"Is Destroyed"},{name:"layoutApi",kind:"REFERENCE",description:"Provides access to the Layout Module",uiLabel:"Layout Api",reference:"LayoutApi"},{name:"pluginsApi",kind:"REFERENCE",description:"Offers access to AdapTable Plugin (e.g. ipushpull, OpenFin etc)",uiLabel:"Plugins Api",reference:"PluginsApi"},{name:"plusMinusApi",kind:"REFERENCE",description:"Provides access to the Plus Minus Module",uiLabel:"Plus Minus Api",reference:"PlusMinusApi"},{name:"predicateApi",kind:"REFERENCE",description:"Manages the Predicate - a boolean-return function used in Filters and Alerts",uiLabel:"Predicate Api",reference:"PredicateApi"},{name:"queryApi",kind:"REFERENCE",description:"Provides access to functions related to the Query Module",uiLabel:"Query Api",reference:"QueryApi"},{name:"queryLanguageApi",kind:"REFERENCE",description:"Mangages AdapTableQL (Query Language)",uiLabel:"Query Language Api",reference:"QueryLanguageApi"},{name:"quickSearchApi",kind:"REFERENCE",description:"Provides access to the Quick Search Module",uiLabel:"Quick Search Api",reference:"QuickSearchApi"},{name:"scheduleApi",kind:"REFERENCE",description:"Provides access to the Schedule Module",uiLabel:"Schedule Api",reference:"ScheduleApi"},{name:"scopeApi",kind:"REFERENCE",description:"Manages the `Scope` object - used widely to determine where objects are applied",uiLabel:"Scope Api",reference:"ScopeApi"},{name:"settingsPanelApi",kind:"REFERENCE",description:"Provides access to the Settings Panel",uiLabel:"Settings Panel Api",reference:"SettingsPanelApi"},{name:"shortcutApi",kind:"REFERENCE",description:"Provides access to the Shortcut Module",uiLabel:"Shortcut Api",reference:"ShortcutApi"},{name:"smartEditApi",kind:"REFERENCE",description:"Provides access to the Smart Edit Module",uiLabel:"Smart Edit Api",reference:"SmartEditApi"},{name:"statusBarApi",kind:"REFERENCE",description:"Provides run-time access to the AdapTable Status Bar",uiLabel:"Status Bar Api",reference:"StatusBarApi"},{name:"systemStatusApi",kind:"REFERENCE",description:"Methods related to displaying System Status and application health messages",uiLabel:"System Status Api",reference:"SystemStatusApi"},{name:"teamSharingApi",kind:"REFERENCE",description:"Functions related to run-time Team Sharing of AdapTable objects between colleagues",uiLabel:"Team Sharing Api",reference:"TeamSharingApi"},{name:"themeApi",kind:"REFERENCE",description:"Api methods related to Theme management",uiLabel:"Theme Api",reference:"ThemeApi"},{name:"toolPanelApi",kind:"REFERENCE",description:"Provides access to the AdapTable Tool Panel on the right hand side of the grid",uiLabel:"Tool Panel Api",reference:"ToolPanelApi"},{name:"userInterfaceApi",kind:"REFERENCE",description:"Manages User Interface Options where colours, styles and permitted values are configured",uiLabel:"User Interface Api",reference:"UserInterfaceApi"}]},AdaptableBaseIcon:{name:"AdaptableBaseIcon",kind:"Interface",description:"Base interface for AdaptableIcon",properties:[{name:"className",kind:"string",description:"The class name of the icon",uiLabel:"Class Name",isOptional:!0},{name:"style",kind:"REFERENCE",description:"CSS Properties",uiLabel:"Style",isOptional:!0,reference:"unknown"}]},AdaptableButton:{name:"AdaptableButton",kind:"Interface",description:"Defines a Button that appears in numerous places including Adaptable Form",properties:[{name:"buttonStyle",kind:"unknown",description:"Style for Button - can be object or function that provides a `ButtonStyle` object",uiLabel:"Button Style",isOptional:!0},{name:"disabled",kind:"unknown",description:"Function that disables / enables the button based on its evaluation result",uiLabel:"Disabled",isOptional:!0},{name:"hidden",kind:"unknown",description:"Function which sets whether Button is hidden",uiLabel:"Hidden",isOptional:!0},{name:"icon",kind:"unknown",description:"Icon for Button - can be object or function that provides a `AdaptableIcon` object",uiLabel:"Icon",isOptional:!0},{name:"label",kind:"unknown",description:"Label for Button - can be string or function that provides string",uiLabel:"Label",isOptional:!0},{name:"onClick",kind:"unknown",description:"Function to invoke when button is clicked",uiLabel:"On Click",isOptional:!0},{name:"tooltip",kind:"unknown",description:"Tooltip for Button - can be string or function that provides string",uiLabel:"Tooltip",isOptional:!0}]},AdaptableCalculatedColumnQuery:{name:"AdaptableCalculatedColumnQuery",kind:"TypeAlias",description:"Calculated Column Query which may be a Scalar or an AggregatedScalar Expression"},AdaptableCellChangedAlert:{name:"AdaptableCellChangedAlert",kind:"Interface",description:"Defines an Alert fired by AdapTable when a cell is changed",properties:[{name:"cellDataChangedInfo",kind:"REFERENCE",description:"Cell DataChange which triggered Alert",uiLabel:"Cell Data Changed Info",reference:"CellDataChangedInfo"}]},AdaptableClearStateFunction:{name:"AdaptableClearStateFunction",kind:"Interface",description:"Allows clearing state when a custom persistState is used. Only called by configApi.reloadPredefinedConfig"},AdaptableColumn:{name:"AdaptableColumn",kind:"Interface",description:"Defines an Adaptable Column - created at run-time based on AG Grid column definition",properties:[{name:"aggregatable",kind:"boolean",description:"Is Column able to display aggregations (e.g. 'sum') when grouped",uiLabel:"Aggregatable"},{name:"aggregationFunction",kind:"string",description:"Custom aggregation function for the Column",uiLabel:"Aggregation Function",isOptional:!0},{name:"availableAggregationFunctions",kind:"array",description:"Available aggregations for the Column",uiLabel:"Available Aggregation Functions",isOptional:!0},{name:"columnGroup",kind:"REFERENCE",description:"The parent column group, if the column belongs to one",uiLabel:"Column Group",isOptional:!0,reference:"unknown"},{name:"field",kind:"string",description:"Is the field of the row to get the cell data from",uiLabel:"Field",isOptional:!0},{name:"filterable",kind:"boolean",description:"Is Column able to be filtered",uiLabel:"Filterable"},{name:"flex",kind:"number",description:"Flex details of the column",uiLabel:"Flex",isOptional:!0},{name:"groupable",kind:"boolean",description:"Can Column form a Row Group",uiLabel:"Groupable"},{name:"hideable",kind:"boolean",description:"Can Column be removed from the grid",uiLabel:"Hideable"},{name:"isExcludedFromQuickSearch",kind:"boolean",description:"Has colummn been excluded from Quick Search results",uiLabel:"Is Excluded From Quick Search"},{name:"isFixed",kind:"boolean",description:"Is Column pinned or locked into position",uiLabel:"Is Fixed"},{name:"isGrouped",kind:"boolean",description:"Is Column currently grouped",uiLabel:"Is Grouped"},{name:"isPrimaryKey",kind:"boolean",description:"Is this the Primary Key column",uiLabel:"Is Primary Key"},{name:"isSparkline",kind:"boolean",description:"Is it a Sparkline Column",uiLabel:"Is Sparkline"},{name:"moveable",kind:"boolean",description:"Can Column be moved at run-time to a new position",uiLabel:"Moveable"},{name:"pinned",kind:"'left' | 'right' | false",description:"The pinned position of the column",uiLabel:"Pinned"},{name:"pivotable",kind:"boolean",description:"Can Column be used in a Pivot Grid",uiLabel:"Pivotable"},{name:"queryable",kind:"boolean",description:"Can the Column be in included in Queries / Expressions",uiLabel:"Queryable"},{name:"readOnly",kind:"boolean",description:"Is the column editable; returns FALSE if the column has conditional/dynamic editability, assuming some rows are editable",uiLabel:"Read Only"},{name:"sortable",kind:"boolean",description:"Is Column sortable",uiLabel:"Sortable"},{name:"visible",kind:"boolean",description:"Is Column currently visible",uiLabel:"Visible"},{name:"width",kind:"number",description:"Column width",uiLabel:"Width",isOptional:!0}]},AdaptableColumnBase:{name:"AdaptableColumnBase",kind:"Interface",description:"Base class for Adaptable Column containing most important properties",properties:[{name:"columnId",kind:"string",description:"Name of Column in AG Grid (e.g. field or colId)",uiLabel:"Column Id"},{name:"dataType",kind:"REFERENCE",description:"DataType of the column",uiLabel:"Data Type",reference:"AdaptableColumnDataType"},{name:"friendlyName",kind:"string",description:"How Column is referred to in Adaptable UI; `Caption` property in AG Grid",uiLabel:"Friendly Name"}]},AdaptableColumnDataType:{name:"AdaptableColumnDataType",kind:"TypeAlias",description:"Type of data stored in an Adaptable Column"},AdaptableComparerFunction:{name:"AdaptableComparerFunction",kind:"TypeAlias",description:"Standard comparer function used to evaluate custom sorts, returns -1, 0, 1 as required"},AdaptableCoordinate:{name:"AdaptableCoordinate",kind:"Interface",description:"Used by AdapTable to remember position of Floating Dashboard",properties:[{name:"x",kind:"number",description:"x axis number",uiLabel:"X"},{name:"y",kind:"number",description:"y axis number",uiLabel:"Y"}]},AdaptableDashboardToolbar:{name:"AdaptableDashboardToolbar",kind:"TypeAlias",description:"List of all the Toolbars that Adaptable provides"},AdaptableDataChangeHistoryAction:{name:"AdaptableDataChangeHistoryAction",kind:"TypeAlias",description:"Built in `undo` data change action"},AdaptableElementIcon:{name:"AdaptableElementIcon",kind:"Interface",description:"Defines an icon as a provided DOM element or HTML string",properties:[{name:"element",kind:"unknown",description:"The icon to display, either a DOM element or HTML string",uiLabel:"Element"}]},AdaptableExternalIcon:{name:"AdaptableExternalIcon",kind:"Interface",description:"Defines an icon from an external source",properties:[{name:"src",kind:"string",description:"The URL of the icon to use",uiLabel:"Src"}]},AdaptableFDC3EventInfo:{name:"AdaptableFDC3EventInfo",kind:"Interface",description:"EventInfo returned by `FDC3MessageSent` event",properties:[{name:"context",kind:"REFERENCE",description:"Full FDC3 Context for the object related to the event",uiLabel:"Context",reference:"FDC3Context"},{name:"eventType",kind:"'RaiseIntent' | 'BroadcastMessage'",description:"Type of Event: `RaiseIntent` or `BroadcastMessage`",uiLabel:"Event Type"},{name:"intent",kind:"unknown",description:"The FDC3 Intent which caused Event to fire (if type is `RaiseIntent`)",uiLabel:"Intent",isOptional:!0}]},AdaptableFlashingCell:{name:"AdaptableFlashingCell",kind:"Interface",description:"Defines an Alert fired by AdapTable",properties:[{name:"cellDataChangedInfo",kind:"REFERENCE",description:"Data change which triggered the FlashingCell",uiLabel:"Cell Data Changed Info",isOptional:!0,reference:"CellDataChangedInfo"},{name:"direction",kind:"'up' | 'down' | 'neutral'",description:"Direction of the change: 'up', 'down' or 'neutral'",uiLabel:"Direction"},{name:"flashColumnIds",kind:"unknown",description:"Column Ids that are flashing",uiLabel:"Flash Column Ids"},{name:"flashingCellDefinition",kind:"REFERENCE",description:"Rule that caused the FlashingCell to fire",uiLabel:"Flashing Cell Definition",reference:"FlashingCellDefinition"},{name:"flashTarget",kind:"unknown",description:"What will flash (e.g. Cell, Row)",uiLabel:"Flash Target"},{name:"rowPrimaryKey",kind:"string",description:"Primary Key Value of Row which is flashing",uiLabel:"Row Primary Key"}]},AdaptableForm:{name:"AdaptableForm",kind:"Interface",description:"Defines a form which appears dynamically; used by Alerts & Export Custom Destinations",properties:[{name:"buttons",kind:"array",description:"Buttons to include in the Form",uiLabel:"Buttons",isOptional:!0},{name:"description",kind:"string",description:"Additional information to appear in the Form",uiLabel:"Description",isOptional:!0},{name:"fields",kind:"unknown",description:"Collection of Dynamic Fields to display",uiLabel:"Fields",isOptional:!0},{name:"title",kind:"string",description:"Title to appear in the Form",uiLabel:"Title",isOptional:!0}]},AdaptableFormat:{name:"AdaptableFormat",kind:"TypeAlias",description:"Object containing formatting information for Numeric and Date Columns"},AdaptableFormField:{name:"AdaptableFormField",kind:"Interface",description:"Defines a Field that appears in an Adaptable Form",properties:[{name:"defaultValue",kind:"string | boolean | number",description:"Field Default Value - can be of type string, boolean, number",uiLabel:"Default Value",isOptional:!0},{name:"fieldType",kind:"REFERENCE",description:"Field Type: text, date, number, checkbox, select, textOutput",uiLabel:"Field Type",reference:"unknown"},{name:"label",kind:"string",description:"Label to display in the Field",uiLabel:"Label"},{name:"name",kind:"string",description:"Name of the Field",uiLabel:"Name"},{name:"options",kind:"unknown",description:"Items to populate the Select input",uiLabel:"Options",isOptional:!0}]},AdaptableIcon:{name:"AdaptableIcon",kind:"TypeAlias",description:"Defines an icon to be used in AdapTable (e.g. in Dashboard Header, Buttons, Menu, etc.)"},AdaptableInternalIcon:{name:"AdaptableInternalIcon",kind:"Interface",description:"Defines an icon from the internal AdapTable icon set",properties:[{name:"name",kind:"REFERENCE",description:"The name of the icon to use (referencing the AdapTable Icon Library)",uiLabel:"Name",reference:"AdaptableInternalIconName"},{name:"size",kind:"number",description:"The size (in pixels) of the SVG icon (defaults to `17px`)",uiLabel:"Size",isOptional:!0}]},AdaptableInternalIconName:{name:"AdaptableInternalIconName",kind:"TypeAlias",description:"All AdapTable internal icon names"},AdaptableLoadStateFunction:{name:"AdaptableLoadStateFunction",kind:"Interface",description:"Allows customization of state loading - used by `loadState` function in StateOptions"},AdaptableMenuItem:{name:"AdaptableMenuItem",kind:"Interface",description:"Menu item used by Adaptable in both Column and Context Menus",properties:[{name:"icon",kind:"REFERENCE",description:"Icon to display in Menu Item",uiLabel:"Icon",isOptional:!0,reference:"AdaptableIcon"},{name:"isVisible",kind:"boolean",description:"Whether menu item is visible",uiLabel:"Is Visible"},{name:"label",kind:"string",description:"Name that appears in the menu",uiLabel:"Label"},{name:"module",kind:"unknown",description:"Adaptable Module associated with (Adaptable) menu item.",uiLabel:"Module",isOptional:!0},{name:"onClick",kind:"unknown",description:"Function to invoke when (custom) menu item is clicked",uiLabel:"On Click",isOptional:!0},{name:"reduxAction",kind:"unknown",description:"Adaptable Redux Action to invoke when (Adaptable) menu item is clicked",uiLabel:"Redux Action",isOptional:!0},{name:"subItems",kind:"array",description:"Sub Menu Items to display",uiLabel:"Sub Items",isOptional:!0}]},AdaptableMessageType:{name:"AdaptableMessageType",kind:"TypeAlias",description:"Defines a Message Types: 'Success', 'Info', 'Warning' or 'Error'"},AdaptableModule:{name:"AdaptableModule",kind:"TypeAlias",description:"Modules provided by AdapTable, subject to Entitlements and usually have Predefined Config"},AdaptableObject:{name:"AdaptableObject",kind:"Interface",description:"Base interface which all other Adaptable State-related objects extend",properties:[{name:"IsReadOnly",kind:"boolean",description:"Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')",uiLabel:"Is Read Only",isOptional:!0},{name:"Source",kind:"'Config' | 'User'",description:"Source of state object: 'Config' if provided via `AdaptableOptions.predefinedConfig`, 'User' or undefined for runtime state.",uiLabel:"Source",isOptional:!0},{name:"Tags",kind:"array",description:"List of Tags associated with the Object; often used for (but not limited to) managing Layout object scope",uiLabel:"Tags",isOptional:!0},{name:"Uuid",kind:"REFERENCE",description:"Unique identifier for the Adaptable Object, generated and used internally by AdapTable",uiLabel:"Uuid",isOptional:!0,reference:"unknown"}]},AdaptableObjectTag:{name:"AdaptableObjectTag",kind:"TypeAlias",description:"AdaptableObjectTag Object Tague - currently supporting only plain string values, but open for future extensions, if ever needed."},AdaptableOptions:{name:"AdaptableOptions",kind:"Interface",description:"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",properties:[{name:"actionOptions",kind:"REFERENCE",description:"Options for managing Action Columns and Action Rows",uiLabel:"Action Options",isOptional:!0,reference:"ActionOptions"},{name:"adaptableId",kind:"string",description:"Identifier for this instance of AdapTable",uiLabel:"Adaptable Id",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"'adaptable_id'"},{name:"adaptableQLOptions",kind:"REFERENCE",description:"Options for managing AdapTableQL",uiLabel:"Adaptable QL Options",isOptional:!0,reference:"AdaptableQLOptions"},{name:"adaptableStateKey",kind:"string",description:"Identifier used as localStorage persistence key for AdaptableState",uiLabel:"Adaptable State Key",isOptional:!0,gridInfo:"item",defaultValue:"`adaptableId` value"},{name:"alertOptions",kind:"REFERENCE",description:"Options for managing Alerts in AdapTable",uiLabel:"Alert Options",isOptional:!0,gridInfo:"container",reference:"AlertOptions"},{name:"autogeneratePrimaryKey",kind:"boolean",description:"Will autogenerate a Primary Key; only use as a last resort if no unique column is available, as limits some Adaptable functionalities",uiLabel:"Autogenerate Primary Key",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"columnOptions",kind:"REFERENCE",description:"Options for managing Columns",uiLabel:"Column Options",isOptional:!0,reference:"ColumnOptions"},{name:"containerOptions",kind:"REFERENCE",description:"Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed",uiLabel:"Container Options",isOptional:!0,reference:"ContainerOptions"},{name:"dashboardOptions",kind:"REFERENCE",description:"Options related to managing the Dashboard in AdapTable",uiLabel:"Dashboard Options",isOptional:!0,gridInfo:"container",reference:"DashboardOptions"},{name:"dataChangeHistoryOptions",kind:"REFERENCE",description:"Options to manage Data Change History Module which provides an overview of all data changes",uiLabel:"Data Change History Options",isOptional:!0,gridInfo:"container",reference:"DataChangeHistoryOptions"},{name:"editOptions",kind:"REFERENCE",description:"Options related to Editing in AdapTable including Server Validation",uiLabel:"Edit Options",isOptional:!0,gridInfo:"container",reference:"EditOptions"},{name:"entitlementOptions",kind:"REFERENCE",description:"Options for managing Entitlements",uiLabel:"Entitlement Options",isOptional:!0,gridInfo:"container",reference:"EntitlementOptions"},{name:"exportOptions",kind:"REFERENCE",description:"Options for managing Exporting and Reports in AdapTable",uiLabel:"Export Options",isOptional:!0,gridInfo:"container",reference:"ExportOptions"},{name:"filterOptions",kind:"REFERENCE",description:"Options for managing Filtering in AdapTable",uiLabel:"Filter Options",isOptional:!0,gridInfo:"container",reference:"FilterOptions"},{name:"flashingCellOptions",kind:"REFERENCE",description:"Options for managing Flashing Cells - primarily default values",uiLabel:"Flashing Cell Options",isOptional:!0,gridInfo:"container",reference:"FlashingCellOptions"},{name:"generalOptions",kind:"REFERENCE",description:"General options to manage AdapTable e.g. grouping behaviour, Primary Keys",uiLabel:"General Options",isOptional:!0,gridInfo:"container",reference:"GeneralOptions"},{name:"gridOptions",kind:"REFERENCE",description:"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",uiLabel:"Grid Options",isOptional:!0,reference:"unknown"},{name:"layoutOptions",kind:"REFERENCE",description:"Options related to Layouts",uiLabel:"Layout Options",isOptional:!0,gridInfo:"container",reference:"LayoutOptions"},{name:"licenseKey",kind:"string",description:"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.",uiLabel:"License Key",isOptional:!0},{name:"menuOptions",kind:"REFERENCE",description:"Options for managing AdapTable menus",uiLabel:"Menu Options",isOptional:!0,gridInfo:"container",reference:"MenuOptions"},{name:"notificationsOptions",kind:"REFERENCE",description:"Options for managing Notifications in AdapTable",uiLabel:"Notifications Options",isOptional:!0,gridInfo:"container",reference:"NotificationsOptions"},{name:"plugins",kind:"array",description:"Used for managing the AdapTable Plugins",uiLabel:"Plugins",isOptional:!0},{name:"predefinedConfig",kind:"unknown",description:"User State set at design-time and shipped with AdapTable for first use; can be `PredefinedConfig` object or url to file containing config",uiLabel:"Predefined Config",isOptional:!0,defaultValue:"undefined"},{name:"primaryKey",kind:"string",description:"Name of Column in AdapTable guaranteed to contain unique values",uiLabel:"Primary Key",gridInfo:"item",defaultValue:"n/a (Mandatory)"},{name:"searchOptions",kind:"REFERENCE",description:"Options for managing Search related functions in AdapTable",uiLabel:"Search Options",isOptional:!0,gridInfo:"container",reference:"SearchOptions"},{name:"settingsPanelOptions",kind:"REFERENCE",description:"Setting panel options",uiLabel:"Settings Panel Options",isOptional:!0,gridInfo:"container",reference:"unknown"},{name:"stateOptions",kind:"REFERENCE",description:"Options related to state hydration / dehydration - allows users to intercept state persistence and state loading and change default behaviour of saving to local storage",uiLabel:"State Options",isOptional:!0,reference:"StateOptions"},{name:"teamSharingOptions",kind:"REFERENCE",description:"Options for managing 'Team Sharing' which allows users to create Adaptable Objects and share with colleagues",uiLabel:"Team Sharing Options",isOptional:!0,gridInfo:"container",reference:"TeamSharingOptions"},{name:"toolPanelOptions",kind:"REFERENCE",description:"Options related to managing the Tool Panel elements in AdapTable",uiLabel:"Tool Panel Options",isOptional:!0,gridInfo:"container",reference:"ToolPanelOptions"},{name:"userInterfaceOptions",kind:"REFERENCE",description:"Options for managing the User Interface elements of AdapTable, i.e. Action Columns, Color Palette etc.",uiLabel:"User Interface Options",isOptional:!0,gridInfo:"container",reference:"UserInterfaceOptions"},{name:"userName",kind:"string",description:"Name of current AdapTable user",uiLabel:"User Name",isOptional:!0,gridInfo:"item",defaultValue:"'anonymous'"}]},AdaptablePersistentState:{name:"AdaptablePersistentState",kind:"Interface",description:"The state object of Adaptable which is persisted"},AdaptablePersistStateFunction:{name:"AdaptablePersistStateFunction",kind:"Interface",description:"Allows customization of state persistence - used `persistState` function in StateOptions"},AdaptablePredicate:{name:"AdaptablePredicate",kind:"Interface",description:"Predicate object used by AdapTableQL - essentially a boolean function",properties:[{name:"Inputs",kind:"array",description:"Optional Inputs that might be needed for evaluation",uiLabel:"Inputs",isOptional:!0},{name:"PredicateId",kind:"string",description:"Id of Predicate (e.g. `Equals`, `GreaterThan`)",uiLabel:"Predicate Id"}]},AdaptablePredicateDef:{name:"AdaptablePredicateDef",kind:"Interface",description:"Defines a Predicate - include where it can run and what it does",properties:[{name:"columnScope",kind:"REFERENCE",description:"Columns (or DataTypes) where Predicate is active",uiLabel:"Column Scope",reference:"AdaptableScope"},{name:"handler",kind:"function",description:"Actual boolean function invoked when evaluating the Predicate",uiLabel:"Handler"},{name:"icon",kind:"unknown",description:"Icon to show (primarily used in Filter dropdown)",uiLabel:"Icon",isOptional:!0},{name:"id",kind:"string",description:"Unique Id for the object",uiLabel:"Id"},{name:"inputs",kind:"array",description:"Inputs the Predicate can take",uiLabel:"Inputs",isOptional:!0},{name:"label",kind:"string",description:"Name of the Predicate",uiLabel:"Label"},{name:"moduleScope",kind:"array",description:"Modules where the Predicate can run",uiLabel:"Module Scope"},{name:"onlyQuickFilter",kind:"boolean",description:"Display this predicate only in Quick Filter Bar (and NOT in Filter Form)",uiLabel:"Only Quick Filter",isOptional:!0},{name:"shortcuts",kind:"array",description:"Keyboard shortcuts to initiate predicate - used in Quick Filter bar",uiLabel:"Shortcuts",isOptional:!0},{name:"toString",kind:"function",description:"String representation of the Predicate",uiLabel:"To String",isOptional:!0}]},AdaptableQLOptions:{name:"AdaptableQLOptions",kind:"Interface",description:"Options for managing AdaptableQL - the Adaptable Query Language which evaluates Predicates and Expressions",properties:[{name:"caseSensitiveTextComparisons",kind:"boolean",description:"Perform case-sensitive text comparisons in all search and filter operations: QuickSearch, Filters, Query, Predicates",uiLabel:"Case Sensitive Text Comparisons",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"false"},{name:"customPredicateDefs",kind:"array",description:"Definitions for Custom provided Predicates",uiLabel:"Custom Predicate Defs",isOptional:!0},{name:"displayColumnFriendlyNamesForExpressions",kind:"boolean",description:"Reference a Column's Header (FriendlyName) in all Expression overviews (instead of ColumnId)",uiLabel:"Display Column Friendly Names For Expressions",isOptional:!0,defaultValue:"true"},{name:"evaluateAdaptableQLExternally",kind:"function",description:"Whether a specific expression (or all expressions in a given module) must be evaluated on the server",uiLabel:"Evaluate Adaptable QL Externally",isOptional:!0},{name:"expressionOptions",kind:"REFERENCE",description:"Options for managing Expressions in AdaptableQL",uiLabel:"Expression Options",isOptional:!0,reference:"ExpressionOptions"},{name:"externallyEvaluatedModules",kind:"REFERENCE",description:"Which searching and filtering Modules should take place on server",uiLabel:"Externally Evaluated Modules",isOptional:!0,gridInfo:"item",defaultValue:"undefined",reference:"unknown"}]},AdaptableQuery:{name:"AdaptableQuery",kind:"TypeAlias",description:"An AdaptableQuery can be either a Boolean, Scalar, Observable, AggregatedBoolean, or AggregatedScalar expression"},AdaptableReadyInfo:{name:"AdaptableReadyInfo",kind:"Interface",description:"Object returned by `AdaptableReady` event - fired when AdapTable has loaded",properties:[{name:"gridOptions",kind:"REFERENCE",description:"Underlying AG Grid GridOptions object",uiLabel:"Grid Options",reference:"unknown"}]},AdaptableRowChangedAlert:{name:"AdaptableRowChangedAlert",kind:"Interface",description:"Defines an Alert fired by AdapTable when a row is changed",properties:[{name:"gridDataChangedInfo",kind:"REFERENCE",description:"Row DataChange which triggered Alert",uiLabel:"Grid Data Changed Info",reference:"GridDataChangedInfo"}]},AdaptableSaveStateFunction:{name:"AdaptableSaveStateFunction",kind:"Interface",description:"Allows the customization state persistence - used by `saveState` function in StateOptions"},AdaptableScope:{name:"AdaptableScope",kind:"TypeAlias",description:"Defines where a given Object / Module is active"},AdaptableSearchState:{name:"AdaptableSearchState",kind:"Interface",description:"Current Searches and Filter in AdapTable",properties:[{name:"columnFilters",kind:"unknown",description:"Currently applied Column Filters",uiLabel:"Column Filters"},{name:"currentQuery",kind:"string | undefined",description:"Current Query",uiLabel:"Current Query"},{name:"dataSet",kind:"unknown",description:"Current DataSet (if one selected)",uiLabel:"Data Set"},{name:"queryAST",kind:"unknown",description:"AST for Current Query",uiLabel:"Query AST"}]},AdaptableSortState:{name:"AdaptableSortState",kind:"Interface",description:"Overview of current sorting state in the grid",properties:[{name:"columnSorts",kind:"array",description:"Which columns have sorting applied and,if so, which direction",uiLabel:"Column Sorts"},{name:"customSorts",kind:"array",description:"All the Custom Sorts in State; this is always sent even if no custom sorts are active",uiLabel:"Custom Sorts"}]},AdaptableState:{name:"AdaptableState",kind:"Interface",description:"The main state object of Adaptable"},AdaptableStateChangedInfo:{name:"AdaptableStateChangedInfo",kind:"Interface",description:"Object returned by the `AdaptableStateChanged` event",properties:[{name:"action",kind:"unknown",description:"The Redux Action that was invoked",uiLabel:"Action"},{name:"actionName",kind:"string",description:"Name of the Action",uiLabel:"Action Name"},{name:"adaptableId",kind:"string",description:"Current AdapTableId",uiLabel:"Adaptable Id"},{name:"adaptableStateKey",kind:"string",description:"Current Adaptable State Key",uiLabel:"Adaptable State Key"},{name:"clientTimestamp",kind:"date",description:"Time on user's computer when message was sent",uiLabel:"Client Timestamp"},{name:"newState",kind:"REFERENCE",description:"Adaptable State after the Action",uiLabel:"New State",reference:"AdaptableState"},{name:"oldState",kind:"REFERENCE",description:"Adaptable State before the Action",uiLabel:"Old State",reference:"AdaptableState"},{name:"userName",kind:"string",description:"Name of current AdapTable user",uiLabel:"User Name"}]},AdaptableStateFunctionConfig:{name:"AdaptableStateFunctionConfig",kind:"Interface",description:"State Function Config object passed into all State Options functions (except 'applyState')",properties:[{name:"adaptableId",kind:"string",description:"Id of current Adaptable instance",uiLabel:"Adaptable Id"},{name:"adaptableStateKey",kind:"string",description:"State Key being used",uiLabel:"Adaptable State Key"},{name:"url",kind:"string",description:"",uiLabel:"Url",isOptional:!0},{name:"userName",kind:"string",description:"current Adaptable user",uiLabel:"User Name"}]},AdaptableStateReloadedInfo:{name:"AdaptableStateReloadedInfo",kind:"Interface",description:"Object returned by the `AdaptableStateReloaded` event",properties:[{name:"adaptableId",kind:"string",description:"Current AdapTableId",uiLabel:"Adaptable Id"},{name:"adaptableStateKey",kind:"string",description:"Current Adaptable State Key",uiLabel:"Adaptable State Key"},{name:"newState",kind:"REFERENCE",description:"Adaptable State after the reload",uiLabel:"New State",reference:"AdaptablePersistentState"},{name:"oldState",kind:"REFERENCE",description:"Adaptable State before the reload",uiLabel:"Old State",reference:"AdaptablePersistentState"}]},AdaptableStatusBar:{name:"AdaptableStatusBar",kind:"Interface",description:"Defines an Adaptable Status Bar",properties:[{name:"Key",kind:"string",description:"Key of Status Bar Panel defined in AG Grid GridOptions - ensure keys are the same (Note: AG Grid statusPanel has a lowercase 'key')",uiLabel:"Key"},{name:"StatusBarPanels",kind:"array",description:"Module Status Panels to render inside Adaptable Status Bar",uiLabel:"Status Bar Panels",isOptional:!0}]},AdaptableStyle:{name:"AdaptableStyle",kind:"Interface",description:"Style object used in numerous AdapTable Modules",properties:[{name:"BackColor",kind:"string",description:"Colour background of cell: provide hex value or name",uiLabel:"Back Color",isOptional:!0},{name:"BorderColor",kind:"string",description:"Colour of cell border: provide hex value or name",uiLabel:"Border Color",isOptional:!0},{name:"ClassName",kind:"string",description:"Existing CSS Class; use instead of setting other object properties",uiLabel:"Class Name",isOptional:!0},{name:"FontSize",kind:"'XSmall' | 'Small' | 'Medium' | 'Large' | 'XLarge'",description:"Size of font: `XSmall`, `Small`, `Medium`, `Large` or `XLarge`",uiLabel:"Font Size",isOptional:!0},{name:"FontStyle",kind:"'Normal' | 'Italic'",description:"Style of font: `Normal` or `Italic`",uiLabel:"Font Style",isOptional:!0},{name:"FontWeight",kind:"'Normal' | 'Bold'",description:"Weight of font: `Normal` or `Bold`",uiLabel:"Font Weight",isOptional:!0},{name:"ForeColor",kind:"string",description:"Font colour in cell: provide hex value or name",uiLabel:"Fore Color",isOptional:!0}]},AdaptableTheme:{name:"AdaptableTheme",kind:"Interface",description:"Used for creating User (i.e. Custom) Themes",properties:[{name:"AgGridClassName",kind:"string",description:"Ag Grid theme to apply when loading theme",uiLabel:"Ag Grid Class Name",isOptional:!0},{name:"Description",kind:"string",description:"Description of Theme - will appear in Theme Toolbar and Toolpanel",uiLabel:"Description"},{name:"Name",kind:"string",description:"Name of the Theme",uiLabel:"Name"},{name:"VendorGridClassName",kind:"string",description:"deprecated use `AgGridClassName` property instead",uiLabel:"Vendor Grid Class Name",isOptional:!0}]},AdaptableToolPanelDefinition:{name:"AdaptableToolPanelDefinition",kind:"Interface",description:"Defines a ToolPanel - Name and VisibilityMode (Expanded / Collapsed)",properties:[{name:"Name",kind:"unknown",description:"ToolPanel name - either an Adaptable Module or a Custom ToolPanel (defined in ToolPanel Options)",uiLabel:"Name"},{name:"VisibilityMode",kind:"'expanded' | 'collapsed'",description:"Whether the ToolPanel is 'expanded' or 'collapsed'",uiLabel:"Visibility Mode",isOptional:!0,defaultValue:"'collapsed'"}]},AggregatedBooleanFunctionName:{name:"AggregatedBooleanFunctionName",kind:"TypeAlias",description:"List of all the Aggregation Functions available in AdaptableQL"},AggregatedScalarFunctionName:{name:"AggregatedScalarFunctionName",kind:"TypeAlias",description:"List of all the AggregatedScalar Functions available in AdaptableQL"},AlertApi:{name:"AlertApi",kind:"Interface",description:"Provides run-time access to Alert function and associated State",properties:[{name:"addAlertDefinition",kind:"function",description:"Adds new Alert Definition",uiLabel:"Add Alert Definition"},{name:"displayAlert",kind:"function",description:"Displays (fully formed) inputted Alert to the User",uiLabel:"Display Alert"},{name:"displayMessageAlertPopup",kind:"function",description:"Displays given Alert as a Popup",uiLabel:"Display Message Alert Popup"},{name:"editAlertDefinition",kind:"function",description:"Edits Alert in State with given one",uiLabel:"Edit Alert Definition"},{name:"executeAlertAction",kind:"function",description:"Runs after an Alert Action is invoked",uiLabel:"Execute Alert Action"},{name:"executeAlertButton",kind:"function",description:"Runs after a button in an Alert Form is clicked",uiLabel:"Execute Alert Button"},{name:"getActiveNonReactiveAlertDefinitions",kind:"function",description:"Retrieves all active (non-suspended) Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)",uiLabel:"Get Active Non Reactive Alert Definitions"},{name:"getActiveReactiveAlertDefinitions",kind:"function",description:"Retrieves all active (non-suspended) Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)",uiLabel:"Get Active Reactive Alert Definitions"},{name:"getAdaptableFormByName",kind:"function",description:"Retrieeves the Adaptable Form with the given name",uiLabel:"Get Adaptable Form By Name"},{name:"getAlertDefinitionById",kind:"function",description:"Retrieves alert definition by id",uiLabel:"Get Alert Definition By Id"},{name:"getAlertDefinitions",kind:"function",description:"Retrieves all Alert Definitions in Alert State",uiLabel:"Get Alert Definitions"},{name:"getAlertDefinitionsWithAllowEdit",kind:"function",description:"Retrieves all Alert Definitions which allow a Cell Edit",uiLabel:"Get Alert Definitions With Allow Edit"},{name:"getAlertDefinitionsWithPreventEdit",kind:"function",description:"Retrieves all Alert Definitions which prevent a Cell Edit",uiLabel:"Get Alert Definitions With Prevent Edit"},{name:"getAlertDescription",kind:"function",description:"Returns a description of an Alert Definition",uiLabel:"Get Alert Description"},{name:"getAlertPredicateDefs",kind:"function",description:"Retrieves all Predicate Defs with Module Scope of Alert",uiLabel:"Get Alert Predicate Defs"},{name:"getAlertPredicateDefsForScope",kind:"function",description:"Retrieves all Predicate Defs that match given Scope",uiLabel:"Get Alert Predicate Defs For Scope"},{name:"getAlertRuleDescription",kind:"function",description:"Returns a description of an Alert Definition's Rule",uiLabel:"Get Alert Rule Description"},{name:"getAlertState",kind:"function",description:"Retrieves Alert section from Adaptable State",uiLabel:"Get Alert State"},{name:"getAlertTypeForAdaptableAlert",kind:"function",description:"Returns for the Alert Type for an Adaptable Alert",uiLabel:"Get Alert Type For Adaptable Alert"},{name:"getNonReactiveAlertDefinitions",kind:"function",description:"Retrieves all Alert Definitions in Alert State which are NOT Reactive (BooleanQuery)",uiLabel:"Get Non Reactive Alert Definitions"},{name:"getReactiveAlertDefinitions",kind:"function",description:"Retrieves all Alert Definitions in Alert State which are reactive (ObservableQuery & AggregationQuery)",uiLabel:"Get Reactive Alert Definitions"},{name:"isCellChangedAdaptableAlert",kind:"function",description:"Was Adaptable Alert fired due to a Cell Change",uiLabel:"Is Cell Changed Adaptable Alert"},{name:"isGenericAdaptableAlert",kind:"function",description:"Is Adaptable Alert a Generic one",uiLabel:"Is Generic Adaptable Alert"},{name:"isRowChangedAdaptableAlert",kind:"function",description:"Was Adaptable Alert fired due to a Row Change",uiLabel:"Is Row Changed Adaptable Alert"},{name:"publishAlertFiredEvent",kind:"function",description:"Publishes an event when an Alert is triggered",uiLabel:"Publish Alert Fired Event"},{name:"showAlert",kind:"function",description:"Creates Alert formed from inputted values and displays it.",uiLabel:"Show Alert"},{name:"showAlertError",kind:"function",description:"Creates Alert formed from inputted values and displays it as Error Alert.",uiLabel:"Show Alert Error"},{name:"showAlertInfo",kind:"function",description:"Creates Alert formed from inputted values and displays it as Info Alert.",uiLabel:"Show Alert Info"},{name:"showAlertPopup",kind:"function",description:"Opens Settings Panel with Alert section selected and visible",uiLabel:"Show Alert Popup"},{name:"showAlertSuccess",kind:"function",description:"Creates Alert formed from inputted values and displays it as Succcess Alert.",uiLabel:"Show Alert Success"},{name:"showAlertWarning",kind:"function",description:"Creates Alert formed from inputted values and displays it as Warning Alert.",uiLabel:"Show Alert Warning"},{name:"suspendAlertDefinition",kind:"function",description:"Suspends Alert Definition",uiLabel:"Suspend Alert Definition"},{name:"unSuspendAlertDefinition",kind:"function",description:"Activates a suspended Alert Definition",uiLabel:"Un Suspend Alert Definition"}]},AlertButton:{name:"AlertButton",kind:"Interface",description:"Defines a button that appears in an Alert Form",properties:[{name:"Action",kind:"unknown",description:"Predefined Action(s) to trigger when button is clicked; but the implementation in `actionHandlers` property of Alert Options",uiLabel:"Action",isOptional:!0},{name:"ButtonStyle",kind:"REFERENCE",description:"Style for the Button",uiLabel:"Button Style",isOptional:!0,reference:"ButtonStyle"},{name:"Label",kind:"string",description:"Label to show in the Button",uiLabel:"Label"},{name:"Tooltip",kind:"string",description:"ToolTip to display",uiLabel:"Tooltip",isOptional:!0}]},AlertDefinition:{name:"AlertDefinition",kind:"Interface",description:"The Alert Definition object used in the Alert function",properties:[{name:"AlertForm",kind:"unknown",description:"Form to display in Alert with buttons and inputs",uiLabel:"Alert Form",isOptional:!0},{name:"AlertProperties",kind:"REFERENCE",description:"Series of properties which set what happens when Alert is triggered",uiLabel:"Alert Properties",isOptional:!0,reference:"AlertProperties"},{name:"MessageText",kind:"string",description:"Alert Message; if not provided AdapTable creates dynamically using Rule & Scope (Note: can be provided as a function in AlertOptions)",uiLabel:"Message Text",isOptional:!0},{name:"MessageType",kind:"REFERENCE",description:"Type of Alert: 'Info', 'Success', 'Warning', 'Error'; influences Alert colour, icon and logging",uiLabel:"Message Type",reference:"AdaptableMessageType"},{name:"Rule",kind:"REFERENCE",description:"When Alert should be triggered",uiLabel:"Rule",reference:"AlertRule"},{name:"Scope",kind:"REFERENCE",description:"Where Alert can be triggered: one, some or all columns or DataTypes",uiLabel:"Scope",reference:"AdaptableScope"}]},AlertFiredInfo:{name:"AlertFiredInfo",kind:"Interface",description:"Object returned by the `AlertFired` event",properties:[{name:"alert",kind:"REFERENCE",description:"Alert which has been fired",uiLabel:"Alert",reference:"AdaptableAlert"}]},AlertForm:{name:"AlertForm",kind:"TypeAlias",description:"Form to show in an Alert"},AlertFormContext:{name:"AlertFormContext",kind:"Interface",description:"Context required by functions when using an Alert Button",properties:[{name:"alert",kind:"REFERENCE",description:"Alert that has been triggered",uiLabel:"Alert",reference:"AdaptableAlert"}]},AlertMessageContext:{name:"AlertMessageContext",kind:"Interface",description:"Context used for creating bespoke Alert messages",properties:[{name:"alertDefinition",kind:"REFERENCE",description:"Current Alert Definition",uiLabel:"Alert Definition",reference:"AlertDefinition"},{name:"cellDataChangedInfo",kind:"REFERENCE",description:"Data change that might have triggered the Alert",uiLabel:"Cell Data Changed Info",isOptional:!0,reference:"CellDataChangedInfo"}]},AlertOptions:{name:"AlertOptions",kind:"Interface",description:"Options related to Alerts in Adaptable.",properties:[{name:"actionHandlers",kind:"array",description:"Custom onClick Handlers for Buttons (displayed in Alert Forms)",uiLabel:"Action Handlers",isOptional:!0},{name:"alertForms",kind:"array",description:"Full definitions of Alert Forms - the names of which are provided in Alert State",uiLabel:"Alert Forms",isOptional:!0},{name:"alertMessageText",kind:"function",description:"Function providing Message to display in Alert; if empty, AdapTable provides dynamically",uiLabel:"Alert Message Text",isOptional:!0},{name:"cellHighlightDuration",kind:"number",description:"How long (in ms) a Cell will be highlighted when an Alert fires",uiLabel:"Cell Highlight Duration",isOptional:!0,gridInfo:"item",defaultValue:"2000"},{name:"dataChangeDetectionPolicy",kind:"'rawValue' | 'formattedValue'",description:"Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data",uiLabel:"Data Change Detection Policy",isOptional:!0,gridInfo:"item",defaultValue:"'rawValue'"},{name:"maxAlertsInStore",kind:"number",description:"How many alerts held in State at any one time; when limit is breached, oldest alert will be removed",uiLabel:"Max Alerts In Store",isOptional:!0,gridInfo:"item",defaultValue:"20"},{name:"rowHighlightDuration",kind:"number",description:"How long (in ms) a Row will be highlighted when an Alert Fires",uiLabel:"Row Highlight Duration",isOptional:!0,gridInfo:"item",defaultValue:"4000"},{name:"statusbarHighlightDuration",kind:"number",description:"How long (in ms) the status-panel will be highlighted when an Alert Fires",uiLabel:"Statusbar Highlight Duration",isOptional:!0,defaultValue:"2000"}]},AlertProperties:{name:"AlertProperties",kind:"Interface",description:"Additional properties that specify how a particular Alert will ALWAYS behave",properties:[{name:"DisplayNotification",kind:"boolean",description:"Displays a notification when Alert is triggered",uiLabel:"Display Notification",isOptional:!0},{name:"HighlightCell",kind:"unknown",description:"Colours updated cell using `MessageType` property of triggering Alert Definition",uiLabel:"Highlight Cell",isOptional:!0},{name:"HighlightRow",kind:"unknown",description:"Colours updated cell using `MessageType` property of triggering Alert Definition",uiLabel:"Highlight Row",isOptional:!0},{name:"JumpToCell",kind:"boolean",description:"Grid will 'jump' to the changed cell which triggered the Alert",uiLabel:"Jump To Cell",isOptional:!0},{name:"JumpToRow",kind:"boolean",description:"Grid will 'jump' to the newly added row which triggered the Alert",uiLabel:"Jump To Row",isOptional:!0},{name:"LogToConsole",kind:"boolean",description:"Logs the Alert message to the console",uiLabel:"Log To Console",isOptional:!0},{name:"PreventEdit",kind:"boolean",description:"Automatically prevent any cell edit which triggered the Alert (i.e. validation)",uiLabel:"Prevent Edit",isOptional:!0,defaultValue:"false"},{name:"ShowInDiv",kind:"boolean",description:"Shows Alert text in the div specificed in `alertContainer` property of Container Options",uiLabel:"Show In Div",isOptional:!0}]},AlertRule:{name:"AlertRule",kind:"TypeAlias",description:"The Alert Rule defined by either an AdaptablePredicate or an AdaptableQuery"},AlertState:{name:"AlertState",kind:"Interface",description:"Predefined Configuration for Alert Module",properties:[{name:"AlertDefinitions",kind:"array",description:"Alert Definitions - will trigger Alerts when rule is met",uiLabel:"Alert Definitions",isOptional:!0}]},AlternativeModuleName:{name:"AlternativeModuleName",kind:"Interface",description:"Defines a new name for an Adaptable Module (e.g. change Dashboard to Grid Manager)",properties:[{name:"adaptableModule",kind:"REFERENCE",description:"Adaptable Module to rename",uiLabel:"Adaptable Module",reference:"AdaptableModule"},{name:"newName",kind:"string",description:"New name to use",uiLabel:"New Name"}]},AngularFrameworkComponent:{name:"AngularFrameworkComponent",kind:"TypeAlias",description:"An Angular component defined by its type and an optional initialisation callback."},ApplicationApi:{name:"ApplicationApi",kind:"Interface",description:"Provides run-time access to the Application Module",properties:[{name:"addApplicationDataEntry",kind:"function",description:"Adds new Application Data Entry",uiLabel:"Add Application Data Entry"},{name:"createApplicationDataEntry",kind:"function",description:"Creates new Application Data Entry with given Key and Value",uiLabel:"Create Application Data Entry"},{name:"deleteApplicationDataEntry",kind:"function",description:"Deletes given Application Data Entry",uiLabel:"Delete Application Data Entry"},{name:"editApplicationDataEntry",kind:"function",description:"Edits given Application Data Entry",uiLabel:"Edit Application Data Entry"},{name:"getApplicationDataEntries",kind:"function",description:"Retrieves all Key Value Pairs in Application state",uiLabel:"Get Application Data Entries"},{name:"getApplicationDataEntriesByValue",kind:"function",description:"Gets Application Data Entry with given value",uiLabel:"Get Application Data Entries By Value"},{name:"getApplicationDataEntryByKey",kind:"function",description:"Gets Application Data Entry with given key",uiLabel:"Get Application Data Entry By Key"},{name:"getApplicationState",kind:"function",description:"Retrieves Application section from Adaptable State",uiLabel:"Get Application State"}]},ApplicationDataEntry:{name:"ApplicationDataEntry",kind:"Interface",description:"Simple Key / Value pair object used to store custom - stringifiable - data in Adaptable State.",properties:[{name:"Key",kind:"string",description:"Key of Key / Value pair - always stored as a string",uiLabel:"Key"},{name:"Value",kind:"unknown",description:"Value of Key / Value pair (actual data being stored) - needs to stringifiable",uiLabel:"Value"}]},ApplicationState:{name:"ApplicationState",kind:"Interface",description:"Predefined Configuration for the Application Module",properties:[{name:"ApplicationDataEntries",kind:"array",description:"Array of Key / Value pairs enabling custom data to be stored in Adaptable State.",uiLabel:"Application Data Entries",isOptional:!0}]},AutoGenerateTagsForLayoutsContext:{name:"AutoGenerateTagsForLayoutsContext",kind:"Interface",description:"Context for `LayoutOptions.autoGenerateTagsForLayouts` method",properties:[{name:"layouts",kind:"array",description:"Layouts currently in Adaptable State",uiLabel:"Layouts"},{name:"objectTags",kind:"array",description:"Object Tags provided in User Interface Options",uiLabel:"Object Tags"}]},BaseContext:{name:"BaseContext",kind:"Interface",description:"Base Context used in many functions provided by developers and invoked as needed by AdapTable",properties:[{name:"adaptableApi",kind:"REFERENCE",description:"The Adaptable Api - included as a convenience",uiLabel:"Adaptable Api",reference:"AdaptableApi"}]},BooleanFunctionName:{name:"BooleanFunctionName",kind:"TypeAlias",description:"List of all the Boolean Functions available in AdaptableQL"},BulkUpdateApi:{name:"BulkUpdateApi",kind:"Interface",description:"Provides run-time access to the Bulk Update Module",properties:[{name:"applyBulkUpdate",kind:"function",description:"Applies a Bulk Update to given Cells",uiLabel:"Apply Bulk Update"},{name:"getBulkUpdateValue",kind:"function",description:"Returns current Bulk Update value",uiLabel:"Get Bulk Update Value"},{name:"setBulkUpdateValue",kind:"function",description:"Sets Bulk Update value",uiLabel:"Set Bulk Update Value"},{name:"showBulkUpdatePopup",kind:"function",description:"Opens Settings Panel with Bulk Update section selected and visible",uiLabel:"Show Bulk Update Popup"}]},BulkUpdatePermittedValues:{name:"BulkUpdatePermittedValues",kind:"Interface",description:"User to define permitted values when updating cells via bulk update",properties:[{name:"values",kind:"unknown",description:"Values to display in Bulk Update Wizard: either hardcoded list or a function that returns a list",uiLabel:"Values"}]},BulkUpdatePermittedValuesContext:{name:"BulkUpdatePermittedValuesContext",kind:"Interface",description:"Context used when getting BulkUpdatePermittedValues via a function",properties:[{name:"gridCells",kind:"array",description:"Cells which will be modified in the Bulk Update",uiLabel:"Grid Cells"}]},ButtonStyle:{name:"ButtonStyle",kind:"Interface",description:"Defines the look and feel of an Adaptable Button",properties:[{name:"className",kind:"string",description:"CSS Classname to use for the Button",uiLabel:"Class Name",isOptional:!0},{name:"tone",kind:"'success' | 'error' | 'neutral' | 'none' | 'warning' | 'info' | 'accent'",description:"Button's Tone - values: 'success', 'error', 'neutral', 'none', 'warning', 'info', 'accent'",uiLabel:"Tone",isOptional:!0,defaultValue:"'neutral'"},{name:"variant",kind:"'text' | 'outlined' | 'raised'",description:"How Button appears - values: 'text', 'outlined', 'raised'",uiLabel:"Variant",isOptional:!0,defaultValue:"'outlined'"}]},CalculatedColumn:{name:"CalculatedColumn",kind:"Interface",description:"Defines a Column where the display value is derived from other values in row, and the definition is stored in State.",properties:[{name:"CalculatedColumnSettings",kind:"REFERENCE",description:"Additional optional properties for Column (e.g. filterable, resizable)",uiLabel:"Calculated Column Settings",isOptional:!0,reference:"CalculatedColumnSettings"},{name:"ColumnId",kind:"string",description:"Name of Calculated Column",uiLabel:"Column Id"},{name:"FriendlyName",kind:"string",description:"Name to be used in Column Header; if blank `ColumnId` is used",uiLabel:"Friendly Name",isOptional:!0},{name:"Query",kind:"REFERENCE",description:"Scalar/AggregatedScalar Query used by AdapTableQL to evaluate Column's value",uiLabel:"Query",reference:"AdaptableCalculatedColumnQuery"}]},CalculatedColumnApi:{name:"CalculatedColumnApi",kind:"Interface",description:"Provides run-time access to the Calculated Column Module",properties:[{name:"addCalculatedColumn",kind:"function",description:"Adds new Calculated Column",uiLabel:"Add Calculated Column"},{name:"deleteCalculatedColumn",kind:"function",description:"Removes Calculated Column from State",uiLabel:"Delete Calculated Column"},{name:"editCalculatedColumn",kind:"function",description:"Edits given Calculated Column",uiLabel:"Edit Calculated Column"},{name:"editCalculatedColumns",kind:"function",description:"Edits given Calculated Columns",uiLabel:"Edit Calculated Columns"},{name:"getAllCalculatedColumn",kind:"function",description:"Retrieves all Calculated Columns in Adaptable State",uiLabel:"Get All Calculated Column"},{name:"getCalculatedColumnById",kind:"function",description:"Retrieves Calculated Column by the unique identifier of the Adaptable Object in the CalculatedColumnState",uiLabel:"Get Calculated Column By Id"},{name:"getCalculatedColumnForColumnId",kind:"function",description:"Gets Calculated Column, if any, for given ColumnId",uiLabel:"Get Calculated Column For Column Id"},{name:"getCalculatedColumnModuleReferences",kind:"function",description:"Returns all the references in the AdaptableState of the given CalculatedColumn",uiLabel:"Get Calculated Column Module References"},{name:"getCalculatedColumnsReferencingColumnId",kind:"function",description:"Returns all Calculated Columns whose Expression contains the ColumnId",uiLabel:"Get Calculated Columns Referencing Column Id"},{name:"getCalculatedColumnState",kind:"function",description:"Retrieves Calculated Column section from Adaptable State",uiLabel:"Get Calculated Column State"},{name:"getReferencedColumnIdsForCalculatedColumn",kind:"function",description:"Gets any ColumnIds referenced in a Calculated Column",uiLabel:"Get Referenced Column Ids For Calculated Column"},{name:"getReferencedColumnIdsForCalculatedColumnId",kind:"function",description:"Gets any ColumnIds referenced in a Calculated Column",uiLabel:"Get Referenced Column Ids For Calculated Column Id"},{name:"showCalculatedColumnPopup",kind:"function",description:"Opens Settings Panel with Calculated Column section selected and visible",uiLabel:"Show Calculated Column Popup"}]},CalculatedColumnSettings:{name:"CalculatedColumnSettings",kind:"Interface",description:"Set of optional properties that define a Calculated Column's behaviour",properties:[{name:"DataType",kind:"'String' | 'Number' | 'Boolean' | 'Date'",description:"Expression's return value DataType; inferred by AdapTable but settable by User",uiLabel:"Data Type"},{name:"ShowToolTip",kind:"boolean",description:"Show underlying Expression as ToolTip when hovering over a cell",uiLabel:"Show Tool Tip",isOptional:!0,defaultValue:"false"}]},CalculatedColumnState:{name:"CalculatedColumnState",kind:"Interface",description:"Predefined Configuration for Calculated Column Module",properties:[{name:"CalculatedColumns",kind:"array",description:"Collection of Calculated Columns",uiLabel:"Calculated Columns",isOptional:!0}]},CalendarApi:{name:"CalendarApi",kind:"Interface",description:"Calendar, Holiday and Working Day related functions, using supplied Calendars in General Options",properties:[{name:"getNextWorkingDay",kind:"function",description:"Returns the next Working Day",uiLabel:"Get Next Working Day"},{name:"getPreviousWorkingDay",kind:"function",description:"Returns the previous Working Day",uiLabel:"Get Previous Working Day"},{name:"isHoliday",kind:"function",description:"Checks if given data is a Holiday",uiLabel:"Is Holiday"},{name:"isSameDay",kind:"function",description:"Returns true if both Dates are the same, ignoring the time portions",uiLabel:"Is Same Day"},{name:"isWorkingDay",kind:"function",description:"Checks if given date is a Working Day",uiLabel:"Is Working Day"}]},CellChangedInfo:{name:"CellChangedInfo",kind:"Interface",description:"EventInfo returned by CellChanged event",properties:[{name:"cellChange",kind:"REFERENCE",description:"Object providing full information of the cell (and column and row) that changed",uiLabel:"Cell Change",reference:"CellDataChangedInfo"}]},CellColorRange:{name:"CellColorRange",kind:"Interface",description:"Defines which Colours to show in Gradient and Percent Bar Styles",properties:[{name:"Color",kind:"string",description:"Cell colour to use for values that fall inside Range",uiLabel:"Color"},{name:"Max",kind:"number | 'Col-Max'",description:"End number of Range",uiLabel:"Max"},{name:"Min",kind:"number | 'Col-Min'",description:"Start number of Range",uiLabel:"Min"},{name:"ReverseGradient",kind:"boolean",description:"Reverses the Gradient so the lower the cell value the darker the colour",uiLabel:"Reverse Gradient",isOptional:!0}]},CellDataChangedInfo:{name:"CellDataChangedInfo",kind:"Interface",description:"Defines a Cell Edit - includes full details of old and new values, the column and the enclosing Row",properties:[{name:"changedAt",kind:"number",description:"Timestamp of change occurrence (in milliseconds)",uiLabel:"Changed At"},{name:"column",kind:"REFERENCE",description:"Column in which cell is situated",uiLabel:"Column",reference:"AdaptableColumn"},{name:"newValue",kind:"unknown",description:"New value for the cell",uiLabel:"New Value"},{name:"oldValue",kind:"unknown",description:"Value in the Cell before the edit",uiLabel:"Old Value"},{name:"primaryKeyValue",kind:"unknown",description:"Primary Key Column's value for the row where edited cell is situated",uiLabel:"Primary Key Value"},{name:"rowData",kind:"unknown",description:"Data in the Row",uiLabel:"Row Data",isOptional:!0},{name:"rowNode",kind:"REFERENCE",description:"AG Grid RowNode that contains the cell",uiLabel:"Row Node",isOptional:!0,reference:"unknown"},{name:"trigger",kind:"'edit' | 'tick' | 'undo' | 'aggChange'",description:"What triggered the change - user, background change or a reverted change?",uiLabel:"Trigger",isOptional:!0}]},CellHighlightInfo:{name:"CellHighlightInfo",kind:"Interface",description:"Defines how a given Cell in AdapTable should be highlighted",properties:[{name:"columnId",kind:"string",description:"Id of Column containing Cell",uiLabel:"Column Id"},{name:"highlightStyle",kind:"REFERENCE",description:"Adaptable Style to use in the Cell Highlight",uiLabel:"Highlight Style",reference:"AdaptableStyle"},{name:"primaryKeyValue",kind:"unknown",description:"Primary Key Value of row containing Cell",uiLabel:"Primary Key Value"},{name:"timeout",kind:"number",description:"Time after which Cell should be unhighlighted",uiLabel:"Timeout",isOptional:!0}]},CellSummaryApi:{name:"CellSummaryApi",kind:"Interface",description:"Provides run-time access to the Cell Summary Module",properties:[{name:"getCellSummaryOperationDefinitions",kind:"function",description:"Retrieves all Cell Summary Definitions from Cell Summary State",uiLabel:"Get Cell Summary Operation Definitions"},{name:"getCellSummaryOperationValue",kind:"function",description:"Retrieves the value of the current selected operation",uiLabel:"Get Cell Summary Operation Value"},{name:"getCurrentCellSummaryOperation",kind:"function",description:"Retrieves currently selected Cell Summary Operation",uiLabel:"Get Current Cell Summary Operation"},{name:"getCurrentCellSummaryOperationValue",kind:"function",description:"Retrieves the value of the current selected operation",uiLabel:"Get Current Cell Summary Operation Value"},{name:"setCurrentCellSummaryOperation",kind:"function",description:"Sets the currently selected Cell Summary Operation",uiLabel:"Set Current Cell Summary Operation"},{name:"showCellSummaryPopup",kind:"function",description:"Opens Settings Panel with Cell Summary section selected and visible",uiLabel:"Show Cell Summary Popup"}]},CellSummaryOperation:{name:"CellSummaryOperation",kind:"Interface",description:"Defines a Custom Cell Summary operation provided by a user",properties:[{name:"operationFunction",kind:"function",description:"Function to run when a summary result is required",uiLabel:"Operation Function"},{name:"operationName",kind:"string",description:"Name of the Operation - will be displayed in the Cell Summary components",uiLabel:"Operation Name"}]},CellSummaryOperationContext:{name:"CellSummaryOperationContext",kind:"Interface",description:"Context provided to a custom Cell Summary Operation function",properties:[{name:"allValues",kind:"array",description:"All values of selected cells",uiLabel:"All Values"},{name:"distinctCount",kind:"number",description:"Count of currently selected cells",uiLabel:"Distinct Count"},{name:"numericColumns",kind:"array",description:"Any numeric columns in current selection",uiLabel:"Numeric Columns"},{name:"numericValues",kind:"array",description:"Any numeric values in current selection",uiLabel:"Numeric Values"},{name:"selectedCellInfo",kind:"REFERENCE",description:"Currently selected cells",uiLabel:"Selected Cell Info",reference:"SelectedCellInfo"}]},CellSummmary:{name:"CellSummmary",kind:"Interface",description:"Defines the Summary operations provides for Selected Cells"},CellTextOption:{name:"CellTextOption",kind:"TypeAlias",description:"Text optionally to show in a Special Column Style special style: 'CellValue' or 'PercentageValue'"},CellTextOptions:{name:"CellTextOptions",kind:"TypeAlias",description:"Array of CellTextOption available in Special Column Styles"},ChartDefinition:{name:"ChartDefinition",kind:"Interface",description:"Wraps an AG Grid Chart Model",properties:[{name:"model",kind:"REFERENCE",description:"AG Grid Chart Model",uiLabel:"Model",reference:"unknown"}]},ChartingApi:{name:"ChartingApi",kind:"Interface",description:"Provides run-time access to Charting Module and related State",properties:[{name:"getCurrentCharts",kind:"function",description:"Retrieves current user-generated Charts",uiLabel:"Get Current Charts"},{name:"getPersistedCharts",kind:"function",description:"Retrieves persisted Charts from Adaptable State",uiLabel:"Get Persisted Charts"},{name:"isChartingEnabled",kind:"function",description:"Whether AdapTable's charting functionality is available",uiLabel:"Is Charting Enabled"},{name:"saveCurrentCharts",kind:"function",description:"Saves all current Charts into Adaptable State",uiLabel:"Save Current Charts"},{name:"showPersistedCharts",kind:"function",description:"Displays all persisted Charts",uiLabel:"Show Persisted Charts"}]},ChartingState:{name:"ChartingState",kind:"Interface",description:"Used for persisting AG Grids in Adaptable State",properties:[{name:"ChartDefinitions",kind:"array",description:"Charting Definitions - wrap AG Grid Chart Models",uiLabel:"Chart Definitions",isOptional:!0}]},CheckboxColumnClickedInfo:{name:"CheckboxColumnClickedInfo",kind:"Interface",description:"Event Info published by CheckboxColumnClicked event",properties:[{name:"column",kind:"REFERENCE",description:"Name of Column where Checkbox was clicked",uiLabel:"Column",reference:"AdaptableColumn"},{name:"isChecked",kind:"boolean",description:"Whether or not the Checkbox is checked",uiLabel:"Is Checked"},{name:"primaryKeyValue",kind:"unknown",description:"Value in Primary Key Column for row where Checkbox was clicked",uiLabel:"Primary Key Value"},{name:"rowData",kind:"unknown",description:"Data in the row where the Checkbox was clicked",uiLabel:"Row Data"}]},ColumnApi:{name:"ColumnApi",kind:"Interface",description:"A large range of column-related functions in AdapTable",properties:[{name:"addColumnsToSelection",kind:"function",description:"Adds (highlights) a group of Columns to any existing selection",uiLabel:"Add Columns To Selection"},{name:"addColumnToSelection",kind:"function",description:"Adds (highlights) a Column to any existing selection",uiLabel:"Add Column To Selection"},{name:"autosizeAllColumns",kind:"function",description:"Autosizes all Columns in the Grid",uiLabel:"Autosize All Columns"},{name:"autosizeColumn",kind:"function",description:"AutoSizes a Column",uiLabel:"Autosize Column"},{name:"autosizeColumns",kind:"function",description:"Autosizes given Columns",uiLabel:"Autosize Columns"},{name:"doesColumnExist",kind:"function",description:"Returns true if the given Column exists in the Grid",uiLabel:"Does Column Exist"},{name:"getAggregetableColumns",kind:"function",description:"Returns all Aggregatable Columns",uiLabel:"Get Aggregetable Columns"},{name:"getAgGridColumnFieldForAdaptableColumn",kind:"function",description:"Retrieves AG Grid's field property for the column",uiLabel:"Get Ag Grid Column Field For Adaptable Column"},{name:"getAgGridColumnForAdaptableColumn",kind:"function",description:"Retrieves AG Grid's column for an Adaptable column",uiLabel:"Get Ag Grid Column For Adaptable Column"},{name:"getAgGridColumnType",kind:"function",description:"Retrieves 'ColumnType' property for a given Column",uiLabel:"Get Ag Grid Column Type"},{name:"getAllColumnFriendlyNames",kind:"function",description:"Retrieves a list providing the Friendly Name / Caption for all columns",uiLabel:"Get All Column Friendly Names"},{name:"getBooleanColumns",kind:"function",description:"Returns all boolean Columns",uiLabel:"Get Boolean Columns"},{name:"getColumnDataTypeFromColumnId",kind:"function",description:"Returns Data Type for a Column",uiLabel:"Get Column Data Type From Column Id"},{name:"getColumnFromFriendlyName",kind:"function",description:"Retrieves Adaptable Column with given Friendly name",uiLabel:"Get Column From Friendly Name"},{name:"getColumnFromId",kind:"function",description:"Retrieves Adaptable Column with given ColumnId",uiLabel:"Get Column From Id"},{name:"getColumnIdFromFriendlyName",kind:"function",description:"Retrieves ColumnId for Column with given Friendly Name",uiLabel:"Get Column Id From Friendly Name"},{name:"getColumnIdsFromFriendlyNames",kind:"function",description:"Retrieves ColumnIds for Columns with given Friendly Names",uiLabel:"Get Column Ids From Friendly Names"},{name:"getColumnIdsFromId",kind:"function",description:"Returns the ColumnId if regular, otherwise referenced columns if Calculated Column",uiLabel:"Get Column Ids From Id"},{name:"getColumns",kind:"function",description:"Returns all Columns",uiLabel:"Get Columns"},{name:"getColumnsFromFriendlyNames",kind:"function",description:"Retrieves Adaptable Columns with given Friendly names",uiLabel:"Get Columns From Friendly Names"},{name:"getColumnsFromIds",kind:"function",description:"Retrieves Adaptable Columns with given ColumnIds",uiLabel:"Get Columns From Ids"},{name:"getColumnsOfType",kind:"function",description:"Returns all Columns that have given DataType",uiLabel:"Get Columns Of Type"},{name:"getDateColumns",kind:"function",description:"Returns all Date Columns",uiLabel:"Get Date Columns"},{name:"getDefaultAggFunc",kind:"function",description:"Returns the default Aggregation Function for a Column",uiLabel:"Get Default Agg Func"},{name:"getDistinctBulkUpdateDisplayValuesForColumn",kind:"function",description:"Gets all distinct column display values for bulk update.",uiLabel:"Get Distinct Bulk Update Display Values For Column"},{name:"getDistinctCustomSortDisplayValuesForColumn",kind:"function",description:"Gets all distinct column display values in for custom sort.",uiLabel:"Get Distinct Custom Sort Display Values For Column"},{name:"getDistinctDisplayValuesForColumn",kind:"function",description:"Gets all distinct display values in the Column",uiLabel:"Get Distinct Display Values For Column"},{name:"getDistinctFilterDisplayValuesForColumn",kind:"function",description:"Gets all distinct display values in for filter column, used for Floating Filter and Column Header filter",uiLabel:"Get Distinct Filter Display Values For Column"},{name:"getDistinctRawValuesForColumn",kind:"function",description:"Gets all distinct raw values in Column. Values are sorted.",uiLabel:"Get Distinct Raw Values For Column"},{name:"getDistinctVisibleDisplayValuesForColumn",kind:"function",description:"Gets all distinct visible display values in the Column",uiLabel:"Get Distinct Visible Display Values For Column"},{name:"getDistinctVisibleRawValuesForColumn",kind:"function",description:"Gets all distinct visible raw values in the Column",uiLabel:"Get Distinct Visible Raw Values For Column"},{name:"getFiltrableColumns",kind:"function",description:"Returns all Sortable Columns",uiLabel:"Get Filtrable Columns"},{name:"getFriendlyNameFromColumn",kind:"function",description:"Retrieves Friendly Name for a given Column",uiLabel:"Get Friendly Name From Column"},{name:"getFriendlyNameFromColumnId",kind:"function",description:"Retrieves Friendly Name for a given ColumnId",uiLabel:"Get Friendly Name From Column Id"},{name:"getFriendlyNamesFromColumnIds",kind:"function",description:"Retrieves Friendly Names for given ColumnIds",uiLabel:"Get Friendly Names From Column Ids"},{name:"getGroupableColumns",kind:"function",description:"Returns all Groupable Columns",uiLabel:"Get Groupable Columns"},{name:"getNumericColumns",kind:"function",description:"Returns all numeric Columns",uiLabel:"Get Numeric Columns"},{name:"getPivotableColumns",kind:"function",description:"Returns all Pivotable Columns",uiLabel:"Get Pivotable Columns"},{name:"getPrimaryKeyColumn",kind:"function",description:"Retrieves current Primary Key Column in AdapTable",uiLabel:"Get Primary Key Column"},{name:"getQueryableColumns",kind:"function",description:"Returns all Queryable Columns",uiLabel:"Get Queryable Columns"},{name:"getSortableColumns",kind:"function",description:"Returns all Sortable Columns",uiLabel:"Get Sortable Columns"},{name:"getStringColumns",kind:"function",description:"Returns all string Columns",uiLabel:"Get String Columns"},{name:"getTypesForColumn",kind:"function",description:"Returns the `types` property for a given Column",uiLabel:"Get Types For Column"},{name:"getUnsortedDistinctRawValuesForColumn",kind:"function",description:"Gets all distinct raw values in Column. Values are un-sorted.",uiLabel:"Get Unsorted Distinct Raw Values For Column"},{name:"getVisibleColumns",kind:"function",description:"Returns all visible Columns",uiLabel:"Get Visible Columns"},{name:"hideColumn",kind:"function",description:"Hides a Column from Grid",uiLabel:"Hide Column"},{name:"isActionColumn",kind:"function",description:"Is Column an Action Column",uiLabel:"Is Action Column"},{name:"isActionRowButtonColumn",kind:"function",description:"Checks if a column is a ActionRowButton column (see UserInterfaceOptions.ActionOptions)",uiLabel:"Is Action Row Button Column"},{name:"isAutoPivotColumn",kind:"function",description:"Is Column pivoted",uiLabel:"Is Auto Pivot Column"},{name:"isAutoRowGroupColumn",kind:"function",description:"Is Column row-grouped",uiLabel:"Is Auto Row Group Column"},{name:"isBooleanColumn",kind:"function",description:"Is Column Boolean",uiLabel:"Is Boolean Column"},{name:"isCalculatedColumn",kind:"function",description:"Is Column a Calculated Column",uiLabel:"Is Calculated Column"},{name:"isColumnReferencedInExpression",kind:"function",description:"Checks if a column is referenced in a given Expression",uiLabel:"Is Column Referenced In Expression"},{name:"isDateColumn",kind:"function",description:"Is Column a Date",uiLabel:"Is Date Column"},{name:"isFreeTextColumn",kind:"function",description:"Is Column a Free Text Column",uiLabel:"Is Free Text Column"},{name:"isNumericColumn",kind:"function",description:"Is Column Numeric",uiLabel:"Is Numeric Column"},{name:"isStyledNumericColumn",kind:"function",description:"Does Column have a numeric style (e.g. Percent Bar or Gradient)",uiLabel:"Is Styled Numeric Column"},{name:"selectAllColumns",kind:"function",description:"Selects all Columns",uiLabel:"Select All Columns"},{name:"selectColumn",kind:"function",description:"Selects (highlights) a Column",uiLabel:"Select Column"},{name:"selectColumns",kind:"function",description:"Selects (highlights) group of Columns",uiLabel:"Select Columns"},{name:"showColumn",kind:"function",description:"Makes a Column visible",uiLabel:"Show Column"},{name:"usesAdaptableFilterForm",kind:"function",description:"Does Column use AdapTable's Filter Form",uiLabel:"Uses Adaptable Filter Form"},{name:"usesAdaptableQuickFilter",kind:"function",description:"Does Column use AdapTable's Quick Filter",uiLabel:"Uses Adaptable Quick Filter"}]},ColumnComparison:{name:"ColumnComparison",kind:"Interface",description:"Enables a Percent Bar or Gradient Style to use another column in its calculations",properties:[{name:"Color",kind:"string",description:"Colour to use for the Comparison",uiLabel:"Color"},{name:"MaxValue",kind:"number | string",description:"End value - either numeric or Column name",uiLabel:"Max Value"},{name:"MinValue",kind:"number | string",description:"Start value - either numeric or Column name",uiLabel:"Min Value"}]},ColumnFilter:{name:"ColumnFilter",kind:"Interface",description:"Defines a Filter applied on a Column using a Predicate",properties:[{name:"ColumnId",kind:"string",description:"Column where Filter should be applied",uiLabel:"Column Id"},{name:"Predicate",kind:"REFERENCE",description:"`AdaptablePredicate` which AdaptableQL will evaluate when the Filter is run",uiLabel:"Predicate",reference:"ColumnFilterPredicate"}]},ColumnFilterPredicate:{name:"ColumnFilterPredicate",kind:"Interface",description:"A Predicate used in Column Filtering"},ColumnFriendlyNameContext:{name:"ColumnFriendlyNameContext",kind:"Interface",description:"Context used when setting a Column Friendly Name",properties:[{name:"agColumn",kind:"REFERENCE",description:"AG Grid ColDef for the Column",uiLabel:"Ag Column",reference:"unknown"},{name:"colId",kind:"string",description:"Id of the Column",uiLabel:"Col Id"}]},ColumnMenuContext:{name:"ColumnMenuContext",kind:"Interface",description:"Provides full details about the Column in which the Column Menu will appear",properties:[{name:"adaptableColumn",kind:"REFERENCE",description:"Current Adaptable Column",uiLabel:"Adaptable Column",reference:"AdaptableColumn"},{name:"agGridColumn",kind:"REFERENCE",description:"Current AG Grid Column",uiLabel:"Ag Grid Column",reference:"unknown"},{name:"isRowGroupColumn",kind:"boolean",description:"Whether current Column is Row Group",uiLabel:"Is Row Group Column"}]},ColumnOptions:{name:"ColumnOptions",kind:"Interface",description:"Options related to managing Columns in Adaptable.",properties:[{name:"autoOrderGroupedColumns",kind:"boolean",description:"Order Grouped Column automatically, deriving from Adaptable State if available (CustomSort or Layout ColumnSort)",uiLabel:"Auto Order Grouped Columns",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"columnFriendlyName",kind:"function",description:"Provide an alternative Friendly Name for a Column",uiLabel:"Column Friendly Name",isOptional:!0,defaultValue:"undefined"},{name:"columnTypes",kind:"array",description:"Optional list of Column Types - used primarily for Calculated and FreeText Columns",uiLabel:"Column Types",isOptional:!0,defaultValue:"undefined"},{name:"hideColumnWhenGrouped",kind:"boolean",description:"Automatically removes a column from the grid when it becomes Row Grouped",uiLabel:"Hide Column When Grouped",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"showMissingColumnsWarning",kind:"boolean",description:"Show warning if AdapTable cannot find a column",uiLabel:"Show Missing Columns Warning",isOptional:!0,gridInfo:"item",defaultValue:"true"}]},ColumnSort:{name:"ColumnSort",kind:"Interface",description:"Defines how a Column is sorted",properties:[{name:"ColumnId",kind:"string",description:"Id of Column being sorted",uiLabel:"Column Id"},{name:"SortOrder",kind:"'Asc' | 'Desc'",description:"How Column is sorted - either 'Asc' or 'Desc'",uiLabel:"Sort Order"}]},ColumnValuesComparer:{name:"ColumnValuesComparer",kind:"Interface",description:"Comparer object for Column Values - used for custom sorting",properties:[{name:"comparer",kind:"REFERENCE",description:"Comparer function to use",uiLabel:"Comparer",reference:"AdaptableComparerFunction"},{name:"scope",kind:"REFERENCE",description:"Column for which to compare values",uiLabel:"Scope",reference:"AdaptableScope"}]},ConfigApi:{name:"ConfigApi",kind:"Interface",description:"Range of functions to access Predefined Config and Adaptable State",properties:[{name:"configInit",kind:"function",description:"Initialised Adaptable State (for internal use only)",uiLabel:"Config Init"},{name:"copyAllStateToClipboard",kind:"function",description:"Copies all Adaptable state to clipboard",uiLabel:"Copy All State To Clipboard"},{name:"copyUserStateToClipboard",kind:"function",description:"Copies User State sections of Adaptable State to clipboard",uiLabel:"Copy User State To Clipboard"},{name:"dispatchStateReadyAction",kind:"function",description:"Sent by each Module when it is Ready",uiLabel:"Dispatch State Ready Action"},{name:"getAdaptableSearchState",kind:"function",description:"Gets search-related sections of Adaptable State",uiLabel:"Get Adaptable Search State"},{name:"getAdaptableSortState",kind:"function",description:"Gets sort-related sections of Adaptable State",uiLabel:"Get Adaptable Sort State"},{name:"getAlertState",kind:"function",description:"Returns Alert section of Adaptable State",uiLabel:"Get Alert State"},{name:"getAllState",kind:"function",description:"Retrieves ALL state which is currently stored by Adaptable (both persistent and transient/internal)",uiLabel:"Get All State"},{name:"getAllUserState",kind:"function",description:"Retrieves the PERSISTED state in Adaptable",uiLabel:"Get All User State"},{name:"getApplicationState",kind:"function",description:"Returns Application section of Adaptable State",uiLabel:"Get Application State"},{name:"getCalculatedColumnState",kind:"function",description:"Returns Calculated Column section of Adaptable State",uiLabel:"Get Calculated Column State"},{name:"getCustomSortState",kind:"function",description:"Returns Custom Sort section of Adaptable State",uiLabel:"Get Custom Sort State"},{name:"getDashboardState",kind:"function",description:"Returns Dashboard section of Adaptable State",uiLabel:"Get Dashboard State"},{name:"getDescriptionForModule",kind:"function",description:"Retrieves a brief description of an AdapTable Module",uiLabel:"Get Description For Module"},{name:"getExportState",kind:"function",description:"Returns Export section of Adaptable State",uiLabel:"Get Export State"},{name:"getFormatColumnState",kind:"function",description:"Returns Formt Column section of Adaptable State",uiLabel:"Get Format Column State"},{name:"getFreeTextColumnState",kind:"function",description:"Returns FreeText Column section of Adaptable State",uiLabel:"Get Free Text Column State"},{name:"getHelpPageForModule",kind:"function",description:"Retrieves the help page for an AdapTable Module",uiLabel:"Get Help Page For Module"},{name:"getLayoutState",kind:"function",description:"Returns Layout section of Adaptable State",uiLabel:"Get Layout State"},{name:"getPersistedState",kind:"function",description:"Retrieves the persisted state in Adaptable. This is the state that was last stored with the `StatusOptions.persistState()` function.",uiLabel:"Get Persisted State"},{name:"getPlusMinusState",kind:"function",description:"Returns Plus Minus section of Adaptable State",uiLabel:"Get Plus Minus State"},{name:"getPredefinedConfig",kind:"function",description:"Returns current Predefined Config",uiLabel:"Get Predefined Config"},{name:"getQueryState",kind:"function",description:"Returns Query section of Adaptable State",uiLabel:"Get Query State"},{name:"getQuickSearchState",kind:"function",description:"Returns Quick Search section of Adaptable State",uiLabel:"Get Quick Search State"},{name:"getScheduleState",kind:"function",description:"Returns Schedule section of Adaptable State",uiLabel:"Get Schedule State"},{name:"getShortcutState",kind:"function",description:"Returns Shortcut section of Adaptable State",uiLabel:"Get Shortcut State"},{name:"getThemeState",kind:"function",description:"Returns Theme section of Adaptable State",uiLabel:"Get Theme State"},{name:"getToolPanelState",kind:"function",description:"Returns Tool Panel section of Adaptable State",uiLabel:"Get Tool Panel State"},{name:"getUserStateByStateKey",kind:"function",description:"Returns given section of Adaptable State (as JSON or object)",uiLabel:"Get User State By State Key"},{name:"incrementUserStateRevision",kind:"function",description:"Adds '1' to current revision number of State element",uiLabel:"Increment User State Revision"},{name:"loadUserState",kind:"function",description:"Loads supplied user state, replacing (NOT merging) existing User(persisted) State.",uiLabel:"Load User State"},{name:"reloadPredefinedConfig",kind:"function",description:"Reloads either existing or supplied Predefined Config; clears persistent state by calling `StateOptions.clearState()` function for remote storage removal",uiLabel:"Reload Predefined Config"},{name:"setAdaptableStateKey",kind:"function",description:"Changes the key used for persisting the Adaptablestate into localStorage",uiLabel:"Set Adaptable State Key"}]},ConfigState:{name:"ConfigState",kind:"Interface",description:"Base Interface for all Adaptable State objects; contains`Revision` property, used for versioning",properties:[{name:"Revision",kind:"number | {\n        Key: number;\n        UpdateStrategy: 'Override' | 'KeepUserDefined';\n    }",description:"Version number of the Item - allows developers to update one section in Predefined Config while keeping others unchanged",uiLabel:"Revision",isOptional:!0}]},ContactColumn:{name:"ContactColumn",kind:"Interface",description:"A (String) Column which will be defined as an FDC3 Contact columnId and at least one other property is required",properties:[{name:"emailColumnId",kind:"string",description:"Column which holds the email address of a Contact",uiLabel:"Email Column Id",isOptional:!0},{name:"fds_idColumnId",kind:"string",description:"Column which holds an FDS_ID value a Contact",uiLabel:"Fds_id Column Id",isOptional:!0},{name:"intents",kind:"REFERENCE",description:"Contact-related FDC3 Intents; can be: `StartCall` `StartChat` `ViewContact`",uiLabel:"Intents",isOptional:!0,reference:"ContactIntents"}]},ContactContext:{name:"ContactContext",kind:"Interface",description:"FDC3 Context to define a Contact",properties:[{name:"id",kind:"unknown",description:"The Contact data: email, FDS_ID",uiLabel:"Id",isOptional:!0},{name:"name",kind:"string",description:"Free text name of Contact",uiLabel:"Name",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `contact`",uiLabel:"Type"}]},ContactIntent:{name:"ContactIntent",kind:"TypeAlias",description:"FDC3 Intents available to a Contact Column"},ContactIntents:{name:"ContactIntents",kind:"TypeAlias",description:"All available Contact Intents"},ContactListContext:{name:"ContactListContext",kind:"Interface",description:"FDC3 Context to define a list of Contacts",properties:[{name:"contacts",kind:"array",description:"The array of Contacts",uiLabel:"Contacts",isOptional:!0},{name:"id",kind:"unknown",description:"Optional Id",uiLabel:"Id",isOptional:!0},{name:"name",kind:"string",description:"Free text name of Contact list",uiLabel:"Name",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `contactList`",uiLabel:"Type"}]},ContainerOptions:{name:"ContainerOptions",kind:"Interface",description:"Options for managing the different div elements required by AdapTable",properties:[{name:"adaptableContainer",kind:"unknown",description:"Div containing AdapTable - string Id or HTMLElement",uiLabel:"Adaptable Container",isOptional:!0,gridInfo:"item",defaultValue:""adaptable""},{name:"agGridContainer",kind:"unknown",description:"Div containing AG Grid instance - string Id or HTMLElement",uiLabel:"Ag Grid Container",isOptional:!0,gridInfo:"item",defaultValue:""grid""},{name:"agGridContainerWaitTimeout",kind:"number",description:"How long AdapTable waits for AG Grid before giving up connecting to it",uiLabel:"Ag Grid Container Wait Timeout",isOptional:!0,gridInfo:"item",defaultValue:"60s"},{name:"alertContainer",kind:"unknown",description:"Div to show Alerts - string Id or HTMLElement",uiLabel:"Alert Container",isOptional:!0,gridInfo:"item",defaultValue:"undefined"},{name:"modalContainer",kind:"unknown",description:"Name of div where modals appear (if null, will be centre of page)",uiLabel:"Modal Container",isOptional:!0,gridInfo:"item",defaultValue:"undefined"},{name:"systemStatusContainer",kind:"unknown",description:"Div to show System Status messages - string Id or HTMLElement",uiLabel:"System Status Container",isOptional:!0,gridInfo:"item",defaultValue:"undefined"}]},ContextMenuContext:{name:"ContextMenuContext",kind:"Interface",description:"Provides full details about current cell (and selected cells) where the Context Menu will appear",properties:[{name:"adaptableColumn",kind:"REFERENCE",description:"Current Adaptable Column",uiLabel:"Adaptable Column",reference:"AdaptableColumn"},{name:"agGridColumn",kind:"REFERENCE",description:"Current AG Grid Column",uiLabel:"Ag Grid Column",reference:"unknown"},{name:"gridCell",kind:"REFERENCE",description:"Cell that has been clicked; contains cell value",uiLabel:"Grid Cell",reference:"GridCell"},{name:"isGroupedNode",kind:"boolean",description:"Whether current AG Grid row node is grouped",uiLabel:"Is Grouped Node"},{name:"isRowGroupColumn",kind:"boolean",description:"Whether current Column is Row Grouped",uiLabel:"Is Row Group Column"},{name:"isSelectedCell",kind:"boolean",description:"Whether cell that was clicked is also currently selected",uiLabel:"Is Selected Cell"},{name:"isSingleSelectedCell",kind:"boolean",description:"Whether the clicked cell is the only selected cell",uiLabel:"Is Single Selected Cell"},{name:"isSingleSelectedColumn",kind:"boolean",description:"Whether Column that was clicked is only column with selected cells",uiLabel:"Is Single Selected Column"},{name:"primaryKeyValue",kind:"unknown",description:"Value of Primary Key column in current row",uiLabel:"Primary Key Value"},{name:"rowNode",kind:"REFERENCE",description:"Current AG Grid row node",uiLabel:"Row Node",reference:"unknown"},{name:"selectedCellInfo",kind:"REFERENCE",description:"Currently selected cells in the grid",uiLabel:"Selected Cell Info",reference:"SelectedCellInfo"},{name:"selectedRowInfo",kind:"REFERENCE",description:"Currently selected rows in the grid",uiLabel:"Selected Row Info",reference:"SelectedRowInfo"}]},CountryColumn:{name:"CountryColumn",kind:"Interface",description:"A (String) Column which will be defined as an FDC3 Country",properties:[{name:"intents",kind:"REFERENCE",description:"Country-related FDC3 Intents; can only be: `ViewChart`",uiLabel:"Intents",isOptional:!0,reference:"CountryIntents"},{name:"isoalpha2ColumnId",kind:"string",description:"Column which contains the ISOALPHA2 Standard",uiLabel:"Isoalpha2Column Id",isOptional:!0},{name:"isoalpha3ColumnId",kind:"string",description:"Column which contains the ISOALPHA3 Standard",uiLabel:"Isoalpha3Column Id",isOptional:!0}]},CountryContext:{name:"CountryContext",kind:"Interface",description:"FDC3 Context to define a Country",properties:[{name:"id",kind:"unknown",description:"The Country data: ISOALPHA2, ISOALPHA3",uiLabel:"Id",isOptional:!0},{name:"name",kind:"string",description:"Free text name of Country",uiLabel:"Name",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `country`",uiLabel:"Type"}]},CountryIntent:{name:"CountryIntent",kind:"TypeAlias",description:"FDC3 Intents available to a Country Column"},CountryIntents:{name:"CountryIntents",kind:"TypeAlias",description:"All available Country Intents"},CreateActionRowContext:{name:"CreateActionRowContext",kind:"Interface",description:"Context used in a Create Row Form",properties:[{name:"clonedRowNode",kind:"REFERENCE",description:"The RowNode being cloned",uiLabel:"Cloned Row Node",isOptional:!0,reference:"unknown"},{name:"type",kind:"unknown",description:"Type of the Context",uiLabel:"Type"}]},CreatedActionRowInfo:{name:"CreatedActionRowInfo",kind:"Interface",description:"Info passed into ActionRowSubmitted Event for Created Rows",properties:[{name:"clonedRowNode",kind:"REFERENCE",description:"Node being cloned",uiLabel:"Cloned Row Node",isOptional:!0,reference:"unknown"},{name:"formData",kind:"REFERENCE",description:"Data entered in the Form",uiLabel:"Form Data",reference:"unknown"},{name:"type",kind:"unknown",description:"Specifies its a Created Action Row",uiLabel:"Type"}]},CustomDestination:{name:"CustomDestination",kind:"Interface",description:"Defines a custom Export destination",properties:[{name:"form",kind:"unknown",description:"Optional Adaptable Form; if provided, it must include Buttons that will execute the Export",uiLabel:"Form",isOptional:!0},{name:"name",kind:"string",description:"Name of Custom Destination (mandatory)",uiLabel:"Name"},{name:"onExport",kind:"function",description:"Optional Function invoked when Export is applied (used if no form is supplied)",uiLabel:"On Export",isOptional:!0}]},CustomDisplayFormatter:{name:"CustomDisplayFormatter",kind:"Interface",description:"Provides Custom Display Formats",properties:[{name:"handler",kind:"function",description:"Function used to perform the Custom Display Format",uiLabel:"Handler"},{name:"id",kind:"string",description:"Id of the Formatted",uiLabel:"Id"},{name:"label",kind:"string",description:"Description",uiLabel:"Label",isOptional:!0},{name:"scope",kind:"REFERENCE",description:"Where the Custom Display Format can be applied",uiLabel:"Scope",reference:"AdaptableScope"}]},CustomDisplayFormatterContext:{name:"CustomDisplayFormatterContext",kind:"Interface",description:"Context used in handler of CustomDisplayFormatter",properties:[{name:"adaptableColumn",kind:"REFERENCE",description:"Column where Custom Display Format will apply",uiLabel:"Adaptable Column",reference:"AdaptableColumn"},{name:"cellValue",kind:"unknown",description:"Non-formatted Cell Value",uiLabel:"Cell Value"},{name:"rowNode",kind:"REFERENCE",description:"Node where Custom Display Format will apply",uiLabel:"Row Node",reference:"unknown"}]},CustomFDC3Column:{name:"CustomFDC3Column",kind:"Interface",description:"A Column which will be defined as Custom FDC3 (can be any datatype)",properties:[{name:"createContext",kind:"unknown",description:"Function which creates FDC3 context for the current column and row",uiLabel:"Create Context"},{name:"intents",kind:"array",description:"Custom FDC3 Intents available to the column",uiLabel:"Intents"}]},CustomFDC3Context:{name:"CustomFDC3Context",kind:"Interface",description:"Context used when providing Custom FDC3 content"},CustomFDC3Intent:{name:"CustomFDC3Intent",kind:"TypeAlias",description:"Custom FDC3 Intent - just a string value"},CustomQueryVariableContext:{name:"CustomQueryVariableContext",kind:"Interface",description:"Context passed when evaluating `ExpressionOptions.customQueryVariables`",properties:[{name:"args",kind:"array",description:"Optional variable arguments",uiLabel:"Args",isOptional:!0}]},CustomRenderContext:{name:"CustomRenderContext",kind:"Interface",description:"Context provided for any custom rendering"},CustomSettingsPanel:{name:"CustomSettingsPanel",kind:"Interface",description:"Definition of a Custom Panel to add to the Adaptable Settings Panel",properties:[{name:"frameworkComponent",kind:"REFERENCE",description:"Framework-specific (Angular or React) component to be rendered",uiLabel:"Framework Component",isOptional:!0,reference:"unknown"},{name:"icon",kind:"REFERENCE",description:"Icon rendered inside settings-panel name, inside the navigation",uiLabel:"Icon",isOptional:!0,reference:"AdaptableIcon"},{name:"name",kind:"string",description:"Appears in Settings Panel Navigation and must be included in settingsPanelOptions.navigation for it to be displayed (by default added to the end)",uiLabel:"Name"},{name:"render",kind:"function",description:"Function to provide bespoke content when NOT using a Framework wrapper",uiLabel:"Render",isOptional:!0}]},CustomSort:{name:"CustomSort",kind:"Interface",description:"Custom Sort object used in Custom Sort function.",properties:[{name:"ColumnId",kind:"string",description:"Id of Column on which Custom Sort will be applied",uiLabel:"Column Id"},{name:"SortedValues",kind:"array",description:"Order of values by which Column will be sorted",uiLabel:"Sorted Values",isOptional:!0}]},CustomSortApi:{name:"CustomSortApi",kind:"Interface",description:"Provides run-time access to the Custom Sort function",properties:[{name:"addCustomSort",kind:"function",description:"Adds a Custom Sort to Custom Sort collection in Adaptable State",uiLabel:"Add Custom Sort"},{name:"createCustomSort",kind:"function",description:"Creates new Custom Sort based on given values",uiLabel:"Create Custom Sort"},{name:"deleteCustomSort",kind:"function",description:"Removes Custom Sort for a given ColumnId",uiLabel:"Delete Custom Sort"},{name:"editCustomSort",kind:"function",description:"Updates existing Custom Sort with new set of Sorted Values",uiLabel:"Edit Custom Sort"},{name:"getAllActiveCustomSort",kind:"function",description:"Retrieves all Custom Sorts that are active (not-suspended) in Adaptable State",uiLabel:"Get All Active Custom Sort"},{name:"getAllCustomSort",kind:"function",description:"Retrieves all Custom Sorts in Adaptable State",uiLabel:"Get All Custom Sort"},{name:"getAllSuspendedCustomSort",kind:"function",description:"Retrieves all Custom Sorts that are suspended in Adaptable State",uiLabel:"Get All Suspended Custom Sort"},{name:"getCustomSortByColumn",kind:"function",description:"Retrieves Custom Sort from Adaptable State for given ColumnId",uiLabel:"Get Custom Sort By Column"},{name:"getCustomSortById",kind:"function",description:"Retrieves Custom Sort by id",uiLabel:"Get Custom Sort By Id"},{name:"getCustomSortState",kind:"function",description:"Retrieves Custom Sort section from Adaptable State",uiLabel:"Get Custom Sort State"},{name:"showCustomSortPopup",kind:"function",description:"Opens Settings Panel with Custom Sort section selected and visible",uiLabel:"Show Custom Sort Popup"},{name:"suspendCustomSort",kind:"function",description:"Suspends Custom Sort",uiLabel:"Suspend Custom Sort"},{name:"unSuspendCustomSort",kind:"function",description:"Un-suspends or activates a suspended Custom Sort",uiLabel:"Un Suspend Custom Sort"}]},CustomSortPermittedValues:{name:"CustomSortPermittedValues",kind:"Interface",description:"Custom column values for Custom Sort",properties:[{name:"values",kind:"unknown",description:"Values to display in Custom Sort Wizard: either hardcoded list or a function that returns a list",uiLabel:"Values"}]},CustomSortState:{name:"CustomSortState",kind:"Interface",description:"Predefined Configuration for Custom Sort Module",properties:[{name:"CustomSorts",kind:"array",description:"Collection of Custom Sort objects.",uiLabel:"Custom Sorts",isOptional:!0}]},CustomToolbar:{name:"CustomToolbar",kind:"Interface",description:"Custom Toolbar (which AdapTable will manage) enabling devs to populate Dashboard with bepoke content",properties:[{name:"frameworkComponent",kind:"REFERENCE",description:"The Framework-specific (Angular or React) component to be rendered",uiLabel:"Framework Component",isOptional:!0,reference:"unknown"},{name:"name",kind:"string",description:"How Toolbar is referenced (e.g. in Dashboard Popup when managing toolbars)",uiLabel:"Name"},{name:"render",kind:"function",description:"Function to provide custom content when NOT using a Framework wrapper",uiLabel:"Render",isOptional:!0},{name:"showCloseButton",kind:"boolean",description:"Shows a Close button at the bottom of Custom Toolbar",uiLabel:"Show Close Button",isOptional:!0},{name:"showConfigureButton",kind:"boolean",description:"Shows a Configure (wrench) button which when clicked fires `CustomToolbarConfigured` event",uiLabel:"Show Configure Button",isOptional:!0},{name:"title",kind:"string",description:"Title to display in Toolbar; if unset or empty string, nothing will show",uiLabel:"Title",isOptional:!0},{name:"toolbarButtons",kind:"array",description:"Optional set of buttons to show in the Toolbar",uiLabel:"Toolbar Buttons",isOptional:!0}]},CustomToolbarButtonContext:{name:"CustomToolbarButtonContext",kind:"Interface",description:"Context required by functions when using a Custom Toolbar Button",properties:[{name:"customToolbar",kind:"REFERENCE",description:"Custom Toolbar which hosts the Button",uiLabel:"Custom Toolbar",reference:"CustomToolbar"}]},CustomToolbarConfiguredInfo:{name:"CustomToolbarConfiguredInfo",kind:"Interface",description:"EventInfo returned by the CustomToolbarConfigured event",properties:[{name:"customToolbar",kind:"REFERENCE",description:"Custom Toolbar in which the 'Configure' button has been clicked",uiLabel:"Custom Toolbar",reference:"CustomToolbar"}]},CustomToolPanel:{name:"CustomToolPanel",kind:"Interface",description:"Defines a Custom ToolPanel - provided by Users and contains custom content",properties:[{name:"buttons",kind:"array",description:"Optional set of buttons to show in the ToolPanel",uiLabel:"Buttons",isOptional:!0},{name:"frameworkComponent",kind:"REFERENCE",description:"Framework-specific (Angular or React) component to be rendered",uiLabel:"Framework Component",isOptional:!0,reference:"unknown"},{name:"name",kind:"string",description:"Name of Custom ToolPanel - should be unique",uiLabel:"Name"},{name:"render",kind:"function",description:"Function to provide bespoke content when NOT using a Framework wrapper",uiLabel:"Render",isOptional:!0},{name:"title",kind:"string",description:"Title to display in Custom ToolPanel; if undefined, will default to `name` property",uiLabel:"Title",isOptional:!0}]},DashboardApi:{name:"DashboardApi",kind:"Interface",description:"Functions relating to the AdapTable Dashboard.",properties:[{name:"collapseDashboard",kind:"function",description:"Collapses Dashboard so only Dashboard Header is visible (and not Toolbars' contents)",uiLabel:"Collapse Dashboard"},{name:"dockDashboard",kind:"function",description:"Docks Dashboard so it 'snaps back' into its customary position above the grid",uiLabel:"Dock Dashboard"},{name:"expandDashboard",kind:"function",description:"Expands Dashboard so Toolbars in Active Tab are fully visible",uiLabel:"Expand Dashboard"},{name:"fireDashboardChangedEvent",kind:"function",description:"Fires Dashboard Changed Event",uiLabel:"Fire Dashboard Changed Event"},{name:"floatDashboard",kind:"function",description:"Floats Dashboard so only Dashboard Header is visible (in reduced size); can be dragged to a new location",uiLabel:"Float Dashboard"},{name:"getActiveTab",kind:"function",description:"Returns current Active Tab (if there is one)",uiLabel:"Get Active Tab"},{name:"getActiveTabIndex",kind:"function",description:"Returns current Active Tab index (if there is one)",uiLabel:"Get Active Tab Index"},{name:"getCurrentToolbars",kind:"function",description:"Retrieves all Toolbars in Active Tab",uiLabel:"Get Current Toolbars"},{name:"getCustomDashboardButtonByLabel",kind:"function",description:"Retrieves first Custom Button with given Label",uiLabel:"Get Custom Dashboard Button By Label"},{name:"getCustomDashboardButtons",kind:"function",description:"Retrieves all Custom Buttons",uiLabel:"Get Custom Dashboard Buttons"},{name:"getCustomToolbarByName",kind:"function",description:"Returns Custom Toolbar with the given name",uiLabel:"Get Custom Toolbar By Name"},{name:"getCustomToolbarContentsDiv",kind:"function",description:"Returns 'div' element for given Custom Toolbar",uiLabel:"Get Custom Toolbar Contents Div"},{name:"getCustomToolbars",kind:"function",description:"Retrieves all Custom Toolbars",uiLabel:"Get Custom Toolbars"},{name:"getDashboardState",kind:"function",description:"Retrieves Dashboard section from Adaptable State",uiLabel:"Get Dashboard State"},{name:"getTabByName",kind:"function",description:"Retrieves the Tab from State that matches inputted name",uiLabel:"Get Tab By Name"},{name:"hasCustomToolbarChanged",kind:"function",description:"Has a custom toolbar become visible or",uiLabel:"Has Custom Toolbar Changed"},{name:"hideDashboard",kind:"function",description:"Hides the Dashboard so cannot be seen",uiLabel:"Hide Dashboard"},{name:"isDashboardCollapsed",kind:"function",description:"Is Dashboard Collapsed",uiLabel:"Is Dashboard Collapsed"},{name:"isDashboardDocked",kind:"function",description:"Is Dashboard Docked",uiLabel:"Is Dashboard Docked"},{name:"isDashboardExpanded",kind:"function",description:"Is Dashboard Expanded",uiLabel:"Is Dashboard Expanded"},{name:"isDashboardFloating",kind:"function",description:"Is Dashboard Floating",uiLabel:"Is Dashboard Floating"},{name:"isDashboardHidden",kind:"function",description:"Is Dashboard Hidden",uiLabel:"Is Dashboard Hidden"},{name:"isDashboardVisible",kind:"function",description:"Is Dashboard Visible",uiLabel:"Is Dashboard Visible"},{name:"isToolbarVisible",kind:"function",description:"Checks if a given Toolbar is visible",uiLabel:"Is Toolbar Visible"},{name:"refreshDashboard",kind:"function",description:"Refreshes the entire Dashboard section, including Toolbars and Buttons; this is particularly relevant for AdapTable built-in elements, as framework components are dependent on the framework specific change detection mechanisms",uiLabel:"Refresh Dashboard"},{name:"setActiveTab",kind:"function",description:"Sets Active Tab in Dashboard",uiLabel:"Set Active Tab"},{name:"setActiveTabIndex",kind:"function",description:"Sets Active Tab in Dashboard",uiLabel:"Set Active Tab Index"},{name:"setCustomToolbarContents",kind:"function",description:"Populates a Custom Toolbar with content",uiLabel:"Set Custom Toolbar Contents"},{name:"setDashboardTitle",kind:"function",description:"Sets title of Dashboard Header",uiLabel:"Set Dashboard Title"},{name:"setModuleButtons",kind:"function",description:"Sets which Module Buttons are visible",uiLabel:"Set Module Buttons"},{name:"showDashboard",kind:"function",description:"Makes the Dashboard visible",uiLabel:"Show Dashboard"},{name:"showDashboardPopup",kind:"function",description:"Opens Settings Panel with Dashboard section selected and visible",uiLabel:"Show Dashboard Popup"}]},DashboardButtonContext:{name:"DashboardButtonContext",kind:"Interface",description:"Context required by functions when using a Dashboard Button",properties:[{name:"dashboardState",kind:"REFERENCE",description:"Current Dashboard State",uiLabel:"Dashboard State",reference:"DashboardState"}]},DashboardChangedInfo:{name:"DashboardChangedInfo",kind:"Interface",description:"Object returned by the `DashboardChanged` event",properties:[{name:"actionName",kind:"string",description:"What caused Dashboard State to change",uiLabel:"Action Name"},{name:"newDashboardState",kind:"REFERENCE",description:"Current Dashboard State",uiLabel:"New Dashboard State",reference:"DashboardState"},{name:"oldDashboardState",kind:"REFERENCE",description:"Previous Dashboard State",uiLabel:"Old Dashboard State",reference:"DashboardState"}]},DashboardOptions:{name:"DashboardOptions",kind:"Interface",description:"Options related to the Dashboard in Adaptable.",properties:[{name:"buttonsLocation",kind:"'left' | 'right'",description:"Where in Dashboard to display Module and Custom Buttons",uiLabel:"Buttons Location",isOptional:!0,defaultValue:"'right'"},{name:"canFloat",kind:"boolean",description:"Whether the Dashboard can be floated; if true (the default), double-clicking Dashboard puts it in float mode",uiLabel:"Can Float",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"customDashboardButtons",kind:"array",description:"Custom Adaptable Buttons to appear in Dashboard (alongside Module Buttons)",uiLabel:"Custom Dashboard Buttons",isOptional:!0},{name:"customToolbars",kind:"array",description:"Toolbars provided by Users which contain custom content",uiLabel:"Custom Toolbars",isOptional:!0},{name:"showQuickSearchInHeader",kind:"boolean",description:"Shows Quick Search textbox in the Dashboard Header",uiLabel:"Show Quick Search In Header",isOptional:!0,gridInfo:"item",defaultValue:"true"}]},DashboardState:{name:"DashboardState",kind:"Interface",description:"Predefined Configuration for the AdapTable Dashboard",properties:[{name:"ActiveTabIndex",kind:"number",description:"The index of the Active Tab (in Tabs collection)",uiLabel:"Active Tab Index",isOptional:!0},{name:"DashboardTitle",kind:"string",description:"Title to display in Dashboard Header",uiLabel:"Dashboard Title",isOptional:!0,defaultValue:"`adaptableId` in Adaptable Options"},{name:"FloatingPosition",kind:"REFERENCE",description:"Position of Dashboard when in 'floating mode'",uiLabel:"Floating Position",isOptional:!0,reference:"AdaptableCoordinate"},{name:"IsCollapsed",kind:"boolean",description:"Whether Dashboard is collapsed; if true, header is visible (but not tabs' contents)",uiLabel:"Is Collapsed",isOptional:!0,defaultValue:"false"},{name:"IsFloating",kind:"boolean",description:"Whether Dashboard is floating; if true, appears in draggable, minmised form (double-click to revert to default position)",uiLabel:"Is Floating",isOptional:!0,defaultValue:"false"},{name:"IsHidden",kind:"boolean",description:"Whether Dashboard is completely hidden - can be made visible again in Column menu and toolpanel",uiLabel:"Is Hidden",isOptional:!0,defaultValue:"false"},{name:"IsInline",kind:"boolean",description:"Alternative way of showing Expanded Dashboard where headers section is to left of Toolbars",uiLabel:"Is Inline",isOptional:!0,defaultValue:"false"},{name:"ModuleButtons",kind:"REFERENCE",description:"Module Buttons which open screen in Settings Panel for associated AdapTable Module",uiLabel:"Module Buttons",isOptional:!0,defaultValue:"['SettingsPanel']",reference:"unknown"},{name:"Tabs",kind:"array",description:"Named group of Toolbars",uiLabel:"Tabs",isOptional:!0,defaultValue:"Empty Array"}]},DashboardTab:{name:"DashboardTab",kind:"Interface",description:"Defines a named set of Toolbars in the AdapTable Dashboard",properties:[{name:"Name",kind:"string",description:"Name of the tab - as appears in the Dashboard",uiLabel:"Name"},{name:"Toolbars",kind:"unknown",description:"List of Toolbars to show in the Tab",uiLabel:"Toolbars"}]},DataChangeHistoryApi:{name:"DataChangeHistoryApi",kind:"Interface",description:"Provides run-time access to the Data Change History Module",properties:[{name:"activateDataChangeHistory",kind:"function",description:"Activates Data Change History tracking (or resumes it, if it is currently suspended)",uiLabel:"Activate Data Change History"},{name:"deactivateDataChangeHistory",kind:"function",description:"Deactivates Data Change History tracking and flushes the cache",uiLabel:"Deactivate Data Change History"},{name:"getDataChangeHistoryLog",kind:"function",description:"Retrieves all data changes which are currently available",uiLabel:"Get Data Change History Log"},{name:"getDataChangeHistoryMode",kind:"function",description:"Retrieves current Data Change History mode: 'ACTIVE', 'INACTIVE', 'SUSPENDED'",uiLabel:"Get Data Change History Mode"},{name:"showDataChangeHistoryPopup",kind:"function",description:"Opens Data Change History screen",uiLabel:"Show Data Change History Popup"},{name:"suspendDataChangeHistory",kind:"function",description:"Suspends data change history tracking",uiLabel:"Suspend Data Change History"},{name:"undoDataChangeHistoryEntry",kind:"function",description:"Reverts the provided data change to its previous value",uiLabel:"Undo Data Change History Entry"}]},DataChangeHistoryButton:{name:"DataChangeHistoryButton",kind:"Interface",description:"A custom AdaptableButton which provides a build in `undo` action"},DataChangeHistoryContext:{name:"DataChangeHistoryContext",kind:"Interface",description:"The context for the DataChangeHistoryButton",properties:[{name:"dataChangedInfo",kind:"REFERENCE",description:"The initial data change",uiLabel:"Data Changed Info",reference:"CellDataChangedInfo"},{name:"isGroupNode",kind:"boolean",description:"If the change references a group node.",uiLabel:"Is Group Node"},{name:"undoDataChange",kind:"unknown",description:"Helper function to undo the change.",uiLabel:"Undo Data Change"}]},DataChangeHistoryOptions:{name:"DataChangeHistoryOptions",kind:"Interface",description:"Options to manage the 'Data Change History Module', which provides an overview of all previous changes, giving the possibility to undo specific changes",properties:[{name:"activeByDefault",kind:"boolean",description:"Whether data change history should be active by default",uiLabel:"Active By Default",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"changeHistoryButton",kind:"unknown",description:"Action button definition. Can be used to implement undo functionality.",uiLabel:"Change History Button",isOptional:!0,defaultValue:"undefined"},{name:"showDataChange",kind:"function",description:"Function specifying which data changes to include in Data Change History",uiLabel:"Show Data Change",isOptional:!0,gridInfo:"item",defaultValue:"undefined (all data changes are logged)"}]},DataSet:{name:"DataSet",kind:"Interface",description:"Defines a Data Set object that can provide data to AdapTable",properties:[{name:"description",kind:"string",description:"Describes the Data Set",uiLabel:"Description"},{name:"form",kind:"unknown",description:"Params for Data Set popup form",uiLabel:"Form",isOptional:!0},{name:"name",kind:"string",description:"Name of Data Set",uiLabel:"Name"}]},DataSetApi:{name:"DataSetApi",kind:"Interface",description:"Provides run-time access to Data Sets",properties:[{name:"clearCurrentDataSet",kind:"function",description:"Clears currently selected Data Set",uiLabel:"Clear Current Data Set"},{name:"fireDataSetSelectedEvent",kind:"function",description:"Fires the DataSet Selected Event",uiLabel:"Fire Data Set Selected Event"},{name:"getAllDataSets",kind:"function",description:"Retrieves the Data Sets from General Options",uiLabel:"Get All Data Sets"},{name:"getCurrentDataSet",kind:"function",description:"Retrieves the currently applied Data Set",uiLabel:"Get Current Data Set"},{name:"getDataSetByName",kind:"function",description:"Retreives Data Set from State with given name",uiLabel:"Get Data Set By Name"},{name:"setDataSet",kind:"function",description:"Makes given Data Set current",uiLabel:"Set Data Set"},{name:"showDataSetPopup",kind:"function",description:"Opens Settings Panel with Data Set section selected and visible",uiLabel:"Show Data Set Popup"}]},DataSetFormContext:{name:"DataSetFormContext",kind:"Interface",description:"Used when a DataSet displays a Form",properties:[{name:"dataSet",kind:"REFERENCE",description:"The DataSet which triggered the Form",uiLabel:"Data Set",reference:"DataSet"}]},DataSetSelectedInfo:{name:"DataSetSelectedInfo",kind:"Interface",description:"Object returned by the `DataSetSelected` event",properties:[{name:"dataSet",kind:"REFERENCE",description:"The DataSet that has been selected",uiLabel:"Data Set",reference:"DataSet"}]},DataUpdateConfig:{name:"DataUpdateConfig",kind:"Interface",description:"Object passed into Adaptable Grid Api data management methods",properties:[{name:"addIndex",kind:"number",description:"Index where to add new rows",uiLabel:"Add Index",isOptional:!0},{name:"callback",kind:"unknown",description:"Callback function invoked when a batch successfully updates",uiLabel:"Callback",isOptional:!0},{name:"runAsync",kind:"boolean",description:"Whether data should be updated asynchronously",uiLabel:"Run Async",isOptional:!0}]},DateFormatterOptions:{name:"DateFormatterOptions",kind:"Interface",description:"Formatter Options for Date Columns - contains a single `Pattern` property",properties:[{name:"Pattern",kind:"string",description:"Pattern to use for Date Format",uiLabel:"Pattern",isOptional:!0}]},DateInputOptions:{name:"DateInputOptions",kind:"Interface",description:"Options for managing and customizing the date inputs.",properties:[{name:"dateFormat",kind:"string",description:"Format string for formatting date input field",uiLabel:"Date Format",isOptional:!0,defaultValue:"'yyyy-MM-dd'"},{name:"datepickerButtons",kind:"array",description:"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 `|`",uiLabel:"Datepicker Buttons",isOptional:!0,defaultValue:"['close','today']"},{name:"locale",kind:"unknown",description:"Locale object (to localize Date Picker)",uiLabel:"Locale",isOptional:!0,defaultValue:"`en-US`"},{name:"showOutsideDays",kind:"boolean",description:"Display outside days (i.e. those falling in next or previous month)",uiLabel:"Show Outside Days",isOptional:!0,defaultValue:"true"},{name:"showWeekNumber",kind:"boolean",description:"Display the week numbers column",uiLabel:"Show Week Number",isOptional:!0,defaultValue:"false"},{name:"useNativeInput",kind:"boolean",description:"Use browser specific date input instead of AdapTable's Date Picker",uiLabel:"Use Native Input",isOptional:!0,defaultValue:"false"}]},DefaultAccessLevelContext:{name:"DefaultAccessLevelContext",kind:"Interface",description:"Provided to defaultAccessLevel function when setting Default Entitlement value programatically",properties:[{name:"adaptableId",kind:"string",description:"Id of current AdapTable instance",uiLabel:"Adaptable Id"},{name:"userName",kind:"string",description:"Name of Current User",uiLabel:"User Name"}]},DeletedActionRowInfo:{name:"DeletedActionRowInfo",kind:"Interface",description:"Info passed into ActionRowSubmitted Event for Deleted Rows",properties:[{name:"rowNode",kind:"REFERENCE",description:"Node being deleted",uiLabel:"Row Node",reference:"unknown"},{name:"type",kind:"unknown",description:"Specifies its a Deleted Action Row",uiLabel:"Type"}]},EditActionRowContext:{name:"EditActionRowContext",kind:"Interface",description:"Context used in an Edit Row Form",properties:[{name:"rowNode",kind:"REFERENCE",description:"The RowNode being edited",uiLabel:"Row Node",reference:"unknown"},{name:"type",kind:"unknown",description:"Type of the Context",uiLabel:"Type"}]},EditedActionRowInfo:{name:"EditedActionRowInfo",kind:"Interface",description:"Info passed into ActionRowSubmitted Event for Edited Rows",properties:[{name:"formData",kind:"REFERENCE",description:"Data entered in the Form",uiLabel:"Form Data",reference:"unknown"},{name:"rowNode",kind:"REFERENCE",description:"Node being edited",uiLabel:"Row Node",reference:"unknown"},{name:"type",kind:"unknown",description:"Specifies its an Edited Action Row",uiLabel:"Type"}]},EditLookUpContext:{name:"EditLookUpContext",kind:"Interface",description:"Context used when getting EditLookUpPermittedValues via a function",properties:[{name:"gridCell",kind:"REFERENCE",description:"Cell being edited",uiLabel:"Grid Cell",isOptional:!0,reference:"GridCell"}]},EditLookUpPermittedValues:{name:"EditLookUpPermittedValues",kind:"Interface",description:"Used to define permitted values for inline column editor",properties:[{name:"values",kind:"unknown",description:"Values to display in Edit Look Up: either hardcoded list or a function that returns a list",uiLabel:"Values",isOptional:!0}]},EditOptions:{name:"EditOptions",kind:"Interface",description:"Options related to Editing in Adaptable - includes Server Validation, Smart Edit Operations and Row Forms",properties:[{name:"displayServerValidationMessages",kind:"boolean",description:"Whether to display message after Server Validation runs",uiLabel:"Display Server Validation Messages",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"isCellEditable",kind:"function",description:"Function which checks if a given Grid Cell is editable",uiLabel:"Is Cell Editable",isOptional:!0},{name:"smartEditCustomOperations",kind:"array",description:"Custom Operations to use in Smart Edit",uiLabel:"Smart Edit Custom Operations",isOptional:!0},{name:"validateOnServer",kind:"unknown",description:"Function to validate Adaptable data edits on Server",uiLabel:"Validate On Server",isOptional:!0}]},EntitlementContext:{name:"EntitlementContext",kind:"Interface",description:"Provided to moduleEntitlements function when setting Entitlements programatically",properties:[{name:"adaptableId",kind:"string",description:"Id of current AdapTable instance",uiLabel:"Adaptable Id"},{name:"adaptableModule",kind:"REFERENCE",description:"Module being entitled",uiLabel:"Adaptable Module",reference:"AdaptableModule"},{name:"defaultAccessLevel",kind:"REFERENCE",description:"The default Access Level for the current instance",uiLabel:"Default Access Level",reference:"AccessLevel"},{name:"userName",kind:"string",description:"Name of Current User",uiLabel:"User Name"}]},EntitlementOptions:{name:"EntitlementOptions",kind:"Interface",description:"Options for managing Entitlements in AdapTable, ie. which Modules are available to the User and whether as *Full*, *ReadOnly* or *Hidden*.",properties:[{name:"defaultAccessLevel",kind:"unknown",description:"AccessLevel to use when an Entitlement is not explicitly set; can be hardcoded value or a function to invoke",uiLabel:"Default Access Level",isOptional:!0,gridInfo:"item",defaultValue:"'Full'"},{name:"moduleEntitlements",kind:"unknown",description:"Returns either collection of `Entitlements`, or a function to invoke when an Entitlement is required",uiLabel:"Module Entitlements",isOptional:!0,gridInfo:"item"}]},EvaluateExpressionExternallyContext:{name:"EvaluateExpressionExternallyContext",kind:"Interface",description:"Context passed when evaluating `AdaptableQLOptions.evaluateExpressionExternally()`",properties:[{name:"expression",kind:"string",description:"Expression to evlauate",uiLabel:"Expression",isOptional:!0},{name:"module",kind:"REFERENCE",description:"Module where the Expression is being evaluated",uiLabel:"Module",reference:"unknown"},{name:"referencedColumns",kind:"array",description:"Columns contained in the Expression",uiLabel:"Referenced Columns",isOptional:!0}]},EventApi:{name:"EventApi",kind:"Interface",description:"Responsible for publishing the many Events that AdapTable fires",properties:[{name:"off",kind:"function",description:"",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from SystemStatusMessageDisplayed",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from AlertFired",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from FlashingCellDisplayed",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from CheckboCxolumnClicked",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from LayoutChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from CustomToolbarConfigured",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from DashboardChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from AdaptableStateChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from AdaptableStateReloaded",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from LiveDataChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from GridSorted",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from ActionRowSubmitted",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from DataSetSelected",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from AdaptableReady",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from FDC3MessageSent",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from QueryRun",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from FilterApplied",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from CellChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from TeamSharingEntityChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from GridDataChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from SelectionChanged",uiLabel:"Off"},{name:"off",kind:"function",description:"Unsubscribe from ThemeChanged",uiLabel:"Off"},{name:"on",kind:"function",description:"",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever a **System Status Message is displayed** in AdapTable",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever an **Alert is triggered** in AdapTable.",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever **Cell Flashing** is triggered in AdapTable.",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever the **Button in a Checkbox Column is clicked**.",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever the current Layout updates in AdapTable",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever **Configure Button is clicked in a Custom Toolbar**",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever **Dashboard State changes** Primarily used for rendering Custom toolbars.",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever **Adaptable State changes**",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever **Adaptable State is reloaded**",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever **a change occurs relating to live reports / data** Used in conjunction with AdapTable's partners OpenFin, ipushpull or Glue42",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever AdapTable is Sorted",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired when an Action Row is submitted",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired when a DataSet is Selected",uiLabel:"On"},{name:"on",kind:"function",description:"Fired when Adaptable is up and running - has no arguments.",uiLabel:"On"},{name:"on",kind:"function",description:"Fired when Adaptable is destroyed",uiLabel:"On"},{name:"on",kind:"function",description:"Fired when an FDC3Message is sent",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever a Query is run in AdapTable",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever a Filter is Applied in AdapTable",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever a cell changes in the Grid",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever a Shared Entity in Team Sharing changes",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired when a row is added, deleted or updated in the Grid",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever the Cell or Row **Selection in AdapTable changes**.",uiLabel:"On"},{name:"on",kind:"function",description:"Event fired whenever the **selected theme of AdapTable is changed**.",uiLabel:"On"}]},ExportApi:{name:"ExportApi",kind:"Interface",description:"Provides run-time access to the Export Module and Report state",properties:[{name:"canExportToExcel",kind:"function",description:"If this AdapTable instance can to export to Excel; if false, the Export to Excel option will not be visible",uiLabel:"Can Export To Excel"},{name:"editReport",kind:"function",description:"Edits an existing report",uiLabel:"Edit Report"},{name:"editReports",kind:"function",description:"Edits existing reports",uiLabel:"Edit Reports"},{name:"exportDataToExcel",kind:"function",description:"Exports data to Excel",uiLabel:"Export Data To Excel"},{name:"exportVisualDataToExcel",kind:"function",description:"Exports data currently in grid to Excel as What-You-See-Is-What-You-Get",uiLabel:"Export Visual Data To Excel"},{name:"getAllCustomDestination",kind:"function",description:"Retrieves all Custom Destinations from Export Options",uiLabel:"Get All Custom Destination"},{name:"getAllReports",kind:"function",description:"Retrieves all Reports in State - both System and User-created Reports",uiLabel:"Get All Reports"},{name:"getAllServerReports",kind:"function",description:"Returns any Custom Reports that have been provided to Export Options",uiLabel:"Get All Server Reports"},{name:"getAvailableExportDestinations",kind:"function",description:"Retrieves the available export destinations",uiLabel:"Get Available Export Destinations"},{name:"getAvailableSystemReports",kind:"function",description:"Retrieves System Reports section of Export State",uiLabel:"Get Available System Reports"},{name:"getCurrentDestination",kind:"function",description:"Retrieves the current Export destination",uiLabel:"Get Current Destination"},{name:"getCurrentReport",kind:"function",description:"Retrieves currently selected Report",uiLabel:"Get Current Report"},{name:"getCurrentReportName",kind:"function",description:"Retrieves name of currently selected Report",uiLabel:"Get Current Report Name"},{name:"getDestinationByName",kind:"function",description:"Retrieves Destination with the given name",uiLabel:"Get Destination By Name"},{name:"getExportDestinationForm",kind:"function",description:"Form Data entered by the User in the UI for a Custom Destination",uiLabel:"Get Export Destination Form"},{name:"getExportState",kind:"function",description:"Retrieves Export section from Adaptable State",uiLabel:"Get Export State"},{name:"getReportById",kind:"function",description:"Retrieves Report by Id",uiLabel:"Get Report By Id"},{name:"getReportByName",kind:"function",description:"Retrieves Report with the given name",uiLabel:"Get Report By Name"},{name:"getReportDataForReport",kind:"function",description:"Returns the ReportData for the Report with the given name",uiLabel:"Get Report Data For Report"},{name:"getReportSchedules",kind:"function",description:"Retrieves all Report Schedules",uiLabel:"Get Report Schedules"},{name:"isDataChangeInReport",kind:"function",description:"Whether given data change affects given report",uiLabel:"Is Data Change In Report"},{name:"isExportDestinationCustom",kind:"function",description:"If the given destination is a Custom one",uiLabel:"Is Export Destination Custom"},{name:"isServerReport",kind:"function",description:"Whether a Report is a Custom Report",uiLabel:"Is Server Report"},{name:"runServerReport",kind:"function",description:"Runs the report function of the ServerReport with the given reportName",uiLabel:"Run Server Report"},{name:"selectDestination",kind:"function",description:"Selects the report destination in the dashboard and statusbar UI",uiLabel:"Select Destination"},{name:"selectReport",kind:"function",description:"Selects the report in the dashboard and statusbar UI",uiLabel:"Select Report"},{name:"sendReport",kind:"function",description:"Sends a Report to a given destination",uiLabel:"Send Report"},{name:"showExportPopup",kind:"function",description:"Opens Settings Panel with Export section selected and visible",uiLabel:"Show Export Popup"}]},ExportFormContext:{name:"ExportFormContext",kind:"Interface",description:"Context required by functions when using an Export Button",properties:[{name:"customDestination",kind:"REFERENCE",description:"Custom Export destination",uiLabel:"Custom Destination",reference:"CustomDestination"},{name:"report",kind:"REFERENCE",description:"The exported report",uiLabel:"Report",reference:"unknown"},{name:"reportData",kind:"REFERENCE",description:"The data in the report",uiLabel:"Report Data",reference:"ReportData"}]},ExportOptions:{name:"ExportOptions",kind:"Interface",description:"Options regarding Exporting data from AdapTable",properties:[{name:"appendFileTimestamp",kind:"boolean",description:"Whether to add a timestamp as a suffix to exported file name",uiLabel:"Append File Timestamp",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"customDestinations",kind:"array",description:"User-provided Report Destinations (in addition to those shipped in AdapTable)",uiLabel:"Custom Destinations",isOptional:!0},{name:"exportDateFormat",kind:"string",description:"Optional custom format for Date columns when exporting",uiLabel:"Export Date Format",isOptional:!0,gridInfo:"item",defaultValue:"undefined"},{name:"exportFormatType",kind:"unknown",description:"Format of exported values; can be set either for whole grid or specifically for each column type",uiLabel:"Export Format Type",isOptional:!0,defaultValue:"rawValue"},{name:"serverReports",kind:"array",description:"Reports run entirely by users (and not AdapTable)",uiLabel:"Server Reports",isOptional:!0},{name:"systemExportDestinations",kind:"REFERENCE",description:"Export destinations to use; leave blank for all, empty array for none",uiLabel:"System Export Destinations",isOptional:!0,gridInfo:"item",defaultValue:"'Excel', 'CSV', 'Clipboard', 'JSON'",reference:"SystemExportDestinations"},{name:"systemReportNames",kind:"REFERENCE",description:"System Reports to use; leave blank for all, empty array for none",uiLabel:"System Report Names",isOptional:!0,gridInfo:"item",defaultValue:"'Visual Data', 'All Data', 'Current Data', 'Selected Cells', 'Selected Rows',",reference:"SystemReportNames"}]},ExportState:{name:"ExportState",kind:"Interface",description:"Predefined Configuration for Export Module",properties:[{name:"CurrentDestination",kind:"unknown",description:"Currently selected Report Destination in Export Toolbar & Tool Panel",uiLabel:"Current Destination",isOptional:!0},{name:"CurrentReport",kind:"string",description:"Currently selected Report - in Export Toolbar & Tool Panel",uiLabel:"Current Report",isOptional:!0},{name:"Reports",kind:"array",description:"User-created Reports; each has Name and Row and Column Scope",uiLabel:"Reports",isOptional:!0}]},ExpressionContext:{name:"ExpressionContext",kind:"Interface",description:"Provides context to an Expression Function, including current row node and AdaptableApi",properties:[{name:"evaluateCustomQueryVariable",kind:"unknown",description:"Evaluate custom variables",uiLabel:"Evaluate Custom Query Variable"},{name:"filterFn",kind:"unknown",description:"Optional filter function to be applied before evaluating the expression",uiLabel:"Filter Fn",isOptional:!0},{name:"functions",kind:"unknown",description:"All Expression Functions available to AdaptableQL",uiLabel:"Functions"},{name:"namedQueryCallStack",kind:"array",description:"All Named Query evaluations: tracked in order to detect circular dependencies",uiLabel:"Named Query Call Stack",isOptional:!0},{name:"node",kind:"unknown",description:"Current AG Grid Row Node being evaluated",uiLabel:"Node"},{name:"whereClauseFunctions",kind:"unknown",description:"Expression Functions available to AdaptableQL in (optional) WHERE clause",uiLabel:"Where Clause Functions",isOptional:!0}]},ExpressionFunction:{name:"ExpressionFunction",kind:"Interface",description:"Defines an AdaptableQL Function used in an Adaptable Expression",properties:[{name:"description",kind:"string",description:"What the AdaptableQL Function does",uiLabel:"Description",isOptional:!0},{name:"examples",kind:"array",description:"Examples that use the AdaptableQL Function",uiLabel:"Examples",isOptional:!0},{name:"handler",kind:"REFERENCE",description:"Actual AdaptableQL Function called by the Expression (mandatory prop)",uiLabel:"Handler",reference:"ExpressionFunctionHandler"},{name:"hasEagerEvaluation",kind:"boolean",description:"Whether Expression is evaluated eagerly (without handling inner AST nodes)",uiLabel:"Has Eager Evaluation",isOptional:!0},{name:"isHiddenFromMenu",kind:"boolean",description:"Removes entry from Expression Editor's Functions dropdown",uiLabel:"Is Hidden From Menu",isOptional:!0},{name:"isPredicate",kind:"boolean",description:"Whether the AdaptableQL Function returns true, if so can be used as Query",uiLabel:"Is Predicate",isOptional:!0},{name:"signatures",kind:"array",description:"How the AdaptableQL Function should be called",uiLabel:"Signatures",isOptional:!0}]},ExpressionFunctionDocBlock:{name:"ExpressionFunctionDocBlock",kind:"TypeAlias",description:"Defines how an AdaptableQL Function is described in Expression Editor"},ExpressionFunctionHandler:{name:"ExpressionFunctionHandler",kind:"TypeAlias",description:"The javascript function which is invoked by an AdaptableQL Function"},ExpressionFunctionMap:{name:"ExpressionFunctionMap",kind:"TypeAlias",description:"Key-Value map of Expression Names and their implementation"},ExpressionOptions:{name:"ExpressionOptions",kind:"Interface",description:"Options for managing Expressions using AdaptableQL",properties:[{name:"customBooleanFunctions",kind:"unknown",description:"Custom (user defined) Boolean Expression Functions available in AdaptableQL",uiLabel:"Custom Boolean Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (none)"},{name:"customQueryVariables",kind:"unknown",description:"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.",uiLabel:"Custom Query Variables",isOptional:!0},{name:"customScalarFunctions",kind:"unknown",description:"Custom (user defined) Scalar Expression Functions available in AdaptableQL",uiLabel:"Custom Scalar Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (none)"},{name:"isColumnQueryable",kind:"function",description:"Specifies if a given column can be included in Queries",uiLabel:"Is Column Queryable",isOptional:!0},{name:"maxTimeframeSize",kind:"number",description:"Maximum time (in milliseconds) to hold a Data Change event in a trailing timeframe (see observableExpressionFunctions); value is capped at 86400000 (~24 hours) for performance reasons",uiLabel:"Max Timeframe Size",isOptional:!0,gridInfo:"item",defaultValue:"28800000 (~8 hours)"},{name:"moduleExpressionFunctions",kind:"unknown",description:"Module specific ExpressionFunctions; if not defined, it falls back to the generally defined system and custom values",uiLabel:"Module Expression Functions",isOptional:!0,gridInfo:"item",defaultValue:"undefined (defaults to available system & custom values)"},{name:"performExpressionValidation",kind:"boolean",description:"Validate Expressions before they can be run or saved",uiLabel:"Perform Expression Validation",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"systemAggregatedBooleanFunctions",kind:"unknown",description:"System (built-in) AggregatedBoolean Expression Functions available in AdaptableQL",uiLabel:"System Aggregated Boolean Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"},{name:"systemAggregatedScalarFunctions",kind:"unknown",description:"System (built-in) AggregatedScalar Expression Functions available in AdaptableQL",uiLabel:"System Aggregated Scalar Functions",isOptional:!0,gridInfo:"item",defaultValue:"undefined (sets all)"},{name:"systemBooleanFunctions",kind:"unknown",description:"System (built-in) Boolean Expression Functions available in AdaptableQL",uiLabel:"System Boolean Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"},{name:"systemObservableFunctions",kind:"unknown",description:"System (built-in) Observable Expression Functions available in AdaptableQL",uiLabel:"System Observable Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"},{name:"systemScalarFunctions",kind:"unknown",description:"System (built-in) Scalar Expression Functions available in AdaptableQL",uiLabel:"System Scalar Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"}]},FDC3Column:{name:"FDC3Column",kind:"Interface",description:"An FDC3 Column - will raise FDC3 intents and broadcast FDC3 messages",properties:[{name:"broadcastContextMenuLabel",kind:"unknown",description:"Label to display in Broadcast Context Menu Item",uiLabel:"Broadcast Context Menu Label",isOptional:!0},{name:"columnId",kind:"string",description:"Id of Column defined as FDC3",uiLabel:"Column Id"},{name:"intentContextMenuLabel",kind:"unknown",description:"Label to display in Intent Context Menu Item",uiLabel:"Intent Context Menu Label",isOptional:!0},{name:"intentIcon",kind:"unknown",description:"Returns a custom icon to display in the Raise Intent Context Menu Item;",uiLabel:"Intent Icon",isOptional:!0},{name:"intents",kind:"array",description:"FDC3 intents which the Column can raise",uiLabel:"Intents",isOptional:!0},{name:"nameColumnId",kind:"string",description:"If provided, will supply `name` property in FDC3 message",uiLabel:"Name Column Id",isOptional:!0},{name:"showBroadcastContextMenu",kind:"boolean",description:"Should Column display a 'Broadcast' context menu item",uiLabel:"Show Broadcast Context Menu",isOptional:!0}]},FDC3Context:{name:"FDC3Context",kind:"Interface",description:"General-purpose context type, as defined by FDC3",properties:[{name:"id",kind:"{\n        [key: string]: string | undefined;\n    }",description:"Optional map of any equivalent identifiers for the context type, e.g. ISIN, CUSIP, etc. for Instrument",uiLabel:"Id",isOptional:!0},{name:"name",kind:"string",description:"Name of the context data (optional) - a text string that describes the data being sent",uiLabel:"Name",isOptional:!0},{name:"type",kind:"REFERENCE",description:"Type of FDC3Context that uniquely identifies it, e.g. "instrument"; used to refer to the accepted context(s) when declaring intents",uiLabel:"Type",reference:"FDC3ContextType"}]},FDC3ContextType:{name:"FDC3ContextType",kind:"TypeAlias",description:"Defines which FDC3 context is being used"},FDC3Intent:{name:"FDC3Intent",kind:"TypeAlias",description:"Full list of FDC3 Intents available - each FDC3 Column can use a subset"},FilterActionOnDataChange:{name:"FilterActionOnDataChange",kind:"Interface",description:"Whether Adaptable re-applies filtering after data edits; if `applyFilter` value is 'Throttle', `throttleDelay` should be set",properties:[{name:"applyFilter",kind:"'Always' | 'Never' | 'Throttle'",description:"When to re-apply Filters: 'Always', 'Never' or 'Throttle'",uiLabel:"Apply Filter"},{name:"throttleDelay",kind:"number",description:"Delay in ms (when `applyFilter` is set to 'Throttle')",uiLabel:"Throttle Delay",isOptional:!0}]},FilterApi:{name:"FilterApi",kind:"Interface",description:"Provides run-time access to Filter section of Adaptable State.",properties:[{name:"areColumnFiltersDifferent",kind:"function",description:"Compares to sets of Column Filters to see if they are identical",uiLabel:"Are Column Filters Different"},{name:"clearAndSetColumnFilter",kind:"function",description:"Clears existing Column Filters and sets new ones",uiLabel:"Clear And Set Column Filter"},{name:"clearColumnFilter",kind:"function",description:"Clears given Column Filter",uiLabel:"Clear Column Filter"},{name:"clearColumnFilterByColumn",kind:"function",description:"Clears Column Filter for given Column",uiLabel:"Clear Column Filter By Column"},{name:"clearColumnFilterByColumns",kind:"function",description:"Clears Column Filters for given set of Columns",uiLabel:"Clear Column Filter By Columns"},{name:"clearColumnFilters",kind:"function",description:"Clears all Column Filters in the Current Layout",uiLabel:"Clear Column Filters"},{name:"columnFiltersToString",kind:"function",description:"Retrieves descriptions of given Column Filters",uiLabel:"Column Filters To String"},{name:"columnFilterToString",kind:"function",description:"Retrieves description of given Column Filter",uiLabel:"Column Filter To String"},{name:"createEqualityColumnFilterForCell",kind:"function",description:"Creates an Equality Filter based on given Grid Cell",uiLabel:"Create Equality Column Filter For Cell"},{name:"createValuesColumnFilterForCells",kind:"function",description:"Creates an Equality Filter based on given Grid Cells",uiLabel:"Create Values Column Filter For Cells"},{name:"evaluateColumnFilter",kind:"function",description:"Calls AdapTableQL to evaluate Filter for given Row",uiLabel:"Evaluate Column Filter"},{name:"findPredicateDefByShortcut",kind:"function",description:"Returns Predicate Definition for given Column and Quick Filter shortcut",uiLabel:"Find Predicate Def By Shortcut"},{name:"fireFilterAppliedEvent",kind:"function",description:"Fires Filter Applied Event - typically used to enable filtering on the server",uiLabel:"Fire Filter Applied Event"},{name:"getActiveColumnFilters",kind:"function",description:"Retrieves all active/no-suspedned Column Filters in currently applied Layout",uiLabel:"Get Active Column Filters"},{name:"getAllColumnFilterForColumn",kind:"function",description:"Retrieves all Column Filters for given Column",uiLabel:"Get All Column Filter For Column"},{name:"getAllSystemFilterIds",kind:"function",description:"Retrieves Ids for all System Filters",uiLabel:"Get All System Filter Ids"},{name:"getColumnFilter",kind:"function",description:"Retrieves the Column Filter for the specified Column.",uiLabel:"Get Column Filter"},{name:"getColumnFilters",kind:"function",description:"Retrieves all Column Filters in currently applied Layout",uiLabel:"Get Column Filters"},{name:"getColumnFiltersForLayout",kind:"function",description:"Retrieves all Column Filters in a given Layout",uiLabel:"Get Column Filters For Layout"},{name:"getFilterPredicateDefsForColumn",kind:"function",description:"Gets all Filter Predicates available for a given Column",uiLabel:"Get Filter Predicate Defs For Column"},{name:"getFilterPredicateDefsForColumnId",kind:"function",description:"Gets all Filter Predicates available for a given ColumnId",uiLabel:"Get Filter Predicate Defs For Column Id"},{name:"hideQuickFilterBar",kind:"function",description:"Hides Quick Filter bar",uiLabel:"Hide Quick Filter Bar"},{name:"isFilterActive",kind:"function",description:"Checks if a filter is active or applied. It is applied when: - filter predicate does not have inputs - filter predicate has inputs with values",uiLabel:"Is Filter Active"},{name:"isQuickFilterAvailable",kind:"function",description:"Whether Quick Filter is available for use",uiLabel:"Is Quick Filter Available"},{name:"isQuickFilterVisible",kind:"function",description:"Whether Quick Filter Form is currently visible",uiLabel:"Is Quick Filter Visible"},{name:"setColumnFilter",kind:"function",description:"Sets Column Filters - will replace filters for existing column and leave other column filters in place",uiLabel:"Set Column Filter"},{name:"shouldNewColumnFilterTriggerGridFiltering",kind:"function",description:"Checks if the filter action should trigger grid filtering.",uiLabel:"Should New Column Filter Trigger Grid Filtering"},{name:"showQuickFilterBar",kind:"function",description:"Makes Quick Filter Bar appear",uiLabel:"Show Quick Filter Bar"},{name:"suspendAllColumnFilters",kind:"function",description:"Suspends all Column Filters",uiLabel:"Suspend All Column Filters"},{name:"suspendColumnFilter",kind:"function",description:"Suspends a Column Filter",uiLabel:"Suspend Column Filter"},{name:"unSuspendAllColumnFilters",kind:"function",description:"Unsuspends all Column Filters",uiLabel:"Un Suspend All Column Filters"},{name:"unSuspendColumnFilter",kind:"function",description:"Unsuspends a Column Filter",uiLabel:"Un Suspend Column Filter"}]},FilterAppliedInfo:{name:"FilterAppliedInfo",kind:"Interface",description:"EventInfo returned by the Filter Applied event",properties:[{name:"columnFilters",kind:"unknown",description:"Currently applied Column Filters",uiLabel:"Column Filters"}]},FilterOptions:{name:"FilterOptions",kind:"Interface",description:"Options for managing Filtering in AdapTable",properties:[{name:"autoApplyFilter",kind:"boolean",description:"Apply selected filters (in Filter Form or Quick Filter Bar) as soon as they are clicked; if false an Apply Filter button is displayed",uiLabel:"Auto Apply Filter",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"true"},{name:"clearFiltersOnStartUp",kind:"boolean",description:"Clears saved Column Filters when AdapTable loads",uiLabel:"Clear Filters On Start Up",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"defaultDateColumnFilter",kind:"unknown",description:"Default filter type for date Columns",uiLabel:"Default Date Column Filter",isOptional:!0,gridInfo:"item",defaultValue:"On"},{name:"defaultFilterFormTab",kind:"'Values' | 'Predicates'",description:"Whether to open the Filter Form on the Values or Predicates tab",uiLabel:"Default Filter Form Tab",isOptional:!0,gridInfo:"item",defaultValue:"'Values'"},{name:"defaultNumericColumnFilter",kind:"unknown",description:"Default filter type for numeric Columns",uiLabel:"Default Numeric Column Filter",isOptional:!0,gridInfo:"item",defaultValue:"Equals"},{name:"defaultStringColumnFilter",kind:"unknown",description:"Default filter type for string Columns",uiLabel:"Default String Column Filter",isOptional:!0,gridInfo:"item",defaultValue:"Contains"},{name:"enableFilterOnSpecialColumns",kind:"boolean",description:"Allows filtering on Calculated & FreeText columns",uiLabel:"Enable Filter On Special Columns",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"filterActionOnExternalDataChange",kind:"REFERENCE",description:"When to re-filter grid after data ticks: 'Always', 'Never' or 'Throttle' (which requires a 'ThrottleDelay')",uiLabel:"Filter Action On External Data Change",isOptional:!0,defaultValue:"'Never'",reference:"FilterActionOnDataChange"},{name:"filterActionOnUserDataChange",kind:"REFERENCE",description:"When to re-filter grid after user edits data: 'Always', 'Never' or 'Throttle' (which requires a 'ThrottleDelay')",uiLabel:"Filter Action On User Data Change",isOptional:!0,defaultValue:"'Always'",reference:"FilterActionOnDataChange"},{name:"hideQuickFilterDropdown",kind:"function",description:"Hides the Dropdown in Quick Filter Bar for a given Column",uiLabel:"Hide Quick Filter Dropdown",isOptional:!0,defaultValue:"undefined"},{name:"hideQuickFilterInput",kind:"function",description:"Hides the Input in Quick Filter Bar for a given Column",uiLabel:"Hide Quick Filter Input",isOptional:!0,defaultValue:"undefined"},{name:"indicateFilteredColumns",kind:"boolean",description:"Make Column header distinctive for filtered columns, helps users see currently filtered columns",uiLabel:"Indicate Filtered Columns",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"true"},{name:"maxFilterValuesToDisplay",kind:"number",description:"Distinct column items to display in Filter Form; useful with large datasource (though AdapTable offers virtualisation)",uiLabel:"Max Filter Values To Display",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"2,000"},{name:"quickFilterHeight",kind:"number",description:"Sets a height for Quick Filter Bar (if not provided AG Grid's default is used)",uiLabel:"Quick Filter Height",isOptional:!0,gridInfo:"item",defaultValue:"null"},{name:"quickFilterTrigger",kind:"'mouseenter' | 'click'",description:"Whether to open Quick Filter dropdown with mouse hover or click",uiLabel:"Quick Filter Trigger",isOptional:!0,gridInfo:"item",defaultValue:"'mouseenter'"},{name:"quickFilterValuesTrigger",kind:"'mouseenter' | 'click'",description:"Whether to open Quick Filter Values dropdown with mouse hover or click",uiLabel:"Quick Filter Values Trigger",isOptional:!0,gridInfo:"item",defaultValue:"'mouseenter'"},{name:"showClearFilterButton",kind:"boolean",description:"Display Clear Filter button in Toolbar and Toolpanel",uiLabel:"Show Clear Filter Button",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"showDistinctFilteredValuesOnly",kind:"boolean",description:"Display only currently filtered distinct values in Filter controls",uiLabel:"Show Distinct Filtered Values Only",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"showQuickFilter",kind:"boolean",description:"Whether to display Quick Filter Bar between Column Header and the Grid (provided its been setup)",uiLabel:"Show Quick Filter",isOptional:!0,defaultValue:"true"},{name:"showSuspendFilterButton",kind:"boolean",description:"Display Suspend / Unsuspend Button in Toolbar and Toolpanel",uiLabel:"Show Suspend Filter Button",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"sortColumnValuesInFilter",kind:"boolean",description:"Whether column values in filter dropdown should apply column's current Sort Order for the column",uiLabel:"Sort Column Values In Filter",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"systemFilters",kind:"unknown",description:"Set which System Filter Predicates are available, using list or function",uiLabel:"System Filters",isOptional:!0},{name:"useAdaptableFilterForm",kind:"boolean | string[]",description:"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",uiLabel:"Use Adaptable Filter Form",isOptional:!0,noCode:"item",defaultValue:"true"},{name:"useAdaptableQuickFilter",kind:"boolean | string[]",description:"Use Adaptable's Quick Filter Bar for all columns if 'true' (the default) or those listed, in preference to AG Grid's Floating Filter",uiLabel:"Use Adaptable Quick Filter",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"true"},{name:"useAgGridFilterFormStyle",kind:"boolean",description:"Styles Adaptable Filter Form to match AG Grid's styling (if using Balham theme)",uiLabel:"Use Ag Grid Filter Form Style",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"true"}]},FilterPermittedValues:{name:"FilterPermittedValues",kind:"Interface",description:"Used to define values inside the floating filter and floating filter (quick filter)",properties:[{name:"suppressFilterSearchBar",kind:"boolean",description:"Prevents AdapTable from filtering the list of values client-side; When true, values is called each time the search bar is changed",uiLabel:"Suppress Filter Search Bar",isOptional:!0,defaultValue:"false"},{name:"values",kind:"unknown",description:"Values to display in 'IN' Filter: either hardcoded list or a function that returns a list",uiLabel:"Values"}]},FilterPermittedValuesContext:{name:"FilterPermittedValuesContext",kind:"Interface",description:"Context used when getting FilterPermittedValues via a function",properties:[{name:"searchFilter",kind:"string",description:"A search string",uiLabel:"Search Filter"}]},FinanceApi:{name:"FinanceApi",kind:"Interface",description:"Provides run-time access to the Finance Plugin",properties:[{name:"createFDC3ContactContext",kind:"function",description:"Creates FDC3 Contact Context",uiLabel:"Create FDC3Contact Context"},{name:"createFDC3ContactListContext",kind:"function",description:"Creates FDC3 Contact List Context",uiLabel:"Create FDC3Contact List Context"},{name:"createFDC3CountryContext",kind:"function",description:"Creates FDC3 Country Context",uiLabel:"Create FDC3Country Context"},{name:"createFDC3InstrumentContext",kind:"function",description:"Creates FDC3 Instrument Context",uiLabel:"Create FDC3Instrument Context"},{name:"createFDC3InstrumentListContext",kind:"function",description:"Creates FDC3 Instrumentlist Context",uiLabel:"Create FDC3Instrument List Context"},{name:"createFDC3OrganizationContext",kind:"function",description:"Creates FDC3 Organization Context",uiLabel:"Create FDC3Organization Context"},{name:"createFDC3PortfolioContext",kind:"function",description:"Creates FDC3 Portfolio Context",uiLabel:"Create FDC3Portfolio Context"},{name:"createFDC3PositionContext",kind:"function",description:"Creates FDC3 Position Context",uiLabel:"Create FDC3Position Context"},{name:"getContactColumnById",kind:"function",description:"Gets Contact Column with given Id",uiLabel:"Get Contact Column By Id"},{name:"getCountryColumnById",kind:"function",description:"Gets Country Column with given Id",uiLabel:"Get Country Column By Id"},{name:"getInstrumentColumnById",kind:"function",description:"Gets Instrument Column with given Id",uiLabel:"Get Instrument Column By Id"},{name:"getOrganizationColumnById",kind:"function",description:"Gets Organization Column with given Id",uiLabel:"Get Organization Column By Id"},{name:"getPluginOptions",kind:"function",description:"Retrieves the FinancePlugOptions provided in the Finance Plugin",uiLabel:"Get Plugin Options"},{name:"getPositionColumnById",kind:"function",description:"Gets Position Column with given Id",uiLabel:"Get Position Column By Id"},{name:"isValidContactlistIntent",kind:"function",description:"Checks whether the Contact Intent is valid for Contact Lists",uiLabel:"Is Valid Contactlist Intent"},{name:"isValidInstrumentlistIntent",kind:"function",description:"Checks whether the Instrument Intent is valid for Instrument Lists",uiLabel:"Is Valid Instrumentlist Intent"},{name:"isValidPositionIntent",kind:"function",description:"Checks whether the Position Intent is valid for single Positions (and not Portfolios)",uiLabel:"Is Valid Position Intent"},{name:"publishBroadcastFDC3MessageEvent",kind:"function",description:"Publishes an FDC3 Message Event of type `Broadcast`",uiLabel:"Publish Broadcast FDC3Message Event"},{name:"publishRaiseFDC3IntentEvent",kind:"function",description:"Publishes an FDC3 Message Event of type `Raise Event`",uiLabel:"Publish Raise FDC3Intent Event"}]},FinancePluginOptions:{name:"FinancePluginOptions",kind:"Interface",description:"Options required for when using the Finance plugin",properties:[{name:"availableFDC3Intents",kind:"unknown",description:"Intents to which to subscribe.",uiLabel:"Available FDC3Intents",isOptional:!0},{name:"fdc3Columns",kind:"unknown",description:"Columns to be defined as FDC3-related",uiLabel:"Fdc3Columns",isOptional:!0},{name:"onFDC3Context",kind:"unknown",description:"Called when a context changes.",uiLabel:"On FDC3Context",isOptional:!0},{name:"onFDC3Intent",kind:"unknown",description:"Called when an intent from `availableIntents` is raised.",uiLabel:"On FDC3Intent",isOptional:!0},{name:"weightedAverageColumns",kind:"array",description:"",uiLabel:"Weighted Average Columns",isOptional:!0}]},FinsembleApi:{name:"FinsembleApi",kind:"Interface",description:"Provides run-time access to the Finsemble Plugin",properties:[{name:"getPluginOptions",kind:"function",description:"Retrieves the FinsemblePlugOptions provided in Finsemble Plugin",uiLabel:"Get Plugin Options"}]},FinsemblePluginOptions:{name:"FinsemblePluginOptions",kind:"Interface",description:"Options required for when using the Finsemble plugin",properties:[{name:"applicationName",kind:"string",description:"Application name - used to identify the application in Finsemble console",uiLabel:"Application Name",isOptional:!0},{name:"showAdaptableAlertsAsNotifications",kind:"boolean",description:"Should Adaptable's Alerts appear as Finsemble Notifications",uiLabel:"Show Adaptable Alerts As Notifications",isOptional:!0,defaultValue:"true"},{name:"stateOptions",kind:"REFERENCE",description:"Options for managing Adaptable State with Finsemble State",uiLabel:"State Options",isOptional:!0,reference:"unknown"}]},FlashingCellApi:{name:"FlashingCellApi",kind:"Interface",description:"Provides run-time access to Flashing Cell functionality and associated State",properties:[{name:"addFlashingCellDefinition",kind:"function",description:"Adds a Flashing cell Definition to State",uiLabel:"Add Flashing Cell Definition"},{name:"addFlashingCellDefinitions",kind:"function",description:"Adds provided Flashing cell Definitions",uiLabel:"Add Flashing Cell Definitions"},{name:"clearGridFlashing",kind:"function",description:"Clears all Cells and Rows which have been flashed (primarily used if duration is 'Always')",uiLabel:"Clear Grid Flashing"},{name:"editFlashingCellDefinition",kind:"function",description:"Edits Flashing Cell Definition in State with given one",uiLabel:"Edit Flashing Cell Definition"},{name:"editFlashingCellDefinitions",kind:"function",description:"Edits provided Flashing cell Definitions",uiLabel:"Edit Flashing Cell Definitions"},{name:"getActiveFlashingCellDefinitions",kind:"function",description:"Retrieves all active (non-suspended) cell Definitions in Flashing Cell State",uiLabel:"Get Active Flashing Cell Definitions"},{name:"getFlashingCellDefinitionById",kind:"function",description:"Retrieves Flashing cell Definition By Id",uiLabel:"Get Flashing Cell Definition By Id"},{name:"getFlashingCellDefinitions",kind:"function",description:"Retrieves all Flashing cell Definitions in Flashing Cell State",uiLabel:"Get Flashing Cell Definitions"},{name:"getFlashingCellFlashTarget",kind:"function",description:"Returns where a Flashing cell Definition will flash a single cell or a whole row",uiLabel:"Get Flashing Cell Flash Target"},{name:"getFlashingCellPredicateDefs",kind:"function",description:"Retrieves all Predicate Defs with Module Scope of Flashing Cell",uiLabel:"Get Flashing Cell Predicate Defs"},{name:"getFlashingCellPredicateDefsForScope",kind:"function",description:"Retrieves all Predicate Defs that match given Scope",uiLabel:"Get Flashing Cell Predicate Defs For Scope"},{name:"getFlashingCellState",kind:"function",description:"Retrieves Flashing Cell section from Adaptable State",uiLabel:"Get Flashing Cell State"},{name:"mergeFlashingCellDefinitionWithDefaults",kind:"function",description:"Merges a Flashing Cell Definition with default values",uiLabel:"Merge Flashing Cell Definition With Defaults"},{name:"setFlashingCellDefinitions",kind:"function",description:"Sets a collection of Flashing Cell Definitions into State",uiLabel:"Set Flashing Cell Definitions"},{name:"showFlashingCell",kind:"function",description:"Displays a Flashing Cell Definition",uiLabel:"Show Flashing Cell"},{name:"suspendFlashingCellDefinition",kind:"function",description:"Suspends a Flashing cell Definition",uiLabel:"Suspend Flashing Cell Definition"},{name:"unSuspendFlashingCellDefinition",kind:"function",description:"Activates a suspended Flashing cell Definition",uiLabel:"Un Suspend Flashing Cell Definition"}]},FlashingCellDefinition:{name:"FlashingCellDefinition",kind:"Interface",description:"The Flashing Cell Definition",properties:[{name:"DownChangeStyle",kind:"REFERENCE",description:"Style for 'Down' value changes",uiLabel:"Down Change Style",isOptional:!0,defaultValue:"Red BackColour",reference:"AdaptableStyle"},{name:"FlashDuration",kind:"number | 'always'",description:"Duration of Flash - can be number (in ms) or 'always'",uiLabel:"Flash Duration",isOptional:!0,defaultValue:"500ms"},{name:"FlashTarget",kind:"unknown",description:"Should a cell or whole row flash",uiLabel:"Flash Target",isOptional:!0,defaultValue:"'cell'"},{name:"NeutralChangeStyle",kind:"REFERENCE",description:"Style for 'Neutral' value changes",uiLabel:"Neutral Change Style",isOptional:!0,defaultValue:"Gray BackColour",reference:"AdaptableStyle"},{name:"Rule",kind:"REFERENCE",description:"When Flashing Cell should be triggered",uiLabel:"Rule",reference:"unknown"},{name:"Scope",kind:"REFERENCE",description:"Where Flashing Cell can display: Column[s] or DataType[s]",uiLabel:"Scope",reference:"AdaptableScope"},{name:"UpChangeStyle",kind:"REFERENCE",description:"Style for 'Up' value changes",uiLabel:"Up Change Style",isOptional:!0,defaultValue:"Green BackColour",reference:"AdaptableStyle"}]},FlashingCellDisplayedInfo:{name:"FlashingCellDisplayedInfo",kind:"Interface",description:"Object returned by the `FlashingCellDisplayed` event",properties:[{name:"flashingCell",kind:"REFERENCE",description:"Details of the Cell (or row) which has just flashed",uiLabel:"Flashing Cell",reference:"AdaptableFlashingCell"}]},FlashingCellOptions:{name:"FlashingCellOptions",kind:"Interface",description:"Properties for Flashing Cell",properties:[{name:"defaultDownChangeStyle",kind:"REFERENCE",description:"Style for 'Down' value changes",uiLabel:"Default Down Change Style",isOptional:!0,defaultValue:"Red BackColour",reference:"AdaptableStyle"},{name:"defaultFlashDuration",kind:"number | 'always'",description:"Duration of Flash - can be number (in ms) or 'always'",uiLabel:"Default Flash Duration",isOptional:!0,defaultValue:"500ms"},{name:"defaultFlashTarget",kind:"'row' | 'cell'",description:"Should a cell or whole row flash",uiLabel:"Default Flash Target",isOptional:!0,defaultValue:"'cell'"},{name:"defaultNeutralChangeStyle",kind:"REFERENCE",description:"Style for 'Neutral' value changes",uiLabel:"Default Neutral Change Style",isOptional:!0,defaultValue:"Gray BackColour",reference:"AdaptableStyle"},{name:"defaultUpChangeStyle",kind:"REFERENCE",description:"Style for 'Up' value changes",uiLabel:"Default Up Change Style",isOptional:!0,defaultValue:"Green BackColour",reference:"AdaptableStyle"}]},FlashingCellState:{name:"FlashingCellState",kind:"Interface",description:"Predefined Configuration for Flashing Cell module",properties:[{name:"FlashingCellDefinitions",kind:"array",description:"Flashing Cell Definitions - will colour cells/rows when rule is met",uiLabel:"Flashing Cell Definitions",isOptional:!0}]},FormatColumn:{name:"FormatColumn",kind:"Interface",description:"Object used in Format Column function",properties:[{name:"CellAlignment",kind:"'Left' | 'Right' | 'Center'",description:"Aligns cells 'Left' or 'Right' or 'Center'",uiLabel:"Cell Alignment",isOptional:!0},{name:"ColumnStyle",kind:"REFERENCE",description:"",uiLabel:"Column Style",isOptional:!0,reference:"unknown"},{name:"DisplayFormat",kind:"REFERENCE",description:"Display Format to apply to Column can be Numeric, String or Date",uiLabel:"Display Format",isOptional:!0,reference:"AdaptableFormat"},{name:"IncludeGroupedRows",kind:"boolean",description:"Whether to Format the Column in Grouped Rows",uiLabel:"Include Grouped Rows",isOptional:!0,defaultValue:"false"},{name:"Rule",kind:"REFERENCE",description:"Predicate-based Rule to use for deciding if a format column needs to be applied. When not defined the format column is always applied.",uiLabel:"Rule",isOptional:!0,reference:"FormatColumnRule"},{name:"Scope",kind:"REFERENCE",description:"Where Format will be applied - whole Row, some Columns or all Columns of given DataType",uiLabel:"Scope",reference:"AdaptableScope"},{name:"Style",kind:"REFERENCE",description:"Style to apply",uiLabel:"Style",isOptional:!0,reference:"AdaptableStyle"}]},FormatColumnApi:{name:"FormatColumnApi",kind:"Interface",description:"Provides run-time access to the Format Column Module and associated state",properties:[{name:"addFormatColumn",kind:"function",description:"Adds a Format Column to Format Column State",uiLabel:"Add Format Column"},{name:"addFormatColumns",kind:"function",description:"Adds Format Columns to Format Column State",uiLabel:"Add Format Columns"},{name:"applyFormatColumnDisplayFormats",kind:"function",description:"Applies display format for all Format Columns in AdapTable State",uiLabel:"Apply Format Column Display Formats"},{name:"decrementFormatColumnPrecedence",kind:"function",description:"Decrement the precedence of the given FormatColumn",uiLabel:"Decrement Format Column Precedence"},{name:"deleteAllFormatColumn",kind:"function",description:"Deletes all Format Columns in Adaptable State",uiLabel:"Delete All Format Column"},{name:"deleteFormatColumn",kind:"function",description:"Deletes an existing Format Column",uiLabel:"Delete Format Column"},{name:"editFormatColumn",kind:"function",description:"Edits the Format Column",uiLabel:"Edit Format Column"},{name:"getAllActiveFormatColumn",kind:"function",description:"Retrieves all active (not-suspended) Format Columns in Adaptable State",uiLabel:"Get All Active Format Column"},{name:"getAllFormatColumn",kind:"function",description:"Retrieves all Format Columns in Adaptable State",uiLabel:"Get All Format Column"},{name:"getAllFormatColumnWithCellAlignment",kind:"function",description:"Retrieves all Format Columns in Adaptable State with `CellAlignment` property set",uiLabel:"Get All Format Column With Cell Alignment"},{name:"getAllFormatColumnWithDisplayFormat",kind:"function",description:"Retrieves all Format Columns in Adaptable State with `DisplayFormat` property set",uiLabel:"Get All Format Column With Display Format"},{name:"getAllFormatColumnWithStyle",kind:"function",description:"Retrieves all Format Columns in Adaptable State with the `Style` property set",uiLabel:"Get All Format Column With Style"},{name:"getAllFormatColumnWithStyleAndCellAlignment",kind:"function",description:"Retrieves all Format Columns in Adaptable State with the `Style` or the `CellAlignment` property set",uiLabel:"Get All Format Column With Style And Cell Alignment"},{name:"getAllSuspendedFormatColumn",kind:"function",description:"Retrieves all suspended Format Columns in Adaptable State",uiLabel:"Get All Suspended Format Column"},{name:"getDateFormattedValue",kind:"function",description:"Format value according to format options.",uiLabel:"Get Date Formatted Value"},{name:"getFormatColumnById",kind:"function",description:"Retrieves Format Column by Id",uiLabel:"Get Format Column By Id"},{name:"getFormatColumnDefsForScope",kind:"function",description:"Returns all Predicates appropriate for the given Scope",uiLabel:"Get Format Column Defs For Scope"},{name:"getFormatColumnPredicateDefs",kind:"function",description:"Returns all Predicates usable in Format Columns",uiLabel:"Get Format Column Predicate Defs"},{name:"getFormatColumnsForColumn",kind:"function",description:"Gets all FormatColumns which are defined for the given column",uiLabel:"Get Format Columns For Column"},{name:"getFormatColumnsForColumnId",kind:"function",description:"Gets all FormatColumns which are defined for the column with the given columnId",uiLabel:"Get Format Columns For Column Id"},{name:"getFormatColumnsRelevantForColumn",kind:"function",description:"Extract from the given FormatColumns only the ones which are relevant for a given cell (intersection of given AdaptableColumn and RowNode)",uiLabel:"Get Format Columns Relevant For Column"},{name:"getFormatColumnState",kind:"function",description:"Retrieves Format Column section from Adaptable State",uiLabel:"Get Format Column State"},{name:"getFormatColumnsWithDisplayFormatForColumn",kind:"function",description:"Get all FormatColumns which are defined for this column and have a custom DisplayFormat",uiLabel:"Get Format Columns With Display Format For Column"},{name:"getFormatColumnsWithExpression",kind:"function",description:"Retrieves all Format Columns which have an Expression",uiLabel:"Get Format Columns With Expression"},{name:"getFormatColumnsWithStyleForColumn",kind:"function",description:"Get all FormatColumns which are defined for this column and have a custom AdaptableStyle",uiLabel:"Get Format Columns With Style For Column"},{name:"getFormatColumnWithSingleColumnScope",kind:"function",description:"Get Format Column which has Scope of Single Column, if any, for given ColumnId",uiLabel:"Get Format Column With Single Column Scope"},{name:"getFormatColumnWithStyleClassNameForColumn",kind:"function",description:"Gets Format Column if any for given Column which includes Style element with ClassName",uiLabel:"Get Format Column With Style Class Name For Column"},{name:"getNumberFormattedValue",kind:"function",description:"Format value according to format options.",uiLabel:"Get Number Formatted Value"},{name:"getStringFormattedValue",kind:"function",description:"Format value according to format options.",uiLabel:"Get String Formatted Value"},{name:"hasCustomDisplayFormatter",kind:"function",description:"Checks if a Format Column contains a Custom Display Formatter",uiLabel:"Has Custom Display Formatter"},{name:"hasStyleFormatColumns",kind:"function",description:"Returns true if Format State includes Format Columns with a Style property",uiLabel:"Has Style Format Columns"},{name:"incrementFormatColumnPrecedence",kind:"function",description:"Increment the precedence of the given FormatColumn",uiLabel:"Increment Format Column Precedence"},{name:"isFormatColumnRelevantForColumn",kind:"function",description:"Checks if format column is relevant for a given cell (intersection of given AdaptableColumn and RowNode)",uiLabel:"Is Format Column Relevant For Column"},{name:"showFormatColumnPopup",kind:"function",description:"Opens Settings Panel with Format Column section selected and visible",uiLabel:"Show Format Column Popup"},{name:"suspendFormatColumn",kind:"function",description:"Suspends an Format column",uiLabel:"Suspend Format Column"},{name:"unSuspendFormatColumn",kind:"function",description:"Suspends an Format column",uiLabel:"Un Suspend Format Column"}]},FormatColumnRule:{name:"FormatColumnRule",kind:"TypeAlias",description:"The Format Column Rule - can be either a Predicate or a BooleanExpression"},FormatColumnState:{name:"FormatColumnState",kind:"Interface",description:"Predefined Configuration for Format Column Module",properties:[{name:"FormatColumns",kind:"array",description:"Collection of Format Columns",uiLabel:"Format Columns",isOptional:!0}]},FormContext:{name:"FormContext",kind:"Interface",description:"Context supplied to Buttons that appear in an Adaptable Form",properties:[{name:"formData",kind:"REFERENCE",description:"Adaptable Form Data",uiLabel:"Form Data",reference:"unknown"}]},FreeTextColumn:{name:"FreeTextColumn",kind:"Interface",description:"The FreeTextColumn object used in the Free Text Column function",properties:[{name:"ColumnId",kind:"string",description:"Id of Column",uiLabel:"Column Id"},{name:"DataType",kind:"'String' | 'Number' | 'Boolean' | 'Date'",description:"Whether Column is String, Number, Boolean or Date",uiLabel:"Data Type",defaultValue:"'String'"},{name:"DefaultValue",kind:"unknown",description:"Initial value to use for each cell in the Column",uiLabel:"Default Value",isOptional:!0},{name:"FreeTextColumnSettings",kind:"REFERENCE",description:"Additional optional properties for Column (e.g. filterable, resizable)",uiLabel:"Free Text Column Settings",isOptional:!0,reference:"FreeTextColumnSettings"},{name:"FreeTextStoredValues",kind:"array",description:"Collection of Stored Values to aplly in the Column",uiLabel:"Free Text Stored Values",isOptional:!0},{name:"FriendlyName",kind:"string",description:"Friendly Name to use to refer to Column; if unset `ColumnId` is used",uiLabel:"Friendly Name",isOptional:!0},{name:"TextEditor",kind:"'Inline' | 'Large'",description:"Cell editor to use when editing a string Free Text Column *",uiLabel:"Text Editor",isOptional:!0,defaultValue:"'Inline'"}]},FreeTextColumnApi:{name:"FreeTextColumnApi",kind:"Interface",description:"Provides run-time access to FreeTextColumn Module and associated state",properties:[{name:"addEditFreeTextColumnStoredValue",kind:"function",description:"Adds FreeTextStoredValue for a FreeTextColumn (replaces existing one if exists)",uiLabel:"Add Edit Free Text Column Stored Value"},{name:"addFreeTextColumn",kind:"function",description:"Adds new FreeTextColumn to Adaptable State",uiLabel:"Add Free Text Column"},{name:"addStoredValuesToFreeTextColumn",kind:"function",description:"Adds Stored Values to Existing FreeTextColumn",uiLabel:"Add Stored Values To Free Text Column"},{name:"checkFreeTextColumnForDataChange",kind:"function",description:"Checks if a User Edit was in a Free Text Column",uiLabel:"Check Free Text Column For Data Change"},{name:"deleteFreeTextColumn",kind:"function",description:"Deletes existing FreeTextColumn from Adaptable State",uiLabel:"Delete Free Text Column"},{name:"editFreeTextColumn",kind:"function",description:"Edits existing FreeTextColumn in Adaptable State",uiLabel:"Edit Free Text Column"},{name:"getAllFreeTextColumn",kind:"function",description:"Gets all FreeTextColumns in Adaptable State",uiLabel:"Get All Free Text Column"},{name:"getFreeTextColumnById",kind:"function",description:"Retrieves FreeTextColumn for given ColumnId",uiLabel:"Get Free Text Column By Id"},{name:"getFreeTextColumnModuleReferences",kind:"function",description:"Returns all the references in the AdaptableState of the given FreeTextColumn",uiLabel:"Get Free Text Column Module References"},{name:"getFreeTextColumnState",kind:"function",description:"Retrieves FreeTextColumn section of Adaptable State",uiLabel:"Get Free Text Column State"},{name:"getFreeTextColumnValueFromRowNode",kind:"function",description:"Retrieves a Free Text Column value from a row",uiLabel:"Get Free Text Column Value From Row Node"},{name:"showFreeTextColumnPopup",kind:"function",description:"Opens Settings Panel with Free Text Column section selected and visible",uiLabel:"Show Free Text Column Popup"}]},FreeTextColumnSettings:{name:"FreeTextColumnSettings",kind:"Interface",description:"Set of optional properties that define a FreeText Columns behaviour"},FreeTextColumnState:{name:"FreeTextColumnState",kind:"Interface",description:"Predefined Configuration for the Free Text Column Module",properties:[{name:"FreeTextColumns",kind:"array",description:"Collection of Free Text Columns",uiLabel:"Free Text Columns",isOptional:!0}]},FreeTextStoredValue:{name:"FreeTextStoredValue",kind:"Interface",description:"Defines a cell value stored in a Free Text Column",properties:[{name:"FreeText",kind:"unknown",description:"Value to store in the cell",uiLabel:"Free Text"},{name:"PrimaryKey",kind:"unknown",description:"Primary Key Column value for the row",uiLabel:"Primary Key"}]},GeneralOptions:{name:"GeneralOptions",kind:"Interface",description:"General options for configuring AdapTable including managing Primary Keys",properties:[{name:"alternativeModuleNames",kind:"array",description:"Alternative names to use for Adaptable Modules in toolbars and menus",uiLabel:"Alternative Module Names",isOptional:!0,defaultValue:"null"},{name:"cellSummaryOperations",kind:"array",description:"Custom Cell Summary Operations to add to shipped set",uiLabel:"Cell Summary Operations",isOptional:!0},{name:"customSortComparers",kind:"array",description:"CustomSort column comparer functions",uiLabel:"Custom Sort Comparers",isOptional:!0},{name:"dataSets",kind:"array",description:"Collection of Data Sets to provide Data to AdapTable",uiLabel:"Data Sets",isOptional:!0},{name:"englishVariant",kind:"'GB' | 'US'",description:"English variant to use in UI labels",uiLabel:"English Variant",isOptional:!0,gridInfo:"item",defaultValue:"'GB'"},{name:"hideEmptyGroupRows",kind:"boolean",description:"Hides any grouped rows if there are no columns visible",uiLabel:"Hide Empty Group Rows",isOptional:!0,defaultValue:"false"},{name:"holidays",kind:"REFERENCE",description:"Holidays - used to determine Working Days",uiLabel:"Holidays",isOptional:!0,defaultValue:"null",reference:"Holidays"},{name:"showGroupingTotalsAsHeader",kind:"boolean",description:"Show aggregated totals row at top of Grid when row grouping",uiLabel:"Show Grouping Totals As Header",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"showMissingPrimaryKeyAlert",kind:"boolean",description:"Shows Alert if Primary Key column in Adaptable Options is not present or incorrect",uiLabel:"Show Missing Primary Key Warning",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"false"},{name:"unbalancedGroupsKey",kind:"unknown",description:"Value to use for 'Unbalanced Groups' (string columns)",uiLabel:"Unbalanced Groups Key",isOptional:!0}]},GlobalExpressionFunctionsContext:{name:"GlobalExpressionFunctionsContext",kind:"Interface",description:"Context provided to global expression functions properties property callback",properties:[{name:"availableExpressionFunctionNames",kind:"unknown",description:"The names of all expression functions available in this context",uiLabel:"Available Expression Function Names"}]},Glue42Api:{name:"Glue42Api",kind:"Interface",description:"Provides run-time access to the Glue42 Plugin.",properties:[{name:"clearGlue42InternalState",kind:"function",description:"Clears all Gluee42 Internal State",uiLabel:"Clear Glue42Internal State"},{name:"getCurrentLiveGlue42Report",kind:"function",description:"Retrieves the current Live Report",uiLabel:"Get Current Live Glue42Report"},{name:"getGlue42Schedules",kind:"function",description:"Retrieves all the Glue42 Schedules in from the Schedule section of AdapTable State",uiLabel:"Get Glue42Schedules"},{name:"getGlue42State",kind:"function",description:"Retrieves the Glue42 section of Adaptable State",uiLabel:"Get Glue42State"},{name:"getPluginOptions",kind:"function",description:"Retrieves the Glue42PluginOptions provided in Glue42 Plugin",uiLabel:"Get Plugin Options"},{name:"isGlue42Available",kind:"function",description:"Returns true if the Glue42 plugin is loaded",uiLabel:"Is Glue42Available"},{name:"isGlue42Running",kind:"function",description:"Returns true if the Glue42 plugin is loaded AND the user has logged into Glue42",uiLabel:"Is Glue42Running"},{name:"loginToGlue42",kind:"function",description:"Logs in the User to Glue42 using the given UserName and Password",uiLabel:"Login To Glue42"},{name:"logoutFromGlue42",kind:"function",description:"Logs out the currently logged in User from Glue42",uiLabel:"Logout From Glue42"},{name:"sendSnapshotToDo",kind:"function",description:"Starts a Snapshot as opposed to a Live report",uiLabel:"Send Snapshot To Do"},{name:"setGlue42AvailableOff",kind:"function",description:"Sets Glue42 Availability Off",uiLabel:"Set Glue42Available Off"},{name:"setGlue42AvailableOn",kind:"function",description:"Sets Glue42 Availability On",uiLabel:"Set Glue42Available On"},{name:"setGlue42LoginErrorMessage",kind:"function",description:"Sets an Error Message returned from Glue42 if login fails",uiLabel:"Set Glue42Login Error Message"},{name:"setGlue42RunningOff",kind:"function",description:"Sets Glue42 Running Off",uiLabel:"Set Glue42Running Off"},{name:"setGlue42RunningOn",kind:"function",description:"Sets Glue42 Running On",uiLabel:"Set Glue42Running On"},{name:"showNotification",kind:"function",description:"Shows a notification in Glue42",uiLabel:"Show Notification"},{name:"showNotificationForAlert",kind:"function",description:"Displays Alert as a Glue42 Notification",uiLabel:"Show Notification For Alert"},{name:"startLiveData",kind:"function",description:"Starts a "Live" report (ie. one which updates as the data ticks)",uiLabel:"Start Live Data"},{name:"stopLiveData",kind:"function",description:"Stops a "Live" report (ie. one which updates as the data ticks)",uiLabel:"Stop Live Data"}]},Glue42PluginOptions:{name:"Glue42PluginOptions",kind:"Interface",description:"Options for using the Glue42 plugin",properties:[{name:"gatewayURL",kind:"string",description:"Gateway URL",uiLabel:"Gateway URL",isOptional:!0},{name:"glue",kind:"unknown",description:"Main Glue desktop object",uiLabel:"Glue",isOptional:!0},{name:"glue42Office",kind:"unknown",description:"Main Glue42 Office object",uiLabel:"Glue42Office",isOptional:!0},{name:"password",kind:"string",description:"Password to use to login to Glue42; typically sourced from PC Credentials",uiLabel:"Password",isOptional:!0},{name:"username",kind:"string",description:"UserName to use to login to Glue42; typically sourced from PC Credentials",uiLabel:"Username",isOptional:!0}]},Glue42Report:{name:"Glue42Report",kind:"Interface",description:"Glue42 report - currently just contains name of Report",properties:[{name:"ReportName",kind:"string",description:"The Report's name (as exists in Export State)",uiLabel:"Report Name"}]},Glue42Schedule:{name:"Glue42Schedule",kind:"Interface",description:"Defines Glue42 Scheduled Report; used in Schedule Module (where State is stored)",properties:[{name:"Glue42Report",kind:"REFERENCE",description:"The Glue42 Report which will be sent when the Schedule runs",uiLabel:"Glue42Report",reference:"Glue42Report"},{name:"Transmission",kind:"'Snapshot' | 'Live Data'",description:"Whether its a one-off or 'streaming' transmission",uiLabel:"Transmission"}]},Glue42State:{name:"Glue42State",kind:"Interface",description:"Internal State used by AdapTable for managing the Glue42 plugin",properties:[{name:"CurrentLiveGlue42Report",kind:"REFERENCE",description:"Which Glue42 Report is currently live",uiLabel:"Current Live Glue42Report",isOptional:!0,reference:"Glue42Report"},{name:"Glue42LoginErrorMessage",kind:"string",description:"Message to show when Login Fails",uiLabel:"Glue42Login Error Message",isOptional:!0},{name:"IsGlue42Available",kind:"boolean",description:"Whether Glue42 is available",uiLabel:"Is Glue42Available",isOptional:!0},{name:"IsGlue42Running",kind:"boolean",description:"Whether Glue42 is running",uiLabel:"Is Glue42Running",isOptional:!0}]},GradientStyle:{name:"GradientStyle",kind:"Interface",description:"Used to display Gradient Styles in Special Column Style"},GridApi:{name:"GridApi",kind:"Interface",description:"Provides access to important properites of AdapTable e.g. sorting, selected cells etc.",properties:[{name:"addGridData",kind:"function",description:"Adds rows to Adaptable (and AG Grid)",uiLabel:"Add Grid Data"},{name:"applyGridFiltering",kind:"function",description:"Applies current Filtering and Searching in AdapTable",uiLabel:"Apply Grid Filtering"},{name:"areCellsEditable",kind:"function",description:"Checks if given set of Grid Cells are editable",uiLabel:"Are Cells Editable"},{name:"clearAdaptableSorting",kind:"function",description:"Removes Column Sorts in AdapTable",uiLabel:"Clear Adaptable Sorting"},{name:"clearGridFiltering",kind:"function",description:"Removes all current Filters and Searches in AdapTable",uiLabel:"Clear Grid Filtering"},{name:"clearRowGroupColumns",kind:"function",description:"Clears Row Grouping in the Grid",uiLabel:"Clear Row Group Columns"},{name:"closeAllRowGroups",kind:"function",description:"Close all open groups in Row Grouping",uiLabel:"Close All Row Groups"},{name:"deleteGridData",kind:"function",description:"Deletes rows from Adaptable (and AG Grid)",uiLabel:"Delete Grid Data"},{name:"deselectAll",kind:"function",description:"Deselects all selected rows, cells and ranges",uiLabel:"Deselect All"},{name:"deSelectNode",kind:"function",description:"Deselects the AG Grid Row Node in AdapTable",uiLabel:"De Select Node"},{name:"deSelectNodes",kind:"function",description:"AG Grid Row Nodes in AdapTable",uiLabel:"De Select Nodes"},{name:"deSelectRow",kind:"function",description:"Deselects Row with given Primary Key Value",uiLabel:"De Select Row"},{name:"deSelectRows",kind:"function",description:"Deselects Row with given Primary Key Values",uiLabel:"De Select Rows"},{name:"destroy",kind:"function",description:"Destroys current AdapTable instance",uiLabel:"Destroy"},{name:"expandAllRowGroups",kind:"function",description:"Expands all closed groups in Row Grouping",uiLabel:"Expand All Row Groups"},{name:"expandRowGroupsForValues",kind:"function",description:"Expands Row Groups that contain given keys",uiLabel:"Expand Row Groups For Values"},{name:"fireCellChangedEvent",kind:"function",description:"Fires Cell Changed Changed Event - when any data in AG Grid's dataset has changed",uiLabel:"Fire Cell Changed Event"},{name:"fireGridDataChangedEvent",kind:"function",description:"Fires Grid Data Changed Event - when a row has changed in AG Grid",uiLabel:"Fire Grid Data Changed Event"},{name:"fireGridSortedEvent",kind:"function",description:"Fires Grid Sorted Event",uiLabel:"Fire Grid Sorted Event"},{name:"fireSearchChangedEvent",kind:"function",description:"Fires Search Changed Event - typically used to enable server searching and filtering This is now deprecated and will be removed in AdapTable 13",uiLabel:"Fire Search Changed Event"},{name:"getAgGridInstance",kind:"function",description:"Returns Ag Grid instance (passed into Adaptable Options at start-up)",uiLabel:"Get Ag Grid Instance"},{name:"getAllRowNodes",kind:"function",description:"Retrieves all Row Nodes currently in the Grid (by default excluding the group rows)",uiLabel:"Get All Row Nodes"},{name:"getCellDisplayValue",kind:"function",description:"Retrieves Display Value for a given cell",uiLabel:"Get Cell Display Value"},{name:"getCellNormalisedValue",kind:"function",description:"Retrieves Normalised Value for a given cell",uiLabel:"Get Cell Normalised Value"},{name:"getCellRawValue",kind:"function",description:"Retrieves Raw Value for a given cell",uiLabel:"Get Cell Raw Value"},{name:"getColumnCount",kind:"function",description:"Returns number of columns in Data Source",uiLabel:"Get Column Count"},{name:"getColumnSortForColumn",kind:"function",description:"Retrieves ColumnSort for a given Column",uiLabel:"Get Column Sort For Column"},{name:"getColumnSorts",kind:"function",description:"Returns Column Sort information in Adaptable",uiLabel:"Get Column Sorts"},{name:"getDisplayValueFromRawValue",kind:"function",description:"Retrieves Formatted Value for a given Raw Value in given Column",uiLabel:"Get Display Value From Raw Value"},{name:"getDisplayValueFromRowNode",kind:"function",description:"Retrieves Display Value for Cell in given Row and Column",uiLabel:"Get Display Value From Row Node"},{name:"getEntitlementAccessLevelForModule",kind:"function",description:"Retrieves the Entitlement Access Level for a given Adaptable Module",uiLabel:"Get Entitlement Access Level For Module"},{name:"getExpandRowGroupsKeys",kind:"function",description:"Get keys for any open rows in Row Grouping",uiLabel:"Get Expand Row Groups Keys"},{name:"getFilteredData",kind:"function",description:"Retrieves filtered data from the grid",uiLabel:"Get Filtered Data"},{name:"getFirstDisplayedRowNode",kind:"function",description:"Retrieves the first Displayed Row Node in AdapTable",uiLabel:"Get First Displayed Row Node"},{name:"getFirstRowNode",kind:"function",description:"Retrieves the first Row Node in AdapTable",uiLabel:"Get First Row Node"},{name:"getGridCellFromRowNode",kind:"function",description:"Retrieves Cell in given Row and Column",uiLabel:"Get Grid Cell From Row Node"},{name:"getGridContainerElement",kind:"function",description:"Returns the Grid Container in which the Adaptable Instance is present",uiLabel:"Get Grid Container Element"},{name:"getGridData",kind:"function",description:"Retrieves all data from the grid",uiLabel:"Get Grid Data"},{name:"getGridState",kind:"function",description:"Returns Grid section from Adaptable State",uiLabel:"Get Grid State"},{name:"getNormalisedValueFromRowNode",kind:"function",description:"Retrieves Normalised Value for Cell in given Row and Column",uiLabel:"Get Normalised Value From Row Node"},{name:"getPrimaryKeyValueForRowNode",kind:"function",description:"Returns the Primary Kev Value for a given Row Node",uiLabel:"Get Primary Key Value For Row Node"},{name:"getPrimaryKeyValuesForRowNodes",kind:"function",description:"Returns the Primary Kev Values for a given Row Node collection",uiLabel:"Get Primary Key Values For Row Nodes"},{name:"getRawValueFromRowNode",kind:"function",description:"Retrieves Raw Value for Cell in given Row and Column",uiLabel:"Get Raw Value From Row Node"},{name:"getRowCount",kind:"function",description:"Returns number of rows in Data Source",uiLabel:"Get Row Count"},{name:"getRowNodeForPrimaryKey",kind:"function",description:"Retrieves Row Node that contains given Primary Key",uiLabel:"Get Row Node For Primary Key"},{name:"getRowNodesForPrimaryKeys",kind:"function",description:"Retrieves Row Nodes that contain given Primary Keys",uiLabel:"Get Row Nodes For Primary Keys"},{name:"getSelectedCellInfo",kind:"function",description:"Returns all current Selected Cells in AdapTable",uiLabel:"Get Selected Cell Info"},{name:"getSelectedRowInfo",kind:"function",description:"Returns all current Selected Rows in AdapTable",uiLabel:"Get Selected Row Info"},{name:"getVisibleColumnCount",kind:"function",description:"Returns number of visible columns in Data Source",uiLabel:"Get Visible Column Count"},{name:"getVisibleRowCount",kind:"function",description:"Returns number of visible rows in Data Source",uiLabel:"Get Visible Row Count"},{name:"getVisibleRowNodes",kind:"function",description:"Retrieves all filtered Row Nodes currently in the Grid (i.e. after applying the current filter)",uiLabel:"Get Visible Row Nodes"},{name:"hideFilterForm",kind:"function",description:"Hides the AdapTable Filter Form",uiLabel:"Hide Filter Form"},{name:"highlightCell",kind:"function",description:"Highlights a Cell in AdapTable",uiLabel:"Highlight Cell"},{name:"highlightRow",kind:"function",description:"Highlight a row using an adaptable style",uiLabel:"Highlight Row"},{name:"highlightRows",kind:"function",description:"Highlight rows using an adaptable style",uiLabel:"Highlight Rows"},{name:"isGridGroupable",kind:"function",description:"Whether AdapTable instance can be Row Grouped",uiLabel:"Is Grid Groupable"},{name:"isGridPivotable",kind:"function",description:"Whether AdapTable instance can be pivoted",uiLabel:"Is Grid Pivotable"},{name:"isGridRowGrouped",kind:"function",description:"Whether Grid is currently showing Row Groups",uiLabel:"Is Grid Row Grouped"},{name:"isGridSelectable",kind:"function",description:"Whether AdapTable instance offers cell selection",uiLabel:"Is Grid Selectable"},{name:"isGroupRowNode",kind:"function",description:"Whether given Row Node is a Row Group",uiLabel:"Is Group Row Node"},{name:"isQuickFilterAvailable",kind:"function",description:"Whether Quick Filter is available in the Grid",uiLabel:"Is Quick Filter Available"},{name:"jumpToCell",kind:"function",description:"Grid will jump to cell in a given Row and Column",uiLabel:"Jump To Cell"},{name:"jumpToColumn",kind:"function",description:"Grid will jump to Column that has given ColumnId",uiLabel:"Jump To Column"},{name:"jumpToRow",kind:"function",description:"Grid will jump to Row containing given Primary Kev Value",uiLabel:"Jump To Row"},{name:"loadGridData",kind:"function",description:"Loads grid with given data",uiLabel:"Load Grid Data"},{name:"redrawGrid",kind:"function",description:"Redraws AdapTable (expensive operation so use sparingly)",uiLabel:"Redraw Grid"},{name:"refreshCells",kind:"function",description:"Refresh Cells in AdapTable",uiLabel:"Refresh Cells"},{name:"refreshRowByPrimaryKey",kind:"function",description:"Forces a re-render of the row with the given primary key value",uiLabel:"Refresh Row By Primary Key"},{name:"refreshRowNode",kind:"function",description:"Forces a re-render of the given row",uiLabel:"Refresh Row Node"},{name:"refreshRowNodes",kind:"function",description:"Forces a re-render of the given rows",uiLabel:"Refresh Row Nodes"},{name:"selectAll",kind:"function",description:"Select the whole Grid",uiLabel:"Select All"},{name:"selectCellRange",kind:"function",description:"Selects a group of cells in a given range - provide either primary keys or row indexes",uiLabel:"Select Cell Range"},{name:"selectColumn",kind:"function",description:"Selects a Column in AG Grid",uiLabel:"Select Column"},{name:"selectColumns",kind:"function",description:"Selects Columns in AG Grid",uiLabel:"Select Columns"},{name:"selectNode",kind:"function",description:"Selects the AG Grid Row Node in AdapTable",uiLabel:"Select Node"},{name:"selectNodes",kind:"function",description:"Selects the AG Grid Row Nodes in AdapTable",uiLabel:"Select Nodes"},{name:"selectRow",kind:"function",description:"Selects Row with given Primary Key Value",uiLabel:"Select Row"},{name:"selectRows",kind:"function",description:"Selects Rows with given Primary Key Values",uiLabel:"Select Rows"},{name:"setAdaptableSorting",kind:"function",description:"Sorts AdapTable using given Column Sorts",uiLabel:"Set Adaptable Sorting"},{name:"setCellsValue",kind:"function",description:"Updates multiple cells",uiLabel:"Set Cells Value"},{name:"setCellValue",kind:"function",description:"Updates cell in Adaptable (first performs Cell & Server Validation)",uiLabel:"Set Cell Value"},{name:"setColumnSorts",kind:"function",description:"Sets Column Sorts in Grid",uiLabel:"Set Column Sorts"},{name:"setGridData",kind:"function",description:"Repopulates grid with given data",uiLabel:"Set Grid Data"},{name:"setRowGroupColumns",kind:"function",description:"Sets the grid to Row Group",uiLabel:"Set Row Group Columns"},{name:"showGridInfoPopup",kind:"function",description:"Opens Settings Panel with Grid Info section selected and visible",uiLabel:"Show Grid Info Popup"},{name:"undoCellEdit",kind:"function",description:"Reverses a data change (if triggered by cell edit)",uiLabel:"Undo Cell Edit"},{name:"unHighlightAllCells",kind:"function",description:"Unhighlights all highlighted Cells in AdapTable",uiLabel:"Un Highlight All Cells"},{name:"unHighlightAllRows",kind:"function",description:"Remove all highlighted rows",uiLabel:"Un Highlight All Rows"},{name:"unHighlightCell",kind:"function",description:"Unhighlights a Cell in AdapTable",uiLabel:"Un Highlight Cell"},{name:"unHighlightRow",kind:"function",description:"Remove highlight from row",uiLabel:"Un Highlight Row"},{name:"unHighlightRows",kind:"function",description:"Remove highlight from row",uiLabel:"Un Highlight Rows"},{name:"updateGridData",kind:"function",description:"Updates Adaptable (and AG Grid) with rows that have changed",uiLabel:"Update Grid Data"}]},GridCell:{name:"GridCell",kind:"Interface",description:"Defines a Cell in Adaptable - every cell is an intersection of a Column Id and a Primary Key Value",properties:[{name:"column",kind:"REFERENCE",description:"Column in which cell is situated",uiLabel:"Column",reference:"AdaptableColumn"},{name:"displayValue",kind:"unknown",description:"Display value of cell (e.g. if formatted)",uiLabel:"Display Value"},{name:"normalisedValue",kind:"unknown",description:"Normalised value of cell",uiLabel:"Normalised Value"},{name:"primaryKeyValue",kind:"unknown",description:"Primary Key column's value in row - how Adaptable locates the cell",uiLabel:"Primary Key Value",isOptional:!0},{name:"rawValue",kind:"unknown",description:"Actual raw value of cell",uiLabel:"Raw Value"},{name:"rowNode",kind:"REFERENCE",description:"AG Grid Row Node that holds the cell",uiLabel:"Row Node",reference:"unknown"}]},GridCellRange:{name:"GridCellRange",kind:"Interface",description:"Defines a range of Cell - used in Grid Api Selection methods Typically use either PrimaryKey Values or Row Indexes",properties:[{name:"columnIds",kind:"array",description:"Columns to select",uiLabel:"Column Ids"},{name:"primaryKeyValueEnd",kind:"unknown",description:"Primary Key value of row at end of range",uiLabel:"Primary Key Value End",isOptional:!0},{name:"primaryKeyValueStart",kind:"unknown",description:"Primary Key value of row at start of range",uiLabel:"Primary Key Value Start",isOptional:!0},{name:"rowIndexEnd",kind:"unknown",description:"Index of row at end of range",uiLabel:"Row Index End",isOptional:!0},{name:"rowIndexStart",kind:"unknown",description:"Index of row at start of range",uiLabel:"Row Index Start",isOptional:!0}]},GridDataChangedInfo:{name:"GridDataChangedInfo",kind:"Interface",description:"EventInfo returned by GridDataChanged event",properties:[{name:"changedAt",kind:"number",description:"Timestamp of change occurrence (in milliseconds)",uiLabel:"Changed At"},{name:"dataRows",kind:"array",description:"Data rows that have been added, updated, or deleted",uiLabel:"Data Rows"},{name:"rowNodes",kind:"array",description:"Row Nodes that were affected by this change",uiLabel:"Row Nodes"},{name:"rowTrigger",kind:"'Add' | 'Edit' | 'Delete'",description:"Trigger for row change: 'Add', 'Edit' or 'Delete'",uiLabel:"Row Trigger"}]},GridRow:{name:"GridRow",kind:"Interface",description:"Detailed information about a Row in AdapTable",properties:[{name:"primaryKeyValue",kind:"unknown",description:"Primary Key column's value for Row - how Adaptable locates a cell",uiLabel:"Primary Key Value"},{name:"rowData",kind:"unknown",description:"Actual data in the Row",uiLabel:"Row Data",isOptional:!0},{name:"rowInfo",kind:"REFERENCE",description:"Object which provides 'meta data' about the Row",uiLabel:"Row Info",isOptional:!0,reference:"RowInfo"},{name:"rowNode",kind:"REFERENCE",description:"AG Grid Row Node object for the Row",uiLabel:"Row Node",isOptional:!0,reference:"unknown"}]},GridSortedInfo:{name:"GridSortedInfo",kind:"Interface",description:"EventInfo returned by GridSorted event",properties:[{name:"adaptableSortState",kind:"REFERENCE",description:"Current sort state in the Grid",uiLabel:"Adaptable Sort State",reference:"AdaptableSortState"}]},HolidayContext:{name:"HolidayContext",kind:"Interface",description:"Context used for isHoliday function",properties:[{name:"adaptableId",kind:"string",description:"Id of current AdapTable instance",uiLabel:"Adaptable Id"},{name:"dateToCheck",kind:"date",description:"Date being checked",uiLabel:"Date To Check"},{name:"userName",kind:"string",description:"Name of Current User",uiLabel:"User Name"}]},Holidays:{name:"Holidays",kind:"Interface",description:"Holidays - can be list or function (latter takes preference)",properties:[{name:"isHoliday",kind:"function",description:"Function which returns true if given date is a holiday",uiLabel:"Is Holiday",isOptional:!0},{name:"list",kind:"array",description:"Holidays provided as valid ISO date strings",uiLabel:"List",isOptional:!0}]},IAdaptableNoCodeWizard:{name:"IAdaptableNoCodeWizard",kind:"Interface",description:"When you want to configure an Adaptable via json file D&D, use this instead of the normal Adaptable constructor"},InstrumentColumn:{name:"InstrumentColumn",kind:"Interface",description:"A Column which will be defined as an FDC3 Instrument",properties:[{name:"bbgColumnId",kind:"string",description:"Column which holds a Bloomberg Ticker value as instrument data",uiLabel:"Bbg Column Id",isOptional:!0},{name:"cusipColumnId",kind:"string",description:"Column which holds a CUSIP value as instrument data",uiLabel:"Cusip Column Id",isOptional:!0},{name:"figiColumnId",kind:"string",description:"Column which holds a [FIGI](https://www.openfigi.com/about/figi) value as instrument data",uiLabel:"Figi Column Id",isOptional:!0},{name:"intents",kind:"REFERENCE",description:"Instrument-related FDC3 Intents; can be: `ViewChart` `ViewQuote` `ViewNews` `ViewAnalysis` `ViewInstrument`",uiLabel:"Intents",isOptional:!0,reference:"InstrumentIntents"},{name:"isinColumnId",kind:"string",description:"Column which holds an ISIN value as instrument data",uiLabel:"Isin Column Id",isOptional:!0},{name:"permidColumnId",kind:"string",description:"Column which holds a PERMID value as instrument data",uiLabel:"Permid Column Id",isOptional:!0},{name:"ricColumnId",kind:"string",description:"Column which holds a Reuters Instrument Code value as instrument data",uiLabel:"Ric Column Id",isOptional:!0},{name:"sedolColumnId",kind:"string",description:"Column which holds a SEDOL value as instrument data",uiLabel:"Sedol Column Id",isOptional:!0},{name:"tickerColumnId",kind:"string",description:"Column which holds a ticker value as instrument data",uiLabel:"Ticker Column Id",isOptional:!0}]},InstrumentContext:{name:"InstrumentContext",kind:"Interface",description:"FDC3 Context to define a financial Instrument",properties:[{name:"id",kind:"unknown",description:"Instrument data: ticker, ISIN, CUSIP, SEDOL, RIC, BBG, PERMID, FIGI",uiLabel:"Id",isOptional:!0},{name:"name",kind:"string",description:"Free text name of the Instrument",uiLabel:"Name",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `instrument`",uiLabel:"Type"}]},InstrumentIntent:{name:"InstrumentIntent",kind:"TypeAlias",description:"FDC3 Intents available to an Instrument Column"},InstrumentIntents:{name:"InstrumentIntents",kind:"TypeAlias",description:"All available Instrument Intents"},InstrumentListContext:{name:"InstrumentListContext",kind:"Interface",description:"FDC3 Context to define an array of financial Instruments",properties:[{name:"id",kind:"unknown",description:"Optional Id",uiLabel:"Id",isOptional:!0},{name:"instruments",kind:"array",description:"The instrument data",uiLabel:"Instruments",isOptional:!0},{name:"name",kind:"string",description:"Free text name of list of Instruments (not set by AdapTable)",uiLabel:"Name",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `instrumentList`",uiLabel:"Type"}]},IPushPullApi:{name:"IPushPullApi",kind:"Interface",description:"Provides run-time access to ipushpull Plugin",properties:[{name:"addNewIPushPullPage",kind:"function",description:"Adds a new page to ipushpull using given name in the supplied folder",uiLabel:"Add New IPush Pull Page"},{name:"clearIPushPullInternalState",kind:"function",description:"Internal method which clears out ipushpull State",uiLabel:"Clear IPush Pull Internal State"},{name:"getAutoLogin",kind:"function",description:"Retrieves `AutoLogin` from ipushpull options; if `true` AdapTable will automatically log user in to ipushpull at start-up",uiLabel:"Get Auto Login"},{name:"getCurrentIPushPullPassword",kind:"function",description:"Retrieves `Password` from ipushpull state -- AFTER someone logs in",uiLabel:"Get Current IPush Pull Password"},{name:"getCurrentIPushPullUsername",kind:"function",description:"Retrieves `Username` from ipushpull state - AFTER someone logs in",uiLabel:"Get Current IPush Pull Username"},{name:"getCurrentLiveIPushPullReport",kind:"function",description:"Retrieves current ipushpull Report from ipushpull state; A Report contains Name, Folder and ipushpull Page",uiLabel:"Get Current Live IPush Pull Report"},{name:"getFolderIdForName",kind:"function",description:"Gets the Id of the ipushpull folder / Domain with the given name",uiLabel:"Get Folder Id For Name"},{name:"getIPushPullDomains",kind:"function",description:"Retrieves all the ipushpull domain to which the current user has access",uiLabel:"Get IPush Pull Domains"},{name:"getIPushPullInstance",kind:"function",description:"Retrieves the current ipushpull instance (if one has been provided by the User at design time in ipushpull state)",uiLabel:"Get IPush Pull Instance"},{name:"getIPushPullPassword",kind:"function",description:"Retrieves `Password` from ipushpull options (if provided)",uiLabel:"Get IPush Pull Password"},{name:"getIPushPullSchedules",kind:"function",description:"Gets ipushpull schedules ie. reports set to run at particular times",uiLabel:"Get IPush Pull Schedules"},{name:"getIPushPullThrottleTime",kind:"function",description:"Retrieves Throttle Time from ipushpull State; how often a Live report will update ipushpull (if data changes)",uiLabel:"Get IPush Pull Throttle Time"},{name:"getIPushPullUsername",kind:"function",description:"Retrieves `Username` from ipushpull options (if provided)",uiLabel:"Get IPush Pull Username"},{name:"getPagesForIPushPullDomain",kind:"function",description:"Retrieves all pages in given ipushpull domain",uiLabel:"Get Pages For IPush Pull Domain"},{name:"includeSystemReports",kind:"function",description:"Whether to dispaly System Reports in ipushpull toolbar",uiLabel:"Include System Reports"},{name:"isIPushPullAvailable",kind:"function",description:"Checks if an ipushpull instance has been provided by the user",uiLabel:"Is IPush Pull Available"},{name:"isIPushPullLiveDataRunning",kind:"function",description:"Checks if a report is sending Live Data to ipushpull",uiLabel:"Is IPush Pull Live Data Running"},{name:"isIPushPullReportLive",kind:"function",description:"Checks if given report is currently 'live' (i.e. sending updates as data changes)",uiLabel:"Is IPush Pull Report Live"},{name:"isIPushPullRunning",kind:"function",description:"Checks to see if ipushpull is running (i.e. a user has successfully logged in)",uiLabel:"Is IPush Pull Running"},{name:"loginToIPushPull",kind:"function",description:"Logins in user to ipushpull with given credentials; if successful ipushpull toolbar will display full set of controls",uiLabel:"Login To IPush Pull"},{name:"logoutFromIPushPull",kind:"function",description:"Logs out the current user from ipushpull (changes ipushpull toolbar to show Login button)",uiLabel:"Logout From IPush Pull"},{name:"retrieveIPushPullDomainsFromIPushPull",kind:"function",description:"Internal AdapTable method used to manage domains",uiLabel:"Retrieve IPush Pull Domains From IPush Pull"},{name:"sendSnapshot",kind:"function",description:"Publishes an ipushpull Report as a one-off export (i.e. with no live data)",uiLabel:"Send Snapshot"},{name:"setIPushPullAvailableOff",kind:"function",description:"Internal method which sets ipushpull is unavailable",uiLabel:"Set IPush Pull Available Off"},{name:"setIPushPullAvailableOn",kind:"function",description:"Internal method which sets ipushpull is available",uiLabel:"Set IPush Pull Available On"},{name:"setIPushPullDomains",kind:"function",description:"Sets given Domains as those for the current User",uiLabel:"Set IPush Pull Domains"},{name:"setIPushPullInstance",kind:"function",description:"Sets the current ipushpull instance - this method should not generally be used.",uiLabel:"Set IPush Pull Instance"},{name:"setIPushPullLoginErrorMessage",kind:"function",description:"Internal method which displays given message in ipushpull login page",uiLabel:"Set IPush Pull Login Error Message"},{name:"setIPushPullRunningOff",kind:"function",description:"Internal method which sets ipushpull is not running",uiLabel:"Set IPush Pull Running Off"},{name:"setIPushPullRunningOn",kind:"function",description:"Internal method which sets ipushpull is running",uiLabel:"Set IPush Pull Running On"},{name:"setIPushPullThrottleTime",kind:"function",description:"Sets Throttle time for ipushpull; how often a Live report will update ipushpull (if data changes)",uiLabel:"Set IPush Pull Throttle Time"},{name:"showIPushPullPopup",kind:"function",description:"Opens iPushPullPopup (though its currently empty!)",uiLabel:"Show IPush Pull Popup"},{name:"startLiveData",kind:"function",description:"Publishes ipushpull Report as Live Data; any changes to underlying data in report will be sent to ipushpull",uiLabel:"Start Live Data"},{name:"stopLiveData",kind:"function",description:"Pauses current Live Data report",uiLabel:"Stop Live Data"}]},IPushPullDomain:{name:"IPushPullDomain",kind:"Interface",description:"Internal object that maps an IPushPull Domain object",properties:[{name:"FolderId",kind:"number",description:"the Id of the Folder",uiLabel:"Folder Id"},{name:"Name",kind:"string",description:"the Name of the Domain / Folder",uiLabel:"Name"},{name:"Pages",kind:"array",description:"The names of the pages within the (Folder)",uiLabel:"Pages"}]},IPushPullPluginOptions:{name:"IPushPullPluginOptions",kind:"Interface",description:"Options available in ipushpull plugin; allows users to collborate and share data in powerful ways",properties:[{name:"autoLogin",kind:"boolean",description:"Whether AdapTable should try log in to ipushpull automatically at start-up",uiLabel:"Auto Login",isOptional:!0,defaultValue:"false"},{name:"includeSystemReports",kind:"boolean",description:"Whether AdapTable will include System Reports (e.g. 'All Data', 'Selected Cells' etc) in the ipushpull toolbar dropdown",uiLabel:"Include System Reports",isOptional:!0,defaultValue:"true"},{name:"ippConfig",kind:"unknown",description:"The config required to run ipushpull; use your ipushpull credentials",uiLabel:"Ipp Config",isOptional:!0},{name:"password",kind:"string",description:"The user's ipushpull password; if supplied, pre-populates the login screen's password textbox",uiLabel:"Password",isOptional:!0},{name:"throttleTime",kind:"number",description:"How many miliseconds AdapTable should throttle when sending data updates to ipushpull",uiLabel:"Throttle Time",isOptional:!0,defaultValue:"2000"},{name:"username",kind:"string",description:"User's ipushpull user name (usually email address); if supplied, pre-populates the login screen's username textbox",uiLabel:"Username",isOptional:!0}]},IPushPullReport:{name:"IPushPullReport",kind:"Interface",description:"An ipushpull report",properties:[{name:"Folder",kind:"string",description:"ipushpull Folder which contains the Page",uiLabel:"Folder"},{name:"Page",kind:"string",description:"ipushpull Page which will contain the data",uiLabel:"Page"},{name:"ReportName",kind:"string",description:"Name of the Report",uiLabel:"Report Name"}]},IPushPullSchedule:{name:"IPushPullSchedule",kind:"Interface",description:"Defines an ipushpull Schedule",properties:[{name:"IPushPullReport",kind:"REFERENCE",description:"The report being exported to Excel (via ipushpull)",uiLabel:"I Push Pull Report",reference:"IPushPullReport"},{name:"Transmission",kind:"'Snapshot' | 'Live Data'",description:"How data is sent: 'Snapshot' or 'Live Data'",uiLabel:"Transmission"}]},IPushPullState:{name:"IPushPullState",kind:"Interface",description:"Internal State used by AdapTable for managing the ipushpull plugin"},Layout:{name:"Layout",kind:"Interface",description:"Defines a Layout; contains everything required i.e. Columns, Sorts, Widths, Aggregations, Grouping & Pivoting",properties:[{name:"AggregationColumns",kind:"REFERENCE",description:"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)",uiLabel:"Aggregation Columns",isOptional:!0,reference:"unknown"},{name:"AutoSave",kind:"boolean",description:"Whether Layout should automatically save or not - overrides `autoSaveLayouts` property in LayoutOptions",uiLabel:"Auto Save",isOptional:!0},{name:"ColumnFilters",kind:"array",description:"Collection of Column Filters.",uiLabel:"Column Filters",isOptional:!0},{name:"ColumnHeadersMap",kind:"unknown",description:"Set of custom header names for some (or all columns)",uiLabel:"Column Headers Map",isOptional:!0},{name:"Columns",kind:"array",description:"Which columns should be visible in the Layout and in which order",uiLabel:"Columns"},{name:"ColumnSorts",kind:"array",description:"Sorting to apply in the Layout",uiLabel:"Column Sorts",isOptional:!0},{name:"ColumnWidthMap",kind:"unknown",description:"Set of widths for some (or all columns)",uiLabel:"Column Width Map",isOptional:!0},{name:"EnablePivot",kind:"boolean",description:"Whether pivoting should be enabled in the Grid when this Layout loads",uiLabel:"Enable Pivot",isOptional:!0},{name:"ExpandedRowGroupValues",kind:"array",description:"Opened Row Groups - set if `displayRowGroups` in LayoutOptions is 'dynamic'",uiLabel:"Expanded Row Group Values",isOptional:!0},{name:"Name",kind:"string",description:"Name of Layout as will appear in Layout toolbar and tool panel",uiLabel:"Name"},{name:"PinnedColumnsMap",kind:"{\n        [columnId: string]: 'left' | 'right';\n    }",description:"Set of pinned Columns",uiLabel:"Pinned Columns Map",isOptional:!0},{name:"PivotColumns",kind:"array",description:"List of Columns which should be pivoted when grid is in pivot mode",uiLabel:"Pivot Columns",isOptional:!0},{name:"RowGroupedColumns",kind:"array",description:"Columns which are row-grouped when the Layout is applied",uiLabel:"Row Grouped Columns",isOptional:!0},{name:"SuppressAggFuncInHeader",kind:"boolean",description:"Whether to include the aggFunc name in the column header: e.g. 'sum(Bank Balance)' will just be 'Bank Balance'",uiLabel:"Suppress Agg Func In Header",isOptional:!0}]},LayoutApi:{name:"LayoutApi",kind:"Interface",description:"Provides run-time access to the Layout Module and associated state",properties:[{name:"areDraftAndCurrentLayoutEqual",kind:"function",description:"Checks if the draft layout and the current layout are the same. Useful when `autoSaveLayouts=true`",uiLabel:"Are Draft And Current Layout Equal"},{name:"areExpandedRowGroupsSavedInLayouts",kind:"function",description:"Returns true if Layouts will contain Expanded Row Groups information",uiLabel:"Are Expanded Row Groups Saved In Layouts"},{name:"areLayoutsEqual",kind:"function",description:"Compares 2 Layouts for equality",uiLabel:"Are Layouts Equal"},{name:"cloneAndSetLayout",kind:"function",description:"Creates new Layout based on given Layout but with name provided and then loads it into Grid",uiLabel:"Clone And Set Layout"},{name:"cloneLayout",kind:"function",description:"Creates new Layout based on given Layout but with name provided",uiLabel:"Clone Layout"},{name:"createAndSetLayout",kind:"function",description:"Creates new Layout in the state and then loads it into Grid",uiLabel:"Create And Set Layout"},{name:"createDefaultLayoutIfNeeded",kind:"function",description:"Creates a Default Layout (when none provided in Config)",uiLabel:"Create Default Layout If Needed"},{name:"createLayout",kind:"function",description:"Creates new Layout in the state",uiLabel:"Create Layout"},{name:"createOrUpdateLayout",kind:"function",description:"Creates new Layout into Adaptable State or updates an existing Layout (with same name or id)",uiLabel:"Create Or Update Layout"},{name:"deleteLayout",kind:"function",description:"Deletes an existing Layout (if not Default or only existing Layout)",uiLabel:"Delete Layout"},{name:"deleteLayoutByName",kind:"function",description:"Deletes an existing Layout provided by Name (if not Default or only existing Layout)",uiLabel:"Delete Layout By Name"},{name:"doesLayoutExist",kind:"function",description:"Checks whether this Layout exists in the Adaptable State (by comparing Uuid property)",uiLabel:"Does Layout Exist"},{name:"fireLayoutChangedEvent",kind:"function",description:"Fires the `LayoutChanged` event",uiLabel:"Fire Layout Changed Event"},{name:"getAllLayout",kind:"function",description:"Retrieves all Layouts in Adaptable State",uiLabel:"Get All Layout"},{name:"getCurrentLayout",kind:"function",description:"Retrieves Current Layout from Layout State",uiLabel:"Get Current Layout"},{name:"getCurrentLayoutColumnSort",kind:"function",description:"Retrieves the sort order of a column from the current layout",uiLabel:"Get Current Layout Column Sort"},{name:"getCurrentLayoutName",kind:"function",description:"Retrieves name of current Layout",uiLabel:"Get Current Layout Name"},{name:"getCurrentVisibleColumnIds",kind:"function",description:"Retrieves array of visible ColumnIds in current Layout",uiLabel:"Get Current Visible Column Ids"},{name:"getCurrentVisibleColumnIdsMap",kind:"function",description:"Retrieves map with visible columns in current Layout",uiLabel:"Get Current Visible Column Ids Map"},{name:"getLayoutById",kind:"function",description:"Retrieves Layout by id",uiLabel:"Get Layout By Id"},{name:"getLayoutByName",kind:"function",description:"Retrieves Layout with the given name",uiLabel:"Get Layout By Name"},{name:"getLayoutDescription",kind:"function",description:"Get a string description of a Layout",uiLabel:"Get Layout Description"},{name:"getLayoutState",kind:"function",description:"Retrieves Layout section from Adaptable State",uiLabel:"Get Layout State"},{name:"getLayoutSupportedFeatures",kind:"function",description:"Returns whant the layout supports. This takes into account the data-source.",uiLabel:"Get Layout Supported Features"},{name:"isCurrentLayoutDefault",kind:"function",description:"Checks if the Current Layout is Default Layout",uiLabel:"Is Current Layout Default"},{name:"isCurrentLayoutReadOnly",kind:"function",description:"Specifies where Current Layout is editable",uiLabel:"Is Current Layout Read Only"},{name:"isDefaultLayout",kind:"function",description:"Checks if the given Layout is Default Layout",uiLabel:"Is Default Layout"},{name:"removeColumnFromAllLayouts",kind:"function",description:"Removes a Column from all Layouts",uiLabel:"Remove Column From All Layouts"},{name:"removeColumnFromCurrentLayout",kind:"function",description:"Removes a Column from the Current Layout",uiLabel:"Remove Column From Current Layout"},{name:"removeColumnFromLayout",kind:"function",description:"Removes a Column from a given Layout",uiLabel:"Remove Column From Layout"},{name:"saveCurrentLayout",kind:"function",description:"Saves current Layout - using column order, visibility, sorting etc. currently in use in the grid",uiLabel:"Save Current Layout"},{name:"saveLayout",kind:"function",description:"Saves given Layout into Adaptable State (creates new Layout if it doesn't exist)",uiLabel:"Save Layout"},{name:"setColumnCaption",kind:"function",description:"Sets a new Caption / Header for a Column (this Layout only)",uiLabel:"Set Column Caption"},{name:"setLayout",kind:"function",description:"Sets (i.e. selects) the Layout",uiLabel:"Set Layout"},{name:"shouldAutoSaveLayout",kind:"function",description:"Whether this Layout should be auto saved (based on Layout State and Layout Options)",uiLabel:"Should Auto Save Layout"},{name:"showChangeColumnCaption",kind:"function",description:"Opens Change Column Caption popup",uiLabel:"Show Change Column Caption"},{name:"showLayoutEditor",kind:"function",description:"Opens Layout Editor - for Current or a named Layout",uiLabel:"Show Layout Editor"},{name:"showLayoutPopup",kind:"function",description:"Opens Settings Panel with Layout section selected",uiLabel:"Show Layout Popup"}]},LayoutAssociatedObject:{name:"LayoutAssociatedObject",kind:"TypeAlias",description:"Types of Adaptable Objects that can be associated with a Layout"},LayoutAssociatedObjectLoadConfig:{name:"LayoutAssociatedObjectLoadConfig",kind:"Interface",description:"Configuration for API methods which load `LayoutAssociatedObject`"},LayoutAvailableContext:{name:"LayoutAvailableContext",kind:"Interface",description:"Context for `LayoutOptions.isObjectAvailableInLayout` functions",properties:[{name:"adaptableObject",kind:"REFERENCE",description:"Object being checked",uiLabel:"Adaptable Object",reference:"LayoutAssociatedObject"},{name:"layout",kind:"REFERENCE",description:"Current Layout",uiLabel:"Layout",reference:"Layout"},{name:"module",kind:"REFERENCE",description:"Current Adaptable Module",uiLabel:"Module",reference:"AdaptableModule"}]},LayoutChangedInfo:{name:"LayoutChangedInfo",kind:"Interface",description:"EventInfo returned by LayoutChanged event",properties:[{name:"actionName",kind:"string",description:"What caused Layout State to change",uiLabel:"Action Name"},{name:"newLayoutState",kind:"REFERENCE",description:"Current Layout State",uiLabel:"New Layout State",reference:"LayoutState"},{name:"oldLayoutState",kind:"unknown",description:"Previous Layout State",uiLabel:"Old Layout State"}]},LayoutOptions:{name:"LayoutOptions",kind:"Interface",description:"Options for configuring Layouts; these manage Column visibility, order, sorting, grouping and width",properties:[{name:"autoSaveLayouts",kind:"boolean",description:"Layouts save whenever Grid's column / sort info changes; if false, a Save button will display",uiLabel:"Auto Save Layouts",isOptional:!0,gridInfo:"item",noCode:"item",defaultValue:"true"},{name:"autoSizeColumnsInLayout",kind:"boolean",description:"Columns auto-size when Layout loads for first time",uiLabel:"Auto Size Columns In Layout",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"autoSizeColumnsInPivotLayout",kind:"boolean",description:"Columns auto-size when Pivot-based Layout loads first time",uiLabel:"Auto Size Columns In Pivot Layout",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"createDefaultLayout",kind:"boolean",description:"Whether a "Default Layout" will be created in addition to Layouts provided in Config",uiLabel:"Create Default Layout",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"displayRowGroups",kind:"'dynamic' | 'expanded' | 'closed'",description:"Whether Row Groups display all as expanded, all as closed or dynamically (i.e. saved in Layout)",uiLabel:"Display Row Groups",isOptional:!0,gridInfo:"item",defaultValue:"'closed'"},{name:"includeExpandedRowGroups",kind:"boolean",description:"Layouts will include details of expanded grouped rows; if true these will be re-applied at start-up",uiLabel:"Include Expanded Row Groups",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"layoutTagOptions",kind:"REFERENCE",description:"Options for leveraging Object Tags to extend Layouts",uiLabel:"Layout Tag Options",isOptional:!0,reference:"unknown"},{name:"layoutViewOptions",kind:"REFERENCE",description:"Customize how Layouts are displayed in Settings Panel",uiLabel:"Layout View Options",isOptional:!0,reference:"LayoutViewOptions"},{name:"pivotPreviewColumns",kind:"unknown",description:"Columns displayed in Table that opens when viewing contents of Pivot Cells",uiLabel:"Pivot Preview Columns",isOptional:!0}]},LayoutState:{name:"LayoutState",kind:"Interface",description:"Predefined Configuration for the Layout Module",properties:[{name:"CurrentLayout",kind:"string",description:"Layout which will be loaded when AdapTable starts - must match `Name` property in Layout",uiLabel:"Current Layout",isOptional:!0},{name:"Layouts",kind:"array",description:"Collection of Layout objects - listed in Layout toolbar and Tool Panel",uiLabel:"Layouts",isOptional:!0}]},LayoutViewOptions:{name:"LayoutViewOptions",kind:"Interface",description:"Customize how Layouts are displayed in Settings Panel",properties:[{name:"maxColumnsToDisplay",kind:"number",description:"How many Column Names to display in inline Layout preview",uiLabel:"Max Columns To Display",isOptional:!0,defaultValue:"10"}]},LiveDataChangedInfo:{name:"LiveDataChangedInfo",kind:"Interface",description:"EventInfo returned by LiveDataChanged event",properties:[{name:"liveDataTrigger",kind:"'Connected' | 'Disconnected' | 'LiveDataStarted' | 'LiveDataStopped' | 'LiveDataUpdated'",description:"What triggered the event to fire",uiLabel:"Live Data Trigger"},{name:"liveReport",kind:"unknown",description:"The Report which is currently live - only used if the Trigger is LiveData related",uiLabel:"Live Report",isOptional:!0},{name:"reportDestination",kind:"'OpenFin' | 'ipushpull' | 'Glue42'",description:"Which Adaptable partner is the export destination for the live data",uiLabel:"Report Destination"}]},LiveReport:{name:"LiveReport",kind:"Interface",description:"Defines which Adaptable Reports are 'Live' (i.e. they will update the destination as the data in Adaptable ticks or changes)",properties:[{name:"pageName",kind:"string",description:"for OpenFin this will be the workbook name; for iPushpull the page name; for Glue42 the Spreadsheet name.",uiLabel:"Page Name"},{name:"report",kind:"REFERENCE",description:"The underlying report",uiLabel:"Report",reference:"unknown"},{name:"reportDestination",kind:"'OpenfinExcel' | 'ipushpull' | 'Glue42'",description:"Where the live data is being sent",uiLabel:"Report Destination"}]},MasterDetailPluginOptions:{name:"MasterDetailPluginOptions",kind:"Interface",description:"Plugin Options used when creating a Master / Detail grid - passed into the plugin as the only argument.",properties:[{name:"detailAdaptableOptions",kind:"REFERENCE",description:"`AdaptableOptions` object to use for child Data Grids; **all** will share the same behaviour and State",uiLabel:"Detail Adaptable Options",reference:"AdaptableOptions"},{name:"onDetailInit",kind:"function",description:"Function called when Detail Grid is initialised (i.e. opens) receives an Adaptable Api object",uiLabel:"On Detail Init",isOptional:!0}]},MenuOptions:{name:"MenuOptions",kind:"Interface",description:"Options for managing menus in AdapTable",properties:[{name:"columnMenuItems",kind:"array",description:"User-defined Menu Items to add to the Column Menu",uiLabel:"Column Menu Items",isOptional:!0},{name:"columnMenuOrder",kind:"unknown",description:"Order in which AG Grid, AdapTable and User Menu items will appear in Column Menu",uiLabel:"Column Menu Order",isOptional:!0,gridInfo:"item",defaultValue:"'aggrid', 'adaptable', 'user'"},{name:"contextMenuItems",kind:"array",description:"User-defined Menu Items to add to the Context Menu",uiLabel:"Context Menu Items",isOptional:!0},{name:"contextMenuOrder",kind:"unknown",description:"Order in which AG grid, AdapTable and User Menu items will appear in Context Menu",uiLabel:"Context Menu Order",isOptional:!0,gridInfo:"item",defaultValue:"'aggrid', 'adaptable', 'user'"},{name:"showAdaptableColumnMenu",kind:"unknown",description:"Show Adaptable Column Menu (or specific items); can be boolean value or function invoked for each menu item",uiLabel:"Show Adaptable Column Menu",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"showAdaptableContextMenu",kind:"unknown",description:"Show Adaptable Context Menu (or specific items); can be boolean value or function invoked for each menu item",uiLabel:"Show Adaptable Context Menu",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"showUngroupColumnMenuItem",kind:"boolean",description:"Adds 'Ungroup' Column Menu item to a row grouped column",uiLabel:"Show Ungroup Column Menu Item",isOptional:!0,gridInfo:"item",defaultValue:"true"}]},ModuleExpressionFunctions:{name:"ModuleExpressionFunctions",kind:"Interface",description:"Type specific Expression Functions",properties:[{name:"customBooleanFunctions",kind:"unknown",description:"Custom (user defined) Boolean Expression Functions available in AdaptableQL",uiLabel:"Custom Boolean Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (none)"},{name:"customScalarFunctions",kind:"unknown",description:"Custom (user defined) Scalar Expression Functions available in AdaptableQL",uiLabel:"Custom Scalar Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (none)"},{name:"systemAggregatedBooleanFunctions",kind:"unknown",description:"System (built-in) AggregatedBoolean Expression Functions available in AdaptableQL",uiLabel:"System Aggregated Boolean Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"},{name:"systemAggregatedScalarFunctions",kind:"unknown",description:"System (built-in) AggregatedScalar Expression Functions available in AdaptableQL",uiLabel:"System Aggregated Scalar Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"},{name:"systemBooleanFunctions",kind:"unknown",description:"System (built-in) Boolean Expression Functions available in AdaptableQL",uiLabel:"System Boolean Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"},{name:"systemObservableFunctions",kind:"unknown",description:"System (built-in) Observable Expression Functions available in AdaptableQL",uiLabel:"System Observable Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"},{name:"systemScalarFunctions",kind:"unknown",description:"System (built-in) Scalar Expression Functions available in AdaptableQL",uiLabel:"System Scalar Functions",isOptional:!0,gridInfo:"item",defaultValue:"null (sets all)"}]},ModuleExpressionFunctionsContext:{name:"ModuleExpressionFunctionsContext",kind:"Interface",description:"Context provided to ExpressionOptions.moduleExpressionFunctions property callback",properties:[{name:"availableAggregatedBooleanFunctionNames",kind:"array",description:"The global aggregated boolean expression functions",uiLabel:"Available Aggregated Boolean Function Names"},{name:"availableAggregatedScalarFunctionNames",kind:"array",description:"The global aggregated scalar expression functions",uiLabel:"Available Aggregated Scalar Function Names"},{name:"availableBooleanFunctionNames",kind:"array",description:"The global boolean expression functions",uiLabel:"Available Boolean Function Names"},{name:"availableObservableFunctionNames",kind:"array",description:"The global observable expression functions",uiLabel:"Available Observable Function Names"},{name:"availableScalarFunctionNames",kind:"array",description:"The global scalar expression functions",uiLabel:"Available Scalar Function Names"},{name:"module",kind:"REFERENCE",description:"The Adaptable Module requesting the expression functions",uiLabel:"Module",reference:"AdaptableModule"}]},ModuleExpressionFunctionsMap:{name:"ModuleExpressionFunctionsMap",kind:"TypeAlias",description:"Module specific Expression Functions"},NamedQuery:{name:"NamedQuery",kind:"Interface",description:"Defines a Query which can be used in multiple AdapTable Modules",properties:[{name:"Name",kind:"string",description:"Name of the Query - how it will appear in Query dropdown",uiLabel:"Name"}]},NotificationsOptions:{name:"NotificationsOptions",kind:"Interface",description:"Options related to System Status Messages and Notifications in Adaptable.",properties:[{name:"closeWhenClicked",kind:"boolean",description:"Closes Notification automatically when its clicked",uiLabel:"Close When Clicked",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"duration",kind:"number | 'always'",description:"How long (in ms) Notifications display for",uiLabel:"Duration",isOptional:!0,gridInfo:"item",defaultValue:"3000"},{name:"isDraggable",kind:"boolean",description:"Can Notification be dragged",uiLabel:"Is Draggable",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"maxNotifications",kind:"number",description:"How many Notifications can be displayed at one time",uiLabel:"Max Notifications",isOptional:!0,gridInfo:"item",defaultValue:"3"},{name:"maxSystemMessagesInStore",kind:"number",description:"How many System Status Messages to hold in State; when limit is reached, oldest Message is removed",uiLabel:"Max System Messages In Store",isOptional:!0,gridInfo:"item",defaultValue:"100"},{name:"pauseWhenHovering",kind:"boolean",description:"Pauses the Notification when mouse hovers over it",uiLabel:"Pause When Hovering",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"position",kind:"REFERENCE",description:"Where Notification will appear (if anywhere)",uiLabel:"Position",isOptional:!0,gridInfo:"item",defaultValue:"'BottomRight'",reference:"TOAST_POSITIONS"},{name:"showApplicationIcon",kind:"boolean",description:"Displays the application icon in Notifications",uiLabel:"Show Application Icon",isOptional:!0,defaultValue:"false"},{name:"showProgressBar",kind:"boolean",description:"Shows a Progress Bar in the Notification",uiLabel:"Show Progress Bar",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"showSystemStatusMessageNotifications",kind:"boolean",description:"Display System Status Messages as Notifications",uiLabel:"Show System Status Message Notifications",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"transition",kind:"'Bounce' | 'Slide' | 'Zoom' | 'Flip'",description:"How Notification will appear: Bounce, Slide, Zoom or Flip",uiLabel:"Transition",isOptional:!0,gridInfo:"item",defaultValue:"'Slide'"}]},NumberFormatterOptions:{name:"NumberFormatterOptions",kind:"Interface",description:"Formatter Options for Numeric Columns",properties:[{name:"FractionDigits",kind:"number",description:"Number of digits to show in fractions",uiLabel:"Fraction Digits",isOptional:!0},{name:"FractionSeparator",kind:"string",description:"Separator to use in fractions",uiLabel:"Fraction Separator",isOptional:!0},{name:"IntegerDigits",kind:"number",description:"Number of digits to show for integers",uiLabel:"Integer Digits",isOptional:!0},{name:"IntegerSeparator",kind:"string",description:"Separator to use in integers",uiLabel:"Integer Separator",isOptional:!0},{name:"Multiplier",kind:"number",description:"Multiplier to use on the number",uiLabel:"Multiplier",isOptional:!0},{name:"Parentheses",kind:"boolean",description:"Shows negative numbers in parentheses",uiLabel:"Parentheses",isOptional:!0},{name:"Prefix",kind:"string",description:"Prefix to use before the number",uiLabel:"Prefix",isOptional:!0},{name:"Suffix",kind:"string",description:"Suffix to use after the number",uiLabel:"Suffix",isOptional:!0},{name:"Truncate",kind:"boolean",description:"Truncates a number",uiLabel:"Truncate",isOptional:!0}]},ObservableFunctionName:{name:"ObservableFunctionName",kind:"TypeAlias",description:"List of all the Observable Functions available in AdaptableQL"},OpenFinApi:{name:"OpenFinApi",kind:"Interface",description:"Provides run-time access to the OpenFin Plugin",properties:[{name:"clearOpenFinInternalState",kind:"function",description:"Clears any objects in internal OpenFin state created by AdapTable",uiLabel:"Clear Open Fin Internal State"},{name:"getAlertOptions",kind:"function",description:"Gets the Alert section from Adaptable Options",uiLabel:"Get Alert Options"},{name:"getCurrentLiveOpenFinReport",kind:"function",description:"Retrieves the OpenFin currently sending live data to Excel",uiLabel:"Get Current Live Open Fin Report"},{name:"getNotificationsOptions",kind:"function",description:"Gets the Notification section from Adaptable Options",uiLabel:"Get Notifications Options"},{name:"getOpenFinSchedules",kind:"function",description:"Retrieves all Schedules that send data to Excel via OpenFin",uiLabel:"Get Open Fin Schedules"},{name:"getOpenFinState",kind:"function",description:"Retrieves the OpenFin section of System State",uiLabel:"Get Open Fin State"},{name:"getOpenFinThrottleTime",kind:"function",description:"Retrieves the Throttle time for live updates",uiLabel:"Get Open Fin Throttle Time"},{name:"getPluginOptions",kind:"function",description:"Retrieves the OpenFinPlugOptions provided in OpenFin Plugin",uiLabel:"Get Plugin Options"},{name:"isOpenFinAvailable",kind:"function",description:"Whether OpenFin is available",uiLabel:"Is Open Fin Available"},{name:"isOpenFinRunning",kind:"function",description:"Whether OpenFin is currently running",uiLabel:"Is Open Fin Running"},{name:"showNotification",kind:"function",description:"Shows a notification in OpenFin",uiLabel:"Show Notification"},{name:"showNotificationForAlert",kind:"function",description:"Displays Alert as an OpenFin Notification",uiLabel:"Show Notification For Alert"},{name:"startLiveData",kind:"function",description:"Runs Report in Excel as Live Report (so updates as AdapTable ticks)",uiLabel:"Start Live Data"},{name:"stopLiveData",kind:"function",description:"Stops live data; data will no longer be sent from AdapTable to Excel",uiLabel:"Stop Live Data"}]},OpenFinPluginOptions:{name:"OpenFinPluginOptions",kind:"Interface",description:"Options required for when using the OpenFin plugin",properties:[{name:"notificationTimeout",kind:"number | false",description:"Timeout (in ms) for OpenFin Notifications to expire; set false for notifications not to auto-dismiss",uiLabel:"Notification Timeout",isOptional:!0,defaultValue:"5000"},{name:"onFDC3MessageSent",kind:"function",description:"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",uiLabel:"On FDC3Message Sent",isOptional:!0},{name:"onNotificationAction",kind:"unknown",description:"Function which is invoked when a button in OpenFin notification is clicked",uiLabel:"On Notification Action",isOptional:!0},{name:"onShowNotification",kind:"function",description:"Updates OpenFin Notification object before it's displayed (just add/remove properties); return false to stop Notification showing",uiLabel:"On Show Notification",isOptional:!0},{name:"onValidationFailureInExcel",kind:"'override' | 'show-notification' | 'show-undo-notification'",description:"Action to perform when a data change in Live Excel report triggers Prevent Edit Alert failure",uiLabel:"On Validation Failure In Excel",isOptional:!0},{name:"showAdaptableAlertsAsNotifications",kind:"boolean",description:"Converts AdapTable Alerts configured to display in popup as OpenFin Notifications",uiLabel:"Show Adaptable Alerts As Notifications",isOptional:!0,defaultValue:"true"},{name:"showAppIconInNotifications",kind:"unknown",description:"Icon to show in Notification - uses the value supplied in UserInterfaceOptions",uiLabel:"Show App Icon In Notifications",isOptional:!0,defaultValue:"true"},{name:"throttleTime",kind:"number",description:"How long (in ms) AdapTable throttles when sending data update to OpenFin",uiLabel:"Throttle Time",isOptional:!0,defaultValue:"2000"}]},OpenFinReport:{name:"OpenFinReport",kind:"Interface",description:"An OpenFin report",properties:[{name:"ReportName",kind:"string",description:"Name of Report (which will exist in the Export State)",uiLabel:"Report Name"}]},OpenFinSchedule:{name:"OpenFinSchedule",kind:"Interface",description:"Defines a OpenFin Schedule - used in Schedule Module",properties:[{name:"OpenFinReport",kind:"REFERENCE",description:"Report being exported to Excel (via OpenFin)",uiLabel:"Open Fin Report",reference:"OpenFinReport"},{name:"Transmission",kind:"unknown",description:"Whether Snapshot or Live Data (currently only the latter is supported)",uiLabel:"Transmission"}]},OpenFinState:{name:"OpenFinState",kind:"Interface",description:"Internal State used by AdapTable for managing the OpenFin plugin"},OrganizationColumn:{name:"OrganizationColumn",kind:"Interface",description:"A (String) Column which will be defined as an FDC3 Organization",properties:[{name:"fds_idColumnId",kind:"string",description:"Column which contains an FDS_ID",uiLabel:"Fds_id Column Id",isOptional:!0},{name:"intents",kind:"REFERENCE",description:"Organization-related FDC3 Intents; can be: `ViewNews` `ViewAnalysis`",uiLabel:"Intents",isOptional:!0,reference:"unknown"},{name:"leiColumnId",kind:"string",description:"Column which contains the LEI",uiLabel:"Lei Column Id",isOptional:!0},{name:"permidColumnId",kind:"string",description:"Column which contains a PermId",uiLabel:"Permid Column Id",isOptional:!0}]},OrganizationContext:{name:"OrganizationContext",kind:"Interface",description:"FDC3 Context to define an Organization",properties:[{name:"id",kind:"unknown",description:"The Organization data: LEI, PERMID, FDS_ID",uiLabel:"Id",isOptional:!0},{name:"name",kind:"string",description:"Free text name of Organization",uiLabel:"Name",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `organization`",uiLabel:"Type"}]},OrganizationIntent:{name:"OrganizationIntent",kind:"TypeAlias",description:"FDC3 Intents available to an Organization Column"},PercentBarStyle:{name:"PercentBarStyle",kind:"Interface",description:"Style used to display Percent Bars in Special Column Style",properties:[{name:"BackColor",kind:"string",description:"Background colour for 'Percent Bar'; leave unset if none required",uiLabel:"Back Color",isOptional:!0,defaultValue:"Gray"},{name:"CellText",kind:"REFERENCE",description:"Whether Cell shows Cell Value, Percent Value, both or none",uiLabel:"Cell Text",isOptional:!0,reference:"CellTextOptions"},{name:"ToolTipText",kind:"REFERENCE",description:"Whether Tooltip shows Cell Value, Percent Value, both or none",uiLabel:"Tool Tip Text",isOptional:!0,reference:"CellTextOptions"}]},PermittedValues:{name:"PermittedValues",kind:"Interface",description:"Permitted/possible values, when column values can be selected (e.g. sort, bulk-update)",properties:[{name:"values",kind:"unknown",description:"Values to display: either hardcoded list or a function that returns a list",uiLabel:"Values",isOptional:!0}]},PermittedValuesContext:{name:"PermittedValuesContext",kind:"Interface",description:"Context used when getting PermittedValues via a function",properties:[{name:"column",kind:"REFERENCE",description:"Column whose values are being displayed",uiLabel:"Column",reference:"AdaptableColumn"}]},PivotPreviewColumnsContext:{name:"PivotPreviewColumnsContext",kind:"Interface",description:"Context uses for pivotPreviewColumns function in Layout Options",properties:[{name:"columnId",kind:"string",description:"Column being opened",uiLabel:"Column Id"},{name:"layout",kind:"REFERENCE",description:"Current Layout",uiLabel:"Layout",reference:"Layout"}]},PluginsApi:{name:"PluginsApi",kind:"Interface",description:"API methods dealing with AdapTable plugins",properties:[{name:"getFinancePluginApi",kind:"function",description:"Returns Finance API class in Adaptable API",uiLabel:"Get Finance Plugin Api"},{name:"getFinsemblePluginApi",kind:"function",description:"Returns Finsemble API class in Adaptable API",uiLabel:"Get Finsemble Plugin Api"},{name:"getGlue42PluginApi",kind:"function",description:"Returns Glue42 API class in Adaptable API",uiLabel:"Get Glue42Plugin Api"},{name:"getipushpullPluginApi",kind:"function",description:"Returns ipushpull API class in Adaptable API",uiLabel:"Getipushpull Plugin Api"},{name:"getOpenFinPluginApi",kind:"function",description:"Returns OpenFin API class in Adaptable API",uiLabel:"Get Open Fin Plugin Api"},{name:"getPluginsState",kind:"function",description:"Retrieves the Plugin State (internal only)",uiLabel:"Get Plugins State"},{name:"getPluginState",kind:"function",description:"Gets the State for a given Plugin",uiLabel:"Get Plugin State"},{name:"registerPlugin",kind:"function",description:"Registers a Plugin (internal method)",uiLabel:"Register Plugin"},{name:"setPluginState",kind:"function",description:"Sets the initial state for a given plugin (internal method)",uiLabel:"Set Plugin State"}]},PlusMinusApi:{name:"PlusMinusApi",kind:"Interface",description:"Provides run-time access to the Plus / Minus Module and associated state",properties:[{name:"addPlusMinusNudge",kind:"function",description:"Adds new Plus Minus Rule to State",uiLabel:"Add Plus Minus Nudge"},{name:"applyPlusMinus",kind:"function",description:"Applies a Plus Minus to given cells",uiLabel:"Apply Plus Minus"},{name:"editPlusMinusNudge",kind:"function",description:"Replaces Plus Minus Rule in State with given one",uiLabel:"Edit Plus Minus Nudge"},{name:"getAllActivePlusMinus",kind:"function",description:"Retrieves all active (not-suspended) Plus Minus Rules in Adaptable State with those with expressions first",uiLabel:"Get All Active Plus Minus"},{name:"getAllPlusMinus",kind:"function",description:"Retrieves all Plus Minus Rules in Adaptable State with those with expressions first",uiLabel:"Get All Plus Minus"},{name:"getAllSuspendedPlusMinus",kind:"function",description:"Retrieves all suspended Plus Minus Rules in Adaptable State with those with expressions first",uiLabel:"Get All Suspended Plus Minus"},{name:"getPlusMinusById",kind:"function",description:"Retrieves Plus Minus Rule by Id",uiLabel:"Get Plus Minus By Id"},{name:"getPlusMinusState",kind:"function",description:"Retrieves Plus Minus section from Adaptable State",uiLabel:"Get Plus Minus State"},{name:"runPlusMinusNudge",kind:"function",description:"Applies a Plus Minus Rule to given cells",uiLabel:"Run Plus Minus Nudge"},{name:"showPlusMinusPopup",kind:"function",description:"Opens Settings Panel with Plus Minus section selected and visible",uiLabel:"Show Plus Minus Popup"},{name:"suspendPlusMinusNudge",kind:"function",description:"Suspends Plus Minus Rule",uiLabel:"Suspend Plus Minus Nudge"},{name:"unSuspendPlusMinusNudge",kind:"function",description:"Activates a suspended Plus Minus Rule",uiLabel:"Un Suspend Plus Minus Nudge"}]},PlusMinusNudge:{name:"PlusMinusNudge",kind:"Interface",description:"Defines a Plus Minus Rule - used in the Plus Minus Module",properties:[{name:"NudgeValue",kind:"number",description:"Amount by which to update cell when Rule is applied",uiLabel:"Nudge Value"},{name:"Rule",kind:"REFERENCE",description:"(Optional) Boolean Expression to determine whether to apply the Nudge",uiLabel:"Rule",isOptional:!0,reference:"unknown"},{name:"Scope",kind:"REFERENCE",description:"Where Rule is applied",uiLabel:"Scope",reference:"AdaptableScope"}]},PlusMinusState:{name:"PlusMinusState",kind:"Interface",description:"Predefined Configuration for Plus Minus Module",properties:[{name:"PlusMinusNudges",kind:"array",description:"Array of Plus Minus Nudges",uiLabel:"Plus Minus Nudges",isOptional:!0}]},PortfolioContext:{name:"PortfolioContext",kind:"Interface",description:"FDC3 Context to define a financial Portfolio (array of Positions)",properties:[{name:"id",kind:"unknown",description:"Optional Id",uiLabel:"Id",isOptional:!0},{name:"name",kind:"string",description:"Free text name of portfolio",uiLabel:"Name",isOptional:!0},{name:"positions",kind:"array",description:"The position data",uiLabel:"Positions",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `portfolio`",uiLabel:"Type"}]},PositionColumn:{name:"PositionColumn",kind:"Interface",description:"A (Numeric) Column which will be defined as an FDC3 Position",properties:[{name:"instrumentColumnId",kind:"string",description:"Column which contains the Instrument information of the FDC3 Message",uiLabel:"Instrument Column Id"},{name:"intents",kind:"REFERENCE",description:"Position-related FDC3 Intents; can be: `ViewChart` `ViewNews` `ViewAnalysis`",uiLabel:"Intents",isOptional:!0,reference:"PositionIntents"}]},PositionContext:{name:"PositionContext",kind:"Interface",description:"FDC3 Context to define a financial Position (requires an Instrument)",properties:[{name:"holding",kind:"number",description:"Holding in the Position (mandatory)",uiLabel:"Holding"},{name:"id",kind:"unknown",description:"Optional Id",uiLabel:"Id",isOptional:!0},{name:"instrument",kind:"REFERENCE",description:"The `InstrumentContext` of the relevant Instrument",uiLabel:"Instrument",reference:"InstrumentContext"},{name:"name",kind:"string",description:"Free text name of Position",uiLabel:"Name",isOptional:!0},{name:"type",kind:"unknown",description:"Context type is always `position`",uiLabel:"Type"}]},PositionIntent:{name:"PositionIntent",kind:"TypeAlias",description:"FDC3 Intents available to a Position Column"},PositionIntents:{name:"PositionIntents",kind:"TypeAlias",description:"All available Position Intents"},PredefinedConfig:{name:"PredefinedConfig",kind:"Interface",description:"This is the main Predefined Config interface which developers will populate at design-time",properties:[{name:"Alert",kind:"REFERENCE",description:"Collection of `AlertDefinitions` which will fire Alerts when the rule is met",uiLabel:"Alert",isOptional:!0,reference:"AlertState"},{name:"Application",kind:"REFERENCE",description:"Empty state section (only populated at Design Time) available for User to store their own data with the rest of AdapTable state.",uiLabel:"Application",isOptional:!0,reference:"ApplicationState"},{name:"CalculatedColumn",kind:"REFERENCE",description:"Supplies a collection of *CalculatedColumn* objects that will display a value based on other cells in the row (using a Calculated Column Expression)",uiLabel:"Calculated Column",isOptional:!0,reference:"CalculatedColumnState"},{name:"Charting",kind:"REFERENCE",description:"Predefine charting models",uiLabel:"Charting",isOptional:!0,reference:"ChartingState"},{name:"ConditionalStyle",kind:"REFERENCE",description:"Supplies a collection of *ConditionalStyle* objects to provides columns and rows with a particular style when the data matches a given rule",uiLabel:"Conditional Style",isOptional:!0,reference:"unknown"},{name:"CustomSort",kind:"REFERENCE",description:"Supplies a collection of *Custom Sort* objects to allow some columns to be sorted in non-standard (e.g. non alphabetical) ways",uiLabel:"Custom Sort",isOptional:!0,reference:"CustomSortState"},{name:"Dashboard",kind:"REFERENCE",description:"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",uiLabel:"Dashboard",isOptional:!0,reference:"DashboardState"},{name:"Export",kind:"REFERENCE",description:"Supplies a collection of *Report* objects, together with name of the Current Report, as part of AdapTable export Module",uiLabel:"Export",isOptional:!0,reference:"ExportState"},{name:"FlashingCell",kind:"REFERENCE",description:"* Objects which define which cells flash in response to data changes",uiLabel:"Flashing Cell",isOptional:!0,reference:"FlashingCellState"},{name:"FormatColumn",kind:"REFERENCE",description:"Supplies a collection of *FormatColumn* objects that will style an entire column in a single way (and not subject to a rule like with Conditional Style).",uiLabel:"Format Column",isOptional:!0,reference:"FormatColumnState"},{name:"FreeTextColumn",kind:"REFERENCE",description:"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.",uiLabel:"Free Text Column",isOptional:!0,reference:"FreeTextColumnState"},{name:"Layout",kind:"REFERENCE",description:"Supplies a collection of *Layout* objects to name and manage groups of column visibility, order and sorts.",uiLabel:"Layout",isOptional:!0,reference:"LayoutState"},{name:"PlusMinus",kind:"REFERENCE",description:"Supplies a collection of *PlusMinus* rule objects to stipulate what happens when the user clicks '+' or '-' in a numeric cell",uiLabel:"Plus Minus",isOptional:!0,reference:"PlusMinusState"},{name:"Query",kind:"REFERENCE",description:"Named Queries available for use across multiple AdapTable Modules; and `CurrentQuery` - an Expression to run at start-up",uiLabel:"Query",isOptional:!0,reference:"QueryState"},{name:"QuickSearch",kind:"REFERENCE",description:"Configues how Quick Search will run i.e. how and whether to highlight matching cells and to filter out non-matching rows",uiLabel:"Quick Search",isOptional:!0,reference:"QuickSearchState"},{name:"Schedule",kind:"REFERENCE",description:"Supplies a collection of *Schedule* objects",uiLabel:"Schedule",isOptional:!0,reference:"ScheduleState"},{name:"Shortcut",kind:"REFERENCE",description:"Supplies a collection of *Shortcut* objects to aid data entry and prevent 'fat finger' issues",uiLabel:"Shortcut",isOptional:!0,reference:"ShortcutState"},{name:"StatusBar",kind:"REFERENCE",description:"Configures the Adaptable Status Bar",uiLabel:"Status Bar",isOptional:!0,reference:"StatusBarState"},{name:"StyledColumn",kind:"REFERENCE",description:"Supplies a collection of Special Column Styles",uiLabel:"Styled Column",isOptional:!0,reference:"StyledColumnState"},{name:"Theme",kind:"REFERENCE",description:"Specifies the current Theme and lists the User and System themes available for selection.",uiLabel:"Theme",isOptional:!0,reference:"ThemeState"},{name:"ToolPanel",kind:"REFERENCE",description:"Sets the order and visibility of the Tool Panel controls in the AdapTable ToolPanel (on right of grid)",uiLabel:"Tool Panel",isOptional:!0,reference:"ToolPanelState"}]},PredicateApi:{name:"PredicateApi",kind:"Interface",description:"Functions which manage the Predicate object in AdapTable",properties:[{name:"getCustomPredicateDefById",kind:"function",description:"Gets Predicate Definition provided by users for given Id",uiLabel:"Get Custom Predicate Def By Id"},{name:"getCustomPredicateDefs",kind:"function",description:"Returns Predicate Definitions provided by users",uiLabel:"Get Custom Predicate Defs"},{name:"getEqualityPredicateForDataType",kind:"function",description:"Gets the correct Equality-type System Predicate for a particular DataType",uiLabel:"Get Equality Predicate For Data Type"},{name:"getPredicateDefById",kind:"function",description:"Gets the Predicate Definition for a given Id",uiLabel:"Get Predicate Def By Id"},{name:"getPredicateDefs",kind:"function",description:"Returns all current Predicate Definitions",uiLabel:"Get Predicate Defs"},{name:"getPredicateDefsByModuleScope",kind:"function",description:"Retrieves all Predicate Definitions for given Module Scope",uiLabel:"Get Predicate Defs By Module Scope"},{name:"getSystemPredicateDefById",kind:"function",description:"Gets Predicate Definition provided by AdapTable for given Id",uiLabel:"Get System Predicate Def By Id"},{name:"getSystemPredicateDefs",kind:"function",description:"Returns Predicate Definitions provided by AdapTable",uiLabel:"Get System Predicate Defs"},{name:"handlePredicate",kind:"function",description:"Main Handler function for a Predicate Definition - used by AdapTableQL",uiLabel:"Handle Predicate"},{name:"hasPredicateValues",kind:"function",description:"Returns true if the predicate has a dropdown.",uiLabel:"Has Predicate Values"},{name:"isValidPredicate",kind:"function",description:"Checks whether a given Predicate Definition is valid",uiLabel:"Is Valid Predicate"},{name:"predicateToString",kind:"function",description:"Stringifies a given Predicate Definition",uiLabel:"Predicate To String"}]},PredicateDefHandlerParams:{name:"PredicateDefHandlerParams",kind:"Interface",description:"Object passed into an Adaptable Predicate Definition",properties:[{name:"api",kind:"REFERENCE",description:"The Adaptable Api",uiLabel:"Api",reference:"AdaptableApi"},{name:"column",kind:"REFERENCE",description:"Adaptable Column which contains the cell",uiLabel:"Column",reference:"AdaptableColumn"},{name:"displayValue",kind:"unknown",description:"Display value in cell being evaluated",uiLabel:"Display Value"},{name:"inputs",kind:"array",description:"Any inputs required to perform evaluation",uiLabel:"Inputs"},{name:"node",kind:"REFERENCE",description:"AG Grid Row node which contains the cell",uiLabel:"Node",reference:"unknown"},{name:"oldValue",kind:"unknown",description:"Previous value in cell (e.g. if evaluating an edit)",uiLabel:"Old Value"},{name:"value",kind:"unknown",description:"Raw value in cell being evaluated",uiLabel:"Value"}]},QueryableColumnContext:{name:"QueryableColumnContext",kind:"Interface",description:"Context passed when evaluating Queryable Columns",properties:[{name:"adaptableColumn",kind:"REFERENCE",description:"Basic Column Info - just ColumnId, DataType and FriendlyName",uiLabel:"Adaptable Column",reference:"AdaptableColumnBase"}]},QueryApi:{name:"QueryApi",kind:"Interface",description:"Provides run-time access to Named and Current Queries",properties:[{name:"clearCurrentQuery",kind:"function",description:"Clears the Current Query",uiLabel:"Clear Current Query"},{name:"expandCurrentQuery",kind:"function",description:"Opens current query editor",uiLabel:"Expand Current Query"},{name:"fireQueryRunEvent",kind:"function",description:"Fires Query Run Event - typically used to enable querying on the server",uiLabel:"Fire Query Run Event"},{name:"getAllNamedQuery",kind:"function",description:"Gets all Named Queries in Adaptable State",uiLabel:"Get All Named Query"},{name:"getCurrentQuery",kind:"function",description:"Returns the Current Query",uiLabel:"Get Current Query"},{name:"getNamedQueryByName",kind:"function",description:"Retrieves Named Query with given name from State",uiLabel:"Get Named Query By Name"},{name:"getNamedQueryModuleReferences",kind:"function",description:"Returns all the references in the AdaptableState of the NamedQuery with the given name",uiLabel:"Get Named Query Module References"},{name:"getQueryState",kind:"function",description:"Retrieves Query section from Adaptable State",uiLabel:"Get Query State"},{name:"getReferencedNamedQueryNames",kind:"function",description:"Returns the name of all the referenced Named Queries as an array of strings",uiLabel:"Get Referenced Named Query Names"},{name:"isValidNamedQueryName",kind:"function",description:"Checks if the given Named Query has a valid name",uiLabel:"Is Valid Named Query Name"},{name:"setCurrentQuery",kind:"function",description:"Set a Query as Current Query",uiLabel:"Set Current Query"},{name:"showExpandedQueryPopup",kind:"function",description:"Opens Expanded Query Popup screen",uiLabel:"Show Expanded Query Popup"},{name:"showQueryPopup",kind:"function",description:"Opens Settings Panel with Query section selected and visible",uiLabel:"Show Query Popup"}]},QueryLanguageApi:{name:"QueryLanguageApi",kind:"Interface",description:"Functions related to AdapTableQL (the Adaptable Query Language)",properties:[{name:"getAdaptableQueryExpression",kind:"function",description:"Returns the Expression string of the given AdaptableQuery: can be Boolean, AggregatedBoolean, Scalar, AggregatedScalar or Observable Expression",uiLabel:"Get Adaptable Query Expression"},{name:"getAdaptableQueryExpressionWithColumnFriendlyNames",kind:"function",description:"Returns the Expression string of the given AdaptableQuery with the column friendly names (instead of their technical IDs)",uiLabel:"Get Adaptable Query Expression With Column Friendly Names"},{name:"getASTForExpression",kind:"function",description:"Runs the AST that AdapTableQL creates for an Expression - useful when evaluating remotely",uiLabel:"Get AST For Expression"},{name:"getColumnsFromExpression",kind:"function",description:"Returns all Columns referenced in an Expression",uiLabel:"Get Columns From Expression"},{name:"isColumnQueryable",kind:"function",description:"Returns whether a Column is Queryable",uiLabel:"Is Column Queryable"},{name:"isValidAggregatedBooleanExpression",kind:"function",description:"Whether the given AggregatedBooleanExpression is valid",uiLabel:"Is Valid Aggregated Boolean Expression"},{name:"isValidAggregatedScalarExpression",kind:"function",description:"Whether the given AggregatedScalarExpression is valid",uiLabel:"Is Valid Aggregated Scalar Expression"},{name:"isValidBooleanExpression",kind:"function",description:"Whether the given BooleanExpression is valid",uiLabel:"Is Valid Boolean Expression"},{name:"isValidObservableExpression",kind:"function",description:"Whether the given ObservableExpression is valid",uiLabel:"Is Valid Observable Expression"}]},QueryRunInfo:{name:"QueryRunInfo",kind:"Interface",description:"EventInfo returned by the QueryRun event",properties:[{name:"currentQuery",kind:"string | undefined",description:"Current Query",uiLabel:"Current Query"},{name:"queryAST",kind:"unknown",description:"AST for Current Query",uiLabel:"Query AST"}]},QueryState:{name:"QueryState",kind:"Interface",description:"Predefined Configuration for Query Module",properties:[{name:"CurrentQuery",kind:"string",description:"Expression used for the Query currently being run",uiLabel:"Current Query",isOptional:!0},{name:"NamedQueries",kind:"array",description:"Named Queries - can be referenced in other Expressions",uiLabel:"Named Queries",isOptional:!0}]},QuickSearchApi:{name:"QuickSearchApi",kind:"Interface",description:"Provides run-time access to Quick Search Module",properties:[{name:"clearQuickSearch",kind:"function",description:"Clears Quick Search",uiLabel:"Clear Quick Search"},{name:"getQuickSearchState",kind:"function",description:"Retrieves Quick Search section from Adaptable State",uiLabel:"Get Quick Search State"},{name:"getQuickSearchStyle",kind:"function",description:"Retrieves current Quick Search style",uiLabel:"Get Quick Search Style"},{name:"getQuickSearchValue",kind:"function",description:"Retrieves current Quick Search text",uiLabel:"Get Quick Search Value"},{name:"runQuickSearch",kind:"function",description:"Runs Quick Search using supplied text",uiLabel:"Run Quick Search"},{name:"setQuickSearchStyle",kind:"function",description:"Sets style for Quick Search; can be name of (a provided) css style",uiLabel:"Set Quick Search Style"},{name:"showQuickSearchPopup",kind:"function",description:"Opens Settings Panel with Quick Search section selected and visible",uiLabel:"Show Quick Search Popup"}]},QuickSearchState:{name:"QuickSearchState",kind:"Interface",description:"Predefined Configuration for Quick Search Module",properties:[{name:"QuickSearchText",kind:"string",description:"Last Quick Search that was run (and will run again at start up)",uiLabel:"Quick Search Text",isOptional:!0},{name:"Style",kind:"REFERENCE",description:"Style to use to highlight matching cells - uses common `AdaptableStyle` object",uiLabel:"Style",isOptional:!0,reference:"AdaptableStyle"}]},RaiseFDC3IntentContext:{name:"RaiseFDC3IntentContext",kind:"Interface",description:"Context passed into Raise FDC3 Intent functions (e.g. get label)",properties:[{name:"intent",kind:"unknown",description:"FDC3 Intent that was raised",uiLabel:"Intent"}]},RangeValueType:{name:"RangeValueType",kind:"TypeAlias",description:"Whether the Range is Number or Percent based"},ReactFrameworkComponent:{name:"ReactFrameworkComponent",kind:"TypeAlias",description:"A function that returns a ReactNode"},ReminderSchedule:{name:"ReminderSchedule",kind:"Interface",description:"Schedules a Reminder to appear at a given point in time",properties:[{name:"DisplayNotification",kind:"boolean",description:"Displays Reminder as a Toast Notification",uiLabel:"Display Notification"},{name:"DisplaySystemStatusMessage",kind:"boolean",description:"Shows Reminder as System Status Message",uiLabel:"Display System Status Message",isOptional:!0},{name:"Header",kind:"string",description:"Reminder header text",uiLabel:"Header"},{name:"Message",kind:"string",description:"Reminder body text",uiLabel:"Message"},{name:"MessageType",kind:"REFERENCE",description:"Type of Message - 'Success', 'Info', 'Warning' or 'Error'",uiLabel:"Message Type",reference:"AdaptableMessageType"}]},ReportColumnScope:{name:"ReportColumnScope",kind:"TypeAlias",description:"Columns to be included in a Report"},ReportContext:{name:"ReportContext",kind:"Interface",description:"Report Context sent when using Custom Export Destinations",properties:[{name:"report",kind:"REFERENCE",description:"Definition of Report being Run",uiLabel:"Report",reference:"unknown"},{name:"reportData",kind:"REFERENCE",description:"Data being exported in the Report",uiLabel:"Report Data",reference:"ReportData"}]},ReportData:{name:"ReportData",kind:"Interface",description:"Defines the data in a Report run by AdapTable",properties:[{name:"columns",kind:"array",description:"Columns in the Report",uiLabel:"Columns"},{name:"rows",kind:"unknown",description:"Rows in the Report",uiLabel:"Rows"}]},ReportRowScope:{name:"ReportRowScope",kind:"TypeAlias",description:"AG Grid Row Data to be included in a Report"},ReportSchedule:{name:"ReportSchedule",kind:"Interface",description:"Defines a Scheduled Report - used in Schedule Module (where State is stored)",properties:[{name:"ExportDestination",kind:"'Excel' | 'CSV' | 'Clipboard' | 'JSON' | string",description:"Where report data will be exported",uiLabel:"Export Destination"},{name:"ExportDestinationData",kind:"REFERENCE",description:"Additional data for a Custom Destination produced by a Dynamic Form",uiLabel:"Export Destination Data",isOptional:!0,reference:"unknown"},{name:"ReportName",kind:"string",description:"Name of Report to run on Schedule",uiLabel:"Report Name"}]},RowInfo:{name:"RowInfo",kind:"Interface",description:"Provides meta data about a Row in Adaptable",properties:[{name:"isDisplayed",kind:"boolean",description:"Is Row displayed (ie. filtered, not necessarily in viewport)",uiLabel:"Is Displayed",isOptional:!0},{name:"isExpanded",kind:"boolean",description:"Is Row expanded (if a group row)",uiLabel:"Is Expanded",isOptional:!0},{name:"isGroup",kind:"boolean",description:"Is Row grouped",uiLabel:"Is Group",isOptional:!0},{name:"isMaster",kind:"boolean",description:"Is Row a Master Row (in a Master-Detail grid)",uiLabel:"Is Master",isOptional:!0},{name:"isSelected",kind:"boolean",description:"Is Row selected",uiLabel:"Is Selected",isOptional:!0},{name:"rowGroupLevel",kind:"number",description:"What level the Row is (if Row Grouping is active)",uiLabel:"Row Group Level",isOptional:!0}]},ScalarFunctionName:{name:"ScalarFunctionName",kind:"TypeAlias",description:"List of all the Scalar Functions available in AdaptableQL"},Schedule:{name:"Schedule",kind:"Interface",description:"Defines when an action will be run - either one-off or recurring",properties:[{name:"DaysOfWeek",kind:"REFERENCE",description:"Days on which Schedule will run",uiLabel:"Days Of Week",isOptional:!0,reference:"unknown"},{name:"Hour",kind:"number",description:"Hour the Schedule will run",uiLabel:"Hour"},{name:"Minute",kind:"number",description:"Minute the Schedule will run",uiLabel:"Minute"},{name:"OneOffDate",kind:"string",description:"A one off date on which the Schedule will run",uiLabel:"One Off Date",isOptional:!0}]},ScheduleApi:{name:"ScheduleApi",kind:"Interface",description:"Provides run-time access to the Schedule Module and associated state",properties:[{name:"addGlue42Schedule",kind:"function",description:"Add Glue42-based Schedule",uiLabel:"Add Glue42Schedule"},{name:"addIPushPullSchedule",kind:"function",description:"Add ipushpull-based Schedule",uiLabel:"Add IPush Pull Schedule"},{name:"addOpenFinSchedule",kind:"function",description:"Add OpenFin-based Schedule",uiLabel:"Add Open Fin Schedule"},{name:"addReminderSchedule",kind:"function",description:"Adds Reminder-based Schedule",uiLabel:"Add Reminder Schedule"},{name:"addReportSchedule",kind:"function",description:"Adds Report / Export Schedule",uiLabel:"Add Report Schedule"},{name:"applySchedule",kind:"function",description:"Applies the Schedule of given type",uiLabel:"Apply Schedule"},{name:"deleteGlue42Schedule",kind:"function",description:"Delete Glue42-based Schedule",uiLabel:"Delete Glue42Schedule"},{name:"deleteIPushPullSchedule",kind:"function",description:"Delete ipushpull-based Schedule",uiLabel:"Delete IPush Pull Schedule"},{name:"deleteOpenFinSchedule",kind:"function",description:"Delete OpenFin-based Schedule",uiLabel:"Delete Open Fin Schedule"},{name:"deleteReminderSchedule",kind:"function",description:"Deletes Reminder-based Schedule",uiLabel:"Delete Reminder Schedule"},{name:"deleteReportSchedule",kind:"function",description:"Deletes Report / Export Schedule",uiLabel:"Delete Report Schedule"},{name:"editGlue42Schedule",kind:"function",description:"Edit Glue42-based Schedule",uiLabel:"Edit Glue42Schedule"},{name:"editIPushPullSchedule",kind:"function",description:"Edit ipushpull-based Schedule",uiLabel:"Edit IPush Pull Schedule"},{name:"editOpenFinSchedule",kind:"function",description:"Edit OpenFin-based Schedule",uiLabel:"Edit Open Fin Schedule"},{name:"editReminderSchedule",kind:"function",description:"Edits Reminder-based Schedule",uiLabel:"Edit Reminder Schedule"},{name:"editReportSchedule",kind:"function",description:"Edits Report / Export Schedule",uiLabel:"Edit Report Schedule"},{name:"getAllActiveGlue42Schedule",kind:"function",description:"Retrieves all active (not-suspended) Glue42-based Schedules from Schedule State",uiLabel:"Get All Active Glue42Schedule"},{name:"getAllActiveIPushPullSchedule",kind:"function",description:"Retrieves all active (not-suspended) ipushpull-based Schedules from Schedule State",uiLabel:"Get All Active IPush Pull Schedule"},{name:"getAllActiveOpenFinSchedule",kind:"function",description:"Retrieves all active (not-suspended) OpenFin-based Schedules from Schedule State",uiLabel:"Get All Active Open Fin Schedule"},{name:"getAllActiveReminderSchedule",kind:"function",description:"Retrieves all active (not-suspended) Reminder-based Schedules from Schedule State",uiLabel:"Get All Active Reminder Schedule"},{name:"getAllActiveReportSchedule",kind:"function",description:"Retrieves all active (not-suspended) Report / Export Schedules from Schedule State",uiLabel:"Get All Active Report Schedule"},{name:"getAllGlue42Schedule",kind:"function",description:"Retrieves all Glue42-based Schedules from Schedule State",uiLabel:"Get All Glue42Schedule"},{name:"getAllIPushPullSchedule",kind:"function",description:"Retrieves all ipushpull-based Schedules from Schedule State",uiLabel:"Get All IPush Pull Schedule"},{name:"getAllOpenFinSchedule",kind:"function",description:"Retrieves all OpenFin-based Schedules from Schedule State",uiLabel:"Get All Open Fin Schedule"},{name:"getAllReminderSchedule",kind:"function",description:"Retrieves all Reminder-based Schedules from Schedule State",uiLabel:"Get All Reminder Schedule"},{name:"getAllReportSchedule",kind:"function",description:"Retrieves all Report / Export Schedules from Schedule State",uiLabel:"Get All Report Schedule"},{name:"getAllSchedule",kind:"function",description:"Retrieves the Schedule section from Adaptable State",uiLabel:"Get All Schedule"},{name:"getAllSuspendedGlue42Schedule",kind:"function",description:"Retrieves all suspended Glue42-based Schedules from Schedule State",uiLabel:"Get All Suspended Glue42Schedule"},{name:"getAllSuspendedIPushPullSchedule",kind:"function",description:"Retrieves all suspended ipushpull-based Schedules from Schedule State",uiLabel:"Get All Suspended IPush Pull Schedule"},{name:"getAllSuspendedOpenFinSchedule",kind:"function",description:"Retrieves all suspended OpenFin-based Schedules from Schedule State",uiLabel:"Get All Suspended Open Fin Schedule"},{name:"getAllSuspendedReminderSchedule",kind:"function",description:"Retrieves all suspended Reminder-based Schedules from Schedule State",uiLabel:"Get All Suspended Reminder Schedule"},{name:"getAllSuspendedReportSchedule",kind:"function",description:"Retrieves all suspended Report / Export Schedules from Schedule State",uiLabel:"Get All Suspended Report Schedule"},{name:"getScheduleById",kind:"function",description:"Retrieves Schedule by id",uiLabel:"Get Schedule By Id"},{name:"getScheduleState",kind:"function",description:"Retrieves Schedule section from Adaptable State",uiLabel:"Get Schedule State"},{name:"showSchedulePopup",kind:"function",description:"Opens Settings Panel with Schedule section selected and visible",uiLabel:"Show Schedule Popup"},{name:"suspendGlue42Schedule",kind:"function",description:"Suspends Glue42-based Schedule",uiLabel:"Suspend Glue42Schedule"},{name:"suspendIPushPullSchedule",kind:"function",description:"Suspends ipushpull-based Schedule",uiLabel:"Suspend IPush Pull Schedule"},{name:"suspendOpenFinSchedule",kind:"function",description:"Suspends OpenFin-based Schedule",uiLabel:"Suspend Open Fin Schedule"},{name:"suspendReminderSchedule",kind:"function",description:"Suspends Reminder-based Schedule",uiLabel:"Suspend Reminder Schedule"},{name:"suspendReportSchedule",kind:"function",description:"Suspends Report / Export Schedule",uiLabel:"Suspend Report Schedule"},{name:"unSuspendGlue42Schedule",kind:"function",description:"Activates a suspended Glue42-based Schedule",uiLabel:"Un Suspend Glue42Schedule"},{name:"unSuspendIPushPullSchedule",kind:"function",description:"Activates a suspended ipushpull-based Schedule",uiLabel:"Un Suspend IPush Pull Schedule"},{name:"unSuspendOpenFinSchedule",kind:"function",description:"Activates a suspended OpenFin-based Schedule",uiLabel:"Un Suspend Open Fin Schedule"},{name:"unSuspendReminderSchedule",kind:"function",description:"Activates a suspended Reminder-based Schedule",uiLabel:"Un Suspend Reminder Schedule"},{name:"unSuspendReportSchedule",kind:"function",description:"Activates a suspended Report / Export Schedule",uiLabel:"Un Suspend Report Schedule"}]},ScheduleState:{name:"ScheduleState",kind:"Interface",description:"Predefined Configuration for the Schedule Module",properties:[{name:"Glue42Schedules",kind:"array",description:"Schedules connected to Glue42 exports - available if Glue42 plugin is running",uiLabel:"Glue42Schedules",isOptional:!0},{name:"IPushPullSchedules",kind:"array",description:"Schedules connected to ipushpull Reports - available if ipushpull plugin is running",uiLabel:"I Push Pull Schedules",isOptional:!0},{name:"OpenFinSchedules",kind:"array",description:"Schedules connected to OpenFin exports - available if OpenFin plugin is running",uiLabel:"Open Fin Schedules",isOptional:!0},{name:"Reminders",kind:"array",description:"Schedules connected to Reminders - Alerts that fire at set times",uiLabel:"Reminders",isOptional:!0},{name:"ReportSchedules",kind:"array",description:"Schedules connected to Reports (created in the Export function)",uiLabel:"Report Schedules",isOptional:!0}]},ScopeApi:{name:"ScopeApi",kind:"Interface",description:"Provides access to a suite of functions related to the `Scope` object",properties:[{name:"areAllBooleanColumnsInScope",kind:"function",description:"True if all selected columns are boolean",uiLabel:"Are All Boolean Columns In Scope"},{name:"createCellColorRangesForScope",kind:"function",description:"Creates Cell Color Ranges (used in Format Column) for given Scope",uiLabel:"Create Cell Color Ranges For Scope"},{name:"getColumnIdsInScope",kind:"function",description:"Returns all the ColumnIds in the Scope",uiLabel:"Get Column Ids In Scope"},{name:"getColumnsForScope",kind:"function",description:"Returns list of all Columns in the given Scope",uiLabel:"Get Columns For Scope"},{name:"getDataTypesInScope",kind:"function",description:"Returns all the DataTypes in the Scope",uiLabel:"Get Data Types In Scope"},{name:"getScopeDescription",kind:"function",description:"Provides a description for the Scope",uiLabel:"Get Scope Description"},{name:"getScopeToString",kind:"function",description:"Gets string representation of the Scope",uiLabel:"Get Scope To String"},{name:"getSingleColumnInScope",kind:"function",description:"Gets the only Column in given Scope",uiLabel:"Get Single Column In Scope"},{name:"isColumnInDateScope",kind:"function",description:"True if Scope has Data DataType which contains Column",uiLabel:"Is Column In Date Scope"},{name:"isColumnInNumericScope",kind:"function",description:"True if Scope has Numeric DataType containing Column",uiLabel:"Is Column In Numeric Scope"},{name:"isColumnInScope",kind:"function",description:"True if Column is in given Scope",uiLabel:"Is Column In Scope"},{name:"isColumnInScopeColumns",kind:"function",description:"True if Column is in Scope's 'ColumnIds' section",uiLabel:"Is Column In Scope Columns"},{name:"isColumnInStringsScope",kind:"function",description:"True if Scope has String DataType containing Column",uiLabel:"Is Column In Strings Scope"},{name:"isPrimaryKeyColumnInScopeColumns",kind:"function",description:"Whether PK column is included in Scope's column section",uiLabel:"Is Primary Key Column In Scope Columns"},{name:"isScopeInScope",kind:"function",description:"True if first scope is in second Scope",uiLabel:"Is Scope In Scope"},{name:"isSingleBooleanColumnScope",kind:"function",description:"True if Scope contains just 1 boolean Column",uiLabel:"Is Single Boolean Column Scope"},{name:"isSingleColumnScope",kind:"function",description:"True if Scope contains just 1 ColumnId",uiLabel:"Is Single Column Scope"},{name:"isSingleNumericColumnScope",kind:"function",description:"True if Scope contains just 1 numeric Column",uiLabel:"Is Single Numeric Column Scope"},{name:"scopeHasColumns",kind:"function",description:"True if Scope contains ColumnIds",uiLabel:"Scope Has Columns"},{name:"scopeHasDataType",kind:"function",description:"True if Scope contains DataTypes",uiLabel:"Scope Has Data Type"},{name:"scopeHasOnlyBooleanDataType",kind:"function",description:"True if the Scope is DataTypes and contains only Boolean",uiLabel:"Scope Has Only Boolean Data Type"},{name:"scopeIsAll",kind:"function",description:"True if Scope is 'All'",uiLabel:"Scope Is All"},{name:"scopeIsEmpty",kind:"function",description:"True if Scope is empty",uiLabel:"Scope Is Empty"}]},SearchChangedInfo:{name:"SearchChangedInfo",kind:"Interface",description:"Deprecated Search Changed Event - use `QueryRun` or `FilterApplied` instead"},SearchOptions:{name:"SearchOptions",kind:"Interface",description:"Search options section of Adaptable Options; includes options for running some (or all) search functions on the server",properties:[{name:"clearSearchesOnStartUp",kind:"boolean",description:"Clears saved searches when AdapTable loads",uiLabel:"Clear Searches On Start Up",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"excludeColumnFromQuickSearch",kind:"function",description:"Function enabling specific Columns to be excluded from Quick Search",uiLabel:"Exclude Column From Quick Search",isOptional:!0,defaultValue:"undefined"},{name:"filterResultsAfterQuickSearch",kind:"boolean",description:"Filters the quick search results so only matching rows are displayed",uiLabel:"Filter Results After Quick Search",isOptional:!0,gridInfo:"item",defaultValue:"false"},{name:"quickSearchPlaceholder",kind:"string",description:"Value to use as placeholder in QuickSearch controls (e.g. in Dashboard)",uiLabel:"Quick Search Placeholder",isOptional:!0,gridInfo:"item",defaultValue:"'Search'"}]},SelectedCellInfo:{name:"SelectedCellInfo",kind:"Interface",description:"Describes which Cells are currently selected in AdapTable",properties:[{name:"columns",kind:"array",description:"Array of Columns which have selected cells",uiLabel:"Columns"},{name:"gridCells",kind:"array",description:"Array of GridCells (which provide cell value, primary kev value and other info)",uiLabel:"Grid Cells"}]},SelectedRowInfo:{name:"SelectedRowInfo",kind:"Interface",description:"Describes which Rows are currently selected in AdapTable",properties:[{name:"gridRows",kind:"array",description:"Array of Grid Rows containing full information about a row in AdapTable",uiLabel:"Grid Rows"}]},SelectionChangedInfo:{name:"SelectionChangedInfo",kind:"Interface",description:"Event Info published by SelectionChanged event",properties:[{name:"selectedCellInfo",kind:"REFERENCE",description:"Details of cells currently selected in the Grid",uiLabel:"Selected Cell Info",reference:"SelectedCellInfo"},{name:"selectedRowInfo",kind:"REFERENCE",description:"Details of rows currently selected in the Grid",uiLabel:"Selected Row Info",reference:"SelectedRowInfo"}]},ServerReport:{name:"ServerReport",kind:"Interface",description:"Defines a Report where all the data is provided entirely by the user",properties:[{name:"name",kind:"string",description:"Name of the Report",uiLabel:"Name"},{name:"onRunReport",kind:"function",description:"Function invoked to return the data (in the form of a `ReportData` object)",uiLabel:"On Run Report"}]},SettingsPanelApi:{name:"SettingsPanelApi",kind:"Interface",description:"Provides run-time access to the Settings Panel",properties:[{name:"showCustomSettingsPanel",kind:"function",description:"Opens Settings Panel with the Custom Settings Panel, provided by name, displayed",uiLabel:"Show Custom Settings Panel"},{name:"showSettingsPanel",kind:"function",description:"Opens Settings Panel and displays specified Module (if provided) or first available one",uiLabel:"Show Settings Panel"}]},SharedEntity:{name:"SharedEntity",kind:"Interface",description:"Defines an object used in Team Sharing",properties:[{name:"ChangedAt",kind:"number",description:"Last time when the object was changed",uiLabel:"Changed At"},{name:"ChangedBy",kind:"string",description:"Last User who changed the object",uiLabel:"Changed By"},{name:"Description",kind:"string",description:"Description of object being shared",uiLabel:"Description"},{name:"Entity",kind:"REFERENCE",description:"Actual Adaptable Object being shared",uiLabel:"Entity",reference:"AdaptableObject"},{name:"EntityDependencyIds",kind:"array",description:"Ids of direct entity dependencies",uiLabel:"Entity Dependency Ids"},{name:"Module",kind:"REFERENCE",description:"Adaptable Module to which object belongs",uiLabel:"Module",reference:"AdaptableModule"},{name:"Revision",kind:"number",description:"Revision - incremental for 'Active', always 1 for 'Snapshot'",uiLabel:"Revision"},{name:"Timestamp",kind:"number",description:"When the object was shared",uiLabel:"Timestamp"},{name:"Type",kind:"REFERENCE",description:"'Snapshot' (for 1-time sharing) or 'Active' (for continuous sharing between local state & Team Share)",uiLabel:"Type",reference:"unknown"},{name:"UserName",kind:"string",description:"User who shared the object",uiLabel:"User Name"}]},SharedEntityConfig:{name:"SharedEntityConfig",kind:"Interface",description:"Describes an Object which is being Team Shared"},Shortcut:{name:"Shortcut",kind:"Interface",description:"Used to define a Shortcut as used in Shortcut State",properties:[{name:"Scope",kind:"unknown",description:"Numeric Columns where Shortcut is applied",uiLabel:"Scope"},{name:"ShortcutKey",kind:"string",description:"Key which triggers the Shortcut when pressed",uiLabel:"Shortcut Key"},{name:"ShortcutOperation",kind:"'Add' | 'Subtract' | 'Multiply' | 'Divide'",description:"The Operation: 'Add', 'Subtract', 'Multiply', 'Divide'",uiLabel:"Shortcut Operation"},{name:"ShortcutValue",kind:"number",description:"Value acting as 2nd operand for ShortcutOperation (1st operand is the cell value)",uiLabel:"Shortcut Value"}]},ShortcutApi:{name:"ShortcutApi",kind:"Interface",description:"Provides run-time access to Shortcut Module and associated state",properties:[{name:"addShortcut",kind:"function",description:"Adds new Shortcut to the state",uiLabel:"Add Shortcut"},{name:"deleteAllShortcut",kind:"function",description:"Deletes all Shortcuts in Adaptable State",uiLabel:"Delete All Shortcut"},{name:"deleteShortcut",kind:"function",description:"Deletes Shortcut from the state",uiLabel:"Delete Shortcut"},{name:"getAllActiveShortcut",kind:"function",description:"Gets all active (not-suspended) Shortcuts in Adaptable State",uiLabel:"Get All Active Shortcut"},{name:"getAllShortcut",kind:"function",description:"Gets all Shortcuts in Adaptable State",uiLabel:"Get All Shortcut"},{name:"getAllSuspendedShortcut",kind:"function",description:"Gets all suspended Shortcuts in Adaptable State",uiLabel:"Get All Suspended Shortcut"},{name:"getShortcutById",kind:"function",description:"Retrieves Shortcut by Id",uiLabel:"Get Shortcut By Id"},{name:"getShortcutState",kind:"function",description:"Retrieves Shortcut section from Adaptable State",uiLabel:"Get Shortcut State"},{name:"showShortcutPopup",kind:"function",description:"Opens Settings Panel with Shortcut section selected and visible",uiLabel:"Show Shortcut Popup"},{name:"suspendShortcut",kind:"function",description:"Suspends Shortcut definition",uiLabel:"Suspend Shortcut"},{name:"unSuspendShortcut",kind:"function",description:"Activates a suspended Shortcut definition",uiLabel:"Un Suspend Shortcut"}]},ShortcutScopeDataType:{name:"ShortcutScopeDataType",kind:"TypeAlias",description:"Shortcut scope data type."},ShortcutState:{name:"ShortcutState",kind:"Interface",description:"Predefined Configuration for Shortcut Module",properties:[{name:"Shortcuts",kind:"array",description:"Collection of Shortcuts - designed to speed up data entry",uiLabel:"Shortcuts",isOptional:!0}]},SmartEditApi:{name:"SmartEditApi",kind:"Interface",description:"Provides run-time access to the Smart Edit Module",properties:[{name:"applySmartEdit",kind:"function",description:"Applies a Smart Edit to given Cells",uiLabel:"Apply Smart Edit"},{name:"getSmartEditCustomOperations",kind:"function",description:"Retrieves an Smart Edit Custom Operations (provided in Edit Options)",uiLabel:"Get Smart Edit Custom Operations"},{name:"getSmartEditOperation",kind:"function",description:"Gets current Smart Edit Operation",uiLabel:"Get Smart Edit Operation"},{name:"getSmartEditValue",kind:"function",description:"Returns current Smart Edit Value",uiLabel:"Get Smart Edit Value"},{name:"setCustomSmartEditOperation",kind:"function",description:"Sets current Smart Edit Operation to a Custom Operation",uiLabel:"Set Custom Smart Edit Operation"},{name:"setSmartEditOperation",kind:"function",description:"Sets (shipped) Smart Edit Operation: 'Add','Subtract','Multiply','Divide'",uiLabel:"Set Smart Edit Operation"},{name:"setSmartEditValue",kind:"function",description:"Sets Smart Edit Value",uiLabel:"Set Smart Edit Value"},{name:"showSmartEditPopup",kind:"function",description:"Opens Settings Panel with Smart Edit section selected and visible",uiLabel:"Show Smart Edit Popup"}]},SmartEditCustomOperation:{name:"SmartEditCustomOperation",kind:"TypeAlias",description:"Custom Operation used in Smart Edit Module"},SmartEditOperation:{name:"SmartEditOperation",kind:"TypeAlias",description:"Operation used by Smart Edit - either System or Custom"},SmartEditOperationContext:{name:"SmartEditOperationContext",kind:"Interface",description:"Context used in Custom Smart Edit Operations",properties:[{name:"currentCell",kind:"REFERENCE",description:"Current selected grid cell - contains column, row and cell value information",uiLabel:"Current Cell",reference:"GridCell"},{name:"smartEditValue",kind:"number",description:"Smart Edit value",uiLabel:"Smart Edit Value"}]},SpecialColumnSettings:{name:"SpecialColumnSettings",kind:"Interface",description:"Base Settings for Calculated Columns and FreeText Columns",properties:[{name:"Aggregatable",kind:"boolean",description:"Whether Column can be used in an aggregation when grouping",uiLabel:"Aggregatable",isOptional:!0,defaultValue:"false"},{name:"ColumnTypes",kind:"array",description:"Custom column types to be added to AG Grid Column Types when object is created",uiLabel:"Column Types",isOptional:!0},{name:"Filterable",kind:"boolean",description:"Whether Column is filterable",uiLabel:"Filterable",isOptional:!0,defaultValue:"false"},{name:"Groupable",kind:"boolean",description:"Whether Column can be grouped",uiLabel:"Groupable",isOptional:!0,defaultValue:"false"},{name:"HeaderToolTip",kind:"string",description:"Tooltip to show in the Column Header (not cells)",uiLabel:"Header Tool Tip",isOptional:!0},{name:"Pivotable",kind:"boolean",description:"Whether Column can be used when grid is in pivot mode",uiLabel:"Pivotable",isOptional:!0,defaultValue:"false"},{name:"Resizable",kind:"boolean",description:"Whether Column can be resized (by dragging column header edges)",uiLabel:"Resizable",isOptional:!0,defaultValue:"false"},{name:"Sortable",kind:"boolean",description:"Whether Column is sortable",uiLabel:"Sortable",isOptional:!0,defaultValue:"false"},{name:"SuppressMenu",kind:"boolean",description:"Whether if no menu should be shown for this Column header.",uiLabel:"Suppress Menu",isOptional:!0,defaultValue:"false"},{name:"SuppressMovable",kind:"boolean",description:"Whether if this Column should be movable via dragging",uiLabel:"Suppress Movable",isOptional:!0,defaultValue:"false"},{name:"Width",kind:"number",description:"Preferred (pixel) Column Width; if unset, calculated dynamically by AG Grid",uiLabel:"Width",isOptional:!0}]},StateOptions:{name:"StateOptions",kind:"Interface",description:"Options related to Adaptable State hydration/dehydration - allows users to intercept state persistence and state loading with custom functionality",properties:[{name:"applyState",kind:"unknown",description:"Allows hooking into Adaptable State hydration",uiLabel:"Apply State",isOptional:!0},{name:"clearState",kind:"REFERENCE",description:"Allows clearing of remote Adaptable State",uiLabel:"Clear State",isOptional:!0,defaultValue:"undefined",reference:"AdaptableClearStateFunction"},{name:"debounceStateDelay",kind:"number",description:"Delay (in ms) to debounce `saveState` / `persistState` calls enabling grouping multiple sequential calls in single one (e.g. elevator doors)",uiLabel:"Debounce State Delay",isOptional:!0,defaultValue:"400"},{name:"loadState",kind:"REFERENCE",description:"Allows customization of Adaptable State loading",uiLabel:"Load State",isOptional:!0,reference:"AdaptableLoadStateFunction"},{name:"persistState",kind:"REFERENCE",description:"Allows customization of Adaptable State persistence",uiLabel:"Persist State",isOptional:!0,reference:"AdaptablePersistStateFunction"},{name:"saveState",kind:"REFERENCE",description:"Allows customization of Adaptable State about to be persisted",uiLabel:"Save State",isOptional:!0,reference:"AdaptableSaveStateFunction"}]},StatusBarApi:{name:"StatusBarApi",kind:"Interface",description:"Methods for managaing the Adaptable Status Bar",properties:[{name:"getAdaptableStatusBars",kind:"unknown",description:"Retrieves the current Adaptable Status Bar Panels",uiLabel:"Get Adaptable Status Bars"},{name:"getAgGridStatusPanels",kind:"function",description:"Retrieves the current AG Grid Status Bar Panels",uiLabel:"Get Ag Grid Status Panels"},{name:"setStatusBarPanels",kind:"unknown",description:"Sets the current Adaptable Status Bar Panels",uiLabel:"Set Status Bar Panels"}]},StatusBarState:{name:"StatusBarState",kind:"Interface",description:"Predefined Configuration for the Adaptable Status Bar",properties:[{name:"StatusBars",kind:"array",description:"Adaptable Status Bars to display - can be unlimited and displayed in 3 locations",uiLabel:"Status Bars",isOptional:!0,defaultValue:"null"}]},StringFormatterOptions:{name:"StringFormatterOptions",kind:"Interface",description:"Formatter Options for String Columns",properties:[{name:"Case",kind:"'Upper' | 'Lower' | 'Sentence'",description:"Sets text to Upper or Lower case",uiLabel:"Case",isOptional:!0},{name:"Prefix",kind:"string",description:"Prefix to use before the cell text",uiLabel:"Prefix",isOptional:!0},{name:"Suffix",kind:"string",description:"Suffix to use after the cell text",uiLabel:"Suffix",isOptional:!0},{name:"Trim",kind:"boolean",description:"Trims text (both start and end)",uiLabel:"Trim",isOptional:!0}]},StyledColumn:{name:"StyledColumn",kind:"Interface",description:"Object used in Special Column Style function",properties:[{name:"CheckBoxStyle",kind:"boolean",description:"Renders a Checkbox in a boolean column",uiLabel:"Check Box Style",isOptional:!0},{name:"ColumnId",kind:"string",description:"Column being styled",uiLabel:"Column Id"},{name:"GradientStyle",kind:"REFERENCE",description:"Styles a numeric column with a Gradient",uiLabel:"Gradient Style",isOptional:!0,reference:"GradientStyle"},{name:"IncludeGroupedRows",kind:"boolean",description:"Includes the Styled Column in Grouped Rows",uiLabel:"Include Grouped Rows",isOptional:!0,defaultValue:"false"},{name:"PercentBarStyle",kind:"REFERENCE",description:"Styles a numeric column so each cell displays a 'bar'",uiLabel:"Percent Bar Style",isOptional:!0,reference:"PercentBarStyle"}]},StyledColumnApi:{name:"StyledColumnApi",kind:"Interface",description:"Provides run-time access to Styled Column Module and associated state",properties:[{name:"addStyledColumn",kind:"function",description:"Create a Styled column",uiLabel:"Add Styled Column"},{name:"deleteStyledColumn",kind:"function",description:"Delete a Styled column",uiLabel:"Delete Styled Column"},{name:"findRangeForColumn",kind:"function",description:"Returns last range that matches the cell value.",uiLabel:"Find Range For Column"},{name:"fireCheckboxColumnClickedEvent",kind:"function",description:"Publishes the CheckboxColumnClickedEvent - when the checkbox in an Checkbox Column is clicked",uiLabel:"Fire Checkbox Column Clicked Event"},{name:"getActiveStyledColumnForColumn",kind:"function",description:"Returns a Styled Column for a given column",uiLabel:"Get Active Styled Column For Column"},{name:"getAllActiveStyledColumn",kind:"function",description:"Retrieves all active (not-suspended) Styled Columns in Adaptable State",uiLabel:"Get All Active Styled Column"},{name:"getAllStyledColumn",kind:"function",description:"Retrieves all Styled Columns in Adaptable State",uiLabel:"Get All Styled Column"},{name:"getAllSuspendedStyledColumn",kind:"function",description:"Retrieves all suspended Styled Columns in Adaptable State",uiLabel:"Get All Suspended Styled Column"},{name:"getCellColorRangeMaxValue",kind:"function",description:"Returns the largest number in a Range",uiLabel:"Get Cell Color Range Max Value"},{name:"getCellColorRangeMinValue",kind:"function",description:"Returns the smallest number in a Range",uiLabel:"Get Cell Color Range Min Value"},{name:"getCheckBoxStyleStyledColumn",kind:"function",description:"Returns first Styled Column that contains checkbox style",uiLabel:"Get Check Box Style Styled Column"},{name:"getColumnComparisonForStyledColumn",kind:"function",description:"Retrieves the ColumnComparison property, if there, from a Styled Column",uiLabel:"Get Column Comparison For Styled Column"},{name:"getColumnIdsFromColumnComparison",kind:"function",description:"Returns any ColumnIds referenced in a Column Comparison",uiLabel:"Get Column Ids From Column Comparison"},{name:"getNumericStyleMaxValue",kind:"function",description:"Gets the Maximum Value to display for a Styled Column",uiLabel:"Get Numeric Style Max Value"},{name:"getNumericStyleMinValue",kind:"function",description:"Gets the Minimum Value to display for a Styled Column",uiLabel:"Get Numeric Style Min Value"},{name:"getStyledColumnByColumnId",kind:"function",description:"Retrieves Styled Column by Column Id",uiLabel:"Get Styled Column By Column Id"},{name:"getStyledColumnById",kind:"function",description:"Retrieves Styled Column by Id",uiLabel:"Get Styled Column By Id"},{name:"getStyledColumnState",kind:"function",description:"Retrieves Styled Column section from Adaptable State",uiLabel:"Get Styled Column State"},{name:"hasStyledColumnRelativeCellRange",kind:"function",description:"Checks if the styled column has a range with a relative value",uiLabel:"Has Styled Column Relative Cell Range"},{name:"isCheckBoxStyleStyledColumn",kind:"function",description:"Whether given column is a (boolean) checkbox column",uiLabel:"Is Check Box Style Styled Column"}]},StyledColumnState:{name:"StyledColumnState",kind:"Interface",description:"Predefined Configuration for Styled Column Module",properties:[{name:"StyledColumns",kind:"array",description:"Collection of Special Column Styles",uiLabel:"Styled Columns",isOptional:!0}]},SuspendableObject:{name:"SuspendableObject",kind:"Interface",description:"Interface that extends Adaptable Object for those config items that can be suspended at run-time",properties:[{name:"IsSuspended",kind:"boolean",description:"Suspends (i.e. turns off) an Adaptable Object",uiLabel:"Is Suspended",isOptional:!0}]},SystemExportDestination:{name:"SystemExportDestination",kind:"TypeAlias",description:"Export Destinations provided by AdapTable"},SystemExportDestinations:{name:"SystemExportDestinations",kind:"TypeAlias",description:"List of System Export Destinations"},SystemFilterPredicateId:{name:"SystemFilterPredicateId",kind:"TypeAlias",description:"List of all the Filter Predicates shipped by AdapTable"},SystemFilterPredicateIds:{name:"SystemFilterPredicateIds",kind:"TypeAlias",description:"Array containing all System Filter Predicates"},SystemFiltersPredicateContext:{name:"SystemFiltersPredicateContext",kind:"Interface",description:"Context used for providing System Filters",properties:[{name:"systemFiltersPredicateDefs",kind:"array",description:"AdapTable-provided System Filter Predicate Definitions",uiLabel:"System Filters Predicate Defs"}]},SystemReportName:{name:"SystemReportName",kind:"TypeAlias",description:"Names of Reports provided by AdapTable"},SystemReportNames:{name:"SystemReportNames",kind:"TypeAlias",description:"Array containing all System Report names"},SystemStatusApi:{name:"SystemStatusApi",kind:"Interface",description:"Provides access to System Status Module and associated state",properties:[{name:"deleteAllSystemStatusMessages",kind:"function",description:"Deletes all System Status messages",uiLabel:"Delete All System Status Messages"},{name:"fireSystemStatusMessageDisplayedEvent",kind:"function",description:"Fires SystemStatusMessageDisplayed Event",uiLabel:"Fire System Status Message Displayed Event"},{name:"getCurrentSystemStatusMessageInfo",kind:"function",description:"Retrieves current System Status Message",uiLabel:"Get Current System Status Message Info"},{name:"setErrorSystemStatus",kind:"function",description:"Sets an **Error** System Status Message",uiLabel:"Set Error System Status"},{name:"setInfoSystemStatus",kind:"function",description:"Sets an **Info** System Status Message",uiLabel:"Set Info System Status"},{name:"setSuccessSystemStatus",kind:"function",description:"Sets a **Success** System Status Message",uiLabel:"Set Success System Status"},{name:"setSystemStatus",kind:"function",description:"Sets a new System Status message; appears in System Status toolbar, tool panel (and popup).",uiLabel:"Set System Status"},{name:"setWarningSystemStatus",kind:"function",description:"Sets a **Warning** System Status Message",uiLabel:"Set Warning System Status"},{name:"showSystemStatusPopup",kind:"function",description:"Opens Settings Panel with System Status section selected and visible",uiLabel:"Show System Status Popup"}]},SystemStatusMessageDisplayedInfo:{name:"SystemStatusMessageDisplayedInfo",kind:"Interface",description:"Object returned by the `SystemStatusMessageDisplayed` event",properties:[{name:"systemStatusMessageInfo",kind:"REFERENCE",description:"Details of the System Status Message and Type",uiLabel:"System Status Message Info",reference:"SystemStatusMessageInfo"}]},SystemStatusMessageInfo:{name:"SystemStatusMessageInfo",kind:"Interface",description:"Wraps a System Status Message",properties:[{name:"statusFurtherInformation",kind:"string",description:"Additional information to display (optional)",uiLabel:"Status Further Information",isOptional:!0},{name:"statusMessage",kind:"string",description:"The Message to be displayed",uiLabel:"Status Message"},{name:"statusType",kind:"REFERENCE",description:"Type of Message i.e. Succcess, Warning, Error, Info",uiLabel:"Status Type",reference:"AdaptableMessageType"},{name:"timestamp",kind:"date",description:"When Message was sent",uiLabel:"Timestamp",isOptional:!0}]},TeamSharingApi:{name:"TeamSharingApi",kind:"Interface",description:"Provides run-time access to Team Sharing Module and associated state",properties:[{name:"checkForUpdates",kind:"function",description:"Checks if active Shared Entities have updates (higher revisions than the local counterpart objects)",uiLabel:"Check For Updates"},{name:"fireTeamSharingEntityChangedEvent",kind:"function",description:"Fires the Team Sharing Entity Changed Event",uiLabel:"Fire Team Sharing Entity Changed Event"},{name:"getLoadedSharedEntities",kind:"function",description:"Retrieves already loaded shared entries.",uiLabel:"Get Loaded Shared Entities"},{name:"getSharedEntities",kind:"function",description:"Retrieves all shared entities which are currently shared. It is an asynchronous operation as it leverages the `TeamSharingOptions.getSharedEntities(...)` method.",uiLabel:"Get Shared Entities"},{name:"getSharedEntryDependencies",kind:"function",description:"Retrieves shared entry dependencies.",uiLabel:"Get Shared Entry Dependencies"},{name:"hasTeamSharingFullRights",kind:"function",description:"Whether current user has full Team Sharing rights (for creating & updating shared items)",uiLabel:"Has Team Sharing Full Rights"},{name:"importSharedEntry",kind:"function",description:"Import shared entry.",uiLabel:"Import Shared Entry"},{name:"isTeamSharingActivated",kind:"function",description:"Whether Team Sharing is Activated",uiLabel:"Is Team Sharing Activated"},{name:"isTeamSharingAvailable",kind:"function",description:"Whether Team Sharing is Available to use",uiLabel:"Is Team Sharing Available"},{name:"setSharedEntities",kind:"function",description:"Sets the shared entities which are currently shared. It is an asynchronous operation as it leverages the `TeamSharingOptions.setSharedEntities(...)` method.",uiLabel:"Set Shared Entities"},{name:"shareEntity",kind:"function",description:"Puts an Adaptable Object into Team Share",uiLabel:"Share Entity"},{name:"showTeamSharingPopup",kind:"function",description:"Opens Settings Panel with Team Sharing section selected and visible",uiLabel:"Show Team Sharing Popup"},{name:"triggerLoadingTeamSharingEntries",kind:"function",description:"Trigger loading of shared entries. By default shared entries are loaded when the Team Sharing popup is visible.",uiLabel:"Trigger Loading Team Sharing Entries"},{name:"unshareEntity",kind:"function",description:"Removes an Adaptable Object from the Team Share.",uiLabel:"Unshare Entity"}]},TeamSharingEntityChangedInfo:{name:"TeamSharingEntityChangedInfo",kind:"Interface",description:"EventInfo returned by TeamSharingEntityChanged event",properties:[{name:"sharedEntity",kind:"REFERENCE",description:"Object containing the Shared Entity that has changed",uiLabel:"Shared Entity",reference:"SharedEntity"}]},TeamSharingImportInfo:{name:"TeamSharingImportInfo",kind:"Interface",description:"Defines Objects which have been imported into Team Sharing"},TeamSharingOptions:{name:"TeamSharingOptions",kind:"Interface",description:"Options for managing Team Sharing - which enables Adaptable Objects to be shared between colleagues",properties:[{name:"enableTeamSharing",kind:"boolean",description:"Whether Team Sharing is enabled",uiLabel:"Enable Team Sharing",gridInfo:"item",defaultValue:"false"},{name:"getSharedEntities",kind:"unknown",description:"Async function which retrieves available Shared Entities that user can download and merge automatically with Adaptable State",uiLabel:"Get Shared Entities",defaultValue:"null"},{name:"setSharedEntities",kind:"unknown",description:"Async function which uploads Shared Entities so they can be downloaded by other members of the team",uiLabel:"Set Shared Entities",defaultValue:"null"},{name:"updateInterval",kind:"number",description:"Frequency (in minutes) to check if Active Shared Entities have a newer revision",uiLabel:"Update Interval",isOptional:!0,gridInfo:"item",defaultValue:"0 (never)"},{name:"updateNotification",kind:"'Alert' | 'AlertWithNotification' | 'SystemStatus'",description:"How user is informed when Active Shared Entities have newer revisions",uiLabel:"Update Notification",isOptional:!0,gridInfo:"item",defaultValue:"null (none)"}]},TeamSharingState:{name:"TeamSharingState",kind:"Interface",description:"State for Team Sharing; this is internal so not designed to be provided as part of Predefined Config",properties:[{name:"ActiveSharedEntityMap",kind:"unknown",description:"Mapping of active AdaptableObjects which are shared with the local state. Maps UUIDs of local AdaptableObjects to a snapshot of the latest synchronized SharedEntity",uiLabel:"Active Shared Entity Map"},{name:"importProcessInProgress",kind:"boolean",description:"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",uiLabel:"Import Process In Progress"},{name:"SharedEntities",kind:"array",description:"List of objects currently being Team Shared",uiLabel:"Shared Entities"}]},ThemeApi:{name:"ThemeApi",kind:"Interface",description:"Provides run-time access to the Theme Module and associated state",properties:[{name:"applyCurrentTheme",kind:"function",description:"Applies the Current Theme",uiLabel:"Apply Current Theme"},{name:"getAgGridCurrentThemeName",kind:"function",description:"Get the name of the current AG Grid theme",uiLabel:"Get Ag Grid Current Theme Name"},{name:"getAllSystemTheme",kind:"function",description:"Retrieves System Themes in State",uiLabel:"Get All System Theme"},{name:"getAllTheme",kind:"function",description:"Retrieves all Themes (both System User) in State",uiLabel:"Get All Theme"},{name:"getAllUserTheme",kind:"function",description:"Retrieves User Themes in State",uiLabel:"Get All User Theme"},{name:"getCurrentTheme",kind:"function",description:"Retrieves name of Current Theme",uiLabel:"Get Current Theme"},{name:"getThemeState",kind:"function",description:"Retrieves Theme section from Adaptable State",uiLabel:"Get Theme State"},{name:"loadDarkTheme",kind:"function",description:"Sets AdapTable Dark Theme - updates the AG Grid theme to match",uiLabel:"Load Dark Theme"},{name:"loadLightTheme",kind:"function",description:"Sets AdapTable Light Theme - updates the AG Grid theme to match",uiLabel:"Load Light Theme"},{name:"loadTheme",kind:"function",description:"Sets Adaptable to use a given theme",uiLabel:"Load Theme"},{name:"setSystemThemes",kind:"function",description:"Sets available System Themes; if empty array is passed none will be",uiLabel:"Set System Themes"},{name:"setUserThemes",kind:"function",description:"Sets available User Themes",uiLabel:"Set User Themes"},{name:"showThemePopup",kind:"function",description:"Opens Settings Panel with Theme section selected and visible",uiLabel:"Show Theme Popup"}]},ThemeChangedInfo:{name:"ThemeChangedInfo",kind:"Interface",description:"Object returned by the `ThemeChanged` event",properties:[{name:"theme",kind:"unknown",description:"Selected Theme: either name of a (System) theme or the (Custom) Theme itself",uiLabel:"Theme"}]},ThemeState:{name:"ThemeState",kind:"Interface",description:"Theme section of Adaptable State",properties:[{name:"CurrentTheme",kind:"unknown",description:"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",uiLabel:"Current Theme",isOptional:!0},{name:"SystemThemes",kind:"unknown",description:"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.",uiLabel:"System Themes",isOptional:!0},{name:"UserThemes",kind:"array",description:"Custom themes (of type AdaptableTheme) provided by developers",uiLabel:"User Themes",isOptional:!0}]},TOAST_POSITIONS:{name:"TOAST_POSITIONS",kind:"TypeAlias",description:"Different positions offered by Notifications"},ToolPanelApi:{name:"ToolPanelApi",kind:"Interface",description:"Functions for managing the AdapTable ToolPanel Component (at side of grid)",properties:[{name:"closeAdapTableToolPanel",kind:"function",description:"Closes the Tool Panel section (irrespective of which toolpanel is showing)",uiLabel:"Close Adap Table Tool Panel"},{name:"getCustomToolPanelButtons",kind:"function",description:"Retrieves all Custom Tool Panel Buttons defined in ToolPanelOptions",uiLabel:"Get Custom Tool Panel Buttons"},{name:"getCustomToolPanelByName",kind:"function",description:"Retrieves the CustomToolPanel with the given name (or undefined if no match is found)",uiLabel:"Get Custom Tool Panel By Name"},{name:"getCustomToolPanels",kind:"function",description:"Retrieves all Custom Tool Panels defined in ToolPanelOptions",uiLabel:"Get Custom Tool Panels"},{name:"getModuleButtons",kind:"function",description:"Sets the Module buttons from the Adaptable ToolPanel",uiLabel:"Get Module Buttons"},{name:"getToolPanelState",kind:"function",description:"Retrieves Tool Panel section from Tool Panel State",uiLabel:"Get Tool Panel State"},{name:"openAdapTableToolPanel",kind:"function",description:"Opens the Adaptable ToolPanel Component",uiLabel:"Open Adap Table Tool Panel"},{name:"setAdaptableToolPanelVisibilityMode",kind:"function",description:"Sets the given Adaptable ToolPanel with the provided visibilityMode (expanded / collapsed)",uiLabel:"Set Adaptable Tool Panel Visibility Mode"},{name:"setCustomToolPanelVisibilityMode",kind:"function",description:"Sets the Custom ToolPanel with the given name with the provided visibilityMode (expanded / collapsed)",uiLabel:"Set Custom Tool Panel Visibility Mode"},{name:"setModuleButtons",kind:"function",description:"Sets the Module buttons in the Adaptable ToolPanel",uiLabel:"Set Module Buttons"},{name:"showToolPanelPopup",kind:"function",description:"Opens Settings Panel with Tool Panel section selected and visible",uiLabel:"Show Tool Panel Popup"}]},ToolPanelButtonContext:{name:"ToolPanelButtonContext",kind:"Interface",description:"Context required by functions when using a ToolPanel Button",properties:[{name:"toolPanelState",kind:"REFERENCE",description:"Current ToolPanel State",uiLabel:"Tool Panel State",reference:"ToolPanelState"}]},ToolPanelOptions:{name:"ToolPanelOptions",kind:"Interface",description:"Options related to managing the AdapTable ToolPanel Component",properties:[{name:"customButtons",kind:"array",description:"ToolPanel Buttons provided by Users which perform custom behaviour",uiLabel:"Custom Buttons",isOptional:!0},{name:"customToolPanels",kind:"array",description:"ToolPanels provided by Users which contain custom content",uiLabel:"Custom Tool Panels",isOptional:!0},{name:"showToolPanelsDropdown",kind:"boolean",description:"Display the Tool Panels dropdown",uiLabel:"Show Tool Panels Dropdown",isOptional:!0,gridInfo:"item",defaultValue:"true"}]},ToolPanelState:{name:"ToolPanelState",kind:"Interface",description:"Predefined Configuration for the Adaptable ToolPanel",properties:[{name:"ModuleButtons",kind:"REFERENCE",description:"AdapTable Module Buttons visible in ToolPanel",uiLabel:"Module Buttons",isOptional:!0,defaultValue:"Empty Array",reference:"unknown"},{name:"ToolPanels",kind:"array",description:"Adaptable Tool Panels which are viaible",uiLabel:"Tool Panels",isOptional:!0,defaultValue:"ToolPanels for all available Modules (subject to Entitlement rules)"}]},ToolPanelVisibilityMode:{name:"ToolPanelVisibilityMode",kind:"TypeAlias",description:"Whether a ToolPanel displays as expanded or collapsed"},UnbalancedGroupsKeyContext:{name:"UnbalancedGroupsKeyContext",kind:"Interface",description:"Context used when setting a value for Unbalanced Row Groups",properties:[{name:"adaptableColumn",kind:"REFERENCE",description:"Adaptable Column being grouped",uiLabel:"Adaptable Column",reference:"AdaptableColumn"},{name:"params",kind:"REFERENCE",description:"AG Grid's Key Creator Params",uiLabel:"Params",reference:"unknown"}]},UserInterfaceApi:{name:"UserInterfaceApi",kind:"Interface",description:"Functions relating to User Interface section of Adaptable State",properties:[{name:"addColumnMenuItem",kind:"function",description:"Adds menu item to Column Menu",uiLabel:"Add Column Menu Item"},{name:"addContextMenuItem",kind:"function",description:"Adds menu item to Context Menu",uiLabel:"Add Context Menu Item"},{name:"getAdaptableObjectTags",kind:"function",description:"Retrieves any Object Tags (provided in User Interface Options)",uiLabel:"Get Adaptable Object Tags"},{name:"getAllEditLookUpItems",kind:"function",description:"Retrieves `editLookUpItems` property from User Interface Options",uiLabel:"Get All Edit Look Up Items"},{name:"getAllPermittedValuesItems",kind:"function",description:"Retrieves `permittedValues` property from User Interface Options",uiLabel:"Get All Permitted Values Items"},{name:"getBulkUpdatePermittedValuesForColumn",kind:"function",description:"Retrieves Permitted values for Bulk Update Module",uiLabel:"Get Bulk Update Permitted Values For Column"},{name:"getColorPalette",kind:"function",description:"Retrieves Color Palette currently being used",uiLabel:"Get Color Palette"},{name:"getCustomSortPermittedValuesForColumn",kind:"function",description:"Retrieves Permitted values for Custom Sort Module",uiLabel:"Get Custom Sort Permitted Values For Column"},{name:"getEditableCellStyle",kind:"function",description:"Returns Style set for Editable cells",uiLabel:"Get Editable Cell Style"},{name:"getEditLookUpItemForColumn",kind:"function",description:"Retrieves EditLookUpItems for a given Column",uiLabel:"Get Edit Look Up Item For Column"},{name:"getEditLookUpValuesForEditLookUpItem",kind:"function",description:"Retrieves actual Look Up Values from an EditLookUpItem",uiLabel:"Get Edit Look Up Values For Edit Look Up Item"},{name:"getFilterPermittedValuesForColumn",kind:"function",description:"Retrieves Permitted values for filtering by column values in Floating Filter and Quick Filter Bar",uiLabel:"Get Filter Permitted Values For Column"},{name:"getPermittedValuesForColumn",kind:"function",description:"Retrieves Permitted Values for a given Column",uiLabel:"Get Permitted Values For Column"},{name:"getReadOnlyCellStyle",kind:"function",description:"Returns Style set for ReadOnly cells",uiLabel:"Get Read Only Cell Style"},{name:"getStyleClassNames",kind:"function",description:"Retrieves any Style Class Names from User Interface Options",uiLabel:"Get Style Class Names"}]},UserInterfaceOptions:{name:"UserInterfaceOptions",kind:"Interface",description:"Options for managing the User Interface of AdapTable",properties:[{name:"applicationIcon",kind:"REFERENCE",description:"The application icon to appear in Dashboard and elsewhere (e.g. OpenFin notifications)",uiLabel:"Application Icon",isOptional:!0,defaultValue:"null",reference:"AdaptableIcon"},{name:"bulkUpdatePermittedValues",kind:"array",description:"Custom column values for editing via bulk-update; when not defined defaults to permittedValues",uiLabel:"Bulk Update Permitted Values",isOptional:!0},{name:"colorPalette",kind:"unknown",description:"Colours to display in Colour Picker (in place of AdapTable's default set); can be hardcoded list or function",uiLabel:"Color Palette",isOptional:!0},{name:"customDisplayFormatters",kind:"array",description:"Custom Formatters to use in the Format Column Module",uiLabel:"Custom Display Formatters",isOptional:!0},{name:"customSortPermittedValues",kind:"array",description:"Custom column values for defining Custom Sort; when not defined defaults to permittedValues",uiLabel:"Custom Sort Permitted Values",isOptional:!0},{name:"dateInputOptions",kind:"REFERENCE",description:"Options for managing and customizing date inputs in AdapTable",uiLabel:"Date Input Options",isOptional:!0,reference:"DateInputOptions"},{name:"editableCellStyle",kind:"REFERENCE",description:"Style to set for editable cells",uiLabel:"Editable Cell Style",isOptional:!0,reference:"AdaptableStyle"},{name:"editLookUpItems",kind:"array",description:"Dropdown values displayed when column is being edited; when not defined defaults to permittedValues",uiLabel:"Edit Look Up Items",isOptional:!0},{name:"filterPermittedValues",kind:"array",description:"Custom column values for 'IN' filter; when not defined defaults to permittedValues",uiLabel:"Filter Permitted Values",isOptional:!0},{name:"gridInfoSections",kind:"REFERENCE",description:"Which sections to show in the Grid Info Screen",uiLabel:"Grid Info Sections",isOptional:!0,defaultValue:"['GridSummary', 'AdaptableOptions', 'ColumnInfo']",reference:"unknown"},{name:"objectTags",kind:"unknown",description:"Optional list of AdaptableObjectTags that can be associated with AdaptableObjects",uiLabel:"Object Tags",isOptional:!0},{name:"permittedValues",kind:"array",description:"List of values which are permitted (e.g. to show in filter)",uiLabel:"Permitted Values",isOptional:!0},{name:"readOnlyCellStyle",kind:"REFERENCE",description:"Style to set for non-editable cells",uiLabel:"Read Only Cell Style",isOptional:!0,reference:"AdaptableStyle"},{name:"showAdapTableVersion",kind:"boolean",description:"Displays the AdapTable version in Grid Info section of Settings Panel",uiLabel:"Show Adap Table Version",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"showDocumentationLinks",kind:"boolean",description:"Provide links to AdapTable documentation (in Module popups and Expression Editor)",uiLabel:"Show Documentation Links",isOptional:!0,gridInfo:"item",defaultValue:"true"},{name:"styleClassNames",kind:"array",description:"Optional list of CSS styles that can be used when creating Adaptable Styles in Adaptable (e.g. in Conditional Style, Format Column and other Modules)",uiLabel:"Style Class Names",isOptional:!0,gridInfo:"item"},{name:"useCustomMacLikeScrollbars",kind:"boolean",description:"Show Mac-like scrollbars; size is configurable via CSS variable `--ab-custom-scrollbar-size` (default: `10px`)",uiLabel:"Use Custom Mac Like Scrollbars",isOptional:!0,gridInfo:"item",defaultValue:"false"}]},UserMenuItem:{name:"UserMenuItem",kind:"Interface",description:"Menu Item which is added to Column Header or Context Menu, and can contain sub items",properties:[{name:"disabled",kind:"unknown",description:"Function to evaluate whether Menu Item is enabled",uiLabel:"Disabled",isOptional:!0},{name:"hidden",kind:"unknown",description:"Function to evaluate whether Menu Item is visible",uiLabel:"Hidden",isOptional:!0},{name:"icon",kind:"REFERENCE",description:"Optional icon to display",uiLabel:"Icon",isOptional:!0,reference:"AdaptableIcon"},{name:"label",kind:"unknown",description:"Text that will appear in the Menu Item",uiLabel:"Label"},{name:"onClick",kind:"unknown",description:"Function to invoke when the Menu Item is clicked",uiLabel:"On Click",isOptional:!0},{name:"subMenuItems",kind:"unknown",description:"Array of Menu Items, enabling limitless levels of menus",uiLabel:"Sub Menu Items",isOptional:!0}]},ValidationResult:{name:"ValidationResult",kind:"Interface",description:"Used for Server Validation ie. after an edit has been made in Adaptable which should be checked on the Server",properties:[{name:"NewValue",kind:"unknown",description:"Cell Value to use for after Server Validation",uiLabel:"New Value",isOptional:!0},{name:"ValidationMessage",kind:"string",description:"Message to diplay with validation",uiLabel:"Validation Message",isOptional:!0}]},WeightedAverageColumn:{name:"WeightedAverageColumn",kind:"Interface",description:""}};