Grid Configurator
For calculation input policies, defaults, execution pins, count meanings and numeric limits, see Aggregation policies. Signatures below describe the current supported exports; a server capability advertisement does not establish equivalent local/server results.
Module Extensions
Section titled “Module Extensions”HTMLRevoGridElement (Extended from global)
Section titled “HTMLRevoGridElement (Extended from global)”interface HTMLRevoGridElement { gridConfigurator?: GridConfiguratorConfig; /** * Enable accessibility. If disabled, the grid will not be accessible. * @default true */ "accessible": boolean; /** * Add trimmed by type */ "addTrimmed": (trimmed: Record<number, boolean>, trimmedType?: string, type?: DimensionRows) => Promise<CustomEvent<{ trimmed: Record<number, boolean>; trimmedType: string; type: string; }>>; /** * Additional data to be passed to plugins, renders or editors. For example if you need to pass Vue component instance. * @default {} */ "additionalData": AdditionalData; /** * Apply changes in editor when closed except 'Escape' cases. If custom editor in use method getValue required. Check interfaces.d.ts `EditorBase` for more info. * @default false */ "applyOnClose": boolean; /** * Autosize config. Enables columns autoSize. For more details check `autoSizeColumn` plugin. By default disabled, hence operation is not performance efficient. `true` to enable with default params (double header separator click for autosize). Or define config. See `AutoSizeColumnConfig` for more details. * @default false */ "autoSizeColumn": boolean | AutoSizeColumnConfig; /** * Disable native drag&drop plugin. * @default true */ "canDrag": boolean; /** * When true cell focus appear. * @default true */ "canFocus": boolean; /** * Enable column move plugin. * @default false */ "canMoveColumns": boolean; /** * Clear current grid focus. Grid has no longer focus on it. */ "clearFocus": () => Promise<void>; /** * Clears column sorting */ "clearSorting": () => Promise<void>; /** * Indicates default column size. * @default 100 */ "colSize": number; /** * Column Types Format. Every type represent multiple column properties. Types will be merged but can be replaced with column properties. Types were made as separate objects to be reusable per multiple columns. * @default {} */ "columnTypes": { [name: string]: ColumnType }; /** * Columns - defines an array of grid columns. Can be column or grouped column. * @default [] */ "columns": (ColumnRegular | ColumnGrouping)[]; /** * Disable lazy rendering mode for the `X axis`. Use when not many columns present and you don't need rerenader cells during scroll. Can be used for initial rendering performance improvement. * @default false */ "disableVirtualX": boolean; /** * Disable lazy rendering mode for the `Y axis`. Use when not many rows present and you don't need rerenader cells during scroll. Can be used for initial rendering performance improvement. * @default false */ "disableVirtualY": boolean; /** * Custom editors register. * @default {} */ "editors": Editors; /** * Enable export plugin. * @default false */ "exporting": boolean; /** * Enables filter plugin. Disabled by default; set to `true` or a configuration object to enable. Can be boolean. Or can be filter collection See `FilterCollection` for more info. * @default false */ "filter": boolean | ColumnFilterConfig; /** * Apply changes typed in editor on editor close except Escape cases. If custom editor in use method `getValue` required. Check `interfaces.d.ts` `EditorBase` for more info. */ "focusTemplate": FocusTemplateFunc; /** * Defines how many rows/columns should be rendered outside visible area. * @default 1 */ "frameSize": number; /** * Provides access to column internal store observer Can be used for plugin support * @param type - type of column */ "getColumnStore": (type?: DimensionCols) => Promise<Observable<DSourceState<ColumnRegular, DimensionCols>>>; /** * Receive all columns in data source */ "getColumns": () => Promise<ColumnRegular[]>; /** * Get size of content Including all pinned data */ "getContentSize": () => Promise<Cell>; /** * Get the currently focused cell. */ "getFocused": () => Promise<FocusedData | null>; /** * Get all active plugins instances */ "getPlugins": () => Promise<PluginBaseComponent[]>; /** * Get all providers for grid Useful for external grid integration */ "getProviders": () => Promise<PluginProviders | undefined>; /** * Get the currently selected Range. */ "getSelectedRange": () => Promise<(RangeArea & AllDimensionType) | null>; /** * Get data from source */ "getSource": (type?: DimensionRows) => Promise<DataType[]>; /** * Provides access to rows internal store observer Can be used for plugin support * @param type - type of source */ "getSourceStore": (type?: DimensionRows) => Promise<Observable<DSourceState<DataType, DimensionRows>>>; /** * Get data from visible part of source Trimmed/filtered rows will be excluded * @param type - type of source */ "getVisibleSource": (type?: DimensionRows) => Promise<any[]>; /** * Group rows based on this property. Define properties to be groped by grouping plugin See `GroupingOptions`. */ "grouping": GroupingOptions; /** * Please only hide the attribution if you are subscribed to Pro version * @default false */ "hideAttribution": boolean; /** * Prevent rendering until job is done. Can be used for initial rendering performance improvement. When several plugins require initial rendering this will prevent double initial rendering. * @default [] */ "jobsBeforeRender": Promise<any>[]; /** * Prevents horizontal scroll state from being mirrored across viewport sections. * @default false */ "noHorizontalScrollTransfer": boolean; /** * Pinned bottom Source: {[T in ColumnProp]: any} - defines pinned bottom rows data source. * @default [] */ "pinnedBottomSource": DataType[]; /** * Pinned top Source: {[T in ColumnProp]: any} - defines pinned top rows data source. * @default [] */ "pinnedTopSource": DataType[]; /** * Custom grid plugins. Can be added or removed at runtime. Every plugin should be inherited from BasePlugin class. For more details check [Plugin guide](https://rv-grid.com/guide/plugin/) * @default [] */ "plugins": GridPlugin[]; /** * When true, user can select a cell range. Required for range-based clipboard fill. * @default false */ "range": boolean; /** * When true, grid in read only mode. * @default false */ "readonly": boolean; /** * Refreshes data viewport. Can be specific part as rgRow or pinned rgRow or 'all' by default. */ "refresh": (type?: DimensionRows | "all") => Promise<void>; /** * Refresh extra elements. Triggers re-rendering of extra elements and functions. Part of extraElements and registerVNode methods. Useful for plugins. */ "refreshExtraElements": () => Promise<void>; /** * Register new virtual node inside of grid. Used for additional items creation such as plugin elements. Should be set before grid render inside of plugins. Can return VNode result of h() function or a function that returns VNode. Function can be used for performance improvement and additional renders. * @default [] */ "registerVNode": ( | VNode | ((c: ExtraNodeFuncConfig) => VNode) )[]; /** * When true, columns are resizable. * @default false */ "resize": boolean; /** * Enables row resizing. Pass a configuration object to customize the height limits or enable resize edges across the full row. * @default false */ "resizeRow": boolean | RowResizeConfig; /** * Row class property mapping. Map custom classes to rows from row object data. Define this property in rgRow object and this will be mapped as rgRow class. * @default '' */ "rowClass": string; /** * Custom row properies to be applied. See `RowDefinition` for more info. * @default [] */ "rowDefinitions": RowDefinition[]; /** * Excel like functionality. Show row numbers. Also can be used for custom row header render if object provided. */ "rowHeaders": RowHeaders | boolean; /** * Indicates default rgRow size. By default 0, means theme package size will be applied Alternatively you can use `rowSize` to reset viewport * @default 0 */ "rowSize": number; /** * Enable right-to-left (RTL) mode. When enabled, columns will be displayed from right to left. * @default false */ "rtl": boolean; /** * Scrolls viewport to specified column by index. */ "scrollToColumnIndex": (coordinate?: number) => Promise<void>; /** * Scrolls viewport to specified column by prop */ "scrollToColumnProp": (prop: ColumnProp, dimension?: DimensionTypeCol) => Promise<void>; /** * Scrolls view port to coordinate */ "scrollToCoordinate": (cell: Partial<Cell>) => Promise<void>; /** * Scrolls viewport to specified row by index. */ "scrollToRow": (coordinate?: number) => Promise<void>; /** * Open editor for cell. */ "setCellEdit": (rgRow: number, prop: ColumnProp, rowSource?: DimensionRows) => Promise<void>; /** * Set focus range. */ "setCellsFocus": (cellStart?: Cell, cellEnd?: Cell, colType?: string, rowType?: string) => Promise<void>; /** * Refreshes data at specified cell. Useful for performance optimization. No viewport update will be triggered. * @example const grid = document.querySelector('revo-grid'); grid.setDataAt({ row: 0, col: 0, val: 'test' }); // refresh */ "setDataAt": ({ row, col, colType, rowType, val, skipDataUpdate }: { row: number; col: number; val?: any; skipDataUpdate?: boolean; } & AllDimensionType) => Promise<void | undefined>; /** * Alternative way to set sorting. `{columns: [{prop: 'name', order: 'asc'}]}` Use SortingPlugin to get current sorting state */ "sorting"?: SortingConfig; /** * Source - defines main data source. Can be an Object or 2 dimensional array([][]); Keys/indexes referenced from columns Prop. * @default [] */ "source": DataType[]; /** * Stretch strategy for columns by `StretchColumn` plugin. For example if there are more space on the right last column size would be increased. * @default false */ "stretch": boolean | string; /** * Theme name. * @default 'default' */ "theme": string; /** * Per-grid custom theme definitions. Assign as a JavaScript property; complex values cannot be serialized as HTML attributes. * @default [] */ "themeDefinitions": ThemeDefinition[]; /** * Trimmed rows. Functionality which allows to hide rows from main data set. `trimmedRows` are physical `rgRow` indexes to hide. * @default {} */ "trimmedRows": Record<number, boolean>; /** * Update column sorting * @param column - column prop and cellCompare * @param order - order to apply * @param additive - if false will replace current order later passed to SortingPlugin */ "updateColumnSorting": (column: Pick<ColumnRegular, "prop" | "cellCompare">, order: "asc" | "desc" | undefined, additive: boolean) => Promise<void>; /** * Update columns */ "updateColumns": (cols: ColumnRegular[]) => Promise<void>; /** * When true enable clipboard. Can be boolean or clipboard config. * @default true */ "useClipboard": boolean | ClipboardConfig; /** * Column dimensions that use X axis virtual rendering. Defaults to regular columns only to preserve pinned column behavior. Set to `['rgCol', 'colPinStart', 'colPinEnd']` to virtualize all column areas. * @default ['rgCol'] */ "virtualX": DimensionCols[]; /** Reactive declarative formats consumed by DataGridFormattingPlugin. */ dataGridFormatting?: DataGridFormattingPresetState; dataGridFormattingPanel?: DataGridFormattingPanelSetting; /** * Direct event manager configuration. */ eventManager?: EventManagerConfig; quickFilter?: QuickFilterInput; filterBadges?: AdvancedFilterBadgesConfig; /** * Direct row auto-size configuration. */ rowAutoSize?: RowAutoSizeConfig; /** * Direct row striping configuration. */ rowOdd?: RowOddInput; /** * Direct infinity-scroll configuration. */ infinityScroll?: Partial<InfinityScrollConfig>; pivot?: Partial<PivotConfig>; pivotCharts?: PivotChartsConfig; pivotChartsUi?: PivotChartsUiConfig; componentOnReady(): Promise<this>; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKey) */ accessKey: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/accessKeyLabel) */ readonly accessKeyLabel: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autocapitalize) */ autocapitalize: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dir) */ dir: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/draggable) */ draggable: boolean; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidden) */ hidden: boolean; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inert) */ inert: boolean; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/innerText) */ innerText: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/lang) */ lang: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetHeight) */ readonly offsetHeight: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetLeft) */ readonly offsetLeft: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetParent) */ readonly offsetParent: Element | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetTop) */ readonly offsetTop: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/offsetWidth) */ readonly offsetWidth: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/outerText) */ outerText: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/popover) */ popover: string | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/spellcheck) */ spellcheck: boolean; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/title) */ title: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/translate) */ translate: boolean; writingSuggestions: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attachInternals) */ attachInternals(): ElementInternals; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/click) */ click(): void; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/hidePopover) */ hidePopover(): void; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/showPopover) */ showPopover(): void; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/togglePopover) */ togglePopover(force?: boolean): boolean; addEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void; addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void; removeEventListener<K extends keyof HTMLElementEventMap>(type: K, listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any, options?: boolean | EventListenerOptions): void; removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attributes) */ readonly attributes: NamedNodeMap; /** * Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/classList) */ readonly classList: DOMTokenList; /** * Returns the value of element's class content attribute. Can be set to change it. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/className) */ className: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientHeight) */ readonly clientHeight: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientLeft) */ readonly clientLeft: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientTop) */ readonly clientTop: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/clientWidth) */ readonly clientWidth: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/currentCSSZoom) */ readonly currentCSSZoom: number; /** * Returns the value of element's id content attribute. Can be set to change it. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/id) */ id: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/innerHTML) */ innerHTML: string; /** * Returns the local name. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/localName) */ readonly localName: string; /** * Returns the namespace. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/namespaceURI) */ readonly namespaceURI: string | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenchange_event) */ onfullscreenchange: ((this: Element, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/fullscreenerror_event) */ onfullscreenerror: ((this: Element, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/outerHTML) */ outerHTML: string; readonly ownerDocument: Document; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/part) */ readonly part: DOMTokenList; /** * Returns the namespace prefix. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/prefix) */ readonly prefix: string | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollHeight) */ readonly scrollHeight: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollLeft) */ scrollLeft: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTop) */ scrollTop: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollWidth) */ readonly scrollWidth: number; /** * Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/shadowRoot) */ readonly shadowRoot: ShadowRoot | null; /** * Returns the value of element's slot content attribute. Can be set to change it. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/slot) */ slot: string; /** * Returns the HTML-uppercased qualified name. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/tagName) */ readonly tagName: string; /** * Creates a shadow root for element and returns it. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/attachShadow) */ attachShadow(init: ShadowRootInit): ShadowRoot; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/checkVisibility) */ checkVisibility(options?: CheckVisibilityOptions): boolean; /** * Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/closest) */ closest<K extends keyof HTMLElementTagNameMap>(selector: K): HTMLElementTagNameMap[K] | null; closest<K extends keyof SVGElementTagNameMap>(selector: K): SVGElementTagNameMap[K] | null; closest<K extends keyof MathMLElementTagNameMap>(selector: K): MathMLElementTagNameMap[K] | null; closest<E extends Element = Element>(selectors: string): E | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/computedStyleMap) */ computedStyleMap(): StylePropertyMapReadOnly; /** * Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttribute) */ getAttribute(qualifiedName: string): string | null; /** * Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNS) */ getAttributeNS(namespace: string | null, localName: string): string | null; /** * Returns the qualified names of all element's attributes. Can contain duplicates. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNames) */ getAttributeNames(): string[]; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNode) */ getAttributeNode(qualifiedName: string): Attr | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getAttributeNodeNS) */ getAttributeNodeNS(namespace: string | null, localName: string): Attr | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getBoundingClientRect) */ getBoundingClientRect(): DOMRect; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getClientRects) */ getClientRects(): DOMRectList; /** * Returns a HTMLCollection of the elements in the object on which the method was invoked (a document or an element) that have all the classes given by classNames. The classNames argument is interpreted as a space-separated list of classes. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByClassName) */ getElementsByClassName(classNames: string): HTMLCollectionOf<Element>; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagName) */ getElementsByTagName<K extends keyof HTMLElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<HTMLElementTagNameMap[K]>; getElementsByTagName<K extends keyof SVGElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<SVGElementTagNameMap[K]>; getElementsByTagName<K extends keyof MathMLElementTagNameMap>(qualifiedName: K): HTMLCollectionOf<MathMLElementTagNameMap[K]>; /** @deprecated */ getElementsByTagName<K extends keyof HTMLElementDeprecatedTagNameMap>(qualifiedName: K): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>; getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getElementsByTagNameNS) */ getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1999/xhtml", localName: string): HTMLCollectionOf<HTMLElement>; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/2000/svg", localName: string): HTMLCollectionOf<SVGElement>; getElementsByTagNameNS(namespaceURI: "http://www.w3.org/1998/Math/MathML", localName: string): HTMLCollectionOf<MathMLElement>; getElementsByTagNameNS(namespace: string | null, localName: string): HTMLCollectionOf<Element>; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/getHTML) */ getHTML(options?: GetHTMLOptions): string; /** * Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttribute) */ hasAttribute(qualifiedName: string): boolean; /** * Returns true if element has an attribute whose namespace is namespace and local name is localName. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributeNS) */ hasAttributeNS(namespace: string | null, localName: string): boolean; /** * Returns true if element has attributes, and false otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasAttributes) */ hasAttributes(): boolean; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/hasPointerCapture) */ hasPointerCapture(pointerId: number): boolean; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentElement) */ insertAdjacentElement(where: InsertPosition, element: Element): Element | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentHTML) */ insertAdjacentHTML(position: InsertPosition, string: string): void; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/insertAdjacentText) */ insertAdjacentText(where: InsertPosition, data: string): void; /** * Returns true if matching selectors against element's root yields element, and false otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches) */ matches(selectors: string): boolean; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/releasePointerCapture) */ releasePointerCapture(pointerId: number): void; /** * Removes element's first attribute whose qualified name is qualifiedName. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttribute) */ removeAttribute(qualifiedName: string): void; /** * Removes element's attribute whose namespace is namespace and local name is localName. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNS) */ removeAttributeNS(namespace: string | null, localName: string): void; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/removeAttributeNode) */ removeAttributeNode(attr: Attr): Attr; /** * Displays element fullscreen and resolves promise when done. * * When supplied, options's navigationUI member indicates whether showing navigation UI while in fullscreen is preferred or not. If set to "show", navigation simplicity is preferred over screen space, and if set to "hide", more screen space is preferred. User agents are always free to honor user preference over the application's. The default value "auto" indicates no application preference. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestFullscreen) */ requestFullscreen(options?: FullscreenOptions): Promise<void>; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/requestPointerLock) */ requestPointerLock(options?: PointerLockOptions): Promise<void>; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scroll) */ scroll(options?: ScrollToOptions): void; scroll(x: number, y: number): void; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollBy) */ scrollBy(options?: ScrollToOptions): void; scrollBy(x: number, y: number): void; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollIntoView) */ scrollIntoView(arg?: boolean | ScrollIntoViewOptions): void; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo) */ scrollTo(options?: ScrollToOptions): void; scrollTo(x: number, y: number): void; /** * Sets the value of element's first attribute whose qualified name is qualifiedName to value. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttribute) */ setAttribute(qualifiedName: string, value: string): void; /** * Sets the value of element's attribute whose namespace is namespace and local name is localName to value. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNS) */ setAttributeNS(namespace: string | null, qualifiedName: string, value: string): void; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNode) */ setAttributeNode(attr: Attr): Attr | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setAttributeNodeNS) */ setAttributeNodeNS(attr: Attr): Attr | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setHTMLUnsafe) */ setHTMLUnsafe(html: string): void; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/setPointerCapture) */ setPointerCapture(pointerId: number): void; /** * If force is not given, "toggles" qualifiedName, removing it if it is present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName. * * Returns true if qualifiedName is now present, and false otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/toggleAttribute) */ toggleAttribute(qualifiedName: string, force?: boolean): boolean; /** * @deprecated This is a legacy alias of `matches`. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/matches) */ webkitMatchesSelector(selectors: string): boolean; /** * Returns node's node document's document base URL. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/baseURI) */ readonly baseURI: string; /** * Returns the children. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/childNodes) */ readonly childNodes: NodeListOf<ChildNode>; /** * Returns the first child. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/firstChild) */ readonly firstChild: ChildNode | null; /** * Returns true if node is connected and false otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isConnected) */ readonly isConnected: boolean; /** * Returns the last child. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lastChild) */ readonly lastChild: ChildNode | null; /** * Returns the next sibling. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nextSibling) */ readonly nextSibling: ChildNode | null; /** * Returns a string appropriate for the type of node. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeName) */ readonly nodeName: string; /** * Returns the type of node. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeType) */ readonly nodeType: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/nodeValue) */ nodeValue: string | null; /** * Returns the parent element. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentElement) */ readonly parentElement: HTMLElement | null; /** * Returns the parent. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/parentNode) */ readonly parentNode: ParentNode | null; /** * Returns the previous sibling. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/previousSibling) */ readonly previousSibling: ChildNode | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/textContent) */ textContent: string | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/appendChild) */ appendChild<T extends Node>(node: T): T; /** * Returns a copy of node. If deep is true, the copy also includes the node's descendants. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/cloneNode) */ cloneNode(deep?: boolean): Node; /** * Returns a bitmask indicating the position of other relative to node. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/compareDocumentPosition) */ compareDocumentPosition(other: Node): number; /** * Returns true if other is an inclusive descendant of node, and false otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/contains) */ contains(other: Node | null): boolean; /** * Returns node's root. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/getRootNode) */ getRootNode(options?: GetRootNodeOptions): Node; /** * Returns whether node has children. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/hasChildNodes) */ hasChildNodes(): boolean; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/insertBefore) */ insertBefore<T extends Node>(node: T, child: Node | null): T; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isDefaultNamespace) */ isDefaultNamespace(namespace: string | null): boolean; /** * Returns whether node and otherNode have the same properties. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isEqualNode) */ isEqualNode(otherNode: Node | null): boolean; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/isSameNode) */ isSameNode(otherNode: Node | null): boolean; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupNamespaceURI) */ lookupNamespaceURI(prefix: string | null): string | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/lookupPrefix) */ lookupPrefix(namespace: string | null): string | null; /** * Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/normalize) */ normalize(): void; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/removeChild) */ removeChild<T extends Node>(child: T): T; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/replaceChild) */ replaceChild<T extends Node>(node: Node, child: T): T; /** node is an element. */ readonly ELEMENT_NODE: 1; readonly ATTRIBUTE_NODE: 2; /** node is a Text node. */ readonly TEXT_NODE: 3; /** node is a CDATASection node. */ readonly CDATA_SECTION_NODE: 4; readonly ENTITY_REFERENCE_NODE: 5; readonly ENTITY_NODE: 6; /** node is a ProcessingInstruction node. */ readonly PROCESSING_INSTRUCTION_NODE: 7; /** node is a Comment node. */ readonly COMMENT_NODE: 8; /** node is a document. */ readonly DOCUMENT_NODE: 9; /** node is a doctype. */ readonly DOCUMENT_TYPE_NODE: 10; /** node is a DocumentFragment node. */ readonly DOCUMENT_FRAGMENT_NODE: 11; readonly NOTATION_NODE: 12; /** Set when node and other are not in the same tree. */ readonly DOCUMENT_POSITION_DISCONNECTED: 0x01; /** Set when other is preceding node. */ readonly DOCUMENT_POSITION_PRECEDING: 0x02; /** Set when other is following node. */ readonly DOCUMENT_POSITION_FOLLOWING: 0x04; /** Set when other is an ancestor of node. */ readonly DOCUMENT_POSITION_CONTAINS: 0x08; /** Set when other is a descendant of node. */ readonly DOCUMENT_POSITION_CONTAINED_BY: 0x10; readonly DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 0x20; /** * Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/EventTarget/dispatchEvent) */ dispatchEvent(event: Event): boolean; 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; ariaCurrent:string|null; ariaDescription:string|null; ariaDisabled:string|null; ariaExpanded:string|null; ariaHasPopup:string|null; ariaHidden:string|null; ariaInvalid:string|null; ariaKeyShortcuts:string|null; ariaLabel:string|null; ariaLevel:string|null; ariaLive:string|null; ariaModal:string|null; ariaMultiLine:string|null; ariaMultiSelectable:string|null; ariaOrientation:string|null; ariaPlaceholder:string|null; ariaPosInSet:string|null; ariaPressed:string|null; ariaReadOnly: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; /** * Returns the first following sibling that is an element, and null otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/nextElementSibling) */ readonly nextElementSibling: Element | null; /** * Returns the first preceding sibling that is an element, and null otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/CharacterData/previousElementSibling) */ readonly previousElementSibling: Element | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/childElementCount) */ readonly childElementCount: number; /** * Returns the child elements. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/children) */ readonly children: HTMLCollection; /** * Returns the first child that is an element, and null otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/firstElementChild) */ readonly firstElementChild: Element | null; /** * Returns the last child that is an element, and null otherwise. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/lastElementChild) */ readonly lastElementChild: Element | null; /** * Inserts nodes after the last child of node, while replacing strings in nodes with equivalent Text nodes. * * Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/append) */ append(...nodes: (Node | string)[]): void; /** * Inserts nodes before the first child of node, while replacing strings in nodes with equivalent Text nodes. * * Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/prepend) */ prepend(...nodes: (Node | string)[]): void; /** * Returns the first element that is a descendant of node that matches selectors. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelector) */ querySelector<K extends keyof HTMLElementTagNameMap>(selectors: K): HTMLElementTagNameMap[K] | null; querySelector<K extends keyof SVGElementTagNameMap>(selectors: K): SVGElementTagNameMap[K] | null; querySelector<K extends keyof MathMLElementTagNameMap>(selectors: K): MathMLElementTagNameMap[K] | null; /** @deprecated */ querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K): HTMLElementDeprecatedTagNameMap[K] | null; querySelector<E extends Element = Element>(selectors: string): E | null; /** * Returns all element descendants of node that match selectors. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/querySelectorAll) */ querySelectorAll<K extends keyof HTMLElementTagNameMap>(selectors: K): NodeListOf<HTMLElementTagNameMap[K]>; querySelectorAll<K extends keyof SVGElementTagNameMap>(selectors: K): NodeListOf<SVGElementTagNameMap[K]>; querySelectorAll<K extends keyof MathMLElementTagNameMap>(selectors: K): NodeListOf<MathMLElementTagNameMap[K]>; /** @deprecated */ querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(selectors: K): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>; querySelectorAll<E extends Element = Element>(selectors: string): NodeListOf<E>; /** * Replace all children of node with nodes, while replacing strings in nodes with equivalent Text nodes. * * Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/replaceChildren) */ replaceChildren(...nodes: (Node | string)[]): void; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/assignedSlot) */ readonly assignedSlot: HTMLSlotElement | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/attributeStyleMap) */ readonly attributeStyleMap: StylePropertyMap; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/style) */ readonly style: CSSStyleDeclaration; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/contentEditable) */ contentEditable: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/enterKeyHint) */ enterKeyHint: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/inputMode) */ inputMode: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/isContentEditable) */ readonly isContentEditable: boolean; /** * Fires when the user aborts the download. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/abort_event) */ onabort: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationcancel_event) */ onanimationcancel: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event) */ onanimationend: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event) */ onanimationiteration: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event) */ onanimationstart: ((this: GlobalEventHandlers, ev: AnimationEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/auxclick_event) */ onauxclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/beforeinput_event) */ onbeforeinput: ((this: GlobalEventHandlers, ev: InputEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/beforetoggle_event) */ onbeforetoggle: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Fires when the object loses the input focus. * @param ev The focus event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/blur_event) */ onblur: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/cancel_event) */ oncancel: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Occurs when playback is possible, but would require further buffering. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplay_event) */ oncanplay: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/canplaythrough_event) */ oncanplaythrough: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Fires when the contents of the object or selection have changed. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/change_event) */ onchange: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Fires when the user clicks the left mouse button on the object * @param ev The mouse event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/click_event) */ onclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDialogElement/close_event) */ onclose: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/webglcontextlost_event) */ oncontextlost: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Fires when the user clicks the right mouse button in the client area, opening the context menu. * @param ev The mouse event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/contextmenu_event) */ oncontextmenu: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLCanvasElement/contextrestored_event) */ oncontextrestored: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/copy_event) */ oncopy: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLTrackElement/cuechange_event) */ oncuechange: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/cut_event) */ oncut: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null; /** * Fires when the user double-clicks the object. * @param ev The mouse event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/dblclick_event) */ ondblclick: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** * Fires on the source object continuously during a drag operation. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drag_event) */ ondrag: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; /** * Fires on the source object when the user releases the mouse at the close of a drag operation. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragend_event) */ ondragend: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; /** * Fires on the target element when the user drags the object to a valid drop target. * @param ev The drag event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragenter_event) */ ondragenter: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; /** * Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation. * @param ev The drag event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragleave_event) */ ondragleave: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; /** * Fires on the target element continuously while the user drags the object over a valid drop target. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragover_event) */ ondragover: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; /** * Fires on the source object when the user starts to drag a text selection or selected object. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dragstart_event) */ ondragstart: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/drop_event) */ ondrop: ((this: GlobalEventHandlers, ev: DragEvent) => any) | null; /** * Occurs when the duration attribute is updated. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/durationchange_event) */ ondurationchange: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Occurs when the media element is reset to its initial state. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/emptied_event) */ onemptied: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Occurs when the end of playback is reached. * @param ev The event * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ended_event) */ onended: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Fires when an error occurs during object loading. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/error_event) */ onerror: OnErrorEventHandler; /** * Fires when the object receives focus. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/focus_event) */ onfocus: ((this: GlobalEventHandlers, ev: FocusEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/formdata_event) */ onformdata: ((this: GlobalEventHandlers, ev: FormDataEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/gotpointercapture_event) */ ongotpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/input_event) */ oninput: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/invalid_event) */ oninvalid: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Fires when the user presses a key. * @param ev The keyboard event * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keydown_event) */ onkeydown: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null; /** * Fires when the user presses an alphanumeric key. * @param ev The event. * @deprecated * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keypress_event) */ onkeypress: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null; /** * Fires when the user releases a key. * @param ev The keyboard event * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/keyup_event) */ onkeyup: ((this: GlobalEventHandlers, ev: KeyboardEvent) => any) | null; /** * Fires immediately after the browser loads the object. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/SVGElement/load_event) */ onload: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Occurs when media data is loaded at the current playback position. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadeddata_event) */ onloadeddata: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Occurs when the duration and dimensions of the media have been determined. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadedmetadata_event) */ onloadedmetadata: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Occurs when Internet Explorer begins looking for media data. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/loadstart_event) */ onloadstart: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/lostpointercapture_event) */ onlostpointercapture: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; /** * Fires when the user clicks the object with either mouse button. * @param ev The mouse event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousedown_event) */ onmousedown: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseenter_event) */ onmouseenter: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseleave_event) */ onmouseleave: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** * Fires when the user moves the mouse over the object. * @param ev The mouse event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mousemove_event) */ onmousemove: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** * Fires when the user moves the mouse pointer outside the boundaries of the object. * @param ev The mouse event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseout_event) */ onmouseout: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** * Fires when the user moves the mouse pointer into the object. * @param ev The mouse event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseover_event) */ onmouseover: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** * Fires when the user releases a mouse button while the mouse is over the object. * @param ev The mouse event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/mouseup_event) */ onmouseup: ((this: GlobalEventHandlers, ev: MouseEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/paste_event) */ onpaste: ((this: GlobalEventHandlers, ev: ClipboardEvent) => any) | null; /** * Occurs when playback is paused. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/pause_event) */ onpause: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Occurs when the play method is requested. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/play_event) */ onplay: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Occurs when the audio or video has started playing. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/playing_event) */ onplaying: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointercancel_event) */ onpointercancel: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerdown_event) */ onpointerdown: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerenter_event) */ onpointerenter: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerleave_event) */ onpointerleave: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointermove_event) */ onpointermove: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerout_event) */ onpointerout: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerover_event) */ onpointerover: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/pointerup_event) */ onpointerup: ((this: GlobalEventHandlers, ev: PointerEvent) => any) | null; /** * Occurs to indicate progress while downloading media data. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/progress_event) */ onprogress: ((this: GlobalEventHandlers, ev: ProgressEvent) => any) | null; /** * Occurs when the playback rate is increased or decreased. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/ratechange_event) */ onratechange: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Fires when the user resets a form. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/reset_event) */ onreset: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLVideoElement/resize_event) */ onresize: ((this: GlobalEventHandlers, ev: UIEvent) => any) | null; /** * Fires when the user repositions the scroll box in the scroll bar on the object. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scroll_event) */ onscroll: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/scrollend_event) */ onscrollend: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/securitypolicyviolation_event) */ onsecuritypolicyviolation: ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any) | null; /** * Occurs when the seek operation ends. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeked_event) */ onseeked: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Occurs when the current playback position is moved. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/seeking_event) */ onseeking: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Fires when the current selection changes. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLInputElement/select_event) */ onselect: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Document/selectionchange_event) */ onselectionchange: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Node/selectstart_event) */ onselectstart: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLSlotElement/slotchange_event) */ onslotchange: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Occurs when the download has stopped. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/stalled_event) */ onstalled: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLFormElement/submit_event) */ onsubmit: ((this: GlobalEventHandlers, ev: SubmitEvent) => any) | null; /** * Occurs if the load operation has been intentionally halted. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/suspend_event) */ onsuspend: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Occurs to indicate the current playback position. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/timeupdate_event) */ ontimeupdate: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLDetailsElement/toggle_event) */ ontoggle: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchcancel_event) */ ontouchcancel?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchend_event) */ ontouchend?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchmove_event) */ ontouchmove?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/touchstart_event) */ ontouchstart?: ((this: GlobalEventHandlers, ev: TouchEvent) => any) | null | undefined; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitioncancel_event) */ ontransitioncancel: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event) */ ontransitionend: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionrun_event) */ ontransitionrun: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionstart_event) */ ontransitionstart: ((this: GlobalEventHandlers, ev: TransitionEvent) => any) | null; /** * Occurs when the volume is changed, or playback is muted or unmuted. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/volumechange_event) */ onvolumechange: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * Occurs when playback stops because the next frame of a video resource is not available. * @param ev The event. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLMediaElement/waiting_event) */ onwaiting: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * @deprecated This is a legacy alias of `onanimationend`. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationend_event) */ onwebkitanimationend: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * @deprecated This is a legacy alias of `onanimationiteration`. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationiteration_event) */ onwebkitanimationiteration: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * @deprecated This is a legacy alias of `onanimationstart`. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/animationstart_event) */ onwebkitanimationstart: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** * @deprecated This is a legacy alias of `ontransitionend`. * * [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/transitionend_event) */ onwebkittransitionend: ((this: GlobalEventHandlers, ev: Event) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/wheel_event) */ onwheel: ((this: GlobalEventHandlers, ev: WheelEvent) => any) | null; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/autofocus) */ autofocus: boolean; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/dataset) */ readonly dataset: DOMStringMap; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/nonce) */ nonce?: string; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/tabIndex) */ tabIndex: number; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/blur) */ blur(): void; /** [MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement/focus) */ focus(options?: FocusOptions): void}HTMLRevoGridElementEventMap (Extended from global)
Section titled “HTMLRevoGridElementEventMap (Extended from global)”interface HTMLRevoGridElementEventMap { gridconfiguratorchange: GridConfiguratorState}Plugin API
Section titled “Plugin API”GridConfiguratorArea
Section titled “GridConfiguratorArea”export type GridConfiguratorArea = 'rows' | 'values' | 'filters';GridConfiguratorAggregator
Section titled “GridConfiguratorAggregator”export type GridConfiguratorAggregator = (values: any[]) => unknown;GridConfiguratorField (Extended from grid-configurator.types.ts)
Section titled “GridConfiguratorField (Extended from grid-configurator.types.ts)”interface GridConfiguratorField { prop: ColumnProp; /** Overrides the available aggregation registry for this field. */ aggregators?: Record<string, GridConfiguratorAggregator>; defaultAggregator?: string}GridConfiguratorValue
Section titled “GridConfiguratorValue”interface GridConfiguratorValue { prop: ColumnProp; aggregator: string}GridConfiguratorConfig
Section titled “GridConfiguratorConfig”interface GridConfiguratorConfig { /** Optional field metadata. Columns remain the source of field names and hierarchy. */ fields?: readonly GridConfiguratorField[]; /** Selected group summaries; one per source column. No Pivot execution is involved. */ values?: readonly GridConfiguratorValue[]; /** Filter shortcuts to display even before a predicate has been applied. */ filters?: readonly ColumnProp[]; /** Additional/replacement named aggregators shared by fields. */ aggregators?: Record<string, GridConfiguratorAggregator>; defaultAggregator?: string; /** Defaults to all three destinations. Does not clear settings in hidden destinations. */ areas?: readonly GridConfiguratorArea[]; /** False creates only the adapter. An element mounts externally; otherwise attaches beside the grid. */ mountTo?: HTMLElement | false; theme?: 'light' | 'dark'; width?: number | string}GridConfiguratorState
Section titled “GridConfiguratorState”interface GridConfiguratorState { columns: readonly ColumnDialogRow[]; rows: readonly ColumnProp[]; values: readonly GridConfiguratorValue[]; filters: readonly ColumnProp[]; activeFilters: readonly ColumnProp[]}GridConfiguratorMount
Section titled “GridConfiguratorMount”interface GridConfiguratorMount { /** Releases only this mounted surface; the grid plugin retains configuration. */ destroy(): void}defineGridConfigurator
Section titled “defineGridConfigurator”Mount an ordinary-grid configurator. The grid must be connected and initialized. Reuses the installed adapter, or installs one without an attached surface.
export async function defineGridConfigurator( host: HTMLElement, grid: HTMLRevoGridElement, config?: GridConfiguratorConfig,): Promise<GridConfiguratorMount>;GridConfiguratorPlugin
Section titled “GridConfiguratorPlugin”Grid authoring adapter. Uses ordinary grid providers, never the Pivot engine.
Dependencies
Section titled “Dependencies”- Auto-installed
ColumnHidePlugin: Owns source-column visibility. - Auto-installed
AdvanceFilterPlugin: Shares column filters and their editor with headers.
class GridConfiguratorPlugin { /** Configurator-specific options only; existing grid state remains authoritative. */ updateConfig(config: GridConfiguratorConfig): void;
getState(): GridConfiguratorState;
/** Moving a surface revokes its previous mount lease without resetting grid settings. */ mount(host: HTMLElement): GridConfiguratorMount;
setVisible(rowId: string, visible: boolean): void;
reorderColumn(draggedRowId: string, targetRowId: string, position: 'before' | 'after'): void;
addField(area: GridConfiguratorArea, prop: ColumnProp): void;
async removeField(area: GridConfiguratorArea, prop: ColumnProp): Promise<void>;
reorderField(area: GridConfiguratorArea, prop: ColumnProp, targetIndex: number): void;
setAggregator(prop: ColumnProp, aggregator: string): void;
openFilter(prop: ColumnProp, anchor: HTMLElement): Promise<void>;
destroy(): void;}