ag-grid-enterprise
- Version 30.2.1
- Published
- 65.4 MB
- No dependencies
- Commercial license
Install
npm i ag-grid-enterprise
yarn add ag-grid-enterprise
pnpm add ag-grid-enterprise
Overview
AG Grid Enterprise Features
Index
Variables
Functions
Classes
SetFilter
- afterGuiAttached()
- afterGuiDetached()
- applyModel()
- areModelsEqual()
- createBodyTemplate()
- destroy()
- doesFilterPass()
- getCssIdentifier()
- getFilterKeys()
- getFilterType()
- getFilterValues()
- getFormattedValue()
- getMiniFilter()
- getModelAsString()
- getModelFromUi()
- getPositionableElement()
- getValueModel()
- getValues()
- handleCancelEnd()
- handleKeyDown()
- isModelValid()
- onAnyFilterChanged()
- onNewRowsLoaded()
- postConstruct()
- refreshFilterValues()
- refreshVirtualList()
- resetFilterValues()
- resetUiToActiveModel()
- resetUiToDefaults()
- setFilterValues()
- setMiniFilter()
- setModel()
- setModelIntoUi()
- setParams()
- updateUiVisibility()
Variables
variable EnterpriseCoreModule
const EnterpriseCoreModule: Module;
variable ExcelExportModule
const ExcelExportModule: Module;
variable SetFilterModule
const SetFilterModule: Module;
Functions
function exportMultipleSheetsAsExcel
exportMultipleSheetsAsExcel: (params: ExcelExportMultipleSheetParams) => void;
function getMultipleSheetsAsExcel
getMultipleSheetsAsExcel: ( params: ExcelExportMultipleSheetParams) => Blob | undefined;
Classes
class LicenseManager
class GridLicenseManager extends BeanStub {}
method getLicenseDetails
static getLicenseDetails: (licenseKey: string) => { licenseKey: string; valid: boolean; expiry: string | null; version: string; isTrial: boolean | null; trialExpired: boolean | null;};
method getWatermarkMessage
getWatermarkMessage: () => string;
method isDisplayWatermark
isDisplayWatermark: () => boolean;
method setLicenseKey
static setLicenseKey: (licenseKey: string) => void;
method validateLicense
validateLicense: () => void;
class SetFilter
class SetFilter<V = string> extends ProvidedFilter<SetFilterModel, V> implements ISetFilter<V> {}
Parameter V
type of value in the Set Filter
constructor
constructor();
method afterGuiAttached
afterGuiAttached: (params?: IAfterGuiAttachedParams) => void;
method afterGuiDetached
afterGuiDetached: () => void;
method applyModel
applyModel: (source?: 'api' | 'ui' | 'rowDataUpdated') => boolean;
method areModelsEqual
protected areModelsEqual: (a: SetFilterModel, b: SetFilterModel) => boolean;
method createBodyTemplate
protected createBodyTemplate: () => string;
method destroy
destroy: () => void;
method doesFilterPass
doesFilterPass: (params: IDoesFilterPassParams) => boolean;
method getCssIdentifier
protected getCssIdentifier: () => string;
method getFilterKeys
getFilterKeys: () => SetFilterModelValue;
method getFilterType
getFilterType: () => 'set';
method getFilterValues
getFilterValues: () => (V | null)[];
method getFormattedValue
getFormattedValue: (key: string | null) => string | null;
method getMiniFilter
getMiniFilter: () => string | null;
method getModelAsString
getModelAsString: (model: SetFilterModel) => string;
method getModelFromUi
getModelFromUi: () => SetFilterModel | null;
method getPositionableElement
protected getPositionableElement: () => HTMLElement;
method getValueModel
getValueModel: () => SetValueModel<V> | null;
method getValues
getValues: () => SetFilterModelValue;
method handleCancelEnd
protected handleCancelEnd: (e: Event) => void;
method handleKeyDown
protected handleKeyDown: (e: KeyboardEvent) => void;
method isModelValid
protected isModelValid: (model: SetFilterModel) => boolean;
method onAnyFilterChanged
onAnyFilterChanged: () => void;
method onNewRowsLoaded
onNewRowsLoaded: () => void;
method postConstruct
protected postConstruct: () => void;
method refreshFilterValues
refreshFilterValues: () => void;
method refreshVirtualList
refreshVirtualList: () => void;
method resetFilterValues
resetFilterValues: () => void;
Public method provided so the user can reset the values of the filter once that it has started.
method resetUiToActiveModel
protected resetUiToActiveModel: ( currentModel: SetFilterModel | null, afterUiUpdatedFunc?: () => void) => void;
method resetUiToDefaults
protected resetUiToDefaults: () => AgPromise<void>;
method setFilterValues
setFilterValues: (values: (V | null)[]) => void;
Public method provided so the user can change the value of the filter once the filter has been already started
Parameter values
The values to use.
method setMiniFilter
setMiniFilter: (newMiniFilter: string | null) => void;
method setModel
setModel: (model: SetFilterModel | null) => AgPromise<void>;
method setModelIntoUi
protected setModelIntoUi: (model: SetFilterModel | null) => AgPromise<void>;
method setParams
setParams: (params: SetFilterParams<any, V>) => void;
method updateUiVisibility
protected updateUiVisibility: () => void;
Package Files (7)
Dependencies (0)
No dependencies.
Dev Dependencies (41)
- @ag-grid-enterprise/advanced-filter
- @ag-grid-enterprise/all-modules
- @ag-grid-enterprise/charts
- @ag-grid-enterprise/clipboard
- @ag-grid-enterprise/column-tool-panel
- @ag-grid-enterprise/core
- @ag-grid-enterprise/excel-export
- @ag-grid-enterprise/filter-tool-panel
- @ag-grid-enterprise/master-detail
- @ag-grid-enterprise/menu
- @ag-grid-enterprise/multi-filter
- @ag-grid-enterprise/range-selection
- @ag-grid-enterprise/rich-select
- @ag-grid-enterprise/row-grouping
- @ag-grid-enterprise/server-side-row-model
- @ag-grid-enterprise/set-filter
- @ag-grid-enterprise/side-bar
- @ag-grid-enterprise/sparklines
- @ag-grid-enterprise/status-bar
- @ag-grid-enterprise/viewport-row-model
- @rollup/plugin-alias
- @types/node
- ag-charts-community
- ag-grid-community
- gulp
- gulp-add-src
- gulp-clean
- gulp-concat
- gulp-header
- gulp-rename
- gulp-replace
- gulp-sourcemaps
- gulp-tsd
- gulp-typescript
- merge2
- rimraf
- rollup
- rollup-plugin-node-resolve
- rollup-plugin-replace
- rollup-plugin-typescript2
- typescript
Peer Dependencies (0)
No peer dependencies.
Badge
To add a badge like this oneto your package's README, use the codes available below.
You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/ag-grid-enterprise
.
- Markdown[](https://www.jsdocs.io/package/ag-grid-enterprise)
- HTML<a href="https://www.jsdocs.io/package/ag-grid-enterprise"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>
- Updated .
Package analyzed in 6230 ms. - Missing or incorrect documentation? Open an issue for this package.