From 4e86f3592efad77ce3c3696f72d41a758554461a Mon Sep 17 00:00:00 2001 From: Alain Dumesny Date: Sat, 9 Aug 2025 23:40:55 -0700 Subject: [PATCH] angular generated HMTL + markup doc --- angular/docs/api/base-widget.md | 96 + angular/docs/api/gridstack-item.component.md | 2895 +++++++++++++++ angular/docs/api/gridstack.component.md | 3300 +++++++++++++++++ angular/docs/api/gridstack.module.md | 44 + angular/docs/api/index.md | 11 + angular/docs/api/types.md | 90 + angular/docs/html/.nojekyll | 1 + angular/docs/html/assets/hierarchy.js | 1 + angular/docs/html/assets/highlight.css | 148 + angular/docs/html/assets/icons.js | 18 + angular/docs/html/assets/icons.svg | 1 + angular/docs/html/assets/main.js | 60 + angular/docs/html/assets/navigation.js | 1 + angular/docs/html/assets/search.js | 1 + angular/docs/html/assets/style.css | 1633 ++++++++ .../html/classes/base-widget.BaseWidget.html | 22 + ...item.component.GridstackItemComponent.html | 39 + ...ridstack.component.GridstackComponent.html | 111 + .../gridstack.module.GridstackModule.html | 8 + ...dstack.component.gsCreateNgComponents.html | 2 + ...tack.component.gsSaveAdditionalNgInfo.html | 5 + ...dstack.component.gsUpdateNgComponents.html | 2 + angular/docs/html/hierarchy.html | 1 + angular/docs/html/index.html | 62 + ...tem.component.GridItemCompHTMLElement.html | 472 +++ ...idstack.component.GridCompHTMLElement.html | 472 +++ .../interfaces/types.NgGridStackNode.html | 5 + .../interfaces/types.NgGridStackOptions.html | 7 + .../interfaces/types.NgGridStackWidget.html | 9 + angular/docs/html/modules.html | 1 + angular/docs/html/modules/base-widget.html | 1 + .../modules/gridstack-item.component.html | 1 + .../html/modules/gridstack.component.html | 1 + .../docs/html/modules/gridstack.module.html | 1 + angular/docs/html/modules/types.html | 1 + angular/docs/html/sitemap.xml | 107 + .../gridstack.component.SelectorToType.html | 3 + .../types/gridstack.component.droppedCB.html | 5 + .../types/gridstack.component.elementCB.html | 4 + .../types/gridstack.component.eventCB.html | 3 + .../types/gridstack.component.nodesCB.html | 4 + .../docs/html/types/types.NgCompInputs.html | 6 + angular/package.json | 5 +- angular/projects/lib/package.json | 2 +- angular/tsconfig.doc.json | 17 + angular/typedoc.html.json | 79 + angular/typedoc.json | 89 + docs/html/sitemap.xml | 120 +- package.json | 4 + scripts/generate-docs.js | 334 ++ 50 files changed, 10243 insertions(+), 62 deletions(-) create mode 100644 angular/docs/api/base-widget.md create mode 100644 angular/docs/api/gridstack-item.component.md create mode 100644 angular/docs/api/gridstack.component.md create mode 100644 angular/docs/api/gridstack.module.md create mode 100644 angular/docs/api/index.md create mode 100644 angular/docs/api/types.md create mode 100644 angular/docs/html/.nojekyll create mode 100644 angular/docs/html/assets/hierarchy.js create mode 100644 angular/docs/html/assets/highlight.css create mode 100644 angular/docs/html/assets/icons.js create mode 100644 angular/docs/html/assets/icons.svg create mode 100644 angular/docs/html/assets/main.js create mode 100644 angular/docs/html/assets/navigation.js create mode 100644 angular/docs/html/assets/search.js create mode 100644 angular/docs/html/assets/style.css create mode 100644 angular/docs/html/classes/base-widget.BaseWidget.html create mode 100644 angular/docs/html/classes/gridstack-item.component.GridstackItemComponent.html create mode 100644 angular/docs/html/classes/gridstack.component.GridstackComponent.html create mode 100644 angular/docs/html/classes/gridstack.module.GridstackModule.html create mode 100644 angular/docs/html/functions/gridstack.component.gsCreateNgComponents.html create mode 100644 angular/docs/html/functions/gridstack.component.gsSaveAdditionalNgInfo.html create mode 100644 angular/docs/html/functions/gridstack.component.gsUpdateNgComponents.html create mode 100644 angular/docs/html/hierarchy.html create mode 100644 angular/docs/html/index.html create mode 100644 angular/docs/html/interfaces/gridstack-item.component.GridItemCompHTMLElement.html create mode 100644 angular/docs/html/interfaces/gridstack.component.GridCompHTMLElement.html create mode 100644 angular/docs/html/interfaces/types.NgGridStackNode.html create mode 100644 angular/docs/html/interfaces/types.NgGridStackOptions.html create mode 100644 angular/docs/html/interfaces/types.NgGridStackWidget.html create mode 100644 angular/docs/html/modules.html create mode 100644 angular/docs/html/modules/base-widget.html create mode 100644 angular/docs/html/modules/gridstack-item.component.html create mode 100644 angular/docs/html/modules/gridstack.component.html create mode 100644 angular/docs/html/modules/gridstack.module.html create mode 100644 angular/docs/html/modules/types.html create mode 100644 angular/docs/html/sitemap.xml create mode 100644 angular/docs/html/types/gridstack.component.SelectorToType.html create mode 100644 angular/docs/html/types/gridstack.component.droppedCB.html create mode 100644 angular/docs/html/types/gridstack.component.elementCB.html create mode 100644 angular/docs/html/types/gridstack.component.eventCB.html create mode 100644 angular/docs/html/types/gridstack.component.nodesCB.html create mode 100644 angular/docs/html/types/types.NgCompInputs.html create mode 100644 angular/tsconfig.doc.json create mode 100644 angular/typedoc.html.json create mode 100644 angular/typedoc.json create mode 100755 scripts/generate-docs.js diff --git a/angular/docs/api/base-widget.md b/angular/docs/api/base-widget.md new file mode 100644 index 000000000..8a81d03a5 --- /dev/null +++ b/angular/docs/api/base-widget.md @@ -0,0 +1,96 @@ +# base-widget + +## Classes + +### `abstract` BaseWidget + +Defined in: [angular/projects/lib/src/lib/base-widget.ts:39](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/base-widget.ts#L39) + +Base widget class for GridStack Angular integration. + +#### Constructors + +##### Constructor + +```ts +new BaseWidget(): BaseWidget; +``` + +###### Returns + +[`BaseWidget`](#basewidget) + +#### Methods + +##### serialize() + +```ts +serialize(): undefined | NgCompInputs; +``` + +Defined in: [angular/projects/lib/src/lib/base-widget.ts:66](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/base-widget.ts#L66) + +Override this method to return serializable data for this widget. + +Return an object with properties that map to your component's @Input() fields. +The selector is handled automatically, so only include component-specific data. + +###### Returns + +`undefined` \| [`NgCompInputs`](types.md#ngcompinputs) + +Object containing serializable component data + +###### Example + +```typescript +serialize() { + return { + title: this.title, + value: this.value, + settings: this.settings + }; +} +``` + +##### deserialize() + +```ts +deserialize(w): void; +``` + +Defined in: [angular/projects/lib/src/lib/base-widget.ts:88](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/base-widget.ts#L88) + +Override this method to handle widget restoration from saved data. + +Use this for complex initialization that goes beyond simple @Input() mapping. +The default implementation automatically assigns input data to component properties. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `w` | [`NgGridStackWidget`](types.md#nggridstackwidget) | The saved widget data including input properties | + +###### Returns + +`void` + +###### Example + +```typescript +deserialize(w: NgGridStackWidget) { + super.deserialize(w); // Call parent for basic setup + + // Custom initialization logic + if (w.input?.complexData) { + this.processComplexData(w.input.complexData); + } +} +``` + +#### Properties + +| Property | Modifier | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `widgetItem?` | `public` | [`NgGridStackWidget`](types.md#nggridstackwidget) | Complete widget definition including position, size, and Angular-specific data. Populated automatically when the widget is loaded or saved. | [angular/projects/lib/src/lib/base-widget.ts:45](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/base-widget.ts#L45) | diff --git a/angular/docs/api/gridstack-item.component.md b/angular/docs/api/gridstack-item.component.md new file mode 100644 index 000000000..58c6d3ece --- /dev/null +++ b/angular/docs/api/gridstack-item.component.md @@ -0,0 +1,2895 @@ +# gridstack-item.component + +## Classes + +### GridstackItemComponent + +Defined in: [angular/projects/lib/src/lib/gridstack-item.component.ts:56](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L56) + +Angular component wrapper for individual GridStack items. + +This component represents a single grid item and handles: +- Dynamic content creation and management +- Integration with parent GridStack component +- Component lifecycle and cleanup +- Widget options and configuration + +Use in combination with GridstackComponent for the parent grid. + +#### Example + +```html + + + + + +``` + +#### Implements + +- `OnDestroy` + +#### Accessors + +##### options + +###### Get Signature + +```ts +get options(): GridStackNode; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack-item.component.ts:100](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L100) + +return the latest grid options (from GS once built, otherwise initial values) + +###### Returns + +`GridStackNode` + +###### Set Signature + +```ts +set options(val): void; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack-item.component.ts:89](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L89) + +Grid item configuration options. +Defines position, size, and behavior of this grid item. + +###### Example + +```typescript +itemOptions: GridStackNode = { + x: 0, y: 0, w: 2, h: 1, + noResize: true, + content: 'Item content' +}; +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `val` | `GridStackNode` | + +###### Returns + +`void` + +##### el + +###### Get Signature + +```ts +get el(): GridItemCompHTMLElement; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack-item.component.ts:107](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L107) + +return the native element that contains grid specific fields as well + +###### Returns + +[`GridItemCompHTMLElement`](#griditemcomphtmlelement) + +#### Constructors + +##### Constructor + +```ts +new GridstackItemComponent(elementRef): GridstackItemComponent; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack-item.component.ts:114](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L114) + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementRef` | `ElementRef`\<[`GridItemCompHTMLElement`](#griditemcomphtmlelement)\> | + +###### Returns + +[`GridstackItemComponent`](#gridstackitemcomponent) + +#### Methods + +##### clearOptions() + +```ts +clearOptions(): void; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack-item.component.ts:110](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L110) + +clears the initial options now that we've built + +###### Returns + +`void` + +##### ngOnDestroy() + +```ts +ngOnDestroy(): void; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack-item.component.ts:118](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L118) + +A callback method that performs custom clean-up, invoked immediately +before a directive, pipe, or service instance is destroyed. + +###### Returns + +`void` + +###### Implementation of + +```ts +OnDestroy.ngOnDestroy +``` + +#### Properties + +| Property | Modifier | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `container?` | `public` | `ViewContainerRef` | Container for dynamic component creation within this grid item. Used to append child components programmatically. | [angular/projects/lib/src/lib/gridstack-item.component.ts:62](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L62) | +| `ref` | `public` | \| `undefined` \| `ComponentRef`\<[`GridstackItemComponent`](#gridstackitemcomponent)\> | Component reference for dynamic component removal. Used internally when this component is created dynamically. | [angular/projects/lib/src/lib/gridstack-item.component.ts:68](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L68) | +| `childWidget` | `public` | `undefined` \| [`BaseWidget`](base-widget.md#basewidget) | Reference to child widget component for serialization. Used to save/restore additional data along with grid position. | [angular/projects/lib/src/lib/gridstack-item.component.ts:74](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L74) | +| `_options?` | `protected` | `GridStackNode` | - | [angular/projects/lib/src/lib/gridstack-item.component.ts:104](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L104) | +| `elementRef` | `readonly` | `ElementRef`\<[`GridItemCompHTMLElement`](#griditemcomphtmlelement)\> | - | [angular/projects/lib/src/lib/gridstack-item.component.ts:114](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L114) | + +## Interfaces + +### GridItemCompHTMLElement + +Defined in: [angular/projects/lib/src/lib/gridstack-item.component.ts:14](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L14) + +Extended HTMLElement interface for grid items. +Stores a back-reference to the Angular component for integration. + +#### Extends + +- `GridItemHTMLElement` + +#### Methods + +##### animate() + +```ts +animate(keyframes, options?): Animation; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:2146 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `keyframes` | `null` \| `Keyframe`[] \| `PropertyIndexedKeyframes` | +| `options?` | `number` \| `KeyframeAnimationOptions` | + +###### Returns + +`Animation` + +###### Inherited from + +```ts +GridItemHTMLElement.animate +``` + +##### getAnimations() + +```ts +getAnimations(options?): Animation[]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:2147 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `GetAnimationsOptions` | + +###### Returns + +`Animation`[] + +###### Inherited from + +```ts +GridItemHTMLElement.getAnimations +``` + +##### after() + +```ts +after(...nodes): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3747 + +Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes. + +Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| ...`nodes` | (`string` \| `Node`)[] | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.after +``` + +##### before() + +```ts +before(...nodes): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3753 + +Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes. + +Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| ...`nodes` | (`string` \| `Node`)[] | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.before +``` + +##### remove() + +```ts +remove(): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3755 + +Removes node. + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.remove +``` + +##### replaceWith() + +```ts +replaceWith(...nodes): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3761 + +Replaces 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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| ...`nodes` | (`string` \| `Node`)[] | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.replaceWith +``` + +##### attachShadow() + +```ts +attachShadow(init): ShadowRoot; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5074 + +Creates a shadow root for element and returns it. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `init` | `ShadowRootInit` | + +###### Returns + +`ShadowRoot` + +###### Inherited from + +```ts +GridItemHTMLElement.attachShadow +``` + +##### checkVisibility() + +```ts +checkVisibility(options?): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5075 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `CheckVisibilityOptions` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridItemHTMLElement.checkVisibility +``` + +##### closest() + +###### Call Signature + +```ts +closest(selector): null | HTMLElementTagNameMap[K]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5077 + +Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selector` | `K` | + +###### Returns + +`null` \| `HTMLElementTagNameMap`\[`K`\] + +###### Inherited from + +```ts +GridItemHTMLElement.closest +``` + +###### Call Signature + +```ts +closest(selector): null | SVGElementTagNameMap[K]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5078 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `SVGElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selector` | `K` | + +###### Returns + +`null` \| `SVGElementTagNameMap`\[`K`\] + +###### Inherited from + +```ts +GridItemHTMLElement.closest +``` + +###### Call Signature + +```ts +closest(selector): null | MathMLElementTagNameMap[K]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5079 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `MathMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selector` | `K` | + +###### Returns + +`null` \| `MathMLElementTagNameMap`\[`K`\] + +###### Inherited from + +```ts +GridItemHTMLElement.closest +``` + +###### Call Signature + +```ts +closest(selectors): null | E; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5080 + +###### Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `E` *extends* `Element`\<`E`\> | `Element` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `string` | + +###### Returns + +`null` \| `E` + +###### Inherited from + +```ts +GridItemHTMLElement.closest +``` + +##### getAttribute() + +```ts +getAttribute(qualifiedName): null | string; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5082 + +Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `string` | + +###### Returns + +`null` \| `string` + +###### Inherited from + +```ts +GridItemHTMLElement.getAttribute +``` + +##### getAttributeNS() + +```ts +getAttributeNS(namespace, localName): null | string; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5084 + +Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | +| `localName` | `string` | + +###### Returns + +`null` \| `string` + +###### Inherited from + +```ts +GridItemHTMLElement.getAttributeNS +``` + +##### getAttributeNames() + +```ts +getAttributeNames(): string[]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5086 + +Returns the qualified names of all element's attributes. Can contain duplicates. + +###### Returns + +`string`[] + +###### Inherited from + +```ts +GridItemHTMLElement.getAttributeNames +``` + +##### getAttributeNode() + +```ts +getAttributeNode(qualifiedName): null | Attr; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5087 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `string` | + +###### Returns + +`null` \| `Attr` + +###### Inherited from + +```ts +GridItemHTMLElement.getAttributeNode +``` + +##### getAttributeNodeNS() + +```ts +getAttributeNodeNS(namespace, localName): null | Attr; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5088 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | +| `localName` | `string` | + +###### Returns + +`null` \| `Attr` + +###### Inherited from + +```ts +GridItemHTMLElement.getAttributeNodeNS +``` + +##### getBoundingClientRect() + +```ts +getBoundingClientRect(): DOMRect; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5089 + +###### Returns + +`DOMRect` + +###### Inherited from + +```ts +GridItemHTMLElement.getBoundingClientRect +``` + +##### getClientRects() + +```ts +getClientRects(): DOMRectList; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5090 + +###### Returns + +`DOMRectList` + +###### Inherited from + +```ts +GridItemHTMLElement.getClientRects +``` + +##### getElementsByClassName() + +```ts +getElementsByClassName(classNames): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5092 + +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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `classNames` | `string` | + +###### Returns + +`HTMLCollectionOf`\<`Element`\> + +###### Inherited from + +```ts +GridItemHTMLElement.getElementsByClassName +``` + +##### getElementsByTagName() + +###### Call Signature + +```ts +getElementsByTagName(qualifiedName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5093 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `K` | + +###### Returns + +`HTMLCollectionOf`\<`HTMLElementTagNameMap`\[`K`\]\> + +###### Inherited from + +```ts +GridItemHTMLElement.getElementsByTagName +``` + +###### Call Signature + +```ts +getElementsByTagName(qualifiedName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5094 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `SVGElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `K` | + +###### Returns + +`HTMLCollectionOf`\<`SVGElementTagNameMap`\[`K`\]\> + +###### Inherited from + +```ts +GridItemHTMLElement.getElementsByTagName +``` + +###### Call Signature + +```ts +getElementsByTagName(qualifiedName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5095 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `MathMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `K` | + +###### Returns + +`HTMLCollectionOf`\<`MathMLElementTagNameMap`\[`K`\]\> + +###### Inherited from + +```ts +GridItemHTMLElement.getElementsByTagName +``` + +###### Call Signature + +```ts +getElementsByTagName(qualifiedName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5097 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementDeprecatedTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `K` | + +###### Returns + +`HTMLCollectionOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\> + +###### Deprecated + +###### Inherited from + +```ts +GridItemHTMLElement.getElementsByTagName +``` + +###### Call Signature + +```ts +getElementsByTagName(qualifiedName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5098 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `string` | + +###### Returns + +`HTMLCollectionOf`\<`Element`\> + +###### Inherited from + +```ts +GridItemHTMLElement.getElementsByTagName +``` + +##### getElementsByTagNameNS() + +###### Call Signature + +```ts +getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5099 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespaceURI` | `"http://www.w3.org/1999/xhtml"` | +| `localName` | `string` | + +###### Returns + +`HTMLCollectionOf`\<`HTMLElement`\> + +###### Inherited from + +```ts +GridItemHTMLElement.getElementsByTagNameNS +``` + +###### Call Signature + +```ts +getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5100 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespaceURI` | `"http://www.w3.org/2000/svg"` | +| `localName` | `string` | + +###### Returns + +`HTMLCollectionOf`\<`SVGElement`\> + +###### Inherited from + +```ts +GridItemHTMLElement.getElementsByTagNameNS +``` + +###### Call Signature + +```ts +getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5101 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespaceURI` | `"http://www.w3.org/1998/Math/MathML"` | +| `localName` | `string` | + +###### Returns + +`HTMLCollectionOf`\<`MathMLElement`\> + +###### Inherited from + +```ts +GridItemHTMLElement.getElementsByTagNameNS +``` + +###### Call Signature + +```ts +getElementsByTagNameNS(namespace, localName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5102 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | +| `localName` | `string` | + +###### Returns + +`HTMLCollectionOf`\<`Element`\> + +###### Inherited from + +```ts +GridItemHTMLElement.getElementsByTagNameNS +``` + +##### hasAttribute() + +```ts +hasAttribute(qualifiedName): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5104 + +Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `string` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridItemHTMLElement.hasAttribute +``` + +##### hasAttributeNS() + +```ts +hasAttributeNS(namespace, localName): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5106 + +Returns true if element has an attribute whose namespace is namespace and local name is localName. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | +| `localName` | `string` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridItemHTMLElement.hasAttributeNS +``` + +##### hasAttributes() + +```ts +hasAttributes(): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5108 + +Returns true if element has attributes, and false otherwise. + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridItemHTMLElement.hasAttributes +``` + +##### hasPointerCapture() + +```ts +hasPointerCapture(pointerId): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5109 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `pointerId` | `number` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridItemHTMLElement.hasPointerCapture +``` + +##### insertAdjacentElement() + +```ts +insertAdjacentElement(where, element): null | Element; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5110 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `where` | `InsertPosition` | +| `element` | `Element` | + +###### Returns + +`null` \| `Element` + +###### Inherited from + +```ts +GridItemHTMLElement.insertAdjacentElement +``` + +##### insertAdjacentHTML() + +```ts +insertAdjacentHTML(position, text): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5111 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `position` | `InsertPosition` | +| `text` | `string` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.insertAdjacentHTML +``` + +##### insertAdjacentText() + +```ts +insertAdjacentText(where, data): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5112 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `where` | `InsertPosition` | +| `data` | `string` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.insertAdjacentText +``` + +##### matches() + +```ts +matches(selectors): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5114 + +Returns true if matching selectors against element's root yields element, and false otherwise. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `string` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridItemHTMLElement.matches +``` + +##### releasePointerCapture() + +```ts +releasePointerCapture(pointerId): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5115 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `pointerId` | `number` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.releasePointerCapture +``` + +##### removeAttribute() + +```ts +removeAttribute(qualifiedName): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5117 + +Removes element's first attribute whose qualified name is qualifiedName. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `string` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.removeAttribute +``` + +##### removeAttributeNS() + +```ts +removeAttributeNS(namespace, localName): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5119 + +Removes element's attribute whose namespace is namespace and local name is localName. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | +| `localName` | `string` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.removeAttributeNS +``` + +##### removeAttributeNode() + +```ts +removeAttributeNode(attr): Attr; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5120 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `attr` | `Attr` | + +###### Returns + +`Attr` + +###### Inherited from + +```ts +GridItemHTMLElement.removeAttributeNode +``` + +##### requestFullscreen() + +```ts +requestFullscreen(options?): Promise; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5126 + +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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `FullscreenOptions` | + +###### Returns + +`Promise`\<`void`\> + +###### Inherited from + +```ts +GridItemHTMLElement.requestFullscreen +``` + +##### requestPointerLock() + +```ts +requestPointerLock(): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5127 + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.requestPointerLock +``` + +##### scroll() + +###### Call Signature + +```ts +scroll(options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5128 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `ScrollToOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.scroll +``` + +###### Call Signature + +```ts +scroll(x, y): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5129 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `number` | +| `y` | `number` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.scroll +``` + +##### scrollBy() + +###### Call Signature + +```ts +scrollBy(options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5130 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `ScrollToOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.scrollBy +``` + +###### Call Signature + +```ts +scrollBy(x, y): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5131 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `number` | +| `y` | `number` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.scrollBy +``` + +##### scrollIntoView() + +```ts +scrollIntoView(arg?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5132 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `arg?` | `boolean` \| `ScrollIntoViewOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.scrollIntoView +``` + +##### scrollTo() + +###### Call Signature + +```ts +scrollTo(options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5133 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `ScrollToOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.scrollTo +``` + +###### Call Signature + +```ts +scrollTo(x, y): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5134 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `number` | +| `y` | `number` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.scrollTo +``` + +##### setAttribute() + +```ts +setAttribute(qualifiedName, value): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5136 + +Sets the value of element's first attribute whose qualified name is qualifiedName to value. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `string` | +| `value` | `string` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.setAttribute +``` + +##### setAttributeNS() + +```ts +setAttributeNS( + namespace, + qualifiedName, + value): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5138 + +Sets the value of element's attribute whose namespace is namespace and local name is localName to value. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | +| `qualifiedName` | `string` | +| `value` | `string` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.setAttributeNS +``` + +##### setAttributeNode() + +```ts +setAttributeNode(attr): null | Attr; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5139 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `attr` | `Attr` | + +###### Returns + +`null` \| `Attr` + +###### Inherited from + +```ts +GridItemHTMLElement.setAttributeNode +``` + +##### setAttributeNodeNS() + +```ts +setAttributeNodeNS(attr): null | Attr; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5140 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `attr` | `Attr` | + +###### Returns + +`null` \| `Attr` + +###### Inherited from + +```ts +GridItemHTMLElement.setAttributeNodeNS +``` + +##### setPointerCapture() + +```ts +setPointerCapture(pointerId): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5141 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `pointerId` | `number` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.setPointerCapture +``` + +##### toggleAttribute() + +```ts +toggleAttribute(qualifiedName, force?): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5147 + +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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `string` | +| `force?` | `boolean` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridItemHTMLElement.toggleAttribute +``` + +##### ~~webkitMatchesSelector()~~ + +```ts +webkitMatchesSelector(selectors): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5149 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `string` | + +###### Returns + +`boolean` + +###### Deprecated + +This is a legacy alias of `matches`. + +###### Inherited from + +```ts +GridItemHTMLElement.webkitMatchesSelector +``` + +##### dispatchEvent() + +```ts +dispatchEvent(event): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5344 + +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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `Event` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridItemHTMLElement.dispatchEvent +``` + +##### attachInternals() + +```ts +attachInternals(): ElementInternals; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:6573 + +###### Returns + +`ElementInternals` + +###### Inherited from + +```ts +GridItemHTMLElement.attachInternals +``` + +##### click() + +```ts +click(): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:6574 + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.click +``` + +##### addEventListener() + +###### Call Signature + +```ts +addEventListener( + type, + listener, + options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:6575 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementEventMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `K` | +| `listener` | (`this`, `ev`) => `any` | +| `options?` | `boolean` \| `AddEventListenerOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.addEventListener +``` + +###### Call Signature + +```ts +addEventListener( + type, + listener, + options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:6576 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string` | +| `listener` | `EventListenerOrEventListenerObject` | +| `options?` | `boolean` \| `AddEventListenerOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.addEventListener +``` + +##### removeEventListener() + +###### Call Signature + +```ts +removeEventListener( + type, + listener, + options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:6577 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementEventMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `K` | +| `listener` | (`this`, `ev`) => `any` | +| `options?` | `boolean` \| `EventListenerOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.removeEventListener +``` + +###### Call Signature + +```ts +removeEventListener( + type, + listener, + options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:6578 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string` | +| `listener` | `EventListenerOrEventListenerObject` | +| `options?` | `boolean` \| `EventListenerOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.removeEventListener +``` + +##### blur() + +```ts +blur(): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:7768 + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.blur +``` + +##### focus() + +```ts +focus(options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:7769 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `FocusOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.focus +``` + +##### appendChild() + +```ts +appendChild(node): T; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10274 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `Node`\<`T`\> | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `node` | `T` | + +###### Returns + +`T` + +###### Inherited from + +```ts +GridItemHTMLElement.appendChild +``` + +##### cloneNode() + +```ts +cloneNode(deep?): Node; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10276 + +Returns a copy of node. If deep is true, the copy also includes the node's descendants. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deep?` | `boolean` | + +###### Returns + +`Node` + +###### Inherited from + +```ts +GridItemHTMLElement.cloneNode +``` + +##### compareDocumentPosition() + +```ts +compareDocumentPosition(other): number; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10278 + +Returns a bitmask indicating the position of other relative to node. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `other` | `Node` | + +###### Returns + +`number` + +###### Inherited from + +```ts +GridItemHTMLElement.compareDocumentPosition +``` + +##### contains() + +```ts +contains(other): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10280 + +Returns true if other is an inclusive descendant of node, and false otherwise. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `other` | `null` \| `Node` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridItemHTMLElement.contains +``` + +##### getRootNode() + +```ts +getRootNode(options?): Node; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10282 + +Returns node's root. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `GetRootNodeOptions` | + +###### Returns + +`Node` + +###### Inherited from + +```ts +GridItemHTMLElement.getRootNode +``` + +##### hasChildNodes() + +```ts +hasChildNodes(): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10284 + +Returns whether node has children. + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridItemHTMLElement.hasChildNodes +``` + +##### insertBefore() + +```ts +insertBefore(node, child): T; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10285 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `Node`\<`T`\> | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `node` | `T` | +| `child` | `null` \| `Node` | + +###### Returns + +`T` + +###### Inherited from + +```ts +GridItemHTMLElement.insertBefore +``` + +##### isDefaultNamespace() + +```ts +isDefaultNamespace(namespace): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10286 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridItemHTMLElement.isDefaultNamespace +``` + +##### isEqualNode() + +```ts +isEqualNode(otherNode): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10288 + +Returns whether node and otherNode have the same properties. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `otherNode` | `null` \| `Node` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridItemHTMLElement.isEqualNode +``` + +##### isSameNode() + +```ts +isSameNode(otherNode): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10289 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `otherNode` | `null` \| `Node` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridItemHTMLElement.isSameNode +``` + +##### lookupNamespaceURI() + +```ts +lookupNamespaceURI(prefix): null | string; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10290 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `prefix` | `null` \| `string` | + +###### Returns + +`null` \| `string` + +###### Inherited from + +```ts +GridItemHTMLElement.lookupNamespaceURI +``` + +##### lookupPrefix() + +```ts +lookupPrefix(namespace): null | string; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10291 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | + +###### Returns + +`null` \| `string` + +###### Inherited from + +```ts +GridItemHTMLElement.lookupPrefix +``` + +##### normalize() + +```ts +normalize(): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10293 + +Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes. + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.normalize +``` + +##### removeChild() + +```ts +removeChild(child): T; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10294 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `Node`\<`T`\> | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `child` | `T` | + +###### Returns + +`T` + +###### Inherited from + +```ts +GridItemHTMLElement.removeChild +``` + +##### replaceChild() + +```ts +replaceChild(node, child): T; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10295 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `Node`\<`T`\> | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `node` | `Node` | +| `child` | `T` | + +###### Returns + +`T` + +###### Inherited from + +```ts +GridItemHTMLElement.replaceChild +``` + +##### append() + +```ts +append(...nodes): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10697 + +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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| ...`nodes` | (`string` \| `Node`)[] | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.append +``` + +##### prepend() + +```ts +prepend(...nodes): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10703 + +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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| ...`nodes` | (`string` \| `Node`)[] | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.prepend +``` + +##### querySelector() + +###### Call Signature + +```ts +querySelector(selectors): null | HTMLElementTagNameMap[K]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10705 + +Returns the first element that is a descendant of node that matches selectors. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`null` \| `HTMLElementTagNameMap`\[`K`\] + +###### Inherited from + +```ts +GridItemHTMLElement.querySelector +``` + +###### Call Signature + +```ts +querySelector(selectors): null | SVGElementTagNameMap[K]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10706 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `SVGElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`null` \| `SVGElementTagNameMap`\[`K`\] + +###### Inherited from + +```ts +GridItemHTMLElement.querySelector +``` + +###### Call Signature + +```ts +querySelector(selectors): null | MathMLElementTagNameMap[K]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10707 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `MathMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`null` \| `MathMLElementTagNameMap`\[`K`\] + +###### Inherited from + +```ts +GridItemHTMLElement.querySelector +``` + +###### Call Signature + +```ts +querySelector(selectors): null | HTMLElementDeprecatedTagNameMap[K]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10709 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementDeprecatedTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`null` \| `HTMLElementDeprecatedTagNameMap`\[`K`\] + +###### Deprecated + +###### Inherited from + +```ts +GridItemHTMLElement.querySelector +``` + +###### Call Signature + +```ts +querySelector(selectors): null | E; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10710 + +###### Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `E` *extends* `Element`\<`E`\> | `Element` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `string` | + +###### Returns + +`null` \| `E` + +###### Inherited from + +```ts +GridItemHTMLElement.querySelector +``` + +##### querySelectorAll() + +###### Call Signature + +```ts +querySelectorAll(selectors): NodeListOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10712 + +Returns all element descendants of node that match selectors. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`NodeListOf`\<`HTMLElementTagNameMap`\[`K`\]\> + +###### Inherited from + +```ts +GridItemHTMLElement.querySelectorAll +``` + +###### Call Signature + +```ts +querySelectorAll(selectors): NodeListOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10713 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `SVGElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`NodeListOf`\<`SVGElementTagNameMap`\[`K`\]\> + +###### Inherited from + +```ts +GridItemHTMLElement.querySelectorAll +``` + +###### Call Signature + +```ts +querySelectorAll(selectors): NodeListOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10714 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `MathMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`NodeListOf`\<`MathMLElementTagNameMap`\[`K`\]\> + +###### Inherited from + +```ts +GridItemHTMLElement.querySelectorAll +``` + +###### Call Signature + +```ts +querySelectorAll(selectors): NodeListOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10716 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementDeprecatedTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`NodeListOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\> + +###### Deprecated + +###### Inherited from + +```ts +GridItemHTMLElement.querySelectorAll +``` + +###### Call Signature + +```ts +querySelectorAll(selectors): NodeListOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10717 + +###### Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `E` *extends* `Element`\<`E`\> | `Element` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `string` | + +###### Returns + +`NodeListOf`\<`E`\> + +###### Inherited from + +```ts +GridItemHTMLElement.querySelectorAll +``` + +##### replaceChildren() + +```ts +replaceChildren(...nodes): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10723 + +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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| ...`nodes` | (`string` \| `Node`)[] | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridItemHTMLElement.replaceChildren +``` + +#### Properties + +| Property | Modifier | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `_gridItemComp?` | `public` | [`GridstackItemComponent`](#gridstackitemcomponent) | Back-reference to the Angular GridStackItem component | - | [angular/projects/lib/src/lib/gridstack-item.component.ts:16](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack-item.component.ts#L16) | +| `ariaAtomic` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaAtomic` | node\_modules/typescript/lib/lib.dom.d.ts:2020 | +| `ariaAutoComplete` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaAutoComplete` | node\_modules/typescript/lib/lib.dom.d.ts:2021 | +| `ariaBusy` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaBusy` | node\_modules/typescript/lib/lib.dom.d.ts:2022 | +| `ariaChecked` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaChecked` | node\_modules/typescript/lib/lib.dom.d.ts:2023 | +| `ariaColCount` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaColCount` | node\_modules/typescript/lib/lib.dom.d.ts:2024 | +| `ariaColIndex` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaColIndex` | node\_modules/typescript/lib/lib.dom.d.ts:2025 | +| `ariaColSpan` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaColSpan` | node\_modules/typescript/lib/lib.dom.d.ts:2026 | +| `ariaCurrent` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaCurrent` | node\_modules/typescript/lib/lib.dom.d.ts:2027 | +| `ariaDisabled` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaDisabled` | node\_modules/typescript/lib/lib.dom.d.ts:2028 | +| `ariaExpanded` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaExpanded` | node\_modules/typescript/lib/lib.dom.d.ts:2029 | +| `ariaHasPopup` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaHasPopup` | node\_modules/typescript/lib/lib.dom.d.ts:2030 | +| `ariaHidden` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaHidden` | node\_modules/typescript/lib/lib.dom.d.ts:2031 | +| `ariaInvalid` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaInvalid` | node\_modules/typescript/lib/lib.dom.d.ts:2032 | +| `ariaKeyShortcuts` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaKeyShortcuts` | node\_modules/typescript/lib/lib.dom.d.ts:2033 | +| `ariaLabel` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaLabel` | node\_modules/typescript/lib/lib.dom.d.ts:2034 | +| `ariaLevel` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaLevel` | node\_modules/typescript/lib/lib.dom.d.ts:2035 | +| `ariaLive` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaLive` | node\_modules/typescript/lib/lib.dom.d.ts:2036 | +| `ariaModal` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaModal` | node\_modules/typescript/lib/lib.dom.d.ts:2037 | +| `ariaMultiLine` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaMultiLine` | node\_modules/typescript/lib/lib.dom.d.ts:2038 | +| `ariaMultiSelectable` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaMultiSelectable` | node\_modules/typescript/lib/lib.dom.d.ts:2039 | +| `ariaOrientation` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaOrientation` | node\_modules/typescript/lib/lib.dom.d.ts:2040 | +| `ariaPlaceholder` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaPlaceholder` | node\_modules/typescript/lib/lib.dom.d.ts:2041 | +| `ariaPosInSet` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaPosInSet` | node\_modules/typescript/lib/lib.dom.d.ts:2042 | +| `ariaPressed` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaPressed` | node\_modules/typescript/lib/lib.dom.d.ts:2043 | +| `ariaReadOnly` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaReadOnly` | node\_modules/typescript/lib/lib.dom.d.ts:2044 | +| `ariaRequired` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaRequired` | node\_modules/typescript/lib/lib.dom.d.ts:2045 | +| `ariaRoleDescription` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaRoleDescription` | node\_modules/typescript/lib/lib.dom.d.ts:2046 | +| `ariaRowCount` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaRowCount` | node\_modules/typescript/lib/lib.dom.d.ts:2047 | +| `ariaRowIndex` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaRowIndex` | node\_modules/typescript/lib/lib.dom.d.ts:2048 | +| `ariaRowSpan` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaRowSpan` | node\_modules/typescript/lib/lib.dom.d.ts:2049 | +| `ariaSelected` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaSelected` | node\_modules/typescript/lib/lib.dom.d.ts:2050 | +| `ariaSetSize` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaSetSize` | node\_modules/typescript/lib/lib.dom.d.ts:2051 | +| `ariaSort` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaSort` | node\_modules/typescript/lib/lib.dom.d.ts:2052 | +| `ariaValueMax` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaValueMax` | node\_modules/typescript/lib/lib.dom.d.ts:2053 | +| `ariaValueMin` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaValueMin` | node\_modules/typescript/lib/lib.dom.d.ts:2054 | +| `ariaValueNow` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaValueNow` | node\_modules/typescript/lib/lib.dom.d.ts:2055 | +| `ariaValueText` | `public` | `null` \| `string` | - | `GridItemHTMLElement.ariaValueText` | node\_modules/typescript/lib/lib.dom.d.ts:2056 | +| `role` | `public` | `null` \| `string` | - | `GridItemHTMLElement.role` | node\_modules/typescript/lib/lib.dom.d.ts:2057 | +| `attributes` | `readonly` | `NamedNodeMap` | - | `GridItemHTMLElement.attributes` | node\_modules/typescript/lib/lib.dom.d.ts:5041 | +| `classList` | `readonly` | `DOMTokenList` | Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object. | `GridItemHTMLElement.classList` | node\_modules/typescript/lib/lib.dom.d.ts:5043 | +| `className` | `public` | `string` | Returns the value of element's class content attribute. Can be set to change it. | `GridItemHTMLElement.className` | node\_modules/typescript/lib/lib.dom.d.ts:5045 | +| `clientHeight` | `readonly` | `number` | - | `GridItemHTMLElement.clientHeight` | node\_modules/typescript/lib/lib.dom.d.ts:5046 | +| `clientLeft` | `readonly` | `number` | - | `GridItemHTMLElement.clientLeft` | node\_modules/typescript/lib/lib.dom.d.ts:5047 | +| `clientTop` | `readonly` | `number` | - | `GridItemHTMLElement.clientTop` | node\_modules/typescript/lib/lib.dom.d.ts:5048 | +| `clientWidth` | `readonly` | `number` | - | `GridItemHTMLElement.clientWidth` | node\_modules/typescript/lib/lib.dom.d.ts:5049 | +| `id` | `public` | `string` | Returns the value of element's id content attribute. Can be set to change it. | `GridItemHTMLElement.id` | node\_modules/typescript/lib/lib.dom.d.ts:5051 | +| `localName` | `readonly` | `string` | Returns the local name. | `GridItemHTMLElement.localName` | node\_modules/typescript/lib/lib.dom.d.ts:5053 | +| `namespaceURI` | `readonly` | `null` \| `string` | Returns the namespace. | [`GridCompHTMLElement`](gridstack.component.md#gridcomphtmlelement).[`namespaceURI`](gridstack.component.md#namespaceuri) | node\_modules/typescript/lib/lib.dom.d.ts:5055 | +| `onfullscreenchange` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onfullscreenchange` | node\_modules/typescript/lib/lib.dom.d.ts:5056 | +| `onfullscreenerror` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onfullscreenerror` | node\_modules/typescript/lib/lib.dom.d.ts:5057 | +| `outerHTML` | `public` | `string` | - | `GridItemHTMLElement.outerHTML` | node\_modules/typescript/lib/lib.dom.d.ts:5058 | +| `ownerDocument` | `readonly` | `Document` | Returns the node document. Returns null for documents. | `GridItemHTMLElement.ownerDocument` | node\_modules/typescript/lib/lib.dom.d.ts:5059 | +| `part` | `readonly` | `DOMTokenList` | - | `GridItemHTMLElement.part` | node\_modules/typescript/lib/lib.dom.d.ts:5060 | +| `prefix` | `readonly` | `null` \| `string` | Returns the namespace prefix. | [`GridCompHTMLElement`](gridstack.component.md#gridcomphtmlelement).[`prefix`](gridstack.component.md#prefix) | node\_modules/typescript/lib/lib.dom.d.ts:5062 | +| `scrollHeight` | `readonly` | `number` | - | `GridItemHTMLElement.scrollHeight` | node\_modules/typescript/lib/lib.dom.d.ts:5063 | +| `scrollLeft` | `public` | `number` | - | `GridItemHTMLElement.scrollLeft` | node\_modules/typescript/lib/lib.dom.d.ts:5064 | +| `scrollTop` | `public` | `number` | - | `GridItemHTMLElement.scrollTop` | node\_modules/typescript/lib/lib.dom.d.ts:5065 | +| `scrollWidth` | `readonly` | `number` | - | `GridItemHTMLElement.scrollWidth` | node\_modules/typescript/lib/lib.dom.d.ts:5066 | +| `shadowRoot` | `readonly` | `null` \| `ShadowRoot` | Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise. | [`GridCompHTMLElement`](gridstack.component.md#gridcomphtmlelement).[`shadowRoot`](gridstack.component.md#shadowroot) | node\_modules/typescript/lib/lib.dom.d.ts:5068 | +| `slot` | `public` | `string` | Returns the value of element's slot content attribute. Can be set to change it. | `GridItemHTMLElement.slot` | node\_modules/typescript/lib/lib.dom.d.ts:5070 | +| `tagName` | `readonly` | `string` | Returns the HTML-uppercased qualified name. | `GridItemHTMLElement.tagName` | node\_modules/typescript/lib/lib.dom.d.ts:5072 | +| `style` | `readonly` | `CSSStyleDeclaration` | - | `GridItemHTMLElement.style` | node\_modules/typescript/lib/lib.dom.d.ts:5162 | +| `contentEditable` | `public` | `string` | - | `GridItemHTMLElement.contentEditable` | node\_modules/typescript/lib/lib.dom.d.ts:5166 | +| `enterKeyHint` | `public` | `string` | - | `GridItemHTMLElement.enterKeyHint` | node\_modules/typescript/lib/lib.dom.d.ts:5167 | +| `inputMode` | `public` | `string` | - | `GridItemHTMLElement.inputMode` | node\_modules/typescript/lib/lib.dom.d.ts:5168 | +| `isContentEditable` | `readonly` | `boolean` | - | `GridItemHTMLElement.isContentEditable` | node\_modules/typescript/lib/lib.dom.d.ts:5169 | +| `onabort` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user aborts the download. **Param** The event. | `GridItemHTMLElement.onabort` | node\_modules/typescript/lib/lib.dom.d.ts:5856 | +| `onanimationcancel` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onanimationcancel` | node\_modules/typescript/lib/lib.dom.d.ts:5857 | +| `onanimationend` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onanimationend` | node\_modules/typescript/lib/lib.dom.d.ts:5858 | +| `onanimationiteration` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onanimationiteration` | node\_modules/typescript/lib/lib.dom.d.ts:5859 | +| `onanimationstart` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onanimationstart` | node\_modules/typescript/lib/lib.dom.d.ts:5860 | +| `onauxclick` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onauxclick` | node\_modules/typescript/lib/lib.dom.d.ts:5861 | +| `onbeforeinput` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onbeforeinput` | node\_modules/typescript/lib/lib.dom.d.ts:5862 | +| `onblur` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the object loses the input focus. **Param** The focus event. | `GridItemHTMLElement.onblur` | node\_modules/typescript/lib/lib.dom.d.ts:5867 | +| `oncancel` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.oncancel` | node\_modules/typescript/lib/lib.dom.d.ts:5868 | +| `oncanplay` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when playback is possible, but would require further buffering. **Param** The event. | `GridItemHTMLElement.oncanplay` | node\_modules/typescript/lib/lib.dom.d.ts:5873 | +| `oncanplaythrough` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.oncanplaythrough` | node\_modules/typescript/lib/lib.dom.d.ts:5874 | +| `onchange` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the contents of the object or selection have changed. **Param** The event. | `GridItemHTMLElement.onchange` | node\_modules/typescript/lib/lib.dom.d.ts:5879 | +| `onclick` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user clicks the left mouse button on the object **Param** The mouse event. | `GridItemHTMLElement.onclick` | node\_modules/typescript/lib/lib.dom.d.ts:5884 | +| `onclose` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onclose` | node\_modules/typescript/lib/lib.dom.d.ts:5885 | +| `oncontextmenu` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user clicks the right mouse button in the client area, opening the context menu. **Param** The mouse event. | `GridItemHTMLElement.oncontextmenu` | node\_modules/typescript/lib/lib.dom.d.ts:5890 | +| `oncopy` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.oncopy` | node\_modules/typescript/lib/lib.dom.d.ts:5891 | +| `oncuechange` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.oncuechange` | node\_modules/typescript/lib/lib.dom.d.ts:5892 | +| `oncut` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.oncut` | node\_modules/typescript/lib/lib.dom.d.ts:5893 | +| `ondblclick` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user double-clicks the object. **Param** The mouse event. | `GridItemHTMLElement.ondblclick` | node\_modules/typescript/lib/lib.dom.d.ts:5898 | +| `ondrag` | `public` | `null` \| (`this`, `ev`) => `any` | Fires on the source object continuously during a drag operation. **Param** The event. | `GridItemHTMLElement.ondrag` | node\_modules/typescript/lib/lib.dom.d.ts:5903 | +| `ondragend` | `public` | `null` \| (`this`, `ev`) => `any` | Fires on the source object when the user releases the mouse at the close of a drag operation. **Param** The event. | `GridItemHTMLElement.ondragend` | node\_modules/typescript/lib/lib.dom.d.ts:5908 | +| `ondragenter` | `public` | `null` \| (`this`, `ev`) => `any` | Fires on the target element when the user drags the object to a valid drop target. **Param** The drag event. | `GridItemHTMLElement.ondragenter` | node\_modules/typescript/lib/lib.dom.d.ts:5913 | +| `ondragleave` | `public` | `null` \| (`this`, `ev`) => `any` | Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation. **Param** The drag event. | `GridItemHTMLElement.ondragleave` | node\_modules/typescript/lib/lib.dom.d.ts:5918 | +| `ondragover` | `public` | `null` \| (`this`, `ev`) => `any` | Fires on the target element continuously while the user drags the object over a valid drop target. **Param** The event. | `GridItemHTMLElement.ondragover` | node\_modules/typescript/lib/lib.dom.d.ts:5923 | +| `ondragstart` | `public` | `null` \| (`this`, `ev`) => `any` | Fires on the source object when the user starts to drag a text selection or selected object. **Param** The event. | `GridItemHTMLElement.ondragstart` | node\_modules/typescript/lib/lib.dom.d.ts:5928 | +| `ondrop` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.ondrop` | node\_modules/typescript/lib/lib.dom.d.ts:5929 | +| `ondurationchange` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the duration attribute is updated. **Param** The event. | `GridItemHTMLElement.ondurationchange` | node\_modules/typescript/lib/lib.dom.d.ts:5934 | +| `onemptied` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the media element is reset to its initial state. **Param** The event. | `GridItemHTMLElement.onemptied` | node\_modules/typescript/lib/lib.dom.d.ts:5939 | +| `onended` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the end of playback is reached. **Param** The event | `GridItemHTMLElement.onended` | node\_modules/typescript/lib/lib.dom.d.ts:5944 | +| `onerror` | `public` | `OnErrorEventHandler` | Fires when an error occurs during object loading. **Param** The event. | `GridItemHTMLElement.onerror` | node\_modules/typescript/lib/lib.dom.d.ts:5949 | +| `onfocus` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the object receives focus. **Param** The event. | `GridItemHTMLElement.onfocus` | node\_modules/typescript/lib/lib.dom.d.ts:5954 | +| `onformdata` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onformdata` | node\_modules/typescript/lib/lib.dom.d.ts:5955 | +| `ongotpointercapture` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.ongotpointercapture` | node\_modules/typescript/lib/lib.dom.d.ts:5956 | +| `oninput` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.oninput` | node\_modules/typescript/lib/lib.dom.d.ts:5957 | +| `oninvalid` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.oninvalid` | node\_modules/typescript/lib/lib.dom.d.ts:5958 | +| `onkeydown` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user presses a key. **Param** The keyboard event | `GridItemHTMLElement.onkeydown` | node\_modules/typescript/lib/lib.dom.d.ts:5963 | +| ~~`onkeypress`~~ | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user presses an alphanumeric key. **Param** The event. **Deprecated** | `GridItemHTMLElement.onkeypress` | node\_modules/typescript/lib/lib.dom.d.ts:5969 | +| `onkeyup` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user releases a key. **Param** The keyboard event | `GridItemHTMLElement.onkeyup` | node\_modules/typescript/lib/lib.dom.d.ts:5974 | +| `onload` | `public` | `null` \| (`this`, `ev`) => `any` | Fires immediately after the browser loads the object. **Param** The event. | `GridItemHTMLElement.onload` | node\_modules/typescript/lib/lib.dom.d.ts:5979 | +| `onloadeddata` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when media data is loaded at the current playback position. **Param** The event. | `GridItemHTMLElement.onloadeddata` | node\_modules/typescript/lib/lib.dom.d.ts:5984 | +| `onloadedmetadata` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the duration and dimensions of the media have been determined. **Param** The event. | `GridItemHTMLElement.onloadedmetadata` | node\_modules/typescript/lib/lib.dom.d.ts:5989 | +| `onloadstart` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when Internet Explorer begins looking for media data. **Param** The event. | `GridItemHTMLElement.onloadstart` | node\_modules/typescript/lib/lib.dom.d.ts:5994 | +| `onlostpointercapture` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onlostpointercapture` | node\_modules/typescript/lib/lib.dom.d.ts:5995 | +| `onmousedown` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user clicks the object with either mouse button. **Param** The mouse event. | `GridItemHTMLElement.onmousedown` | node\_modules/typescript/lib/lib.dom.d.ts:6000 | +| `onmouseenter` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onmouseenter` | node\_modules/typescript/lib/lib.dom.d.ts:6001 | +| `onmouseleave` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onmouseleave` | node\_modules/typescript/lib/lib.dom.d.ts:6002 | +| `onmousemove` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user moves the mouse over the object. **Param** The mouse event. | `GridItemHTMLElement.onmousemove` | node\_modules/typescript/lib/lib.dom.d.ts:6007 | +| `onmouseout` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user moves the mouse pointer outside the boundaries of the object. **Param** The mouse event. | `GridItemHTMLElement.onmouseout` | node\_modules/typescript/lib/lib.dom.d.ts:6012 | +| `onmouseover` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user moves the mouse pointer into the object. **Param** The mouse event. | `GridItemHTMLElement.onmouseover` | node\_modules/typescript/lib/lib.dom.d.ts:6017 | +| `onmouseup` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user releases a mouse button while the mouse is over the object. **Param** The mouse event. | `GridItemHTMLElement.onmouseup` | node\_modules/typescript/lib/lib.dom.d.ts:6022 | +| `onpaste` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onpaste` | node\_modules/typescript/lib/lib.dom.d.ts:6023 | +| `onpause` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when playback is paused. **Param** The event. | `GridItemHTMLElement.onpause` | node\_modules/typescript/lib/lib.dom.d.ts:6028 | +| `onplay` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the play method is requested. **Param** The event. | `GridItemHTMLElement.onplay` | node\_modules/typescript/lib/lib.dom.d.ts:6033 | +| `onplaying` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the audio or video has started playing. **Param** The event. | `GridItemHTMLElement.onplaying` | node\_modules/typescript/lib/lib.dom.d.ts:6038 | +| `onpointercancel` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onpointercancel` | node\_modules/typescript/lib/lib.dom.d.ts:6039 | +| `onpointerdown` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onpointerdown` | node\_modules/typescript/lib/lib.dom.d.ts:6040 | +| `onpointerenter` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onpointerenter` | node\_modules/typescript/lib/lib.dom.d.ts:6041 | +| `onpointerleave` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onpointerleave` | node\_modules/typescript/lib/lib.dom.d.ts:6042 | +| `onpointermove` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onpointermove` | node\_modules/typescript/lib/lib.dom.d.ts:6043 | +| `onpointerout` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onpointerout` | node\_modules/typescript/lib/lib.dom.d.ts:6044 | +| `onpointerover` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onpointerover` | node\_modules/typescript/lib/lib.dom.d.ts:6045 | +| `onpointerup` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onpointerup` | node\_modules/typescript/lib/lib.dom.d.ts:6046 | +| `onprogress` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs to indicate progress while downloading media data. **Param** The event. | `GridItemHTMLElement.onprogress` | node\_modules/typescript/lib/lib.dom.d.ts:6051 | +| `onratechange` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the playback rate is increased or decreased. **Param** The event. | `GridItemHTMLElement.onratechange` | node\_modules/typescript/lib/lib.dom.d.ts:6056 | +| `onreset` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user resets a form. **Param** The event. | `GridItemHTMLElement.onreset` | node\_modules/typescript/lib/lib.dom.d.ts:6061 | +| `onresize` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onresize` | node\_modules/typescript/lib/lib.dom.d.ts:6062 | +| `onscroll` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user repositions the scroll box in the scroll bar on the object. **Param** The event. | `GridItemHTMLElement.onscroll` | node\_modules/typescript/lib/lib.dom.d.ts:6067 | +| `onsecuritypolicyviolation` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onsecuritypolicyviolation` | node\_modules/typescript/lib/lib.dom.d.ts:6068 | +| `onseeked` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the seek operation ends. **Param** The event. | `GridItemHTMLElement.onseeked` | node\_modules/typescript/lib/lib.dom.d.ts:6073 | +| `onseeking` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the current playback position is moved. **Param** The event. | `GridItemHTMLElement.onseeking` | node\_modules/typescript/lib/lib.dom.d.ts:6078 | +| `onselect` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the current selection changes. **Param** The event. | `GridItemHTMLElement.onselect` | node\_modules/typescript/lib/lib.dom.d.ts:6083 | +| `onselectionchange` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onselectionchange` | node\_modules/typescript/lib/lib.dom.d.ts:6084 | +| `onselectstart` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onselectstart` | node\_modules/typescript/lib/lib.dom.d.ts:6085 | +| `onslotchange` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onslotchange` | node\_modules/typescript/lib/lib.dom.d.ts:6086 | +| `onstalled` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the download has stopped. **Param** The event. | `GridItemHTMLElement.onstalled` | node\_modules/typescript/lib/lib.dom.d.ts:6091 | +| `onsubmit` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onsubmit` | node\_modules/typescript/lib/lib.dom.d.ts:6092 | +| `onsuspend` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs if the load operation has been intentionally halted. **Param** The event. | `GridItemHTMLElement.onsuspend` | node\_modules/typescript/lib/lib.dom.d.ts:6097 | +| `ontimeupdate` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs to indicate the current playback position. **Param** The event. | `GridItemHTMLElement.ontimeupdate` | node\_modules/typescript/lib/lib.dom.d.ts:6102 | +| `ontoggle` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.ontoggle` | node\_modules/typescript/lib/lib.dom.d.ts:6103 | +| `ontouchcancel?` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.ontouchcancel` | node\_modules/typescript/lib/lib.dom.d.ts:6104 | +| `ontouchend?` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.ontouchend` | node\_modules/typescript/lib/lib.dom.d.ts:6105 | +| `ontouchmove?` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.ontouchmove` | node\_modules/typescript/lib/lib.dom.d.ts:6106 | +| `ontouchstart?` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.ontouchstart` | node\_modules/typescript/lib/lib.dom.d.ts:6107 | +| `ontransitioncancel` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.ontransitioncancel` | node\_modules/typescript/lib/lib.dom.d.ts:6108 | +| `ontransitionend` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.ontransitionend` | node\_modules/typescript/lib/lib.dom.d.ts:6109 | +| `ontransitionrun` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.ontransitionrun` | node\_modules/typescript/lib/lib.dom.d.ts:6110 | +| `ontransitionstart` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.ontransitionstart` | node\_modules/typescript/lib/lib.dom.d.ts:6111 | +| `onvolumechange` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the volume is changed, or playback is muted or unmuted. **Param** The event. | `GridItemHTMLElement.onvolumechange` | node\_modules/typescript/lib/lib.dom.d.ts:6116 | +| `onwaiting` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when playback stops because the next frame of a video resource is not available. **Param** The event. | `GridItemHTMLElement.onwaiting` | node\_modules/typescript/lib/lib.dom.d.ts:6121 | +| ~~`onwebkitanimationend`~~ | `public` | `null` \| (`this`, `ev`) => `any` | **Deprecated** This is a legacy alias of `onanimationend`. | `GridItemHTMLElement.onwebkitanimationend` | node\_modules/typescript/lib/lib.dom.d.ts:6123 | +| ~~`onwebkitanimationiteration`~~ | `public` | `null` \| (`this`, `ev`) => `any` | **Deprecated** This is a legacy alias of `onanimationiteration`. | `GridItemHTMLElement.onwebkitanimationiteration` | node\_modules/typescript/lib/lib.dom.d.ts:6125 | +| ~~`onwebkitanimationstart`~~ | `public` | `null` \| (`this`, `ev`) => `any` | **Deprecated** This is a legacy alias of `onanimationstart`. | `GridItemHTMLElement.onwebkitanimationstart` | node\_modules/typescript/lib/lib.dom.d.ts:6127 | +| ~~`onwebkittransitionend`~~ | `public` | `null` \| (`this`, `ev`) => `any` | **Deprecated** This is a legacy alias of `ontransitionend`. | `GridItemHTMLElement.onwebkittransitionend` | node\_modules/typescript/lib/lib.dom.d.ts:6129 | +| `onwheel` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridItemHTMLElement.onwheel` | node\_modules/typescript/lib/lib.dom.d.ts:6130 | +| `accessKey` | `public` | `string` | - | `GridItemHTMLElement.accessKey` | node\_modules/typescript/lib/lib.dom.d.ts:6555 | +| `accessKeyLabel` | `readonly` | `string` | - | `GridItemHTMLElement.accessKeyLabel` | node\_modules/typescript/lib/lib.dom.d.ts:6556 | +| `autocapitalize` | `public` | `string` | - | `GridItemHTMLElement.autocapitalize` | node\_modules/typescript/lib/lib.dom.d.ts:6557 | +| `dir` | `public` | `string` | - | `GridItemHTMLElement.dir` | node\_modules/typescript/lib/lib.dom.d.ts:6558 | +| `draggable` | `public` | `boolean` | - | `GridItemHTMLElement.draggable` | node\_modules/typescript/lib/lib.dom.d.ts:6559 | +| `hidden` | `public` | `boolean` | - | `GridItemHTMLElement.hidden` | node\_modules/typescript/lib/lib.dom.d.ts:6560 | +| `inert` | `public` | `boolean` | - | `GridItemHTMLElement.inert` | node\_modules/typescript/lib/lib.dom.d.ts:6561 | +| `innerText` | `public` | `string` | - | `GridItemHTMLElement.innerText` | node\_modules/typescript/lib/lib.dom.d.ts:6562 | +| `lang` | `public` | `string` | - | `GridItemHTMLElement.lang` | node\_modules/typescript/lib/lib.dom.d.ts:6563 | +| `offsetHeight` | `readonly` | `number` | - | `GridItemHTMLElement.offsetHeight` | node\_modules/typescript/lib/lib.dom.d.ts:6564 | +| `offsetLeft` | `readonly` | `number` | - | `GridItemHTMLElement.offsetLeft` | node\_modules/typescript/lib/lib.dom.d.ts:6565 | +| `offsetParent` | `readonly` | `null` \| `Element` | - | [`GridCompHTMLElement`](gridstack.component.md#gridcomphtmlelement).[`offsetParent`](gridstack.component.md#offsetparent) | node\_modules/typescript/lib/lib.dom.d.ts:6566 | +| `offsetTop` | `readonly` | `number` | - | `GridItemHTMLElement.offsetTop` | node\_modules/typescript/lib/lib.dom.d.ts:6567 | +| `offsetWidth` | `readonly` | `number` | - | `GridItemHTMLElement.offsetWidth` | node\_modules/typescript/lib/lib.dom.d.ts:6568 | +| `outerText` | `public` | `string` | - | `GridItemHTMLElement.outerText` | node\_modules/typescript/lib/lib.dom.d.ts:6569 | +| `spellcheck` | `public` | `boolean` | - | `GridItemHTMLElement.spellcheck` | node\_modules/typescript/lib/lib.dom.d.ts:6570 | +| `title` | `public` | `string` | - | `GridItemHTMLElement.title` | node\_modules/typescript/lib/lib.dom.d.ts:6571 | +| `translate` | `public` | `boolean` | - | `GridItemHTMLElement.translate` | node\_modules/typescript/lib/lib.dom.d.ts:6572 | +| `autofocus` | `public` | `boolean` | - | `GridItemHTMLElement.autofocus` | node\_modules/typescript/lib/lib.dom.d.ts:7764 | +| `dataset` | `readonly` | `DOMStringMap` | - | `GridItemHTMLElement.dataset` | node\_modules/typescript/lib/lib.dom.d.ts:7765 | +| `nonce?` | `public` | `string` | - | `GridItemHTMLElement.nonce` | node\_modules/typescript/lib/lib.dom.d.ts:7766 | +| `tabIndex` | `public` | `number` | - | `GridItemHTMLElement.tabIndex` | node\_modules/typescript/lib/lib.dom.d.ts:7767 | +| `innerHTML` | `public` | `string` | - | `GridItemHTMLElement.innerHTML` | node\_modules/typescript/lib/lib.dom.d.ts:9130 | +| `baseURI` | `readonly` | `string` | Returns node's node document's document base URL. | `GridItemHTMLElement.baseURI` | node\_modules/typescript/lib/lib.dom.d.ts:10249 | +| `childNodes` | `readonly` | `NodeListOf`\<`ChildNode`\> | Returns the children. | `GridItemHTMLElement.childNodes` | node\_modules/typescript/lib/lib.dom.d.ts:10251 | +| `firstChild` | `readonly` | `null` \| `ChildNode` | Returns the first child. | [`GridCompHTMLElement`](gridstack.component.md#gridcomphtmlelement).[`firstChild`](gridstack.component.md#firstchild) | node\_modules/typescript/lib/lib.dom.d.ts:10253 | +| `isConnected` | `readonly` | `boolean` | Returns true if node is connected and false otherwise. | `GridItemHTMLElement.isConnected` | node\_modules/typescript/lib/lib.dom.d.ts:10255 | +| `lastChild` | `readonly` | `null` \| `ChildNode` | Returns the last child. | [`GridCompHTMLElement`](gridstack.component.md#gridcomphtmlelement).[`lastChild`](gridstack.component.md#lastchild) | node\_modules/typescript/lib/lib.dom.d.ts:10257 | +| `nextSibling` | `readonly` | `null` \| `ChildNode` | Returns the next sibling. | [`GridCompHTMLElement`](gridstack.component.md#gridcomphtmlelement).[`nextSibling`](gridstack.component.md#nextsibling) | node\_modules/typescript/lib/lib.dom.d.ts:10259 | +| `nodeName` | `readonly` | `string` | Returns a string appropriate for the type of node. | `GridItemHTMLElement.nodeName` | node\_modules/typescript/lib/lib.dom.d.ts:10261 | +| `nodeType` | `readonly` | `number` | Returns the type of node. | `GridItemHTMLElement.nodeType` | node\_modules/typescript/lib/lib.dom.d.ts:10263 | +| `nodeValue` | `public` | `null` \| `string` | - | [`GridCompHTMLElement`](gridstack.component.md#gridcomphtmlelement).[`nodeValue`](gridstack.component.md#nodevalue) | node\_modules/typescript/lib/lib.dom.d.ts:10264 | +| `parentElement` | `readonly` | `null` \| `HTMLElement` | Returns the parent element. | [`GridCompHTMLElement`](gridstack.component.md#gridcomphtmlelement).[`parentElement`](gridstack.component.md#parentelement) | node\_modules/typescript/lib/lib.dom.d.ts:10268 | +| `parentNode` | `readonly` | `null` \| `ParentNode` | Returns the parent. | [`GridCompHTMLElement`](gridstack.component.md#gridcomphtmlelement).[`parentNode`](gridstack.component.md#parentnode) | node\_modules/typescript/lib/lib.dom.d.ts:10270 | +| `previousSibling` | `readonly` | `null` \| `ChildNode` | Returns the previous sibling. | [`GridCompHTMLElement`](gridstack.component.md#gridcomphtmlelement).[`previousSibling`](gridstack.component.md#previoussibling) | node\_modules/typescript/lib/lib.dom.d.ts:10272 | +| `textContent` | `public` | `null` \| `string` | - | [`GridCompHTMLElement`](gridstack.component.md#gridcomphtmlelement).[`textContent`](gridstack.component.md#textcontent) | node\_modules/typescript/lib/lib.dom.d.ts:10273 | +| `ELEMENT_NODE` | `readonly` | `1` | node is an element. | `GridItemHTMLElement.ELEMENT_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10297 | +| `ATTRIBUTE_NODE` | `readonly` | `2` | - | `GridItemHTMLElement.ATTRIBUTE_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10298 | +| `TEXT_NODE` | `readonly` | `3` | node is a Text node. | `GridItemHTMLElement.TEXT_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10300 | +| `CDATA_SECTION_NODE` | `readonly` | `4` | node is a CDATASection node. | `GridItemHTMLElement.CDATA_SECTION_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10302 | +| `ENTITY_REFERENCE_NODE` | `readonly` | `5` | - | `GridItemHTMLElement.ENTITY_REFERENCE_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10303 | +| `ENTITY_NODE` | `readonly` | `6` | - | `GridItemHTMLElement.ENTITY_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10304 | +| `PROCESSING_INSTRUCTION_NODE` | `readonly` | `7` | node is a ProcessingInstruction node. | `GridItemHTMLElement.PROCESSING_INSTRUCTION_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10306 | +| `COMMENT_NODE` | `readonly` | `8` | node is a Comment node. | `GridItemHTMLElement.COMMENT_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10308 | +| `DOCUMENT_NODE` | `readonly` | `9` | node is a document. | `GridItemHTMLElement.DOCUMENT_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10310 | +| `DOCUMENT_TYPE_NODE` | `readonly` | `10` | node is a doctype. | `GridItemHTMLElement.DOCUMENT_TYPE_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10312 | +| `DOCUMENT_FRAGMENT_NODE` | `readonly` | `11` | node is a DocumentFragment node. | `GridItemHTMLElement.DOCUMENT_FRAGMENT_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10314 | +| `NOTATION_NODE` | `readonly` | `12` | - | `GridItemHTMLElement.NOTATION_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10315 | +| `DOCUMENT_POSITION_DISCONNECTED` | `readonly` | `1` | Set when node and other are not in the same tree. | `GridItemHTMLElement.DOCUMENT_POSITION_DISCONNECTED` | node\_modules/typescript/lib/lib.dom.d.ts:10317 | +| `DOCUMENT_POSITION_PRECEDING` | `readonly` | `2` | Set when other is preceding node. | `GridItemHTMLElement.DOCUMENT_POSITION_PRECEDING` | node\_modules/typescript/lib/lib.dom.d.ts:10319 | +| `DOCUMENT_POSITION_FOLLOWING` | `readonly` | `4` | Set when other is following node. | `GridItemHTMLElement.DOCUMENT_POSITION_FOLLOWING` | node\_modules/typescript/lib/lib.dom.d.ts:10321 | +| `DOCUMENT_POSITION_CONTAINS` | `readonly` | `8` | Set when other is an ancestor of node. | `GridItemHTMLElement.DOCUMENT_POSITION_CONTAINS` | node\_modules/typescript/lib/lib.dom.d.ts:10323 | +| `DOCUMENT_POSITION_CONTAINED_BY` | `readonly` | `16` | Set when other is a descendant of node. | `GridItemHTMLElement.DOCUMENT_POSITION_CONTAINED_BY` | node\_modules/typescript/lib/lib.dom.d.ts:10325 | +| `DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC` | `readonly` | `32` | - | `GridItemHTMLElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC` | node\_modules/typescript/lib/lib.dom.d.ts:10326 | +| `nextElementSibling` | `readonly` | `null` \| `Element` | Returns the first following sibling that is an element, and null otherwise. | `GridItemHTMLElement.nextElementSibling` | node\_modules/typescript/lib/lib.dom.d.ts:10416 | +| `previousElementSibling` | `readonly` | `null` \| `Element` | Returns the first preceding sibling that is an element, and null otherwise. | `GridItemHTMLElement.previousElementSibling` | node\_modules/typescript/lib/lib.dom.d.ts:10418 | +| `childElementCount` | `readonly` | `number` | - | `GridItemHTMLElement.childElementCount` | node\_modules/typescript/lib/lib.dom.d.ts:10685 | +| `children` | `readonly` | `HTMLCollection` | Returns the child elements. | `GridItemHTMLElement.children` | node\_modules/typescript/lib/lib.dom.d.ts:10687 | +| `firstElementChild` | `readonly` | `null` \| `Element` | Returns the first child that is an element, and null otherwise. | [`GridCompHTMLElement`](gridstack.component.md#gridcomphtmlelement).[`firstElementChild`](gridstack.component.md#firstelementchild) | node\_modules/typescript/lib/lib.dom.d.ts:10689 | +| `lastElementChild` | `readonly` | `null` \| `Element` | Returns the last child that is an element, and null otherwise. | [`GridCompHTMLElement`](gridstack.component.md#gridcomphtmlelement).[`lastElementChild`](gridstack.component.md#lastelementchild) | node\_modules/typescript/lib/lib.dom.d.ts:10691 | +| `assignedSlot` | `readonly` | `null` \| `HTMLSlotElement` | - | `GridItemHTMLElement.assignedSlot` | node\_modules/typescript/lib/lib.dom.d.ts:13933 | diff --git a/angular/docs/api/gridstack.component.md b/angular/docs/api/gridstack.component.md new file mode 100644 index 000000000..c642e0257 --- /dev/null +++ b/angular/docs/api/gridstack.component.md @@ -0,0 +1,3300 @@ +# gridstack.component + +## Classes + +### GridstackComponent + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:85](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L85) + +Angular component wrapper for GridStack. + +This component provides Angular integration for GridStack grids, handling: +- Grid initialization and lifecycle +- Dynamic component creation and management +- Event binding and emission +- Integration with Angular change detection + +Use in combination with GridstackItemComponent for individual grid items. + +#### Example + +```html + +
Drag widgets here
+
+``` + +#### Implements + +- `OnInit` +- `AfterContentInit` +- `OnDestroy` + +#### Accessors + +##### options + +###### Get Signature + +```ts +get options(): GridStackOptions; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:120](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L120) + +Get the current running grid options + +###### Returns + +`GridStackOptions` + +###### Set Signature + +```ts +set options(o): void; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:112](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L112) + +Grid configuration options. +Can be set before grid initialization or updated after grid is created. + +###### Example + +```typescript +gridOptions: GridStackOptions = { + column: 12, + cellHeight: 'auto', + animate: true +}; +``` + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `o` | `GridStackOptions` | + +###### Returns + +`void` + +##### el + +###### Get Signature + +```ts +get el(): GridCompHTMLElement; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:190](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L190) + +Get the native DOM element that contains grid-specific fields. +This element has GridStack properties attached to it. + +###### Returns + +[`GridCompHTMLElement`](#gridcomphtmlelement) + +##### grid + +###### Get Signature + +```ts +get grid(): undefined | GridStack; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:201](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L201) + +Get the underlying GridStack instance. +Use this to access GridStack API methods directly. + +###### Example + +```typescript +this.gridComponent.grid.addWidget({x: 0, y: 0, w: 2, h: 1}); +``` + +###### Returns + +`undefined` \| `GridStack` + +#### Constructors + +##### Constructor + +```ts +new GridstackComponent(elementRef): GridstackComponent; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:252](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L252) + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `elementRef` | `ElementRef`\<[`GridCompHTMLElement`](#gridcomphtmlelement)\> | + +###### Returns + +[`GridstackComponent`](#gridstackcomponent) + +#### Methods + +##### addComponentToSelectorType() + +```ts +static addComponentToSelectorType(typeList): void; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:234](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L234) + +Register a list of Angular components for dynamic creation. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `typeList` | `Type`\<`Object`\>[] | Array of component types to register | + +###### Returns + +`void` + +###### Example + +```typescript +GridstackComponent.addComponentToSelectorType([ + MyWidgetComponent, + AnotherWidgetComponent +]); +``` + +##### getSelector() + +```ts +static getSelector(type): string; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:243](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L243) + +Extract the selector string from an Angular component type. + +###### Parameters + +| Parameter | Type | Description | +| ------ | ------ | ------ | +| `type` | `Type`\<`Object`\> | The component type to get selector from | + +###### Returns + +`string` + +The component's selector string + +##### ngOnInit() + +```ts +ngOnInit(): void; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:266](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L266) + +A callback method that is invoked immediately after the +default change detector has checked the directive's +data-bound properties for the first time, +and before any of the view or content children have been checked. +It is invoked only once when the directive is instantiated. + +###### Returns + +`void` + +###### Implementation of + +```ts +OnInit.ngOnInit +``` + +##### ngAfterContentInit() + +```ts +ngAfterContentInit(): void; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:276](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L276) + +wait until after all DOM is ready to init gridstack children (after angular ngFor and sub-components run first) + +###### Returns + +`void` + +###### Implementation of + +```ts +AfterContentInit.ngAfterContentInit +``` + +##### ngOnDestroy() + +```ts +ngOnDestroy(): void; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:284](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L284) + +A callback method that performs custom clean-up, invoked immediately +before a directive, pipe, or service instance is destroyed. + +###### Returns + +`void` + +###### Implementation of + +```ts +OnDestroy.ngOnDestroy +``` + +##### updateAll() + +```ts +updateAll(): void; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:298](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L298) + +called when the TEMPLATE (not recommended) list of items changes - get a list of nodes and +update the layout accordingly (which will take care of adding/removing items changed by Angular) + +###### Returns + +`void` + +##### checkEmpty() + +```ts +checkEmpty(): void; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:309](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L309) + +check if the grid is empty, if so show alternative content + +###### Returns + +`void` + +##### hookEvents() + +```ts +protected hookEvents(grid?): void; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:315](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L315) + +get all known events as easy to use Outputs for convenience + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `grid?` | `GridStack` | + +###### Returns + +`void` + +##### unhookEvents() + +```ts +protected unhookEvents(grid?): void; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:342](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L342) + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `grid?` | `GridStack` | + +###### Returns + +`void` + +#### Properties + +| Property | Modifier | Type | Default value | Description | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `gridstackItems?` | `public` | `QueryList`\<[`GridstackItemComponent`](gridstack-item.component.md#gridstackitemcomponent)\> | `undefined` | List of template-based grid items (not recommended approach). Used to sync between DOM and GridStack internals when items are defined in templates. Prefer dynamic component creation instead. | [angular/projects/lib/src/lib/gridstack.component.ts:92](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L92) | +| `container?` | `public` | `ViewContainerRef` | `undefined` | Container for dynamic component creation (recommended approach). Used to append grid items programmatically at runtime. | [angular/projects/lib/src/lib/gridstack.component.ts:97](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L97) | +| `isEmpty?` | `public` | `boolean` | `undefined` | Controls whether empty content should be displayed. Set to true to show ng-content with 'empty-content' selector when grid has no items. **Example** `
Drag widgets here to get started
` | [angular/projects/lib/src/lib/gridstack.component.ts:133](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L133) | +| `addedCB` | `public` | `EventEmitter`\<[`nodesCB`](#nodescb)\> | `undefined` | Emitted when widgets are added to the grid | [angular/projects/lib/src/lib/gridstack.component.ts:151](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L151) | +| `changeCB` | `public` | `EventEmitter`\<[`nodesCB`](#nodescb)\> | `undefined` | Emitted when grid layout changes | [angular/projects/lib/src/lib/gridstack.component.ts:154](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L154) | +| `disableCB` | `public` | `EventEmitter`\<[`eventCB`](#eventcb)\> | `undefined` | Emitted when grid is disabled | [angular/projects/lib/src/lib/gridstack.component.ts:157](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L157) | +| `dragCB` | `public` | `EventEmitter`\<[`elementCB`](#elementcb)\> | `undefined` | Emitted during widget drag operations | [angular/projects/lib/src/lib/gridstack.component.ts:160](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L160) | +| `dragStartCB` | `public` | `EventEmitter`\<[`elementCB`](#elementcb)\> | `undefined` | Emitted when widget drag starts | [angular/projects/lib/src/lib/gridstack.component.ts:163](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L163) | +| `dragStopCB` | `public` | `EventEmitter`\<[`elementCB`](#elementcb)\> | `undefined` | Emitted when widget drag stops | [angular/projects/lib/src/lib/gridstack.component.ts:166](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L166) | +| `droppedCB` | `public` | `EventEmitter`\<[`droppedCB`](#droppedcb)\> | `undefined` | Emitted when widget is dropped | [angular/projects/lib/src/lib/gridstack.component.ts:169](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L169) | +| `enableCB` | `public` | `EventEmitter`\<[`eventCB`](#eventcb)\> | `undefined` | Emitted when grid is enabled | [angular/projects/lib/src/lib/gridstack.component.ts:172](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L172) | +| `removedCB` | `public` | `EventEmitter`\<[`nodesCB`](#nodescb)\> | `undefined` | Emitted when widgets are removed from the grid | [angular/projects/lib/src/lib/gridstack.component.ts:175](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L175) | +| `resizeCB` | `public` | `EventEmitter`\<[`elementCB`](#elementcb)\> | `undefined` | Emitted during widget resize operations | [angular/projects/lib/src/lib/gridstack.component.ts:178](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L178) | +| `resizeStartCB` | `public` | `EventEmitter`\<[`elementCB`](#elementcb)\> | `undefined` | Emitted when widget resize starts | [angular/projects/lib/src/lib/gridstack.component.ts:181](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L181) | +| `resizeStopCB` | `public` | `EventEmitter`\<[`elementCB`](#elementcb)\> | `undefined` | Emitted when widget resize stops | [angular/projects/lib/src/lib/gridstack.component.ts:184](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L184) | +| `ref` | `public` | \| `undefined` \| `ComponentRef`\<[`GridstackComponent`](#gridstackcomponent)\> | `undefined` | Component reference for dynamic component removal. Used internally when this component is created dynamically. | [angular/projects/lib/src/lib/gridstack.component.ts:207](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L207) | +| `selectorToType` | `static` | [`SelectorToType`](#selectortotype) | `{}` | Mapping of component selectors to their types for dynamic creation. This enables dynamic component instantiation from string selectors. Angular doesn't provide public access to this mapping, so we maintain our own. **Example** `GridstackComponent.addComponentToSelectorType([MyWidgetComponent]);` | [angular/projects/lib/src/lib/gridstack.component.ts:220](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L220) | +| `_options?` | `protected` | `GridStackOptions` | `undefined` | - | [angular/projects/lib/src/lib/gridstack.component.ts:247](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L247) | +| `_grid?` | `protected` | `GridStack` | `undefined` | - | [angular/projects/lib/src/lib/gridstack.component.ts:248](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L248) | +| `_sub` | `protected` | `undefined` \| `Subscription` | `undefined` | - | [angular/projects/lib/src/lib/gridstack.component.ts:249](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L249) | +| `loaded?` | `protected` | `boolean` | `undefined` | - | [angular/projects/lib/src/lib/gridstack.component.ts:250](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L250) | +| `elementRef` | `readonly` | `ElementRef`\<[`GridCompHTMLElement`](#gridcomphtmlelement)\> | `undefined` | - | [angular/projects/lib/src/lib/gridstack.component.ts:252](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L252) | + +## Interfaces + +### GridCompHTMLElement + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:39](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L39) + +Extended HTMLElement interface for the grid container. +Stores a back-reference to the Angular component for integration purposes. + +#### Extends + +- `GridHTMLElement` + +#### Methods + +##### animate() + +```ts +animate(keyframes, options?): Animation; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:2146 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `keyframes` | `null` \| `Keyframe`[] \| `PropertyIndexedKeyframes` | +| `options?` | `number` \| `KeyframeAnimationOptions` | + +###### Returns + +`Animation` + +###### Inherited from + +```ts +GridHTMLElement.animate +``` + +##### getAnimations() + +```ts +getAnimations(options?): Animation[]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:2147 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `GetAnimationsOptions` | + +###### Returns + +`Animation`[] + +###### Inherited from + +```ts +GridHTMLElement.getAnimations +``` + +##### after() + +```ts +after(...nodes): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3747 + +Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes. + +Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| ...`nodes` | (`string` \| `Node`)[] | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.after +``` + +##### before() + +```ts +before(...nodes): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3753 + +Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes. + +Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| ...`nodes` | (`string` \| `Node`)[] | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.before +``` + +##### remove() + +```ts +remove(): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3755 + +Removes node. + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.remove +``` + +##### replaceWith() + +```ts +replaceWith(...nodes): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:3761 + +Replaces 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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| ...`nodes` | (`string` \| `Node`)[] | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.replaceWith +``` + +##### attachShadow() + +```ts +attachShadow(init): ShadowRoot; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5074 + +Creates a shadow root for element and returns it. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `init` | `ShadowRootInit` | + +###### Returns + +`ShadowRoot` + +###### Inherited from + +```ts +GridHTMLElement.attachShadow +``` + +##### checkVisibility() + +```ts +checkVisibility(options?): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5075 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `CheckVisibilityOptions` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridHTMLElement.checkVisibility +``` + +##### closest() + +###### Call Signature + +```ts +closest(selector): null | HTMLElementTagNameMap[K]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5077 + +Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selector` | `K` | + +###### Returns + +`null` \| `HTMLElementTagNameMap`\[`K`\] + +###### Inherited from + +```ts +GridHTMLElement.closest +``` + +###### Call Signature + +```ts +closest(selector): null | SVGElementTagNameMap[K]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5078 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `SVGElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selector` | `K` | + +###### Returns + +`null` \| `SVGElementTagNameMap`\[`K`\] + +###### Inherited from + +```ts +GridHTMLElement.closest +``` + +###### Call Signature + +```ts +closest(selector): null | MathMLElementTagNameMap[K]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5079 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `MathMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selector` | `K` | + +###### Returns + +`null` \| `MathMLElementTagNameMap`\[`K`\] + +###### Inherited from + +```ts +GridHTMLElement.closest +``` + +###### Call Signature + +```ts +closest(selectors): null | E; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5080 + +###### Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `E` *extends* `Element`\<`E`\> | `Element` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `string` | + +###### Returns + +`null` \| `E` + +###### Inherited from + +```ts +GridHTMLElement.closest +``` + +##### getAttribute() + +```ts +getAttribute(qualifiedName): null | string; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5082 + +Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `string` | + +###### Returns + +`null` \| `string` + +###### Inherited from + +```ts +GridHTMLElement.getAttribute +``` + +##### getAttributeNS() + +```ts +getAttributeNS(namespace, localName): null | string; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5084 + +Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | +| `localName` | `string` | + +###### Returns + +`null` \| `string` + +###### Inherited from + +```ts +GridHTMLElement.getAttributeNS +``` + +##### getAttributeNames() + +```ts +getAttributeNames(): string[]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5086 + +Returns the qualified names of all element's attributes. Can contain duplicates. + +###### Returns + +`string`[] + +###### Inherited from + +```ts +GridHTMLElement.getAttributeNames +``` + +##### getAttributeNode() + +```ts +getAttributeNode(qualifiedName): null | Attr; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5087 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `string` | + +###### Returns + +`null` \| `Attr` + +###### Inherited from + +```ts +GridHTMLElement.getAttributeNode +``` + +##### getAttributeNodeNS() + +```ts +getAttributeNodeNS(namespace, localName): null | Attr; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5088 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | +| `localName` | `string` | + +###### Returns + +`null` \| `Attr` + +###### Inherited from + +```ts +GridHTMLElement.getAttributeNodeNS +``` + +##### getBoundingClientRect() + +```ts +getBoundingClientRect(): DOMRect; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5089 + +###### Returns + +`DOMRect` + +###### Inherited from + +```ts +GridHTMLElement.getBoundingClientRect +``` + +##### getClientRects() + +```ts +getClientRects(): DOMRectList; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5090 + +###### Returns + +`DOMRectList` + +###### Inherited from + +```ts +GridHTMLElement.getClientRects +``` + +##### getElementsByClassName() + +```ts +getElementsByClassName(classNames): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5092 + +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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `classNames` | `string` | + +###### Returns + +`HTMLCollectionOf`\<`Element`\> + +###### Inherited from + +```ts +GridHTMLElement.getElementsByClassName +``` + +##### getElementsByTagName() + +###### Call Signature + +```ts +getElementsByTagName(qualifiedName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5093 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `K` | + +###### Returns + +`HTMLCollectionOf`\<`HTMLElementTagNameMap`\[`K`\]\> + +###### Inherited from + +```ts +GridHTMLElement.getElementsByTagName +``` + +###### Call Signature + +```ts +getElementsByTagName(qualifiedName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5094 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `SVGElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `K` | + +###### Returns + +`HTMLCollectionOf`\<`SVGElementTagNameMap`\[`K`\]\> + +###### Inherited from + +```ts +GridHTMLElement.getElementsByTagName +``` + +###### Call Signature + +```ts +getElementsByTagName(qualifiedName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5095 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `MathMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `K` | + +###### Returns + +`HTMLCollectionOf`\<`MathMLElementTagNameMap`\[`K`\]\> + +###### Inherited from + +```ts +GridHTMLElement.getElementsByTagName +``` + +###### Call Signature + +```ts +getElementsByTagName(qualifiedName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5097 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementDeprecatedTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `K` | + +###### Returns + +`HTMLCollectionOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\> + +###### Deprecated + +###### Inherited from + +```ts +GridHTMLElement.getElementsByTagName +``` + +###### Call Signature + +```ts +getElementsByTagName(qualifiedName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5098 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `string` | + +###### Returns + +`HTMLCollectionOf`\<`Element`\> + +###### Inherited from + +```ts +GridHTMLElement.getElementsByTagName +``` + +##### getElementsByTagNameNS() + +###### Call Signature + +```ts +getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5099 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespaceURI` | `"http://www.w3.org/1999/xhtml"` | +| `localName` | `string` | + +###### Returns + +`HTMLCollectionOf`\<`HTMLElement`\> + +###### Inherited from + +```ts +GridHTMLElement.getElementsByTagNameNS +``` + +###### Call Signature + +```ts +getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5100 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespaceURI` | `"http://www.w3.org/2000/svg"` | +| `localName` | `string` | + +###### Returns + +`HTMLCollectionOf`\<`SVGElement`\> + +###### Inherited from + +```ts +GridHTMLElement.getElementsByTagNameNS +``` + +###### Call Signature + +```ts +getElementsByTagNameNS(namespaceURI, localName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5101 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespaceURI` | `"http://www.w3.org/1998/Math/MathML"` | +| `localName` | `string` | + +###### Returns + +`HTMLCollectionOf`\<`MathMLElement`\> + +###### Inherited from + +```ts +GridHTMLElement.getElementsByTagNameNS +``` + +###### Call Signature + +```ts +getElementsByTagNameNS(namespace, localName): HTMLCollectionOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5102 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | +| `localName` | `string` | + +###### Returns + +`HTMLCollectionOf`\<`Element`\> + +###### Inherited from + +```ts +GridHTMLElement.getElementsByTagNameNS +``` + +##### hasAttribute() + +```ts +hasAttribute(qualifiedName): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5104 + +Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `string` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridHTMLElement.hasAttribute +``` + +##### hasAttributeNS() + +```ts +hasAttributeNS(namespace, localName): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5106 + +Returns true if element has an attribute whose namespace is namespace and local name is localName. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | +| `localName` | `string` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridHTMLElement.hasAttributeNS +``` + +##### hasAttributes() + +```ts +hasAttributes(): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5108 + +Returns true if element has attributes, and false otherwise. + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridHTMLElement.hasAttributes +``` + +##### hasPointerCapture() + +```ts +hasPointerCapture(pointerId): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5109 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `pointerId` | `number` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridHTMLElement.hasPointerCapture +``` + +##### insertAdjacentElement() + +```ts +insertAdjacentElement(where, element): null | Element; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5110 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `where` | `InsertPosition` | +| `element` | `Element` | + +###### Returns + +`null` \| `Element` + +###### Inherited from + +```ts +GridHTMLElement.insertAdjacentElement +``` + +##### insertAdjacentHTML() + +```ts +insertAdjacentHTML(position, text): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5111 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `position` | `InsertPosition` | +| `text` | `string` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.insertAdjacentHTML +``` + +##### insertAdjacentText() + +```ts +insertAdjacentText(where, data): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5112 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `where` | `InsertPosition` | +| `data` | `string` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.insertAdjacentText +``` + +##### matches() + +```ts +matches(selectors): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5114 + +Returns true if matching selectors against element's root yields element, and false otherwise. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `string` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridHTMLElement.matches +``` + +##### releasePointerCapture() + +```ts +releasePointerCapture(pointerId): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5115 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `pointerId` | `number` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.releasePointerCapture +``` + +##### removeAttribute() + +```ts +removeAttribute(qualifiedName): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5117 + +Removes element's first attribute whose qualified name is qualifiedName. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `string` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.removeAttribute +``` + +##### removeAttributeNS() + +```ts +removeAttributeNS(namespace, localName): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5119 + +Removes element's attribute whose namespace is namespace and local name is localName. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | +| `localName` | `string` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.removeAttributeNS +``` + +##### removeAttributeNode() + +```ts +removeAttributeNode(attr): Attr; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5120 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `attr` | `Attr` | + +###### Returns + +`Attr` + +###### Inherited from + +```ts +GridHTMLElement.removeAttributeNode +``` + +##### requestFullscreen() + +```ts +requestFullscreen(options?): Promise; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5126 + +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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `FullscreenOptions` | + +###### Returns + +`Promise`\<`void`\> + +###### Inherited from + +```ts +GridHTMLElement.requestFullscreen +``` + +##### requestPointerLock() + +```ts +requestPointerLock(): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5127 + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.requestPointerLock +``` + +##### scroll() + +###### Call Signature + +```ts +scroll(options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5128 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `ScrollToOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.scroll +``` + +###### Call Signature + +```ts +scroll(x, y): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5129 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `number` | +| `y` | `number` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.scroll +``` + +##### scrollBy() + +###### Call Signature + +```ts +scrollBy(options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5130 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `ScrollToOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.scrollBy +``` + +###### Call Signature + +```ts +scrollBy(x, y): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5131 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `number` | +| `y` | `number` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.scrollBy +``` + +##### scrollIntoView() + +```ts +scrollIntoView(arg?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5132 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `arg?` | `boolean` \| `ScrollIntoViewOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.scrollIntoView +``` + +##### scrollTo() + +###### Call Signature + +```ts +scrollTo(options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5133 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `ScrollToOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.scrollTo +``` + +###### Call Signature + +```ts +scrollTo(x, y): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5134 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `x` | `number` | +| `y` | `number` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.scrollTo +``` + +##### setAttribute() + +```ts +setAttribute(qualifiedName, value): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5136 + +Sets the value of element's first attribute whose qualified name is qualifiedName to value. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `string` | +| `value` | `string` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.setAttribute +``` + +##### setAttributeNS() + +```ts +setAttributeNS( + namespace, + qualifiedName, + value): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5138 + +Sets the value of element's attribute whose namespace is namespace and local name is localName to value. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | +| `qualifiedName` | `string` | +| `value` | `string` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.setAttributeNS +``` + +##### setAttributeNode() + +```ts +setAttributeNode(attr): null | Attr; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5139 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `attr` | `Attr` | + +###### Returns + +`null` \| `Attr` + +###### Inherited from + +```ts +GridHTMLElement.setAttributeNode +``` + +##### setAttributeNodeNS() + +```ts +setAttributeNodeNS(attr): null | Attr; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5140 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `attr` | `Attr` | + +###### Returns + +`null` \| `Attr` + +###### Inherited from + +```ts +GridHTMLElement.setAttributeNodeNS +``` + +##### setPointerCapture() + +```ts +setPointerCapture(pointerId): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5141 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `pointerId` | `number` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.setPointerCapture +``` + +##### toggleAttribute() + +```ts +toggleAttribute(qualifiedName, force?): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5147 + +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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `qualifiedName` | `string` | +| `force?` | `boolean` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridHTMLElement.toggleAttribute +``` + +##### ~~webkitMatchesSelector()~~ + +```ts +webkitMatchesSelector(selectors): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5149 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `string` | + +###### Returns + +`boolean` + +###### Deprecated + +This is a legacy alias of `matches`. + +###### Inherited from + +```ts +GridHTMLElement.webkitMatchesSelector +``` + +##### dispatchEvent() + +```ts +dispatchEvent(event): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:5344 + +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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `event` | `Event` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridHTMLElement.dispatchEvent +``` + +##### attachInternals() + +```ts +attachInternals(): ElementInternals; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:6573 + +###### Returns + +`ElementInternals` + +###### Inherited from + +```ts +GridHTMLElement.attachInternals +``` + +##### click() + +```ts +click(): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:6574 + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.click +``` + +##### addEventListener() + +###### Call Signature + +```ts +addEventListener( + type, + listener, + options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:6575 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementEventMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `K` | +| `listener` | (`this`, `ev`) => `any` | +| `options?` | `boolean` \| `AddEventListenerOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.addEventListener +``` + +###### Call Signature + +```ts +addEventListener( + type, + listener, + options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:6576 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string` | +| `listener` | `EventListenerOrEventListenerObject` | +| `options?` | `boolean` \| `AddEventListenerOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.addEventListener +``` + +##### removeEventListener() + +###### Call Signature + +```ts +removeEventListener( + type, + listener, + options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:6577 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementEventMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `K` | +| `listener` | (`this`, `ev`) => `any` | +| `options?` | `boolean` \| `EventListenerOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.removeEventListener +``` + +###### Call Signature + +```ts +removeEventListener( + type, + listener, + options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:6578 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `type` | `string` | +| `listener` | `EventListenerOrEventListenerObject` | +| `options?` | `boolean` \| `EventListenerOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.removeEventListener +``` + +##### blur() + +```ts +blur(): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:7768 + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.blur +``` + +##### focus() + +```ts +focus(options?): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:7769 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `FocusOptions` | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.focus +``` + +##### appendChild() + +```ts +appendChild(node): T; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10274 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `Node`\<`T`\> | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `node` | `T` | + +###### Returns + +`T` + +###### Inherited from + +```ts +GridHTMLElement.appendChild +``` + +##### cloneNode() + +```ts +cloneNode(deep?): Node; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10276 + +Returns a copy of node. If deep is true, the copy also includes the node's descendants. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `deep?` | `boolean` | + +###### Returns + +`Node` + +###### Inherited from + +```ts +GridHTMLElement.cloneNode +``` + +##### compareDocumentPosition() + +```ts +compareDocumentPosition(other): number; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10278 + +Returns a bitmask indicating the position of other relative to node. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `other` | `Node` | + +###### Returns + +`number` + +###### Inherited from + +```ts +GridHTMLElement.compareDocumentPosition +``` + +##### contains() + +```ts +contains(other): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10280 + +Returns true if other is an inclusive descendant of node, and false otherwise. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `other` | `null` \| `Node` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridHTMLElement.contains +``` + +##### getRootNode() + +```ts +getRootNode(options?): Node; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10282 + +Returns node's root. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `options?` | `GetRootNodeOptions` | + +###### Returns + +`Node` + +###### Inherited from + +```ts +GridHTMLElement.getRootNode +``` + +##### hasChildNodes() + +```ts +hasChildNodes(): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10284 + +Returns whether node has children. + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridHTMLElement.hasChildNodes +``` + +##### insertBefore() + +```ts +insertBefore(node, child): T; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10285 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `Node`\<`T`\> | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `node` | `T` | +| `child` | `null` \| `Node` | + +###### Returns + +`T` + +###### Inherited from + +```ts +GridHTMLElement.insertBefore +``` + +##### isDefaultNamespace() + +```ts +isDefaultNamespace(namespace): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10286 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridHTMLElement.isDefaultNamespace +``` + +##### isEqualNode() + +```ts +isEqualNode(otherNode): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10288 + +Returns whether node and otherNode have the same properties. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `otherNode` | `null` \| `Node` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridHTMLElement.isEqualNode +``` + +##### isSameNode() + +```ts +isSameNode(otherNode): boolean; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10289 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `otherNode` | `null` \| `Node` | + +###### Returns + +`boolean` + +###### Inherited from + +```ts +GridHTMLElement.isSameNode +``` + +##### lookupNamespaceURI() + +```ts +lookupNamespaceURI(prefix): null | string; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10290 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `prefix` | `null` \| `string` | + +###### Returns + +`null` \| `string` + +###### Inherited from + +```ts +GridHTMLElement.lookupNamespaceURI +``` + +##### lookupPrefix() + +```ts +lookupPrefix(namespace): null | string; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10291 + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `namespace` | `null` \| `string` | + +###### Returns + +`null` \| `string` + +###### Inherited from + +```ts +GridHTMLElement.lookupPrefix +``` + +##### normalize() + +```ts +normalize(): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10293 + +Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes. + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.normalize +``` + +##### removeChild() + +```ts +removeChild(child): T; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10294 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `Node`\<`T`\> | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `child` | `T` | + +###### Returns + +`T` + +###### Inherited from + +```ts +GridHTMLElement.removeChild +``` + +##### replaceChild() + +```ts +replaceChild(node, child): T; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10295 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `T` *extends* `Node`\<`T`\> | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `node` | `Node` | +| `child` | `T` | + +###### Returns + +`T` + +###### Inherited from + +```ts +GridHTMLElement.replaceChild +``` + +##### append() + +```ts +append(...nodes): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10697 + +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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| ...`nodes` | (`string` \| `Node`)[] | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.append +``` + +##### prepend() + +```ts +prepend(...nodes): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10703 + +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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| ...`nodes` | (`string` \| `Node`)[] | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.prepend +``` + +##### querySelector() + +###### Call Signature + +```ts +querySelector(selectors): null | HTMLElementTagNameMap[K]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10705 + +Returns the first element that is a descendant of node that matches selectors. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`null` \| `HTMLElementTagNameMap`\[`K`\] + +###### Inherited from + +```ts +GridHTMLElement.querySelector +``` + +###### Call Signature + +```ts +querySelector(selectors): null | SVGElementTagNameMap[K]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10706 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `SVGElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`null` \| `SVGElementTagNameMap`\[`K`\] + +###### Inherited from + +```ts +GridHTMLElement.querySelector +``` + +###### Call Signature + +```ts +querySelector(selectors): null | MathMLElementTagNameMap[K]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10707 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `MathMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`null` \| `MathMLElementTagNameMap`\[`K`\] + +###### Inherited from + +```ts +GridHTMLElement.querySelector +``` + +###### Call Signature + +```ts +querySelector(selectors): null | HTMLElementDeprecatedTagNameMap[K]; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10709 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementDeprecatedTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`null` \| `HTMLElementDeprecatedTagNameMap`\[`K`\] + +###### Deprecated + +###### Inherited from + +```ts +GridHTMLElement.querySelector +``` + +###### Call Signature + +```ts +querySelector(selectors): null | E; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10710 + +###### Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `E` *extends* `Element`\<`E`\> | `Element` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `string` | + +###### Returns + +`null` \| `E` + +###### Inherited from + +```ts +GridHTMLElement.querySelector +``` + +##### querySelectorAll() + +###### Call Signature + +```ts +querySelectorAll(selectors): NodeListOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10712 + +Returns all element descendants of node that match selectors. + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`NodeListOf`\<`HTMLElementTagNameMap`\[`K`\]\> + +###### Inherited from + +```ts +GridHTMLElement.querySelectorAll +``` + +###### Call Signature + +```ts +querySelectorAll(selectors): NodeListOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10713 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `SVGElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`NodeListOf`\<`SVGElementTagNameMap`\[`K`\]\> + +###### Inherited from + +```ts +GridHTMLElement.querySelectorAll +``` + +###### Call Signature + +```ts +querySelectorAll(selectors): NodeListOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10714 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `MathMLElementTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`NodeListOf`\<`MathMLElementTagNameMap`\[`K`\]\> + +###### Inherited from + +```ts +GridHTMLElement.querySelectorAll +``` + +###### Call Signature + +```ts +querySelectorAll(selectors): NodeListOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10716 + +###### Type Parameters + +| Type Parameter | +| ------ | +| `K` *extends* keyof `HTMLElementDeprecatedTagNameMap` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `K` | + +###### Returns + +`NodeListOf`\<`HTMLElementDeprecatedTagNameMap`\[`K`\]\> + +###### Deprecated + +###### Inherited from + +```ts +GridHTMLElement.querySelectorAll +``` + +###### Call Signature + +```ts +querySelectorAll(selectors): NodeListOf; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10717 + +###### Type Parameters + +| Type Parameter | Default type | +| ------ | ------ | +| `E` *extends* `Element`\<`E`\> | `Element` | + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| `selectors` | `string` | + +###### Returns + +`NodeListOf`\<`E`\> + +###### Inherited from + +```ts +GridHTMLElement.querySelectorAll +``` + +##### replaceChildren() + +```ts +replaceChildren(...nodes): void; +``` + +Defined in: node\_modules/typescript/lib/lib.dom.d.ts:10723 + +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. + +###### Parameters + +| Parameter | Type | +| ------ | ------ | +| ...`nodes` | (`string` \| `Node`)[] | + +###### Returns + +`void` + +###### Inherited from + +```ts +GridHTMLElement.replaceChildren +``` + +#### Properties + +| Property | Modifier | Type | Description | Inherited from | Defined in | +| ------ | ------ | ------ | ------ | ------ | ------ | +| `_gridComp?` | `public` | [`GridstackComponent`](#gridstackcomponent) | Back-reference to the Angular GridStack component | - | [angular/projects/lib/src/lib/gridstack.component.ts:41](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L41) | +| `ariaAtomic` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaAtomic` | node\_modules/typescript/lib/lib.dom.d.ts:2020 | +| `ariaAutoComplete` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaAutoComplete` | node\_modules/typescript/lib/lib.dom.d.ts:2021 | +| `ariaBusy` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaBusy` | node\_modules/typescript/lib/lib.dom.d.ts:2022 | +| `ariaChecked` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaChecked` | node\_modules/typescript/lib/lib.dom.d.ts:2023 | +| `ariaColCount` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaColCount` | node\_modules/typescript/lib/lib.dom.d.ts:2024 | +| `ariaColIndex` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaColIndex` | node\_modules/typescript/lib/lib.dom.d.ts:2025 | +| `ariaColSpan` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaColSpan` | node\_modules/typescript/lib/lib.dom.d.ts:2026 | +| `ariaCurrent` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaCurrent` | node\_modules/typescript/lib/lib.dom.d.ts:2027 | +| `ariaDisabled` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaDisabled` | node\_modules/typescript/lib/lib.dom.d.ts:2028 | +| `ariaExpanded` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaExpanded` | node\_modules/typescript/lib/lib.dom.d.ts:2029 | +| `ariaHasPopup` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaHasPopup` | node\_modules/typescript/lib/lib.dom.d.ts:2030 | +| `ariaHidden` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaHidden` | node\_modules/typescript/lib/lib.dom.d.ts:2031 | +| `ariaInvalid` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaInvalid` | node\_modules/typescript/lib/lib.dom.d.ts:2032 | +| `ariaKeyShortcuts` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaKeyShortcuts` | node\_modules/typescript/lib/lib.dom.d.ts:2033 | +| `ariaLabel` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaLabel` | node\_modules/typescript/lib/lib.dom.d.ts:2034 | +| `ariaLevel` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaLevel` | node\_modules/typescript/lib/lib.dom.d.ts:2035 | +| `ariaLive` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaLive` | node\_modules/typescript/lib/lib.dom.d.ts:2036 | +| `ariaModal` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaModal` | node\_modules/typescript/lib/lib.dom.d.ts:2037 | +| `ariaMultiLine` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaMultiLine` | node\_modules/typescript/lib/lib.dom.d.ts:2038 | +| `ariaMultiSelectable` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaMultiSelectable` | node\_modules/typescript/lib/lib.dom.d.ts:2039 | +| `ariaOrientation` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaOrientation` | node\_modules/typescript/lib/lib.dom.d.ts:2040 | +| `ariaPlaceholder` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaPlaceholder` | node\_modules/typescript/lib/lib.dom.d.ts:2041 | +| `ariaPosInSet` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaPosInSet` | node\_modules/typescript/lib/lib.dom.d.ts:2042 | +| `ariaPressed` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaPressed` | node\_modules/typescript/lib/lib.dom.d.ts:2043 | +| `ariaReadOnly` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaReadOnly` | node\_modules/typescript/lib/lib.dom.d.ts:2044 | +| `ariaRequired` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaRequired` | node\_modules/typescript/lib/lib.dom.d.ts:2045 | +| `ariaRoleDescription` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaRoleDescription` | node\_modules/typescript/lib/lib.dom.d.ts:2046 | +| `ariaRowCount` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaRowCount` | node\_modules/typescript/lib/lib.dom.d.ts:2047 | +| `ariaRowIndex` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaRowIndex` | node\_modules/typescript/lib/lib.dom.d.ts:2048 | +| `ariaRowSpan` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaRowSpan` | node\_modules/typescript/lib/lib.dom.d.ts:2049 | +| `ariaSelected` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaSelected` | node\_modules/typescript/lib/lib.dom.d.ts:2050 | +| `ariaSetSize` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaSetSize` | node\_modules/typescript/lib/lib.dom.d.ts:2051 | +| `ariaSort` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaSort` | node\_modules/typescript/lib/lib.dom.d.ts:2052 | +| `ariaValueMax` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaValueMax` | node\_modules/typescript/lib/lib.dom.d.ts:2053 | +| `ariaValueMin` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaValueMin` | node\_modules/typescript/lib/lib.dom.d.ts:2054 | +| `ariaValueNow` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaValueNow` | node\_modules/typescript/lib/lib.dom.d.ts:2055 | +| `ariaValueText` | `public` | `null` \| `string` | - | `GridHTMLElement.ariaValueText` | node\_modules/typescript/lib/lib.dom.d.ts:2056 | +| `role` | `public` | `null` \| `string` | - | `GridHTMLElement.role` | node\_modules/typescript/lib/lib.dom.d.ts:2057 | +| `attributes` | `readonly` | `NamedNodeMap` | - | `GridHTMLElement.attributes` | node\_modules/typescript/lib/lib.dom.d.ts:5041 | +| `classList` | `readonly` | `DOMTokenList` | Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object. | `GridHTMLElement.classList` | node\_modules/typescript/lib/lib.dom.d.ts:5043 | +| `className` | `public` | `string` | Returns the value of element's class content attribute. Can be set to change it. | `GridHTMLElement.className` | node\_modules/typescript/lib/lib.dom.d.ts:5045 | +| `clientHeight` | `readonly` | `number` | - | `GridHTMLElement.clientHeight` | node\_modules/typescript/lib/lib.dom.d.ts:5046 | +| `clientLeft` | `readonly` | `number` | - | `GridHTMLElement.clientLeft` | node\_modules/typescript/lib/lib.dom.d.ts:5047 | +| `clientTop` | `readonly` | `number` | - | `GridHTMLElement.clientTop` | node\_modules/typescript/lib/lib.dom.d.ts:5048 | +| `clientWidth` | `readonly` | `number` | - | `GridHTMLElement.clientWidth` | node\_modules/typescript/lib/lib.dom.d.ts:5049 | +| `id` | `public` | `string` | Returns the value of element's id content attribute. Can be set to change it. | `GridHTMLElement.id` | node\_modules/typescript/lib/lib.dom.d.ts:5051 | +| `localName` | `readonly` | `string` | Returns the local name. | `GridHTMLElement.localName` | node\_modules/typescript/lib/lib.dom.d.ts:5053 | +| `namespaceURI` | `readonly` | `null` \| `string` | Returns the namespace. | `GridHTMLElement.namespaceURI` | node\_modules/typescript/lib/lib.dom.d.ts:5055 | +| `onfullscreenchange` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onfullscreenchange` | node\_modules/typescript/lib/lib.dom.d.ts:5056 | +| `onfullscreenerror` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onfullscreenerror` | node\_modules/typescript/lib/lib.dom.d.ts:5057 | +| `outerHTML` | `public` | `string` | - | `GridHTMLElement.outerHTML` | node\_modules/typescript/lib/lib.dom.d.ts:5058 | +| `ownerDocument` | `readonly` | `Document` | Returns the node document. Returns null for documents. | `GridHTMLElement.ownerDocument` | node\_modules/typescript/lib/lib.dom.d.ts:5059 | +| `part` | `readonly` | `DOMTokenList` | - | `GridHTMLElement.part` | node\_modules/typescript/lib/lib.dom.d.ts:5060 | +| `prefix` | `readonly` | `null` \| `string` | Returns the namespace prefix. | `GridHTMLElement.prefix` | node\_modules/typescript/lib/lib.dom.d.ts:5062 | +| `scrollHeight` | `readonly` | `number` | - | `GridHTMLElement.scrollHeight` | node\_modules/typescript/lib/lib.dom.d.ts:5063 | +| `scrollLeft` | `public` | `number` | - | `GridHTMLElement.scrollLeft` | node\_modules/typescript/lib/lib.dom.d.ts:5064 | +| `scrollTop` | `public` | `number` | - | `GridHTMLElement.scrollTop` | node\_modules/typescript/lib/lib.dom.d.ts:5065 | +| `scrollWidth` | `readonly` | `number` | - | `GridHTMLElement.scrollWidth` | node\_modules/typescript/lib/lib.dom.d.ts:5066 | +| `shadowRoot` | `readonly` | `null` \| `ShadowRoot` | Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise. | `GridHTMLElement.shadowRoot` | node\_modules/typescript/lib/lib.dom.d.ts:5068 | +| `slot` | `public` | `string` | Returns the value of element's slot content attribute. Can be set to change it. | `GridHTMLElement.slot` | node\_modules/typescript/lib/lib.dom.d.ts:5070 | +| `tagName` | `readonly` | `string` | Returns the HTML-uppercased qualified name. | `GridHTMLElement.tagName` | node\_modules/typescript/lib/lib.dom.d.ts:5072 | +| `style` | `readonly` | `CSSStyleDeclaration` | - | `GridHTMLElement.style` | node\_modules/typescript/lib/lib.dom.d.ts:5162 | +| `contentEditable` | `public` | `string` | - | `GridHTMLElement.contentEditable` | node\_modules/typescript/lib/lib.dom.d.ts:5166 | +| `enterKeyHint` | `public` | `string` | - | `GridHTMLElement.enterKeyHint` | node\_modules/typescript/lib/lib.dom.d.ts:5167 | +| `inputMode` | `public` | `string` | - | `GridHTMLElement.inputMode` | node\_modules/typescript/lib/lib.dom.d.ts:5168 | +| `isContentEditable` | `readonly` | `boolean` | - | `GridHTMLElement.isContentEditable` | node\_modules/typescript/lib/lib.dom.d.ts:5169 | +| `onabort` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user aborts the download. **Param** The event. | `GridHTMLElement.onabort` | node\_modules/typescript/lib/lib.dom.d.ts:5856 | +| `onanimationcancel` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onanimationcancel` | node\_modules/typescript/lib/lib.dom.d.ts:5857 | +| `onanimationend` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onanimationend` | node\_modules/typescript/lib/lib.dom.d.ts:5858 | +| `onanimationiteration` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onanimationiteration` | node\_modules/typescript/lib/lib.dom.d.ts:5859 | +| `onanimationstart` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onanimationstart` | node\_modules/typescript/lib/lib.dom.d.ts:5860 | +| `onauxclick` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onauxclick` | node\_modules/typescript/lib/lib.dom.d.ts:5861 | +| `onbeforeinput` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onbeforeinput` | node\_modules/typescript/lib/lib.dom.d.ts:5862 | +| `onblur` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the object loses the input focus. **Param** The focus event. | `GridHTMLElement.onblur` | node\_modules/typescript/lib/lib.dom.d.ts:5867 | +| `oncancel` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.oncancel` | node\_modules/typescript/lib/lib.dom.d.ts:5868 | +| `oncanplay` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when playback is possible, but would require further buffering. **Param** The event. | `GridHTMLElement.oncanplay` | node\_modules/typescript/lib/lib.dom.d.ts:5873 | +| `oncanplaythrough` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.oncanplaythrough` | node\_modules/typescript/lib/lib.dom.d.ts:5874 | +| `onchange` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the contents of the object or selection have changed. **Param** The event. | `GridHTMLElement.onchange` | node\_modules/typescript/lib/lib.dom.d.ts:5879 | +| `onclick` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user clicks the left mouse button on the object **Param** The mouse event. | `GridHTMLElement.onclick` | node\_modules/typescript/lib/lib.dom.d.ts:5884 | +| `onclose` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onclose` | node\_modules/typescript/lib/lib.dom.d.ts:5885 | +| `oncontextmenu` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user clicks the right mouse button in the client area, opening the context menu. **Param** The mouse event. | `GridHTMLElement.oncontextmenu` | node\_modules/typescript/lib/lib.dom.d.ts:5890 | +| `oncopy` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.oncopy` | node\_modules/typescript/lib/lib.dom.d.ts:5891 | +| `oncuechange` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.oncuechange` | node\_modules/typescript/lib/lib.dom.d.ts:5892 | +| `oncut` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.oncut` | node\_modules/typescript/lib/lib.dom.d.ts:5893 | +| `ondblclick` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user double-clicks the object. **Param** The mouse event. | `GridHTMLElement.ondblclick` | node\_modules/typescript/lib/lib.dom.d.ts:5898 | +| `ondrag` | `public` | `null` \| (`this`, `ev`) => `any` | Fires on the source object continuously during a drag operation. **Param** The event. | `GridHTMLElement.ondrag` | node\_modules/typescript/lib/lib.dom.d.ts:5903 | +| `ondragend` | `public` | `null` \| (`this`, `ev`) => `any` | Fires on the source object when the user releases the mouse at the close of a drag operation. **Param** The event. | `GridHTMLElement.ondragend` | node\_modules/typescript/lib/lib.dom.d.ts:5908 | +| `ondragenter` | `public` | `null` \| (`this`, `ev`) => `any` | Fires on the target element when the user drags the object to a valid drop target. **Param** The drag event. | `GridHTMLElement.ondragenter` | node\_modules/typescript/lib/lib.dom.d.ts:5913 | +| `ondragleave` | `public` | `null` \| (`this`, `ev`) => `any` | Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation. **Param** The drag event. | `GridHTMLElement.ondragleave` | node\_modules/typescript/lib/lib.dom.d.ts:5918 | +| `ondragover` | `public` | `null` \| (`this`, `ev`) => `any` | Fires on the target element continuously while the user drags the object over a valid drop target. **Param** The event. | `GridHTMLElement.ondragover` | node\_modules/typescript/lib/lib.dom.d.ts:5923 | +| `ondragstart` | `public` | `null` \| (`this`, `ev`) => `any` | Fires on the source object when the user starts to drag a text selection or selected object. **Param** The event. | `GridHTMLElement.ondragstart` | node\_modules/typescript/lib/lib.dom.d.ts:5928 | +| `ondrop` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.ondrop` | node\_modules/typescript/lib/lib.dom.d.ts:5929 | +| `ondurationchange` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the duration attribute is updated. **Param** The event. | `GridHTMLElement.ondurationchange` | node\_modules/typescript/lib/lib.dom.d.ts:5934 | +| `onemptied` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the media element is reset to its initial state. **Param** The event. | `GridHTMLElement.onemptied` | node\_modules/typescript/lib/lib.dom.d.ts:5939 | +| `onended` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the end of playback is reached. **Param** The event | `GridHTMLElement.onended` | node\_modules/typescript/lib/lib.dom.d.ts:5944 | +| `onerror` | `public` | `OnErrorEventHandler` | Fires when an error occurs during object loading. **Param** The event. | `GridHTMLElement.onerror` | node\_modules/typescript/lib/lib.dom.d.ts:5949 | +| `onfocus` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the object receives focus. **Param** The event. | `GridHTMLElement.onfocus` | node\_modules/typescript/lib/lib.dom.d.ts:5954 | +| `onformdata` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onformdata` | node\_modules/typescript/lib/lib.dom.d.ts:5955 | +| `ongotpointercapture` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.ongotpointercapture` | node\_modules/typescript/lib/lib.dom.d.ts:5956 | +| `oninput` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.oninput` | node\_modules/typescript/lib/lib.dom.d.ts:5957 | +| `oninvalid` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.oninvalid` | node\_modules/typescript/lib/lib.dom.d.ts:5958 | +| `onkeydown` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user presses a key. **Param** The keyboard event | `GridHTMLElement.onkeydown` | node\_modules/typescript/lib/lib.dom.d.ts:5963 | +| ~~`onkeypress`~~ | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user presses an alphanumeric key. **Param** The event. **Deprecated** | `GridHTMLElement.onkeypress` | node\_modules/typescript/lib/lib.dom.d.ts:5969 | +| `onkeyup` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user releases a key. **Param** The keyboard event | `GridHTMLElement.onkeyup` | node\_modules/typescript/lib/lib.dom.d.ts:5974 | +| `onload` | `public` | `null` \| (`this`, `ev`) => `any` | Fires immediately after the browser loads the object. **Param** The event. | `GridHTMLElement.onload` | node\_modules/typescript/lib/lib.dom.d.ts:5979 | +| `onloadeddata` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when media data is loaded at the current playback position. **Param** The event. | `GridHTMLElement.onloadeddata` | node\_modules/typescript/lib/lib.dom.d.ts:5984 | +| `onloadedmetadata` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the duration and dimensions of the media have been determined. **Param** The event. | `GridHTMLElement.onloadedmetadata` | node\_modules/typescript/lib/lib.dom.d.ts:5989 | +| `onloadstart` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when Internet Explorer begins looking for media data. **Param** The event. | `GridHTMLElement.onloadstart` | node\_modules/typescript/lib/lib.dom.d.ts:5994 | +| `onlostpointercapture` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onlostpointercapture` | node\_modules/typescript/lib/lib.dom.d.ts:5995 | +| `onmousedown` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user clicks the object with either mouse button. **Param** The mouse event. | `GridHTMLElement.onmousedown` | node\_modules/typescript/lib/lib.dom.d.ts:6000 | +| `onmouseenter` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onmouseenter` | node\_modules/typescript/lib/lib.dom.d.ts:6001 | +| `onmouseleave` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onmouseleave` | node\_modules/typescript/lib/lib.dom.d.ts:6002 | +| `onmousemove` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user moves the mouse over the object. **Param** The mouse event. | `GridHTMLElement.onmousemove` | node\_modules/typescript/lib/lib.dom.d.ts:6007 | +| `onmouseout` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user moves the mouse pointer outside the boundaries of the object. **Param** The mouse event. | `GridHTMLElement.onmouseout` | node\_modules/typescript/lib/lib.dom.d.ts:6012 | +| `onmouseover` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user moves the mouse pointer into the object. **Param** The mouse event. | `GridHTMLElement.onmouseover` | node\_modules/typescript/lib/lib.dom.d.ts:6017 | +| `onmouseup` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user releases a mouse button while the mouse is over the object. **Param** The mouse event. | `GridHTMLElement.onmouseup` | node\_modules/typescript/lib/lib.dom.d.ts:6022 | +| `onpaste` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onpaste` | node\_modules/typescript/lib/lib.dom.d.ts:6023 | +| `onpause` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when playback is paused. **Param** The event. | `GridHTMLElement.onpause` | node\_modules/typescript/lib/lib.dom.d.ts:6028 | +| `onplay` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the play method is requested. **Param** The event. | `GridHTMLElement.onplay` | node\_modules/typescript/lib/lib.dom.d.ts:6033 | +| `onplaying` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the audio or video has started playing. **Param** The event. | `GridHTMLElement.onplaying` | node\_modules/typescript/lib/lib.dom.d.ts:6038 | +| `onpointercancel` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onpointercancel` | node\_modules/typescript/lib/lib.dom.d.ts:6039 | +| `onpointerdown` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onpointerdown` | node\_modules/typescript/lib/lib.dom.d.ts:6040 | +| `onpointerenter` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onpointerenter` | node\_modules/typescript/lib/lib.dom.d.ts:6041 | +| `onpointerleave` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onpointerleave` | node\_modules/typescript/lib/lib.dom.d.ts:6042 | +| `onpointermove` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onpointermove` | node\_modules/typescript/lib/lib.dom.d.ts:6043 | +| `onpointerout` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onpointerout` | node\_modules/typescript/lib/lib.dom.d.ts:6044 | +| `onpointerover` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onpointerover` | node\_modules/typescript/lib/lib.dom.d.ts:6045 | +| `onpointerup` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onpointerup` | node\_modules/typescript/lib/lib.dom.d.ts:6046 | +| `onprogress` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs to indicate progress while downloading media data. **Param** The event. | `GridHTMLElement.onprogress` | node\_modules/typescript/lib/lib.dom.d.ts:6051 | +| `onratechange` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the playback rate is increased or decreased. **Param** The event. | `GridHTMLElement.onratechange` | node\_modules/typescript/lib/lib.dom.d.ts:6056 | +| `onreset` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user resets a form. **Param** The event. | `GridHTMLElement.onreset` | node\_modules/typescript/lib/lib.dom.d.ts:6061 | +| `onresize` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onresize` | node\_modules/typescript/lib/lib.dom.d.ts:6062 | +| `onscroll` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the user repositions the scroll box in the scroll bar on the object. **Param** The event. | `GridHTMLElement.onscroll` | node\_modules/typescript/lib/lib.dom.d.ts:6067 | +| `onsecuritypolicyviolation` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onsecuritypolicyviolation` | node\_modules/typescript/lib/lib.dom.d.ts:6068 | +| `onseeked` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the seek operation ends. **Param** The event. | `GridHTMLElement.onseeked` | node\_modules/typescript/lib/lib.dom.d.ts:6073 | +| `onseeking` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the current playback position is moved. **Param** The event. | `GridHTMLElement.onseeking` | node\_modules/typescript/lib/lib.dom.d.ts:6078 | +| `onselect` | `public` | `null` \| (`this`, `ev`) => `any` | Fires when the current selection changes. **Param** The event. | `GridHTMLElement.onselect` | node\_modules/typescript/lib/lib.dom.d.ts:6083 | +| `onselectionchange` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onselectionchange` | node\_modules/typescript/lib/lib.dom.d.ts:6084 | +| `onselectstart` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onselectstart` | node\_modules/typescript/lib/lib.dom.d.ts:6085 | +| `onslotchange` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onslotchange` | node\_modules/typescript/lib/lib.dom.d.ts:6086 | +| `onstalled` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the download has stopped. **Param** The event. | `GridHTMLElement.onstalled` | node\_modules/typescript/lib/lib.dom.d.ts:6091 | +| `onsubmit` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onsubmit` | node\_modules/typescript/lib/lib.dom.d.ts:6092 | +| `onsuspend` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs if the load operation has been intentionally halted. **Param** The event. | `GridHTMLElement.onsuspend` | node\_modules/typescript/lib/lib.dom.d.ts:6097 | +| `ontimeupdate` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs to indicate the current playback position. **Param** The event. | `GridHTMLElement.ontimeupdate` | node\_modules/typescript/lib/lib.dom.d.ts:6102 | +| `ontoggle` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.ontoggle` | node\_modules/typescript/lib/lib.dom.d.ts:6103 | +| `ontouchcancel?` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.ontouchcancel` | node\_modules/typescript/lib/lib.dom.d.ts:6104 | +| `ontouchend?` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.ontouchend` | node\_modules/typescript/lib/lib.dom.d.ts:6105 | +| `ontouchmove?` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.ontouchmove` | node\_modules/typescript/lib/lib.dom.d.ts:6106 | +| `ontouchstart?` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.ontouchstart` | node\_modules/typescript/lib/lib.dom.d.ts:6107 | +| `ontransitioncancel` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.ontransitioncancel` | node\_modules/typescript/lib/lib.dom.d.ts:6108 | +| `ontransitionend` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.ontransitionend` | node\_modules/typescript/lib/lib.dom.d.ts:6109 | +| `ontransitionrun` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.ontransitionrun` | node\_modules/typescript/lib/lib.dom.d.ts:6110 | +| `ontransitionstart` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.ontransitionstart` | node\_modules/typescript/lib/lib.dom.d.ts:6111 | +| `onvolumechange` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when the volume is changed, or playback is muted or unmuted. **Param** The event. | `GridHTMLElement.onvolumechange` | node\_modules/typescript/lib/lib.dom.d.ts:6116 | +| `onwaiting` | `public` | `null` \| (`this`, `ev`) => `any` | Occurs when playback stops because the next frame of a video resource is not available. **Param** The event. | `GridHTMLElement.onwaiting` | node\_modules/typescript/lib/lib.dom.d.ts:6121 | +| ~~`onwebkitanimationend`~~ | `public` | `null` \| (`this`, `ev`) => `any` | **Deprecated** This is a legacy alias of `onanimationend`. | `GridHTMLElement.onwebkitanimationend` | node\_modules/typescript/lib/lib.dom.d.ts:6123 | +| ~~`onwebkitanimationiteration`~~ | `public` | `null` \| (`this`, `ev`) => `any` | **Deprecated** This is a legacy alias of `onanimationiteration`. | `GridHTMLElement.onwebkitanimationiteration` | node\_modules/typescript/lib/lib.dom.d.ts:6125 | +| ~~`onwebkitanimationstart`~~ | `public` | `null` \| (`this`, `ev`) => `any` | **Deprecated** This is a legacy alias of `onanimationstart`. | `GridHTMLElement.onwebkitanimationstart` | node\_modules/typescript/lib/lib.dom.d.ts:6127 | +| ~~`onwebkittransitionend`~~ | `public` | `null` \| (`this`, `ev`) => `any` | **Deprecated** This is a legacy alias of `ontransitionend`. | `GridHTMLElement.onwebkittransitionend` | node\_modules/typescript/lib/lib.dom.d.ts:6129 | +| `onwheel` | `public` | `null` \| (`this`, `ev`) => `any` | - | `GridHTMLElement.onwheel` | node\_modules/typescript/lib/lib.dom.d.ts:6130 | +| `accessKey` | `public` | `string` | - | `GridHTMLElement.accessKey` | node\_modules/typescript/lib/lib.dom.d.ts:6555 | +| `accessKeyLabel` | `readonly` | `string` | - | `GridHTMLElement.accessKeyLabel` | node\_modules/typescript/lib/lib.dom.d.ts:6556 | +| `autocapitalize` | `public` | `string` | - | `GridHTMLElement.autocapitalize` | node\_modules/typescript/lib/lib.dom.d.ts:6557 | +| `dir` | `public` | `string` | - | `GridHTMLElement.dir` | node\_modules/typescript/lib/lib.dom.d.ts:6558 | +| `draggable` | `public` | `boolean` | - | `GridHTMLElement.draggable` | node\_modules/typescript/lib/lib.dom.d.ts:6559 | +| `hidden` | `public` | `boolean` | - | `GridHTMLElement.hidden` | node\_modules/typescript/lib/lib.dom.d.ts:6560 | +| `inert` | `public` | `boolean` | - | `GridHTMLElement.inert` | node\_modules/typescript/lib/lib.dom.d.ts:6561 | +| `innerText` | `public` | `string` | - | `GridHTMLElement.innerText` | node\_modules/typescript/lib/lib.dom.d.ts:6562 | +| `lang` | `public` | `string` | - | `GridHTMLElement.lang` | node\_modules/typescript/lib/lib.dom.d.ts:6563 | +| `offsetHeight` | `readonly` | `number` | - | `GridHTMLElement.offsetHeight` | node\_modules/typescript/lib/lib.dom.d.ts:6564 | +| `offsetLeft` | `readonly` | `number` | - | `GridHTMLElement.offsetLeft` | node\_modules/typescript/lib/lib.dom.d.ts:6565 | +| `offsetParent` | `readonly` | `null` \| `Element` | - | `GridHTMLElement.offsetParent` | node\_modules/typescript/lib/lib.dom.d.ts:6566 | +| `offsetTop` | `readonly` | `number` | - | `GridHTMLElement.offsetTop` | node\_modules/typescript/lib/lib.dom.d.ts:6567 | +| `offsetWidth` | `readonly` | `number` | - | `GridHTMLElement.offsetWidth` | node\_modules/typescript/lib/lib.dom.d.ts:6568 | +| `outerText` | `public` | `string` | - | `GridHTMLElement.outerText` | node\_modules/typescript/lib/lib.dom.d.ts:6569 | +| `spellcheck` | `public` | `boolean` | - | `GridHTMLElement.spellcheck` | node\_modules/typescript/lib/lib.dom.d.ts:6570 | +| `title` | `public` | `string` | - | `GridHTMLElement.title` | node\_modules/typescript/lib/lib.dom.d.ts:6571 | +| `translate` | `public` | `boolean` | - | `GridHTMLElement.translate` | node\_modules/typescript/lib/lib.dom.d.ts:6572 | +| `autofocus` | `public` | `boolean` | - | `GridHTMLElement.autofocus` | node\_modules/typescript/lib/lib.dom.d.ts:7764 | +| `dataset` | `readonly` | `DOMStringMap` | - | `GridHTMLElement.dataset` | node\_modules/typescript/lib/lib.dom.d.ts:7765 | +| `nonce?` | `public` | `string` | - | `GridHTMLElement.nonce` | node\_modules/typescript/lib/lib.dom.d.ts:7766 | +| `tabIndex` | `public` | `number` | - | `GridHTMLElement.tabIndex` | node\_modules/typescript/lib/lib.dom.d.ts:7767 | +| `innerHTML` | `public` | `string` | - | `GridHTMLElement.innerHTML` | node\_modules/typescript/lib/lib.dom.d.ts:9130 | +| `baseURI` | `readonly` | `string` | Returns node's node document's document base URL. | `GridHTMLElement.baseURI` | node\_modules/typescript/lib/lib.dom.d.ts:10249 | +| `childNodes` | `readonly` | `NodeListOf`\<`ChildNode`\> | Returns the children. | `GridHTMLElement.childNodes` | node\_modules/typescript/lib/lib.dom.d.ts:10251 | +| `firstChild` | `readonly` | `null` \| `ChildNode` | Returns the first child. | `GridHTMLElement.firstChild` | node\_modules/typescript/lib/lib.dom.d.ts:10253 | +| `isConnected` | `readonly` | `boolean` | Returns true if node is connected and false otherwise. | `GridHTMLElement.isConnected` | node\_modules/typescript/lib/lib.dom.d.ts:10255 | +| `lastChild` | `readonly` | `null` \| `ChildNode` | Returns the last child. | `GridHTMLElement.lastChild` | node\_modules/typescript/lib/lib.dom.d.ts:10257 | +| `nextSibling` | `readonly` | `null` \| `ChildNode` | Returns the next sibling. | `GridHTMLElement.nextSibling` | node\_modules/typescript/lib/lib.dom.d.ts:10259 | +| `nodeName` | `readonly` | `string` | Returns a string appropriate for the type of node. | `GridHTMLElement.nodeName` | node\_modules/typescript/lib/lib.dom.d.ts:10261 | +| `nodeType` | `readonly` | `number` | Returns the type of node. | `GridHTMLElement.nodeType` | node\_modules/typescript/lib/lib.dom.d.ts:10263 | +| `nodeValue` | `public` | `null` \| `string` | - | `GridHTMLElement.nodeValue` | node\_modules/typescript/lib/lib.dom.d.ts:10264 | +| `parentElement` | `readonly` | `null` \| `HTMLElement` | Returns the parent element. | `GridHTMLElement.parentElement` | node\_modules/typescript/lib/lib.dom.d.ts:10268 | +| `parentNode` | `readonly` | `null` \| `ParentNode` | Returns the parent. | `GridHTMLElement.parentNode` | node\_modules/typescript/lib/lib.dom.d.ts:10270 | +| `previousSibling` | `readonly` | `null` \| `ChildNode` | Returns the previous sibling. | `GridHTMLElement.previousSibling` | node\_modules/typescript/lib/lib.dom.d.ts:10272 | +| `textContent` | `public` | `null` \| `string` | - | `GridHTMLElement.textContent` | node\_modules/typescript/lib/lib.dom.d.ts:10273 | +| `ELEMENT_NODE` | `readonly` | `1` | node is an element. | `GridHTMLElement.ELEMENT_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10297 | +| `ATTRIBUTE_NODE` | `readonly` | `2` | - | `GridHTMLElement.ATTRIBUTE_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10298 | +| `TEXT_NODE` | `readonly` | `3` | node is a Text node. | `GridHTMLElement.TEXT_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10300 | +| `CDATA_SECTION_NODE` | `readonly` | `4` | node is a CDATASection node. | `GridHTMLElement.CDATA_SECTION_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10302 | +| `ENTITY_REFERENCE_NODE` | `readonly` | `5` | - | `GridHTMLElement.ENTITY_REFERENCE_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10303 | +| `ENTITY_NODE` | `readonly` | `6` | - | `GridHTMLElement.ENTITY_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10304 | +| `PROCESSING_INSTRUCTION_NODE` | `readonly` | `7` | node is a ProcessingInstruction node. | `GridHTMLElement.PROCESSING_INSTRUCTION_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10306 | +| `COMMENT_NODE` | `readonly` | `8` | node is a Comment node. | `GridHTMLElement.COMMENT_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10308 | +| `DOCUMENT_NODE` | `readonly` | `9` | node is a document. | `GridHTMLElement.DOCUMENT_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10310 | +| `DOCUMENT_TYPE_NODE` | `readonly` | `10` | node is a doctype. | `GridHTMLElement.DOCUMENT_TYPE_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10312 | +| `DOCUMENT_FRAGMENT_NODE` | `readonly` | `11` | node is a DocumentFragment node. | `GridHTMLElement.DOCUMENT_FRAGMENT_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10314 | +| `NOTATION_NODE` | `readonly` | `12` | - | `GridHTMLElement.NOTATION_NODE` | node\_modules/typescript/lib/lib.dom.d.ts:10315 | +| `DOCUMENT_POSITION_DISCONNECTED` | `readonly` | `1` | Set when node and other are not in the same tree. | `GridHTMLElement.DOCUMENT_POSITION_DISCONNECTED` | node\_modules/typescript/lib/lib.dom.d.ts:10317 | +| `DOCUMENT_POSITION_PRECEDING` | `readonly` | `2` | Set when other is preceding node. | `GridHTMLElement.DOCUMENT_POSITION_PRECEDING` | node\_modules/typescript/lib/lib.dom.d.ts:10319 | +| `DOCUMENT_POSITION_FOLLOWING` | `readonly` | `4` | Set when other is following node. | `GridHTMLElement.DOCUMENT_POSITION_FOLLOWING` | node\_modules/typescript/lib/lib.dom.d.ts:10321 | +| `DOCUMENT_POSITION_CONTAINS` | `readonly` | `8` | Set when other is an ancestor of node. | `GridHTMLElement.DOCUMENT_POSITION_CONTAINS` | node\_modules/typescript/lib/lib.dom.d.ts:10323 | +| `DOCUMENT_POSITION_CONTAINED_BY` | `readonly` | `16` | Set when other is a descendant of node. | `GridHTMLElement.DOCUMENT_POSITION_CONTAINED_BY` | node\_modules/typescript/lib/lib.dom.d.ts:10325 | +| `DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC` | `readonly` | `32` | - | `GridHTMLElement.DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC` | node\_modules/typescript/lib/lib.dom.d.ts:10326 | +| `nextElementSibling` | `readonly` | `null` \| `Element` | Returns the first following sibling that is an element, and null otherwise. | `GridHTMLElement.nextElementSibling` | node\_modules/typescript/lib/lib.dom.d.ts:10416 | +| `previousElementSibling` | `readonly` | `null` \| `Element` | Returns the first preceding sibling that is an element, and null otherwise. | `GridHTMLElement.previousElementSibling` | node\_modules/typescript/lib/lib.dom.d.ts:10418 | +| `childElementCount` | `readonly` | `number` | - | `GridHTMLElement.childElementCount` | node\_modules/typescript/lib/lib.dom.d.ts:10685 | +| `children` | `readonly` | `HTMLCollection` | Returns the child elements. | `GridHTMLElement.children` | node\_modules/typescript/lib/lib.dom.d.ts:10687 | +| `firstElementChild` | `readonly` | `null` \| `Element` | Returns the first child that is an element, and null otherwise. | `GridHTMLElement.firstElementChild` | node\_modules/typescript/lib/lib.dom.d.ts:10689 | +| `lastElementChild` | `readonly` | `null` \| `Element` | Returns the last child that is an element, and null otherwise. | `GridHTMLElement.lastElementChild` | node\_modules/typescript/lib/lib.dom.d.ts:10691 | +| `assignedSlot` | `readonly` | `null` \| `HTMLSlotElement` | - | `GridHTMLElement.assignedSlot` | node\_modules/typescript/lib/lib.dom.d.ts:13933 | + +## Functions + +### gsCreateNgComponents() + +```ts +function gsCreateNgComponents( + host, + n, + add, + isGrid): undefined | HTMLElement; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:353](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L353) + +can be used when a new item needs to be created, which we do as a Angular component, or deleted (skip) + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `host` | `HTMLElement` \| [`GridCompHTMLElement`](#gridcomphtmlelement) | +| `n` | [`NgGridStackNode`](types.md#nggridstacknode) | +| `add` | `boolean` | +| `isGrid` | `boolean` | + +#### Returns + +`undefined` \| `HTMLElement` + +*** + +### gsSaveAdditionalNgInfo() + +```ts +function gsSaveAdditionalNgInfo(n, w): void; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:437](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L437) + +called for each item in the grid - check if additional information needs to be saved. +Note: since this is options minus gridstack protected members using Utils.removeInternalForSave(), +this typically doesn't need to do anything. However your custom Component @Input() are now supported +using BaseWidget.serialize() + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `n` | [`NgGridStackNode`](types.md#nggridstacknode) | +| `w` | [`NgGridStackWidget`](types.md#nggridstackwidget) | + +#### Returns + +`void` + +*** + +### gsUpdateNgComponents() + +```ts +function gsUpdateNgComponents(n): void; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:456](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L456) + +track when widgeta re updated (rather than created) to make sure we de-serialize them as well + +#### Parameters + +| Parameter | Type | +| ------ | ------ | +| `n` | [`NgGridStackNode`](types.md#nggridstacknode) | + +#### Returns + +`void` + +## Type Aliases + +### eventCB + +```ts +type eventCB = object; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:24](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L24) + +Callback for general events (enable, disable, etc.) + +#### Properties + +##### event + +```ts +event: Event; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:24](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L24) + +*** + +### elementCB + +```ts +type elementCB = object; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:27](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L27) + +Callback for element-specific events (resize, drag, etc.) + +#### Properties + +##### event + +```ts +event: Event; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:27](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L27) + +##### el + +```ts +el: GridItemHTMLElement; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:27](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L27) + +*** + +### nodesCB + +```ts +type nodesCB = object; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:30](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L30) + +Callback for events affecting multiple nodes (change, etc.) + +#### Properties + +##### event + +```ts +event: Event; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:30](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L30) + +##### nodes + +```ts +nodes: GridStackNode[]; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:30](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L30) + +*** + +### droppedCB + +```ts +type droppedCB = object; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:33](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L33) + +Callback for drop events with before/after node state + +#### Properties + +##### event + +```ts +event: Event; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:33](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L33) + +##### previousNode + +```ts +previousNode: GridStackNode; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:33](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L33) + +##### newNode + +```ts +newNode: GridStackNode; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:33](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L33) + +*** + +### SelectorToType + +```ts +type SelectorToType = object; +``` + +Defined in: [angular/projects/lib/src/lib/gridstack.component.ts:48](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.component.ts#L48) + +Mapping of selector strings to Angular component types. +Used for dynamic component creation based on widget selectors. + +#### Index Signature + +```ts +[key: string]: Type +``` diff --git a/angular/docs/api/gridstack.module.md b/angular/docs/api/gridstack.module.md new file mode 100644 index 000000000..6e3aedcdc --- /dev/null +++ b/angular/docs/api/gridstack.module.md @@ -0,0 +1,44 @@ +# gridstack.module + +## Classes + +### ~~GridstackModule~~ + +Defined in: [angular/projects/lib/src/lib/gridstack.module.ts:44](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/gridstack.module.ts#L44) + +#### Deprecated + +Use GridstackComponent and GridstackItemComponent as standalone components instead. + +This NgModule is provided for backward compatibility but is no longer the recommended approach. +Import components directly in your standalone components or use the new Angular module structure. + +#### Example + +```typescript +// Preferred approach - standalone components +@Component({ + selector: 'my-app', + imports: [GridstackComponent, GridstackItemComponent], + template: '' +}) +export class AppComponent {} + +// Legacy approach (deprecated) +@NgModule({ + imports: [GridstackModule] +}) +export class AppModule {} +``` + +#### Constructors + +##### Constructor + +```ts +new GridstackModule(): GridstackModule; +``` + +###### Returns + +[`GridstackModule`](#gridstackmodule) diff --git a/angular/docs/api/index.md b/angular/docs/api/index.md new file mode 100644 index 000000000..a23a71b57 --- /dev/null +++ b/angular/docs/api/index.md @@ -0,0 +1,11 @@ +# GridStack Angular Library v12.2.2-dev + +## Modules + +| Module | Description | +| ------ | ------ | +| [gridstack.component](gridstack.component.md) | - | +| [gridstack-item.component](gridstack-item.component.md) | - | +| [gridstack.module](gridstack.module.md) | - | +| [base-widget](base-widget.md) | - | +| [types](types.md) | - | diff --git a/angular/docs/api/types.md b/angular/docs/api/types.md new file mode 100644 index 000000000..0615a08dd --- /dev/null +++ b/angular/docs/api/types.md @@ -0,0 +1,90 @@ +# types + +## Interfaces + +### NgGridStackWidget + +Defined in: [angular/projects/lib/src/lib/types.ts:12](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/types.ts#L12) + +Extended GridStackWidget interface for Angular integration. +Adds Angular-specific properties for dynamic component creation. + +#### Extends + +- `GridStackWidget` + +#### Properties + +| Property | Type | Description | Overrides | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `selector?` | `string` | Angular component selector for dynamic creation (e.g., 'my-widget') | - | [angular/projects/lib/src/lib/types.ts:14](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/types.ts#L14) | +| `input?` | [`NgCompInputs`](#ngcompinputs) | Serialized data for component @Input() properties | - | [angular/projects/lib/src/lib/types.ts:16](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/types.ts#L16) | +| `subGridOpts?` | [`NgGridStackOptions`](#nggridstackoptions) | Configuration for nested sub-grids | `GridStackWidget.subGridOpts` | [angular/projects/lib/src/lib/types.ts:18](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/types.ts#L18) | + +*** + +### NgGridStackNode + +Defined in: [angular/projects/lib/src/lib/types.ts:25](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/types.ts#L25) + +Extended GridStackNode interface for Angular integration. +Adds component selector for dynamic content creation. + +#### Extends + +- `GridStackNode` + +#### Properties + +| Property | Type | Description | Defined in | +| ------ | ------ | ------ | ------ | +| `selector?` | `string` | Angular component selector for this node's content | [angular/projects/lib/src/lib/types.ts:27](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/types.ts#L27) | + +*** + +### NgGridStackOptions + +Defined in: [angular/projects/lib/src/lib/types.ts:34](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/types.ts#L34) + +Extended GridStackOptions interface for Angular integration. +Supports Angular-specific widget definitions and nested grids. + +#### Extends + +- `GridStackOptions` + +#### Properties + +| Property | Type | Description | Overrides | Defined in | +| ------ | ------ | ------ | ------ | ------ | +| `children?` | [`NgGridStackWidget`](#nggridstackwidget)[] | Array of Angular widget definitions for initial grid setup | `GridStackOptions.children` | [angular/projects/lib/src/lib/types.ts:36](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/types.ts#L36) | +| `subGridOpts?` | [`NgGridStackOptions`](#nggridstackoptions) | Configuration for nested sub-grids (Angular-aware) | `GridStackOptions.subGridOpts` | [angular/projects/lib/src/lib/types.ts:38](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/types.ts#L38) | + +## Type Aliases + +### NgCompInputs + +```ts +type NgCompInputs = object; +``` + +Defined in: [angular/projects/lib/src/lib/types.ts:54](https://github.com/adumesny/gridstack.js/blob/master/angular/projects/lib/src/lib/types.ts#L54) + +Type for component input data serialization. +Maps @Input() property names to their values for widget persistence. + +#### Index Signature + +```ts +[key: string]: any +``` + +#### Example + +```typescript +const inputs: NgCompInputs = { + title: 'My Widget', + value: 42, + config: { enabled: true } +}; +``` diff --git a/angular/docs/html/.nojekyll b/angular/docs/html/.nojekyll new file mode 100644 index 000000000..e2ac6616a --- /dev/null +++ b/angular/docs/html/.nojekyll @@ -0,0 +1 @@ +TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/angular/docs/html/assets/hierarchy.js b/angular/docs/html/assets/hierarchy.js new file mode 100644 index 000000000..88636f05d --- /dev/null +++ b/angular/docs/html/assets/hierarchy.js @@ -0,0 +1 @@ +window.hierarchyData = "eJyrVirKzy8pVrKKjtVRKkpNy0lNLsnMzwMKVNfWAgCbHgqm" \ No newline at end of file diff --git a/angular/docs/html/assets/highlight.css b/angular/docs/html/assets/highlight.css new file mode 100644 index 000000000..08c38c277 --- /dev/null +++ b/angular/docs/html/assets/highlight.css @@ -0,0 +1,148 @@ +:root { + --light-hl-0: #800000; + --dark-hl-0: #808080; + --light-hl-1: #CD3131; + --dark-hl-1: #F44747; + --light-hl-2: #000000; + --dark-hl-2: #D4D4D4; + --light-hl-3: #E50000; + --dark-hl-3: #9CDCFE; + --light-hl-4: #0000FF; + --dark-hl-4: #CE9178; + --light-hl-5: #AF00DB; + --dark-hl-5: #C586C0; + --light-hl-6: #A31515; + --dark-hl-6: #CE9178; + --light-hl-7: #800000; + --dark-hl-7: #D7BA7D; + --light-hl-8: #0451A5; + --dark-hl-8: #CE9178; + --light-hl-9: #001080; + --dark-hl-9: #9CDCFE; + --light-hl-10: #795E26; + --dark-hl-10: #DCDCAA; + --light-hl-11: #008000; + --dark-hl-11: #6A9955; + --light-hl-12: #0000FF; + --dark-hl-12: #569CD6; + --light-hl-13: #267F99; + --dark-hl-13: #4EC9B0; + --light-hl-14: #098658; + --dark-hl-14: #B5CEA8; + --light-hl-15: #800000; + --dark-hl-15: #569CD6; + --light-hl-16: #000000; + --dark-hl-16: #C8C8C8; + --light-hl-17: #0070C1; + --dark-hl-17: #4FC1FF; + --light-code-background: #FFFFFF; + --dark-code-background: #1E1E1E; +} + +@media (prefers-color-scheme: light) { :root { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); + --hl-16: var(--light-hl-16); + --hl-17: var(--light-hl-17); + --code-background: var(--light-code-background); +} } + +@media (prefers-color-scheme: dark) { :root { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); + --hl-16: var(--dark-hl-16); + --hl-17: var(--dark-hl-17); + --code-background: var(--dark-code-background); +} } + +:root[data-theme='light'] { + --hl-0: var(--light-hl-0); + --hl-1: var(--light-hl-1); + --hl-2: var(--light-hl-2); + --hl-3: var(--light-hl-3); + --hl-4: var(--light-hl-4); + --hl-5: var(--light-hl-5); + --hl-6: var(--light-hl-6); + --hl-7: var(--light-hl-7); + --hl-8: var(--light-hl-8); + --hl-9: var(--light-hl-9); + --hl-10: var(--light-hl-10); + --hl-11: var(--light-hl-11); + --hl-12: var(--light-hl-12); + --hl-13: var(--light-hl-13); + --hl-14: var(--light-hl-14); + --hl-15: var(--light-hl-15); + --hl-16: var(--light-hl-16); + --hl-17: var(--light-hl-17); + --code-background: var(--light-code-background); +} + +:root[data-theme='dark'] { + --hl-0: var(--dark-hl-0); + --hl-1: var(--dark-hl-1); + --hl-2: var(--dark-hl-2); + --hl-3: var(--dark-hl-3); + --hl-4: var(--dark-hl-4); + --hl-5: var(--dark-hl-5); + --hl-6: var(--dark-hl-6); + --hl-7: var(--dark-hl-7); + --hl-8: var(--dark-hl-8); + --hl-9: var(--dark-hl-9); + --hl-10: var(--dark-hl-10); + --hl-11: var(--dark-hl-11); + --hl-12: var(--dark-hl-12); + --hl-13: var(--dark-hl-13); + --hl-14: var(--dark-hl-14); + --hl-15: var(--dark-hl-15); + --hl-16: var(--dark-hl-16); + --hl-17: var(--dark-hl-17); + --code-background: var(--dark-code-background); +} + +.hl-0 { color: var(--hl-0); } +.hl-1 { color: var(--hl-1); } +.hl-2 { color: var(--hl-2); } +.hl-3 { color: var(--hl-3); } +.hl-4 { color: var(--hl-4); } +.hl-5 { color: var(--hl-5); } +.hl-6 { color: var(--hl-6); } +.hl-7 { color: var(--hl-7); } +.hl-8 { color: var(--hl-8); } +.hl-9 { color: var(--hl-9); } +.hl-10 { color: var(--hl-10); } +.hl-11 { color: var(--hl-11); } +.hl-12 { color: var(--hl-12); } +.hl-13 { color: var(--hl-13); } +.hl-14 { color: var(--hl-14); } +.hl-15 { color: var(--hl-15); } +.hl-16 { color: var(--hl-16); } +.hl-17 { color: var(--hl-17); } +pre, code { background: var(--code-background); } diff --git a/angular/docs/html/assets/icons.js b/angular/docs/html/assets/icons.js new file mode 100644 index 000000000..58882d76d --- /dev/null +++ b/angular/docs/html/assets/icons.js @@ -0,0 +1,18 @@ +(function() { + addIcons(); + function addIcons() { + if (document.readyState === "loading") return document.addEventListener("DOMContentLoaded", addIcons); + const svg = document.body.appendChild(document.createElementNS("http://www.w3.org/2000/svg", "svg")); + svg.innerHTML = `MMNEPVFCICPMFPCPTTAAATR`; + svg.style.display = "none"; + if (location.protocol === "file:") updateUseElements(); + } + + function updateUseElements() { + document.querySelectorAll("use").forEach(el => { + if (el.getAttribute("href").includes("#icon-")) { + el.setAttribute("href", el.getAttribute("href").replace(/.*#/, "#")); + } + }); + } +})() \ No newline at end of file diff --git a/angular/docs/html/assets/icons.svg b/angular/docs/html/assets/icons.svg new file mode 100644 index 000000000..50ad5799d --- /dev/null +++ b/angular/docs/html/assets/icons.svg @@ -0,0 +1 @@ +MMNEPVFCICPMFPCPTTAAATR \ No newline at end of file diff --git a/angular/docs/html/assets/main.js b/angular/docs/html/assets/main.js new file mode 100644 index 000000000..19bbb7a74 --- /dev/null +++ b/angular/docs/html/assets/main.js @@ -0,0 +1,60 @@ +"use strict"; +window.translations={"copy":"Copy","copied":"Copied!","normally_hidden":"This member is normally hidden due to your filter settings.","hierarchy_expand":"Expand","hierarchy_collapse":"Collapse","folder":"Folder","search_index_not_available":"The search index is not available","search_no_results_found_for_0":"No results found for {0}","kind_1":"Project","kind_2":"Module","kind_4":"Namespace","kind_8":"Enumeration","kind_16":"Enumeration Member","kind_32":"Variable","kind_64":"Function","kind_128":"Class","kind_256":"Interface","kind_512":"Constructor","kind_1024":"Property","kind_2048":"Method","kind_4096":"Call Signature","kind_8192":"Index Signature","kind_16384":"Constructor Signature","kind_32768":"Parameter","kind_65536":"Type Literal","kind_131072":"Type Parameter","kind_262144":"Accessor","kind_524288":"Get Signature","kind_1048576":"Set Signature","kind_2097152":"Type Alias","kind_4194304":"Reference","kind_8388608":"Document"}; +"use strict";(()=>{var Ke=Object.create;var he=Object.defineProperty;var Ge=Object.getOwnPropertyDescriptor;var Ze=Object.getOwnPropertyNames;var Xe=Object.getPrototypeOf,Ye=Object.prototype.hasOwnProperty;var et=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var tt=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Ze(e))!Ye.call(t,i)&&i!==n&&he(t,i,{get:()=>e[i],enumerable:!(r=Ge(e,i))||r.enumerable});return t};var nt=(t,e,n)=>(n=t!=null?Ke(Xe(t)):{},tt(e||!t||!t.__esModule?he(n,"default",{value:t,enumerable:!0}):n,t));var ye=et((me,ge)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,l],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?d+=2:a==c&&(n+=r[l+1]*i[d+1],l+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),f=s.str.charAt(1),p;f in s.node.edges?p=s.node.edges[f]:(p=new t.TokenSet,s.node.edges[f]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof me=="object"?ge.exports=n():e.lunr=n()}(this,function(){return t})})()});var M,G={getItem(){return null},setItem(){}},K;try{K=localStorage,M=K}catch{K=G,M=G}var S={getItem:t=>M.getItem(t),setItem:(t,e)=>M.setItem(t,e),disableWritingLocalStorage(){M=G},disable(){localStorage.clear(),M=G},enable(){M=K}};window.TypeDoc||={disableWritingLocalStorage(){S.disableWritingLocalStorage()},disableLocalStorage:()=>{S.disable()},enableLocalStorage:()=>{S.enable()}};window.translations||={copy:"Copy",copied:"Copied!",normally_hidden:"This member is normally hidden due to your filter settings.",hierarchy_expand:"Expand",hierarchy_collapse:"Collapse",search_index_not_available:"The search index is not available",search_no_results_found_for_0:"No results found for {0}",folder:"Folder",kind_1:"Project",kind_2:"Module",kind_4:"Namespace",kind_8:"Enumeration",kind_16:"Enumeration Member",kind_32:"Variable",kind_64:"Function",kind_128:"Class",kind_256:"Interface",kind_512:"Constructor",kind_1024:"Property",kind_2048:"Method",kind_4096:"Call Signature",kind_8192:"Index Signature",kind_16384:"Constructor Signature",kind_32768:"Parameter",kind_65536:"Type Literal",kind_131072:"Type Parameter",kind_262144:"Accessor",kind_524288:"Get Signature",kind_1048576:"Set Signature",kind_2097152:"Type Alias",kind_4194304:"Reference",kind_8388608:"Document"};var pe=[];function X(t,e){pe.push({selector:e,constructor:t})}var Z=class{alwaysVisibleMember=null;constructor(){this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}createComponents(e){pe.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.ensureFocusedElementVisible(),this.updateIndexVisibility(),this.scrollToHash())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!rt(e)){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r,document.querySelector(".col-sidebar").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(!n)return;let r=n.offsetParent==null,i=n;for(;i!==document.body;)i instanceof HTMLDetailsElement&&(i.open=!0),i=i.parentElement;if(n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let s=document.createElement("p");s.classList.add("warning"),s.textContent=window.translations.normally_hidden,n.prepend(s)}r&&e.scrollIntoView()}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent=window.translations.copied,e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent=window.translations.copy},100)},1e3)})})}};function rt(t){let e=t.getBoundingClientRect(),n=Math.max(document.documentElement.clientHeight,window.innerHeight);return!(e.bottom<0||e.top-n>=0)}var fe=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var Ie=nt(ye(),1);async function R(t){let e=Uint8Array.from(atob(t),s=>s.charCodeAt(0)),r=new Blob([e]).stream().pipeThrough(new DecompressionStream("deflate")),i=await new Response(r).text();return JSON.parse(i)}var Y="closing",ae="tsd-overlay";function it(){let t=Math.abs(window.innerWidth-document.documentElement.clientWidth);document.body.style.overflow="hidden",document.body.style.paddingRight=`${t}px`}function st(){document.body.style.removeProperty("overflow"),document.body.style.removeProperty("padding-right")}function xe(t,e){t.addEventListener("animationend",()=>{t.classList.contains(Y)&&(t.classList.remove(Y),document.getElementById(ae)?.remove(),t.close(),st())}),t.addEventListener("cancel",n=>{n.preventDefault(),ve(t)}),e?.closeOnClick&&document.addEventListener("click",n=>{t.open&&!t.contains(n.target)&&ve(t)},!0)}function Ee(t){if(t.open)return;let e=document.createElement("div");e.id=ae,document.body.appendChild(e),t.showModal(),it()}function ve(t){if(!t.open)return;document.getElementById(ae)?.classList.add(Y),t.classList.add(Y)}var I=class{el;app;constructor(e){this.el=e.el,this.app=e.app}};var be=document.head.appendChild(document.createElement("style"));be.dataset.for="filters";var le={};function we(t){for(let e of t.split(/\s+/))if(le.hasOwnProperty(e)&&!le[e])return!0;return!1}var ee=class extends I{key;value;constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),be.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=S.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){S.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),le[`tsd-is-${this.el.name}`]=this.value,this.app.filterChanged(),this.app.updateIndexVisibility()}};var Le=0;async function Se(t,e){if(!window.searchData)return;let n=await R(window.searchData);t.data=n,t.index=Ie.Index.load(n.index),e.innerHTML=""}function _e(){let t=document.getElementById("tsd-search-trigger"),e=document.getElementById("tsd-search"),n=document.getElementById("tsd-search-input"),r=document.getElementById("tsd-search-results"),i=document.getElementById("tsd-search-script"),s=document.getElementById("tsd-search-status");if(!(t&&e&&n&&r&&i&&s))throw new Error("Search controls missing");let o={base:document.documentElement.dataset.base};o.base.endsWith("/")||(o.base+="/"),i.addEventListener("error",()=>{let a=window.translations.search_index_not_available;Pe(s,a)}),i.addEventListener("load",()=>{Se(o,s)}),Se(o,s),ot({trigger:t,searchEl:e,results:r,field:n,status:s},o)}function ot(t,e){let{field:n,results:r,searchEl:i,status:s,trigger:o}=t;xe(i,{closeOnClick:!0});function a(){Ee(i),n.setSelectionRange(0,n.value.length)}o.addEventListener("click",a),n.addEventListener("input",fe(()=>{at(r,n,s,e)},200)),n.addEventListener("keydown",l=>{if(r.childElementCount===0||l.ctrlKey||l.metaKey||l.altKey)return;let d=n.getAttribute("aria-activedescendant"),f=d?document.getElementById(d):null;if(f){let p=!1,v=!1;switch(l.key){case"Home":case"End":case"ArrowLeft":case"ArrowRight":v=!0;break;case"ArrowDown":case"ArrowUp":p=l.shiftKey;break}(p||v)&&ke(n)}if(!l.shiftKey)switch(l.key){case"Enter":f?.querySelector("a")?.click();break;case"ArrowUp":Te(r,n,f,-1),l.preventDefault();break;case"ArrowDown":Te(r,n,f,1),l.preventDefault();break}});function c(){ke(n)}n.addEventListener("change",c),n.addEventListener("blur",c),n.addEventListener("click",c),document.body.addEventListener("keydown",l=>{if(l.altKey||l.metaKey||l.shiftKey)return;let d=l.ctrlKey&&l.key==="k",f=!l.ctrlKey&&!ut()&&l.key==="/";(d||f)&&(l.preventDefault(),a())})}function at(t,e,n,r){if(!r.index||!r.data)return;t.innerHTML="",n.innerHTML="",Le+=1;let i=e.value.trim(),s;if(i){let a=i.split(" ").map(c=>c.length?`*${c}*`:"").join(" ");s=r.index.search(a).filter(({ref:c})=>{let l=r.data.rows[Number(c)].classes;return!l||!we(l)})}else s=[];if(s.length===0&&i){let a=window.translations.search_no_results_found_for_0.replace("{0}",` "${te(i)}" `);Pe(n,a);return}for(let a=0;ac.score-a.score);let o=Math.min(10,s.length);for(let a=0;a`,f=Ce(c.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(f+=` (score: ${s[a].score.toFixed(2)})`),c.parent&&(f=` + ${Ce(c.parent,i)}.${f}`);let p=document.createElement("li");p.id=`tsd-search:${Le}-${a}`,p.role="option",p.ariaSelected="false",p.classList.value=c.classes??"";let v=document.createElement("a");v.tabIndex=-1,v.href=r.base+c.url,v.innerHTML=d+`${f}`,p.append(v),t.appendChild(p)}}function Te(t,e,n,r){let i;if(r===1?i=n?.nextElementSibling||t.firstElementChild:i=n?.previousElementSibling||t.lastElementChild,i!==n){if(!i||i.role!=="option"){console.error("Option missing");return}i.ariaSelected="true",i.scrollIntoView({behavior:"smooth",block:"nearest"}),e.setAttribute("aria-activedescendant",i.id),n?.setAttribute("aria-selected","false")}}function ke(t){let e=t.getAttribute("aria-activedescendant");(e?document.getElementById(e):null)?.setAttribute("aria-selected","false"),t.setAttribute("aria-activedescendant","")}function Ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(te(t.substring(s,o)),`${te(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(te(t.substring(s))),i.join("")}var lt={"&":"&","<":"<",">":">","'":"'",'"':"""};function te(t){return t.replace(/[&<>"'"]/g,e=>lt[e])}function Pe(t,e){t.innerHTML=e?`
${e}
`:""}var ct=["button","checkbox","file","hidden","image","radio","range","reset","submit"];function ut(){let t=document.activeElement;return t?t.isContentEditable||t.tagName==="TEXTAREA"||t.tagName==="SEARCH"?!0:t.tagName==="INPUT"&&!ct.includes(t.type):!1}var D="mousedown",Me="mousemove",$="mouseup",ne={x:0,y:0},Qe=!1,ce=!1,dt=!1,F=!1,Oe=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Oe?"is-mobile":"not-mobile");Oe&&"ontouchstart"in document.documentElement&&(dt=!0,D="touchstart",Me="touchmove",$="touchend");document.addEventListener(D,t=>{ce=!0,F=!1;let e=D=="touchstart"?t.targetTouches[0]:t;ne.y=e.pageY||0,ne.x=e.pageX||0});document.addEventListener(Me,t=>{if(ce&&!F){let e=D=="touchstart"?t.targetTouches[0]:t,n=ne.x-(e.pageX||0),r=ne.y-(e.pageY||0);F=Math.sqrt(n*n+r*r)>10}});document.addEventListener($,()=>{ce=!1});document.addEventListener("click",t=>{Qe&&(t.preventDefault(),t.stopImmediatePropagation(),Qe=!1)});var re=class extends I{active;className;constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener($,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(D,n=>this.onDocumentPointerDown(n)),document.addEventListener($,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){F||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!F&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var ue=new Map,de=class{open;accordions=[];key;constructor(e,n){this.key=e,this.open=n}add(e){this.accordions.push(e),e.open=this.open,e.addEventListener("toggle",()=>{this.toggle(e.open)})}toggle(e){for(let n of this.accordions)n.open=e;S.setItem(this.key,e.toString())}},ie=class extends I{constructor(e){super(e);let n=this.el.querySelector("summary"),r=n.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)});let i=`tsd-accordion-${n.dataset.key??n.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`,s;if(ue.has(i))s=ue.get(i);else{let o=S.getItem(i),a=o?o==="true":this.el.open;s=new de(i,a),ue.set(i,s)}s.add(this.el)}};function He(t){let e=S.getItem("tsd-theme")||"os";t.value=e,Ae(e),t.addEventListener("change",()=>{S.setItem("tsd-theme",t.value),Ae(t.value)})}function Ae(t){document.documentElement.dataset.theme=t}var se;function Ne(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",Re),Re())}async function Re(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let e=await R(window.navigationData);se=document.documentElement.dataset.base,se.endsWith("/")||(se+="/"),t.innerHTML="";for(let n of e)Be(n,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function Be(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-accordion`:"tsd-accordion";let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.dataset.key=i.join("$"),o.innerHTML='',De(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let c=a.appendChild(document.createElement("ul"));c.className="tsd-nested-navigation";for(let l of t.children)Be(l,c,i)}else De(t,r,t.class)}function De(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));if(r.href=se+t.path,n&&(r.className=n),location.pathname===r.pathname&&!r.href.includes("#")&&(r.classList.add("current"),r.ariaCurrent="page"),t.kind){let i=window.translations[`kind_${t.kind}`].replaceAll('"',""");r.innerHTML=``}r.appendChild(Fe(t.text,document.createElement("span")))}else{let r=e.appendChild(document.createElement("span")),i=window.translations.folder.replaceAll('"',""");r.innerHTML=``,r.appendChild(Fe(t.text,document.createElement("span")))}}function Fe(t,e){let n=t.split(/(?<=[^A-Z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])|(?<=[_-])(?=[^_-])/);for(let r=0;r{let i=r.target;for(;i.parentElement&&i.parentElement.tagName!="LI";)i=i.parentElement;i.dataset.dropdown&&(i.dataset.dropdown=String(i.dataset.dropdown!=="true"))});let t=new Map,e=new Set;for(let r of document.querySelectorAll(".tsd-full-hierarchy [data-refl]")){let i=r.querySelector("ul");t.has(r.dataset.refl)?e.add(r.dataset.refl):i&&t.set(r.dataset.refl,i)}for(let r of e)n(r);function n(r){let i=t.get(r).cloneNode(!0);i.querySelectorAll("[id]").forEach(s=>{s.removeAttribute("id")}),i.querySelectorAll("[data-dropdown]").forEach(s=>{s.dataset.dropdown="false"});for(let s of document.querySelectorAll(`[data-refl="${r}"]`)){let o=gt(),a=s.querySelector("ul");s.insertBefore(o,a),o.dataset.dropdown=String(!!a),a||s.appendChild(i.cloneNode(!0))}}}function pt(){let t=document.getElementById("tsd-hierarchy-script");t&&(t.addEventListener("load",Ve),Ve())}async function Ve(){let t=document.querySelector(".tsd-panel.tsd-hierarchy:has(h4 a)");if(!t||!window.hierarchyData)return;let e=+t.dataset.refl,n=await R(window.hierarchyData),r=t.querySelector("ul"),i=document.createElement("ul");if(i.classList.add("tsd-hierarchy"),ft(i,n,e),r.querySelectorAll("li").length==i.querySelectorAll("li").length)return;let s=document.createElement("span");s.classList.add("tsd-hierarchy-toggle"),s.textContent=window.translations.hierarchy_expand,t.querySelector("h4 a")?.insertAdjacentElement("afterend",s),s.insertAdjacentText("beforebegin",", "),s.addEventListener("click",()=>{s.textContent===window.translations.hierarchy_expand?(r.insertAdjacentElement("afterend",i),r.remove(),s.textContent=window.translations.hierarchy_collapse):(i.insertAdjacentElement("afterend",r),i.remove(),s.textContent=window.translations.hierarchy_expand)})}function ft(t,e,n){let r=e.roots.filter(i=>mt(e,i,n));for(let i of r)t.appendChild(je(e,i,n))}function je(t,e,n,r=new Set){if(r.has(e))return;r.add(e);let i=t.reflections[e],s=document.createElement("li");if(s.classList.add("tsd-hierarchy-item"),e===n){let o=s.appendChild(document.createElement("span"));o.textContent=i.name,o.classList.add("tsd-hierarchy-target")}else{for(let a of i.uniqueNameParents||[]){let c=t.reflections[a],l=s.appendChild(document.createElement("a"));l.textContent=c.name,l.href=oe+c.url,l.className=c.class+" tsd-signature-type",s.append(document.createTextNode("."))}let o=s.appendChild(document.createElement("a"));o.textContent=t.reflections[e].name,o.href=oe+i.url,o.className=i.class+" tsd-signature-type"}if(i.children){let o=s.appendChild(document.createElement("ul"));o.classList.add("tsd-hierarchy");for(let a of i.children){let c=je(t,a,n,r);c&&o.appendChild(c)}}return r.delete(e),s}function mt(t,e,n){if(e===n)return!0;let r=new Set,i=[t.reflections[e]];for(;i.length;){let s=i.pop();if(!r.has(s)){r.add(s);for(let o of s.children||[]){if(o===n)return!0;i.push(t.reflections[o])}}}return!1}function gt(){let t=document.createElementNS("http://www.w3.org/2000/svg","svg");return t.setAttribute("width","20"),t.setAttribute("height","20"),t.setAttribute("viewBox","0 0 24 24"),t.setAttribute("fill","none"),t.innerHTML='',t}X(re,"a[data-toggle]");X(ie,".tsd-accordion");X(ee,".tsd-filter-item input[type=checkbox]");var qe=document.getElementById("tsd-theme");qe&&He(qe);var yt=new Z;Object.defineProperty(window,"app",{value:yt});_e();Ne();$e();"virtualKeyboard"in navigator&&(navigator.virtualKeyboard.overlaysContent=!0);})(); +/*! Bundled license information: + +lunr/lunr.js: + (** + * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 + * Copyright (C) 2020 Oliver Nightingale + * @license MIT + *) + (*! + * lunr.utils + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Set + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.tokenizer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Pipeline + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Vector + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.stemmer + * Copyright (C) 2020 Oliver Nightingale + * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt + *) + (*! + * lunr.stopWordFilter + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.trimmer + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.TokenSet + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Index + * Copyright (C) 2020 Oliver Nightingale + *) + (*! + * lunr.Builder + * Copyright (C) 2020 Oliver Nightingale + *) +*/ diff --git a/angular/docs/html/assets/navigation.js b/angular/docs/html/assets/navigation.js new file mode 100644 index 000000000..88ad8d197 --- /dev/null +++ b/angular/docs/html/assets/navigation.js @@ -0,0 +1 @@ +window.navigationData = "eJydlU1TwjAQhv9LzgWFEVRu0nGUGakHcDwwHGqylA5tkmkD6jj8d9Pvj4Q2em3f93l3l2W7+UECvgSaIS/ySSxcfBhiFnJGgQpkIe6KvXwZMnIMIL7SiIZ7EQZSefApQbOxhfDeD0gEFM02JRxOUmnPK6D45hdwubSFvb6/HU3GZ6siBhCaMwtxH5UyArEZM5f2EUnEOAdixizFfdQnabal7Xm9fHnMmqv4PhUQ7Vx8IUTjbcVNprWolRweFixas7Ws26SLpsOklZRgq2uHAzeOO9po+ppJo/FdLcWL7QhcAY5XyuMqZ3ekWPiM6pN03mbW9KYRtXJP8ECInyDdwPEWdMfMw3Tuzrg3Tv7dmepVorb1sAIy8AWERpeipTQ6F8lvu5C2P614O+gCpGvXy50qfH37qMtUAepiamc6zGbXdXWzJ8YzTE3LFlX9U+XUlkOp2sqsyVEDHgGWi0NQo5UPN4bBp0880GxE7aVRA3Opf2+xitrrrErXPef0YKllpY+NCnK8ZEKrZELtumr7mPEUbdfa1cSO/KqYYROlIfSVpyfAjJuLu9HJai8oP9ZPTfZBKHiVQv8B2J63vxFp+JA=" \ No newline at end of file diff --git a/angular/docs/html/assets/search.js b/angular/docs/html/assets/search.js new file mode 100644 index 000000000..e1add8acc --- /dev/null +++ b/angular/docs/html/assets/search.js @@ -0,0 +1 @@ +window.searchData = "eJzVfWuP7Day2H8ZB1gHmB2LD5GSsXeDvc4i10DuLpDdJB98DaPPtGam455Wox9z9qzh/x5W8dEqiiWp5+EgX6Y5ehSLZL2rSP1yc+g/H2++/eGXm583u/XNt/L2Zrd67m6+vXk8bNbH0+r+57v7/nnf77rd6eb25nzYunvP/fq87Y7fFJ65ezo9b92D99vV8dg50Dc3v94m6FVrRX3po3txb3z3rwnu6cuegRqeLEC/vdmvDoBcGeVL56KSmvZ8Zb9fxZcW9x5fn5qCbfe8eBLis7/9NJCeXzMRaZgcJttXoHHVHBRxyJdj16+746LFCE/+5ksx7PcVCxEHyGCBt6/FIr70FizyhVgf+v2+Wy9aivTsb74YtOdXLMdlmAwm+0P3sunPx7+4Gbseofj2zr/9jnjtus+vQ8m9+C7YyNokZP6be+c79/S//f3f//ufPZcnxDa7U3d4WN0z2BVefTcq+ukxAH8rMl8hpHsPafm0laaF57i/Ofl4f+oPf+//7tZywcLSF940a7Iha4lPfjcyOwJoduroa++2jOnR70/d8/Et2HyVnt0EUNctZjYvDL73/e602uy6w5tQHUJ5JyylkUJf8Oz3p02/e9uEXmB8xExujn9+3p++vAnDzbELMD4Cw9V6TZTkazBEGPefPooan1a7x+6NKHogH4bjenNcfdq+FckA5eOwPKwe34qiA/Gh+P3ttDqc3gHJI8D5YEz7/bsg2u8/EM/cCH4dmgjlw7Dsdu/APB7Ih+F46J77lzfPZIDygVgeN/9860x6IB+M43vwuYf0sZwesX0zr0dk35fbM4toEAR5FQ9dFw+5BjN4/82W74et8cMbl/bhgzA7ll2q1yAZQZ36kwf1Xutc6WZoTaZn/t4n/+6tuDuw6aFTn0byceN47E4R+bcRbXc6XuB8BIX89B5O0E8lL+h0XP9+c/z9/tCf3AC69Tvi/GZh8NNIGnwgtsfzp7ch6wH8Frhu+9W6e9vUJhAfhG8t5DDQcDwdzm9mMwrnQ0xUH/36H2/UFAFMrjDedYKJINs9/nX3/W7zphDYV7vHfrfxQD5C2O4e//Rw6g7f9buTe+odsF0BuHsP7kPx/uvuvzqL7tC/LcAD07tOcD4C0/N+vTp1f9q+zTr0UFbb9zQSh1jeP3X3P789XoZg3jlkRvB86vuf/wyJmrcpXQDTRTC/hSw4794Jcw/oo3E3A+fh+N2hc7T3l8f04GUED+fdPVovxTGUXn1LYJ9g9bfVS/en9XoD3a+2f3n8fvfQL8ar9PK7YfY/kVdfNV/jV9+CVaEe5PeQu1hSFJI9OF0ZkmXzINUCI1ia0cv7YmAsnIp8iFOGcOzl3dDz1jG8cN8vSfgthD2Xbouv0EUdyZdSb+P333eeFyS0rkDrmszWMrCvCkxcg/GiCMXbcL1/2mzX/3uzdi7vO80yAPwcAb437temEq/BfHFO8W0zPu/6X4P062MAb537qaDlNSNYEr28HldioW671eGv7znrCPHj6OVqZ/tKMbjc634bqS9xv68jldf74W8joUVO4zVDucp7vB73Qjmvt9N4sy08MGmuFS2If6eAx65JAJy9sNQ8DXi/JRQ1gcCVQagypOLMf1odu99/ppo1Tvrg3uL5/lf3DqOoh+Auj01P8BC96+d2osdFM1p+n5Mj/kEg9qsQ8Zc3/rVX4kGkwLE7bFbbzT/HxD6FxvCt98DCiY1X4UHfey0mCQ0sEBxRNl5d7PL95RE46W/ASRlpD7wpD3L06DR5e+xm8nPX9vbVbFaIeZstNNvtz1eP+av41rugcDx/giedeXS8fjrOn0A09vsTbwXNo8MQBCkznsIIHvytiCH19QpSwAHNDju3U6ewCc++YfDorbkHr+7uq8GbC8cfR/ZOhEiweRUljhHKa6N9OO174Ld8d0SEdnlg0TL8eOsGte7+cfPtLzcv3eHoEHA35Z26a93TD5tuu4Z9WR4BB6t/DjGwdX9/xuaP4bH/heQHD/unv6lubn+obrW4U6L+8cfbH+LLeAMvRBiXK/iicP+J0otwQ96qu8rqW3Ur7qRUt/q2vqtMfVu767pubk3434bf5lbfVcLS/gTpT7r/2lvZ3Dm1RvqTI0QleVEBosUhKsRU3rUGERXWIoJKOXzUXWOaWyFiIzwnlLtQm/ZWaN+gPSvSs+ZQ1iOUNXmxBpQdKvLOGopyPXqzJm8aeNOUBmvmB2vdKjTuumhiow23ZOUbtGtDurbcaO0IZ0tebADntjTaZvRmQ95sYUxuicydMOTFlh2slGFsElZSKHHrpEm4UseG8Q3adUvJv+KGK8acIzLWQRaxReYR45cpHwigbmfhl14es4KgvCCQ5Nviy3AL+VU57q3c5Gk3Q0D/whGUkuECPGFd90rDo5Wb1TrcMfFRRzd3be3uOLq5M/CImye3Qk5aVOElLWBVHGFp6RqVcRLCLc1d5aSo9oyVDYMylgB20XVxGHDLYykQBXVnKwMoeImEKMAtRMEAUoBC7RhbG4dCreusa8qaAvhN2wLN4R11W901jQojVa3vRoZOatc/TEpbuSs4KVV7W8OjrbytYa5N7S7I8Eit4iMw2aZ18rN2jcaBrWG2JTxj41uOge+UcYTe+lvZMKicEMC7pioxHd6CcbQOkRawd0AlIKmtBLZx2NraE0DlxuVH2Co/RmA1jdMPkw0zqtx6uwG4eTGAv4Prlsfg7DvWMxLuOGYw8FLjxmUAsAIlUccrJnQOiDhqaW9BWvnX29CwVXjYitiQsYEioBW3VofR2Dq+FSGDsPNXALJwEsC24VYTITcRciPDw42Kz+h4pQ7INyY+bGGAbU5VVHYKkIhNmanhloL5ax3JOLoKDZw3x2sah1A1QFAOB0fZtYoNHG/berKBZ2pYEO0eMBYxD3PSOuq3QJi1o7EGCBOUdlvFhghvtRKZVNy2Kt7SrtFUrlHHhom3bLzSIKXY27YNr4uqCvdEJVJLppby/WVTRrWGAFUAwqcggZtIwSrQqXL6GwWVAalRhSueYB0HIaNJR5Y4YzYyWutwxmlRMGREz0FrFYoS924Fokq1MJ46tYAxG5jVyvpWNgqqwUSL1onrxBlCNlv51osyt84OUxwHNJAbnMUJlOUGBAxZIZLALxUQAayiECjCgQyFSC0kXLcwQqBoAfIXCNfpXyHqdM2ka0AnNUAVTbrbBgQESoUKzSMRIUuJcshhIFXsV+r4rqzTNZNaNrWa1GpjS1Uel2waqTaWoGBBmRcYCO+h2NKOTZGTbJTQNSgcHKwOglh6VgB2UV4GNGAiIeE7IA0svnFAGh2voCxpcTm81HP0DsJOhdWAXv0sw1N+luFFPzK8htpVCWip1IIOLMgcJFx/zaSWTVCadC1iK3QV72oR72oZe9OpD619KzOfqbUi0dIva1u8h9rWgPrSoYFzC42mDuYyyoDG0UbbJgMaB+MWQGhbsrdkZv9LRKMoI/GeZxAneluYkUrHLoDlBUhMJ1xcZ26VsZV1Ru0kiU5DXaYnVe5MVjgeO+zWja52BJCPjFozUmNnqtgZ3tPoHmnQ8aOR1TqNrC6OjNov0vsWRRfB3xt1VprP2hb7okaGRG+kLi+ZWd5XW+yLalBpOV8A7xQ6KK2Xs4hK60U1j0SHxZSJo1lOHEYWx0UVhEQFYcrE0Ra5bxnTmej2CONdowwNKmAVClhTJBt/T72BRhWVOAoljik6SP7eqLPlNKqoWFEoVkyRRv29ZX0VaVRlkQjF+vX+loCutPXRBqAwXFz0sqK7dXGhQG1ZZ6wZdC2c9kHLq5Fe7zh7BjQTul54zbTBPxO2Cq6WsCJdk/E5q+K71ntirlH7x7LBUSmmdKB8ddc2LR1c8skqoPkqNpAWnf7CEShHpNh35WYcdSmklfxQ4JI3LCz8BWvI6WfXl0WnUwGO3ohw76HFZmFRbBvvNlVqiXi3kemaiu+iVvetOrVMaoU+snmgAlahEHW2/FgSqeghto6fcWW0DFZo4xYPrdBgg4I9gtNiG8/Guo32FjivYG+5YUgYBgxSO6NUtFVqCd/KEKXSWRnOk1XRAzTRVkY/1hk14Dej0WzQk3V2cOv9Dg3Gswx2oR9BFaxoCaYVIinCkJzxggssYGQXe9HU0Ya0ydZEq9u3kjXZ6tRKFivSvm8la7JN1mQbLVZZVakVrWKJjodvqdQKfWQzSHWOQp1TFS0jvJd8EMBJYMQHJsR1j95/2ePwZr2j/aaNjoaU4X2Z3AtZ2eCPyKpJ19rYElXJ+VBUkakGdWZRkeE95FlwDhFvFRZfSrSVIbrmV83hIXAxtBuA+xdcKxQrEsOlBiYY46W+VftWhhpVe8qH9kyJOpNmurxMlZVGi18U9YceR+c01T4ao3OiqBH0ODynqT7RGJ6DcOYIcT0Oz2mqIDSG5yDYWsEs07fV+O0s3Kzx7ZINpAsRZyq2dI0vy+Ko8V5gZaBp3YaIkFEhJNhAt8jTSniJAHITowxV4z0iC/YHepZ1ZYJnCQC9PwmQvHwDUMLrO7ir0l0M8QBYgREdBc9hJAcsC+k9PMeMEr1NA+pa1uFdKU16Dj0nJ5AkRDHRtZeyjdfQJ4N+JUSGwzUZ31UqXdOpVaeWib2p1Ad6Z77VRigoU31LxDe0j6xkXq6mEltjDF8XbUG8h5BBb/v4aowOWS39UoBLj5LShnl3utqGadcQ90GhUoObqTCFA8NU8QWJoVntjECp69Qy8TlQJeFak1ptbKHAQCgY53TXsqFS0apRtDqNUqBlG4L7GH+xaTQmoA6U5W9eBuZppwV9Y+MbEuMTCpBDivHX6jRYkRBWcYi1jtMD4e1wLU0AhmJ9q0mt1reywVI5rFEOm2KOSofsiBsRLIkncul5TVsT9HIT4smtE+Y+tOcaPqIH1hRGhJ1tgxE9gIMRPeUjem5e3Cs+SAeThkELCwyDIOEpUVehJY1ILVgDA1RjVGrpdLdO10xq2dRqUquNLTRLTZOzANULGvWCLaosndwhUOEoQaCBIRsNMVsvXjCohCICIs0Ko3Sg19BJguekleGatGD8G7wGLozKkaN6p0a9Y4v2AN7zJvAtTE3rGE9XAUW0exuncry5Cy3PWB4Jg127hg0vStvES21oNFUBv5pqtho1W1OcvHqs2Wqq2WqfeCpqCLyHvGh8kNpJn5hjqRofrG7dQmBoummDTQsiGwORQL/CZ1RlDDq2YLShmQvyRGLEGKwiT2MNromNd5sIRaIF76/V6ZpJLVhtyFVIMNChlQ2Z6uMa9XFTzJfVKhh4wGEYpbUyRBeDj4NGMozcqOCuQajUu2vuBYy8a4gsY8wW7L8KZ6UN4UK8JDHgD/5PiyrMoBTyNyVmUeCSz3UYJFinUWDoTQSPvhzebCIELwdA1rURgje08VICgYa2v1anlkktm1pNaiEPQbKtil0oNLR9S6aWSi2dWnXoV4F54ASzo4fKevRU1aTHWt/KFo6aQjV6nOWsP95L+bk2ps0gwO1Tap7qdBupDlJxntbgmhIxT4dJhdBSqaVTq04tk1o2tZrUakMfCrPseA2sqXEOr86qBDAVCXL6DjxdcBJaN/mSjrZQMUCtihq9PVm0Kvw9mConNTApDFEkzAoDdWDcGq/gM1aHOAU0THzG5+ysTwdbR7zKRydCLlZGcwVsKu9cQkYeCcRBRiXmHs6GQK2FGp0teK0wBHvz2oSwcvSG9SlZ51R716ChIBBRqNaIiShTh8ypVUFY1Krx0qIVOEdOiVvptXktAw6QPkYXUtQxOa19KtWqkEu1jiJ95tc9Y3A+Hf2gXFA+NuSeccyDqtfRHCZO8U4bGigxKkeEKI8qtyxoU+MtGxtNCFpgQgR6wKymNV5m+Xs+uwQAhB8YXNM+JlBjkMW/KlAy+VadWia1bGh5UQ5hHoXWO4S4lLSp1aQWmikQUkHrHa8pkVo+XgG2k/LXstWkBkbdsmlFf+t90oo+EAKjKSQRB749zgFAV0oH316p8Fw2DmqLmIoNQ5nq/2kYylCjxPgUUrlmSURMQf5jcEaYgYwhgsSCRRXlRx3lR+1zeQZdO/+0bJP8wqn0LZtaKCKQnNrYwoRa22SCwFADyWC4uJzLxXvI+BDg8rYpWAXJU0YLSTTJZcYokApGgURnwjMYuLg+aAautk8iokPtXVJ4Dp1JjUH+Or6B7IdutK9VwFadWia1bHJJk5uKRNi0fh6C059cVxVdV9dSqaXDu0rX6ZpJb9h0t0l3o3us6ipeq0VqyXQ39VHrkstsqAVnFBtHMuOAiqFWhNFsvN7fEsmzCO7E2PvwcXd0MNDBAQsYw+7+kkw+R7Ttve73Gf8AP0OSWgEGg8p10enw92KCyFNSGzMADaBfQY4EnDBYstgyoepP1aEQ7lbVxRStyYoPDR++MmY821SJG8uGr8y4hNBQJWwaNl7gb/1/HS8wVEcZr6OKEUozjo4aqhksiv+6FKG0UTMon3uCMoYQ+gfBj86MdtxbV1hEYcDiAJkT5JcxKL/8Le+JOAb3doWTWNaEhxsfZYJwBEg/66MQlaNMDPIbrJ7BEB8UKQiLCqANy4N3pK8ak1jqEJ7D8ixoefXZwiKhBQN9yybC836GSKYBdAuzEe5CTdydAg7FSEcNbIAaEGKeCovUfEunVp1aJrVsajWp1cYWEpdvidSSsTeb+rA6XavRq4VrqQ+b+rCpDxv6oARgqca1gmdTOw4DWKrlLAhY0KpuUUBdNhXoO5sR0jjUbalgtug+l2MRNpWiSjUwyxUGuNpUp+l1e9NKnB+NOSiFcRCdZ7MtFexWT8zAOFRuqcS1KFXLgRC8J5K08cXHg3isR9kOwrHe5a+LYgjzCCEKW4W7GL1AQeOtEt+Kzykf7XKUqBqdWnVqmdQKYi0bKRXoFt2/cm22jUlCrbE83ldNylhr6W0dqFPGdK+WIQgkWi89WosZdbCHVEgAQx0letm1CnEPmwrKwEHxQhlCAhjugLpLkWo7fY4PK1QFSh5gfxHrPH12AAOQOJEKJlHF2lEvEuBdH3pA/EWE59UwZN9UY+O1JhagqpClc3fR8PWtWCmqWplaKrV0akX8VGvSNZuuNelaG1q6CsWo2bJllfgWIxxl3op5Sat0XKSwRsovUe34S6NEcTaDX6JGhyXyxbhghstQVus4z5NSE1P0VRVzuZi/8YsGhmx6IawG6k80CjG3giPTMb6lMLqpAho+KAUtv0It6FjZhnfDusBdvy5QXl3hzEOdn4oNHRt1bJjYsLHRxEYbGqKKDRFBiwhaRNAigvYUhw9F2CLCFh52tnTUjrGg6cGMKTDceDeEpXaBBUWvRcmCsm0QqeDyoHwCnw95Adw3DORAAwVVI2IkxpGvztzBGg36yoRKkRrIx2eS0EKoSi6fpRZIA/oIzHw3VZZK3yaGyaHqEZGpdagsh2VD30A7jVj7itKADmhjlKy29mrd4aABGyiosVWGTUPVYYNOJniI5q4WGToiaiIb40LW18g4IwFKSRQWloDqxcw8KjQJRX9O1mS9UjXagDrUsAlltFZ4y2c49a2JJXICo41W+1yaxsSlxr0rrpV1RVVto7CroofQRFXrw63oFnhqQNV8S7P+nhac/MN1cBSOVNE67vFUAcYOuqEYKK1lSPl7qhil/BuqlBvNU4UuGgQxTofYQMIXU1JgTQuMlmB4T5pSDK+hKr3BUGp5S04zrNpZxDqBY2K8BBMWbdy9ANJf6hAi0dgCaakxG+15qC3xUENVc4O+liqGHRszYCL0ROtWDbgJwiZWiAHLoMtnvfyC0g2LWISWqopcRHVOY3l6tqXVA3rDSKwnbNgV6Am7wt51bClRXL9sCxkIQq1K7l+TNgNov3uiibYIpMX9ItWoxBR6CoOCpFh6jqWaeUESVLSEVojBtCgEnEisRPAt4F3li38gQKxTKxUuqTZe00qmVixD0kqnVp1aJrVsajWpFQvntQ4bALKJ8yoDd5S+dIdTt/7e7yz94Yebm9tfbn4KG03dfIT9rL/8etlR+u0vN8L4S6L1v7Lyv0qH33BfWf9bN/7XSP9rw/M2PGfDcw0+9+tgzyr8C7hXQ7wguFVGLEeEdlwCLAhgdsRXAJQEojTcHLYcBArAGe5vRUkTiEAeZYj89Ifzly9AoLIqArnRVXjvAosFco9H1A2wuQzvRujlcC7H3V1gqcum8F9uarsMWDqMaTi4y6LdqEDjRi2Dh4c/D2E1g4kSi2CsyKBYJlSUyXQdfuP/gS7qwHS1yeiFXe3V/X13JDMC1ZjTVOhZnoHWH9ab3eP2C5kYp0nLIDWP2MS58API1YCm1DIywE8aURnDzbsUE+j5b30MwQxwkQuXfw2z9Q1+O8Q16KRx6zA5aeHMUQLJWRllSHWgKzM1TkIdYNuVYdnAPI1iYT08uEXMhim4ueeJDI6AJiAEJ+Wi0kr8wgPd0inTnCzXkbUqHlRPh6hYKTwx71s3yN3qtHmh9G41hxerY1Y7KqQ4XlTNUFOXIRG+MbM2Qy6uTCauOFshPN/UPCaP5+2KUIHmiDwKTxHElwjQI5a5BRPnYYRtLlwziydhr+goEmNUQwZxv3o4Svcb4DaWH/XmeXXqqNExTftlMP3pqTv4E5ySkKVEwnG5mkCOynzFUurEqn45PWXyAWqHpoRXEc5+Q0UMN0dK8yCouWE56rK8HNjvi5MLMf1XwOoo80FsmFn4SK88Aez38aC/IVrcLE2idehX909DOC23XlEaCMIvRbAHglnLkniA6JWt+w2cNkEZh8OKkCl4u4yFzItBakFaTgzWVSY4AsMbPTsBx+PmkRqqEKFklodnyROlGNY/4Q2K08ktb2YusTpI8fN+PvVUbHHGzYTYcjCc+NvcO11N1lCxrlwSwcT5LAL/nBEdBCIYwmCBfFrd/0wRW6iSqErhQDsUyUIo1qzmKQvO7qMoXuj/xka3cgiKXVMARfCpWfqKGndieMcuHoM5RE4MkFvmlF0g3Q1OMhzqE46PeKnhYG7uqa3BsQBPYZ+o3mYh5IGWJD149LqOmngs3fGq91P30B8yDKfDGWMvlPcyPfRvRpa75CaBFQKfuqfVy6YnUKCEiLGv2TjJp+70OZu2lou+TJBt96WnalmzQnaCMty7mdVjuREJVit96s8UFclKsAkyOG+2lAU1t0TRaDcTwCgow03whLiiNiU7LbxLfJ95dpr1f/gFAhi5bOfCksEUiY61/7maYaBHKlyh+H9q7FMC4p66gIKdgsjZNcs395malKwTOLEk3Xb71G0en6h5Ill3kpUG/tPPNCA0FU64OH08C3iY//lf/uPGufEQxcT/v/5P+E0cEjJnHU6WRy+fqh6GjQZRQznWwDycjD44vTaxEAiGRv9YWSoDv0+B6zIesRyX6FlL3X/qiQ6RNRqnVvPyxaghYgPDIkVO5uZ8s6Xml+LkWR3jyGx453Iw6lBeD0LRyfsYjXIqikW+qzHEdADZLItM4gGl1D+cFt+3E6YifAqBjrXmgC2QjQDsTN1z1ourJ8EcChkBNUDtotzmJsvByqBwdgCvL+/77fmZSmrJ2iS8TOyfnUGxgnERi4KFRHIFDMS9g/dps91QNlKGNYNZjQ7Att0pc0JYnTwxWQDnH9T2ut4qL0Zo2JzjXCgxD3GocD+FGPNQYoDHhRSTIKmGAoVPqo5CjeH5Uchxcq1xPn6XpcnY1ORs1DiB/OMfvnmm9KPY2N48ghS/is3mxhi0oVM6RaG7hw2xxiG3fm0a1UM5H0aMKARLXVEpZmHxJv5OUPHuSCmYTSVOYnz5JMNQ6w4iBDratZHwIkHqZXLy8nWtoagcpIXz2GWJ+Wbjm6GbPJLcsuJhgnYRUpYg5Qw/FWdHT8HLhI1gA+UxApD0PkcfhLsnuv3j+rAiU9KwQYiwvnKKS06HfktnRk0XazBwnGG96Xb31I5vWI3Og8KvQdJYpWSN9JaK6FGQdrqbjKlZc2ZWQzDlM0lMFZNHRbTOh0NOWmwaZ8J8OB9P/TO11dhMTkQ60n3UBaygWq9OK2rzsh59nam8Yih3oOJYubamtobgnIiaZZ9197A607iIZIt9IuITk9A9OBmYZXPYlZoBQ61OzQ2Oj4QhmE1O0IoVDbxJdoGUlQywRUgk81kGCbYi9QLZaD8ftVh3+0N3nwsHxVa68MYB+T7O0PQcRqqX1aEMQH39mYao2BqLCWLAz4RlU1WzMYFZL2vdwXfScieCNV0mVvDUjU0KNmjEE9fmAPhk5RBs0n95qC0BzixelmrncKTJKcGGiWI51QSxbY6rTzRLy8bIZmBkMad6QK5yWWIlAKJiq2YVPqunHJz9dpVRqlCcOOUth/Xmhdgy07Q5ZcuseypgOFzmUzHrvjvufkeVcMuBi7p/ChzRxCykaFVEA5SPEOUWIJuGCpBkIFIZ+ElOQs6pTA2obJmHAFCOp9XhlIMaRLDksqCMB9Xvc0jDcOs4ylaG1O+pbLg2bQUQ9hnJGzbSykt5D+Y+Kzu9DCjmDhdqoPMhr8Zjbb1ICIrnoi/uRZonZaFdHTiZCYwsN5MDlnkNgWBrJCMqvEPQ3dFoAetzNDyIrIgGjmy6NkvdrY5ZkJu1dHk8tpQaLpQVFyR3cacprIufZx86JdMSZ96JDkAzvh5EKZYptOGHYoe8PUwNRGdwGT91z5vjMTeZrs8SOTCn3I9l61FT7VPQTXJScEfR4H4DJ8WaKRW3U8QEJmtMj7IpbPSWat7biRrVbpcbOqyqmwaREYUZ2jnRBJxZxN3YzDGsmRNmkfc+PTgaJmFL5PjK+u5EBCtbWBQWL5AtCy3PZbaDaQprFQRrkMvjbR9TBPwyZs9BjG/ZMgAMMm1siGU85pRxn5B0/9j3h6wu8/psRvePU7fLthOwIQ2RRftpxfxUubPr5rC6z0p0OZpULC2GLweSWCYLhYjhqfj+w+ZAg8+SDQPOZzAfstKeV6x5ihPnNsaMbRGRS2WbeXJmaVJGDWdsQXKmGMbl6sKnZM3DgfoLgq24SVI/S0ylSnzWBH3sdt2B7i9hjTweRlaYOrd/I+31izZCmKJU+sIyqOvq8hHWIfcMBJJaphge+y6ryGUT4vzsZXvrBrH/SzF6KefB2Mn5BLHWQK7to6NI6jAmaF1Q+ohSgY/cxQ2A8L3TghU4iK6EQc7P/2ArIAMVjrW8WKzLnLvwSdg8ainkdJEUB4oAYfPjcT0T70den6Qc/Jo8IcGBV1yPveJLnjojH5afSERisLWFdTouX70vZtIHRvmyjaMXeIUdCkPX3Syr2knw/viHb4pTCOcvXav1E6DimAd+/cVGGuW2p+J+Y/h3S7dDsns35wlrSWdf//D8ZWrfEFuBwVu2qX/gbcrMbH3V/GCioBihaIcsMxb8iVUWrA70Qdi9GdCnWOYyJmAlch/ISFswwBeguOuz7BcbsKXJ5EmgRWk5V87OG7cJ7rhwTbM7Oy0vhLOMGMfefEbs8egzybtHpthkEGq+JJ1m1vl4XL10l/25u8fN7iELOw+Wu16oEo/n/XoCUzWMiqT85jRMEocSbCx8+ZEET6vdeptlyzgq5C0nD4UaTy0LhpU2HgydJLaslK9CQjBZ7JQ1tnlH+WmV1U9w5J4rbD4H9bTKUmRsJdAEjC7bCsIyEZ9TARh/+CbP0bBRHX6K+v7ncSxA2mFocplp8dR/doCoe8nqKz7MCqYnUSis85JFvyaoibFm53Y01+ysbWhMk7Vxcvuf57+Ne2e9cbImO9qBVdLLM7AbqOSEK6OyGs3aM1OIjgI77B4FXoN6KFkBNCtueDA0FjznDoisoGbeVNzs7rfnTMez4UVeLHowecEcex4NXwPiXt28bNZnGiFgt8jOFx+Dmjw8jyhDsrKf51woTqHVA+x+gomJcgqcDk6xsXm6RWrKWw5gN/8cDdRMi8xLCGCCI3b7bCdWNdxpMI7HXsTB1cVW2BcNk7C7EaegOIMwqwgULBEl73Ve0iDc0yavBJJsxTevJC+w8gJfts6Ud4IAmLMOaVRsbiP9lFQ4dY/j0mNWjedhpjwMlEKaiyPWgMHhYUWXkI0Lvz4yjv3sxtlc9vyK2WxuhEiIuGUF2ATXvfSjDUzTZ2IsIuHM75qu8BxEALO8X5yI0dksMRqeWQYp2k1UUl6XWcZ4lDEUapiXW2a+BTA//st/pEjg8W7rXJ8T9VjYkjDeVqVqQbBbZeat7zyGIdkyytEWkDziyvpT0Ec52qbk0DFdViUD0Iq7oLhpnEaMAGELELhwdkoUx8mYNQ9+3vWfqWHAnq7CJwm2Th8cs23P03GSMpQvPdWz8EU9hhZnN1Nuu8fVPd0twypAXhFsNw/d/Zf7LLU+tyz8dG83dJ6auaNZUnKNB9mvsgSqHER94EDDkXnCm5/b/jE/qeH6/fhwflfmJ7JWGD/1z6sN7h2h8VG2+IUVn8+rn7MCdpbANQ9jt3oc+ZfsjuF5Onhe0f2XbPUUrxYciH3mcLD2uMhStvzaOaiZ9cnZPLz1+dw9f+rodk745t217sZzd3rqM/3P+uFF/b/k4BrfCzUK2L0z/HlXz5vdORsxS2b8iMcxbFbWTDDOeXva7CkcdtMGT17ZTkPWXczsmZSd58ljOgPCnjXGLiE8nhEtZ4HwWI3PChQsf8+X2O26vKblencbYGRxczahM1tYvXMKmqKkWWN6eVJ1132mCLL7UckJhQyoPNkih+mgZWmCrBqXdZ15W3b3iKfshB1/45DHIEGux8nJMkSg9JJjP7A2E2EuI9bHrM5HspYSH4rZPbJpLj2ISl4yWnPDnEpw6cGWlYs7uhhiKbU13DFU2O7Ki/zdY0nQXn9A4e6x34V9Q2QtBjnCsUM6N+R+N6K5oVeiF04dPS2O3X8dHYaJQeZMyckgNqEIEH6XEQOnG/ktuAAlqwIdENR4+cnhoyzAvNx1UB+xcJ4P3TE/IY2t2ud9n11Py0nZzMWsO+Ag0fVio2kTyqL/TJUXu2MwKkLWoeg//Z+OFl4qNrbE27o9Scewso6ek8dXKEb3OOXs+Y7pLmU2isWPP9+XzbJi2rDLEkm/y3JHbLpTzwaV+n3n45vZ6UVswaMOU8kKilJVQzXU4HlgphBsy4M582ekhV5jVKuABGvM8znTAdBfyAkpik0p8q5en521PX1K1/iQs2g6lQOHxR796cTZQZWaW9oJgjtTI4M1Ynnvuz+fcrtHshlfPsLUv3QHt7zZqTesbzTr9eVBLzZXwI9sv8qPC1DsltfkJLEIOXaEPB2dqJp1d2fD3A7eceNM/kz8aHafKG9s7jdZkRwrBheg1e/P29E+crasgafxfX8c77lnZWtefjsB99A9ZKfjs1TP5y48lEO+XZ5VfCzdO0Avm/58HFlhA2taLNsQsj/0j4fVc/EEYMGWYs8fFuPgOmI7bTLrjC2ZoEmAiTJ/tvw99JidQ816szwxHnrYW58FT9lUFW8vOUAvmXASLJgJieLBZGcUX180EeDQSurpPWZFMOdPWxoMFmwUb2JQ54Pj1Sw+w9ZxsFPsjJWnLKbMbr3m47iHLBLMhismIKzW1AhjP37Ce96Hzj+WrTVbkpGneaL9ypNAtilTDCtrRyncabmBoizXI6zlmZ/wlo4Hyk5oo5t/yv0+ggLLLBC2nJKVxfhtGFpxIti0y3x6G8Hl2xvZTd+s1Axgcv9zuOF/WYH+AY5mOXZ54SrrYfOG6tiT5T91EhZ38Z5XDzsf7fDTUUuJEeCUDjgY1KgFfBYDGx1xYIbcsizweAA4hYoR1rDkTcFDdzofMsNmOpm8ZJfh4ZwdIMqe/DIFIj8TTrC70fldPg7MafNMCY2NMPCfVoB68G/8tFPRxAZ9eVkDsDIrYPqrKYO6DXYdS/vmBqcDXzIlUdkUIhmpbjl3/uL+p+I3caawoVuC5yIpvF5Pu1r6fBONHtqmOZxpLooHOuWb2RUrsHmCT7BGbgJb0W1my/PKn0QYhiLteKTpTLx5ZPMUDWcR8Maxg/SyyWJONVunOeuwHbOtpuw5pnQnJQMKPl5G9RT7bZqpuTrR04s1i1Squ+SBPfXnbXaUEhsD44f2RCOmgiWx+aMcjljOTZUIW7jCC59NHnhkP8/A+zVH+BJhVoHIekc8CeXswsZv593z488bepIQGwPiD7M70twIS4Exehwr+SYoct/dbx4yX4mNlQWJmJ8PkLvDs/u+oHx2DR/LyxJZ10cZ0J7q1qPtJoJ11CZYAWBlQWWWGaJ24KXZKfteG2vX8vzk7LsMH7aqLOYLeNoBa4NKMLa+fHaTyfE0Oj6KZVJ60AAPjap31jibICo4wficmVRsJcQETWXfdmW/ixALZ+dPaXYgQ4w/yyYOvKYRlBmD47zvDncTJ0lev9HOgYStL3n9x/X1TwFQNlZ2MwC/pPlqsikIPuxx/LIj0o1NKvIx0VNWhyfZmkA+uXnqnG7MJAKbTqS50qloSQSbJa+mk7BFQE/0Mw2KtUz4qXYwsnJqthoti6Qmay6olLhtZnkx3Okpc6UWRnmS8Zd9SDA/HyF9GjRLxLLHaDAfRc9HWC6mnxnphob52ehbFL28V+CAZTvv2dPnJpad7kxg477ps6v53GY1nmxhfEXnkv3A/CSqd/F8En/iAfwHxx74Op2vadZUsEeL8vWU2Mf+0MPXte/9pyrg7OuvP99hIdXd4BoV2NdveMSuSs6JZg+V5k1BBHbanDKzmS0GnYH0stqeM0jTSc8ipCzaIlm+5jdmFIbEOl3z/NLTaV4qZbLyjnzXQ5Q+I86IhnzkjOKXAS9H14+kT3aIz4hT+IEe8tNS2HjZhGQ4nLOo7OyepYzFJxDMD0Dhz7NtlsCi5uegbs3G164KMiHI+8Nmn33pbO4LIPnKxwKgWZk3NbjCh1NZE4G36s7u1cP2y+gr7tPnRJQhMXv7h1/9rJeFwiEkm33And2Xzq4WjcpI9gtO81EnfyoHtRbZHaYzUPIv0w+PF9JjquQB0SgRq2hSLRO/cLQyh82UJ00f5RI5CGFAxaxqO+dfmGW7YkTr6OsexbP7yl1nJC7ZQMsEsziqPN75XFncV/rQH47ZGR2KVdQ86IJmZaNsswoNgWXn5rBB5lmh/LLJyurZiCSvr2k4kt1FufwUmmB4/Rfe8ro+SPl5lVfXs/t7WaHzOTvAi3WWolIn36kpQ/xdRl5sAIuvS/zcUbGj2EOt6VfNi7Cesg/tsqInO56OPc1w6ZnGJK9b2PPclOZ0cKo4Pz1PXV7PIVirlA82fn7aZOd+s6l4imsR2GiPwfC8vNK3vVOWTk/PazlPPuC6aFjmucXcPInZvvxkU1aU+DGtqAnKbkXiKRDBjA6YG57jldZ6WpV6SLRAd+7LiiNyZmO9nze5smcl58SU0Q3x7J7DeFxu8Zii3FvgetpkqUm2pokf82G131NWYveyzG9MpeXOrL3A64ns4y1sBclixfMlq0JWbK1iSs1XkzP/4y2WtG43Owfihx9//fX/AmKjgfQ="; \ No newline at end of file diff --git a/angular/docs/html/assets/style.css b/angular/docs/html/assets/style.css new file mode 100644 index 000000000..5ba5a2a90 --- /dev/null +++ b/angular/docs/html/assets/style.css @@ -0,0 +1,1633 @@ +@layer typedoc { + :root { + --dim-toolbar-contents-height: 2.5rem; + --dim-toolbar-border-bottom-width: 1px; + --dim-header-height: calc( + var(--dim-toolbar-border-bottom-width) + + var(--dim-toolbar-contents-height) + ); + + /* 0rem For mobile; unit is required for calculation in `calc` */ + --dim-container-main-margin-y: 0rem; + + --dim-footer-height: 3.5rem; + + --modal-animation-duration: 0.2s; + } + + :root { + /* Light */ + --light-color-background: #f2f4f8; + --light-color-background-secondary: #eff0f1; + /* Not to be confused with [:active](https://developer.mozilla.org/en-US/docs/Web/CSS/:active) */ + --light-color-background-active: #d6d8da; + --light-color-background-warning: #e6e600; + --light-color-warning-text: #222; + --light-color-accent: #c5c7c9; + --light-color-active-menu-item: var(--light-color-background-active); + --light-color-text: #222; + --light-color-contrast-text: #000; + --light-color-text-aside: #5e5e5e; + + --light-color-icon-background: var(--light-color-background); + --light-color-icon-text: var(--light-color-text); + + --light-color-comment-tag-text: var(--light-color-text); + --light-color-comment-tag: var(--light-color-background); + + --light-color-link: #1f70c2; + --light-color-focus-outline: #3584e4; + + --light-color-ts-keyword: #056bd6; + --light-color-ts-project: #b111c9; + --light-color-ts-module: var(--light-color-ts-project); + --light-color-ts-namespace: var(--light-color-ts-project); + --light-color-ts-enum: #7e6f15; + --light-color-ts-enum-member: var(--light-color-ts-enum); + --light-color-ts-variable: #4760ec; + --light-color-ts-function: #572be7; + --light-color-ts-class: #1f70c2; + --light-color-ts-interface: #108024; + --light-color-ts-constructor: var(--light-color-ts-class); + --light-color-ts-property: #9f5f30; + --light-color-ts-method: #be3989; + --light-color-ts-reference: #ff4d82; + --light-color-ts-call-signature: var(--light-color-ts-method); + --light-color-ts-index-signature: var(--light-color-ts-property); + --light-color-ts-constructor-signature: var( + --light-color-ts-constructor + ); + --light-color-ts-parameter: var(--light-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --light-color-ts-type-parameter: #a55c0e; + --light-color-ts-accessor: #c73c3c; + --light-color-ts-get-signature: var(--light-color-ts-accessor); + --light-color-ts-set-signature: var(--light-color-ts-accessor); + --light-color-ts-type-alias: #d51270; + /* reference not included as links will be colored with the kind that it points to */ + --light-color-document: #000000; + + --light-color-alert-note: #0969d9; + --light-color-alert-tip: #1a7f37; + --light-color-alert-important: #8250df; + --light-color-alert-warning: #9a6700; + --light-color-alert-caution: #cf222e; + + --light-external-icon: url("data:image/svg+xml;utf8,"); + --light-color-scheme: light; + } + + :root { + /* Dark */ + --dark-color-background: #2b2e33; + --dark-color-background-secondary: #1e2024; + /* Not to be confused with [:active](https://developer.mozilla.org/en-US/docs/Web/CSS/:active) */ + --dark-color-background-active: #5d5d6a; + --dark-color-background-warning: #bebe00; + --dark-color-warning-text: #222; + --dark-color-accent: #9096a2; + --dark-color-active-menu-item: var(--dark-color-background-active); + --dark-color-text: #f5f5f5; + --dark-color-contrast-text: #ffffff; + --dark-color-text-aside: #dddddd; + + --dark-color-icon-background: var(--dark-color-background-secondary); + --dark-color-icon-text: var(--dark-color-text); + + --dark-color-comment-tag-text: var(--dark-color-text); + --dark-color-comment-tag: var(--dark-color-background); + + --dark-color-link: #00aff4; + --dark-color-focus-outline: #4c97f2; + + --dark-color-ts-keyword: #3399ff; + --dark-color-ts-project: #e358ff; + --dark-color-ts-module: var(--dark-color-ts-project); + --dark-color-ts-namespace: var(--dark-color-ts-project); + --dark-color-ts-enum: #f4d93e; + --dark-color-ts-enum-member: var(--dark-color-ts-enum); + --dark-color-ts-variable: #798dff; + --dark-color-ts-function: #a280ff; + --dark-color-ts-class: #8ac4ff; + --dark-color-ts-interface: #6cff87; + --dark-color-ts-constructor: var(--dark-color-ts-class); + --dark-color-ts-property: #ff984d; + --dark-color-ts-method: #ff4db8; + --dark-color-ts-reference: #ff4d82; + --dark-color-ts-call-signature: var(--dark-color-ts-method); + --dark-color-ts-index-signature: var(--dark-color-ts-property); + --dark-color-ts-constructor-signature: var(--dark-color-ts-constructor); + --dark-color-ts-parameter: var(--dark-color-ts-variable); + /* type literal not included as links will never be generated to it */ + --dark-color-ts-type-parameter: #e07d13; + --dark-color-ts-accessor: #ff6060; + --dark-color-ts-get-signature: var(--dark-color-ts-accessor); + --dark-color-ts-set-signature: var(--dark-color-ts-accessor); + --dark-color-ts-type-alias: #ff6492; + /* reference not included as links will be colored with the kind that it points to */ + --dark-color-document: #ffffff; + + --dark-color-alert-note: #0969d9; + --dark-color-alert-tip: #1a7f37; + --dark-color-alert-important: #8250df; + --dark-color-alert-warning: #9a6700; + --dark-color-alert-caution: #cf222e; + + --dark-external-icon: url("data:image/svg+xml;utf8,"); + --dark-color-scheme: dark; + } + + @media (prefers-color-scheme: light) { + :root { + --color-background: var(--light-color-background); + --color-background-secondary: var( + --light-color-background-secondary + ); + --color-background-active: var(--light-color-background-active); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-contrast-text: var(--light-color-contrast-text); + --color-text-aside: var(--light-color-text-aside); + + --color-icon-background: var(--light-color-icon-background); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-alert-note: var(--light-color-alert-note); + --color-alert-tip: var(--light-color-alert-tip); + --color-alert-important: var(--light-color-alert-important); + --color-alert-warning: var(--light-color-alert-warning); + --color-alert-caution: var(--light-color-alert-caution); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } + } + + @media (prefers-color-scheme: dark) { + :root { + --color-background: var(--dark-color-background); + --color-background-secondary: var( + --dark-color-background-secondary + ); + --color-background-active: var(--dark-color-background-active); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-contrast-text: var(--dark-color-contrast-text); + --color-text-aside: var(--dark-color-text-aside); + + --color-icon-background: var(--dark-color-icon-background); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-alert-note: var(--dark-color-alert-note); + --color-alert-tip: var(--dark-color-alert-tip); + --color-alert-important: var(--dark-color-alert-important); + --color-alert-warning: var(--dark-color-alert-warning); + --color-alert-caution: var(--dark-color-alert-caution); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } + } + + :root[data-theme="light"] { + --color-background: var(--light-color-background); + --color-background-secondary: var(--light-color-background-secondary); + --color-background-active: var(--light-color-background-active); + --color-background-warning: var(--light-color-background-warning); + --color-warning-text: var(--light-color-warning-text); + --color-icon-background: var(--light-color-icon-background); + --color-accent: var(--light-color-accent); + --color-active-menu-item: var(--light-color-active-menu-item); + --color-text: var(--light-color-text); + --color-contrast-text: var(--light-color-contrast-text); + --color-text-aside: var(--light-color-text-aside); + --color-icon-text: var(--light-color-icon-text); + + --color-comment-tag-text: var(--light-color-text); + --color-comment-tag: var(--light-color-background); + + --color-link: var(--light-color-link); + --color-focus-outline: var(--light-color-focus-outline); + + --color-ts-keyword: var(--light-color-ts-keyword); + --color-ts-project: var(--light-color-ts-project); + --color-ts-module: var(--light-color-ts-module); + --color-ts-namespace: var(--light-color-ts-namespace); + --color-ts-enum: var(--light-color-ts-enum); + --color-ts-enum-member: var(--light-color-ts-enum-member); + --color-ts-variable: var(--light-color-ts-variable); + --color-ts-function: var(--light-color-ts-function); + --color-ts-class: var(--light-color-ts-class); + --color-ts-interface: var(--light-color-ts-interface); + --color-ts-constructor: var(--light-color-ts-constructor); + --color-ts-property: var(--light-color-ts-property); + --color-ts-method: var(--light-color-ts-method); + --color-ts-reference: var(--light-color-ts-reference); + --color-ts-call-signature: var(--light-color-ts-call-signature); + --color-ts-index-signature: var(--light-color-ts-index-signature); + --color-ts-constructor-signature: var( + --light-color-ts-constructor-signature + ); + --color-ts-parameter: var(--light-color-ts-parameter); + --color-ts-type-parameter: var(--light-color-ts-type-parameter); + --color-ts-accessor: var(--light-color-ts-accessor); + --color-ts-get-signature: var(--light-color-ts-get-signature); + --color-ts-set-signature: var(--light-color-ts-set-signature); + --color-ts-type-alias: var(--light-color-ts-type-alias); + --color-document: var(--light-color-document); + + --color-note: var(--light-color-note); + --color-tip: var(--light-color-tip); + --color-important: var(--light-color-important); + --color-warning: var(--light-color-warning); + --color-caution: var(--light-color-caution); + + --external-icon: var(--light-external-icon); + --color-scheme: var(--light-color-scheme); + } + + :root[data-theme="dark"] { + --color-background: var(--dark-color-background); + --color-background-secondary: var(--dark-color-background-secondary); + --color-background-active: var(--dark-color-background-active); + --color-background-warning: var(--dark-color-background-warning); + --color-warning-text: var(--dark-color-warning-text); + --color-icon-background: var(--dark-color-icon-background); + --color-accent: var(--dark-color-accent); + --color-active-menu-item: var(--dark-color-active-menu-item); + --color-text: var(--dark-color-text); + --color-contrast-text: var(--dark-color-contrast-text); + --color-text-aside: var(--dark-color-text-aside); + --color-icon-text: var(--dark-color-icon-text); + + --color-comment-tag-text: var(--dark-color-text); + --color-comment-tag: var(--dark-color-background); + + --color-link: var(--dark-color-link); + --color-focus-outline: var(--dark-color-focus-outline); + + --color-ts-keyword: var(--dark-color-ts-keyword); + --color-ts-project: var(--dark-color-ts-project); + --color-ts-module: var(--dark-color-ts-module); + --color-ts-namespace: var(--dark-color-ts-namespace); + --color-ts-enum: var(--dark-color-ts-enum); + --color-ts-enum-member: var(--dark-color-ts-enum-member); + --color-ts-variable: var(--dark-color-ts-variable); + --color-ts-function: var(--dark-color-ts-function); + --color-ts-class: var(--dark-color-ts-class); + --color-ts-interface: var(--dark-color-ts-interface); + --color-ts-constructor: var(--dark-color-ts-constructor); + --color-ts-property: var(--dark-color-ts-property); + --color-ts-method: var(--dark-color-ts-method); + --color-ts-reference: var(--dark-color-ts-reference); + --color-ts-call-signature: var(--dark-color-ts-call-signature); + --color-ts-index-signature: var(--dark-color-ts-index-signature); + --color-ts-constructor-signature: var( + --dark-color-ts-constructor-signature + ); + --color-ts-parameter: var(--dark-color-ts-parameter); + --color-ts-type-parameter: var(--dark-color-ts-type-parameter); + --color-ts-accessor: var(--dark-color-ts-accessor); + --color-ts-get-signature: var(--dark-color-ts-get-signature); + --color-ts-set-signature: var(--dark-color-ts-set-signature); + --color-ts-type-alias: var(--dark-color-ts-type-alias); + --color-document: var(--dark-color-document); + + --color-note: var(--dark-color-note); + --color-tip: var(--dark-color-tip); + --color-important: var(--dark-color-important); + --color-warning: var(--dark-color-warning); + --color-caution: var(--dark-color-caution); + + --external-icon: var(--dark-external-icon); + --color-scheme: var(--dark-color-scheme); + } + + html { + color-scheme: var(--color-scheme); + @media (prefers-reduced-motion: no-preference) { + scroll-behavior: smooth; + } + } + + *:focus-visible, + .tsd-accordion-summary:focus-visible svg { + outline: 2px solid var(--color-focus-outline); + } + + .always-visible, + .always-visible .tsd-signatures { + display: inherit !important; + } + + h1, + h2, + h3, + h4, + h5, + h6 { + line-height: 1.2; + } + + h1 { + font-size: 1.875rem; + margin: 0.67rem 0; + } + + h2 { + font-size: 1.5rem; + margin: 0.83rem 0; + } + + h3 { + font-size: 1.25rem; + margin: 1rem 0; + } + + h4 { + font-size: 1.05rem; + margin: 1.33rem 0; + } + + h5 { + font-size: 1rem; + margin: 1.5rem 0; + } + + h6 { + font-size: 0.875rem; + margin: 2.33rem 0; + } + + dl, + menu, + ol, + ul { + margin: 1em 0; + } + + dd { + margin: 0 0 0 34px; + } + + .container { + max-width: 1700px; + padding: 0 2rem; + } + + /* Footer */ + footer { + border-top: 1px solid var(--color-accent); + padding-top: 1rem; + padding-bottom: 1rem; + max-height: var(--dim-footer-height); + } + footer > p { + margin: 0 1em; + } + + .container-main { + margin: var(--dim-container-main-margin-y) auto; + /* toolbar, footer, margin */ + min-height: calc( + 100svh - var(--dim-header-height) - var(--dim-footer-height) - + 2 * var(--dim-container-main-margin-y) + ); + } + + @keyframes fade-in { + from { + opacity: 0; + } + to { + opacity: 1; + } + } + @keyframes fade-out { + from { + opacity: 1; + visibility: visible; + } + to { + opacity: 0; + } + } + @keyframes pop-in-from-right { + from { + transform: translate(100%, 0); + } + to { + transform: translate(0, 0); + } + } + @keyframes pop-out-to-right { + from { + transform: translate(0, 0); + visibility: visible; + } + to { + transform: translate(100%, 0); + } + } + body { + background: var(--color-background); + font-family: + -apple-system, BlinkMacSystemFont, "Segoe UI", "Noto Sans", + Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji"; + font-size: 16px; + color: var(--color-text); + margin: 0; + } + + a { + color: var(--color-link); + text-decoration: none; + } + a:hover { + text-decoration: underline; + } + a.external[target="_blank"] { + background-image: var(--external-icon); + background-position: top 3px right; + background-repeat: no-repeat; + padding-right: 13px; + } + a.tsd-anchor-link { + color: var(--color-text); + } + :target { + scroll-margin-block: calc(var(--dim-header-height) + 0.5rem); + } + + code, + pre { + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + padding: 0.2em; + margin: 0; + font-size: 0.875rem; + border-radius: 0.8em; + } + + pre { + position: relative; + white-space: pre-wrap; + word-wrap: break-word; + padding: 10px; + border: 1px solid var(--color-accent); + margin-bottom: 8px; + } + pre code { + padding: 0; + font-size: 100%; + } + pre > button { + position: absolute; + top: 10px; + right: 10px; + opacity: 0; + transition: opacity 0.1s; + box-sizing: border-box; + } + pre:hover > button, + pre > button.visible, + pre > button:focus-visible { + opacity: 1; + } + + blockquote { + margin: 1em 0; + padding-left: 1em; + border-left: 4px solid gray; + } + + img { + max-width: 100%; + } + + * { + scrollbar-width: thin; + scrollbar-color: var(--color-accent) var(--color-icon-background); + } + + *::-webkit-scrollbar { + width: 0.75rem; + } + + *::-webkit-scrollbar-track { + background: var(--color-icon-background); + } + + *::-webkit-scrollbar-thumb { + background-color: var(--color-accent); + border-radius: 999rem; + border: 0.25rem solid var(--color-icon-background); + } + + dialog { + border: none; + outline: none; + padding: 0; + background-color: var(--color-background); + } + dialog::backdrop { + display: none; + } + #tsd-overlay { + background-color: rgba(0, 0, 0, 0.5); + position: fixed; + z-index: 9999; + top: 0; + left: 0; + right: 0; + bottom: 0; + animation: fade-in var(--modal-animation-duration) forwards; + } + #tsd-overlay.closing { + animation-name: fade-out; + } + + .tsd-typography { + line-height: 1.333em; + } + .tsd-typography ul { + list-style: square; + padding: 0 0 0 20px; + margin: 0; + } + .tsd-typography .tsd-index-panel h3, + .tsd-index-panel .tsd-typography h3, + .tsd-typography h4, + .tsd-typography h5, + .tsd-typography h6 { + font-size: 1em; + } + .tsd-typography h5, + .tsd-typography h6 { + font-weight: normal; + } + .tsd-typography p, + .tsd-typography ul, + .tsd-typography ol { + margin: 1em 0; + } + .tsd-typography table { + border-collapse: collapse; + border: none; + } + .tsd-typography td, + .tsd-typography th { + padding: 6px 13px; + border: 1px solid var(--color-accent); + } + .tsd-typography thead, + .tsd-typography tr:nth-child(even) { + background-color: var(--color-background-secondary); + } + + .tsd-alert { + padding: 8px 16px; + margin-bottom: 16px; + border-left: 0.25em solid var(--alert-color); + } + .tsd-alert blockquote > :last-child, + .tsd-alert > :last-child { + margin-bottom: 0; + } + .tsd-alert-title { + color: var(--alert-color); + display: inline-flex; + align-items: center; + } + .tsd-alert-title span { + margin-left: 4px; + } + + .tsd-alert-note { + --alert-color: var(--color-alert-note); + } + .tsd-alert-tip { + --alert-color: var(--color-alert-tip); + } + .tsd-alert-important { + --alert-color: var(--color-alert-important); + } + .tsd-alert-warning { + --alert-color: var(--color-alert-warning); + } + .tsd-alert-caution { + --alert-color: var(--color-alert-caution); + } + + .tsd-breadcrumb { + margin: 0; + margin-top: 1rem; + padding: 0; + color: var(--color-text-aside); + } + .tsd-breadcrumb a { + color: var(--color-text-aside); + text-decoration: none; + } + .tsd-breadcrumb a:hover { + text-decoration: underline; + } + .tsd-breadcrumb li { + display: inline; + } + .tsd-breadcrumb li:after { + content: " / "; + } + + .tsd-comment-tags { + display: flex; + flex-direction: column; + } + dl.tsd-comment-tag-group { + display: flex; + align-items: center; + overflow: hidden; + margin: 0.5em 0; + } + dl.tsd-comment-tag-group dt { + display: flex; + margin-right: 0.5em; + font-size: 0.875em; + font-weight: normal; + } + dl.tsd-comment-tag-group dd { + margin: 0; + } + code.tsd-tag { + padding: 0.25em 0.4em; + border: 0.1em solid var(--color-accent); + margin-right: 0.25em; + font-size: 70%; + } + h1 code.tsd-tag:first-of-type { + margin-left: 0.25em; + } + + dl.tsd-comment-tag-group dd:before, + dl.tsd-comment-tag-group dd:after { + content: " "; + } + dl.tsd-comment-tag-group dd pre, + dl.tsd-comment-tag-group dd:after { + clear: both; + } + dl.tsd-comment-tag-group p { + margin: 0; + } + + .tsd-panel.tsd-comment .lead { + font-size: 1.1em; + line-height: 1.333em; + margin-bottom: 2em; + } + .tsd-panel.tsd-comment .lead:last-child { + margin-bottom: 0; + } + + .tsd-filter-visibility h4 { + font-size: 1rem; + padding-top: 0.75rem; + padding-bottom: 0.5rem; + margin: 0; + } + .tsd-filter-item:not(:last-child) { + margin-bottom: 0.5rem; + } + .tsd-filter-input { + display: flex; + width: -moz-fit-content; + width: fit-content; + align-items: center; + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + cursor: pointer; + } + .tsd-filter-input input[type="checkbox"] { + cursor: pointer; + position: absolute; + width: 1.5em; + height: 1.5em; + opacity: 0; + } + .tsd-filter-input input[type="checkbox"]:disabled { + pointer-events: none; + } + .tsd-filter-input svg { + cursor: pointer; + width: 1.5em; + height: 1.5em; + margin-right: 0.5em; + border-radius: 0.33em; + /* Leaving this at full opacity breaks event listeners on Firefox. + Don't remove unless you know what you're doing. */ + opacity: 0.99; + } + .tsd-filter-input input[type="checkbox"]:focus-visible + svg { + outline: 2px solid var(--color-focus-outline); + } + .tsd-checkbox-background { + fill: var(--color-accent); + } + input[type="checkbox"]:checked ~ svg .tsd-checkbox-checkmark { + stroke: var(--color-text); + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-background { + fill: var(--color-background); + stroke: var(--color-accent); + stroke-width: 0.25rem; + } + .tsd-filter-input input:disabled ~ svg > .tsd-checkbox-checkmark { + stroke: var(--color-accent); + } + + .settings-label { + font-weight: bold; + text-transform: uppercase; + display: inline-block; + } + + .tsd-filter-visibility .settings-label { + margin: 0.75rem 0 0.5rem 0; + } + + .tsd-theme-toggle .settings-label { + margin: 0.75rem 0.75rem 0 0; + } + + .tsd-hierarchy h4 label:hover span { + text-decoration: underline; + } + + .tsd-hierarchy { + list-style: square; + margin: 0; + } + .tsd-hierarchy-target { + font-weight: bold; + } + .tsd-hierarchy-toggle { + color: var(--color-link); + cursor: pointer; + } + + .tsd-full-hierarchy:not(:last-child) { + margin-bottom: 1em; + padding-bottom: 1em; + border-bottom: 1px solid var(--color-accent); + } + .tsd-full-hierarchy, + .tsd-full-hierarchy ul { + list-style: none; + margin: 0; + padding: 0; + } + .tsd-full-hierarchy ul { + padding-left: 1.5rem; + } + .tsd-full-hierarchy a { + padding: 0.25rem 0 !important; + font-size: 1rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-full-hierarchy svg[data-dropdown] { + cursor: pointer; + } + .tsd-full-hierarchy svg[data-dropdown="false"] { + transform: rotate(-90deg); + } + .tsd-full-hierarchy svg[data-dropdown="false"] ~ ul { + display: none; + } + + .tsd-panel-group.tsd-index-group { + margin-bottom: 0; + } + .tsd-index-panel .tsd-index-list { + list-style: none; + line-height: 1.333em; + margin: 0; + padding: 0.25rem 0 0 0; + overflow: hidden; + display: grid; + grid-template-columns: repeat(3, 1fr); + column-gap: 1rem; + grid-template-rows: auto; + } + @media (max-width: 1024px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(2, 1fr); + } + } + @media (max-width: 768px) { + .tsd-index-panel .tsd-index-list { + grid-template-columns: repeat(1, 1fr); + } + } + .tsd-index-panel .tsd-index-list li { + -webkit-page-break-inside: avoid; + -moz-page-break-inside: avoid; + -ms-page-break-inside: avoid; + -o-page-break-inside: avoid; + page-break-inside: avoid; + } + + .tsd-flag { + display: inline-block; + padding: 0.25em 0.4em; + border-radius: 4px; + color: var(--color-comment-tag-text); + background-color: var(--color-comment-tag); + text-indent: 0; + font-size: 75%; + line-height: 1; + font-weight: normal; + } + + .tsd-anchor { + position: relative; + top: -100px; + } + + .tsd-member { + position: relative; + } + .tsd-member .tsd-anchor + h3 { + display: flex; + align-items: center; + margin-top: 0; + margin-bottom: 0; + border-bottom: none; + } + + .tsd-navigation.settings { + margin: 0; + margin-bottom: 1rem; + } + .tsd-navigation > a, + .tsd-navigation .tsd-accordion-summary { + width: calc(100% - 0.25rem); + display: flex; + align-items: center; + } + .tsd-navigation a, + .tsd-navigation summary > span, + .tsd-page-navigation a { + display: flex; + width: calc(100% - 0.25rem); + align-items: center; + padding: 0.25rem; + color: var(--color-text); + text-decoration: none; + box-sizing: border-box; + } + .tsd-navigation a.current, + .tsd-page-navigation a.current { + background: var(--color-active-menu-item); + color: var(--color-contrast-text); + } + .tsd-navigation a:hover, + .tsd-page-navigation a:hover { + text-decoration: underline; + } + .tsd-navigation ul, + .tsd-page-navigation ul { + margin-top: 0; + margin-bottom: 0; + padding: 0; + list-style: none; + } + .tsd-navigation li, + .tsd-page-navigation li { + padding: 0; + max-width: 100%; + } + .tsd-navigation .tsd-nav-link { + display: none; + } + .tsd-nested-navigation { + margin-left: 3rem; + } + .tsd-nested-navigation > li > details { + margin-left: -1.5rem; + } + .tsd-small-nested-navigation { + margin-left: 1.5rem; + } + .tsd-small-nested-navigation > li > details { + margin-left: -1.5rem; + } + + .tsd-page-navigation-section > summary { + padding: 0.25rem; + } + .tsd-page-navigation-section > summary > svg { + margin-right: 0.25rem; + } + .tsd-page-navigation-section > div { + margin-left: 30px; + } + .tsd-page-navigation ul { + padding-left: 1.75rem; + } + + #tsd-sidebar-links a { + margin-top: 0; + margin-bottom: 0.5rem; + line-height: 1.25rem; + } + #tsd-sidebar-links a:last-of-type { + margin-bottom: 0; + } + + a.tsd-index-link { + padding: 0.25rem 0 !important; + font-size: 1rem; + line-height: 1.25rem; + display: inline-flex; + align-items: center; + color: var(--color-text); + } + .tsd-accordion-summary { + list-style-type: none; /* hide marker on non-safari */ + outline: none; /* broken on safari, so just hide it */ + display: flex; + align-items: center; + gap: 0.25rem; + box-sizing: border-box; + } + .tsd-accordion-summary::-webkit-details-marker { + display: none; /* hide marker on safari */ + } + .tsd-accordion-summary, + .tsd-accordion-summary a { + -moz-user-select: none; + -webkit-user-select: none; + -ms-user-select: none; + user-select: none; + + cursor: pointer; + } + .tsd-accordion-summary a { + width: calc(100% - 1.5rem); + } + .tsd-accordion-summary > * { + margin-top: 0; + margin-bottom: 0; + padding-top: 0; + padding-bottom: 0; + } + /* + * We need to be careful to target the arrow indicating whether the accordion + * is open, but not any other SVGs included in the details element. + */ + .tsd-accordion:not([open]) > .tsd-accordion-summary > svg:first-child { + transform: rotate(-90deg); + } + .tsd-index-content > :not(:first-child) { + margin-top: 0.75rem; + } + .tsd-index-summary { + margin-top: 1.5rem; + margin-bottom: 0.75rem; + display: flex; + align-content: center; + } + + .tsd-no-select { + -webkit-user-select: none; + -moz-user-select: none; + -ms-user-select: none; + user-select: none; + } + .tsd-kind-icon { + margin-right: 0.5rem; + width: 1.25rem; + height: 1.25rem; + min-width: 1.25rem; + min-height: 1.25rem; + } + .tsd-signature > .tsd-kind-icon { + margin-right: 0.8rem; + } + + .tsd-panel { + margin-bottom: 2.5rem; + } + .tsd-panel.tsd-member { + margin-bottom: 4rem; + } + .tsd-panel:empty { + display: none; + } + .tsd-panel > h1, + .tsd-panel > h2, + .tsd-panel > h3 { + margin: 1.5rem -1.5rem 0.75rem -1.5rem; + padding: 0 1.5rem 0.75rem 1.5rem; + } + .tsd-panel > h1.tsd-before-signature, + .tsd-panel > h2.tsd-before-signature, + .tsd-panel > h3.tsd-before-signature { + margin-bottom: 0; + border-bottom: none; + } + + .tsd-panel-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group { + margin: 2rem 0; + } + .tsd-panel-group.tsd-index-group details { + margin: 2rem 0; + } + .tsd-panel-group > .tsd-accordion-summary { + margin-bottom: 1rem; + } + + #tsd-search[open] { + animation: fade-in var(--modal-animation-duration) ease-out forwards; + } + #tsd-search[open].closing { + animation-name: fade-out; + } + + /* Avoid setting `display` on closed dialog */ + #tsd-search[open] { + display: flex; + flex-direction: column; + padding: 1rem; + width: 32rem; + max-width: 90vw; + max-height: calc(100vh - env(keyboard-inset-height, 0px) - 25vh); + /* Anchor dialog to top */ + margin-top: 10vh; + border-radius: 6px; + will-change: max-height; + } + #tsd-search-input { + box-sizing: border-box; + width: 100%; + padding: 0 0.625rem; /* 10px */ + outline: 0; + border: 2px solid var(--color-accent); + background-color: transparent; + color: var(--color-text); + border-radius: 4px; + height: 2.5rem; + flex: 0 0 auto; + font-size: 0.875rem; + transition: border-color 0.2s, background-color 0.2s; + } + #tsd-search-input:focus-visible { + background-color: var(--color-background-active); + border-color: transparent; + color: var(--color-contrast-text); + } + #tsd-search-input::placeholder { + color: inherit; + opacity: 0.8; + } + #tsd-search-results { + margin: 0; + padding: 0; + list-style: none; + flex: 1 1 auto; + display: flex; + flex-direction: column; + overflow-y: auto; + } + #tsd-search-results:not(:empty) { + margin-top: 0.5rem; + } + #tsd-search-results > li { + background-color: var(--color-background); + line-height: 1.5; + box-sizing: border-box; + border-radius: 4px; + } + #tsd-search-results > li:nth-child(even) { + background-color: var(--color-background-secondary); + } + #tsd-search-results > li:is(:hover, [aria-selected="true"]) { + background-color: var(--color-background-active); + color: var(--color-contrast-text); + } + /* It's important that this takes full size of parent `li`, to capture a click on `li` */ + #tsd-search-results > li > a { + display: flex; + align-items: center; + padding: 0.5rem 0.25rem; + box-sizing: border-box; + width: 100%; + } + #tsd-search-results > li > a > .text { + flex: 1 1 auto; + min-width: 0; + overflow-wrap: anywhere; + } + #tsd-search-results > li > a .parent { + color: var(--color-text-aside); + } + #tsd-search-results > li > a mark { + color: inherit; + background-color: inherit; + font-weight: bold; + } + #tsd-search-status { + flex: 1; + display: grid; + place-content: center; + text-align: center; + overflow-wrap: anywhere; + } + #tsd-search-status:not(:empty) { + min-height: 6rem; + } + + .tsd-signature { + margin: 0 0 1rem 0; + padding: 1rem 0.5rem; + border: 1px solid var(--color-accent); + font-family: Menlo, Monaco, Consolas, "Courier New", monospace; + font-size: 14px; + overflow-x: auto; + } + + .tsd-signature-keyword { + color: var(--color-ts-keyword); + font-weight: normal; + } + + .tsd-signature-symbol { + color: var(--color-text-aside); + font-weight: normal; + } + + .tsd-signature-type { + font-style: italic; + font-weight: normal; + } + + .tsd-signatures { + padding: 0; + margin: 0 0 1em 0; + list-style-type: none; + } + .tsd-signatures .tsd-signature { + margin: 0; + border-color: var(--color-accent); + border-width: 1px 0; + transition: background-color 0.1s; + } + .tsd-signatures .tsd-index-signature:not(:last-child) { + margin-bottom: 1em; + } + .tsd-signatures .tsd-index-signature .tsd-signature { + border-width: 1px; + } + .tsd-description .tsd-signatures .tsd-signature { + border-width: 1px; + } + + ul.tsd-parameter-list, + ul.tsd-type-parameter-list { + list-style: square; + margin: 0; + padding-left: 20px; + } + ul.tsd-parameter-list > li.tsd-parameter-signature, + ul.tsd-type-parameter-list > li.tsd-parameter-signature { + list-style: none; + margin-left: -20px; + } + ul.tsd-parameter-list h5, + ul.tsd-type-parameter-list h5 { + font-size: 16px; + margin: 1em 0 0.5em 0; + } + .tsd-sources { + margin-top: 1rem; + font-size: 0.875em; + } + .tsd-sources a { + color: var(--color-text-aside); + text-decoration: underline; + } + .tsd-sources ul { + list-style: none; + padding: 0; + } + + .tsd-page-toolbar { + position: sticky; + z-index: 1; + top: 0; + left: 0; + width: 100%; + color: var(--color-text); + background: var(--color-background-secondary); + border-bottom: var(--dim-toolbar-border-bottom-width) + var(--color-accent) solid; + transition: transform 0.3s ease-in-out; + } + .tsd-page-toolbar a { + color: var(--color-text); + } + .tsd-toolbar-contents { + display: flex; + align-items: center; + height: var(--dim-toolbar-contents-height); + margin: 0 auto; + } + .tsd-toolbar-contents > .title { + font-weight: bold; + margin-right: auto; + } + #tsd-toolbar-links { + display: flex; + align-items: center; + gap: 1.5rem; + margin-right: 1rem; + } + + .tsd-widget { + box-sizing: border-box; + display: inline-block; + opacity: 0.8; + height: 2.5rem; + width: 2.5rem; + transition: opacity 0.1s, background-color 0.1s; + text-align: center; + cursor: pointer; + border: none; + background-color: transparent; + } + .tsd-widget:hover { + opacity: 0.9; + } + .tsd-widget:active { + opacity: 1; + background-color: var(--color-accent); + } + #tsd-toolbar-menu-trigger { + display: none; + } + + .tsd-member-summary-name { + display: inline-flex; + align-items: center; + padding: 0.25rem; + text-decoration: none; + } + + .tsd-anchor-icon { + display: inline-flex; + align-items: center; + margin-left: 0.5rem; + color: var(--color-text); + vertical-align: middle; + } + + .tsd-anchor-icon svg { + width: 1em; + height: 1em; + visibility: hidden; + } + + .tsd-member-summary-name:hover > .tsd-anchor-icon svg, + .tsd-anchor-link:hover > .tsd-anchor-icon svg, + .tsd-anchor-icon:focus-visible svg { + visibility: visible; + } + + .deprecated { + text-decoration: line-through !important; + } + + .warning { + padding: 1rem; + color: var(--color-warning-text); + background: var(--color-background-warning); + } + + .tsd-kind-project { + color: var(--color-ts-project); + } + .tsd-kind-module { + color: var(--color-ts-module); + } + .tsd-kind-namespace { + color: var(--color-ts-namespace); + } + .tsd-kind-enum { + color: var(--color-ts-enum); + } + .tsd-kind-enum-member { + color: var(--color-ts-enum-member); + } + .tsd-kind-variable { + color: var(--color-ts-variable); + } + .tsd-kind-function { + color: var(--color-ts-function); + } + .tsd-kind-class { + color: var(--color-ts-class); + } + .tsd-kind-interface { + color: var(--color-ts-interface); + } + .tsd-kind-constructor { + color: var(--color-ts-constructor); + } + .tsd-kind-property { + color: var(--color-ts-property); + } + .tsd-kind-method { + color: var(--color-ts-method); + } + .tsd-kind-reference { + color: var(--color-ts-reference); + } + .tsd-kind-call-signature { + color: var(--color-ts-call-signature); + } + .tsd-kind-index-signature { + color: var(--color-ts-index-signature); + } + .tsd-kind-constructor-signature { + color: var(--color-ts-constructor-signature); + } + .tsd-kind-parameter { + color: var(--color-ts-parameter); + } + .tsd-kind-type-parameter { + color: var(--color-ts-type-parameter); + } + .tsd-kind-accessor { + color: var(--color-ts-accessor); + } + .tsd-kind-get-signature { + color: var(--color-ts-get-signature); + } + .tsd-kind-set-signature { + color: var(--color-ts-set-signature); + } + .tsd-kind-type-alias { + color: var(--color-ts-type-alias); + } + + /* if we have a kind icon, don't color the text by kind */ + .tsd-kind-icon ~ span { + color: var(--color-text); + } + + /* mobile */ + @media (max-width: 769px) { + #tsd-toolbar-menu-trigger { + display: inline-block; + /* temporary fix to vertically align, for compatibility */ + line-height: 2.5; + } + #tsd-toolbar-links { + display: none; + } + + .container-main { + display: flex; + } + .col-content { + float: none; + max-width: 100%; + width: 100%; + } + .col-sidebar { + position: fixed !important; + overflow-y: auto; + -webkit-overflow-scrolling: touch; + z-index: 1024; + top: 0 !important; + bottom: 0 !important; + left: auto !important; + right: 0 !important; + padding: 1.5rem 1.5rem 0 0; + width: 75vw; + visibility: hidden; + background-color: var(--color-background); + transform: translate(100%, 0); + } + .col-sidebar > *:last-child { + padding-bottom: 20px; + } + .overlay { + content: ""; + display: block; + position: fixed; + z-index: 1023; + top: 0; + left: 0; + right: 0; + bottom: 0; + background-color: rgba(0, 0, 0, 0.75); + visibility: hidden; + } + + .to-has-menu .overlay { + animation: fade-in 0.4s; + } + + .to-has-menu .col-sidebar { + animation: pop-in-from-right 0.4s; + } + + .from-has-menu .overlay { + animation: fade-out 0.4s; + } + + .from-has-menu .col-sidebar { + animation: pop-out-to-right 0.4s; + } + + .has-menu body { + overflow: hidden; + } + .has-menu .overlay { + visibility: visible; + } + .has-menu .col-sidebar { + visibility: visible; + transform: translate(0, 0); + display: flex; + flex-direction: column; + gap: 1.5rem; + max-height: 100vh; + padding: 1rem 2rem; + } + .has-menu .tsd-navigation { + max-height: 100%; + } + .tsd-navigation .tsd-nav-link { + display: flex; + } + } + + /* one sidebar */ + @media (min-width: 770px) { + .container-main { + display: grid; + grid-template-columns: minmax(0, 1fr) minmax(0, 2fr); + grid-template-areas: "sidebar content"; + --dim-container-main-margin-y: 2rem; + } + + .tsd-breadcrumb { + margin-top: 0; + } + + .col-sidebar { + grid-area: sidebar; + } + .col-content { + grid-area: content; + padding: 0 1rem; + } + } + @media (min-width: 770px) and (max-width: 1399px) { + .col-sidebar { + max-height: calc( + 100vh - var(--dim-header-height) - var(--dim-footer-height) - + 2 * var(--dim-container-main-margin-y) + ); + overflow: auto; + position: sticky; + top: calc( + var(--dim-header-height) + var(--dim-container-main-margin-y) + ); + } + .site-menu { + margin-top: 1rem; + } + } + + /* two sidebars */ + @media (min-width: 1200px) { + .container-main { + grid-template-columns: + minmax(0, 1fr) minmax(0, 2.5fr) minmax( + 0, + 20rem + ); + grid-template-areas: "sidebar content toc"; + } + + .col-sidebar { + display: contents; + } + + .page-menu { + grid-area: toc; + padding-left: 1rem; + } + .site-menu { + grid-area: sidebar; + } + + .site-menu { + margin-top: 0rem; + } + + .page-menu, + .site-menu { + max-height: calc( + 100vh - var(--dim-header-height) - var(--dim-footer-height) - + 2 * var(--dim-container-main-margin-y) + ); + overflow: auto; + position: sticky; + top: calc( + var(--dim-header-height) + var(--dim-container-main-margin-y) + ); + } + } +} diff --git a/angular/docs/html/classes/base-widget.BaseWidget.html b/angular/docs/html/classes/base-widget.BaseWidget.html new file mode 100644 index 000000000..138ac61de --- /dev/null +++ b/angular/docs/html/classes/base-widget.BaseWidget.html @@ -0,0 +1,22 @@ +BaseWidget | GridStack Angular Library - v12.2.2-dev

Class BaseWidgetAbstract

Base widget class for GridStack Angular integration.

+
Index

Constructors

Methods

Properties

Constructors

Methods

  • Override this method to return serializable data for this widget.

    +

    Return an object with properties that map to your component's @Input() fields. +The selector is handled automatically, so only include component-specific data.

    +

    Returns undefined | NgCompInputs

    Object containing serializable component data

    +
    serialize() {
    return {
    title: this.title,
    value: this.value,
    settings: this.settings
    };
    } +
    + +
  • Override this method to handle widget restoration from saved data.

    +

    Use this for complex initialization that goes beyond simple @Input() mapping. +The default implementation automatically assigns input data to component properties.

    +

    Parameters

    Returns void

    deserialize(w: NgGridStackWidget) {
    super.deserialize(w); // Call parent for basic setup

    // Custom initialization logic
    if (w.input?.complexData) {
    this.processComplexData(w.input.complexData);
    }
    } +
    + +

Properties

widgetItem?: NgGridStackWidget

Complete widget definition including position, size, and Angular-specific data. +Populated automatically when the widget is loaded or saved.

+
diff --git a/angular/docs/html/classes/gridstack-item.component.GridstackItemComponent.html b/angular/docs/html/classes/gridstack-item.component.GridstackItemComponent.html new file mode 100644 index 000000000..401fcf2af --- /dev/null +++ b/angular/docs/html/classes/gridstack-item.component.GridstackItemComponent.html @@ -0,0 +1,39 @@ +GridstackItemComponent | GridStack Angular Library - v12.2.2-dev

Angular component wrapper for individual GridStack items.

+

This component represents a single grid item and handles:

+
    +
  • Dynamic content creation and management
  • +
  • Integration with parent GridStack component
  • +
  • Component lifecycle and cleanup
  • +
  • Widget options and configuration
  • +
+

Use in combination with GridstackComponent for the parent grid.

+
<gridstack>
<gridstack-item [options]="{x: 0, y: 0, w: 2, h: 1}">
<my-widget-component></my-widget-component>
</gridstack-item>
</gridstack> +
+ +

Implements

  • OnDestroy
Index

Accessors

Constructors

Methods

Properties

Accessors

Constructors

Methods

Properties

container?: ViewContainerRef

Container for dynamic component creation within this grid item. +Used to append child components programmatically.

+
ref: undefined | ComponentRef<GridstackItemComponent>

Component reference for dynamic component removal. +Used internally when this component is created dynamically.

+
childWidget: undefined | BaseWidget

Reference to child widget component for serialization. +Used to save/restore additional data along with grid position.

+
_options?: GridStackNode
elementRef: ElementRef<GridItemCompHTMLElement>
diff --git a/angular/docs/html/classes/gridstack.component.GridstackComponent.html b/angular/docs/html/classes/gridstack.component.GridstackComponent.html new file mode 100644 index 000000000..c4c6bb86f --- /dev/null +++ b/angular/docs/html/classes/gridstack.component.GridstackComponent.html @@ -0,0 +1,111 @@ +GridstackComponent | GridStack Angular Library - v12.2.2-dev

Angular component wrapper for GridStack.

+

This component provides Angular integration for GridStack grids, handling:

+
    +
  • Grid initialization and lifecycle
  • +
  • Dynamic component creation and management
  • +
  • Event binding and emission
  • +
  • Integration with Angular change detection
  • +
+

Use in combination with GridstackItemComponent for individual grid items.

+
<gridstack [options]="gridOptions" (change)="onGridChange($event)">
<div empty-content>Drag widgets here</div>
</gridstack> +
+ +

Implements

  • OnInit
  • AfterContentInit
  • OnDestroy
Index

Accessors

  • get grid(): undefined | GridStack

    Get the underlying GridStack instance. +Use this to access GridStack API methods directly.

    +

    Returns undefined | GridStack

    this.gridComponent.grid.addWidget({x: 0, y: 0, w: 2, h: 1});
    +
    + +

Constructors

Methods

  • Register a list of Angular components for dynamic creation.

    +

    Parameters

    • typeList: Type<Object>[]

      Array of component types to register

      +

    Returns void

    GridstackComponent.addComponentToSelectorType([
    MyWidgetComponent,
    AnotherWidgetComponent
    ]); +
    + +
  • Extract the selector string from an Angular component type.

    +

    Parameters

    • type: Type<Object>

      The component type to get selector from

      +

    Returns string

    The component's selector string

    +
  • A callback method that is invoked immediately after the +default change detector has checked the directive's +data-bound properties for the first time, +and before any of the view or content children have been checked. +It is invoked only once when the directive is instantiated.

    +

    Returns void

  • called when the TEMPLATE (not recommended) list of items changes - get a list of nodes and +update the layout accordingly (which will take care of adding/removing items changed by Angular)

    +

    Returns void

Properties

gridstackItems?: QueryList<GridstackItemComponent>

List of template-based grid items (not recommended approach). +Used to sync between DOM and GridStack internals when items are defined in templates. +Prefer dynamic component creation instead.

+
container?: ViewContainerRef

Container for dynamic component creation (recommended approach). +Used to append grid items programmatically at runtime.

+
isEmpty?: boolean

Controls whether empty content should be displayed. +Set to true to show ng-content with 'empty-content' selector when grid has no items.

+
<gridstack [isEmpty]="gridItems.length === 0">
<div empty-content>Drag widgets here to get started</div>
</gridstack> +
+ +
addedCB: EventEmitter<nodesCB> = ...

Emitted when widgets are added to the grid

+
changeCB: EventEmitter<nodesCB> = ...

Emitted when grid layout changes

+
disableCB: EventEmitter<eventCB> = ...

Emitted when grid is disabled

+
dragCB: EventEmitter<elementCB> = ...

Emitted during widget drag operations

+
dragStartCB: EventEmitter<elementCB> = ...

Emitted when widget drag starts

+
dragStopCB: EventEmitter<elementCB> = ...

Emitted when widget drag stops

+
droppedCB: EventEmitter<droppedCB> = ...

Emitted when widget is dropped

+
enableCB: EventEmitter<eventCB> = ...

Emitted when grid is enabled

+
removedCB: EventEmitter<nodesCB> = ...

Emitted when widgets are removed from the grid

+
resizeCB: EventEmitter<elementCB> = ...

Emitted during widget resize operations

+
resizeStartCB: EventEmitter<elementCB> = ...

Emitted when widget resize starts

+
resizeStopCB: EventEmitter<elementCB> = ...

Emitted when widget resize stops

+
ref: undefined | ComponentRef<GridstackComponent>

Component reference for dynamic component removal. +Used internally when this component is created dynamically.

+
selectorToType: SelectorToType = {}

Mapping of component selectors to their types for dynamic creation.

+

This enables dynamic component instantiation from string selectors. +Angular doesn't provide public access to this mapping, so we maintain our own.

+
GridstackComponent.addComponentToSelectorType([MyWidgetComponent]);
+
+ +
_options?: GridStackOptions
_grid?: GridStack
_sub: undefined | Subscription
loaded?: boolean
elementRef: ElementRef<GridCompHTMLElement>
diff --git a/angular/docs/html/classes/gridstack.module.GridstackModule.html b/angular/docs/html/classes/gridstack.module.GridstackModule.html new file mode 100644 index 000000000..8422588fd --- /dev/null +++ b/angular/docs/html/classes/gridstack.module.GridstackModule.html @@ -0,0 +1,8 @@ +GridstackModule | GridStack Angular Library - v12.2.2-dev

Class GridstackModule

Use GridstackComponent and GridstackItemComponent as standalone components instead.

+

This NgModule is provided for backward compatibility but is no longer the recommended approach. +Import components directly in your standalone components or use the new Angular module structure.

+
// Preferred approach - standalone components
@Component({
selector: 'my-app',
imports: [GridstackComponent, GridstackItemComponent],
template: '<gridstack></gridstack>'
})
export class AppComponent {}

// Legacy approach (deprecated)
@NgModule({
imports: [GridstackModule]
})
export class AppModule {} +
+ +
Index

Constructors

Constructors

diff --git a/angular/docs/html/functions/gridstack.component.gsCreateNgComponents.html b/angular/docs/html/functions/gridstack.component.gsCreateNgComponents.html new file mode 100644 index 000000000..d721aabea --- /dev/null +++ b/angular/docs/html/functions/gridstack.component.gsCreateNgComponents.html @@ -0,0 +1,2 @@ +gsCreateNgComponents | GridStack Angular Library - v12.2.2-dev

Function gsCreateNgComponents

diff --git a/angular/docs/html/functions/gridstack.component.gsSaveAdditionalNgInfo.html b/angular/docs/html/functions/gridstack.component.gsSaveAdditionalNgInfo.html new file mode 100644 index 000000000..22a7e0c15 --- /dev/null +++ b/angular/docs/html/functions/gridstack.component.gsSaveAdditionalNgInfo.html @@ -0,0 +1,5 @@ +gsSaveAdditionalNgInfo | GridStack Angular Library - v12.2.2-dev

Function gsSaveAdditionalNgInfo

diff --git a/angular/docs/html/functions/gridstack.component.gsUpdateNgComponents.html b/angular/docs/html/functions/gridstack.component.gsUpdateNgComponents.html new file mode 100644 index 000000000..d65ce45b2 --- /dev/null +++ b/angular/docs/html/functions/gridstack.component.gsUpdateNgComponents.html @@ -0,0 +1,2 @@ +gsUpdateNgComponents | GridStack Angular Library - v12.2.2-dev

Function gsUpdateNgComponents

diff --git a/angular/docs/html/hierarchy.html b/angular/docs/html/hierarchy.html new file mode 100644 index 000000000..4425da01c --- /dev/null +++ b/angular/docs/html/hierarchy.html @@ -0,0 +1 @@ +GridStack Angular Library - v12.2.2-dev

GridStack Angular Library - v12.2.2-dev

Hierarchy Summary

diff --git a/angular/docs/html/index.html b/angular/docs/html/index.html new file mode 100644 index 000000000..81e826840 --- /dev/null +++ b/angular/docs/html/index.html @@ -0,0 +1,62 @@ +GridStack Angular Library - v12.2.2-dev

GridStack Angular Library - v12.2.2-dev

Angular wrapper

The Angular wrapper component is a better way to use Gridstack, but alternative raw ngFor or simple demos are also given.

+

Running version can be seen here https://stackblitz.com/edit/gridstack-angular

+

Dynamic grid items

this is the recommended way if you are going to have multiple grids (alow drag&drop between) or drag from toolbar to create items, or drag to remove items, etc...

+

I.E. don't use Angular templating to create grid items as that is harder to sync when gridstack will also add/remove items.

+

MyComponent HTML

+
<gridstack [options]="gridOptions"></gridstack>
+
+ +

MyComponent CSS

+
@import "gridstack/dist/gridstack.min.css";

.grid-stack {
background: #fafad2;
}
.grid-stack-item-content {
text-align: center;
background-color: #18bc9c;
} +
+ +

Standalone MyComponent Code

+
import { GridStackOptions } from 'gridstack';
import { GridstackComponent, GridstackItemComponent } from 'gridstack/dist/angular';

@Component({
imports: [ // SKIP if doing module import instead (next)
GridstackComponent,
GridstackItemComponent
]
...
})
export class MyComponent {
// sample grid options + items to load...
public gridOptions: GridStackOptions = {
margin: 5,
children: [ // or call load(children) or addWidget(children[0]) with same data
{x:0, y:0, minW:2, content:'Item 1'},
{x:1, y:0, content:'Item 2'},
{x:0, y:1, content:'Item 3'},
]
}

} +
+ +

IF doing module import instead of standalone, you will also need this:

+
import { GridstackModule } from 'gridstack/dist/angular';

@NgModule({
imports: [GridstackModule, ...]
...
bootstrap: [AppComponent]
})
export class AppModule { } +
+ +

More Complete example

In this example (build on previous one) will use your actual custom angular components inside each grid item (instead of dummy html content) and have per component saved settings as well (using BaseWidget).

+

HTML

+
<gridstack [options]="gridOptions" (changeCB)="onChange($event)">
<div empty-content>message when grid is empty</div>
</gridstack> +
+ +

Code

+
import { Component } from '@angular/core';
import { GridStack, GridStackOptions } from 'gridstack';
import { GridstackComponent, gsCreateNgComponents, NgGridStackWidget, nodesCB, BaseWidget } from 'gridstack/dist/angular';

// some custom components
@Component({
selector: 'app-a',
template: 'Comp A {{text}}',
})
export class AComponent extends BaseWidget implements OnDestroy {
@Input() text: string = 'foo'; // test custom input data
public override serialize(): NgCompInputs | undefined { return this.text ? {text: this.text} : undefined; }
ngOnDestroy() {
console.log('Comp A destroyed'); // test to make sure cleanup happens
}
}

@Component({
selector: 'app-b',
template: 'Comp B',
})
export class BComponent extends BaseWidget {
}

// ...in your module (classic), OR your ng19 app.config provideEnvironmentInitializer call this:
constructor() {
// register all our dynamic components types created by the grid
GridstackComponent.addComponentToSelectorType([AComponent, BComponent]) ;
}

// now our content will use Components instead of dummy html content
public gridOptions: NgGridStackOptions = {
margin: 5,
minRow: 1, // make space for empty message
children: [ // or call load()/addWidget() with same data
{x:0, y:0, minW:2, selector:'app-a'},
{x:1, y:0, minW:2, selector:'app-a', input: { text: 'bar' }}, // custom input that works using BaseWidget.deserialize() Object.assign(this, w.input)
{x:2, y:0, selector:'app-b'},
{x:3, y:0, content:'plain html'},
]
}

// called whenever items change size/position/etc.. see other events
public onChange(data: nodesCB) {
console.log('change ', data.nodes.length > 1 ? data.nodes : data.nodes[0]);
} +
+ +

ngFor with wrapper

For simple case where you control the children creation (gridstack doesn't do create or re-parenting)

+

HTML

+
<gridstack [options]="gridOptions" (changeCB)="onChange($event)">
<!-- Angular 17+ -->
@for (n of items; track n.id) {
<gridstack-item [options]="n">Item {{n.id}}</gridstack-item>
}
<!-- Angular 16 -->
<gridstack-item *ngFor="let n of items; trackBy: identify" [options]="n"> Item {{n.id}} </gridstack-item>
</gridstack> +
+ +

Code

+
import { GridStackOptions, GridStackWidget } from 'gridstack';
import { nodesCB } from 'gridstack/dist/angular';

/** sample grid options and items to load... */
public gridOptions: GridStackOptions = { margin: 5 }
public items: GridStackWidget[] = [
{x:0, y:0, minW:2, id:'1'}, // must have unique id used for trackBy
{x:1, y:0, id:'2'},
{x:0, y:1, id:'3'},
];

// called whenever items change size/position/etc..
public onChange(data: nodesCB) {
console.log('change ', data.nodes.length > 1 ? data.nodes : data.nodes[0]);
}

// ngFor unique node id to have correct match between our items used and GS
public identify(index: number, w: GridStackWidget) {
return w.id; // or use index if no id is set and you only modify at the end...
} +
+ +

You can see a fuller example at app.component.ts

+

to build the demo, go to angular/projects/demo and run yarn + yarn start and navigate to http://localhost:4200/

+

Code started shipping with v8.1.2+ in dist/angular for people to use directly and is an angular module! (source code under dist/angular/src)

+
    +
  • This wrapper needs: +
      +
    • gridstack v8+ to run as it needs the latest changes (use older version that matches GS versions)
    • +
    • Angular 14+ for dynamic createComponent() API and Standalone Components (verified against 19+)
    • +
    +
  • +
+

NOTE: if you are on Angular 13 or below: copy the wrapper code over (or patch it - see main page example) and change createComponent() calls to use old API instead: +NOTE2: now that we're using standalone, you will also need to remove standalone: true and imports on each component so you will to copy those locally (or use <11.1.2 version)

+
protected resolver: ComponentFactoryResolver,
...
const factory = this.resolver.resolveComponentFactory(GridItemComponent);
const gridItemRef = grid.container.createComponent(factory) as ComponentRef<GridItemComponent>;
// ...do the same for widget selector... +
+ +
    +
  • This wrapper handles well ngFor loops, but if you're using a trackBy function (as I would recommend) and no element id change after an update, +you must manually update the GridstackItemComponent.option directly - see modifyNgFor() example.
  • +
  • The original client list of items is not updated to match content changes made by gridstack (TBD later), but adding new item or removing (as shown in demo) will update those new items. Client could use change/added/removed events to sync that list if they wish to do so.
  • +
+

Would appreciate getting help doing the same for React and Vue (2 other popular frameworks)

+

-Alain

+
diff --git a/angular/docs/html/interfaces/gridstack-item.component.GridItemCompHTMLElement.html b/angular/docs/html/interfaces/gridstack-item.component.GridItemCompHTMLElement.html new file mode 100644 index 000000000..b047dc2c1 --- /dev/null +++ b/angular/docs/html/interfaces/gridstack-item.component.GridItemCompHTMLElement.html @@ -0,0 +1,472 @@ +GridItemCompHTMLElement | GridStack Angular Library - v12.2.2-dev

Interface GridItemCompHTMLElement

Extended HTMLElement interface for grid items. +Stores a back-reference to the Angular component for integration.

+
interface GridItemCompHTMLElement {
    _gridItemComp?: GridstackItemComponent;
    ariaAtomic: null | string;
    ariaAutoComplete: null | string;
    ariaBusy: null | string;
    ariaChecked: null | string;
    ariaColCount: null | string;
    ariaColIndex: null | string;
    ariaColSpan: null | string;
    ariaCurrent: null | string;
    ariaDisabled: null | string;
    ariaExpanded: null | string;
    ariaHasPopup: null | string;
    ariaHidden: null | string;
    ariaInvalid: null | string;
    ariaKeyShortcuts: null | string;
    ariaLabel: null | string;
    ariaLevel: null | string;
    ariaLive: null | string;
    ariaModal: null | string;
    ariaMultiLine: null | string;
    ariaMultiSelectable: null | string;
    ariaOrientation: null | string;
    ariaPlaceholder: null | string;
    ariaPosInSet: null | string;
    ariaPressed: null | string;
    ariaReadOnly: null | string;
    ariaRequired: null | string;
    ariaRoleDescription: null | string;
    ariaRowCount: null | string;
    ariaRowIndex: null | string;
    ariaRowSpan: null | string;
    ariaSelected: null | string;
    ariaSetSize: null | string;
    ariaSort: null | string;
    ariaValueMax: null | string;
    ariaValueMin: null | string;
    ariaValueNow: null | string;
    ariaValueText: null | string;
    role: null | string;
    animate(
        keyframes: null | Keyframe[] | PropertyIndexedKeyframes,
        options?: number | KeyframeAnimationOptions,
    ): Animation;
    getAnimations(options?: GetAnimationsOptions): Animation[];
    after(...nodes: (string | Node)[]): void;
    before(...nodes: (string | Node)[]): void;
    remove(): void;
    replaceWith(...nodes: (string | Node)[]): void;
    attributes: NamedNodeMap;
    classList: DOMTokenList;
    className: string;
    clientHeight: number;
    clientLeft: number;
    clientTop: number;
    clientWidth: number;
    id: string;
    localName: string;
    namespaceURI: null | string;
    onfullscreenchange: null | ((this: Element, ev: Event) => any);
    onfullscreenerror: null | ((this: Element, ev: Event) => any);
    outerHTML: string;
    ownerDocument: Document;
    part: DOMTokenList;
    prefix: null | string;
    scrollHeight: number;
    scrollLeft: number;
    scrollTop: number;
    scrollWidth: number;
    shadowRoot: null | ShadowRoot;
    slot: string;
    tagName: string;
    attachShadow(init: ShadowRootInit): ShadowRoot;
    checkVisibility(options?: CheckVisibilityOptions): boolean;
    closest<K extends keyof HTMLElementTagNameMap>(
        selector: K,
    ): null | HTMLElementTagNameMap[K];
    closest<K extends keyof SVGElementTagNameMap>(
        selector: K,
    ): null | SVGElementTagNameMap[K];
    closest<K extends keyof MathMLElementTagNameMap>(
        selector: K,
    ): null | MathMLElementTagNameMap[K];
    closest<E extends Element<E> = Element>(selectors: string): null | E;
    getAttribute(qualifiedName: string): null | string;
    getAttributeNS(namespace: null | string, localName: string): null | string;
    getAttributeNames(): string[];
    getAttributeNode(qualifiedName: string): null | Attr;
    getAttributeNodeNS(
        namespace: null | string,
        localName: string,
    ): null | Attr;
    getBoundingClientRect(): DOMRect;
    getClientRects(): DOMRectList;
    getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
    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]>;
    getElementsByTagName<K extends keyof HTMLElementDeprecatedTagNameMap>(
        qualifiedName: K,
    ): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>;
    getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
    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: null | string,
        localName: string,
    ): HTMLCollectionOf<Element>;
    hasAttribute(qualifiedName: string): boolean;
    hasAttributeNS(namespace: null | string, localName: string): boolean;
    hasAttributes(): boolean;
    hasPointerCapture(pointerId: number): boolean;
    insertAdjacentElement(
        where: InsertPosition,
        element: Element,
    ): null | Element;
    insertAdjacentHTML(position: InsertPosition, text: string): void;
    insertAdjacentText(where: InsertPosition, data: string): void;
    matches(selectors: string): boolean;
    releasePointerCapture(pointerId: number): void;
    removeAttribute(qualifiedName: string): void;
    removeAttributeNS(namespace: null | string, localName: string): void;
    removeAttributeNode(attr: Attr): Attr;
    requestFullscreen(options?: FullscreenOptions): Promise<void>;
    requestPointerLock(): void;
    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: null | string,
        qualifiedName: string,
        value: string,
    ): void;
    setAttributeNode(attr: Attr): null | Attr;
    setAttributeNodeNS(attr: Attr): null | Attr;
    setPointerCapture(pointerId: number): void;
    toggleAttribute(qualifiedName: string, force?: boolean): boolean;
    webkitMatchesSelector(selectors: string): boolean;
    style: CSSStyleDeclaration;
    contentEditable: string;
    enterKeyHint: string;
    inputMode: string;
    isContentEditable: boolean;
    dispatchEvent(event: Event): boolean;
    onabort: null | ((this: GlobalEventHandlers, ev: UIEvent) => any);
    onanimationcancel:
        | null
        | ((this: GlobalEventHandlers, ev: AnimationEvent) => any);
    onanimationend:
        | null
        | ((this: GlobalEventHandlers, ev: AnimationEvent) => any);
    onanimationiteration:
        | null
        | ((this: GlobalEventHandlers, ev: AnimationEvent) => any);
    onanimationstart:
        | null
        | ((this: GlobalEventHandlers, ev: AnimationEvent) => any);
    onauxclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onbeforeinput: null | ((this: GlobalEventHandlers, ev: InputEvent) => any);
    onblur: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any);
    oncancel: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oncanplay: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oncanplaythrough: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onchange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onclose: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oncontextmenu: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    oncopy: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any);
    oncuechange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oncut: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any);
    ondblclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    ondrag: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragend: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragenter: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragleave: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragover: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragstart: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondrop: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondurationchange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onemptied: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onended: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onerror: OnErrorEventHandler;
    onfocus: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any);
    onformdata: null | ((this: GlobalEventHandlers, ev: FormDataEvent) => any);
    ongotpointercapture:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    oninput: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oninvalid: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onkeydown: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any);
    onkeypress: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any);
    onkeyup: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any);
    onload: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onloadeddata: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onloadedmetadata: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onloadstart: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onlostpointercapture:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onmousedown: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseenter: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseleave: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmousemove: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseout: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseover: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseup: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onpaste: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any);
    onpause: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onplay: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onplaying: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onpointercancel:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerdown:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerenter:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerleave:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointermove:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerout: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerover:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerup: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onprogress: null | ((this: GlobalEventHandlers, ev: ProgressEvent) => any);
    onratechange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onreset: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onresize: null | ((this: GlobalEventHandlers, ev: UIEvent) => any);
    onscroll: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onsecuritypolicyviolation:
        | null
        | ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any);
    onseeked: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onseeking: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onselect: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onselectionchange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onselectstart: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onslotchange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onstalled: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onsubmit: null | ((this: GlobalEventHandlers, ev: SubmitEvent) => any);
    onsuspend: null | ((this: GlobalEventHandlers, ev: Event) => any);
    ontimeupdate: null | ((this: GlobalEventHandlers, ev: Event) => any);
    ontoggle: null | ((this: GlobalEventHandlers, ev: Event) => any);
    ontouchcancel?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any);
    ontouchend?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any);
    ontouchmove?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any);
    ontouchstart?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any);
    ontransitioncancel:
        | null
        | ((this: GlobalEventHandlers, ev: TransitionEvent) => any);
    ontransitionend:
        | null
        | ((this: GlobalEventHandlers, ev: TransitionEvent) => any);
    ontransitionrun:
        | null
        | ((this: GlobalEventHandlers, ev: TransitionEvent) => any);
    ontransitionstart:
        | null
        | ((this: GlobalEventHandlers, ev: TransitionEvent) => any);
    onvolumechange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onwaiting: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onwebkitanimationend:
        | null
        | ((this: GlobalEventHandlers, ev: Event) => any);
    onwebkitanimationiteration:
        | null
        | ((this: GlobalEventHandlers, ev: Event) => any);
    onwebkitanimationstart:
        | null
        | ((this: GlobalEventHandlers, ev: Event) => any);
    onwebkittransitionend:
        | null
        | ((this: GlobalEventHandlers, ev: Event) => any);
    onwheel: null | ((this: GlobalEventHandlers, ev: WheelEvent) => any);
    accessKey: string;
    accessKeyLabel: string;
    autocapitalize: string;
    dir: string;
    draggable: boolean;
    hidden: boolean;
    inert: boolean;
    innerText: string;
    lang: string;
    offsetHeight: number;
    offsetLeft: number;
    offsetParent: null | Element;
    offsetTop: number;
    offsetWidth: number;
    outerText: string;
    spellcheck: boolean;
    title: string;
    translate: boolean;
    attachInternals(): ElementInternals;
    click(): void;
    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;
    autofocus: boolean;
    dataset: DOMStringMap;
    nonce?: string;
    tabIndex: number;
    blur(): void;
    focus(options?: FocusOptions): void;
    innerHTML: string;
    baseURI: string;
    childNodes: NodeListOf<ChildNode>;
    firstChild: null | ChildNode;
    isConnected: boolean;
    lastChild: null | ChildNode;
    nextSibling: null | ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: null | string;
    parentElement: null | HTMLElement;
    parentNode: null | ParentNode;
    previousSibling: null | ChildNode;
    textContent: null | string;
    appendChild<T extends Node<T>>(node: T): T;
    cloneNode(deep?: boolean): Node;
    compareDocumentPosition(other: Node): number;
    contains(other: null | Node): boolean;
    getRootNode(options?: GetRootNodeOptions): Node;
    hasChildNodes(): boolean;
    insertBefore<T extends Node<T>>(node: T, child: null | Node): T;
    isDefaultNamespace(namespace: null | string): boolean;
    isEqualNode(otherNode: null | Node): boolean;
    isSameNode(otherNode: null | Node): boolean;
    lookupNamespaceURI(prefix: null | string): null | string;
    lookupPrefix(namespace: null | string): null | string;
    normalize(): void;
    removeChild<T extends Node<T>>(child: T): T;
    replaceChild<T extends Node<T>>(node: Node, child: T): T;
    ELEMENT_NODE: 1;
    ATTRIBUTE_NODE: 2;
    TEXT_NODE: 3;
    CDATA_SECTION_NODE: 4;
    ENTITY_REFERENCE_NODE: 5;
    ENTITY_NODE: 6;
    PROCESSING_INSTRUCTION_NODE: 7;
    COMMENT_NODE: 8;
    DOCUMENT_NODE: 9;
    DOCUMENT_TYPE_NODE: 10;
    DOCUMENT_FRAGMENT_NODE: 11;
    NOTATION_NODE: 12;
    DOCUMENT_POSITION_DISCONNECTED: 1;
    DOCUMENT_POSITION_PRECEDING: 2;
    DOCUMENT_POSITION_FOLLOWING: 4;
    DOCUMENT_POSITION_CONTAINS: 8;
    DOCUMENT_POSITION_CONTAINED_BY: 16;
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
    nextElementSibling: null | Element;
    previousElementSibling: null | Element;
    childElementCount: number;
    children: HTMLCollection;
    firstElementChild: null | Element;
    lastElementChild: null | Element;
    append(...nodes: (string | Node)[]): void;
    prepend(...nodes: (string | Node)[]): void;
    querySelector<K extends keyof HTMLElementTagNameMap>(
        selectors: K,
    ): null | HTMLElementTagNameMap[K];
    querySelector<K extends keyof SVGElementTagNameMap>(
        selectors: K,
    ): null | SVGElementTagNameMap[K];
    querySelector<K extends keyof MathMLElementTagNameMap>(
        selectors: K,
    ): null | MathMLElementTagNameMap[K];
    querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(
        selectors: K,
    ): null | HTMLElementDeprecatedTagNameMap[K];
    querySelector<E extends Element<E> = Element>(selectors: string): null | E;
    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]>;
    querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(
        selectors: K,
    ): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;
    querySelectorAll<E extends Element<E> = Element>(
        selectors: string,
    ): NodeListOf<E>;
    replaceChildren(...nodes: (string | Node)[]): void;
    assignedSlot: null | HTMLSlotElement;
}

Hierarchy

  • GridItemHTMLElement
    • GridItemCompHTMLElement
Index

Methods

Properties

_gridItemComp? +ariaAtomic +ariaAutoComplete +ariaBusy +ariaChecked +ariaColCount +ariaColIndex +ariaColSpan +ariaCurrent +ariaDisabled +ariaExpanded +ariaHasPopup +ariaHidden +ariaInvalid +ariaKeyShortcuts +ariaLabel +ariaLevel +ariaLive +ariaModal +ariaMultiLine +ariaMultiSelectable +ariaOrientation +ariaPlaceholder +ariaPosInSet +ariaPressed +ariaReadOnly +ariaRequired +ariaRoleDescription +ariaRowCount +ariaRowIndex +ariaRowSpan +ariaSelected +ariaSetSize +ariaSort +ariaValueMax +ariaValueMin +ariaValueNow +ariaValueText +role +attributes +classList +className +clientHeight +clientLeft +clientTop +clientWidth +id +localName +namespaceURI +onfullscreenchange +onfullscreenerror +outerHTML +ownerDocument +part +prefix +scrollHeight +scrollLeft +scrollTop +scrollWidth +shadowRoot +slot +tagName +style +contentEditable +enterKeyHint +inputMode +isContentEditable +onabort +onanimationcancel +onanimationend +onanimationiteration +onanimationstart +onauxclick +onbeforeinput +onblur +oncancel +oncanplay +oncanplaythrough +onchange +onclick +onclose +oncontextmenu +oncopy +oncuechange +oncut +ondblclick +ondrag +ondragend +ondragenter +ondragleave +ondragover +ondragstart +ondrop +ondurationchange +onemptied +onended +onerror +onfocus +onformdata +ongotpointercapture +oninput +oninvalid +onkeydown +onkeypress +onkeyup +onload +onloadeddata +onloadedmetadata +onloadstart +onlostpointercapture +onmousedown +onmouseenter +onmouseleave +onmousemove +onmouseout +onmouseover +onmouseup +onpaste +onpause +onplay +onplaying +onpointercancel +onpointerdown +onpointerenter +onpointerleave +onpointermove +onpointerout +onpointerover +onpointerup +onprogress +onratechange +onreset +onresize +onscroll +onsecuritypolicyviolation +onseeked +onseeking +onselect +onselectionchange +onselectstart +onslotchange +onstalled +onsubmit +onsuspend +ontimeupdate +ontoggle +ontouchcancel? +ontouchend? +ontouchmove? +ontouchstart? +ontransitioncancel +ontransitionend +ontransitionrun +ontransitionstart +onvolumechange +onwaiting +onwebkitanimationend +onwebkitanimationiteration +onwebkitanimationstart +onwebkittransitionend +onwheel +accessKey +accessKeyLabel +autocapitalize +dir +draggable +hidden +inert +innerText +lang +offsetHeight +offsetLeft +offsetParent +offsetTop +offsetWidth +outerText +spellcheck +title +translate +autofocus +dataset +nonce? +tabIndex +innerHTML +baseURI +childNodes +firstChild +isConnected +lastChild +nextSibling +nodeName +nodeType +nodeValue +parentElement +parentNode +previousSibling +textContent +ELEMENT_NODE +ATTRIBUTE_NODE +TEXT_NODE +CDATA_SECTION_NODE +ENTITY_REFERENCE_NODE +ENTITY_NODE +PROCESSING_INSTRUCTION_NODE +COMMENT_NODE +DOCUMENT_NODE +DOCUMENT_TYPE_NODE +DOCUMENT_FRAGMENT_NODE +NOTATION_NODE +DOCUMENT_POSITION_DISCONNECTED +DOCUMENT_POSITION_PRECEDING +DOCUMENT_POSITION_FOLLOWING +DOCUMENT_POSITION_CONTAINS +DOCUMENT_POSITION_CONTAINED_BY +DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC +nextElementSibling +previousElementSibling +childElementCount +children +firstElementChild +lastElementChild +assignedSlot +

Methods

  • Parameters

    • keyframes: null | Keyframe[] | PropertyIndexedKeyframes
    • Optionaloptions: number | KeyframeAnimationOptions

    Returns Animation

  • Parameters

    • Optionaloptions: GetAnimationsOptions

    Returns Animation[]

  • Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

    +

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    +

    Parameters

    • ...nodes: (string | Node)[]

    Returns void

  • Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

    +

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    +

    Parameters

    • ...nodes: (string | Node)[]

    Returns void

  • Removes node.

    +

    Returns void

  • Replaces 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.

    +

    Parameters

    • ...nodes: (string | Node)[]

    Returns void

  • Creates a shadow root for element and returns it.

    +

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

  • Parameters

    • Optionaloptions: CheckVisibilityOptions

    Returns boolean

  • Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

    +

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns null | HTMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns null | SVGElementTagNameMap[K]

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selector: K

    Returns null | MathMLElementTagNameMap[K]

  • Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns null | E

  • Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

    +

    Parameters

    • qualifiedName: string

    Returns null | string

  • Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

    +

    Parameters

    • namespace: null | string
    • localName: string

    Returns null | string

  • Returns the qualified names of all element's attributes. Can contain duplicates.

    +

    Returns string[]

  • Parameters

    • qualifiedName: string

    Returns null | Attr

  • Parameters

    • namespace: null | string
    • localName: string

    Returns null | Attr

  • Returns DOMRect

  • Returns 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.

    +

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

  • Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<MathMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

  • Parameters

    • namespaceURI: "http://www.w3.org/1999/xhtml"
    • localName: string

    Returns HTMLCollectionOf<HTMLElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/2000/svg"
    • localName: string

    Returns HTMLCollectionOf<SVGElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/1998/Math/MathML"
    • localName: string

    Returns HTMLCollectionOf<MathMLElement>

  • Parameters

    • namespace: null | string
    • localName: string

    Returns HTMLCollectionOf<Element>

  • Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

    +

    Parameters

    • qualifiedName: string

    Returns boolean

  • Returns true if element has an attribute whose namespace is namespace and local name is localName.

    +

    Parameters

    • namespace: null | string
    • localName: string

    Returns boolean

  • Returns true if element has attributes, and false otherwise.

    +

    Returns boolean

  • Parameters

    • pointerId: number

    Returns boolean

  • Parameters

    • where: InsertPosition
    • element: Element

    Returns null | Element

  • Parameters

    • position: InsertPosition
    • text: string

    Returns void

  • Parameters

    • where: InsertPosition
    • data: string

    Returns void

  • Returns true if matching selectors against element's root yields element, and false otherwise.

    +

    Parameters

    • selectors: string

    Returns boolean

  • Parameters

    • pointerId: number

    Returns void

  • Removes element's first attribute whose qualified name is qualifiedName.

    +

    Parameters

    • qualifiedName: string

    Returns void

  • Removes element's attribute whose namespace is namespace and local name is localName.

    +

    Parameters

    • namespace: null | string
    • localName: string

    Returns void

  • Parameters

    • attr: Attr

    Returns 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.

    +

    Parameters

    • Optionaloptions: FullscreenOptions

    Returns Promise<void>

  • Returns void

  • Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • Optionalarg: boolean | ScrollIntoViewOptions

    Returns void

  • Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Sets the value of element's first attribute whose qualified name is qualifiedName to value.

    +

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

  • Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

    +

    Parameters

    • namespace: null | string
    • qualifiedName: string
    • value: string

    Returns void

  • Parameters

    • attr: Attr

    Returns null | Attr

  • Parameters

    • attr: Attr

    Returns null | Attr

  • Parameters

    • pointerId: number

    Returns 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.

    +

    Parameters

    • qualifiedName: string
    • Optionalforce: boolean

    Returns boolean

  • Parameters

    • selectors: string

    Returns boolean

    This is a legacy alias of matches.

    +
  • 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.

    +

    Parameters

    • event: Event

    Returns boolean

  • Returns ElementInternals

  • Returns void

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
    • Optionaloptions: boolean | AddEventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optionaloptions: boolean | AddEventListenerOptions

    Returns void

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
    • Optionaloptions: boolean | EventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optionaloptions: boolean | EventListenerOptions

    Returns void

  • Returns void

  • Parameters

    • Optionaloptions: FocusOptions

    Returns void

  • Type Parameters

    • T extends Node<T>

    Parameters

    • node: T

    Returns T

  • Returns a copy of node. If deep is true, the copy also includes the node's descendants.

    +

    Parameters

    • Optionaldeep: boolean

    Returns Node

  • Returns a bitmask indicating the position of other relative to node.

    +

    Parameters

    • other: Node

    Returns number

  • Returns true if other is an inclusive descendant of node, and false otherwise.

    +

    Parameters

    • other: null | Node

    Returns boolean

  • Returns node's root.

    +

    Parameters

    • Optionaloptions: GetRootNodeOptions

    Returns Node

  • Returns whether node has children.

    +

    Returns boolean

  • Type Parameters

    • T extends Node<T>

    Parameters

    • node: T
    • child: null | Node

    Returns T

  • Parameters

    • namespace: null | string

    Returns boolean

  • Returns whether node and otherNode have the same properties.

    +

    Parameters

    • otherNode: null | Node

    Returns boolean

  • Parameters

    • otherNode: null | Node

    Returns boolean

  • Parameters

    • prefix: null | string

    Returns null | string

  • Parameters

    • namespace: null | string

    Returns null | string

  • Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

    +

    Returns void

  • Type Parameters

    • T extends Node<T>

    Parameters

    • child: T

    Returns T

  • Type Parameters

    • T extends Node<T>

    Parameters

    • node: Node
    • child: T

    Returns T

  • 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.

    +

    Parameters

    • ...nodes: (string | Node)[]

    Returns 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.

    +

    Parameters

    • ...nodes: (string | Node)[]

    Returns void

  • Returns the first element that is a descendant of node that matches selectors.

    +

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns null | HTMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns null | SVGElementTagNameMap[K]

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selectors: K

    Returns null | MathMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • selectors: K

    Returns null | HTMLElementDeprecatedTagNameMap[K]

  • Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns null | E

  • Returns all element descendants of node that match selectors.

    +

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<MathMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

  • Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns 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.

    +

    Parameters

    • ...nodes: (string | Node)[]

    Returns void

Properties

_gridItemComp?: GridstackItemComponent

Back-reference to the Angular GridStackItem component

+
ariaAtomic: null | string
ariaAutoComplete: null | string
ariaBusy: null | string
ariaChecked: null | string
ariaColCount: null | string
ariaColIndex: null | string
ariaColSpan: null | string
ariaCurrent: null | string
ariaDisabled: null | string
ariaExpanded: null | string
ariaHasPopup: null | string
ariaHidden: null | string
ariaInvalid: null | string
ariaKeyShortcuts: null | string
ariaLabel: null | string
ariaLevel: null | string
ariaLive: null | string
ariaModal: null | string
ariaMultiLine: null | string
ariaMultiSelectable: null | string
ariaOrientation: null | string
ariaPlaceholder: null | string
ariaPosInSet: null | string
ariaPressed: null | string
ariaReadOnly: null | string
ariaRequired: null | string
ariaRoleDescription: null | string
ariaRowCount: null | string
ariaRowIndex: null | string
ariaRowSpan: null | string
ariaSelected: null | string
ariaSetSize: null | string
ariaSort: null | string
ariaValueMax: null | string
ariaValueMin: null | string
ariaValueNow: null | string
ariaValueText: null | string
role: null | string
attributes: NamedNodeMap
classList: DOMTokenList

Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

+
className: string

Returns the value of element's class content attribute. Can be set to change it.

+
clientHeight: number
clientLeft: number
clientTop: number
clientWidth: number
id: string

Returns the value of element's id content attribute. Can be set to change it.

+
localName: string

Returns the local name.

+
namespaceURI: null | string

Returns the namespace.

+
onfullscreenchange: null | ((this: Element, ev: Event) => any)
onfullscreenerror: null | ((this: Element, ev: Event) => any)
outerHTML: string
ownerDocument: Document

Returns the node document. Returns null for documents.

+
part: DOMTokenList
prefix: null | string

Returns the namespace prefix.

+
scrollHeight: number
scrollLeft: number
scrollTop: number
scrollWidth: number
shadowRoot: null | ShadowRoot

Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

+
slot: string

Returns the value of element's slot content attribute. Can be set to change it.

+
tagName: string

Returns the HTML-uppercased qualified name.

+
style: CSSStyleDeclaration
contentEditable: string
enterKeyHint: string
inputMode: string
isContentEditable: boolean
onabort: null | ((this: GlobalEventHandlers, ev: UIEvent) => any)

Fires when the user aborts the download.

+

The event.

+
onanimationcancel:
    | null
    | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
onanimationend: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
onanimationiteration:
    | null
    | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
onanimationstart:
    | null
    | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
onauxclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)
onbeforeinput: null | ((this: GlobalEventHandlers, ev: InputEvent) => any)
onblur: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any)

Fires when the object loses the input focus.

+

The focus event.

+
oncancel: null | ((this: GlobalEventHandlers, ev: Event) => any)
oncanplay: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when playback is possible, but would require further buffering.

+

The event.

+
oncanplaythrough: null | ((this: GlobalEventHandlers, ev: Event) => any)
onchange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the contents of the object or selection have changed.

+

The event.

+
onclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user clicks the left mouse button on the object

+

The mouse event.

+
onclose: null | ((this: GlobalEventHandlers, ev: Event) => any)
oncontextmenu: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user clicks the right mouse button in the client area, opening the context menu.

+

The mouse event.

+
oncopy: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)
oncuechange: null | ((this: GlobalEventHandlers, ev: Event) => any)
oncut: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)
ondblclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user double-clicks the object.

+

The mouse event.

+
ondrag: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the source object continuously during a drag operation.

+

The event.

+
ondragend: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the source object when the user releases the mouse at the close of a drag operation.

+

The event.

+
ondragenter: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the target element when the user drags the object to a valid drop target.

+

The drag event.

+
ondragleave: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

+

The drag event.

+
ondragover: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the target element continuously while the user drags the object over a valid drop target.

+

The event.

+
ondragstart: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the source object when the user starts to drag a text selection or selected object.

+

The event.

+
ondrop: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)
ondurationchange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the duration attribute is updated.

+

The event.

+
onemptied: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the media element is reset to its initial state.

+

The event.

+
onended: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the end of playback is reached.

+

The event

+
onerror: OnErrorEventHandler

Fires when an error occurs during object loading.

+

The event.

+
onfocus: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any)

Fires when the object receives focus.

+

The event.

+
onformdata: null | ((this: GlobalEventHandlers, ev: FormDataEvent) => any)
ongotpointercapture:
    | null
    | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
oninput: null | ((this: GlobalEventHandlers, ev: Event) => any)
oninvalid: null | ((this: GlobalEventHandlers, ev: Event) => any)
onkeydown: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

Fires when the user presses a key.

+

The keyboard event

+
onkeypress: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

Fires when the user presses an alphanumeric key.

+

The event.

+
onkeyup: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

Fires when the user releases a key.

+

The keyboard event

+
onload: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires immediately after the browser loads the object.

+

The event.

+
onloadeddata: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when media data is loaded at the current playback position.

+

The event.

+
onloadedmetadata: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the duration and dimensions of the media have been determined.

+

The event.

+
onloadstart: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when Internet Explorer begins looking for media data.

+

The event.

+
onlostpointercapture:
    | null
    | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onmousedown: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user clicks the object with either mouse button.

+

The mouse event.

+
onmouseenter: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)
onmouseleave: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)
onmousemove: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user moves the mouse over the object.

+

The mouse event.

+
onmouseout: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user moves the mouse pointer outside the boundaries of the object.

+

The mouse event.

+
onmouseover: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user moves the mouse pointer into the object.

+

The mouse event.

+
onmouseup: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user releases a mouse button while the mouse is over the object.

+

The mouse event.

+
onpaste: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)
onpause: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when playback is paused.

+

The event.

+
onplay: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the play method is requested.

+

The event.

+
onplaying: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the audio or video has started playing.

+

The event.

+
onpointercancel: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerdown: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerenter: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerleave: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointermove: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerout: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerover: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerup: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onprogress: null | ((this: GlobalEventHandlers, ev: ProgressEvent) => any)

Occurs to indicate progress while downloading media data.

+

The event.

+
onratechange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the playback rate is increased or decreased.

+

The event.

+
onreset: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the user resets a form.

+

The event.

+
onresize: null | ((this: GlobalEventHandlers, ev: UIEvent) => any)
onscroll: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the user repositions the scroll box in the scroll bar on the object.

+

The event.

+
onsecuritypolicyviolation:
    | null
    | ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any)
onseeked: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the seek operation ends.

+

The event.

+
onseeking: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the current playback position is moved.

+

The event.

+
onselect: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the current selection changes.

+

The event.

+
onselectionchange: null | ((this: GlobalEventHandlers, ev: Event) => any)
onselectstart: null | ((this: GlobalEventHandlers, ev: Event) => any)
onslotchange: null | ((this: GlobalEventHandlers, ev: Event) => any)
onstalled: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the download has stopped.

+

The event.

+
onsubmit: null | ((this: GlobalEventHandlers, ev: SubmitEvent) => any)
onsuspend: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs if the load operation has been intentionally halted.

+

The event.

+
ontimeupdate: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs to indicate the current playback position.

+

The event.

+
ontoggle: null | ((this: GlobalEventHandlers, ev: Event) => any)
ontouchcancel?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
ontouchend?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
ontouchmove?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
ontouchstart?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
ontransitioncancel:
    | null
    | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
ontransitionend:
    | null
    | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
ontransitionrun:
    | null
    | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
ontransitionstart:
    | null
    | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
onvolumechange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the volume is changed, or playback is muted or unmuted.

+

The event.

+
onwaiting: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when playback stops because the next frame of a video resource is not available.

+

The event.

+
onwebkitanimationend: null | ((this: GlobalEventHandlers, ev: Event) => any)

This is a legacy alias of onanimationend.

+
onwebkitanimationiteration:
    | null
    | ((this: GlobalEventHandlers, ev: Event) => any)

This is a legacy alias of onanimationiteration.

+
onwebkitanimationstart: null | ((this: GlobalEventHandlers, ev: Event) => any)

This is a legacy alias of onanimationstart.

+
onwebkittransitionend: null | ((this: GlobalEventHandlers, ev: Event) => any)

This is a legacy alias of ontransitionend.

+
onwheel: null | ((this: GlobalEventHandlers, ev: WheelEvent) => any)
accessKey: string
accessKeyLabel: string
autocapitalize: string
dir: string
draggable: boolean
hidden: boolean
inert: boolean
innerText: string
lang: string
offsetHeight: number
offsetLeft: number
offsetParent: null | Element
offsetTop: number
offsetWidth: number
outerText: string
spellcheck: boolean
title: string
translate: boolean
autofocus: boolean
dataset: DOMStringMap
nonce?: string
tabIndex: number
innerHTML: string
baseURI: string

Returns node's node document's document base URL.

+
childNodes: NodeListOf<ChildNode>

Returns the children.

+
firstChild: null | ChildNode

Returns the first child.

+
isConnected: boolean

Returns true if node is connected and false otherwise.

+
lastChild: null | ChildNode

Returns the last child.

+
nextSibling: null | ChildNode

Returns the next sibling.

+
nodeName: string

Returns a string appropriate for the type of node.

+
nodeType: number

Returns the type of node.

+
nodeValue: null | string
parentElement: null | HTMLElement

Returns the parent element.

+
parentNode: null | ParentNode

Returns the parent.

+
previousSibling: null | ChildNode

Returns the previous sibling.

+
textContent: null | string
ELEMENT_NODE: 1

node is an element.

+
ATTRIBUTE_NODE: 2
TEXT_NODE: 3

node is a Text node.

+
CDATA_SECTION_NODE: 4

node is a CDATASection node.

+
ENTITY_REFERENCE_NODE: 5
ENTITY_NODE: 6
PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

+
COMMENT_NODE: 8

node is a Comment node.

+
DOCUMENT_NODE: 9

node is a document.

+
DOCUMENT_TYPE_NODE: 10

node is a doctype.

+
DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

+
NOTATION_NODE: 12
DOCUMENT_POSITION_DISCONNECTED: 1

Set when node and other are not in the same tree.

+
DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

+
DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

+
DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

+
DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

+
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32
nextElementSibling: null | Element

Returns the first following sibling that is an element, and null otherwise.

+
previousElementSibling: null | Element

Returns the first preceding sibling that is an element, and null otherwise.

+
childElementCount: number
children: HTMLCollection

Returns the child elements.

+
firstElementChild: null | Element

Returns the first child that is an element, and null otherwise.

+
lastElementChild: null | Element

Returns the last child that is an element, and null otherwise.

+
assignedSlot: null | HTMLSlotElement
diff --git a/angular/docs/html/interfaces/gridstack.component.GridCompHTMLElement.html b/angular/docs/html/interfaces/gridstack.component.GridCompHTMLElement.html new file mode 100644 index 000000000..fed79b12c --- /dev/null +++ b/angular/docs/html/interfaces/gridstack.component.GridCompHTMLElement.html @@ -0,0 +1,472 @@ +GridCompHTMLElement | GridStack Angular Library - v12.2.2-dev

Interface GridCompHTMLElement

Extended HTMLElement interface for the grid container. +Stores a back-reference to the Angular component for integration purposes.

+
interface GridCompHTMLElement {
    _gridComp?: GridstackComponent;
    ariaAtomic: null | string;
    ariaAutoComplete: null | string;
    ariaBusy: null | string;
    ariaChecked: null | string;
    ariaColCount: null | string;
    ariaColIndex: null | string;
    ariaColSpan: null | string;
    ariaCurrent: null | string;
    ariaDisabled: null | string;
    ariaExpanded: null | string;
    ariaHasPopup: null | string;
    ariaHidden: null | string;
    ariaInvalid: null | string;
    ariaKeyShortcuts: null | string;
    ariaLabel: null | string;
    ariaLevel: null | string;
    ariaLive: null | string;
    ariaModal: null | string;
    ariaMultiLine: null | string;
    ariaMultiSelectable: null | string;
    ariaOrientation: null | string;
    ariaPlaceholder: null | string;
    ariaPosInSet: null | string;
    ariaPressed: null | string;
    ariaReadOnly: null | string;
    ariaRequired: null | string;
    ariaRoleDescription: null | string;
    ariaRowCount: null | string;
    ariaRowIndex: null | string;
    ariaRowSpan: null | string;
    ariaSelected: null | string;
    ariaSetSize: null | string;
    ariaSort: null | string;
    ariaValueMax: null | string;
    ariaValueMin: null | string;
    ariaValueNow: null | string;
    ariaValueText: null | string;
    role: null | string;
    animate(
        keyframes: null | Keyframe[] | PropertyIndexedKeyframes,
        options?: number | KeyframeAnimationOptions,
    ): Animation;
    getAnimations(options?: GetAnimationsOptions): Animation[];
    after(...nodes: (string | Node)[]): void;
    before(...nodes: (string | Node)[]): void;
    remove(): void;
    replaceWith(...nodes: (string | Node)[]): void;
    attributes: NamedNodeMap;
    classList: DOMTokenList;
    className: string;
    clientHeight: number;
    clientLeft: number;
    clientTop: number;
    clientWidth: number;
    id: string;
    localName: string;
    namespaceURI: null | string;
    onfullscreenchange: null | ((this: Element, ev: Event) => any);
    onfullscreenerror: null | ((this: Element, ev: Event) => any);
    outerHTML: string;
    ownerDocument: Document;
    part: DOMTokenList;
    prefix: null | string;
    scrollHeight: number;
    scrollLeft: number;
    scrollTop: number;
    scrollWidth: number;
    shadowRoot: null | ShadowRoot;
    slot: string;
    tagName: string;
    attachShadow(init: ShadowRootInit): ShadowRoot;
    checkVisibility(options?: CheckVisibilityOptions): boolean;
    closest<K extends keyof HTMLElementTagNameMap>(
        selector: K,
    ): null | HTMLElementTagNameMap[K];
    closest<K extends keyof SVGElementTagNameMap>(
        selector: K,
    ): null | SVGElementTagNameMap[K];
    closest<K extends keyof MathMLElementTagNameMap>(
        selector: K,
    ): null | MathMLElementTagNameMap[K];
    closest<E extends Element<E> = Element>(selectors: string): null | E;
    getAttribute(qualifiedName: string): null | string;
    getAttributeNS(namespace: null | string, localName: string): null | string;
    getAttributeNames(): string[];
    getAttributeNode(qualifiedName: string): null | Attr;
    getAttributeNodeNS(
        namespace: null | string,
        localName: string,
    ): null | Attr;
    getBoundingClientRect(): DOMRect;
    getClientRects(): DOMRectList;
    getElementsByClassName(classNames: string): HTMLCollectionOf<Element>;
    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]>;
    getElementsByTagName<K extends keyof HTMLElementDeprecatedTagNameMap>(
        qualifiedName: K,
    ): HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>;
    getElementsByTagName(qualifiedName: string): HTMLCollectionOf<Element>;
    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: null | string,
        localName: string,
    ): HTMLCollectionOf<Element>;
    hasAttribute(qualifiedName: string): boolean;
    hasAttributeNS(namespace: null | string, localName: string): boolean;
    hasAttributes(): boolean;
    hasPointerCapture(pointerId: number): boolean;
    insertAdjacentElement(
        where: InsertPosition,
        element: Element,
    ): null | Element;
    insertAdjacentHTML(position: InsertPosition, text: string): void;
    insertAdjacentText(where: InsertPosition, data: string): void;
    matches(selectors: string): boolean;
    releasePointerCapture(pointerId: number): void;
    removeAttribute(qualifiedName: string): void;
    removeAttributeNS(namespace: null | string, localName: string): void;
    removeAttributeNode(attr: Attr): Attr;
    requestFullscreen(options?: FullscreenOptions): Promise<void>;
    requestPointerLock(): void;
    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: null | string,
        qualifiedName: string,
        value: string,
    ): void;
    setAttributeNode(attr: Attr): null | Attr;
    setAttributeNodeNS(attr: Attr): null | Attr;
    setPointerCapture(pointerId: number): void;
    toggleAttribute(qualifiedName: string, force?: boolean): boolean;
    webkitMatchesSelector(selectors: string): boolean;
    style: CSSStyleDeclaration;
    contentEditable: string;
    enterKeyHint: string;
    inputMode: string;
    isContentEditable: boolean;
    dispatchEvent(event: Event): boolean;
    onabort: null | ((this: GlobalEventHandlers, ev: UIEvent) => any);
    onanimationcancel:
        | null
        | ((this: GlobalEventHandlers, ev: AnimationEvent) => any);
    onanimationend:
        | null
        | ((this: GlobalEventHandlers, ev: AnimationEvent) => any);
    onanimationiteration:
        | null
        | ((this: GlobalEventHandlers, ev: AnimationEvent) => any);
    onanimationstart:
        | null
        | ((this: GlobalEventHandlers, ev: AnimationEvent) => any);
    onauxclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onbeforeinput: null | ((this: GlobalEventHandlers, ev: InputEvent) => any);
    onblur: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any);
    oncancel: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oncanplay: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oncanplaythrough: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onchange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onclose: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oncontextmenu: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    oncopy: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any);
    oncuechange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oncut: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any);
    ondblclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    ondrag: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragend: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragenter: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragleave: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragover: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondragstart: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondrop: null | ((this: GlobalEventHandlers, ev: DragEvent) => any);
    ondurationchange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onemptied: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onended: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onerror: OnErrorEventHandler;
    onfocus: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any);
    onformdata: null | ((this: GlobalEventHandlers, ev: FormDataEvent) => any);
    ongotpointercapture:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    oninput: null | ((this: GlobalEventHandlers, ev: Event) => any);
    oninvalid: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onkeydown: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any);
    onkeypress: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any);
    onkeyup: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any);
    onload: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onloadeddata: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onloadedmetadata: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onloadstart: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onlostpointercapture:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onmousedown: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseenter: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseleave: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmousemove: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseout: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseover: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onmouseup: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any);
    onpaste: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any);
    onpause: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onplay: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onplaying: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onpointercancel:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerdown:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerenter:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerleave:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointermove:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerout: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerover:
        | null
        | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onpointerup: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any);
    onprogress: null | ((this: GlobalEventHandlers, ev: ProgressEvent) => any);
    onratechange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onreset: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onresize: null | ((this: GlobalEventHandlers, ev: UIEvent) => any);
    onscroll: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onsecuritypolicyviolation:
        | null
        | ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any);
    onseeked: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onseeking: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onselect: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onselectionchange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onselectstart: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onslotchange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onstalled: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onsubmit: null | ((this: GlobalEventHandlers, ev: SubmitEvent) => any);
    onsuspend: null | ((this: GlobalEventHandlers, ev: Event) => any);
    ontimeupdate: null | ((this: GlobalEventHandlers, ev: Event) => any);
    ontoggle: null | ((this: GlobalEventHandlers, ev: Event) => any);
    ontouchcancel?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any);
    ontouchend?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any);
    ontouchmove?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any);
    ontouchstart?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any);
    ontransitioncancel:
        | null
        | ((this: GlobalEventHandlers, ev: TransitionEvent) => any);
    ontransitionend:
        | null
        | ((this: GlobalEventHandlers, ev: TransitionEvent) => any);
    ontransitionrun:
        | null
        | ((this: GlobalEventHandlers, ev: TransitionEvent) => any);
    ontransitionstart:
        | null
        | ((this: GlobalEventHandlers, ev: TransitionEvent) => any);
    onvolumechange: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onwaiting: null | ((this: GlobalEventHandlers, ev: Event) => any);
    onwebkitanimationend:
        | null
        | ((this: GlobalEventHandlers, ev: Event) => any);
    onwebkitanimationiteration:
        | null
        | ((this: GlobalEventHandlers, ev: Event) => any);
    onwebkitanimationstart:
        | null
        | ((this: GlobalEventHandlers, ev: Event) => any);
    onwebkittransitionend:
        | null
        | ((this: GlobalEventHandlers, ev: Event) => any);
    onwheel: null | ((this: GlobalEventHandlers, ev: WheelEvent) => any);
    accessKey: string;
    accessKeyLabel: string;
    autocapitalize: string;
    dir: string;
    draggable: boolean;
    hidden: boolean;
    inert: boolean;
    innerText: string;
    lang: string;
    offsetHeight: number;
    offsetLeft: number;
    offsetParent: null | Element;
    offsetTop: number;
    offsetWidth: number;
    outerText: string;
    spellcheck: boolean;
    title: string;
    translate: boolean;
    attachInternals(): ElementInternals;
    click(): void;
    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;
    autofocus: boolean;
    dataset: DOMStringMap;
    nonce?: string;
    tabIndex: number;
    blur(): void;
    focus(options?: FocusOptions): void;
    innerHTML: string;
    baseURI: string;
    childNodes: NodeListOf<ChildNode>;
    firstChild: null | ChildNode;
    isConnected: boolean;
    lastChild: null | ChildNode;
    nextSibling: null | ChildNode;
    nodeName: string;
    nodeType: number;
    nodeValue: null | string;
    parentElement: null | HTMLElement;
    parentNode: null | ParentNode;
    previousSibling: null | ChildNode;
    textContent: null | string;
    appendChild<T extends Node<T>>(node: T): T;
    cloneNode(deep?: boolean): Node;
    compareDocumentPosition(other: Node): number;
    contains(other: null | Node): boolean;
    getRootNode(options?: GetRootNodeOptions): Node;
    hasChildNodes(): boolean;
    insertBefore<T extends Node<T>>(node: T, child: null | Node): T;
    isDefaultNamespace(namespace: null | string): boolean;
    isEqualNode(otherNode: null | Node): boolean;
    isSameNode(otherNode: null | Node): boolean;
    lookupNamespaceURI(prefix: null | string): null | string;
    lookupPrefix(namespace: null | string): null | string;
    normalize(): void;
    removeChild<T extends Node<T>>(child: T): T;
    replaceChild<T extends Node<T>>(node: Node, child: T): T;
    ELEMENT_NODE: 1;
    ATTRIBUTE_NODE: 2;
    TEXT_NODE: 3;
    CDATA_SECTION_NODE: 4;
    ENTITY_REFERENCE_NODE: 5;
    ENTITY_NODE: 6;
    PROCESSING_INSTRUCTION_NODE: 7;
    COMMENT_NODE: 8;
    DOCUMENT_NODE: 9;
    DOCUMENT_TYPE_NODE: 10;
    DOCUMENT_FRAGMENT_NODE: 11;
    NOTATION_NODE: 12;
    DOCUMENT_POSITION_DISCONNECTED: 1;
    DOCUMENT_POSITION_PRECEDING: 2;
    DOCUMENT_POSITION_FOLLOWING: 4;
    DOCUMENT_POSITION_CONTAINS: 8;
    DOCUMENT_POSITION_CONTAINED_BY: 16;
    DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32;
    nextElementSibling: null | Element;
    previousElementSibling: null | Element;
    childElementCount: number;
    children: HTMLCollection;
    firstElementChild: null | Element;
    lastElementChild: null | Element;
    append(...nodes: (string | Node)[]): void;
    prepend(...nodes: (string | Node)[]): void;
    querySelector<K extends keyof HTMLElementTagNameMap>(
        selectors: K,
    ): null | HTMLElementTagNameMap[K];
    querySelector<K extends keyof SVGElementTagNameMap>(
        selectors: K,
    ): null | SVGElementTagNameMap[K];
    querySelector<K extends keyof MathMLElementTagNameMap>(
        selectors: K,
    ): null | MathMLElementTagNameMap[K];
    querySelector<K extends keyof HTMLElementDeprecatedTagNameMap>(
        selectors: K,
    ): null | HTMLElementDeprecatedTagNameMap[K];
    querySelector<E extends Element<E> = Element>(selectors: string): null | E;
    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]>;
    querySelectorAll<K extends keyof HTMLElementDeprecatedTagNameMap>(
        selectors: K,
    ): NodeListOf<HTMLElementDeprecatedTagNameMap[K]>;
    querySelectorAll<E extends Element<E> = Element>(
        selectors: string,
    ): NodeListOf<E>;
    replaceChildren(...nodes: (string | Node)[]): void;
    assignedSlot: null | HTMLSlotElement;
}

Hierarchy

  • GridHTMLElement
    • GridCompHTMLElement
Index

Methods

Properties

_gridComp? +ariaAtomic +ariaAutoComplete +ariaBusy +ariaChecked +ariaColCount +ariaColIndex +ariaColSpan +ariaCurrent +ariaDisabled +ariaExpanded +ariaHasPopup +ariaHidden +ariaInvalid +ariaKeyShortcuts +ariaLabel +ariaLevel +ariaLive +ariaModal +ariaMultiLine +ariaMultiSelectable +ariaOrientation +ariaPlaceholder +ariaPosInSet +ariaPressed +ariaReadOnly +ariaRequired +ariaRoleDescription +ariaRowCount +ariaRowIndex +ariaRowSpan +ariaSelected +ariaSetSize +ariaSort +ariaValueMax +ariaValueMin +ariaValueNow +ariaValueText +role +attributes +classList +className +clientHeight +clientLeft +clientTop +clientWidth +id +localName +namespaceURI +onfullscreenchange +onfullscreenerror +outerHTML +ownerDocument +part +prefix +scrollHeight +scrollLeft +scrollTop +scrollWidth +shadowRoot +slot +tagName +style +contentEditable +enterKeyHint +inputMode +isContentEditable +onabort +onanimationcancel +onanimationend +onanimationiteration +onanimationstart +onauxclick +onbeforeinput +onblur +oncancel +oncanplay +oncanplaythrough +onchange +onclick +onclose +oncontextmenu +oncopy +oncuechange +oncut +ondblclick +ondrag +ondragend +ondragenter +ondragleave +ondragover +ondragstart +ondrop +ondurationchange +onemptied +onended +onerror +onfocus +onformdata +ongotpointercapture +oninput +oninvalid +onkeydown +onkeypress +onkeyup +onload +onloadeddata +onloadedmetadata +onloadstart +onlostpointercapture +onmousedown +onmouseenter +onmouseleave +onmousemove +onmouseout +onmouseover +onmouseup +onpaste +onpause +onplay +onplaying +onpointercancel +onpointerdown +onpointerenter +onpointerleave +onpointermove +onpointerout +onpointerover +onpointerup +onprogress +onratechange +onreset +onresize +onscroll +onsecuritypolicyviolation +onseeked +onseeking +onselect +onselectionchange +onselectstart +onslotchange +onstalled +onsubmit +onsuspend +ontimeupdate +ontoggle +ontouchcancel? +ontouchend? +ontouchmove? +ontouchstart? +ontransitioncancel +ontransitionend +ontransitionrun +ontransitionstart +onvolumechange +onwaiting +onwebkitanimationend +onwebkitanimationiteration +onwebkitanimationstart +onwebkittransitionend +onwheel +accessKey +accessKeyLabel +autocapitalize +dir +draggable +hidden +inert +innerText +lang +offsetHeight +offsetLeft +offsetParent +offsetTop +offsetWidth +outerText +spellcheck +title +translate +autofocus +dataset +nonce? +tabIndex +innerHTML +baseURI +childNodes +firstChild +isConnected +lastChild +nextSibling +nodeName +nodeType +nodeValue +parentElement +parentNode +previousSibling +textContent +ELEMENT_NODE +ATTRIBUTE_NODE +TEXT_NODE +CDATA_SECTION_NODE +ENTITY_REFERENCE_NODE +ENTITY_NODE +PROCESSING_INSTRUCTION_NODE +COMMENT_NODE +DOCUMENT_NODE +DOCUMENT_TYPE_NODE +DOCUMENT_FRAGMENT_NODE +NOTATION_NODE +DOCUMENT_POSITION_DISCONNECTED +DOCUMENT_POSITION_PRECEDING +DOCUMENT_POSITION_FOLLOWING +DOCUMENT_POSITION_CONTAINS +DOCUMENT_POSITION_CONTAINED_BY +DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC +nextElementSibling +previousElementSibling +childElementCount +children +firstElementChild +lastElementChild +assignedSlot +

Methods

  • Parameters

    • keyframes: null | Keyframe[] | PropertyIndexedKeyframes
    • Optionaloptions: number | KeyframeAnimationOptions

    Returns Animation

  • Parameters

    • Optionaloptions: GetAnimationsOptions

    Returns Animation[]

  • Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes.

    +

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    +

    Parameters

    • ...nodes: (string | Node)[]

    Returns void

  • Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes.

    +

    Throws a "HierarchyRequestError" DOMException if the constraints of the node tree are violated.

    +

    Parameters

    • ...nodes: (string | Node)[]

    Returns void

  • Removes node.

    +

    Returns void

  • Replaces 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.

    +

    Parameters

    • ...nodes: (string | Node)[]

    Returns void

  • Creates a shadow root for element and returns it.

    +

    Parameters

    • init: ShadowRootInit

    Returns ShadowRoot

  • Parameters

    • Optionaloptions: CheckVisibilityOptions

    Returns boolean

  • Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise.

    +

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selector: K

    Returns null | HTMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selector: K

    Returns null | SVGElementTagNameMap[K]

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selector: K

    Returns null | MathMLElementTagNameMap[K]

  • Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns null | E

  • Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise.

    +

    Parameters

    • qualifiedName: string

    Returns null | string

  • Returns element's attribute whose namespace is namespace and local name is localName, and null if there is no such attribute otherwise.

    +

    Parameters

    • namespace: null | string
    • localName: string

    Returns null | string

  • Returns the qualified names of all element's attributes. Can contain duplicates.

    +

    Returns string[]

  • Parameters

    • qualifiedName: string

    Returns null | Attr

  • Parameters

    • namespace: null | string
    • localName: string

    Returns null | Attr

  • Returns DOMRect

  • Returns 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.

    +

    Parameters

    • classNames: string

    Returns HTMLCollectionOf<Element>

  • Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<SVGElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<MathMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • qualifiedName: K

    Returns HTMLCollectionOf<HTMLElementDeprecatedTagNameMap[K]>

  • Parameters

    • qualifiedName: string

    Returns HTMLCollectionOf<Element>

  • Parameters

    • namespaceURI: "http://www.w3.org/1999/xhtml"
    • localName: string

    Returns HTMLCollectionOf<HTMLElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/2000/svg"
    • localName: string

    Returns HTMLCollectionOf<SVGElement>

  • Parameters

    • namespaceURI: "http://www.w3.org/1998/Math/MathML"
    • localName: string

    Returns HTMLCollectionOf<MathMLElement>

  • Parameters

    • namespace: null | string
    • localName: string

    Returns HTMLCollectionOf<Element>

  • Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise.

    +

    Parameters

    • qualifiedName: string

    Returns boolean

  • Returns true if element has an attribute whose namespace is namespace and local name is localName.

    +

    Parameters

    • namespace: null | string
    • localName: string

    Returns boolean

  • Returns true if element has attributes, and false otherwise.

    +

    Returns boolean

  • Parameters

    • pointerId: number

    Returns boolean

  • Parameters

    • where: InsertPosition
    • element: Element

    Returns null | Element

  • Parameters

    • position: InsertPosition
    • text: string

    Returns void

  • Parameters

    • where: InsertPosition
    • data: string

    Returns void

  • Returns true if matching selectors against element's root yields element, and false otherwise.

    +

    Parameters

    • selectors: string

    Returns boolean

  • Parameters

    • pointerId: number

    Returns void

  • Removes element's first attribute whose qualified name is qualifiedName.

    +

    Parameters

    • qualifiedName: string

    Returns void

  • Removes element's attribute whose namespace is namespace and local name is localName.

    +

    Parameters

    • namespace: null | string
    • localName: string

    Returns void

  • Parameters

    • attr: Attr

    Returns 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.

    +

    Parameters

    • Optionaloptions: FullscreenOptions

    Returns Promise<void>

  • Returns void

  • Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Parameters

    • Optionalarg: boolean | ScrollIntoViewOptions

    Returns void

  • Parameters

    • Optionaloptions: ScrollToOptions

    Returns void

  • Parameters

    • x: number
    • y: number

    Returns void

  • Sets the value of element's first attribute whose qualified name is qualifiedName to value.

    +

    Parameters

    • qualifiedName: string
    • value: string

    Returns void

  • Sets the value of element's attribute whose namespace is namespace and local name is localName to value.

    +

    Parameters

    • namespace: null | string
    • qualifiedName: string
    • value: string

    Returns void

  • Parameters

    • attr: Attr

    Returns null | Attr

  • Parameters

    • attr: Attr

    Returns null | Attr

  • Parameters

    • pointerId: number

    Returns 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.

    +

    Parameters

    • qualifiedName: string
    • Optionalforce: boolean

    Returns boolean

  • Parameters

    • selectors: string

    Returns boolean

    This is a legacy alias of matches.

    +
  • 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.

    +

    Parameters

    • event: Event

    Returns boolean

  • Returns ElementInternals

  • Returns void

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
    • Optionaloptions: boolean | AddEventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optionaloptions: boolean | AddEventListenerOptions

    Returns void

  • Type Parameters

    • K extends keyof HTMLElementEventMap

    Parameters

    • type: K
    • listener: (this: HTMLElement, ev: HTMLElementEventMap[K]) => any
    • Optionaloptions: boolean | EventListenerOptions

    Returns void

  • Parameters

    • type: string
    • listener: EventListenerOrEventListenerObject
    • Optionaloptions: boolean | EventListenerOptions

    Returns void

  • Returns void

  • Parameters

    • Optionaloptions: FocusOptions

    Returns void

  • Type Parameters

    • T extends Node<T>

    Parameters

    • node: T

    Returns T

  • Returns a copy of node. If deep is true, the copy also includes the node's descendants.

    +

    Parameters

    • Optionaldeep: boolean

    Returns Node

  • Returns a bitmask indicating the position of other relative to node.

    +

    Parameters

    • other: Node

    Returns number

  • Returns true if other is an inclusive descendant of node, and false otherwise.

    +

    Parameters

    • other: null | Node

    Returns boolean

  • Returns node's root.

    +

    Parameters

    • Optionaloptions: GetRootNodeOptions

    Returns Node

  • Returns whether node has children.

    +

    Returns boolean

  • Type Parameters

    • T extends Node<T>

    Parameters

    • node: T
    • child: null | Node

    Returns T

  • Parameters

    • namespace: null | string

    Returns boolean

  • Returns whether node and otherNode have the same properties.

    +

    Parameters

    • otherNode: null | Node

    Returns boolean

  • Parameters

    • otherNode: null | Node

    Returns boolean

  • Parameters

    • prefix: null | string

    Returns null | string

  • Parameters

    • namespace: null | string

    Returns null | string

  • Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes.

    +

    Returns void

  • Type Parameters

    • T extends Node<T>

    Parameters

    • child: T

    Returns T

  • Type Parameters

    • T extends Node<T>

    Parameters

    • node: Node
    • child: T

    Returns T

  • 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.

    +

    Parameters

    • ...nodes: (string | Node)[]

    Returns 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.

    +

    Parameters

    • ...nodes: (string | Node)[]

    Returns void

  • Returns the first element that is a descendant of node that matches selectors.

    +

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns null | HTMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns null | SVGElementTagNameMap[K]

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selectors: K

    Returns null | MathMLElementTagNameMap[K]

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • selectors: K

    Returns null | HTMLElementDeprecatedTagNameMap[K]

  • Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns null | E

  • Returns all element descendants of node that match selectors.

    +

    Type Parameters

    • K extends keyof HTMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof SVGElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<SVGElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof MathMLElementTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<MathMLElementTagNameMap[K]>

  • Type Parameters

    • K extends keyof HTMLElementDeprecatedTagNameMap

    Parameters

    • selectors: K

    Returns NodeListOf<HTMLElementDeprecatedTagNameMap[K]>

  • Type Parameters

    • E extends Element<E> = Element

    Parameters

    • selectors: string

    Returns 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.

    +

    Parameters

    • ...nodes: (string | Node)[]

    Returns void

Properties

_gridComp?: GridstackComponent

Back-reference to the Angular GridStack component

+
ariaAtomic: null | string
ariaAutoComplete: null | string
ariaBusy: null | string
ariaChecked: null | string
ariaColCount: null | string
ariaColIndex: null | string
ariaColSpan: null | string
ariaCurrent: null | string
ariaDisabled: null | string
ariaExpanded: null | string
ariaHasPopup: null | string
ariaHidden: null | string
ariaInvalid: null | string
ariaKeyShortcuts: null | string
ariaLabel: null | string
ariaLevel: null | string
ariaLive: null | string
ariaModal: null | string
ariaMultiLine: null | string
ariaMultiSelectable: null | string
ariaOrientation: null | string
ariaPlaceholder: null | string
ariaPosInSet: null | string
ariaPressed: null | string
ariaReadOnly: null | string
ariaRequired: null | string
ariaRoleDescription: null | string
ariaRowCount: null | string
ariaRowIndex: null | string
ariaRowSpan: null | string
ariaSelected: null | string
ariaSetSize: null | string
ariaSort: null | string
ariaValueMax: null | string
ariaValueMin: null | string
ariaValueNow: null | string
ariaValueText: null | string
role: null | string
attributes: NamedNodeMap
classList: DOMTokenList

Allows for manipulation of element's class content attribute as a set of whitespace-separated tokens through a DOMTokenList object.

+
className: string

Returns the value of element's class content attribute. Can be set to change it.

+
clientHeight: number
clientLeft: number
clientTop: number
clientWidth: number
id: string

Returns the value of element's id content attribute. Can be set to change it.

+
localName: string

Returns the local name.

+
namespaceURI: null | string

Returns the namespace.

+
onfullscreenchange: null | ((this: Element, ev: Event) => any)
onfullscreenerror: null | ((this: Element, ev: Event) => any)
outerHTML: string
ownerDocument: Document

Returns the node document. Returns null for documents.

+
part: DOMTokenList
prefix: null | string

Returns the namespace prefix.

+
scrollHeight: number
scrollLeft: number
scrollTop: number
scrollWidth: number
shadowRoot: null | ShadowRoot

Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise.

+
slot: string

Returns the value of element's slot content attribute. Can be set to change it.

+
tagName: string

Returns the HTML-uppercased qualified name.

+
style: CSSStyleDeclaration
contentEditable: string
enterKeyHint: string
inputMode: string
isContentEditable: boolean
onabort: null | ((this: GlobalEventHandlers, ev: UIEvent) => any)

Fires when the user aborts the download.

+

The event.

+
onanimationcancel:
    | null
    | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
onanimationend: null | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
onanimationiteration:
    | null
    | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
onanimationstart:
    | null
    | ((this: GlobalEventHandlers, ev: AnimationEvent) => any)
onauxclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)
onbeforeinput: null | ((this: GlobalEventHandlers, ev: InputEvent) => any)
onblur: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any)

Fires when the object loses the input focus.

+

The focus event.

+
oncancel: null | ((this: GlobalEventHandlers, ev: Event) => any)
oncanplay: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when playback is possible, but would require further buffering.

+

The event.

+
oncanplaythrough: null | ((this: GlobalEventHandlers, ev: Event) => any)
onchange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the contents of the object or selection have changed.

+

The event.

+
onclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user clicks the left mouse button on the object

+

The mouse event.

+
onclose: null | ((this: GlobalEventHandlers, ev: Event) => any)
oncontextmenu: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user clicks the right mouse button in the client area, opening the context menu.

+

The mouse event.

+
oncopy: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)
oncuechange: null | ((this: GlobalEventHandlers, ev: Event) => any)
oncut: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)
ondblclick: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user double-clicks the object.

+

The mouse event.

+
ondrag: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the source object continuously during a drag operation.

+

The event.

+
ondragend: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the source object when the user releases the mouse at the close of a drag operation.

+

The event.

+
ondragenter: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the target element when the user drags the object to a valid drop target.

+

The drag event.

+
ondragleave: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

+

The drag event.

+
ondragover: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the target element continuously while the user drags the object over a valid drop target.

+

The event.

+
ondragstart: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)

Fires on the source object when the user starts to drag a text selection or selected object.

+

The event.

+
ondrop: null | ((this: GlobalEventHandlers, ev: DragEvent) => any)
ondurationchange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the duration attribute is updated.

+

The event.

+
onemptied: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the media element is reset to its initial state.

+

The event.

+
onended: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the end of playback is reached.

+

The event

+
onerror: OnErrorEventHandler

Fires when an error occurs during object loading.

+

The event.

+
onfocus: null | ((this: GlobalEventHandlers, ev: FocusEvent) => any)

Fires when the object receives focus.

+

The event.

+
onformdata: null | ((this: GlobalEventHandlers, ev: FormDataEvent) => any)
ongotpointercapture:
    | null
    | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
oninput: null | ((this: GlobalEventHandlers, ev: Event) => any)
oninvalid: null | ((this: GlobalEventHandlers, ev: Event) => any)
onkeydown: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

Fires when the user presses a key.

+

The keyboard event

+
onkeypress: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

Fires when the user presses an alphanumeric key.

+

The event.

+
onkeyup: null | ((this: GlobalEventHandlers, ev: KeyboardEvent) => any)

Fires when the user releases a key.

+

The keyboard event

+
onload: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires immediately after the browser loads the object.

+

The event.

+
onloadeddata: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when media data is loaded at the current playback position.

+

The event.

+
onloadedmetadata: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the duration and dimensions of the media have been determined.

+

The event.

+
onloadstart: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when Internet Explorer begins looking for media data.

+

The event.

+
onlostpointercapture:
    | null
    | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onmousedown: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user clicks the object with either mouse button.

+

The mouse event.

+
onmouseenter: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)
onmouseleave: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)
onmousemove: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user moves the mouse over the object.

+

The mouse event.

+
onmouseout: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user moves the mouse pointer outside the boundaries of the object.

+

The mouse event.

+
onmouseover: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user moves the mouse pointer into the object.

+

The mouse event.

+
onmouseup: null | ((this: GlobalEventHandlers, ev: MouseEvent) => any)

Fires when the user releases a mouse button while the mouse is over the object.

+

The mouse event.

+
onpaste: null | ((this: GlobalEventHandlers, ev: ClipboardEvent) => any)
onpause: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when playback is paused.

+

The event.

+
onplay: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the play method is requested.

+

The event.

+
onplaying: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the audio or video has started playing.

+

The event.

+
onpointercancel: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerdown: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerenter: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerleave: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointermove: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerout: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerover: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onpointerup: null | ((this: GlobalEventHandlers, ev: PointerEvent) => any)
onprogress: null | ((this: GlobalEventHandlers, ev: ProgressEvent) => any)

Occurs to indicate progress while downloading media data.

+

The event.

+
onratechange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the playback rate is increased or decreased.

+

The event.

+
onreset: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the user resets a form.

+

The event.

+
onresize: null | ((this: GlobalEventHandlers, ev: UIEvent) => any)
onscroll: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the user repositions the scroll box in the scroll bar on the object.

+

The event.

+
onsecuritypolicyviolation:
    | null
    | ((this: GlobalEventHandlers, ev: SecurityPolicyViolationEvent) => any)
onseeked: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the seek operation ends.

+

The event.

+
onseeking: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the current playback position is moved.

+

The event.

+
onselect: null | ((this: GlobalEventHandlers, ev: Event) => any)

Fires when the current selection changes.

+

The event.

+
onselectionchange: null | ((this: GlobalEventHandlers, ev: Event) => any)
onselectstart: null | ((this: GlobalEventHandlers, ev: Event) => any)
onslotchange: null | ((this: GlobalEventHandlers, ev: Event) => any)
onstalled: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the download has stopped.

+

The event.

+
onsubmit: null | ((this: GlobalEventHandlers, ev: SubmitEvent) => any)
onsuspend: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs if the load operation has been intentionally halted.

+

The event.

+
ontimeupdate: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs to indicate the current playback position.

+

The event.

+
ontoggle: null | ((this: GlobalEventHandlers, ev: Event) => any)
ontouchcancel?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
ontouchend?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
ontouchmove?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
ontouchstart?: null | ((this: GlobalEventHandlers, ev: TouchEvent) => any)
ontransitioncancel:
    | null
    | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
ontransitionend:
    | null
    | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
ontransitionrun:
    | null
    | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
ontransitionstart:
    | null
    | ((this: GlobalEventHandlers, ev: TransitionEvent) => any)
onvolumechange: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when the volume is changed, or playback is muted or unmuted.

+

The event.

+
onwaiting: null | ((this: GlobalEventHandlers, ev: Event) => any)

Occurs when playback stops because the next frame of a video resource is not available.

+

The event.

+
onwebkitanimationend: null | ((this: GlobalEventHandlers, ev: Event) => any)

This is a legacy alias of onanimationend.

+
onwebkitanimationiteration:
    | null
    | ((this: GlobalEventHandlers, ev: Event) => any)

This is a legacy alias of onanimationiteration.

+
onwebkitanimationstart: null | ((this: GlobalEventHandlers, ev: Event) => any)

This is a legacy alias of onanimationstart.

+
onwebkittransitionend: null | ((this: GlobalEventHandlers, ev: Event) => any)

This is a legacy alias of ontransitionend.

+
onwheel: null | ((this: GlobalEventHandlers, ev: WheelEvent) => any)
accessKey: string
accessKeyLabel: string
autocapitalize: string
dir: string
draggable: boolean
hidden: boolean
inert: boolean
innerText: string
lang: string
offsetHeight: number
offsetLeft: number
offsetParent: null | Element
offsetTop: number
offsetWidth: number
outerText: string
spellcheck: boolean
title: string
translate: boolean
autofocus: boolean
dataset: DOMStringMap
nonce?: string
tabIndex: number
innerHTML: string
baseURI: string

Returns node's node document's document base URL.

+
childNodes: NodeListOf<ChildNode>

Returns the children.

+
firstChild: null | ChildNode

Returns the first child.

+
isConnected: boolean

Returns true if node is connected and false otherwise.

+
lastChild: null | ChildNode

Returns the last child.

+
nextSibling: null | ChildNode

Returns the next sibling.

+
nodeName: string

Returns a string appropriate for the type of node.

+
nodeType: number

Returns the type of node.

+
nodeValue: null | string
parentElement: null | HTMLElement

Returns the parent element.

+
parentNode: null | ParentNode

Returns the parent.

+
previousSibling: null | ChildNode

Returns the previous sibling.

+
textContent: null | string
ELEMENT_NODE: 1

node is an element.

+
ATTRIBUTE_NODE: 2
TEXT_NODE: 3

node is a Text node.

+
CDATA_SECTION_NODE: 4

node is a CDATASection node.

+
ENTITY_REFERENCE_NODE: 5
ENTITY_NODE: 6
PROCESSING_INSTRUCTION_NODE: 7

node is a ProcessingInstruction node.

+
COMMENT_NODE: 8

node is a Comment node.

+
DOCUMENT_NODE: 9

node is a document.

+
DOCUMENT_TYPE_NODE: 10

node is a doctype.

+
DOCUMENT_FRAGMENT_NODE: 11

node is a DocumentFragment node.

+
NOTATION_NODE: 12
DOCUMENT_POSITION_DISCONNECTED: 1

Set when node and other are not in the same tree.

+
DOCUMENT_POSITION_PRECEDING: 2

Set when other is preceding node.

+
DOCUMENT_POSITION_FOLLOWING: 4

Set when other is following node.

+
DOCUMENT_POSITION_CONTAINS: 8

Set when other is an ancestor of node.

+
DOCUMENT_POSITION_CONTAINED_BY: 16

Set when other is a descendant of node.

+
DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC: 32
nextElementSibling: null | Element

Returns the first following sibling that is an element, and null otherwise.

+
previousElementSibling: null | Element

Returns the first preceding sibling that is an element, and null otherwise.

+
childElementCount: number
children: HTMLCollection

Returns the child elements.

+
firstElementChild: null | Element

Returns the first child that is an element, and null otherwise.

+
lastElementChild: null | Element

Returns the last child that is an element, and null otherwise.

+
assignedSlot: null | HTMLSlotElement
diff --git a/angular/docs/html/interfaces/types.NgGridStackNode.html b/angular/docs/html/interfaces/types.NgGridStackNode.html new file mode 100644 index 000000000..df2c573b1 --- /dev/null +++ b/angular/docs/html/interfaces/types.NgGridStackNode.html @@ -0,0 +1,5 @@ +NgGridStackNode | GridStack Angular Library - v12.2.2-dev

Interface NgGridStackNode

Extended GridStackNode interface for Angular integration. +Adds component selector for dynamic content creation.

+
interface NgGridStackNode {
    selector?: string;
}

Hierarchy

  • GridStackNode
    • NgGridStackNode
Index

Properties

Properties

selector?: string

Angular component selector for this node's content

+
diff --git a/angular/docs/html/interfaces/types.NgGridStackOptions.html b/angular/docs/html/interfaces/types.NgGridStackOptions.html new file mode 100644 index 000000000..29197e841 --- /dev/null +++ b/angular/docs/html/interfaces/types.NgGridStackOptions.html @@ -0,0 +1,7 @@ +NgGridStackOptions | GridStack Angular Library - v12.2.2-dev

Interface NgGridStackOptions

Extended GridStackOptions interface for Angular integration. +Supports Angular-specific widget definitions and nested grids.

+
interface NgGridStackOptions {
    children?: NgGridStackWidget[];
    subGridOpts?: NgGridStackOptions;
}

Hierarchy

  • GridStackOptions
    • NgGridStackOptions
Index

Properties

Properties

children?: NgGridStackWidget[]

Array of Angular widget definitions for initial grid setup

+
subGridOpts?: NgGridStackOptions

Configuration for nested sub-grids (Angular-aware)

+
diff --git a/angular/docs/html/interfaces/types.NgGridStackWidget.html b/angular/docs/html/interfaces/types.NgGridStackWidget.html new file mode 100644 index 000000000..e2eed67f0 --- /dev/null +++ b/angular/docs/html/interfaces/types.NgGridStackWidget.html @@ -0,0 +1,9 @@ +NgGridStackWidget | GridStack Angular Library - v12.2.2-dev

Interface NgGridStackWidget

Extended GridStackWidget interface for Angular integration. +Adds Angular-specific properties for dynamic component creation.

+
interface NgGridStackWidget {
    selector?: string;
    input?: NgCompInputs;
    subGridOpts?: NgGridStackOptions;
}

Hierarchy

  • GridStackWidget
    • NgGridStackWidget
Index

Properties

selector?: string

Angular component selector for dynamic creation (e.g., 'my-widget')

+
input?: NgCompInputs

Serialized data for component @Input() properties

+
subGridOpts?: NgGridStackOptions

Configuration for nested sub-grids

+
diff --git a/angular/docs/html/modules.html b/angular/docs/html/modules.html new file mode 100644 index 000000000..d3e9846d0 --- /dev/null +++ b/angular/docs/html/modules.html @@ -0,0 +1 @@ +GridStack Angular Library - v12.2.2-dev
diff --git a/angular/docs/html/modules/base-widget.html b/angular/docs/html/modules/base-widget.html new file mode 100644 index 000000000..48717779c --- /dev/null +++ b/angular/docs/html/modules/base-widget.html @@ -0,0 +1 @@ +base-widget | GridStack Angular Library - v12.2.2-dev

Module base-widget

Classes

BaseWidget
diff --git a/angular/docs/html/modules/gridstack-item.component.html b/angular/docs/html/modules/gridstack-item.component.html new file mode 100644 index 000000000..004720990 --- /dev/null +++ b/angular/docs/html/modules/gridstack-item.component.html @@ -0,0 +1 @@ +gridstack-item.component | GridStack Angular Library - v12.2.2-dev

Module gridstack-item.component

Classes

GridstackItemComponent

Interfaces

GridItemCompHTMLElement
diff --git a/angular/docs/html/modules/gridstack.component.html b/angular/docs/html/modules/gridstack.component.html new file mode 100644 index 000000000..f15916a6b --- /dev/null +++ b/angular/docs/html/modules/gridstack.component.html @@ -0,0 +1 @@ +gridstack.component | GridStack Angular Library - v12.2.2-dev
diff --git a/angular/docs/html/modules/gridstack.module.html b/angular/docs/html/modules/gridstack.module.html new file mode 100644 index 000000000..6620e9f60 --- /dev/null +++ b/angular/docs/html/modules/gridstack.module.html @@ -0,0 +1 @@ +gridstack.module | GridStack Angular Library - v12.2.2-dev

Module gridstack.module

Classes

GridstackModule
diff --git a/angular/docs/html/modules/types.html b/angular/docs/html/modules/types.html new file mode 100644 index 000000000..c289e585f --- /dev/null +++ b/angular/docs/html/modules/types.html @@ -0,0 +1 @@ +types | GridStack Angular Library - v12.2.2-dev
diff --git a/angular/docs/html/sitemap.xml b/angular/docs/html/sitemap.xml new file mode 100644 index 000000000..eb8333d44 --- /dev/null +++ b/angular/docs/html/sitemap.xml @@ -0,0 +1,107 @@ + + + + https://gridstack.github.io/gridstack.js/angular/index.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/modules.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/hierarchy.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/modules/gridstack.component.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/types/gridstack.component.eventCB.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/types/gridstack.component.elementCB.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/types/gridstack.component.nodesCB.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/types/gridstack.component.droppedCB.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/interfaces/gridstack.component.GridCompHTMLElement.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/types/gridstack.component.SelectorToType.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/classes/gridstack.component.GridstackComponent.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/functions/gridstack.component.gsCreateNgComponents.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/functions/gridstack.component.gsSaveAdditionalNgInfo.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/functions/gridstack.component.gsUpdateNgComponents.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/modules/gridstack-item.component.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/interfaces/gridstack-item.component.GridItemCompHTMLElement.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/classes/gridstack-item.component.GridstackItemComponent.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/modules/gridstack.module.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/classes/gridstack.module.GridstackModule.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/modules/base-widget.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/classes/base-widget.BaseWidget.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/modules/types.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/interfaces/types.NgGridStackWidget.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/interfaces/types.NgGridStackNode.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/interfaces/types.NgGridStackOptions.html + 2025-08-10T06:38:33.420Z + + + https://gridstack.github.io/gridstack.js/angular/types/types.NgCompInputs.html + 2025-08-10T06:38:33.420Z + + diff --git a/angular/docs/html/types/gridstack.component.SelectorToType.html b/angular/docs/html/types/gridstack.component.SelectorToType.html new file mode 100644 index 000000000..9c3cc3f9b --- /dev/null +++ b/angular/docs/html/types/gridstack.component.SelectorToType.html @@ -0,0 +1,3 @@ +SelectorToType | GridStack Angular Library - v12.2.2-dev

Type Alias SelectorToType

SelectorToType: { [key: string]: Type<Object> }

Mapping of selector strings to Angular component types. +Used for dynamic component creation based on widget selectors.

+

Type declaration

  • [key: string]: Type<Object>
diff --git a/angular/docs/html/types/gridstack.component.droppedCB.html b/angular/docs/html/types/gridstack.component.droppedCB.html new file mode 100644 index 000000000..20ede3a3c --- /dev/null +++ b/angular/docs/html/types/gridstack.component.droppedCB.html @@ -0,0 +1,5 @@ +droppedCB | GridStack Angular Library - v12.2.2-dev

Type Alias droppedCB

Callback for drop events with before/after node state

+
type droppedCB = {
    event: Event;
    previousNode: GridStackNode;
    newNode: GridStackNode;
}
Index

Properties

Properties

event: Event
previousNode: GridStackNode
newNode: GridStackNode
diff --git a/angular/docs/html/types/gridstack.component.elementCB.html b/angular/docs/html/types/gridstack.component.elementCB.html new file mode 100644 index 000000000..bd55a8ad4 --- /dev/null +++ b/angular/docs/html/types/gridstack.component.elementCB.html @@ -0,0 +1,4 @@ +elementCB | GridStack Angular Library - v12.2.2-dev

Type Alias elementCB

Callback for element-specific events (resize, drag, etc.)

+
type elementCB = {
    event: Event;
    el: GridItemHTMLElement;
}
Index

Properties

Properties

event: Event
el: GridItemHTMLElement
diff --git a/angular/docs/html/types/gridstack.component.eventCB.html b/angular/docs/html/types/gridstack.component.eventCB.html new file mode 100644 index 000000000..4457659b6 --- /dev/null +++ b/angular/docs/html/types/gridstack.component.eventCB.html @@ -0,0 +1,3 @@ +eventCB | GridStack Angular Library - v12.2.2-dev

Type Alias eventCB

Callback for general events (enable, disable, etc.)

+
type eventCB = {
    event: Event;
}
Index

Properties

Properties

event: Event
diff --git a/angular/docs/html/types/gridstack.component.nodesCB.html b/angular/docs/html/types/gridstack.component.nodesCB.html new file mode 100644 index 000000000..78e399a34 --- /dev/null +++ b/angular/docs/html/types/gridstack.component.nodesCB.html @@ -0,0 +1,4 @@ +nodesCB | GridStack Angular Library - v12.2.2-dev

Type Alias nodesCB

Callback for events affecting multiple nodes (change, etc.)

+
type nodesCB = {
    event: Event;
    nodes: GridStackNode[];
}
Index

Properties

Properties

event: Event
nodes: GridStackNode[]
diff --git a/angular/docs/html/types/types.NgCompInputs.html b/angular/docs/html/types/types.NgCompInputs.html new file mode 100644 index 000000000..34d348bac --- /dev/null +++ b/angular/docs/html/types/types.NgCompInputs.html @@ -0,0 +1,6 @@ +NgCompInputs | GridStack Angular Library - v12.2.2-dev

Type Alias NgCompInputs

NgCompInputs: { [key: string]: any }

Type for component input data serialization. +Maps @Input() property names to their values for widget persistence.

+

Type declaration

  • [key: string]: any
const inputs: NgCompInputs = {
title: 'My Widget',
value: 42,
config: { enabled: true }
}; +
+ +
diff --git a/angular/package.json b/angular/package.json index b02cf50b7..9e243506f 100644 --- a/angular/package.json +++ b/angular/package.json @@ -6,7 +6,10 @@ "start": "ng serve", "build": "ng build", "watch": "ng build --watch --configuration development", - "test": "ng test" + "test": "ng test", + "doc": "npx typedoc --options typedoc.json && npx typedoc --options typedoc.html.json", + "doc:api": "npx typedoc --options typedoc.json", + "doc:html": "npx typedoc --options typedoc.html.json" }, "private": true, "dependencies": { diff --git a/angular/projects/lib/package.json b/angular/projects/lib/package.json index bef129c20..b54902d6a 100644 --- a/angular/projects/lib/package.json +++ b/angular/projects/lib/package.json @@ -1,6 +1,6 @@ { "name": "gridstack-angular", - "version": "11.1.0", + "version": "12.2.2-dev", "peerDependencies": { "@angular/common": ">=14", "@angular/core": ">=14" diff --git a/angular/tsconfig.doc.json b/angular/tsconfig.doc.json new file mode 100644 index 000000000..1d9998d06 --- /dev/null +++ b/angular/tsconfig.doc.json @@ -0,0 +1,17 @@ +{ + "extends": "./tsconfig.json", + "compilerOptions": { + "declaration": true, + "emitDeclarationOnly": true, + "skipLibCheck": true + }, + "include": [ + "projects/lib/src/lib/**/*.ts" + ], + "exclude": [ + "projects/demo/**/*", + "**/*.spec.ts", + "**/*.test.ts", + "node_modules/**" + ] +} diff --git a/angular/typedoc.html.json b/angular/typedoc.html.json new file mode 100644 index 000000000..5caec2359 --- /dev/null +++ b/angular/typedoc.html.json @@ -0,0 +1,79 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "entryPoints": [ + "projects/lib/src/lib/gridstack.component.ts", + "projects/lib/src/lib/gridstack-item.component.ts", + "projects/lib/src/lib/gridstack.module.ts", + "projects/lib/src/lib/base-widget.ts", + "projects/lib/src/lib/types.ts" + ], + "tsconfig": "tsconfig.doc.json", + "excludeExternals": false, + "out": "docs/html", + "exclude": [ + "**/*.spec.ts", + "**/*.test.ts", + "**/spec/**", + "**/test/**", + "**/demo/**", + "projects/demo/**", + "**/app.component.ts", + "**/simple.ts", + "**/ngFor.ts", + "**/ngFor_cmd.ts", + "**/dummy.component.ts", + "node_modules/**" + ], + "excludePrivate": true, + "excludeProtected": false, + "excludeInternal": true, + "includeVersion": true, + "sort": ["source-order"], + "sortEntryPoints": false, + "kindSortOrder": [ + "Class", + "Interface", + "TypeAlias", + "Variable", + "Function" + ], + "groupOrder": [ + "Modules", + "Components", + "Classes", + "Interfaces", + "Type aliases", + "Variables", + "Functions" + ], + "categorizeByGroup": true, + "defaultCategory": "Other", + "categoryOrder": [ + "Main", + "Components", + "Angular Integration", + "Types", + "Utilities", + "*" + ], + "readme": "README.md", + "theme": "default", + "hideGenerator": false, + "searchInComments": true, + "searchInDocuments": true, + "cleanOutputDir": true, + "titleLink": "https://gridstackjs.com/", + "navigationLinks": { + "GitHub": "https://github.com/gridstack/gridstack.js", + "Demo": "https://gridstackjs.com/demo/", + "Main Library": "../../../docs/html/" + }, + "sidebarLinks": { + "Documentation": "https://github.com/gridstack/gridstack.js/tree/master/doc", + "Angular Guide": "README.md" + }, + "hostedBaseUrl": "https://gridstack.github.io/gridstack.js/angular/", + "gitRevision": "master", + "gitRemote": "origin", + "name": "GridStack Angular Library" +} diff --git a/angular/typedoc.json b/angular/typedoc.json new file mode 100644 index 000000000..6383463ca --- /dev/null +++ b/angular/typedoc.json @@ -0,0 +1,89 @@ +{ + "$schema": "https://typedoc.org/schema.json", + "entryPoints": [ + "projects/lib/src/lib/gridstack.component.ts", + "projects/lib/src/lib/gridstack-item.component.ts", + "projects/lib/src/lib/gridstack.module.ts", + "projects/lib/src/lib/base-widget.ts", + "projects/lib/src/lib/types.ts" + ], + "tsconfig": "tsconfig.doc.json", + "excludeExternals": false, + "out": "docs/api", + "plugin": ["typedoc-plugin-markdown"], + "theme": "markdown", + "exclude": [ + "**/*.spec.ts", + "**/*.test.ts", + "**/spec/**", + "**/test/**", + "**/demo/**", + "projects/demo/**", + "**/app.component.ts", + "**/simple.ts", + "**/ngFor.ts", + "**/ngFor_cmd.ts", + "**/dummy.component.ts", + "node_modules/**" + ], + "excludePrivate": true, + "excludeProtected": false, + "excludeInternal": true, + "includeVersion": true, + "sort": ["source-order"], + "sortEntryPoints": false, + "kindSortOrder": [ + "Class", + "Interface", + "TypeAlias", + "Variable", + "Function" + ], + "groupOrder": [ + "Modules", + "Components", + "Classes", + "Interfaces", + "Type aliases", + "Variables", + "Functions" + ], + "categorizeByGroup": true, + "defaultCategory": "Other", + "categoryOrder": [ + "Main", + "Components", + "Angular Integration", + "Types", + "Utilities", + "*" + ], + "readme": "none", + "hidePageHeader": true, + "hideBreadcrumbs": true, + "hidePageTitle": false, + "disableSources": false, + "useCodeBlocks": true, + "indexFormat": "table", + "parametersFormat": "table", + "interfacePropertiesFormat": "table", + "classPropertiesFormat": "table", + "enumMembersFormat": "table", + "typeDeclarationFormat": "table", + "propertyMembersFormat": "table", + "expandObjects": false, + "expandParameters": false, + "blockTagsPreserveOrder": [ + "@param", + "@returns", + "@throws" + ], + "outputFileStrategy": "modules", + "mergeReadme": false, + "entryFileName": "index", + "cleanOutputDir": true, + "excludeReferences": true, + "gitRevision": "master", + "gitRemote": "origin", + "name": "GridStack Angular Library" +} diff --git a/docs/html/sitemap.xml b/docs/html/sitemap.xml index 4b75448e0..e9ef2e5ec 100644 --- a/docs/html/sitemap.xml +++ b/docs/html/sitemap.xml @@ -2,242 +2,242 @@ https://gridstack.github.io/gridstack.js/index.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/hierarchy.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/AddRemoveFcn.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/Breakpoint.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/CellPosition.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/ColumnOptions.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/CompactOptions.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/classes/DDBaseImplement.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/DDCallback.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/classes/DDDraggable.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/DDDragOpt.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/DDDropOpt.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/classes/DDDroppable.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/DDDroppableOpt.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/classes/DDElement.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/DDElementHost.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/classes/DDGridStack.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/DDKey.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/classes/DDManager.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/DDOpts.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/DDRemoveOpt.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/classes/DDResizable.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/classes/DDResizableHandle.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/DDResizableHandleOpt.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/DDResizableOpt.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/DDResizeOpt.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/DDUIData.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/DDValue.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/DragTransform.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/EventCallback.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/variables/gridDefaults.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/GridHTMLElement.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/GridItemHTMLElement.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/classes/GridStack.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/GridStackDroppedHandler.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/GridStackElement.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/GridStackElementHandler.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/classes/GridStackEngine.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/GridStackEngineOptions.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/GridStackEvent.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/GridStackEventHandler.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/GridStackEventHandlerCallback.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/GridStackMoveOpts.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/GridStackNode.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/GridStackNodesHandler.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/GridStackOptions.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/GridStackPosition.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/GridStackWidget.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/HeightData.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/HTMLElementExtendOpt.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/MousePosition.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/numberOrString.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/Position.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/Rect.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/RenderFcn.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/ResizeToContentFcn.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/Responsive.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/types/SaveFcn.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/interfaces/Size.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z https://gridstack.github.io/gridstack.js/classes/Utils.html - 2025-08-10T06:03:46.621Z + 2025-08-10T06:38:30.897Z diff --git a/package.json b/package.json index 1ce9573b5..3cd0a5861 100644 --- a/package.json +++ b/package.json @@ -32,6 +32,10 @@ "doc": "doctoc ./README.md && doctoc ./doc/README.md && doctoc ./doc/CHANGES.md && yarn doc:api && yarn doc:api:html", "doc:api": "typedoc && rm -rf docs/api/_media && node scripts/reorder-docs.js", "doc:api:html": "typedoc --options typedoc.html.json && node scripts/reorder-html-docs.js", + "doc:all": "node scripts/generate-docs.js", + "doc:main": "node scripts/generate-docs.js --main-only", + "doc:angular": "node scripts/generate-docs.js --angular-only", + "doc:clean": "node scripts/generate-docs.js --no-cleanup", "test": "yarn lint && karma start karma.conf.js", "lint": "tsc --noEmit && eslint src/*.ts", "reset": "rm -rf dist node_modules", diff --git a/scripts/generate-docs.js b/scripts/generate-docs.js new file mode 100755 index 000000000..d88923dc1 --- /dev/null +++ b/scripts/generate-docs.js @@ -0,0 +1,334 @@ +#!/usr/bin/env node + +/** + * Generic documentation generation script for GridStack.js + * Generates both HTML and Markdown documentation for the main library and Angular components + */ + +const { execSync } = require('child_process'); +const fs = require('fs'); +const path = require('path'); + +// Configuration +const config = { + // Main library paths + mainLib: { + root: '.', + typedocConfig: 'typedoc.json', + typedocHtmlConfig: 'typedoc.html.json', + outputDir: 'docs' + }, + + // Angular library paths + angular: { + root: 'angular', + typedocConfig: 'typedoc.json', + typedocHtmlConfig: 'typedoc.html.json', + outputDir: 'docs' + }, + + // Output configuration + output: { + cleanup: true, + verbose: true + } +}; + +/** + * Execute a command and handle errors + * @param {string} command - Command to execute + * @param {string} cwd - Working directory + * @param {string} description - Description for logging + */ +function execCommand(command, cwd = '.', description = '') { + if (config.output.verbose) { + console.log(`\n📋 ${description || command}`); + console.log(` Working directory: ${cwd}`); + console.log(` Command: ${command}`); + } + + try { + const result = execSync(command, { + cwd, + stdio: config.output.verbose ? 'inherit' : 'pipe', + encoding: 'utf8' + }); + + if (config.output.verbose) { + console.log(`✅ Success`); + } + + return result; + } catch (error) { + console.error(`❌ Error executing: ${command}`); + console.error(` Working directory: ${cwd}`); + console.error(` Error: ${error.message}`); + + if (error.stdout) { + console.error(` Stdout: ${error.stdout}`); + } + if (error.stderr) { + console.error(` Stderr: ${error.stderr}`); + } + + throw error; + } +} + +/** + * Check if a file exists + * @param {string} filePath - Path to check + * @returns {boolean} + */ +function fileExists(filePath) { + try { + return fs.statSync(filePath).isFile(); + } catch { + return false; + } +} + +/** + * Generate documentation for a library + * @param {Object} libConfig - Library configuration + * @param {string} libName - Library name for logging + */ +function generateLibraryDocs(libConfig, libName) { + const { root, typedocConfig, typedocHtmlConfig } = libConfig; + + console.log(`\n🔧 Generating documentation for ${libName}...`); + + // Check if TypeDoc config files exist + const markdownConfigPath = path.join(root, typedocConfig); + const htmlConfigPath = path.join(root, typedocHtmlConfig); + + if (!fileExists(markdownConfigPath)) { + console.warn(`⚠️ Markdown config not found: ${markdownConfigPath}`); + } + + if (!fileExists(htmlConfigPath)) { + console.warn(`⚠️ HTML config not found: ${htmlConfigPath}`); + } + + // Generate Markdown documentation + if (fileExists(markdownConfigPath)) { + execCommand( + `npx typedoc --options ${typedocConfig}`, + root, + `Generating Markdown docs for ${libName}` + ); + + // Remove _media directory if it exists (similar to main library) + const mediaPath = path.join(root, libConfig.outputDir, 'api', '_media'); + if (fs.existsSync(mediaPath)) { + execCommand( + `rm -rf ${path.join(libConfig.outputDir, 'api', '_media')}`, + root, + `Removing _media directory for ${libName}` + ); + } + } + + // Generate HTML documentation + if (fileExists(htmlConfigPath)) { + execCommand( + `npx typedoc --options ${typedocHtmlConfig}`, + root, + `Generating HTML docs for ${libName}` + ); + + // Remove media directory from HTML docs if it exists + const htmlMediaPath = path.join(root, libConfig.outputDir, 'html', 'media'); + if (fs.existsSync(htmlMediaPath)) { + execCommand( + `rm -rf ${path.join(libConfig.outputDir, 'html', 'media')}`, + root, + `Removing media directory from HTML docs for ${libName}` + ); + } + } + + console.log(`✅ ${libName} documentation generated successfully`); +} + +/** + * Run post-processing scripts if they exist + */ +function runPostProcessing() { + console.log(`\n🔧 Running post-processing...`); + + // Main library post-processing + if (fileExists('scripts/reorder-docs.js')) { + execCommand( + 'node scripts/reorder-docs.js', + '.', + 'Reordering Markdown documentation' + ); + } + + if (fileExists('scripts/reorder-html-docs.js')) { + execCommand( + 'node scripts/reorder-html-docs.js', + '.', + 'Reordering HTML documentation' + ); + } + + console.log(`✅ Post-processing completed`); +} + +/** + * Clean up old documentation if requested + */ +function cleanup() { + if (!config.output.cleanup) return; + + console.log(`\n🧹 Cleaning up old documentation...`); + + // Clean main library docs + const mainDocsPath = path.join(config.mainLib.root, config.mainLib.outputDir); + if (fs.existsSync(mainDocsPath)) { + execCommand(`rm -rf ${mainDocsPath}/api ${mainDocsPath}/html`, '.', 'Cleaning main library docs'); + } + + // Clean Angular docs + const angularDocsPath = path.join(config.angular.root, config.angular.outputDir); + if (fs.existsSync(angularDocsPath)) { + execCommand(`rm -rf ${angularDocsPath}`, config.angular.root, 'Cleaning Angular library docs'); + } + + console.log(`✅ Cleanup completed`); +} + +/** + * Display help information + */ +function showHelp() { + console.log(` +📚 GridStack Documentation Generator + +Usage: node scripts/generate-docs.js [options] + +Options: + --main-only Generate only main library documentation + --angular-only Generate only Angular library documentation + --no-cleanup Skip cleanup of existing documentation + --quiet Reduce output verbosity + --help, -h Show this help message + +Examples: + node scripts/generate-docs.js # Generate all documentation + node scripts/generate-docs.js --main-only # Main library only + node scripts/generate-docs.js --angular-only # Angular library only + node scripts/generate-docs.js --no-cleanup # Keep existing docs + +Environment: + NODE_ENV Set to 'development' for verbose output + `); +} + +/** + * Parse command line arguments + */ +function parseArgs() { + const args = process.argv.slice(2); + const options = { + mainOnly: false, + angularOnly: false, + cleanup: true, + verbose: process.env.NODE_ENV === 'development' + }; + + for (const arg of args) { + switch (arg) { + case '--main-only': + options.mainOnly = true; + break; + case '--angular-only': + options.angularOnly = true; + break; + case '--no-cleanup': + options.cleanup = false; + break; + case '--quiet': + options.verbose = false; + break; + case '--help': + case '-h': + showHelp(); + process.exit(0); + break; + default: + console.warn(`⚠️ Unknown argument: ${arg}`); + } + } + + return options; +} + +/** + * Main execution function + */ +function main() { + const options = parseArgs(); + + // Update config with options + config.output.cleanup = options.cleanup; + config.output.verbose = options.verbose; + + console.log(`🚀 GridStack Documentation Generator`); + console.log(` Main library: ${!options.angularOnly}`); + console.log(` Angular library: ${!options.mainOnly}`); + console.log(` Cleanup: ${config.output.cleanup}`); + console.log(` Verbose: ${config.output.verbose}`); + + try { + // Cleanup if requested + if (config.output.cleanup) { + cleanup(); + } + + // Generate main library documentation + if (!options.angularOnly) { + generateLibraryDocs(config.mainLib, 'Main Library'); + } + + // Generate Angular library documentation + if (!options.mainOnly) { + generateLibraryDocs(config.angular, 'Angular Library'); + } + + // Run post-processing + if (!options.angularOnly) { + runPostProcessing(); + } + + console.log(`\n🎉 Documentation generation completed successfully!`); + console.log(`\nGenerated documentation:`); + + if (!options.angularOnly) { + console.log(` 📄 Main Library Markdown: docs/api/`); + console.log(` 🌐 Main Library HTML: docs/html/`); + } + + if (!options.mainOnly) { + console.log(` 📄 Angular Library Markdown: angular/docs/api/`); + console.log(` 🌐 Angular Library HTML: angular/docs/html/`); + } + + } catch (error) { + console.error(`\n💥 Documentation generation failed!`); + console.error(`Error: ${error.message}`); + process.exit(1); + } +} + +// Run the script +if (require.main === module) { + main(); +} + +module.exports = { + generateLibraryDocs, + config +};