@adaptabletools/adaptable
Version:
Powerful data-agnostic HTML5 AG Grid extension which provides advanced, cutting-edge functionality to meet all DataGrid requirements
1 lines • 186 kB
JavaScript
export const ADAPTABLE_METAMODEL={AccessLevel:{name:"AccessLevel",kind:"A",desc:"Whether an Entitlement is `ReadOnly`, `Hidden` or `Full`"},ActionButtonCommand:{name:"ActionButtonCommand",kind:"A",desc:"Commands to assign to Action Buttons that open Row Forms: 'create', 'clone', 'edit' or 'delete'"},ActionColumn:{name:"ActionColumn",kind:"I",desc:"A Special Column that wraps an AdapTable Button",props:[{name:"actionColumnButton",kind:"u",desc:"Button (or list of buttons) to display in the Column"},{name:"actionColumnSettings",kind:"R",desc:"Optional properties to configure the Column (e.g. filterable, resizable)",isOpt:!0,ref:"ActionColumnSettings"},{name:"columnId",kind:"s",desc:"Mandatory 'Id'; if no value set for `FriendlyName`, this will also be Column name"},{name:"friendlyName",kind:"s",desc:"How Column appears in Column Header, Menus; if no value set, `ColumnId` is used",isOpt:!0},{name:"rowScope",kind:"R",desc:"Which types of Rows should contain buttons (i.e. data, grouped, summary)",isOpt:!0,ref:"RowScope"}]},ActionColumnButton:{name:"ActionColumnButton",kind:"I",desc:"Button that is displayed inside an Action Column",props:[{name:"command",kind:"R",desc:"Command to assign to Action Column Button that displays a Row Form",isOpt:!0,ref:"ActionButtonCommand"}]},ActionColumnContext:{name:"ActionColumnContext",kind:"I",desc:"Context required by functions when using an Action Column Button",props:[{name:"actionColumn",kind:"u",desc:"Action Column in question"},{name:"data",kind:"u",desc:"The current row's data"},{name:"primaryKeyValue",kind:"u",desc:"Primary Key Value in current row"},{name:"rowNode",kind:"u",desc:"Current AG Grid Row Node"}]},ActionColumnDefaultConfiguration:{name:"ActionColumnDefaultConfiguration",kind:"I",desc:"Default configuration to use for an FDC3 Action Column",props:[{name:"columnId",kind:"s",desc:"Column Id",isOpt:!0,defVal:"'fdc3ActionColumn'"},{name:"headerName",kind:"s",desc:"Column Header",isOpt:!0,defVal:"'FDC3 Actions'"},{name:"movable",kind:"b",desc:"If Column is movable",isOpt:!0,defVal:"true"},{name:"resizable",kind:"b",desc:"If Column is resizable",isOpt:!0,defVal:"true"},{name:"rowScope",kind:"R",desc:"Which rows button appears in",isOpt:!0,defVal:"data rows only",ref:"RowScope"},{name:"width",kind:"n",desc:"Column Width in pixels",isOpt:!0,defVal:"200"}]},ActionColumnOptions:{name:"ActionColumnOptions",kind:"I",desc:"Options related to Action Columns in AdapTable",props:[{name:"actionColumns",kind:"u",desc:"Columns which contain an AdapTable Button - used for performing Actions",isOpt:!0,defVal:"undefined"}]},ActionColumnSettings:{name:"ActionColumnSettings",kind:"I",desc:"Set of optional properties that define an Action Columns behaviour",props:[{name:"resizable",kind:"b",desc:"Whether Column can be resized (by dragging column header edges)",isOpt:!0,defVal:"true"},{name:"suppressMenu",kind:"b",desc:"Whether no menu should be shown for this Column header.",isOpt:!0,defVal:"false"},{name:"suppressMovable",kind:"b",desc:"Whether if this Column should be movable via dragging",isOpt:!0,defVal:"false"},{name:"width",kind:"n",desc:"Preferred width (in pixels) for Column; if unset, calculated dynamically by AG Grid",isOpt:!0}]},AdaptableAggregatedBooleanQuery:{name:"AdaptableAggregatedBooleanQuery",kind:"I",desc:"Wraps an AdapTableQL Aggregated Boolean Expression",props:[{name:"AggregatedBooleanExpression",kind:"s",desc:"AdapTableQL Expression that returns true / false based on multiple rows"}]},AdaptableAggregatedScalarQuery:{name:"AdaptableAggregatedScalarQuery",kind:"I",desc:"Wraps an AdapTableQL Aggregated Scalar Expression",props:[{name:"AggregatedScalarExpression",kind:"s",desc:"AdapTableQL Expression that returns any value based on multiple rows"}]},AdaptableAlert:{name:"AdaptableAlert",kind:"A",desc:"Defines an Alert fired by AdapTable"},AdaptableAlertBase:{name:"AdaptableAlertBase",kind:"I",desc:"Defines the base(common) properties of an Alert fired by AdapTable, regardless of the type of change",props:[{name:"alertDefinition",kind:"R",desc:"Rule that caused Alert to fire",ref:"AlertDefinition"},{name:"alertType",kind:"u",desc:"The type of Alert"},{name:"header",kind:"s",desc:"Alert Header text"},{name:"message",kind:"s",desc:"Alert Body text"}]},AdaptableAlertCommand:{name:"AdaptableAlertCommand",kind:"A",desc:"Commands available in an Alert"},AdaptableAlertQuery:{name:"AdaptableAlertQuery",kind:"A",desc:"Alert Query which may be either a Boolean, Observable or AggregatedBoolean Expression"},AdaptableAlertType:{name:"AdaptableAlertType",kind:"A",desc:"Type of AdapTable Alert: generic, cellChange or rowChange"},AdaptableBaseIcon:{name:"AdaptableBaseIcon",kind:"I",desc:"Base interface for AdaptableIcon",props:[{name:"className",kind:"s",desc:"The class name of the icon",isOpt:!0},{name:"style",kind:"R",desc:"CSS Properties",isOpt:!0,ref:"unknown"}]},AdaptableBooleanQuery:{name:"AdaptableBooleanQuery",kind:"I",desc:"Wraps an AdapTableQL Boolean Expression",props:[{name:"BooleanExpression",kind:"s",desc:"AdapTableQL Expression that returns true / false"}]},AdaptableButton:{name:"AdaptableButton",kind:"I",desc:"Defines a Button that appears in numerous places including Adaptable Form",props:[{name:"buttonStyle",kind:"u",desc:"Style for Button - can be object or function that provides a `ButtonStyle` object",isOpt:!0},{name:"disabled",kind:"u",desc:"Function that disables / enables the button based on its evaluation result",isOpt:!0},{name:"hidden",kind:"u",desc:"Function which sets whether Button is hidden",isOpt:!0},{name:"icon",kind:"u",desc:"Icon for Button - can be object or function that provides a `AdaptableIcon` object",isOpt:!0},{name:"label",kind:"u",desc:"Label for Button - can be string or function that provides string",isOpt:!0},{name:"onClick",kind:"u",desc:"Function to invoke when button is clicked",isOpt:!0},{name:"tooltip",kind:"u",desc:"Tooltip for Button - can be string or function that provides string",isOpt:!0}]},AdaptableCalculatedColumnQuery:{name:"AdaptableCalculatedColumnQuery",kind:"A",desc:"Calculated Column Query which may be a Scalar or an AggregatedScalar Expression"},AdaptableCellChangedAlert:{name:"AdaptableCellChangedAlert",kind:"I",desc:"Defines an Alert fired by AdapTable when a cell is changed",props:[{name:"cellDataChangedInfo",kind:"u",desc:"Cell DataChange which triggered Alert"}]},AdaptableClearStateFunction:{name:"AdaptableClearStateFunction",kind:"I",desc:"Allows clearing state when a custom persistState is used. Only called by StateApi.reloadInitialState"},AdaptableColumn:{name:"AdaptableColumn",kind:"I",desc:"Defines an AdapTable Column - created at run-time based on AG Grid ColDef",props:[{name:"aggregatable",kind:"b",desc:"Is Column able to display aggregations (e.g. 'sum') when grouped"},{name:"aggregationFunction",kind:"s",desc:"Custom Aggregation function for the Column",isOpt:!0},{name:"alwaysHidden",kind:"b",desc:"Whether the Column is always hidden"},{name:"availableAggregationFunctions",kind:"a",desc:"Available Aggregations for the Column",isOpt:!0},{name:"columnGroup",kind:"R",desc:"The parent Column group (if Column belongs to one)",isOpt:!0,ref:"AdaptableColumnGroup"},{name:"exportable",kind:"b",desc:"Whether the Column can be included in Reports"},{name:"field",kind:"u",desc:"Field in the row to get cell data from",isOpt:!0},{name:"fieldOnly",kind:"b",desc:"Is the Column ONLY available as a field and never visible"},{name:"filterable",kind:"b",desc:"Is Column able to be filtered"},{name:"flex",kind:"n",desc:"Flex details of the Column",isOpt:!0},{name:"groupable",kind:"b",desc:"Can Column form a Row Group"},{name:"hideable",kind:"b",desc:"Can Column be removed from the grid"},{name:"isActionColumn",kind:"b",desc:"Is Column an Action Column"},{name:"isCalculatedColumn",kind:"b",desc:"Is Column a Calculated Column"},{name:"isFixed",kind:"b",desc:"Is Column pinned or locked into position"},{name:"isFreeTextColumn",kind:"b",desc:"Is Column a Free Text Column"},{name:"isGeneratedPivotResultColumn",kind:"b",desc:"Is Column a generated Pivot Result Column"},{name:"isGeneratedRowGroupColumn",kind:"b",desc:"Is Column a generated Row Group Column"},{name:"isGrouped",kind:"b",desc:"Is Column currently Row-Grouped"},{name:"isPrimaryKey",kind:"b",desc:"Is this the Primary Key Column"},{name:"isSparkline",kind:"b",desc:"Is it a Sparkline Column"},{name:"isTreeColumn",kind:"b",desc:"Whether the Column is the Tree Column (in Tree View)"},{name:"moveable",kind:"b",desc:"Can Column be moved at run-time to a new position"},{name:"pinned",kind:"'left' | 'right' | false",desc:"The pinned position of the Column"},{name:"pivotable",kind:"b",desc:"Can Column be used in a Pivot Layout"},{name:"queryable",kind:"b",desc:"Can the Column be in included in Queries / Expressions"},{name:"readOnly",kind:"b",desc:"Is Column editable; returns FALSE if Column has conditional/dynamic editability, assuming some rows are editable"},{name:"sortable",kind:"b",desc:"Is Column sortable"},{name:"visible",kind:"b",desc:"Is Column currently visible"},{name:"width",kind:"n",desc:"Column width",isOpt:!0}]},AdaptableColumnBase:{name:"AdaptableColumnBase",kind:"I",desc:"Base class for AdapTable Column containing most important properties",props:[{name:"columnId",kind:"s",desc:"Name of Column in AG Grid (e.g. field or colId)"},{name:"columnTypes",kind:"a",desc:"Column Types of the Column",isOpt:!0},{name:"dataType",kind:"R",desc:"DataType of the Column",ref:"AdaptableColumnDataType"},{name:"friendlyName",kind:"s",desc:"How Column is referred to in Adaptable UI; `Caption` property in AG Grid"}]},AdaptableColumnContext:{name:"AdaptableColumnContext",kind:"I",desc:"Context provided for per Column callbacks",props:[{name:"column",kind:"u",desc:"The current Column"}]},AdaptableColumnDataType:{name:"AdaptableColumnDataType",kind:"A",desc:"Defines data type of a Column; can be an AG Grid BaseCellDataType or an AdapTable array-related one"},AdaptableColumnGroup:{name:"AdaptableColumnGroup",kind:"I",desc:"Defines a Column Group",props:[{name:"allowGroupSplit",kind:"b",desc:"Whether the Group can be split"},{name:"columnGroupId",kind:"s",desc:"Id for the Column Group"},{name:"friendlyName",kind:"s",desc:"Friendly name for the Group"},{name:"groupCount",kind:"n",desc:"Number of Columns in the the Group"}]},AdaptableColumnMenuItem:{name:"AdaptableColumnMenuItem",kind:"A",desc:"Menu item used by Adaptable in Column Menus"},AdaptableColumnMenuItemName:{name:"AdaptableColumnMenuItemName",kind:"A",desc:"Name of Column Menu Item provided by AdapTable"},AdaptableColumnPredicate:{name:"AdaptableColumnPredicate",kind:"I",desc:"Restricts a Predicate to a given Column",props:[{name:"ColumnId",kind:"s",desc:"Id of Column which will be evaluated by the Predicate",isOpt:!0}]},AdaptableComment:{name:"AdaptableComment",kind:"I",desc:"Comment that can be applied to a Cell in AdapTable",props:[{name:"AdaptableId",kind:"s",desc:"Id of this AdapTable instance",isOpt:!0},{name:"Author",kind:"u",desc:"Author of the Comment",isOpt:!0},{name:"Timestamp",kind:"n",desc:"When Comment was made"},{name:"Uuid",kind:"R",desc:"Unique identifier for the Comment",isOpt:!0,ref:"unknown"},{name:"Value",kind:"s",desc:"Content of the Comment"}]},AdaptableComparerFunction:{name:"AdaptableComparerFunction",kind:"A",desc:"Standard comparer function used to evaluate custom sorts, returns -1, 0, 1 as required"},AdaptableConfig:{name:"AdaptableConfig",kind:"I",desc:"Config used by No Code Plugin to set up AdapTable",props:[{name:"adaptableOptions",kind:"R",desc:"Adaptable Options object",ref:"AdaptableOptions"},{name:"gridOptions",kind:"R",desc:"AG Grid Grid Options object",ref:"unknown"}]},AdaptableContextMenuItem:{name:"AdaptableContextMenuItem",kind:"A",desc:"Menu item used by Adaptable in Context Menus"},AdaptableContextMenuItemName:{name:"AdaptableContextMenuItemName",kind:"A",desc:"Name of Context Menu Item provided by AdapTable"},AdaptableCoordinate:{name:"AdaptableCoordinate",kind:"I",desc:"Used by AdapTable to remember position of Floating Dashboard",props:[{name:"x",kind:"n",desc:"x axis number"},{name:"y",kind:"n",desc:"y axis number"}]},AdaptableCustomIcon:{name:"AdaptableCustomIcon",kind:"I",desc:"Defines an icon from an external source",props:[{name:"src",kind:"s",desc:"The URL of the icon to use"}]},AdaptableDashboardToolbar:{name:"AdaptableDashboardToolbar",kind:"A",desc:"List of all the Toolbars that Adaptable provides"},AdaptableDataChangeHistoryAction:{name:"AdaptableDataChangeHistoryAction",kind:"A",desc:"Built in `undo` or `clear` data change action"},AdaptableDateEditorParams:{name:"AdaptableDateEditorParams",kind:"I",desc:"Params used by the AdapTable Date Editor"},AdaptableElementIcon:{name:"AdaptableElementIcon",kind:"I",desc:"Defines an icon as a provided DOM element or HTML string",props:[{name:"element",kind:"u",desc:"The icon to display, either a DOM element or HTML string"}]},AdaptableField:{name:"AdaptableField",kind:"I",desc:"Used in Expressions to reference row values which are not a column definition",props:[{name:"dataType",kind:"R",desc:"Data Type of field, used to validate and show correctly in UI",ref:"AdaptableColumnDataType"},{name:"label",kind:"s",desc:"Label for field (optional - defaults to name)",isOpt:!0},{name:"name",kind:"s",desc:"Name of field in data source, e.g. 'rowId', 'parentObject.childObject.value'"}]},AdaptableFieldContext:{name:"AdaptableFieldContext",kind:"I",desc:"Context used when providing Fields programatically"},AdaptableFlashingCell:{name:"AdaptableFlashingCell",kind:"I",desc:"Defines an Alert fired by AdapTable",props:[{name:"cellDataChangedInfo",kind:"R",desc:"Data change which triggered the FlashingCell",isOpt:!0,ref:"CellDataChangedInfo"},{name:"direction",kind:"'up' | 'down' | 'neutral'",desc:"Direction of the change: 'up', 'down' or 'neutral'"},{name:"flashColumnIds",kind:"u",desc:"Column Ids that are flashing"},{name:"flashingCellDefinition",kind:"R",desc:"Rule that caused the FlashingCell to fire",ref:"FlashingCellDefinition"},{name:"flashTarget",kind:"u",desc:"What will flash (e.g. Cell, Row)"},{name:"rowPrimaryKey",kind:"s",desc:"Primary Key Value of Row which is flashing"}]},AdaptableForm:{name:"AdaptableForm",kind:"I",desc:"Defines a form which appears dynamically; used by Alerts & Export Custom Destinations",props:[{name:"buttons",kind:"a",desc:"Buttons to include in the Form",isOpt:!0},{name:"description",kind:"s",desc:"Additional information to appear in the Form",isOpt:!0},{name:"fields",kind:"u",desc:"Collection of Dynamic Fields to display",isOpt:!0},{name:"title",kind:"s",desc:"Title to appear in the Form",isOpt:!0}]},AdaptableFormat:{name:"AdaptableFormat",kind:"A",desc:"Object containing formatting information for Numeric and Date Columns"},AdaptableFormData:{name:"AdaptableFormData",kind:"A",desc:"Data which appears in an AdapTable Form"},AdaptableFormField:{name:"AdaptableFormField",kind:"I",desc:"Defines a Field that appears in an Adaptable Form",props:[{name:"defaultValue",kind:"string | boolean | number",desc:"Field Default Value - can be of type string, boolean, number",isOpt:!0},{name:"fieldType",kind:"R",desc:"Field Type: text, date, number, checkbox, select, textOutput",ref:"AdaptableFormFieldType"},{name:"label",kind:"s",desc:"Label to display in the Field"},{name:"name",kind:"s",desc:"Name of the Field"},{name:"options",kind:"u",desc:"Items to populate the Select input",isOpt:!0}]},AdaptableFormFieldType:{name:"AdaptableFormFieldType",kind:"A",desc:"Types of Controls used in an AdapTable Form"},AdaptableFrameworkComponent:{name:"AdaptableFrameworkComponent",kind:"A",desc:"Base Component for Bespoke Components: can be Angular, React or Vue"},AdaptableGenericAlert:{name:"AdaptableGenericAlert",kind:"I",desc:"Defines a generic AdapTable Alert"},AdaptableIcon:{name:"AdaptableIcon",kind:"A",desc:"Defines an icon to be used in AdapTable (e.g. in Dashboard Header, Buttons, Menu, etc.)"},AdaptableLoadStateFunction:{name:"AdaptableLoadStateFunction",kind:"I",desc:"Allows customization of state loading - used by `loadState` function in StateOptions"},AdaptableMenuItem:{name:"AdaptableMenuItem",kind:"I",desc:"Generic Menu item used by Adaptable in Column or Context Menus",props:[{name:"category",kind:"R",desc:"Category of Adaptable Menu Item: Module, General, Group or CustomSettingsPanel",ref:"MenuCategory"},{name:"icon",kind:"R",desc:"Icon to display in Menu Item",isOpt:!0,ref:"AdaptableIcon"},{name:"isVisible",kind:"b",desc:"Whether menu item is visible"},{name:"label",kind:"s",desc:"Text that appears in the menu"},{name:"name",kind:"u",desc:"Unique name for the Menu Item"},{name:"onClick",kind:"u",desc:"Function to invoke when (custom) menu item is clicked",isOpt:!0},{name:"subItems",kind:"a",desc:"Sub Menu Items to display",isOpt:!0}]},AdaptableMessageType:{name:"AdaptableMessageType",kind:"A",desc:"Defines a Message Types: 'Success', 'Info', 'Warning' or 'Error'"},AdaptableModule:{name:"AdaptableModule",kind:"A",desc:"Modules provided by AdapTable, subject to Entitlements and usually have Initial Adaptable State"},AdaptableModuleButton:{name:"AdaptableModuleButton",kind:"A",desc:"List of all the Module buttons Adaptable provides - each Module has a popup for which this is a shortcut button"},AdaptableNoCodeWizardOptions:{name:"AdaptableNoCodeWizardOptions",kind:"I",desc:"Adaptable Options used by the No Code Wizard"},AdaptableNote:{name:"AdaptableNote",kind:"I",desc:"Note that can be applied to a Cell in AdapTable",props:[{name:"ColumnId",kind:"s",desc:"Id of Column containing the Note"},{name:"PrimaryKeyValue",kind:"u",desc:"Value in Grid's Primary Key Column"},{name:"Text",kind:"s",desc:"Content of the Note"},{name:"Timestamp",kind:"n",desc:"When Note was made",isOpt:!0}]},AdaptableNotes:{name:"AdaptableNotes",kind:"A",desc:"Collection of Cell Notes"},AdaptableNumberCellEditorParams:{name:"AdaptableNumberCellEditorParams",kind:"I",desc:"Adaptable number editor parameters extending the AG Grid .",props:[{name:"emptyValue",kind:"s",desc:"Value to set for the cell, when the clear button is pressed",defVal:"'' (empty string)"},{name:"showClearButton",kind:"b",desc:"Whether to show the clear button. If `true`, it works together with `cellEditorParams.emptyValue`",defVal:"true"}]},AdaptableObject:{name:"AdaptableObject",kind:"I",desc:"Base interface which all other Adaptable State-related objects extend",props:[{name:"AdaptableVersion",kind:"R",desc:"Current AdapTable version",isOpt:!0,ref:"AdaptableVersion"},{name:"IsReadOnly",kind:"b",desc:"Sets Entity to ReadOnly (overwriting a Strategy Entitlement of 'Full')",isOpt:!0},{name:"Source",kind:"'InitialState' | 'User'",desc:"Source of state object: 'InitialState' if provided via `AdaptableOptions.initialState`, 'User' or undefined for runtime state.",isOpt:!0},{name:"Tags",kind:"a",desc:"List of Tags associated with the Object; often used for (but not limited to) managing Layout object scope",isOpt:!0},{name:"Uuid",kind:"R",desc:"Unique identifier for the Adaptable Object, generated and used internally by AdapTable",isOpt:!0,ref:"unknown"}]},AdaptableObjectLookupCriteria:{name:"AdaptableObjectLookupCriteria",kind:"I",desc:"Lookup criteria for finding specific Adaptable Objects; all given criteria will be composed with an AND operator",props:[{name:"ids",kind:"u",desc:"Technical IDs of Adaptable Objects",isOpt:!0},{name:"scope",kind:"R",desc:"ColumnScope",isOpt:!0,ref:"ColumnScope"},{name:"tag",kind:"R",desc:"AdaptableObjectTag",isOpt:!0,ref:"AdaptableObjectTag"}]},AdaptableObjectTag:{name:"AdaptableObjectTag",kind:"A",desc:"AdaptableObjectTag Object Tag - currently supporting only plain string values, but open for future extensions, if needed"},AdaptableObservableQuery:{name:"AdaptableObservableQuery",kind:"I",desc:"Wraps an AdapTableQL Observable Expression",props:[{name:"ObservableExpression",kind:"s",desc:"AdapTableQL Expression that observes the Grid or given rows"}]},AdaptableOptions:{name:"AdaptableOptions",kind:"I",desc:"Large group of options enabling developers to set up AdapTable at design time to fit precise requirements",props:[{name:"actionColumnOptions",kind:"u",desc:"Options for managing Action Columns",isOpt:!0},{name:"adaptableContext",kind:"u",desc:"Application-specific context object - is included by AdapTable in all callbacks and Events",isOpt:!0},{name:"adaptableId",kind:"s",desc:"Identifier for this instance of AdapTable",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"'adaptable_id_$random_number'"},{name:"adaptableStateKey",kind:"s",desc:"Identifier used as localStorage persistence key for AdaptableState",isOpt:!0,gridInfo:"item",defVal:"`adaptableId` value"},{name:"alertOptions",kind:"u",desc:"Options for managing Alerts in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container"},{name:"autogeneratePrimaryKey",kind:"b",desc:"Will autogenerate a Primary Key; only use as a last resort if no unique column is available, as limits some Adaptable functionalities",isOpt:!0,gridInfo:"item",defVal:"false"},{name:"calendarOptions",kind:"R",desc:"Options for managing Holidays and Working Days",isOpt:!0,ref:"CalendarOptions"},{name:"cellSummaryOptions",kind:"u",desc:"Options for adding custom Cell Summaries",isOpt:!0},{name:"chartingOptions",kind:"R",desc:"Options for managing AG Grid's Charting",isOpt:!0,noCode:"container",ref:"ChartingOptions"},{name:"columnMenuOptions",kind:"u",desc:"Options for managing AdapTable Column Menu",isOpt:!0,gridInfo:"container"},{name:"columnOptions",kind:"R",desc:"Options related to Columns",isOpt:!0,noCode:"container",ref:"ColumnOptions"},{name:"commentOptions",kind:"u",desc:"Options for managing collaborative Comments",isOpt:!0},{name:"containerOptions",kind:"R",desc:"Options for setting the 'Div' elements in which AdapTable, AG Grid, popups are placed",isOpt:!0,ref:"ContainerOptions"},{name:"contextMenuOptions",kind:"u",desc:"Options for managing AdapTable Context Menu",isOpt:!0,gridInfo:"container"},{name:"customSortOptions",kind:"R",desc:"Options for using Custom Sort",isOpt:!0,ref:"CustomSortOptions"},{name:"dashboardOptions",kind:"R",desc:"Options for managing the Dashboard in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container",ref:"DashboardOptions"},{name:"dataChangeHistoryOptions",kind:"u",desc:"Options to manage Data Change History Module which provides an overview of all data changes",isOpt:!0,gridInfo:"container",noCode:"container"},{name:"dataImportOptions",kind:"R",desc:"Options for managing the Data Import function",isOpt:!0,ref:"DataImportOptions"},{name:"dataSetOptions",kind:"u",desc:"Options to manage Data Sets",isOpt:!0},{name:"editOptions",kind:"u",desc:"Options related to Editing in AdapTable including Server Validation",isOpt:!0,gridInfo:"container"},{name:"entitlementOptions",kind:"R",desc:"Options for managing Entitlements",isOpt:!0,gridInfo:"container",ref:"EntitlementOptions"},{name:"exportOptions",kind:"u",desc:"Options for managing Exporting and Reports in AdapTable",isOpt:!0,gridInfo:"container"},{name:"expressionOptions",kind:"u",desc:"Options for managing AdapTableQL Expressions",isOpt:!0,noCode:"container"},{name:"fdc3Options",kind:"R",desc:"Options for managing FDC3 in AdapTable",isOpt:!0,ref:"Fdc3Options"},{name:"filterOptions",kind:"u",desc:"Filtering Options - both Column Filters and the Grid Filter",isOpt:!0},{name:"flashingCellOptions",kind:"R",desc:"Options for managing Flashing Cells - primarily default values",isOpt:!0,gridInfo:"container",ref:"FlashingCellOptions"},{name:"formatColumnOptions",kind:"R",desc:"Options for providing Custom Display Formats",isOpt:!0,ref:"FormatColumnOptions"},{name:"initialState",kind:"R",desc:"Initial State set at design-time and shipped with AdapTable for first use; must include at least one Layout",defVal:"undefined",ref:"InitialState"},{name:"layoutOptions",kind:"R",desc:"Options related to Layouts",isOpt:!0,gridInfo:"container",noCode:"container",ref:"LayoutOptions"},{name:"licenseKey",kind:"s",desc:"Commercial license key. If the license is not provided or is expired, various visual information notes will be displayed and some functionality may be limited.",isOpt:!0},{name:"noteOptions",kind:"R",desc:"Options for managing personal Notes",isOpt:!0,ref:"NoteOptions"},{name:"notificationsOptions",kind:"R",desc:"Options for managing Notifications in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container",ref:"NotificationsOptions"},{name:"plugins",kind:"a",desc:"Used for managing the AdapTable Plugins",isOpt:!0},{name:"predicateOptions",kind:"R",desc:"Options for managing Predicates in AdapTableQL",isOpt:!0,ref:"PredicateOptions"},{name:"primaryKey",kind:"s",desc:"Name of Column in AdapTable guaranteed to contain unique values",gridInfo:"item",defVal:"n/a (Mandatory)"},{name:"quickSearchOptions",kind:"u",desc:"Options for managing Search related functions in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container"},{name:"rowFormOptions",kind:"u",desc:"Options for managing Row Forms",isOpt:!0},{name:"settingsPanelOptions",kind:"R",desc:"Setting panel options",isOpt:!0,gridInfo:"container",noCode:"container",ref:"SettingsPanelOptions"},{name:"stateOptions",kind:"R",desc:"Options related to state hydration / dehydration - allows users to intercept state persistence and state loading and change default behaviour of saving to local storage",isOpt:!0,ref:"StateOptions"},{name:"teamSharingOptions",kind:"R",desc:"Options for managing 'Team Sharing' which allows users to create Adaptable Objects and share with colleagues",isOpt:!0,gridInfo:"container",ref:"TeamSharingOptions"},{name:"toolPanelOptions",kind:"R",desc:"Options related to managing the Tool Panel elements in AdapTable",isOpt:!0,gridInfo:"container",noCode:"container",ref:"ToolPanelOptions"},{name:"userInterfaceOptions",kind:"u",desc:"Options for managing the User Interface elements of AdapTable, i.e. Action Columns, Color Palette etc.",isOpt:!0,gridInfo:"container"},{name:"userName",kind:"s",desc:"Name of current AdapTable user",isOpt:!0,gridInfo:"item",defVal:"'anonymous'"}]},AdaptablePercentageCellEditorParams:{name:"AdaptablePercentageCellEditorParams",kind:"I",desc:"AdapTablePercentageCellEditor parameters - extends AdaptableNumberCellEditorParams"},AdaptablePersistentState:{name:"AdaptablePersistentState",kind:"I",desc:"The state object of Adaptable which is persisted"},AdaptablePersistStateFunction:{name:"AdaptablePersistStateFunction",kind:"I",desc:"Allows customization of state persistence - used `persistState` function in StateOptions"},AdaptablePlugin:{name:"AdaptablePlugin",kind:"C",desc:"Base class for all AdapTable Plugins"},AdaptablePredicate:{name:"AdaptablePredicate",kind:"I",desc:"Predicate object used by AdapTableQL - essentially a boolean function",props:[{name:"Inputs",kind:"a",desc:"Optional Inputs that might be needed for evaluation",isOpt:!0},{name:"PredicateId",kind:"u",desc:"Id of Predicate (e.g. `Equals`, `GreaterThan`)"}]},AdaptablePredicateDef:{name:"AdaptablePredicateDef",kind:"I",desc:"Defines a Predicate - include where it can run and what it does",props:[{name:"columnScope",kind:"R",desc:"Columns (or DataTypes) where Predicate is active",ref:"ColumnScope"},{name:"handler",kind:"f",desc:"Actual boolean function invoked when evaluating the Predicate"},{name:"icon",kind:"u",desc:"Icon to show (primarily used in Filter dropdown)",isOpt:!0},{name:"id",kind:"u",desc:"Predicate Id"},{name:"inputs",kind:"a",desc:"Inputs the Predicate can take",isOpt:!0},{name:"label",kind:"s",desc:"Name of the Predicate"},{name:"moduleScope",kind:"a",desc:"Modules where Predicate can run"},{name:"shortcuts",kind:"a",desc:"Keyboard shortcuts to initiate predicate - used in Quick Filter bar",isOpt:!0},{name:"toString",kind:"f",desc:"String representation of the Predicate",isOpt:!0}]},AdaptableQLModule:{name:"AdaptableQLModule",kind:"A",desc:"Modules which leverage AdapTableQL; can be used to set remote evaluation"},AdaptableQuery:{name:"AdaptableQuery",kind:"A",desc:"An AdaptableQuery can be either a Boolean, Scalar, Observable, AggregatedBoolean, or AggregatedScalar expression"},AdaptableRowChangedAlert:{name:"AdaptableRowChangedAlert",kind:"I",desc:"Defines an Alert fired by AdapTable when a row is changed",props:[{name:"rowDataChangedInfo",kind:"u",desc:"Row DataChange which triggered Alert"}]},AdaptableSaveStateFunction:{name:"AdaptableSaveStateFunction",kind:"I",desc:"Allows the customization state persistence - used by `saveState` function in StateOptions"},AdaptableScalarQuery:{name:"AdaptableScalarQuery",kind:"I",desc:"Wraps an AdapTableQL Scalar Expression",props:[{name:"ScalarExpression",kind:"s",desc:"AdapTableQL Expression that returns any value"}]},AdaptableSearchState:{name:"AdaptableSearchState",kind:"I",desc:"Current Searches and Filter in AdapTable",props:[{name:"columnFilters",kind:"u",desc:"Currently applied Column Filters"},{name:"dataSet",kind:"u",desc:"Current DataSet (if one selected)"},{name:"gridFilter",kind:"string | undefined",desc:"Current Grid Filter"},{name:"gridFilterAST",kind:"u",desc:"AST for Grid Filter"}]},AdaptableSettingsPanel:{name:"AdaptableSettingsPanel",kind:"A",desc:"Modules which can appear in the Settings Panel"},AdaptableSharedEntity:{name:"AdaptableSharedEntity",kind:"I",desc:"Defines an AdaptableObject shared with Team Sharing",props:[{name:"ChangedAt",kind:"n",desc:"Last time when the object was changed"},{name:"ChangedBy",kind:"s",desc:"Last User who changed the object"},{name:"Description",kind:"s",desc:"Description of object being shared"},{name:"Entity",kind:"R",desc:"Actual Adaptable Object being shared",ref:"AdaptableObject"},{name:"EntityDependencyIds",kind:"a",desc:"Ids of direct entity dependencies"},{name:"EntityType",kind:"u",desc:"Type of shared entity (either Adaptable specific or custom object)"},{name:"Module",kind:"R",desc:"Adaptable Module to which object belongs",ref:"AdaptableModule"},{name:"Revision",kind:"n",desc:"Revision - incremental for 'Active', always 1 for 'Snapshot'"},{name:"Timestamp",kind:"n",desc:"When the object was shared"},{name:"Type",kind:"R",desc:"'Snapshot' (for 1-time sharing) or 'Active' (for continuous sharing)",ref:"SharedEntityType"},{name:"UserName",kind:"s",desc:"User who shared the object"}]},AdaptableSharedEntityConfig:{name:"AdaptableSharedEntityConfig",kind:"I",desc:"Describes an AdaptableObject which is being Team Shared"},AdaptableSortState:{name:"AdaptableSortState",kind:"I",desc:"Overview of current sorting state in the grid",props:[{name:"columnSorts",kind:"a",desc:"Which columns have sorting applied and,if so, which direction"},{name:"customSorts",kind:"a",desc:"All Custom Sorts in State (note: this is always sent, even if no custom sorts are active)"}]},AdaptableSpecialColumnType:{name:"AdaptableSpecialColumnType",kind:"A",desc:"Column Types recognised by AdapTable; to be set in GridOptions"},AdaptableState:{name:"AdaptableState",kind:"I",desc:"The main state object of Adaptable"},AdaptableStateFunctionConfig:{name:"AdaptableStateFunctionConfig",kind:"I",desc:"State Function Config object passed into all State Options functions (except 'applyState')",props:[{name:"adaptableId",kind:"s",desc:"Id of current Adaptable instance"},{name:"adaptableStateKey",kind:"s",desc:"State Key being used"},{name:"userName",kind:"s",desc:"current Adaptable user"}]},AdaptableStatusBar:{name:"AdaptableStatusBar",kind:"I",desc:"Defines an Adaptable Status Bar",props:[{name:"Key",kind:"s",desc:"Key of Status Bar Panel as defined in AG Grid GridOptions - ensure keys are the same (note: AG Grid statusPanel is lowercase 'key')"},{name:"StatusBarPanels",kind:"a",desc:"Module Status Panels to render inside Adaptable Status Bar",isOpt:!0}]},AdaptableStatusBarPanel:{name:"AdaptableStatusBarPanel",kind:"A",desc:"Modules which can appear in the AdapTable Status Bar"},AdaptableStyle:{name:"AdaptableStyle",kind:"I",desc:"Style object used in numerous AdapTable Modules",props:[{name:"BackColor",kind:"s",desc:"Colour background of cell: hex, rgb(a) or name",isOpt:!0},{name:"BorderColor",kind:"s",desc:"Colour of cell border: hex, rgb(a) or name",isOpt:!0},{name:"BorderRadius",kind:"n",desc:"Rounds corners of an element's outer border edge; equivalent of CSS border-radius",isOpt:!0},{name:"ClassName",kind:"s",desc:"Existing CSS Class; use instead of setting other object properties",isOpt:!0},{name:"FontSize",kind:"'XSmall' | 'Small' | 'Medium' | 'Large' | 'XLarge'",desc:"Size of font: `XSmall`, `Small`, `Medium`, `Large` or `XLarge`",isOpt:!0},{name:"FontStyle",kind:"'Normal' | 'Italic'",desc:"Style of font: `Normal` or `Italic`",isOpt:!0},{name:"FontWeight",kind:"'Normal' | 'Bold'",desc:"Weight of font: `Normal` or `Bold`",isOpt:!0},{name:"ForeColor",kind:"s",desc:"Font colour in cell: hex, rgb(a) or name",isOpt:!0},{name:"TextDecoration",kind:"'None' | 'Underline' | 'Overline' | 'LineThrough'",desc:"Decoration of font: `None`, `Underline`, `Overline` or `LineThrough`",isOpt:!0}]},AdaptableSystemColumnMenuItem:{name:"AdaptableSystemColumnMenuItem",kind:"I",desc:"System Menu Item that is provided by AdapTable",props:[{name:"menuType",kind:"u",desc:"Type of Menu - always 'Adaptable'"}]},AdaptableSystemContextMenuItem:{name:"AdaptableSystemContextMenuItem",kind:"I",desc:"System Menu Item that is provided by AdapTable",props:[{name:"menuType",kind:"u",desc:"Type of Menu - always 'Adaptable'"}]},AdaptableSystemIcon:{name:"AdaptableSystemIcon",kind:"I",desc:"Defines an icon from the System AdapTable icon set",props:[{name:"name",kind:"u",desc:"The name of the icon to use (referencing the AdapTable Icon Library)"},{name:"size",kind:"n",desc:"The size (in pixels) of the SVG icon (defaults to `17px`)",isOpt:!0}]},AdaptableSystemIconName:{name:"AdaptableSystemIconName",kind:"A",desc:"All AdapTable System Icon names"},AdaptableTheme:{name:"AdaptableTheme",kind:"I",desc:"Used for creating User (i.e. Custom) Themes",props:[{name:"AgGridClassName",kind:"s",desc:"Ag Grid theme to apply when loading theme; relevant only when using the legacy AG Grid themes",isOpt:!0},{name:"AgThemeMode",kind:"u",desc:"AG Grid theme mode to apply when this theme is selected. Valid values are `light`, `dark`, `dark-blue` or any custom theme mode defined in AG Grid. When set, adds a data-ag-theme-mode attribute to the document body.",isOpt:!0},{name:"CSSVariables",kind:"u",desc:"Variables to be applied at runtime",isOpt:!0},{name:"Description",kind:"s",desc:"Description of Theme - will appear in Theme Toolbar and Toolpanel"},{name:"Name",kind:"s",desc:"Name of the Theme"},{name:"Variant",kind:"'light' | 'dark'",desc:"Base theme variant to derive custom theme from. Use `light` to inherit from Adaptable Light Theme or `dark` for Adaptable Dark Theme. When creating custom themes, specifying a variant ensures proper inheritance of base theme styles.",isOpt:!0}]},AdaptableToolPanel:{name:"AdaptableToolPanel",kind:"A",desc:"Modules which can appear as AdapTable Tool Panels"},AdaptableToolPanelDefinition:{name:"AdaptableToolPanelDefinition",kind:"I",desc:"Defines a ToolPanel - Name and VisibilityMode (Expanded / Collapsed)",props:[{name:"Name",kind:"u",desc:"ToolPanel name - either an Adaptable Module or a Custom ToolPanel (defined in ToolPanel Options)"},{name:"VisibilityMode",kind:"'expanded' | 'collapsed'",desc:"Whether the ToolPanel is 'expanded' or 'collapsed'",isOpt:!0,defVal:"'collapsed'"}]},AdaptableVersion:{name:"AdaptableVersion",kind:"A",desc:"The current version of AdapTable being used"},AggregatedExpressionFilterRowContext:{name:"AggregatedExpressionFilterRowContext",kind:"I",desc:"Context used when applying a filter to Rows before Reducer is called",props:[{name:"aggColumnId",kind:"s",desc:"Column Id of the column being aggregated Usually the first Col argument, e.g. [colId]"},{name:"args",kind:"a",desc:"Arguments passed to the function"},{name:"getValueForColId",kind:"u",desc:"Utility function to get the value of a column"},{name:"groupByColumnIds",kind:"a",desc:"Column Id(s) of the column(s) being grouped by",isOpt:!0},{name:"rowNode",kind:"R",desc:"Current row node",ref:"unknown"}]},AggregatedExpressionFunction:{name:"AggregatedExpressionFunction",kind:"I",desc:"Defines an AdapTableQL function that aggregates data",props:[{name:"description",kind:"s",desc:"Description of the Aggregated Expression Function",isOpt:!0},{name:"examples",kind:"a",desc:"Examples to use the Aggregated Expression Function",isOpt:!0},{name:"filterRow",kind:"f",desc:"Optional filter which is applied to each row before the reducer is called. If the filter returns false, the row is NOT included in the aggregation.",isOpt:!0},{name:"initialValue",kind:"u",desc:"Mandatory Initial Value for the aggregation"},{name:"inputTypes",kind:"a",desc:"Optional argument types.",isOpt:!0},{name:"prepareRowValue",kind:"u",desc:"Called for each row AFTER the reducer() and processAggregatedValue() functions Can be used when each row has a different aggregated value (e.g. percentage = row value / aggregated value). Returns return value for each individual row",isOpt:!0},{name:"processAggregatedValue",kind:"f",desc:"Called AFTER the reducer() has processed all values / rows Can be used to change result of reducer based on the values array (e.g. average = aggregated value / count)",isOpt:!0},{name:"reducer",kind:"f",desc:"Mandatory Reducer function which is called for each value(row) in the Column Data"},{name:"signatures",kind:"a",desc:"Example Signatures for the Aggregated Expression Function",isOpt:!0}]},AggregatedExpressionPrepareRowValueContext:{name:"AggregatedExpressionPrepareRowValueContext",kind:"I",desc:"Context used by prepareRowValue property in Aggregated Expressions",props:[{name:"aggColumnId",kind:"s",desc:"Column Id of the column being aggregated"},{name:"aggregatedValue",kind:"u",desc:"Result of the reducer"},{name:"args",kind:"a",desc:"Arguments passed to the function"},{name:"getValueForColId",kind:"u",desc:"Helper function to get the value of a column"},{name:"groupByColumnIds",kind:"a",desc:"Column Id(s) of the column(s) being grouped by",isOpt:!0},{name:"rowNode",kind:"R",desc:"Current Row Node",ref:"unknown"}]},AggregatedExpressionProcessAggValueContext:{name:"AggregatedExpressionProcessAggValueContext",kind:"I",desc:"Context used by processAggregatedValue property in Aggregated Expressions",props:[{name:"aggColumnId",kind:"s",desc:"Column Id of the column being aggregated"},{name:"aggregatedValue",kind:"u",desc:"Result of the reducer"},{name:"args",kind:"a",desc:"Arguments passed to the function"},{name:"groupByColumnIds",kind:"a",desc:"Column Id(s) of the column(s) being grouped by",isOpt:!0},{name:"rowNodes",kind:"a",desc:"Array of row nodes; if aggregation is grouped, this will be the array of row nodes for the group"}]},AggregatedExpressionReducerContext:{name:"AggregatedExpressionReducerContext",kind:"I",desc:"Context used by the reducer property in Aggregated Expressions",props:[{name:"accumulator",kind:"u",desc:"Value returned by the previous call to the reducer function, or the initialValue if this is the first call. You return the new accumulator value from this function."},{name:"aggColumnId",kind:"s",desc:"Column Id of the column being aggregated"},{name:"args",kind:"a",desc:"Arguments passed to the function"},{name:"currentValue",kind:"u",desc:"Current value being processed in the Column Data"},{name:"getValueForColId",kind:"u",desc:"Helper function to get the value of a column"},{name:"groupByColumnIds",kind:"a",desc:"Column Id(s) of the column(s) being grouped by",isOpt:!0},{name:"index",kind:"n",desc:"Index of the current value in the Column Data"},{name:"rowNode",kind:"R",desc:"Current row node",ref:"unknown"}]},AgGridColumnMenuItemType:{name:"AgGridColumnMenuItemType",kind:"A",desc:"Defines AG Grid Column Menu Items"},AgGridConfig:{name:"AgGridConfig",kind:"I",desc:"Contains AG Grid Options and Modules - used when instantiating AdapTable vanilla",props:[{name:"gridOptions",kind:"R",desc:"AG Grid GridOptions object",ref:"unknown"},{name:"modules",kind:"a",desc:"AG Grid Modules to use; provide empty array if using CJS"}]},AgGridContextMenuItemType:{name:"AgGridContextMenuItemType",kind:"A",desc:"Defines AG Grid Context Menu Items"},AgGridMenuItem:{name:"AgGridMenuItem",kind:"I",desc:"Menu Item that is provided by AG Grid",props:[{name:"menuType",kind:"u",desc:"Type of Menu - always 'AgGrid'"},{name:"name",kind:"u",desc:"Name of the Menu Type"}]},AlertButton:{name:"AlertButton",kind:"I",desc:"Defines a button that appears in an Alert Form",props:[{name:"ButtonStyle",kind:"R",desc:"Style for the Button",isOpt:!0,ref:"ButtonStyle"},{name:"Command",kind:"u",desc:"Predefined Command(s) to trigger when button is clicked; implemented in `commandHandlers` property of Alert Options",isOpt:!0},{name:"Label",kind:"s",desc:"Label to show in the Button"},{name:"Tooltip",kind:"s",desc:"ToolTip to display",isOpt:!0}]},AlertButtonForm:{name:"AlertButtonForm",kind:"A",desc:"Form triggered by an Alert which contains only Buttons"},AlertDefinition:{name:"AlertDefinition",kind:"I",desc:"The Alert Definition object used in the Alert function",props:[{name:"AlertForm",kind:"u",desc:"Form to display in Alert with buttons and inputs",isOpt:!0},{name:"AlertProperties",kind:"R",desc:"Series of properties which set what happens when Alert is triggered",isOpt:!0,ref:"AlertProperties"},{name:"MessageHeader",kind:"s",desc:"Title of displayed Alert Message",isOpt:!0},{name:"MessageText",kind:"s",desc:"Title of displayed Alert Message; if null, AdapTable creates dynamically using Rule & Scope",isOpt:!0},{name:"MessageType",kind:"R",desc:"Type of Alert: 'Info', 'Success', 'Warning', 'Error'; influences Alert colour, icon and logging",ref:"AdaptableMessageType"},{name:"Rule",kind:"R",desc:"When Alert should be triggered",ref:"AlertRule"},{name:"Scope",kind:"R",desc:"Where Alert can be triggered: one, some or all columns or DataTypes",ref:"ColumnScope"}]},AlertDefinitionPredicate:{name:"AlertDefinitionPredicate",kind:"I",desc:"Predicate used when creating a Predicate-based Rule for an Alert"},AlertForm:{name:"AlertForm",kind:"A",desc:"Form to show in an Alert"},AlertFormContext:{name:"AlertFormContext",kind:"I",desc:"Context required by functions when using an Alert Button",props:[{name:"alert",kind:"u",desc:"Alert that has been triggered"}]},AlertMessageContext:{name:"AlertMessageContext",kind:"I",desc:"Context used for creating bespoke Alert messages",props:[{name:"alertDefinition",kind:"R",desc:"Current Alert Definition",ref:"AlertDefinition"},{name:"cellDataChangedInfo",kind:"u",desc:"Cell Data change that might have triggered the Alert",isOpt:!0},{name:"rowDataChangedInfo",kind:"u",desc:"Row Data change that might have triggered the Alert (e.g. Row Added or Removed)",isOpt:!0}]},AlertOptions:{name:"AlertOptions",kind:"I",desc:"Options related to Alerts in Adaptable.",props:[{name:"alertForms",kind:"u",desc:"Full definitions of Alert Forms - the names of which are provided in Alert State",isOpt:!0},{name:"alertMessageHeader",kind:"u",desc:"Function providing Header to display in Alert; if empty, AdapTable provides dynamically",isOpt:!0},{name:"alertMessageText",kind:"u",desc:"Function providing Message to display in Alert; if empty, AdapTable provides dynamically",isOpt:!0},{name:"cellHighlightDuration",kind:"n",desc:"How long (in ms) a Cell will be highlighted when an Alert fires",isOpt:!0,gridInfo:"item",defVal:"2000"},{name:"commandHandlers",kind:"u",desc:"Custom onClick Handlers for Buttons (displayed in Alert Forms)",isOpt:!0},{name:"dataChangeDetectionPolicy",kind:"R",desc:"Whether Alert rule is evaluated against the `rawValue` or `formattedValue` of the changed cell data",isOpt:!0,gridInfo:"item",defVal:"'rawValue'",ref:"DataChangeDetectionPolicy"},{name:"maxAlertsInStore",kind:"n",desc:"How many alerts held in State at any one time; when limit is breached, oldest alert will be removed",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"20"},{name:"rowHighlightDuration",kind:"n",desc:"How long (in ms) a Row will be highlighted when an Alert Fires",isOpt:!0,gridInfo:"item",defVal:"4000"},{name:"showMissingPrimaryKeyAlert",kind:"b",desc:"Shows Alert if Primary Key column in Adaptable Options is not present or incorrect",uiLabel:"Show Missing Primary Key Warning",isOpt:!0,gridInfo:"item",noCode:"item",defVal:"false"},{name:"statusbarHighlightDuration",kind:"n",desc:"How long (in ms) Alert panel in Status Bar highlights when an Alert Fires",isOpt:!0,defVal:"2000"}]},AlertProperties:{name:"AlertProperties",kind:"I",desc:"Additional properties that specify how a particular Alert will ALWAYS behave",props:[{name:"DisplayNotification",kind:"b",desc:"Displays a notification when Alert is triggered",isOpt:!0},{name:"HighlightCell",kind:"u",desc:"Colours updated Row using `MessageType` of triggering Alert Definition",isOpt:!0},{name:"HighlightRow",kind:"u",desc:"Colours updated Row using `MessageType` of triggering Alert Definition",isOpt:!0},{name:"JumpToCell",kind:"b",desc:"Grid will 'jump' to the changed cell which triggered the Alert",isOpt:!0},{name:"JumpToRow",kind:"b",desc:"Grid will 'jump' to the newly added row which triggered the Alert",isOpt:!0},{name:"LogToConsole",kind:"b",desc:"Logs the Alert message to the console",isOpt:!0},{name:"NotificationDuration",kind:"u",desc:"Notifiction duration(defaults to `NotificationOptions.duration`)",isOpt:!0},{name:"PreventEdit",kind:"b",desc:"Automatically prevent any cell edit which triggered the Alert (i.e. validation)",isOpt:!0,defVal:"false"},{name:"ShowInDiv",kind:"b",desc:"Shows Alert text in the div specificed in `alertContainer` property of Container Options",isOpt:!0}]},AlertRule:{name:"AlertRule",kind:"A",desc:"The Alert Rule defined by either an AdaptablePredicate or an AdaptableQuery"},AlertState:{name:"AlertState",kind:"I",desc:"Adaptable State section for Alert Module",props:[{name:"AlertDefinitions",kind:"a",desc:"Alert Definitions - will trigger Alerts when rule is met",isOpt:!0}]},AlternativeModuleName:{name:"AlternativeModuleName",kind:"I",desc:"Defines a new name for an Adaptable Module (e.g. change Dashboard to Grid Manager)",props:[{name:"adaptableModule",kind:"R",desc:"Adaptable Module to rename",ref:"AdaptableModule"},{name:"newName",kind:"s",desc:"New name to use"}]},AngularFrameworkComponent:{name:"AngularFrameworkComponent",kind:"A",desc:"Angular component defined by its type and (optional) initialisation callback"},ApplicationDataEntry:{name:"ApplicationDataEntry",kind:"I",desc:"Simple Key / Value pair object used to store custom - stringifiable - data in Adaptable State.",props:[{name:"Key",kind:"s",desc:"Key of Key / Value pair - always stored as a string"},{name:"Value",kind:"u",desc:"Value of Key / Value pair (actual data being stored) - needs to stringifiable"}]},ApplicationState:{name:"ApplicationState",kind:"I",desc:"Adaptable State Section for the Application Module",props:[{name:"ApplicationDataEntries",kind:"a",desc:"Array of Key / Value pairs enabling custom data to be stored in Adaptable State.",isOpt:!0}]},ApplyFilterAction:{name:"ApplyFilterAction",kind:"A",desc:"When to apply a Filter: 'Always', 'Never' or 'Throttle'"},AST_Expression:{name:"AST_Expression",kind:"A",desc:"Defines AST of an Expressoin"},AST_Function:{name:"AST_Function",kind:"A",desc:"Defines AST of an Expression Function"},AST:{name:"AST",kind:"A",desc:"An AST Expression"},AutoGenerateTagsForLayoutsContext:{name:"AutoGenerateTagsForLayoutsContext",kind:"I",desc:"Context for `LayoutOptions.autoGenerateTagsForLayouts` method",props:[{name:"layouts",kind:"a",desc:"Layouts currently in Adaptable State"},{name:"objectTags",kind:"a",desc:"Object Tags provided in User Interface Options"}]},BadgeStyle:{name:"BadgeStyle",kind:"I",desc:"Collection of Badge Style Definitions to display in a Badge Styled Column",props:[{name:"Badges",kind:"a",desc:"Collection of Badge Style Definitions",isOpt:!0},{name:"RowScope",kind:"R",desc:"Which types of Rows should contain a Badge (data, grouped, summary)",isOpt:!0,ref:"RowScope"}]},BadgeStyleDefinition:{name:"BadgeStyleDefinition",kind:"I",desc:"Defines a Badge Style",props:[{name:"Icon",kind:"u",desc:"Icon to display in Badge",isOpt:!0},{name:"IconPosition",kind:"'Start' | 'End'",desc:"Position of Icon in the Badge - 'Start' or 'End'",isOpt:!0},{name:"Predicate",kind:"R",desc:"Optional Rule for deciding whether Badge is displayed",isOpt:!0,ref:"BadgeStylePredicate"},{name:"Style",kind:"R",desc:"Style for the Badge",isOpt:!0,ref:"AdaptableStyle"}]},BadgeStylePredicate:{name:"BadgeStylePredicate",kind:"I",desc:"System Predicate definition for Badge Style"},BaseContext:{name:"BaseContext",kind:"I",desc:"Base class for all AdapTable callbacks and Events",props:[{name:"adaptableApi",kind:"R",desc:"Adaptable Api object",ref:"unknown"},{name:"adaptableContext",kind:"u",desc:"Custom application Context provided in Adaptable Options"},{name:"adaptableId",kind:"s",desc:"Id of current AdapTable instance"},{name:"adaptableStateKey",kind:"s",desc:"Current Adaptable State Key"},{name:"clientTimestamp",kind:"d",desc:"Time on user's computer"},{name:"userName",kind:"s",desc:"Name of Current User"}]},BaseExportContext:{name:"BaseExportContext",kind:"I",desc:"Context information available in all Export-related functions",props:[{name:"exportDestination",kind:"R",desc:"Export Destination for the Report",isOpt:!0,ref:"ExportDestinationType"},{name:"report",kind:"R",desc:"The Report Configuration being run",ref:"Report"},{name:"reportF