@adaptabletools/adaptable 17.0.0-canary.0 → 17.0.0-canary.1

package/publishTimestamp.d.ts

@@ -1,2 +0,0 @@
-declare const _default: 1703252162352;
-export default _default;

package/publishTimestamp.js

@@ -1 +0,0 @@
-export default 1703252162352;

package/src/AdaptableOptions/FilterOptions.d.ts

@@ -1,216 +0,0 @@
-import { AdaptableColumn } from '../PredefinedConfig/Common/AdaptableColumn';
-import { FilterActionOnDataChange } from '../PredefinedConfig/Common/FilterActionOnDataChange';
-import { ColumnFilterContext, SystemAlertPredicateId, SystemFilterPredicateId } from '../../types';
-import { StrictExtract } from '../Utilities/Extensions/TypeExtensions';
-/**
- * Options for managing Filtering in AdapTable
- * @deprecated use ColumnFilterOptions instead
- */
-export interface FilterOptions<TData = any> {
-    /**
-     * Hides Dropdown in Quick Filter Bar for a given Column
-     *
-     * @defaultValue undefined
-     */
-    hideQuickFilterDropdown?: (columFilterContext: ColumnFilterContext<TData>) => boolean;
-    /**
-     * Hides Input in Quick Filter Bar for a given Column
-     *
-     * @defaultValue undefined
-     */
-    hideQuickFilterInput?: (columFilterContext: ColumnFilterContext<TData>) => boolean;
-    /**
-     * Distinct column items to display in Filter Form; useful with large datasource (though AdapTable offers virtualisation)
-     *
-     * @defaultValue 2,000
-     * @gridInfoItem
-     * @noCodeItem
-     */
-    maxFilterValuesToDisplay?: number;
-    /**
-     * Make Column header distinctive for filtered columns, helps users see currently filtered columns
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     * @noCodeItem
-     */
-    indicateFilteredColumns?: boolean;
-    /**
-     * 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
-     *
-     * @defaultValue true
-     * @noCodeItem
-     */
-    useAdaptableFilterForm?: boolean | string[];
-    /**
-     * Styles Adaptable Filter Form to match AG Grid's styling (if using Balham theme)
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     * @noCodeItem
-     */
-    useAgGridFilterFormStyle?: boolean;
-    /**
-     * Use Adaptable's Quick Filter Bar for all columns if 'true' (the default) or those listed, in preference to AG Grid's Floating Filter
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     * @noCodeItem
-     */
-    useAdaptableQuickFilter?: boolean | string[];
-    /**
-     * Whether to open Quick Filter dropdown with mouse hover or click
-     *
-     * @defaultValue 'mouseenter'
-     * @gridInfoItem
-     * @noCodeItem
-     */
-    quickFilterTrigger?: 'mouseenter' | 'click';
-    /**
-     * Whether to open Quick Filter Values dropdown with mouse hover or click
-     *
-     * @defaultValue 'mouseenter'
-     * @gridInfoItem
-     * @noCodeItem
-     */
-    quickFilterValuesTrigger?: 'mouseenter' | 'click';
-    /**
-     * Sets a height for Quick Filter Bar (if not provided AG Grid's default is used)
-     *
-     * @defaultValue null
-     * @gridInfoItem
-     */
-    quickFilterHeight?: number;
-    /**
-     * When to re-filter grid after user edits data: 'Always', 'Never' or 'Throttle' (which requires a 'ThrottleDelay')
-     *
-     * @defaultValue 'Always'
-     */
-    filterActionOnUserDataChange?: FilterActionOnDataChange;
-    /**
-     * When to re-filter grid after data ticks: 'Always', 'Never' or 'Throttle' (which requires a 'ThrottleDelay')
-     *
-     * @defaultValue 'Never'
-     */
-    filterActionOnExternalDataChange?: FilterActionOnDataChange;
-    /**
-     * Apply selected filters (in Filter Form or Quick Filter Bar) as soon as they are clicked; if false an Apply Filter button is displayed
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     * @noCodeItem
-     */
-    autoApplyFilter?: boolean;
-    /**
-     * Clears saved Column Filters when AdapTable loads
-     *
-     * @defaultValue false
-     * @gridInfoItem
-     */
-    clearFiltersOnStartUp?: boolean;
-    /**
-     * Whether column values in filter dropdown should apply column's current Sort Order for the column
-     *
-     * @defaultValue false
-     * @gridInfoItem
-     */
-    sortColumnValuesInFilter?: boolean;
-    /**
-     * Default filter type for numeric Columns
-     *
-     * @defaultValue Equals
-     * @gridInfoItem
-     */
-    defaultNumericColumnFilter?: StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'Values'> | ((column: AdaptableColumn) => StrictExtract<SystemFilterPredicateId, 'GreaterThan' | 'LessThan' | 'Equals' | 'NotEquals' | 'Values'>);
-    /**
-     * Default filter type for string Columns
-     *
-     * @defaultValue Contains
-     * @gridInfoItem
-     */
-    defaultStringColumnFilter?: StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Values'> | ((column: AdaptableColumn) => StrictExtract<SystemFilterPredicateId, 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Values'>);
-    /**
-     * Default filter type for date Columns
-     *
-     * @defaultValue On
-     * @gridInfoItem
-     */
-    defaultDateColumnFilter?: StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'Values'> | ((column: AdaptableColumn) => StrictExtract<SystemFilterPredicateId, 'After' | 'Before' | 'On' | 'NotOn' | 'Values'>);
-    /**
-     * Whether to open the Filter Form on the Values or Predicates tab
-     *
-     * @defaultValue 'Values'
-     * @gridInfoItem
-     */
-    defaultFilterFormTab?: 'Values' | 'Predicates';
-    /**
-     * Allows filtering on Calculated & FreeText columns
-     *
-     * @defaultValue true
-     * @gridInfoItem
-     */
-    enableFilterOnSpecialColumns?: boolean;
-    /**
-     * Whether to display Quick Filter Bar between Column Header and the Grid (provided its been setup)
-     * @defaultValue  true
-     * @noCodeItem
-     */
-    showQuickFilter?: boolean;
-    /**
-     * If Values filter should filter on datetime rather than date
-     * @defaultValue false
-     * @noCodeItem
-     */
-    filterUsingTime?: boolean;
-    /**
-     * Display only currently filtered distinct values in Filter controls
-     *
-     * @defaultValue false
-     * @gridInfoItem
-     * @noCodeItem
-     */
-    showDistinctFilteredValuesOnly?: boolean;
-    /**
-     * Display Clear Filter button in Toolbar and Tool Panel
-     * @defaultValue  false
-     * @gridInfoItem
-     * @noCodeItem
-     */
-    showClearFilterButton?: boolean;
-    /**
-     * Display Suspend / Unsuspend Button in Toolbar and Tool Panel
-     * @defaultValue  false
-     * @gridInfoItem
-     * @noCodeItem
-     */
-    showSuspendFilterButton?: boolean;
-    /**
-     * Shortcut Keys to activate a Quick Filter Predicate
-     */
-    quickFilterWildcards?: Partial<Record<SystemAlertPredicateId, string[]>>;
-    /**
-     * Time to wait (in ms) before Filter Bar reacts to new value
-     * @defaultValue 250
-     * @gridInfoItem
-     */
-    quickFilterDebounce?: number;
-    /**
-     * Show the count of each distinct item for given column in the Values (IN) Filter
-     * @defaultValue  false
-     * @gridInfoItem
-     * @noCodeItem
-     */
-    showValuesCount?: (column: AdaptableColumn<TData>) => boolean;
-    /**
-     * Width of Values popup in Filter Bar - can be set width or same size as Column
-     * @defaultValue '180'
-     */
-    quickFilterValuesWidth?: 'auto' | number;
-    /**
-     * Includes a [BLANKS] entry in Values filter
-     * @defaultValue  false
-     * @gridInfoItem
-     * @noCodeItem
-     */
-    includeBlankFilterValues?: boolean;
-}

package/src/AdaptableOptions/FinancePluginOptions.d.ts

@@ -1,6 +0,0 @@
-/**
- * Removed in Version 16
- * @deprecated - now provided in FDC3 Options
- */
-export interface FinancePluginOptions {
-}

package/src/AdaptableOptions/FinancePluginOptions.js

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

package/src/Api/Events/ChexboxColumnClicked.d.ts

@@ -1,24 +0,0 @@
-import { AdaptableColumn } from '../../PredefinedConfig/Common/AdaptableColumn';
-import { BaseEventInfo } from './BaseEventInfo';
-/**
- * Event Info published by CheckboxColumnClicked event
- * @deprecated - no longer used in AdapTable 16
- */
-export interface CheckboxColumnClickedInfo extends BaseEventInfo {
-    /**
-     * Name of Column where Checkbox was clicked
-     */
-    column: AdaptableColumn;
-    /**
-     * Value in Primary Key Column for row where Checkbox was clicked
-     */
-    primaryKeyValue: any;
-    /**
-     * Data in the row where the Checkbox was clicked
-     */
-    rowData: any;
-    /**
-     * Whether or not the Checkbox is checked
-     */
-    isChecked: boolean;
-}

package/src/Api/Events/ChexboxColumnClicked.js

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

package/src/Api/Events/QueryRun.d.ts

@@ -1,15 +0,0 @@
-import { BaseEventInfo } from './BaseEventInfo';
-/**
- * EventInfo returned by the QueryRun event
- * @deprecated Query functionality was moved to GridFilter
- */
-export interface QueryRunInfo extends BaseEventInfo {
-    /**
-     * Current Query
-     */
-    currentQuery: string | undefined;
-    /**
-     * AST for Current Query
-     */
-    queryAST: any;
-}

package/src/Api/Events/QueryRun.js

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

package/src/PredefinedConfig/ConditionalStyleState.d.ts

@@ -1,41 +0,0 @@
-import { ConfigState } from './ConfigState';
-import { AdaptableStyle } from './Common/AdaptableStyle';
-import { AdaptableScope } from './Common/AdaptableScope';
-import { AdaptablePredicate } from './Common/AdaptablePredicate';
-import { TypeHint } from './Common/Types';
-import { XOR } from '../Utilities/Extensions/TypeExtensions';
-import { AdaptableBooleanQuery } from './Common/AdaptableQuery';
-import { SuspendableObject } from './Common/SuspendableObject';
-/**
- * Deprecated section of Adaptable State - use `FormatColumnState` instead
- * @deprecated use `FormatColumnState` instead
- **/
-export interface ConditionalStyleState extends ConfigState {
-    ConditionalStyles?: ConditionalStyle[];
-}
-/**
- * Deprecated Adaptable Object - use `FormatColumn` instead
- * @deprecated use `FormatColumn` instead
- */
-export interface ConditionalStyle extends SuspendableObject {
-    Scope: AdaptableScope;
-    Rule: ConditionalStyleRule;
-    Style: AdaptableStyle;
-    IncludeGroupedRows?: boolean;
-}
-/**
- * Deprecated - use `FormatColumnPredicate` instead
- * @deprecated use `FormatColumnPredicate` instead
- */
-export interface ConditionalStylePredicate extends AdaptablePredicate {
-    PredicateId: TypeHint<string, SystemConditionalStylePredicateId>;
-}
-/**
- * Deprecated - use `FormatColumnRule` instead
- * @deprecated use `FormatColumnRule` instead
- */
-export declare type ConditionalStyleRule = XOR<{
-    Predicate: ConditionalStylePredicate;
-}, AdaptableBooleanQuery>;
-declare type SystemConditionalStylePredicateId = 'Blanks' | 'NonBlanks' | 'Equals' | 'NotEquals' | 'GreaterThan' | 'LessThan' | 'Positive' | 'Negative' | 'Zero' | 'Between' | 'NotBetween' | 'Is' | 'IsNot' | 'Contains' | 'NotContains' | 'StartsWith' | 'EndsWith' | 'Regex' | 'Today' | 'Yesterday' | 'Tomorrow' | 'ThisWeek' | 'ThisMonth' | 'ThisQuarter' | 'ThisYear' | 'InPast' | 'InFuture' | 'Before' | 'After' | 'On' | 'NotOn' | 'NextWorkDay' | 'LastWorkDay' | 'True' | 'False';
-export {};

package/src/PredefinedConfig/ConditionalStyleState.js

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

package/version.d.ts

@@ -1,2 +0,0 @@
-declare const _default: "17.0.0-canary.0";
-export default _default;

package/version.js

@@ -1 +0,0 @@
-export default '17.0.0-canary.0'; // PLEASE DONT UPDATE THIS!!! - will be updated at build time with the correct version