import { ViewTemplate } from '@microsoft/fast-element'; import { FoundationElement } from '@microsoft/fast-foundation'; import type { ColDef, ColumnState, GridApi, GridOptions, GridParams } from 'ag-grid-community'; import { GridProBaseDatasource } from './datasource/base.datasource'; import type { GridComponents, GridProCaseType, GridProErrorEvent, GridProErrorItem, GridProEventsAndCallbacks } from './grid-pro.types'; import { GridOptionsConfig, GridProStatusBarConfig, GridProStatusBarLabelConfig } from './grid-pro.types'; import { StatePersistence } from './state-persistence'; declare const GridProBeta_base: (new (...args: any[]) => { #_container: import("@genesislcap/foundation-utils").FoundationLayoutContainer | import("@genesislcap/foundation-utils").LayoutCacheContainer | import("@genesislcap/foundation-utils").DOMContainer; #_latestTokenCode: string; #_hasFirstLoaded: boolean; #_cleanupTimeout: NodeJS.Timeout; #_shouldForceLifecycle: boolean; cloneNode(deep?: boolean): Node; deepClone(): Node; get shouldRunDisconnect(): boolean; get shouldRunConnect(): boolean; #_blockLifecycleDueToTokenChange(lifecycleType: "connect" | "disconnect" | "reconnect"): boolean; #_tryFindContainingLayout(e: Element): import("@genesislcap/foundation-utils").FoundationLayoutContainer | import("@genesislcap/foundation-utils").LayoutCacheContainer | import("@genesislcap/foundation-utils").DOMContainer; connectedCallback(): void; readonly $fastController: import("@microsoft/fast-element").Controller; $emit(type: string, detail?: any, options?: Omit): boolean | void; disconnectedCallback(): void; attributeChangedCallback(name: string, oldValue: string, newValue: string): void; accessKey: string; readonly accessKeyLabel: string; autocapitalize: string; autocorrect: boolean; dir: string; draggable: boolean; hidden: boolean; inert: boolean; innerText: string; lang: string; readonly offsetHeight: number; readonly offsetLeft: number; readonly offsetParent: Element | null; readonly offsetTop: number; readonly offsetWidth: number; outerText: string; popover: string | null; spellcheck: boolean; title: string; translate: boolean; writingSuggestions: string; attachInternals(): ElementInternals; click(): void; hidePopover(): void; showPopover(): void; togglePopover(options?: boolean): boolean; addEventListener(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; removeEventListener(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; readonly attributes: NamedNodeMap; get classList(): DOMTokenList; set classList(value: string): any; className: string; readonly clientHeight: number; readonly clientLeft: number; readonly clientTop: number; readonly clientWidth: number; readonly currentCSSZoom: number; id: string; innerHTML: string; readonly localName: string; readonly namespaceURI: string | null; onfullscreenchange: (this: Element, ev: Event) => any; onfullscreenerror: (this: Element, ev: Event) => any; outerHTML: string; readonly ownerDocument: Document; get part(): DOMTokenList; set part(value: string): any; readonly prefix: string | null; readonly scrollHeight: number; scrollLeft: number; scrollTop: number; readonly scrollWidth: number; readonly shadowRoot: ShadowRoot | null; slot: string; readonly tagName: string; attachShadow(init: ShadowRootInit): ShadowRoot; checkVisibility(options?: CheckVisibilityOptions): boolean; closest(selector: K): HTMLElementTagNameMap[K]; closest(selector: K): SVGElementTagNameMap[K]; closest(selector: K): MathMLElementTagNameMap[K]; closest(selectors: string): E; computedStyleMap(): StylePropertyMapReadOnly; getAttribute(qualifiedName: string): string | null; getAttributeNS(namespace: string | null, localName: string): string | null; getAttributeNames(): string[]; getAttributeNode(qualifiedName: string): Attr | null; getAttributeNodeNS(namespace: string | null, localName: string): Attr | null; getBoundingClientRect(): DOMRect; getClientRects(): DOMRectList; getElementsByClassName(classNames: string): HTMLCollectionOf; getElementsByTagName(qualifiedName: K): HTMLCollectionOf; getElementsByTagName(qualifiedName: K): HTMLCollectionOf; getElementsByTagName(qualifiedName: K): HTMLCollectionOf; getElementsByTagName(qualifiedName: K): HTMLCollectionOf; getElementsByTagName(qualifiedName: string): HTMLCollectionOf; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf; getElementsByTagNameNS(namespace: string | null, localName: string): HTMLCollectionOf; getHTML(options?: GetHTMLOptions): string; hasAttribute(qualifiedName: string): boolean; hasAttributeNS(namespace: string | null, localName: string): boolean; hasAttributes(): boolean; hasPointerCapture(pointerId: number): boolean; insertAdjacentElement(where: InsertPosition, element: Element): Element | null; insertAdjacentHTML(position: InsertPosition, string: string): void; insertAdjacentText(where: InsertPosition, data: string): void; matches(selectors: string): boolean; releasePointerCapture(pointerId: number): void; removeAttribute(qualifiedName: string): void; removeAttributeNS(namespace: string | null, localName: string): void; removeAttributeNode(attr: Attr): Attr; requestFullscreen(options?: FullscreenOptions): Promise; requestPointerLock(options?: PointerLockOptions): Promise; scroll(options?: ScrollToOptions): void; scroll(x: number, y: number): void; scrollBy(options?: ScrollToOptions): void; scrollBy(x: number, y: number): void; scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void; scrollTo(options?: ScrollToOptions): void; scrollTo(x: number, y: number): void; setAttribute(qualifiedName: string, value: string): void; setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void; setAttributeNode(attr: Attr): Attr | null; setAttributeNodeNS(attr: Attr): Attr | null; setHTMLUnsafe(html: string): void; setPointerCapture(pointerId: number): void; toggleAttribute(qualifiedName: string, force?: boolean): boolean; webkitMatchesSelector(selectors: string): boolean; textContent: string; readonly baseURI: string; readonly childNodes: NodeListOf; readonly firstChild: ChildNode | null; readonly isConnected: boolean; readonly lastChild: ChildNode | null; readonly nextSibling: ChildNode | null; readonly nodeName: string; readonly nodeType: number; nodeValue: string | null; readonly parentElement: HTMLElement | null; readonly parentNode: ParentNode | null; readonly previousSibling: ChildNode | null; appendChild(node: T_1): T_1; compareDocumentPosition(other: Node): number; contains(other: Node | null): boolean; getRootNode(options?: GetRootNodeOptions): Node; hasChildNodes(): boolean; insertBefore(node: T_1, child: Node | null): T_1; isDefaultNamespace(namespace: string | null): boolean; isEqualNode(otherNode: Node | null): boolean; isSameNode(otherNode: Node | null): boolean; lookupNamespaceURI(prefix: string | null): string | null; lookupPrefix(namespace: string | null): string | null; normalize(): void; removeChild(child: T_1): T_1; replaceChild(node: Node, child: T_1): T_1; readonly ELEMENT_NODE: 1; readonly ATTRIBUTE_NODE: 2; readonly TEXT_NODE: 3; readonly CDATA_SECTION_NODE: 4; readonly ENTITY_REFERENCE_NODE: 5; readonly ENTITY_NODE: 6; readonly PROCESSING_INSTRUCTION_NODE: 7; readonly COMMENT_NODE: 8; readonly DOCUMENT_NODE: 9; readonly DOCUMENT_TYPE_NODE: 10; readonly DOCUMENT_FRAGMENT_NODE: 11; readonly NOTATION_NODE: 12; readonly DOCUMENT_POSITION_DISCONNECTED: 1; readonly DOCUMENT_POSITION_PRECEDING: 2; readonly DOCUMENT_POSITION_FOLLOWING: 4; readonly DOCUMENT_POSITION_CONTAINS: 8; readonly DOCUMENT_POSITION_CONTAINED_BY: 16; readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32; dispatchEvent(event: Event): boolean; ariaActiveDescendantElement: Element | null; ariaAtomic: string | null; ariaAutoComplete: string | null; ariaBrailleLabel: string | null; ariaBrailleRoleDescription: string | null; ariaBusy: string | null; ariaChecked: string | null; ariaColCount: string | null; ariaColIndex: string | null; ariaColIndexText: string | null; ariaColSpan: string | null; ariaControlsElements: ReadonlyArray | null; ariaCurrent: string | null; ariaDescribedByElements: ReadonlyArray | null; ariaDescription: string | null; ariaDetailsElements: ReadonlyArray | null; ariaDisabled: string | null; ariaErrorMessageElements: ReadonlyArray | null; ariaExpanded: string | null; ariaFlowToElements: ReadonlyArray | null; ariaHasPopup: string | null; ariaHidden: string | null; ariaInvalid: string | null; ariaKeyShortcuts: string | null; ariaLabel: string | null; ariaLabelledByElements: ReadonlyArray | null; ariaLevel: string | null; ariaLive: string | null; ariaModal: string | null; ariaMultiLine: string | null; ariaMultiSelectable: string | null; ariaOrientation: string | null; ariaOwnsElements: ReadonlyArray | null; ariaPlaceholder: string | null; ariaPosInSet: string | null; ariaPressed: string | null; ariaReadOnly: string | null; ariaRelevant: string | null; ariaRequired: string | null; ariaRoleDescription: string | null; ariaRowCount: string | null; ariaRowIndex: string | null; ariaRowIndexText: string | null; ariaRowSpan: string | null; ariaSelected: string | null; ariaSetSize: string | null; ariaSort: string | null; ariaValueMax: string | null; ariaValueMin: string | null; ariaValueNow: string | null; ariaValueText: string | null; role: string | null; animate(keyframes: Keyframe[] | PropertyIndexedKeyframes | null, options?: number | KeyframeAnimationOptions): Animation; getAnimations(options?: GetAnimationsOptions): Animation[]; after(...nodes: (Node | string)[]): void; before(...nodes: (Node | string)[]): void; remove(): void; replaceWith(...nodes: (Node | string)[]): void; readonly nextElementSibling: Element | null; readonly previousElementSibling: Element | null; readonly childElementCount: number; readonly children: HTMLCollection; readonly firstElementChild: Element | null; readonly lastElementChild: Element | null; append(...nodes: (Node | string)[]): void; prepend(...nodes: (Node | string)[]): void; querySelector(selectors: K): HTMLElementTagNameMap[K] | null; querySelector(selectors: K): SVGElementTagNameMap[K] | null; querySelector(selectors: K): MathMLElementTagNameMap[K] | null; querySelector(selectors: K): HTMLElementDeprecatedTagNameMap[K] | null; querySelector(selectors: string): E | null; querySelectorAll(selectors: K): NodeListOf; querySelectorAll(selectors: K): NodeListOf; querySelectorAll(selectors: K): NodeListOf; querySelectorAll(selectors: K): NodeListOf; querySelectorAll(selectors: string): NodeListOf; replaceChildren(...nodes: (Node | string)[]): void; readonly assignedSlot: HTMLSlotElement | null; readonly attributeStyleMap: StylePropertyMap; get style(): CSSStyleDeclaration; set style(cssText: string): any; contentEditable: string; enterKeyHint: string; inputMode: string; readonly isContentEditable: boolean; onabort: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null; onanimationcancel: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null; onanimationend: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null; onanimationiteration: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null; onanimationstart: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null; onauxclick: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; onbeforeinput: ((this: GlobalEventHandlers, ev: InputEvent) => any) | null; onbeforematch: ((this: GlobalEventHandlers, ev: Event) => any) | null; onbeforetoggle: ((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null; onblur: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null; oncancel: ((this: GlobalEventHandlers, ev: Event) => any) | null; oncanplay: ((this: GlobalEventHandlers, ev: Event) => any) | null; oncanplaythrough: ((this: GlobalEventHandlers, ev: Event) => any) | null; onchange: ((this: GlobalEventHandlers, ev: Event) => any) | null; onclick: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; onclose: ((this: GlobalEventHandlers, ev: Event) => any) | null; oncontextlost: ((this: GlobalEventHandlers, ev: Event) => any) | null; oncontextmenu: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; oncontextrestored: ((this: GlobalEventHandlers, ev: Event) => any) | null; oncopy: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null; oncuechange: ((this: GlobalEventHandlers, ev: Event) => any) | null; oncut: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null; ondblclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; ondrag: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; ondragend: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; ondragenter: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; ondragleave: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; ondragover: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; ondragstart: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; ondrop: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; ondurationchange: ((this: GlobalEventHandlers, ev: Event) => any) | null; onemptied: ((this: GlobalEventHandlers, ev: Event) => any) | null; onended: ((this: GlobalEventHandlers, ev: Event) => any) | null; onerror: OnErrorEventHandler; onfocus: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null; onformdata: ((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null; ongotpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; oninput: ((this: GlobalEventHandlers, ev: Event) => any) | null; oninvalid: ((this: GlobalEventHandlers, ev: Event) => any) | null; onkeydown: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null; onkeypress: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null; onkeyup: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null; onload: ((this: GlobalEventHandlers, ev: Event) => any) | null; onloadeddata: ((this: GlobalEventHandlers, ev: Event) => any) | null; onloadedmetadata: ((this: GlobalEventHandlers, ev: Event) => any) | null; onloadstart: ((this: GlobalEventHandlers, ev: Event) => any) | null; onlostpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; onmousedown: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; onmouseenter: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; onmouseleave: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; onmousemove: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; onmouseout: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; onmouseover: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; onmouseup: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; onpaste: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null; onpause: ((this: GlobalEventHandlers, ev: Event) => any) | null; onplay: ((this: GlobalEventHandlers, ev: Event) => any) | null; onplaying: ((this: GlobalEventHandlers, ev: Event) => any) | null; onpointercancel: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; onpointerdown: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; onpointerenter: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; onpointerleave: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; onpointermove: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; onpointerout: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; onpointerover: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; onpointerrawupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null; onpointerup: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; onprogress: ((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null; onratechange: ((this: GlobalEventHandlers, ev: Event) => any) | null; onreset: ((this: GlobalEventHandlers, ev: Event) => any) | null; onresize: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null; onscroll: ((this: GlobalEventHandlers, ev: Event) => any) | null; onscrollend: ((this: GlobalEventHandlers, ev: Event) => any) | null; onsecuritypolicyviolation: ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null; onseeked: ((this: GlobalEventHandlers, ev: Event) => any) | null; onseeking: ((this: GlobalEventHandlers, ev: Event) => any) | null; onselect: ((this: GlobalEventHandlers, ev: Event) => any) | null; onselectionchange: ((this: GlobalEventHandlers, ev: Event) => any) | null; onselectstart: ((this: GlobalEventHandlers, ev: Event) => any) | null; onslotchange: ((this: GlobalEventHandlers, ev: Event) => any) | null; onstalled: ((this: GlobalEventHandlers, ev: Event) => any) | null; onsubmit: ((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null; onsuspend: ((this: GlobalEventHandlers, ev: Event) => any) | null; ontimeupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null; ontoggle: ((this: GlobalEventHandlers, ev: ToggleEvent) => any) | null; ontouchcancel?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined; ontouchend?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined; ontouchmove?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined; ontouchstart?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined; ontransitioncancel: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null; ontransitionend: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null; ontransitionrun: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null; ontransitionstart: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null; onvolumechange: ((this: GlobalEventHandlers, ev: Event) => any) | null; onwaiting: ((this: GlobalEventHandlers, ev: Event) => any) | null; onwebkitanimationend: ((this: GlobalEventHandlers, ev: Event) => any) | null; onwebkitanimationiteration: ((this: GlobalEventHandlers, ev: Event) => any) | null; onwebkitanimationstart: ((this: GlobalEventHandlers, ev: Event) => any) | null; onwebkittransitionend: ((this: GlobalEventHandlers, ev: Event) => any) | null; onwheel: ((this: GlobalEventHandlers, ev: WheelEvent) => any) | null; autofocus: boolean; readonly dataset: DOMStringMap; nonce?: string; tabIndex: number; blur(): void; focus(options?: FocusOptions): void; }) & typeof FoundationElement; /** * The Grid Pro element (AG Grid v35 compatible). * @remarks Grid Pro is a Web Component wrapper around the AG Grid Community library. * @beta * @tagname %%prefix%%-grid-pro * * @fires gridReady - Fired when AG Grid is ready (detail includes the grid-ready event and grid id) * @fires onGridReady - Deprecated alias for the grid-ready signal; prefer `gridReady` * @fires gridready - Native `Event` from `globalEventListener` when AG Grid fires `gridReady` (`agGridDetails` holds the AG Grid event) * @remarks Re-emits AG Grid public API events when listeners are registered via `addEventListener` (event names match AG Grid public event strings). The same AG Grid events are also dispatched as native `Event`s with lowercased `type` and payload on `agGridDetails` (for example `addEventListener('columnresized', ...)`). */ export declare class GridProBeta extends GridProBeta_base { gridApi: GridApi; gridErrorItems: GridProErrorItem[]; statePersistence: StatePersistence; /** * Timeout function used to debounce resize calls * @internal */ private debounced; private disposed; private readonly debouncedSaveColumnState; private readonly debouncedSaveFilterModel; autoCellRendererByType: boolean; onlyTemplateColDefs: boolean; /** * Boolean attribute to control whether the grid autosizes the columns upon interaction. * This will disable the column widths from being manually set, and doesn't save the widths * in local storage if you are using `persist-column-state-key`. */ gridAutosizingEnabled: boolean; /** * If false, will disable cell flashing for all cells by default, unless otherwise defined in custom colDef * @remarks Defaults to true */ enableCellFlashing: boolean; /** * If true, will enable row flashing for all rows for `add` async transactions */ enableRowFlashing: boolean; /** * The key to use for persisting the column state in local browser or KV storage. */ persistColumnStateKey: string; /** * The key to use for persisting the filter model in local browser or KV storage. */ persistFilterModelKey: string; /** * The case type to use for the header names. If not set, the default CONSTANT_CASE will be used. * @remarks Can be one of the following: camelCase, capitalCase, dotCase, headerCase, noCase, paramCase, pascalCase, pathCase, sentenceCase, snakeCase. * @public */ headerCaseType: GridProCaseType; /** * The row data to display in the grid. * @remarks For scenarios where you want to set data manually, without relying on ``. * @public */ rowData: any[]; rowDataChanged(_: any, rowData: any): void; columnComponentName: string; eventsAndCallbacks: GridProEventsAndCallbacks; headerHeight: number; rowHeight: number; classNames: string; agGrid: GridApi; gridSlot: HTMLSlotElement; themeMode: 'light' | 'dark'; gridComponents: { [componentName: string]: any; }; /** * Enable pagination for the grid. * @remarks * When enabled, the grid will automatically configure pagination settings. * Note that AG Grid's full pagination functionality requires the Enterprise module. * While basic pagination will work in Community edition, advanced features like * custom pagination components require Enterprise. * @see https://www.ag-grid.com/javascript-data-grid/row-pagination/ * @see https://www.ag-grid.com/javascript-data-grid/server-side-model-pagination/ */ pagination: boolean; /** * Number of rows per page when pagination is enabled. * @remarks * **Default Value:** `DatasourceDefaults.DEFAULT_PAGINATION_PAGE_SIZE (25)` (default MAX_ROWS divided by 10) * * **Only used when pagination is enabled on client-side, server-side pagination page size is fixed to MAX_ROWS.** * * Note that AG Grid's full pagination functionality requires the Enterprise module. */ paginationPageSize: number; /** * Configuration for the grid status bar components. * @remarks * This requires AG Grid Enterprise module to be enabled. * The status bar will only be displayed if the Enterprise module is available. * @see https://www.ag-grid.com/javascript-data-grid/component-status-bar/ */ statusBarConfig: GridProStatusBarConfig; /** * Enables or disables the grid status bar. * @remarks * Default is false. * When disabled, no status bar will be displayed regardless of statusBarConfig. * This requires AG Grid Enterprise module to be available for the status bar to be displayed when enabled. */ withStatusBar: boolean; /** * Custom error handler dialog template function. * @remarks * When provided, this function will be used to render custom error dialogs instead of the default error handler. * The function should accept a prefix string and an array of grid error items and return a ViewTemplate. * If not provided, the default error handler dialog template will be used. */ customErrorHandlerTemplate?: (prefix: string, gridErrorItems: GridProErrorItem[]) => ViewTemplate; private columnState; protected agAttributes: Record; protected agPropertiesMap: Record; protected agGridOptions: GridOptions; /** User-supplied grid options cached as merge base for datasource re-init. */ private userProvidedGridOptions; private applyingDatasourceGridOptions; protected initialised: boolean; private rehydrationAttempted; private rootEventsListeners; private datasourceEventHandlers; private gridEventsQueue; private registeredGridEvents; private gridEventListeners; private luminanceSubscription?; private visibilityObserverCleanup?; private readonly boundGlobalEventListener; private _filterConfig; getfilterModel(): Promise<{ [key: string]: any; }>; setFilterModel(value: { [key: string]: any; }): Promise; /** * Injectable config that allows to change grid options on an app level basis * To modify options, register instance of the config in DOM container that is * above the grid or on the top level of the application, so it applies to all grids. * * @example * ``` * DI.getOrCreateDOMContainer().register([ * Registration.instance(GridOptionsConfig, { * headerHeight: 50, * }), * ]); * ``` */ gridOptionsConfig: GridOptionsConfig; provider: any; constructor(); /** * Adds an event listener to the grid element. * @param eventType - The event type to listen for. Recommened to use the `Events` from AG Grid. * @param listener - The event listener to call when the event is fired. * @param options - An options object that specifies characteristics about the event listener. * @privateRemarks * This will change once we do the AG Upgrade and `eventType` will be correctly typed. */ addEventListener(eventType: string, listener: any, options?: boolean | AddEventListenerOptions): void; private addGridEventListener; private handleError; private handleBaseDatasourceError; hideDatasourceError(): void; private handleLuminanceChange; private readonly luminanceObserver; connectedCallback(): void; disconnectedCallback(): void; private performDisconnectCleanup; private destroyGridInstance; /** * Helper method to add or remove datasource event listeners * @internal */ private toggleDatasourceEventListeners; /** * Handles datasource initialization * @internal */ private handleInitialize; /** * Handles data loading from datasource * @internal */ private handleDataLoaded; /** * Handles data changes from datasource * @internal */ private handleDataChanged; private flashAddedCells; /** * Handles schema updates from datasource * @internal */ private handleSchemaUpdated; /** * Handles data clearing from datasource * @internal */ private handleDataCleared; /** * Handles loading started from datasource * @internal */ private handleLoadingStarted; /** * Handles loading finished from datasource * @internal */ private handleLoadingFinished; /** * Handles no data available from datasource * @internal */ private handleNoDataAvailable; /** * Handles filter restoration from datasource * @internal */ private handleFiltersRestored; /** * Handles more data availability from datasource * @internal */ private handleMoreDataAvailable; /** * Handles datasource errors * @internal */ private handleDatasourceError; /** * Handles datasource destroy * @internal */ private handleDatasourceDestroy; /** * Handles refreshing server-side data * @internal */ private handleRefreshServerSide; /** * Handles setting server-side datasource * @internal */ private handleSetServerSideDatasource; /** * Handles adding CSS class to grid element * @internal */ private handleAddGridCssClass; /** * Handles removing CSS class from grid element * @internal */ private handleRemoveGridCssClass; /** * Handles applying server-side transactions * @internal */ private handleApplyServerSideTransaction; combineAllGridComponents(gridOptionsComponents: GridComponents): GridComponents; statePersistanceEnabled(): boolean; /** * Gets the currently selected rows from the grid * @public * @returns Array of selected row data */ getSelectedRows(): any[]; /** * Gets the row data from selected cell ranges * @internal * @returns Array containing the row data from selected cell ranges, or empty array if none */ private getCellRangeRowData; /** * Checks if any rows are currently selected * @public * @returns True if rows are selected, false otherwise */ hasSelectedRows(): boolean; /** * Updates the label-value status bar component with new label and value * @public * @param params - Object containing label, value, and optionally hide flag * @example * ```ts * gridPro.updateLabelValueStatusBar({ * label: 'Total Records', * value: '1,234', * hide: false * }); * ``` */ updateLabelValueStatusBar(params: GridProStatusBarLabelConfig): void; /** * Because we try and resize the grid to fit using callbacks on events, this will cause * a stack overflow of calls to resize, so we need to debounce it. * @internal */ private debouncedColumnAutosize; /** * If {@link @genesislcap/grid-pro#GridPro.gridAutosizingEnabled} is true, will remove the widths from the column states. * @internal */ private removeConfigWidthsToAutosize; private saveColumnState; /** * Gets the saved grid ColumnState[] from storage * @remarks This is used to restore the grid state when the grid is rehydrated * @privateRemarks Not using `columnApi.get|setColumnState()` for these flows as it doesn't work setting new columnDefs vs different ordering. * @public */ getSavedColumnState(): Promise; private restoreColumnState; cacheFilterConfig(): void; restoreCachedFilterConfig(): Promise; /** * @public */ get gridOptions(): GridOptions; /** * @public */ get isServerSide(): boolean; /** * @public */ get gridParams(): GridParams; /** * Get the datasource element. * @remarks This will return the first datasource element found in the light DOM, wrapping all concrete datasource implementations. * @public */ get gridProDatasource(): GridProBaseDatasource; set gridOptions(options: GridOptions); private setLocalGridOptions; /** * Clears the local grid options, this is used to clear the grid options when the grid is restarted. * @public */ clearLocalGridOptions(): void; private resetGridOptionsState; private initGrid; /** * Will merge templated column definitions with `columnDefs` plus localStorage's column state or `deferredColumnStates`. * @public * @remarks This will favor the column state from the browser's local storage over the `deferredColumnStates` property on the `grid-pro-genesis-datasource` element. * @param columnDefs - The column definitions to apply to the grid. * @param deferredColumnDefsOrState - If true, will merge the column definitions with the saved column state or the `deferredColumnStates` property * on the `grid-pro-genesis-datasource` element. Defaults to false but `grid-pro-genesis-datasource` will set this to true. * @returns The merged column definitions. */ mergeAllColumnDefsAndStates(columnDefs: ColDef[], deferredColumnDefsOrState?: boolean): Promise<(import("@ag-grid-community/core").ColDef | import("@ag-grid-community/core").ColGroupDef)[] | (ColDef | { colId?: string; field?: string; type?: string | string[]; valueGetter?: string | import("@ag-grid-community/core").ValueGetterFunc | import("ag-grid-community").ValueGetterFunc; valueFormatter?: string | import("@ag-grid-community/core").ValueFormatterFunc | import("ag-grid-community").ValueFormatterFunc; refData?: { [key: string]: string; }; keyCreator?: ((params: import("@ag-grid-community/core").KeyCreatorParams) => string) | ((params: import("ag-grid-community").KeyCreatorParams) => string); equals?: (valueA: any, valueB: any) => boolean; tooltipField?: string; tooltipValueGetter?: ((params: import("@ag-grid-community/core").ITooltipParams) => string | any) | ((params: import("ag-grid-community").ITooltipParams) => string | any); checkboxSelection?: boolean | import("@ag-grid-community/core").CheckboxSelectionCallback | import("ag-grid-community").CheckboxSelectionCallback; showDisabledCheckboxes?: boolean; icons?: { [key: string]: string | Function; }; suppressNavigable?: boolean | import("@ag-grid-community/core").SuppressNavigableCallback | import("ag-grid-community").SuppressNavigableCallback; suppressKeyboardEvent?: ((params: import("@ag-grid-community/core").SuppressKeyboardEventParams) => boolean) | ((params: import("ag-grid-community").SuppressKeyboardEventParams) => boolean); suppressPaste?: boolean | import("@ag-grid-community/core").SuppressPasteCallback | import("ag-grid-community").SuppressPasteCallback; suppressFillHandle?: boolean; hide?: boolean | null; initialHide?: boolean; lockVisible?: boolean; lockPosition?: boolean | "left" | "right"; suppressMovable?: boolean; editable?: boolean | import("@ag-grid-community/core").EditableCallback | import("ag-grid-community").EditableCallback; valueSetter?: string | import("@ag-grid-community/core").ValueSetterFunc | import("ag-grid-community").ValueSetterFunc; valueParser?: string | import("@ag-grid-community/core").ValueParserFunc | import("ag-grid-community").ValueParserFunc; cellEditor?: any; cellEditorFramework?: any; cellEditorParams?: any; cellEditorSelector?: import("@ag-grid-community/core").CellEditorSelectorFunc | import("ag-grid-community").CellEditorSelectorFunc; singleClickEdit?: boolean; cellEditorPopup?: boolean; cellEditorPopupPosition?: "over" | "under"; onCellValueChanged?: ((event: import("@ag-grid-community/core").NewValueParams) => void) | ((event: import("ag-grid-community").NewValueParams) => void); onCellClicked?: ((event: import("@ag-grid-community/core").CellClickedEvent) => void) | ((event: import("ag-grid-community").CellClickedEvent) => void); onCellDoubleClicked?: ((event: import("@ag-grid-community/core").CellDoubleClickedEvent) => void) | ((event: import("ag-grid-community").CellDoubleClickedEvent) => void); onCellContextMenu?: ((event: import("@ag-grid-community/core").CellContextMenuEvent) => void) | ((event: import("ag-grid-community").CellContextMenuEvent) => void); getQuickFilterText?: ((params: import("@ag-grid-community/core").GetQuickFilterTextParams) => string) | ((params: import("ag-grid-community").GetQuickFilterTextParams) => string); filterValueGetter?: string | import("@ag-grid-community/core").ValueGetterFunc | import("ag-grid-community").ValueGetterFunc; floatingFilter?: boolean; wrapHeaderText?: boolean; autoHeaderHeight?: boolean; headerComponent?: any; headerComponentFramework?: any; headerComponentParams?: any; menuTabs?: import("@ag-grid-community/core").ColumnMenuTab[]; columnsMenuParams?: import("@ag-grid-community/core").ColumnsMenuParams; suppressMenu?: boolean; headerCheckboxSelection?: boolean | import("@ag-grid-community/core").HeaderCheckboxSelectionCallback | import("ag-grid-community").HeaderCheckboxSelectionCallback; headerCheckboxSelectionFilteredOnly?: boolean; headerCheckboxSelectionCurrentPageOnly?: boolean; chartDataType?: "category" | "series" | "time" | "excluded"; pinned?: boolean | "left" | "right" | null; initialPinned?: boolean | "left" | "right"; lockPinned?: boolean; pivot?: boolean | null; initialPivot?: boolean; pivotIndex?: number | null; initialPivotIndex?: number; pivotComparator?: (valueA: string, valueB: string) => number; enablePivot?: boolean; cellStyle?: import("@ag-grid-community/core").CellStyle | import("@ag-grid-community/core").CellStyleFunc | import("ag-grid-community").CellStyleFunc; cellClass?: string | string[] | import("@ag-grid-community/core").CellClassFunc | import("ag-grid-community").CellClassFunc; cellClassRules?: import("@ag-grid-community/core").CellClassRules | import("ag-grid-community").CellClassRules; cellRenderer?: any; cellRendererFramework?: any; cellRendererParams?: any; cellRendererSelector?: import("@ag-grid-community/core").CellRendererSelectorFunc | import("ag-grid-community").CellRendererSelectorFunc; autoHeight?: boolean; wrapText?: boolean; enableCellChangeFlash?: boolean; suppressCellFlash?: boolean; rowDrag?: boolean | import("@ag-grid-community/core").RowDragCallback | import("ag-grid-community").RowDragCallback; rowDragText?: ((params: import("@ag-grid-community/core").IRowDragItem, dragItemCount: number) => string) | ((params: import("ag-grid-community").IRowDragItem, dragItemCount: number) => string); dndSource?: boolean | import("@ag-grid-community/core").DndSourceCallback | import("ag-grid-community").DndSourceCallback; dndSourceOnRowDrag?: ((params: import("@ag-grid-community/core").DndSourceOnRowDragParams) => void) | ((params: import("ag-grid-community").DndSourceOnRowDragParams) => void); rowGroup?: boolean | null; initialRowGroup?: boolean; rowGroupIndex?: number | null; initialRowGroupIndex?: number; enableRowGroup?: boolean; enableValue?: boolean; aggFunc?: string | import("@ag-grid-community/core").IAggFunc | import("ag-grid-community").IAggFunc; initialAggFunc?: string | import("@ag-grid-community/core").IAggFunc | import("ag-grid-community").IAggFunc; defaultAggFunc?: string; allowedAggFuncs?: string[]; showRowGroup?: string | boolean; sortable?: boolean; sort?: "asc" | "desc" | import("ag-grid-community").SortDef; initialSort?: "asc" | "desc" | import("ag-grid-community").SortDef; sortIndex?: number | null; initialSortIndex?: number; sortingOrder?: (import("ag-grid-community").SortDirection | import("ag-grid-community").SortDef)[]; comparator?: ((valueA: any, valueB: any, nodeA: import("@ag-grid-community/core").IRowNode, nodeB: import("@ag-grid-community/core").IRowNode, isDescending: boolean) => number) | import("ag-grid-community/dist/types/src/entities/colDef").SortComparatorFn | Partial>>; unSortIcon?: boolean; colSpan?: ((params: import("@ag-grid-community/core").ColSpanParams) => number) | ((params: import("ag-grid-community").ColSpanParams) => number); rowSpan?: ((params: import("@ag-grid-community/core").RowSpanParams) => number) | ((params: import("ag-grid-community").RowSpanParams) => number); width?: number; initialWidth?: number; minWidth?: number; maxWidth?: number; flex?: number | null; initialFlex?: number; resizable?: boolean; suppressSizeToFit?: boolean; suppressAutoSize?: boolean; pivotValueColumn?: import("@ag-grid-community/core").Column | import("ag-grid-community").Column; pivotTotalColumnIds?: string[]; spanHeaderHeight?: boolean; headerName?: string; headerValueGetter?: string | import("@ag-grid-community/core").HeaderValueGetterFunc | import("ag-grid-community").HeaderValueGetterFunc; headerTooltip?: string; headerClass?: string | string[] | ((params: import("@ag-grid-community/core").HeaderClassParams) => string | string[] | undefined) | ((params: import("ag-grid-community").HeaderClassParams) => string | string[] | undefined); suppressHeaderKeyboardEvent?: ((params: import("@ag-grid-community/core").SuppressHeaderKeyboardEventParams) => boolean) | ((params: import("ag-grid-community").SuppressHeaderKeyboardEventParams) => boolean); columnGroupShow?: "open" | "closed"; toolPanelClass?: string | string[] | ((params: import("@ag-grid-community/core").ToolPanelClassParams) => string | string[] | undefined) | ((params: import("ag-grid-community").ToolPanelClassParams) => string | string[] | undefined); suppressColumnsToolPanel?: boolean; suppressFiltersToolPanel?: boolean; tooltipComponent?: any; tooltipComponentFramework?: any; tooltipComponentParams?: any; pivotKeys?: string[]; filter?: any; filterFramework?: any; filterParams?: any; floatingFilterComponent?: any; floatingFilterComponentFramework?: any; floatingFilterComponentParams?: any; cellDataType?: boolean | string; allowFormula?: boolean; tooltipComponentSelector?: import("ag-grid-community").CellEditorSelectorFunc | import("ag-grid-community").CellRendererSelectorFunc; useValueFormatterForExport?: boolean; useValueParserForImport?: boolean; suppressFloatingFilterButton?: boolean; dateComponent?: any; dateComponentParams?: any; getFindText?: import("ag-grid-community").GetFindTextFunc; columnChooserParams?: import("ag-grid-community").ColumnChooserParams; suppressHeaderMenuButton?: boolean; suppressHeaderFilterButton?: boolean; mainMenuItems?: import("ag-grid-community").GetMainMenuItems | (import("ag-grid-community").MenuItemDef | import("ag-grid-community").DefaultMenuItem)[]; contextMenuItems?: import("ag-grid-community").GetContextMenuItems | (import("ag-grid-community").MenuItemDef | import("ag-grid-community").DefaultMenuItem)[]; loadingCellRenderer?: any; loadingCellRendererParams?: any; loadingCellRendererSelector?: import("ag-grid-community").ILoadingCellRendererSelectorFunc; rowGroupingHierarchy?: (string | ColDef)[]; groupHierarchy?: (string | ColDef)[]; spanRows?: boolean | ((params: import("ag-grid-community").SpanRowsParams) => boolean); suppressSpanHeaderHeight?: boolean; headerTooltipValueGetter?: (params: import("ag-grid-community").ITooltipParams) => string | any; headerStyle?: import("ag-grid-community").HeaderStyle | import("ag-grid-community").HeaderStyleFunc; cellAriaRole?: string; context?: any; suppressHeaderContextMenu?: boolean; })[]>; private panelExists; private addRowCountPanel; private addMaxRowsPanel; private addAggregationPanel; private addDatasourcePanels; private addPaginationPanel; protected setupPaginationAndStatusBar(gridOptions: GridOptions): void; get observedAttributes(): string[]; agAttributeChangedCallback(attName: any, oldValue: any, newValue: any): void; globalEventListener(eventType: any, event: any): void; } export {}; //# sourceMappingURL=grid-pro-beta.d.ts.map