diff --git a/.github/workflows/npm-publish.yml b/.github/workflows/npm-publish.yml index f707b47de..a2ec737a8 100644 --- a/.github/workflows/npm-publish.yml +++ b/.github/workflows/npm-publish.yml @@ -12,8 +12,10 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v2 + - uses: actions/checkout@v4 + with: + token: ${{ secrets.CLASSIC_PAT_GITHUB }} + - uses: actions/setup-node@v4 with: node-version: 24 registry-url: "https://registry.npmjs.org" @@ -24,6 +26,15 @@ jobs: - name: Install packages run: yarn install --frozen-lockfile + - name: Configure git auth for private submodules + env: + TOKEN: ${{ secrets.CLASSIC_PAT_GITHUB }} + run: git config --global url."https://x-access-token:${TOKEN}@github.com/".insteadOf "https://github.com/" + + - name: Build MCP API docs + working-directory: packages/igniteui-mcp/igniteui-doc-mcp + run: npm run build:docs:all + - name: Build packages run: | npm run build-pack diff --git a/.gitmodules b/.gitmodules index 9a939890f..b5febf3fd 100644 --- a/.gitmodules +++ b/.gitmodules @@ -35,9 +35,11 @@ [submodule "packages/igniteui-mcp/igniteui-doc-mcp/react/igniteui-react"] path = packages/igniteui-mcp/igniteui-doc-mcp/react/igniteui-react url = https://github.com/IgniteUI/igniteui-react.git -[submodule "packages/igniteui-mcp/igniteui-doc-mcp/blazor/api-docs"] - path = packages/igniteui-mcp/igniteui-doc-mcp/blazor/api-docs - url = https://github.com/IgniteUI/api-docs [submodule "packages/igniteui-mcp/igniteui-doc-mcp/blazor/igniteui-blazor"] path = packages/igniteui-mcp/igniteui-doc-mcp/blazor/igniteui-blazor url = https://github.com/IgniteUI/igniteui-blazor.git +[submodule "packages/igniteui-mcp/igniteui-doc-mcp/common/api-docs"] + path = packages/igniteui-mcp/igniteui-doc-mcp/common/api-docs + url = https://github.com/IgniteUI/api-docs + branch = master + ignore = dirty diff --git a/packages/cli/package.json b/packages/cli/package.json index f71b5ca1e..4dfc3ecf7 100644 --- a/packages/cli/package.json +++ b/packages/cli/package.json @@ -1,6 +1,6 @@ { "name": "igniteui-cli", - "version": "15.2.1", + "version": "15.2.2-alpha.2", "description": "CLI tool for creating Ignite UI projects", "keywords": [ "CLI", @@ -66,9 +66,9 @@ "all": true }, "dependencies": { - "@igniteui/angular-templates": "^21.2.1521", - "@igniteui/cli-core": "^15.2.1", - "@igniteui/mcp-server": "^15.2.1", + "@igniteui/angular-templates": "^21.2.1522-alpha.2", + "@igniteui/cli-core": "^15.2.2-alpha.2", + "@igniteui/mcp-server": "^15.2.2-alpha.2", "@inquirer/prompts": "^7.9.0", "chalk": "^5.3.0", "glob": "^11.0.0", diff --git a/packages/core/package.json b/packages/core/package.json index 20981529c..ac9752f52 100644 --- a/packages/core/package.json +++ b/packages/core/package.json @@ -1,6 +1,6 @@ { "name": "@igniteui/cli-core", - "version": "15.2.1", + "version": "15.2.2-alpha.2", "description": "Base types and functionality for Ignite UI CLI", "repository": { "type": "git", diff --git a/packages/igniteui-mcp/.gitignore b/packages/igniteui-mcp/.gitignore index 062f172d6..8ac21c79f 100644 --- a/packages/igniteui-mcp/.gitignore +++ b/packages/igniteui-mcp/.gitignore @@ -32,9 +32,9 @@ yarn-debug.log* yarn-error.log* # API MCP - Generated documentation -# igniteui-doc-mcp/docs/angular-api -# igniteui-doc-mcp/docs/blazor-api -# igniteui-doc-mcp/docs/react-api -# igniteui-doc-mcp/docs/webcomponents-api +igniteui-doc-mcp/docs/angular-api +igniteui-doc-mcp/docs/blazor-api +igniteui-doc-mcp/docs/react-api +igniteui-doc-mcp/docs/webcomponents-api tmp/ diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/CLAUDE.md b/packages/igniteui-mcp/igniteui-doc-mcp/CLAUDE.md index 6be21764f..010d91c08 100644 --- a/packages/igniteui-mcp/igniteui-doc-mcp/CLAUDE.md +++ b/packages/igniteui-mcp/igniteui-doc-mcp/CLAUDE.md @@ -29,10 +29,10 @@ This is the **Ignite UI Documentation MCP Server** — a Model Context Protocol │ ├── inject-blazor-docs.ts # Inject Blazor sample code (github-src based, .razor/.razor.cs/.css files) │ ├── compress-blazor-docs.ts # LLM-based compression with Blazor-specific prompt (Igb prefix, no suffix, supports --batch mode) │ ├── validate-docs.ts # LLM-as-Judge validation of compressed docs (platform-independent) -│ ├── export-angular-api.ts # Build Angular API docs from blazor/api-docs submodule → docs/angular-api/ -│ ├── export-react-api.ts # Build React API docs from blazor/api-docs submodule → docs/react-api/ -│ ├── export-wc-api.ts # Build Web Components API docs from blazor/api-docs submodule → docs/webcomponents-api/ -│ └── export-blazor-api.ts # Build Blazor API docs from blazor/api-docs submodule → docs/blazor-api/ +│ ├── export-angular-api.ts # Build Angular API docs from common/api-docs submodule → docs/angular-api/ +│ ├── export-react-api.ts # Build React API docs from common/api-docs submodule → docs/react-api/ +│ ├── export-wc-api.ts # Build Web Components API docs from common/api-docs submodule → docs/webcomponents-api/ +│ └── export-blazor-api.ts # Build Blazor API docs from common/api-docs submodule → docs/blazor-api/ ├── docs/ │ ├── knowledgebase.md # Lessons learned and issues for cross-platform reference (32 entries) │ ├── db.md # SQLite + FTS4 database integration (IMPLEMENTED) @@ -84,7 +84,7 @@ npm start # run MCP server in local mode (default, uses bundled SQLite ### API Docs Generation -The `blazor/api-docs` submodule provides the Astro build pipeline used by all four platforms. Run these scripts once (or when upstream API data changes) to populate the `docs/*-api/` directories: +The `common/api-docs` submodule provides the Astro build pipeline used by all four platforms. Run these scripts once (or when upstream API data changes) to populate the `docs/*-api/` directories: ```bash npm run build:docs:angular-api # Angular: Astro build → docs/angular-api/ diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/DEVELOPMENT.md b/packages/igniteui-mcp/igniteui-doc-mcp/DEVELOPMENT.md index 60e12ca7e..94e634f59 100644 --- a/packages/igniteui-mcp/igniteui-doc-mcp/DEVELOPMENT.md +++ b/packages/igniteui-mcp/igniteui-doc-mcp/DEVELOPMENT.md @@ -6,7 +6,7 @@ MCP server that serves pre-compressed Ignite UI component documentation via full ```bash cd packages/igniteui-mcp/igniteui-doc-mcp -git submodule update --init blazor/api-docs +git submodule update --init common/api-docs npm install ``` @@ -24,7 +24,7 @@ npm run build:db ``` ### Building the API markdown -The `blazor/api-docs` submodule provides the Astro-based API build pipeline used by all four platforms. A fresh clone still needs `git submodule update --init blazor/api-docs` to materialize it locally. +The `common/api-docs` submodule provides the Astro-based API build pipeline used by all four platforms. A fresh clone still needs `git submodule update --init common/api-docs` to materialize it locally. Before using the MCP server from a source checkout, generate the local API markdowns: @@ -417,7 +417,7 @@ Per-platform clear removes the platform subdirectory from `docs_processing/`, `d ## API Reference Documentation -The MCP server provides API reference lookup via the `get_api_reference` and `search_api` tools. API docs are generated from the `blazor/api-docs` submodule using its Astro build pipeline and stored as `llms-full.txt` files in `docs/{platform}-api/`. +The MCP server provides API reference lookup via the `get_api_reference` and `search_api` tools. API docs are generated from the `common/api-docs` submodule using its Astro build pipeline and stored as `llms-full.txt` files in `docs/{platform}-api/`. All four platforms use the same source strategy: @@ -439,20 +439,20 @@ npm run build:docs:all # Build all four platforms ``` Each `build:docs:{platform}-api` script: -1. Initializes the `blazor/api-docs` git submodule +1. Initializes the `common/api-docs` git submodule 2. Runs `npm install` in the submodule 3. Runs the Astro static build for the platform (`npm run build:{platform}:en`) 4. Copies the generated `llms-full.txt` files from `dist/en/api/{platform}/` to `docs/{platform}-api/` -The Blazor script additionally runs `dotnet tool restore` and `npm run fetch:tools:blazor` + the five docfx package build scripts before the Astro step. Angular's TypeDoc JSON data is pre-bundled in `blazor/api-docs/src/data/angular/` so no fetch step is needed. +The Blazor script additionally runs `dotnet tool restore` and `npm run fetch:tools:blazor` + the five docfx package build scripts before the Astro step. Angular's TypeDoc JSON data is pre-bundled in `common/api-docs/src/data/angular/` so no fetch step is needed. ### Rebuilding After Upstream Changes -When a new version of `blazor/api-docs` is available: +When a new version of `common/api-docs` is available: 1. Update the submodule: ```bash - cd blazor/api-docs + cd common/api-docs git fetch && git checkout cd ../.. ``` diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/README.md b/packages/igniteui-mcp/igniteui-doc-mcp/README.md index c1e6ce15e..fe1f7039a 100644 --- a/packages/igniteui-mcp/igniteui-doc-mcp/README.md +++ b/packages/igniteui-mcp/igniteui-doc-mcp/README.md @@ -20,13 +20,13 @@ npx @igniteui/mcp-server In order to run the MCP from this repository, git submodules must be initialized first. The repo already includes the submodule entries, but a fresh clone still needs to fetch them locally. -The `blazor/api-docs` submodule is required for local API markdown generation for all four platforms (Angular, React, Web Components, and Blazor). +The `common/api-docs` submodule is required for local API markdown generation for all four platforms (Angular, React, Web Components, and Blazor). Recommended first-time setup: ```bash cd packages/igniteui-mcp/igniteui-doc-mcp -git submodule update --init blazor/api-docs +git submodule update --init common/api-docs npm install npm run build:docs:all npm run build diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/blazor/api-docs b/packages/igniteui-mcp/igniteui-doc-mcp/blazor/api-docs deleted file mode 160000 index b9bfff038..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/blazor/api-docs +++ /dev/null @@ -1 +0,0 @@ -Subproject commit b9bfff038f1a20ebbf9f1d46ef61136db227d73f diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/common/api-docs b/packages/igniteui-mcp/igniteui-doc-mcp/common/api-docs new file mode 160000 index 000000000..170f96995 --- /dev/null +++ b/packages/igniteui-mcp/igniteui-doc-mcp/common/api-docs @@ -0,0 +1 @@ +Subproject commit 170f9699528e5849aa618d9bd24b67a6950188a1 diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular-core/latest/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular-core/latest/llms-full.txt deleted file mode 100644 index 4b09ee57f..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular-core/latest/llms-full.txt +++ /dev/null @@ -1,6193 +0,0 @@ -# Ignite UI for Angular Core vlatest — Full API Reference - -> Complete API reference for the Ignite UI for Angular Core package (latest). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: Angular -Package: igniteui-angular-core -Version: latest - -## Classes - -### [AngularRenderer](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/AngularRenderer) - -- **constructor**(container: any, renderer: Renderer2, document: any, ngZone: NgZone, useDefaultsSource: boolean, defaultsSource: any, portalManager?: PortalManager): AngularRenderer -- **rootWrapper**: `DomWrapper` -- **addSizeWatcher**(onResized: any): void -- **append**(child: DomWrapper): DomRenderer -- **appendToBody**(element: DomWrapper): void -- **clearTimeout**(timerId: any): void -- **createElement**(elementName: any): AngularWrapper -- **createElementNS**(elementName: any, ns: any): AngularWrapper -- **destroy**(): void -- **endCSSQuery**(): void -- **expandTemplate**(template: string, args: any): AngularWrapper -- **get2DCanvasContext**(canvas: AngularWrapper): CanvasRenderingContext2D -- **getClearTimeout**(): any -- **getCssDefaultPropertyValue**(className: string, propertyName: string): string -- **getCssDefaultValuesForClassCollection**(classPrefix: string, propertyNames: string[]): any[] -- **getCurrentDiscovery**(): AngularWrapper -- **getDefaultFontHeight**(): number -- **getExternal**(internalComponent: any, styleSourceElement: DomWrapper, optionalParent?: any): any -- **getHeightForFontString**(fontString: any, text: any, useOffsetHeight: any): any -- **getPortal**(hostElement: DomWrapper, elementTag: string, portalCallback: any, isContentPortal: boolean): void -- **getRequestAnimationFrame**(): any -- **getResourceString**(resourceId: string): string -- **getSetTimeout**(): any -- **getSubRenderer**(root: DomWrapper): DomRenderer -- **getWrapper**(ele: any): DomWrapper -- **globalListen**(element: string, eventName: string, handler: any): any -- **hasBody**(): boolean -- **hasWindow**(): boolean -- **querySelector**(selector: string): DomWrapper -- **removeSizeWatcher**(): void -- **runInMainZone**(action: any): void -- **setCssQueryFontString**(fontString: any): void -- **setCultureId**(culture: string): void -- **setResourceBundleId**(bundle: string): void -- **setTimeout**(act: any, millisecondsDelay: number): number -- **startCSSQuery**(): void -- **supportsAnimation**(): boolean -- **supportsDOMEvents**(): boolean -- **withRenderer**(act: any): void - -### [AngularWrapper](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/AngularWrapper) - -- **constructor**(ele: any, renderer: Renderer2, ngZone: NgZone): AngularWrapper -- **addClass**(className: string): DomWrapper -- **append**(child: DomWrapper): DomWrapper -- **before**(child: any): DomWrapper -- **clone**(): DomWrapper -- **destroy**(): void -- **findByClass**(className: any): DomWrapper[] -- **focus**(preventScroll?: boolean): DomWrapper -- **getAttribute**(propertyName: string): string -- **getChildAt**(i: any): DomWrapper -- **getChildCount**(): number -- **getNativeElement**(): any -- **getOffset**(): AngularWrapperPosition -- **getOffsetHelper**(ele: Element): AngularWrapperPosition -- **getProperty**(propertyName: string): any -- **getStyleProperty**(propertyName: string): string -- **getText**(): string -- **height**(): number -- **hide**(): DomWrapper -- **listen**(eventName: string, handler: any): any -- **outerHeight**(): number -- **outerHeightWithMargin**(): number -- **outerWidth**(): number -- **outerWidthWithMargin**(): number -- **parent**(): AngularWrapper -- **querySelectorAll**(selector: string): AngularWrapper[] -- **remove**(): DomWrapper -- **removeChild**(child: DomWrapper): this -- **removeChildren**(): DomWrapper -- **removeClass**(className: string): DomWrapper -- **setAttribute**(propertyName: string, value: string): this -- **setOffset**(x: number, y: number): DomWrapper -- **setProperty**(propertyName: string, value: any): DomWrapper -- **setRawPosition**(x: number, y: number): DomWrapper -- **setRawSize**(width: number, height: number): DomWrapper -- **setRawStyleProperty**(propertyName: string, value: string): DomWrapper -- **setRawText**(value: string): DomWrapper -- **setRawXPosition**(x: number): DomWrapper -- **setRawYPosition**(y: number): DomWrapper -- **setStyleProperty**(propertyName: string, value: string): DomWrapper -- **setText**(value: string): DomWrapper -- **show**(): DomWrapper -- **unlistenAll**(): DomWrapper -- **width**(): number -- **withRenderer**(act: any): void - -### [ArrayBox$1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/ArrayBox$1) - -- **constructor**(target: any): ArrayBox$1 -- **$arrayWrapper**: `boolean` -- **isFixedSize**: `boolean` -- **isReadOnly**: `boolean` -- **isSynchronized**: `boolean` -- **syncRoot**: `any` -- **$type**: `Type` -- **count**: `number` -- **add**(item: T): void -- **clear**(): void -- **contains**(item: T): boolean -- **copyTo**(array: T[], arrayIndex: number): void -- **equals**(other: any): boolean -- **getEnumerator**(): IEnumerator$1 -- **getEnumeratorObject**(): IEnumerator -- **getHashCode**(): number -- **indexOf**(item: T): number -- **insert**(index: number, item: T): void -- **insertRange**(index: number, items: any[]): void -- **item**(index: number, value?: T): T -- **remove**(item: T): boolean -- **removeAt**(index: number): void -- **removeRange**(index: number, count: number): void -- **reverse**(): void - -### [Base](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/Base) - -- **constructor**(): Base -- **$type**: `Type` -- static **nextHashCode**: `number` -- **equals**(other: any): boolean -- **getHashCode**(): number -- **memberwiseClone**(): Base -- static **compare**(item1: any, item2: any): number -- static **compareSimple**(item1: any, item2: any): number -- static **equalsSimple**(item1: any, item2: any): boolean -- static **equalsStatic**(a: any, b: any): boolean -- static **getArrayOfProperties**(obj: any): any[] -- static **getArrayOfValues**(obj: any): any[] -- static **getHashCodeStatic**(obj: any): number -- static **referenceEquals**(a: any, b: any): boolean - -### [BaseError](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/BaseError) - -- **constructor**(initNumber?: number, rest: any[]): BaseError -- static **$t**: `Type` -- **innerException**: `any` -- **message**: `string` -- **init1**(initNumber: number, message: string): void -- **init2**(initNumber: number, message: string, innerException: any): void -- **toString**(): string — Returns a string representation of an object. - -### [BinaryUtil](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/BinaryUtil) - -- **constructor**(): BinaryUtil -- static **getBinary**(url: string, callback: any, error: any): void -- static **isResponseTypeSupported**(responseType: any): boolean - -### [Calendar](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/Calendar) - -- **constructor**(): Calendar -- static **$t**: `Type` -- **addMonths**(time: Date, months: number): Date -- **addYears**(time: Date, years: number): Date -- **eras**(): number[] -- **getDayOfMonth**(time: Date): number -- **getDaysInMonth**(year: number, month: number, era: number): number -- **getDaysInYear**(year: number, era: number): number -- **getEra**(time: Date): number -- **getMonth**(time: Date): number -- **getYear**(time: Date): number -- **toDateTime**(year: number, month: number, day: number, hour: number, minute: number, second: number, millisecond: number, era: number): Date - -### [CollectionAdapter](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/CollectionAdapter) - -- **constructor**(query: any, target: IList$1, allList: T[], toTarget: any, onItemAdded: any, onItemRemoved: any, collisionChecker?: any): CollectionAdapter -- **actualContent**: `any[]` -- **collisionChecker**: `any` -- **addManualItem**(item: T): void -- **clearManualItems**(): void -- **insertManualItem**(index: number, item: T): void -- **notifyContentChanged**(): void -- **onQueryChanged**(currentItems: T[]): void -- **removeManualItem**(item: T): boolean -- **removeManualItemAt**(index: number): void -- **shiftContentToManual**(manualCollection: any, onMoving: any): void -- **syncItems**(): void -- **updateQuery**(q: any): void - -### [CompareInfo](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/CompareInfo) - -- **constructor**(): CompareInfo -- static **$t**: `Type` -- **compare1**(string1: string, offset1: number, length1: number, string2: string, offset2: number, length2: number, options: CompareOptions): number -- **compare4**(string1: string, string2: string): number -- **compare5**(string1: string, string2: string, options: CompareOptions): number -- **indexOf1**(source: string, value: string): number -- **indexOf3**(source: string, value: string, options: CompareOptions): number -- **indexOf5**(source: string, value: string, options: CompareOptions): number -- **indexOf6**(source: string, value: string, startIndex: number, options: CompareOptions): number -- **referenceEquals**(a: CompareInfo, b: CompareInfo): boolean - -### [CompareUtil](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/CompareUtil) - -- **constructor**(): CompareUtil -- static **compareTo**(obj1: any, obj2: any): number -- static **compareToObject**(obj1: any, obj2: any): number - -### [ComponentRendererAdapter](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/ComponentRendererAdapter) - -- **constructor**(): ComponentRendererAdapter -- **isBlazorRenderer**: `boolean` -- **addItemToCollection**(propertyName: string, propertyMetadata: TypeDescriptionMetadata, target: any, newIndex: number, item: any): void -- **clearCollection**(target: any, propertyName: string, metadata: TypeDescriptionMetadata): void -- **clearContainer**(container: any, context: TypeDescriptionContext, continueActions: any): void -- **coerceToEnum**(type: string, context: TypeDescriptionContext, value: string): string -- **createBrushCollection**(brushes: any[]): any[] -- **createColorCollection**(colors: any[]): any[] -- **createDoubleCollection**(lengths: any[]): any[] -- **createObject**(type: string, container: any, context: TypeDescriptionContext, nameContext: string): any -- **ensureExternalObject**(target: any, propertyMetadata: TypeDescriptionMetadata): any -- **executeMethod**(target: any, methodName: string, argumentValues_: any[], argumentMetadata: TypeDescriptionMetadata[], onFinished: any): void -- **flushChanges**(container: any): void -- **forPropertyValueItem**(target: any, propertyName: string, forItem: any): void -- **getMarkupCollection**(target: any, propertyName: string, metadata: TypeDescriptionMetadata, isCollection: boolean): MarkupCollection -- **getMarkupTypeMatcher**(target: any, propertyName: string, metadata: TypeDescriptionMetadata, isCollection: boolean): null | any -- **getPropertyValue**(target: any, propertyName: string): any -- **getRootObject**(container: any): any -- **mustManageInMarkup**(target: any, propertyName: string, metadata: TypeDescriptionMetadata, isCollection: boolean): boolean -- **onPendingRef**(target: any, propertyName: string, propertyMetadata: TypeDescriptionMetadata, sourceRef: DescriptionRef): void -- **onUIThread**(container: any, action: any): void -- **removeItemFromCollection**(propertyName: string, propertyMetadata: TypeDescriptionMetadata, target: any, oldIndex: number): void -- **removeRootItem**(container: any, context: TypeDescriptionContext, continueActions: any): void -- **replaceItemInCollection**(propertyName: string, propertyMetadata: TypeDescriptionMetadata, target: any, newIndex: number, item: any): void -- **replaceRootItem**(container: any, type: string, context: TypeDescriptionContext, continueActions: any): void -- **resetPropertyOnTarget**(container: any, propertyName: string, propertyMetadata: TypeDescriptionMetadata, target: any): void -- **serializeBrush**(value: any): any -- **serializeBrushCollection**(value: any): any -- **serializeColor**(value: any): any -- **serializeColorCollection**(value: any): any -- **serializeDoubleCollection**(value: any): any -- **serializePoint**(value: any): any -- **serializeRect**(value: any): any -- **serializeSize**(value: any): any -- **serializeTimespan**(value: any): any -- **setOrUpdateCollectionOnTarget**(container: any, propertyName: string, propertyMetadata: TypeDescriptionMetadata, context: TypeDescriptionContext, target: any, value: any): void -- **setPropertyValue**(target: any, propertyName: string, propertyMetadata: TypeDescriptionMetadata, value: any, oldValue: any, sourceRef: DescriptionRef): void - -### [ConvertUtil](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/ConvertUtil) - -- **constructor**(): ConvertUtil -- static **convertToNumber**(meth: string, v: any, minValue: number, maxValue: number, trunc: boolean, provider?: IFormatProvider, throwOnNaN?: boolean): number -- static **toBoolean**(v: any, provider?: IFormatProvider): boolean -- static **toByte**(v: any, provider?: IFormatProvider): number -- static **toChar**(v: any, provider?: IFormatProvider): string -- static **toDateTime**(v: any, provider?: IFormatProvider): Date -- static **toDecimal**(v: any, provider?: IFormatProvider): number -- static **toDouble**(v: any, provider?: IFormatProvider): number -- static **toInt16**(v: any, provider?: IFormatProvider): number -- static **toInt32**(v: any, provider?: IFormatProvider): number -- static **toInt64**(v: any, provider?: IFormatProvider): number -- static **toSByte**(v: any, provider?: IFormatProvider): number -- static **toSingle**(v: any, provider?: IFormatProvider): number -- static **toString1**(v: any, provider?: IFormatProvider): string -- static **toUInt16**(v: any, provider?: IFormatProvider): number -- static **toUInt32**(v: any, provider?: IFormatProvider): number -- static **toUInt64**(v: any, provider?: IFormatProvider): number - -### [CultureInfo](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/CultureInfo) - -- **constructor**(name: string): CultureInfo -- static **$t**: `Type` -- **calendar**: `Calendar` -- **compareInfo**: `CompareInfo` -- **dateTimeFormat**: `DateTimeFormat` -- **name**: `string` -- **numberFormat**: `NumberFormatInfo` -- **twoLetterISOLanguageName**: `string` -- static **currentCulture**: `CultureInfo` -- static **invariantCulture**: `CultureInfo` -- **clone**(): CultureInfo -- **getFormat**($t: Type): DateTimeFormat | NumberFormatInfo -- static **getCultureInfo**(lcid: string | number): CultureInfo - -### [DataVisualizationLocaleCs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleCs) - -- **constructor**(): DataVisualizationLocaleCs -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleDa](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleDa) - -- **constructor**(): DataVisualizationLocaleDa -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleDe](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleDe) - -- **constructor**(): DataVisualizationLocaleDe -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_Header1**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader1**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader1**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader1**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader1**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleEn](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleEn) - -- **constructor**(): DataVisualizationLocaleEn -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleEs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleEs) - -- **constructor**(): DataVisualizationLocaleEs -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_Header1**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader1**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader1**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader1**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader1**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleFr](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleFr) - -- **constructor**(): DataVisualizationLocaleFr -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_Header1**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader1**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader1**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader1**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader1**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleHu](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleHu) - -- **constructor**(): DataVisualizationLocaleHu -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleIt](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleIt) - -- **constructor**(): DataVisualizationLocaleIt -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleJa](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleJa) - -- **constructor**(): DataVisualizationLocaleJa -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleKo](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleKo) - -- **constructor**(): DataVisualizationLocaleKo -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleNb](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleNb) - -- **constructor**(): DataVisualizationLocaleNb -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleNl](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleNl) - -- **constructor**(): DataVisualizationLocaleNl -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocalePl](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocalePl) - -- **constructor**(): DataVisualizationLocalePl -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocalePt](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocalePt) - -- **constructor**(): DataVisualizationLocalePt -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleRo](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleRo) - -- **constructor**(): DataVisualizationLocaleRo -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleSv](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleSv) - -- **constructor**(): DataVisualizationLocaleSv -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleTr](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleTr) - -- **constructor**(): DataVisualizationLocaleTr -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleZhHans](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleZhHans) - -- **constructor**(): DataVisualizationLocaleZhHans -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DataVisualizationLocaleZhHant](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DataVisualizationLocaleZhHant) - -- **constructor**(): DataVisualizationLocaleZhHant -- **AssemblyNotIncluded**: `string` -- **BreakEvenTitle_BreakEven**: `string` -- **BreakEvenTitle_FixedCost**: `string` -- **BreakEvenTitle_LossArea**: `string` -- **BreakEvenTitle_MarginalProfit**: `string` -- **BreakEvenTitle_ProfitArea**: `string` -- **BreakEvenTitle_SafetyMargin**: `string` -- **BreakEvenTitle_SalesRevenue**: `string` -- **BreakEvenTitle_TotalCost**: `string` -- **BreakEvenTitle_VariableCost**: `string` -- **BubbleSeries_Radius**: `string` -- **DataChart_InteractivityNotLoaded**: `string` -- **DataChart_NumberAbbreviatorNotLoaded**: `string` -- **DataChart_VisualDataNotLoaded**: `string` -- **DataProviderNotInitialized**: `string` -- **DataSource_Summary_Avg**: `string` -- **DataSource_Summary_Count**: `string` -- **DataSource_Summary_Max**: `string` -- **DataSource_Summary_Min**: `string` -- **DataSource_Summary_Sum**: `string` -- **Default_Series_Title**: `string` -- **FinancialChart_IndicatorMenu_Header**: `string` -- **FinancialChart_IndicatorMenu_IndicatorsCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_OverlaysCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_TrendlinesCategoryHeader**: `string` -- **FinancialChart_IndicatorMenu_VolumeCategoryHeader**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AbsoluteVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AccumulationDistribution**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageDirectionalIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_AverageTrueRange**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_BollingerBandWidth**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ChaikinVolatility**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_CommodityChannelIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_DetrendedPriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_EaseOfMovement**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FastStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_ForceIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_FullStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MarketFacilitationIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MassIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MedianPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MoneyFlowIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_MovingAverageConvergenceDivergence**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_NegativeVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_OnBalanceVolume**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentagePriceOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PercentageVolumeOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PositiveVolumeIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_PriceVolumeTrend**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RateOfChangeAndMomentum**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_RelativeStrengthIndex**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_SlowStochasticOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StandardDeviation**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_StochRSI**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TRIX**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_TypicalPrice**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_UltimateOscillator**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WeightedClose**: `string` -- **FinancialChart_IndicatorsMenu_Indicator_WilliamsPercentR**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_BollingerBands**: `string` -- **FinancialChart_IndicatorsMenu_Overlay_PriceChannel**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CubicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_CumulativeAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ExponentialFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LinearFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_LogarithmicFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_ModifiedAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_PowerLawFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuadraticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuarticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_QuinticFit**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_SimpleAverage**: `string` -- **FinancialChart_IndicatorsMenu_TrendLine_WeightedAverage**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Area**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Column**: `string` -- **FinancialChart_IndicatorsMenu_Volume_Line**: `string` -- **FinancialChart_RangeSelector_All**: `string` -- **FinancialChart_RangeSelector_From**: `string` -- **FinancialChart_RangeSelector_OneMonth**: `string` -- **FinancialChart_RangeSelector_OneYear**: `string` -- **FinancialChart_RangeSelector_SixMonths**: `string` -- **FinancialChart_RangeSelector_ThreeMonths**: `string` -- **FinancialChart_RangeSelector_To**: `string` -- **FinancialChart_RangeSelector_YearToDate**: `string` -- **FinancialSeries_Close**: `string` -- **FinancialSeries_High**: `string` -- **FinancialSeries_Low**: `string` -- **FinancialSeries_Open**: `string` -- **FinancialSeries_Volume**: `string` -- **NoEncodingsLoaded**: `string` -- **NotSupportedEncoding**: `string` -- **Object_Sealed**: `string` -- **OPD_DefaultInteraction**: `string` -- **OPD_DragPan**: `string` -- **OPD_DragZoom**: `string` -- **OPD_ScaleToFit**: `string` -- **OPD_ScaleToFit_SeriesViewer**: `string` -- **OPD_ZoomIn**: `string` -- **OPD_ZoomOut**: `string` -- **OPD_ZoomTo100**: `string` -- **PieChart_Others**: `string` -- **RangeModificationsNotSupportRangeModificationsNotSupported**: `string` -- **ScatterSeries_Value**: `string` -- **TRIAL_VERSION**: `string` - -### [DateTimeFormat](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DateTimeFormat) - -- **constructor**(cultureName: string, isInvariant: boolean): DateTimeFormat -- static **$t**: `Type` -- **dateSeparator**: `string` -- **longDatePattern**: `string` -- **monthNames**: `string[]` -- **shortDatePattern**: `string` -- **shortTimePattern**: `string` -- **timeSeparator**: `string` -- **clone**(): DateTimeFormat - -### [DictionaryUtil](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/DictionaryUtil) - -- **constructor**(): DictionaryUtil -- static **dictionaryCreate**(capacity?: number): Map -- static **dictionaryGetDictionary**(obj: any): Map -- static **dictionaryGetEnumerator**(map: Map): IEnumerator -- static **dictionaryGetKeys**(map: Map): IEnumerator -- static **dictionaryGetValues**(map: Map): IEnumerator -- static **en**(map: Map): Generator - -### [Enum](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/Enum) - -- **constructor**(): Enum -- static **$t**: `Type` - -### [EnumBox](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/EnumBox) - -- **constructor**(value: number, type: Type): EnumBox -- readonly **value**: `number` -- **getActualName**(): string -- **getHashCode**(): number -- **toDouble**(provider: IFormatProvider): number -- **toString**(): string — Returns a string representation of an object. - -### [EnumerableWrapper](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/EnumerableWrapper) - -- **constructor**(inner: IEnumerable$1): EnumerableWrapper -- **[iterator]**(): EnumeratorWrapper - -### [EnumerableWrapperObject](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/EnumerableWrapperObject) - -- **constructor**(inner: IEnumerable): EnumerableWrapperObject -- **[iterator]**(): EnumeratorWrapperObject - -### [EnumeratorWrapper](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/EnumeratorWrapper) - -- **constructor**(inner: IEnumerator$1): EnumeratorWrapper -- **next**(): IteratorResult - -### [EnumeratorWrapperObject](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/EnumeratorWrapperObject) - -- **constructor**(inner: IEnumerator): EnumeratorWrapperObject -- **next**(): IteratorResult - -### [EnumUtil](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/EnumUtil) - -- **constructor**(): EnumUtil -- static **enumHasFlag**(value: number, flag: number): boolean -- static **getEnumValue**($t: Type, v: any): T -- static **getFlaggedName**(enumType: Type, v: number, getName: any): string -- static **getName**(enumType: Type, v: number): string -- static **getNames**($t: Type): string[] -- static **getValues**($t: Type): number[] -- static **isDefined**($t: Type, value: T): boolean -- static **parse**(enumType: Type, value: string, ignoreCase: boolean): unknown -- static **toDouble**(enumType: Type, value: any, provider: any): number -- static **toObject**($t: Type, value: T): any -- static **toString**(enumType: Type, value: any): string -- static **tryParse$1**($tEnum: Type, value: string, ignoreCase: boolean, result: TEnum): any - -### [EventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/EventArgs) - -- **constructor**(): EventArgs -- static **$t**: `Type` -- static **empty**: `EventArgs` - -### [FormatException](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/FormatException) - -- **constructor**(initNumber: number, rest: any[]): FormatException -- static **$t**: `Type` -- **init1**(initNumber: number, message: string): void -- **init2**(initNumber: number, message: string, innerException: any): void - -### [HttpRequestUtil](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/HttpRequestUtil) - -- **constructor**(): HttpRequestUtil -- static **submit**(url: string, callback: any, error: any): any - -### [IgCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgCollection) - -- **constructor**(): IgCollection -- **count**: `number` -- **[iterator]**(): Generator -- **add**(item: T): void -- **clear**(): void -- **contains**(item: T): boolean -- **filter**(predicate: any, thisArg?: any): T[] -- **findByName**(name: string): any -- **hasName**(name: string): boolean -- **indexOf**(item: T): number -- **insert**(index: number, item: T): void -- **item**(index: number, value?: T): T -- **remove**(item: T): boolean -- **removeAt**(index: number): void -- **toArray**(): T[] - -### [IgEvent](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgEvent) - -- **constructor**(): IgEvent -- **add**(callback: any): void -- **emit**(sender: TSender, args: TArgs): void -- **remove**(callback: any): void - -### [IgxAsyncCompletedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxAsyncCompletedEventArgs) - -- **constructor**(): IgxAsyncCompletedEventArgs -- static **ngAcceptInputType_cancelled**: `string | boolean` -- **cancelled**: `boolean` -- **errorMessage**: `string` -- **userState**: `any` - -### [IgxBaseGenericDataSource](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxBaseGenericDataSource) -The base class for generic data sources. - -- **constructor**(): IgxBaseGenericDataSource -- **executionContext**: `IDataSourceExecutionContext` — Gets or sets the execution context that the data source should synchronize asynchronous actions with, or use to defer delayed actions. -- **filterExpressions**: `IgxFilterExpressionCollection` — Gets the current filter that is applied to the data source. -- **groupDescriptions**: `IgxDataSourceGroupDescriptionCollection` — Gets the current grouping that is applied to the data source. -- **sortDescriptions**: `IgxDataSourceSortDescriptionCollection` — Gets the current sort that is applied to the data source. -- **summaryDescriptions**: `IgxDataSourceSummaryDescriptionCollection` — Gets the current summaries that are applied to the data source. -- **findByName**(name: string): any -- **queueAutoRefresh**(): void — Called to manually queue a refresh of the data source. -- static **_createFromInternal**(internal: any): IgxBaseGenericDataSource - -### [IgxCancelEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxCancelEventArgs) - -- **constructor**(): IgxCancelEventArgs -- static **ngAcceptInputType_cancel**: `string | boolean` -- **cancel**: `boolean` - -### [IgxCancellingMultiScaleImageEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxCancellingMultiScaleImageEventArgs) - -- **constructor**(): IgxCancellingMultiScaleImageEventArgs -- **uri**: `string` - -### [IgxCaptureImageSettings](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxCaptureImageSettings) - -- **constructor**(): IgxCaptureImageSettings -- static **ngAcceptInputType_addToClipboard**: `string | boolean` -- static **ngAcceptInputType_format**: `string | CaptureImageFormat` -- **addToClipboard**: `boolean` -- **format**: `CaptureImageFormat` -- **findByName**(name: string): any - -### [IgxChildContentComponent](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxChildContentComponent) - -- **constructor**(_changeDetectorRef: ChangeDetectorRef, renderer: Renderer2, viewContainer: ViewContainerRef): IgxChildContentComponent -- **viewContainer**: `ViewContainerRef` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **alignItems**: `string` -- **display**: `string` -- **flexDirection**: `string` -- **template**: `TemplateRef` -- **markChanged**(): void - -### [IgxComponentRendererContainerComponent](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxComponentRendererContainerComponent) - -- **constructor**(_renderer: Renderer2, _elRef: ViewContainerRef, _ngZone: NgZone, changeDetector: ChangeDetectorRef, _componentFactoryResolver: ComponentFactoryResolver, _injector: Injector): IgxComponentRendererContainerComponent -- **_dynamicContent**: `ViewContainerRef` -- **isAngularHost**: `boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **height**: `string` -- **width**: `string` -- **clearContainer**(continueActions: any): void -- **createObject**(type: string, container: any, context: TypeDescriptionContext, portalChildren: boolean, nameContext: string): unknown -- **determineInjector**(origName: string, typeName: string, type: Function): any -- **getRootObject**(): any -- **getSpecificAnchor**(origName: string, typeName: string, type: Function, context: TypeDescriptionContext): any -- **replaceRootItem**(t: any, deferAttach: boolean, continueActions: any): void -- static **isEvent**(ev: any): boolean - -### [IgxContentChildCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxContentChildCollection) - -- **constructor**(list?: any[]): IgxContentChildCollection - -### [IgxDataContext](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataContext) - -- **constructor**(): IgxDataContext -- static **ngAcceptInputType_thickness**: `string | number` -- **actualItemBrush**: `string` — Gets the actual resolved brush in use for the item that is in context. -- **i**: `DataContext` -- **item**: `any` — Gets the item that is in context. -- **itemBrush**: `string` — Gets the potential brush in usage for the item in context. -- **itemLabel**: `any` — Gets the label in use for the item in context, if available. -- **legendLabel**: `any` — Gets the legend label to use for the item in context, if available. -- **outline**: `string` — Gets the outline in use for the item in context. -- **series**: `any` -- **thickness**: `number` — Gets the thickness of the item in context. -- **findByName**(name: string): any - -### [IgxDataLegendSeriesContext](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataLegendSeriesContext) -Represent info about series values - -- **constructor**(): IgxDataLegendSeriesContext -- **seriesFamily**: `string` — Gets a family of series that the current series belongs to, e.g. Category, Range, Financial, etc. -- **findByName**(name: string): any -- **getSeriesValue**(type: string | DataLegendSeriesValueType): number — Gets value info for the series value type -- **getSeriesValueInfo**(type: string | DataLegendSeriesValueType): IgxDataLegendSeriesValueInfo — Creates an instance of DataLegendSeriesContext -- **getSeriesValues**(): number[] — Gets all values that a series renders at the current data point -For example, Open, High, Low, Close for Financial Series -- **setSeriesValue**(type: string | DataLegendSeriesValueType, value: number): void -- **setSeriesValueInfo**(type: string | DataLegendSeriesValueType, valueInfo: IgxDataLegendSeriesValueInfo): void - -### [IgxDataLegendSeriesValueInfo](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataLegendSeriesValueInfo) -Represent info about series values - -- **constructor**(): IgxDataLegendSeriesValueInfo -- static **ngAcceptInputType_allowLabels**: `string | boolean` -- static **ngAcceptInputType_allowUnits**: `string | boolean` -- static **ngAcceptInputType_formatAllowAbbreviation**: `string | boolean` -- static **ngAcceptInputType_formatAllowCurrency**: `string | boolean` -- static **ngAcceptInputType_formatAllowDecimal**: `string | boolean` -- static **ngAcceptInputType_formatAllowInteger**: `string | boolean` -- static **ngAcceptInputType_formatAllowPercent**: `string | boolean` -- static **ngAcceptInputType_formatMaxFractions**: `string | number` -- static **ngAcceptInputType_formatMinFractions**: `string | number` -- static **ngAcceptInputType_formatUseNegativeColor**: `string | boolean` -- static **ngAcceptInputType_formatUsePositiveColor**: `string | boolean` -- static **ngAcceptInputType_index**: `string | number` -- static **ngAcceptInputType_isExcludeByDefault**: `string | boolean` -- static **ngAcceptInputType_orderIndex**: `string | number` -- static **ngAcceptInputType_value**: `string | number` -- static **ngAcceptInputType_valueType**: `string | DataLegendSeriesValueType` -- **allowLabels**: `boolean` — Gets or sets whether the label text is allowed by the series, e.g. "H:" -- **allowUnits**: `boolean` — Gets or sets whether the unit text is allowed by the series, e.g. "Hz" -- **formatAllowAbbreviation**: `boolean` — Gets or sets whether or not allow displaying value with abbreviation -- **formatAllowCurrency**: `boolean` — Gets or sets whether or not allow displaying value as currency -- **formatAllowDecimal**: `boolean` — Gets or sets whether or not allow displaying value as decimal -- **formatAllowInteger**: `boolean` — Gets or sets whether or not allow displaying value as integer -- **formatAllowPercent**: `boolean` — Gets or sets whether or not allow displaying value as percentage -- **formatMaxFractions**: `number` — Gets or sets maximum digits used for displaying faction of the value -- **formatMinFractions**: `number` — Gets or sets minimum digits used for displaying faction of the value -- **formatUseNegativeColor**: `boolean` — Gets or sets whether or not use conditional color -- **formatUsePositiveColor**: `boolean` — Gets or sets whether or not use conditional color -- **formatWithSeriesColor**: `string` — Gets value color used by the series -- **index**: `number` — Gets the index of series -- **isExcludeByDefault**: `boolean` — Gets or sets whether this value is excluded/hidden by default in Data Legend -- **memberLabel**: `string` — Gets or sets member path for the series value, e.g. "High" -- **memberPath**: `string` — Gets or sets member path for the series value, e.g. "HighPrice" -- **memberSymbol**: `string` — Gets or sets label for the series value, e.g. "H:" -- **memberUnit**: `string` — Gets or sets unit text for the value, e.g. "Hz" -- **orderIndex**: `number` -- **value**: `number` — Gets value of series -- **valueNegativePrefix**: `string` — Gets or sets prefix for negative value -- **valueNegativeSuffix**: `string` — Gets or sets suffix for negative value -- **valuePositivePrefix**: `string` — Gets or sets prefix for positive value -- **valuePositiveSuffix**: `string` — Gets or sets suffix for positive value -- **valueType**: `DataLegendSeriesValueType` — Gets or sets type of value -- **findByName**(name: string): any -- **toString**(): string — Converts this object to a string - -### [IgxDataLegendSummaryColumn](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataLegendSummaryColumn) -Represent a column in summary row - -- **constructor**(): IgxDataLegendSummaryColumn -- static **ngAcceptInputType_seriesLabels**: `string | string[]` -- static **ngAcceptInputType_seriesUnits**: `string | string[]` -- static **ngAcceptInputType_seriesValues**: `string | number[]` -- **seriesLabels**: `string[]` — Get labels rendered on left side of series values, e.g. "H:" for High, "L:" for Low -- **seriesUnits**: `string[]` — Get optional units on right side of series values, e.g. "Hz" for hertz -- **seriesValues**: `number[]` — Get values of series in the summary column -- **addLabel**(label: string): void — Add label in the summary column -- **addUnits**(units: string): void — Add unit in the summary column -- **addValue**(value: number): void — Add a value in the summary column - -### [IgxDataSeriesCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataSeriesCollection) - -- **constructor**(list?: DataSeries[]): IgxDataSeriesCollection - -### [IgxDataSourceDataProviderSchemaChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataSourceDataProviderSchemaChangedEventArgs) -Provides information about a schema change event. - -- **constructor**(): IgxDataSourceDataProviderSchemaChangedEventArgs -- static **ngAcceptInputType_count**: `string | number` -- **count**: `number` — Represents the current full count for the data provider. May be -1 if this information is not available yet. -- **schema**: `IDataSourceSchema` — Represents the current schema for the data provider. - -### [IgxDataSourceGroupDescription](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataSourceGroupDescription) - -- **constructor**(): IgxDataSourceGroupDescription - -### [IgxDataSourceGroupDescriptionCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataSourceGroupDescriptionCollection) - -- **constructor**(): IgxDataSourceGroupDescriptionCollection -- **add**(item: IgxDataSourceGroupDescription): boolean -- **clear**(): void -- **findByName**(name: string): any -- **indexOf**(item: IgxDataSourceGroupDescription): number -- **insert**(index: number, item: IgxDataSourceGroupDescription): void -- **remove**(item: IgxDataSourceGroupDescription): boolean -- **removeAt**(index: number): IgxDataSourceGroupDescription - -### [IgxDataSourcePropertiesRequestedChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataSourcePropertiesRequestedChangedEventArgs) -Provides information about a properties requested changed event. - -- **constructor**(): IgxDataSourcePropertiesRequestedChangedEventArgs - -### [IgxDataSourceRootSummariesChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataSourceRootSummariesChangedEventArgs) -Provides information about row expansion or collapse. - -- **constructor**(): IgxDataSourceRootSummariesChangedEventArgs - -### [IgxDataSourceRowExpansionChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataSourceRowExpansionChangedEventArgs) -Provides information about row expansion or collapse. - -- **constructor**(): IgxDataSourceRowExpansionChangedEventArgs -- static **ngAcceptInputType_newState**: `string | boolean` -- static **ngAcceptInputType_oldState**: `string | boolean` -- static **ngAcceptInputType_rowIndex**: `string | number` -- **newState**: `boolean` — The new state of the row. True is expanded, False is collapsed. -- **oldState**: `boolean` — The previous state of the row. True is expanded, False is collapsed. -- **rowIndex**: `number` — The index of the row being expanded or collapsed. - -### [IgxDataSourceSchemaChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataSourceSchemaChangedEventArgs) -Provides information about a schema change event that has occurred. - -- **constructor**(): IgxDataSourceSchemaChangedEventArgs -- static **ngAcceptInputType_count**: `string | number` -- **count**: `number` — Gets the current full count of items in the data source. -- **schema**: `IDataSourceSchema` — Gets the new schema that has been provided. - -### [IgxDataSourceSortDescription](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataSourceSortDescription) - -- **constructor**(): IgxDataSourceSortDescription -- static **ngAcceptInputType_sortDirection**: `string | ListSortDirection` -- **field**: `string` — Gets or sets the property being sorted. -- **sortDirection**: `ListSortDirection` — Gets or sets the direction to sort based on the property. -- **equals**(other: any): boolean — Returns if the SortDescription is equal to another. -- **findByName**(name: string): any - -### [IgxDataSourceSortDescriptionCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataSourceSortDescriptionCollection) - -- **constructor**(): IgxDataSourceSortDescriptionCollection -- static **ngAcceptInputType_shouldDetachOnTargetChange**: `string | boolean` -- **shouldDetachOnTargetChange**: `boolean` — Gets or sets whether this collection should detach the sync when the target collection changes. -- **add**(item: IgxDataSourceSortDescription): boolean -- **clear**(): void -- **findByName**(name: string): any -- **indexOf**(item: IgxDataSourceSortDescription): number -- **insert**(index: number, item: IgxDataSourceSortDescription): void -- **remove**(item: IgxDataSourceSortDescription): boolean -- **removeAt**(index: number): IgxDataSourceSortDescription - -### [IgxDataSourceSummaryDescription](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataSourceSummaryDescription) - -- **constructor**(): IgxDataSourceSummaryDescription -- static **ngAcceptInputType_operand**: `string | DataSourceSummaryOperand` -- **alias**: `string` — Gets or sets an alias for the summary. Currently only used in aggregated data situations. -- **calculatorDisplayName**: `string` — Gets or sets the name to use when displaying the calculator name. -- **field**: `string` -- **operand**: `DataSourceSummaryOperand` -- **provideCalculator**: `EventEmitter` — Called when the summary calculator is required. -- **equals**(other: any): boolean -- **findByName**(name: string): any - -### [IgxDataSourceSummaryDescriptionCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDataSourceSummaryDescriptionCollection) - -- **constructor**(): IgxDataSourceSummaryDescriptionCollection -- static **ngAcceptInputType_shouldDetachOnTargetChange**: `string | boolean` -- **shouldDetachOnTargetChange**: `boolean` — Gets or sets whether this collection should detach the sync when the target collection changes. -- **add**(item: IgxDataSourceSummaryDescription): boolean -- **clear**(): void -- **findByName**(name: string): any -- **indexOf**(item: IgxDataSourceSummaryDescription): number -- **insert**(index: number, item: IgxDataSourceSummaryDescription): void -- **remove**(item: IgxDataSourceSummaryDescription): boolean -- **removeAt**(index: number): IgxDataSourceSummaryDescription - -### [IgxDateTimeFormatSpecifier](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDateTimeFormatSpecifier) - -- **constructor**(): IgxDateTimeFormatSpecifier -- static **ngAcceptInputType_fractionalSecondDigits**: `string | number` -- **calendar**: `string` -- **dateStyle**: `string` -- **day**: `string` -- **dayPeriod**: `string` -- **era**: `string` -- **formatMatcher**: `string` -- **fractionalSecondDigits**: `number` -- **hour**: `string` -- **hour12**: `string` -- **hourCycle**: `string` -- **locale**: `string` -- **localeMatcher**: `string` -- **minute**: `string` -- **month**: `string` -- **numberingSystem**: `string` -- **second**: `string` -- **timeStyle**: `string` -- **timeZone**: `string` -- **timeZoneName**: `string` -- **weekDay**: `string` -- **year**: `string` - -### [IgxDoubleValueChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDoubleValueChangedEventArgs) -Provides data for double value change events. - -- **constructor**(): IgxDoubleValueChangedEventArgs -- static **ngAcceptInputType_newValue**: `string | number` -- static **ngAcceptInputType_oldValue**: `string | number` -- **newValue**: `number` — Gets the new value. -- **oldValue**: `number` — Gets the value before the change. - -### [IgxDownloadingMultiScaleImageEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxDownloadingMultiScaleImageEventArgs) - -- **constructor**(): IgxDownloadingMultiScaleImageEventArgs -- **i**: `DownloadingMultiScaleImageEventArgs` -- **image**: `HTMLImageElement` -- **uri**: `string` - -### [IgxFilterExpressionCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxFilterExpressionCollection) -Represents a colleciton of filter expressions. - -- **constructor**(): IgxFilterExpressionCollection -- static **ngAcceptInputType_shouldDetachOnTargetChange**: `string | boolean` -- **count**: `number` -- **i**: `FilterExpressionCollection` -- **onChanged**: `any` -- **shouldDetachOnTargetChange**: `boolean` — Gets or sets whether this collection should detach the sync when the target collection changes. -- **syncTarget**: `IgxFilterExpressionCollection` -- **[iterator]**(): Generator -- **add**(item: IFilterExpression): boolean -- **clear**(): void -- **findByName**(name: string): any -- **get**(index: number): IFilterExpression -- **indexOf**(item: IFilterExpression): number -- **insert**(index: number, item: IFilterExpression): void -- **item**(index: number, value?: IFilterExpression): IFilterExpression -- **remove**(item: IFilterExpression): boolean -- **removeAt**(index: number): IFilterExpression -- **set**(index: number, value: IFilterExpression): IFilterExpression -- **toArray**(): IFilterExpression[] - -### [IgxFocusEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxFocusEventArgs) - -- **constructor**(): IgxFocusEventArgs -- **fromTarget**: `any` -- **target**: `any` - -### [IgxFormatSpecifier](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxFormatSpecifier) - -- **constructor**(): IgxFormatSpecifier -- **findByName**(name: string): any -- **getLocalCulture**(): string - -### [IgxFormatSpecifierCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxFormatSpecifierCollection) - -- **constructor**(list?: IgxFormatSpecifier[]): IgxFormatSpecifierCollection - -### [IgxGenericVirtualDataSource](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxGenericVirtualDataSource) -The base class for generic data sources. - -- **constructor**(): IgxGenericVirtualDataSource -- **pageRequested**: `EventEmitter` — Raised when the datasource requests page data. -- **addSchemaProperty**(propertyName: string, propertyType: string | GenericDataSourceSchemaPropertyType): void -- **addSummaryDate**(propertyName: string, operand: string | DataSourceSummaryOperand, value: Date): void -- **addSummaryDouble**(propertyName: string, operand: string | DataSourceSummaryOperand, value: number): void -- **addSummaryInt**(propertyName: string, operand: string | DataSourceSummaryOperand, value: number): void -- **addSummaryString**(propertyName: string, operand: string | DataSourceSummaryOperand, value: string): void -- **fillColumnBool**(column: string, values: boolean[]): void -- **fillColumnDate**(column: string, values: Date[]): void -- **fillColumnDouble**(column: string, values: number[]): void -- **fillColumnInt**(column: string, values: number[]): void -- **fillColumnString**(column: string, values: string[]): void -- **fillCount**(count: number): void — Provides the row count for the datasource. The datasource obtains this from the page request so be must be called -after FillPageStart. -- **fillGroupEnd**(): void — Ends the current group. -- **fillGroupStart**(startIndex: number, endIndex: number): void -- **fillGroupValueDate**(propertyName: string, value: Date): void -- **fillGroupValueDouble**(propertyName: string, value: number): void -- **fillGroupValueInt**(propertyName: string, value: number): void -- **fillGroupValueString**(propertyName: string, value: string): void -- **fillPageEnd**(): void — Ends the current page. Must be called after FillPageStart. -- **fillPageStart**(requestId: number): void — Starts filling a page for the specified request. Must later be followed by FillPageEnd to complete the request. - -### [IgxGetTileImageUriArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxGetTileImageUriArgs) -Event arguments for GetTileImageUri event - -- **constructor**(): IgxGetTileImageUriArgs -- static **ngAcceptInputType_tileLevel**: `string | number` -- static **ngAcceptInputType_tilePositionX**: `string | number` -- static **ngAcceptInputType_tilePositionY**: `string | number` -- **tileImageUri**: `string` — Gets or sets the tile's image URI -- **tileLevel**: `number` — Gets or sets the tile level. -- **tilePositionX**: `number` — Gets or sets the tile's X position -- **tilePositionY**: `number` — Gets or sets the tile's Y position - -### [IgxHeatTileGenerator](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxHeatTileGenerator) - -- **constructor**(): IgxHeatTileGenerator -- static **ngAcceptInputType_blurRadius**: `string | number` -- static **ngAcceptInputType_logarithmBase**: `string | number` -- static **ngAcceptInputType_maxBlurRadius**: `string | number` -- static **ngAcceptInputType_maximumValue**: `string | number` -- static **ngAcceptInputType_minimumValue**: `string | number` -- static **ngAcceptInputType_scaleColorOffsets**: `string | number[]` -- static **ngAcceptInputType_useBlurRadiusAdjustedForZoom**: `string | boolean` -- static **ngAcceptInputType_useGlobalMinMax**: `string | boolean` -- static **ngAcceptInputType_useGlobalMinMaxAdjustedForZoom**: `string | boolean` -- static **ngAcceptInputType_useLogarithmicScale**: `string | boolean` -- static **ngAcceptInputType_useWebWorkers**: `string | boolean` -- static **ngAcceptInputType_values**: `string | number[]` -- static **ngAcceptInputType_xValues**: `string | number[]` -- static **ngAcceptInputType_yValues**: `string | number[]` -- **blurRadius**: `number` -- **logarithmBase**: `number` -- **maxBlurRadius**: `number` -- **maximumColor**: `string` -- **maximumValue**: `number` -- **minimumColor**: `string` -- **minimumValue**: `number` -- **scaleColorOffsets**: `number[]` -- **scaleColors**: `string[]` -- **useBlurRadiusAdjustedForZoom**: `boolean` -- **useGlobalMinMax**: `boolean` -- **useGlobalMinMaxAdjustedForZoom**: `boolean` -- **useLogarithmicScale**: `boolean` -- **useWebWorkers**: `boolean` -- **values**: `number[]` -- **webWorkerInstance**: `any` -- **webWorkerScriptPath**: `string` -- **xValues**: `number[]` -- **yValues**: `number[]` -- **cancelTile**(z: number, x: number, y: number): void -- **destroy**(): void -- **findByName**(name: string): any -- **getTile**(z: number, x: number, y: number, onCreated: any, onCreating: any, zoomChanging: any, existingImage: HTMLImageElement): void - -### [IgxHighlightingInfo](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxHighlightingInfo) -Contains contextual information about a highlighting. - -- **constructor**(): IgxHighlightingInfo -- static **ngAcceptInputType_endIndex**: `string | number` -- static **ngAcceptInputType_isExclusive**: `string | boolean` -- static **ngAcceptInputType_isFullRange**: `string | boolean` -- static **ngAcceptInputType_isMarker**: `string | boolean` -- static **ngAcceptInputType_progress**: `string | number` -- static **ngAcceptInputType_startIndex**: `string | number` -- static **ngAcceptInputType_state**: `string | HighlightingState` -- **context**: `any` — The context for the highlight. -- **endIndex**: `number` — The index of the last highlighted item. - -You can use the EndIndex to get or set the last highlighted item for the series. - - - -- **isExclusive**: `boolean` — TODO -- **isFullRange**: `boolean` — True if this HighlightingInfo represents a full selection of the data. -- **isMarker**: `boolean` — True if this HighlightingInfo represents a marker highlighting. - -You can set the IsMarker to True if the HighlightingInfo represents a marker highlighting. Otherwise set to false. - - - -- **progress**: `number` — A number between 0 and 1 representing the progress of the highlighting. - -You can use the Progress property to set a number between 0 and 1 representing the progress of the highlighting. - - - -- **startIndex**: `number` — The index of the first highlighted item. - -You can use StartIndex to get or set the first highlighted item for the series. - - - -- **state**: `HighlightingState` — The state of the highlighting. - -You can use the State to get or set the transitioning state of the highlighting, between In, Out, or Static. -- **findByName**(name: string): any - -### [IgxImageCapturedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxImageCapturedEventArgs) - -- **constructor**(): IgxImageCapturedEventArgs -- **base64Data**: `string` — Gets the captured image as Base64. -- **image**: `any` — Gets the captured image. -- **settings**: `IgxCaptureImageSettings` — Gets the settings used to capture the image. - -### [IgxKeyEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxKeyEventArgs) -Event args for KeyUp and KeyDown events. - -- **constructor**(): IgxKeyEventArgs -- static **ngAcceptInputType_alt**: `string | boolean` -- static **ngAcceptInputType_ctrl**: `string | boolean` -- static **ngAcceptInputType_defaultPrevented**: `string | boolean` -- static **ngAcceptInputType_keyCode**: `string | number` -- static **ngAcceptInputType_modifiers**: `string | ModifierKeys` -- static **ngAcceptInputType_shift**: `string | boolean` -- **alt**: `boolean` — Gets a value indicating whether the ALT key was pressed. -- **ctrl**: `boolean` — Gets a value indicating whether the CTRL key was pressed. -- **defaultPrevented**: `boolean` — Gets whether the PreventDefault method was called. -- **keyCode**: `number` — Gets the keyboard code for a KeyDown or KeyUp event. -- **modifiers**: `ModifierKeys` — Gets the modifier flags for a KeyDown or KeyUp event. -The flags indicate which combination of CTRL, SHIFT, and ALT keys was pressed. -- **originalEvent**: `any` -- **shift**: `boolean` — Gets a value indicating whether the SHIFT key was pressed. -- **preventDefault**(): void — Tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be. -- **stopPropagation**(): void — Prevent the event from bubbling up. - -### [IgxNumberFormatSpecifier](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxNumberFormatSpecifier) - -- **constructor**(): IgxNumberFormatSpecifier -- static **ngAcceptInputType_maximumFractionDigits**: `string | number` -- static **ngAcceptInputType_maximumSignificantDigits**: `string | number` -- static **ngAcceptInputType_minimumFractionDigits**: `string | number` -- static **ngAcceptInputType_minimumIntegerDigits**: `string | number` -- static **ngAcceptInputType_minimumSignificantDigits**: `string | number` -- static **ngAcceptInputType_useGrouping**: `string | boolean` -- **compactDisplay**: `string` -- **currency**: `string` -- **currencyCode**: `string` -- **currencyDisplay**: `string` -- **currencySign**: `string` -- **locale**: `string` -- **localeMatcher**: `string` -- **maximumFractionDigits**: `number` -- **maximumSignificantDigits**: `number` -- **minimumFractionDigits**: `number` -- **minimumIntegerDigits**: `number` -- **minimumSignificantDigits**: `number` -- **notation**: `string` -- **numberingSystem**: `string` -- **signDisplay**: `string` -- **style**: `string` -- **unit**: `string` -- **unitDisplay**: `string` -- **useGrouping**: `boolean` - -### [IgxObjectCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxObjectCollection) - -- **constructor**(list?: any[]): IgxObjectCollection - -### [IgxOnClosedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxOnClosedEventArgs) - -- **constructor**(): IgxOnClosedEventArgs - -### [IgxOnPopupEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxOnPopupEventArgs) - -- **constructor**(): IgxOnPopupEventArgs - -### [IgxPageRequestedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxPageRequestedEventArgs) -Information about the requested page. - -- **constructor**(): IgxPageRequestedEventArgs -- static **ngAcceptInputType_dataSourceId**: `string | number` -- static **ngAcceptInputType_isSchemaRequest**: `string | boolean` -- static **ngAcceptInputType_pageIndex**: `string | number` -- static **ngAcceptInputType_pageSize**: `string | number` -- static **ngAcceptInputType_requestId**: `string | number` -- **dataSourceId**: `number` — The Unique ID for the data source making the request. -- **isSchemaRequest**: `boolean` — The data source is requesting the schema for the data. -- **pageIndex**: `number` — The page index being requested. -- **pageSize**: `number` — The page size being requested. -- **requestId**: `number` — The unique ID for the page request. - -### [IgxPopupComponent](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxPopupComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxPopupComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **_mainDiv**: `Element` -- **_mainDivRef**: `ElementRef` -- static **ngAcceptInputType_actualElevation**: `string | number` -- static **ngAcceptInputType_animationDuration**: `string | number` -- static **ngAcceptInputType_animationEnabled**: `string | boolean` -- static **ngAcceptInputType_animationType**: `string | PopupAnimationType` -- static **ngAcceptInputType_cornerRadius**: `string | number` -- static **ngAcceptInputType_disableHitTestDuringAnimation**: `string | boolean` -- static **ngAcceptInputType_elevation**: `string | number` -- static **ngAcceptInputType_isClosing**: `string | boolean` -- static **ngAcceptInputType_isFixed**: `string | boolean` -- static **ngAcceptInputType_isFocusable**: `string | boolean` -- static **ngAcceptInputType_isHitTestVisible**: `string | boolean` -- static **ngAcceptInputType_isPointerEnabled**: `string | boolean` -- static **ngAcceptInputType_isShowing**: `string | boolean` -- static **ngAcceptInputType_isShown**: `string | boolean` -- static **ngAcceptInputType_pointerPosition**: `string | PopupPointerPosition` -- static **ngAcceptInputType_pointerSize**: `string | number` -- static **ngAcceptInputType_useTopLayer**: `string | boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualAmbientShadowColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **actualElevation**: `number` — Gets or sets the elevation of the border shadow -- **actualPenumbraShadowColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **actualUmbraShadowColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **animationDuration**: `number` — Gets or sets the duration of the Popup and Closeup animations in milliseconds. -- **animationEnabled**: `boolean` — Gets or sets whether the popup and closeup animations are animated. -- **animationType**: `PopupAnimationType` — Gets or sets the type of animation to use when the popup opens and closes. -- **background**: `string` — Gets or sets the background color of the popup. -- **cornerRadius**: `number` -- **disableHitTestDuringAnimation**: `boolean` — Gets or sets whether to disable hit testing during the open and close animations. -- **elevation**: `number` — Gets or sets the elevation to use for the button regardless of type. -- **height**: `string` -- **i**: `Popup` -- **isClosing**: `boolean` — Gets whether the popup is in the middle of closing or not. -- **isFixed**: `boolean` — Indicates that the popup will position itself relative to the window instead of the document. -- **isFocusable**: `boolean` -- **isHitTestVisible**: `boolean` — Gets or sets whether to disable hit testing on the popup. -- **isPointerEnabled**: `boolean` — Gets or sets whether to show a pointer off the side of the popup towards the popup target. -- **isShowing**: `boolean` — Gets whether the popup is in the middle of opening or not. -- **isShown**: `boolean` — Gets / sets the isShown state of the panel. -- **measuringContentSize**: `EventEmitter` -- **onClosed**: `EventEmitter` -- **onPopup**: `EventEmitter` — Fires when the popup is shown -- **pointerBackground**: `string` — Gets or sets the pointer background color. -- **pointerPosition**: `PopupPointerPosition` — Gets or sets the pointer position. -- **pointerSize**: `number` — Gets or sets the pointer size. -- **popupGotFocus**: `EventEmitter` — Fired when the open popup gains focus. -- **popupLostFocus**: `EventEmitter` — Fired when the open popup loses focus. -- **useTopLayer**: `boolean` — Indicates that the popup will place itself into the browser top layer. -- **width**: `string` -- **close**(): void — Closes the popup. -- **exportSerializedVisualModel**(): string — Returns a serialized copy of the exported visual model -- **exportVisualModel**(): any — Exports visual information about the current state of the grid. -- **findByName**(name: string): any -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **ngAfterViewInit**(): void -- **ngOnDestroy**(): void -- **showRelativeToExclusionRect**(exclusionRect: IgRect, popupDirection: string | PopupDirection, popupAlignment: string | PopupAlignment): void -- **updateStyle**(): void - -### [IgxPopupMeasuringContentSizeEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxPopupMeasuringContentSizeEventArgs) - -- **constructor**(): IgxPopupMeasuringContentSizeEventArgs - -### [IgxPropertyUpdatedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxPropertyUpdatedEventArgs) -EventArgs class for property updated events. - -- **constructor**(): IgxPropertyUpdatedEventArgs -- **newValue**: `any` — New or current value of the property being updated. -- **oldValue**: `any` — Old or previous value of the property being updated. -- **propertyName**: `string` — Name of the property being updated. - -### [IgxProvideCalculatorEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxProvideCalculatorEventArgs) -Event arguments for the ProvideCalculator event. - -- **constructor**(): IgxProvideCalculatorEventArgs -- **calculator**: `SummaryCalculator` — Gets or sets the summary calculator to use for this summary. - -### [IgxRectChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxRectChangedEventArgs) -Provides data for rectangle changed events. - -- **constructor**(): IgxRectChangedEventArgs -- static **ngAcceptInputType_newRect**: `string | IgRect` -- static **ngAcceptInputType_oldRect**: `string | IgRect` -- **newRect**: `IgRect` — Gets the new rectangle. -- **oldRect**: `IgRect` — Gets the rectangle before the change. - -### [IgxShapeDataSource](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxShapeDataSource) -Class used to convert Shapefiles into CLR objects. - -- **constructor**(): IgxShapeDataSource -- static **ngAcceptInputType_computedWorldRect**: `string | IgRect` -- static **ngAcceptInputType_count**: `string | number` -- static **ngAcceptInputType_deferImportCompleted**: `string | boolean` -- static **ngAcceptInputType_worldRect**: `string | IgRect` -- **computedWorldRect**: `IgRect` — Gets the world bounding rectangle, based on the filtered shapes -- **count**: `number` — The total number of ShapefileRecords in the collection. -- **databaseSource**: `string` — The Uri of the .dbf portion of the Shapefile. -- **deferImportCompleted**: `boolean` — The Uri of the .shp portion of the Shapefile. -- **filter**: `EventEmitter` -- **i**: `ShapefileConverter` -- **importCompleted**: `EventEmitter` — Event raised when the Shapefile has been imported from both the ShapefileSource and DatabaseSource Uris. -- **importPending**: `EventEmitter` — Event raised when the Shapefile has been imported from both the ShapefileSource and DatabaseSource Uris. -- **name**: `string` -- **shapefileSource**: `string` — The Uri of the .shp portion of the Shapefile. -- **shapeHeader**: `Header` — Gets the header of the Shapefile. -- **shapeType**: `ShapeType` — Gets the shape type, as read from the header of the Shapefile. -- **worldRect**: `IgRect` — Gets the world bounding rectangle, as read from the header of the Shapefile. -- **dataBind**(): void -- **findByName**(name: string): any -- **getLargestShapeBoundsForRecord**(index: number): IgRect -- **getMaxLongitude**(recordIndex: number, useLargestShape: boolean, fromLongitude: number, toLongitude: number): number -- **getPointData**(): IgxShapefileRecord[] — Gets the point data. -- **getRecord**(index: number): IgxShapefileRecord -- **getRecordBounds**(index: number): IgRect -- **getRecordFieldNames**(index: number): string[] -- **getRecordsCount**(): number -- **getRecordValue**(index: number, fieldName: string): any -- **getRecordValues**(fieldName: string): any[] -- **getWorldBounds**(useComputed: boolean): IgRect -- **removeRecord**(index: number): void -- **sendImportCompleted**(): void -- **setRecordValue**(index: number, fieldName: string, value: any): void -- **setRecordValues**(fieldName: string, values: any[]): void -- **setWorldBounds**(setComputed: boolean, bounds: IgRect): void -- **shiftAllShapes**(offsetX: number, offsetY: number): void -- **shiftShapes**(recordIndex: number, offsetX: number, offsetY: number): void - -### [IgxShapefileRecord](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxShapefileRecord) -Represents a record of data from a Shapefile (.shp and .dbf). - -- **constructor**(): IgxShapefileRecord -- static **ngAcceptInputType_bounds**: `string | IgRect` -- **bounds**: `IgRect` — Gets the bounds for the shapes -- **fieldsNames**: `string[]` — Gets an array of field names and values for this record -- **fieldsTypes**: `string[]` — Gets an arry of field types and values for this record -- **fieldValues**: `any` -- **i**: `ShapefileRecord` -- **points**: `Point[][]` — Gets an array of arrays of points for this record -- **shapeType**: `ShapeType` — Gets the shape type, as read from the header of the Shapefile. -- **findByName**(name: string): any -- **getFieldValue**(fieldName: string): any -- **setFieldValue**(fieldName: string, value: any): void - -### [IgxShapeFilterRecordEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxShapeFilterRecordEventArgs) - -- **constructor**(): IgxShapeFilterRecordEventArgs -- static **ngAcceptInputType_shouldInclude**: `string | boolean` -- **record**: `IgxShapefileRecord` -- **shouldInclude**: `boolean` - -### [IgxSimpleDefaultTooltipComponent](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxSimpleDefaultTooltipComponent) - -- **constructor**(_changeDetectorRef: ChangeDetectorRef): IgxSimpleDefaultTooltipComponent -- **labelText**: `any` -- **onContentReady**: `EventEmitter` -- **tooltip**: `TemplateRef` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **ensureDefaultTooltip**(gauge: any): void -- **getLabel**(context: any): any -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- static **register**(): void - -### [IgxStockChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxStockChangedEventArgs) -Represents event arguments for FDC3 MessageRecived - -- **constructor**(): IgxStockChangedEventArgs -- static **ngAcceptInputType_addedSymbols**: `string | string[]` -- static **ngAcceptInputType_removedSymbols**: `string | string[]` -- **addedSymbols**: `string[]` — Gets array of added stock symbols -- **removedSymbols**: `string[]` — Gets array of removed stock symbols - -### [IgxStyle](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxStyle) -A class that exposes style realted properties. - -- **constructor**(): IgxStyle -- **findByName**(name: string): any - -### [IgxTemplateContentComponent](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxTemplateContentComponent) - -- **constructor**(_changeDetectorRef: ChangeDetectorRef, viewContainer: ViewContainerRef): IgxTemplateContentComponent -- **viewContainer**: `ViewContainerRef` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **context**: `any` -- **template**: `TemplateRef` -- **markChanged**(): void - -### [IgxToolCommandArgumentCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxToolCommandArgumentCollection) - -- **constructor**(list?: ToolCommandArgument[]): IgxToolCommandArgumentCollection - -### [IgxTooltipContainerComponent](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxTooltipContainerComponent) - -- **constructor**(_changeDetectorRef: ChangeDetectorRef): IgxTooltipContainerComponent -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **containerTemplate**: `TemplateRef` -- **context**: `any` -- **template**: `TemplateRef` -- static **register**(): void - -### [IgxTransactionState](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxTransactionState) -Represents the final state of items with all transactions combined. - -- **constructor**(): IgxTransactionState -- static **ngAcceptInputType_transactionType**: `string | TransactionType` -- **id**: `any` — Gets or sets the ID for the state. I.e. an items primary key. -- **transactionType**: `TransactionType` — Gets or sets how this state was created. -- **value**: `any` — Gets or sets the final value with all transaction deltas combined. -- **version**: `any` — Gets or sets the version data for this item. Used for concurrency. -- **findByName**(name: string): any - -### [IgxTriangulationDataSource](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxTriangulationDataSource) -Class for converting Itf files into enumerable triangulations. - -- **constructor**(): IgxTriangulationDataSource -- **i**: `ItfConverter` -- **importCompleted**: `EventEmitter` — Event raised when the import operation has completed -- **source**: `string` — Gets the string path specifying the location of the Itf file. -- **findByName**(name: string): any -- **getPointData**(): TriangulationSourcePointRecord[] — Gets the point data. -- **getTriangleData**(): Triangle[] — Gets the triangle data. - -### [IgxTriangulationStatusEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxTriangulationStatusEventArgs) - -- **constructor**(): IgxTriangulationStatusEventArgs -- static **ngAcceptInputType_currentStatus**: `string | number` -- **currentStatus**: `number` — The current status from 0 to 100 of the progressive triangulation. - -### [IgxUploadDataCompletedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxUploadDataCompletedEventArgs) - -- **constructor**(): IgxUploadDataCompletedEventArgs -- static **ngAcceptInputType_result**: `string | number[]` -- **result**: `number[]` - -### [IgxUploadStringCompletedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IgxUploadStringCompletedEventArgs) - -- **constructor**(): IgxUploadStringCompletedEventArgs -- **result**: `string` - -### [IterableWrapper](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IterableWrapper) - -- **constructor**(inner: any): IterableWrapper -- **getEnumerator**(): IEnumerator$1 -- **getEnumeratorObject**(): IEnumerator - -### [IteratorWrapper](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/IteratorWrapper) - -- **constructor**(inner: Iterator, getNew: any): IteratorWrapper -- **current**: `T` -- **currentObject**: `T` -- **dispose**(): void -- **moveNext**(): boolean -- **reset**(): void - -### [NamePatcher](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/NamePatcher) - -- **constructor**(): NamePatcher -- static **_patched**: `Set` -- static **ensurePatched**(prot: any, nameFilter?: any): void -- static **ensureStylablePatched**(prot: any): void - -### [NotSupportedException](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/NotSupportedException) - -- **constructor**(initNumber: number, rest: any[]): NotSupportedException -- static **$t**: `Type` -- **init1**(initNumber: number, message: string): void -- **init2**(initNumber: number, message: string, innerException: any): void - -### [Nullable](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/Nullable) - -- **constructor**(): Nullable -- static **$t**: `Type` -- static **getUnderlyingType**(nullableType: Type): Type - -### [Nullable$1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/Nullable$1) - -- **constructor**($t: Type, value: T): Nullable$1 -- readonly **isNullable**: `true` -- static **$t**: `Type` -- **hasValue**: `boolean` -- **value**: `T` -- **equals**(value: Nullable$1): boolean -- **getDefaultValue**(): T -- **getHashCode**(): number -- **getValueOrDefault**(): T -- **getValueOrDefault1**(defaultValue: T): T -- **postDecrement**(): Nullable$1 -- **postIncrement**(): Nullable$1 -- **preDecrement**(): Nullable$1 -- **preIncrement**(): Nullable$1 -- **toString**(): string — Returns a string representation of an object. -- static **nullableEquals**(v1: any, v2: any): boolean - -### [NumberFormatInfo](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/NumberFormatInfo) - -- **constructor**(cultureName: string, isInvariant: boolean): NumberFormatInfo -- static **$t**: `Type` -- **currencySymbol**: `string` -- **nativeDigits**: `string[]` -- **negativeSign**: `string` -- **numberDecimalSeparator**: `string` -- **numberGroupSeparator**: `string` -- **numberGroupSizes**: `number[]` -- **percentSymbol**: `string` -- **positiveSign**: `string` -- **clone**(): NumberFormatInfo - -### [PlatformConstants](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/PlatformConstants) - -- **constructor**(): PlatformConstants -- static **Postfix**: `string` -- static **Prefix**: `string` - -### [PointUtil](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/PointUtil) - -- **constructor**(): PointUtil -- static **create**(): any -- static **createXY**(x: number, y: number): any -- static **equals**(p1: Point, p2: Point): boolean -- static **notEquals**(p1: Point, p2: Point): boolean - -### [PortalManager](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/PortalManager) - -- **constructor**(id: string, componentFactoryResolver: ComponentFactoryResolver): PortalManager -- **detectChanges**: `any` -- **renderer**: `AngularRenderer` -- **dynamicContent**: `ViewContainerRef` -- **_destroy**(portal: AngularDomPortal): void -- **getPortal**(hostElement: DomWrapper, elementTag: string, portalCallback: any, isContentPortal: boolean): void -- **onChildContentChanged**(template: any): void - -### [PromiseFactory](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/PromiseFactory) - -- **constructor**(): PromiseFactory -- **promise**(): PromiseWrapper -- **reject**(error: any): void -- **resolve**(result?: any): void - -### [PromiseWrapper](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/PromiseWrapper) - -- **constructor**(inner: Promise): PromiseWrapper -- **always**(continuation: any): PromiseWrapper -- **done**(continuation: any): PromiseWrapper -- **fail**(continuation: any): PromiseWrapper -- **state**(): string -- **then**(pass: any, fail: any): PromiseWrapper - -### [PropertyChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/PropertyChangedEventArgs) - -- **constructor**(propertyName: string): PropertyChangedEventArgs -- static **$t**: `Type` -- **propertyName**: `string` - -### [ReflectionUtil](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/ReflectionUtil) - -- **constructor**(): ReflectionUtil -- static **getPropertyGetter**: `any` - -### [Stream](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/Stream) - -- **constructor**(): Stream -- static **$t**: `Type` -- **canRead**: `boolean` -- **canSeek**: `boolean` -- **canWrite**: `boolean` -- **length**: `number` -- **position**: `number` -- **close**(): void -- **dispose**(): void -- **flush**(): void -- **read**(bytes: number[], offset: number, count: number): number -- **readByte**(): number -- **seek**(offset: number, origin: SeekOrigin): number -- **setLength**(value: number): void -- **write**(buffer: number[], offset: number, count: number): void -- **writeByte**(value: number): void - -### [SystemException](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/SystemException) - -- **constructor**(initNumber: number, rest: any[]): SystemException -- static **$t**: `Type` -- **init1**(initNumber: number, message: string): void -- **init2**(initNumber: number, message: string, innerException: any): void - -### [Thread](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/Thread) - -- **constructor**(): Thread -- static **$t**: `Type` -- **currentCulture**: `CultureInfo` -- static **currentThread**: `Thread` - -### [Type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/Type) - -- **constructor**(instanceConstructor: Function, identifier: string, baseType?: Type, interfaces?: Type[], staticInitializer?: any): Type -- **_$nullNullable**: `any` -- **baseType**: `Type` -- **enumInfo**: `EnumInfo` -- **identifier**: `number` -- **InstanceConstructor**: `Function` -- **interfaces**: `Type[]` -- **isEnumType**: `boolean` -- **isNullable**: `boolean` -- **name**: `string` -- **specializationCache**: `any` -- **stringId**: `string` -- **typeArguments**: `number | Type[]` -- **fullName**: `string` -- **genericTypeArguments**: `number | Type[]` -- **isGenericType**: `boolean` -- **isGenericTypeDefinition**: `boolean` -- **isPrimitive**: `boolean` -- **isValueType**: `boolean` -- **typeName**: `string` -- **equals**(other: Type): boolean -- **generateString**(): string -- **getSpecId**(types: number | Type[]): string -- **getStaticFields**(type?: Type): any -- **initSelfReferences**(replacement?: Type): Type -- **isAssignableFrom**(tOther: Type): boolean -- **isInstanceOfType**(value: string | Type): boolean -- **specialize**(rest: number | Function | Type[]): Type -- static **canAssign**(targetType: Type, type: Type): boolean -- static **canAssignSimple**(targetType: Type, type: Type): boolean -- static **checkEquals**(type1: any, type2: any): boolean -- static **createInstance**($t: Function | Type): T -- static **decodePropType**(val: any): Type -- static **getDefaultValue**($t: Type): T -- static **getPrimitiveHashCode**(v: any): number -- static **op_Equality**(type1: Type, type2: Type): boolean -- static **op_Inequality**(type1: Type, type2: Type): boolean - -### [TypeRegistrar](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/TypeRegistrar) - -- **constructor**(): TypeRegistrar -- static **_registrar**: `Map` -- static **callRegister**(typeName: string): void -- static **create**(typeName: string, rest: any[]): any -- static **createFromInternal**(internal: any, prefix: string, postfix: string): any -- static **get**(typeName: string): any -- static **isRegistered**(typeName: string): boolean -- static **register**(typeName: string, type: Type): void -- static **registerCons**(typeName: string, type: Function): void - -### [ValueType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/classes/ValueType) - -- **constructor**(): ValueType -- static **$t**: `Type` - -## Interfaces - -### [AngularWrapperPosition](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/AngularWrapperPosition) - -- **left**: `number` -- **top**: `number` - -### [Delegate](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/Delegate) - -- **original?**: `any` -- **target?**: `any` -- **enumerate?**: `any` - -### [DomPortal](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/DomPortal) - -- **componentRef**: `any` -- **portalContainer**: `DomWrapper` -- **destroy**: `any` - -### [DomRenderer](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/DomRenderer) - -- **rootWrapper**: `DomWrapper` -- **append**: `any` -- **appendToBody**: `any` -- **clearTimeout**: `any` -- **createElement**: `any` -- **createElementNS**: `any` -- **destroy**: `any` -- **endCSSQuery**: `any` -- **expandTemplate**: `any` -- **get2DCanvasContext**: `any` -- **getClearTimeout**: `any` -- **getCssDefaultPropertyValue**: `any` -- **getCssDefaultValuesForClassCollection**: `any` -- **getExternal**: `any` -- **getHeightForFontString**: `any` -- **getPortal**: `any` -- **getRequestAnimationFrame**: `any` -- **getResourceString**: `any` -- **getSetTimeout**: `any` -- **getSubRenderer**: `any` -- **getWrapper**: `any` -- **globalListen**: `any` -- **hasBody**: `any` -- **hasWindow**: `any` -- **querySelector**: `any` -- **runInMainZone**: `any` -- **setCssQueryFontString**: `any` -- **setCultureId**: `any` -- **setResourceBundleId**: `any` -- **setTimeout**: `any` -- **startCSSQuery**: `any` -- **supportsAnimation**: `any` -- **supportsDOMEvents**: `any` - -### [DomWrapper](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/DomWrapper) - -- **addClass**: `any` -- **append**: `any` -- **before**: `any` -- **clone**: `any` -- **destroy**: `any` -- **findByClass**: `any` -- **focus**: `any` -- **getAttribute**: `any` -- **getChildAt**: `any` -- **getChildCount**: `any` -- **getNativeElement**: `any` -- **getOffset**: `any` -- **getProperty**: `any` -- **getStyleProperty**: `any` -- **getText**: `any` -- **height**: `any` -- **hide**: `any` -- **listen**: `any` -- **outerHeight**: `any` -- **outerHeightWithMargin**: `any` -- **outerWidth**: `any` -- **outerWidthWithMargin**: `any` -- **parent**: `any` -- **querySelectorAll**: `any` -- **remove**: `any` -- **removeChild**: `any` -- **removeChildren**: `any` -- **removeClass**: `any` -- **setAttribute**: `any` -- **setOffset**: `any` -- **setProperty**: `any` -- **setRawPosition**: `any` -- **setRawSize**: `any` -- **setRawStyleProperty**: `any` -- **setRawText**: `any` -- **setRawXPosition**: `any` -- **setRawYPosition**: `any` -- **setStyleProperty**: `any` -- **setText**: `any` -- **show**: `any` -- **unlistenAll**: `any` -- **width**: `any` - -### [DomWrapperPosition](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/DomWrapperPosition) - -- **left**: `number` -- **top**: `number` - -### [EnumInfo](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/EnumInfo) - -- **actualNames**: `string[]` -- **actualNamesValuesMap**: `any` -- **mustCoerceToInt**: `Boolean` -- **names**: `string[]` -- **namesValuesMap**: `any` - -### [ICollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/ICollection) - -- **count**: `number` -- **isSynchronized**: `boolean` -- **syncRoot**: `any` -- **copyTo**: `any` - -### [ICollection$1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/ICollection$1) - -- **count**: `number` -- **isReadOnly**: `boolean` -- **add**: `any` -- **clear**: `any` -- **contains**: `any` -- **copyTo**: `any` -- **remove**: `any` - -### [IComparable](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IComparable) - -- **compareToObject**: `any` - -### [IComparable$1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IComparable$1) - -- **compareTo**: `any` - -### [IConvertible](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IConvertible) - -- **toBoolean**: `any` -- **toByte**: `any` -- **toChar**: `any` -- **toDateTime**: `any` -- **toDecimal**: `any` -- **toDouble**: `any` -- **toInt16**: `any` -- **toInt32**: `any` -- **toInt64**: `any` -- **toSByte**: `any` -- **toSingle**: `any` -- **toString1**: `any` -- **toUInt16**: `any` -- **toUInt32**: `any` -- **toUInt64**: `any` - -### [IDictionary](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IDictionary) - - -### [IDisposable](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IDisposable) - -- **dispose**: `any` - -### [IEnumerable](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IEnumerable) - -- **getEnumeratorObject**: `any` - -### [IEnumerable$1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IEnumerable$1) - -- **getEnumerator**: `any` - -### [IEnumerator](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IEnumerator) - -- **currentObject**: `any` -- **moveNext**: `any` -- **reset**: `any` - -### [IEnumerator$1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IEnumerator$1) - -- **current**: `T` -- **moveNext**: `any` -- **reset**: `any` - -### [IEqualityComparer](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IEqualityComparer) - -- **equals**: `any` -- **getHashCode**: `any` - -### [IEqualityComparer$1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IEqualityComparer$1) - -- **equalsC**: `any` -- **getHashCodeC**: `any` - -### [IEquatable$1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IEquatable$1) - -- **equals**: `any` - -### [IFormatProvider](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IFormatProvider) - -- **getFormat**: `any` - -### [IgDataTemplate](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IgDataTemplate) - -- **measure**: `any` -- **passCompleted**: `any` -- **passStarting**: `any` -- **render**: `any` - -### [IgPoint](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IgPoint) - -- **x**: `number` -- **y**: `number` - -### [IgRect](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IgRect) - -- **height**: `number` -- **left**: `number` -- **top**: `number` -- **width**: `number` - -### [IgSize](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IgSize) - -- **height**: `number` -- **width**: `number` - -### [IList](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IList) - -- **isFixedSize**: `boolean` -- **isReadOnly**: `boolean` -- **isSynchronized**: `boolean` -- **add**: `any` -- **clear**: `any` -- **contains**: `any` -- **indexOf**: `any` -- **insert**: `any` -- **item**: `any` -- **remove**: `any` -- **removeAt**: `any` - -### [IList$1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IList$1) - -- **indexOf**: `any` -- **insert**: `any` -- **item**: `any` -- **removeAt**: `any` - -### [INotifyPropertyChanged](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/INotifyPropertyChanged) - -- **propertyChanged**: `any` - -### [IRenderTemplateObject](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/IRenderTemplateObject) - -- **strings**: `TemplateStringsArray` -- **values**: `any` - -### [LegacyGestureEvent](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/LegacyGestureEvent) - -- **scale**: `number` - -### [NormalizedEvent](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/NormalizedEvent) - -- **button**: `number` -- **originalEvent**: `MouseEvent & TouchEvent & PointerEvent & LegacyGestureEvent & WheelEvent` -- **pageX**: `number` -- **pageY**: `number` -- **target**: `Node` — Returns the object to which event is dispatched (its target). -- **wheelDelta?**: `number` - -### [Point](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/Point) - -- **x**: `number` -- **y**: `number` - -### [XmlAttribute](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/XmlAttribute) - -- **childNodes**: `XmlNodeList` -- **cloneNode**: `any` - -### [XmlDocument](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/XmlDocument) - -- **childNodes**: `XmlNodeList` -- **documentElement**: `XmlElement` -- **cloneNode**: `any` -- **createElementNS**: `any` -- **createNode**: `any` -- **importNode**: `any` - -### [XmlElement](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/XmlElement) - - -### [XmlLinkedNode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/XmlLinkedNode) - - -### [XmlNamedNodeMap](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/XmlNamedNodeMap) - -- **getQualifiedItem**: `any` - -### [XmlNode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/XmlNode) - -- **attributes**: `XmlNodeList` -- **baseName**: `string` -- **childNodes**: `XmlNodeList` -- **localName**: `string` -- **namespaceURI**: `string` -- **nodeType**: `XmlNodeType` -- **nodeValue**: `string` -- **ownerDocument**: `XmlDocument` -- **text**: `string` -- **textContent**: `string` -- **value**: `string` -- **xml**: `string` -- **appendChild**: `any` -- **cloneNode**: `any` -- **getAttributeNodeNS**: `any` -- **removeChild**: `any` -- **setAttributeNode**: `any` - -### [XmlNodeList](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/interfaces/XmlNodeList) - -- **length**: `number` -- **item**: `any` - -## Enumerations - -### [BaseControlTheme](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/BaseControlTheme) - -- **Default** = 0 -- **DenaliLight** = 1 -- **MaterialLight** = 2 -- **RevealDark** = 6 -- **RevealLight** = 5 -- **SlingshotDark** = 4 -- **SlingshotLight** = 3 - -### [CalendarWeekRule](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/CalendarWeekRule) - -- **FirstDay** = 0 -- **FirstFourDayWeek** = 2 -- **FirstFullWeek** = 1 - -### [CalloutCollisionMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/CalloutCollisionMode) -An enum representing the available collision modes of callout layers. - -- **Auto** = 0 — Automatically decide the collision strategy. -- **Greedy** = 2 — Use a greedy algorithm to avoid collisions. This is cheap and predictable, but of comparatively low quality. -- **GreedyCenterOfMass** = 3 — Use a greedy algorithm with localized center of mass hints to avoid collisions. This is relatively cheap to perform, compared to the simulated annealing approach, but is of comparatively lower quality. -- **RadialBestFit** = 4 — If slice anchors are present, either fit the labels inside the slices or outside, depending on collisions. -- **RadialCenter** = 7 — If slice anchors are present, fit the labels inside the slices. -- **RadialInsideEnd** = 5 — If slice anchors are present, either fit the labels inside the slices or outside, depending on collisions. -- **RadialOutsideEnd** = 6 — If slice anchors are present, either fit the labels inside the slices or outside, depending on collisions. -- **SimulatedAnnealing** = 1 — Use a simulated annealing based collision strategy. This is higher quality, but takes longer, and is performed time-sliced in the background until an acceptable quality is reached. - -### [CancelBehavior](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/CancelBehavior) - -- **KeepCurrent** = 0 -- **ToBeginning** = 2 -- **ToEnd** = 1 - -### [CaptureImageFormat](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/CaptureImageFormat) - -- **Jpeg** = 1 -- **Png** = 0 - -### [CodeGenerationLibraryItemContentLocation](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/CodeGenerationLibraryItemContentLocation) - -- **CDN** = 2 -- **CDNSkipHydrate** = 3 -- **Code** = 0 -- **JsonFile** = 1 - -### [CodeGenerationLibraryItemPlatform](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/CodeGenerationLibraryItemPlatform) - -- **All** = 11 -- **AllWeb** = 7 -- **Angular** = 0 -- **Blazor** = 14 -- **Desktop** = 8 -- **DotNet** = 13 -- **JQuery** = 3 -- **React** = 1 -- **Unknown** = 12 -- **Web** = 6 -- **WebComponents** = 2 -- **Win** = 9 -- **WindowsForms** = 5 -- **WPF** = 4 -- **XPlat** = 10 - -### [CodeGenerationLibraryItemType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/CodeGenerationLibraryItemType) - -- **Data** = 0 -- **EventHandler** = 1 -- **Template** = 2 -- **Unknown** = 3 - -### [CodeGenerationTargetPlatforms](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/CodeGenerationTargetPlatforms) - -- **Angular** = 1 -- **Blazor** = 5 -- **React** = 2 -- **WebComponents** = 3 -- **WindowsForms** = 4 -- **WPF** = 0 - -### [CollisionGeometryType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/CollisionGeometryType) - -- **Box** = 0 -- **Boxes** = 1 -- **Circle** = 3 -- **PieSlice** = 2 - -### [CompareOptions](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/CompareOptions) - -- **IgnoreCase** = 1 -- **IgnoreKanaType** = 8 -- **IgnoreNonSpace** = 2 -- **IgnoreSymbols** = 4 -- **IgnoreWidth** = 16 -- **None** = 0 -- **Ordinal** = 1073741824 -- **OrdinalIgnoreCase** = 268435456 -- **StringSort** = 536870912 - -### [ControlDisplayDensity](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ControlDisplayDensity) - -- **Auto** = 0 -- **Comfortable** = 1 -- **Compact** = 3 -- **Cosy** = 2 -- **Minimal** = 4 - -### [DataAbbreviationMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataAbbreviationMode) -Describes the mode used to abbreviate large numbers - -- **Auto** = 0 — Specifies abbreviation that is automatically resolves to shared abbreviation between multiple numbers, 2.5K for 2,500 and 2500K for 2,500,000 -- **Billion** = 5 — Specifies number abbreviation to billion, 2.5B for 2,500,000,000 -- **Independent** = 1 — Specifies independent abbreviation for multiple numbers, 2.5K for 2,500 and 2.5M for 2,500,000 -- **Kilo** = 3 — Specifies number abbreviation to thousands, 2.5K for 2,500 -- **Million** = 4 — Specifies number abbreviation to millions, 2.5M for 2,500,000 -- **None** = 9 — Specifies no abbreviation of numbers -- **Quadrillion** = 7 — Specifies number abbreviation to quadrillion, 2.5Q for 2,500,000,000,000,000 -- **Shared** = 2 — Specifies shared abbreviation between multiple numbers, 2.5K for 2,500 and 2500K for 2,500,000 -- **Trillion** = 6 — Specifies number abbreviation to trillion, 2.5T for 2,500,000,000,000 -- **Unset** = 8 — Specifies default abbreviation - -### [DataLegendHeaderDateMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataLegendHeaderDateMode) -Describes mode for formatting date in header of data legend - -- **Auto** = 0 — Specifies automatic date format that defaults to short string -- **FullStyle** = 4 — Specifies date as full string in header row of data legend -- **LongStyle** = 2 — Specifies date as long string in header row of data legend -- **MediumStyle** = 3 — Specifies date as medium string in header row of data legend -- **None** = 5 — Specifies no date in header row of data legend -- **ShortStyle** = 1 — Specifies date as short string in header row of data legend - -### [DataLegendHeaderTimeMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataLegendHeaderTimeMode) -Describes mode for formatting time in header of data legend - -- **Auto** = 0 — Specifies automatic time format that defaults to no string -- **FullStyle** = 4 — Specifies time as full string in header row of data legend -- **LongStyle** = 2 — Specifies time as long string in header row of data legend -- **MediumStyle** = 3 — Specifies time as medium string in header row of data legend -- **None** = 5 — Specifies no time in header row of data legend -- **ShortStyle** = 1 — Specifies time as short string in header row of data legend - -### [DataLegendLabelMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataLegendLabelMode) -Describes mode for displaying labels before series values in the data legend. - -- **Auto** = 0 — Specifies automatic labels based on series type, e.g. "O: H: L: C:" for Financial Series -- **Hidden** = 2 — Specifies hidden labels before series values -- **Visible** = 1 — Specifies always visible labels before series values - -### [DataLegendLayoutMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataLegendLayoutMode) -Describes mode for displaying values in the data legend. - -- **Table** = 0 — Specifies a layout mode where values of series are placed in columns of a table -- **Vertical** = 1 — Specifies a layout mode where values of series are stacked vertically below series title - -### [DataLegendSeriesFamily](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataLegendSeriesFamily) -Describes type of data columns to use for the data legend. - -- **Category** = 0 — Specifies the Category series -- **Financial** = 2 — Specifies the Financial Price series -- **Geographic** = 9 — Specifies the Geographic series -- **Highlight** = 10 — Specifies the Highlight series -- **Indicator** = 3 — Specifies the Financial Indicator series -- **Polar** = 4 — Specifies the Polar series -- **Radial** = 5 — Specifies the Radial series -- **Range** = 1 — Specifies the Range series -- **Scatter** = 6 — Specifies the Scatter series -- **Shape** = 8 — Specifies the Shape series -- **Stacked** = 7 — Specifies the Stacked series - -### [DataLegendSeriesValueType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataLegendSeriesValueType) -Describes type of data columns to use for the data legend. - -- **Angle** = 10 — Specifies the Angle data column for the polar series -- **Average** = 6 — Specifies the average column between high/low for the range series -- **Change** = 9 — Specifies the Change data column for the financial price series -- **Close** = 4 — Specifies the Close data column for the financial price series -- **Fill** = 12 — Specifies the Fill data column for the bubble series -- **High** = 2 — Specifies the High data column for the financial price series and range series -- **Low** = 1 — Specifies the Low data column for the financial price series and range series -- **Open** = 3 — Specifies the Open data column for the financial price series -- **Radius** = 11 — Specifies the Radius data column for the polar series, radial series, and bubble series -- **Range** = 7 — Specifies the range column between high/low for the range series -- **Summary** = 15 — Specifies the summary data columns for all series -- **TypicalPrice** = 5 — Specifies the typical price column for the financial price series: (high + low + close) / 3 -- **Value** = 0 — Specifies the Value data column for the category series and radial series -- **Volume** = 8 — Specifies the Volume data column for the financial price series -- **XValue** = 13 — Specifies the X data column for the bubble series and scatter series -- **YValue** = 14 — Specifies the Y data column for the bubble series and scatter series - -### [DataLegendSummaryType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataLegendSummaryType) -Describes type of summarization to use for the data legend. - -- **Auto** = 0 — Specifies automatic summarization -- **Average** = 2 — Specifies average of values in summary row -- **Max** = 4 — Specifies maximum of values in summary row -- **Min** = 3 — Specifies minimum of values in summary row -- **None** = 5 — Specifies no summarization -- **Total** = 1 — Specifies total of values in summary row - -### [DataLegendUnitsMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataLegendUnitsMode) -Describes mode for displaying units after series values in the data legend. - -- **Auto** = 0 — Specifies automatic visibility of units based on series type -- **Hidden** = 2 — Specifies hidden units after series values -- **Visible** = 1 — Specifies always visible units after series values - -### [DataLegendValueMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataLegendValueMode) -Describes mode for displaying values in the data legend. - -- **Auto** = 0 — Specifies automatic mode that resolves to best value display mode -- **Currency** = 2 — Specifies values with currency symbol, e.g. $170.25 for 170.25 -Note symbol of the currency depends on the ValueFormatCulture property -- **Decimal** = 1 — Specifies values as decimal number, e.g. 170.25 for 170.25 - -### [DataSeriesAxisType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataSeriesAxisType) -Indicates which axis type is suggested in a data series. - -- **Category** = 0 — Used when a category axis type is suggested. -- **CategoryAngle** = 5 — Used when an angular category axis is suggested. -- **ContinuousDateTime** = 3 — Used when a continuous date time axis type is suggested. -- **DiscreteDateTime** = 4 — Used when a discrete date time axis type is suggested. -- **Linear** = 1 — Used when a linear axis type is suggested. -- **Logarithmic** = 2 — Used when a logarithmic axis type is suggested. -- **NotApplicable** = 9 — Used when an axis is not applicable. -- **ProportionalCategoryAngle** = 6 — Used when a proportional category angle axis is suggested. -- **RadialLinear** = 7 — Used when a radial axis is suggested. -- **RadialLogarithmic** = 8 — Used when a logarithmic radial axis is suggested. - -### [DataSeriesIntent](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataSeriesIntent) -Identifies various intents for the sub properties of the data being bound to a data series. - -- **AxisDateValue** = 17 — Identifies an axis date value to use for a series. -- **AxisLabelValue** = 16 — Identifies an axis label value to use for a series. -- **CloseSeriesValue** = 14 — Identifies a close value to use for a financial series or range series. -- **DontPlot** = 18 — Identifies that a value should be ignored when considering values for a series. -- **GenerationInput** = 25 — Identifes a value that has been used to generate other data to bind against. -- **HighSeriesValue** = 12 — Identifies a high value to use for a financial series or range series. -- **LowSeriesValue** = 13 — Identifies a low value to use for a financial series or range series. -- **OpenSeriesValue** = 11 — Identifies an open value to use for a financial series. -- **PrimarySeriesValue** = 0 — Identifies the primary values to use for a series. -- **SalesFixedCost** = 20 — Identifies a sales fixed cost to use for a break-even series -- **SalesMarginalProfit** = 24 — Identifies a sales marginal profit to use for a break-even series -- **SalesRevenue** = 23 — Identifies a sales revenue to use for a break-even series -- **SalesTotalCost** = 22 — Identifies a sales total cost to use for a break-even series -- **SalesUnit** = 19 — Identifies a sales units value to use for a break-even series -- **SalesVariableCost** = 21 — Identifies a sales variable cost to use for a break-even series -- **SeriesAngle** = 6 — Identifies the angle values to use for a polar or radial series. -- **SeriesFill** = 3 — Identifies the fill scale values to use for a bubble series or scatter area series. -- **SeriesGroup** = 9 — Identifies a grouping identifier to use for a series. -- **SeriesLabel** = 4 — Identifies the legend label values to use for a bubble series in item-wize legends. -- **SeriesRadius** = 5 — Identifies the radius values to use for a bubble, polar, or radial series. -- **SeriesShape** = 7 — Identifies the shape values to use for a scatter polyline or polygon series. -- **SeriesTitle** = 10 — Identifies a title to use for a series. -- **SeriesValue** = 8 — Identifies the item-wize values to use for a series. -- **SeriesX** = 1 — Identifies the x axis values to use for a scatter series. -- **SeriesY** = 2 — Identifies the y axis values to use for a scatter series. -- **VolumeSeriesValue** = 15 — Identifies a volume value to use for a financial series or range series. - -### [DataSeriesMarker](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataSeriesMarker) -Identifies which type of marker is suggested for a data series. - -- **Automatic** = 0 — Used when Automatic marker shape is suggested. -- **Circle** = 2 — Used when Circle marker shape is suggested. -- **Diamond** = 6 — Used when Diamond marker shape is suggested. -- **Hexagon** = 8 — Used when Hexagon marker shape is suggested. -- **Hexagram** = 11 — Used when Six-pointed star marker shape is suggested. -- **Hidden** = 12 — Used when a hidden marker is suggested. -- **None** = 1 — Used when no marker is suggested. -- **Pentagon** = 7 — Used when Pentagon marker shape is suggested. -- **Pentagram** = 10 — Used when Five-pointed star marker shape is suggested. -- **Pyramid** = 4 — Used when Flat-base triangle marker shape is suggested. -- **Smart** = 13 — Used when a hidden marker is suggested. -- **Square** = 5 — Used when Square marker shape is suggested. -- **Tetragram** = 9 — Used when Four-pointed star marker shape is suggested. -- **Triangle** = 3 — Used when Flat-top triangle marker shape is suggested. - -### [DataSeriesPropertyType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataSeriesPropertyType) - -- **DateTime** = 1 -- **Numeric** = 2 -- **string1** = 0 - -### [DataSeriesType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataSeriesType) -Identifies which type of series is suggested for a data series. - -- **Area** = 2 — Used when an area series is suggested. -- **Bar** = 3 — Used when a bar series is suggested. -- **CalloutLayer** = 28 — Used when a callout layer is suggested. -- **CategoryHighlightLayer** = 30 — Used when a category highlight layer is suggested. -- **CategoryItemHighlightLayer** = 31 — Used when a category item highlight layer is suggested. -- **CategoryToolTipLayer** = 26 — Used when a category tooltip layer is suggested. -- **Column** = 1 — Used when a column series is suggested. -- **CrosshairLayer** = 27 — Used when a crosshair layer is suggested. -- **DataToolTipLayer** = 32 — Used when a data tooltip layer is suggested. -- **FinalValueLayer** = 29 — Used when a final value layer is suggested. -- **FinancialIndicator** = 21 — Used when an financial indicator series is suggested. -- **FinancialOverlay** = 22 — Used when a financial overlay series is suggested. -- **FinancialPrice** = 20 — Used when a financial price series is suggested. -- **GeographicBubble** = 44 — Used when a geographic bubble series is suggested. -- **GeographicContour** = 42 — Used when a geographic contour series is suggested. -- **GeographicHeat** = 46 — Used when a geographic head map series is suggested. -- **GeographicHighDensity** = 43 — Used when a geographic high density scatter series is suggested. -- **GeographicPolygon** = 45 — Used when a geographic polygon series is suggested. -- **GeographicPolyline** = 40 — Used when a geographic polyline series is suggested. -- **GeographicScatter** = 39 — Used when a geographic point series is suggested. -- **GeographicScatterArea** = 41 — Used when a geographic scatter area series is suggested. -- **ItemToolTipLayer** = 25 — Used when an item tooltip layer is suggested. -- **Line** = 0 — Used when a line series is suggested. -- **LinearGauge** = 38 — Used when a linear gauge is recommended. -- **Pie** = 35 — Used when a pie chart is suggested. -- **Point** = 10 — Used when a point series is suggested. -- **RadialGauge** = 37 — Used when a radial gauge is recommended. -- **RadialLine** = 36 — Used when a radial line series is suggested. -- **ScatterArea** = 14 — Used when a scatter area series is suggested. -- **ScatterBubble** = 17 — Used when a bubble series is suggested. -- **ScatterContour** = 15 — Used when a scatter contour series is suggested. -- **ScatterHighDensity** = 16 — Used when a high density scatter series is suggested. -- **ScatterLine** = 12 — Used when a scatter line series is suggested. -- **ScatterPoint** = 11 — Used when a scatter point series is suggested. -- **ScatterPolygon** = 18 — Used when a polygon series is suggested. -- **ScatterPolyline** = 19 — Used when a polyline series is suggested. -- **ScatterSpline** = 13 — Used when a scatter spline series is suggested. -- **Spline** = 6 — Used when a spline series is suggested. -- **SplineArea** = 7 — Used when a spline area series is suggested. -- **Stacked** = 9 — Used when a stacked series is suggested. -- **StepArea** = 5 — Used when a step area series is suggested. -- **StepLine** = 4 — Used when a step line series is suggested. -- **TrendLineLayer** = 34 — Used when a trend line layer is suggested. -- **Unknown** = 24 — Specifies unknown series type -- **ValueLayer** = 33 — Used when a value layer is suggested. -- **ValueOverlay** = 23 — Used when a value overlay is suggested. -- **Waterfall** = 8 — Used when a waterfall series is suggested. - -### [DataSourcePageRequestPriority](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataSourcePageRequestPriority) -Indicates the priority for a page request. - -- **High** = 2 — Indicates a request with high priority. -- **Low** = 0 — Indicates a request with low priority. -- **Normal** = 1 — Indicates a request with normal priority. - -### [DataSourceRowType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataSourceRowType) -The row type. - -- **Custom** = 6 — Custom -- **Normal** = 0 — Normal row -- **SectionFooter** = 2 — Section footer -- **SectionHeader** = 1 — Section header -- **ShiftedRow** = 3 — A shited row -- **SummaryRowRoot** = 4 — A summary row at the root level -- **SummaryRowSection** = 5 — A summary row at the section level - -### [DataSourceSchemaPropertyType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataSourceSchemaPropertyType) -Enumerates the available property types on a data source schema. - -- **BooleanValue** = 2 — The property is of type boolean. -- **ByteValue** = 10 — The property is of type byte. -- **DateTimeOffsetValue** = 9 — The property is of type datetimeoffset. -- **DateTimeValue** = 8 — The property is of type datetime. -- **DecimalValue** = 6 — The property is of type decimal. -- **DoubleValue** = 5 — The property is of type double. -- **IntValue** = 1 — The property is of type integer. -- **LongValue** = 3 — The property is of type long. -- **ObjectValue** = 11 — The property is of type object. -- **ShortValue** = 4 — The property if of type short. -- **SingleValue** = 7 — The property is of type single. -- **StringValue** = 0 — The property is of type string. - -### [DataSourceSectionHeaderDisplayMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataSourceSectionHeaderDisplayMode) -Enumerates possible display modes for section headers. - -- **Combined** = 0 — Each group is preceded by a single section header that combines multiple groups into one. -- **Split** = 1 — Each group may be preceded by multiple section headers, one for each group. - -### [DataSourceSummaryOperand](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataSourceSummaryOperand) - -- **Average** = 3 -- **Count** = 4 -- **Custom** = 5 -- **Max** = 1 -- **Min** = 0 -- **Sum** = 2 - -### [DataSourceSummaryScope](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataSourceSummaryScope) -Enumerates different calculation modes for summaries in the data source. - -- **Both** = 0 — Summaries are calculated for both the root and section level. -- **Groups** = 2 — Summaries are only calculated at the group level. -- **None** = 3 — Summaries are not calculated at all. -- **Root** = 1 — Summaries are only calculated at the root level. - -### [DataTooltipGroupedPositionX](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataTooltipGroupedPositionX) -Describes available positions on the X axis at which the summary tooltip to be displayed. - -- **Auto** = 0 — A position on the X axis is selected automatically. -- **LeftEdgeSnapLeft** = 4 — Aligns the tooltip so that it appears to the left of the horizontal snap point of the current series if applicable. -- **LeftEdgeSnapMiddle** = 6 — Aligns the tooltip so that it appears at the middle of the horizontal snap point of the current series if applicable. -- **LeftEdgeSnapRight** = 5 — Aligns the tooltip so that it appears to the right of the horizontal snap point of the current series if applicable. -- **PinLeft** = 13 — Aligns the tooltip relative to the left plot area edge. -- **PinMiddle** = 15 — Aligns the tooltip width center with the width center of the plot area. -- **PinRight** = 14 — Aligns the tooltip relative to the right plot area edge. -- **RightEdgeSnapLeft** = 7 — Aligns the tooltip so that it appears to the left of the horizontal snap point of the current series if applicable. -- **RightEdgeSnapMiddle** = 9 — Aligns the tooltip so that it appears at the middle of the horizontal snap point of the current series if applicable. -- **RightEdgeSnapRight** = 8 — Aligns the tooltip so that it appears to the right of the horizontal snap point of the current series if applicable. -- **SnapLeft** = 1 — Aligns the tooltip so that it appears to the left of the horizontal snap point of the current series if applicable. -- **SnapMiddle** = 3 — Aligns the tooltip so that it appears at the middle of the horizontal snap point of the current series if applicable. -- **SnapRight** = 2 — Aligns the tooltip so that it appears to the right of the horizontal snap point of the current series if applicable. -- **TrackLeft** = 10 — Aligns the tooltip so that it appears to the left of the cursor. -- **TrackMiddle** = 12 — Aligns the tooltip so that the cursor appears in the center of the tooltip width. -- **TrackRight** = 11 — Aligns the tooltip so that it appears to the right of the cursor. - -### [DataTooltipGroupedPositionY](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataTooltipGroupedPositionY) -Describes available positions on the Y axis at which the summary tooltip to be displayed. - -- **Auto** = 0 — A position on the Y axis is selected automatically. -- **BottomEdgeSnapBottom** = 8 — Aligns the tooltip so that it appears at the bottom of the vertical snap point of the current series if applicable. -- **BottomEdgeSnapMiddle** = 9 — Aligns the tooltip so that it appears at the middle of the vertical snap point of the current series if applicable. -- **BottomEdgeSnapTop** = 7 — Aligns the tooltip so that it appears at the top of the vertical snap point of the current series if applicable. -- **PinBottom** = 14 — Aligns the tooltip relative to the bottom chart edge. -- **PinMiddle** = 15 — Aligns the tooltip height center with the height center of the chart. -- **PinTop** = 13 — Aligns the tooltip relative to the top chart edge. -- **SnapBottom** = 2 — Aligns the tooltip so that it appears at the bottom of the vertical snap point of the current series if applicable. -- **SnapMiddle** = 3 — Aligns the tooltip so that it appears at the middle of the vertical snap point of the current series if applicable. -- **SnapTop** = 1 — Aligns the tooltip so that it appears at the top of the vertical snap point of the current series if applicable. -- **TopEdgeSnapBottom** = 5 — Aligns the tooltip so that it appears at the bottom of the vertical snap point of the current series if applicable. -- **TopEdgeSnapMiddle** = 6 — Aligns the tooltip so that it appears at the middle of the vertical snap point of the current series if applicable. -- **TopEdgeSnapTop** = 4 — Aligns the tooltip so that it appears at the top of the vertical snap point of the current series if applicable. -- **TrackBottom** = 11 — Aligns the tooltip so that it appears at the bottom of the cursor. -- **TrackMiddle** = 12 — Aligns the tooltip so that the cursor appears in the center of the tooltip height. -- **TrackTop** = 10 — Aligns the tooltip so that it appears at the top of the cursor. - -### [DataToolTipLayerGroupingMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DataToolTipLayerGroupingMode) -Describes available positions on the crossing axis at which the category tooltip can be displayed. - -- **Auto** = 0 — A grouping mode is selected automatically -- **Grouped** = 1 — Displays a grouped tooltip based on the primary axis if possible. -- **Individual** = 2 — Displays individual tooltips for each series. - -### [DateTimeKind](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DateTimeKind) - -- **Local** = 2 -- **Unspecified** = 0 -- **Utc** = 1 - -### [DayOfWeek](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DayOfWeek) - -- **Friday** = 5 -- **Monday** = 1 -- **Saturday** = 6 -- **Sunday** = 0 -- **Thursday** = 4 -- **Tuesday** = 2 -- **Wednesday** = 3 - -### [DescriptionPathOperatorType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/DescriptionPathOperatorType) - -- **Combine** = 1 -- **None** = 0 - -### [ElevationMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ElevationMode) - -- **Auto** = 0 -- **HaloShadow** = 2 -- **MaterialShadow** = 1 - -### [EntityHandling](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/EntityHandling) - -- **ExpandCharEntities** = 2 -- **ExpandEntities** = 1 - -### [ErrorBarCalculatorReference](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ErrorBarCalculatorReference) -Describes available behaviors for choosing the direction of error bars calculation in scatter series. - -- **X** = 0 — Variable X. -- **Y** = 1 — Variable Y. - -### [ErrorBarCalculatorType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ErrorBarCalculatorType) -Describes available types of error bar calculators. - -- **Data** = 2 — A calculator type that provides the input values directly. -- **Fixed** = 0 — A calculator type that provides a fixed value. -- **Percentage** = 1 — A calculator type that provides a fixed percentage of each input value -- **StandardDeviation** = 3 — A calculator type that provides the standard deviation of the input values. -- **StandardError** = 4 — A calculator type that provides the standard error of the input values. - -### [FastItemsSourceEventAction](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/FastItemsSourceEventAction) -Describes available actions that can cause a DataSource event. - -- **Change** = 3 — An item property value changed in the data source. -- **Insert** = 1 — One or more rows were added to the data source. -- **Remove** = 0 — One or more rows were removed from the data source. -- **Replace** = 2 — One or more rows were replaced in the data source. -- **Reset** = 4 — The entire data source contents were reset. - -### [FillRule](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/FillRule) - -- **EvenOdd** = 0 -- **Nonzero** = 1 - -### [FilterExpressionFunctionType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/FilterExpressionFunctionType) -Indentifies the function type for a filter function expression. - -- **Cast** = 24 — Gets a value cast to a specific type. -- **Ceiling** = 19 — Ceilings a numeric value. -- **Concat** = 10 — Concatenates strings together. -- **Contains** = 0 — Determines if a string contains another. -- **Date** = 20 — Gets the date from a date/time. -- **Day** = 11 — Gets the day from a date/time. -- **EndsWith** = 1 — Determines if a string ends with another. -- **Env** = 25 — Gets a variable from the environment, if applicable -- **Floor** = 18 — Floors a numeric value. -- **Hour** = 12 — Gets the hour from a date/time. -- **IndexOf** = 4 — Gets the index of a string within another. -- **IsOf** = 23 — Gets whether the value matches a certain type. -- **Length** = 3 — Gets the length of a string. -- **Minute** = 13 — Gets the minute from a date/time. -- **Month** = 14 — Gets the month from a date/time. -- **Now** = 22 — Gets the current date/time. -- **Replace** = 5 — Replaces instances of a string within another with a separate string. -- **Round** = 17 — Rounds a numeric value. -- **Second** = 15 — Gets teh second from a date/time. -- **StartsWith** = 2 — Determines if a string starts with another. -- **Substring** = 6 — Gets the substring of a string based on start index and optionally length. -- **Time** = 21 — Gets the time from a date/time. -- **ToLower** = 7 — Gets the lowercase representation of a string. -- **ToUpper** = 8 — Gets the uppercase representation of a string. -- **Trim** = 9 — Trims the starting and ending whitespace from a string. -- **Year** = 16 — Gets the year from a date/time. - -### [FilterExpressionOperatorType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/FilterExpressionOperatorType) -Identifies the operator type of an operator filter expression. - -- **Add** = 10 — Adds two expressions. -- **And** = 7 — Applies the And operator to two expressions. -- **Divide** = 13 — Divides one expression by another. -- **Equal** = 1 — Determines if two expressions are equal. -- **GreaterThan** = 3 — Determines if an expression is greater than another. -- **GreaterThanOrEqual** = 4 — Determines if an expression is greater than or equal to another. -- **Grouping** = 15 — Groups an expression. -- **LessThan** = 5 — Determines if an expression is less than another. -- **LessThanOrEqual** = 6 — Determines if an expression is less than or equal to another. -- **Modulo** = 14 — Performs the modulus of one expression by another. -- **Multiply** = 12 — Multiplies two expressions. -- **None** = 0 — No operator type specified. -- **Not** = 9 — Applies the Not operator to a single expression. -- **NotEqual** = 2 — Determines if two expressions are not equal. -- **Or** = 8 — Applies the Or operator to two expressions. -- **Subtract** = 11 — Subtracts one expression from another. - -### [FilterExpressionWrapperType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/FilterExpressionWrapperType) -Identifies the type of wrapper expression. - -- **LastMonth** = 8 — A wrapper for the LastMonth expression. -- **LastQuarter** = 14 — A wrapper for the LastQuarter expression. -- **LastWeek** = 5 — A wrapper for the LastWeek expression. -- **LastYear** = 11 — A wrapper for the LastYear expression. -- **NextMonth** = 7 — A wrapper for the NextMonth expression. -- **NextQuarter** = 13 — A wrapper for the NextQuarter expression. -- **NextWeek** = 4 — A wrapper for the NextWeek expression. -- **NextYear** = 10 — A wrapper for the NextYear expression. -- **Q1** = 16 — A wrapper for the Q1 expression. -- **Q2** = 17 — A wrapper for the Q2 expression. -- **Q3** = 18 — A wrapper for the Q3 expression. -- **Q4** = 19 — A wrapper for the Q4 expression. -- **ThisMonth** = 6 — A wrapper for the ThisMonth expression. -- **ThisQuarter** = 12 — A wrapper for the ThisQuarter expression. -- **ThisWeek** = 3 — A wrapper for the ThisWeek expression. -- **ThisYear** = 9 — A wrapper for the ThisYear expression. -- **Today** = 0 — A wrapper for the Today expression. -- **Tomorrow** = 1 — A wrapper for the Tomorrow expression. -- **YearToDate** = 15 — A wrapper for the YearToDate expression. -- **Yesterday** = 2 — A wrapper for the Yesterday expression. - -### [FlatDataProviderJoinCollisionType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/FlatDataProviderJoinCollisionType) -Enumerates the join types available to the flat data provider. - -- **Auto** = 0 — Retention is based on the join type. -- **LeftOnly** = 1 — Retains values only if they are from left. -- **PreferLeft** = 3 — Prefers to retain values from left. -- **PreferRight** = 4 — Prefers to retain values from right. -- **RightOnly** = 2 — Retains values only if they are from right. - -### [FlatDataProviderJoinType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/FlatDataProviderJoinType) -Enumerates the join types available to the flat data provider. - -- **Join** = 0 — Performs an inner join. -- **Left** = 1 — Performs a left outer join. -- **Right** = 2 — Performs a right outer join. - -### [Formatting](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/Formatting) - -- **Indented** = 1 -- **None** = 0 - -### [GenericDataSourceSchemaPropertyType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/GenericDataSourceSchemaPropertyType) -Enumerates the available property types on a data source schema. - -- **BooleanValue** = 0 — The property is of type boolean. -- **DateTimeValue** = 3 — The property is of type datetime. -- **DoubleValue** = 2 — The property is of type double. -- **IntValue** = 1 — The property is of type integer. -- **StringValue** = 4 — The property is of type string. - -### [GeometryType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/GeometryType) - -- **Ellipse** = 3 -- **Group** = 0 -- **Line** = 1 -- **Path** = 4 -- **Rectangle** = 2 - -### [GradientDirection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/GradientDirection) -Describes available behaviors for setting direction of linear gradient brush or a radial gradient brush - -- **BottomTop** = 1 — Specifies from bottom to top direction of gradient brush -- **LeftRight** = 2 — Specifies from left to right direction of gradient brush -- **Radial** = 4 — Specifies radial gradient brush -- **RightLeft** = 3 — Specifies from right to left direction of gradient brush -- **TopBottom** = 0 — Specifies from top to bottom direction of gradient brush - -### [HighlightedValueDisplayMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/HighlightedValueDisplayMode) - -- **Auto** = 0 -- **Hidden** = 1 -- **Overlay** = 2 - -### [HighlightedValueLabelMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/HighlightedValueLabelMode) -Describes the label mode for highlighted series. - -- **Auto** = 0 -- **LabelBoth** = 3 -- **PreferHighlighted** = 2 -- **PreferOriginal** = 1 - -### [HighlightingState](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/HighlightingState) -Describes available highlighting states - -- **inward** = 1 — Highlight is transitioning in. -- **outward** = 0 — Highlight is transitioning out. -- **Static** = 2 — Highlight is active and not transitioning in or out. - -### [HighlightState](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/HighlightState) -Enum specifying state of the highlight value - -- **Hidden** = 0 -- **Hiding** = 5 -- **Showing** = 2 -- **Shown** = 3 -- **StartHiding** = 4 -- **StartShowing** = 1 - -### [HorizontalAlignment](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/HorizontalAlignment) -Indicates the horizontal position of an item relative to another object. - -- **Center** = 1 — Center the item -- **Left** = 0 — Align the item to the left -- **Right** = 2 — Align the item to the right -- **Stretch** = 3 — Stretch the item to the full width - -### [InteractionState](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/InteractionState) -Describes available interaction states of the chart or geographic map control. - -- **Auto** = 4 — User gesture will start a pan action in a touch environment and a drag rectangle in a mouse environment. -- **DragPan** = 2 — User gesture will start a pan action to move the chart's window. -- **DragSelect** = 3 — User gesture will start a drag selection to selected parf of the chart -- **DragZoom** = 1 — User gesture will start a drag rectangle to zoom the chart. -- **None** = 0 — User gesture will not change the state of the chart. - -### [InterpolationMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/InterpolationMode) -Describes available modes for color interpolation. - -- **HSV** = 1 — Interpolation in HSV space. -- **RGB** = 0 — Interpolation in RGB space. - -### [Key](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/Key) - -- **A** = 30 -- **Add** = 79 -- **Alt** = 6 -- **B** = 31 -- **Back** = 1 -- **C** = 32 -- **CapsLock** = 7 -- **Ctrl** = 5 -- **D** = 33 -- **D0** = 20 -- **D1** = 21 -- **D2** = 22 -- **D3** = 23 -- **D4** = 24 -- **D5** = 25 -- **D6** = 26 -- **D7** = 27 -- **D8** = 28 -- **D9** = 29 -- **Decimal** = 81 -- **del** = 19 -- **Divide** = 82 -- **Down** = 17 -- **E** = 34 -- **End** = 12 -- **Enter** = 3 -- **Escape** = 8 -- **F** = 35 -- **F1** = 56 -- **F10** = 65 -- **F11** = 66 -- **F12** = 67 -- **F2** = 57 -- **F3** = 58 -- **F4** = 59 -- **F5** = 60 -- **F6** = 61 -- **F7** = 62 -- **F8** = 63 -- **F9** = 64 -- **G** = 36 -- **H** = 37 -- **Home** = 13 -- **I** = 38 -- **Insert** = 18 -- **J** = 39 -- **K** = 40 -- **L** = 41 -- **Left** = 14 -- **M** = 42 -- **Multiply** = 78 -- **N** = 43 -- **None** = 0 -- **NumPad0** = 68 -- **NumPad1** = 69 -- **NumPad2** = 70 -- **NumPad3** = 71 -- **NumPad4** = 72 -- **NumPad5** = 73 -- **NumPad6** = 74 -- **NumPad7** = 75 -- **NumPad8** = 76 -- **NumPad9** = 77 -- **O** = 44 -- **OemMinus** = 88 -- **OemPipe** = 85 -- **OemPlus** = 87 -- **OemQuestion** = 84 -- **OemSemicolon** = 83 -- **OemTilde** = 86 -- **P** = 45 -- **PageDown** = 11 -- **PageUp** = 10 -- **Q** = 46 -- **R** = 47 -- **Right** = 16 -- **S** = 48 -- **Shift** = 4 -- **Space** = 9 -- **Subtract** = 80 -- **T** = 49 -- **Tab** = 2 -- **U** = 50 -- **Unknown** = 255 -- **Up** = 15 -- **V** = 51 -- **W** = 52 -- **X** = 53 -- **Y** = 54 -- **Z** = 55 - -### [LegendEmptyValuesMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/LegendEmptyValuesMode) -Describes available modes for displaying empty values in chart legend. - -- **AlwaysHidden** = 0 — Always hide legend items for zero values regradless of the Others Category. -- **AlwaysVisible** = 1 — Always show legend items for zero values even when the Others Category is present. -- **ShowWhenNoOthersCategory** = 2 — Show legend items for zero values only when the Others Category is not present. - -### [LegendItemBadgeMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/LegendItemBadgeMode) -Describes mode of legend badges that represent all series in a legend - -- **MatchSeries** = 1 — Specifies legend badges that match all visuals of series such as thickness and markers (if supported by a series) -- **Simplified** = 0 — Specifies legend badges with simplified visuals of series, e.g. with fixed thickness, no overlaid markers - -### [LegendItemBadgeShape](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/LegendItemBadgeShape) -Describes the type of legend badge that represents a series in a legend - -- **Automatic** = 0 — Specifies automatic badge with best match of series type, e.g. Square badge for Area Series, Line badge for Line Series etc. -- **Bar** = 5 — Specifies a thick horizontal bar in a legend -- **Circle** = 1 — Specifies a circle badge in a legend -- **Column** = 6 — Specifies a thick vertical column in a legend -- **Hidden** = 7 — Specifies hidden badge in a legend, next to the series title -- **Line** = 2 — Specifies a thin line badge in a legend -- **Marker** = 4 — Specifies a marker badge in a legend (if series supports markers otherwise a circle badge) -- **Square** = 3 — Specifies a square badge in a legend - -### [ListSortDirection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ListSortDirection) - -- **Ascending** = 0 -- **Descending** = 1 - -### [ModifierKeys](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ModifierKeys) - -- **Alt** = 1 -- **Apple** = 8 -- **Control** = 2 -- **None** = 0 -- **Shift** = 4 -- **Windows** = 8 - -### [MouseButton](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/MouseButton) - -- **Left** = 0 -- **Middle** = 1 -- **Right** = 2 -- **Unkown** = 3 - -### [NativeUIElementFactoryFlavor](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/NativeUIElementFactoryFlavor) - -- **NativePlatform** = 1 -- **None** = 0 -- **XPlat** = 2 - -### [NeedleBeingDragged](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/NeedleBeingDragged) -Enum specifying which needle if any is being dragged - -- **Highlight** = 2 -- **Main** = 1 -- **None** = 0 - -### [NotifyCollectionChangedAction](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/NotifyCollectionChangedAction) - -- **Add** = 0 -- **Remove** = 1 -- **Replace** = 2 -- **Reset** = 4 - -### [NumberStyles](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/NumberStyles) - -- **AllowCurrencySymbol** = 256 -- **AllowDecimalPoint** = 32 -- **AllowExponent** = 128 -- **AllowHexSpecifier** = 512 -- **AllowLeadingSign** = 4 -- **AllowLeadingWhite** = 1 -- **AllowParentheses** = 16 -- **AllowThousands** = 64 -- **AllowTrailingSign** = 8 -- **AllowTrailingWhite** = 2 -- **Any** = 511 -- **Currency** = 383 -- **Float** = 167 -- **HexNumber** = 515 -- **Integer** = 7 -- **None** = 0 -- **Number** = 111 - -### [OthersCategoryType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/OthersCategoryType) -Describes available behaviors for calculating and grouping slices into the Others slice. - -- **Number** = 0 — Data value is compared directly to the value of OthersCategoryThreshold. -- **Percent** = 1 — Data value is compared to OthersCategoryThreshold as a percentage of the total. - -### [PathSegmentType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/PathSegmentType) - -- **Arc** = 4 -- **Bezier** = 1 -- **Line** = 0 -- **PolyBezier** = 2 -- **PolyLine** = 3 - -### [PenLineCap](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/PenLineCap) -Indicates the type of shape at the end of a line. - -- **Flat** = 0 — A flat end -- **Round** = 2 — A round end -- **Square** = 1 — A square end -- **Triangle** = 3 — A triangluar end - -### [PenLineJoin](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/PenLineJoin) -Indicates the type of shape at the end of a line. - -- **Bevel** = 1 — Beveled vertices. -- **Miter** = 0 — Regular angular vertices. -- **Round** = 2 — Rounded vertices. - -### [PermissionState](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/PermissionState) - -- **None** = 0 -- **Unrestricted** = 1 - -### [PopupAlignment](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/PopupAlignment) -Indicates which side of the exclusion rectangle to which the popup is aligned. - -- **Auto** = 0 — No specified direction. -- **Far** = 2 — Popup should be aligned to the near far. This usually means right or bottom. -- **Middle** = 3 — Popup should be aligned in the middle. -- **Near** = 1 — Popup should be aligned to the near side. This usually means left or top. - -### [PopupAnimationType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/PopupAnimationType) - -- **FadeInOutSlide** = 1 -- **GrowShrink** = 0 - -### [PopupDirection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/PopupDirection) -Indicates which direction the popup will pop up in relation to the exclusion rectangle. - -- **Auto** = 0 — No specified direction. -- **Down** = 1 — Popup should be displayed downward. -- **Left** = 3 — Popup should be displayed to the left. -- **Right** = 4 — Popup should be displayed to the right. -- **Up** = 2 — Popup should be displayed upward. - -### [PopupPointerPosition](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/PopupPointerPosition) -Indicates where the popup pointer should be positioned. - -- **Auto** = 0 -- **Bottom** = 2 -- **Left** = 3 -- **Right** = 4 -- **Top** = 1 - -### [RadialLabelMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/RadialLabelMode) -Describes available radial label modes. - -- **Auto** = 0 — Labelling mode is determined automatically. -- **Label** = 5 — The label of the category is used as a label. -- **LabelAndPercentage** = 7 — The label of the category and the percentage are used as the label, if using a proportional axis, otherwise the label and value is used as a fallback. -- **LabelAndValue** = 6 — The label of the category and the value are used as the label. -- **LabelAndValueAndPercentage** = 8 — The label of the category and the value and the percentage are used as the label, if using a proportional axis, otherwise the label and value is used as a fallback. -- **Normal** = 1 — Labelling mode is defined by the settings of the callout layer. -- **Percentage** = 3 — The percentage of the whole is displayed, if using a proportional axis, otherwise the value is used as a fallback. -- **Value** = 2 — The value of the item is displayed. -- **ValueAndPercentage** = 4 — The value and the percentage are displayed, if using a proportional axis, otherwise the value is used as a fallback. - -### [ReadState](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ReadState) - -- **Closed** = 4 -- **EndOfFile** = 3 -- **Error** = 2 -- **Initial** = 0 -- **Interactive** = 1 - -### [RegexOptions](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/RegexOptions) - -- **Compiled** = 8 -- **CultureInvariant** = 512 -- **ECMAScript** = 256 -- **ExplicitCapture** = 4 -- **IgnoreCase** = 1 -- **IgnorePatternWhitespace** = 32 -- **Multiline** = 2 -- **None** = 0 -- **RightToLeft** = 64 -- **Singleline** = 16 - -### [ScrollbarStyle](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ScrollbarStyle) -Describes the different types of scrollbars available. - -- **Default** = 0 — The default scrollbar style. -- **Fading** = 1 — The scrollbar will fade away after a few seconds when the mouse moves away from it or scrolling stops. -- **Hidden** = 3 — The scrollbar is hidden. -- **Thin** = 2 — The scrollbar appears as a thin line when idle. It will grow in size when scrolling or when the mouse is close by. - -### [SecurityAction](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/SecurityAction) - -- **Assert** = 3 -- **Demand** = 2 -- **Deny** = 4 -- **InheritanceDemand** = 7 -- **LinkDemand** = 6 -- **PermitOnly** = 5 -- **RequestMinimum** = 8 -- **RequestOptional** = 9 -- **RequestRefuse** = 10 - -### [SeekOrigin](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/SeekOrigin) - -- **Begin** = 0 -- **Current** = 1 -- **End** = 2 - -### [SeriesHighlightedValuesDisplayMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/SeriesHighlightedValuesDisplayMode) - -- **Auto** = 0 -- **Hidden** = 1 -- **Overlay** = 2 - -### [ShapeType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ShapeType) -Describes available types of item represented by the current row of a shapefile. - -- **None** = 0 — A placeholder value which cannot occur when reading a shapefile. -- **Point** = 1 — Specifies a point shape. -- **PointM** = 21 — Specifies a pointm shape (not supported; cannot occur when reading a shapefile) -- **PointZ** = 11 — Specifies a polypoint shape (not supported; cannot occur when reading a shapefile) -- **Polygon** = 5 — Specifies a polygon shape. -- **PolygonM** = 25 — Specifies a polygonm shape (not supported; cannot occur when reading a shapefile) -- **PolygonZ** = 15 — Specifies a polygonz shape -- **PolyLine** = 3 — Specifies a polyline shape. -- **PolyLineM** = 23 — Specifies a polylinem shape (not supported; cannot occur when reading a shapefile) -- **PolyLineZ** = 13 — Specifies a polylinez shape -- **PolyPatch** = 31 — Specifies a polypatchm shape (not supported; cannot occur when reading a shapefile) -- **PolyPoint** = 8 — Specifies a polypoint shape (not supported; cannot occur when reading a shapefile) -- **PolyPointM** = 28 — Specifies a polypointm shape (not supported; cannot occur when reading a shapefile) -- **PolyPointZ** = 18 — Specifies a polypointz shape (not supported; cannot occur when reading a shapefile) - -### [SmartPosition](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/SmartPosition) -Describes available positions for smart label placement with respect to the notional rectangle's -origin - -- **CenterBottom** = 7 — Specifies center bottom as a valid smart placement position. -- **CenterCenter** = 4 — Specifies center center as a valid smart placement position. -- **CenterTop** = 1 — Specifies center top as a valid smart placement position. -- **LeftBottom** = 6 — Specifies left bottom as a valid smart placement position. -- **LeftCenter** = 3 — Specifies left center as a valid smart placement position. -- **LeftTop** = 0 — Specifies left top as a valid smart placement position. -- **RightBottom** = 8 — Specifies right bottom as a valid smart placement position. -- **RightCenter** = 5 — Specifies right center as a valid smart placement position. -- **RightTop** = 2 — Specifies right top as a valid smart placement position. - -### [Stretch](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/Stretch) - -- **Fill** = 1 -- **None** = 0 -- **Uniform** = 2 -- **UniformToFill** = 3 - -### [StringComparison](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/StringComparison) - -- **CurrentCulture** = 0 -- **CurrentCultureIgnoreCase** = 1 -- **InvariantCulture** = 2 -- **InvariantCultureIgnoreCase** = 3 -- **Ordinal** = 4 -- **OrdinalIgnoreCase** = 5 - -### [StringSplitOptions](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/StringSplitOptions) - -- **None** = 0 -- **RemoveEmptyEntries** = 1 - -### [SweepDirection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/SweepDirection) -Enum representing the direction of an arc. - -- **Clockwise** = 1 — In a direction corresponding to the typical forward movement of the hands of a clock. -- **Counterclockwise** = 0 — In a direction opposite the typical forward movement of the hands of a clock. - -### [TaskStatus](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/TaskStatus) - -- **Canceled** = 6 -- **Created** = 0 -- **Faulted** = 7 -- **RanToCompletion** = 5 - -### [ToolActionButtonInfoDisplayType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ToolActionButtonInfoDisplayType) - -- **Flat** = 1 -- **Outlined** = 2 -- **Raised** = 0 - -### [ToolActionFieldSelectorInfoType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ToolActionFieldSelectorInfoType) - -- **Label** = 0 -- **Value** = 1 - -### [ToolActionInfoDensity](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ToolActionInfoDensity) - -- **Auto** = 0 -- **Comfortable** = 1 -- **Compact** = 3 -- **Cosy** = 2 -- **Minimal** = 4 - -### [ToolActionType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ToolActionType) -Represents type for toolbar action - -- **Button** = 9 -- **ButtonPair** = 13 -- **Checkbox** = 2 -- **CheckboxList** = 11 -- **ColorEditor** = 16 -- **Combo** = 14 -- **FieldSelector** = 12 -- **GroupHeader** = 1 -- **IconButton** = 3 -- **IconMenu** = 8 -- **Label** = 4 -- **NumberInput** = 5 -- **Radio** = 6 -- **Separator** = 7 -- **SubPanel** = 10 -- **TextInput** = 15 -- **Unknown** = 0 - -### [ToolCommandExecutionState](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ToolCommandExecutionState) - -- **Completed** = 0 -- **Failed** = 1 -- **Pending** = 2 - -### [ToolCommandStateType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ToolCommandStateType) - -- **IsDisabledChanged** = 1 -- **ValueChanged** = 2 -- **VisibilityChanged** = 0 - -### [ToolContextBindingMode](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ToolContextBindingMode) - -- **OneWay** = 0 -- **TwoWay** = 1 - -### [ToolContextValueType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/ToolContextValueType) - -- **BoolValue** = 5 -- **Brush** = 0 -- **BrushCollection** = 1 -- **Color** = 2 -- **Data** = 7 -- **DoubleValue** = 4 -- **IntValue** = 6 -- **StringValue** = 3 - -### [TransactionEvent](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/TransactionEvent) -An enumeration for the different transaction service events. - -- **Add** = 3 — A transaction was added to the service. -- **Clear** = 2 — Transactions have been cleared from the service. -- **Commit** = 5 — Transactions have been committed. -- **End** = 4 — Pending transactions have ended. -- **Redo** = 1 — A redo action has occurred. -- **Undo** = 0 — An undo action has occurred. - -### [TransactionPendingState](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/TransactionPendingState) -An enumeration for the different pending states a transaction can be in. - -- **Accept** = 1 — The transaction is to be accepted. -- **Pending** = 0 — The transaction will stay pending. -- **Reject** = 2 — The transaction is to be rejected. - -### [TransactionType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/TransactionType) -An enumeration for the different transaction types. - -- **Add** = 0 — An add transaction. -- **Delete** = 2 — A delete transaction. -- **Update** = 1 — An update transaction. - -### [TrendLineType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/TrendLineType) -Describes available types of trend lines supported by series. - -- **CubicFit** = 3 — Cubic polynomial fit. -- **CumulativeAverage** = 12 — Cumulative moving average. -- **ExponentialAverage** = 10 — Exponential moving average. -- **ExponentialFit** = 7 — Exponential fit. -- **LinearFit** = 1 — Linear fit. -- **LogarithmicFit** = 6 — Logarithmic fit. -- **ModifiedAverage** = 11 — Modified moving average. -- **None** = 0 — No trend line will be displayed. -- **PowerLawFit** = 8 — Powerlaw fit. -- **QuadraticFit** = 2 — Quadratic polynomial fit. -- **QuarticFit** = 4 — Quartic polynomial fit. -- **QuinticFit** = 5 — Quintic polynomial fit. -- **SimpleAverage** = 9 — Simple moving average. -- **WeightedAverage** = 13 — Weighted moving average. - -### [UnknownValuePlotting](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/UnknownValuePlotting) -Describes available methods of plotting data with unknown values in a series. -Double.NaN and null are examples of unknown values. - -- **DontPlot** = 1 — Do not plot the unknown value on the chart. -- **LinearInterpolate** = 0 — Plot the unknown value as the midpoint between surrounding known values using linear interpolation. - -### [UriKind](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/UriKind) - -- **Absolute** = 1 -- **Relative** = 2 -- **RelativeOrAbsolute** = 0 - -### [VerticalAlignment](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/VerticalAlignment) -Indicates the vertica position of an item relative to another object. - -- **Bottom** = 2 — Align the item to the bottom -- **Center** = 1 — Center the item -- **Stretch** = 3 — Stretch the item to the full height -- **Top** = 0 — Align the item to the top - -### [Visibility](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/Visibility) -Specifies the display state of an element. - -- **Collapsed** = 1 — Do not display the element. -- **Visible** = 0 — Display the element. - -### [WhitespaceHandling](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/WhitespaceHandling) - -- **All** = 0 -- **None** = 2 -- **Significant** = 1 - -### [WriteState](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/WriteState) - -- **Attribute** = 3 — An attribute is being written. -- **Closed** = 5 — The close method has been called. -- **Content** = 4 — Element content is being written. -- **Element** = 2 — An element start tag is being written. -- **Prolog** = 1 — The prolog is being written. -- **Start** = 0 — A write method has not been called. - -### [XBaseDataType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/XBaseDataType) -Enum for XBase field data types. - -- **AutoIncrement** = 16 — Auto increment data type. -- **Binary** = 6 — Binary data type. -- **Character** = 0 — Character data type. -- **Currency** = 9 — Currency data type. -- **Date** = 3 — Date data type. -- **DateTime** = 10 — DateTime data type. -- **double1** = 15 — Double data type. -- **FloatingPoint** = 5 — Floating point data type. -- **General** = 7 — General data type. -- **Integer** = 11 — Integer data type. -- **Logical** = 2 — Logical data type. -- **Memo** = 4 — Memo data type. -- **Number** = 1 — Number data type. -- **Picture** = 8 — Picture data type. -- **Timestamp** = 14 — Timestamp data type. -- **Variant** = 13 — Variant data type. -- **VariField** = 12 — VariField data type. - -### [XmlNodeType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/XmlNodeType) - -- **Attribute** = 2 -- **CDATA** = 4 -- **Comment** = 8 -- **Document** = 9 -- **DocumentFragment** = 11 -- **DocumentType** = 10 -- **Element** = 1 -- **EndElement** = 15 -- **EndEntity** = 16 -- **Entity** = 6 -- **EntityReference** = 5 -- **None** = 0 -- **Notation** = 12 -- **ProcessingInstruction** = 7 -- **SignificantWhitespace** = 14 -- **Text** = 3 -- **Whitespace** = 13 -- **XmlDeclaration** = 17 - -### [XmlSpace](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/enums/XmlSpace) -Specifies the current xml:space scope - -- **Default** = 1 — the xml:space scope = "default" -- **None** = 0 — No xml:space scope. -- **Preserve** = 2 — the xml:space scope = "preserve" - -## Type Aliases - -### [InstanceConstructor](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/types/InstanceConstructor) -`Function` - -### [RenderFunction](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/types/RenderFunction) -`any` - -## Functions - -### [addBrushPaletteThemeEntry](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/addBrushPaletteThemeEntry) -`addBrushPaletteThemeEntry(theme: any, clss: string, backgrounds: string[], outlines: string[]): void` - -### [addPaletteThemeEntry](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/addPaletteThemeEntry) -`addPaletteThemeEntry(theme: any, clss: string, background: string, border?: string, foreground?: string): void` - -### [addTextThemeEntry](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/addTextThemeEntry) -`addTextThemeEntry(theme: any, clss: string, fontFamily: string, fontSize: string, textColor: string, leftMargin?: string, topMargin?: string, rightMargin?: string, bottomMargin?: string, horizontalAlignment?: string, verticalAlignment?: string): void` - -### [arrayClear](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayClear) -`arrayClear(arr: any[]): void` - -### [arrayClear1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayClear1) -`arrayClear1(array: any[], index: number, length: number): void` - -### [arrayContains](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayContains) -`arrayContains(array: T[], value: T): boolean` - -### [arrayCopy](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayCopy) -`arrayCopy(source: any[], sourceIndex: number, dest: any[], destIndex: number, count: number): void` - -### [arrayCopy1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayCopy1) -`arrayCopy1(source: any[], sourceIndex: number, dest: any[], destIndex: number, count: number): void` - -### [arrayCopy2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayCopy2) -`arrayCopy2(source: any[], dest: any[], count: number): void` - -### [arrayCopyTo](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayCopyTo) -`arrayCopyTo(source: any[], dest: any[], index: number): void` - -### [arrayFindByName](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayFindByName) -`arrayFindByName(arr: any[], name: string): any` - -### [arrayGetLength](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayGetLength) -`arrayGetLength(target: any[], dimension: number): number` - -### [arrayGetRank](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayGetRank) -`arrayGetRank(target: any[]): number` - -### [arrayGetValue](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayGetValue) -`arrayGetValue(target: any[], index: number): any` - -### [arrayIndexOf1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayIndexOf1) -`arrayIndexOf1($t: Type, array: any[], value: any): number` - -### [arrayInsert](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayInsert) -`arrayInsert(target: any[], index: number, item: any): void` - -### [arrayInsertRange](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayInsertRange) -`arrayInsertRange(target: any[], index: number, items: any[]): void` - -### [arrayInsertRange1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayInsertRange1) -`arrayInsertRange1(target: any[], index: number, items: any[]): void` - -### [arrayLast](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayLast) -`arrayLast(array: T[]): T` - -### [arrayListCreate](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayListCreate) -`arrayListCreate(): ArrayBox$1` - -### [arrayRemoveAt](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayRemoveAt) -`arrayRemoveAt(target: any[], index: number): void` - -### [arrayRemoveItem](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayRemoveItem) -`arrayRemoveItem(target: any[], item: any): boolean` - -### [arrayResize](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayResize) -`arrayResize(target: T[], length: number): void` - -### [arrayShallowClone](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/arrayShallowClone) -`arrayShallowClone(arr: any[]): any[]` - -### [b64toUint8Array](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/b64toUint8Array) -`b64toUint8Array(b64Data: string, nBlocksSize?: number): any` - -### [boolCompare](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/boolCompare) -`boolCompare(value: boolean, other: boolean): -1 | 0 | 1` - -### [boolToDecimal](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/boolToDecimal) -`boolToDecimal(value: boolean, provider: CultureInfo): number` - -### [boolToDouble](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/boolToDouble) -`boolToDouble(value: boolean, provider: CultureInfo): number` - -### [boolToInt16](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/boolToInt16) -`boolToInt16(value: boolean, provider: CultureInfo): number` - -### [boolToInt32](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/boolToInt32) -`boolToInt32(value: boolean, provider: CultureInfo): number` - -### [boolToInt64](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/boolToInt64) -`boolToInt64(value: boolean, provider: CultureInfo): number` - -### [boolToSingle](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/boolToSingle) -`boolToSingle(value: boolean, provider: CultureInfo): number` - -### [boolToString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/boolToString) -`boolToString(value: boolean, provider: any): string` - -### [boolToUInt16](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/boolToUInt16) -`boolToUInt16(value: boolean, provider: CultureInfo): number` - -### [boolToUInt32](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/boolToUInt32) -`boolToUInt32(value: boolean, provider: CultureInfo): number` - -### [boolToUInt64](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/boolToUInt64) -`boolToUInt64(value: boolean, provider: CultureInfo): number` - -### [boxArray$1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/boxArray$1) -`boxArray$1(array: any): ArrayBox$1` - -### [brushCollectionToString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/brushCollectionToString) -`brushCollectionToString(v: BrushCollection): string` - -### [brushToString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/brushToString) -`brushToString(v: Brush): string` - -### [callStaticConstructors](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/callStaticConstructors) -`callStaticConstructors(): void` - -### [ceil10](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/ceil10) -`ceil10(value: any, exp: number): any` - -### [charMaxValue](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/charMaxValue) -`charMaxValue(): string` - -### [charMinValue](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/charMinValue) -`charMinValue(): string` - -### [colorCollectionToString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/colorCollectionToString) -`colorCollectionToString(v: ObservableColorCollection): string` - -### [colorToString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/colorToString) -`colorToString(v: Color): string` - -### [compareTo](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/compareTo) -`compareTo(value: number, other: number): -1 | 0 | 1` - -### [createGuid](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/createGuid) -`createGuid(): string` - -### [createMutationObserver](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/createMutationObserver) -`createMutationObserver(args: any[]): any` - -### [dateAdd](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateAdd) -`dateAdd(d: any, t: any): Date` - -### [dateAddDays](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateAddDays) -`dateAddDays(value: Date, days: number): Date` - -### [dateAddHours](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateAddHours) -`dateAddHours(value: Date, hours: number): Date` - -### [dateAddMinutes](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateAddMinutes) -`dateAddMinutes(value: Date, minutes: number): Date` - -### [dateAddMonths](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateAddMonths) -`dateAddMonths(value: Date, num: number): Date` - -### [dateAddSeconds](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateAddSeconds) -`dateAddSeconds(value: Date, seconds: number): Date` - -### [dateAddYears](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateAddYears) -`dateAddYears(value: Date, num: number): Date` - -### [dateEquals](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateEquals) -`dateEquals(d1: Date, d2: Date): boolean` - -### [dateFromFileTime](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateFromFileTime) -`dateFromFileTime(value: number): number` - -### [dateFromFileTimeUtc](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateFromFileTimeUtc) -`dateFromFileTimeUtc(value: number): Date` - -### [dateFromMilliseconds](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateFromMilliseconds) -`dateFromMilliseconds(value: number): Date` - -### [dateFromTicks](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateFromTicks) -`dateFromTicks(ticks: number): Date` - -### [dateFromValues](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateFromValues) -`dateFromValues(year: number, month: number, day: number, hour: number, minute: number, second: number, millisecond: number): Date` - -### [dateGetDate](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateGetDate) -`dateGetDate(value: Date): Date` - -### [dateGetMonth](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateGetMonth) -`dateGetMonth(value: Date): number` - -### [dateGetTimeOfDay](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateGetTimeOfDay) -`dateGetTimeOfDay(value: Date): number` - -### [dateIsDST](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateIsDST) -`dateIsDST(date: Date): boolean` - -### [dateIsLeapYear](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateIsLeapYear) -`dateIsLeapYear(year: number): boolean` - -### [dateKind](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateKind) -`dateKind(): DateTimeKind` - -### [dateMaxValue](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateMaxValue) -`dateMaxValue(): Date` - -### [dateMinValue](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateMinValue) -`dateMinValue(): Date` - -### [dateNow](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateNow) -`dateNow(): Date` - -### [dateParse](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateParse) -`dateParse(s: string, provider?: any): any` - -### [dateParseExact](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateParseExact) -`dateParseExact(s: string, format?: string, provider?: any): Date` - -### [dateStdTimezoneOffset](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateStdTimezoneOffset) -`dateStdTimezoneOffset(date: Date): number` - -### [dateSubtract](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateSubtract) -`dateSubtract(d: any, t: any): Date` - -### [dateToday](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateToday) -`dateToday(): Date` - -### [dateToFileTime](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateToFileTime) -`dateToFileTime(value: Date): number` - -### [dateToString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateToString) -`dateToString(value: Date, provider: any): any` - -### [dateToStringFormat](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateToStringFormat) -`dateToStringFormat(value: Date, format: string, provider?: CultureInfo): any` - -### [dateTryParse](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/dateTryParse) -`dateTryParse(s: string, result?: Date): any` - -### [daysInMonth](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/daysInMonth) -`daysInMonth(year: number, month: number): number` - -### [decimalAdjust](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/decimalAdjust) -`decimalAdjust(type: string, value: any, exp: number): any` - -### [defaultDVDateParse](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/defaultDVDateParse) -`defaultDVDateParse(str: string): Date` - -### [delegateCombine](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/delegateCombine) -`delegateCombine(del1: T, del2: T): T` - -### [delegateRemove](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/delegateRemove) -`delegateRemove(del1: T, del2: T): T` - -### [doubleCollectionToString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/doubleCollectionToString) -`doubleCollectionToString(v: DoubleCollection): string` - -### [endsWith1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/endsWith1) -`endsWith1(target: string, s: string, comparisonType: StringComparison): boolean` - -### [ensureBool](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/ensureBool) -`ensureBool(v: any): boolean` - -### [ensureEnum](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/ensureEnum) -`ensureEnum($t: Type, v: any): T` - -### [enumGetBox](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/enumGetBox) -`enumGetBox($t: Type, v: number): T` - -### [enumToString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/enumToString) -`enumToString($t: Type, v: any): string` - -### [floor10](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/floor10) -`floor10(value: any, exp: number): any` - -### [fromBrushCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/fromBrushCollection) -`fromBrushCollection(v: BrushCollection): string[]` - -### [fromColorCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/fromColorCollection) -`fromColorCollection(v: ObservableColorCollection): string[]` - -### [fromDict](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/fromDict) -`fromDict(v: Map): Iterable` - -### [fromDoubleCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/fromDoubleCollection) -`fromDoubleCollection(v: DoubleCollection): number[]` - -### [fromEn](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/fromEn) -`fromEn(v: IEnumerable): Iterable` - -### [fromEnum](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/fromEnum) -`fromEnum(v: IEnumerable$1): Iterable` - -### [fromOADate](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/fromOADate) -`fromOADate(value: number): Date` - -### [fromPoint](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/fromPoint) -`fromPoint(v: Point): Point` - -### [fromRect](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/fromRect) -`fromRect(v: Rect): IgRect` - -### [fromSize](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/fromSize) -`fromSize(v: Size): IgSize` - -### [fromSpinal](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/fromSpinal) -`fromSpinal(value: string): string` - -### [getAllPropertyNames](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/getAllPropertyNames) -`getAllPropertyNames(comp: any): string[]` - -### [getBoxIfEnum](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/getBoxIfEnum) -`getBoxIfEnum($t: Type, v: any): any` - -### [getColorStringSafe](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/getColorStringSafe) -`getColorStringSafe(v: any): string` - -### [getEn](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/getEn) -`getEn(arr: any[]): Generator` - -### [getEnumerator](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/getEnumerator) -`getEnumerator(en: any): IEnumerator$1` - -### [getEnumeratorObject](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/getEnumeratorObject) -`getEnumeratorObject(en: any): IEnumerator` - -### [getInstanceType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/getInstanceType) -`getInstanceType(obj: any): Type` - -### [getModifiedProps](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/getModifiedProps) -`getModifiedProps(prevProps: any, nextProps: any): any` - -### [ieeeRemainder](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/ieeeRemainder) -`ieeeRemainder(a: number, b: number): number` - -### [indexOfAny](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/indexOfAny) -`indexOfAny(target: string, chars: string[]): number` - -### [initializePropertiesFromCss](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/initializePropertiesFromCss) -`initializePropertiesFromCss(ele: Element, comp: any, cssPrefix: string, ignoredProperties?: Set, prefixRequired?: boolean, additionalPrefixes?: string[]): void` - -### [intDivide](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/intDivide) -`intDivide(value: number, divisor: number): number` - -### [interfaceToInternal](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/interfaceToInternal) -`interfaceToInternal(v: any, create: any): T` - -### [intSToU](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/intSToU) -`intSToU(number: number): number` - -### [intToString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/intToString) -`intToString(number: number, provider?: any): string` - -### [intToString1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/intToString1) -`intToString1(number: number, format: string, provider?: any): string` - -### [isDigit](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/isDigit) -`isDigit(c: string): boolean` - -### [isDigit1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/isDigit1) -`isDigit1(c: string, index: number): boolean` - -### [isInfinity](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/isInfinity) -`isInfinity(value: number): boolean` - -### [isLetter](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/isLetter) -`isLetter(c: string): boolean` - -### [isLetterOrDigit](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/isLetterOrDigit) -`isLetterOrDigit(target: string): boolean` - -### [isLower](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/isLower) -`isLower(target: string): boolean` - -### [isNaN_](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/isNaN_) -`isNaN_(v: number): boolean` - -### [isNegativeInfinity](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/isNegativeInfinity) -`isNegativeInfinity(v: number): boolean` - -### [isNumber](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/isNumber) -`isNumber(c: string): boolean` - -### [isPoint](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/isPoint) -`isPoint(p: any): boolean` - -### [isPositiveInfinity](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/isPositiveInfinity) -`isPositiveInfinity(v: number): boolean` - -### [isRect](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/isRect) -`isRect(r: any): boolean` - -### [isSize](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/isSize) -`isSize(s: any): boolean` - -### [isValidProp](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/isValidProp) -`isValidProp(owner: any, prop: string): boolean` - -### [lastIndexOfAny](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/lastIndexOfAny) -`lastIndexOfAny(target: string, chars: string[]): number` - -### [log10](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/log10) -`log10(value: number): number` - -### [logBase](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/logBase) -`logBase(n: number, n2: number): number` - -### [markDep](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/markDep) -`markDep(depProp: Function, PropMeta: Function, t: Function, changedFunction: string, props: any[]): string[]` - -### [markEnum](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/markEnum) -`markEnum(name: string, encodedDef: string, mustCoerceToInt?: Boolean): Type` - -### [markStruct](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/markStruct) -`markStruct(t: Function, name: string, baseType?: Type, interfaces?: Type[], staticInitializer?: any): any` - -### [markType](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/markType) -`markType(t: Function, name: string, baseType?: Type, interfaces?: Type[], staticInitializer?: any): Type` - -### [netRegexToJS](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/netRegexToJS) -`netRegexToJS(netPattern: string): any` - -### [nullableAdd](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/nullableAdd) -`nullableAdd(v1: any, v2: any): Nullable$1` - -### [nullableConcat](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/nullableConcat) -`nullableConcat(v1: any, v2: any): string` - -### [nullableDivide](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/nullableDivide) -`nullableDivide(v1: any, v2: any): Nullable$1` - -### [nullableEquals](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/nullableEquals) -`nullableEquals(v1: any, v2: any): boolean` - -### [nullableGreaterThan](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/nullableGreaterThan) -`nullableGreaterThan(v1: any, v2: any): boolean` - -### [nullableGreaterThanOrEqual](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/nullableGreaterThanOrEqual) -`nullableGreaterThanOrEqual(v1: any, v2: any): boolean` - -### [nullableIsNull](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/nullableIsNull) -`nullableIsNull(v: any): boolean` - -### [nullableLessThan](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/nullableLessThan) -`nullableLessThan(v1: any, v2: any): boolean` - -### [nullableLessThanOrEqual](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/nullableLessThanOrEqual) -`nullableLessThanOrEqual(v1: any, v2: any): boolean` - -### [nullableModulus](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/nullableModulus) -`nullableModulus(v1: any, v2: any): Nullable$1` - -### [nullableMultiply](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/nullableMultiply) -`nullableMultiply(v1: any, v2: any): Nullable$1` - -### [nullableNotEquals](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/nullableNotEquals) -`nullableNotEquals(v1: any, v2: any): boolean` - -### [nullableSubtract](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/nullableSubtract) -`nullableSubtract(v1: any, v2: any): Nullable$1` - -### [numberToString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/numberToString) -`numberToString(number: number, provider?: any): string` - -### [numberToString1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/numberToString1) -`numberToString1(value: number, provider: CultureInfo): string` - -### [numberToString2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/numberToString2) -`numberToString2(number: number, format: string, provider?: any): string` - -### [padLeft](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/padLeft) -`padLeft(target: string, len: number, c: string): string` - -### [padRight](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/padRight) -`padRight(target: string, len: number, c: string): string` - -### [parseBool](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseBool) -`parseBool(s: string): boolean` - -### [parseInt16_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseInt16_1) -`parseInt16_1(s: string, provider?: CultureInfo): number` - -### [parseInt16_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseInt16_2) -`parseInt16_2(s: string, style: NumberStyles, provider?: CultureInfo): number` - -### [parseInt32_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseInt32_1) -`parseInt32_1(s: string, provider?: CultureInfo): number` - -### [parseInt32_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseInt32_2) -`parseInt32_2(s: string, style: NumberStyles, provider?: CultureInfo): number` - -### [parseInt64_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseInt64_1) -`parseInt64_1(s: string, provider?: CultureInfo): number` - -### [parseInt64_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseInt64_2) -`parseInt64_2(s: string, style: NumberStyles, provider?: CultureInfo): number` - -### [parseInt8_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseInt8_1) -`parseInt8_1(s: string, provider?: CultureInfo): number` - -### [parseInt8_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseInt8_2) -`parseInt8_2(s: string, style: NumberStyles, provider?: CultureInfo): number` - -### [parseIntCore](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseIntCore) -`parseIntCore(s: string, provider: CultureInfo, min: number, max: number, style?: NumberStyles): number` - -### [parseNumber](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseNumber) -`parseNumber(s: string, provider: CultureInfo): number` - -### [parseNumber1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseNumber1) -`parseNumber1(s: string, style: NumberStyles, provider?: CultureInfo): number` - -### [parseUInt16_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseUInt16_1) -`parseUInt16_1(s: string, provider?: CultureInfo): number` - -### [parseUInt16_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseUInt16_2) -`parseUInt16_2(s: string, style: NumberStyles, provider?: CultureInfo): number` - -### [parseUInt32_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseUInt32_1) -`parseUInt32_1(s: string, provider?: CultureInfo): number` - -### [parseUInt32_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseUInt32_2) -`parseUInt32_2(s: string, style: NumberStyles, provider?: CultureInfo): number` - -### [parseUInt64_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseUInt64_1) -`parseUInt64_1(s: string, provider?: CultureInfo): number` - -### [parseUInt64_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseUInt64_2) -`parseUInt64_2(s: string, style: NumberStyles, provider?: CultureInfo): number` - -### [parseUInt8_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseUInt8_1) -`parseUInt8_1(s: string, provider?: CultureInfo): number` - -### [parseUInt8_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/parseUInt8_2) -`parseUInt8_2(s: string, style: NumberStyles, provider?: CultureInfo): number` - -### [pointFromLiteral](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/pointFromLiteral) -`pointFromLiteral(p: IgPoint): Point` - -### [pointToLiteral](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/pointToLiteral) -`pointToLiteral(p: Point): IgPoint` - -### [pointToString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/pointToString) -`pointToString(v: Point): string` - -### [rectFromLiteral](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/rectFromLiteral) -`rectFromLiteral(r: IgRect): Rect` - -### [rectToLiteral](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/rectToLiteral) -`rectToLiteral(r: Rect): IgRect` - -### [rectToString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/rectToString) -`rectToString(v: IgRect): string` - -### [reverse](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/reverse) -`reverse(target: string): string` - -### [rgbToHex](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/rgbToHex) -`rgbToHex(color: string): string` - -### [round10](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/round10) -`round10(value: any, exp: number): any` - -### [round10N](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/round10N) -`round10N(value: any, exp: number): any` - -### [runOn](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/runOn) -`runOn(target: any, func: T): T` - -### [sizeFromLiteral](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/sizeFromLiteral) -`sizeFromLiteral(s: IgSize): Size` - -### [sizeToLiteral](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/sizeToLiteral) -`sizeToLiteral(s: Size): IgSize` - -### [sizeToString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/sizeToString) -`sizeToString(v: IgSize): string` - -### [sleep](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/sleep) -`sleep(milliseconds: number): void` - -### [startsWith1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/startsWith1) -`startsWith1(target: string, s: string, comparisonType: StringComparison): boolean` - -### [stringCompare](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringCompare) -`stringCompare(target: string, other: string): -1 | 0 | 1` - -### [stringCompare1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringCompare1) -`stringCompare1(strA: string, strB: string, comparisonType: StringComparison): number` - -### [stringCompare2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringCompare2) -`stringCompare2(strA: string, strB: string, culture: CultureInfo, options: CompareOptions): number` - -### [stringCompare3](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringCompare3) -`stringCompare3(strA: string, indexA: number, strB: string, indexB: number, length: number): number` - -### [stringCompareOrdinal](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringCompareOrdinal) -`stringCompareOrdinal(strA: string, indexA: number, strB: string, indexB: number, length: number): number` - -### [stringCompareTo](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringCompareTo) -`stringCompareTo(target: string, other: string): -1 | 0 | 1` - -### [stringConcat](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringConcat) -`stringConcat(s: string[]): string` - -### [stringContains](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringContains) -`stringContains(str: string, check: string): boolean` - -### [stringCopyToCharArray](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringCopyToCharArray) -`stringCopyToCharArray(source: string, sourceIndex: number, destination: string[], destinationIndex: number, count: number): void` - -### [stringCreateFromChar](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringCreateFromChar) -`stringCreateFromChar(char: string, count: number): string` - -### [stringCreateFromCharArray](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringCreateFromCharArray) -`stringCreateFromCharArray(charArray: string[]): string` - -### [stringCreateFromCharArraySlice](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringCreateFromCharArraySlice) -`stringCreateFromCharArraySlice(charArray: string[], start: number, length: number): string` - -### [stringEmpty](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringEmpty) -`stringEmpty(): string` - -### [stringEndsWith](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringEndsWith) -`stringEndsWith(str: string, check: string): boolean` - -### [stringEquals](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringEquals) -`stringEquals(target: string, other: string): boolean` - -### [stringEquals1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringEquals1) -`stringEquals1(strA: string, strB: string, comparisonType: StringComparison): boolean` - -### [stringEscapeRegExp](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringEscapeRegExp) -`stringEscapeRegExp(str: string): string` - -### [stringFormat](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringFormat) -`stringFormat(format: string, rest: any[]): string` - -### [stringFormat1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringFormat1) -`stringFormat1(format: string, args: any[]): string` - -### [stringFormat2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringFormat2) -`stringFormat2(provider: any, format: string, args: any[]): string` - -### [stringInsert](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringInsert) -`stringInsert(str: string, index: number, value: string): string` - -### [stringIsDigit](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringIsDigit) -`stringIsDigit(str: string, index?: number): boolean` - -### [stringIsNullOrEmpty](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringIsNullOrEmpty) -`stringIsNullOrEmpty(target: string): boolean` - -### [stringIsNullOrWhiteSpace](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringIsNullOrWhiteSpace) -`stringIsNullOrWhiteSpace(target: string): boolean` - -### [stringJoin](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringJoin) -`stringJoin(sep: string, vals: string[]): string` - -### [stringJoin1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringJoin1) -`stringJoin1($t: Type, sep: string, vals: IEnumerable$1): any` - -### [stringRemove](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringRemove) -`stringRemove(target: string, index: number, count?: number): string` - -### [stringReplace](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringReplace) -`stringReplace(str: string, oldValue: string, newValue: string): string` - -### [stringSplit](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringSplit) -`stringSplit(value: string, separators: string[], options: StringSplitOptions): string[]` - -### [stringStartsWith](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringStartsWith) -`stringStartsWith(str: string, check: string): boolean` - -### [stringToBrush](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringToBrush) -`stringToBrush(v: string): Brush` - -### [stringToCharArray](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringToCharArray) -`stringToCharArray(target: string): string[]` - -### [stringToColor](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringToColor) -`stringToColor(v: string): Color` - -### [stringToLocaleLower](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringToLocaleLower) -`stringToLocaleLower(str: string, locale?: any): string` - -### [stringToLocaleUpper](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringToLocaleUpper) -`stringToLocaleUpper(str: string, locale?: any): string` - -### [stringToString$1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringToString$1) -`stringToString$1($t: Type, v: any): any` - -### [stringToString1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/stringToString1) -`stringToString1(target: string): string` - -### [strToColor](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/strToColor) -`strToColor(str: string): any` - -### [timeSpanDays](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanDays) -`timeSpanDays(t: number): number` - -### [timeSpanFromDays](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanFromDays) -`timeSpanFromDays(v: number): number` - -### [timeSpanFromHours](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanFromHours) -`timeSpanFromHours(v: number): number` - -### [timeSpanFromMilliseconds](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanFromMilliseconds) -`timeSpanFromMilliseconds(v: number): number` - -### [timeSpanFromMinutes](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanFromMinutes) -`timeSpanFromMinutes(v: number): number` - -### [timeSpanFromSeconds](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanFromSeconds) -`timeSpanFromSeconds(v: number): number` - -### [timeSpanFromTicks](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanFromTicks) -`timeSpanFromTicks(v: number): number` - -### [timeSpanHours](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanHours) -`timeSpanHours(t: number): number` - -### [timeSpanInit1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanInit1) -`timeSpanInit1(h: number, m: number, s: number): number` - -### [timeSpanInit2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanInit2) -`timeSpanInit2(d: number, h: number, m: number, s: number, ms: number): number` - -### [timeSpanInit3](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanInit3) -`timeSpanInit3(d: number, h: number, m: number, s: number): number` - -### [timeSpanMilliseconds](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanMilliseconds) -`timeSpanMilliseconds(t: number): number` - -### [timeSpanMinutes](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanMinutes) -`timeSpanMinutes(t: number): number` - -### [timeSpanNegate](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanNegate) -`timeSpanNegate(t: number): number` - -### [timeSpanSeconds](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanSeconds) -`timeSpanSeconds(t: number): number` - -### [timeSpanTicks](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanTicks) -`timeSpanTicks(t: number): number` - -### [timeSpanTotalDays](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanTotalDays) -`timeSpanTotalDays(t: number): number` - -### [timeSpanTotalHours](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanTotalHours) -`timeSpanTotalHours(t: number): number` - -### [timeSpanTotalMilliseconds](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanTotalMilliseconds) -`timeSpanTotalMilliseconds(t: number): number` - -### [timeSpanTotalMinutes](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanTotalMinutes) -`timeSpanTotalMinutes(t: number): number` - -### [timeSpanTotalSeconds](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/timeSpanTotalSeconds) -`timeSpanTotalSeconds(t: number): number` - -### [toBoolean](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toBoolean) -`toBoolean(value: boolean, provider: CultureInfo): boolean` - -### [toBrushCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toBrushCollection) -`toBrushCollection(v: string | string[]): BrushCollection` - -### [toColorCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toColorCollection) -`toColorCollection(v: string | string[]): ObservableColorCollection` - -### [toDecimal](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toDecimal) -`toDecimal(value: number): number` - -### [toDouble](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toDouble) -`toDouble(value: number): number` - -### [toDoubleCollection](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toDoubleCollection) -`toDoubleCollection(v: string | number[]): DoubleCollection` - -### [toEn](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toEn) -`toEn(v: any): IEnumerable` - -### [toEnum](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toEnum) -`toEnum(v: any): IEnumerable$1` - -### [toLocalTime](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toLocalTime) -`toLocalTime(value: Date): Date` - -### [toLongDateString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toLongDateString) -`toLongDateString(value: Date): string` - -### [toLongTimeString](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toLongTimeString) -`toLongTimeString(value: Date): string` - -### [toNullable](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toNullable) -`toNullable(t: Type, value: T | Nullable$1): Nullable$1` - -### [toOADate](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toOADate) -`toOADate(value: Date): number` - -### [toPoint](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toPoint) -`toPoint(v: string | Point): Point` - -### [toRect](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toRect) -`toRect(v: string | IgRect): Rect` - -### [toSize](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toSize) -`toSize(v: string | IgSize): Size` - -### [toSpinal](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toSpinal) -`toSpinal(value: string): string` - -### [toString1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toString1) -`toString1(value: boolean, provider: CultureInfo): string` - -### [toUniversalTime](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/toUniversalTime) -`toUniversalTime(value: Date): Date` - -### [trim](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/trim) -`trim(target: string, rest: string[]): string` - -### [trimEnd](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/trimEnd) -`trimEnd(target: string, rest: any[]): string` - -### [trimStart](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/trimStart) -`trimStart(target: string, rest: any[]): string` - -### [truncate](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/truncate) -`truncate(val: number): number` - -### [tryParseBool](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseBool) -`tryParseBool(s: string, v?: boolean): any` - -### [tryParseInt16_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseInt16_1) -`tryParseInt16_1(s: string, value?: number): any` - -### [tryParseInt16_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseInt16_2) -`tryParseInt16_2(s: string, style: NumberStyles, provider?: CultureInfo, value?: number): any` - -### [tryParseInt32_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseInt32_1) -`tryParseInt32_1(s: string, value?: number): any` - -### [tryParseInt32_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseInt32_2) -`tryParseInt32_2(s: string, style: NumberStyles, provider?: CultureInfo, value?: number): any` - -### [tryParseInt64_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseInt64_1) -`tryParseInt64_1(s: string, value?: number): any` - -### [tryParseInt64_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseInt64_2) -`tryParseInt64_2(s: string, style: NumberStyles, provider?: CultureInfo, value?: number): any` - -### [tryParseInt8_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseInt8_1) -`tryParseInt8_1(s: string, value?: number): any` - -### [tryParseInt8_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseInt8_2) -`tryParseInt8_2(s: string, style: NumberStyles, provider?: CultureInfo, value?: number): any` - -### [tryParseIntCore](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseIntCore) -`tryParseIntCore(s: string, provider: CultureInfo, min: number, max: number, style?: NumberStyles): any` - -### [tryParseNumber](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseNumber) -`tryParseNumber(s: string, v?: number): any` - -### [tryParseNumber1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseNumber1) -`tryParseNumber1(s: string, style: NumberStyles, provider: any, v?: number): any` - -### [tryParseUInt16_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseUInt16_1) -`tryParseUInt16_1(s: string, value?: number): any` - -### [tryParseUInt16_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseUInt16_2) -`tryParseUInt16_2(s: string, style: NumberStyles, provider?: CultureInfo, value?: number): any` - -### [tryParseUInt32_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseUInt32_1) -`tryParseUInt32_1(s: string, value?: number): any` - -### [tryParseUInt32_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseUInt32_2) -`tryParseUInt32_2(s: string, style: NumberStyles, provider?: CultureInfo, value?: number): any` - -### [tryParseUInt64_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseUInt64_1) -`tryParseUInt64_1(s: string, value?: number): any` - -### [tryParseUInt64_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseUInt64_2) -`tryParseUInt64_2(s: string, style: NumberStyles, provider?: CultureInfo, value?: number): any` - -### [tryParseUInt8_1](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseUInt8_1) -`tryParseUInt8_1(s: string, value?: number): any` - -### [tryParseUInt8_2](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/tryParseUInt8_2) -`tryParseUInt8_2(s: string, style: NumberStyles, provider?: CultureInfo, value?: number): any` - -### [typeCast](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/typeCast) -`typeCast(targetType: Function | Type, obj: any): T` - -### [typeCastObjTo$t](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/typeCastObjTo$t) -`typeCastObjTo$t($t: Type, v: any): any` - -### [typeGetValue](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/typeGetValue) -`typeGetValue(v: any): any` - -### [u32BitwiseAnd](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/u32BitwiseAnd) -`u32BitwiseAnd(a: number, b: number): number` - -### [u32BitwiseOr](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/u32BitwiseOr) -`u32BitwiseOr(a: number, b: number): number` - -### [u32BitwiseXor](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/u32BitwiseXor) -`u32BitwiseXor(a: number, b: number): number` - -### [u32LS](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/u32LS) -`u32LS(a: number, b: number): number` - -### [uint8ArraytoB64](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/uint8ArraytoB64) -`uint8ArraytoB64(aBytes: number[]): string` - -### [unboxArray](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/unboxArray) -`unboxArray(box: any): T[]` - -### [unicode_hack](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/unicode_hack) -`unicode_hack(regexpString: string | RegExp): RegExp` - -### [unwrapNullable](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/unwrapNullable) -`unwrapNullable(v: any): any` - -### [wrapNullable](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/functions/wrapNullable) -`wrapNullable($t: Type, v: any): any` - -## Variables - -### [a$](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/a$) -`Type` - -### [Array_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/Array_$type) -`Type` - -### [b$](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/b$) -`Type` - -### [Boolean_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/Boolean_$type) -`Type` - -### [CalendarWeekRule_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/CalendarWeekRule_$type) -`Type` - -### [d$](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/d$) -`Type` - -### [Date_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/Date_$type) -`Type` - -### [DateTimeKind_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/DateTimeKind_$type) -`Type` - -### [DayOfWeek_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/DayOfWeek_$type) -`Type` - -### [Delegate_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/Delegate_$type) -`Type` - -### [DomPortal_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/DomPortal_$type) -`Type` - -### [DomRenderer_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/DomRenderer_$type) -`Type` - -### [DomWrapper_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/DomWrapper_$type) -`Type` - -### [ICollection_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/ICollection_$type) -`Type` - -### [ICollection$1_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/ICollection$1_$type) -`Type` - -### [IComparable_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IComparable_$type) -`Type` - -### [IComparable$1_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IComparable$1_$type) -`Type` - -### [IConvertible_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IConvertible_$type) -`Type` - -### [IDictionary_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IDictionary_$type) -`Type` - -### [IDisposable_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IDisposable_$type) -`Type` - -### [IEnumerable_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IEnumerable_$type) -`Type` - -### [IEnumerable$1_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IEnumerable$1_$type) -`Type` - -### [IEnumerator_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IEnumerator_$type) -`Type` - -### [IEnumerator$1_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IEnumerator$1_$type) -`Type` - -### [IEqualityComparer_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IEqualityComparer_$type) -`Type` - -### [IEqualityComparer$1_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IEqualityComparer$1_$type) -`Type` - -### [IEquatable$1_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IEquatable$1_$type) -`Type` - -### [IFormatProvider_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IFormatProvider_$type) -`Type` - -### [IList_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IList_$type) -`Type` - -### [IList$1_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/IList$1_$type) -`Type` - -### [INotifyPropertyChanged_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/INotifyPropertyChanged_$type) -`Type` - -### [n$](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/n$) -`Type` - -### [Number_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/Number_$type) -`Type` - -### [Point_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/Point_$type) -`Type` - -### [s$](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/s$) -`Type` - -### [String_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/String_$type) -`Type` - -### [v$](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/v$) -`Type` - -### [Void_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/Void_$type) -`Type` - -### [wellKnownColors](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/wellKnownColors) -`any` - -### [XmlAttribute_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/XmlAttribute_$type) -`Type` - -### [XmlDocument_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/XmlDocument_$type) -`Type` - -### [XmlElement_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/XmlElement_$type) -`Type` - -### [XmlLinkedNode_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/XmlLinkedNode_$type) -`Type` - -### [XmlNamedNodeMap_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/XmlNamedNodeMap_$type) -`Type` - -### [XmlNode_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/XmlNode_$type) -`Type` - -### [XmlNodeList_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/XmlNodeList_$type) -`Type` - -### [XmlNodeType_$type](https://www.infragistics.com/api/angular/igniteui-angular-core/latest/variables/XmlNodeType_$type) -`Type` diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular-gauges/latest/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular-gauges/latest/llms-full.txt deleted file mode 100644 index bdc9b7b90..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular-gauges/latest/llms-full.txt +++ /dev/null @@ -1,958 +0,0 @@ -# Ignite UI for Angular Gauges latest — Full API Reference - -> Complete API reference for the Ignite UI for Angular Gauges package (latest). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: Angular -Package: igniteui-angular-gauges -Version: latest - -## Classes - -### [IgxAlignLinearGraphLabelEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/classes/IgxAlignLinearGraphLabelEventArgs) -Represents event argument for AlignLinearGraphLabel. - -- **constructor**(): IgxAlignLinearGraphLabelEventArgs -- **height**: `number` -- **i**: `AlignLinearGraphLabelEventArgs` -- **offsetX**: `number` -- **offsetY**: `number` -- **width**: `number` - -### [IgxAlignRadialGaugeLabelEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/classes/IgxAlignRadialGaugeLabelEventArgs) -Represents event argument for AlignRadialGaugeLabel. - -- **constructor**(): IgxAlignRadialGaugeLabelEventArgs -- **height**: `number` -- **i**: `AlignRadialGaugeLabelEventArgs` -- **offsetX**: `number` -- **offsetY**: `number` -- **width**: `number` - -### [IgxBulletGraphComponent](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/classes/IgxBulletGraphComponent) -Represents a bullet graph. - -- **constructor**(_renderer: Renderer2, _elRef: ViewContainerRef, _ngZone: NgZone, _componentFactoryResolver: ComponentFactoryResolver, _injector: Injector): IgxBulletGraphComponent -- **_dynamicContent**: `ViewContainerRef` -- **actualRanges**: `IgxLinearGraphRangeComponent[]` — The ranges actually present in the chart. Do not directly modify this array. -This array's contents can be modified by causing Angular to reproject the child content. -Or adding and removing ranges from the manual ranges collection on the ranges property. -- **contentRanges**: `QueryList` -- static **ngAcceptInputType_actualHighlightValueDisplayMode**: `string | HighlightedValueDisplayMode` -- static **ngAcceptInputType_actualHighlightValueOpacity**: `string | number` -- static **ngAcceptInputType_actualMaximumValue**: `string | number` -- static **ngAcceptInputType_actualMinimumValue**: `string | number` -- static **ngAcceptInputType_actualPixelScalingRatio**: `string | number` -- static **ngAcceptInputType_animating**: `string | boolean` -- static **ngAcceptInputType_backingInnerExtent**: `string | number` -- static **ngAcceptInputType_backingOuterExtent**: `string | number` -- static **ngAcceptInputType_backingStrokeThickness**: `string | number` -- static **ngAcceptInputType_highlightValue**: `string | number` -- static **ngAcceptInputType_highlightValueDisplayMode**: `string | HighlightedValueDisplayMode` -- static **ngAcceptInputType_highlightValueOpacity**: `string | number` -- static **ngAcceptInputType_interval**: `string | number` -- static **ngAcceptInputType_isScaleInverted**: `string | boolean` -- static **ngAcceptInputType_labelExtent**: `string | number` -- static **ngAcceptInputType_labelFormatSpecifiers**: `string | any[]` -- static **ngAcceptInputType_labelInterval**: `string | number` -- static **ngAcceptInputType_labelsPostInitial**: `string | number` -- static **ngAcceptInputType_labelsPreTerminal**: `string | number` -- static **ngAcceptInputType_labelsVisible**: `string | boolean` -- static **ngAcceptInputType_maximumValue**: `string | number` -- static **ngAcceptInputType_mergeViewports**: `string | boolean` -- static **ngAcceptInputType_minimumValue**: `string | number` -- static **ngAcceptInputType_minorTickCount**: `string | number` -- static **ngAcceptInputType_minorTickEndExtent**: `string | number` -- static **ngAcceptInputType_minorTickStartExtent**: `string | number` -- static **ngAcceptInputType_minorTickStrokeThickness**: `string | number` -- static **ngAcceptInputType_orientation**: `string | LinearScaleOrientation` -- static **ngAcceptInputType_pixelScalingRatio**: `string | number` -- static **ngAcceptInputType_rangeBrushes**: `string | string[]` -- static **ngAcceptInputType_rangeInnerExtent**: `string | number` -- static **ngAcceptInputType_rangeOuterExtent**: `string | number` -- static **ngAcceptInputType_rangeOutlines**: `string | string[]` -- static **ngAcceptInputType_scaleBackgroundThickness**: `string | number` -- static **ngAcceptInputType_scaleEndExtent**: `string | number` -- static **ngAcceptInputType_scaleStartExtent**: `string | number` -- static **ngAcceptInputType_showToolTip**: `string | boolean` -- static **ngAcceptInputType_showToolTipTimeout**: `string | number` -- static **ngAcceptInputType_targetValue**: `string | number` -- static **ngAcceptInputType_targetValueBreadth**: `string | number` -- static **ngAcceptInputType_targetValueInnerExtent**: `string | number` -- static **ngAcceptInputType_targetValueOuterExtent**: `string | number` -- static **ngAcceptInputType_targetValueStrokeThickness**: `string | number` -- static **ngAcceptInputType_tickEndExtent**: `string | number` -- static **ngAcceptInputType_ticksPostInitial**: `string | number` -- static **ngAcceptInputType_ticksPreTerminal**: `string | number` -- static **ngAcceptInputType_tickStartExtent**: `string | number` -- static **ngAcceptInputType_tickStrokeThickness**: `string | number` -- static **ngAcceptInputType_transitionDuration**: `string | number` -- static **ngAcceptInputType_transitionProgress**: `string | number` -- static **ngAcceptInputType_value**: `string | number` -- static **ngAcceptInputType_valueInnerExtent**: `string | number` -- static **ngAcceptInputType_valueOuterExtent**: `string | number` -- static **ngAcceptInputType_valueStrokeThickness**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualHighlightValueDisplayMode**: `HighlightedValueDisplayMode` — Gets whether and how to display the highlighted value. -- **actualHighlightValueOpacity**: `number` — Gets the actual opacity of the primary needle while highlighting -- **actualMaximumValue**: `number` — Gets the resolved maximum value of the scale. -- **actualMaximumValueChange**: `EventEmitter` -- **actualMinimumValue**: `number` — Gets the resolved minimum value of the scale. -- **actualMinimumValueChange**: `EventEmitter` -- **actualPixelScalingRatio**: `number` — Gets the actual pixel scaling ratio used to affect the pixel density of the control. -A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control -to appear blurry. -- **alignLabel**: `EventEmitter` — Event which is raised when a label of the bullet graph is aligned along the scale. -Function takes first argument evt and second argument ui. -Use ui.owner to obtain reference to gauge widget. -Use ui.actualMinimumValue to obtain the minimum value of the bullet graph scale. -Use ui.actualMaximumValue to obtain the maximum value of the bullet graph scale. -Use ui.value to obtain the value on the the bullet graph scale associated with the label. -Use ui.label to obtain the string value of the label. -Use ui.width to obtain the width of the label. -Use ui.height to obtain the height of the label. -Use ui.offsetX to obtain the X offset of the label on the bullet graph scale. -Use ui.offsetY to obtain the Y offset of the label on the bullet graph scale. -- **animating**: `boolean` — Gets a value indicating whether the bullet graph is currently animating. -- **backingBrush**: `string` — Gets or sets the brush to use to fill the backing of the bullet graph. -- **backingInnerExtent**: `number` — Gets or sets the inner extent of the bullet graph backing. -- **backingOuterExtent**: `number` — Gets or sets the outer extent of the bullet graph backing. -- **backingOutline**: `string` — Gets or sets the brush to use for the outline of the backing. -- **backingStrokeThickness**: `number` — Gets or sets the stroke thickness of the backing outline. -- **font**: `string` — Gets or sets the font. -- **fontBrush**: `string` — Gets or sets the brush to use for the label font. -- **formatLabel**: `EventEmitter` — Event which is raised when a label of the bullet graph is formatted. -Function takes first argument evt and second argument ui. -Use ui.owner to obtain reference to the bullet graph widget. -Use ui.actualMinimumValue to obtain the minimum value of the bullet graph scale. -Use ui.actualMaximumValue to obtain the maximum value of the bullet graph scale. -Use ui.value to obtain the value on the the bullet graph scale associated with the label. -Use ui.label to obtain the string value of the label. -- **height**: `string` -- **highlightValue**: `number` — Gets or sets the highlight value at which to point the secondary needle of the gauge. -- **highlightValueDisplayMode**: `HighlightedValueDisplayMode` — Gets or sets whether and how to display the highlighted value. -- **highlightValueOpacity**: `number` — Gets or sets the opacity of the primary needle while highlighting -- **interval**: `number` — Gets or sets the interval to use for the scale. -- **isScaleInverted**: `boolean` — Gets or sets a value indicating whether the scale is inverted. -When the scale is inverted the direction in which the scale values increase is right to left. -- **labelExtent**: `number` — Gets or sets the position at which to put the labels as a value from 0 to 1, measured from the bottom of the scale. -Values further from zero than 1 can be used to hide the labels of the bullet graph. -- **labelFormat**: `string` — Gets or sets the label composite format used when creating label values. -- **labelFormatSpecifiers**: `any[]` — Gets or sets the format specifiers to use with the LabelFormat string. -- **labelInterval**: `number` — Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale. -- **labelsPostInitial**: `number` — A value to start adding labels, added to the scale's MinimumValue. -- **labelsPreTerminal**: `number` — A value to stop adding labels, subtracted from the scale's MaximumValue. -- **labelsVisible**: `boolean` — Gets or sets whether the labels are visible in the gauge. -- **maximumValue**: `number` — Gets or sets the maximum value of the scale. -- **mergeViewports**: `boolean` — Gets or sets whether the scale viewport will be merged with backing viewport. -- **minimumValue**: `number` — Gets or sets the minimum value of the scale. -- **minorTickBrush**: `string` — Gets or sets the brush to use for the minor tickmarks. -- **minorTickCount**: `number` — Gets or sets the number of minor tickmarks to place between major tickmarks. -- **minorTickEndExtent**: `number` — Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. -Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **minorTickStartExtent**: `number` — Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. -Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **minorTickStrokeThickness**: `number` — Gets or sets the stroke thickness to use when rendering minor ticks. -- **orientation**: `LinearScaleOrientation` — Gets or sets the orientation of the scale. -- **pixelScalingRatio**: `number` — Gets or sets the scaling value used to affect the pixel density of the control. -A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control -to appear blurry. -- **rangeBrushes**: `string[]` — Gets or sets a collection of brushes to be used as the palette for bullet graph ranges. -- **rangeInnerExtent**: `number` — Gets or sets the position at which to start rendering the ranges, measured from the front/bottom of the control as a value from 0 to 1. -Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **rangeOuterExtent**: `number` — Gets or sets the position at which to stop rendering the range as a value from 0 to 1 measured from the front/bottom of the bullet graph. -Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **rangeOutlines**: `string[]` — Gets or sets a collection of brushes to be used as the palette for bullet graph outlines. -- **ranges**: `IgxLinearGraphRangeCollection` — A collection or manually added axes for the chart. -- **scaleBackgroundBrush**: `string` — Gets or sets the background brush for the scale. -- **scaleBackgroundOutline**: `string` — Gets or sets the background outline for the scale. -- **scaleBackgroundThickness**: `number` — Gets or sets the background outline thickness for the scale. -- **scaleEndExtent**: `number` — Gets or sets the position at which to stop rendering the scale as a value from 0 to 1, measured from the front/bottom of the bullet graph. -Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **scaleStartExtent**: `number` — Gets or sets the position at which to start rendering the scale, measured from the front/bottom of the bullet graph as a value from 0 to 1. -Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **showToolTip**: `boolean` — Gets or sets a value indicating whether tooltips are enabled. -- **showToolTipTimeout**: `number` — Gets or sets the time in milliseconds that tooltip appearance is delayed with. -- **targetValue**: `number` — Gets or sets the value indicated by the target value bar. -- **targetValueBreadth**: `number` — Get or sets the breadth of the target value element. -- **targetValueBrush**: `string` — Gets or sets the brush to use when rendering the fill of the comparative marker. -- **targetValueInnerExtent**: `number` — Gets or sets the position at which to start rendering the target value, measured from the front/bottom of the control as a value from 0 to 1. -Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **targetValueName**: `string` — Gets or sets the name used for the target value. The name is displayed in the default target value tooltip. -- **targetValueOuterExtent**: `number` — Gets or sets the position at which to start rendering the target value, measured from the front/bottom of the control as a value from 0 to 1. -Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **targetValueOutline**: `string` — Gets or sets the brush to use when rendering the outline of the target value. -- **targetValueStrokeThickness**: `number` — Gets or sets the stroke thickness of the outline of the target value bar. -- **tickBrush**: `string` — Gets or sets the brush to use for the major tickmarks. -- **tickEndExtent**: `number` — Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. -Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **ticksPostInitial**: `number` — A value to start adding tickmarks, added to the scale's MinimumValue. -- **ticksPreTerminal**: `number` — A value to stop adding tickmarks, subtracted from the scale's MaximumValue. -- **tickStartExtent**: `number` — Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. -Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **tickStrokeThickness**: `number` — Gets or sets the stroke thickness to use when rendering ticks. -- **tooltipTemplate**: `TemplateRef` -- **transitionDuration**: `number` — Gets or sets the number of milliseconds over which changes to the bullet graph should be animated. -- **transitionProgress**: `number` — Gets the transition progress of the animation when the control is animating. -- **value**: `number` — Gets or sets the value at which the bar ends. -- **valueBrush**: `string` — Gets or sets the brush to use for the actual value element. -- **valueInnerExtent**: `number` — Gets or sets the position at which to start rendering the actual value geometries, measured from the front/bottom of the bullet graph as a value from 0 to 1. -Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **valueName**: `string` — Gets or sets the name used for actual value. -- **valueOuterExtent**: `number` — Gets or sets the position at which to stop rendering the actual value geometries as a value from 0 to 1 measured from the front/bottom of the bullet graph. -Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **valueOutline**: `string` — Gets or sets the brush to use for the outline of actual value element. -- **valueStrokeThickness**: `number` — Gets or sets the stroke thickness to use when rendering single actual value element. -- **width**: `string` -- **containerResized**(): void — Notify that the container has resized. -- **exportSerializedVisualData**(): string — Returns visuals as a serialized string. -- **findByName**(name: string): any -- **flush**(): void — Use to force the bullet graph to finish any deferred work before printing or evaluating its visual. -This should only be called if the visual of the bullet graph needs to be synchronously saved or evaluated. -Calling this method too often will hinder the performance of the bullet graph. -- **getValueForPoint**(point: IgPoint): number — Gets the value for the main scale of the bullet graph for a given point within the bounds of the bullet graph. -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void — A callback method that performs custom clean-up, invoked immediately -before a directive, pipe, or service instance is destroyed. -- **provideContainer**(container: any): void — Provide a container for the bullet graph. -- **styleUpdated**(): void — Notify that the bullet graph styling has updated. -- **updateStyle**(): void -- static **_createFromInternal**(internal: any): IgxBulletGraphComponent - -### [IgxFormatLinearGraphLabelEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/classes/IgxFormatLinearGraphLabelEventArgs) -Represents event argument for FormatLinearGraphLabel. - -- **constructor**(): IgxFormatLinearGraphLabelEventArgs -- **actualMaximumValue**: `number` -- **actualMinimumValue**: `number` -- **i**: `FormatLinearGraphLabelEventArgs` -- **label**: `string` -- **value**: `number` - -### [IgxFormatRadialGaugeLabelEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/classes/IgxFormatRadialGaugeLabelEventArgs) -Represents event argument for FormatRadialGaugeLabel. - -- **constructor**(): IgxFormatRadialGaugeLabelEventArgs -- **actualMaximumValue**: `number` -- **actualMinimumValue**: `number` -- **angle**: `number` -- **endAngle**: `number` -- **i**: `FormatRadialGaugeLabelEventArgs` -- **label**: `string` -- **startAngle**: `number` -- **value**: `number` - -### [IgxLinearGaugeComponent](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/classes/IgxLinearGaugeComponent) -A linear gauge for displaying a single value on a defined scale. - -- **constructor**(_renderer: Renderer2, _elRef: ViewContainerRef, _ngZone: NgZone, _componentFactoryResolver: ComponentFactoryResolver, _injector: Injector): IgxLinearGaugeComponent -- **_dynamicContent**: `ViewContainerRef` -- **actualRanges**: `IgxLinearGraphRangeComponent[]` — The ranges actually present in the chart. Do not directly modify this array. -This array's contents can be modified by causing Angular to reproject the child content. -Or adding and removing ranges from the manual ranges collection on the ranges property. -- **contentRanges**: `QueryList` -- static **ngAcceptInputType_actualHighlightValueDisplayMode**: `string | HighlightedValueDisplayMode` -- static **ngAcceptInputType_actualHighlightValueOpacity**: `string | number` -- static **ngAcceptInputType_actualMaximumValue**: `string | number` -- static **ngAcceptInputType_actualMinimumValue**: `string | number` -- static **ngAcceptInputType_actualPixelScalingRatio**: `string | number` -- static **ngAcceptInputType_animating**: `string | boolean` -- static **ngAcceptInputType_backingInnerExtent**: `string | number` -- static **ngAcceptInputType_backingOuterExtent**: `string | number` -- static **ngAcceptInputType_backingStrokeThickness**: `string | number` -- static **ngAcceptInputType_highlightValue**: `string | number` -- static **ngAcceptInputType_highlightValueDisplayMode**: `string | HighlightedValueDisplayMode` -- static **ngAcceptInputType_highlightValueOpacity**: `string | number` -- static **ngAcceptInputType_interval**: `string | number` -- static **ngAcceptInputType_isHighlightNeedleDraggingEnabled**: `string | boolean` -- static **ngAcceptInputType_isNeedleDraggingEnabled**: `string | boolean` -- static **ngAcceptInputType_isScaleInverted**: `string | boolean` -- static **ngAcceptInputType_labelExtent**: `string | number` -- static **ngAcceptInputType_labelFormatSpecifiers**: `string | any[]` -- static **ngAcceptInputType_labelInterval**: `string | number` -- static **ngAcceptInputType_labelsPostInitial**: `string | number` -- static **ngAcceptInputType_labelsPreTerminal**: `string | number` -- static **ngAcceptInputType_labelsVisible**: `string | boolean` -- static **ngAcceptInputType_maximumValue**: `string | number` -- static **ngAcceptInputType_mergeViewports**: `string | boolean` -- static **ngAcceptInputType_minimumValue**: `string | number` -- static **ngAcceptInputType_minorTickCount**: `string | number` -- static **ngAcceptInputType_minorTickEndExtent**: `string | number` -- static **ngAcceptInputType_minorTickStartExtent**: `string | number` -- static **ngAcceptInputType_minorTickStrokeThickness**: `string | number` -- static **ngAcceptInputType_needleBreadth**: `string | number` -- static **ngAcceptInputType_needleInnerBaseWidth**: `string | number` -- static **ngAcceptInputType_needleInnerExtent**: `string | number` -- static **ngAcceptInputType_needleInnerPointExtent**: `string | number` -- static **ngAcceptInputType_needleInnerPointWidth**: `string | number` -- static **ngAcceptInputType_needleOuterBaseWidth**: `string | number` -- static **ngAcceptInputType_needleOuterExtent**: `string | number` -- static **ngAcceptInputType_needleOuterPointExtent**: `string | number` -- static **ngAcceptInputType_needleOuterPointWidth**: `string | number` -- static **ngAcceptInputType_needleShape**: `string | LinearGraphNeedleShape` -- static **ngAcceptInputType_needleStrokeThickness**: `string | number` -- static **ngAcceptInputType_orientation**: `string | LinearScaleOrientation` -- static **ngAcceptInputType_pixelScalingRatio**: `string | number` -- static **ngAcceptInputType_rangeBrushes**: `string | string[]` -- static **ngAcceptInputType_rangeInnerExtent**: `string | number` -- static **ngAcceptInputType_rangeOuterExtent**: `string | number` -- static **ngAcceptInputType_rangeOutlines**: `string | string[]` -- static **ngAcceptInputType_scaleEndExtent**: `string | number` -- static **ngAcceptInputType_scaleInnerExtent**: `string | number` -- static **ngAcceptInputType_scaleOuterExtent**: `string | number` -- static **ngAcceptInputType_scaleStartExtent**: `string | number` -- static **ngAcceptInputType_scaleStrokeThickness**: `string | number` -- static **ngAcceptInputType_showToolTip**: `string | boolean` -- static **ngAcceptInputType_showToolTipTimeout**: `string | number` -- static **ngAcceptInputType_tickEndExtent**: `string | number` -- static **ngAcceptInputType_ticksPostInitial**: `string | number` -- static **ngAcceptInputType_ticksPreTerminal**: `string | number` -- static **ngAcceptInputType_tickStartExtent**: `string | number` -- static **ngAcceptInputType_tickStrokeThickness**: `string | number` -- static **ngAcceptInputType_transitionDuration**: `string | number` -- static **ngAcceptInputType_transitionProgress**: `string | number` -- static **ngAcceptInputType_value**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualHighlightValueDisplayMode**: `HighlightedValueDisplayMode` — Gets whether and how to display the highlighted value. -- **actualHighlightValueOpacity**: `number` — Gets the actual opacity of the primary needle while highlighting -- **actualMaximumValue**: `number` — Gets the resolved maximum value of the scale. -- **actualMaximumValueChange**: `EventEmitter` -- **actualMinimumValue**: `number` — Gets the resolved minimum value of the scale. -- **actualMinimumValueChange**: `EventEmitter` -- **actualPixelScalingRatio**: `number` — Gets the actual pixel scaling ratio used to affect the pixel density of the control. -A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control -to appear blurry. -- **alignLabel**: `EventEmitter` — Event which is raised when a label of the linear gauge is aligned along the scale. -Function takes first argument evt and second argument ui. -Use ui.owner to obtain reference to the gauge widget. -Use ui.actualMinimumValue to obtain the minimum value of the gauge scale. -Use ui.actualMaximumValue to obtain the maximum value of the gauge scale. -Use ui.value to obtain the value on the gauge scale associated with the label. -Use ui.label to obtain the string value of the label. -Use ui.width to obtain the width of the label. -Use ui.height to obtain the height of the label. -Use ui.offsetX to obtain the X offset of the label on the gauge scale. -Use ui.offsetY to obtain the Y offset of the label on the gauge scale. -- **animating**: `boolean` — Gets a value indicating whether the bullet graph is currently animating. -- **backingBrush**: `string` — Gets or sets the brush to use to fill the backing of the linear gauge. -- **backingInnerExtent**: `number` — Gets or sets the inner extent of the linear gauge backing. -- **backingOuterExtent**: `number` — Gets or sets the outer extent of the linear gauge backing. -- **backingOutline**: `string` — Gets or sets the brush to use for the outline of the backing. -- **backingStrokeThickness**: `number` — Gets or sets the stroke thickness of the backing outline. -- **font**: `string` — Gets or sets the font. -- **fontBrush**: `string` — Gets or sets the brush to use for the label font. -- **formatLabel**: `EventEmitter` — Event which is raised when a label of the the gauge is formatted. -Function takes first argument evt and second argument ui. -Use ui.owner to obtain reference to the gauge widget. -Use ui.actualMinimumValue to obtain the minimum value of the gauge scale. -Use ui.actualMaximumValue to obtain the maximum value of the gauge scale. -Use ui.value to obtain the value on the the gauge scale associated with the label. -Use ui.label to obtain the string value of the label. -- **height**: `string` -- **highlightValue**: `number` — Gets or sets the highlight value at which to point the secondary needle of the gauge. -- **highlightValueChanged**: `EventEmitter` — Occurs when the Hightlight Value property changes. -- **highlightValueDisplayMode**: `HighlightedValueDisplayMode` — Gets or sets whether and how to display the highlighted value. -- **highlightValueOpacity**: `number` — Gets or sets the opacity of the primary needle while highlighting -- **interval**: `number` — Gets or sets the interval to use for the scale. -- **isHighlightNeedleDraggingEnabled**: `boolean` — Gets or sets whether highlight needle dragging is enabled or not. -- **isNeedleDraggingEnabled**: `boolean` — Gets or sets whether needle dragging is enabled or not. -- **isScaleInverted**: `boolean` — Gets or sets a value indicating whether the scale is inverted. -When the scale is inverted the direction in which the scale values increase is right to left. -- **labelExtent**: `number` — Gets or sets the position at which to put the labels as a value from 0 to 1, measured from the bottom of the scale. -Values further from zero than 1 can be used to hide the labels of the linear gauge. -- **labelFormat**: `string` — Gets or sets the label composite format used when creating label values. -- **labelFormatSpecifiers**: `any[]` — Gets or sets the format specifiers to use with the LabelFormat string. -- **labelInterval**: `number` — Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale. -- **labelsPostInitial**: `number` — A value to start adding labels, added to the scale's MinimumValue. -- **labelsPreTerminal**: `number` — A value to stop adding labels, subtracted from the scale's MaximumValue. -- **labelsVisible**: `boolean` — Gets or sets whether the labels are visible in the gauge. -- **maximumValue**: `number` — Gets or sets the maximum value of the scale. -- **mergeViewports**: `boolean` — Gets or sets whether the scale viewport will be merged with backing viewport. -- **minimumValue**: `number` — Gets or sets the minimum value of the scale. -- **minorTickBrush**: `string` — Gets or sets the brush to use for the minor tickmarks. -- **minorTickCount**: `number` — Gets or sets the number of minor tickmarks to place between major tickmarks. -- **minorTickEndExtent**: `number` — Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. -Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **minorTickStartExtent**: `number` — Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. -Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **minorTickStrokeThickness**: `number` — Gets or sets the stroke thickness to use when rendering minor ticks. -- **needleBreadth**: `number` — Gets or sets the needle breadth. -- **needleBrush**: `string` — Gets or sets the brush to use for needle element. -- **needleInnerBaseWidth**: `number` — Gets or sets the width of the needle's inner base. -- **needleInnerExtent**: `number` — Gets or sets the position at which to start rendering the needle geometry, measured from the front/bottom of the linear gauge as a value from 0 to 1. -Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **needleInnerPointExtent**: `number` — Gets or sets the extent of the needle's inner point. -- **needleInnerPointWidth**: `number` — Gets or sets the width of the needle's inner point. -- **needleName**: `string` — Gets or sets the name used for needle. -- **needleOuterBaseWidth**: `number` — Gets or sets the width of the needle's outer base. -- **needleOuterExtent**: `number` — Gets or sets the position at which to stop rendering the needle geometry as a value from 0 to 1 measured from the front/bottom of the linear gauge. -Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **needleOuterPointExtent**: `number` — Gets or sets the extent of the needle's outer point. -- **needleOuterPointWidth**: `number` — Gets or sets the width of the needle's outer point. -- **needleOutline**: `string` — Gets or sets the brush to use for the outline of needle element. -- **needleShape**: `LinearGraphNeedleShape` — Gets or sets the shape to use when rendering the needle from a number of options. -- **needleStrokeThickness**: `number` — Gets or sets the stroke thickness to use when rendering single actual value element. -- **orientation**: `LinearScaleOrientation` — Gets or sets the orientation of the scale. -- **pixelScalingRatio**: `number` — Gets or sets the scaling value used to affect the pixel density of the control. -A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control -to appear blurry. -- **rangeBrushes**: `string[]` — Gets or sets a collection of brushes to be used as the palette for linear gauge ranges. -- **rangeInnerExtent**: `number` — Gets or sets the position at which to start rendering the ranges, measured from the front/bottom of the control as a value from 0 to 1. -Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **rangeOuterExtent**: `number` — Gets or sets the position at which to stop rendering the range as a value from 0 to 1 measured from the front/bottom of the linear gauge. -Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **rangeOutlines**: `string[]` — Gets or sets a collection of brushes to be used as the palette for linear gauge outlines. -- **ranges**: `IgxLinearGraphRangeCollection` — A collection or manually added axes for the chart. -- **scaleBrush**: `string` — Gets or sets the brush to use to fill the scale of the linear gauge. -- **scaleEndExtent**: `number` — Gets or sets the position at which to stop rendering the scale as a value from 0 to 1, measured from the front/bottom of the linear gauge. -Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **scaleInnerExtent**: `number` — Gets or sets the position at which to start rendering the scale, measured from the bottom/front (when orientation is horizontal/vertical) of the control as a value from 0 to 1. -Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **scaleOuterExtent**: `number` — Gets or sets the position at which to stop rendering the scale as a value from 0 to 1 measured from the bottom/front (when orientation is horizontal/vertical) of the linear gauge. -Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **scaleOutline**: `string` — Gets or sets the brush to use for the outline of the scale. -- **scaleStartExtent**: `number` — Gets or sets the position at which to start rendering the scale, measured from the front/bottom of the linear gauge as a value from 0 to 1. -Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **scaleStrokeThickness**: `number` — Gets or sets the stroke thickness of the scale outline. -- **showToolTip**: `boolean` — Gets or sets a value indicating whether tooltips are enabled. -- **showToolTipTimeout**: `number` — Gets or sets the time in milliseconds that tooltip appearance is delayed with. -- **tickBrush**: `string` — Gets or sets the brush to use for the major tickmarks. -- **tickEndExtent**: `number` — Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. -Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **ticksPostInitial**: `number` — A value to start adding tickmarks, added to the scale's MinimumValue. -- **ticksPreTerminal**: `number` — A value to stop adding tickmarks, subtracted from the scale's MaximumValue. -- **tickStartExtent**: `number` — Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. -Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **tickStrokeThickness**: `number` — Gets or sets the stroke thickness to use when rendering ticks. -- **tooltipTemplate**: `TemplateRef` -- **transitionDuration**: `number` — Gets or sets the number of milliseconds over which changes to the linear gauge should be animated. -- **transitionProgress**: `number` — Gets the transition progress of the animation when the control is animating. -- **value**: `number` — Gets or sets the value at which the needle is positioned. -- **valueChanged**: `EventEmitter` — Occurs when the Value property changes. -- **width**: `string` -- **containerResized**(): void -- **exportSerializedVisualData**(): string — Returns visuals as a serialized string. -- **findByName**(name: string): any -- **flush**(): void — Use to force the linear gauge to finish any deferred work before printing or evaluating its visual. -This should only be called if the visual of the linear gauge needs to be synchronously saved or evaluated. -Calling this method too often will hinder the performance of the linear gauge. -- **getValueForPoint**(point: IgPoint): number — Gets the value for the main scale of the gauge for a given point within the bounds of the gauge. -- **highlightNeedleContainsPoint**(point: IgPoint, isFinger: boolean): boolean -- **needleContainsPoint**(point: IgPoint, isFinger: boolean): boolean -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void — A callback method that performs custom clean-up, invoked immediately -before a directive, pipe, or service instance is destroyed. -- **provideContainer**(container: any): void — Called by the UI framework to provide a UI container for rendering this control. -- **styleUpdated**(): void -- **updateStyle**(): void -- static **_createFromInternal**(internal: any): IgxLinearGaugeComponent - -### [IgxLinearGraphRangeCollection](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/classes/IgxLinearGraphRangeCollection) - -- **constructor**(list?: IgxLinearGraphRangeComponent[]): IgxLinearGraphRangeCollection - -### [IgxLinearGraphRangeComponent](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/classes/IgxLinearGraphRangeComponent) - -- **constructor**(): IgxLinearGraphRangeComponent -- static **ngAcceptInputType_endValue**: `string | number` -- static **ngAcceptInputType_innerEndExtent**: `string | number` -- static **ngAcceptInputType_innerStartExtent**: `string | number` -- static **ngAcceptInputType_outerEndExtent**: `string | number` -- static **ngAcceptInputType_outerStartExtent**: `string | number` -- static **ngAcceptInputType_startValue**: `string | number` -- static **ngAcceptInputType_strokeThickness**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **brush**: `string` — Gets or sets the brush to use to fill the range. -- **endValue**: `number` — Gets or sets the value at which the range ends along the scale. -- **i**: `XamLinearGraphRange` -- **innerEndExtent**: `number` — Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to end rendering the inner edge of the range. -Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. -- **innerStartExtent**: `number` — Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to start rendering the inner edge of the range. -Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. -- **name**: `string` — Gets or sets the name of the range. -- **outerEndExtent**: `number` — Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to end rendering the outer edge of the range. -Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. -- **outerStartExtent**: `number` — Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to start rendering the outer edge of the range. -Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. -- **outline**: `string` — Gets or sets the outline to use when rendering the range. -- **rangeInternal**: `XamLinearGraphRange` -- **startValue**: `number` — Gets or sets the value at which the range starts along the scale. -- **strokeThickness**: `number` — Gets or sets the stroke thickness to use when rendering this range's outline. -- **findByName**(name: string): any -- **ngOnInit**(): void — 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. -- static **_createFromInternal**(internal: any): IgxLinearGraphRangeComponent - -### [IgxRadialGaugeComponent](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/classes/IgxRadialGaugeComponent) -A radial gauge for displaying a single value on a defined scale. - -- **constructor**(_renderer: Renderer2, _elRef: ViewContainerRef, _ngZone: NgZone, _componentFactoryResolver: ComponentFactoryResolver, _injector: Injector): IgxRadialGaugeComponent -- **_dynamicContent**: `ViewContainerRef` -- **actualRanges**: `IgxRadialGaugeRangeComponent[]` — The ranges actually present in the chart. Do not directly modify this array. -This array's contents can be modified by causing Angular to reproject the child content. -Or adding and removing ranges from the manual ranges collection on the ranges property. -- **contentRanges**: `QueryList` -- static **ngAcceptInputType_actualHighlightValueDisplayMode**: `string | HighlightedValueDisplayMode` -- static **ngAcceptInputType_actualHighlightValueOpacity**: `string | number` -- static **ngAcceptInputType_actualMaximumValue**: `string | number` -- static **ngAcceptInputType_actualMinimumValue**: `string | number` -- static **ngAcceptInputType_actualPixelScalingRatio**: `string | number` -- static **ngAcceptInputType_animating**: `string | boolean` -- static **ngAcceptInputType_backingCornerRadius**: `string | number` -- static **ngAcceptInputType_backingInnerExtent**: `string | number` -- static **ngAcceptInputType_backingOuterExtent**: `string | number` -- static **ngAcceptInputType_backingOversweep**: `string | number` -- static **ngAcceptInputType_backingShape**: `string | RadialGaugeBackingShape` -- static **ngAcceptInputType_backingStrokeThickness**: `string | number` -- static **ngAcceptInputType_centerX**: `string | number` -- static **ngAcceptInputType_centerY**: `string | number` -- static **ngAcceptInputType_duplicateLabelOmissionStrategy**: `string | RadialGaugeDuplicateLabelOmissionStrategy` -- static **ngAcceptInputType_highlightLabelAngle**: `string | number` -- static **ngAcceptInputType_highlightLabelDisplaysValue**: `string | boolean` -- static **ngAcceptInputType_highlightLabelExtent**: `string | number` -- static **ngAcceptInputType_highlightLabelFormatSpecifiers**: `string | any[]` -- static **ngAcceptInputType_highlightLabelSnapsToNeedlePivot**: `string | boolean` -- static **ngAcceptInputType_highlightValue**: `string | number` -- static **ngAcceptInputType_highlightValueDisplayMode**: `string | HighlightedValueDisplayMode` -- static **ngAcceptInputType_highlightValueOpacity**: `string | number` -- static **ngAcceptInputType_interval**: `string | number` -- static **ngAcceptInputType_isHighlightNeedleDraggingConstrained**: `string | boolean` -- static **ngAcceptInputType_isHighlightNeedleDraggingEnabled**: `string | boolean` -- static **ngAcceptInputType_isNeedleDraggingConstrained**: `string | boolean` -- static **ngAcceptInputType_isNeedleDraggingEnabled**: `string | boolean` -- static **ngAcceptInputType_labelExtent**: `string | number` -- static **ngAcceptInputType_labelFormatSpecifiers**: `string | any[]` -- static **ngAcceptInputType_labelInterval**: `string | number` -- static **ngAcceptInputType_maximumValue**: `string | number` -- static **ngAcceptInputType_minimumValue**: `string | number` -- static **ngAcceptInputType_minorTickCount**: `string | number` -- static **ngAcceptInputType_minorTickEndExtent**: `string | number` -- static **ngAcceptInputType_minorTickStartExtent**: `string | number` -- static **ngAcceptInputType_minorTickStrokeThickness**: `string | number` -- static **ngAcceptInputType_needleBaseFeatureExtent**: `string | number` -- static **ngAcceptInputType_needleBaseFeatureWidthRatio**: `string | number` -- static **ngAcceptInputType_needleEndExtent**: `string | number` -- static **ngAcceptInputType_needleEndWidthRatio**: `string | number` -- static **ngAcceptInputType_needlePivotInnerWidthRatio**: `string | number` -- static **ngAcceptInputType_needlePivotShape**: `string | RadialGaugePivotShape` -- static **ngAcceptInputType_needlePivotStrokeThickness**: `string | number` -- static **ngAcceptInputType_needlePivotWidthRatio**: `string | number` -- static **ngAcceptInputType_needlePointFeatureExtent**: `string | number` -- static **ngAcceptInputType_needlePointFeatureWidthRatio**: `string | number` -- static **ngAcceptInputType_needleShape**: `string | RadialGaugeNeedleShape` -- static **ngAcceptInputType_needleStartExtent**: `string | number` -- static **ngAcceptInputType_needleStartWidthRatio**: `string | number` -- static **ngAcceptInputType_needleStrokeThickness**: `string | number` -- static **ngAcceptInputType_opticalScalingEnabled**: `string | boolean` -- static **ngAcceptInputType_opticalScalingRatio**: `string | number` -- static **ngAcceptInputType_opticalScalingSize**: `string | number` -- static **ngAcceptInputType_pixelScalingRatio**: `string | number` -- static **ngAcceptInputType_radiusMultiplier**: `string | number` -- static **ngAcceptInputType_rangeBrushes**: `string | string[]` -- static **ngAcceptInputType_rangeOutlines**: `string | string[]` -- static **ngAcceptInputType_scaleEndAngle**: `string | number` -- static **ngAcceptInputType_scaleEndExtent**: `string | number` -- static **ngAcceptInputType_scaleOversweep**: `string | number` -- static **ngAcceptInputType_scaleOversweepShape**: `string | RadialGaugeScaleOversweepShape` -- static **ngAcceptInputType_scaleStartAngle**: `string | number` -- static **ngAcceptInputType_scaleStartExtent**: `string | number` -- static **ngAcceptInputType_scaleSweepDirection**: `string | SweepDirection` -- static **ngAcceptInputType_subtitleAngle**: `string | number` -- static **ngAcceptInputType_subtitleDisplaysValue**: `string | boolean` -- static **ngAcceptInputType_subtitleExtent**: `string | number` -- static **ngAcceptInputType_subtitleFormatSpecifiers**: `string | any[]` -- static **ngAcceptInputType_subtitleSnapsToNeedlePivot**: `string | boolean` -- static **ngAcceptInputType_tickEndExtent**: `string | number` -- static **ngAcceptInputType_tickStartExtent**: `string | number` -- static **ngAcceptInputType_tickStrokeThickness**: `string | number` -- static **ngAcceptInputType_titleAngle**: `string | number` -- static **ngAcceptInputType_titleDisplaysValue**: `string | boolean` -- static **ngAcceptInputType_titleExtent**: `string | number` -- static **ngAcceptInputType_titleFormatSpecifiers**: `string | any[]` -- static **ngAcceptInputType_titleSnapsToNeedlePivot**: `string | boolean` -- static **ngAcceptInputType_transitionDuration**: `string | number` -- static **ngAcceptInputType_transitionProgress**: `string | number` -- static **ngAcceptInputType_value**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualHighlightValueDisplayMode**: `HighlightedValueDisplayMode` — Gets whether and how to display the highlighted value. -- **actualHighlightValueOpacity**: `number` — Gets the actual opacity of the primary needle while highlighting -- **actualMaximumValue**: `number` — Gets the resolved maximum value of the scale. -- **actualMaximumValueChange**: `EventEmitter` -- **actualMinimumValue**: `number` — Gets the resolved minimum value of the scale. -- **actualMinimumValueChange**: `EventEmitter` -- **actualPixelScalingRatio**: `number` — Gets the actual pixel scaling ratio used to affect the pixel density of the control. -A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control -to appear blurry. -- **alignHighlightLabel**: `EventEmitter` — Event which is raised when a highlight label of the gauge is aligned and styled. -Function takes first argument null and second argument ui. -Use ui.owner to obtain reference to gauge widget. -Use ui.actualMinimumValue to obtain the minimum value of gauge scale. -Use ui.actualMaximumValue to obtain the maximum value of gauge scale. -Use ui.startAngle to obtain the starting angle of gauge scale. -Use ui.endAngle to obtain the ending angle of gauge scale. -Use ui.angle to obtain the angle on the gauge scale at which the label will be located. -Use ui.value to obtain the value on the gauge scale associated with the label. -Use ui.label to obtain the string value of the label. -- **alignLabel**: `EventEmitter` — Event which is raised when a label of the gauge is aligned along the scale. -Function takes first argument null and second argument ui. -Use ui.owner to obtain reference to gauge widget. -Use ui.actualMinimumValue to obtain the minimum value of gauge scale. -Use ui.actualMaximumValue to obtain the maximum value of gauge scale. -Use ui.startAngle to obtain the starting angle of gauge scale. -Use ui.endAngle to obtain the ending angle of gauge scale. -Use ui.angle to obtain the angle on the gauge scale at which the label will be located. -Use ui.value to obtain the value on the gauge scale associated with the label. -Use ui.label to obtain the string value of the label. -Use ui.width to obtain the width of the label. -Use ui.height to obtain the height of the label. -Use ui.offsetX to obtain the X offset of the label on the gauge scale. -Use ui.offsetY to obtain the Y offset of the label on the gauge scale. -- **alignSubtitle**: `EventEmitter` — Event which is raised when a subtitle of the gauge is aligned and styled. -Function takes first argument null and second argument ui. -Use ui.owner to obtain reference to gauge widget. -Use ui.actualMinimumValue to obtain the minimum value of gauge scale. -Use ui.actualMaximumValue to obtain the maximum value of gauge scale. -Use ui.startAngle to obtain the starting angle of gauge scale. -Use ui.endAngle to obtain the ending angle of gauge scale. -Use ui.angle to obtain the angle on the gauge scale at which the label will be located. -Use ui.value to obtain the value on the gauge scale associated with the label. -Use ui.label to obtain the string value of the label. -- **alignTitle**: `EventEmitter` — Event which is raised when a title of the gauge is aligned and styled. -Function takes first argument null and second argument ui. -Use ui.owner to obtain reference to gauge widget. -Use ui.actualMinimumValue to obtain the minimum value of gauge scale. -Use ui.actualMaximumValue to obtain the maximum value of gauge scale. -Use ui.startAngle to obtain the starting angle of gauge scale. -Use ui.endAngle to obtain the ending angle of gauge scale. -Use ui.angle to obtain the angle on the gauge scale at which the label will be located. -Use ui.value to obtain the value on the gauge scale associated with the label. -Use ui.label to obtain the string value of the label. -- **animating**: `boolean` — Gets a value indicating whether the radial gauge is currently animating. -- **backingBrush**: `string` — Gets or sets the brush to use to fill the backing of the gauge. -- **backingCornerRadius**: `number` — Gets or sets the corner rounding radius to use for the fitted scale backings. -- **backingInnerExtent**: `number` — Gets or sets the inner extent of the gauge backing. -- **backingOuterExtent**: `number` — Gets or sets the outer extent of the gauge backing. -- **backingOutline**: `string` — Gets or sets the brush to use for the outline of the backing. -- **backingOversweep**: `number` — Gets or sets the over sweep angle to apply to the backing if it is displaying fitted (in degrees). Must be greater or equal to 0. -- **backingShape**: `RadialGaugeBackingShape` — Gets or sets the type of shape to use for the backing of the gauge. -- **backingStrokeThickness**: `number` — Gets or sets the stroke thickness of the backing outline. -- **centerX**: `number` — Gets or sets the x position of the center of the gauge with the value ranging from 0 to 1. -- **centerY**: `number` — Gets or sets the y position of the center of the gauge with the value ranging from 0 to 1. -- **duplicateLabelOmissionStrategy**: `RadialGaugeDuplicateLabelOmissionStrategy` — Gets or sets the strategy to use for omitting labels if the first and last label have the same value. -- **font**: `string` — Gets or sets the font. -- **fontBrush**: `string` — Gets or sets the brush to use for the label font. -- **formatHighlightLabel**: `EventEmitter` — Event which is raised when a highlight label of the gauge is formatted. -Function takes first argument null and second argument ui. -Use ui.owner to obtain reference to gauge widget. -Use ui.actualMinimumValue to obtain the minimum value of gauge scale. -Use ui.actualMaximumValue to obtain the maximum value of gauge scale. -Use ui.startAngle to obtain the starting angle of gauge scale. -Use ui.endAngle to obtain the ending angle of gauge scale. -Use ui.angle to obtain the angle on the gauge scale at which the title will be located. -Use ui.value to obtain the value on the gauge scale associated with the title. -Use ui.label to obtain the string value of the title. -- **formatLabel**: `EventEmitter` — Event which is raised when a label of the gauge is formatted. -Function takes first argument null and second argument ui. -Use ui.owner to obtain reference to gauge widget. -Use ui.actualMinimumValue to obtain the minimum value of gauge scale. -Use ui.actualMaximumValue to obtain the maximum value of gauge scale. -Use ui.startAngle to obtain the starting angle of gauge scale. -Use ui.endAngle to obtain the ending angle of gauge scale. -Use ui.angle to obtain the angle on the gauge scale at which the label will be located. -Use ui.value to obtain the value on the gauge scale associated with the label. -Use ui.label to obtain the string value of the label. -- **formatSubtitle**: `EventEmitter` — Event which is raised when a subtitle of the gauge is formatted. -Function takes first argument null and second argument ui. -Use ui.owner to obtain reference to gauge widget. -Use ui.actualMinimumValue to obtain the minimum value of gauge scale. -Use ui.actualMaximumValue to obtain the maximum value of gauge scale. -Use ui.startAngle to obtain the starting angle of gauge scale. -Use ui.endAngle to obtain the ending angle of gauge scale. -Use ui.angle to obtain the angle on the gauge scale at which the subtitle will be located. -Use ui.value to obtain the value on the gauge scale associated with the subtitle. -Use ui.label to obtain the string value of the subtitle. -- **formatTitle**: `EventEmitter` — Event which is raised when a title of the gauge is formatted. -Function takes first argument null and second argument ui. -Use ui.owner to obtain reference to gauge widget. -Use ui.actualMinimumValue to obtain the minimum value of gauge scale. -Use ui.actualMaximumValue to obtain the maximum value of gauge scale. -Use ui.startAngle to obtain the starting angle of gauge scale. -Use ui.endAngle to obtain the ending angle of gauge scale. -Use ui.angle to obtain the angle on the gauge scale at which the title will be located. -Use ui.value to obtain the value on the gauge scale associated with the title. -Use ui.label to obtain the string value of the title. -- **height**: `string` -- **highlightLabelAngle**: `number` — Gets or sets the angle for the highlight label in degrees. -- **highlightLabelBrush**: `string` — Gets or sets the brush to use for rendering highlight text -- **highlightLabelDisplaysValue**: `boolean` — Gets or sets the highlight label shows values of the gauge. -- **highlightLabelExtent**: `number` — Gets or sets the angle for the highlight label in degrees. -- **highlightLabelFormat**: `string` — Gets or sets the format used when creating highlight label. -- **highlightLabelFormatSpecifiers**: `any[]` — Gets or sets the format specifiers to use with the HighlightLabelFormat string. -- **highlightLabelSnapsToNeedlePivot**: `boolean` — Gets or sets whether or not the highlight label should snap angle position to needle pivot (opposite of needle pointer). -- **highlightLabelText**: `string` — Gets or sets the text displayed for the highlight label of the gauge. -- **highlightLabelTextStyle**: `string` — Gets or Sets the style to use for the units text. -- **highlightValue**: `number` — Gets or sets the highlight value at which to point the secondary needle of the gauge. -- **highlightValueChanged**: `EventEmitter` — Occurs when the Hightlight Value property changes. -- **highlightValueDisplayMode**: `HighlightedValueDisplayMode` — Gets or sets whether and how to display the highlighted value. -- **highlightValueOpacity**: `number` — Gets or sets the opacity of the primary needle while highlighting -- **interval**: `number` — Gets or sets the interval to use for the scale. -- **isHighlightNeedleDraggingConstrained**: `boolean` — Gets or sets whether the needle is constrained within the minimum and maximum value range during dragging. -- **isHighlightNeedleDraggingEnabled**: `boolean` — Gets or sets whether needle dragging is enabled or not. -- **isNeedleDraggingConstrained**: `boolean` — Gets or sets whether the needle is constrained within the minimum and maximum value range during dragging. -- **isNeedleDraggingEnabled**: `boolean` — Gets or sets whether needle dragging is enabled or not. -- **labelExtent**: `number` — Gets or sets the position at which to put the labels as a value from 0 to 1, measured form the center of the gauge. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **labelFormat**: `string` — Gets or sets the label composite format used when creating label values. -- **labelFormatSpecifiers**: `any[]` — Gets or sets the format specifiers to use with the LabelFormat string. -- **labelInterval**: `number` — Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale. -- **maximumValue**: `number` — Gets or sets the maximum value of the scale. -- **minimumValue**: `number` — Gets or sets the minimum value of the scale. -- **minorTickBrush**: `string` — Gets or sets the brush to use for the minor tickmarks. -- **minorTickCount**: `number` — Gets or sets the number of minor tickmarks to place between major tickmarks. -- **minorTickEndExtent**: `number` — Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the center of the gauge. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **minorTickStartExtent**: `number` — Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the center of the gauge. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **minorTickStrokeThickness**: `number` — Gets or sets the stroke thickness to use when rendering minor ticks. -- **needleBaseFeatureExtent**: `number` — Gets or sets the extent of the feature which is closest to the base (e.g. a bulb) with a value from -1 to 1. Note: Only some needle shapes respect this property, namely: NeedleWithBulb, RectangleWithBulb, TrapezoidWithBulb, and TriangleWithBulb. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **needleBaseFeatureWidthRatio**: `number` — Gets or sets the width of the needle at its feature which is closest to the base (e.g. a bulb) with a value from 0 to 1. Note: Only some needle shapes respect this property, namely: NeedleWithBulb, RectangleWithBulb, TrapezoidWithBulb, and TriangleWithBulb. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **needleBrush**: `string` — Gets or sets the brush to use when rendering the fill of the needle. -- **needleEndExtent**: `number` — Gets or sets the extent (from -1 to 1) at which to end rendering the needle, measured from the center of the gauge. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **needleEndWidthRatio**: `number` — Gets or sets the width of the needle at its point using a value from (0 to 1). Note: Only some needle shapes respect this property. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **needleOutline**: `string` — Gets or sets the brush to use when rendering the outline of the needle. -- **needlePivotBrush**: `string` — Gets or sets the brush to use for filling the needle cap. Note: this only applies to certain cap shapes. -- **needlePivotInnerWidthRatio**: `number` — Gets or sets the width of the inner cutout section of the needle cap with a value from 0 to 1. Note: Will only take effect if you have a cap set on the needle that has a cutout section. -- **needlePivotOutline**: `string` — Gets or sets the brush to use for the outlines of the needle cap. -- **needlePivotShape**: `RadialGaugePivotShape` — Gets or sets the shape to use for the needle cap. -- **needlePivotStrokeThickness**: `number` — Gets or sets the stroke thickness to use for the outline of the needle cap. -- **needlePivotWidthRatio**: `number` — Gets or sets the width of the cap of the needle with a value from 0 to 1. Note: Will only take effect if you have a cap set on the needle. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **needlePointFeatureExtent**: `number` — Gets or sets the extent of the feature which is closest to the point (e.g. the tapering point of a needle) with a value from -1 to 1. Note: Only some needle shapes respect this property. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **needlePointFeatureWidthRatio**: `number` — Gets or sets the width of the needle at its feature which is closest to the point (e.g. the tapering point of a needle) with a value from 0 to 1. Note: Only some needle shapes respect this property. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **needleShape**: `RadialGaugeNeedleShape` — Gets or sets the shape to use when rendering the needle from a number of options. -- **needleStartExtent**: `number` — Gets or sets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **needleStartWidthRatio**: `number` — Gets or sets the width of the needle at its point using a value from (0 to 1). Note: Only some needle shapes respect this property. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **needleStrokeThickness**: `number` — Gets or sets the stroke thickness of the needle outline. -- **opticalScalingEnabled**: `boolean` — Gets or sets the title uses optical scaling when the gauge is resized. -- **opticalScalingRatio**: `number` — Gets the optical scaling ratio calculated by dividing minimum gauge size by value of OpticalScalingSize property. -- **opticalScalingSize**: `number` — Gets or sets the size at which labels have 100% optical scaling, e.g. labels will have larger fonts when gauge's size is larger -- labels will have 200% larger fonts when gauge's size is 1000 and this property is set to 500 -- labels will have 50% smaller fonts when gauge's size is 250 and this property is set to 500 -- **pixelScalingRatio**: `number` — Gets or sets the scaling value used to affect the pixel density of the control. -A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control -to appear blurry. -- **radiusMultiplier**: `number` — Gets or sets the multiplying factor to apply to the normal radius of the gauge. -The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. -This introduces a multiplicative factor to that value. -- **rangeBrushes**: `string[]` — Gets or sets a collection of brushes to be used as the palette for gauge ranges. -- **rangeOutlines**: `string[]` — Gets or sets a collection of brushes to be used as the palette for gauge outlines. -- **ranges**: `IgxRadialGaugeRangeCollection` — A collection or manually added axes for the chart. -- **scaleBrush**: `string` — Gets or sets the brush to use to fill the background of the scale. -- **scaleEndAngle**: `number` — Gets or sets the end angle for the scale in degrees. -- **scaleEndExtent**: `number` — Gets or sets the position at which to stop rendering the scale as a value from 0 to 1 measured from the center of the gauge. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **scaleOversweep**: `number` — Gets or sets the extra degrees of sweep to apply to the scale background. Must be greater or equal to 0. -- **scaleOversweepShape**: `RadialGaugeScaleOversweepShape` — Gets or sets the oversweep shape to use for the excess fill area for the scale. -- **scaleStartAngle**: `number` — Gets or sets the start angle for the scale in degrees. -- **scaleStartExtent**: `number` — Gets or sets the position at which to start rendering the scale, measured from the center of the gauge as a value from 0 to 1. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **scaleSweepDirection**: `SweepDirection` — Gets or sets the direction in which the scale sweeps around the center from the start angle to end angle. -- **subtitleAngle**: `number` — Gets or sets the angle for the inner label in degrees. -- **subtitleBrush**: `string` — Gets or sets the brush to use for rendering inner unit text -- **subtitleDisplaysValue**: `boolean` — Gets or sets the subtitle show values of the gauge. -- **subtitleExtent**: `number` — Gets or sets the angle for the inner label in degrees. -- **subtitleFormat**: `string` — Gets or sets the subtitle format used when creating subtitle label. -- **subtitleFormatSpecifiers**: `any[]` — Gets or sets the format specifiers to use with the SubtitleFormat string. -- **subtitleSnapsToNeedlePivot**: `boolean` — Gets or sets whether or not the subtitle should snap angle position to needle pivot (opposite of needle pointer). -- **subtitleText**: `string` — Gets or sets the text displayed in the subtitle of the gauge. -- **subtitleTextStyle**: `string` — Gets or Sets the style to use for the units text. -- **tickBrush**: `string` — Gets or sets the brush to use for the major tickmarks. -- **tickEndExtent**: `number` — Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the center of the gauge. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **tickStartExtent**: `number` — Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the center of the gauge. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **tickStrokeThickness**: `number` — Gets or sets the stroke thickness to use when rendering ticks. -- **titleAngle**: `number` — Gets or sets the angle for the inner label in degrees. -- **titleBrush**: `string` — Gets or sets the brush to use for rendering inner unit text -- **titleDisplaysValue**: `boolean` — Gets or sets the title show values of the gauge. -- **titleExtent**: `number` — Gets or sets the angle for the inner label in degrees. -- **titleFormat**: `string` — Gets or sets the title format used when creating title label. -- **titleFormatSpecifiers**: `any[]` — Gets or sets the format specifiers to use with the TitleFormat string. -- **titleSnapsToNeedlePivot**: `boolean` — Gets or sets whether or not the title should snap angle position to needle pivot (opposite of needle pointer). -- **titleText**: `string` — Gets or sets the text displayed in the title of the gauge. -- **titleTextStyle**: `string` — Gets or Sets the style to use for the units text. -- **transitionDuration**: `number` — Gets or sets the number of milliseconds over which changes to the gauge should be animated. -- **transitionProgress**: `number` — Gets the transition progress of the animation when the control is animating. -- **value**: `number` — Gets or sets the value at which to point the needle of the gauge. -- **valueChanged**: `EventEmitter` — Occurs when the Value property changes. -- **width**: `string` -- **containerResized**(): void -- **exportSerializedVisualData**(): string — Returns visuals as a serialized string. -- **findByName**(name: string): any -- **flush**(): void — Use to force the radial gauge to finish any deferred work before printing or evaluating its visual. -This should only be called if the visual of the radial gauge needs to be synchronously saved or evaluated. -Calling this method too often will hinder the performance of the radial gauge. -- **getPointForValue**(value: number, extent: number): IgPoint -- **getValueForPoint**(point: IgPoint): number — Gets the value for the main scale of the gauge for a given point within the bounds of the gauge. -- **highlightNeedleContainsPoint**(point: IgPoint, isFinger: boolean): boolean -- **needleContainsPoint**(point: IgPoint, isFinger: boolean): boolean -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void — A callback method that performs custom clean-up, invoked immediately -before a directive, pipe, or service instance is destroyed. -- **provideContainer**(container: any): void — Called by the UI framework to provide a UI container for rendering this control. -- **scaleValue**(value: number): number — Scales a value on the gauge's main scale to an angle around the center point of the gauge, in radians. -- **styleUpdated**(): void -- **unscaleValue**(angle: number): number — Unscales a value from an angle in radians to the represented value along the main scale of the gauge. -- **updateStyle**(): void -- static **_createFromInternal**(internal: any): IgxRadialGaugeComponent - -### [IgxRadialGaugeRangeCollection](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/classes/IgxRadialGaugeRangeCollection) - -- **constructor**(list?: IgxRadialGaugeRangeComponent[]): IgxRadialGaugeRangeCollection - -### [IgxRadialGaugeRangeComponent](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/classes/IgxRadialGaugeRangeComponent) - -- **constructor**(): IgxRadialGaugeRangeComponent -- static **ngAcceptInputType_endValue**: `string | number` -- static **ngAcceptInputType_innerEndExtent**: `string | number` -- static **ngAcceptInputType_innerStartExtent**: `string | number` -- static **ngAcceptInputType_outerEndExtent**: `string | number` -- static **ngAcceptInputType_outerStartExtent**: `string | number` -- static **ngAcceptInputType_startValue**: `string | number` -- static **ngAcceptInputType_strokeThickness**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **brush**: `string` — Gets or sets the brush to use to fill the range. -- **endValue**: `number` — Gets or sets the value at which the range ends along the scale. -- **i**: `XamRadialGaugeRange` -- **innerEndExtent**: `number` — Gets or sets the distance from the center of the gauge (from 0 to 1) at which to end rendering the inner sweep of the range. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **innerStartExtent**: `number` — Gets or sets the distance from the center of the gauge (from 0 to 1) at which to start rendering the inner sweep of the range. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **name**: `string` — Gets or sets the name of the range. -- **outerEndExtent**: `number` — Gets or sets the distance from the center of the gauge (from 0 to 1) at which to end rendering the outer sweep of the range. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **outerStartExtent**: `number` — Gets or sets the distance from the center of the gauge (from 0 to 1) at which to start rendering the outer sweep of the range. -Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **outline**: `string` — Gets or sets the outline to use when rendering the range. -- **rangeInternal**: `XamRadialGaugeRange` -- **startValue**: `number` — Gets or sets the value at which the range starts along the scale. -- **strokeThickness**: `number` — Gets or sets the stroke thickness to use when rendering this range's outline. -- **findByName**(name: string): any -- **ngOnInit**(): void — 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. -- static **_createFromInternal**(internal: any): IgxRadialGaugeRangeComponent - -## Enumerations - -### [LinearGraphNeedleShape](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/enums/LinearGraphNeedleShape) -Enumeration of preset needle shapes. - -- **Custom** = 0 — A custom user defined needle shape. -- **Needle** = 3 — A needle shaped like a needle. -- **Rectangle** = 1 — A needle shaped like a rectangle. -- **Trapezoid** = 4 — A needle shaped like a trapezoid. -- **Triangle** = 2 — A needle shaped like a triangle. - -### [LinearScaleOrientation](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/enums/LinearScaleOrientation) -Describes the orientation of a linear scale. - -- **Horizontal** = 0 — The scale has a horizontal orientation. -- **Vertical** = 1 — The scale has a vertical orientation. - -### [RadialGaugeBackingShape](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/enums/RadialGaugeBackingShape) -Enum specifying shapes that can be used by the backing area of the radial gauge. - -- **Circular** = 0 — A circular backing shape. -- **Fitted** = 1 — A fitted backing shape. - -### [RadialGaugeDuplicateLabelOmissionStrategy](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/enums/RadialGaugeDuplicateLabelOmissionStrategy) -Enum specifying multiple strategies for omitting labels. - -- **OmitBoth** = 3 — Omit both labels. -- **OmitFirst** = 1 — Omit the first label. -- **OmitLast** = 0 — Omit the last label. -- **OmitNeither** = 2 — Omit no labels. - -### [RadialGaugeNeedleShape](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/enums/RadialGaugeNeedleShape) -Enum specifying various preset needle shapes. - -- **Needle** = 3 — A needle shape. -- **NeedleWithBulb** = 7 — A needle shape with a bulb at the end. -- **None** = 0 — No shape. -- **Rectangle** = 1 — A rectangle shape. -- **RectangleWithBulb** = 5 — A rectangle shape with a bulb at the end. -- **Trapezoid** = 4 — A trapezoid shape. -- **TrapezoidWithBulb** = 8 — A trapezoid shape with a bulb at the end. -- **Triangle** = 2 — A triangle shape. -- **TriangleWithBulb** = 6 — A triangle shape with a bulb at the end. - -### [RadialGaugePivotShape](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/enums/RadialGaugePivotShape) -Enum specifying shapes for the needle pivot. - -- **Circle** = 1 — A circle shaped pivot. -- **CircleOverlay** = 3 — A circle pivot overlayed on top of the needle. -- **CircleOverlayWithHole** = 4 — A circle pivot with a hole in it overlayed on top of the needle. -- **CircleUnderlay** = 5 — A circle pivot rendered underneath the needle. -- **CircleUnderlayWithHole** = 6 — A circle pivot with a hold in it rendered underneath the needle. -- **CircleWithHole** = 2 — A circle pivot with a hole in it. -- **None** = 0 — No pivot shape. - -### [RadialGaugeScaleOversweepShape](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/enums/RadialGaugeScaleOversweepShape) -Enum specifying oversweep shapes. - -- **Auto** = 0 — A default oversweep shape. -- **Circular** = 1 — A circular oversweep shape. -- **Fitted** = 2 — A fitted oversweep shape. - -### [TitlesPosition](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/enums/TitlesPosition) -Enum specifying the position of the titles relative to scale's start/end. - -- **ScaleEnd** = 1 — The titles are placed at the scale's end (maximum value). -- **ScaleStart** = 0 — The titles are placed at scale's start (minimum value). - -## Variables - -### [BulletGraphStylingDefaults](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/variables/BulletGraphStylingDefaults) -`any` - -### [LinearGaugeStylingDefaults](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/variables/LinearGaugeStylingDefaults) -`any` - -### [RadialGaugeStylingDefaults](https://www.infragistics.com/api/angular/igniteui-angular-gauges/latest/variables/RadialGaugeStylingDefaults) -`any` diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular-inputs/latest/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular-inputs/latest/llms-full.txt deleted file mode 100644 index 2f43c66fd..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular-inputs/latest/llms-full.txt +++ /dev/null @@ -1,1660 +0,0 @@ -# Ignite UI for Angular Inputs vlatest — Full API Reference - -> Complete API reference for the Ignite UI for Angular Inputs package (latest). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: Angular -Package: igniteui-angular-inputs -Version: latest - -## Classes - -### [IgxButtonClickEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxButtonClickEventArgs) - -- **constructor**(): IgxButtonClickEventArgs - -### [IgxButtonGroupSelectionChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxButtonGroupSelectionChangedEventArgs) - -- **constructor**(): IgxButtonGroupSelectionChangedEventArgs - -### [IgxCheckboxChangeEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxCheckboxChangeEventArgs) - -- **constructor**(): IgxCheckboxChangeEventArgs -- static **ngAcceptInputType_isChecked**: `string | boolean` -- static **ngAcceptInputType_isIndeterminate**: `string | boolean` -- **isChecked**: `boolean` -- **isIndeterminate**: `boolean` - -### [IgxColorEditorComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxColorEditorComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxColorEditorComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **container**: `Element` -- static **ngAcceptInputType_allowTextInput**: `string | boolean` -- static **ngAcceptInputType_baseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_density**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_isDisabled**: `string | boolean` -- static **ngAcceptInputType_isFixed**: `string | boolean` -- static **ngAcceptInputType_openAsChild**: `string | boolean` -- static **ngAcceptInputType_openOnFocus**: `string | boolean` -- static **ngAcceptInputType_showClearButton**: `string | boolean` -- static **ngAcceptInputType_useTopLayer**: `string | boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **allowTextInput**: `boolean` — Gets or sets the AllowTextInput property to detirmine if entering text into the input is allowed -- **baseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the date picker. -- **density**: `ControlDisplayDensity` — Gets or sets the display density to use for the date pcicker. -- **gotFocus**: `EventEmitter` -- **iconColor**: `string` — Gets or Sets the text color -- **isDisabled**: `boolean` -- **isFixed**: `boolean` — Indicates that the editor dropdown will position itself relative to the window instead of the document. -- **label**: `string` — Gets or Sets the property name that contains the label. -- **labelTextColor**: `string` — Gets or sets the color to use for the text. -- **labelTextStyle**: `string` — Gets or sets the font to use for the input. -- **lostFocus**: `EventEmitter` -- **openAsChild**: `boolean` — Indicates that the dropdown should open as a child of the color editor. -- **openOnFocus**: `boolean` — Gets or sets the AllowTextInput property to detirmine if entering text into the input is allowed -- **showClearButton**: `boolean` — Gets or sets the ShowClearButton property to detirmine if the clear button is shown -- **textColor**: `string` — Gets or Sets the text color -- **textStyle**: `string` — Gets or sets the font to use for the combobox. -- **useTopLayer**: `boolean` — Indicates that the dropdown will place itself into the browser top layer. -- **value**: `string` — Gets or Sets color value of the editor. -- **valueChanged**: `EventEmitter` — Called when color is selected. -- **valueChanging**: `EventEmitter` — Called when color is selected. -- **findByName**(name: string): any -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void -- **select**(): void -- **updateStyle**(): void -- static **_createFromInternal**(internal: any): IgxColorEditorComponent - -### [IgxColorEditorGotFocusEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxColorEditorGotFocusEventArgs) - -- **constructor**(): IgxColorEditorGotFocusEventArgs - -### [IgxColorEditorLostFocusEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxColorEditorLostFocusEventArgs) - -- **constructor**(): IgxColorEditorLostFocusEventArgs - -### [IgxColorEditorPanelClosedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxColorEditorPanelClosedEventArgs) - -- **constructor**(): IgxColorEditorPanelClosedEventArgs - -### [IgxColorEditorPanelComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxColorEditorPanelComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxColorEditorPanelComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **container**: `Element` -- static **ngAcceptInputType_actualPixelScalingRatio**: `string | number` -- static **ngAcceptInputType_baseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_density**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_pixelScalingRatio**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualPixelScalingRatio**: `number` -- **backgroundColor**: `string` — Gets or Sets the selected color background color -- **baseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the ColorEditorPanel. -- **density**: `ControlDisplayDensity` — Gets or sets the display density to use for the ColorEditorPanel. -- **focusColorBorderColor**: `string` — Gets or Sets the focus color border color -- **hoverBackgroundColor**: `string` — Gets or Sets the focus date background color -- **pixelScalingRatio**: `number` — Gets or sets the scaling value used to affect the pixel density of the control. -A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control -to appear blurry. -- **selectedColorBorderColor**: `string` — Gets or Sets the selected color boreder color -- **selectedFocusDateBackgroundColor**: `string` — Gets or Sets the selected color border color -- **textColor**: `string` — Gets or Sets the selected date text color -- **textStyle**: `string` — Gets or sets the font to use for the combobox. -- **value**: `string` — Gets or Sets the value for the color editor panel. -- **valueChanged**: `EventEmitter` — Called when date is selected. -- **valueChanging**: `EventEmitter` — Called when date is selected. -- **findByName**(name: string): any -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void -- **updateStyle**(): void -- static **_createFromInternal**(internal: any): IgxColorEditorPanelComponent - -### [IgxColorEditorPanelSelectedValueChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxColorEditorPanelSelectedValueChangedEventArgs) - -- **constructor**(): IgxColorEditorPanelSelectedValueChangedEventArgs -- **newValue**: `string` -- **oldValue**: `string` - -### [IgxGotFocusEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxGotFocusEventArgs) - -- **constructor**(): IgxGotFocusEventArgs - -### [IgxInputChangeEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxInputChangeEventArgs) - -- **constructor**(): IgxInputChangeEventArgs -- static **ngAcceptInputType_isCompositionInProgress**: `string | boolean` -- **isCompositionInProgress**: `boolean` -- **value**: `string` - -### [IgxLostFocusEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxLostFocusEventArgs) - -- **constructor**(): IgxLostFocusEventArgs - -### [IgxMultiSliderComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxMultiSliderComponent) - -- **constructor**(): IgxMultiSliderComponent -- static **ngAcceptInputType_actualPixelScalingRatio**: `string | number` -- static **ngAcceptInputType_areThumbCalloutsEnabled**: `string | boolean` -- static **ngAcceptInputType_barExtent**: `string | number` -- static **ngAcceptInputType_barStrokeThickness**: `string | number` -- static **ngAcceptInputType_calloutStrokeThickness**: `string | number` -- static **ngAcceptInputType_endInset**: `string | number` -- static **ngAcceptInputType_isCustomBarProvided**: `string | boolean` -- static **ngAcceptInputType_isCustomRangeThumbProvided**: `string | boolean` -- static **ngAcceptInputType_isCustomShadeProvided**: `string | boolean` -- static **ngAcceptInputType_isCustomThumbProvided**: `string | boolean` -- static **ngAcceptInputType_max**: `string | number` -- static **ngAcceptInputType_min**: `string | number` -- static **ngAcceptInputType_orientation**: `string | MultiSliderOrientation` -- static **ngAcceptInputType_pixelScalingRatio**: `string | number` -- static **ngAcceptInputType_rangeThumbStrokeThickness**: `string | number` -- static **ngAcceptInputType_startInset**: `string | number` -- static **ngAcceptInputType_step**: `string | number` -- static **ngAcceptInputType_thumbHeight**: `string | number` -- static **ngAcceptInputType_thumbs**: `string | IgxMultiSliderThumbCollection` -- static **ngAcceptInputType_thumbStrokeThickness**: `string | number` -- static **ngAcceptInputType_thumbWidth**: `string | number` -- static **ngAcceptInputType_trackEndInset**: `string | number` -- static **ngAcceptInputType_trackStartInset**: `string | number` -- static **ngAcceptInputType_windowRect**: `string | IgRect` -- static **ngAcceptInputType_yMax**: `string | number` -- static **ngAcceptInputType_yMin**: `string | number` -- static **ngAcceptInputType_yStep**: `string | number` -- static **ngAcceptInputType_yTrackEndInset**: `string | number` -- static **ngAcceptInputType_yTrackStartInset**: `string | number` -- static **ngAcceptInputType_yValue**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualPixelScalingRatio**: `number` -- **areThumbCalloutsEnabled**: `boolean` -- **barBrush**: `string` -- **barExtent**: `number` -- **barOutline**: `string` -- **barStrokeThickness**: `number` -- **calloutBrush**: `string` -- **calloutOutline**: `string` -- **calloutStrokeThickness**: `number` -- **calloutTextColor**: `string` -- **endInset**: `number` -- **isCustomBarProvided**: `boolean` -- **isCustomRangeThumbProvided**: `boolean` -- **isCustomShadeProvided**: `boolean` -- **isCustomThumbProvided**: `boolean` -- **max**: `number` -- **min**: `number` -- **orientation**: `MultiSliderOrientation` -- **pixelScalingRatio**: `number` — Gets or sets the scaling value used to affect the pixel density of the control. -A higher scaling ratio will produce crisper visuals at the expense of memory. Lower values will cause the control -to appear blurry. -- **rangeThumbBrush**: `string` -- **rangeThumbOutline**: `string` -- **rangeThumbRidgesBrush**: `string` -- **rangeThumbStrokeThickness**: `number` -- **resolvingToolTipValue**: `EventEmitter` -- **startInset**: `number` -- **step**: `number` -- **thumbBrush**: `string` -- **thumbCalloutTextStyle**: `string` -- **thumbHeight**: `number` -- **thumbOutline**: `string` -- **thumbRidgesBrush**: `string` -- **thumbs**: `IgxMultiSliderThumbCollection` — Gets the column definitions that are assigned to the grid. This collection can be modified to add or remove columns in the grid. -- **thumbStrokeThickness**: `number` -- **thumbValueChanged**: `EventEmitter` -- **thumbValueChanging**: `EventEmitter` -- **thumbWidth**: `number` -- **trackEndInset**: `number` -- **trackStartInset**: `number` -- **windowRect**: `IgRect` -- **yMax**: `number` -- **yMin**: `number` -- **yStep**: `number` -- **yTrackEndInset**: `number` -- **yTrackStartInset**: `number` -- **yValue**: `number` -- **yValueChanged**: `EventEmitter` -- **yValueChanging**: `EventEmitter` -- **findByName**(name: string): any -- **flush**(): void -- **hide**(): void — Hides the ZoomSlider. -- **ngOnInit**(): void — 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. -- **onAttachedToUI**(): void -- **onDetachedFromUI**(): void -- **provideContainer**(container: any): void — Called by the UI framework to provide a UI container for rendering this control. -- **show**(): void — Shows the ZoomSlider. -- **trackDirty**(): void -- static **_createFromInternal**(internal: any): IgxMultiSliderComponent - -### [IgxMultiSliderResolvingToolTipValueEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxMultiSliderResolvingToolTipValueEventArgs) - -- **constructor**(): IgxMultiSliderResolvingToolTipValueEventArgs -- static **ngAcceptInputType_position**: `string | number` -- **position**: `number` -- **value**: `any` - -### [IgxMultiSliderThumb](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxMultiSliderThumb) - -- **constructor**(): IgxMultiSliderThumb -- static **ngAcceptInputType_rangePosition**: `string | MultiSliderThumbRangePosition` -- static **ngAcceptInputType_value**: `string | number` -- **propertyUpdated**: `EventEmitter` -- **range**: `IgxMultiSliderTrackThumbRange` -- **rangePosition**: `MultiSliderThumbRangePosition` -- **value**: `number` -- **findByName**(name: string): any -- **push**(amount: number): number - -### [IgxMultiSliderThumbCollection](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxMultiSliderThumbCollection) - -- **constructor**(list?: IgxMultiSliderThumb[]): IgxMultiSliderThumbCollection - -### [IgxMultiSliderThumbValueChangingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxMultiSliderThumbValueChangingEventArgs) - -- **constructor**(): IgxMultiSliderThumbValueChangingEventArgs -- static **ngAcceptInputType_value**: `string | number` -- **thumb**: `IgxMultiSliderThumb` -- **value**: `number` - -### [IgxMultiSliderTrackThumbRange](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxMultiSliderTrackThumbRange) - -- **constructor**(): IgxMultiSliderTrackThumbRange -- static **ngAcceptInputType_maxWidth**: `string | number` -- static **ngAcceptInputType_minWidth**: `string | number` -- static **ngAcceptInputType_position**: `string | number` -- static **ngAcceptInputType_width**: `string | number` -- **higherThumb**: `IgxMultiSliderThumb` -- **lowerThumb**: `IgxMultiSliderThumb` -- **maxWidth**: `number` -- **minWidth**: `number` -- **position**: `number` -- **width**: `number` -- **findByName**(name: string): any - -### [IgxMultiSliderYValueChangingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxMultiSliderYValueChangingEventArgs) - -- **constructor**(): IgxMultiSliderYValueChangingEventArgs -- static **ngAcceptInputType_value**: `string | number` -- **value**: `number` - -### [IgxSelectedValueChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxSelectedValueChangedEventArgs) - -- **constructor**(): IgxSelectedValueChangedEventArgs -- **newValue**: `Date` -- **oldValue**: `Date` - -### [IgxXButtonComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXButtonComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxXButtonComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **container**: `Element` -- static **ngAcceptInputType_actualBorderWidth**: `string | number` -- static **ngAcceptInputType_actualCornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_actualCornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_actualCornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_actualCornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_actualDensity**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_actualDisabledElevation**: `string | number` -- static **ngAcceptInputType_actualDisableRipple**: `string | boolean` -- static **ngAcceptInputType_actualElevationMode**: `string | ElevationMode` -- static **ngAcceptInputType_actualFocusElevation**: `string | number` -- static **ngAcceptInputType_actualHoverElevation**: `string | number` -- static **ngAcceptInputType_actualRestingElevation**: `string | number` -- static **ngAcceptInputType_baseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_borderWidth**: `string | number` -- static **ngAcceptInputType_clickTunneling**: `string | boolean` -- static **ngAcceptInputType_contentPaddingBottom**: `string | number` -- static **ngAcceptInputType_contentPaddingLeft**: `string | number` -- static **ngAcceptInputType_contentPaddingRight**: `string | number` -- static **ngAcceptInputType_contentPaddingTop**: `string | number` -- static **ngAcceptInputType_cornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_cornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_cornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_cornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_density**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_disabled**: `string | boolean` -- static **ngAcceptInputType_disabledElevation**: `string | number` -- static **ngAcceptInputType_disableHover**: `string | boolean` -- static **ngAcceptInputType_disablePointer**: `string | boolean` -- static **ngAcceptInputType_disableRipple**: `string | boolean` -- static **ngAcceptInputType_disableTransitions**: `string | boolean` -- static **ngAcceptInputType_displayType**: `string | ButtonDisplayStyle` -- static **ngAcceptInputType_elevationMode**: `string | ElevationMode` -- static **ngAcceptInputType_fabBorderWidth**: `string | number` -- static **ngAcceptInputType_fabCornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_fabCornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_fabCornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_fabCornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_fabDisabledElevation**: `string | number` -- static **ngAcceptInputType_fabFocusElevation**: `string | number` -- static **ngAcceptInputType_fabHoverElevation**: `string | number` -- static **ngAcceptInputType_fabRestingElevation**: `string | number` -- static **ngAcceptInputType_fillAvailableSpace**: `string | boolean` -- static **ngAcceptInputType_flatBorderWidth**: `string | number` -- static **ngAcceptInputType_flatCornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_flatCornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_flatCornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_flatCornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_flatDisabledElevation**: `string | number` -- static **ngAcceptInputType_flatFocusElevation**: `string | number` -- static **ngAcceptInputType_flatHoverElevation**: `string | number` -- static **ngAcceptInputType_flatRestingElevation**: `string | number` -- static **ngAcceptInputType_focused**: `string | boolean` -- static **ngAcceptInputType_focusElevation**: `string | number` -- static **ngAcceptInputType_horizontalContentAlignment**: `string | HorizontalAlignment` -- static **ngAcceptInputType_hoverElevation**: `string | number` -- static **ngAcceptInputType_iconBorderWidth**: `string | number` -- static **ngAcceptInputType_iconCornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_iconCornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_iconCornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_iconCornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_iconDisabledElevation**: `string | number` -- static **ngAcceptInputType_iconFocusElevation**: `string | number` -- static **ngAcceptInputType_iconHoverElevation**: `string | number` -- static **ngAcceptInputType_iconRestingElevation**: `string | number` -- static **ngAcceptInputType_isFocusStyleEnabled**: `string | boolean` -- static **ngAcceptInputType_isHover**: `string | boolean` -- static **ngAcceptInputType_minHeight**: `string | number` -- static **ngAcceptInputType_minWidth**: `string | number` -- static **ngAcceptInputType_outlinedBorderWidth**: `string | number` -- static **ngAcceptInputType_outlinedCornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_outlinedCornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_outlinedCornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_outlinedCornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_outlinedDisabledElevation**: `string | number` -- static **ngAcceptInputType_outlinedFocusElevation**: `string | number` -- static **ngAcceptInputType_outlinedHoverElevation**: `string | number` -- static **ngAcceptInputType_outlinedRestingElevation**: `string | number` -- static **ngAcceptInputType_raisedBorderWidth**: `string | number` -- static **ngAcceptInputType_raisedCornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_raisedCornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_raisedCornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_raisedCornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_raisedDisabledElevation**: `string | number` -- static **ngAcceptInputType_raisedFocusElevation**: `string | number` -- static **ngAcceptInputType_raisedHoverElevation**: `string | number` -- static **ngAcceptInputType_raisedRestingElevation**: `string | number` -- static **ngAcceptInputType_restingElevation**: `string | number` -- static **ngAcceptInputType_stopPropagation**: `string | boolean` -- static **ngAcceptInputType_tabIndex**: `string | number` -- static **ngAcceptInputType_verticalContentAlignment**: `string | VerticalAlignment` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualAmbientShadowColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **actualBackgroundColor**: `string` — Gets the color to use for the actual background. -- **actualBorderColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **actualBorderWidth**: `number` — Gets or sets the Width to use for the check mark when the checkbox is checked. -- **actualCornerRadiusBottomLeft**: `number` -- **actualCornerRadiusBottomRight**: `number` -- **actualCornerRadiusTopLeft**: `number` -- **actualCornerRadiusTopRight**: `number` -- **actualDensity**: `ControlDisplayDensity` — Gets the actual display density to use for the label. -- **actualDisabledBackgroundColor**: `string` — Gets the actual color to use for the disabled background of the button. -- **actualDisabledBorderColor**: `string` — Gets the actual color to use for the disabled border of the button. -- **actualDisabledElevation**: `number` — Gets the actual disabled elevation to use for the button. -- **actualDisabledTextColor**: `string` — Gets the actual color to use for the disabled text of the button. -- **actualDisableRipple**: `boolean` — Gets whether to actually disable the ripple effect for the button. -- **actualElevationMode**: `ElevationMode` — Gets the actual disabled elevation to use for the button. -- **actualFocusBackgroundColor**: `string` — Gets the color to use for the actual background. -- **actualFocusElevation**: `number` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **actualFocusTextColor**: `string` — Gets the actual color to use for the focused text. -- **actualHoverBackgroundColor**: `string` — Gets the hover color to use for the actual background. -- **actualHoverElevation**: `number` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **actualHoverTextColor**: `string` — Gets the color to use for the actual background. -- **actualPenumbraShadowColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **actualRestingElevation**: `number` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **actualRippleColor**: `string` — Gets or sets the color to use for the ripple when the button is pressed. -- **actualTextColor**: `string` — Gets the color to use for the actual background. -- **actualUmbraShadowColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **alignItems**: `string` — Gets or sets the id to use for the checkbox. -- **ariaLabel**: `string` — Gets or sets the value of the aria-label attribute. -- **backgroundColor**: `string` — Gets or sets the color to use for the background when the button regardless of type. -- **baseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the button. -- **borderColor**: `string` — Gets or sets the border color to use for the button regardless of type. -- **borderWidth**: `number` — Gets or sets the width to use for the button border regardless of type. -- **clicked**: `EventEmitter` -- **clickTunneling**: `boolean` — Gets or sets if clicking on the button is allowed to tunnel down to button content. -- **contentPaddingBottom**: `number` — Gets or sets the bottom padding for the button content. -- **contentPaddingLeft**: `number` — Gets or sets the left padding for the button content. -- **contentPaddingRight**: `number` — Gets or sets the right padding for the button content. -- **contentPaddingTop**: `number` — Gets or sets the top padding for the button content. -- **cornerRadiusBottomLeft**: `number` -- **cornerRadiusBottomRight**: `number` -- **cornerRadiusTopLeft**: `number` -- **cornerRadiusTopRight**: `number` -- **density**: `ControlDisplayDensity` — Gets or sets the display density to use for the button. -- **disabled**: `boolean` — Gets or sets whether the checkbox is disabled. -- **disabledBackgroundColor**: `string` — Gets or sets the color to use for the disabled background of the button when the type is disabled. -- **disabledBorderColor**: `string` — Gets or sets the color to use for the disabled border of the button when the type is raised. -- **disabledElevation**: `number` — Gets or sets the disabled elevation to use for the button when the type is raised. -- **disabledTextColor**: `string` — Gets or sets the color to use for the disabled text of the button when the type is raised. -- **disableHover**: `boolean` — Gets or sets whether the hover effect is disabled. -- **disablePointer**: `boolean` — Gets or sets whether the cursor will change into a pointer when the button is hovered. -- **disableRipple**: `boolean` — Gets or sets whether to disable the ripple effect for the button. -- **disableTransitions**: `boolean` — Gets or sets whether the checkbox transitions are disabled. -- **display**: `string` — Gets or sets the id to use for the checkbox. -- **displayType**: `ButtonDisplayStyle` — Gets or sets the display style to use for the button. -- **elevationMode**: `ElevationMode` — Gets or sets the disabled elevation to use for the button when the type is raised. -- **fabBackgroundColor**: `string` — Gets or sets the color to use for the background of the button when the type is floating action button. -- **fabBorderColor**: `string` — Gets or sets the border color to use for the button when the type is floating action button. -- **fabBorderWidth**: `number` — Gets or sets the width to use for the button border when the type is floating action button. -- **fabCornerRadiusBottomLeft**: `number` -- **fabCornerRadiusBottomRight**: `number` -- **fabCornerRadiusTopLeft**: `number` -- **fabCornerRadiusTopRight**: `number` -- **fabDisabledBackgroundColor**: `string` — Gets or sets the color to use for the disabled background of the button when the type is fab. -- **fabDisabledBorderColor**: `string` — Gets or sets the color to use for the disabled border of the button when the type is fab. -- **fabDisabledElevation**: `number` — Gets or sets the disabled elevation to use for the button when the type is fab. -- **fabDisabledTextColor**: `string` — Gets or sets the color to use for the disabled text of the button when the type is fab. -- **fabFocusBackgroundColor**: `string` — Gets or sets the color to use for the backround the button when it is focused and fab. -- **fabFocusElevation**: `number` — Gets or sets the focus elevation to use for the button when the type is floating action button. -- **fabFocusTextColor**: `string` — Gets or sets the color to use for the text the button when it is focused and fab. -- **fabHoverBackgroundColor**: `string` — Gets or sets the hover color to use for the background of the button when the type is hoveredFab. -- **fabHoverElevation**: `number` — Gets or sets the hover elevation to use for the button when the type is floating action button. -- **fabHoverTextColor**: `string` — Gets or sets the color to use for the hovered text of the button when type is floating action button. -- **fabRestingElevation**: `number` — Gets or sets the elevation to use for the button when the type is floating action button. -- **fabRippleColor**: `string` — Gets or sets the color to use for the background when the button is pressed and the type is floating action button. -- **fabTextColor**: `string` — Gets or sets the color to use for the text of the button when type is floating action button. -- **fillAvailableSpace**: `boolean` — Gets or sets whether the button should fill the available space. If false, the button -will use an intrinsic size. -- **flatBackgroundColor**: `string` — Gets or sets the color to use for the background of the button when the type is flat. -- **flatBorderColor**: `string` — Gets or sets the border color to use for the button when the type is flat. -- **flatBorderWidth**: `number` — Gets or sets the width to use for the button border when the type is flat. -- **flatCornerRadiusBottomLeft**: `number` -- **flatCornerRadiusBottomRight**: `number` -- **flatCornerRadiusTopLeft**: `number` -- **flatCornerRadiusTopRight**: `number` -- **flatDisabledBackgroundColor**: `string` — Gets or sets the color to use for the disabled background of the button when the type is flat. -- **flatDisabledBorderColor**: `string` — Gets or sets the color to use for the disabled border of the button when the type is flat. -- **flatDisabledElevation**: `number` — Gets or sets the disabled elevation to use for the button when the type is flat. -- **flatDisabledTextColor**: `string` — Gets or sets the color to use for the disabled text of the button when the type is flat. -- **flatFocusBackgroundColor**: `string` — Gets or sets the color to use for the backround the button when it is focused and flat. -- **flatFocusElevation**: `number` — Gets or sets the focus elevation to use for the button when the type is flat. -- **flatFocusTextColor**: `string` — Gets or sets the color to use for the text the button when it is focused and flat. -- **flatHoverBackgroundColor**: `string` — Gets or sets the hover color to use for the background of the button when the type is flat. -- **flatHoverElevation**: `number` — Gets or sets the hover elevation to use for the button when the type is flat. -- **flatHoverTextColor**: `string` — Gets or sets the color to use for the hovered text of the button when type is flat. -- **flatRestingElevation**: `number` — Gets or sets the elevation to use for the button when the type is flat. -- **flatRippleColor**: `string` — Gets or sets the color to use for the background when the button is pressed and the type is floating action button. -- **flatTextColor**: `string` — Gets or sets the color to use for the text of the button when type is flat. -- **flexDirection**: `string` — Gets or sets the id to use for the checkbox. -- **flexGrow**: `string` — Gets or sets the flex-grow setting for the button. -- **focusBackgroundColor**: `string` — Gets or sets the color to use for the backround the button when it is focused. -- **focused**: `boolean` — Gets or sets if the checkbox is Focused. -- **focusElevation**: `number` — Gets or sets the focus elevation to use for the button regardless of type. -- **focusTextColor**: `string` — Gets or sets the color to use for the text of the button when it is focused. -- **gotFocus**: `EventEmitter` -- **horizontalContentAlignment**: `HorizontalAlignment` -- **hoverBackgroundColor**: `string` — Gets or sets the hover color to use for the background of the button when the type is hovered. -- **hoverElevation**: `number` — Gets or sets the hover elevation to use for the button regardless of type. -- **hoverTextColor**: `string` — Gets or sets the color to use for the hovered text of the button regardless of type. -- **iconBackgroundColor**: `string` — Gets or sets the color to use for the background of the button when the type is icon. -- **iconBorderColor**: `string` — Gets or sets the border color to use for the button when the type is icon. -- **iconBorderWidth**: `number` — Gets or sets the width to use for the button border when the type is icon. -- **iconCornerRadiusBottomLeft**: `number` -- **iconCornerRadiusBottomRight**: `number` -- **iconCornerRadiusTopLeft**: `number` -- **iconCornerRadiusTopRight**: `number` -- **iconDisabledBackgroundColor**: `string` — Gets or sets the color to use for the disabled background of the button when the type is icon. -- **iconDisabledBorderColor**: `string` — Gets or sets the color to use for the disabled border of the button when the type is icon. -- **iconDisabledElevation**: `number` — Gets or sets the disabled elevation to use for the button when the type is icon. -- **iconDisabledTextColor**: `string` — Gets or sets the color to use for the disabled text of the button when the type is icon. -- **iconFocusBackgroundColor**: `string` — Gets or sets the color to use for the backround the button when it is focused and icon. -- **iconFocusElevation**: `number` — Gets or sets the focus elevation to use for the button when the type is icon. -- **iconFocusTextColor**: `string` — Gets or sets the color to use for the text the button when it is focused and icon. -- **iconHoverBackgroundColor**: `string` — Gets or sets the hover color to use for the background of the button when the type is hoveredIcon. -- **iconHoverElevation**: `number` — Gets or sets the hover elevation to use for the button when the type is icon. -- **iconHoverTextColor**: `string` — Gets or sets the color to use for the hovered text of the button when type is icon. -- **iconRestingElevation**: `number` — Gets or sets the elevation to use for the button when the type is icon. -- **iconRippleColor**: `string` — Gets or sets the color to use for the background when the button is pressed and the type is floating action button. -- **iconTextColor**: `string` — Gets or sets the color to use for the text of the button when type is icon. -- **id**: `string` — Gets or sets the id to use for the checkbox. -- **inputId**: `string` — Gets or sets the id to use for the internal native checkbox. -- **isFocusStyleEnabled**: `boolean` — Gets or sets if the button show use styling to show focus. -- **isHover**: `boolean` — Gets or sets whether the checkbox is checked. -- **lostFocus**: `EventEmitter` -- **minHeight**: `number` — Gets or sets the min height to use for the button. -- **minWidth**: `number` — Gets or sets the min width to use for the button. -- **name**: `string` — Gets or sets name to use for the button. -- **outlinedBackgroundColor**: `string` — Gets or sets the color to use for the background of the button when the type is outlined. -- **outlinedBorderColor**: `string` — Gets or sets the border color to use for the button when the type is outlined. -- **outlinedBorderWidth**: `number` — Gets or sets the width to use for the button border when the type is outlined. -- **outlinedCornerRadiusBottomLeft**: `number` -- **outlinedCornerRadiusBottomRight**: `number` -- **outlinedCornerRadiusTopLeft**: `number` -- **outlinedCornerRadiusTopRight**: `number` -- **outlinedDisabledBackgroundColor**: `string` — Gets or sets the color to use for the disabled background of the button when the type is outlined. -- **outlinedDisabledBorderColor**: `string` — Gets or sets the color to use for the disabled border of the button when the type is outlined. -- **outlinedDisabledElevation**: `number` — Gets or sets the disabled elevation to use for the button when the type is outlined. -- **outlinedDisabledTextColor**: `string` — Gets or sets the color to use for the disabled text of the button when the type is outlined. -- **outlinedFocusBackgroundColor**: `string` — Gets or sets the color to use for the backround the button when it is focused and outlined. -- **outlinedFocusElevation**: `number` — Gets or sets the focus elevation to use for the button when the type is outlined. -- **outlinedFocusTextColor**: `string` — Gets or sets the color to use for the text the button when it is focused and outlined. -- **outlinedHoverBackgroundColor**: `string` — Gets or sets the hover color to use for the background of the button when the type is hoveredOutlined. -- **outlinedHoverElevation**: `number` — Gets or sets the hover elevation to use for the button when the type is outlined. -- **outlinedHoverTextColor**: `string` — Gets or sets the color to use for the hovered text of the button when type is outlined. -- **outlinedRestingElevation**: `number` — Gets or sets the elevation to use for the button when the type is outlined. -- **outlinedRippleColor**: `string` — Gets or sets the color to use for the background when the button is pressed and the type is floating action button. -- **outlinedTextColor**: `string` — Gets or sets the color to use for the text of the button when type is outlined. -- **raisedBackgroundColor**: `string` — Gets or sets the color to use for the background of the button when the type is raised. -- **raisedBorderColor**: `string` — Gets or sets the border color to use for the button when the type is raised. -- **raisedBorderWidth**: `number` — Gets or sets the width to use for the button border when the type is raised. -- **raisedCornerRadiusBottomLeft**: `number` -- **raisedCornerRadiusBottomRight**: `number` -- **raisedCornerRadiusTopLeft**: `number` -- **raisedCornerRadiusTopRight**: `number` -- **raisedDisabledBackgroundColor**: `string` — Gets or sets the color to use for the disabled background of the button when the type is raised. -- **raisedDisabledBorderColor**: `string` — Gets or sets the color to use for the disabled border of the button when the type is raised. -- **raisedDisabledElevation**: `number` — Gets or sets the disabled elevation to use for the button when the type is raised. -- **raisedDisabledTextColor**: `string` — Gets or sets the color to use for the disabled text of the button when the type is raised. -- **raisedFocusBackgroundColor**: `string` — Gets or sets the color to use for the backround the button when it is focused and raised. -- **raisedFocusElevation**: `number` — Gets or sets the focus elevation to use for the button when the type is raised. -- **raisedFocusTextColor**: `string` — Gets or sets the color to use for the text the button when it is focused and raised. -- **raisedHoverBackgroundColor**: `string` — Gets or sets the hover color to use for the background of the button when the type is raised. -- **raisedHoverElevation**: `number` — Gets or sets the hover elevation to use for the button when the type is raised. -- **raisedHoverTextColor**: `string` — Gets or sets the color to use for the hovered text of the button when type is raised. -- **raisedRestingElevation**: `number` — Gets or sets the elevation to use for the button when the type is raised. -- **raisedRippleColor**: `string` — Gets or sets the color to use for the background when the button is pressed and the type is floating action button. -- **raisedTextColor**: `string` — Gets or sets the color to use for the text of the button when type is raised. -- **restingElevation**: `number` — Gets or sets the elevation to use for the button regardless of type. -- **rippleColor**: `string` — Gets or sets the color to use for the background of the button regardless of type. -- **stopPropagation**: `boolean` — Gets or sets whether mouse events on the button will bubble up to parent elements. -- **tabIndex**: `number` — Gets or sets TabIndex to use for the checkbox. -- **textColor**: `string` — Gets or sets the color to use for the text of the button regardless of type. -- **textStyle**: `string` — Gets or sets the use for the button. -- **value**: `any` — Gets or sets value to use for the checkbox. -- **verticalContentAlignment**: `VerticalAlignment` -- **ensureActualCornerRadius**(): void -- **ensureCornerRadius**(): void -- **ensureFabCornerRadius**(): void -- **ensureFlatCornerRadius**(): void -- **ensureIconCornerRadius**(): void -- **ensureOutlinedCornerRadius**(): void -- **ensureRaisedCornerRadius**(): void -- **exportSerializedVisualModel**(): string — Returns a serialized copy of the exported visual model -- **exportVisualModel**(): any — Exports visual information about the current state of the grid. -- **findByName**(name: string): any -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void -- **onAttachedToUI**(): void -- **onDetachedFromUI**(): void -- **updateStyle**(): void -- static **_createFromInternal**(internal: any): IgxXButtonComponent - -### [IgxXButtonGroupButtonCollection](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXButtonGroupButtonCollection) - -- **constructor**(list?: IgxXButtonComponent[]): IgxXButtonGroupButtonCollection - -### [IgxXButtonGroupComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXButtonGroupComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxXButtonGroupComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **actualButtons**: `IgxXButtonComponent[]` — The style mappings actually present in the chart. Do not directly modify this array. -This array's contents can be modified by causing Angular to reproject the child content. -Or adding and removing stye mappings from the manual style mapping collection on the styleMappings property. -- **container**: `Element` -- **contentButtons**: `QueryList` -- static **ngAcceptInputType_actualDensity**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_actualItemBorderWidth**: `string | number` -- static **ngAcceptInputType_actualItemCornerRadius**: `string | number` -- static **ngAcceptInputType_baseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_density**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_disabled**: `string | boolean` -- static **ngAcceptInputType_displayType**: `string | ButtonGroupDisplayStyle` -- static **ngAcceptInputType_flatItemBorderWidth**: `string | number` -- static **ngAcceptInputType_flatItemCornerRadius**: `string | number` -- static **ngAcceptInputType_isMultiSelect**: `string | boolean` -- static **ngAcceptInputType_itemBorderWidth**: `string | number` -- static **ngAcceptInputType_itemCornerRadius**: `string | number` -- static **ngAcceptInputType_orientation**: `string | ButtonGroupOrientation` -- static **ngAcceptInputType_outlinedItemBorderWidth**: `string | number` -- static **ngAcceptInputType_outlinedItemCornerRadius**: `string | number` -- static **ngAcceptInputType_selectedIndices**: `string | number[]` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualDensity**: `ControlDisplayDensity` — Gets the actual display density to use for the button group. -- **actualItemBackgroundColor**: `string` — Gets the actual item background color. -- **actualItemBorderColor**: `string` — Gets the actual item border color. -- **actualItemBorderWidth**: `number` — Gets the actual item border width. -- **actualItemCornerRadius**: `number` — Gets the actual item corner radius for the appropriate corners. -- **actualItemDisabledBackgroundColor**: `string` — Gets the actual item background color. -- **actualItemDisabledBorderColor**: `string` — Gets the actual item border color. -- **actualItemDisabledTextColor**: `string` — Gets the actual item text color. -- **actualItemHoverBackgroundColor**: `string` — Gets the actual item hovered background color. -- **actualItemHoverTextColor**: `string` — Gets the actual item text color. -- **actualItemTextColor**: `string` — Gets the actual item text color. -- **actualSelectedItemBackgroundColor**: `string` — Gets the actual selected item background color. -- **actualSelectedItemHoverBackgroundColor**: `string` — Gets the actual selected item hovered background color. -- **actualSelectedItemHoverTextColor**: `string` — Gets the actual selected item hovered text color. -- **actualSelectedItemTextColor**: `string` — Gets the stroke actual selected item text color. -- **baseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the button group. -- **buttons**: `IgxXButtonGroupButtonCollection` — A collection or manually added axes for the chart. -- **density**: `ControlDisplayDensity` — Gets or sets the display density to use for the button group. -- **disabled**: `boolean` — Gets or sets whether the checkbox is disabled. -- **displayType**: `ButtonGroupDisplayStyle` — Gets or sets the display style to use for the button. -- **flatItemBackgroundColor**: `string` — Gets or sets the color to use the background of the buttons in the group when type is flat. -- **flatItemBorderColor**: `string` — Gets or sets the color to use the border of the buttons in the group when type is flat. -- **flatItemBorderWidth**: `number` — Gets or sets the border width to use for the buttons in the group when type is flat. -- **flatItemCornerRadius**: `number` — Gets or sets the corner radius to use for the appropriate corners for the flat type item buttons. -- **flatItemDisabledBackgroundColor**: `string` — Gets or sets the disabled color to use the background of the buttons in the group when type is flat. -- **flatItemDisabledBorderColor**: `string` — Gets or sets the disabled color to use the border of the buttons in the group when type is flat. -- **flatItemDisabledTextColor**: `string` — Gets or sets the disabled color to use the text of the buttons in the group when type is flat. -- **flatItemHoverBackgroundColor**: `string` — Gets or sets the color to use the hovered background of the buttons in the group when type is flat. -- **flatItemHoverTextColor**: `string` — Gets or sets the color to use the hovered text of the buttons in the group when type is flat. -- **flatItemTextColor**: `string` — Gets or sets the color to use the text of the buttons in the group when type is flat. -- **flatSelectedItemBackgroundColor**: `string` — Gets or sets the color to use the background of the buttons in the group that are selected when type is flat. -- **flatSelectedItemHoverBackgroundColor**: `string` — Gets or sets the color to use the hovered background of the buttons in the group that are selected when type is flat. -- **flatSelectedItemHoverTextColor**: `string` — Gets or sets the color to use the hovered text of the buttons in the group that are selected when type is flat. -- **flatSelectedItemTextColor**: `string` — Gets or sets the color to use the text of the buttons in the group that are selected when type is flat. -- **i**: `XButtonGroup` -- **id**: `string` — Gets or sets the id to use for the button group. -- **isMultiSelect**: `boolean` — Gets or sets whether the group supports multi-select. -- **itemBackgroundColor**: `string` — Gets or sets the color to use the background of the buttons in the group. -- **itemBorderColor**: `string` — Gets or sets the color to use the border of the buttons in the group. -- **itemBorderWidth**: `number` — Gets or sets the border width to use for the buttons in the group. -- **itemCornerRadius**: `number` — Gets or sets the corner radius to use for the appropriate corners for the item buttons. -- **itemDisabledBackgroundColor**: `string` — Gets or sets the disabled color to use the background of the buttons in the group. -- **itemDisabledBorderColor**: `string` — Gets or sets the disabled color to use the border of the buttons in the group. -- **itemDisabledTextColor**: `string` — Gets or sets the disabled color to use the text of the buttons in the group. -- **itemHoverBackgroundColor**: `string` — Gets or sets the color to use the hovered background of the buttons in the group. -- **itemHoverTextColor**: `string` — Gets or sets the color to use the hovered text of the buttons in the group. -- **itemTextColor**: `string` — Gets or sets the color to use the text of the buttons in the group. -- **orientation**: `ButtonGroupOrientation` — Gets or sets the oreientation to use the button group when type is outlined. -- **outlinedItemBackgroundColor**: `string` — Gets or sets the color to use the background of the buttons in the group when type is outlined. -- **outlinedItemBorderColor**: `string` — Gets or sets the color to use the border of the buttons in the group when type is outlined. -- **outlinedItemBorderWidth**: `number` — Gets or sets the border width to use for the buttons in the group when type is outlined. -- **outlinedItemCornerRadius**: `number` — Gets or sets the corner radius to use for the appropriate corners for the outlined type item buttons. -- **outlinedItemDisabledBackgroundColor**: `string` — Gets or sets the disabled color to use the background of the buttons in the group when type is outlined. -- **outlinedItemDisabledBorderColor**: `string` — Gets or sets the disabled color to use the border of the buttons in the group when type is outlined. -- **outlinedItemDisabledTextColor**: `string` — Gets or sets the disabled color to use the text of the buttons in the group when type is outlined. -- **outlinedItemHoverBackgroundColor**: `string` — Gets or sets the color to use the hovered background of the buttons in the group when type is outlined. -- **outlinedItemHoverTextColor**: `string` — Gets or sets the color to use the hovered text of the buttons in the group when type is outlined. -- **outlinedItemTextColor**: `string` — Gets or sets the color to use the text of the buttons in the group when type is outlined. -- **outlinedSelectedItemBackgroundColor**: `string` — Gets or sets the color to use the background of the buttons in the group that are selected when type is outlined. -- **outlinedSelectedItemHoverBackgroundColor**: `string` — Gets or sets the color to use the hovered background of the buttons in the group that are selected when type is outlined. -- **outlinedSelectedItemHoverTextColor**: `string` — Gets or sets the color to use the hovered text of the buttons in the group that are selected when type is outlined. -- **outlinedSelectedItemTextColor**: `string` — Gets or sets the color to use the text of the buttons in the group that are selected when type is outlined. -- **selectedIndices**: `number[]` — Gets the currently selected button indices. -- **selectedItemBackgroundColor**: `string` — Gets or sets the color to use the background of the buttons in the group that are selected. -- **selectedItemHoverBackgroundColor**: `string` — Gets or sets the color to use the hovered background of the buttons in the group that are selected. -- **selectedItemHoverTextColor**: `string` — Gets or sets the color to use the hovered text of the buttons in the group that are selected. -- **selectedItemTextColor**: `string` — Gets or sets the color to use the text of the buttons in the group that are selected. -- **selectionChanged**: `EventEmitter` -- **exportSerializedVisualModel**(): string — Returns a serialized copy of the exported visual model -- **exportVisualModel**(): any — Exports visual information about the current state of the grid. -- **findByName**(name: string): any -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void -- **onAttachedToUI**(): void -- **onDetachedFromUI**(): void -- **updateStyle**(): void - -### [IgxXCalendarComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXCalendarComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxXCalendarComponent -- **_calendarContainer**: `ElementRef` -- **container**: `Element` -- static **ngAcceptInputType_baseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_density**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_firstDayOfWeek**: `string | DayOfWeek` -- static **ngAcceptInputType_firstWeekOfYear**: `string | FirstWeek` -- static **ngAcceptInputType_showTodayButton**: `string | boolean` -- static **ngAcceptInputType_showWeekNumbers**: `string | boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **backgroundColor**: `string` — Gets or Sets the selected date background color -- **baseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the calendar. -- **currentDateBorderColor**: `string` — Gets or Sets the current date text color -- **currentDateTextColor**: `string` — Gets or Sets the current date text color -- **density**: `ControlDisplayDensity` — Gets or sets the display density to use for the calendar. -- **firstDayOfWeek**: `DayOfWeek` — Gets or sets the FirstDayOfWeek property to detirmine first day of the week -- **firstWeekOfYear**: `FirstWeek` — Gets or sets the FirstWeekOfYear property to detirmine first week of the year -- **focusDateBackgroundColor**: `string` — Gets or Sets the focus date background color -- **focusDateTextColor**: `string` — Gets or Sets the focus date text color -- **height**: `string` -- **hoverBackgroundColor**: `string` — Gets or Sets the focus date background color -- **i**: `XCalendar` -- **maxDate**: `Date` — Gets or Sets the property name that contains the MaxDate. -- **minDate**: `Date` — Gets or Sets the property name that contains the MinDate. -- **selectedDateBackgroundColor**: `string` — Gets or Sets the selected date background color -- **selectedDateTextColor**: `string` — Gets or Sets the selected date text color -- **selectedFocusDateBackgroundColor**: `string` — Gets or Sets the selected date background color -- **selectedValueChanged**: `EventEmitter` — Called when date is selected. -- **showTodayButton**: `boolean` — Gets or sets the ShowTodayButton property to detirmine if the today button is shown -- **showWeekNumbers**: `boolean` — Gets or sets the ShowWeekNumbers property to detirmine if the week numbers are shown -- **textColor**: `string` — Gets or Sets the selected date text color -- **textStyle**: `string` — Gets or sets the font to use for the combobox. -- **today**: `Date` — Gets or Sets the property name that contains the values. -- **value**: `Date` — Gets or Sets the value for the calendar. -- **valueChange**: `EventEmitter` -- **width**: `string` -- **exportSerializedVisualModel**(): string — Returns a serialized copy of the exported visual model -- **exportVisualModel**(): any — Exports visual information about the current state of the grid. -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void -- **updateStyle**(): void - -### [IgxXCheckboxComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXCheckboxComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxXCheckboxComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **container**: `Element` -- static **ngAcceptInputType_actualBorderWidth**: `string | number` -- static **ngAcceptInputType_actualCornerRadius**: `string | number` -- static **ngAcceptInputType_actualTickStrokeWidth**: `string | number` -- static **ngAcceptInputType_baseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_borderWidth**: `string | number` -- static **ngAcceptInputType_checked**: `string | boolean` -- static **ngAcceptInputType_cornerRadius**: `string | number` -- static **ngAcceptInputType_disabled**: `string | boolean` -- static **ngAcceptInputType_disableRipple**: `string | boolean` -- static **ngAcceptInputType_disableTransitions**: `string | boolean` -- static **ngAcceptInputType_focused**: `string | boolean` -- static **ngAcceptInputType_indeterminate**: `string | boolean` -- static **ngAcceptInputType_labelPosition**: `string | CheckboxLabelPosition` -- static **ngAcceptInputType_required**: `string | number` -- static **ngAcceptInputType_tabIndex**: `string | number` -- static **ngAcceptInputType_tickStrokeWidth**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualBorderWidth**: `number` — Gets or sets the Width to use for the check mark when the checkbox is checked. -- **actualCheckedBackgroundColor**: `string` — Gets or sets the color to use for the actual background when the checkbox is checked. -- **actualCheckedBorderColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **actualCornerRadius**: `number` — Gets the actual corner radius to use for the checkbox. -- **actualTickColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **actualTickStrokeWidth**: `number` — Gets or sets the stroke width to use for the check mark. -- **actualUncheckedBackgroundColor**: `string` — Gets or sets the color to use for the actual background when the checkbox is unchecked. -- **actualUncheckedBorderColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **ariaLabel**: `string` — Gets or sets the value of the aria-label attribute. -- **ariaLabelledBy**: `string` — Gets or sets the value of the aria-labelledby attribute. -- **baseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the checkbox. -- **borderWidth**: `number` — Gets or sets the Width to use for the check mark when the checkbox is checked. -- **change**: `EventEmitter` -- **checked**: `boolean` — Gets or sets whether the checkbox is checked. -- **checkedBackgroundColor**: `string` — Gets or sets the color to use for the background when the checkbox is checked. -- **checkedBorderColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **cornerRadius**: `number` — Gets or sets the corner radius to use for the checkbox. -- **disabled**: `boolean` — Gets or sets whether the checkbox is disabled. -- **disableRipple**: `boolean` — Gets or sets whether to disable the ripple effect for the checkbox. -- **disableTransitions**: `boolean` — Gets or sets whether the checkbox transitions are disabled. -- **focused**: `boolean` — Gets or sets if the checkbox is Focused. -- **i**: `XCheckbox` -- **id**: `string` — Gets or sets the id to use for the checkbox. -- **indeterminate**: `boolean` — Gets or sets whether the checkbox is indeterminate. -- **inputId**: `string` — Gets or sets the id to use for the internal native checkbox. -- **labelId**: `string` — Gets or sets id to use for the checkbox label. -- **labelPosition**: `CheckboxLabelPosition` — Gets or sets LabelPosition to use for the checkbox. -- **name**: `string` — Gets or sets name to use for the checkbox. -- **required**: `number` — Gets or sets if the checkbox is required. -- **tabIndex**: `number` — Gets or sets TabIndex to use for the checkbox. -- **tickColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **tickStrokeWidth**: `number` — Gets or sets the corner radius to use for the checkbox. -- **uncheckedBackgroundColor**: `string` — Gets or sets the color to use for the background when the checkbox is unchecked. -- **uncheckedBorderColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is unchecked. -- **value**: `any` — Gets or sets value to use for the checkbox. -- **exportSerializedVisualModel**(): string — Returns a serialized copy of the exported visual model -- **exportVisualModel**(): any — Exports visual information about the current state of the grid. -- **findByName**(name: string): any -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void -- **onAttachedToUI**(): void -- **onDetachedFromUI**(): void -- **updateStyle**(): void - -### [IgxXDatePickerComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXDatePickerComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxXDatePickerComponent -- **_datePickerContainer**: `ElementRef` -- **container**: `Element` -- static **ngAcceptInputType_allowTextInput**: `string | boolean` -- static **ngAcceptInputType_baseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_dateFormat**: `string | DateFormats` -- static **ngAcceptInputType_density**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_firstDayOfWeek**: `string | DayOfWeek` -- static **ngAcceptInputType_firstWeekOfYear**: `string | FirstWeek` -- static **ngAcceptInputType_isDisabled**: `string | boolean` -- static **ngAcceptInputType_isFixed**: `string | boolean` -- static **ngAcceptInputType_openAsChild**: `string | boolean` -- static **ngAcceptInputType_openOnFocus**: `string | boolean` -- static **ngAcceptInputType_showClearButton**: `string | boolean` -- static **ngAcceptInputType_showTodayButton**: `string | boolean` -- static **ngAcceptInputType_showWeekNumbers**: `string | boolean` -- static **ngAcceptInputType_useTopLayer**: `string | boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **allowTextInput**: `boolean` — Gets or sets the AllowTextInput property to detirmine if entering text into the input is allowed -- **baseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the date picker. -- **changing**: `EventEmitter` -- **dateFormat**: `DateFormats` — Gets or sets the date time format to use for this column. If FormatString is specificied this value is ignored. -- **density**: `ControlDisplayDensity` — Gets or sets the display density to use for the date pcicker. -- **firstDayOfWeek**: `DayOfWeek` — Gets or sets the FirstDayOfWeek property to detirmine first day of the week -- **firstWeekOfYear**: `FirstWeek` — Gets or sets the FirstWeekOfYear property to detirmine first week of the year -- **formatString**: `string` — Gets or sets the Format property to detirmine the format of the date in the input -- **gotFocus**: `EventEmitter` -- **height**: `string` -- **i**: `XDatePicker` -- **iconColor**: `string` — Gets or Sets the text color -- **isDisabled**: `boolean` -- **isFixed**: `boolean` — Indicates that the calendar dropdown will position itself relative to the window instead of the document. -- **keyDown**: `EventEmitter` -- **label**: `string` — Gets or Sets the property name that contains the label. -- **labelTextColor**: `string` — Gets or sets the color to use for the text. -- **labelTextStyle**: `string` — Gets or sets the font to use for the combobox. -- **lostFocus**: `EventEmitter` -- **maxDate**: `Date` — Gets or Sets the property name that contains the MaxDate. -- **minDate**: `Date` — Gets or Sets the property name that contains the MinDate. -- **openAsChild**: `boolean` — Indicates that the dropdown should open as a child of the date picker. -- **openOnFocus**: `boolean` — Gets or sets the AllowTextInput property to detirmine if entering text into the input is allowed -- **placeholder**: `string` — Gets or Sets the property name that contains the placeholder. -- **selectedValueChanged**: `EventEmitter` — Called when date is selected. -- **showClearButton**: `boolean` — Gets or sets the ShowClearButton property to detirmine if the clear button is shown -- **showTodayButton**: `boolean` — Gets or sets the ShowTodayButton property to detirmine if the today button is shown -- **showWeekNumbers**: `boolean` — Gets or sets the ShowWeekNumbers property to detirmine if the week numbers are shown -- **textColor**: `string` — Gets or Sets the text color -- **textStyle**: `string` — Gets or sets the font to use for the combobox. -- **today**: `Date` — Gets or Sets the property name that contains the values. -- **useTopLayer**: `boolean` — Indicates that the dropdown will place itself into the browser top layer. -- **value**: `Date` — Gets or Sets the property name that contains the values. -- **valueChange**: `EventEmitter` -- **width**: `string` -- **exportSerializedVisualModel**(): string — Returns a serialized copy of the exported visual model -- **exportVisualModel**(): any — Exports visual information about the current state of the grid. -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void -- **select**(): void -- **updateStyle**(): void - -### [IgxXIconComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXIconComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxXIconComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **container**: `Element` -- static **ngAcceptInputType_actualStrokeWidth**: `string | number` -- static **ngAcceptInputType_actualViewBoxHeight**: `string | number` -- static **ngAcceptInputType_actualViewBoxLeft**: `string | number` -- static **ngAcceptInputType_actualViewBoxTop**: `string | number` -- static **ngAcceptInputType_actualViewBoxWidth**: `string | number` -- static **ngAcceptInputType_baseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_disabled**: `string | boolean` -- static **ngAcceptInputType_fillColors**: `string | string[]` -- static **ngAcceptInputType_height**: `string | number` -- static **ngAcceptInputType_hoverStrokeThickness**: `string | number` -- static **ngAcceptInputType_isHover**: `string | boolean` -- static **ngAcceptInputType_opacity**: `string | number` -- static **ngAcceptInputType_strokeColors**: `string | string[]` -- static **ngAcceptInputType_strokeWidth**: `string | number` -- static **ngAcceptInputType_sVGPaths**: `string | string[]` -- static **ngAcceptInputType_tabIndex**: `string | number` -- static **ngAcceptInputType_viewBoxHeight**: `string | number` -- static **ngAcceptInputType_viewBoxLeft**: `string | number` -- static **ngAcceptInputType_viewBoxTop**: `string | number` -- static **ngAcceptInputType_viewBoxWidth**: `string | number` -- static **ngAcceptInputType_width**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualFill**: `string` — Gets the fill color currently used by the icon. -- **actualStroke**: `string` — Gets the stroke color currently used by the icon. -- **actualStrokeWidth**: `number` — Gets the stroke width currently used by the icon. -- **actualTextColor**: `string` — Gets the text color currently used by the icon. -- **actualViewBoxHeight**: `number` — Gets the actual viewbox height for the svg icon. -- **actualViewBoxLeft**: `number` — Gets the actual viewbox left for the svg icon. -- **actualViewBoxTop**: `number` — Gets the actual viewbox top for the svg icon. -- **actualViewBoxWidth**: `number` — Gets the actual viewbox width for the svg icon. -- **ariaLabel**: `string` — Gets or sets the value of the aria-label attribute. -- **baseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the button. -- **dataURL**: `string` — Gets or sets data url for the icon to use. -- **disabled**: `boolean` — Gets or sets whether the checkbox is disabled. -- **fill**: `string` — Gets or sets the fill color to use for the icon. -- **fillColors**: `string[]` — Gets or sets a collection of fill colors to use in the icon. -These colors can be used by SVG elements that have been marked with the -ig-icon-fill-# -class where # is a number from 0 to count - 1. -- **height**: `number` — Gets or sets the height of the icon. -- **hoverFill**: `string` — Gets or sets the fill color to use when the icon is hovered. -- **hoverStroke**: `string` — Gets or sets the stroke color to use when the icon is hovered. -- **hoverStrokeThickness**: `number` — Gets or sets the stroke thickness to use when the icon is hovered. -- **hoverTextColor**: `string` — Gets or sets the text color to use when the icon is hovered. -- **i**: `XIcon` -- **id**: `string` — Gets or sets the id to use for the checkbox. -- **isHover**: `boolean` — Gets or sets whether the icon is hovered. -- **opacity**: `number` -- **primaryFillColor**: `string` — Gets or sets a primary fill color for the icon. -This color is used by SVG elements that have been marked -with the -ig-icon-primary-fill -class. -- **primaryStrokeColor**: `string` — Gets or sets a primary stroke color for the icon. -This color is used by SVG elements that have been marked -with the -ig-icon-primary-stroke -class. -- **secondaryFillColor**: `string` — Gets or sets a secondary fill color for the icon. -This color is used by SVG elements that have been marked -with the -ig-icon-secondary-fill -class. -- **secondaryStrokeColor**: `string` — Gets or sets a secondary stroke color for the icon. -This color is used by SVG elements that have been marked -with the -ig-icon-secondary-stroke -class. -- **source**: `any` — Gets or sets the image source for the icon. Used if none of the other icon types are not used. -- **stroke**: `string` — Gets or sets the stroke color to use for the icon. -- **strokeColors**: `string[]` — Gets or sets a collection of stroke colors to use in the icon. -These colors can be used by SVG elements that have been marked with the -ig-icon-stroke-# -class where # is a number from 0 to count - 1. -- **strokeWidth**: `number` — Gets or sets the stroke thickness to use for the icon. -- **svg**: `string` — Gets or sets svg text for the icon to use. -- **svgPath**: `string` — Gets or sets path data for the icon to use. -- **sVGPaths**: `string[]` — Gets or sets an array of path data for the icon to use. -- **tabIndex**: `number` — Gets or sets TabIndex to use for the checkbox. -- **textColor**: `string` — Gets or sets the text color to use for the icon. -- **textStyle**: `string` — Gets or sets the use for the button. -- **viewBoxHeight**: `number` — Gets or sets the viewbox height for the svg icon. -- **viewBoxLeft**: `number` — Gets or sets the viewbox left for the svg icon. -- **viewBoxTop**: `number` — Gets or sets the viewbox top for the svg icon. -- **viewBoxWidth**: `number` — Gets or sets the viewbox width for the svg icon. -- **width**: `number` — Gets or sets the width of the icon. -- **exportSerializedVisualModel**(): string — Returns a serialized copy of the exported visual model -- **exportVisualModel**(): any — Exports visual information about the current state of the grid. -- **findByName**(name: string): any -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void -- **onAttachedToUI**(): void -- **onDetachedFromUI**(): void -- **updateStyle**(): void - -### [IgxXInputComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXInputComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxXInputComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **container**: `Element` -- static **ngAcceptInputType_actualDensity**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_baseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_density**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_disabled**: `string | boolean` -- static **ngAcceptInputType_hasValue**: `string | boolean` -- static **ngAcceptInputType_includeLiterals**: `string | boolean` -- static **ngAcceptInputType_isHover**: `string | boolean` -- static **ngAcceptInputType_readonly**: `string | boolean` -- static **ngAcceptInputType_selectionEnd**: `string | number` -- static **ngAcceptInputType_selectionStart**: `string | number` -- static **ngAcceptInputType_showSpinner**: `string | boolean` -- static **ngAcceptInputType_tabIndex**: `string | number` -- static **ngAcceptInputType_textAlignment**: `string | HorizontalAlignment` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualDensity**: `ControlDisplayDensity` — Gets the actual display density to use for the label. -- **actualHoverTextColor**: `string` — Gets the actual hover color to use for the text. -- **actualTextColor**: `string` — Gets the actual color to use for the text color. -- **ariaLabel**: `string` — Gets or sets the value of the aria-label attribute. -- **baseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the button. -- **change**: `EventEmitter` -- **changing**: `EventEmitter` -- **compositionEnd**: `EventEmitter` -- **density**: `ControlDisplayDensity` — Gets or sets the display density to use for the input. -- **disabled**: `boolean` — Gets or sets whether the checkbox is disabled. -- **for**: `string` — Gets or sets the for attribute to use for the input. -- **hasValue**: `boolean` -- **hoverTextColor**: `string` — Gets or sets the color to use for the hovered text of the button regardless of type. -- **id**: `string` — Gets or sets the id to use for the checkbox. -- **includeLiterals**: `boolean` — Specifies if the bound value includes the formatting symbols. -- **inputType**: `string` — Gets or sets the type to use for the input. -- **isHover**: `boolean` — Gets or sets whether the input is hovered. -- **keyDown**: `EventEmitter` -- **keyPress**: `EventEmitter` -- **keyUp**: `EventEmitter` -- **mask**: `string` — Gets/Sets the input mask for the input. -- **placeholder**: `string` — Gets or sets the placeholder to use for the input. -- **promptChar**: `string` — Gets/Sets the character representing a fillable spot in the input mask -- **readonly**: `boolean` — Gets or sets whether the checkbox is readonly. -- **selectionEnd**: `number` — Returns / Sets the end index of the selected text. When nothing is selected, this returns the position of the text input cursor (caret) inside of the input. -- **selectionStart**: `number` — Returns / Sets the beginning index of the selected text. When nothing is selected, this returns the position of the text input cursor (caret) inside of the input. -- **showSpinner**: `boolean` -- **tabIndex**: `number` — Gets or sets TabIndex to use for the checkbox. -- **textAlignment**: `HorizontalAlignment` — Gets or sets the alignment of the text. -- **textColor**: `string` — Gets or sets the color to use for the text. -- **textStyle**: `string` — Gets or sets the use for the button. -- **value**: `string` — Gets or sets the value for the input. -- **blur**(): void -- **exportSerializedVisualModel**(): string — Returns a serialized copy of the exported visual model -- **exportVisualModel**(): any — Exports visual information about the current state of the grid. -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void -- **onAttachedToUI**(): void -- **onDetachedFromUI**(): void -- **select**(): void -- **setSelectionRange**(selectionStart: number, selectionEnd: number): void -- **updateStyle**(): void - -### [IgxXInputGroupComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXInputGroupComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxXInputGroupComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **actualInputs**: `IgxXInputGroupItemComponent[]` — The style mappings actually present in the chart. Do not directly modify this array. -This array's contents can be modified by causing Angular to reproject the child content. -Or adding and removing stye mappings from the manual style mapping collection on the styleMappings property. -- **container**: `Element` -- **contentInputs**: `QueryList` -- static **ngAcceptInputType_actualBorderWidth**: `string | number` -- static **ngAcceptInputType_actualContentPaddingBottom**: `string | number` -- static **ngAcceptInputType_actualContentPaddingLeft**: `string | number` -- static **ngAcceptInputType_actualContentPaddingRight**: `string | number` -- static **ngAcceptInputType_actualContentPaddingTop**: `string | number` -- static **ngAcceptInputType_actualCornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_actualCornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_actualCornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_actualCornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_actualDensity**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_actualFocusBorderWidth**: `string | number` -- static **ngAcceptInputType_actualFocusUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_actualFocusUnderlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_actualHoverUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_actualHoverUnderlineWidth**: `string | number` -- static **ngAcceptInputType_actualIsExpanded**: `string | boolean` -- static **ngAcceptInputType_actualUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_actualUnderlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_actualUnderlineRippleWidth**: `string | number` -- static **ngAcceptInputType_actualUnderlineWidth**: `string | number` -- static **ngAcceptInputType_baseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_borderTypeBorderWidth**: `string | number` -- static **ngAcceptInputType_borderTypeContentPaddingBottom**: `string | number` -- static **ngAcceptInputType_borderTypeContentPaddingLeft**: `string | number` -- static **ngAcceptInputType_borderTypeContentPaddingRight**: `string | number` -- static **ngAcceptInputType_borderTypeContentPaddingTop**: `string | number` -- static **ngAcceptInputType_borderTypeCornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_borderTypeCornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_borderTypeCornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_borderTypeCornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_borderTypeFocusBorderWidth**: `string | number` -- static **ngAcceptInputType_borderTypeFocusUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_borderTypeFocusUnderlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_borderTypeHoverUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_borderTypeHoverUnderlineWidth**: `string | number` -- static **ngAcceptInputType_borderTypeUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_borderTypeUnderlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_borderTypeUnderlineRippleWidth**: `string | number` -- static **ngAcceptInputType_borderTypeUnderlineWidth**: `string | number` -- static **ngAcceptInputType_borderWidth**: `string | number` -- static **ngAcceptInputType_boxTypeBorderWidth**: `string | number` -- static **ngAcceptInputType_boxTypeContentPaddingBottom**: `string | number` -- static **ngAcceptInputType_boxTypeContentPaddingLeft**: `string | number` -- static **ngAcceptInputType_boxTypeContentPaddingRight**: `string | number` -- static **ngAcceptInputType_boxTypeContentPaddingTop**: `string | number` -- static **ngAcceptInputType_boxTypeCornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_boxTypeCornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_boxTypeCornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_boxTypeCornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_boxTypeFocusBorderWidth**: `string | number` -- static **ngAcceptInputType_boxTypeFocusUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_boxTypeFocusUnderlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_boxTypeHoverUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_boxTypeHoverUnderlineWidth**: `string | number` -- static **ngAcceptInputType_boxTypeUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_boxTypeUnderlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_boxTypeUnderlineRippleWidth**: `string | number` -- static **ngAcceptInputType_boxTypeUnderlineWidth**: `string | number` -- static **ngAcceptInputType_contentPaddingBottom**: `string | number` -- static **ngAcceptInputType_contentPaddingLeft**: `string | number` -- static **ngAcceptInputType_contentPaddingRight**: `string | number` -- static **ngAcceptInputType_contentPaddingTop**: `string | number` -- static **ngAcceptInputType_cornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_cornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_cornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_cornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_density**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_disabled**: `string | boolean` -- static **ngAcceptInputType_displayType**: `string | InputGroupDisplayType` -- static **ngAcceptInputType_focusBorderWidth**: `string | number` -- static **ngAcceptInputType_focusUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_focusUnderlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_hoverUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_hoverUnderlineWidth**: `string | number` -- static **ngAcceptInputType_inputHasValue**: `string | boolean` -- static **ngAcceptInputType_isExpanded**: `string | boolean` -- static **ngAcceptInputType_isFocused**: `string | boolean` -- static **ngAcceptInputType_isHovered**: `string | boolean` -- static **ngAcceptInputType_lineTypeBorderWidth**: `string | number` -- static **ngAcceptInputType_lineTypeContentPaddingBottom**: `string | number` -- static **ngAcceptInputType_lineTypeContentPaddingLeft**: `string | number` -- static **ngAcceptInputType_lineTypeContentPaddingRight**: `string | number` -- static **ngAcceptInputType_lineTypeContentPaddingTop**: `string | number` -- static **ngAcceptInputType_lineTypeCornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_lineTypeCornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_lineTypeCornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_lineTypeCornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_lineTypeFocusBorderWidth**: `string | number` -- static **ngAcceptInputType_lineTypeFocusUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_lineTypeFocusUnderlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_lineTypeHoverUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_lineTypeHoverUnderlineWidth**: `string | number` -- static **ngAcceptInputType_lineTypeUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_lineTypeUnderlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_lineTypeUnderlineRippleWidth**: `string | number` -- static **ngAcceptInputType_lineTypeUnderlineWidth**: `string | number` -- static **ngAcceptInputType_searchTypeBorderWidth**: `string | number` -- static **ngAcceptInputType_searchTypeContentPaddingBottom**: `string | number` -- static **ngAcceptInputType_searchTypeContentPaddingLeft**: `string | number` -- static **ngAcceptInputType_searchTypeContentPaddingRight**: `string | number` -- static **ngAcceptInputType_searchTypeContentPaddingTop**: `string | number` -- static **ngAcceptInputType_searchTypeCornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_searchTypeCornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_searchTypeCornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_searchTypeCornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_searchTypeFocusBorderWidth**: `string | number` -- static **ngAcceptInputType_searchTypeFocusUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_searchTypeFocusUnderlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_searchTypeHoverUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_searchTypeHoverUnderlineWidth**: `string | number` -- static **ngAcceptInputType_searchTypeUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_searchTypeUnderlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_searchTypeUnderlineRippleWidth**: `string | number` -- static **ngAcceptInputType_searchTypeUnderlineWidth**: `string | number` -- static **ngAcceptInputType_underlineOpacity**: `string | number` -- static **ngAcceptInputType_underlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_underlineRippleWidth**: `string | number` -- static **ngAcceptInputType_underlineWidth**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualBackgroundColor**: `string` — Gets the actual opacity to use for the underline ripple element. -- **actualBorderColor**: `string` — Gets the actual item background color. -- **actualBorderWidth**: `number` — Gets the actual item border width. -- **actualContentPaddingBottom**: `number` -- **actualContentPaddingLeft**: `number` -- **actualContentPaddingRight**: `number` -- **actualContentPaddingTop**: `number` -- **actualCornerRadiusBottomLeft**: `number` -- **actualCornerRadiusBottomRight**: `number` -- **actualCornerRadiusTopLeft**: `number` -- **actualCornerRadiusTopRight**: `number` -- **actualDensity**: `ControlDisplayDensity` — Gets the actual display density to use for the input group. -- **actualFocusBorderColor**: `string` — Gets the actual item border color. -- **actualFocusBorderWidth**: `number` — Gets the actual item border width. -- **actualFocusUnderlineColor**: `string` — Gets the actual color to use for the underline element when focused. -- **actualFocusUnderlineOpacity**: `number` — Gets the actual opacity to use for the underline element when focused. -- **actualFocusUnderlineRippleOpacity**: `number` — Gets the actual opacity to use for the underline ripple element when focused. -- **actualHoverUnderlineColor**: `string` — Gets the actual color to use for the underline element. -- **actualHoverUnderlineOpacity**: `number` — Gets the actual opacity to use for the underline element when hovered. -- **actualHoverUnderlineWidth**: `number` — Gets the width to use for the underline element when hovered. -- **actualIsExpanded**: `boolean` — Gets or sets whether the input group is expanded or not. -- **actualUnderlineColor**: `string` — Gets the actual color to use for the underline element. -- **actualUnderlineOpacity**: `number` — Gets the actual opacity to use for the underline element. -- **actualUnderlineRippleColor**: `string` — Gets the actual color to use for the underline ripple element. -- **actualUnderlineRippleOpacity**: `number` — Gets the actual opacity to use for the underline ripple element. -- **actualUnderlineRippleWidth**: `number` — Gets the actual width to use for the underline element. -- **actualUnderlineWidth**: `number` — Gets the actual width to use for the underline element. -- **backgroundColor**: `string` — Gets or sets the background color to use for the input group. -- **baseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the label. -- **borderColor**: `string` — Gets or sets the color to use the border of the input group. -- **borderTypeBackgroundColor**: `string` — Gets or sets the background color to use for the input group when type is border. -- **borderTypeBorderColor**: `string` — Gets or sets the color to use the border of the input group when type is border. -- **borderTypeBorderWidth**: `number` — Gets or sets the border width to use for the border of the item group when using type line. -- **borderTypeContentPaddingBottom**: `number` -- **borderTypeContentPaddingLeft**: `number` -- **borderTypeContentPaddingRight**: `number` -- **borderTypeContentPaddingTop**: `number` -- **borderTypeCornerRadiusBottomLeft**: `number` -- **borderTypeCornerRadiusBottomRight**: `number` -- **borderTypeCornerRadiusTopLeft**: `number` -- **borderTypeCornerRadiusTopRight**: `number` -- **borderTypeFocusBorderColor**: `string` — Gets or sets the focus color to use the border of the input group when type is border. -- **borderTypeFocusBorderWidth**: `number` — Gets or sets the border width to use for the border of the item group when focused when type is border. -- **borderTypeFocusUnderlineColor**: `string` — Gets or sets the color to use for the underline element when type is border. -- **borderTypeFocusUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element when type is border. -- **borderTypeFocusUnderlineRippleOpacity**: `number` — Gets or sets the opacity to use for the underline ripple element when focused when type is border. -- **borderTypeHoverUnderlineColor**: `string` — Gets or sets the color to use for the underline element when type is border. -- **borderTypeHoverUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element when type is border. -- **borderTypeHoverUnderlineWidth**: `number` — Gets or sets the width to use for the underline element when hovered when type is border. -- **borderTypeUnderlineColor**: `string` — Gets or sets the color to use for the underline element when type is border. -- **borderTypeUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element when type is border. -- **borderTypeUnderlineRippleColor**: `string` — Gets or sets the color to use for the underline ripple element when type is border. -- **borderTypeUnderlineRippleOpacity**: `number` — Gets or sets the opacity to use for the underline ripple element when type is border. -- **borderTypeUnderlineRippleWidth**: `number` — Gets or sets the width to use for the underline element when type is border. -- **borderTypeUnderlineWidth**: `number` — Gets or sets the width to use for the underline element when type is border. -- **borderWidth**: `number` — Gets or sets the border width to use for the border of the item group. -- **boxTypeBackgroundColor**: `string` — Gets or sets the background color to use for the input group when type is box. -- **boxTypeBorderColor**: `string` — Gets or sets the color to use the border of the input group when type is box. -- **boxTypeBorderWidth**: `number` — Gets or sets the border width to use for the border of the item group when using type line. -- **boxTypeContentPaddingBottom**: `number` -- **boxTypeContentPaddingLeft**: `number` -- **boxTypeContentPaddingRight**: `number` -- **boxTypeContentPaddingTop**: `number` -- **boxTypeCornerRadiusBottomLeft**: `number` -- **boxTypeCornerRadiusBottomRight**: `number` -- **boxTypeCornerRadiusTopLeft**: `number` -- **boxTypeCornerRadiusTopRight**: `number` -- **boxTypeFocusBorderColor**: `string` — Gets or sets the focus color to use the border of the input group when type is box. -- **boxTypeFocusBorderWidth**: `number` — Gets or sets the border width to use for the border of the item group when focused when type is box. -- **boxTypeFocusUnderlineColor**: `string` — Gets or sets the color to use for the underline element when type is box. -- **boxTypeFocusUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element when type is box. -- **boxTypeFocusUnderlineRippleOpacity**: `number` — Gets or sets the opacity to use for the underline ripple element when focused when type is box. -- **boxTypeHoverUnderlineColor**: `string` — Gets or sets the color to use for the underline element when type is box. -- **boxTypeHoverUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element when type is box. -- **boxTypeHoverUnderlineWidth**: `number` — Gets or sets the width to use for the underline element when hovered when type is box. -- **boxTypeUnderlineColor**: `string` — Gets or sets the color to use for the underline element when type is box. -- **boxTypeUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element when type is box. -- **boxTypeUnderlineRippleColor**: `string` — Gets or sets the color to use for the underline ripple element when type is box. -- **boxTypeUnderlineRippleOpacity**: `number` — Gets or sets the opacity to use for the underline ripple element when type is box. -- **boxTypeUnderlineRippleWidth**: `number` — Gets or sets the width to use for the underline element when type is box. -- **boxTypeUnderlineWidth**: `number` — Gets or sets the width to use for the underline element when type is box. -- **contentPaddingBottom**: `number` -- **contentPaddingLeft**: `number` -- **contentPaddingRight**: `number` -- **contentPaddingTop**: `number` -- **cornerRadiusBottomLeft**: `number` -- **cornerRadiusBottomRight**: `number` -- **cornerRadiusTopLeft**: `number` -- **cornerRadiusTopRight**: `number` -- **density**: `ControlDisplayDensity` — Gets or sets the display density to use for the input group. -- **disabled**: `boolean` — Gets or sets whether the checkbox is disabled. -- **displayType**: `InputGroupDisplayType` — Gets or sets the display style to use for the button. -- **focusBorderColor**: `string` — Gets or sets the color to use the hovered background of the inputs in the group. -- **focusBorderWidth**: `number` — Gets or sets the border width to use for the border of the item group when focused. -- **focusUnderlineColor**: `string` — Gets or sets the color to use for the underline element. -- **focusUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element. -- **focusUnderlineRippleOpacity**: `number` — Gets or sets the opacity to use for the underline ripple element when focused. -- **hoverUnderlineColor**: `string` — Gets or sets the color to use for the underline element. -- **hoverUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element. -- **hoverUnderlineWidth**: `number` — Gets or sets the width to use for the underline element when hovered. -- **i**: `XInputGroup` -- **id**: `string` — Gets or sets the id to use for the checkbox. -- **inputHasValue**: `boolean` -- **inputs**: `IgxXInputGroupInputCollection` — A collection or manually added axes for the chart. -- **isExpanded**: `boolean` — Gets or sets whether the input group is expanded or not. -- **isFocused**: `boolean` — Gets or sets whether the input group is hovered or not. -- **isHovered**: `boolean` — Gets or sets whether the input group is hovered or not. -- **lineTypeBackgroundColor**: `string` — Gets or sets the background color to use for the input group when type is line. -- **lineTypeBorderColor**: `string` — Gets or sets the color to use the border of the input group when type is line. -- **lineTypeBorderWidth**: `number` — Gets or sets the border width to use for the border of the item group when using type line. -- **lineTypeContentPaddingBottom**: `number` -- **lineTypeContentPaddingLeft**: `number` -- **lineTypeContentPaddingRight**: `number` -- **lineTypeContentPaddingTop**: `number` -- **lineTypeCornerRadiusBottomLeft**: `number` -- **lineTypeCornerRadiusBottomRight**: `number` -- **lineTypeCornerRadiusTopLeft**: `number` -- **lineTypeCornerRadiusTopRight**: `number` -- **lineTypeFocusBorderColor**: `string` — Gets or sets the focus color to use the border of the input group when type is line. -- **lineTypeFocusBorderWidth**: `number` — Gets or sets the border width to use for the border of the item group when focused when type is line. -- **lineTypeFocusUnderlineColor**: `string` — Gets or sets the color to use for the underline element when type is line. -- **lineTypeFocusUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element when type is line. -- **lineTypeFocusUnderlineRippleOpacity**: `number` — Gets or sets the opacity to use for the underline ripple element when focused when type is line. -- **lineTypeHoverUnderlineColor**: `string` — Gets or sets the color to use for the underline element when type is line. -- **lineTypeHoverUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element when type is line. -- **lineTypeHoverUnderlineWidth**: `number` — Gets or sets the width to use for the underline element when hovered when type is line. -- **lineTypeUnderlineColor**: `string` — Gets or sets the color to use for the underline element when type is line. -- **lineTypeUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element when type is line. -- **lineTypeUnderlineRippleColor**: `string` — Gets or sets the color to use for the underline ripple element when type is line. -- **lineTypeUnderlineRippleOpacity**: `number` — Gets or sets the opacity to use for the underline ripple element when type is line. -- **lineTypeUnderlineRippleWidth**: `number` — Gets or sets the width to use for the underline element when type is line. -- **lineTypeUnderlineWidth**: `number` — Gets or sets the width to use for the underline element when type is line. -- **searchTypeBackgroundColor**: `string` — Gets or sets the background color to use for the input group when type is search. -- **searchTypeBorderColor**: `string` — Gets or sets the color to use the search of the input group when type is search. -- **searchTypeBorderWidth**: `number` — Gets or sets the search width to use for the border of the item group when using type line. -- **searchTypeContentPaddingBottom**: `number` -- **searchTypeContentPaddingLeft**: `number` -- **searchTypeContentPaddingRight**: `number` -- **searchTypeContentPaddingTop**: `number` -- **searchTypeCornerRadiusBottomLeft**: `number` -- **searchTypeCornerRadiusBottomRight**: `number` -- **searchTypeCornerRadiusTopLeft**: `number` -- **searchTypeCornerRadiusTopRight**: `number` -- **searchTypeFocusBorderColor**: `string` — Gets or sets the focus color to use the search of the input group when type is search. -- **searchTypeFocusBorderWidth**: `number` — Gets or sets the search width to use for the border of the item group when focused when type is search. -- **searchTypeFocusUnderlineColor**: `string` — Gets or sets the color to use for the underline element when type is search. -- **searchTypeFocusUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element when type is search. -- **searchTypeFocusUnderlineRippleOpacity**: `number` — Gets or sets the opacity to use for the underline ripple element when focused when type is search. -- **searchTypeHoverUnderlineColor**: `string` — Gets or sets the color to use for the underline element when type is search. -- **searchTypeHoverUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element when type is search. -- **searchTypeHoverUnderlineWidth**: `number` — Gets or sets the width to use for the underline element when hovered when type is search. -- **searchTypeUnderlineColor**: `string` — Gets or sets the color to use for the underline element when type is search. -- **searchTypeUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element when type is search. -- **searchTypeUnderlineRippleColor**: `string` — Gets or sets the color to use for the underline ripple element when type is search. -- **searchTypeUnderlineRippleOpacity**: `number` — Gets or sets the opacity to use for the underline ripple element when type is search. -- **searchTypeUnderlineRippleWidth**: `number` — Gets or sets the width to use for the underline element when type is search. -- **searchTypeUnderlineWidth**: `number` — Gets or sets the width to use for the underline element when type is search. -- **underlineColor**: `string` — Gets or sets the color to use for the underline element. -- **underlineOpacity**: `number` — Gets or sets the color to use for the underline element. -- **underlineRippleColor**: `string` — Gets or sets the color to use for the underline ripple element. -- **underlineRippleOpacity**: `number` — Gets or sets the opacity to use for the underline ripple element. -- **underlineRippleWidth**: `number` — Gets or sets the width to use for the underline element. -- **underlineWidth**: `number` — Gets or sets the width to use for the underline element. -- **ensureActualContentPadding**(): void -- **ensureActualCornerRadius**(): void -- **ensureBorderTypeContentPadding**(): void -- **ensureBorderTypeCornerRadius**(): void -- **ensureBoxTypeContentPadding**(): void -- **ensureBoxTypeCornerRadius**(): void -- **ensureContentPadding**(): void -- **ensureCornerRadius**(): void -- **ensureLineTypeContentPadding**(): void -- **ensureLineTypeCornerRadius**(): void -- **ensureSearchTypeContentPadding**(): void -- **ensureSearchTypeCornerRadius**(): void -- **exportSerializedVisualModel**(): string — Returns a serialized copy of the exported visual model -- **exportVisualModel**(): any — Exports visual information about the current state of the grid. -- **findByName**(name: string): any -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void -- **onAttachedToUI**(): void -- **onDetachedFromUI**(): void -- **updateStyle**(): void - -### [IgxXInputGroupInputCollection](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXInputGroupInputCollection) - -- **constructor**(list?: IgxXInputGroupItemComponent[]): IgxXInputGroupInputCollection - -### [IgxXInputGroupItemComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXInputGroupItemComponent) - -- **constructor**(): IgxXInputGroupItemComponent -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **name**: `string` — Gets or sets name to use for the button. -- **findByName**(name: string): any -- **ngOnInit**(): void — 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. -- static **_createFromInternal**(internal: any): IgxXInputGroupItemComponent - -### [IgxXLabelComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXLabelComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxXLabelComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **container**: `Element` -- static **ngAcceptInputType_actualDensity**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_baseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_density**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_disabled**: `string | boolean` -- static **ngAcceptInputType_isHover**: `string | boolean` -- static **ngAcceptInputType_tabIndex**: `string | number` -- static **ngAcceptInputType_value**: `string | boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualDensity**: `ControlDisplayDensity` — Gets the actual display density to use for the label. -- **actualHighlightTextColor**: `string` — Gets the actual color to use for the text color. -- **actualHoverHighlightTextColor**: `string` — Gets the actual color to use for the text color when highlighted and hovered. -- **actualHoverTextColor**: `string` — Gets the actual hover color to use for the text. -- **actualTextColor**: `string` — Gets the actual color to use for the text color. -- **alignItems**: `string` — Gets or sets the id to use for the checkbox. -- **alignSelf**: `string` — Gets or sets the id to use for the checkbox. -- **ariaLabel**: `string` — Gets or sets the value of the aria-label attribute. -- **baseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the label. -- **density**: `ControlDisplayDensity` — Gets or sets the display density to use for the label. -- **disabled**: `boolean` — Gets or sets whether the checkbox is disabled. -- **display**: `string` — Gets or sets the id to use for the checkbox. -- **flexDirection**: `string` — Gets or sets the id to use for the checkbox. -- **flexGrow**: `string` — Gets or sets the flex-grow setting for the button. -- **for**: `string` — Gets or sets the for attribute to use for the label. -- **highlightTextColor**: `string` — Gets or sets the color to use for the text. -- **hoverHighlightTextColor**: `string` — Gets or sets the color to use for the text. -- **hoverTextColor**: `string` — Gets or sets the color to use for the hovered text of the button regardless of type. -- **id**: `string` — Gets or sets the id to use for the checkbox. -- **isHover**: `boolean` — Gets or sets whether the label is hovered. -- **tabIndex**: `number` — Gets or sets TabIndex to use for the checkbox. -- **text**: `string` — Gets or sets the text for the label. -- **textColor**: `string` — Gets or sets the color to use for the text. -- **textStyle**: `string` — Gets or sets the use for the button. -- **value**: `boolean` — Gets or sets the value for the label. -- **exportSerializedVisualModel**(): string — Returns a serialized copy of the exported visual model -- **exportVisualModel**(): any — Exports visual information about the current state of the grid. -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void -- **onAttachedToUI**(): void -- **onDetachedFromUI**(): void -- **updateStyle**(): void - -### [IgxXPrefixComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXPrefixComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxXPrefixComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **container**: `Element` -- static **ngAcceptInputType_disabled**: `string | boolean` -- static **ngAcceptInputType_isHover**: `string | boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **ariaLabel**: `string` — Gets or sets the value of the aria-label attribute. -- **disabled**: `boolean` — Gets or sets whether the checkbox is disabled. -- **id**: `string` — Gets or sets the id to use for the checkbox. -- **isHover**: `boolean` — Gets or sets whether the prefix is hovered. -- **exportSerializedVisualModel**(): string — Returns a serialized copy of the exported visual model -- **exportVisualModel**(): any — Exports visual information about the current state of the grid. -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void -- **onAttachedToUI**(): void -- **onDetachedFromUI**(): void -- **updateStyle**(): void - -### [IgxXRippleComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXRippleComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxXRippleComponent -- **container**: `Element` -- static **ngAcceptInputType_isCentered**: `string | boolean` -- static **ngAcceptInputType_isDisabled**: `string | boolean` -- static **ngAcceptInputType_isHoverEnabled**: `string | boolean` -- static **ngAcceptInputType_rippleDuration**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualHoverColor**: `string` — Gets or sets the actual color to use for the background when the ripple is hovered. -- **actualRippleColor**: `string` — Gets or sets the color to use for the actual background when the checkbox is unchecked. -- **eventSource**: `any` — Gets or sets the target element to inject ripples into. -- **height**: `string` -- **hoverColor**: `string` — Gets or sets the color to use for the background when the ripple is hovered. -- **i**: `XRipple` -- **isCentered**: `boolean` — Gets or sets if the ripple is centered. -- **isDisabled**: `boolean` — Gets or sets if the ripple is disabled. -- **isHoverEnabled**: `boolean` — Gets or sets if the ripple is centered. -- **left**: `string` -- **position**: `string` -- **rippleColor**: `string` — Gets or sets the color to use for the background when the checkbox is unchecked. -- **rippleDuration**: `number` — Gets or sets the duration to use for the ripple animation. -- **top**: `string` -- **width**: `string` -- **exportSerializedVisualModel**(): string — Returns a serialized copy of the exported visual model -- **exportVisualModel**(): any — Exports visual information about the current state of the grid. -- **findByName**(name: string): any -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **ngOnDestroy**(): void -- **onAttachedToUI**(): void -- **onDetachedFromUI**(): void -- **updateStyle**(): void - -### [IgxXSuffixComponent](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/IgxXSuffixComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxXSuffixComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **container**: `Element` -- static **ngAcceptInputType_disabled**: `string | boolean` -- static **ngAcceptInputType_isHover**: `string | boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **ariaLabel**: `string` — Gets or sets the value of the aria-label attribute. -- **disabled**: `boolean` — Gets or sets whether the checkbox is disabled. -- **id**: `string` — Gets or sets the id to use for the checkbox. -- **isHover**: `boolean` — Gets or sets whether the suffix is hovered. -- **exportSerializedVisualModel**(): string — Returns a serialized copy of the exported visual model -- **exportVisualModel**(): any — Exports visual information about the current state of the grid. -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void -- **onAttachedToUI**(): void -- **onDetachedFromUI**(): void -- **updateStyle**(): void - -### [XCalendarLocaleEn](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/classes/XCalendarLocaleEn) - -- **constructor**(): XCalendarLocaleEn -- **April_Full**: `string` -- **April_Short**: `string` -- **August_Full**: `string` -- **August_Short**: `string` -- **December_Full**: `string` -- **December_Short**: `string` -- **February_Full**: `string` -- **February_Short**: `string` -- **Friday_Full**: `string` -- **Friday_Short**: `string` -- **Friday_Single**: `string` -- **January_Full**: `string` -- **January_Short**: `string` -- **July_Full**: `string` -- **July_Short**: `string` -- **June_Full**: `string` -- **June_Short**: `string` -- **March_Full**: `string` -- **March_Short**: `string` -- **May_Full**: `string` -- **May_Short**: `string` -- **Monday_Full**: `string` -- **Monday_Short**: `string` -- **Monday_Single**: `string` -- **November_Full**: `string` -- **November_Short**: `string` -- **October_Full**: `string` -- **October_Short**: `string` -- **Saturday_Full**: `string` -- **Saturday_Short**: `string` -- **Saturday_Single**: `string` -- **September_Full**: `string` -- **September_Short**: `string` -- **Sunday_Full**: `string` -- **Sunday_Short**: `string` -- **Sunday_Single**: `string` -- **Thursday_Full**: `string` -- **Thursday_Short**: `string` -- **Thursday_Single**: `string` -- **Today**: `string` -- **Tuesday_Full**: `string` -- **Tuesday_Short**: `string` -- **Tuesday_Single**: `string` -- **Wednesday_Full**: `string` -- **Wednesday_Short**: `string` -- **Wednesday_Single**: `string` - -## Enumerations - -### [ButtonGroupOrientation](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/enums/ButtonGroupOrientation) - -- **Horizontal** = 0 -- **Vertical** = 1 - -### [DateFormats](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/enums/DateFormats) -Indicates some simple date formats to be used. - -- **DateLong** = 1 — A standard long date format is used. -- **DateShort** = 0 — A standard short date format is used. - -### [DayOfWeek](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/enums/DayOfWeek) -Indicates some simple date formats to be used. - -- **Friday** = 5 — First Day of Week is Friday -- **Monday** = 1 — First Day of Week is Monday -- **Saturday** = 6 — First Day of Week is Saturday -- **Sunday** = 0 — First Day of Week is Sunday -- **Thursday** = 4 — First Day of Week is Thursday -- **Tuesday** = 2 — First Day of Week is Tuesday -- **Wednesday** = 3 — First Day of Week is Wednesday - -### [FirstWeek](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/enums/FirstWeek) -Indicates some simple date formats to be used. - -- **FirstDay** = 0 — First Day of Year is Start of First Week -- **FirstFourDayWeek** = 2 — First Four Day Week in year is First Week -- **FirstFullWeek** = 1 — First Full Week in year is First Week - -### [InputGroupDisplayType](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/enums/InputGroupDisplayType) - -- **Border** = 2 -- **Box** = 1 -- **Line** = 0 -- **Search** = 3 - -### [InputShiftType](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/enums/InputShiftType) - -- **Border** = 2 -- **Box** = 1 -- **Line** = 0 - -### [LabelShiftType](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/enums/LabelShiftType) - -- **Border** = 2 -- **Box** = 1 -- **Line** = 0 - -### [MultiSliderOrientation](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/enums/MultiSliderOrientation) - -- **Horizontal** = 0 -- **TwoDimensional** = 2 -- **Vertical** = 1 - -### [MultiSliderThumbRangePosition](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/enums/MultiSliderThumbRangePosition) - -- **PinnedHigher** = 1 -- **PinnedLower** = 0 - -### [PrefixShiftType](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/enums/PrefixShiftType) - -- **Border** = 2 -- **Box** = 1 -- **Line** = 0 - -### [SuffixShiftType](https://www.infragistics.com/api/angular/igniteui-angular-inputs/latest/enums/SuffixShiftType) - -- **Border** = 2 -- **Box** = 1 -- **Line** = 0 diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular-layouts/latest/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular-layouts/latest/llms-full.txt deleted file mode 100644 index c35fe1c4f..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular-layouts/latest/llms-full.txt +++ /dev/null @@ -1,1682 +0,0 @@ -# Ignite UI for Angular Layouts latest — Full API Reference - -> Complete API reference for the Ignite UI for Angular Layouts package (latest). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: Angular -Package: igniteui-angular-layouts -Version: latest - -## Classes - -### [IgxComboEditorComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxComboEditorComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxComboEditorComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **_mainDiv**: `Element` -- **_mainDivRef**: `ElementRef` -- static **ngAcceptInputType_actualBaseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_actualBorderWidth**: `string | number` -- static **ngAcceptInputType_actualContentPaddingBottom**: `string | number` -- static **ngAcceptInputType_actualContentPaddingLeft**: `string | number` -- static **ngAcceptInputType_actualContentPaddingRight**: `string | number` -- static **ngAcceptInputType_actualContentPaddingTop**: `string | number` -- static **ngAcceptInputType_actualCornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_actualCornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_actualCornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_actualCornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_actualDensity**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_actualFocusBorderWidth**: `string | number` -- static **ngAcceptInputType_actualFocusUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_actualFocusUnderlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_actualHoverUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_actualHoverUnderlineWidth**: `string | number` -- static **ngAcceptInputType_actualLabelVisible**: `string | boolean` -- static **ngAcceptInputType_actualUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_actualUnderlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_actualUnderlineRippleWidth**: `string | number` -- static **ngAcceptInputType_actualUnderlineWidth**: `string | number` -- static **ngAcceptInputType_actualValueField**: `string | string[]` -- static **ngAcceptInputType_allowFilter**: `string | boolean` -- static **ngAcceptInputType_baseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_borderWidth**: `string | number` -- static **ngAcceptInputType_contentPaddingBottom**: `string | number` -- static **ngAcceptInputType_contentPaddingLeft**: `string | number` -- static **ngAcceptInputType_contentPaddingRight**: `string | number` -- static **ngAcceptInputType_contentPaddingTop**: `string | number` -- static **ngAcceptInputType_cornerRadiusBottomLeft**: `string | number` -- static **ngAcceptInputType_cornerRadiusBottomRight**: `string | number` -- static **ngAcceptInputType_cornerRadiusTopLeft**: `string | number` -- static **ngAcceptInputType_cornerRadiusTopRight**: `string | number` -- static **ngAcceptInputType_dataSourceDesiredProperties**: `string | string[]` -- static **ngAcceptInputType_density**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_dropDownButtonVisible**: `string | boolean` -- static **ngAcceptInputType_fields**: `string | string[]` -- static **ngAcceptInputType_focusBorderWidth**: `string | number` -- static **ngAcceptInputType_focusUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_focusUnderlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_hoverUnderlineOpacity**: `string | number` -- static **ngAcceptInputType_hoverUnderlineWidth**: `string | number` -- static **ngAcceptInputType_isFixed**: `string | boolean` -- static **ngAcceptInputType_openAsChild**: `string | boolean` -- static **ngAcceptInputType_underlineOpacity**: `string | number` -- static **ngAcceptInputType_underlineRippleOpacity**: `string | number` -- static **ngAcceptInputType_underlineRippleWidth**: `string | number` -- static **ngAcceptInputType_underlineWidth**: `string | number` -- static **ngAcceptInputType_useTopLayer**: `string | boolean` -- static **ngAcceptInputType_valueField**: `string | string[]` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualBackgroundColor**: `string` — Gets the actual opacity to use for the underline ripple element. -- **actualBaseTheme**: `BaseControlTheme` — Gets the actual display baseTheme to use for the component. -- **actualBorderColor**: `string` — Gets the actual item background color. -- **actualBorderWidth**: `number` — Gets the actual item border width. -- **actualContentPaddingBottom**: `number` -- **actualContentPaddingLeft**: `number` -- **actualContentPaddingRight**: `number` -- **actualContentPaddingTop**: `number` -- **actualCornerRadiusBottomLeft**: `number` -- **actualCornerRadiusBottomRight**: `number` -- **actualCornerRadiusTopLeft**: `number` -- **actualCornerRadiusTopRight**: `number` -- **actualDataSource**: `IDataSource` — Gets the actual data source that is being used by the combo box list. If a collection was provided for the combo box data, an implicit LocalDataSource has been created, and this is available via this property. -- **actualDensity**: `ControlDisplayDensity` — Gets the actual display Density to use for the component. -- **actualFocusBorderColor**: `string` — Gets the actual item border color. -- **actualFocusBorderWidth**: `number` — Gets the actual item border width. -- **actualFocusUnderlineColor**: `string` — Gets the actual color to use for the underline element when focused. -- **actualFocusUnderlineOpacity**: `number` — Gets the actual opacity to use for the underline element when focused. -- **actualFocusUnderlineRippleOpacity**: `number` — Gets the actual opacity to use for the underline ripple element when focused. -- **actualHoverUnderlineColor**: `string` — Gets the actual color to use for the underline element. -- **actualHoverUnderlineOpacity**: `number` — Gets the actual opacity to use for the underline element when hovered. -- **actualHoverUnderlineWidth**: `number` — Gets the width to use for the underline element when hovered. -- **actualLabelTextColor**: `string` — Gets the actual color to use for the text color. -- **actualLabelVisible**: `boolean` — Gets or sets the visibility of the label. -- **actualNoMatchesFoundLabel**: `string` — Gets the actual text to display on the list when no suggested matches are found. -- **actualNoMatchesFoundLabelBackgroundColor**: `string` — Gets the actual color to use for the "no matches found" label. -- **actualNoMatchesFoundLabelTextColor**: `string` — Gets the actual color to use for the "no matches found" label. -- **actualTextColor**: `string` — Gets the actual color to use for the text color. -- **actualUnderlineColor**: `string` — Gets the actual color to use for the underline element. -- **actualUnderlineOpacity**: `number` — Gets the actual opacity to use for the underline element. -- **actualUnderlineRippleColor**: `string` — Gets the actual color to use for the underline ripple element. -- **actualUnderlineRippleOpacity**: `number` — Gets the actual opacity to use for the underline ripple element. -- **actualUnderlineRippleWidth**: `number` — Gets the actual width to use for the underline element. -- **actualUnderlineWidth**: `number` — Gets the actual width to use for the underline element. -- **actualValueField**: `string[]` — Gets the actual name of the field in the data source will be used as the Value of the ComboEditor. -- **allowFilter**: `boolean` — Whether to allow filtering of the combo -- **backgroundColor**: `string` — Gets or sets the background color to use for the input group. -- **baseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the component. -- **borderColor**: `string` — Gets or sets the color to use the border of the input group. -- **borderWidth**: `number` — Gets or sets the border width to use for the border of the item group. -- **change**: `EventEmitter` -- **changing**: `EventEmitter` -- **contentPaddingBottom**: `number` -- **contentPaddingLeft**: `number` -- **contentPaddingRight**: `number` -- **contentPaddingTop**: `number` -- **cornerRadiusBottomLeft**: `number` -- **cornerRadiusBottomRight**: `number` -- **cornerRadiusTopLeft**: `number` -- **cornerRadiusTopRight**: `number` -- **dataSource**: `any` — Gets or sets the data to which to bind the combo box list. This can be some type of array or list, or it can -be an IDataSource instance. -- **dataSourceDesiredProperties**: `string[]` — Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source. -- **density**: `ControlDisplayDensity` — Gets or sets the display Density to use for the buttons and dropdown grid. -- **dropDownButtonVisible**: `boolean` — Gets or sets the visibility of the drop down button. -- **fields**: `string[]` — Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source. -- **focusBorderColor**: `string` — Gets or sets the color to use the hovered background of the inputs in the group. -- **focusBorderWidth**: `number` — Gets or sets the border width to use for the border of the item group when focused. -- **focusUnderlineColor**: `string` — Gets or sets the color to use for the underline element. -- **focusUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element. -- **focusUnderlineRippleOpacity**: `number` — Gets or sets the opacity to use for the underline ripple element when focused. -- **gotFocus**: `EventEmitter` -- **height**: `string` -- **hoverUnderlineColor**: `string` — Gets or sets the color to use for the underline element. -- **hoverUnderlineOpacity**: `number` — Gets or sets the color to use for the underline element. -- **hoverUnderlineWidth**: `number` — Gets or sets the width to use for the underline element when hovered. -- **i**: `ComboEditor` -- **isFixed**: `boolean` — Indicates that the dropdown will position itself relative to the window instead of the document. -- **keyDown**: `EventEmitter` -- **label**: `string` — The text displayed in the label portion of the control. -- **labelTextColor**: `string` — Gets or sets the color to use for the text. -- **labelTextStyle**: `string` — Gets or sets the font to use for the combobox. -- **lostFocus**: `EventEmitter` -- **noMatchesFoundLabel**: `string` — Gets or sets the text to display on the list when no suggested matches are found. -- **noMatchesFoundLabelBackgroundColor**: `string` — Gets or sets the color to use for the "no matches found" label. -- **noMatchesFoundLabelTextColor**: `string` — Gets or sets the color to use for the "no matches found" label. -- **noMatchesFoundLabelTextStyle**: `string` — Gets or sets the font to use for the combobox. -- **openAsChild**: `boolean` — Indicates that the dropdown should open as a child of the combobox. -- **placeholder**: `string` — Placeholder text which gives the user a hint about what kind of text is expected. -- **selectedValueChanged**: `EventEmitter` -- **text**: `string` — The text displayed in the edit portion of the control. -- **textChange**: `EventEmitter` -- **textColor**: `string` — Gets or sets the color to use for the text. -- **textField**: `string` — Determines the name of the field in the data source will be used as the Text of the ComboEditor. -- **textStyle**: `string` — Gets or sets the font to use for the combobox. -- **textValueChanged**: `EventEmitter` -- **underlineColor**: `string` — Gets or sets the color to use for the underline element. -- **underlineOpacity**: `number` — Gets or sets the color to use for the underline element. -- **underlineRippleColor**: `string` — Gets or sets the color to use for the underline ripple element. -- **underlineRippleOpacity**: `number` — Gets or sets the opacity to use for the underline ripple element. -- **underlineRippleWidth**: `number` — Gets or sets the width to use for the underline element. -- **underlineWidth**: `number` — Gets or sets the width to use for the underline element. -- **useTopLayer**: `boolean` — Indicates that the dropdown will place itself into the browser top layer. -- **value**: `any` — Gets or sets the Value of the combo. -When the user selects an item from, the value is set based on the specified ValueField field. If not ValueField is specified, then the first field in the data source is used. -When the user enters text into the combo, the list is searched based on the TextField field. If a matching string is found, the Value of the combo is the value of the ValueField field in the same row. -If the text entered in the combo does not match any item on the list, then the value will return null. -- **valueChange**: `EventEmitter` -- **valueField**: `string[]` — Sets or gets the user provided primary key to assume for the data. Certain functionality of the combo (such as the the current Value) requires -a way to uniquely identify items in order to work correctly. -If a primary key cannot be inferred from the data source, you may need to provide one here. -- **width**: `string` -- **closeUp**(): void — Programmatically closes the list. -- **dropDown**(): void — Programmatically drops down the list. -- **enableDisableFiltering**(allowFilter: boolean): void -- **ensureActualContentPadding**(): void -- **ensureActualCornerRadius**(): void -- **ensureContentPadding**(): void -- **ensureCornerRadius**(): void -- **exportSerializedVisualModel**(): string — Returns a serialized copy of the exported visual model -- **exportVisualModel**(): any — Exports visual information about the current state of the grid. -- **findByName**(name: string): any -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **ngAfterViewInit**(): void -- **ngOnDestroy**(): void -- **select**(): void — Selects all the text in the combo input area. -- **selectGridRow**(index: number): void -- **updateStyle**(): void -- **verifyDisplayText**(): void - -### [IgxComboEditorGotFocusEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxComboEditorGotFocusEventArgs) - -- **constructor**(): IgxComboEditorGotFocusEventArgs - -### [IgxComboEditorLostFocusEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxComboEditorLostFocusEventArgs) - -- **constructor**(): IgxComboEditorLostFocusEventArgs - -### [IgxComboEditorTextChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxComboEditorTextChangedEventArgs) - -- **constructor**(): IgxComboEditorTextChangedEventArgs -- **newText**: `string` -- **oldText**: `string` - -### [IgxComboEditorValueChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxComboEditorValueChangedEventArgs) - -- **constructor**(): IgxComboEditorValueChangedEventArgs -- **newValue**: `any` -- **oldValue**: `any` - -### [IgxLayoutPrimaryKeyValue](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxLayoutPrimaryKeyValue) -A primary key value. - -- **constructor**(): IgxLayoutPrimaryKeyValue -- static **ngAcceptInputType_key**: `string | string[]` -- static **ngAcceptInputType_value**: `string | any[]` -- **key**: `string[]` — The primary key associated with this value. -- **value**: `any[]` — The value of the keys for this primary key value. -- **equals**(other: any): boolean — Determines if two primary key values are equal. -- **findByName**(name: string): any - -### [IgxLayoutSelectedItemsCollection](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxLayoutSelectedItemsCollection) - -- **constructor**(list?: any[]): IgxLayoutSelectedItemsCollection - -### [IgxLayoutSelectedKeysCollection](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxLayoutSelectedKeysCollection) - -- **constructor**(list?: IgxLayoutPrimaryKeyValue[]): IgxLayoutSelectedKeysCollection - -### [IgxListPanelActiveRowChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelActiveRowChangedEventArgs) -Information about the change to the selected cells in the grid. - -- **constructor**(): IgxListPanelActiveRowChangedEventArgs -- static **ngAcceptInputType_newActiveRow**: `string | number` -- static **ngAcceptInputType_oldActiveRow**: `string | number` -- **newActiveRow**: `number` — The new active row. -- **oldActiveRow**: `number` — The old active row. - -### [IgxListPanelComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, changeDetector: ChangeDetectorRef, componentFactoryResolver: ComponentFactoryResolver): IgxListPanelComponent -- **_mainDiv**: `Element` -- **_mainDivRef**: `ElementRef` -- static **ngAcceptInputType_activationBorderBottomWidth**: `string | number` -- static **ngAcceptInputType_activationBorderLeftWidth**: `string | number` -- static **ngAcceptInputType_activationBorderRightWidth**: `string | number` -- static **ngAcceptInputType_activationBorderTopWidth**: `string | number` -- static **ngAcceptInputType_activationMode**: `string | ListPanelActivationMode` -- static **ngAcceptInputType_activeRow**: `string | number` -- static **ngAcceptInputType_actualPrimaryKey**: `string | string[]` -- static **ngAcceptInputType_actualRowHeight**: `string | number` -- static **ngAcceptInputType_hasUnevenSizes**: `string | boolean` -- static **ngAcceptInputType_isActiveRowStyleEnabled**: `string | boolean` -- static **ngAcceptInputType_isCustomRowHeightEnabled**: `string | boolean` -- static **ngAcceptInputType_itemSpacing**: `string | number` -- static **ngAcceptInputType_notifyOnAllSelectionChanges**: `string | boolean` -- static **ngAcceptInputType_orientation**: `string | ListPanelOrientation` -- static **ngAcceptInputType_primaryKey**: `string | string[]` -- static **ngAcceptInputType_rowHeight**: `string | number` -- static **ngAcceptInputType_schemaIncludedProperties**: `string | string[]` -- static **ngAcceptInputType_scrollbarStyle**: `string | ScrollbarStyle` -- static **ngAcceptInputType_selectedItems**: `string | IgxListPanelSelectedItemsCollection` -- static **ngAcceptInputType_selectedKeys**: `string | IgxListPanelSelectedKeysCollection` -- static **ngAcceptInputType_selectionBehavior**: `string | ListPanelSelectionBehavior` -- static **ngAcceptInputType_selectionMode**: `string | ListPanelSelectionMode` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **activationBorder**: `string` — Gets or sets the activation border color to use. -- **activationBorderBottomWidth**: `number` — Gets or sets the amount of bottom activation border to use for the cell content of this column. -- **activationBorderLeftWidth**: `number` — Gets or sets the amount of left activation border to use for the cell content for this column. -- **activationBorderRightWidth**: `number` — Gets or sets the amount of right activation border to use for the cell content of this column. -- **activationBorderTopWidth**: `number` — Gets or sets the amount of top activation border to use for the cell content for this column. -- **activationMode**: `ListPanelActivationMode` — Sets or gets the grid selection mode. -- **activeRow**: `number` — Gets or sets the position of the active row. -- **activeRowChanged**: `EventEmitter` — Called when the active row changes. -- **actualPrimaryKey**: `string[]` — Gets either the inferred primary key from the data source, or the user provided primary key, if present. Represents the actual primary key that the grid will use in operations that require it. -- **actualPrimaryKeyChange**: `EventEmitter` -- **actualRowHeight**: `number` -- **backgroundColor**: `string` — Gets or sets the color to use for the background of the component. -- **cellTextStyle**: `string` — Gets or Sets the property name that contains the values. -- **contentRefreshed**: `EventEmitter` -- **hasUnevenSizes**: `boolean` -- **height**: `string` -- **i**: `ListPanel` -- **isActiveRowStyleEnabled**: `boolean` — Gets or sets whether the active row style will be applied to rows when made active. -- **isCustomRowHeightEnabled**: `boolean` — Gets or sets the color to use for the background of the component. -- **itemClicked**: `EventEmitter` -- **itemHeightRequested**: `EventEmitter` -- **itemRebind**: `EventEmitter` — Called when item content is rebound. -- **itemRecycled**: `EventEmitter` — Called when item content is recycled. -- **itemSpacing**: `number` — Gets or sets the spacing between items. -- **itemWidthRequested**: `EventEmitter` -- **normalBackground**: `string` — Gets or sets the background color to use. -- **notifyOnAllSelectionChanges**: `boolean` — Gets or sets if the grid should notify on programmatic selection changes as well as changes from the UI. -- **orientation**: `ListPanelOrientation` — Gets or sets the color to use for the background of the component. -- **primaryKey**: `string[]` — Sets or gets the user provided primary key to assume for the data. Certain functionality of the grid requires a way to uniquely identify items in order to work correctly. -If a primary key cannot be inferred from the data source, you may need to provide one here. -- **rowHeight**: `number` — Gets or Sets the property name that contains the values. -- **rowUpdating**: `EventEmitter` -- **schemaIncludedProperties**: `string[]` — Gets either the filtered properties to include in the schema of the data source. -- **scrollbarBackground**: `string` — Gets or sets the scrollbar background color. -- **scrollbarStyle**: `ScrollbarStyle` — Gets or sets the style of scrollbar. -- **selectedBackground**: `string` — Gets or sets the background color to use for the cells when they are selected -- **selectedItems**: `IgxListPanelSelectedItemsCollection` — Gets which items are currently selected in the grid. Collection can be updated to programatically select items. -- **selectedItemsChanged**: `EventEmitter` — Called when the selected items change. -- **selectedKeys**: `IgxListPanelSelectedKeysCollection` — Gets which primary key values are currently selected in the grid. Collection can be updated to programatically select items. -- **selectedKeysChanged**: `EventEmitter` — Called when the selected keys change. -- **selectionBehavior**: `ListPanelSelectionBehavior` — Sets or gets how selection behaves in the grid. -- **selectionChanged**: `EventEmitter` — Called when an individual selection operation has been made. -- **selectionMode**: `ListPanelSelectionMode` — Sets or gets the grid selection mode. -- **textColor**: `string` — Gets or sets the color to use for the text of the component. -- **width**: `string` -- **createLocalDataSource**(itemsSource: any, schemaIncludedProperties: string[]): IDataSource -- **dataIndexOfItem**(item: any): number — Returns the data index of an item within the bound data source. -- **dataIndexOfPrimaryKey**(key: any[]): number -- **deselectAllRows**(): void — Deselects all currently selected rows. -- **exportSerializedVisualData**(): string -- **exportVisualData**(): any -- **findByName**(name: string): any -- **getFirstVisibleIndex**(): number — Gets the first visible index in the grid. -- **getItemKey**(primaryKey: string[], item_: any): IgxListPanelPrimaryKeyValue -- **getLastVisibleIndex**(): number — Gets the last visible index in the grid. -- **getRowKey**(primaryKey: string[], rowIndex: number): IgxListPanelPrimaryKeyValue -- **invalidateVisibleItems**(): void — Invalidates the bound data for the rows currently visible. -- **moveViewportTo**(x: number, y: number): void -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **ngAfterViewInit**(): void -- **ngOnDestroy**(): void -- **notifyClearItems**(): void — Manually notifies the grid's data source that the data it has bound to has been cleared and needs to be re-examined. -This should not be called if the data that the grid is bound to is already observable. -- **notifyInsertItem**(index: number, newItem: any): void -- **notifyRemoveItem**(index: number, oldItem: any): void -- **notifySetItem**(index: number, oldItem: any, newItem: any): void -- **notifySizeChanged**(): void -- **onContentSizeChanged**(): void -- **onScroll**(): void -- **onScrollStart**(): void -- **onScrollStop**(): void -- **scrollTo**(x: number, y: number): void -- **scrollToLastRowByIndex**(rowNumber: number): void — Scrolls the grid so that a row is the last visible, by index. -- **scrollToRowByIndex**(rowNumber: number): void — Scrolls the grid to given row, by index -- **selectAllRows**(): void — Selects all of the rows in the grid. -- **setScrollbarColor**(color: any): void -- **setScrollbarStyle**(style: ScrollbarStyle): void -- **updateStyle**(): void - -### [IgxListPanelContentRebindEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelContentRebindEventArgs) -Information about list item content that was just rebound. - -- **constructor**(): IgxListPanelContentRebindEventArgs -- **rowObject**: `any` — The model that is rebinding. - -### [IgxListPanelContentRecycledEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelContentRecycledEventArgs) -Information about list item content that was just recycled. - -- **constructor**(): IgxListPanelContentRecycledEventArgs -- **rowObject**: `any` — The model that was recycled. - -### [IgxListPanelContentRefreshedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelContentRefreshedEventArgs) - -- **constructor**(): IgxListPanelContentRefreshedEventArgs - -### [IgxListPanelItemEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelItemEventArgs) -Event arguments for the SelectionChanged event. - -- **constructor**(): IgxListPanelItemEventArgs -- static **ngAcceptInputType_isDoubleClick**: `string | boolean` -- static **ngAcceptInputType_isLeftButton**: `string | boolean` -- **isDoubleClick**: `boolean` -- **isLeftButton**: `boolean` -- **itemInfo**: `IgxListPanelItemModel` -- **listPanel**: `IgxListPanelComponent` - -### [IgxListPanelItemModel](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelItemModel) - -- **constructor**(): IgxListPanelItemModel -- static **ngAcceptInputType_dataRow**: `string | number` -- static **ngAcceptInputType_isActivated**: `string | boolean` -- static **ngAcceptInputType_isActivationSupported**: `string | boolean` -- static **ngAcceptInputType_isModelDirty**: `string | boolean` -- static **ngAcceptInputType_isSelected**: `string | boolean` -- static **ngAcceptInputType_left**: `string | number` -- static **ngAcceptInputType_rowHeight**: `string | number` -- static **ngAcceptInputType_top**: `string | number` -- **dataRow**: `number` -- **isActivated**: `boolean` -- **isActivationSupported**: `boolean` -- **isModelDirty**: `boolean` -- **isSelected**: `boolean` -- **left**: `number` -- **rowHeight**: `number` -- **rowObject**: `any` -- **top**: `number` -- **findByName**(name: string): any - -### [IgxListPanelPrimaryKeyValue](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelPrimaryKeyValue) -A primary key value. - -- **constructor**(): IgxListPanelPrimaryKeyValue -- static **ngAcceptInputType_key**: `string | string[]` -- static **ngAcceptInputType_value**: `string | any[]` -- **key**: `string[]` — The primary key associated with this value. -- **value**: `any[]` — The value of the keys for this primary key value. -- **equals**(other: any): boolean — Determines if two primary key values are equal. -- **findByName**(name: string): any - -### [IgxListPanelSelectedItemsChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelSelectedItemsChangedEventArgs) -Information about the changing selected items in the grid. - -- **constructor**(): IgxListPanelSelectedItemsChangedEventArgs -- static **ngAcceptInputType_addedItems**: `string | IgxListPanelSelectedItemsCollection` -- static **ngAcceptInputType_currentItems**: `string | IgxListPanelSelectedItemsCollection` -- static **ngAcceptInputType_removedItems**: `string | IgxListPanelSelectedItemsCollection` -- **addedItems**: `IgxListPanelSelectedItemsCollection` — The items added to the selection. -- **currentItems**: `IgxListPanelSelectedItemsCollection` — The items added to the selection. -- **removedItems**: `IgxListPanelSelectedItemsCollection` — The items removed from the selection. - -### [IgxListPanelSelectedItemsCollection](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelSelectedItemsCollection) - -- **constructor**(list?: any[]): IgxListPanelSelectedItemsCollection - -### [IgxListPanelSelectedKeysChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelSelectedKeysChangedEventArgs) -Information about the change to the selected keys in the grid. - -- **constructor**(): IgxListPanelSelectedKeysChangedEventArgs -- static **ngAcceptInputType_addedKeys**: `string | IgxListPanelSelectedKeysCollection` -- static **ngAcceptInputType_currentKeys**: `string | IgxListPanelSelectedKeysCollection` -- static **ngAcceptInputType_removedKeys**: `string | IgxListPanelSelectedKeysCollection` -- **addedKeys**: `IgxListPanelSelectedKeysCollection` — The keys added to the selection. -- **currentKeys**: `IgxListPanelSelectedKeysCollection` — All keys in the selection. -- **removedKeys**: `IgxListPanelSelectedKeysCollection` — The keys removed from the selection. - -### [IgxListPanelSelectedKeysCollection](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelSelectedKeysCollection) - -- **constructor**(list?: IgxListPanelPrimaryKeyValue[]): IgxListPanelSelectedKeysCollection - -### [IgxListPanelSelectionChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelSelectionChangedEventArgs) -Event arguments for the SelectionChanged event. - -- **constructor**(): IgxListPanelSelectionChangedEventArgs - -### [IgxListPanelTemplateHeightRequestedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelTemplateHeightRequestedEventArgs) - -- **constructor**(): IgxListPanelTemplateHeightRequestedEventArgs -- static **ngAcceptInputType_dataRow**: `string | number` -- static **ngAcceptInputType_height**: `string | number` -- **dataItem**: `any` -- **dataRow**: `number` -- **height**: `number` - -### [IgxListPanelTemplateItemUpdatingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelTemplateItemUpdatingEventArgs) - -- **constructor**(): IgxListPanelTemplateItemUpdatingEventArgs -- static **ngAcceptInputType_availableWidth**: `string | number` -- **availableWidth**: `number` -- **content**: `any` -- **model**: `IgxListPanelItemModel` - -### [IgxListPanelTemplateWidthRequestedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxListPanelTemplateWidthRequestedEventArgs) - -- **constructor**(): IgxListPanelTemplateWidthRequestedEventArgs -- static **ngAcceptInputType_dataRow**: `string | number` -- static **ngAcceptInputType_width**: `string | number` -- **dataItem**: `any` -- **dataRow**: `number` -- **width**: `number` - -### [IgxOnCollapsedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxOnCollapsedEventArgs) - -- **constructor**(): IgxOnCollapsedEventArgs - -### [IgxOnExpandedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxOnExpandedEventArgs) - -- **constructor**(): IgxOnExpandedEventArgs - -### [IgxPropertyEditorDataSource](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxPropertyEditorDataSource) - -- **constructor**(): IgxPropertyEditorDataSource -- **context**: `TypeDescriptionContext` -- **descriptionType**: `string` -- **findByName**(name: string): any - -### [IgxPropertyEditorDescriptionObject](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxPropertyEditorDescriptionObject) - -- **constructor**(): IgxPropertyEditorDescriptionObject -- static **ngAcceptInputType_properties**: `string | IgxPropertyEditorPropertyDescriptionCollection` -- **descriptionType**: `string` -- **properties**: `IgxPropertyEditorPropertyDescriptionCollection` -- **findByName**(name: string): any - -### [IgxPropertyEditorDescriptionObjectCollection](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxPropertyEditorDescriptionObjectCollection) - -- **constructor**(list?: IgxPropertyEditorDescriptionObject[]): IgxPropertyEditorDescriptionObjectCollection - -### [IgxPropertyEditorPanelComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxPropertyEditorPanelComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, changeDetector: ChangeDetectorRef, componentFactoryResolver: ComponentFactoryResolver): IgxPropertyEditorPanelComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **_mainDiv**: `Element` -- **_mainDivRef**: `ElementRef` -- **actualProperties**: `IgxPropertyEditorPropertyDescriptionComponent[]` — The style mappings actually present in the chart. Do not directly modify this array. -This array's contents can be modified by causing Angular to reproject the child content. -Or adding and removing stye mappings from the manual style mapping collection on the properties property. -- **contentProperties**: `QueryList` -- static **ngAcceptInputType_actualDataSource**: `string | IgxPropertyEditorPropertyDescriptionCollection` -- static **ngAcceptInputType_actualRowHeight**: `string | number` -- static **ngAcceptInputType_isHorizontal**: `string | boolean` -- static **ngAcceptInputType_isIndirectModeEnabled**: `string | boolean` -- static **ngAcceptInputType_isWrappingEnabled**: `string | boolean` -- static **ngAcceptInputType_rowHeight**: `string | number` -- static **ngAcceptInputType_updateMode**: `string | PropertyEditorPanelUpdateMode` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualDataSource**: `IgxPropertyEditorPropertyDescriptionCollection` — Gets the actaul data or data source instance to which to bind the grid. -- **actualDescriptionContext**: `TypeDescriptionContext` -- **actualRowHeight**: `number` -- **backgroundColor**: `string` — Gets or sets the color to use for the background of the component. -- **cellTextStyle**: `string` — Gets or Sets the property name that contains the values. -- **componentRenderer**: `ComponentRenderer` -- **descriptionContext**: `TypeDescriptionContext` -- **descriptionType**: `string` -- **height**: `string` -- **i**: `PropertyEditorPanel` -- **isHorizontal**: `boolean` -- **isIndirectModeEnabled**: `boolean` -- **isWrappingEnabled**: `boolean` -- **properties**: `IgxPropertyEditorPropertyDescriptionCollection` — A collection or manually added axes for the chart. -- **rowHeight**: `number` — Gets or Sets the property name that contains the values. -- **target**: `any` -- **textColor**: `string` — Gets or sets the color to use for the text of the component. -- **updateMode**: `PropertyEditorPanelUpdateMode` — Gets or Sets the property name that contains the values. -- **width**: `string` -- **findByName**(name: string): any -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **ngAfterViewInit**(): void -- **ngOnDestroy**(): void -- **notifyClearItems**(): void — Manually notifies the checkboxlist's grid that the data it has bound to has been cleared and needs to be re-examined. -This should not be called if the data that the grid is bound to is already observable. -- **notifyInsertItem**(index: number, newItem: any): void -- **notifyRemoveItem**(index: number, oldItem: any): void -- **notifySetItem**(index: number, oldItem: any, newItem: any): void -- **updateStyle**(): void - -### [IgxPropertyEditorPropertyDescriptionButtonClickEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxPropertyEditorPropertyDescriptionButtonClickEventArgs) - -- **constructor**(): IgxPropertyEditorPropertyDescriptionButtonClickEventArgs - -### [IgxPropertyEditorPropertyDescriptionChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxPropertyEditorPropertyDescriptionChangedEventArgs) - -- **constructor**(): IgxPropertyEditorPropertyDescriptionChangedEventArgs -- **newValue**: `any` - -### [IgxPropertyEditorPropertyDescriptionCoercingValueEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxPropertyEditorPropertyDescriptionCoercingValueEventArgs) - -- **constructor**(): IgxPropertyEditorPropertyDescriptionCoercingValueEventArgs -- static **ngAcceptInputType_complexValues**: `string | IgxPropertyEditorDescriptionObjectCollection` -- **complexValue**: `IgxPropertyEditorDescriptionObject` -- **complexValues**: `IgxPropertyEditorDescriptionObjectCollection` -- **value**: `any` - -### [IgxPropertyEditorPropertyDescriptionCollection](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxPropertyEditorPropertyDescriptionCollection) - -- **constructor**(list?: IgxPropertyEditorPropertyDescriptionComponent[]): IgxPropertyEditorPropertyDescriptionCollection - -### [IgxPropertyEditorPropertyDescriptionComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxPropertyEditorPropertyDescriptionComponent) - -- **constructor**(): IgxPropertyEditorPropertyDescriptionComponent -- static **ngAcceptInputType_coercedComplexValues**: `string | IgxPropertyEditorDescriptionObjectCollection` -- static **ngAcceptInputType_coercedValueType**: `string | PropertyEditorValueType` -- static **ngAcceptInputType_complexValues**: `string | IgxPropertyEditorDescriptionObjectCollection` -- static **ngAcceptInputType_dropDownNames**: `string | string[]` -- static **ngAcceptInputType_dropDownValues**: `string | string[]` -- static **ngAcceptInputType_editorWidth**: `string | number` -- static **ngAcceptInputType_labelWidth**: `string | number` -- static **ngAcceptInputType_max**: `string | number` -- static **ngAcceptInputType_min**: `string | number` -- static **ngAcceptInputType_properties**: `string | IgxPropertyEditorPropertyDescriptionCollection` -- static **ngAcceptInputType_shouldOverrideDefaultEditor**: `string | boolean` -- static **ngAcceptInputType_step**: `string | number` -- static **ngAcceptInputType_useCoercedValue**: `string | boolean` -- static **ngAcceptInputType_valueType**: `string | PropertyEditorValueType` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **buttonClicked**: `EventEmitter` -- **changed**: `EventEmitter` -- **coercedComplexValue**: `IgxPropertyEditorDescriptionObject` -- **coercedComplexValues**: `IgxPropertyEditorDescriptionObjectCollection` -- **coercedPrimitiveValue**: `any` -- **coercedValueType**: `PropertyEditorValueType` -- **coercingValue**: `EventEmitter` -- **complexValue**: `IgxPropertyEditorDescriptionObject` -- **complexValues**: `IgxPropertyEditorDescriptionObjectCollection` -- **dropDownNames**: `string[]` -- **dropDownValues**: `string[]` -- **editorWidth**: `number` -- **elementDescriptionType**: `string` -- **label**: `string` -- **labelWidth**: `number` -- **max**: `number` -- **min**: `number` -- **name**: `string` — Gets or sets the unique name of the mapping. -- **primitiveValue**: `any` -- **properties**: `IgxPropertyEditorPropertyDescriptionCollection` -- **propertyDescriptionType**: `string` -- **propertyPath**: `string` -- **shouldOverrideDefaultEditor**: `boolean` -- **step**: `number` -- **subtitle**: `string` -- **targetPropertyUpdating**: `EventEmitter` -- **useCoercedValue**: `boolean` -- **valueType**: `PropertyEditorValueType` -- **findByName**(name: string): any -- **ngOnInit**(): void — 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. -- static **_createFromInternal**(internal: any): IgxPropertyEditorPropertyDescriptionComponent - -### [IgxPropertyEditorPropertyDescriptionTargetPropertyUpdatingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxPropertyEditorPropertyDescriptionTargetPropertyUpdatingEventArgs) - -- **constructor**(): IgxPropertyEditorPropertyDescriptionTargetPropertyUpdatingEventArgs -- **propertyPath**: `string` -- **target**: `any` -- **value**: `any` - -### [IgxToolActionButtonComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionButtonComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionButtonComponent -- static **ngAcceptInputType_cornerRadius**: `string | number` -- static **ngAcceptInputType_displayType**: `string | ToolActionButtonDisplayType` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **cornerRadius**: `number` — Gets or sets the button corner radius. -- **displayType**: `ToolActionButtonDisplayType` — Gets or sets the display type for the button. -- **ngAfterContentInit**(): void - -### [IgxToolActionButtonPairComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionButtonPairComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionButtonPairComponent -- static **ngAcceptInputType_cornerRadius**: `string | number` -- static **ngAcceptInputType_displayType**: `string | ToolActionButtonGroupDisplayType` -- static **ngAcceptInputType_isToggleDisabled**: `string | boolean` -- static **ngAcceptInputType_leftIconFillColors**: `string | string[]` -- static **ngAcceptInputType_leftIconStrokeColors**: `string | string[]` -- static **ngAcceptInputType_leftIconStrokeWidth**: `string | number` -- static **ngAcceptInputType_leftIconViewBoxHeight**: `string | number` -- static **ngAcceptInputType_leftIconViewBoxLeft**: `string | number` -- static **ngAcceptInputType_leftIconViewBoxTop**: `string | number` -- static **ngAcceptInputType_leftIconViewBoxWidth**: `string | number` -- static **ngAcceptInputType_leftIsDisabled**: `string | boolean` -- static **ngAcceptInputType_leftIsSelected**: `string | boolean` -- static **ngAcceptInputType_rightIconFillColors**: `string | string[]` -- static **ngAcceptInputType_rightIconStrokeColors**: `string | string[]` -- static **ngAcceptInputType_rightIconStrokeWidth**: `string | number` -- static **ngAcceptInputType_rightIconViewBoxHeight**: `string | number` -- static **ngAcceptInputType_rightIconViewBoxLeft**: `string | number` -- static **ngAcceptInputType_rightIconViewBoxTop**: `string | number` -- static **ngAcceptInputType_rightIconViewBoxWidth**: `string | number` -- static **ngAcceptInputType_rightIsDisabled**: `string | boolean` -- static **ngAcceptInputType_rightIsSelected**: `string | boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualLeftIconFill**: `string` — Gets the actual LeftIcon fill color. -- **actualLeftIconStroke**: `string` — Gets the actual LeftIcon stroke color. -- **actualRightIconFill**: `string` — Gets the actual RightIcon fill color. -- **actualRightIconStroke**: `string` — Gets the actual RightIcon stroke color. -- **cornerRadius**: `number` — Gets or sets the button corner radius. -- **displayType**: `ToolActionButtonGroupDisplayType` — Gets or sets the display type for the button. -- **isToggleDisabled**: `boolean` -- **leftCommandArgument**: `string` -- **leftIconCollectionName**: `string` -- **leftIconFill**: `string` — Gets or sets the LeftIcon fill color. -- **leftIconFillColors**: `string[]` — Gets or sets the LeftIcon fill colors. -- **leftIconName**: `string` -- **leftIconStroke**: `string` — Gets or sets the LeftIcon stroke color. -- **leftIconStrokeColors**: `string[]` — Gets or sets the LeftIcon stroke colors. -- **leftIconStrokeWidth**: `number` — Gets or sets the LeftIcon viewbox width. -- **leftIconViewBoxHeight**: `number` — Gets or sets the LeftIcon viewbox height. -- **leftIconViewBoxLeft**: `number` — Gets or sets the LeftIcon viewbox left. -- **leftIconViewBoxTop**: `number` — Gets or sets the LeftIcon viewbox top. -- **leftIconViewBoxWidth**: `number` — Gets or sets the LeftIcon viewbox width. -- **leftIsDisabled**: `boolean` -- **leftIsSelected**: `boolean` -- **leftTitle**: `string` — Gets or sets the title of the left button. -- **rightCommandArgument**: `string` -- **rightIconCollectionName**: `string` -- **rightIconFill**: `string` — Gets or sets the RightIcon fill color. -- **rightIconFillColors**: `string[]` — Gets or sets the RightIcon fill colors. -- **rightIconName**: `string` -- **rightIconStroke**: `string` — Gets or sets the RightIcon stroke color. -- **rightIconStrokeColors**: `string[]` — Gets or sets the RightIcon stroke colors. -- **rightIconStrokeWidth**: `number` — Gets or sets the RightIcon viewbox width. -- **rightIconViewBoxHeight**: `number` — Gets or sets the RightIcon viewbox height. -- **rightIconViewBoxLeft**: `number` — Gets or sets the RightIcon viewbox left. -- **rightIconViewBoxTop**: `number` — Gets or sets the RightIcon viewbox top. -- **rightIconViewBoxWidth**: `number` — Gets or sets the RightIcon viewbox width. -- **rightIsDisabled**: `boolean` -- **rightIsSelected**: `boolean` -- **rightTitle**: `string` — Gets or sets the title of the Right button. -- **ngAfterContentInit**(): void - -### [IgxToolActionCheckboxComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionCheckboxComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionCheckboxComponent -- static **ngAcceptInputType_isChecked**: `string | boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualCheckedBackgroundColor**: `string` — Gets the actual background color of the checkbox when in the checked state. -- **actualCheckedBorderColor**: `string` — Gets the actual border color of the checkbox when in the checked state. -- **actualUncheckedBackgroundColor**: `string` — Gets the actual background color of the checkbox when in the unchecked state. -- **actualUncheckedBorderColor**: `string` — Gets the actual border color of the checkbox when in the unchecked state. -- **checkedBackgroundColor**: `string` — Gets or sets the background color of the checkbox when in the checked state. -- **checkedBorderColor**: `string` — Gets or sets the border color of the checkbox when in the checked state. -- **isChecked**: `boolean` — Gets or sets if the tool action is checked. -- **uncheckedBackgroundColor**: `string` — Gets or sets the background color of the checkbox when in the unchecked state. -- **uncheckedBorderColor**: `string` — Gets or sets the border color of the checkbox when in the unchecked state. -- **ngAfterContentInit**(): void - -### [IgxToolActionCheckboxListComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionCheckboxListComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionCheckboxListComponent -- static **ngAcceptInputType_indexType**: `string | ToolActionCheckboxListIndexType` -- static **ngAcceptInputType_primaryKey**: `string | string[]` -- static **ngAcceptInputType_selectedKeys**: `string | IgxLayoutSelectedKeysCollection` -- static **ngAcceptInputType_showSelectAll**: `string | boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **dataMemberPath**: `string` — Gets or sets if the tool action is checked. -- **dataSource**: `any` — Gets or sets if the tool action is checked. -- **indexType**: `ToolActionCheckboxListIndexType` -- **primaryKey**: `string[]` — Gets or sets if the tool action is checked. -- **selectedKeys**: `IgxLayoutSelectedKeysCollection` -- **selectedMemberPath**: `string` — Gets or sets if the tool action is checked. -- **showSelectAll**: `boolean` — Gets or sets if the select all row is shown. -- **findByName**(name: string): any -- **ngAfterContentInit**(): void - -### [IgxToolActionCollection](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionCollection) - -- **constructor**(list?: IgxToolActionComponent[]): IgxToolActionCollection - -### [IgxToolActionColorEditorComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionColorEditorComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionColorEditorComponent -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **value**: `string` — Gets or sets the value for the input. -- **ngAfterContentInit**(): void - -### [IgxToolActionComboComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionComboComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionComboComponent -- static **ngAcceptInputType_selectedValues**: `string | IgxLayoutSelectedItemsCollection` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **dataSource**: `any` — Gets or sets if the tool action is checked. -- **displayMemberPath**: `string` — Gets or sets the field to use to get the displayed values. -- **selectedValues**: `IgxLayoutSelectedItemsCollection` -- **valueMemberPath**: `string` — Gets or sets the field to use to get the values to use. -- **ngAfterContentInit**(): void - -### [IgxToolActionComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionComponent -- **contentActions**: `QueryList` -- static **ngAcceptInputType_actions**: `string | IgxToolActionCollection` -- static **ngAcceptInputType_actualDensity**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_actualHighlightRadius**: `string | number` -- static **ngAcceptInputType_actualHighlightWidth**: `string | number` -- static **ngAcceptInputType_actualIconHeight**: `string | number` -- static **ngAcceptInputType_actualIconWidth**: `string | number` -- static **ngAcceptInputType_actualPaddingBottom**: `string | number` -- static **ngAcceptInputType_actualPaddingLeft**: `string | number` -- static **ngAcceptInputType_actualPaddingRight**: `string | number` -- static **ngAcceptInputType_actualPaddingTop**: `string | number` -- static **ngAcceptInputType_closeOnExecute**: `string | boolean` -- static **ngAcceptInputType_contextBindings**: `string | IgxToolContextBindingCollection` -- static **ngAcceptInputType_density**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_height**: `string | number` -- static **ngAcceptInputType_highlightRadius**: `string | number` -- static **ngAcceptInputType_highlightWidth**: `string | number` -- static **ngAcceptInputType_iconFillColors**: `string | string[]` -- static **ngAcceptInputType_iconHeight**: `string | number` -- static **ngAcceptInputType_iconStrokeColors**: `string | string[]` -- static **ngAcceptInputType_iconStrokeWidth**: `string | number` -- static **ngAcceptInputType_iconViewBoxHeight**: `string | number` -- static **ngAcceptInputType_iconViewBoxLeft**: `string | number` -- static **ngAcceptInputType_iconViewBoxTop**: `string | number` -- static **ngAcceptInputType_iconViewBoxWidth**: `string | number` -- static **ngAcceptInputType_iconWidth**: `string | number` -- static **ngAcceptInputType_isDisabled**: `string | boolean` -- static **ngAcceptInputType_isHighlighted**: `string | boolean` -- static **ngAcceptInputType_isOpen**: `string | boolean` -- static **ngAcceptInputType_paddingBottom**: `string | number` -- static **ngAcceptInputType_paddingLeft**: `string | number` -- static **ngAcceptInputType_paddingRight**: `string | number` -- static **ngAcceptInputType_paddingTop**: `string | number` -- static **ngAcceptInputType_subPanelRowHeight**: `string | number` -- static **ngAcceptInputType_titleHorizontalAlignment**: `string | HorizontalAlignment` -- static **ngAcceptInputType_visibility**: `string | Visibility` -- static **ngAcceptInputType_width**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actionId**: `string` -- **actions**: `IgxToolActionCollection` — Gets the sub actions associated with this tool action. -- **actualActions**: `IgxToolActionComponent[]` -- **actualBackground**: `string` — Gets the actual background used by the tool action. -- **actualDensity**: `ControlDisplayDensity` — Gets the resolved display density to use for the action. -- **actualDisabledTextColor**: `string` — Gets the actual label text color when the tool is disabled. -- **actualHighlightColor**: `string` -- **actualHighlightRadius**: `number` -- **actualHighlightWidth**: `number` -- **actualHoverBackground**: `string` — Gets the actual hover background used by the tool action. -- **actualIconFill**: `string` — Gets the actual icon fill color. -- **actualIconHeight**: `number` — Gets the actual icon height used. -- **actualIconStroke**: `string` — Gets the actual icon stroke color. -- **actualIconWidth**: `number` — Gets the actual icon width used. -- **actualPaddingBottom**: `number` -- **actualPaddingLeft**: `number` -- **actualPaddingRight**: `number` -- **actualPaddingTop**: `number` -- **actualSubtitleTextColor**: `string` — Gets the actual label text color. -- **actualSubtitleTextStyle**: `FontInfo` — Gets the actual font used. -- **actualTextColor**: `string` — Gets the actual label text color. -- **actualTextStyle**: `FontInfo` — Gets the actual font used. -- **afterId**: `string` — Gets or sets the Id of the action that this action will be inserted after. -Subsequent actions will continue to insert after the target action, following -the original action that set this property. If using this property do not use the -BeforeId property. -This property is only relevant during initial insertion into the toolbar. Changing the property -after the action has already been added will have no effect. -- **background**: `string` — Gets or sets the background color of the tool action. -- **beforeId**: `string` — Gets or sets the Id of the action that this action will be inserted before. -Subsequent actions will continue to insert before the target action, following -the original action that set this property. If using this property do not use the -AfterId property. -This property is only relevant during initial insertion into the toolbar. Changing the property -after the action has already been added will have no effect. -- **closeOnExecute**: `boolean` — Gets or sets if the tool action will close its parent dropdown when executed by the user. -- **commandArgument**: `string` -- **commandArgumentValue**: `any` -- **commandId**: `string` -- **contextBindings**: `IgxToolContextBindingCollection` — Gets the context bindings for this tool action. -- **density**: `ControlDisplayDensity` — Gets or sets the display density to use for the action. -- **disabledTextColor**: `string` — Gets or sets the label text color when the tool is disabled. -- **height**: `number` — Gets or sets the height to use for this tool action. -- **highlightColor**: `string` -- **highlightRadius**: `number` -- **highlightWidth**: `number` -- **hoverBackground**: `string` — Gets or sets the hover background for this tool action. -- **iconCollectionName**: `string` -- **iconFill**: `string` — Gets or sets the icon fill color. -- **iconFillColors**: `string[]` — Gets or sets the icon fill colors. -- **iconHeight**: `number` — Gets or sets the height of the icon. -- **iconName**: `string` -- **iconStroke**: `string` — Gets or sets the icon stroke color. -- **iconStrokeColors**: `string[]` — Gets or sets the icon stroke colors. -- **iconStrokeWidth**: `number` — Gets or sets the icon viewbox width. -- **iconViewBoxHeight**: `number` — Gets or sets the icon viewbox height. -- **iconViewBoxLeft**: `number` — Gets or sets the icon viewbox left. -- **iconViewBoxTop**: `number` — Gets or sets the icon viewbox top. -- **iconViewBoxWidth**: `number` — Gets or sets the icon viewbox width. -- **iconWidth**: `number` — Gets or sets the width of the icon. -- **isDisabled**: `boolean` -- **isHighlighted**: `boolean` -- **isOpen**: `boolean` -- **name**: `string` -- **onCommand**: `EventEmitter` -- **overlayId**: `string` — Sets to the Id of the action that this action will overlay itself on to. -The purpose of this property is to allow users to override actions automatically generated by -toolbar targets such as the DataChart. These generated actions all have unique Ids associated -with them that can be used for the OverlayId. -These overlaid actions will -not -replace the generated one but will have its properties -overlaid onto the generated actions. -- **paddingBottom**: `number` -- **paddingLeft**: `number` -- **paddingRight**: `number` -- **paddingTop**: `number` -- **parentId**: `string` -- **performed**: `EventEmitter` -- **subPanelRowHeight**: `number` — Gets or sets the height to use for the sub panel if different than default -- **subtitle**: `string` — Gets or sets the subtitle of the tool. -- **subtitleTextColor**: `string` — Gets or sets the label text color. -- **subtitleTextStyle**: `string` — Gets or sets the font to use. -- **textColor**: `string` — Gets or sets the label text color. -- **textStyle**: `string` — Gets or sets the font to use. -- **title**: `string` — Gets or sets the title of the tool. -- **titleHorizontalAlignment**: `HorizontalAlignment` — Gets or sets the title horizontal alignment. -- **visibility**: `Visibility` — Gets or sets the tool action visibility. -- **width**: `number` — Gets or sets the width to use for this tool action. -- **closeSubmenu**(): void -- **exportSerializedVisualData**(): string -- **exportVisualData**(): any -- **findByName**(name: string): any -- **ngAfterContentInit**(): void -- **ngOnInit**(): void — 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. -- **openSubMenu**(): void -- static **_createFromInternal**(internal: any): IgxToolActionComponent - -### [IgxToolActionEventDetail](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionEventDetail) - -- **constructor**(): IgxToolActionEventDetail -- static **ngAcceptInputType_actionType**: `string | ToolActionType` -- static **ngAcceptInputType_boolValue**: `string | boolean` -- static **ngAcceptInputType_isModified**: `string | boolean` -- static **ngAcceptInputType_numberValue**: `string | number` -- **actionId**: `string` -- **actionType**: `ToolActionType` -- **boolValue**: `boolean` -- **dateTimeValue**: `Date` -- **isModified**: `boolean` -- **numberValue**: `number` -- **stringValue**: `string` -- **untypedValue**: `any` -- **findByName**(name: string): any - -### [IgxToolActionEventDetailCollection](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionEventDetailCollection) - -- **constructor**(list?: IgxToolActionEventDetail[]): IgxToolActionEventDetailCollection - -### [IgxToolActionFieldSelectorAggregation](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionFieldSelectorAggregation) - -- **constructor**(): IgxToolActionFieldSelectorAggregation -- static **ngAcceptInputType_operand**: `string | DataSourceSummaryOperand` -- **label**: `string` -- **name**: `string` -- **operand**: `DataSourceSummaryOperand` -- **findByName**(name: string): any - -### [IgxToolActionFieldSelectorAggregationsCollection](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionFieldSelectorAggregationsCollection) - -- **constructor**(list?: IgxToolActionFieldSelectorAggregation[]): IgxToolActionFieldSelectorAggregationsCollection - -### [IgxToolActionFieldSelectorComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionFieldSelectorComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionFieldSelectorComponent -- static **ngAcceptInputType_actualPaddingBottom**: `string | number` -- static **ngAcceptInputType_actualPaddingLeft**: `string | number` -- static **ngAcceptInputType_actualPaddingRight**: `string | number` -- static **ngAcceptInputType_actualPaddingTop**: `string | number` -- static **ngAcceptInputType_aggregations**: `string | IgxToolActionFieldSelectorAggregationsCollection` -- static **ngAcceptInputType_fieldType**: `string | ToolActionFieldSelectorType` -- static **ngAcceptInputType_paddingBottom**: `string | number` -- static **ngAcceptInputType_paddingLeft**: `string | number` -- static **ngAcceptInputType_paddingRight**: `string | number` -- static **ngAcceptInputType_paddingTop**: `string | number` -- static **ngAcceptInputType_selectedAggregations**: `string | IgxToolActionFieldSelectorSelectedAggregationsCollection` -- static **ngAcceptInputType_singleSelection**: `string | boolean` -- static **ngAcceptInputType_updateDataSource**: `string | boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualPaddingBottom**: `number` -- **actualPaddingLeft**: `number` -- **actualPaddingRight**: `number` -- **actualPaddingTop**: `number` -- **aggregations**: `IgxToolActionFieldSelectorAggregationsCollection` — Gets or sets a list of aggregations to use, if null a default list is used instead. -If list provided has custom aggregations the data source is never updated. -- **dataSource**: `IDataSource` — Gets or sets if the tool action is checked. -- **fieldType**: `ToolActionFieldSelectorType` — Gets or sets if the tool action is checked. -- **legendTarget**: `any` -- **paddingBottom**: `number` -- **paddingLeft**: `number` -- **paddingRight**: `number` -- **paddingTop**: `number` -- **selectedAggregations**: `IgxToolActionFieldSelectorSelectedAggregationsCollection` — Used to set default values when using custom aggregations, will be overriden otherwise -- **singleSelection**: `boolean` — Gets or sets if the list only takes one selection at a time. -- **updateDataSource**: `boolean` — Gets or sets if the data source has to be updated when changes are made. -- **findByName**(name: string): any -- **ngAfterContentInit**(): void - -### [IgxToolActionFieldSelectorSelectedAggregation](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionFieldSelectorSelectedAggregation) - -- **constructor**(): IgxToolActionFieldSelectorSelectedAggregation -- static **ngAcceptInputType_aggregationOperand**: `string | DataSourceSummaryOperand` -- **aggregationName**: `string` -- **aggregationOperand**: `DataSourceSummaryOperand` -- **field**: `string` -- **findByName**(name: string): any - -### [IgxToolActionFieldSelectorSelectedAggregationsCollection](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionFieldSelectorSelectedAggregationsCollection) - -- **constructor**(list?: IgxToolActionFieldSelectorSelectedAggregation[]): IgxToolActionFieldSelectorSelectedAggregationsCollection - -### [IgxToolActionGroupHeaderComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionGroupHeaderComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionGroupHeaderComponent -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualBackIconColor**: `string` — Gets the actual back icon color. -- **backIconColor**: `string` — Gets or sets the icon color for the back button. -- **ngAfterContentInit**(): void - -### [IgxToolActionIconButtonComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionIconButtonComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionIconButtonComponent -- static **ngAcceptInputType_actualContentPaddingBottom**: `string | number` -- static **ngAcceptInputType_actualContentPaddingLeft**: `string | number` -- static **ngAcceptInputType_actualContentPaddingRight**: `string | number` -- static **ngAcceptInputType_actualContentPaddingTop**: `string | number` -- static **ngAcceptInputType_actualTooltipDelay**: `string | number` -- static **ngAcceptInputType_contentPaddingBottom**: `string | number` -- static **ngAcceptInputType_contentPaddingLeft**: `string | number` -- static **ngAcceptInputType_contentPaddingRight**: `string | number` -- static **ngAcceptInputType_contentPaddingTop**: `string | number` -- static **ngAcceptInputType_isOpen**: `string | boolean` -- static **ngAcceptInputType_tooltipDelay**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualContentPaddingBottom**: `number` -- **actualContentPaddingLeft**: `number` -- **actualContentPaddingRight**: `number` -- **actualContentPaddingTop**: `number` -- **actualTooltipDelay**: `number` — Gets the actual delay before the tooltip is displayed (in milliseconds). -- **contentPaddingBottom**: `number` -- **contentPaddingLeft**: `number` -- **contentPaddingRight**: `number` -- **contentPaddingTop**: `number` -- **isOpen**: `boolean` -- **popupOpening**: `EventEmitter` -- **tooltipDelay**: `number` — Gets or sets how long it takes before the tooltip is displayed (in milliseconds). -- **closeSubmenu**(): void -- **exportVisualData**(): any -- **ngAfterContentInit**(): void -- **openSubMenu**(): void - -### [IgxToolActionIconMenuComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionIconMenuComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionIconMenuComponent -- static **ngAcceptInputType_showArrowIcon**: `string | boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualArrowStroke**: `string` — Gets the actual stroke color of the arrow icon. -- **arrowStroke**: `string` — Gets or sets the stroke color of the arrow icon. -- **showArrowIcon**: `boolean` — Gets or sets whether the arrow icon should be shown. -- **exportVisualData**(): any -- **ngAfterContentInit**(): void - -### [IgxToolActionLabelComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionLabelComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionLabelComponent -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **ngAfterContentInit**(): void - -### [IgxToolActionNumberInputComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionNumberInputComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionNumberInputComponent -- static **ngAcceptInputType_value**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **value**: `number` — Gets or sets the value for the input. -- **ngAfterContentInit**(): void - -### [IgxToolActionPerformedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionPerformedEventArgs) - -- **constructor**(): IgxToolActionPerformedEventArgs -- static **ngAcceptInputType_detailCollection**: `string | IgxToolActionEventDetailCollection` -- static **ngAcceptInputType_isAggregate**: `string | boolean` -- **detail**: `IgxToolActionEventDetail` -- **detailCollection**: `IgxToolActionEventDetailCollection` -- **isAggregate**: `boolean` - -### [IgxToolActionPopupOpeningEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionPopupOpeningEventArgs) - -- **constructor**(): IgxToolActionPopupOpeningEventArgs -- static **ngAcceptInputType_cancel**: `string | boolean` -- **cancel**: `boolean` -- **sourceAction**: `IgxToolActionComponent` - -### [IgxToolActionRadioComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionRadioComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionRadioComponent -- static **ngAcceptInputType_isChecked**: `string | boolean` -- static **ngAcceptInputType_isManual**: `string | boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualCheckedBackgroundColor**: `string` — Gets the actual background color of the radio when in the checked state. -- **actualCheckedBorderColor**: `string` — Gets the actual border color of the radio when in the checked state. -- **actualUncheckedBackgroundColor**: `string` — Gets the actual background color of the radio when in the unchecked state. -- **actualUncheckedBorderColor**: `string` — Gets the actual border color of the radio when in the unchecked state. -- **channel**: `string` — Gets or sets the channel this radio button belongs to. -- **checkedBackgroundColor**: `string` — Gets or sets the background color of the radio when in the checked state. -- **checkedBorderColor**: `string` — Gets or sets the border color of the radio when in the checked state. -- **isChecked**: `boolean` — Gets or sets if the tool action is checked. -- **isManual**: `boolean` — Gets or sets if the checked state of the radio is handled manually by the user. The radio -well not become selected when clicked if this property is true. -- **uncheckedBackgroundColor**: `string` — Gets or sets the background color of the radio when in the unchecked state. -- **uncheckedBorderColor**: `string` — Gets or sets the border color of the radio when in the unchecked state. -- **ngAfterContentInit**(): void - -### [IgxToolActionSeparatorComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionSeparatorComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionSeparatorComponent -- static **ngAcceptInputType_isGroupHeaderSeparator**: `string | boolean` -- static **ngAcceptInputType_size**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **isGroupHeaderSeparator**: `boolean` — Gets or sets whether to use group header styling or regular styling on this separator. -- **size**: `number` — Gets or sets the size of the separator. -- **ngAfterContentInit**(): void - -### [IgxToolActionSubPanelComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionSubPanelComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionSubPanelComponent -- static **ngAcceptInputType_itemSpacing**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **itemSpacing**: `number` — Gets or sets the spacing between items. -- **ngAfterContentInit**(): void - -### [IgxToolActionTextInputComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolActionTextInputComponent) -Represents base class for all tool actions in toolbar - -- **constructor**(): IgxToolActionTextInputComponent -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **value**: `string` — Gets or sets the value for the input. -- **ngAfterContentInit**(): void - -### [IgxToolbarComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolbarComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, changeDetector: ChangeDetectorRef, componentFactoryResolver: ComponentFactoryResolver): IgxToolbarComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **_mainDiv**: `Element` -- **_mainDivRef**: `ElementRef` -- **combinedActions**: `IgxToolActionComponent[]` — The style mappings actually present in the chart. Do not directly modify this array. -This array's contents can be modified by causing Angular to reproject the child content. -Or adding and removing stye mappings from the manual style mapping collection on the actions property. -- **contentActions**: `QueryList` -- static **ngAcceptInputType_actualActions**: `string | IgxToolActionCollection` -- static **ngAcceptInputType_autoGeneratedActions**: `string | IgxToolActionCollection` -- static **ngAcceptInputType_baseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_density**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_dropdownClickBuffer**: `string | number` -- static **ngAcceptInputType_dropdownDelay**: `string | number` -- static **ngAcceptInputType_highlightRadius**: `string | number` -- static **ngAcceptInputType_highlightWidth**: `string | number` -- static **ngAcceptInputType_isOpen**: `string | boolean` -- static **ngAcceptInputType_orientation**: `string | ToolbarOrientation` -- static **ngAcceptInputType_rowHeight**: `string | number` -- static **ngAcceptInputType_scrollbarStyle**: `string | ScrollbarStyle` -- static **ngAcceptInputType_separatorHorizontalPaddingBottom**: `string | number` -- static **ngAcceptInputType_separatorHorizontalPaddingLeft**: `string | number` -- static **ngAcceptInputType_separatorHorizontalPaddingRight**: `string | number` -- static **ngAcceptInputType_separatorHorizontalPaddingTop**: `string | number` -- static **ngAcceptInputType_separatorVerticalPaddingBottom**: `string | number` -- static **ngAcceptInputType_separatorVerticalPaddingLeft**: `string | number` -- static **ngAcceptInputType_separatorVerticalPaddingRight**: `string | number` -- static **ngAcceptInputType_separatorVerticalPaddingTop**: `string | number` -- static **ngAcceptInputType_showOnHover**: `string | boolean` -- static **ngAcceptInputType_showTooltipOnHover**: `string | boolean` -- static **ngAcceptInputType_stopPropagation**: `string | boolean` -- static **ngAcceptInputType_toolTipCornerRadius**: `string | number` -- static **ngAcceptInputType_toolTipElevation**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actions**: `IgxToolActionCollection` — A collection or manually added axes for the chart. -- **actualActions**: `IgxToolActionCollection` — Gets or sets the data or data source instance to which to bind the grid. -- **autoGeneratedActions**: `IgxToolActionCollection` — Gets or sets the data or data source instance to which to bind the grid. -- **backgroundColor**: `string` — Gets or sets the color to use for the background of the component. -- **baseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the checkbox. -- **cellTextStyle**: `string` — Gets or sets the text style. -- **checkedBackgroundColor**: `string` — Gets or sets the background color of the radio when in the checked state. -- **checkedBorderColor**: `string` — Gets or sets the border color of the radio when in the checked state. -- **density**: `ControlDisplayDensity` — Gets or sets the display density to use for the toolbar. -- **disabledTextColor**: `string` — Gets or sets the color to use for the text in disabled tool actions. -- **dropdownClickBuffer**: `number` — Gets or sets the amount of time to wait when clicking on the icon menu button while the dropdown is opening. If a click was -executed within this buffer window the dropdown will be left open. Otherwise it will close it. Setting a negative value will -always keep the dropdown open during a hover open and will require an extra click to close. -- **dropdownDelay**: `number` — Gets or sets the dropdown delay time in milliseconds. -- **groupHeaderBackgroundColor**: `string` — Gets or sets the group header background color. -- **groupHeaderSubtitleTextColor**: `string` — Gets or sets the text color for group header subtitles. -- **groupHeaderTextColor**: `string` — Gets or sets the text color for group header tool actions. -- **groupHeaderTextStyle**: `string` — Gets or sets the text style. -- **height**: `string` -- **highlightColor**: `string` -- **highlightRadius**: `number` -- **highlightWidth**: `number` -- **hoverBackgroundColor**: `string` — Gets or sets the hover background color. -- **i**: `Toolbar` -- **iconFill**: `string` — Gets or sets the fill color of icons in the ToolPanel. -- **iconStroke**: `string` — Gets or sets the stroke color of icons in the ToolPanel. -- **isOpen**: `boolean` -- **menuArrowStroke**: `string` — Gets or sets the stroke color for all icon menu dropdown arrows. -- **onCommand**: `EventEmitter` — Event raised when a command is triggered in the toolbar. -- **orientation**: `ToolbarOrientation` — Gets or sets the orientation of the toolbar. -- **rowHeight**: `number` — Gets or sets the row height that should be used. -- **scrollbarStyle**: `ScrollbarStyle` — Gets or sets the style of scrollbar. -- **separatorBackgroundColor**: `string` — Gets or sets the separator background color. -- **separatorHorizontalPaddingBottom**: `number` — Gets or sets the bottom padding for separators in the horizontal orientation. -- **separatorHorizontalPaddingLeft**: `number` — Gets or sets the left padding for separators in the horizontal orientation. -- **separatorHorizontalPaddingRight**: `number` — Gets or sets the right padding for separators in the horizontal orientation. -- **separatorHorizontalPaddingTop**: `number` — Gets or sets the top padding for separators in the horizontal orientation. -- **separatorVerticalPaddingBottom**: `number` — Gets or sets the bottom padding for separators in the vertical orientation. -- **separatorVerticalPaddingLeft**: `number` — Gets or sets the left padding for separators in the vertical orientation. -- **separatorVerticalPaddingRight**: `number` — Gets or sets the right padding for separators in the vertical orientation. -- **separatorVerticalPaddingTop**: `number` — Gets or sets the top padding for separators in the vertical orientation. -- **showOnHover**: `boolean` — Gets or sets if the tool actions should display their submenus on mouse hover. -- **showTooltipOnHover**: `boolean` — Gets or sets if the tool action icon buttons should display their tooltips on mouse hover. -- **stopPropagation**: `boolean` — Prevents clicks on the tool actions from bubbling. -- **submenuBackgroundColor**: `string` — Gets or sets the background color for submenus. -- **subMenuClosing**: `EventEmitter` — Event raised when a submenu is closed on the toolbar -- **subMenuOpening**: `EventEmitter` — Event raised when a submenu is opened on the toolbar. -- **subtitleTextColor**: `string` — Gets or sets the text color for subtitles. -- **subtitleTextStyle**: `string` — Gets or sets the text style for subtitles. -- **target**: `any` — Gets or sets a target component which the toolbar can request actions from. -- **textColor**: `string` — Gets or sets the color to use for the text of the component. -- **toolTipBackgroundColor**: `string` — Gets or sets the tooltip background color. -- **toolTipCornerRadius**: `number` — Gets or sets the tooltip corner radius. -- **toolTipElevation**: `number` — Gets or sets the shadow elevation for the tooltip. -- **toolTipTextColor**: `string` — Gets or sets the tooltip text color. -- **uncheckedBackgroundColor**: `string` — Gets or sets the background color of the radio when in the unchecked state. -- **uncheckedBorderColor**: `string` — Gets or sets the border color of the radio when in the unchecked state. -- **width**: `string` -- **closeSubmenus**(): void — Forces any open sub menus to close. -- **exportSerializedVisualData**(): string — Returns a serialized copy of the exported visual model -- **exportVisualData**(): any — Exports visual information about the current state of the grid. -- **findByName**(name: string): any -- **flushRefresh**(): void -- **getBoolContextItem**(key: string): boolean -- **getBrushCollectionContextItem**(key: string): string[] -- **getBrushContextItem**(key: string): string -- **getColorContextItem**(key: string): string -- **getDataContextItem**(key: string): any -- **getDataURLFromCache**(iconCollection: string, iconName: string): string -- **getDesiredSize**(): IgSize — Get the desired size the toolbar wants to be. -- **getDoubleContextItem**(key: string): number -- **getExternalDataContextItem**(key: string): any -- **getExternalDoubleContextItem**(key: string): number -- **getExternalIntContextItem**(key: string): number -- **getIconFromCache**(iconCollection: string, iconName: string): string -- **getIconSource**(iconCollection: string, iconName: string): any -- **getIntContextItem**(key: string): number -- **getMultiPathSVGFromCache**(iconCollection: string, iconName: string): string[] -- **getStringContextItem**(key: string): string -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **ngAfterViewInit**(): void -- **ngOnDestroy**(): void -- **onCommandStateChanged**(id: string, type: string | ToolCommandStateType, value: any): void -- **registerIconFromDataURL**(iconCollection: string, iconName: string, dataURL: string): void -- **registerIconFromText**(iconCollection: string, iconName: string, iconText: string): void -- **registerIconSource**(iconCollection: string, iconName: string, source: any): void -- **registerMultiPathSVG**(iconCollection: string, iconName: string, multiPathSVG: string[]): void -- **setBoolContextItem**(key: string, value: boolean): void -- **setBrushCollectionContextItem**(key: string, value: string[]): void -- **setBrushContextItem**(key: string, value: string): void -- **setColorContextItem**(key: string, value: string): void -- **setDataContextItem**(key: string, value: any): void -- **setDoubleContextItem**(key: string, value: number): void -- **setExternalDataContextItem**(key: string, value: any): void -- **setExternalDoubleContextItem**(key: string, value: any): void -- **setExternalIntContextItem**(key: string, value: any): void -- **setIntContextItem**(key: string, value: number): void -- **setStringContextItem**(key: string, value: string): void -- **updateStyle**(): void - -### [IgxToolbarSubMenuClosingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolbarSubMenuClosingEventArgs) - -- **constructor**(): IgxToolbarSubMenuClosingEventArgs - -### [IgxToolbarSubMenuOpeningEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolbarSubMenuOpeningEventArgs) - -- **constructor**(): IgxToolbarSubMenuOpeningEventArgs - -### [IgxToolCommandEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolCommandEventArgs) - -- **constructor**(): IgxToolCommandEventArgs -- static **ngAcceptInputType_closeOnExecute**: `string | boolean` -- **closeOnExecute**: `boolean` -- **command**: `ToolCommand` - -### [IgxToolContextBinding](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolContextBinding) - -- **constructor**(): IgxToolContextBinding -- static **ngAcceptInputType_bindingMode**: `string | ToolContextBindingMode` -- **bindingMode**: `ToolContextBindingMode` -- **contextKey**: `string` -- **propertyName**: `string` -- **propertyUpdated**: `EventEmitter` -- **findByName**(name: string): any - -### [IgxToolContextBindingCollection](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolContextBindingCollection) - -- **constructor**(list?: IgxToolContextBinding[]): IgxToolContextBindingCollection - -### [IgxToolPanelComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolPanelComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, changeDetector: ChangeDetectorRef, componentFactoryResolver: ComponentFactoryResolver): IgxToolPanelComponent -- **_childTemplateRef**: `TemplateRef` -- **_dynamicContent**: `ViewContainerRef` -- **_mainDiv**: `Element` -- **_mainDivRef**: `ElementRef` -- **actualActions**: `IgxToolActionComponent[]` — The style mappings actually present in the chart. Do not directly modify this array. -This array's contents can be modified by causing Angular to reproject the child content. -Or adding and removing stye mappings from the manual style mapping collection on the actions property. -- **contentActions**: `QueryList` -- static **ngAcceptInputType_actualDensity**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_actualDropdownDelay**: `string | number` -- static **ngAcceptInputType_actualHighlightRadius**: `string | number` -- static **ngAcceptInputType_actualHighlightWidth**: `string | number` -- static **ngAcceptInputType_actualRowHeight**: `string | number` -- static **ngAcceptInputType_actualSeparatorHorizontalPaddingBottom**: `string | number` -- static **ngAcceptInputType_actualSeparatorHorizontalPaddingLeft**: `string | number` -- static **ngAcceptInputType_actualSeparatorHorizontalPaddingRight**: `string | number` -- static **ngAcceptInputType_actualSeparatorHorizontalPaddingTop**: `string | number` -- static **ngAcceptInputType_actualSeparatorVerticalPaddingBottom**: `string | number` -- static **ngAcceptInputType_actualSeparatorVerticalPaddingLeft**: `string | number` -- static **ngAcceptInputType_actualSeparatorVerticalPaddingRight**: `string | number` -- static **ngAcceptInputType_actualSeparatorVerticalPaddingTop**: `string | number` -- static **ngAcceptInputType_actualToolTipCornerRadius**: `string | number` -- static **ngAcceptInputType_actualToolTipElevation**: `string | number` -- static **ngAcceptInputType_baseTheme**: `string | BaseControlTheme` -- static **ngAcceptInputType_density**: `string | ControlDisplayDensity` -- static **ngAcceptInputType_dropdownClickBuffer**: `string | number` -- static **ngAcceptInputType_dropdownDelay**: `string | number` -- static **ngAcceptInputType_highlightRadius**: `string | number` -- static **ngAcceptInputType_highlightWidth**: `string | number` -- static **ngAcceptInputType_isOpen**: `string | boolean` -- static **ngAcceptInputType_itemSpacing**: `string | number` -- static **ngAcceptInputType_nestedActionMode**: `string | NestedActionMode` -- static **ngAcceptInputType_orientation**: `string | ToolPanelOrientation` -- static **ngAcceptInputType_rowHeight**: `string | number` -- static **ngAcceptInputType_scrollbarStyle**: `string | ScrollbarStyle` -- static **ngAcceptInputType_separatorHorizontalPaddingBottom**: `string | number` -- static **ngAcceptInputType_separatorHorizontalPaddingLeft**: `string | number` -- static **ngAcceptInputType_separatorHorizontalPaddingRight**: `string | number` -- static **ngAcceptInputType_separatorHorizontalPaddingTop**: `string | number` -- static **ngAcceptInputType_separatorVerticalPaddingBottom**: `string | number` -- static **ngAcceptInputType_separatorVerticalPaddingLeft**: `string | number` -- static **ngAcceptInputType_separatorVerticalPaddingRight**: `string | number` -- static **ngAcceptInputType_separatorVerticalPaddingTop**: `string | number` -- static **ngAcceptInputType_showOnHover**: `string | boolean` -- static **ngAcceptInputType_showTooltipOnHover**: `string | boolean` -- static **ngAcceptInputType_stopPropagation**: `string | boolean` -- static **ngAcceptInputType_toolTipCornerRadius**: `string | number` -- static **ngAcceptInputType_toolTipElevation**: `string | number` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actions**: `IgxToolActionCollection` — A collection or manually added axes for the chart. -- **actualBackgroundColor**: `string` -- **actualCheckedBackgroundColor**: `string` — Gets the actual background color of the radio when in the checked state. -- **actualCheckedBorderColor**: `string` — Gets the actual border color of the radio when in the checked state. -- **actualDensity**: `ControlDisplayDensity` — Gets the resolved display density to use for the toolbar. -- **actualDisabledTextColor**: `string` -- **actualDropdownDelay**: `number` — Gets the actual dropdown delay. -- **actualGroupHeaderBackgroundColor**: `string` -- **actualGroupHeaderSeparatorBackgroundColor**: `string` -- **actualGroupHeaderSubtitleTextColor**: `string` -- **actualGroupHeaderTextColor**: `string` -- **actualHighlightColor**: `string` -- **actualHighlightRadius**: `number` -- **actualHighlightWidth**: `number` -- **actualHoverBackgroundColor**: `string` -- **actualIconFill**: `string` — Gets the actual icon fill color. -- **actualIconStroke**: `string` — Gets the actual icon stroke color. -- **actualMenuArrowStroke**: `string` — Gets the actual stroke color for all icon menu dropdown arrows. -- **actualRowHeight**: `number` — Gets the actual row height used by the panel. -- **actualSeparatorBackgroundColor**: `string` -- **actualSeparatorHorizontalPaddingBottom**: `number` -- **actualSeparatorHorizontalPaddingLeft**: `number` -- **actualSeparatorHorizontalPaddingRight**: `number` -- **actualSeparatorHorizontalPaddingTop**: `number` -- **actualSeparatorVerticalPaddingBottom**: `number` -- **actualSeparatorVerticalPaddingLeft**: `number` -- **actualSeparatorVerticalPaddingRight**: `number` -- **actualSeparatorVerticalPaddingTop**: `number` -- **actualSubmenuBackgroundColor**: `string` -- **actualSubtitleTextColor**: `string` -- **actualTextColor**: `string` -- **actualToolTipBackgroundColor**: `string` — Gets the actual tooltip background color. -- **actualToolTipCornerRadius**: `number` — Gets the actual tooltip corner radius. -- **actualToolTipElevation**: `number` — Gets the actual shadow elevation used by the tooltip. -- **actualToolTipTextColor**: `string` -- **actualUncheckedBackgroundColor**: `string` — Gets the actual background color of the radio when in the unchecked state. -- **actualUncheckedBorderColor**: `string` — Gets the actual border color of the radio when in the unchecked state. -- **backgroundColor**: `string` — Gets or sets the color to use for the background of the component. -- **baseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the checkbox. -- **cellTextStyle**: `string` — Gets or sets the text style for the panel. -- **checkedBackgroundColor**: `string` — Gets or sets the background color of the radio when in the checked state. -- **checkedBorderColor**: `string` — Gets or sets the border color of the radio when in the checked state. -- **contentRefreshed**: `EventEmitter` -- **density**: `ControlDisplayDensity` — Gets or sets the display density to use for the toolbar. -- **disabledTextColor**: `string` — Gets or sets the color to use for the text in disabled tool actions. -- **dropdownClickBuffer**: `number` — Gets or sets the amount of time to wait when clicking on the icon menu button while the dropdown is opening. If a click was -executed within this buffer window the dropdown will be left open. Otherwise it will close it. Setting a negative value will -always keep the dropdown open during a hover open and will require an extra click to close. -- **dropdownDelay**: `number` — Gets or sets the dropdown delay time in milliseconds. -- **groupHeaderBackgroundColor**: `string` — Gets or sets the group header background color. -- **groupHeaderSeparatorBackgroundColor**: `string` — Gets or sets the group header separator background color. -- **groupHeaderSubtitleTextColor**: `string` — Gets or sets the text color for group header subtitle. -- **groupHeaderTextColor**: `string` — Gets or sets the text color for group header tool actions. -- **groupHeaderTextStyle**: `string` — Gets or sets the text style. -- **height**: `string` -- **highlightColor**: `string` -- **highlightRadius**: `number` -- **highlightWidth**: `number` -- **hoverBackgroundColor**: `string` — Gets or sets the hover background color. -- **i**: `ToolPanel` -- **iconFill**: `string` — Gets or sets the fill color of icons in the ToolPanel. -- **iconStroke**: `string` — Gets or sets the stroke color of icons in the ToolPanel. -- **isOpen**: `boolean` -- **itemSpacing**: `number` — Gets or sets the spacing between items -- **menuArrowStroke**: `string` — Gets or sets the stroke color for all icon menu dropdown arrows. -- **nestedActionMode**: `NestedActionMode` — Gets or sets the mode used when displaying nested actions. -- **onCommand**: `EventEmitter` -- **orientation**: `ToolPanelOrientation` — Gets or sets the color to use for the background of the component. -- **rowHeight**: `number` — Gets or sets the row height for the panel. -- **scrollbarStyle**: `ScrollbarStyle` — Gets or sets the style of scrollbar. -- **separatorBackgroundColor**: `string` — Gets or sets the separator background color. -- **separatorHorizontalPaddingBottom**: `number` — Gets or sets the bottom padding for separators in the horizontal orientation. -- **separatorHorizontalPaddingLeft**: `number` — Gets or sets the left padding for separators in the horizontal orientation. -- **separatorHorizontalPaddingRight**: `number` — Gets or sets the right padding for separators in the horizontal orientation. -- **separatorHorizontalPaddingTop**: `number` — Gets or sets the top padding for separators in the horizontal orientation. -- **separatorVerticalPaddingBottom**: `number` — Gets or sets the bottom padding for separators in the vertical orientation. -- **separatorVerticalPaddingLeft**: `number` — Gets or sets the left padding for separators in the vertical orientation. -- **separatorVerticalPaddingRight**: `number` — Gets or sets the right padding for separators in the vertical orientation. -- **separatorVerticalPaddingTop**: `number` — Gets or sets the top padding for separators in the vertical orientation. -- **showOnHover**: `boolean` — Gets or sets if the tool actions should display their submenus on mouse hover. -- **showTooltipOnHover**: `boolean` — Gets or sets if the tool action icon buttons should display their tooltips on mouse hover. -- **stopPropagation**: `boolean` — Prevents clicks on the tool actions from bubbling. -- **submenuBackgroundColor**: `string` — Gets or sets the background color for submenus. -- **subtitleTextColor**: `string` — Gets or sets the color to use for the subtitle of the component. -- **subtitleTextStyle**: `string` — Gets or sets the subtitle text style for the panel. -- **textColor**: `string` — Gets or sets the color to use for the text of the component. -- **toolTipBackgroundColor**: `string` — Gets or sets the tooltip background color. -- **toolTipCornerRadius**: `number` — Gets or sets the tooltip corner radius. -- **toolTipElevation**: `number` — Gets or sets the shadow elevation for the tooltip. -- **toolTipTextColor**: `string` — Gets or sets the tooltip text color. -- **uncheckedBackgroundColor**: `string` — Gets or sets the background color of the radio when in the unchecked state. -- **uncheckedBorderColor**: `string` — Gets or sets the border color of the radio when in the unchecked state. -- **width**: `string` -- **closeSubmenus**(): void — Forces any open sub menus to close. -- **exportSerializedVisualData**(): string -- **exportVisualData**(): any -- **findByName**(name: string): any -- **flushRefresh**(): void -- **getBoolContextItem**(key: string): boolean -- **getBrushCollectionContextItem**(key: string): string[] -- **getBrushContextItem**(key: string): string -- **getColorContextItem**(key: string): string -- **getDataContextItem**(key: string): any -- **getDesiredSize**(): IgSize -- **getDoubleContextItem**(key: string): number -- **getIntContextItem**(key: string): number -- **getStringContextItem**(key: string): string -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **ngAfterViewInit**(): void -- **ngOnDestroy**(): void -- **refresh**(): void -- **setBoolContextItem**(key: string, value: boolean): void -- **setBrushCollectionContextItem**(key: string, value: string[]): void -- **setBrushContextItem**(key: string, value: string): void -- **setColorContextItem**(key: string, value: string): void -- **setDataContextItem**(key: string, value: any): void -- **setDoubleContextItem**(key: string, value: number): void -- **setIntContextItem**(key: string, value: number): void -- **setStringContextItem**(key: string, value: string): void -- **updateStyle**(): void - -### [IgxToolPanelContentRefreshedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolPanelContentRefreshedEventArgs) - -- **constructor**(): IgxToolPanelContentRefreshedEventArgs - -### [IgxToolPanelContextChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolPanelContextChangedEventArgs) - -- **constructor**(): IgxToolPanelContextChangedEventArgs -- **contextKey**: `string` -- **newValue**: `any` -- **oldValue**: `any` - -### [IgxToolPanelContextSwappedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxToolPanelContextSwappedEventArgs) - -- **constructor**(): IgxToolPanelContextSwappedEventArgs - -### [IgxXExpansionPanelComponent](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/classes/IgxXExpansionPanelComponent) - -- **constructor**(renderer: Renderer2, _elRef: ViewContainerRef, ngZone: NgZone, injector: Injector, componentFactoryResolver: ComponentFactoryResolver): IgxXExpansionPanelComponent -- **_contentInner**: `ElementRef` -- **_contentOuter**: `ElementRef` -- **_dynamicContent**: `ViewContainerRef` -- **_header**: `ElementRef` -- **_mainDiv**: `Element` -- **_mainDivRef**: `ElementRef` -- static **ngAcceptInputType_actualElevation**: `string | number` -- static **ngAcceptInputType_elevation**: `string | number` -- static **ngAcceptInputType_expanded**: `string | boolean` -- static **ɵcmp**: `unknown` -- static **ɵfac**: `unknown` -- **actualAmbientShadowColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **actualCaptionTextColor**: `string` — Gets or sets the color to use for the actual header caption text. -- **actualDescriptionTextColor**: `string` — Gets or sets the color to use for the actual header description text. -- **actualElevation**: `number` — Gets or sets the elevation of the border shadow -- **actualHeaderBackgroundColor**: `string` — Gets or sets the color to use for the actual background of the header. -- **actualPenumbraShadowColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **actualUmbraShadowColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **caption**: `string` — Gets / sets the caption to display in the header area. -- **captionCollapsedTextColor**: `string` — Gets or sets the color to use for the header caption text when the panel is collapsed. -- **captionExpandedTextColor**: `string` — Gets or sets the color to use for the header caption text when the panel is expanded. -- **captionTextColor**: `string` — Gets or sets the color to use for the header caption text. -- **description**: `string` — Gets / sets the description to display in the header area. -- **descriptionCollapsedTextColor**: `string` — Gets or sets the color to use for the header description text when the panel is collapsed. -- **descriptionExpandedTextColor**: `string` — Gets or sets the color to use for the header description text when the panel is expanded. -- **descriptionTextColor**: `string` — Gets or sets the color to use for the header description text. -- **elevation**: `number` — Gets or sets the elevation to use for the button regardless of type. -- **expanded**: `boolean` — Gets / sets the expanded state of the panel. -- **headerBackgroundColor**: `string` — Gets or sets the color to use for the background of the header. -- **headerCollapsedBackgroundColor**: `string` — Gets or sets the color to use for the background of the header when the panel is expanded. -- **headerExpandedBackgroundColor**: `string` — Gets or sets the color to use for the background of the header when the panel is expanded. -- **height**: `string` -- **i**: `XExpansionPanel` -- **onCollapsed**: `EventEmitter` — Fires when the expansion panel is collapsed. -- **onExpanded**: `EventEmitter` -- **width**: `string` -- **collapse**(): void — Collapses the contents of the expansion panel. -- **expand**(): void — Expands the contents of the expansion panel. -- **findByName**(name: string): any -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **ngOnDestroy**(): void -- **toggle**(): void — Toggles the expanded state of the expansion panel. -- **updateStyle**(): void - -## Enumerations - -### [ComboEditorCloneDataSourceFilterOperation](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/ComboEditorCloneDataSourceFilterOperation) -Indicates the current operation underway for the cloned data source. - -- **None** = 0 -- **TextToValue** = 2 -- **ValueToText** = 1 - -### [ComboEditorSelectedItemChangeType](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/ComboEditorSelectedItemChangeType) -Indicates what type of operation is taking place when the selected row, value, or text in the combo box changes. - -- **Row** = 2 -- **Text** = 1 -- **Value** = 0 - -### [ListPanelActivationMode](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/ListPanelActivationMode) -Indicates the activation mode to use for the grid. - -- **Cell** = 1 — A single cell is permitted to be activated at a time. -- **None** = 0 — No activation should be peformed based on interaction. - -### [ListPanelOrientation](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/ListPanelOrientation) - -- **Horizontal** = 1 -- **HorizontalWrapped** = 2 -- **Vertical** = 0 - -### [ListPanelSelectionBehavior](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/ListPanelSelectionBehavior) -Indicates the selection mode to use for the grid. - -- **ModifierBased** = 1 — Only one row or cell is selected at a time and modifier keys are required to multi-select them. -- **Toggle** = 0 — Rows and cells are selected using a toggleable behavior. Modifier selection is ignored (CTRL and SHIFT). - -### [ListPanelSelectionMode](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/ListPanelSelectionMode) -Indicates the selection mode to use for the grid. - -- **MultipleRow** = 2 — Multiple rows are permitted to be selected at a time from interaction. -- **None** = 0 — No selection should be peformed based on interaction. -- **SingleRow** = 1 — A single row is permitted to be selected at a time from interaction. - -### [NestedActionMode](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/NestedActionMode) - -- **Replace** = 0 — Replaces the current tool action view with the nested view. - -### [PropertyEditorPanelUpdateMode](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/PropertyEditorPanelUpdateMode) - -- **Auto** = 0 -- **ComponentRendererOverlay** = 1 -- **DataSeriesToDescriptionCustomizations** = 2 - -### [PropertyEditorValueType](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/PropertyEditorValueType) - -- **Array** = 10 -- **boolean1** = 7 -- **Brush** = 4 -- **BrushCollection** = 6 -- **Button** = 20 -- **Collection** = 9 -- **Color** = 5 -- **ColorCollection** = 14 -- **DataRef** = 18 -- **Date** = 3 -- **DoubleCollection** = 23 -- **EnumValue** = 15 -- **EventRef** = 17 -- **Header** = 25 -- **MethodRef** = 16 -- **Number** = 1 -- **Point** = 11 -- **Rect** = 13 -- **Separator** = 24 -- **Size** = 12 -- **Slider** = 21 -- **StringValue** = 2 -- **SubType** = 8 -- **TemplateRef** = 22 -- **TimeSpan** = 19 -- **Unhandled** = 0 - -### [ToolActionButtonDisplayType](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/ToolActionButtonDisplayType) -Different display types for the button. - -- **Flat** = 1 -- **Outlined** = 2 -- **Raised** = 0 - -### [ToolActionButtonGroupDisplayType](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/ToolActionButtonGroupDisplayType) -Different display types for the button. - -- **Flat** = 0 -- **Outlined** = 1 - -### [ToolActionCheckboxListIndexType](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/ToolActionCheckboxListIndexType) - -- **DeSelected** = 1 -- **Selected** = 0 - -### [ToolActionFieldSelectorEventType](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/ToolActionFieldSelectorEventType) - -- **AggregationChange** = 1 -- **Change** = 0 - -### [ToolActionFieldSelectorType](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/ToolActionFieldSelectorType) - -- **Label** = 0 -- **Value** = 1 - -### [ToolbarOrientation](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/ToolbarOrientation) - -- **Horizontal** = 1 -- **HorizontalWrapped** = 2 -- **Vertical** = 0 - -### [ToolPanelOrientation](https://www.infragistics.com/api/angular/igniteui-angular-layouts/latest/enums/ToolPanelOrientation) - -- **Horizontal** = 1 -- **HorizontalWrapped** = 2 -- **Vertical** = 0 diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular/21.0.x/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular/21.0.x/llms-full.txt deleted file mode 100644 index 37d74a9bd..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/angular-api/igniteui-angular/21.0.x/llms-full.txt +++ /dev/null @@ -1,9415 +0,0 @@ -# Ignite UI for Angular v21.0.x — Full API Reference - -> Complete API reference for the Ignite UI for Angular package (21.0.x). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: Angular -Package: igniteui-angular -Version: 21.0.x - -## Classes - -### [AbsoluteScrollStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/AbsoluteScrollStrategy) -On scroll reposition the overlay content. - -- **constructor**(scrollContainer?: HTMLElement): AbsoluteScrollStrategy -- **attach**(): void — Attaches the strategy -settings.scrollStrategy.attach(); -- **detach**(): void — Detaches the strategy -settings.scrollStrategy.detach(); -- **initialize**(document: Document, overlayService: IgxOverlayService, id: string): void — Initializes the strategy. Should be called once - -### [AutoPositionStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/AutoPositionStrategy) -Positions the element as in **Connected** positioning strategy and re-positions the element in -the view port (calculating a different start point) in case the element is partially getting out of view - -- **constructor**(settings?: PositionSettings): AutoPositionStrategy - -### [BaseFilteringStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/BaseFilteringStrategy) - -- **constructor**(): BaseFilteringStrategy -- **filter**(data: any[], expressionsTree: IFilteringExpressionsTree, advancedExpressionsTree?: IFilteringExpressionsTree, grid?: GridType): any[] -- **findMatchByExpression**(rec: any, expr: IFilteringExpression, isDate?: boolean, isTime?: boolean, grid?: GridType): boolean -- **getFilterItems**(column: ColumnType, tree: IFilteringExpressionsTree): Promise -- **matchRecord**(rec: any, expressions: IFilteringExpression | IFilteringExpressionsTree, grid?: GridType, entity?: string): boolean - -### [BlockScrollStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/BlockScrollStrategy) -Prevents scrolling while the overlay content is shown. - -- **constructor**(): BlockScrollStrategy -- **attach**(): void — Attaches the strategy -settings.scrollStrategy.attach(); -- **detach**(): void — Detaches the strategy -settings.scrollStrategy.detach(); -- **initialize**(document: Document): void — Initializes the strategy. Should be called once - -### [CachedDataCloneStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/CachedDataCloneStrategy) -Data clone strategy that is uses cache to deep clone primitive values, dates and objects. -It allows using circular references inside object. - -- **constructor**(): CachedDataCloneStrategy -- **clone**(data: any): any — Clones provided data - -### [Calendar](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/Calendar) - -- **constructor**(): Calendar -- **timedelta**(date: Date, interval: string, units: number): Date - -### [CarouselHammerConfig](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/CarouselHammerConfig) - -- **constructor**(): CarouselHammerConfig -- **overrides**: `any` — Maps gesture event names to a set of configuration options -that specify overrides to the default values for specific properties. - -The key is a supported event name to be configured, -and the options object contains a set of properties, with override values -to be applied to the named recognizer event. -For example, to disable recognition of the rotate event, specify - {"rotate": {"enable": false}}. - -Properties that are not present take the HammerJS default values. -For information about which properties are supported for which events, -and their allowed and default values, see -[HammerJS documentation](https://hammerjs.github.io/). - -### [CloseScrollStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/CloseScrollStrategy) -Uses a tolerance and closes the shown component upon scrolling if the tolerance is exceeded - -- **constructor**(scrollContainer?: HTMLElement): CloseScrollStrategy -- **attach**(): void — Attaches the strategy -settings.scrollStrategy.attach(); -- **detach**(): void — Detaches the strategy -settings.scrollStrategy.detach(); -- **initialize**(document: Document, overlayService: IgxOverlayService, id: string): void — Initializes the strategy. Should be called once - -### [ConnectedPositioningStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/ConnectedPositioningStrategy) -Positions the element based on the directions and start point passed in trough PositionSettings. -It is possible to either pass a start point or an HTMLElement as a positioning base. - -- **constructor**(settings?: PositionSettings): ConnectedPositioningStrategy -- **settings**: `PositionSettings` — PositionSettings to use when position the component in the overlay -- **clone**(): IPositionStrategy — Creates clone of this position strategy -- **position**(contentElement: HTMLElement, size: Size, document?: Document, initialCall?: boolean, target?: HTMLElement | Point): void — Position the element based on the PositionStrategy implementing this interface. - -### [ContainerPositionStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/ContainerPositionStrategy) -Positions the element inside the containing outlet based on the directions passed in trough PositionSettings. -These are Top/Middle/Bottom for verticalDirection and Left/Center/Right for horizontalDirection - -- **constructor**(settings?: PositionSettings): ContainerPositionStrategy -- **position**(contentElement: HTMLElement): void — Position the element based on the PositionStrategy implementing this interface. - -### [DefaultDataCloneStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/DefaultDataCloneStrategy) -Simplified data clone strategy that deep clones primitive values, dates and objects. -Does not support circular references in objects. - -- **constructor**(): DefaultDataCloneStrategy -- **clone**(data: any): any — Clones provided data - -### [DefaultPivotGridRecordSortingStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/DefaultPivotGridRecordSortingStrategy) - -- **sort**(data: any[], fieldName: string, dir: SortingDirection, ignoreCase: boolean, valueResolver: any, isDate?: boolean, isTime?: boolean, _grid?: PivotGridType): any[] -- static **instance**(): DefaultPivotGridRecordSortingStrategy - -### [DefaultPivotSortingStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/DefaultPivotSortingStrategy) - -- **sort**(data: any[], fieldName: string, dir: SortingDirection, ignoreCase: boolean, valueResolver: any, isDate?: boolean, isTime?: boolean, grid?: PivotGridType): any[] -- static **instance**(): DefaultPivotSortingStrategy - -### [DefaultSortingStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/DefaultSortingStrategy) - -- **compareValues**(a: any, b: any): number -- **sort**(data: any[], fieldName: string, dir: SortingDirection, ignoreCase: boolean, valueResolver: any, isDate?: boolean, isTime?: boolean): any[] -- static **instance**(): DefaultSortingStrategy - -### [DimensionValuesFilteringStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/DimensionValuesFilteringStrategy) - -- **constructor**(fields?: string[]): DimensionValuesFilteringStrategy -- **getFilterItems**(column: ColumnType, tree: IFilteringExpressionsTree): Promise - -### [ElasticPositionStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/ElasticPositionStrategy) -Positions the element as in **Connected** positioning strategy and resize the element -to fit in the view port in case the element is partially getting out of view - -- **constructor**(settings?: PositionSettings): ElasticPositionStrategy - -### [ExpressionsTreeUtil](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/ExpressionsTreeUtil) - -- **constructor**(): ExpressionsTreeUtil -- static **find**(tree: IFilteringExpressionsTree, fieldName: string): IFilteringExpression | IFilteringExpressionsTree — Returns the filtering expression for a column with the provided tree and fieldName. -let filteringExpression = ExpressionsTreeUtil.find(gridExpressionTree, 'Column Field'); -- static **findIndex**(tree: IFilteringExpressionsTree, fieldName: string): number — Returns the index of the filtering expression for a column with the provided tree and fieldName. -let filteringExpressionIndex = ExpressionsTreeUtil.findIndex(gridExpressionTree, 'Column Field'); - -### [FilteringExpressionsTree](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/FilteringExpressionsTree) - -- **constructor**(operator: FilteringLogic, fieldName?: string, entity?: string, returnFields?: string[]): FilteringExpressionsTree -- **entity**: `string` — Sets/gets the entity. -gridExpressionsTree.entity = 'Entity A'; - -let entity = gridExpressionsTree.entity; -- **fieldName**: `string` — Sets/gets the field name of the column where the filtering expression is placed. -gridExpressionTree.fieldName = 'Column Field'; - -let columnField = expressionTree.fieldName; -- **filteringOperands**: `IFilteringExpression | IFilteringExpressionsTree[]` — Sets/gets the filtering operands. -const gridExpressionsTree = new FilteringExpressionsTree(FilteringLogic.And); -const expression = [ -{ - condition: IgxStringFilteringOperand.instance().condition('contains'), - fieldName: 'Column Field', - searchVal: 'Value', - ignoreCase: false -}]; -gridExpressionsTree.filteringOperands.push(expression); -this.grid.filteringExpressionsTree = gridExpressionsTree; - -let filteringOperands = gridExpressionsTree.filteringOperands; -- **operator**: `FilteringLogic` — Sets/gets the operator. -gridExpressionsTree.operator = FilteringLogic.And; - -let operator = gridExpressionsTree.operator; -- **returnFields**: `string[]` — Sets/gets the return fields. -gridExpressionsTree.returnFields = ['Column Field 1', 'Column Field 2']; - -let returnFields = gridExpressionsTree.returnFields; -- **type**: `FilteringExpressionsTreeType` — Sets/gets the type of the filtering expressions tree. -gridExpressionTree.type = FilteringExpressionsTree.Advanced; - -let type = expressionTree.type; -- **find**(fieldName: string): IFilteringExpression | IFilteringExpressionsTree — Returns the filtering expression for a column with the provided fieldName. -let filteringExpression = gridExpressionTree.find('Column Field'); -- **findIndex**(fieldName: string): number — Returns the index of the filtering expression for a column with the provided fieldName. -let filteringExpressionIndex = gridExpressionTree.findIndex('Column Field'); -- static **empty**(expressionTree: IFilteringExpressionsTree): boolean — Checks if filtering expressions tree is empty. - -### [FilteringStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/FilteringStrategy) - -- **constructor**(): FilteringStrategy -- **filter**(data: T[], expressionsTree: IFilteringExpressionsTree, advancedExpressionsTree: IFilteringExpressionsTree, grid: GridType): T[] -- static **instance**(): FilteringStrategy - -### [FilterUtil](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/FilterUtil) - -- **constructor**(): FilterUtil -- static **filter**(data: T[], state: IFilteringState, grid?: GridType): T[] - -### [FormattedValuesFilteringStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/FormattedValuesFilteringStrategy) - -- **constructor**(fields?: string[]): FormattedValuesFilteringStrategy - -### [FormattedValuesSortingStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/FormattedValuesSortingStrategy) - -- **constructor**(): FormattedValuesSortingStrategy -- **sort**(data: any[], fieldName: string, dir: SortingDirection, ignoreCase: boolean, valueResolver: any, isDate?: boolean, isTime?: boolean, grid?: GridType): any[] -- static **instance**(): FormattedValuesSortingStrategy - -### [GlobalPositionStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/GlobalPositionStrategy) -Positions the element based on the directions passed in trough PositionSettings. -These are Top/Middle/Bottom for verticalDirection and Left/Center/Right for horizontalDirection - -- **constructor**(settings?: PositionSettings): GlobalPositionStrategy -- **settings**: `PositionSettings` — PositionSettings to use when position the component in the overlay -- **clone**(): IPositionStrategy — Clone the strategy instance. -settings.positionStrategy.clone(); -- **position**(contentElement: HTMLElement): void — Position the element based on the PositionStrategy implementing this interface. - -### [GroupMemberCountSortingStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/GroupMemberCountSortingStrategy) - -- **groupBy**(data: any, key: any): any -- **sort**(data: any[], fieldName: string, dir: SortingDirection): any[] -- static **instance**(): GroupMemberCountSortingStrategy - -### [IgcFormControlDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgcFormControlDirective) - -- **constructor**(elementRef: ElementRef, renderer: Renderer2): IgcFormControlDirective - -### [IgSizeDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgSizeDirective) - -- **constructor**(): IgSizeDirective -- **igSize**: `string` - -### [IgxAccordionComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxAccordionComponent) -IgxAccordion is a container-based component that contains that can house multiple expansion panels. - -- **constructor**(cdr: ChangeDetectorRef): IgxAccordionComponent -- **id**: `string` — Get/Set the id of the accordion component. -Default value is "igx-accordion-0"; - - -const accordionId = this.accordion.id; -- **panelCollapsed**: `EventEmitter` — Emitted after a panel has been collapsed. - - - -- **panelCollapsing**: `EventEmitter` — Emitted before a panel is collapsed. -- **panelExpanded**: `EventEmitter` — Emitted after a panel has been expanded. - - - - - -public handlePanelExpanded(event: IExpansionPanelCancelableEventArgs) { - const expandedPanel: IgxExpansionPanelComponent = event.panel; - console.log("Panel is expanded: ", expandedPanel.id); -} -- **panelExpanding**: `EventEmitter` — Emitted before a panel is expanded. -- **animationSettings**: `ToggleAnimationSettings` — Get/Set the animation settings that panels should use when expanding/collpasing. - - - - -const customAnimationSettings: ToggleAnimationSettings = { - openAnimation: growVerIn, - closeAnimation: growVerOut -}; - -this.accordion.animationSettings = customAnimationSettings; -- **panels**: `IgxExpansionPanelComponent[]` — Get all panels. - -const panels: IgxExpansionPanelComponent[] = this.accordion.panels; -- **singleBranchExpand**: `boolean` — Get/Set how the accordion handles the expansion of the projected expansion panels. -If set to true, only a single panel can be expanded at a time, collapsing all others - - -... - - - -this.accordion.singleBranchExpand = false; -- **collapseAll**(): void — Collapses all expanded expansion panels. - -accordion.collapseAll(); -- **expandAll**(): void — Expands all collapsed expansion panels. - -accordion.expandAll(); - -### [IgxActionStripComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxActionStripComponent) -Action Strip provides templatable area for one or more actions. - -- **constructor**(_viewContainer: ViewContainerRef, renderer: Renderer2, el: ElementRef): IgxActionStripComponent -- **context**: `any` — Sets the context of an action strip. -The context should be an instance of a @Component, that has element property. -This element will be the placeholder of the action strip. -- **hidden**: `boolean` — Gets/Sets the visibility of the Action Strip. -Could be used to set if the Action Strip will be initially hidden. -- **resourceStrings**: `IActionStripResourceStrings` -- **hide**(): void — Hiding the Action Strip and removing it from its current context element. -- **show**(context?: any): void — Showing the Action Strip and appending it the specified context element. - -### [IgxActionStripMenuItemDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxActionStripMenuItemDirective) - -- **constructor**(templateRef: TemplateRef): IgxActionStripMenuItemDirective -- **templateRef**: `TemplateRef` - -### [IgxAdvancedFilteringDialogComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxAdvancedFilteringDialogComponent) -A component used for presenting advanced filtering UI for a Grid. -It is used internally in the Grid, but could also be hosted in a container outside of it. - -Example: - - - -- **constructor**(cdr: ChangeDetectorRef, platform: PlatformUtil): IgxAdvancedFilteringDialogComponent -- **cdr**: `ChangeDetectorRef` -- **grid**: `GridType` — Returns the grid. - -### [IgxAppendDropStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxAppendDropStrategy) - -- **constructor**(_renderer: Renderer2): IgxAppendDropStrategy -- **dropAction**(drag: IgxDragDirective, drop: IgxDropDirective, _atIndex: number): void - -### [IgxAutocompleteDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxAutocompleteDirective) -**Ignite UI for Angular Autocomplete** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/autocomplete.html) - -The igxAutocomplete directive provides a way to enhance a text input -by showing a drop down of suggested options, provided by the developer. - -Example: - - - - {{town}} - - - -- **constructor**(ngModel: NgModel, formControl: FormControlName, group: IgxInputGroupComponent, elementRef: ElementRef, cdr: ChangeDetectorRef): IgxAutocompleteDirective -- **autocompleteSettings**: `AutocompleteOverlaySettings` — Provide overlay settings for the autocomplete drop down - -// get -let settings = this.autocomplete.autocompleteSettings; - - - - -// set -this.settings = { - positionStrategy: new ConnectedPositioningStrategy({ - closeAnimation: null, - openAnimation: null - }) -}; -- **disabled**: `boolean` — Enables/disables autocomplete component - -// get -let disabled = this.autocomplete.disabled; - - - - -// set -public disabled = true; -- **selectionChanging**: `EventEmitter` — Emitted after item from the drop down is selected - - -- **target**: `IgxDropDownComponent` — Sets the target of the autocomplete directive - - - -... - -... - -- **close**(): void — Closes autocomplete drop down -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **open**(): void — Opens autocomplete drop down - -### [IgxAvatarComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxAvatarComponent) -Avatar provides a way to display an image, icon or initials to the user. - -- **constructor**(elementRef: ElementRef): IgxAvatarComponent -- **ariaLabel**: `string` — Returns the aria-label attribute of the avatar. -- **bgColor**: `string` — Sets the background color of the avatar. -- **color**: `string` — Sets the color of the avatar's initials or icon. -- **elementRef**: `ElementRef` -- **icon**: `string` — Sets an icon to the avatar. All icons from the material icon set are supported. -- **id**: `string` — Sets the id of the avatar. If not set, the first avatar component will have id = "igx-avatar-0". -- **initials**: `string` — Sets initials to the avatar. -- **role**: `string` — Returns the role attribute of the avatar. -- **roleDescription**: `string` — Returns the type of the avatar. -The avatar can be: -- "initials type avatar" -- "icon type avatar" -- "image type avatar". -- "custom type avatar". -- **shape**: `"circle" | "rounded" | "square"` — Sets square, rounded or circular shape to the avatar. -By default the shape of the avatar is square. -- **size**: `string` — Returns the size of the avatar. -- **src**: `string` -- **type**: `IgxAvatarType` — Returns the type of the avatar. - -### [IgxBadgeComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxBadgeComponent) -Badge provides visual notifications used to decorate avatars, menus, etc. - -- **constructor**(): IgxBadgeComponent -- **cssClass**: `string` — Sets/gets the css class to use on the badge. -- **icon**: `string` — Sets/gets an icon for the badge from the material icons set. -- **iconSet**: `string` — The name of the icon set. Used in case the icon is from a different icon set. -- **id**: `string` — Sets/gets the id of the badge. -- **label**: `string` — Sets/gets the aria-label attribute value. -- **outlined**: `boolean` — Sets/gets whether the badge is outlined. -Default value is false. -- **role**: `string` — Sets/gets the role attribute value. -- **shape**: `"rounded" | "square"` — Sets a square shape to the badge, if shape is set to square. -By default the shape of the badge is rounded. -- **type**: `string` — Sets/gets the type of the badge. -- **value**: `string | number` — Sets/gets the value to be displayed inside the badge. -- **errorClass**: `boolean` -- **infoClass**: `boolean` -- **successClass**: `boolean` -- **warningClass**: `boolean` - -### [IgxBannerActionsDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxBannerActionsDirective) - -- **constructor**(): IgxBannerActionsDirective - -### [IgxBannerComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxBannerComponent) -**Ignite UI for Angular Banner** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/banner.html) - -The Ignite UI Banner provides a highly template-able and easy to use banner that can be shown in your application. - -Usage: - - - Our privacy settings have changed. - - - - - - -- **constructor**(elementRef: ElementRef): IgxBannerComponent -- **closed**: `EventEmitter` — Fires after the banner hides -public handleClosed(event) { - ... -} - - -- **closing**: `EventEmitter` — Fires before the banner hides -public handleClosing(event) { - ... -} - - -- **cssClass**: `string` -- **elementRef**: `ElementRef` -- **opened**: `EventEmitter` — Fires after the banner shows up -public handleOpened(event) { - ... -} - - -- **opening**: `EventEmitter` — Fires before the banner shows up -public handleOpening(event) { - ... -} - - -- **animationSettings**: `ToggleAnimationSettings` — Get the animation settings used by the banner open/close methods -let currentAnimations: ToggleAnimationSettings = banner.animationSettings -- **collapsed**: `boolean` — Gets whether the banner is collapsed. - -const isCollapsed: boolean = banner.collapsed; -- **element**: `HTMLElement` — Returns the native element of the banner component - const myBannerElement: HTMLElement = banner.element; -- **expanded**: `boolean` — Gets/Sets whether the banner is expanded (visible) or collapsed (hidden). -Defaults to false. -Setting to true opens the banner, while false closes it. -- **resourceStrings**: `IBannerResourceStrings` -- **close**(event?: Event): void — Closes the banner - - myBanner.close(); - - - -... - - -- **open**(event?: Event): void — Opens the banner - - myBanner.open(); - - - -... - - -- **toggle**(event?: Event): void — Toggles the banner - - myBanner.toggle(); - - - -... - - - -### [IgxBaseExporter](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxBaseExporter) - -- **constructor**(): IgxBaseExporter -- **columnExporting**: `EventEmitter` — This event is emitted when a column is exported. -this.exporterService.columnExporting.subscribe((args: IColumnExportingEventArgs) => { -// put event handler code here -}); -- **exportEnded**: `EventEmitter` -- **rowExporting**: `EventEmitter` — This event is emitted when a row is exported. -this.exporterService.rowExporting.subscribe((args: IRowExportingEventArgs) => { -// put event handler code here -}); -- **export**(grid: any, options: IgxExporterOptionsBase): void — Method for exporting IgxGrid component's data. -this.exporterService.export(this.igxGridForExport, this.exportOptions); -- **exportData**(data: any[], options: IgxExporterOptionsBase): void — Method for exporting any kind of array data. -this.exporterService.exportData(this.arrayForExport, this.exportOptions); - -### [IgxBaseTransactionService](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxBaseTransactionService) - -- **constructor**(): IgxBaseTransactionService -- **onStateUpdate**: `EventEmitter` — Event fired when transaction state has changed - add transaction, commit all transactions, undo and redo -- **canRedo**: `boolean` -- **canUndo**: `boolean` -- **cloneStrategy**: `IDataCloneStrategy` — Gets/Sets the data clone strategy used to clone data -- **enabled**: `boolean` — Returns whether transaction is enabled for this service -- **add**(transaction: T, recordRef?: any): void — Adds provided transaction with recordRef if any -- **clear**(_id?: any): void — Clears all transactions -- **commit**(_data: any[], _id?: any): void — Applies all transactions over the provided data -- **endPending**(_commit: boolean): void — Clears all pending transactions and aggregated pending state. If commit is set to true -commits pending states as single transaction -- **getAggregatedChanges**(mergeChanges: boolean): T[] — Returns aggregated changes from all transactions -- **getAggregatedValue**(id: any, mergeChanges: boolean): any — Returns value of the required id including all uncommitted changes -- **getState**(id: any): S — Returns the state of the record with provided id -- **getTransactionLog**(_id?: any): T[] — Returns all recorded transactions in chronological order -- **redo**(): void — Applies the last undone transaction if any -- **startPending**(): void — Starts pending transactions. All transactions passed after call to startPending -will not be added to transaction log -- **undo**(): void — Remove the last transaction if any - -### [IgxBooleanFilteringOperand](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxBooleanFilteringOperand) -Provides filtering operations for booleans - - -### [IgxBottomNavComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxBottomNavComponent) -Bottom Navigation component enables the user to navigate among a number of contents displayed in a single view. - - -### [IgxBottomNavContentComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxBottomNavContentComponent) - - -### [IgxBottomNavHeaderComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxBottomNavHeaderComponent) - - -### [IgxBottomNavHeaderIconDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxBottomNavHeaderIconDirective) - -- **constructor**(): IgxBottomNavHeaderIconDirective - -### [IgxBottomNavHeaderLabelDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxBottomNavHeaderLabelDirective) - -- **constructor**(): IgxBottomNavHeaderLabelDirective - -### [IgxBottomNavItemComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxBottomNavItemComponent) - - -### [IgxButtonDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxButtonDirective) -The Button directive provides the Ignite UI Button functionality to every component that's intended to be used as a button. - -- **constructor**(element: ElementRef, _renderer: Renderer2): IgxButtonDirective -- **buttonSelected**: `EventEmitter` — Called when the button is selected. -- **label**: `string` -- **selected**: `boolean` -- **type**: `IgxButtonType` - -### [IgxButtonGroupComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxButtonGroupComponent) -**Ignite UI for Angular Button Group** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/buttongroup.html) - -The Ignite UI Button Group displays a group of buttons either vertically or horizontally. The group supports -single, multi and singleRequired selection. - -Example: - - - -The fontOptions value shown above is defined as: -this.fontOptions = [ - { icon: 'format_bold', selected: false }, - { icon: 'format_italic', selected: false }, - { icon: 'format_underlined', selected: false }]; - -- **constructor**(_cdr: ChangeDetectorRef, _renderer: Renderer2, _el: ElementRef): IgxButtonGroupComponent -- **deselected**: `EventEmitter` — An -- **id**: `string` — Gets/Sets the value of the id attribute. If not set it will be automatically generated. - -- **selected**: `EventEmitter` — An -- **values**: `any` — Property that configures the buttons in the button group using a collection of Button objects. - public ngOnInit() { - this.cities = [ - new Button({ - label: "Sofia" - }), - new Button({ - label: "London" - }), - new Button({ - label: "New York", - selected: true - }), - new Button({ - label: "Tokyo" - }) - ]; - } - //.. - - -- **alignment**: `ButtonGroupAlignment` — Returns the alignment of the igx-buttongroup. -@ViewChild("MyChild") -public buttonG: IgxButtonGroupComponent; -ngAfterViewInit(){ - let buttonAlignment = this.buttonG.alignment; -} -- **buttons**: `IgxButtonDirective[]` — A collection containing all buttons inside the button group. -- **disabled**: `boolean` — Disables the igx-buttongroup component. By default it's false. - -- **isVertical**: `boolean` — Returns true if the igx-buttongroup alignment is vertical. -Note that in order for the accessor to work correctly the property should be set explicitly. - - -//... -@ViewChild("MyChild") -private buttonG: IgxButtonGroupComponent; -ngAfterViewInit(){ - let orientation = this.buttonG.isVertical; -} -- **itemContentCssClass**: `string` — Returns the CSS class of the item content of the IgxButtonGroup. - @ViewChild("MyChild") -public buttonG: IgxButtonGroupComponent; -ngAfterViewInit(){ - let buttonSelect = this.buttonG.itemContentCssClass; -} -- **multiSelection**: `boolean` — Enables selecting multiple buttons. By default, multi-selection is false. -- **selectedButtons**: `IgxButtonDirective[]` — Gets the selected button/buttons. -@ViewChild("MyChild") -private buttonG: IgxButtonGroupComponent; -ngAfterViewInit(){ - let selectedButton = this.buttonG.selectedButtons; -} -- **selectionMode**: `"single" | "multi" | "singleRequired"` — Gets/Sets the selection mode to 'single', 'singleRequired' or 'multi' of the buttons. By default, the selection mode is 'single'. - -- **deselectButton**(index: number): void — Deselects a button by its index. -@ViewChild("MyChild") -private buttonG: IgxButtonGroupComponent; -ngAfterViewInit(){ - this.buttonG.deselectButton(2); - this.cdr.detectChanges(); -} -- **selectButton**(index: number): void — Selects a button by its index. -@ViewChild("MyChild") -private buttonG: IgxButtonGroupComponent; -ngAfterViewInit(){ - this.buttonG.selectButton(2); - this.cdr.detectChanges(); -} -- **updateDeselected**(index: number): void - -### [IgxCalendarComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCalendarComponent) -Calendar provides a way to display date information. - -- **hasHeader**: `boolean` — Sets/gets whether the calendar has header. -Default value is true. -- **headerOrientation**: `"horizontal" | "vertical"` -- **id**: `string` — Sets/gets the id of the calendar. -- **orientation**: `"horizontal" | "vertical"` -- **showWeekNumbers**: `boolean` — Show/hide week numbers -- **vertical**: `boolean` — Sets/gets whether the calendar header will be in vertical position. -Default value is false. -- **context**: `any` — Gets the context for the template marked with either igxCalendarSubHeaderMonth -or igxCalendarSubHeaderYear directive. -- **headerContext**: `any` — Gets the context for the template marked with the igxCalendarHeader directive. -- **headerTemplate**: `any` — Gets the header template. -- **headerTitleTemplate**: `any` — Gets the header template. -- **monthsViewNumber**: `number` — Sets/gets the number of month views displayed. -Default value is 1. -- **subheaderTemplate**: `any` — Gets the subheader template. -- **deselectDate**(value?: string | Date | Date[]): void — Deselects date(s) (based on the selection type). -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **updateActiveDescendant**(date: Date): void - -### [IgxCalendarMonthDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCalendarMonthDirective) - -- **constructor**(elementRef: ElementRef): IgxCalendarMonthDirective -- **isActive**: `boolean` -- **isCurrent**: `boolean` -- **isSelected**: `boolean` - -### [IgxCalendarViewBaseDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCalendarViewBaseDirective) - -- **constructor**(elementRef: ElementRef): IgxCalendarViewBaseDirective -- **date**: `Date` -- **elementRef**: `ElementRef` -- **itemSelection**: `EventEmitter` -- **showActive**: `boolean` -- **value**: `Date` -- **isActive**: `boolean` -- **isCurrent**: `boolean` -- **isSelected**: `boolean` -- **nativeElement**: `any` -- **onMouseDown**(event: MouseEvent): void - -### [IgxCardActionsComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCardActionsComponent) -IgxCardActions is container for the card actions. - -- **constructor**(card: IgxCardComponent): IgxCardActionsComponent -- **card**: `IgxCardComponent` -- **layout**: `string` — Sets the layout style of the actions. -You can justify the elements slotted in the igx-card-action container -so that they are positioned equally from one another taking up all the -space available along the card actions axis. -- **vertical**: `boolean` — Sets the vertical attribute of the actions. -When set to true the actions will be layed out vertically. -- **isJustifyLayout**: `boolean` — A getter that returns true when the layout has been -set to justify. - -### [IgxCardComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCardComponent) -Card provides a way to display organized content in appealing way. - -- **constructor**(): IgxCardComponent -- **elevated**: `boolean` — Sets/gets whether the card is elevated. -Default value is false. -- **horizontal**: `boolean` — Sets the value of the horizontal attribute of the card. -Setting this to true will make the different card sections align horizontally, -essentially flipping the card to the side. -- **id**: `string` — Sets/gets the id of the card. -If not set, id will have value "igx-card-0"; -- **role**: `string` — Sets the value of the role attribute of the card. -By default the value is set to group. - -### [IgxCardContentDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCardContentDirective) -IgxCardContent is container for the card content. - -- **constructor**(): IgxCardContentDirective - -### [IgxCardFooterDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCardFooterDirective) -IgxCardFooter is container for the card footer - -- **constructor**(): IgxCardFooterDirective -- **role**: `string` — Sets the value of the role attribute of the card footer. -By default the value is set to footer. - -### [IgxCardHeaderComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCardHeaderComponent) -IgxCardHeader is container for the card header - -- **constructor**(): IgxCardHeaderComponent -- **vertical**: `boolean` — Sets the layout style of the header. -By default the header elements(thumbnail and title/subtitle) are aligned horizontally. - -### [IgxCardHeaderSubtitleDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCardHeaderSubtitleDirective) -igxCardHeaderSubtitle is used to denote the header subtitle in a card. -Use it to tag text nodes. - -- **constructor**(): IgxCardHeaderSubtitleDirective - -### [IgxCardHeaderTitleDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCardHeaderTitleDirective) -igxCardHeaderTitle is used to denote the header title in a card. -Use it to tag text nodes. - -- **constructor**(): IgxCardHeaderTitleDirective - -### [IgxCardMediaDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCardMediaDirective) -IgxCardMedia is container for the card media section. -Use it to wrap images and videos. - -- **constructor**(): IgxCardMediaDirective -- **height**: `string` — Sets the height style property of the media container. -If not provided it will be set to auto. -- **role**: `string` — Sets the role attribute of the media container. -- **width**: `string` — Sets the width and min-width style property -of the media container. If not provided it will be set to auto. - -### [IgxCardThumbnailDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCardThumbnailDirective) -IgxCardThumbnail is container for the card thumbnail section. -Use it to wrap anything you want to be used as a thumbnail. - -- **constructor**(): IgxCardThumbnailDirective - -### [IgxCarouselComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCarouselComponent) -**Ignite UI for Angular Carousel** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/carousel.html) - -The Ignite UI Carousel is used to browse or navigate through a collection of slides. Slides can contain custom -content such as images or cards and be used for things such as on-boarding tutorials or page-based interfaces. -It can be used as a separate fullscreen element or inside another component. - -Example: - - -

First Slide Header

-

First slide Content

- - -

Second Slide Header

-

Second Slide Content

- - -- **constructor**(cdr: ChangeDetectorRef, element: ElementRef, iterableDiffers: IterableDiffers, animationService: AnimationService, platformUtil: PlatformUtil, dir: IgxDirectionality, document: any): IgxCarouselComponent -- **animationType**: `CarouselAnimationType` — Gets/sets the animation type of carousel. -Default value is slide. - - -- **carouselPaused**: `EventEmitter` — An event that is emitted after the carousel has been paused. -Provides a reference to the IgxCarouselComponent as an event argument. - -- **carouselPlaying**: `EventEmitter` — An event that is emitted after the carousel has resumed transitioning between slides. -Provides a reference to the IgxCarouselComponent as an event argument. - -- **cssClass**: `string` — Returns the class of the carousel component. -let class = this.carousel.cssClass; -- **gesturesSupport**: `boolean` — Controls whether the carousel should support gestures. -Default value is true. - -- **id**: `string` — Sets the id of the carousel. -If not set, the id of the first carousel component will be "igx-carousel-0". - -- **indicators**: `boolean` — Controls whether the carousel should render the indicators. -Default value is true. - -- **indicatorsOrientation**: `CarouselIndicatorsOrientation` — Gets/sets the display mode of carousel indicators. It can be start or end. -Default value is end. - - -- **indicatorTemplate**: `TemplateRef` — The custom template, if any, that should be used when rendering carousel indicators - -// Set in typescript -const myCustomTemplate: TemplateRef = myComponent.customTemplate; -myComponent.carousel.indicatorTemplate = myCustomTemplate; - - - - ... - - brightness_7 - brightness_5 - - -- **loop**: `boolean` — Sets whether the carousel should loop back to the first slide after reaching the last slide. -Default value is true. - -- **maximumIndicatorsCount**: `number` — Controls the maximum indexes that can be shown. -Default value is 10. - -- **navigation**: `boolean` — Controls whether the carousel should render the left/right navigation buttons. -Default value is true. - -- **nextButtonTemplate**: `TemplateRef` — The custom template, if any, that should be used when rendering carousel next button - -// Set in typescript -const myCustomTemplate: TemplateRef = myComponent.customTemplate; -myComponent.carousel.nextButtonTemplate = myCustomTemplate; - - - - ... - - - - -- **pause**: `boolean` — Sets whether the carousel will pause the slide transitions on user interactions. -Default value is true. - -- **prevButtonTemplate**: `TemplateRef` — The custom template, if any, that should be used when rendering carousel previous button - -// Set in typescript -const myCustomTemplate: TemplateRef = myComponent.customTemplate; -myComponent.carousel.prevButtonTemplate = myCustomTemplate; - - - - ... - - - - -- **role**: `string` — Returns the role attribute of the carousel. -let carouselRole = this.carousel.role; -- **slideAdded**: `EventEmitter` — An event that is emitted after a slide has been added to the carousel. -Provides references to the IgxCarouselComponent and IgxSlideComponent as event arguments. - -- **slideChanged**: `EventEmitter` — An event that is emitted after a slide transition has happened. -Provides references to the IgxCarouselComponent and IgxSlideComponent as event arguments. - -- **slideRemoved**: `EventEmitter` — An event that is emitted after a slide has been removed from the carousel. -Provides references to the IgxCarouselComponent and IgxSlideComponent as event arguments. - -- **slides**: `QueryList` — The collection of slides currently in the carousel. -let slides: QueryList = this.carousel.slides; -- **vertical**: `boolean` — Controls whether the carousel has vertical alignment. -Default value is false. - -- **current**: `number` — The index of the slide being currently shown. -let currentSlideNumber = this.carousel.current; -- **interval**: `number` — Returns the time interval in milliseconds before the slide changes. -let timeInterval = this.carousel.interval; -- **isDestroyed**: `boolean` — Returns а boolean indicating if the carousel is destroyed. -let isDestroyed = this.carousel.isDestroyed; -- **isPlaying**: `boolean` — Returns a boolean indicating if the carousel is playing. -let isPlaying = this.carousel.isPlaying; -- **nativeElement**: `any` — Returns a reference to the carousel element in the DOM. -let nativeElement = this.carousel.nativeElement; -- **resourceStrings**: `ICarouselResourceStrings` — An accessor that returns the resource strings. -- **total**: `number` — Returns the total number of slides in the carousel. -let slideCount = this.carousel.total; -- **touchAction**: `"auto" | "pan-y"` — Gets the touch-action style of the list item. -let touchAction = this.listItem.touchAction; -- **add**(slide: IgxSlideComponent): void — Adds a new slide to the carousel. -this.carousel.add(newSlide); -- **get**(index: number): IgxSlideComponent — Returns the slide corresponding to the provided index or null. -let slide1 = this.carousel.get(1); -- **next**(): void — Transitions to the next slide in the carousel. -this.carousel.next(); -- **play**(): void — Resumes playing of the carousel if in paused state. -No operation otherwise. -this.carousel.play(); -} -- **prev**(): void — Transitions to the previous slide in the carousel. -this.carousel.prev(); -- **remove**(slide: IgxSlideComponent): void — Removes a slide from the carousel. -this.carousel.remove(slide); -- **select**(slide: IgxSlideComponent, direction: Direction): void — Kicks in a transition for a given slide with a given direction. -this.carousel.select(this.carousel.get(2), Direction.NEXT); -- **stop**(): void — Stops slide transitions if the pause option is set to true. -No operation otherwise. - this.carousel.stop(); -} - -### [IgxCarouselIndicatorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCarouselIndicatorDirective) - -- **constructor**(): IgxCarouselIndicatorDirective - -### [IgxCarouselNextButtonDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCarouselNextButtonDirective) - -- **constructor**(): IgxCarouselNextButtonDirective - -### [IgxCarouselPrevButtonDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCarouselPrevButtonDirective) - -- **constructor**(): IgxCarouselPrevButtonDirective - -### [IgxCellEditorTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCellEditorTemplateDirective) - -- **constructor**(template: TemplateRef): IgxCellEditorTemplateDirective -- **template**: `TemplateRef` -- static **ngTemplateContextGuard**(_directive: IgxCellEditorTemplateDirective, context: unknown): context - -### [IgxCellHeaderTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCellHeaderTemplateDirective) - -- **constructor**(template: TemplateRef): IgxCellHeaderTemplateDirective -- **template**: `TemplateRef` -- static **ngTemplateContextGuard**(_directive: IgxCellHeaderTemplateDirective, context: unknown): context - -### [IgxCellTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCellTemplateDirective) - -- **constructor**(template: TemplateRef): IgxCellTemplateDirective -- **template**: `TemplateRef` -- static **ngTemplateContextGuard**(_directive: IgxCellTemplateDirective, context: unknown): context - -### [IgxCellValidationErrorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCellValidationErrorDirective) - -- **constructor**(template: TemplateRef): IgxCellValidationErrorDirective -- **template**: `TemplateRef` -- static **ngTemplateContextGuard**(_directive: IgxCellValidationErrorDirective, context: unknown): context - -### [IgxCheckboxComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCheckboxComponent) -Allows users to make a binary choice for a certain condition. - -- **constructor**(cdr: ChangeDetectorRef, themeToken: ThemeToken, ngControl: NgControl): IgxCheckboxComponent -- **cssClass**: `string` — Returns the class of the checkbox component. -- **disabled**: `boolean` — Sets/gets whether the checkbox is disabled. -Default value is false. -- **disableTransitions**: `boolean` — Sets/gets whether the checkbox should disable all css transitions. -Default value is false. -- **focused**: `boolean` — Sets/gets whether the checkbox component is on focus. -Default value is false. -- **indeterminate**: `boolean` — Sets/gets the checkbox indeterminate visual state. -Default value is false; -- **invalid**: `boolean` — Sets/gets whether the checkbox is invalid. -Default value is false. -- **readonly**: `boolean` — Sets/gets whether the checkbox is readonly. -Default value is false. -- **checked**: `boolean` - -### [IgxChipComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxChipComponent) -Chip is compact visual component that displays information in an obround. - -- **constructor**(cdr: ChangeDetectorRef, ref: ElementRef, renderer: Renderer2, document: any): IgxChipComponent -- **animateOnRelease**: `boolean` — Enables/disables the draggable element animation when the element is released. -By default it's set to true. -- **cdr**: `ChangeDetectorRef` -- **chipClick**: `EventEmitter` — Emits an event when the IgxChipComponent is clicked. -Returns the clicked IgxChipComponent, whether the event should be canceled. -- **data**: `any` — Stores data related to the chip. -- **disabled**: `boolean` — Disables the IgxChipComponent. When disabled it restricts user interactions -like focusing on click or tab, selection on click or Space, dragging. -By default it is set to false. -- **document**: `any` -- **dragDirective**: `IgxDragDirective` — Property that contains a reference to the IgxDragDirective the IgxChipComponent uses for dragging behavior. -- **dragDrop**: `EventEmitter` — Emits an event when the IgxChipComponent has been dropped in the IgxChipsAreaComponent. -Returns the target IgxChipComponent, the drag IgxChipComponent, as well as -the original drop event arguments. -- **dragEnter**: `EventEmitter` — Emits an event when the IgxChipComponent has entered the IgxChipsAreaComponent. -Returns the target IgxChipComponent, the drag IgxChipComponent, as well as -the original drop event arguments. -- **draggable**: `boolean` — Defines if the IgxChipComponent can be dragged in order to change it's position. -By default it is set to false. -- **dragLeave**: `EventEmitter` — Emits an event when the IgxChipComponent has left the IgxChipsAreaComponent. -Returns the target IgxChipComponent, the drag IgxChipComponent, as well as -the original drop event arguments. -- **dragOver**: `EventEmitter` — Emits an event when the IgxChipComponent is over the IgxChipsAreaComponent. -Returns the target IgxChipComponent, the drag IgxChipComponent, as well as -the original drop event arguments. -- **hideBaseOnDrag**: `boolean` — Enables/disables the hiding of the base element that has been dragged. -By default it's set to true. -- **id**: `string` — Sets the value of id attribute. If not provided it will be automatically generated. -- **keyDown**: `EventEmitter` — Emits an event when the IgxChipComponent keyboard navigation is being used. -Returns the focused/selected IgxChipComponent, whether the event should be canceled, -if the alt, shift or control key is pressed and the pressed key name. -- **moveEnd**: `EventEmitter` — Emits an event when the IgxChipComponent moving ends. -Returns the moved IgxChipComponent. -- **moveStart**: `EventEmitter` — Emits an event when the IgxChipComponent moving starts. -Returns the moving IgxChipComponent. -- **removable**: `boolean` — Defines if the IgxChipComponent should render remove button and throw remove events. -By default it is set to false. -- **remove**: `EventEmitter` — Emits an event when the IgxChipComponent is removed. -Returns the removed IgxChipComponent. -- **removeIcon**: `TemplateRef` — Overrides the default icon that the chip applies to the remove button. -- **role**: `string` — Returns the role attribute of the chip. -- **selectable**: `boolean` — Defines if the IgxChipComponent can be selected on click or through navigation, -By default it is set to false. -- **selectedChanged**: `EventEmitter` — Emits event when the IgxChipComponent is selected/deselected and any related animations and transitions also end. -- **selectedChanging**: `EventEmitter` — Emits event when the IgxChipComponent is selected/deselected. -Returns the selected chip reference, whether the event should be canceled, what is the next selection state and -when the event is triggered by interaction originalEvent is provided, otherwise originalEvent is null. -- **selectIcon**: `TemplateRef` — Overrides the default icon that the chip applies when it is selected. -- **variant**: `string | any` — Sets/gets the variant of the chip. -- **color**: `any` — Returns the background color of the IgxChipComponent. -- **resourceStrings**: `IChipResourceStrings` — An accessor that returns the resource strings. -- **selected**: `boolean` — Returns if the IgxChipComponent is selected. -- **tabIndex**: `number` -- **ngOnDestroy**(): void — A callback method that performs custom clean-up, invoked immediately -before a directive, pipe, or service instance is destroyed. -- **ngOnInit**(): void — 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. -- **onRemoveMouseDown**(event: PointerEvent | MouseEvent): void -- **onSelectTransitionDone**(event: any): void - -### [IgxChipsAreaComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxChipsAreaComponent) -The chip area allows you to perform more complex scenarios with chips that require interaction, -like dragging, selection, navigation, etc. - -- **constructor**(cdr: ChangeDetectorRef, element: ElementRef, _iterableDiffers: IterableDiffers): IgxChipsAreaComponent -- **ariaLabel**: `string` — Returns the aria-label attribute of the chips area. -- **cdr**: `ChangeDetectorRef` -- **chipsList**: `QueryList` — Holds the IgxChipComponent in the IgxChipsAreaComponent. -- **element**: `ElementRef` -- **height**: `number` — Sets the height of the IgxChipsAreaComponent. -- **moveEnd**: `EventEmitter` — Emits an event after an IgxChipComponent in the IgxChipsAreaComponent is moved. -- **moveStart**: `EventEmitter` — Emits an event when an IgxChipComponent in the IgxChipsAreaComponent is moved. -- **reorder**: `EventEmitter` — Emits an event when IgxChipComponents in the IgxChipsAreaComponent should be reordered. -Returns an array of IgxChipComponents. -- **role**: `string` — Returns the role attribute of the chips area. -- **selectionChange**: `EventEmitter` — Emits an event when an IgxChipComponent in the IgxChipsAreaComponent is selected/deselected. -Fired after the chips area is initialized if there are initially selected chips as well. -Returns an array of selected IgxChipComponents and the IgxChipAreaComponent. -- **width**: `number` — Sets the width of the IgxChipsAreaComponent. - -### [IgxCircularProgressBarComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCircularProgressBarComponent) - -- **constructor**(renderer: Renderer2): IgxCircularProgressBarComponent -- **gradientTemplate**: `IgxProgressBarGradientDirective` -- **id**: `string` — Sets the value of id attribute. If not provided it will be automatically generated. - -- **textTemplate**: `IgxProgressBarTextTemplateDirective` -- **textVisibility**: `boolean` — Sets the text visibility. By default, it is set to true. - -- **type**: `string` — Set type of the IgxCircularProgressBarComponent. Possible options - default, success, info, warning, and error. - -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. - -### [IgxCollapsibleIndicatorTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCollapsibleIndicatorTemplateDirective) - -- **constructor**(template: TemplateRef): IgxCollapsibleIndicatorTemplateDirective -- **template**: `TemplateRef` -- static **ngTemplateContextGuard**(_directive: IgxCollapsibleIndicatorTemplateDirective, context: unknown): context - -### [IgxColumnActionsBaseDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxColumnActionsBaseDirective) - -- **constructor**(): IgxColumnActionsBaseDirective - -### [IgxColumnActionsComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxColumnActionsComponent) -Providing reference to IgxColumnActionsComponent: - @ViewChild('columnActions', { read: IgxColumnActionsComponent }) - public columnActions: IgxColumnActionsComponent; - -- **constructor**(differs: IterableDiffers): IgxColumnActionsComponent -- **columnItems**: `QueryList` — Gets the checkbox components representing column items currently present in the dropdown -- **columnsAreaMaxHeight**: `string` — Gets/sets the max height of the columns area. -- **columnToggled**: `EventEmitter` — An event that is emitted after a column's checked state is changed. -Provides references to the column and the checked properties as event arguments. - -- **cssClass**: `string` — Sets/Gets the css class selector. -By default the value of the class attribute is "igx-column-actions". -let cssCLass = this.columnHidingUI.cssClass; - -this.columnHidingUI.cssClass = 'column-chooser'; -- **grid**: `GridType` — Gets/Sets the grid to provide column actions for. -- **hideFilter**: `boolean` — Shows/hides the columns filtering input from the UI. -- **indentation**: `number` — Gets/sets the indentation of columns in the column list based on their hierarchy level. -- **title**: `string` — Gets/sets the title of the column actions component. -- **checkAllText**: `string` — Gets the text of the button that checks all columns. -- **columnDisplayOrder**: `ColumnDisplayOrder` — Gets the display order of the columns. -- **filterColumnsPrompt**: `string` — Gets the prompt that is displayed in the filter input. -- **filterCriteria**: `string` — Gets the value which filters the columns list. -- **id**: `string` — Gets/Sets the value of the id attribute. -- **uncheckAllText**: `string` — Gets the text of the button that unchecks all columns. -- **checkAllColumns**(): void — Checks all columns and performs the appropriate action. -- **uncheckAllColumns**(): void — Unchecks all columns and performs the appropriate action. - -### [IgxColumnComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxColumnComponent) -**Ignite UI for Angular Column** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/grid#columns-configuration) - -The Ignite UI Column is used within an igx-grid element to define what data the column will show. Features such as sorting, -filtering & editing are enabled at the column level. You can also provide a template containing custom content inside -the column using ng-template which will be used for all cells within the column. - -- **constructor**(grid: GridType, _validators: Validator[], platform: PlatformUtil): IgxColumnComponent -- **additionalTemplateContext**: `any` — Sets/gets custom properties provided in additional template context. - - - - {{ props }} - - -- **autosizeHeader**: `boolean` — Sets/gets whether the column header is included in autosize logic. -Useful when template for a column header is sized based on parent, for example a default div. -Default value is false. -let isResizable = this.column.resizable; - - -- **cellClasses**: `any` — Sets a conditional class selector of the column cells. -Accepts an object literal, containing key-value pairs, -where the key is the name of the CSS class, while the -value is either a callback function that returns a boolean, -or boolean, like so: -callback = (rowData, columnKey, cellValue, rowIndex) => { return rowData[columnKey] > 6; } -cellClasses = { 'className' : this.callback }; - - - -- **cellStyles**: `any` — Sets conditional style properties on the column cells. -Similar to ngStyle it accepts an object literal where the keys are -the style properties and the value is the expression to be evaluated. -As with cellClasses it accepts a callback function. -styles = { - background: 'royalblue', - color: (rowData, columnKey, cellValue, rowIndex) => value.startsWith('Important') ? 'red': 'inherit' -} - - -- **children**: `QueryList` — Sets/gets the children columns. -let columnChildren = this.column.children; -- **colEnd**: `number` — Column index where the current field should end. -The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field - - - -- **colStart**: `number` — Column index from which the field is starting. - - - -- **dataType**: `GridColumnDataType` — Sets/gets the data type of the column values. -Default value is string. -let columnDataType = this.column.dataType; - - -- **disableHiding**: `boolean` — Gets whether the hiding is disabled. -let isHidingDisabled = this.column.disableHiding; -- **disablePinning**: `boolean` — Gets whether the pinning is disabled. -let isPinningDisabled = this.column.disablePinning; -- **expandedChange**: `EventEmitter` — Emitted when the column expanded or collapsed. - - - -- **filterable**: `boolean` — Sets/gets whether the column is filterable. -Default value is true. -let isFilterable = this.column.filterable; - - -- **filteringIgnoreCase**: `boolean` — Sets/gets whether the column filtering should be case sensitive. -Default value is true. -let filteringIgnoreCase = this.column.filteringIgnoreCase; - - -- **formatter**: `any` — Applies display format to cell values in the column. Does not modify the underlying data. -- **grid**: `GridType` — Represents the instance of the parent GridType that contains this column. -- **header**: `string` — Sets/gets the header value. -let columnHeader = this.column.header; - - -- **headerClasses**: `string` — Sets/gets the class selector of the column header. -let columnHeaderClass = this.column.headerClasses; - - -- **headerGroupClasses**: `string` — Sets/gets the class selector of the column group header. -let columnHeaderClass = this.column.headerGroupClasses; - - -- **headerGroupStyles**: `any` — Sets conditional style properties on the column header group wrapper. -Similar to ngStyle it accepts an object literal where the keys are -the style properties and the value is the expression to be evaluated. -styles = { - background: 'royalblue', - color: (column) => column.pinned ? 'red': 'inherit' -} - - -- **headerStyles**: `any` — Sets conditional style properties on the column header. -Similar to ngStyle it accepts an object literal where the keys are -the style properties and the value is the expression to be evaluated. -styles = { - background: 'royalblue', - color: (column) => column.pinned ? 'red': 'inherit' -} - - -- **hiddenChange**: `EventEmitter` — Emitted when the column is hidden or shown. - - - -- **parent**: `any` — Sets/gets the parent column. -let parentColumn = this.column.parent; - -this.column.parent = higherLevelColumn; -- **pinnedChange**: `EventEmitter` — Emitted when the column is pinned/unpinned. - - - -- **resizable**: `boolean` — Sets/gets whether the column is resizable. -Default value is false. -let isResizable = this.column.resizable; - - -- **rowEnd**: `number` — Row index where the current field should end. -The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field - - - -- **rowStart**: `number` — Row index from which the field is starting. - - - -- **searchable**: `boolean` — Sets/gets whether the column is searchable. -Default value is true. -let isSearchable = this.column.searchable'; - - -- **sortable**: `boolean` — Sets/gets whether the column is sortable. -Default value is false. -let isSortable = this.column.sortable; - - -- **sortingIgnoreCase**: `boolean` — Sets/gets whether the column sorting should be case sensitive. -Default value is true. -let sortingIgnoreCase = this.column.sortingIgnoreCase; - - -- **summaryFormatter**: `any` — The summaryFormatter is used to format the display of the column summaries. - -In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter -to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers. - -columnInit(column: IgxColumnComponent) { - if (column.field == "OrderDate") { - column.summaryFormatter = this.summaryFormat; - } -} - -summaryFormat(summary: IgxSummaryResult, summaryOperand: IgxSummaryOperand): string { - const result = summary.summaryResult; - if(summaryResult.key !== 'count' && result !== null && result !== undefined) { - const pipe = new DatePipe('fr-FR'); - return pipe.transform(result,'mediumDate'); - } - return result; -} -- **title**: `string` — Sets/gets the title value. -let title = this.column.title; - - -- **widthChange**: `EventEmitter` — Emitted when the column width changes. - - - -- **bodyTemplate**: `TemplateRef` — Returns a reference to the bodyTemplate. -let bodyTemplate = this.column.bodyTemplate; -- **childColumns**: `ColumnType[]` — A list containing all the child columns under this column (if any). -Empty without children or if this column is not Group or Layout. -- **collapsible**: `boolean` — Optional -Indicated whether the column can be collapsed. If the value is true, the column can be collapsed -It is used in tree grid and for navigation -- **columnGroup**: `boolean` — Specifies whether the column belongs to a group of columns. -- **columnLayout**: `boolean` — Returns a boolean indicating if the column is a ColumnLayout for multi-row layout. -let columnGroup = this.column.columnGroup; -- **columnLayoutChild**: `boolean` — Returns a boolean indicating if the column is a child of a ColumnLayout for multi-row layout. -let columnLayoutChild = this.column.columnLayoutChild; -- **disabledSummaries**: `string[]` — Sets/gets the summary operands to exclude from display. -Accepts an array of string keys representing the summary types to disable, such as 'Min', 'Max', 'Count' etc. -let disabledSummaries = this.column.disabledSummaries; - - -- **editable**: `boolean` — Indicated whether the column can be edited. If the value is true, the column can be edited -- **editorOptions**: `IColumnEditorOptions` — Sets properties on the default column editors -- **errorTemplate**: `TemplateRef` — Returns a reference to the validation error template. -let errorTemplate = this.column.errorTemplate; -- **expanded**: `boolean` — Indicates if the column is currently expanded or collapsed. If the value is true, the column is expanded -- **field**: `string` — The internal field name, used in expressions and queries. -- **filterCellTemplate**: `TemplateRef` — Represents a custom template for filtering -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **filteringExpressionsTree**: `FilteringExpressionsTree` — The filtering expressions for the column. -The type contains properties and methods for filtering: filteringOperands, operator (logic), fieldName, etc. -- **filters**: `IgxFilteringOperand` — Optional filtering operands that apply to this field. -- **groupable**: `boolean` — Indicates whether a column can be put in a group. If the value is true, the column can be put in a group -- **groupingComparer**: `any` — Represents a method with custom grouping comparator to determine the members of the group. -- **hasSummary**: `boolean` — Gets a value indicating whether the summary for the column is enabled. -let hasSummary = this.column.hasSummary; -- **headerTemplate**: `TemplateRef` — The template reference for the custom header of the column -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **hidden**: `boolean` — Indicates whether a column is currently hidden (not visible). If the value is true, the column is not visible -- **index**: `number` — The index of the column within the grid. -Includes the hidden columns when counting -- **inlineEditorTemplate**: `TemplateRef` — The template reference for the custom inline editor of the column -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **level**: `number` — Represents the hierarchical level of the column in the column layout -- **maxWidth**: `string` -- **minWidth**: `string` -- **pinned**: `boolean` — Indicates if the column is currently pinned. If the value is true, the column is pinned -- **pipeArgs**: `IColumnPipeArgs` — Optional arguments for any pipe applied to the field. -- **selectable**: `boolean` — Indicates if the column can be selected. If the value is true, the column can be selected -- **selected**: `boolean` — Indicates if the column is currently selected. If the value is true, the column is selected -- **sortStrategy**: `ISortingStrategy` — The sorting strategy used for sorting this column. -The interface contains a method sort that sorts the provided data based on the given sorting expressions -- **summaries**: `any` — Gets the column summaries. -let columnSummaries = this.column.summaries; -- **summaryTemplate**: `TemplateRef` — The template reference for a summary of the column -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **topLevelParent**: `ColumnType` — Optional -The root parent of this column (if any). -If there is no root parent, that means the current column is the root parent -- **visibleIndex**: `number` — The index of the column within the grid. -Does not include the hidden columns when counting -- **visibleWhenCollapsed**: `boolean` -- **width**: `string` — Gets the width of the column. -let columnWidth = this.column.width; -- **autosize**(byHeaderOnly: boolean): void — Autosize the column to the longest currently visible cell value, including the header cell. -@ViewChild('grid') grid: IgxGridComponent; -let column = this.grid.columnList.filter(c => c.field === 'ID')[0]; -column.autosize(); -- **move**(index: number): void — Moves a column to the specified visible index. -If passed index is invalid, or if column would receive a different visible index after moving, moving is not performed. -If passed index would move the column to a different column group. moving is not performed. -- **pin**(index?: number): boolean — Pins the column at the provided index in the pinned area. -Defaults to index 0 if not provided, or to the initial index in the pinned area. -Returns true if the column is successfully pinned. Returns false if the column cannot be pinned. -Column cannot be pinned if: -- Is already pinned -- index argument is out of range -- The pinned area exceeds 80% of the grid width -let success = this.column.pin(); -- **unpin**(index?: number): boolean — Unpins the column and place it at the provided index in the unpinned area. -Defaults to index 0 if not provided, or to the initial index in the unpinned area. -Returns true if the column is successfully unpinned. Returns false if the column cannot be unpinned. -Column cannot be unpinned if: -- Is already unpinned -- index argument is out of range -let success = this.column.unpin(); - -### [IgxColumnEmailValidatorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxColumnEmailValidatorDirective) - -- **constructor**(): IgxColumnEmailValidatorDirective - -### [IgxColumnGroupComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxColumnGroupComponent) -**Ignite UI for Angular Column Group** - -- **constructor**(grid: GridType, _validators: Validator[], platform: PlatformUtil): IgxColumnGroupComponent -- **children**: `QueryList` -- **collapsibleIndicatorTemplate**: `TemplateRef` — Allows you to define a custom template for expand/collapse indicator -- **searchable**: `boolean` — Sets/gets whether the column group is searchable. -Default value is true. -let isSearchable = this.columnGroup.searchable; - - -- **childColumns**: `ColumnType[]` — A list containing all the child columns under this column (if any). -Empty without children or if this column is not Group or Layout. -- **collapsible**: `boolean` — Optional -Indicated whether the column can be collapsed. If the value is true, the column can be collapsed -It is used in tree grid and for navigation -- **columnGroup**: `boolean` — Specifies whether the column belongs to a group of columns. -- **columnLayout**: `boolean` — Returns a boolean indicating if the column is a ColumnLayout for multi-row layout. -let columnGroup = this.column.columnGroup; -- **expanded**: `boolean` — Indicates if the column is currently expanded or collapsed. If the value is true, the column is expanded -- **filters**: `any` — Optional filtering operands that apply to this field. -- **hidden**: `boolean` — Indicates whether a column is currently hidden (not visible). If the value is true, the column is not visible -- **selectable**: `boolean` — Indicates if the column can be selected. If the value is true, the column can be selected -- **selected**: `boolean` — Indicates if the column is currently selected. If the value is true, the column is selected -- **summaries**: `any` — Gets the column group summaries. -let columnGroupSummaries = this.columnGroup.summaries; -- **width**: `string` — Gets the width of the column group. -let columnGroupWidth = this.columnGroup.width; - -### [IgxColumnHidingDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxColumnHidingDirective) - -- **constructor**(columnActions: IgxColumnActionsComponent): IgxColumnHidingDirective - -### [IgxColumnLayoutComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxColumnLayoutComponent) -Column layout for declaration of Multi-row Layout - -- **constructor**(grid: GridType, _validators: Validator[], platform: PlatformUtil): IgxColumnLayoutComponent -- **columnLayout**: `boolean` — Returns a boolean indicating if the column is a ColumnLayout for multi-row layout. -let columnGroup = this.column.columnGroup; -- **hidden**: `boolean` — Indicates whether a column is currently hidden (not visible). If the value is true, the column is not visible -- **visibleIndex**: `number` — The index of the column within the grid. -Does not include the hidden columns when counting -- **width**: `any` — Gets the width of the column layout. -let columnGroupWidth = this.columnGroup.width; - -### [IgxColumnMaxLengthValidatorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxColumnMaxLengthValidatorDirective) - -- **constructor**(): IgxColumnMaxLengthValidatorDirective - -### [IgxColumnMaxValidatorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxColumnMaxValidatorDirective) - -- **constructor**(): IgxColumnMaxValidatorDirective - -### [IgxColumnMinLengthValidatorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxColumnMinLengthValidatorDirective) - -- **constructor**(): IgxColumnMinLengthValidatorDirective - -### [IgxColumnMinValidatorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxColumnMinValidatorDirective) - -- **constructor**(): IgxColumnMinValidatorDirective - -### [IgxColumnPinningDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxColumnPinningDirective) - -- **constructor**(columnActions: IgxColumnActionsComponent): IgxColumnPinningDirective - -### [IgxColumnRequiredValidatorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxColumnRequiredValidatorDirective) - -- **constructor**(): IgxColumnRequiredValidatorDirective - -### [IgxColumPatternValidatorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxColumPatternValidatorDirective) - -- **constructor**(): IgxColumPatternValidatorDirective - -### [IgxComboAddItemDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxComboAddItemDirective) -Defines the custom template that will be used to display the ADD button - -- **constructor**(): IgxComboAddItemDirective - -### [IgxComboClearIconDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxComboClearIconDirective) -Defines the custom template that will be used when rendering the combo's clear icon - -- **constructor**(): IgxComboClearIconDirective - -### [IgxComboComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxComboComponent) -Represents a drop-down list that provides editable functionalities, allowing users to choose an option from a predefined list. - -- **constructor**(elementRef: ElementRef, cdr: ChangeDetectorRef, selectionService: IgxSelectionAPIService, comboAPI: IgxComboAPIService, document: any, _inputGroupType: IgxInputGroupType, _injector: Injector, _iconService?: IgxIconService): IgxComboComponent -- **autoFocusSearch**: `boolean` — Whether the combo's search box should be focused after the dropdown is opened. -When false, the combo's list item container will be focused instead -- **searchPlaceholder**: `string` — Defines the placeholder value for the combo dropdown search field -- **selectionChanging**: `EventEmitter` — Emitted when item selection is changing, before the selection completes - - -- **deselect**(items: any[], event?: Event): void — Deselect defined items -- **deselectAllItems**(ignoreFilter?: boolean, event?: Event): void — Deselect all (filtered) items -- **onArrowDown**(event: Event): void -- **select**(newItems: any[], clearCurrentSelection?: boolean, event?: Event): void — Select defined items -- **selectAllItems**(ignoreFilter?: boolean, event?: Event): void — Select all (filtered) items -- **setSelectedItem**(itemID: any, select: boolean, event?: Event): void — Selects/Deselects a single item - -### [IgxComboEmptyDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxComboEmptyDirective) -Defines the custom template that will be displayed when the combo's list is empty - -- **constructor**(): IgxComboEmptyDirective - -### [IgxComboFooterDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxComboFooterDirective) -Allows a custom element to be added at the end of the combo list. - -- **constructor**(): IgxComboFooterDirective - -### [IgxComboHeaderDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxComboHeaderDirective) -Allows a custom element to be added at the beginning of the combo list. - -- **constructor**(): IgxComboHeaderDirective - -### [IgxComboHeaderItemDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxComboHeaderItemDirective) -Defines the custom template that will be used when rendering header items for groups in the combo's list - -- **constructor**(): IgxComboHeaderItemDirective - -### [IgxComboItemDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxComboItemDirective) -Allows the combo's items to be modified with a custom template - -- **constructor**(): IgxComboItemDirective - -### [IgxComboToggleIconDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxComboToggleIconDirective) -The custom template that will be used when rendering the combo's toggle button - -- **constructor**(): IgxComboToggleIconDirective - -### [IgxCsvExporterOptions](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCsvExporterOptions) -Objects of this class are used to configure the CSV exporting process. - -- **constructor**(fileName: string, fileType: CsvFileTypes): IgxCsvExporterOptions -- **fileType**: `any` — Gets the CSV export format. -let filetype = this.exportOptions.fileType; -- **valueDelimiter**: `any` — Gets the value delimiter which will be used for the exporting operation. -let delimiter = this.exportOptions.valueDelimiter; - -### [IgxCsvExporterService](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCsvExporterService) -**Ignite UI for Angular CSV Exporter Service** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/exporter-csv) - -The Ignite UI for Angular CSV Exporter service can export data in a Character Separated Values format from -both raw data (array) or from an IgxGrid. - -Example: -public localData = [ - { Name: "Eric Ridley", Age: "26" }, - { Name: "Alanis Brook", Age: "22" }, - { Name: "Jonathan Morris", Age: "23" } -]; - -constructor(private csvExportService: IgxCsvExporterService) { -} - -const opt: IgxCsvExporterOptions = new IgxCsvExporterOptions("FileName", CsvFileTypes.CSV); -this.csvExportService.exportData(this.localData, opt); - -- **constructor**(): IgxCsvExporterService -- **exportEnded**: `EventEmitter` — This event is emitted when the export process finishes. -this.exporterService.exportEnded.subscribe((args: ICsvExportEndedEventArgs) => { -// put event handler code here -}); - -### [IgxCSVTextDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxCSVTextDirective) - -- **constructor**(): IgxCSVTextDirective - -### [IgxDataLoadingTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDataLoadingTemplateDirective) - -- **constructor**(template: TemplateRef): IgxDataLoadingTemplateDirective -- **template**: `TemplateRef` - -### [IgxDataRecordSorting](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDataRecordSorting) -Represents a class extending the IgxSorting class -Provides custom data record sorting. - -- **constructor**(): IgxDataRecordSorting - -### [IgxDateFilteringOperand](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDateFilteringOperand) -Provides filtering operations for Dates - - -### [IgxDatePickerComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDatePickerComponent) -Date Picker displays a popup calendar that lets users select a single date. - -- **constructor**(element: ElementRef, _localeId: string, _overlayService: IgxOverlayService, _injector: Injector, _renderer: Renderer2, platform: PlatformUtil, cdr: ChangeDetectorRef, _inputGroupType?: IgxInputGroupType): IgxDatePickerComponent -- **calendarFormat**: `IFormattingOptions` — Gets/Sets the format options of the IgxDatePickerComponent. -- **cancelButtonLabel**: `string` — Gets/Sets the cancel button's label. -- **displayMonthsCount**: `number` — Gets/Sets the number of month views displayed. -- **formatter**: `any` — Gets/Sets a custom formatter function on the selected or passed date. -- **formatViews**: `IFormattingViews` — Gets/Sets the format views of the IgxDatePickerComponent. -- **headerOrientation**: `PickerHeaderOrientation` — Gets/Sets the orientation of the IgxDatePickerComponent header. -- **hideOutsideDays**: `boolean` — Gets/Sets whether the inactive dates will be hidden. -- **id**: `string` — Gets/Sets the value of id attribute. -- **outlet**: `ElementRef | IgxOverlayOutletDirective` — Gets/Sets the container used for the popup element. -- **resourceStrings**: `IDatePickerResourceStrings` — Gets/Sets the resource strings for the picker's default toggle icon. -By default it uses EN resources. -- **showWeekNumbers**: `boolean` — Show/hide week numbers -- **spinDelta**: `Pick` — Delta values used to increment or decrement each editor date part on spin actions. -All values default to 1. -- **spinLoop**: `boolean` — Specify if the currently spun date segment should loop over. -- **todayButtonLabel**: `string` — Gets/Sets the today button's label. -- **validationFailed**: `EventEmitter` — Emitted when the user types/spins invalid date in the date-picker editor. -- **valueChange**: `EventEmitter` — Emitted when the picker's value changes. -- **disabledDates**: `DateRangeDescriptor[]` — Gets/Sets the disabled dates descriptors. -- **maxValue**: `string | Date` -- **minValue**: `string | Date` -- **specialDates**: `DateRangeDescriptor[]` — Gets/Sets the special dates descriptors. -- **value**: `string | Date` — Gets/Sets the selected date. -- **clear**(): void — Clears the input field and the picker's value. -- **close**(): void — Closes the picker's dropdown or dialog. -- **decrement**(datePart?: DatePart, delta?: number): void — Decrement a specified DatePart -- **increment**(datePart?: DatePart, delta?: number): void — Increment a specified DatePart. -- **open**(settings?: OverlaySettings): void — Opens the picker's dropdown or dialog. -- **select**(value: Date): void — Selects a date. -- **selectToday**(): void — Selects today's date and closes the picker. -- **toggle**(settings?: OverlaySettings): void — Toggles the picker's dropdown or dialog - -### [IgxDateRangeEndComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDateRangeEndComponent) -Defines the end input for a date range picker - -- **constructor**(element: ElementRef, _inputGroupType: IgxInputGroupType, document: any, platform: PlatformUtil, cdr: ChangeDetectorRef, themeToken: ThemeToken): IgxDateRangeEndComponent - -### [IgxDateRangePickerComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDateRangePickerComponent) -Provides the ability to select a range of dates from a calendar UI or editable inputs. - -- **constructor**(element: ElementRef, _localeId: string, platform: PlatformUtil, _injector: Injector, _cdr: ChangeDetectorRef, _overlayService: IgxOverlayService, _inputGroupType?: IgxInputGroupType): IgxDateRangePickerComponent -- **displayFormat**: `string` — The format used when editable inputs are not focused. -- **displayMonthsCount**: `number` — The number of displayed month views. -- **formatter**: `any` — A custom formatter function, applied on the selected or passed in date. -- **hideOutsideDays**: `boolean` — Gets/Sets whether dates that are not part of the current month will be displayed. -- **inputFormat**: `string` — The expected user input format and placeholder. -- **label**: `IgxLabelDirective` -- **outlet**: `ElementRef | IgxOverlayOutletDirective` — Gets/Sets the container used for the popup element. -- **overlaySettings**: `OverlaySettings` — Custom overlay settings that should be used to display the calendar. -- **pickerActions**: `IgxPickerActionsDirective` -- **placeholder**: `string` — Sets the placeholder for single-input IgxDateRangePickerComponent. -- **showWeekNumbers**: `boolean` — Show/hide week numbers -- **valueChange**: `EventEmitter` — Emitted when the picker's value changes. Used for two-way binding. -- **collapsed**: `boolean` — Gets calendar state. - -let state = this.dateRange.collapsed; -- **doneButtonText**: `string` -- **locale**: `string` — Gets the locale of the date-range-picker. -If not set, defaults to application's locale. -- **maxValue**: `string | Date` -- **minValue**: `string | Date` -- **resourceStrings**: `IDateRangePickerResourceStrings` — An accessor that returns the resource strings. -- **value**: `DateRange` — The currently selected value / range from the calendar -- **close**(): void — Closes the date range picker's dropdown or dialog. -- **open**(overlaySettings?: OverlaySettings): void — Opens the date range picker's dropdown or dialog. -- **select**(startDate: Date, endDate?: Date): void — Selects a range of dates. If no endDate is passed, range is 1 day (only startDate) -- **toggle**(overlaySettings?: OverlaySettings): void — Toggles the date range picker's dropdown or dialog - -### [IgxDateRangeSeparatorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDateRangeSeparatorDirective) -Replaces the default separator to with the provided value - -- **constructor**(): IgxDateRangeSeparatorDirective - -### [IgxDateRangeStartComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDateRangeStartComponent) -Defines the start input for a date range picker - -- **constructor**(element: ElementRef, _inputGroupType: IgxInputGroupType, document: any, platform: PlatformUtil, cdr: ChangeDetectorRef, themeToken: ThemeToken): IgxDateRangeStartComponent - -### [IgxDateSummaryOperand](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDateSummaryOperand) - -- **constructor**(): IgxDateSummaryOperand -- **operate**(data: any[], allData: any[], fieldName?: string, groupRecord?: IGroupByRecord): IgxSummaryResult[] — Executes the static methods and returns IgxSummaryResult[]. -interface IgxSummaryResult { - key: string; - label: string; - summaryResult: any; -} - -Can be overridden in the inherited classes to provide customization for the summary. -class CustomDateSummary extends IgxDateSummaryOperand { - constructor() { - super(); - } - public operate(data: any[], allData: any[], fieldName: string, groupRecord: IGroupByRecord): IgxSummaryResult[] { - const result = super.operate(data, allData, fieldName, groupRecord); - result.push({ - key: "deadline", - label: "Deadline Date", - summaryResult: this.calculateDeadline(data); - }); - return result; - } -} -this.grid.getColumnByName('ColumnName').summaries = CustomDateSummary; -- static **earliest**(data: any[]): any — Returns the earliest date value in the data records. -If filtering is applied, returns the latest date value in the filtered data records. -IgxDateSummaryOperand.earliest(data); -- static **latest**(data: any[]): any — Returns the latest date value in the data records. -If filtering is applied, returns the latest date value in the filtered data records. -IgxDateSummaryOperand.latest(data); - -### [IgxDateTimeEditorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDateTimeEditorDirective) -Date Time Editor provides a functionality to input, edit and format date and time. - -- **constructor**(renderer: Renderer2, elementRef: ElementRef, maskParser: MaskParsingService, platform: PlatformUtil, _document: any, _locale: any): IgxDateTimeEditorDirective -- **defaultFormatType**: `"date" | "dateTime" | "time"` — Specify the default input format type. Defaults to date, which includes -only date parts for editing. Other valid options are time and dateTime. -- **locale**: `string` — Locale settings used for value formatting. -- **spinDelta**: `DatePartDeltas` — Delta values used to increment or decrement each editor date part on spin actions. -All values default to 1. -- **spinLoop**: `boolean` — Specify if the currently spun date segment should loop over. -- **validationFailed**: `EventEmitter` — Emitted when the editor is not within a specified range or when the editor's value is in an invalid state. -- **valueChange**: `EventEmitter` — Emitted when the editor's value has changed. -- **displayFormat**: `string` -- **inputFormat**: `string` -- **maxValue**: `string | Date` — Maximum value required for the editor to remain valid. -- **minValue**: `string | Date` — Minimum value required for the editor to remain valid. -- **value**: `string | Date` -- **clear**(): void — Clear the input element value. -- **decrement**(datePart?: DatePart, delta?: number): void — Decrement specified DatePart. -- **increment**(datePart?: DatePart, delta?: number): void — Increment specified DatePart. -- **onWheel**(event: WheelEvent): void - -### [IgxDateTimeFilteringOperand](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDateTimeFilteringOperand) - - -### [IgxDaysViewComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDaysViewComponent) - -- **id**: `string` — Sets/gets the id of the days view. -If not set, the id will have value "igx-days-view-0". - - -let daysViewId = this.daysView.id; -- **role**: `string` -- **showWeekNumbers**: `boolean` — Show/hide week numbers -- **tabIndex**: `number` -- readonly **viewClass**: `true` -- **activeDate**: `Date` -- **hideLeadingDays**: `boolean` -- **hideTrailingDays**: `boolean` -- **previewRangeDate**: `Date` -- **showActiveDay**: `boolean` -- **standalone**: `boolean` - -### [IgxDefaultDropStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDefaultDropStrategy) - -- **constructor**(): IgxDefaultDropStrategy -- **dropAction**(_drag: IgxDragDirective, _drop: IgxDropDirective, _atIndex: number): void - -### [IgxDialogComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDialogComponent) -**Ignite UI for Angular Dialog Window** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/dialog.html) - -The Ignite UI Dialog Window presents a dialog window to the user which can simply display messages or display -more complicated visuals such as a user sign-in form. It also provides a right and left button -which can be used for custom actions. - -Example: - - -
- - - - -
-
- - - - -
- - -- **constructor**(elementRef: ElementRef, navService: IgxNavigationService): IgxDialogComponent -- **closed**: `EventEmitter` — An event that is emitted after the dialog is closed. - - -- **closing**: `EventEmitter` — An event that is emitted before the dialog is closed. - - -- **focusTrap**: `boolean` — Set whether the Tab key focus is trapped within the dialog when opened. -Defaults to true. - -- **id**: `string` — Sets the value of the id attribute. If not provided it will be automatically generated. - - -- **leftButtonLabel**: `string` — Sets the label of the left button of the dialog. - -- **leftButtonRipple**: `string` — Sets the left button ripple. The ripple animates a click/tap to a component as a series of fading waves. -The property accepts all valid CSS color property values. - -- **leftButtonSelect**: `EventEmitter` — An event that is emitted when the left button is clicked. - - -- **leftButtonType**: `IgxButtonType` — Sets the left button type. The types are flat, contained and fab. -The flat type button is a rectangle and doesn't have a shadow.
-The contained type button is also a rectangle but has a shadow.
-The fab type button is a circle with a shadow.
-The default value is flat. - -- **message**: `string` — Sets the message text of the dialog. - -- **opened**: `EventEmitter` — An event that is emitted after the dialog is opened. - - -- **opening**: `EventEmitter` — An event that is emitted before the dialog is opened. - - -- **rightButtonLabel**: `string` — Sets the label of the right button of the dialog. - -- **rightButtonRipple**: `string` — Sets the right button ripple. - -- **rightButtonSelect**: `EventEmitter` — An event that is emitted when the right button is clicked. - - -- **rightButtonType**: `IgxButtonType` — Sets the right button type. The types are flat, contained and fab. -The flat type button is a rectangle and doesn't have a shadow.
-The contained type button is also a rectangle but has a shadow.
-The fab type button is a circle with a shadow.
-The default value is flat. - -- **title**: `string` — Sets the title of the dialog. - -- **toggleRef**: `IgxToggleDirective` -- **closeOnEscape**: `boolean` — Controls whether the dialog should close when Esc key is pressed. Defaults to true - -- **closeOnOutsideSelect**: `boolean` — Gets/Sets whether the dialog should close on click outside the component. By default it's false. - - -- **isCollapsed**: `boolean` -- **isModal**: `boolean` — Controls whether the dialog should be shown as modal. Defaults to true - -- **isOpen**: `boolean` — State of the dialog. - -// get -let dialogIsOpen = this.dialog.isOpen; - - - - - - -Two-way data binding. - - -- **positionSettings**: `PositionSettings` — Get the position and animation settings used by the dialog. -@ViewChild('alert', { static: true }) public alert: IgxDialogComponent; -let currentPosition: PositionSettings = this.alert.positionSettings -- **role**: `"dialog" | "alertdialog" | "alert"` — Returns the value of the role of the dialog. The valid values are dialog, alertdialog, alert. -@ViewChild("MyDialog") -public dialog: IgxDialogComponent; -ngAfterViewInit() { - let dialogRole = this.dialog.role; -} -- **state**: `string` — Returns the value of state. Possible state values are "open" or "close". -@ViewChild("MyDialog") -public dialog: IgxDialogComponent; -ngAfterViewInit() { - let dialogState = this.dialog.state; -} -- **titleId**: `string` — Returns the value of the title id. - @ViewChild("MyDialog") -public dialog: IgxDialogComponent; -ngAfterViewInit() { - let dialogTitle = this.dialog.titleId; -} -- **close**(): void — A method that that closes the dialog. -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **open**(overlaySettings: OverlaySettings): void — A method that opens the dialog. -- **toggle**(): void — A method that opens/closes the dialog. - -### [IgxDividerDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDividerDirective) - -- **constructor**(): IgxDividerDirective -- **id**: `string` — Sets/gets the id of the divider. -If not set, id will have value "igx-divider-0"; - - -let dividerId = this.divider.id; -- **middle**: `boolean` — If set to true and an inset value has been provided, -the divider will start shrinking from both ends. - -- **role**: `string` — Sets the value of role attribute. -If not the default value of separator will be used. -- **type**: `string` — Sets the type of the divider. The default value -is default. The divider can also be dashed; - -- **vertical**: `boolean` — Sets the divider in vertical orientation. - -- **inset**: `string` — Gets the current divider inset in terms of -inset-inline-start representation as applied to the divider. -const inset = this.divider.inset; -- **isDashed**: `boolean` -- **isSolid**: `boolean` — A getter that returns true if the type of the divider is default; -const isDefault = this.divider.isDefault; - -### [IgxDragDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDragDirective) - -- **constructor**(cdr: ChangeDetectorRef, element: ElementRef, viewContainer: ViewContainerRef, zone: NgZone, renderer: Renderer2, platformUtil: PlatformUtil): IgxDragDirective -- **cdr**: `ChangeDetectorRef` -- **dragChannel**: `string | number | string[] | number[]` — A property that provides a way for igxDrag and igxDrop to be linked through channels. -It accepts single value or an array of values and evaluates then using strict equality. -
- 95 -
-
- Numbers drop area! -
-- **dragClick**: `EventEmitter` — Event triggered when the draggable element is clicked. -
- Drag Me! -
- -public onDragClick(){ - alert("The element has been clicked!"); -} -- **dragDirection**: `DragDirection` — Sets the directions that the element can be dragged. -By default it is set to both horizontal and vertical directions. -
- Drag Me! -
- -public dragDir = DragDirection.HORIZONTAL; -- **dragEnd**: `EventEmitter` — Event triggered when the draggable element is released. -
- Drag Me! -
- -public onDragEnd(){ - alert("The drag has ended!"); -} -- **dragMove**: `EventEmitter` — Event triggered when the draggable element has been moved. -
- Drag Me! -
- -public onDragMove(){ - alert("The element has moved!"); -} -- **dragStart**: `EventEmitter` — Event triggered when the draggable element drag starts. -
- Drag Me! -
- -public onDragStart(){ - alert("The drag has stared!"); -} -- **dragTolerance**: `number` — Sets the tolerance in pixels before drag starts. -By default the drag starts after the draggable element is moved by 5px. -
- Drag Me! -
-- **element**: `ElementRef` -- **ghost**: `boolean` — Sets whether the base element should be moved, or a ghost element should be rendered that represents it instead. -By default it is set to true. -If it is set to false when dragging the base element is moved instead and no ghost elements are rendered. -
- Drag Me! -
-- **ghostClass**: `string` — Sets a custom class that will be added to the ghostElement element. -
- Drag Me! -
-- **ghostCreate**: `EventEmitter` — Event triggered when the drag ghost element is created. -
- Drag Me! -
- -public ghostCreated(){ - alert("The ghost has been created!"); -} -- **ghostDestroy**: `EventEmitter` — Event triggered when the drag ghost element is created. -
- Drag Me! -
- -public ghostDestroyed(){ - alert("The ghost has been destroyed!"); -} -- **ghostHost**: `any` — Sets the element to which the dragged element will be appended. -By default it's set to null and the dragged element is appended to the body. -
-
- Drag Me! -
-- **ghostStyle**: `any` — Set styles that will be added to the ghostElement element. -
- Drag Me! -
-- **ghostTemplate**: `TemplateRef` — Specifies a template for the ghost element created when dragging starts and ghost is true. -By default a clone of the base element the igxDrag is instanced is created. -
- Drag Me! -
- -
- I am being dragged! -
- -- **renderer**: `Renderer2` -- **scrollContainer**: `HTMLElement` — Overrides the scroll container of the dragged element. By default its the window. -- **transitioned**: `EventEmitter` — Event triggered after the draggable element is released and after its animation has finished. -
- Drag Me! -
- -public onMoveEnd(){ - alert("The move has ended!"); -} -- **viewContainer**: `ViewContainerRef` -- **zone**: `NgZone` -- **data**: `any` -- **ghostOffsetX**: `any` -- **ghostOffsetY**: `any` -- **location**: `IgxDragLocation` — Gets the current location of the element relative to the page. -- **originLocation**: `IgxDragLocation` — Gets the original location of the element before dragging started. -- **setLocation**(newLocation: IgxDragLocation): void — Sets desired location of the base element or ghost element if rended relative to the document. -- **transitionTo**(target: ElementRef | IgxDragLocation, customAnimArgs?: IDragCustomTransitionArgs, startLocation?: IgxDragLocation): void — Animates the base or ghost element to a specific target location or other element using transition. -If ghost is true but there is not ghost rendered, it will be created and animated. -It is recommended to use 'getBoundingClientRects() + pageScroll' when determining desired location. -- **transitionToOrigin**(customAnimArgs?: IDragCustomTransitionArgs, startLocation?: IgxDragLocation): void — Animates the base or ghost element depending on the ghost input to its initial location. -If ghost is true but there is not ghost rendered, it will be created and animated. -If the base element has changed its DOM position its initial location will be changed accordingly. - -### [IgxDragHandleDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDragHandleDirective) - -- **constructor**(element: ElementRef): IgxDragHandleDirective -- **baseClass**: `boolean` -- **element**: `ElementRef` - -### [IgxDragIgnoreDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDragIgnoreDirective) - -- **constructor**(element: ElementRef): IgxDragIgnoreDirective -- **baseClass**: `boolean` -- **element**: `ElementRef` - -### [IgxDragLocation](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDragLocation) - -- **constructor**(_pageX: any, _pageY: any): IgxDragLocation -- **pageX**: `number` -- **pageY**: `number` - -### [IgxDropDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDropDirective) - -- **constructor**(element: ElementRef, _renderer: Renderer2, _zone: NgZone): IgxDropDirective -- **dropChannel**: `string | number | string[] | number[]` — A property that provides a way for igxDrag and igxDrop to be linked through channels. -It accepts single value or an array of values and evaluates then using strict equality. -
- 95 -
-
- Numbers drop area! -
-- **dropped**: `EventEmitter` — Event triggered when dragged element is dropped in the area of the element. -Since the igxDrop has default logic that appends the dropped element as a child, it can be canceled here. -To cancel the default logic the cancel property of the event needs to be set to true. -
-
- -public dragDrop(){ - alert("A draggable element has been dropped in the chip area!"); -} -- **element**: `ElementRef` -- **enter**: `EventEmitter` — Event triggered when dragged element enters the area of the element. -
-
- -public dragEnter(){ - alert("A draggable element has entered the chip area!"); -} -- **leave**: `EventEmitter` — Event triggered when dragged element leaves the area of the element. -
-
- -public dragLeave(){ - alert("A draggable element has left the chip area!"); -} -- **over**: `EventEmitter` — Event triggered when dragged element enters the area of the element. -
-
- -public dragEnter(){ - alert("A draggable element has entered the chip area!"); -} -- **data**: `any` -- **dropStrategy**: `any` - -### [IgxDropDownComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDropDownComponent) -**Ignite UI for Angular DropDown** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/drop-down) - -The Ignite UI for Angular Drop Down displays a scrollable list of items which may be visually grouped and -supports selection of a single item. Clicking or tapping an item selects it and closes the Drop Down - -Example: - - - {{ item.value }} - - - -- **constructor**(elementRef: ElementRef, cdr: ChangeDetectorRef, document: any, selection: IgxSelectionAPIService): IgxDropDownComponent -- **allowItemsFocus**: `boolean` — Gets/sets whether items take focus. Disabled by default. -When enabled, drop down items gain tab index and are focused when active - -this includes activating the selected item when opening the drop down and moving with keyboard navigation. - -Note: Keep that focus shift in mind when using the igxDropDownItemNavigation directive -and ensure it's placed either on each focusable item or a common ancestor to allow it to handle keyboard events. - -// get -let dropDownAllowsItemFocus = this.dropdown.allowItemsFocus; - - - - -- **closed**: `EventEmitter` — Emitted after the dropdown is closed - - -- **closing**: `EventEmitter` — Emitted before the dropdown is closed - - -- **labelledBy**: `string` — Sets aria-labelledby attribute value. - -- **opened**: `EventEmitter` — Emitted after the dropdown is opened - - -- **opening**: `EventEmitter` — Emitted before the dropdown is opened - - -- **collapsed**: `boolean` — Gets if the dropdown is collapsed - -let isCollapsed = this.dropdown.collapsed; -- **id**: `string` — Gets/Sets the drop down's id - -// get -let myDropDownCurrentId = this.dropdown.id; - - - -- **listId**: `string` — Id of the internal listbox of the drop down -- **selectedItem**: `IgxDropDownItemBaseDirective` — Get currently selected item - -let currentItem = this.dropdown.selectedItem; -- **clearSelection**(): void — Clears the selection of the dropdown -this.dropdown.clearSelection(); -- **close**(event?: Event): void — Closes the dropdown - -this.dropdown.close(); -- **navigateItem**(index: number): void — Navigates to the item on the specified index -If the data in the drop-down is virtualized, pass the index of the item in the virtualized data. -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **onItemActionKey**(key: DropDownActionKey, event?: Event): void — Keydown Handler -- **open**(overlaySettings?: OverlaySettings): void — Opens the dropdown - -this.dropdown.open(); -- **setSelectedItem**(index: number): void — Select an item by index -- **toggle**(overlaySettings?: OverlaySettings): void — Toggles the dropdown - -this.dropdown.toggle(); - -### [IgxDropDownGroupComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDropDownGroupComponent) -The is a container intended for row items in -a container. - -- **constructor**(): IgxDropDownGroupComponent -- **disabled**: `boolean` — Sets/gets if the item group is disabled - -const myDropDownGroup: IgxDropDownGroupComponent = this.dropdownGroup; -// get -... -const groupState: boolean = myDropDownGroup.disabled; -... -//set -... -myDropDownGroup,disabled = false; -... - - - - - {{ item.text }} - - - - -**NOTE:** All items inside of a disabled drop down group will be treated as disabled -- **label**: `string` — Sets/gets the label of the item group - -const myDropDownGroup: IgxDropDownGroupComponent = this.dropdownGroup; -// get -... -const myLabel: string = myDropDownGroup.label; -... -// set -... -myDropDownGroup.label = 'My New Label'; -... - - - - ... - -- **labelledBy**: `string` - -### [IgxDropDownItemComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDropDownItemComponent) -The is a container intended for row items in -a container. - -- **constructor**(dropDown: IDropDownBase, elementRef: ElementRef, group: IgxDropDownGroupComponent, selection?: IgxSelectionAPIService): IgxDropDownItemComponent -- **focused**: `boolean` — Sets/gets if the given item is focused - let mySelectedItem = this.dropdown.selectedItem; - let isMyItemFocused = mySelectedItem.focused; -- **selected**: `boolean` — Sets/Gets if the item is the currently selected one in the dropdown - - let mySelectedItem = this.dropdown.selectedItem; - let isMyItemSelected = mySelectedItem.selected; // true - - -Two-way data binding - - -### [IgxDropDownItemNavigationDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxDropDownItemNavigationDirective) -Navigation Directive that handles keyboard events on its host and controls a targeted IgxDropDownBaseDirective component - -- **constructor**(dropdown: IgxDropDownBaseDirective): IgxDropDownItemNavigationDirective -- **dropdown**: `IgxDropDownBaseDirective` -- **activeDescendant**: `string` -- **target**: `IgxDropDownBaseDirective` — Gets the target of the navigation directive; - -// Get -export class MyComponent { - ... - @ContentChild(IgxDropDownNavigationDirective) - navDirective: IgxDropDownNavigationDirective = null - ... - const navTarget: IgxDropDownBaseDirective = navDirective.navTarget -} -- **handleKeyDown**(event: KeyboardEvent): void — Captures keydown events and calls the appropriate handlers on the target component -- **onArrowDownKeyDown**(): void — Navigates to previous item -- **onArrowUpKeyDown**(): void — Navigates to previous item -- **onEndKeyDown**(): void — Navigates to target's last item -- **onHomeKeyDown**(): void — Navigates to target's first item - -### [IgxEmptyListTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxEmptyListTemplateDirective) - -- **constructor**(template: TemplateRef): IgxEmptyListTemplateDirective -- **template**: `TemplateRef` - -### [IgxExcelExporterOptions](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelExporterOptions) -Objects of this class are used to configure the Excel exporting process. - -- **constructor**(fileName: string): IgxExcelExporterOptions -- **exportAsTable**: `boolean` — Specifies whether the exported data should be formatted as Excel table. (True by default) -let exportAsTable = this.exportOptions.exportAsTable; -this.exportOptions.exportAsTable = false; -- **ignorePinning**: `boolean` — Specifies if column pinning should be ignored. If ignoreColumnsOrder is set to true, -this option will always be considered as set to true. -let ignorePinning = this.exportOptions.ignorePinning; -this.exportOptions.ignorePinning = true; -- **columnWidth**: `number` — Gets the width of the columns in the exported excel file. -let width = this.exportOptions.columnWidth; -- **rowHeight**: `number` — Gets the height of the rows in the exported excel file. -let height = this.exportOptions.rowHeight; -- **worksheetName**: `string` — Gets the name of the worksheet in the exported excel file. -let worksheetName = this.exportOptions.worksheetName; - -### [IgxExcelExporterService](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelExporterService) -**Ignite UI for Angular Excel Exporter Service** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/exporter_excel.html) - -The Ignite UI for Angular Excel Exporter service can export data in Microsoft® Excel® format from both raw data -(array) or from an IgxGrid. - -Example: -public localData = [ - { Name: "Eric Ridley", Age: "26" }, - { Name: "Alanis Brook", Age: "22" }, - { Name: "Jonathan Morris", Age: "23" } -]; - -constructor(private excelExportService: IgxExcelExporterService) { -} - -this.excelExportService.exportData(this.localData, new IgxExcelExporterOptions("FileName")); - -- **constructor**(): IgxExcelExporterService -- **exportEnded**: `EventEmitter` — This event is emitted when the export process finishes. -this.exporterService.exportEnded.subscribe((args: IExcelExportEndedEventArgs) => { -// put event handler code here -}); - -### [IgxExcelStyleClearFiltersComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelStyleClearFiltersComponent) -A component used for presenting Excel style clear filters UI. - -- **constructor**(esf: BaseFilteringComponent, platform: PlatformUtil): IgxExcelStyleClearFiltersComponent -- **esf**: `BaseFilteringComponent` - -### [IgxExcelStyleColumnOperationsTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelStyleColumnOperationsTemplateDirective) - -- **constructor**(): IgxExcelStyleColumnOperationsTemplateDirective - -### [IgxExcelStyleConditionalFilterComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelStyleConditionalFilterComponent) -A component used for presenting Excel style conditional filter UI. - -- **constructor**(esf: BaseFilteringComponent, platform: PlatformUtil): IgxExcelStyleConditionalFilterComponent -- **esf**: `BaseFilteringComponent` -- **ngOnDestroy**(): void — A callback method that performs custom clean-up, invoked immediately -before a directive, pipe, or service instance is destroyed. - -### [IgxExcelStyleFilterOperationsTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelStyleFilterOperationsTemplateDirective) - -- **constructor**(): IgxExcelStyleFilterOperationsTemplateDirective - -### [IgxExcelStyleHeaderComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelStyleHeaderComponent) -A component used for presenting Excel style header UI. - -- **constructor**(esf: BaseFilteringComponent): IgxExcelStyleHeaderComponent -- **esf**: `BaseFilteringComponent` -- **showHiding**: `boolean` — Sets whether the column hiding icon should be shown in the header. -Default value is false. -- **showPinning**: `boolean` — Sets whether the column pinning icon should be shown in the header. -Default value is false. -- **showSelecting**: `boolean` — Sets whether the column selecting icon should be shown in the header. -Default value is false. - -### [IgxExcelStyleHidingComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelStyleHidingComponent) -A component used for presenting Excel style column hiding UI. - -- **constructor**(esf: BaseFilteringComponent): IgxExcelStyleHidingComponent -- **esf**: `BaseFilteringComponent` - -### [IgxExcelStyleLoadingValuesTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelStyleLoadingValuesTemplateDirective) - -- **constructor**(template: TemplateRef): IgxExcelStyleLoadingValuesTemplateDirective -- **template**: `TemplateRef` -- static **ngTemplateContextGuard**(_dir: IgxExcelStyleLoadingValuesTemplateDirective, ctx: unknown): ctx - -### [IgxExcelStyleMovingComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelStyleMovingComponent) -A component used for presenting Excel style column moving UI. - -- **constructor**(esf: BaseFilteringComponent): IgxExcelStyleMovingComponent -- **esf**: `BaseFilteringComponent` - -### [IgxExcelStylePinningComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelStylePinningComponent) -A component used for presenting Excel style column pinning UI. - -- **constructor**(esf: BaseFilteringComponent): IgxExcelStylePinningComponent -- **esf**: `BaseFilteringComponent` - -### [IgxExcelStyleSearchComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelStyleSearchComponent) -A component used for presenting Excel style search UI. - -- **constructor**(cdr: ChangeDetectorRef, esf: BaseFilteringComponent, platform: PlatformUtil): IgxExcelStyleSearchComponent -- **cdr**: `ChangeDetectorRef` -- **esf**: `BaseFilteringComponent` -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnDestroy**(): void — A callback method that performs custom clean-up, invoked immediately -before a directive, pipe, or service instance is destroyed. - -### [IgxExcelStyleSelectingComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelStyleSelectingComponent) -A component used for presenting Excel style conditional filter UI. - -- **constructor**(esf: BaseFilteringComponent): IgxExcelStyleSelectingComponent -- **esf**: `BaseFilteringComponent` - -### [IgxExcelStyleSortingComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelStyleSortingComponent) -A component used for presenting Excel style column sorting UI. - -- **constructor**(esf: BaseFilteringComponent, cdr: ChangeDetectorRef): IgxExcelStyleSortingComponent -- **esf**: `BaseFilteringComponent` -- **ngOnDestroy**(): void — A callback method that performs custom clean-up, invoked immediately -before a directive, pipe, or service instance is destroyed. - -### [IgxExcelTextDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExcelTextDirective) - -- **constructor**(): IgxExcelTextDirective - -### [IgxExpansionPanelBodyComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExpansionPanelBodyComponent) - -- **constructor**(panel: IgxExpansionPanelBase, element: ElementRef, cdr: ChangeDetectorRef): IgxExpansionPanelBodyComponent -- **cdr**: `ChangeDetectorRef` -- **element**: `ElementRef` -- **panel**: `IgxExpansionPanelBase` -- **role**: `string` — Gets/sets the role attribute of the panel body -Default is 'region'; -Get - const currentRole = this.panel.body.role; - -Set - this.panel.body.role = 'content'; - - -- **label**: `string` — Gets the aria-label attribute of the panel body -Defaults to the panel id with '-region' in the end; -Get - const currentLabel = this.panel.body.label; -- **labelledBy**: `string` — Gets the aria-labelledby attribute of the panel body -Defaults to the panel header id; -Get - const currentLabel = this.panel.body.labelledBy; - -### [IgxExpansionPanelComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExpansionPanelComponent) - -- **constructor**(animationService: AnimationService, cdr: ChangeDetectorRef, elementRef?: ElementRef): IgxExpansionPanelComponent -- **collapsed**: `boolean` — Gets/sets whether the component is collapsed (its content is hidden) -Get - const myPanelState: boolean = this.panel.collapsed; - -Set - this.panel.collapsed = true; - - -Two-way data binding: - -- **contentCollapsed**: `EventEmitter` — Emitted when the expansion panel finishes collapsing - handleCollapsed(event: IExpansionPanelEventArgs) - - - ... - -- **contentCollapsing**: `EventEmitter` — Emitted when the expansion panel starts collapsing - handleCollapsing(event: IExpansionPanelCancelableEventArgs) - - - ... - -- **contentExpanded**: `EventEmitter` — Emitted when the expansion panel finishes expanding - handleExpanded(event: IExpansionPanelEventArgs) - - - ... - -- **contentExpanding**: `EventEmitter` — Emitted when the expansion panel starts expanding - handleExpanding(event: IExpansionPanelCancelableEventArgs) - - - ... - -- **id**: `string` — Sets/gets the id of the expansion panel component. -If not set, id will have value "igx-expansion-panel-0"; - - -let panelId = this.panel.id; -- **animationSettings**: `ToggleAnimationSettings` — Sets/gets the animation settings of the expansion panel component -Open and Close animation should be passed - -Get - const currentAnimations = this.panel.animationSettings; - -Set - import { slideInLeft, slideOutRight } from 'igniteui-angular'; - ... - this.panel.animationsSettings = { - openAnimation: slideInLeft, - closeAnimation: slideOutRight -}; - -or via template - import { slideInLeft, slideOutRight } from 'igniteui-angular'; - ... - myCustomAnimationObject = { - openAnimation: slideInLeft, - closeAnimation: slideOutRight -}; -html - - ... - -``` -- **close**(evt?: Event): void -- **collapse**(evt?: Event): void — Collapses the panel - - - ... - - -- **expand**(evt?: Event): void — Expands the panel - - - ... - - -- **open**(evt?: Event): void -- **toggle**(evt?: Event): void — Toggles the panel - - - ... - - - -### [IgxExpansionPanelHeaderComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExpansionPanelHeaderComponent) - -- **constructor**(panel: IgxExpansionPanelBase, cdr: ChangeDetectorRef, elementRef: ElementRef): IgxExpansionPanelHeaderComponent -- **cdr**: `ChangeDetectorRef` -- **elementRef**: `ElementRef` -- **iconPosition**: `ExpansionPanelHeaderIconPosition` — Gets/sets the position of the expansion-panel-header expand/collapse icon -Accepts left, right or none - const currentIconPosition = this.panel.header.iconPosition; - -Set - this.panel.header.iconPosition = 'left'; - - -- **id**: `string` — Sets/gets the id of the expansion panel header. -let panelHeaderId = this.panel.header.id; -- **interaction**: `EventEmitter` — Emitted whenever a user interacts with the header host - handleInteraction(event: IExpansionPanelCancelableEventArgs) { - ... -} - - - ... - -- **lv**: `string` — Gets/sets the aria-level attribute of the header -Get - const currentAriaLevel = this.panel.header.lv; - -Set - this.panel.header.lv = '5'; - - -- **panel**: `IgxExpansionPanelBase` -- **role**: `string` — Gets/sets the role attribute of the header -Get - const currentRole = this.panel.header.role; - -Set - this.panel.header.role = '5'; - - -- **disabled**: `boolean` — Gets/sets the whether the header is disabled -When disabled, the header will not handle user events and will stop their propagation - - const isDisabled = this.panel.header.disabled; - -Set - this.panel.header.disabled = true; - - - ... - -- **iconRef**: `ElementRef` — Returns a reference to the igx-expansion-panel-icon element; -If iconPosition is NONE - return null; - -### [IgxExporterOptionsBase](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxExporterOptionsBase) - -- **constructor**(fileName: string, _fileExtension: string): IgxExporterOptionsBase -- **alwaysExportHeaders**: `boolean` — Specifies whether the headers should be exported if there is no data. -let alwaysExportHeaders = this.exportOptions.alwaysExportHeaders; -this.exportOptions.alwaysExportHeaders = false; -- **exportSummaries**: `boolean` — Specifies whether the exported data should include column summaries. -let exportSummaries = this.exportOptions.exportSummaries; -this.exportOptions.exportSummaries = true; -- **freezeHeaders**: `boolean` — Specifies whether the exported data should have frozen headers. -let freezeHeaders = this.exportOptions.freezeHeaders; -this.exportOptions.freezeHeaders = true; -- **ignoreColumnsOrder**: `boolean` — Specifies if the exporter should ignore the current column order in the IgxGrid. -let ignoreColumnsOrder = this.exportOptions.ignoreColumnsOrder; -this.exportOptions.ignoreColumnsOrder = true; -- **ignoreColumnsVisibility**: `boolean` — Specifies whether hidden columns should be exported. -let ignoreColumnsVisibility = this.exportOptions.ignoreColumnsVisibility; -this.exportOptions.ignoreColumnsVisibility = true; -- **ignoreFiltering**: `boolean` — Specifies whether filtered out rows should be exported. -let ignoreFiltering = this.exportOptions.ignoreFiltering; -this.exportOptions.ignoreFiltering = true; -- **ignoreGrouping**: `boolean` — Specifies whether the exported data should be grouped as in the provided IgxGrid. -let ignoreGrouping = this.exportOptions.ignoreGrouping; -this.exportOptions.ignoreGrouping = true; -- **ignoreMultiColumnHeaders**: `boolean` — Specifies whether the exported data should include multi column headers as in the provided IgxGrid. -let ignoreMultiColumnHeaders = this.exportOptions.ignoreMultiColumnHeaders; -this.exportOptions.ignoreMultiColumnHeaders = true; -- **ignoreSorting**: `boolean` — Specifies whether the exported data should be sorted as in the provided IgxGrid. -When you export grouped data, setting ignoreSorting to true will cause -the grouping to fail because it relies on the sorting of the records. -let ignoreSorting = this.exportOptions.ignoreSorting; -this.exportOptions.ignoreSorting = true; -- **fileName**: `string` — Gets the file name which will be used for the exporting operation. -let fileName = this.exportOptions.fileName; - -### [IgxFilterCellTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxFilterCellTemplateDirective) - -- **constructor**(template: TemplateRef): IgxFilterCellTemplateDirective -- **template**: `TemplateRef` -- static **ngTemplateContextGuard**(_directive: IgxFilterCellTemplateDirective, context: unknown): context - -### [IgxFilterDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxFilterDirective) - -- **constructor**(): IgxFilterDirective -- **filtered**: `EventEmitter` -- **filtering**: `EventEmitter` -- **filterOptions**: `IgxFilterOptions` -- **ngOnChanges**(changes: SimpleChanges): void — A callback method that is invoked immediately after the -default change detector has checked data-bound properties -if at least one has changed, and before the view and content -children are checked. - -### [IgxFilteringOperand](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxFilteringOperand) -Provides base filtering operations -Implementations should be Singleton - -- **constructor**(): IgxFilteringOperand -- **operations**: `IFilteringOperation[]` -- **append**(operation: IFilteringOperation): void — Adds a new condition to the filtering operations. -- **condition**(name: string): IFilteringOperation — Returns an instance of the condition with the specified name. -- **conditionList**(): string[] — Returns an array of names of the conditions which are visible in the filtering UI -- static **instance**(): IgxFilteringOperand - -### [IgxFilterOptions](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxFilterOptions) - -- **constructor**(): IgxFilterOptions -- **inputValue**: `string` -- **items**: `any[]` -- **key**: `string | string[]` -- **formatter**(valueToTest: string): string -- **get_value**(item: any, key: string): string -- **matchFn**(valueToTest: string, inputValue: string): boolean -- **metConditionFn**(item: any): void -- **overdueConditionFn**(item: any): void - -### [IgxFilterPipe](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxFilterPipe) - -- **constructor**(): IgxFilterPipe -- **transform**(items: any[], options: IgxFilterOptions): any[] - -### [IgxFlatTransactionFactory](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxFlatTransactionFactory) -Factory service for instantiating TransactionServices - -- **constructor**(): IgxFlatTransactionFactory -- **create**(type: TRANSACTION_TYPE): TransactionService — Creates a new Transaction service instance depending on the specified type. - -### [IgxFlexDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxFlexDirective) - -- **constructor**(): IgxFlexDirective -- **basis**: `string` — Applies the flex-basis attribute to an element that uses the directive. - -Default value is auto. - -Other possible values include content, max-content, min-content, fit-content. - -
Content
-- **flex**: `string` — Applies the directive to an element. - -Possible values include igxFlexGrow, igxFlexShrink, igxFlexOrder, igxFlexBasis. - -
Content
-- **grow**: `number` — Applies the grow attribute to an element that uses the directive. - -Default value is 1. - -
-
Content1
-
Content2
-
Content3
-
-- **order**: `number` — Applies the order attribute to an element that uses the directive. - -Default value is 0. - -
-
Content1
-
Content2
-
Content3
-
-- **shrink**: `number` — Applies the shrink attribute to an element that uses the directive. - -Default value is 1. - -
-
Content1
-
Content2
-
Content3
-
- -### [IgxFocusDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxFocusDirective) - -- **constructor**(element: ElementRef, comp?: any[], control?: any[]): IgxFocusDirective -- **focused**: `boolean` — Returns the state of the igxFocus. -@ViewChild('focusContainer', {read: IgxFocusDirective}) -public igxFocus: IgxFocusDirective; -let isFocusOn = this.igxFocus.focused; -- **nativeElement**: `any` — Gets the native element of the igxFocus. -@ViewChild('focusContainer', {read: IgxFocusDirective}) -public igxFocus: IgxFocusDirective; -let igxFocusNativeElement = this.igxFocus.nativeElement; -- **trigger**(): void — Triggers the igxFocus state. -@ViewChild('focusContainer', {read: IgxFocusDirective}) -public igxFocus: IgxFocusDirective; -this.igxFocus.trigger(); - -### [IgxFocusTrapDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxFocusTrapDirective) - -- **focusTrap**: `boolean` - -### [IgxForOfContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxForOfContext) - -- **constructor**($implicit: T, igxForOf: U, index: number, count: number): IgxForOfContext -- **$implicit**: `T` -- **count**: `number` -- **igxForOf**: `U` -- **index**: `number` -- **even**: `boolean` — A function that returns whether the element is even or not -- **first**: `boolean` — A function that returns whether the element is the first or not -- **last**: `boolean` — A function that returns whether the element is the last or not -- **odd**: `boolean` — A function that returns whether the element is odd or not - -### [IgxForOfDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxForOfDirective) - -- **constructor**(_viewContainer: ViewContainerRef, _template: TemplateRef>>, _differs: IterableDiffers, cdr: ChangeDetectorRef, _zone: NgZone, syncScrollService: IgxForOfScrollSyncService, platformUtil: PlatformUtil, document: any): IgxForOfDirective -- **beforeViewDestroyed**: `EventEmitter>` -- **cdr**: `ChangeDetectorRef` -- **chunkLoad**: `EventEmitter` — An event that is emitted after a new chunk has been loaded. - - -loadChunk(e){ -alert("chunk loaded!"); -} -- **chunkPreload**: `EventEmitter` — An event that is emitted on chunk loading to emit the current state information - startIndex, endIndex, totalCount. -Can be used for implementing remote load on demand for the igxFor data. - - -chunkPreload(e){ -alert("chunk is loading!"); -} -- **contentSizeChange**: `EventEmitter` — An event that is emitted after the rendered content size of the igxForOf has been changed. -- **dataChanged**: `EventEmitter` — An event that is emitted after data has been changed. - - -dataChanged(e){ -alert("data changed!"); -} -- **igxForContainerSize**: `any` — Sets the px-affixed size of the container along the axis of scrolling. -For "horizontal" orientation this value is the width of the container and for "vertical" is the height. - - -- **igxForItemSize**: `any` — Sets the px-affixed size of the item along the axis of scrolling. -For "horizontal" orientation this value is the width of the column and for "vertical" is the height or the row. - -- **igxForOf**: `U & T[]` — Sets the data to be rendered. - -- **igxForScrollContainer**: `any` — Optionally pass the parent igxFor instance to create a virtual template scrolling both horizontally and vertically. - -
- -
{{rowIndex}} : {{item.text}}
- -
- -- **igxForScrollOrientation**: `string` — Specifies the scroll orientation. -Scroll orientation can be "vertical" or "horizontal". - -- **igxForSizePropName**: `any` — Sets the property name from which to read the size in the data object. -- **state**: `IForOfState` — The current state of the directive. It contains startIndex and chunkSize. -state.startIndex - The index of the item at which the current visible chunk begins. -state.chunkSize - The number of items the current visible chunk holds. -These options can be used when implementing remote virtualization as they provide the necessary state information. -const gridState = this.parentVirtDir.state; -- **displayContainer**: `HTMLElement` -- **igxForTotalItemCount**: `number` — The total count of the virtual data items, when using remote service. -Similar to the property totalItemCount, but this will allow setting the data count into the template. - -- **igxForTrackBy**: `TrackByFunction` — Gets the function used to track changes in the items collection. -By default the object references are compared. However this can be optimized if you have unique identifier -value that can be used for the comparison instead of the object ref or if you have some other property values -in the item object that should be tracked for changes. -This option is similar to ngForTrackBy. -const trackFunc = this.parentVirtDir.igxForTrackBy; -- **scrollPosition**: `number` — Gets/Sets the scroll position. -const position = directive.scrollPosition; -directive.scrollPosition = value; -- **totalItemCount**: `number` — The total count of the virtual data items, when using remote service. -this.parentVirtDir.totalItemCount = data.Count; -- **virtualHelper**: `HTMLElement` -- **addScroll**(add: number): boolean — Shifts the scroll thumb position. -this.parentVirtDir.addScroll(5); -- **addScrollTop**(add: number): boolean — Shifts the scroll thumb position. -this.parentVirtDir.addScroll(5); -- **getIndexAtScroll**(scrollOffset: number): number — Returns the index of the element at the specified offset. -this.parentVirtDir.getIndexAtScroll(100); -- **getItemCountInView**(): number — Returns the total number of items that are fully visible. -this.parentVirtDir.getItemCountInView(); -- **getScroll**(): HTMLElement — Returns a reference to the scrollbar DOM element. -This is either a vertical or horizontal scrollbar depending on the specified igxForScrollOrientation. -dir.getScroll(); -- **getScrollForIndex**(index: number, bottom?: boolean): number — Returns the scroll offset of the element at the specified index. -this.parentVirtDir.getScrollForIndex(1); -- **getSizeAt**(index: number): number — Returns the size of the element at the specified index. -this.parentVirtDir.getSizeAt(1); -- **isIndexOutsideView**(index: number): boolean — Returns whether the target index is outside the view. -this.parentVirtDir.isIndexOutsideView(10); -- **isScrollable**(): boolean -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **scrollNext**(): void — Scrolls by one item into the appropriate next direction. -For "horizontal" orientation that will be the right column and for "vertical" that is the lower row. -this.parentVirtDir.scrollNext(); -- **scrollNextPage**(): void — Scrolls by one page into the appropriate next direction. -For "horizontal" orientation that will be one view to the right and for "vertical" that is one view to the bottom. -this.parentVirtDir.scrollNextPage(); -- **scrollPrev**(): void — Scrolls by one item into the appropriate previous direction. -For "horizontal" orientation that will be the left column and for "vertical" that is the upper row. -this.parentVirtDir.scrollPrev(); -- **scrollPrevPage**(): void — Scrolls by one page into the appropriate previous direction. -For "horizontal" orientation that will be one view to the left and for "vertical" that is one view to the top. -this.parentVirtDir.scrollPrevPage(); -- **scrollTo**(index: number): void — Scrolls to the specified index. -this.parentVirtDir.scrollTo(5); -- **verticalScrollHandler**(event: any): void - -### [IgxGridActionButtonComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridActionButtonComponent) - -- **constructor**(): IgxGridActionButtonComponent -- **actionClick**: `EventEmitter` — Event emitted when action button is clicked. -- **asMenuItem**: `boolean` — Whether button action is rendered in menu and should container text label. -- **classNames**: `string` — Additional Menu item container element classes. -- **container**: `ElementRef` -- **iconName**: `string` — Name of the icon to display in the button. -- **iconSet**: `string` — The name of the icon set. Used in case the icon is from a different icon set. -- **labelText**: `string` — The text of the label. - -### [IgxGridActionsBaseDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridActionsBaseDirective) - -- **constructor**(iconService: IgxIconService, differs: IterableDiffers): IgxGridActionsBaseDirective -- **asMenuItems**: `boolean` — Gets/Sets if the action buttons will be rendered as menu items. When in menu, items will be rendered with text label. - -### [IgxGridCell](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridCell) -Interface representing a cell in the grid. It is essentially the blueprint to a cell object. -Contains definitions of properties and methods, relevant to a cell - -- **grid**: `GridType` — Returns the grid containing the cell. -- **active**: `boolean` — Indicates whether the cell is currently active (focused). -- **column**: `ColumnType` — Represents the column that the cell belongs to. -- **editable**: `boolean` — Indicates whether the cell can be edited. -- **editMode**: `boolean` — Indicates whether the cell is currently in edit mode. -- **editValue**: `any` — The value to display when the cell is in edit mode. -- **id**: `any` — Optional; An object identifying the cell. It contains rowID, columnID, and rowIndex of the cell. -- **row**: `RowType` — Represents the row that the cell belongs to -- **selected**: `boolean` — Indicates whether the cell is currently selected. It is false, if the sell is not selected, and true, if it is. -- **validation**: `IGridValidationState` — Optional; An object representing the validation state of the cell. -Whether it's valid or invalid, and if it has errors -- **value**: `any` — The current value of the cell. -- **width**: `string` — The CSS width of the cell as a string. -- **update**(val: any): void — Updates the cell value. - -cell.update(newValue); - -### [IgxGridComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridComponent) -Grid provides a way to present and manipulate tabular data. - -- **constructor**(validation: IgxGridValidationService, colResizingService: IgxColumnResizingService, gridAPI: GridServiceType, transactionFactory: IgxFlatTransactionFactory, elementRef: ElementRef, zone: NgZone, cdr: ChangeDetectorRef, differs: IterableDiffers, viewRef: ViewContainerRef, injector: Injector, envInjector: EnvironmentInjector, navigation: IgxGridNavigationService, textHighlightService: IgxTextHighlightService, overlayService: IgxOverlayService, localeId: string, platform: PlatformUtil, _diTransactions?: TransactionService): IgxGridComponent -- **dataPreLoad**: `EventEmitter` — Emitted when a new chunk of data is loaded from virtualization. -- **dropAreaTemplate**: `TemplateRef` — Gets/Sets the template that will be rendered as a GroupBy drop area. -- **groupingDone**: `EventEmitter` — Emitted when columns are grouped/ungrouped. -- **groupingExpansionStateChange**: `EventEmitter` — Emitted when groups are expanded/collapsed. -- **groupingExpressionsChange**: `EventEmitter` — Emitted when grouping is performed. -- **groupsExpanded**: `boolean` — Gets/Sets whether created groups are rendered expanded or collapsed. -- **id**: `string` — Gets/Sets the value of the id attribute. -- **data**: `any[]` — Gets/Sets the array of data that populates the component. -- **detailTemplate**: `TemplateRef` — Returns a reference to the master-detail template. -let detailTemplate = this.grid.detailTemplate; -- **dropAreaMessage**: `string` -- **groupByRowSelectorTemplate**: `TemplateRef` — Optional -The template for the group row selector. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **groupingExpansionState**: `IGroupByExpandState[]` — Gets/Sets a list of expansion states for group rows. -- **groupingExpressions**: `IGroupingExpression[]` — Gets/Sets the group by state. -- **groupRowTemplate**: `TemplateRef` — Optional -The template for group-by rows. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **groupsRecords**: `IGroupByRecord[]` — Gets the hierarchical representation of the group by records. -- **groupStrategy**: `IGridGroupingStrategy` — Gets/Sets the grouping strategy of the grid. -- **hideGroupedColumns**: `boolean` — Gets/Sets whether the grouped columns should be hidden. -- **selectedCells**: `CellType[]` — Returns an array of the selected IgxGridCells. -- **showGroupArea**: `boolean` — Returns whether the IgxGridComponent has group area. -- **totalItemCount**: `number` -- **clearGrouping**(name?: string | string[]): void — Clears grouping for particular column, array of columns or all columns. -- **deselectRowsInGroup**(groupRow: IGroupByRecord): void — Deselect all rows within a group. -- **fullyExpandGroup**(groupRow: IGroupByRecord): void — Expands the specified group and all of its parent groups. -- **getCellByColumn**(rowIndex: number, columnField: string): CellType — Returns a CellType object that matches the conditions. -- **getCellByKey**(rowSelector: any, columnField: string): CellType — Returns a CellType object that matches the conditions. -- **getRowByIndex**(index: number): RowType — Returns the IgxGridRow by index. -- **getRowByKey**(key: any): RowType — Returns IgxGridRow object by the specified primary key. -- **getSelectedData**(formatters: boolean, headers: boolean): any[] — Returns an array of the current cell selection in the form of [{ column.field: cell.value }, ...]. -- **groupBy**(expression: IGroupingExpression | IGroupingExpression[]): void — Groups by a new IgxColumnComponent based on the provided expression, or modifies an existing one. -- **isExpandedGroup**(group: IGroupByRecord): boolean — Returns if a group is expanded or not. -- **pinRow**(rowID: any, index?: number): boolean — Pin the row by its id. -- **selectRowsInGroup**(groupRow: IGroupByRecord, clearPrevSelection?: boolean): void — Select all rows within a group. -- **toggleAllGroupRows**(): void — Toggles the expansion state of all group rows recursively. -- **toggleGroup**(groupRow: IGroupByRecord): void — Toggles the expansion state of a group. -- **unpinRow**(rowID: any): boolean — Unpin the row by its id. - -### [IgxGridEditingActionsComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridEditingActionsComponent) -Grid Editing Actions for the Action Strip - -- **constructor**(iconService: IgxIconService, differs: IterableDiffers): IgxGridEditingActionsComponent -- **addChild**: `boolean` — An input to enable/disable action strip child row adding button -- **deleteRow**: `boolean` — An input to enable/disable action strip row deleting button -- **editRow**: `boolean` — An input to enable/disable action strip row editing button -- **addRow**: `boolean` -- **hasChildren**: `boolean` -- **startEdit**(event?: any): void — Enter row or cell edit mode depending the grid rowEditable option - -### [IgxGridExcelStyleFilteringComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridExcelStyleFilteringComponent) -A component used for presenting Excel style filtering UI for a specific column. -It is used internally in the Grid, but could also be hosted in a container outside of it. - -Example: - - - -- **constructor**(cdr: ChangeDetectorRef, element: ElementRef, platform: PlatformUtil, document: any, gridAPI?: GridType): IgxGridExcelStyleFilteringComponent -- **mainDropdown**: `ElementRef` -- **column**: `ColumnType` — Returns the current column. -- **maxHeight**: `string` — Gets the maximum height. - -Setting value in template: -[maxHeight]="''" - - -Example for setting a value: -[maxHeight]="'700px'" -- **minHeight**: `string` — Gets the minimum height. - -Setting value in template: -[minHeight]="''" - - -Example for setting a value: -[minHeight]="'700px'" - -### [IgxGridFooterComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridFooterComponent) - -- **constructor**(): IgxGridFooterComponent - -### [IgxGridForOfContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridForOfContext) - -- **constructor**($implicit: T, igxGridForOf: U, index: number, count: number): IgxGridForOfContext -- **igxGridForOf**: `U` - -### [IgxGridForOfDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridForOfDirective) - -- **constructor**(_viewContainer: ViewContainerRef, _template: TemplateRef>>, _differs: IterableDiffers, cdr: ChangeDetectorRef, _zone: NgZone, _platformUtil: PlatformUtil, _document: any, syncScrollService: IgxForOfScrollSyncService, syncService: IgxForOfSyncService): IgxGridForOfDirective -- **igxGridForOfUniqueSizeCache**: `boolean` -- **igxGridForOfVariableSizes**: `boolean` -- **igxGridForOf**: `U & T[]` - -### [IgxGridPinningActionsComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridPinningActionsComponent) -Grid Pinning Actions for the Action Strip - -- **constructor**(iconService: IgxIconService, differs: IterableDiffers): IgxGridPinningActionsComponent -- **pin**(event?: any): void — Pin the row according to the context. -- **scrollToRow**(event: any): void -- **unpin**(event?: any): void — Unpin the row according to the context. - -### [IgxGridRow](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridRow) -Interface representing a row in the grid. It is essentially the blueprint to a row object. -Contains definitions of properties and methods, relevant to a row - -- **parent**: `RowType` — Optional -Contains the parent row of the current row, if it has one. -If the parent row exist, it means that the current row is a child row -- **viewIndex**: `number` — Returns the view index calculated per the grid page. - -### [IgxGridStateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridStateDirective) - -- **stateParsed**: `EventEmitter` — Event emitted when set state is called with a string. -Returns the parsed state object so that it can be further modified before applying to the grid. -this.state.stateParsed.subscribe(parsedState => parsedState.sorting.forEach(x => x.strategy = NoopSortingStrategy.instance()}); -- **options**: `IGridStateOptions` — An object with options determining if a certain feature state should be saved. - - -public options = {selection: false, advancedFiltering: false}; -- **getState**(serialize: boolean, features?: keyof IGridStateOptions | keyof IGridStateOptions[]): string | IGridState — Gets the state of a feature or states of all grid features, unless a certain feature is disabled through the options property. -- **setState**(state: string | IGridState, features?: keyof IGridStateOptions | keyof IGridStateOptions[]): void — Restores grid features' state based on the IGridState object passed as an argument. - -### [IgxGridToolbarActionsComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridToolbarActionsComponent) -Provides a way to template the action portion of the toolbar in the grid. - -- **constructor**(): IgxGridToolbarActionsComponent - -### [IgxGridToolbarAdvancedFilteringComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridToolbarAdvancedFilteringComponent) -Provides a pre-configured button to open the advanced filtering dialog of the grid. - -- **constructor**(toolbar: IgxToolbarToken): IgxGridToolbarAdvancedFilteringComponent -- **overlaySettings**: `OverlaySettings` - -### [IgxGridToolbarComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridToolbarComponent) -Provides a context-aware container component for UI operations for the grid components. - -- **constructor**(api: GridServiceType, iconService: IgxIconService, element: ElementRef): IgxGridToolbarComponent -- **showProgress**: `boolean` — When enabled, shows the indeterminate progress bar. -- **grid**: `GridType` — Gets/sets the grid component for the toolbar component. -- **nativeElement**: `HTMLElement` — Returns the native DOM element of the toolbar component - -### [IgxGridToolbarDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridToolbarDirective) - -- **constructor**(template: TemplateRef): IgxGridToolbarDirective -- **template**: `TemplateRef` -- static **ngTemplateContextGuard**(_dir: IgxGridToolbarDirective, ctx: unknown): ctx - -### [IgxGridToolbarExporterComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridToolbarExporterComponent) -Provides a pre-configured exporter component for the grid. - -- **constructor**(toolbar: IgxToolbarToken, excelExporter: IgxExcelExporterService, csvExporter: IgxCsvExporterService): IgxGridToolbarExporterComponent -- **exportCSV**: `boolean` — Show entry for CSV export. -- **exportEnded**: `EventEmitter` — Emitted on successful ending of an export operation. -- **exportExcel**: `boolean` — Show entry for Excel export. -- **exportStarted**: `EventEmitter` — Emitted when starting an export operation. Re-emitted additionally -by the grid itself. -- **filename**: `string` — The name for the exported file. -- **export**(type: "excel" | "csv"): void — Export the grid's data - -### [IgxGridToolbarHidingComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridToolbarHidingComponent) -Provides a pre-configured column hiding component for the grid. - -- **constructor**(toolbar: IgxToolbarToken): IgxGridToolbarHidingComponent - -### [IgxGridToolbarPinningComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridToolbarPinningComponent) -Provides a pre-configured column pinning component for the grid. - -- **constructor**(toolbar: IgxToolbarToken): IgxGridToolbarPinningComponent - -### [IgxGridToolbarTitleComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGridToolbarTitleComponent) -Provides a way to template the title portion of the toolbar in the grid. - -- **constructor**(): IgxGridToolbarTitleComponent - -### [IgxGroupByRow](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGroupByRow) -Interface representing a row in the grid. It is essentially the blueprint to a row object. -Contains definitions of properties and methods, relevant to a row - -- **grid**: `GridType` — The grid that contains the row. -- **index**: `number` — Returns the row index. -- **isGroupByRow**: `boolean` — Returns always true, because this is in instance of an IgxGroupByRow. -- **children**: `RowType[]` — Optional -Contains the child rows of the current row, if there are any. -- **expanded**: `boolean` — Optional -Indicates whether the current row is expanded. -The value is true, if the row is expanded and false, if it is collapsed -- **groupRow**: `IGroupByRecord` — The IGroupByRecord object, representing the group record, if the row is a GroupByRow. -- **selected**: `boolean` — Optional -Indicates whether the current row is selected -- **viewIndex**: `number` — Returns the view index calculated per the grid page. -- **isActive**(): boolean -- **toggle**(): void — Toggles the group row expanded/collapsed state. -groupRow.toggle() - -### [IgxGroupedTreeGridSorting](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGroupedTreeGridSorting) -Represents a class implementing the IGridSortingStrategy interface. -It provides sorting functionality for grid data based on sorting expressions. - -- **constructor**(): IgxGroupedTreeGridSorting -- static **instance**(): IgxGroupedTreeGridSorting - -### [IgxGrouping](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxGrouping) -Represents a class implementing the IGridGroupingStrategy interface and extending the IgxSorting class. -It provides a method to group data based on the given grouping state. - -- **constructor**(): IgxGrouping -- **groupBy**(data: any[], state: IGroupingState, grid?: any, groupsRecords?: any[], fullResult: IGroupByResult): IGroupByResult — Groups the provided data based on the given grouping state. -Returns an object containing the result of the grouping operation. - -### [IgxHierarchicalGridComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxHierarchicalGridComponent) -Hierarchical grid - -- **constructor**(validationService: IgxGridValidationService, selectionService: IgxGridSelectionService, colResizingService: IgxColumnResizingService, gridAPI: IgxHierarchicalGridAPIService, transactionFactory: IgxFlatTransactionFactory, elementRef: ElementRef, zone: NgZone, document: any, cdr: ChangeDetectorRef, differs: IterableDiffers, viewRef: ViewContainerRef, injector: Injector, envInjector: EnvironmentInjector, navigation: IgxHierarchicalGridNavigationService, filteringService: IgxFilteringService, textHighlightService: IgxTextHighlightService, overlayService: IgxOverlayService, summaryService: IgxGridSummaryService, localeId: string, platform: PlatformUtil, _diTransactions?: TransactionService): IgxHierarchicalGridComponent -- **advancedFilteringExpressionsTree**: `IFilteringExpressionsTree` — Gets/Sets the advanced filtering state. -- **data**: `any[]` — Returns an array of data set to the IgxHierarchicalGridComponent. -let filteredData = this.grid.filteredData; -- **expandChildren**: `boolean` — Gets if all immediate children of the IgxHierarchicalGridComponent previously have been set to be expanded/collapsed. -If previously set and some rows have been manually expanded/collapsed it will still return the last set value. -const expanded = this.grid.expandChildren; -- **foreignKey**: `any` — Gets the unique identifier of the parent row. It may be a string or number if primaryKey of the -parent grid is set or an object reference of the parent record otherwise. -const foreignKey = this.grid.foreignKey; -- **id**: `string` — Represents the unique identifier of the grid. -- **schema**: `EntityType[]` -- **selectedCells**: `CellType[]` — Returns an array of the selected IgxGridCells. -- **totalItemCount**: `number` -- **getCellByColumn**(rowIndex: number, columnField: string): CellType — Returns a CellType object that matches the conditions. -- **getCellByKey**(rowSelector: any, columnField: string): CellType — Returns a CellType object that matches the conditions. -- **getRowByIndex**(index: number): RowType — Returns the RowType by index. -- **getRowByKey**(key: any): RowType — Returns the RowType by key. -- **pinRow**(rowID: any, index?: number): boolean — Pin the row by its id. -- **unpinRow**(rowID: any): boolean — Unpin the row by its id. - -### [IgxHierarchicalGridRow](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxHierarchicalGridRow) -Interface representing a row in the grid. It is essentially the blueprint to a row object. -Contains definitions of properties and methods, relevant to a row - -- **cells**: `CellType[]` — Optional -A list or an array of cells, that belong to the row -- **hasChildren**: `boolean` — Optional -Indicates whether the current row has any child rows -- **viewIndex**: `number` — Returns the view index calculated per the grid page. - -### [IgxHierarchicalTransactionFactory](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxHierarchicalTransactionFactory) -Factory service for instantiating HierarchicalTransactionServices - -- **constructor**(): IgxHierarchicalTransactionFactory -- **create**(type: TRANSACTION_TYPE): HierarchicalTransactionService — Creates a new HierarchialTransaction service instance depending on the specified type. - -### [IgxHintDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxHintDirective) - -- **constructor**(): IgxHintDirective -- **isPositionEnd**: `boolean` — Sets/gets whether the hint position is at the end. -Default value is false. -@ViewChild('hint', {read: IgxHintDirective}) -public igxHint: IgxHintDirective; -this.igxHint.isPositionEnd = true; - -let isHintPositionEnd = this.igxHint.isPositionEnd; -- **isPositionStart**: `boolean` — Sets/gets whether the hint position is at the start. -Default value is false. -@ViewChild('hint', {read: IgxHintDirective}) -public igxHint: IgxHintDirective; -this.igxHint.isPositionStart = true; - -let isHintPositionStart = this.igxHint.isPositionStart; -- **position**: `string` — Gets the position of the hint. -@ViewChild('hint', {read: IgxHintDirective}) -public igxHint: IgxHintDirective; -let hintPosition = this.igxHint.position; - -### [igxI18N](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/igxI18N) - -- **changei18n**(resourceStrings: IResourceStrings): void — Changes the resource strings for all components in the application -@param resourceStrings to be applied -- **getCurrentResourceStrings**(en: IResourceStrings): IResourceStrings -- static **instance**(): igxI18N - -### [IgxIconButtonDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxIconButtonDirective) -The IgxIconButtonDirective provides a way to use an icon as a fully functional button. - -- **constructor**(element: ElementRef): IgxIconButtonDirective -- **type**: `IgxIconButtonType` - -### [IgxIconComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxIconComponent) -Icon provides a way to include material icons to markup - -- **constructor**(el: ElementRef, iconService: IgxIconService, ref: ChangeDetectorRef): IgxIconComponent -- **active**: `boolean` — An -- **ariaHidden**: `boolean` — The aria-hidden attribute of the icon. - By default is set to 'true'. -- **el**: `ElementRef` -- **family**: `string` — An -- **name**: `string` — Set the name of the icon. -- **getActive**: `boolean` — An accessor that returns the value of the active property. -- **getFamily**: `string` — An accessor that returns the value of the family property. -- **getInactive**: `boolean` — An accessor that returns inactive property. -- **getName**: `string` — An accessor that returns the value of the iconName property. -- **getSvg**: `SafeHtml` — An accessor that returns the underlying SVG image as SafeHtml. - -### [IgxIconService](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxIconService) -**Ignite UI for Angular Icon Service** - - -The Ignite UI Icon Service makes it easy for developers to include custom SVG images and use them with IgxIconComponent. -In addition it could be used to associate a custom class to be applied on IgxIconComponent according to given font-family. - -Example: -this.iconService.setFamily('material', { className: 'material-icons', type: 'font' }); -this.iconService.addSvgIcon('aruba', '/assets/svg/country_flags/aruba.svg', 'svg-flags'); - -- **constructor**(_sanitizer: DomSanitizer, _httpClient: HttpClient, _platformUtil: PlatformUtil, _themeToken: ThemeToken, _destroyRef: DestroyRef, document: Document): IgxIconService -- **iconLoaded**: `Observable` — Observable that emits when an icon is successfully loaded -through a HTTP request. -- **defaultFamily**: `IconFamily` — Returns the default font-family. - const defaultFamily = this.iconService.defaultFamily; -- **addIconRef**(name: string, family: string, icon: IconMeta): void — Adds an icon reference meta for an icon in a meta family. - Executes only if no icon reference is found. - this.iconService.addIconRef('aruba', 'default', { name: 'aruba', family: 'svg-flags' }); -- **addSvgIcon**(name: string, url: string, family: string, stripMeta: boolean): void — Adds an SVG image to the cache. SVG source is an url. - this.iconService.addSvgIcon('aruba', '/assets/svg/country_flags/aruba.svg', 'svg-flags'); -- **addSvgIconFromText**(name: string, iconText: string, family: string, stripMeta: boolean): void — Adds an SVG image to the cache. SVG source is its text. - this.iconService.addSvgIconFromText('simple', ' - ', 'svg-flags'); -- **familyClassName**(alias: string): string — Returns the custom class, if any, associated to a given font-family. - const familyClass = this.iconService.familyClassName('material'); -- **getIconRef**(name: string, family: string): IconReference — Returns the icon reference meta for an icon in a given family. - const iconRef = this.iconService.getIconRef('aruba', 'default'); -- **getSvgIcon**(name: string, family: string): SafeHtml — Returns the cached SVG image as string. - const svgIcon = this.iconService.getSvgIcon('aruba', 'svg-flags'); -- **isSvgIconCached**(name: string, family: string): boolean — Returns whether a given SVG image is present in the cache. - const isSvgCached = this.iconService.isSvgIconCached('aruba', 'svg-flags'); -- **registerFamilyAlias**(alias: string, className: string, type: IconType): this — Registers a custom class to be applied to IgxIconComponent for a given font-family. - this.iconService.registerFamilyAlias('material', 'material-icons'); -- **setFamily**(name: string, meta: FamilyMeta): void — Creates a family to className relationship that is applied to the IgxIconComponent - whenever that family name is used. - this.iconService.setFamily('material', { className: 'material-icons', type: 'liga' }); -- **setIconRef**(name: string, family: string, icon: IconMeta): void — Similar to addIconRef, but always sets the icon reference meta for an icon in a meta family. - this.iconService.setIconRef('aruba', 'default', { name: 'aruba', family: 'svg-flags' }); - -### [IgxInputDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxInputDirective) -The igxInput directive creates single- or multiline text elements, covering common scenarios when dealing with form inputs. - -- **constructor**(inputGroup: IgxInputGroupBase, ngModel: NgModel, formControl: NgControl, element: ElementRef, cdr: ChangeDetectorRef, renderer: Renderer2): IgxInputDirective -- **inputGroup**: `IgxInputGroupBase` -- **isInput**: `boolean` — Sets/gets whether the "igx-input-group__input" class is added to the host element. -Default value is false. -- **isTextArea**: `boolean` — Sets/gets whether the "class.igx-input-group__textarea" class is added to the host element. -Default value is false. -- **disabled**: `boolean` — Gets the disabled property -- **focused**: `boolean` — Gets whether the igxInput is focused. -- **hasPlaceholder**: `boolean` — Gets whether the igxInput has a placeholder. -- **isValid**: `boolean` — Gets whether the igxInput is valid. -- **nativeElement**: `HTMLInputElement` — Gets the nativeElement of the igxInput. -- **placeholder**: `string` — Gets the placeholder element of the igxInput. -- **required**: `boolean` — Gets whether the igxInput is required. -- **valid**: `IgxInputState` — Gets the state of the igxInput. -- **value**: `any` — Gets the value property. -- **focus**(): void — Sets a focus on the igxInput. - -### [IgxInputGroupComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxInputGroupComponent) - -- **constructor**(element: ElementRef, _inputGroupType: IgxInputGroupType, document: any, platform: PlatformUtil, cdr: ChangeDetectorRef, themeToken: ThemeToken): IgxInputGroupComponent -- **defaultClass**: `boolean` — Property that enables/disables the auto-generated class of the IgxInputGroupComponent. -By default applied the class is applied. - @ViewChild("MyInputGroup") - public inputGroup: IgxInputGroupComponent; - ngAfterViewInit(){ - this.inputGroup.defaultClass = false; - -} -- **element**: `ElementRef` -- **suppressInputAutofocus**: `boolean` — Prevents automatically focusing the input when clicking on other elements in the input group (e.g. prefix or suffix). -- **hasBorder**: `boolean` — Returns whether the IgxInputGroupComponent has border. -@ViewChild("MyInputGroup") -public inputGroup: IgxInputGroupComponent; -ngAfterViewInit(){ - let inputBorder = this.inputGroup.hasBorder; -} -- **hasHints**: `boolean` — Returns whether the IgxInputGroupComponent has hints. -@ViewChild("MyInputGroup") -public inputGroup: IgxInputGroupComponent; -ngAfterViewInit(){ - let inputHints = this.inputGroup.hasHints; -} -- **isTypeBootstrap**: `boolean` — Returns true if the IgxInputGroupComponent theme is Bootstrap. -@ViewChild("MyInputGroup1") -public inputGroup: IgxInputGroupComponent; -ngAfterViewInit(){ - let isTypeBootstrap = this.inputGroup.isTypeBootstrap; -} -- **isTypeBorder**: `boolean` — Returns whether the IgxInputGroupComponent type is border. -@ViewChild("MyInputGroup1") -public inputGroup: IgxInputGroupComponent; -ngAfterViewInit(){ - let isTypeBorder = this.inputGroup.isTypeBorder; -} -- **isTypeBox**: `boolean` — Returns whether the IgxInputGroupComponent type is box. -@ViewChild("MyInputGroup1") -public inputGroup: IgxInputGroupComponent; -ngAfterViewInit(){ - let isTypeBox = this.inputGroup.isTypeBox; -} -- **isTypeFluent**: `boolean` — Returns true if the IgxInputGroupComponent theme is Fluent. -@ViewChild("MyInputGroup1") -public inputGroup: IgxInputGroupComponent; -ngAfterViewInit(){ - let isTypeFluent = this.inputGroup.isTypeFluent; -} -- **isTypeIndigo**: `boolean` — Returns true if the IgxInputGroupComponent theme is Indigo. -@ViewChild("MyInputGroup1") -public inputGroup: IgxInputGroupComponent; -ngAfterViewInit(){ - let isTypeIndigo = this.inputGroup.isTypeIndigo; -} -- **isTypeLine**: `boolean` — Returns whether the IgxInputGroupComponent type is line. -@ViewChild("MyInputGroup1") -public inputGroup: IgxInputGroupComponent; -ngAfterViewInit(){ - let isTypeLine = this.inputGroup.isTypeLine; -} -- **isTypeSearch**: `boolean` — Returns whether the IgxInputGroupComponent type is search. -@ViewChild("MyInputGroup1") -public inputGroup: IgxInputGroupComponent; -ngAfterViewInit(){ - let isTypeSearch = this.inputGroup.isTypeSearch; -} -- **resourceStrings**: `IInputResourceStrings` — Returns the resource strings. -- **theme**: `IgxTheme` — Returns the theme of the input. -The returned value is of type IgxInputGroupType. -@ViewChild("MyInputGroup") -public inputGroup: IgxInputGroupComponent; -ngAfterViewInit() { - let inputTheme = this.inputGroup.theme; -} -- **type**: `IgxInputGroupType` — Returns the type of the IgxInputGroupComponent. How the input is styled. -The default is line. -@ViewChild("MyInputGroup") -public inputGroup: IgxInputGroupComponent; -ngAfterViewInit(){ - let inputType = this.inputGroup.type; -} - -### [IgxInsertDropStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxInsertDropStrategy) - -- **constructor**(_renderer: Renderer2): IgxInsertDropStrategy -- **dropAction**(drag: IgxDragDirective, drop: IgxDropDirective, atIndex: number): void - -### [IgxLabelDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxLabelDirective) - -- **constructor**(): IgxLabelDirective -- **defaultClass**: `boolean` - -### [IgxLayoutDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxLayoutDirective) - -- **constructor**(): IgxLayoutDirective -- **dir**: `string` — Sets the default flow direction of the container's children. - -Defaults to rows. - -
-
1
-
2
-
3
-
-- **itemAlign**: `string` — Defines the default behavior for how children are laid out along the corss axis of the current line. - -Defaults to flex-start. - -Other possible values are flex-end, center, baseline, and stretch. - -
-
1
-
2
-
3
-
-- **justify**: `string` — Defines the alignment along the main axis. - -Defaults to flex-start which packs the children toward the start line. - -Other possible values are flex-end, center, space-between, space-around. - -
-
1
-
2
-
3
-
-- **reverse**: `boolean` — Defines the direction flex children are placed in the flex container. - -When set to true, the rows direction goes right to left and columns goes bottom to top. - -
-
1
-
2
-
3
-
-- **wrap**: `string` — By default the immediate children will all try to fit onto one line. - -The default value nowrap sets this behavior. - -Other accepted values are wrap and wrap-reverse. - -
-
1
-
2
-
3
-
- -### [IgxLinearProgressBarComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxLinearProgressBarComponent) - -- **constructor**(): IgxLinearProgressBarComponent -- **cssClass**: `string` -- **id**: `string` — Sets the value of id attribute. If not provided it will be automatically generated. - -- **role**: `string` — Sets the value of the role attribute. If not provided it will be automatically set to progressbar. - -- **striped**: `boolean` — Set IgxLinearProgressBarComponent to have striped style. By default it is set to false. - -- **textAlign**: `IgxTextAlign` — Set the position that defines where the text is aligned. -Possible options - IgxTextAlign.START (default), IgxTextAlign.CENTER, IgxTextAlign.END. -public positionCenter: IgxTextAlign; -public ngOnInit() { - this.positionCenter = IgxTextAlign.CENTER; -} - //... - - -- **textTop**: `boolean` — Set the position that defines if the text should be aligned above the progress line. By default, is set to false. - -- **textVisibility**: `boolean` — Set the text to be visible. By default, it is set to true. - -- **type**: `string` — Set type of the IgxLinearProgressBarComponent. Possible options - default, success, info, warning, and error. - -- **valueMin**: `number` -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. - -### [IgxListActionDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxListActionDirective) -igxListAction is container for the List action -Use it to wrap anything you want to be used as a list action: icon, checkbox... - -- **constructor**(): IgxListActionDirective - -### [IgxListComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxListComponent) -Displays a collection of data items in a templatable list format - -- **constructor**(element: ElementRef): IgxListComponent -- **allowLeftPanning**: `boolean` — Sets/gets whether the left panning of an item is allowed. -- **allowRightPanning**: `boolean` — Sets/gets whether the right panning of an item is allowed. -- **children**: `QueryList` — Returns a collection of all items and headers in the list. -- **dataLoadingTemplate**: `IgxDataLoadingTemplateDirective` — Sets/gets the list loading template. -- **element**: `ElementRef` -- **emptyListTemplate**: `IgxEmptyListTemplateDirective` — Sets/gets the empty list template. -- **endPan**: `EventEmitter` — Event emitted when a pan gesture is completed or canceled. -- **id**: `string` — Sets/gets the id of the list. -- **isLoading**: `boolean` — Sets/gets whether the list is currently loading data. -- **itemClicked**: `EventEmitter` — Event emitted when a list item is clicked. -- **leftPan**: `EventEmitter` — Event emitted when a left pan gesture is executed on a list item. -- **listItemLeftPanningTemplate**: `IgxListItemLeftPanningTemplateDirective` — Sets/gets the template for left panning a list item. -- **listItemRightPanningTemplate**: `IgxListItemRightPanningTemplateDirective` — Sets/gets the template for right panning a list item. -- **panEndTriggeringThreshold**: `number` — Provides a threshold after which the item's panning will be completed automatically. -- **panStateChange**: `EventEmitter` — Event emitted when a pan gesture is executed on a list item. -- **resetPan**: `EventEmitter` — Event emitted when a pan item is returned to its original position. -- **rightPan**: `EventEmitter` — Event emitted when a right pan gesture is executed on a list item. -- **startPan**: `EventEmitter` — Event emitted when a pan gesture is started. -- **context**: `any` — Gets the context object of the template binding. -- **headers**: `IgxListItemComponent[]` — Gets the header list items. -- **isListEmpty**: `boolean` — Gets a boolean indicating if the list is empty. -- **items**: `IgxListItemComponent[]` — Gets the list items excluding the header ones. -- **resourceStrings**: `IListResourceStrings` — Returns the resource strings. -- **role**: `string` — Gets/Sets the role attribute value. -- **template**: `TemplateRef` — Gets a TemplateRef to the currently used template. - -### [IgxListItemComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxListItemComponent) -The Ignite UI List Item component is a container intended for row items in the Ignite UI for Angular List component. - -Example: - - Contacts - - {{ contact.name }} - {{ contact.phone }} - - - -- **constructor**(list: IgxListBaseDirective, elementRef: ElementRef, _renderer: Renderer2): IgxListItemComponent -- **ariaLabel**: `string` — Sets/gets the aria-label attribute of the list item. -this.listItem.ariaLabel = "Item1"; - -let itemAriaLabel = this.listItem.ariaLabel; -- **hidden**: `boolean` — Sets/gets whether the list item is hidden. -By default the hidden value is false. -Hidden Item - -let isHidden = this.listItem.hidden; -- **isHeader**: `boolean` — Sets/gets whether the list item is a header. -Header - -let isHeader = this.listItem.isHeader; -- **leftPanningTemplateElement**: `any` — Provides a reference to the template's base element shown when left panning a list item. -const leftPanTmpl = this.listItem.leftPanningTemplateElement; -- **list**: `IgxListBaseDirective` -- **rightPanningTemplateElement**: `any` — Provides a reference to the template's base element shown when right panning a list item. -const rightPanTmpl = this.listItem.rightPanningTemplateElement; -- **touchAction**: `string` — Gets the touch-action style of the list item. -let touchAction = this.listItem.touchAction; -- **contentElement**: `any` — Returns a reference container which contains the list item's content. -let listItemContainer = this.listItem.contentElement. -- **context**: `any` — Returns the context object which represents the template context binding into the list item container -by providing the $implicit declaration which is the IgxListItemComponent itself. -let listItemComponent = this.listItem.context; -- **display**: `string` — Returns string value which describes the display mode of the list item. -let isHidden = this.listItem.display; -- **element**: `any` — Returns an element reference to the list item. -let listItemElement = this.listItem.element. -- **headerStyle**: `boolean` — Indicates whether list item should have header style. -let headerStyle = this.listItem.headerStyle; -- **index**: `number` — Gets the index of a list item. -let itemIndex = this.listItem.index; -- **innerStyle**: `boolean` — Applies the inner style of the list item if the item is not counted as header. -let innerStyle = this.listItem.innerStyle; -- **maxLeft**: `number` — Gets the maximum left position of the list item. -let maxLeft = this.listItem.maxLeft; -- **maxRight**: `any` — Gets the maximum right position of the list item. -let maxRight = this.listItem.maxRight; -- **panState**: `IgxListPanState` — Gets the panState of a list item. -let itemPanState = this.listItem.panState; -- **role**: `string` — Gets/Sets the role attribute of the list item. -let itemRole = this.listItem.role; -- **selected**: `boolean` — Sets/gets whether the list item is selected. -Selection is only applied to non-header items. -When selected, the CSS class 'igx-list__item-base--selected' is added to the item. -Selected Item - -let isSelected = this.listItem.selected; -this.listItem.selected = true; -- **width**: `any` — Gets the width of a list item. -let itemWidth = this.listItem.width; - -### [IgxListItemLeftPanningTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxListItemLeftPanningTemplateDirective) - -- **constructor**(template: TemplateRef): IgxListItemLeftPanningTemplateDirective -- **template**: `TemplateRef` - -### [IgxListItemRightPanningTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxListItemRightPanningTemplateDirective) - -- **constructor**(template: TemplateRef): IgxListItemRightPanningTemplateDirective -- **template**: `TemplateRef` - -### [IgxListLineDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxListLineDirective) -igxListLine is container for the List text content -Use it to wrap anything you want to be used as a plane text. - -- **constructor**(): IgxListLineDirective - -### [IgxListLineSubTitleDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxListLineSubTitleDirective) -igxListLineSubTitle is a directive that add class to the target element -Use it to make anything to look like list Subtitle. - -- **constructor**(): IgxListLineSubTitleDirective -- **cssClass**: `string` - -### [IgxListLineTitleDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxListLineTitleDirective) -igxListLineTitle is a directive that add class to the target element -Use it to make anything to look like list Title. - -- **constructor**(): IgxListLineTitleDirective -- **cssClass**: `string` - -### [IgxListThumbnailDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxListThumbnailDirective) -igxListThumbnail is container for the List media -Use it to wrap anything you want to be used as a thumbnail. - -- **constructor**(): IgxListThumbnailDirective - -### [IgxMaskDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxMaskDirective) - -- **constructor**(elementRef: ElementRef, maskParser: MaskParsingService, renderer: Renderer2, platform: PlatformUtil): IgxMaskDirective -- **displayValuePipe**: `PipeTransform` — Specifies a pipe to be used on blur. - -- **focusedValuePipe**: `PipeTransform` — Specifies a pipe to be used on focus. - -- **includeLiterals**: `boolean` — Specifies if the bound value includes the formatting symbols. - -- **promptChar**: `string` — Sets the character representing a fillable spot in the input mask. -Default value is "'_'". - -- **valueChanged**: `EventEmitter` — Emits an event each time the value changes. -Provides rawValue: string and formattedValue: string as event arguments. - -- **mask**: `string` — Sets the input mask. - - -### [IgxMonthPickerComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxMonthPickerComponent) - -- **id**: `string` — Sets/gets the id of the month picker. -If not set, the id will have value "igx-month-picker-0". -- **ngAfterViewInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of a component's view. -It is invoked only once when the view is instantiated. -- **ngOnInit**(): void — 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. -- **selectDate**(value: Date): Date — Selects a date. - this.monthPicker.selectDate(new Date(2018-06-12)); - -### [IgxMonthsViewComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxMonthsViewComponent) - -- **constructor**(el: ElementRef, dayInterval: DayInterval): IgxMonthsViewComponent -- **el**: `ElementRef` -- **formatView**: `boolean` — Gets/sets whether the view should be rendered -according to the locale and format, if any. -- **id**: `string` — Sets/gets the id of the months view. -If not set, the id will have value "igx-months-view-0". - - -let monthsViewId = this.monthsView.id; -- **monthFormat**: `any` — Gets the month format option of the months view. -let monthFormat = this.monthsView.monthFormat. -- **standalone**: `boolean` - -### [IgxNavbarActionDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxNavbarActionDirective) -IgxActionIcon is a container for the action nav icon of the IgxNavbar. - -- **constructor**(): IgxNavbarActionDirective - -### [IgxNavbarComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxNavbarComponent) -**Ignite UI for Angular Navbar** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/navbar.html) - -The Ignite UI Navbar is most commonly used to provide an app header with a hamburger menu and navigation -state such as a "Go Back" button. It also supports other actions represented by icons. - -Example: - - search - favorite - more_vert - - -- **constructor**(): IgxNavbarComponent -- **action**: `EventEmitter` — The event that will be thrown when the action is executed, -provides reference to the IgxNavbar component as argument -public actionExc(event){ - alert("Action Execute!"); -} - //.. - - -- **actionButtonIcon**: `string` — Sets the icon of the IgxNavbarComponent. - -- **id**: `string` — Sets the value of the id attribute. If not provided it will be automatically generated. - -- **title**: `string` — Sets the title of the IgxNavbarComponent. - -- **titleId**: `string` — Sets the titleId of the IgxNavbarComponent. If not set it will be automatically generated. - -- **isActionButtonVisible**: `boolean` — Returns whether the IgxNavbarComponent action button is visible, true/false. - @ViewChild("MyChild") -public navBar: IgxNavbarComponent; -ngAfterViewInit(){ - let actionButtonVisibile = this.navBar.isActionButtonVisible; -} -- **isTitleContentVisible**: `boolean` - -### [IgxNavbarTitleDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxNavbarTitleDirective) - -- **constructor**(): IgxNavbarTitleDirective - -### [IgxNavDrawerItemDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxNavDrawerItemDirective) - -- **constructor**(): IgxNavDrawerItemDirective -- **active**: `boolean` — Styles a navigation drawer item as selected. -If not set, active will have default value false. -- **disabled**: `boolean` — Disables a navigation drawer item. -If not set, disabled will have default value false. -- **isHeader**: `boolean` — Styles a navigation drawer item as a group header. -If not set, isHeader will have default value false. - -### [IgxNavDrawerMiniTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxNavDrawerMiniTemplateDirective) - -- **constructor**(template: TemplateRef): IgxNavDrawerMiniTemplateDirective -- **template**: `TemplateRef` - -### [IgxNavDrawerTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxNavDrawerTemplateDirective) - -- **constructor**(template: TemplateRef): IgxNavDrawerTemplateDirective -- **template**: `TemplateRef` - -### [IgxNavigationCloseDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxNavigationCloseDirective) -Directive that can close targets through provided NavigationService. - -Usage: - - -Where the ID matches the ID of compatible IToggleView component. - -- **constructor**(nav: IgxNavigationService): IgxNavigationCloseDirective -- **state**: `IgxNavigationService` -- **closeNavigationDrawer**(): void - -### [IgxNavigationDrawerComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxNavigationDrawerComponent) -**Ignite UI for Angular Navigation Drawer** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/navdrawer) - -The Ignite UI Navigation Drawer is a collapsible side navigation container commonly used in combination with the Navbar. - -Example: - - - - - - -- **constructor**(elementRef: ElementRef, _state: IgxNavigationService, renderer: Renderer2, _touchManager: HammerGesturesManager, platformUtil: PlatformUtil): IgxNavigationDrawerComponent -- **closed**: `EventEmitter` — Event fired when the Navigation Drawer has closed. - - -- **closing**: `EventEmitter` — Event fired as the Navigation Drawer is about to close. - - -- **disableAnimation**: `boolean` — Enables/disables the animation, when toggling the drawer. Set to false by default. -html - -- **enableGestures**: `boolean` — Enables the use of touch gestures to manipulate the drawer: -- swipe/pan from edge to open, swipe-toggle and pan-drag. - -// get -let gesturesEnabled = this.navdrawer.enableGestures; - - - - -- **id**: `string` — ID of the component - -// get -let myNavDrawerId = this.navdrawer.id; - - - - -- **miniWidth**: `string` — Width of the drawer in its mini state. - -// get -let navDrawerMiniWidth = this.navdrawer.miniWidth; - - - - -- **opened**: `EventEmitter` — Event fired when the Navigation Drawer has opened. - - -- **opening**: `EventEmitter` — Event fired as the Navigation Drawer is about to open. - - -- **pin**: `boolean` — When pinned the drawer is relatively positioned instead of sitting above content. -May require additional layout styling. - -// get -let navDrawerIsPinned = this.navdrawer.pin; - - - - -- **pinChange**: `EventEmitter` — Pinned state change output for two-way binding. - - -- **pinThreshold**: `number` — Minimum device width required for automatic pin to be toggled. -Default is 1024, can be set to a falsy value to disable this behavior. - -// get -let navDrawerPinThreshold = this.navdrawer.pinThreshold; - - - - -- **position**: `string` — Position of the Navigation Drawer. Can be "left"(default) or "right". - -// get -let myNavDrawerPosition = this.navdrawer.position; - - - - -- **isOpen**: `boolean` — State of the drawer. - -// get -let navDrawerIsOpen = this.navdrawer.isOpen; - - - - - - -Two-way data binding. - - -- **width**: `string` -- **close**(): void — Close the Navigation Drawer. Has no effect if already closed. - -this.navdrawer.close(); -- **open**(): void — Open the Navigation Drawer. Has no effect if already opened. - -this.navdrawer.open(); -- **toggle**(): void — Toggle the open state of the Navigation Drawer. - -this.navdrawer.toggle(); - -### [IgxNavigationService](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxNavigationService) -Common service to be injected between components where those implementing common -ToggleView interface can register and toggle directives can call their methods. -TODO: Track currently active? Events? - -- **constructor**(): IgxNavigationService -- **add**(id: string, navItem: IToggleView): void -- **close**(id: string, args: any[]): any -- **get**(id: string): IToggleView -- **open**(id: string, args: any[]): any -- **remove**(id: string): void -- **toggle**(id: string, args: any[]): any - -### [IgxNavigationToggleDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxNavigationToggleDirective) -Directive that can toggle targets through provided NavigationService. - -Usage: - - -Where the ID matches the ID of compatible IToggleView component. - -- **constructor**(nav: IgxNavigationService): IgxNavigationToggleDirective -- **state**: `IgxNavigationService` -- **toggleNavigationDrawer**(): void - -### [IgxNumberFilteringOperand](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxNumberFilteringOperand) -Provides filtering operations for numbers - - -### [IgxNumberSummaryOperand](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxNumberSummaryOperand) - -- **constructor**(): IgxNumberSummaryOperand -- **operate**(data: any[], allData: any[], fieldName?: string, groupRecord?: IGroupByRecord): IgxSummaryResult[] — Executes the static methods and returns IgxSummaryResult[]. -interface IgxSummaryResult { - key: string; - label: string; - summaryResult: any; -} - -Can be overridden in the inherited classes to provide customization for the summary. -class CustomNumberSummary extends IgxNumberSummaryOperand { - constructor() { - super(); - } - public operate(data: any[], allData: any[], fieldName: string, groupRecord: IGroupByRecord): IgxSummaryResult[] { - const result = super.operate(data, allData, fieldName, groupRecord); - result.push({ - key: "avg", - label: "Avg", - summaryResult: IgxNumberSummaryOperand.average(data) - }); - result.push({ - key: 'mdn', - label: 'Median', - summaryResult: this.findMedian(data) - }); - return result; - } -} -this.grid.getColumnByName('ColumnName').summaries = CustomNumberSummary; -- static **average**(data: any[]): number — Returns the average numeric value in the data provided data records. -If filtering is applied, returns the average numeric value in the filtered data records. -IgxSummaryOperand.average(data); -- static **max**(data: any[]): number — Returns the maximum numeric value in the provided data records. -If filtering is applied, returns the maximum value in the filtered data records. -IgxNumberSummaryOperand.max(data); -- static **min**(data: any[]): number — Returns the minimum numeric value in the provided data records. -If filtering is applied, returns the minimum value in the filtered data records. -IgxNumberSummaryOperand.min(data); -- static **sum**(data: any[]): number — Returns the sum of the numeric values in the provided data records. -If filtering is applied, returns the sum of the numeric values in the data records. -IgxNumberSummaryOperand.sum(data); - -### [IgxOverlayOutletDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxOverlayOutletDirective) -Mark an element as an igxOverlay outlet container. -Directive instance is exported as overlay-outlet to be assigned to templates variables: -
- -- **constructor**(element: ElementRef): IgxOverlayOutletDirective -- **element**: `ElementRef` - -### [IgxOverlayService](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxOverlayService) -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-main) -The overlay service allows users to show components on overlay div above all other elements in the page. - -- **constructor**(_appRef: ApplicationRef, document: any, _zone: NgZone, platformUtil: PlatformUtil, animationService: AnimationService): IgxOverlayService -- **animationStarting**: `EventEmitter` — Emitted just before the overlay animation start. -animationStarting(event: OverlayAnimationEventArgs){ - const animationStarting = event; -} -- **closed**: `EventEmitter` — Emitted after the overlay content is closed and all animations are finished. -closed(event: OverlayEventArgs){ - const closed = event; -} -- **closing**: `EventEmitter` — Emitted just before the overlay content starts to close. -closing(event: OverlayCancelableEventArgs){ - const closing = event; -} -- **contentAppended**: `EventEmitter` — Emitted after the content is appended to the overlay, and before animations are started. -contentAppended(event: OverlayEventArgs){ - const contentAppended = event; -} -- **contentAppending**: `EventEmitter` — Emitted before the content is appended to the overlay. -contentAppending(event: OverlayEventArgs){ - const contentAppending = event; -} -- **opened**: `EventEmitter` — Emitted after the overlay content is opened and all animations are finished. -opened(event: OverlayEventArgs){ - const opened = event; -} -- **opening**: `EventEmitter` — Emitted just before the overlay content starts to open. -opening(event: OverlayCancelableEventArgs){ - const opening = event; -} -- **attach**(element: ElementRef, settings?: OverlaySettings): string — Generates Id. Provide this Id when call show(id) method -- **attach**(component: Type$1, settings?: OverlayCreateSettings): string — Generates Id. Provide this Id when call show(id) method - -Note created instance is in root scope, prefer the viewContainerRef overload when local injection context is needed. -- **attach**(component: Type$1, viewContainerRef: ViewContainerRef, settings?: OverlaySettings): string — Generates an Id. Provide this Id when calling the show(id) method -- **detach**(id: string): void — Remove overlay with the provided id. -- **detachAll**(): void — Remove all the overlays. -this.overlay.detachAll(); -- **hide**(id: string, event?: Event): void — Hides the component with the ID provided as a parameter. -this.overlay.hide(id); -- **hideAll**(): void — Hides all the components and the overlay. -this.overlay.hideAll(); -- **reposition**(id: string): void — Repositions the component with ID provided as a parameter. -- **setOffset**(id: string, deltaX: number, deltaY: number, offsetMode?: OffsetMode): void — Offsets the content along the corresponding axis by the provided amount with optional offsetMode that determines whether to add (by default) or set the offset values -- **show**(id: string, settings?: OverlaySettings): void — Shows the overlay for provided id. -- static **createAbsoluteOverlaySettings**(position?: AbsolutePosition, outlet?: ElementRef | IgxOverlayOutletDirective): OverlaySettings — Creates overlay settings with global or container position strategy and preset position settings -- static **createRelativeOverlaySettings**(target: HTMLElement | Point, position?: RelativePosition, strategy?: RelativePositionStrategy): OverlaySettings — Creates overlay settings with auto, connected or elastic position strategy and preset position settings - -### [IgxPageNavigationComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPageNavigationComponent) - -- **constructor**(paginator: IgxPaginatorComponent): IgxPageNavigationComponent -- **paginator**: `IgxPaginatorComponent` -- **role**: `string` — Sets the role attribute of the element. - -### [IgxPageSizeSelectorComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPageSizeSelectorComponent) - -- **constructor**(paginator: IgxPaginatorComponent): IgxPageSizeSelectorComponent -- **paginator**: `IgxPaginatorComponent` - -### [IgxPaginatorComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPaginatorComponent) -Paginator component description - -- **constructor**(elementRef: ElementRef, cdr: ChangeDetectorRef): IgxPaginatorComponent -- **pageChange**: `EventEmitter` — Emitted after the current page is changed. -- **paging**: `EventEmitter` — Emitted before paging is performed. -- **pagingDone**: `EventEmitter` — Emitted after paging is performed. -- **perPageChange**: `EventEmitter` — Emitted when perPage property value of the paginator is changed. -- **totalPages**: `number` — Total pages calculated from totalRecords and perPage -- **isFirstPage**: `boolean` — Returns if the current page is the first page. -const lastPage = this.paginator.isFirstPage; -- **isLastPage**: `boolean` — Returns if the current page is the last page. -const lastPage = this.paginator.isLastPage; -- **nativeElement**: `any` -- **overlaySettings**: `OverlaySettings` — Sets custom OverlaySettings. - -- **page**: `number` — Gets/Sets the current page of the paginator. -The default is 0. -let page = this.paginator.page; -- **perPage**: `number` — Gets/Sets the number of visible items per page in the paginator. -The default is 15. -let itemsPerPage = this.paginator.perPage; -- **resourceStrings**: `IPaginatorResourceStrings` — An accessor that returns the resource strings. -- **selectOptions**: `number[]` — Sets custom options in the select of the paginator -let options = this.paginator.selectOptions; -- **totalRecords**: `number` — Sets the total records. -let totalRecords = this.paginator.totalRecords; -- **nextPage**(): void — Goes to the next page of the IgxPaginatorComponent, if the paginator is not already at the last page. -this.paginator.nextPage(); -- **paginate**(val: number): void — Goes to the desired page index. -this.paginator.paginate(1); -- **previousPage**(): void — Goes to the previous page of the IgxPaginatorComponent, if the paginator is not already at the first page. -this.paginator.previousPage(); - -### [IgxPaginatorContentDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPaginatorContentDirective) - -- **constructor**(): IgxPaginatorContentDirective - -### [IgxPaginatorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPaginatorDirective) - -- **constructor**(template: TemplateRef): IgxPaginatorDirective -- **template**: `TemplateRef` - -### [IgxPickerActionsDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPickerActionsDirective) -IgxPickerActionsDirective can be used to re-template the dropdown/dialog action buttons. - -- **constructor**(template: TemplateRef): IgxPickerActionsDirective -- **template**: `TemplateRef` - -### [IgxPickerClearComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPickerClearComponent) -Templates the default clear icon in the picker. - -- **constructor**(): IgxPickerClearComponent - -### [IgxPickerToggleComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPickerToggleComponent) -Templates the default toggle icon in the picker. - -- **constructor**(): IgxPickerToggleComponent -- **clicked**: `EventEmitter` -- **onClick**(event: MouseEvent): void - -### [IgxPivotAggregate](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPivotAggregate) - -- **constructor**(): IgxPivotAggregate -- static **aggregators**(): IPivotAggregator[] — Gets array with default aggregator function for base aggregation. -IgxPivotAggregate.aggregators(); -- static **count**(members: number[]): number — Counts all the records in the data source. -If filtering is applied, counts only the filtered records. -IgxSummaryOperand.count(dataSource); - -### [IgxPivotDataSelectorComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPivotDataSelectorComponent) -Pivot Data Selector provides means to configure the pivot state of the Pivot Grid via a vertical panel UI - -- **constructor**(renderer: Renderer2, cdr: ChangeDetectorRef): IgxPivotDataSelectorComponent -- **animationSettings**: `any` -- **columnsExpanded**: `boolean` — Gets/sets whether the columns panel is expanded -Get - const columnsPanelState: boolean = this.dataSelector.columnsExpanded; - -Set - - - -Two-way data binding: - -- **columnsExpandedChange**: `EventEmitter` — Emitted when the columns panel is expanded or collapsed. -- **filtersExpanded**: `boolean` — Gets/sets whether the filters panel is expanded -Get - const filtersPanelState: boolean = this.dataSelector.filtersExpanded; - -Set - - - -Two-way data binding: - -- **filtersExpandedChange**: `EventEmitter` — Emitted when the filters panel is expanded or collapsed. -- **rowsExpanded**: `boolean` — Gets/sets whether the rows panel is expanded -Get - const rowsPanelState: boolean = this.dataSelector.rowsExpanded; - -Set - - - -Two-way data binding: - -- **rowsExpandedChange**: `EventEmitter` — Emitted when the rows panel is expanded or collapsed. -- **valuesExpanded**: `boolean` — Gets/sets whether the values panel is expanded -Get - const valuesPanelState: boolean = this.dataSelector.valuesExpanded; - -Set - - - -Two-way data binding: - -- **valuesExpandedChange**: `EventEmitter` — Emitted when the values panel is expanded or collapsed. -- **grid**: `PivotGridType` — Returns the grid. - -### [IgxPivotDateAggregate](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPivotDateAggregate) - -- **constructor**(): IgxPivotDateAggregate -- static **aggregators**(): IPivotAggregator[] — Gets array with default aggregator function for date aggregation. -IgxPivotDateAggregate.aggregators(); -- static **earliest**(members: any[]): any — Returns the earliest date value in the data records. -If filtering is applied, returns the latest date value in the filtered data records. -IgxPivotDateAggregate.earliest(data); -- static **latest**(members: any[]): any — Returns the latest date value in the data records. -If filtering is applied, returns the latest date value in the filtered data records. -IgxPivotDateAggregate.latest(data); - -### [IgxPivotDateDimension](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPivotDateDimension) -Configuration of a pivot dimension. - -- **constructor**(inBaseDimension: IPivotDimension, inOptions: IPivotDateDimensionOptions): IgxPivotDateDimension -- **dataType**: `GridColumnDataType` — Gets/Sets data type -- **defaultOptions**: `any` — Default options. -- **displayName**: `string` — Display name to show instead of the field name of this value. * -- **enabled**: `boolean` — Enables/Disables a particular dimension from pivot structure. -- **baseDimension**: `IPivotDimension` — Gets/Sets the base dimension that is used by this class to determine the other dimensions and their values. -Having base dimension set is required in order for the Date Dimensions to show. -- **options**: `IPivotDateDimensionOptions` — Gets/Sets the options for the predefined date dimensions whether to show quarter, years and etc. -- **resourceStrings**: `IGridResourceStrings` - -### [IgxPivotGridComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPivotGridComponent) -Pivot Grid provides a way to present and manipulate data in a pivot table view. - -- **constructor**(validationService: IgxGridValidationService, selectionService: IgxGridSelectionService, colResizingService: IgxPivotColumnResizingService, gridAPI: GridBaseAPIService, transactionFactory: IgxFlatTransactionFactory, elementRef: ElementRef, zone: NgZone, document: any, cdr: ChangeDetectorRef, differs: IterableDiffers, viewRef: ViewContainerRef, injector: Injector, envInjector: EnvironmentInjector, navigation: IgxPivotGridNavigationService, filteringService: IgxFilteringService, textHighlightService: IgxTextHighlightService, overlayService: IgxOverlayService, summaryService: IgxGridSummaryService, localeId: string, platform: PlatformUtil, _diTransactions?: TransactionService): IgxPivotGridComponent -- **autoGenerateConfig**: `boolean` — Gets/Sets whether to auto-generate the pivot configuration based on the provided data. -- **dimensionInit**: `EventEmitter` — Emitted when the dimension is initialized. -- **dimensionsChange**: `EventEmitter` — Emitted when the dimension collection is changed via the grid chip area. -- **dimensionsSortingExpressionsChange**: `EventEmitter[]>` — Emitted when a dimension is sorted. -- **emptyPivotGridTemplate**: `TemplateRef` — Gets/Sets a custom template when pivot grid is empty. -- **pivotConfigurationChange**: `EventEmitter` — Emitted when any of the pivotConfiguration properties is changed via the grid chip area. -- **rowDimensionHeaderTemplate**: `TemplateRef` -- **valueChipTemplate**: `TemplateRef` — Gets/Sets a custom template for the value chips. -- **valueInit**: `EventEmitter` — Emitted when the value is initialized. -- **valuesChange**: `EventEmitter` — Emitted when the values collection is changed via the grid chip area. -- **allDimensions**: `IPivotDimension[]` — An array of all dimensions (rows and columns) in the pivot grid. -it includes hierarchical level, filters and sorting, dimensional level, etc. -- **allowAdvancedFiltering**: `boolean` -- **allowFiltering**: `boolean` — Indicates whether filtering in the grid is enabled. If te value is true, the grid can be filtered -- **batchEditing**: `boolean` -- **data**: `any[]` — Returns an array of data set to the component. -let data = this.grid.data; -- **defaultExpandState**: `boolean` — Gets/Sets the default expand state for all rows. -- **dimensionsSortingExpressions**: `ISortingExpression[]` — Gets the sorting expressions generated for the dimensions. -- **dragIndicatorIconTemplate**: `TemplateRef` — The template for drag indicator icons. Could be of any type -- **filterMode**: `FilterMode` — The filter mode for the grid. It can be quick filter of excel-style filter -- **hideRowSelectors**: `boolean` -- **id**: `string` — Represents the unique identifier of the grid. -- **pagingMode**: `GridPagingMode` — Represents the paging of the grid. It can be either 'Local' or 'Remote' -- Local: Default value; The grid will paginate the data source based on the page -- **pinning**: `any` — The configuration for columns and rows pinning in the grid -It's of type IPinningConfig, which can have value for columns (start, end) and for rows (top, bottom) -- **pivotConfiguration**: `IPivotConfiguration` — The configuration settings for the pivot grid. -it includes dimension strategy for rows and columns, filters and data keys -- **pivotUI**: `IPivotUISettings` — Specifies whether to show the pivot configuration UI in the grid. -- **pivotValueCloneStrategy**: `IDataCloneStrategy` -- **rowDraggable**: `boolean` — Indicates whether rows in the grid can be dragged. If te value is true, the rows can be dragged -- **rowEditable**: `boolean` — Indicates whether rows in the grid are editable. If te value is true, the rows can be edited -- **selectedRows**: `any[]` — Gets/Sets the current selection state. -- **shouldGenerate**: `boolean` -- **showSummaryOnCollapse**: `boolean` -- **summaryCalculationMode**: `GridSummaryCalculationMode` — Represents the calculation mode for summaries: 'rootLevelOnly', 'childLevelsOnly', 'rootAndChildLevels' -- **summaryPosition**: `GridSummaryPosition` — Represents the position of summaries: 'top', 'bottom' -- **summaryRowHeight**: `number` — Get/Set IgxSummaryRow height -- **superCompactMode**: `boolean` — Enables a super compact theme for the component. -- **totalRecords**: `number` -- **autoSizeRowDimension**(dimension: IPivotDimension): void — Auto-sizes row dimension cells. -- **filterDimension**(dimension: IPivotDimension, value: any, conditionOrExpressionTree?: IFilteringOperation | IFilteringExpressionsTree): void — Filters a single IPivotDimension. -- **getColumnGroupExpandState**(col: IgxColumnComponent): boolean -- **insertDimensionAt**(dimension: IPivotDimension, targetCollectionType: PivotDimensionType, index?: number): void — Inserts dimension in target collection by type at specified index or at the collection's end. -- **insertValueAt**(value: IPivotValue, index?: number): void — Inserts value at specified index or at the end. -- **moveDimension**(dimension: IPivotDimension, targetCollectionType: PivotDimensionType, index?: number): void — Move dimension from its currently collection to the specified target collection by type at specified index or at the collection's end. -- **moveValue**(value: IPivotValue, index?: number): void — Move value from its currently at specified index or at the end. -- **notifyDimensionChange**(regenerateColumns: boolean): void — Notifies for dimension change. -- **removeDimension**(dimension: IPivotDimension): void — Removes dimension from its currently collection. -- **removeValue**(value: IPivotValue): void — Removes value from collection. -- **sortDimension**(dimension: IPivotDimension, sortDirection: SortingDirection): void — Sort the dimension and its children in the provided direction. -- **toggleColumn**(col: IgxColumnComponent): void -- **toggleDimension**(dimension: IPivotDimension): void — Toggles the dimension's enabled state on or off. -- **toggleRowGroup**(col: IgxColumnComponent, newState: boolean): void -- **toggleValue**(value: IPivotValue): void — Toggles the value's enabled state on or off. - -### [IgxPivotGridRow](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPivotGridRow) -Interface representing a row in the grid. It is essentially the blueprint to a row object. -Contains definitions of properties and methods, relevant to a row - -- **constructor**(grid: IgxPivotGridComponent, index: number, data?: any): IgxPivotGridRow -- **grid**: `IgxPivotGridComponent` — The grid that contains the row. -- **index**: `number` — The index of the row within the grid -- **data**: `any` — The data passed to the row component. -- **key**: `any` — Gets the row key. -A row in the grid is identified either by: -- primaryKey data value, -- the whole rowData, if the primaryKey is omitted. - -let rowKey = row.key; -- **selected**: `boolean` — Optional -Indicates whether the current row is selected -- **viewIndex**: `number` — Returns the view index calculated per the grid page. - -### [IgxPivotNumericAggregate](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPivotNumericAggregate) - -- **constructor**(): IgxPivotNumericAggregate -- static **aggregators**(): IPivotAggregator[] — Gets array with default aggregator function for numeric aggregation. -IgxPivotAggregate.aggregators(); -- static **average**(members: number[]): number — Returns the average numeric value in the data provided data records. -If filtering is applied, returns the average numeric value in the filtered data records. -IgxPivotNumericAggregate.average(data); -- static **max**(members: number[]): number — Returns the maximum numeric value in the provided data records. -If filtering is applied, returns the maximum value in the filtered data records. -IgxPivotNumericAggregate.max(data); -- static **min**(members: number[]): number — Returns the minimum numeric value in the provided data records. -If filtering is applied, returns the minimum value in the filtered data records. -IgxPivotNumericAggregate.min(members, data); -- static **sum**(members: number[]): number — Returns the sum of the numeric values in the provided data records. -If filtering is applied, returns the sum of the numeric values in the data records. -IgxPivotNumericAggregate.sum(data); - -### [IgxPivotTimeAggregate](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPivotTimeAggregate) - -- **constructor**(): IgxPivotTimeAggregate -- static **aggregators**(): IPivotAggregator[] — Gets array with default aggregator function for time aggregation. -IgxPivotTimeAggregate.aggregators(); -- static **earliestTime**(members: any[]): any — Returns the earliest time value in the data records. Compare only the time part of the date. -If filtering is applied, returns the earliest time value in the filtered data records. -IgxPivotTimeAggregate.earliestTime(data); -- static **latestTime**(members: any[]): any — Returns the latest time value in the data records. Compare only the time part of the date. -If filtering is applied, returns the latest time value in the filtered data records. -IgxPivotTimeAggregate.latestTime(data); - -### [IgxPrependDropStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxPrependDropStrategy) - -- **constructor**(_renderer: Renderer2): IgxPrependDropStrategy -- **dropAction**(drag: IgxDragDirective, drop: IgxDropDirective, _atIndex: number): void - -### [IgxProgressBarGradientDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxProgressBarGradientDirective) - -- **constructor**(template: TemplateRef): IgxProgressBarGradientDirective -- **template**: `TemplateRef` - -### [IgxProgressBarTextTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxProgressBarTextTemplateDirective) - -- **constructor**(template: TemplateRef): IgxProgressBarTextTemplateDirective -- **template**: `TemplateRef` - -### [IgxQueryBuilderComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxQueryBuilderComponent) -A component used for operating with complex filters by creating or editing conditions -and grouping them using AND/OR logic. -It is used internally in the Advanced Filtering of the Grid. - -- **constructor**(iconService: IgxIconService): IgxQueryBuilderComponent -- **disableEntityChange**: `boolean` — Disables subsequent entity changes at the root level after the initial selection. -- **disableReturnFieldsChange**: `boolean` — Disables return fields changes at the root level. -- **expressionTreeChange**: `EventEmitter` — Event fired as the expression tree is changed. - - -- **locale**: `string` — Gets the locale of the query builder. -If not set, defaults to application's locale. -- **showEntityChangeDialog**: `boolean` — Gets/sets whether the confirmation dialog should be shown when changing entity. -Default value is true. -- **entities**: `EntityType[]` — Gets the list of entities available for the IgxQueryBuilderComponent. - -Each entity describes a logical group of fields that can be used in queries. -An entity can optionally have child entities, allowing nested sub-queries. -- **expressionTree**: `IExpressionTree` — Returns the expression tree. -- **resourceStrings**: `IQueryBuilderResourceStrings` — Returns the resource strings. -- **canCommit**(): boolean — Returns whether the expression tree can be committed in the current state. -- **commit**(): void — Commits the expression tree in the current state if it is valid. If not throws an exception. -- **discard**(): void — Discards all unsaved changes to the expression tree. -- **onExpressionTreeChange**(tree: IExpressionTree): void - -### [IgxQueryBuilderHeaderComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxQueryBuilderHeaderComponent) - -- **constructor**(): IgxQueryBuilderHeaderComponent -- **showLegend**: `boolean` — Show/hide the legend. -- **title**: `string` — Sets the title of the IgxQueryBuilderHeaderComponent. -- **resourceStrings**: `IQueryBuilderResourceStrings` — Returns the resource strings. - -### [IgxQueryBuilderSearchValueTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxQueryBuilderSearchValueTemplateDirective) -Defines the custom template that will be used for the search value input of condition in edit mode - -- **constructor**(template: TemplateRef): IgxQueryBuilderSearchValueTemplateDirective -- **template**: `TemplateRef` - -### [IgxRadioComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxRadioComponent) -**Ignite UI for Angular Radio Button** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/radio_button.html) - -The Ignite UI Radio Button allows the user to select a single option from an available set of options that are listed side by side. - -Example: - - Simple radio button - - -- **constructor**(cdr: ChangeDetectorRef, themeToken: ThemeToken, ngControl: NgControl): IgxRadioComponent -- **cssClass**: `string` — Returns the class of the radio component. -let radioClass = this.radio.cssClass; -- **disabled**: `boolean` — Sets/gets the disabled attribute. -Default value is false. - - -let isDisabled = this.radio.disabled; -- **focused**: `boolean` — Sets/gets whether the radio component is on focus. -Default value is false. -this.radio.focus = true; - -let isFocused = this.radio.focused; -- **invalid**: `boolean` — Sets/gets whether the radio button is invalid. -Default value is false. - - -let isInvalid = this.radio.invalid; -- **checked**: `boolean` -- **deselect**(): void — Deselects the current radio button. -this.radio.deselect(); -- **select**(): void — Selects the current radio button. -this.radio.select(); -- **writeValue**(value: any): void — Checks whether the provided value is consistent to the current radio button. -If it is, the checked attribute will have value true; -this.radio.writeValue('radioButtonValue'); - -### [IgxRadioGroupDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxRadioGroupDirective) -Radio group directive renders set of radio buttons. - -- **constructor**(ngControl: NgControl, _directionality: IgxDirectionality, cdr: ChangeDetectorRef): IgxRadioGroupDirective -- readonly **change**: `EventEmitter` — An event that is emitted after the radio group value is changed. -- **ngControl**: `NgControl` -- **alignment**: `RadioGroupAlignment` — Returns the alignment of the igx-radio-group. -@ViewChild("MyRadioGroup") -public radioGroup: IgxRadioGroupDirective; -ngAfterViewInit(){ - let radioAlignment = this.radioGroup.alignment; -} -- **invalid**: `boolean` — Sets/gets whether the radio group is invalid. -- **name**: `string` — Sets/gets the name attribute of the radio group component. All child radio buttons inherits this name. -- **radioButtons**: `QueryList` — Returns reference to the child radio buttons. -- **required**: `boolean` — Sets/gets whether the radio group is required. -- **selected**: `IgxRadioComponent` — Sets/gets the selected child radio button. -- **value**: `any` — Sets/gets the value attribute. -- **ngDoCheck**(): void — A callback method that performs change-detection, invoked -after the default change-detector runs. -See KeyValueDiffers and IterableDiffers for implementing -custom change checking for collections. -- **writeValue**(value: any): void — Sets the "checked" property value on the radio input element. - -### [IgxRippleDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxRippleDirective) - -- **constructor**(builder: AnimationBuilder, elementRef: ElementRef, renderer: Renderer2, zone: NgZone): IgxRippleDirective -- **rippleColor**: `string` — Sets/gets the ripple color. - - -@ViewChild('rippleContainer', {read: IgxRippleDirective}) -public ripple: IgxRippleDirective; -let rippleColor = this.ripple.rippleColor; -- **rippleDisabled**: `boolean` — Sets/gets whether the ripple is disabled. -Default value is false. - - -@ViewChild('rippleContainer', {read: IgxRippleDirective}) -public ripple: IgxRippleDirective; -let isRippleDisabled = this.ripple.rippleDisabled; -- **rippleDuration**: `number` — Sets/gets the ripple duration(in milliseconds). -Default value is 600. - - -@ViewChild('rippleContainer', {read: IgxRippleDirective}) -public ripple: IgxRippleDirective; -let rippleDuration = this.ripple.rippleDuration; -- **rippleTarget**: `string` — Sets/gets the ripple target. -
- -@ViewChild('rippleContainer', {read: IgxRippleDirective}) -public ripple: IgxRippleDirective; -let rippleTarget = this.ripple.rippleTarget; - -Can set the ripple to activate on a child element inside the parent where igxRipple is defined. -
- -
-- **centered**: `boolean` - -### [IgxRowDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxRowDirective) - -- **constructor**(grid: GridType, selectionService: IgxGridSelectionService, element: ElementRef, cdr: ChangeDetectorRef): IgxRowDirective -- **cdr**: `ChangeDetectorRef` -- **disabled**: `boolean` — Sets whether this specific row has disabled functionality for editing and row selection. -Default value is false. -this.grid.selectedRows[0].pinned = true; -- **element**: `ElementRef` -- **grid**: `GridType` -- **index**: `number` — The index of the row. - -// get the index of the second selected row -let selectedRowIndex = this.grid.selectedRows[1].index; -- **selectionService**: `IgxGridSelectionService` -- **addRowUI**: `any` -- **cells**: `QueryList` — Gets the rendered cells in the row component. - -// get the cells of the third selected row -let selectedRowCells = this.grid.selectedRows[2].cells; -- **data**: `any` — The data passed to the row component. - -// get the row data for the first selected row -let selectedRowData = this.grid.selectedRows[0].data; -- **dataRowIndex**: `number` -- **expanded**: `boolean` — Gets the expanded state of the row. -let isExpanded = row.expanded; -- **inEditMode**: `boolean` -- **key**: `any` — Gets the ID of the row. -A row in the grid is identified either by: -- primaryKey data value, -- the whole data, if the primaryKey is omitted. - -let rowID = this.grid.selectedRows[2].key; -- **nativeElement**: `HTMLElement` — The native DOM element representing the row. Could be null in certain environments. - -// get the nativeElement of the second selected row -let selectedRowNativeElement = this.grid.selectedRows[1].nativeElement; -- **pinned**: `boolean` — Gets whether the row is pinned. -let isPinned = row.pinned; -- **rowHeight**: `number` -- **selected**: `boolean` -- **virtDirRow**: `IgxGridForOfDirective` -- **beginAddRow**(): void — Spawns the add row UI for the specific row. -- **delete**(): void — Removes the specified row from the grid's data source. -This method emits rowDeleted event. - -// delete the third selected row from the grid -this.grid.selectedRows[2].delete(); -- **isCellActive**(visibleColumnIndex: any): boolean -- **pin**(): boolean — Pins the specified row. -This method emits rowPinning`rowPinned` event. - -// pin the selected row from the grid -this.grid.selectedRows[0].pin(); -- **unpin**(): boolean — Unpins the specified row. -This method emits rowPinning`rowPinned` event. - -// unpin the selected row from the grid -this.grid.selectedRows[0].unpin(); -- **update**(value: any): void — Updates the specified row object and the data source record with the passed value. - -// update the second selected row's value -let newValue = "Apple"; -this.grid.selectedRows[1].update(newValue); - -### [IgxRowIslandComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxRowIslandComponent) -Row island - -- **constructor**(validationService: IgxGridValidationService, selectionService: IgxGridSelectionService, colResizingService: IgxColumnResizingService, gridAPI: IgxHierarchicalGridAPIService, transactionFactory: IgxFlatTransactionFactory, elementRef: ElementRef, zone: NgZone, document: any, cdr: ChangeDetectorRef, differs: IterableDiffers, viewRef: ViewContainerRef, injector: Injector, envInjector: EnvironmentInjector, navigation: IgxHierarchicalGridNavigationService, filteringService: IgxFilteringService, textHighlightService: IgxTextHighlightService, overlayService: IgxOverlayService, summaryService: IgxGridSummaryService, rowIslandAPI: IgxRowIslandAPIService, localeId: string, platform: PlatformUtil): IgxRowIslandComponent -- **gridCreated**: `EventEmitter` — Event emitted when a grid is being created based on this row island. - - - - - -- **gridInitialized**: `EventEmitter` — Emitted after a grid is being initialized for this row island. -The emitting is done in ngAfterViewInit. - - - - - -- **key**: `string` — Sets the key of the row island by which child data would be taken from the row data if such is provided. - - - - - -- **rowIslandAPI**: `IgxRowIslandAPIService` -- **childDataKey**: `string` -- **expandChildren**: `boolean` — Gets if all immediate children of the grids for this IgxRowIslandComponent have been set to be expanded/collapsed. -const expanded = this.rowIsland.expandChildren; -- **paginatorTemplate**: `TemplateRef` — Sets/Gets the paginator template for each child grid created from this row island. -- **toolbarTemplate**: `TemplateRef` — Sets/Gets the toolbar template for each child grid created from this row island. - -### [IgxSelectComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxSelectComponent) -**Ignite UI for Angular Select** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/select) - -The igxSelect provides an input with dropdown list allowing selection of a single item. - -Example: - - - - {{ item.field }} - - - -- **constructor**(elementRef: ElementRef, cdr: ChangeDetectorRef, document: any, selection: IgxSelectionAPIService, overlayService: IgxOverlayService, _inputGroupType: IgxInputGroupType, _injector: Injector): IgxSelectComponent -- **closed**: `EventEmitter` — Emitted after the dropdown is closed - - -- **closing**: `EventEmitter` — Emitted before the dropdown is closed - - -- **disabled**: `boolean` — Disables the component. - -- **footerTemplate**: `TemplateRef` — The custom template, if any, that should be used when rendering the FOOTER for the select items list - -// Set in typescript -const myCustomTemplate: TemplateRef = myComponent.customTemplate; -myComponent.select.footerTemplate = myCustomTemplate; - - - - ... - -
- This is a custom footer -
- - -- **headerTemplate**: `TemplateRef` — The custom template, if any, that should be used when rendering the HEADER for the select items list - -// Set in typescript -const myCustomTemplate: TemplateRef = myComponent.customTemplate; -myComponent.select.headerTemplate = myCustomTemplate; - - - - ... - -
- This is a custom header -
- - -- **opened**: `EventEmitter` — Emitted after the dropdown is opened - - -- **opening**: `EventEmitter` — Emitted before the dropdown is opened - - -- **overlaySettings**: `OverlaySettings` — Sets custom OverlaySettings IgxSelectComponent. - -- **placeholder**: `any` — Sets input placeholder. -- **toggleIconTemplate**: `TemplateRef` — The custom template, if any, that should be used when rendering the select TOGGLE(open/close) button - -// Set in typescript -const myCustomTemplate: TemplateRef = myComponent.customTemplate; -myComponent.select.toggleIconTemplate = myCustomTemplate; - - - - ... - - {{ collapsed ? 'remove_circle' : 'remove_circle_outline'}} - - -- **type**: `IgxInputGroupType` — Sets how the select will be styled. -The allowed values are line, box and border. The input-group default is line. - -- **value**: `any` — Gets/Sets the component value. - -// get -let selectValue = this.select.value; - - -// set -this.select.value = 'London'; - - -- **inputGroupClick**(event: MouseEvent, overlaySettings?: OverlaySettings): void -- **open**(overlaySettings?: OverlaySettings): void — Opens the select - -this.select.open(); - -### [IgxSelectGroupComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxSelectGroupComponent) -The is a container intended for row items in -a container. - -- **constructor**(): IgxSelectGroupComponent - -### [IgxSelectItemComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxSelectItemComponent) -The is a container intended for row items in -a container. - -- **constructor**(dropDown: IDropDownBase, elementRef: ElementRef, group: IgxDropDownGroupComponent, selection?: IgxSelectionAPIService): IgxSelectItemComponent -- **selected**: `any` — Sets/Gets if the item is the currently selected one in the select - - let mySelectedItem = this.select.selectedItem; - let isMyItemSelected = mySelectedItem.selected; // true -- **text**: `string` — Gets/Sets the item's text to be displayed in the select component's input when the item is selected. - - //get - let mySelectedItem = this.dropDown.selectedItem; - let selectedItemText = mySelectedItem.text; - - -// set - - -### [IgxSimpleComboComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxSimpleComboComponent) -Represents a drop-down list that provides filtering functionality, allowing users to choose a single option from a predefined list. - -- **constructor**(elementRef: ElementRef, cdr: ChangeDetectorRef, selectionService: IgxSelectionAPIService, comboAPI: IgxComboAPIService, platformUtil: PlatformUtil, document: any, _inputGroupType: IgxInputGroupType, _injector: Injector, _iconService?: IgxIconService, formGroupDirective?: FormGroupDirective): IgxSimpleComboComponent -- **selectionChanging**: `EventEmitter` — Emitted when item selection is changing, before the selection completes - - -- **selection**: `any` — Get current selection state -- **value**: `any` — The value of the combo - -// get -let comboValue = this.combo.value; -- **deselect**(): void — Deselect the currently selected item -- **select**(item: any): void — Select a defined item - -### [IgxSlideComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxSlideComponent) -A slide component that usually holds an image and/or a caption text. -IgxSlideComponent is usually a child component of an IgxCarouselComponent. - - - - - -- **constructor**(elementRef: ElementRef): IgxSlideComponent -- **cssClass**: `string` — Returns the class of the slide component. -let class = this.slide.cssClass; -- **direction**: `Direction` — Gets/sets the target direction for the slide. - - - -- **index**: `number` — Gets/sets the index of the slide inside the carousel. - - - -- **previous**: `boolean` -- **tab**: `string` — Returns the role of the slide component. -By default is set to tabpanel -- **total**: `number` -- **active**: `boolean` — Gets/sets the active state of the slide. - - - - - -Two-way data binding. - - - -- **nativeElement**: `any` — Returns a reference to the carousel element in the DOM. -let nativeElement = this.slide.nativeElement; -- **tabIndex**: `number` — Returns the tabIndex of the slide component. -let tabIndex = this.carousel.tabIndex; -- **ngAfterContentChecked**(): void — A callback method that is invoked immediately after the -default change detector has completed checking all of the directive's -content. - -### [IgxSliderComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxSliderComponent) -**Ignite UI for Angular Slider** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/slider/slider) - -The Ignite UI Slider allows selection in a given range by moving the thumb along the track. The track -can be defined as continuous or stepped, and you can choose between single and range slider types. - -Example: - - - -- **constructor**(renderer: Renderer2, _el: ElementRef, _cdr: ChangeDetectorRef, _ngZone: NgZone, _dir: IgxDirectionality): IgxSliderComponent -- **dragFinished**: `EventEmitter` — This event is emitted at the end of every slide interaction. -public change(event){ - alert("The value has been changed!"); -} - - -- **id**: `string` — Sets the value of the id attribute. -If not provided it will be automatically generated. - -- **lowerValueChange**: `EventEmitter` — This event is emitted every time the lower value of a range slider is changed. -public change(value){ - alert(The lower value has been changed to ${value}); -} - - -- **primaryTickLabels**: `boolean` — show/hide primary tick labels - -- **secondaryTickLabels**: `boolean` — show/hide secondary tick labels - -- **showTicks**: `boolean` — Show/hide slider ticks - -- **thumbLabelVisibilityDuration**: `number` — Sets the duration visibility of thumbs labels. The default value is 750 milliseconds. - -- **tickLabelsOrientation**: `TickLabelsOrientation` — Changes tick labels rotation: -horizontal - The default rotation -toptobottom - Rotates tick labels vertically to 90deg -bottomtotop - Rotate tick labels vertically to -90deg - -- **ticksOrientation**: `TicksOrientation` — Changes ticks orientation: -bottom - The default orienation, below the slider track. -top - Above the slider track -mirror - combines top and bottom orientation. - -- **upperValueChange**: `EventEmitter` — This event is emitted every time the upper value of a range slider is changed. -public change(value){ - alert(The upper value has been changed to ${value}); -} - - -- **valueChange**: `EventEmitter` — This event is emitted every time the value is changed. -public change(event){ - alert("The value has been changed!"); -} - - -- **context**: `any` — Returns the template context corresponding -to IgxThumbFromTemplateDirective and IgxThumbToTemplateDirective templates. - -return { - $implicit // returns the value of the label, - labels // returns the labels collection the user has passed. -} -- **continuous**: `boolean` — Returns if the IgxSliderComponent is set as continuous. -@ViewChild("slider2") -public slider: IgxSliderComponent; -ngAfterViewInit(){ - let continuous = this.slider.continuous; -} -- **disabled**: `boolean` — Returns if the IgxSliderComponent is disabled. -@ViewChild("slider2") -public slider: IgxSliderComponent; -ngAfterViewInit(){ - let isDisabled = this.slider.disabled; -} -- **isRange**: `boolean` — Returns whether the IgxSliderComponent type is RANGE. - @ViewChild("slider") -public slider: IgxSliderComponent; -ngAfterViewInit(){ - let sliderRange = this.slider.isRange; -} -- **labels**: `string | number | boolean[]` — Enables labelView, by accepting a collection of primitive values with more than one element. -Each element will be equally spread over the slider and it will serve as a thumb label. -Once the property is set, it will precendence over maxValue, minValue, step. -This means that the manipulation for those properties won't be allowed. -- **labelsViewEnabled**: `boolean` — Returns if label view is enabled. -If the labels is set, the view is automatically activated. -@ViewChild("slider") -public slider: IgxSliderComponent; -let labelView = this.slider.labelsViewEnabled; -- **lowerBound**: `number` — Returns the lower boundary of settable values of the IgxSliderComponent. -If not set, will return minValue. -@ViewChild("slider") -public slider: IgxSliderComponent; -ngAfterViewInit(){ - let sliderLowBound = this.slider.lowerBound; -} -- **lowerLabel**: `string | number | boolean` — Returns the value corresponding the lower label. -@ViewChild("slider") -public slider: IgxSliderComponent; -let label = this.slider.lowerLabel; -- **lowerValue**: `number` — Returns the lower value of a RANGE IgxSliderComponent. -@ViewChild("slider") -public slider: IgxSliderComponent; -public lowValue(event){ - let sliderLowValue = this.slider.lowerValue; -} -- **maxValue**: `number` — Returns the maximum displayed track value for the IgxSliderComponent. -@ViewChild("slider") -public slider: IgxSliderComponent; -ngAfterViewInit(){ - let sliderMax = this.slider.maxValue; -} -- **minValue**: `number` — Returns the minimal displayed track value of the IgxSliderComponent. - @ViewChild("slider2") -public slider: IgxSliderComponent; -ngAfterViewInit(){ - let sliderMin = this.slider.minValue; -} -- **primaryTicks**: `number` — Returns the number of the presented primary ticks. -const primaryTicks = this.slider.primaryTicks; -- **secondaryTicks**: `number` — Returns the number of the presented secondary ticks. -const secondaryTicks = this.slider.secondaryTicks; -- **step**: `number` — Returns the incremental/decremental dragging step of the IgxSliderComponent. -@ViewChild("slider2") -public slider: IgxSliderComponent; -ngAfterViewInit(){ - let step = this.slider.step; -} -- **type**: `IgxSliderType` — Gets the type of the IgxSliderComponent. -The slider can be IgxSliderType.SLIDER(default) or IgxSliderType.RANGE. -@ViewChild("slider2") -public slider: IgxSliderComponent; -ngAfterViewInit(){ - let type = this.slider.type; -} -- **upperBound**: `number` — Returns the upper boundary of settable values of the IgxSliderComponent. -If not set, will return maxValue -@ViewChild("slider") -public slider: IgxSliderComponent; -ngAfterViewInit(){ - let sliderUpBound = this.slider.upperBound; -} -- **upperLabel**: `string | number | boolean` — Returns the value corresponding the upper label. -@ViewChild("slider") -public slider: IgxSliderComponent; -let label = this.slider.upperLabel; -- **upperValue**: `number` — Returns the upper value of a RANGE IgxSliderComponent. -Returns value of a SLIDER IgxSliderComponent - @ViewChild("slider2") -public slider: IgxSliderComponent; -public upperValue(event){ - let upperValue = this.slider.upperValue; -} -- **value**: `number | IRangeSliderValue` — Returns the slider value. If the slider is of type IgxSliderType.SLIDER the returned value is number. -If the slider type is IgxSliderType.RANGE. -The returned value represents an object of lowerValue and upperValue. -@ViewChild("slider2") -public slider: IgxSliderComponent; -public sliderValue(event){ - let sliderVal = this.slider.value; -} -- **ngAfterContentInit**(): void — A callback method that is invoked immediately after -Angular has completed initialization of all of the directive's -content. -It is invoked only once when the directive is instantiated. -- **setValue**(value: number | IRangeSliderValue, triggerChange: boolean): void - -### [IgxSnackbarComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxSnackbarComponent) -**Ignite UI for Angular Snackbar** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/snackbar.html) - -The Ignite UI Snack Bar provides feedback about an operation with a single-line message, which can -include a link to an action such as Undo. - -Example: - -
- - Message sent - -
- -- **actionText**: `string` — Sets/gets the actionText attribute. - -- **animationDone**: `EventEmitter` — An event that will be emitted when the snackbar animation ends. -Provides reference to the ToggleViewEventArgs interface as an argument. - -- **animationStarted**: `EventEmitter` — An event that will be emitted when the snackbar animation starts. -Provides reference to the ToggleViewEventArgs interface as an argument. - -- **clicked**: `EventEmitter` — An event that will be emitted when the action button is clicked. -Provides reference to the IgxSnackbarComponent as an argument. - -- **id**: `string` — Sets/gets the id of the snackbar. -If not set, the id of the first snackbar component will be "igx-snackbar-0"; - - -let snackbarId = this.snackbar.id; -- **positionSettings**: `PositionSettings` — Get the position and animation settings used by the snackbar. -@ViewChild('snackbar', { static: true }) public snackbar: IgxSnackbarComponent; -let currentPosition: PositionSettings = this.snackbar.positionSettings -- **open**(message?: string): void — Shows the snackbar and hides it after the displayTime is over if autoHide is set to true. -this.snackbar.open(); -- **toggle**(): void — Opens or closes the snackbar, depending on its current state. - -this.snackbar.toggle(); - -### [IgxSorting](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxSorting) -Represents a class implementing the IGridSortingStrategy interface. -It provides sorting functionality for grid data based on sorting expressions. - -- **constructor**(): IgxSorting -- **sort**(data: any[], expressions: ISortingExpression[], grid?: GridType): any[] — Sorts the provided data based on the given sorting expressions. -data: The array of data to be sorted. -expressions: An array of sorting expressions that define the sorting rules. The expression contains information like file name, whether the letter case should be taken into account, etc. -grid: (Optional) The instance of the grid where the sorting is applied. -Returns a new array with the data sorted according to the sorting expressions. - -### [IgxSplitterComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxSplitterComponent) -Provides a framework for a simple layout, splitting the view horizontally or vertically -into multiple smaller resizable and collapsible areas. - -- **constructor**(document: any, elementRef: ElementRef, zone: NgZone): IgxSplitterComponent -- **document**: `any` -- **nonCollapsible**: `boolean` — Sets the visibility of the handle and expanders in the splitter bar. -False by default -- **panes**: `QueryList` — Gets the list of splitter panes. -- **resizeEnd**: `EventEmitter` — Event fired when resizing of panes ends. -- **resizeStart**: `EventEmitter` — Event fired when resizing of panes starts. -- **resizing**: `EventEmitter` — Event fired when resizing of panes is in progress. -- **type**: `SplitterType` — Gets/Sets the splitter orientation. -- **onMoveEnd**(delta: number): void - -### [IgxSplitterPaneComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxSplitterPaneComponent) -Represents individual resizable/collapsible panes. - -- **constructor**(el: ElementRef): IgxSplitterPaneComponent -- **collapsedChange**: `EventEmitter` — Event fired when collapsed state of pane is changed. -- **resizable**: `boolean` — Gets/Sets whether pane is resizable. -- **collapsed**: `boolean` -- **dragSize**: `any` -- **maxSize**: `string` — Gets/Set the maximum allowed size of the current pane. -- **minSize**: `string` — Gets/Sets the minimum allowed size of the current pane. -- **order**: `number` -- **size**: `string` — Gets/Sets the size of the current pane. - * -- **toggle**(): void — Toggles the collapsed state of the pane. - -### [IgxStepActiveIndicatorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxStepActiveIndicatorDirective) -Allows a custom element to be added as an active step indicator. - -- **constructor**(): IgxStepActiveIndicatorDirective - -### [IgxStepCompletedIndicatorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxStepCompletedIndicatorDirective) -Allows a custom element to be added as a complete step indicator. - -- **constructor**(): IgxStepCompletedIndicatorDirective - -### [IgxStepComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxStepComponent) -The IgxStepComponent is used within the igx-stepper element and it holds the content of each step. -It also supports custom indicators, title and subtitle. - -- **constructor**(stepper: IgxStepper, cdr: ChangeDetectorRef, renderer: Renderer2, platform: PlatformUtil, stepperService: IgxStepperService, animationService: AnimationService, element: ElementRef, dir: IgxDirectionality): IgxStepComponent -- **activeChange**: `EventEmitter` — Emitted when the step's active property changes. Can be used for two-way binding. - - - - - -const step: IgxStepComponent = this.stepper.step[0]; -step.activeChange.subscribe((e: boolean) => console.log("Step active state change to ", e)) -- **cdr**: `ChangeDetectorRef` -- **completed**: `boolean` — Get/Set whether the step is completed. -- **id**: `string` — Get/Set the id of the step component. -Default value is "igx-step-0"; - - -const stepId = this.step.id; -- **optional**: `boolean` — Get/Set whether the step is optional. -- **renderer**: `Renderer2` -- **stepper**: `IgxStepper` -- **active**: `boolean` -- **disabled**: `boolean` -- **index**: `number` — Get the step index inside of the stepper. - -const step = this.stepper.steps[1]; -const stepIndex: number = step.index; -- **isValid**: `boolean` — Get/Set whether the step is valid. - - ... -
-
- ... -
-
- -- **tabIndex**: `number` - -### [IgxStepContentDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxStepContentDirective) -Allows a custom element to be added as a step content. - -- **constructor**(step: IgxStep, stepperService: IgxStepperService, elementRef: ElementRef): IgxStepContentDirective -- **defaultClass**: `boolean` -- **elementRef**: `ElementRef` -- **id**: `string` -- **role**: `string` -- **stepId**: `string` -- **tabIndex**: `number` - -### [IgxStepIndicatorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxStepIndicatorDirective) -Allows a custom element to be added as a step indicator. - -- **constructor**(): IgxStepIndicatorDirective - -### [IgxStepInvalidIndicatorDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxStepInvalidIndicatorDirective) -Allows a custom element to be added as an invalid step indicator. - -- **constructor**(): IgxStepInvalidIndicatorDirective - -### [IgxStepperComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxStepperComponent) -IgxStepper provides a wizard-like workflow by dividing content into logical steps. - -- **constructor**(cdr: ChangeDetectorRef, animationService: AnimationService, stepperService: IgxStepperService, element: ElementRef): IgxStepperComponent -- **activeStepChanged**: `EventEmitter` — Emitted when the active step is changed. -- **activeStepChanging**: `EventEmitter` — Emitted when the stepper's active step is changing. - - - - - -public handleActiveStepChanging(event: IStepChangingEventArgs) { - if (event.newIndex < event.oldIndex) { - event.cancel = true; - } -} -- **contentTop**: `boolean` — Get/Set whether the content is displayed above the steps. -- **stepType**: `IgxStepType` — Get/Set the type of the steps. - -this.stepper.stepType = IgxStepType.Indicator; -- **titlePosition**: `IgxStepperTitlePosition` — Get/Set the position of the steps title. -- **animationDuration**: `number` — Get/Set the animation duration. - - -- **horizontalAnimationType**: `HorizontalAnimationType` — Get/Set the animation type of the stepper when the orientation direction is horizontal. -- **linear**: `boolean` — Get/Set whether the stepper is linear. -- **orientation**: `IgxStepperOrientation` — Get/Set the stepper orientation. - -this.stepper.orientation = IgxStepperOrientation.Vertical; -- **steps**: `IgxStepComponent[]` — Get all steps. - -const steps: IgxStepComponent[] = this.stepper.steps; -- **verticalAnimationType**: `VerticalAnimationType` — Get/Set the animation type of the stepper when the orientation direction is vertical. -- **navigateTo**(index: number): void — Activates the step at a given index. - -this.stepper.navigateTo(1); -- **next**(): void — Activates the next enabled step. - -this.stepper.next(); -- **prev**(): void — Activates the previous enabled step. - -this.stepper.prev(); -- **reset**(): void — Resets the stepper to its initial state i.e. activates the first step. - -### [IgxStepSubtitleDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxStepSubtitleDirective) -Allows a custom element to be added as a step subtitle. - -- **constructor**(): IgxStepSubtitleDirective -- **defaultClass**: `boolean` - -### [IgxStepTitleDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxStepTitleDirective) -Allows a custom element to be added as a step title. - -- **constructor**(): IgxStepTitleDirective -- **defaultClass**: `boolean` - -### [IgxStringFilteringOperand](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxStringFilteringOperand) -Provides filtering operations for strings - -- static **applyIgnoreCase**(a: string, ignoreCase: boolean): string — Applies case sensitivity on strings if provided - -### [IgxSummaryOperand](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxSummaryOperand) - -- **constructor**(): IgxSummaryOperand -- **operate**(data: any[], _allData: any[], _fieldName?: string, _groupRecord?: IGroupByRecord): IgxSummaryResult[] — Executes the static count method and returns IgxSummaryResult[]. -interface IgxSummaryResult { - key: string; - label: string; - summaryResult: any; -} - -Can be overridden in the inherited classes to provide customization for the summary. -class CustomSummary extends IgxSummaryOperand { - constructor() { - super(); - } - public operate(data: any[], allData: any[], fieldName: string, groupRecord: IGroupByRecord): IgxSummaryResult[] { - const result = []; - result.push({ - key: "test", - label: "Test", - summaryResult: IgxSummaryOperand.count(data) - }); - return result; - } -} -this.grid.getColumnByName('ColumnName').summaries = CustomSummary; -- static **count**(data: any[]): number — Counts all the records in the data source. -If filtering is applied, counts only the filtered records. -IgxSummaryOperand.count(dataSource); - -### [IgxSummaryRow](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxSummaryRow) -Interface representing a row in the grid. It is essentially the blueprint to a row object. -Contains definitions of properties and methods, relevant to a row - -- **grid**: `GridType` — The grid that contains the row. -- **index**: `number` — Returns the row index. -- **isSummaryRow**: `boolean` — Returns always true, because this is in instance of an IgxGroupByRow. -- **summaries**: `Map` — Optional -A map of column field names to the summary results for the row. -- **viewIndex**: `number` — Returns the view index calculated per the grid page. - -### [IgxSummaryTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxSummaryTemplateDirective) - -- **constructor**(template: TemplateRef): IgxSummaryTemplateDirective -- **template**: `TemplateRef` -- static **ngTemplateContextGuard**(_directive: IgxSummaryTemplateDirective, context: unknown): context - -### [IgxSwitchComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxSwitchComponent) -The Switch component is a binary choice selection component. - -- **constructor**(cdr: ChangeDetectorRef, themeToken: ThemeToken, ngControl: NgControl): IgxSwitchComponent -- **cssClass**: `string` — Returns the class of the switch component. -- **disabled**: `boolean` — Sets/gets the disabled attribute. -Default value is false. -- **focused**: `boolean` — Sets/gets whether the switch component is on focus. -Default value is false. -- **invalid**: `boolean` — Sets/gets whether the switch component is invalid. -Default value is false. -- **checked**: `boolean` - -### [IgxTabContentComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTabContentComponent) - - -### [IgxTabHeaderComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTabHeaderComponent) - - -### [IgxTabHeaderIconDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTabHeaderIconDirective) - -- **constructor**(): IgxTabHeaderIconDirective - -### [IgxTabHeaderLabelDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTabHeaderLabelDirective) - -- **constructor**(): IgxTabHeaderLabelDirective - -### [IgxTabItemComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTabItemComponent) - - -### [IgxTabsComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTabsComponent) -Tabs component is used to organize or switch between similar data sets. - -- **constructor**(animationService: AnimationService, cdr: ChangeDetectorRef, ngZone: NgZone, dir: IgxDirectionality, platform: PlatformUtil): IgxTabsComponent -- **activation**: `"auto" | "manual"` — Determines the tab activation. -When set to auto, the tab is instantly selected while navigating with the Left/Right Arrows, Home or End keys and the corresponding panel is displayed. -When set to manual, the tab is only focused. The selection happens after pressing Space or Enter. -Defaults is auto. -- **tabAlignment**: `string` — Gets/Sets the tab alignment. Defaults to start. - -### [IgxTextHighlightDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTextHighlightDirective) - -- **constructor**(element: ElementRef, service: IgxTextHighlightService, renderer: Renderer2): IgxTextHighlightDirective -- **activeCssClass**: `string` — Determines the CSS class of the active highlight element. -This allows the developer to provide custom CSS to customize the highlight. - -
-
-- **column**: `any` — The identifier of the column on which the directive is currently on. - -
-
-- **cssClass**: `string` — Determines the CSS class of the highlight elements. -This allows the developer to provide custom CSS to customize the highlight. - -
-
-- **groupName**: `string` — Identifies the highlight within a unique group. -This allows it to have several different highlight groups, -with each of them having their own active highlight. - -
-
-- **metadata**: `Map` — A map that contains all additional conditions, that you need to activate a highlighted -element. To activate the condition, you will have to add a new metadata key to -the metadata property of the IActiveHighlightInfo interface. -- **row**: `any` — The identifier of the row on which the directive is currently on. - -
-
-- **value**: `any` — The underlying value of the element that will be highlighted. - -// get -const elementValue = this.textHighlight.value; - - - -
-
-- **activateIfNecessary**(): void — Activates the highlight if it is on the currently active row and column. -- **clearHighlight**(): void — Clears any existing highlight. -- **highlight**(text: string, caseSensitive?: boolean, exactMatch?: boolean): number — Clears the existing highlight and highlights the searched text. -Returns how many times the element contains the searched text. -- **observe**(): void — Attaches a MutationObserver to the parentElement and watches for when the container element is removed/readded to the DOM. -Should be used only when necessary as using many observers may lead to performance degradation. - -### [IgxTextHighlightService](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTextHighlightService) - -- **constructor**(): IgxTextHighlightService -- **highlightGroupsMap**: `Map` -- **onActiveElementChanged**: `EventEmitter` -- **clearActiveHighlight**(groupName: any): void — Clears any existing highlight. -- **destroyGroup**(groupName: string): void — Destroys a highlight group. -- **setActiveHighlight**(groupName: string, highlight: IActiveHighlightInfo): void — Activates the highlight at a given index. -(if such index exists) - -### [IgxTextSelectionDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTextSelectionDirective) - -- **constructor**(element: ElementRef): IgxTextSelectionDirective -- **selected**: `boolean` — Determines whether the input element could be selected through the directive. - - - - - - - -- **nativeElement**: `any` — Returns the nativeElement of the element where the directive was applied. - - - - - -@ViewChild('firstName', - {read: IgxTextSelectionDirective}) -public inputElement: IgxTextSelectionDirective; - -public getNativeElement() { - return this.inputElement.nativeElement; -} -- **trigger**(): void — Triggers the selection of the element if it is marked as selectable. - - - - - -@ViewChild('firstName', - {read: IgxTextSelectionDirective}) -public inputElement: IgxTextSelectionDirective; - -public triggerElementSelection() { - this.inputElement.trigger(); -} - -### [IgxThumbFromTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxThumbFromTemplateDirective) -Template directive that allows you to set a custom template representing the lower label value of the IgxSliderComponent - - - {{value}} - - -- **constructor**(): IgxThumbFromTemplateDirective - -### [IgxThumbToTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxThumbToTemplateDirective) -Template directive that allows you to set a custom template representing the upper label value of the IgxSliderComponent - - - {{value}} - - -- **constructor**(): IgxThumbToTemplateDirective - -### [IgxTickLabelTemplateDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTickLabelTemplateDirective) -Template directive that allows you to set a custom template, represeting primary/secondary tick labels of the IgxSliderComponent - -- **constructor**(): IgxTickLabelTemplateDirective - -### [IgxTimeFilteringOperand](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTimeFilteringOperand) - - -### [IgxTimePickerComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTimePickerComponent) - -- **constructor**(element: ElementRef, _localeId: string, _inputGroupType: IgxInputGroupType, _injector: Injector, platform: PlatformUtil, cdr: ChangeDetectorRef): IgxTimePickerComponent -- **displayFormat**: `string` — The format used when editable input is not focused. Defaults to the inputFormat if not set. -- **formatter**: `any` — Gets/Sets a custom formatter function on the selected or passed date. -- **headerOrientation**: `PickerHeaderOrientation` — Sets the orientation of the picker's header. -- **id**: `string` — Sets the value of the id attribute. - -- **inputFormat**: `string` — The expected user input format and placeholder. -- **mode**: `PickerInteractionMode` — Gets/Sets the interaction mode - dialog or drop down. -- **selected**: `EventEmitter` — Emitted after a selection has been done. -- **spinLoop**: `boolean` — Sets whether the seconds, minutes and hour spinning will loop back around when end value is reached. -By default it's set to true. - -- **validationFailed**: `EventEmitter` — Emitted when the user types/spins invalid time in the time-picker editor. -- **valueChange**: `EventEmitter` — Emitted when the picker's value changes. -- **cancelButtonLabel**: `string` — An accessor that returns the label of cancel button. -- **collapsed**: `boolean` — Gets if the dropdown/dialog is collapsed - -let isCollapsed = this.timePicker.collapsed; -- **itemsDelta**: `Pick` -- **maxValue**: `string | Date` -- **minValue**: `string | Date` -- **okButtonLabel**: `string` — An accessor that returns the label of ok button. -- **resourceStrings**: `ITimePickerResourceStrings` — An accessor that returns the resource strings. -- **value**: `string | Date` — The currently selected value / time from the drop-down/dialog -- **clear**(): void — Clears the time picker value if it is a string or resets the time to 00:00:00 if the value is a Date object. -- **close**(): void — Closes the dropdown/dialog. - - -@ViewChild('timePicker', { read: IgxTimePickerComponent }) picker: IgxTimePickerComponent; -picker.close(); -- **decrement**(datePart?: DatePart, delta?: number): void — Decrement a specified DatePart -- **increment**(datePart?: DatePart, delta?: number): void — Increment a specified DatePart. -- **open**(settings?: OverlaySettings): void — Opens the picker's dialog UI. -- **select**(date: string | Date): void — Selects time from the igxTimePicker. -- **toggle**(settings?: OverlaySettings): void - -### [IgxTimeSummaryOperand](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTimeSummaryOperand) - -- **constructor**(): IgxTimeSummaryOperand -- **operate**(data: any[], allData: any[], fieldName?: string, groupRecord?: IGroupByRecord): IgxSummaryResult[] -- static **earliestTime**(data: any[]): any — Returns the earliest time value in the data records. Compare only the time part of the date. -If filtering is applied, returns the earliest time value in the filtered data records. -IgxTimeSummaryOperand.earliestTime(data); -- static **latestTime**(data: any[]): any — Returns the latest time value in the data records. Compare only the time part of the date. -If filtering is applied, returns the latest time value in the filtered data records. -IgxTimeSummaryOperand.latestTime(data); - -### [IgxToastComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxToastComponent) -**Ignite UI for Angular Toast** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/toast) - -The Ignite UI Toast provides information and warning messages that are non-interactive and cannot -be dismissed by the user. Toasts can be displayed at the bottom, middle, or top of the page. - -Example: - - - Notification displayed - - -- **constructor**(_element: ElementRef, cdr: ChangeDetectorRef, navService: IgxNavigationService, overlayService: IgxOverlayService): IgxToastComponent -- **id**: `string` — Sets/gets the id of the toast. -If not set, the id will have value "igx-toast-0". - - -let toastId = this.toast.id; -- **role**: `string` — Sets/gets the role attribute. -If not set, role will have value "alert". - - -let toastRole = this.toast.role; -- **element**: `any` — Gets the nativeElement of the toast. -let nativeElement = this.toast.element; -- **positionSettings**: `PositionSettings` — Get the position and animation settings used by the toast. -@ViewChild('toast', { static: true }) public toast: IgxToastComponent; -let currentPosition: PositionSettings = this.toast.positionSettings -- **open**(message?: string, settings?: PositionSettings): void — Shows the toast. -If autoHide is enabled, the toast will hide after displayTime is over. - -this.toast.open(); -- **toggle**(): void — Opens or closes the toast, depending on its current state. - -this.toast.toggle(); - -### [IgxToggleActionDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxToggleActionDirective) - -- **constructor**(element: ElementRef, navigationService: IgxNavigationService): IgxToggleActionDirective -- **outlet**: `ElementRef | IgxOverlayOutletDirective` — Determines where the toggle element overlay should be attached. - - -
- -Where outlet in an instance of IgxOverlayOutletDirective or an ElementRef -- **overlaySettings**: `OverlaySettings` — Provide settings that control the toggle overlay positioning, interaction and scroll behavior. -const settings: OverlaySettings = { - closeOnOutsideClick: false, - modal: false - } - ---- - -
- -### [IgxToggleDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxToggleDirective) -Common interface for Components with show and collapse functionality - -- **appended**: `EventEmitter` — Emits an event after the toggle element is appended to the overlay container. - -onAppended() { - alert("Content appended!"); -} - - -
-
-- **closed**: `EventEmitter` — Emits an event after the toggle container is closed. - -onToggleClosed(event) { - alert("Toggle closed!"); -} - - -
-
-- **closing**: `EventEmitter` — Emits an event before the toggle container is closed. - -onToggleClosing(event) { - alert("Toggle closing!"); -} - - -
-
-- **id**: `string` — Identifier which is registered into IgxNavigationService - -let myToggleId = this.toggle.id; -- **opened**: `EventEmitter` — Emits an event after the toggle container is opened. - -onToggleOpened(event) { - alert("Toggle opened!"); -} - - -
-
-- **opening**: `EventEmitter` — Emits an event before the toggle container is opened. - -onToggleOpening(event) { - alert("Toggle opening!"); -} - - -
-
-- **hiddenWebkitClass**: `boolean` -- **overlayId**: `string` — Returns the id of the overlay the content is rendered in. -this.myToggle.overlayId; -- **close**(event?: Event): void — Closes the toggle. - -this.myToggle.close(); -- **open**(overlaySettings?: OverlaySettings): void — Opens the toggle. - -this.myToggle.open(); -- **reposition**(): void — Repositions the toggle. -this.myToggle.reposition(); -- **setOffset**(deltaX: number, deltaY: number, offsetMode?: OffsetMode): void — Offsets the content along the corresponding axis by the provided amount with optional -offsetMode that determines whether to add (by default) or set the offset values with OffsetMode.Add and OffsetMode.Set -- **toggle**(overlaySettings?: OverlaySettings): void — Opens or closes the toggle, depending on its current state. - -this.myToggle.toggle(); - -### [IgxTooltipDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTooltipDirective) -**Ignite UI for Angular Tooltip** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/tooltip) - -The Ignite UI for Angular Tooltip directive is used to mark an HTML element in the markup as one that should behave as a tooltip. -The tooltip is used in combination with the Ignite UI for Angular Tooltip Target by assigning the exported tooltip reference to the -respective target's selector property. - -Example: - -Hello there, I am a tooltip! - -- **context**: `any` — Gets/sets any tooltip related data. -The 'context' can be used for storing any information that is necessary -to access when working with the tooltip. - -// get -let tooltipContext = this.tooltip.context; - - -// set -this.tooltip.context = "Tooltip's context"; -- **id**: `string` — Identifier for the tooltip. -If this is property is not explicitly set, it will be automatically generated. - -let tooltipId = this.tooltip.id; -- **role**: `string` — Get the role attribute of the tooltip. - -let tooltipRole = this.tooltip.role; - -### [IgxTooltipTargetDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTooltipTargetDirective) -**Ignite UI for Angular Tooltip Target** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/tooltip) - -The Ignite UI for Angular Tooltip Target directive is used to mark an HTML element in the markup as one that has a tooltip. -The tooltip target is used in combination with the Ignite UI for Angular Tooltip by assigning the exported tooltip reference to the -target's selector property. - -Example: - -Hello there, I am a tooltip! - -- **constructor**(_element: ElementRef, _navigationService: IgxNavigationService, _viewContainerRef: ViewContainerRef): IgxTooltipTargetDirective -- **hideDelay**: `number` — Gets/sets the amount of milliseconds that should pass before hiding the tooltip. - -// get -let tooltipHideDelay = this.tooltipTarget.hideDelay; - - - - -Hello there, I am a tooltip! -- **showDelay**: `number` — Gets/sets the amount of milliseconds that should pass before showing the tooltip. - -// get -let tooltipShowDelay = this.tooltipTarget.showDelay; - - - - -Hello there, I am a tooltip! -- **tooltipDisabled**: `boolean` — Specifies if the tooltip should not show when hovering its target with the mouse. (defaults to false) -While setting this property to 'true' will disable the user interactions that shows/hides the tooltip, -the developer will still be able to show/hide the tooltip through the API. - -// get -let tooltipDisabledValue = this.tooltipTarget.tooltipDisabled; - - - - -Hello there, I am a tooltip! -- **tooltipHide**: `EventEmitter` — Emits an event when the tooltip that is associated with this target starts hiding. -This event is fired before the start of the countdown to hiding the tooltip. - -tooltipHiding(args: ITooltipHideEventArgs) { - alert("Tooltip started hiding!"); -} - - - -Hello there, I am a tooltip! -- **tooltipShow**: `EventEmitter` — Emits an event when the tooltip that is associated with this target starts showing. -This event is fired before the start of the countdown to showing the tooltip. - -tooltipShowing(args: ITooltipShowEventArgs) { - alert("Tooltip started showing!"); -} - - - -Hello there, I am a tooltip! -- **nativeElement**: `any` — Gets the respective native element of the directive. - -let tooltipTargetElement = this.tooltipTarget.nativeElement; -- **tooltipHidden**: `boolean` — Indicates if the tooltip that is is associated with this target is currently hidden. - -let tooltipHiddenValue = this.tooltipTarget.tooltipHidden; -- **hideTooltip**(): void — Hides the tooltip by respecting the 'hideDelay' property. - -this.tooltipTarget.hideTooltip(); -- **showTooltip**(): void — Shows the tooltip by respecting the 'showDelay' property. - -this.tooltipTarget.showTooltip(); - -### [IgxTransactionService](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTransactionService) - -- **constructor**(): IgxTransactionService -- **canRedo**: `boolean` -- **canUndo**: `boolean` -- **enabled**: `boolean` — Returns whether transaction is enabled for this service -- **add**(transaction: T, recordRef?: any): void — Adds provided transaction with recordRef if any -- **clear**(id?: any): void — Clears all transactions -- **commit**(data: any[], id?: any): void — Applies all transactions over the provided data -- **endPending**(commit: boolean): void — Clears all pending transactions and aggregated pending state. If commit is set to true -commits pending states as single transaction -- **getAggregatedChanges**(mergeChanges: boolean): T[] — Returns aggregated changes from all transactions -- **getAggregatedValue**(id: any, mergeChanges: boolean): any — Returns value of the required id including all uncommitted changes -- **getState**(id: any, pending: boolean): S — Returns the state of the record with provided id -- **getTransactionLog**(id?: any): T[] — Returns all recorded transactions in chronological order -- **redo**(): void — Applies the last undone transaction if any -- **undo**(): void — Remove the last transaction if any - -### [IgxTreeComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTreeComponent) -IgxTreeComponent allows a developer to show a set of nodes in a hierarchical fashion. - -- **constructor**(navService: IgxTreeNavigationService, selectionService: IgxTreeSelectionService, treeService: IgxTreeService, element: ElementRef, platform: PlatformUtil): IgxTreeComponent -- **activeNodeChanged**: `EventEmitter>` — Emitted when the active node is changed. -- **animationSettings**: `ToggleAnimationSettings` — Get/Set the animation settings that branches should use when expanding/collpasing. - - - - - -const animationSettings: ToggleAnimationSettings = { - openAnimation: growVerIn, - closeAnimation: growVerOut -}; - -this.tree.animationSettings = animationSettings; -- **cssClass**: `string` -- **expandIndicator**: `TemplateRef` — A custom template to be used for the expand indicator of nodes - - - {{ expanded ? "close_fullscreen": "open_in_full"}} - - -- **nodeCollapsed**: `EventEmitter` — Emitted when a node is collapsed, after it finishes -- **nodeCollapsing**: `EventEmitter` — Emitted when a node is collapsing, before it finishes - - - - - -public handleNodeCollapsing(event: ITreeNodeTogglingEventArgs) { - const collapsedNode: IgxTreeNode = event.node; - if (collapsedNode.alwaysOpen) { - event.cancel = true; - } -} -- **nodeExpanded**: `EventEmitter` — Emitted when a node is expanded, after it finishes - - - - - -public handleNodeExpanded(event: ITreeNodeToggledEventArgs) { - const expandedNode: IgxTreeNode = event.node; - console.log("Node is expanded: ", expandedNode.data); -} -- **nodeExpanding**: `EventEmitter` — Emitted when a node is expanding, before it finishes - - - - - -public handleNodeExpanding(event: ITreeNodeTogglingEventArgs) { - const expandedNode: IgxTreeNode = event.node; - if (expandedNode.disabled) { - event.cancel = true; - } -} -- **nodeSelection**: `EventEmitter` — Emitted when the node selection is changed through interaction - - - - - -public handleNodeSelection(event: ITreeNodeSelectionEvent) { - const newSelection: IgxTreeNode[] = event.newSelection; - const added: IgxTreeNode[] = event.added; - console.log("New selection will be: ", newSelection); - console.log("Added nodes: ", event.added); -} -- **singleBranchExpand**: `boolean` — Get/Set how the tree should handle branch expansion. -If set to true, only a single branch can be expanded at a time, collapsing all others - - -... - - - -const tree: IgxTree = this.tree; -this.tree.singleBranchExpand = false; -- **toggleNodeOnClick**: `boolean` — Get/Set if nodes should be expanded/collapsed when clicking over them. - - -... - - - -const tree: IgxTree = this.tree; -this.tree.toggleNodeOnClick = false; -- **rootNodes**: `IgxTreeNodeComponent[]` — Returns all **root level** nodes - -const tree: IgxTree = this.tree; -const rootNodes: IgxTreeNodeComponent[] = tree.rootNodes; -- **selection**: `IgxTreeSelectionType` — Gets/Sets tree selection mode -- **collapseAll**(nodes?: IgxTreeNode[]): void — Collapses all of the passed nodes. -If no nodes are passed, collapses ALL nodes -- **deselectAll**(nodes?: IgxTreeNodeComponent[]): void — Deselect all nodes if the nodes collection is empty. Otherwise, deselect the nodes in the nodes collection. -- **expandAll**(nodes?: IgxTreeNode[]): void — Expands all of the passed nodes. -If no nodes are passed, expands ALL nodes -- **findNodes**(searchTerm: any, comparer?: IgxTreeSearchResolver): IgxTreeNodeComponent[] — Returns all of the nodes that match the passed searchTerm. -Accepts a custom comparer function for evaluating the search term against the nodes. - -### [IgxTreeGridComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTreeGridComponent) -**Ignite UI for Angular Tree Grid** - -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/grid) - -The Ignite UI Tree Grid displays and manipulates hierarchical data with consistent schema formatted as a table and -provides features such as sorting, filtering, editing, column pinning, paging, column moving and hiding. - -Example: - - - - - - -- **constructor**(validationService: IgxGridValidationService, selectionService: IgxGridSelectionService, colResizingService: IgxColumnResizingService, gridAPI: GridServiceType, transactionFactory: IgxHierarchicalTransactionFactory, _elementRef: ElementRef, _zone: NgZone, document: any, cdr: ChangeDetectorRef, differs: IterableDiffers, viewRef: ViewContainerRef, injector: Injector, envInjector: EnvironmentInjector, navigation: IgxGridNavigationService, filteringService: IgxFilteringService, textHighlightService: IgxTextHighlightService, overlayService: IgxOverlayService, summaryService: IgxGridSummaryService, localeId: string, platform: PlatformUtil, _diTransactions?: HierarchicalTransactionService): IgxTreeGridComponent -- **cascadeOnDelete**: `boolean` — Sets whether child records should be deleted when their parent gets deleted. -By default it is set to true and deletes all children along with the parent. - - -- **childDataKey**: `string` — Sets the child data key of the IgxTreeGridComponent. - -- **foreignKey**: `string` — Sets the foreign key of the IgxTreeGridComponent. - - -- **hasChildrenKey**: `string` — Sets the key indicating whether a row has children. -This property is only used for load on demand scenarios. - - -- **id**: `string` — Sets the value of the id attribute. If not provided it will be automatically generated. - -- **loadChildrenOnDemand**: `any` — Sets a callback for loading child rows on demand. - - - -public loadChildren = (parentID: any, done: (children: any[]) => void) => { - this.dataService.getData(parentID, children => done(children)); -} -- **processedRecords**: `Map` — Returns a map of all processed (filtered and sorted) ITreeGridRecords. -// gets the processed record with primaryKey=2 -const states = this.grid.processedRecords.get(2); -- **processedRootRecords**: `ITreeGridRecord[]` — Returns an array of processed (filtered and sorted) root ITreeGridRecords. -// gets the processed root record with index=2 -const states = this.grid.processedRootRecords[2]; -- **records**: `Map` — Returns a map of all ITreeGridRecords. -// gets the record with primaryKey=2 -const states = this.grid.records.get(2); -- **rootRecords**: `ITreeGridRecord[]` — Returns an array of the root level ITreeGridRecords. -// gets the root record with index=2 -const states = this.grid.rootRecords[2]; -- **data**: `any[]` — Gets/Sets the array of data that populates the component. - -- **expansionDepth**: `number` — Sets the count of levels to be expanded in the IgxTreeGridComponent. By default it is -set to Infinity which means all levels would be expanded. - -- **rowLoadingIndicatorTemplate**: `TemplateRef` — Optional -The template for row loading indicators. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **selectedCells**: `CellType[]` — Returns an array of the selected IgxGridCells. -- **addRow**(data: any, parentRowID?: any): void — Creates a new IgxTreeGridRowComponent with the given data. If a parentRowID is not specified, the newly created -row would be added at the root level. Otherwise, it would be added as a child of the row whose primaryKey matches -the specified parentRowID. If the parentRowID does not exist, an error would be thrown. -const record = { - ID: this.grid.data[this.grid1.data.length - 1].ID + 1, - Name: this.newRecord -}; -this.grid.addRow(record, 1); // Adds a new child row to the row with ID=1. -- **beginAddRowByIndex**(index: number, asChild?: boolean): void — Enters add mode by spawning the UI with the context of the specified row by index. -- **collapseAll**(): void — Collapses all rows. - -this.grid.collapseAll(); -- **expandAll**(): void — Expands all rows. -this.grid.expandAll(); -- **getCellByColumn**(rowIndex: number, columnField: string): CellType — Returns a CellType object that matches the conditions. -- **getCellByKey**(rowSelector: any, columnField: string): CellType — Returns a CellType object that matches the conditions. -- **getRowByIndex**(index: number): RowType — Returns the IgxTreeGridRow by index. -- **getRowByKey**(key: any): RowType — Returns the RowType object by the specified primary key. -- **getSelectedData**(formatters: boolean, headers: boolean): any[] — Returns an array of the current cell selection in the form of [{ column.field: cell.value }, ...]. -- **pinRow**(rowID: any, index?: number): boolean — Pin the row by its id. -- **unpinRow**(rowID: any): boolean — Unpin the row by its id. - -### [IgxTreeGridRow](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTreeGridRow) -Interface representing a row in the grid. It is essentially the blueprint to a row object. -Contains definitions of properties and methods, relevant to a row - -- **children**: `RowType[]` — Optional -Contains the child rows of the current row, if there are any. -- **data**: `any` — The data passed to the row component. - -let selectedRowData = this.grid.selectedRows[0].data; -- **disabled**: `boolean` — Optional -Indicates whether the current row is disabled -- **expanded**: `boolean` — Optional -Indicates whether the current row is expanded. -The value is true, if the row is expanded and false, if it is collapsed -- **hasChildren**: `boolean` — Optional -Indicates whether the current row has any child rows -- **parent**: `RowType` — Optional -Contains the parent row of the current row, if it has one. -If the parent row exist, it means that the current row is a child row -- **pinned**: `boolean` — Optional -Indicates whether the current row is pinned. -- **treeRow**: `ITreeGridRecord` — Optional -Represents the hierarchical record associated with the row (for tree grids). -It is of type ITreeGridRecord, which contains the data, children, the hierarchical level, etc. -- **viewIndex**: `number` — Returns the view index calculated per the grid page. - -### [IgxTreeNodeComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxTreeNodeComponent) -The tree node component represents a child node of the tree component or another tree node. -Usage: - - - ... - - {{ data.FirstName }} {{ data.LastName }} - - ... - - -- **constructor**(tree: IgxTree, selectionService: IgxTreeSelectionService, treeService: IgxTreeService, navService: IgxTreeNavigationService, cdr: ChangeDetectorRef, animationService: AnimationService, element: ElementRef, parentNode: IgxTreeNode): IgxTreeNodeComponent -- **data**: `T` — The data entry that the node is visualizing. -- **expandedChange**: `EventEmitter` — Emitted when the node's expanded property changes. - - - - - - - -const node: IgxTreeNode = this.tree.findNodes(data[0])[0]; -node.expandedChange.pipe(takeUntil(this.destroy$)).subscribe((e: boolean) => console.log("Node expansion state changed to ", e)) -- **loading**: `boolean` — To be used for load-on-demand scenarios in order to specify whether the node is loading data. -- **parentNode**: `IgxTreeNode` -- **selectedChange**: `EventEmitter` — Emitted when the node's selected property changes. - - - - - - - -const node: IgxTreeNode = this.tree.findNodes(data[0])[0]; -node.selectedChange.pipe(takeUntil(this.destroy$)).subscribe((e: boolean) => console.log("Node selection changed to ", e)) -- **tree**: `IgxTree` -- **active**: `boolean` -- **children**: `IgxTreeNode[]` — Return the child nodes of the node (if any) -- **disabled**: `boolean` — Gets/Sets the disabled state of the node -- **expanded**: `boolean` — Get/set whether the node is expanded - - - ... - - {{ node.label }} - - - - -const node: IgxTreeNode = this.tree.findNodes(data[0])[0]; -const expanded = node.expanded; -node.expanded = true; -- **level**: `number` — The depth of the node, relative to the root - - - ... - - My level is {{ node.level }} - - - - -const node: IgxTreeNode = this.tree.findNodes(data[12])[0]; -const level: number = node.level; -- **path**: `IgxTreeNode[]` — Retrieves the full path to the node incuding itself - -const node: IgxTreeNode = this.tree.findNodes(data[0])[0]; -const path: IgxTreeNode[] = node.path; -- **resourceStrings**: `ITreeResourceStrings` — An accessor that returns the resource strings. -- **selected**: `boolean` — Get/set whether the node is selected. Supporst two-way binding. - - - ... - - {{ node.label }} - - - - -const node: IgxTreeNode = this.tree.findNodes(data[0])[0]; -const selected = node.selected; -node.selected = true; -- **collapse**(): void — Collapses the node, triggering animation - - - My Node - - - - -const myNode: IgxTreeNode = this.tree.findNodes(data[0])[0]; -myNode.collapse(); -- **expand**(): void — Expands the node, triggering animation - - - My Node - - - - -const myNode: IgxTreeNode = this.tree.findNodes(data[0])[0]; -myNode.expand(); -- **toggle**(): void — Toggles the node expansion state, triggering animation - - - My Node - - - - -const myNode: IgxTreeNode = this.tree.findNodes(data[0])[0]; -myNode.toggle(); - -### [IgxYearsViewComponent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/IgxYearsViewComponent) - -- **constructor**(el: ElementRef, dayInterval: DayInterval): IgxYearsViewComponent -- **el**: `ElementRef` -- **standalone**: `boolean` -- **yearFormat**: `any` — Gets the year format option of the years view. -let yearFormat = this.yearsView.yearFormat. - -### [ITreeGridAggregation](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/ITreeGridAggregation) - -- **constructor**(): ITreeGridAggregation -- **aggregate**: `any` -- **field**: `string` - -### [NoopFilteringStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/NoopFilteringStrategy) - -- **constructor**(): NoopFilteringStrategy -- **filter**(data: any[], _: IFilteringExpressionsTree, __?: IFilteringExpressionsTree): any[] -- static **instance**(): NoopFilteringStrategy - -### [NoopPivotDimensionsStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/NoopPivotDimensionsStrategy) -Interface describing Pivot data processing for dimensions. -Should contain a process method and return records hierarchy based on the provided dimensions. - -- **constructor**(): NoopPivotDimensionsStrategy -- **process**(collection: any[], _: IPivotDimension[], __: IPivotValue[]): any[] -- static **instance**(): NoopPivotDimensionsStrategy - -### [NoOpScrollStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/NoOpScrollStrategy) -Empty scroll strategy. Does nothing. - -- **constructor**(): NoOpScrollStrategy -- **attach**(): void — Detaches the strategy -settings.scrollStrategy.detach(); -- **detach**(): void — Detaches the strategy -settings.scrollStrategy.detach(); -- **initialize**(): void — Initializes the strategy. Should be called once - -### [NoopSortingStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/NoopSortingStrategy) -Represents a class implementing the IGridSortingStrategy interface with a no-operation sorting strategy. -It performs no sorting and returns the data as it is. - -- **sort**(data: any[]): any[] — data: The array of data to be sorted. Could be of any type. -expressions: An array of sorting expressions that define the sorting rules. The expression contains information like file name, whether the letter case should be taken into account, etc. -grid: (Optional) The instance of the grid where the sorting is applied. -Returns a new array with the data sorted according to the sorting expressions. -- static **instance**(): NoopSortingStrategy - -### [PivotColumnDimensionsStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/PivotColumnDimensionsStrategy) -Interface describing Pivot data processing for dimensions. -Should contain a process method and return records hierarchy based on the provided dimensions. - -- **constructor**(): PivotColumnDimensionsStrategy -- **process**(collection: IPivotGridRecord[], columns: IPivotDimension[], values: IPivotValue[], cloneStrategy: IDataCloneStrategy, pivotKeys: IPivotKeys): any[] -- static **instance**(): PivotRowDimensionsStrategy | PivotColumnDimensionsStrategy - -### [PivotRowDimensionsStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/PivotRowDimensionsStrategy) -Interface describing Pivot data processing for dimensions. -Should contain a process method and return records hierarchy based on the provided dimensions. - -- **constructor**(): PivotRowDimensionsStrategy -- **process**(collection: any, rows: IPivotDimension[], values: IPivotValue[], cloneStrategy: IDataCloneStrategy, pivotKeys: IPivotKeys): IPivotGridRecord[] -- static **instance**(): PivotRowDimensionsStrategy - -### [Point](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/Point) - -- **constructor**(x: number, y: number): Point -- **x**: `number` -- **y**: `number` - -### [ScrollStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/ScrollStrategy) -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-scroll). -Scroll strategies determines how the scrolling will be handled in the provided IgxOverlayService. - -- **constructor**(): ScrollStrategy -- **attach**(): void — Attaches the strategy -settings.scrollStrategy.attach(); -- **detach**(): void — Detaches the strategy -settings.scrollStrategy.detach(); -- **initialize**(document: Document, overlayService: IgxOverlayService, id: string): any — Initializes the strategy. Should be called once - -### [ThemeToken](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/ThemeToken) - -- **constructor**(t?: IgxTheme): ThemeToken -- **subject**: `BehaviorSubject` -- **preferToken**: `boolean` -- **theme**: `IgxTheme` -- **onChange**(callback: any): Subscription -- **set**(theme: IgxTheme): void - -### [TreeGridFilteringStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/TreeGridFilteringStrategy) - -- **constructor**(hierarchicalFilterFields?: string[]): TreeGridFilteringStrategy -- **hierarchicalFilterFields**: `string[]` -- **filter**(data: ITreeGridRecord[], expressionsTree: IFilteringExpressionsTree, advancedExpressionsTree?: IFilteringExpressionsTree, grid?: GridType): ITreeGridRecord[] -- **getFilterItems**(column: ColumnType, tree: IFilteringExpressionsTree): Promise - -### [TreeGridFormattedValuesFilteringStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/TreeGridFormattedValuesFilteringStrategy) - -- **constructor**(fields?: string[]): TreeGridFormattedValuesFilteringStrategy - -### [TreeGridMatchingRecordsOnlyFilteringStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/classes/TreeGridMatchingRecordsOnlyFilteringStrategy) - -- **constructor**(hierarchicalFilterFields?: string[]): TreeGridMatchingRecordsOnlyFilteringStrategy -- **filter**(data: ITreeGridRecord[], expressionsTree: IFilteringExpressionsTree, advancedExpressionsTree?: IFilteringExpressionsTree, grid?: GridType): ITreeGridRecord[] - -## Interfaces - -### [Action](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/Action) - -- **recordRef**: `any` -- **transaction**: `T` - -### [AutocompleteOverlaySettings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/AutocompleteOverlaySettings) - -- **outlet?**: `ElementRef | IgxOverlayOutletDirective` — Set the outlet container to attach the overlay to -- **positionStrategy?**: `IPositionStrategy` — Position strategy to use with this settings -- **scrollStrategy?**: `IScrollStrategy` — Scroll strategy to use with this settings - -### [AutocompleteSelectionChangingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/AutocompleteSelectionChangingEventArgs) -Interface that encapsulates onItemSelection event arguments - new value and cancel selection. - -- **value**: `string` — New value selected from the drop down - -### [BannerCancelEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/BannerCancelEventArgs) - - -### [BannerEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/BannerEventArgs) - -- **event?**: `Event` - -### [CancelableBrowserEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/CancelableBrowserEventArgs) - -- **event?**: `Event` — Browser event - -### [CancelableEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/CancelableEventArgs) - -- **cancel**: `boolean` — Provides the ability to cancel the event. - -### [CarouselAnimationSettings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/CarouselAnimationSettings) - -- **enterAnimation**: `AnimationReferenceMetadata` -- **leaveAnimation**: `AnimationReferenceMetadata` - -### [CellType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/CellType) -Interface representing a cell in the grid. It is essentially the blueprint to a cell object. -Contains definitions of properties and methods, relevant to a cell - -- **active**: `boolean` — Indicates whether the cell is currently active (focused). -- **cellID?**: `any` — Optional; The cellID is the unique key, used to identify the cell -- **column**: `ColumnType` — Represents the column that the cell belongs to. -- **editable**: `boolean` — Indicates whether the cell can be edited. -- **editMode**: `boolean` — Indicates whether the cell is currently in edit mode. -- **editValue**: `any` — The value to display when the cell is in edit mode. -- **grid**: `GridType` — Represents the grid instance containing the cell -- **id?**: `any` — Optional; An object identifying the cell. It contains rowID, columnID, and rowIndex of the cell. -- **nativeElement?**: `HTMLElement` — Represents the native HTML element of the cell itself -- **readonly?**: `boolean` -- **row**: `RowType` — Represents the row that the cell belongs to -- **selected**: `boolean` — Indicates whether the cell is currently selected. It is false, if the sell is not selected, and true, if it is. -- **title?**: `any` — An optional title to display for the cell -- **update**: `any` — A method definition to update the value of the cell. -- **validation?**: `IGridValidationState` — Optional; An object representing the validation state of the cell. -Whether it's valid or invalid, and if it has errors -- **value**: `any` — The current value of the cell. -- **visibleColumnIndex?**: `number` — The index of the column that the cell belongs to. It counts only the visible (not hidden) columns -- **width**: `string` — The CSS width of the cell as a string. -- **activate?**: `any` -- **calculateSizeToFit?**: `any` -- **onClick?**: `any` -- **onDoubleClick?**: `any` -- **setEditMode?**: `any` - -### [ColumnType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ColumnType) -Represents a column in the GridType. It is essentially the blueprint to a column object. -Contains definitions of properties and methods, relevant to a column - -- **additionalTemplateContext**: `any` -- **applySelectableClass**: `boolean` -- **calcWidth**: `any` — Custom CSS styling, applied to every column -calcWidth, minWidthPx, maxWidthPx, minWidth, maxWidth, minWidthPercent, maxWidthPercent, resolvedWidth -- **children**: `QueryList` — A list containing all the child columns under this column (if any). -- **colEnd**: `number` -- **collapsible?**: `boolean` — Optional -Indicated whether the column can be collapsed. If the value is true, the column can be collapsed -It is used in tree grid and for navigation -- **collapsibleIndicatorTemplate?**: `TemplateRef` — The template reference for the collapsible indicator of the column. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **colStart**: `number` -- **columnGroup**: `boolean` — Specifies whether the column belongs to a group of columns. -- **columnLayout**: `boolean` -- **columnLayoutChild**: `boolean` -- **dataType**: `GridColumnDataType` — Represents the type of data for the column: -string, number, boolean, currency, date, time, etc. -- **disabledSummaries?**: `string[]` -- **disableHiding**: `boolean` — Indicates whether a column can be hidden. If the value is true, the column cannot be hidden -- **disablePinning**: `boolean` — Indicates whether a column can be pinned. If the value is true, the column cannot be pinned -- **editable**: `boolean` — Indicated whether the column can be edited. If the value is true, the column can be edited -- **editorOptions**: `IColumnEditorOptions` — Sets properties on the default column editors -- **expanded**: `boolean` — Indicates if the column is currently expanded or collapsed. If the value is true, the column is expanded -- **filterable**: `boolean` — Indicates whether a column can be filtered. If the value is true, the column can be filtered -- **filterCellTemplate**: `TemplateRef` — Represents a custom template for filtering -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **filteringExpressionsTree**: `FilteringExpressionsTree` — The filtering expressions for the column. -The type contains properties and methods for filtering: filteringOperands, operator (logic), fieldName, etc. -- **filteringIgnoreCase**: `boolean` -- **grid**: `GridType` — Represents the instance of the parent GridType that contains this column. -- **groupable**: `boolean` — Indicates whether a column can be put in a group. If the value is true, the column can be put in a group -- **groupingComparer**: `any` — Represents a method with custom grouping comparator to determine the members of the group. -- **hasNestedPath**: `boolean` -- **hasSummary**: `boolean` -- **header?**: `string` — Optional -Represents the header text of the column -- **headerClasses**: `any` — Represents custom CSS classes applied to the header element. When added, they take different styling -- **headerGroupClasses**: `any` — Represents custom CSS classes applied to the header group. When added, they take different styling -- **headerGroupStyles**: `any` — Represents custom CSS styles applied to the header group. When added, they take different styling -- **headerStyles**: `any` — Represents custom CSS styles applied to the header element. When added, they take different styling -- **headerTemplate**: `TemplateRef` — The template reference for the custom header of the column -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **hidden**: `boolean` — Indicates whether a column is currently hidden (not visible). If the value is true, the column is not visible -- **index**: `number` — The index of the column within the grid. -Includes the hidden columns when counting -- **inlineEditorTemplate**: `TemplateRef` — The template reference for the custom inline editor of the column -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **isFirstPinned**: `boolean` — Indicates whether the current column is the first for the grid to be pinned. -If the value is false, there are columns, that have been pinned before the current -- **isLastPinned**: `boolean` — Indicates whether the current column is the last to be pinned. -If the value is false, there are columns, that have been pinned after the current -- **level**: `number` — Represents the hierarchical level of the column in the column layout -- **maxWidth**: `string` -- **maxWidthPercent**: `number` -- **maxWidthPx**: `number` -- **minWidth**: `string` -- **minWidthPercent**: `number` -- **minWidthPx**: `number` -- **parent?**: `ColumnType` — Optional -The immediate parent (right above) column of this column (if any). -If there is no parent, that means the current column is the root parent -- **pinned**: `boolean` — Indicates if the column is currently pinned. If the value is true, the column is pinned -- **pipeArgs**: `IColumnPipeArgs` — Optional arguments for any pipe applied to the field. -- **resizable**: `boolean` — Specifies whether the column can be resized. If the value is true, the column can be resized -- **resolvedWidth**: `string` -- **rowEnd**: `number` -- **rowStart**: `number` -- **searchable**: `boolean` — Specifies whether the data of the column can be searched. If the value is true, the column data can be searched -- **selectable**: `boolean` — Indicates if the column can be selected. If the value is true, the column can be selected -- **selected**: `boolean` — Indicates if the column is currently selected. If the value is true, the column is selected -- **sortable**: `boolean` — Indicates whether a column can be sorted. If the value is true, the column can be sorted. -- **sortingIgnoreCase**: `boolean` — Indicates whether the search should match results, no matter the case of the letters (upper and lower) -If the value is false, the result will depend on the case (example: E will not match e) -If the value is true, the result will not depend on the case (example: E will match e) -- **sortStrategy**: `ISortingStrategy` — The sorting strategy used for sorting this column. -The interface contains a method sort that sorts the provided data based on the given sorting expressions -- **summaries**: `any` -- **summaryTemplate**: `TemplateRef` — The template reference for a summary of the column -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **title**: `string` — The title of the column, used for accessibility purposes -- **topLevelParent?**: `ColumnType` — Optional -The root parent of this column (if any). -If there is no root parent, that means the current column is the root parent -- **validators**: `any[]` -- **visibleIndex**: `number` — The index of the column within the grid. -Does not include the hidden columns when counting -- **width**: `string` -- **childColumns**: `any` -- **getAutoSize**: `any` -- **getCellWidth**: `any` -- **getGridTemplate**: `any` -- **getResizableColUnderEnd**: `any` -- **move**: `any` -- **pin**: `any` -- **populateVisibleIndexes?**: `any` -- **toggleVisibility**: `any` -- **unpin**: `any` - -### [DatePartDeltas](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/DatePartDeltas) -Delta values used for spin actions. - -- **date?**: `number` -- **fractionalSeconds?**: `number` -- **hours?**: `number` -- **minutes?**: `number` -- **month?**: `number` -- **seconds?**: `number` -- **year?**: `number` - -### [DateRange](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/DateRange) -Represents a range between two dates. - -- **end**: `string | Date` -- **start**: `string | Date` - -### [DateRangeDescriptor](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/DateRangeDescriptor) - -- **dateRange?**: `Date[]` -- **type**: `DateRangeType` - -### [DimensionValueType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/DimensionValueType) - -- **children**: `Map` -- **value**: `string` - -### [EntityType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/EntityType) -Describes an entity in the QueryBuilder. -An entity represents a logical grouping of fields and can have nested child entities. - -- **childEntities?**: `EntityType[]` — Optional child entities. -This allows building hierarchical or nested query structures. -- **fields**: `FieldType[]` — The list of fields that belong to this entity. -- **name**: `string` — The name of the entity. -Typically used as an identifier in expressions. - -### [FamilyMeta](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/FamilyMeta) - -- **className**: `string` -- **prefix?**: `string` -- **type**: `IconType` - -### [FieldType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/FieldType) -Describes a field that can be used in the Grid and QueryBuilder components. - -- **dataType**: `DataType` — The data type of the field. -- **defaultDateTimeFormat?**: `string` — Default date/time format for Date/Time fields. -- **defaultTimeFormat?**: `string` — Default time format for Date/Time fields. -- **editorOptions?**: `IFieldEditorOptions` — Options for the editor associated with this field. -- **field**: `string` — The internal field name, used in expressions and queries. -- **filters?**: `IgxFilteringOperand` — Optional filtering operands that apply to this field. -- **header?**: `string` — Optional column header for UI display purposes. -- **label?**: `string` — Display label for the field. -- **pipeArgs?**: `IFieldPipeArgs` — Optional arguments for any pipe applied to the field. -- **formatter?**: `any` - -### [FlatGridType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/FlatGridType) -An interface describing a Flat Grid type. It is essentially the blueprint to a grid kind -Contains definitions of properties and methods, relevant to a grid kind -Extends from GridType - -- **groupingExpansionState**: `IGroupByExpandState[]` -- **groupingExpressions**: `IGroupingExpression[]` -- **groupingExpressionsChange**: `EventEmitter` -- **clearGrouping**: `any` -- **groupBy**: `any` -- **toggleGroup**: `any` - -### [GridSelectionRange](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/GridSelectionRange) -Represents a range selection between certain rows and columns of the grid. -Range selection can be made either through drag selection or through keyboard selection. - -- **columnEnd**: `string | number` — The identifier or index of the ending column of the selection range. -It can be either a string representing the column's field name or a numeric index. -- **columnStart**: `string | number` — The identifier or index of the starting column of the selection range. -It can be either a string representing the column's field name or a numeric index. -- **rowEnd**: `number` — The index of the ending row of the selection range. -- **rowStart**: `number` — The index of the starting row of the selection range. - -### [GridServiceType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/GridServiceType) -Represents the service interface for interacting with the grid. - -- **cms**: `IgxColumnMovingService` — A service responsible for handling column moving within the grid. It contains a reference to the column, its icon, and indicator for cancelation. -- **crudService**: `any` — Represents the type of the CRUD service (Create, Read, Update, Delete) operations on the grid data. -- **grid**: `GridType` — The reference to the parent GridType that contains the service. -- **addRowToData**: `any` -- **clear_groupby?**: `any` -- **clear_sort**: `any` -- **deleteRowById**: `any` -- **expand_path_to_record?**: `any` -- **filterDataByExpressions**: `any` -- **get_all_data**: `any` -- **get_cell_by_index**: `any` -- **get_cell_by_key**: `any` -- **get_cell_by_visible_index**: `any` -- **get_column_by_name**: `any` -- **get_data**: `any` -- **get_groupBy_record_id?**: `any` -- **get_pin_row_event_args**: `any` -- **get_rec_by_id**: `any` -- **get_rec_id_by_index**: `any` -- **get_rec_index_by_id**: `any` -- **get_row_by_index**: `any` -- **get_row_by_key**: `any` -- **get_row_expansion_state**: `any` -- **get_row_id**: `any` -- **get_row_index_in_data**: `any` -- **get_selected_children?**: `any` -- **get_summary_data**: `any` -- **getChildGrid?**: `any` -- **getChildGrids?**: `any` -- **getParentRowId?**: `any` -- **getRowData**: `any` -- **prepare_sorting_expression**: `any` -- **registerChildRowIsland?**: `any` -- **remove_grouping_expression?**: `any` -- **row_deleted_transaction**: `any` -- **set_grouprow_expansion_state?**: `any` -- **set_row_expansion_state**: `any` -- **sort**: `any` -- **sort_multiple**: `any` -- **sortDataByExpressions**: `any` -- **unsetChildRowIsland?**: `any` -- **update_cell**: `any` -- **update_row**: `any` - -### [GridSVGIcon](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/GridSVGIcon) - -- **name**: `string` -- **value**: `string` - -### [GridType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/GridType) -Interface representing a grid type. It is essentially the blueprint to a grid object. -Contains definitions of properties and methods, relevant to a grid -Extends IGridDataBindable - -- **_baseFontSize?**: `number` — The default font size, calculated for each element -- **_filteredSortedUnpinnedData**: `any[]` -- **_filteredUnpinnedData**: `any[]` -- **_totalRecords**: `number` -- **activeNodeChange**: `EventEmitter` -- **advancedFilteringExpressionsTree**: `IFilteringExpressionsTree` -- **advancedFilteringExpressionsTreeChange**: `EventEmitter` -- **allowAdvancedFiltering**: `boolean` -- **allowFiltering**: `boolean` — Indicates whether filtering in the grid is enabled. If te value is true, the grid can be filtered -- **batchEditing**: `boolean` -- **batchEditingChange?**: `EventEmitter` -- **calcHeight**: `number` — CSS styling calculated for an element: calcHeight, calcWidth, outerWidth -- **calcWidth**: `number` -- **cascadeOnDelete?**: `boolean` -- **cdr**: `ChangeDetectorRef` — Provides change detection functionality. -A change-detection tree collects all views that are to be checked for changes. -The property cannot be changed (readonly) -- **cellClick**: `EventEmitter` -- **cellEdit**: `EventEmitter` -- **cellEditDone**: `EventEmitter` -- **cellEditEnter**: `EventEmitter` -- **cellEditExit**: `EventEmitter` -- **cellSelection**: `GridSelectionMode` — Represents the selection mode for cells: 'none','single', 'multiple', 'multipleCascade' -- **childDataKey?**: `any` -- **childLayoutKeys?**: `any[]` -- **childLayoutList?**: `QueryList` -- **columnInDrag**: `any` — Indicates if the column of the grid is in drag mode -- **columnList**: `QueryList` — An unmodifiable list, containing all the columns of the grid. -- **columnMoving**: `EventEmitter` -- **columnMovingEnd**: `EventEmitter` -- **columnMovingStart**: `EventEmitter` -- **columnPin**: `EventEmitter` -- **columnPinned**: `EventEmitter` -- **columnResized**: `EventEmitter` -- **columns**: `ColumnType[]` -- **columnSelection**: `GridSelectionMode` — Represents the selection mode for columns: 'none','single', 'multiple', 'multipleCascade' -- **columnSelectionChanging**: `EventEmitter` -- **columnVisibilityChanged**: `EventEmitter` -- **columnVisibilityChanging**: `EventEmitter` -- **columnWidthSetByUser**: `boolean` — Indicates whether the width of the column is set by the user, or is configured automatically. -- **contextMenu**: `EventEmitter` -- **currencyPositionLeft**: `boolean` — Indicates whether the currency symbol is positioned to the left of values. -- **dataCloneStrategy**: `IDataCloneStrategy` — Strategy, used for cloning the provided data. The type has one method, that takes any type of data -- **dataRowList**: `any` -- **dataView**: `any[]` -- **dataWithAddedInTransactionRows**: `any[]` -- **defaultHeaderGroupMinWidth**: `any` — Minimal width for headers -- **defaultRowHeight**: `number` -- **defaultSummaryHeight**: `number` -- **disableTransitions**: `boolean` — Indicates whether transitions are disabled for the grid. -- **doubleClick**: `EventEmitter` -- **dragIndicatorIconBase**: `any` — The base drag indicator icon. Could be of any type -- **dragIndicatorIconTemplate**: `any` — The template for drag indicator icons. Could be of any type -- **excelStyleHeaderIconTemplate**: `TemplateRef` — The template for header icon -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **expansionDepth?**: `number` -- **expansionStates**: `Map` -- **filteredSortedData**: `any[]` -- **filtering**: `EventEmitter` -- **filteringDone**: `EventEmitter` -- **filteringExpressionsTree**: `IFilteringExpressionsTree` -- **filteringExpressionsTreeChange**: `EventEmitter` -- **filteringLogic**: `FilteringLogic` -- **filteringPipeTrigger**: `number` -- **filterMode**: `FilterMode` — The filter mode for the grid. It can be quick filter of excel-style filter -- **filterStrategy**: `IFilteringStrategy` -- **firstEditableColumnIndex**: `number` -- **flatData?**: `any[]` -- **foreignKey?**: `any` -- **formGroupCreated**: `EventEmitter` -- **getHeaderCellWidth**: `any` — Property, that gets the header cell inner width for auto-sizing. -- **gridAPI**: `GridServiceType` — Represents the grid service type providing API methods for the grid -- **gridKeydown**: `EventEmitter` -- **groupByRowSelectorTemplate?**: `TemplateRef` — Optional -The template for the group row selector. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **groupingExpansionState?**: `IGroupByExpandState[]` -- **groupingExpressions?**: `IGroupingExpression[]` -- **groupingExpressionsChange?**: `EventEmitter` -- **groupingFlatResult?**: `any[]` -- **groupingMetadata?**: `any[]` -- **groupingResult?**: `any[]` -- **groupRowTemplate?**: `TemplateRef` — Optional -The template for group-by rows. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **groupsExpanded?**: `boolean` -- **groupsRecords?**: `IGroupByRecord[]` -- **groupStrategy?**: `IGridGroupingStrategy` -- **hasChildrenKey?**: `any` -- **hasDetails**: `boolean` -- **hasExpandableChildren?**: `boolean` — Optional -Indicates whether the grid has expandable children (hierarchical and tree grid) -- **hasPinnedRecords**: `boolean` -- **hasVisibleColumns**: `boolean` — Indicates whether the grid has columns that are shown -- **headerCollapsedIndicatorTemplate**: `TemplateRef` — The template for header collapsed indicators. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **headerExpandedIndicatorTemplate**: `TemplateRef` — The template for header expanded indicators. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **headerFeaturesWidth**: `number` -- **headSelectorBaseAriaLabel**: `string` -- **headSelectorTemplate**: `TemplateRef` — The template for the header selector. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **hiddenColumnsCount**: `number` — Represents the count of only the hidden (not visible) columns -- **highlightedRowID?**: `any` -- **iconTemplate?**: `TemplateRef` — Optional -The template for grid icons. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **id**: `string` — Represents the unique identifier of the grid. -- **isCellSelectable**: `boolean` — Indicates whether cells are selectable in the grid -- **isLoading**: `boolean` -- **isMultiRowSelectionEnabled**: `boolean` — Indicates whether it is allowed to select more than one row in the grid -- **isPinningToStart**: `boolean` — Indicates whether the grid's element is pinned to the start of the grid -- **isRowPinningToTop**: `boolean` -- **isRowSelectable**: `boolean` — Indicates whether the grid's rows can be selected -- **lastChildGrid?**: `GridType` -- **lastEditableColumnIndex**: `number` -- **lastSearchInfo**: `ISearchInfo` — Represents the last search in the grid -It contains the search text (the user has entered), the match and some settings for the search -- **loadChildrenOnDemand?**: `any` -- **loadingRows?**: `Set` -- **locale**: `string` — Represents the locale of the grid: USD, EUR, GBP, CNY, JPY, etc. -- **localeChange**: `EventEmitter` -- **maxLevelHeaderDepth**: `number` -- **moving**: `boolean` — Indicates whether the grid is currently in a moving state. -- **multiRowLayoutRowSize**: `number` -- **nativeElement**: `HTMLElement` — Represents the native HTML element itself -- **navigation**: `any` -- **outerWidth**: `number` -- **outlet**: `any` -- **pagingMode**: `GridPagingMode` — Represents the paging of the grid. It can be either 'Local' or 'Remote' -- Local: Default value; The grid will paginate the data source based on the page -- **parent?**: `GridType` -- **parentVirtDir**: `any` -- **pinnedColumns**: `ColumnType[]` — An array of columns, but it counts only the ones that are pinned -- **pinnedColumnsCount**: `number` — Represents the count of only the pinned columns -- **pinnedRecords**: `any[]` -- **pinnedRecordsCount**: `number` -- **pinnedRows**: `any[]` -- **pinnedWidth**: `number` — The width of pinned element -- **pinning**: `IPinningConfig` — The configuration for columns and rows pinning in the grid -It's of type IPinningConfig, which can have value for columns (start, end) and for rows (top, bottom) -- **pipeTrigger**: `number` -- **primaryKey**: `string` — Represents the unique primary key used for identifying rows in the grid -- **processedExpandedFlatData?**: `any[]` -- **processedRecords?**: `Map` -- **processedRootRecords?**: `ITreeGridRecord[]` -- **rangeSelected**: `EventEmitter` -- **records?**: `Map` -- **rendered$**: `Observable` -- **renderedRowHeight**: `number` — The height of the visible rows in the grid. -- **resizeNotify**: `Subject` -- **resourceStrings**: `IGridResourceStrings` -- **rootGrid?**: `GridType` -- **rootRecords?**: `ITreeGridRecord[]` -- **rootSummariesEnabled**: `boolean` -- **rowAdd**: `EventEmitter` -- **rowAdded**: `EventEmitter` -- **rowAddedNotifier**: `Subject` -- **rowClick**: `EventEmitter` -- **rowCollapsedIndicatorTemplate**: `TemplateRef` — The template for collapsed row indicators. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **rowDelete**: `EventEmitter` -- **rowDeleted**: `EventEmitter` -- **rowDeletedNotifier**: `Subject` -- **rowDragEnd**: `EventEmitter` -- **rowDraggable**: `boolean` — Indicates whether rows in the grid can be dragged. If te value is true, the rows can be dragged -- **rowDragging**: `boolean` — Indicates whether a row is currently being dragged -- **rowDragStart**: `EventEmitter` -- **rowEdit**: `EventEmitter` -- **rowEditable**: `boolean` — Indicates whether rows in the grid are editable. If te value is true, the rows can be edited -- **rowEditDone**: `EventEmitter` -- **rowEditEnter**: `EventEmitter` -- **rowEditExit**: `EventEmitter` -- **rowEditingOverlay**: `IgxToggleDirective` -- **rowEditTabs**: `any` -- **rowExpandedIndicatorTemplate**: `TemplateRef` — The template for expanded row indicators. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **rowHeight**: `number` — The height of each row in the grid. Setting a constant height can solve problems with not showing all elements when scrolling -- **rowList**: `any` -- **rowLoadingIndicatorTemplate?**: `TemplateRef` — Optional -The template for row loading indicators. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **rowSelection**: `GridSelectionMode` — Represents the selection mode for rows: 'none','single', 'multiple', 'multipleCascade' -- **rowSelectionChanging**: `EventEmitter` -- **rowSelectorTemplate**: `TemplateRef` — The template for row selectors. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **rowToggle**: `EventEmitter` -- **scrollSize**: `number` -- **selected**: `EventEmitter` -- **selectedCells?**: `CellType[]` -- **selectedRows**: `any[]` -- **selectionService**: `any` — The service handling selection in the grid. Selecting, deselecting elements -- **selectRowOnClick**: `boolean` -- **showExpandAll?**: `boolean` — Optional -Indicates whether collapsed grid elements should be expanded -- **showRowSelectors**: `boolean` — Indicates whether the selectors of the rows are visible -- **sortAscendingHeaderIconTemplate**: `TemplateRef` — The template for ascending sort header icons. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **sortDescendingHeaderIconTemplate**: `TemplateRef` — The template for descending sort header icons. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **sortHeaderIconTemplate**: `TemplateRef` — The template for sort header icons. -It is of type TemplateRef, which represents an embedded template, used to instantiate embedded views -- **sortingExpressions**: `ISortingExpression[]` -- **sortingExpressionsChange**: `EventEmitter[]>` -- **sortingOptions**: `ISortingOptions` -- **sortStrategy**: `IGridSortingStrategy` -- **summariesMargin**: `number` — The CSS margin of the summaries -- **summariesRowList**: `any` -- **summaryCalculationMode**: `GridSummaryCalculationMode` — Represents the calculation mode for summaries: 'rootLevelOnly', 'childLevelsOnly', 'rootAndChildLevels' -- **summaryPipeTrigger**: `number` -- **summaryPosition**: `GridSummaryPosition` — Represents the position of summaries: 'top', 'bottom' -- **summaryRowHeight**: `number` -- **tbody**: `any` -- **toolbarExporting**: `EventEmitter` -- **totalRowsCountAfterFilter**: `number` -- **transactions**: `TransactionService` — Represents the transaction service for the grid. -- **treeGroupArea?**: `any` -- **uniqueColumnValuesStrategy**: `any` — Property, that provides a callback for loading unique column values on demand. -If this property is provided, the unique values it generates will be used by the Excel Style Filtering -- **unpinnedColumns**: `ColumnType[]` — An array of columns, but it counts only the ones that are not pinned -- **unpinnedRecords**: `any[]` -- **unpinnedWidth**: `number` — The width of unpinned element -- **updateOnRender?**: `boolean` -- **validation**: `IgxGridValidationService` — Represents the validation service for the grid. The type contains properties and methods (logic) for validating records -- **validationStatusChange**: `EventEmitter` -- **validationTrigger**: `GridValidationTrigger` — The trigger for grid validation. It's value can either be change or blur -- **verticalScrollContainer**: `any` -- **virtualizationState**: `IForOfState` — Represents the state of virtualization for the grid. It has an owner, start index and chunk size -- **visibleColumns**: `ColumnType[]` — An array of columns, but it counts only the ones visible (not hidden) in the view -- **clearCellSelection**: `any` -- **clearGrouping?**: `any` -- **clearSort**: `any` -- **closeRowEditingOverlay**: `any` -- **collapseRow**: `any` -- **columnToVisibleIndex**: `any` -- **createColumnsList?**: `any` -- **createFilterDropdown**: `any` -- **createRow?**: `any` -- **deleteRow**: `any` -- **deleteRowById**: `any` -- **deselectAllColumns**: `any` -- **deselectAllRows**: `any` -- **deselectColumns**: `any` -- **deselectRows**: `any` -- **generateRowPath?**: `any` -- **getChildGrids?**: `any` -- **getColumnByName**: `any` -- **getColumnByVisibleIndex**: `any` -- **getDefaultExpandState**: `any` -- **getDragGhostCustomTemplate**: `any` -- **getEmptyRecordObjectFor**: `any` -- **getHeaderGroupWidth**: `any` -- **getInitialPinnedIndex**: `any` -- **getNextCell**: `any` -- **getPossibleColumnWidth**: `any` -- **getPreviousCell**: `any` -- **getRowByIndex?**: `any` -- **getRowByKey?**: `any` -- **getSelectedRanges**: `any` -- **getUnpinnedIndexById**: `any` -- **getVisibleContentHeight**: `any` -- **groupBy?**: `any` -- **hasVerticalScroll**: `any` -- **isChildGridRecord?**: `any` -- **isColumnGrouped**: `any` -- **isDetailRecord**: `any` -- **isExpandedGroup**: `any` -- **isGhostRecord**: `any` -- **isGroupByRecord**: `any` -- **isHierarchicalRecord?**: `any` -- **isRecordPinned**: `any` -- **isRecordPinnedByViewIndex**: `any` -- **isSummaryRow**: `any` -- **isTreeRow?**: `any` -- **moveColumn**: `any` -- **navigateTo**: `any` -- **notifyChanges**: `any` -- **openAdvancedFilteringDialog**: `any` -- **openRowOverlay**: `any` -- **pinRow**: `any` -- **preventHeaderScroll?**: `any` -- **reflow**: `any` -- **refreshSearch**: `any` -- **repositionRowEditingOverlay**: `any` -- **resetColumnCollections**: `any` -- **resetHorizontalVirtualization**: `any` -- **resolveOutlet?**: `any` -- **selectAllRows**: `any` -- **selectColumns**: `any` -- **selectedColumns**: `any` -- **selectRange**: `any` -- **selectRows**: `any` -- **setFilteredData**: `any` -- **setFilteredSortedData**: `any` -- **setUpPaginator**: `any` -- **showSnackbarFor**: `any` -- **sort**: `any` -- **toggleAll?**: `any` -- **toggleAllGroupRows?**: `any` -- **toggleGroup?**: `any` -- **trackColumnChanges**: `any` -- **triggerPipes**: `any` -- **unpinRow**: `any` -- **updateCell**: `any` -- **updateColumns**: `any` -- **updateRow**: `any` - -### [HeaderType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/HeaderType) -Interface representing a header cell in the grid. It is essentially the blueprint to a header cell object. -Contains definitions of properties, relevant to the header - -- **column**: `ColumnType` — The column that the header cell represents. -- **nativeElement**: `HTMLElement` — Represents the native HTML element of the cell itself -- **selectable**: `boolean` — Indicates whether the cell can be selected -- **selected**: `boolean` — Indicates whether the cell is currently selected -- **sortDirection**: `SortingDirection` — Represents the sorting direction of the column (ascending, descending or none). -- **sorted**: `boolean` — Indicates whether the column is currently sorted. -- **title**: `boolean` — Indicates whether the column header is a title cell. - -### [HierarchicalGridType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/HierarchicalGridType) -An interface describing a Hierarchical Grid type. It is essentially the blueprint to a grid kind -Contains definitions of properties and methods, relevant to a grid kind -Extends from GridType - -- **childLayoutKeys**: `any[]` - -### [HierarchicalTransactionService](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/HierarchicalTransactionService) - -- **commit**: `any` - -### [IAccordionCancelableEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IAccordionCancelableEventArgs) - -- **owner**: `IgxAccordionComponent` — Provides reference to the owner component. -- **panel**: `IgxExpansionPanelBase` — Provides a reference to the IgxExpansionPanelComponent which is currently expanding/collapsing. - -### [IAccordionEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IAccordionEventArgs) - -- **owner**: `IgxAccordionComponent` — Provides reference to the owner component. -- **panel**: `IgxExpansionPanelBase` — Provides a reference to the IgxExpansionPanelComponent which was expanded/collapsed. - -### [IActionStripResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IActionStripResourceStrings) - -- **igx_action_strip_button_more_title?**: `string` - -### [IActiveHighlightInfo](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IActiveHighlightInfo) -An interface describing information for the active highlight. - -- **column?**: `any` — The column of the highlight. -- **index**: `number` — The index of the highlight. -- **metadata?**: `Map` — Additional, custom checks to perform prior an element highlighting. -- **row?**: `any` — The row of the highlight. - -### [IActiveNodeChangeEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IActiveNodeChangeEventArgs) -Emitted when the active node is changed - -- **column**: `number` — Represents the column index of the active node -- **level?**: `number` — Optional -Represents the hierarchical level of the active node -- **row**: `number` — Represents the row index of the active node -- **tag**: `GridKeydownTargetType` — Represents the type of the active node. -The GridKeydownTargetType is an enum or that specifies the possible target types - -### [IBannerResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IBannerResourceStrings) - -- **igx_banner_button_dismiss?**: `string` - -### [IBaseChipEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IBaseChipEventArgs) - -- **originalEvent**: `KeyboardEvent | MouseEvent | TouchEvent | IDropBaseEventArgs | IDragBaseEventArgs` -- **owner**: `IgxChipComponent` — Provides reference to the owner component. - -### [IBaseChipsAreaEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IBaseChipsAreaEventArgs) - -- **originalEvent**: `KeyboardEvent | MouseEvent | TouchEvent | IDropBaseEventArgs | IDragBaseEventArgs` -- **owner**: `IgxChipsAreaComponent` - -### [IBaseSearchInfo](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IBaseSearchInfo) - -- **caseSensitive**: `boolean` -- **content**: `string` -- **exactMatch**: `boolean` -- **matchCount**: `number` -- **searchText**: `string` - -### [IButtonEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IButtonEventArgs) - -- **button**: `IgxButtonDirective` - -### [IButtonGroupEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IButtonGroupEventArgs) - -- **button**: `IgxButtonDirective` -- **index**: `number` -- **owner**: `IgxButtonGroupComponent` — Provides reference to the owner component. - -### [ICachedViewLoadedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ICachedViewLoadedEventArgs) - -- **oldContext**: `any` - -### [ICalendarResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ICalendarResourceStrings) - -- **igx_calendar_first_picker_of?**: `string` -- **igx_calendar_multi_selection?**: `string` -- **igx_calendar_next_month?**: `string` -- **igx_calendar_next_year?**: `string` -- **igx_calendar_next_years?**: `string` -- **igx_calendar_previous_month?**: `string` -- **igx_calendar_previous_year?**: `string` -- **igx_calendar_previous_years?**: `string` -- **igx_calendar_range_end?**: `string` -- **igx_calendar_range_label_end?**: `string` -- **igx_calendar_range_label_start?**: `string` -- **igx_calendar_range_placeholder?**: `string` -- **igx_calendar_range_selection?**: `string` -- **igx_calendar_range_start?**: `string` -- **igx_calendar_select_date?**: `string` -- **igx_calendar_select_month?**: `string` -- **igx_calendar_select_year?**: `string` -- **igx_calendar_selected_month_is?**: `string` -- **igx_calendar_single_selection?**: `string` -- **igx_calendar_singular_multi_selection?**: `string` -- **igx_calendar_singular_range_selection?**: `string` -- **igx_calendar_singular_single_selection?**: `string` - -### [ICarouselResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ICarouselResourceStrings) - -- **igx_carousel_next_slide?**: `string` -- **igx_carousel_of?**: `string` -- **igx_carousel_previous_slide?**: `string` -- **igx_carousel_slide?**: `string` - -### [ICellPosition](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ICellPosition) -The event is triggered when getting the current position of a certain cell - -- **rowIndex**: `number` — It returns the position (index) of the row, the cell is in -- **visibleColumnIndex**: `number` — It returns the position (index) of the column, the cell is in -Counts only the visible (non hidden) columns - -### [IChangeCheckboxEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IChangeCheckboxEventArgs) - -- **checked**: `boolean` -- **value?**: `any` - -### [IChangeProgressEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IChangeProgressEventArgs) - -- **currentValue**: `number` -- **previousValue**: `number` - -### [IChipClickEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IChipClickEventArgs) - -- **cancel**: `boolean` - -### [IChipEnterDragAreaEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IChipEnterDragAreaEventArgs) - -- **dragChip**: `IgxChipComponent` - -### [IChipKeyDownEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IChipKeyDownEventArgs) - -- **cancel**: `boolean` -- **originalEvent**: `KeyboardEvent` - -### [IChipResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IChipResourceStrings) - -- **igx_chip_remove?**: `string` -- **igx_chip_select?**: `string` - -### [IChipsAreaReorderEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IChipsAreaReorderEventArgs) - -- **chipsArray**: `IgxChipComponent[]` - -### [IChipsAreaSelectEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IChipsAreaSelectEventArgs) - -- **newSelection**: `IgxChipComponent[]` - -### [IChipSelectEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IChipSelectEventArgs) - -- **cancel**: `boolean` -- **selected**: `boolean` - -### [IClipboardOptions](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IClipboardOptions) -An interface describing settings for clipboard options - -- **copyFormatters**: `boolean` — Apply the columns formatters (if any) on the data in the clipboard output. -- **copyHeaders**: `boolean` — Include the columns headers in the clipboard output. -- **enabled**: `boolean` — Enables/disables the copy behavior -- **separator**: `string` — The separator used for formatting the copy output. Defaults to \t. - -### [IColumnEditorOptions](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnEditorOptions) - - -### [IColumnExportingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnExportingEventArgs) -columnExporting event arguments -this.exporterService.columnExporting.subscribe((args: IColumnExportingEventArgs) => { -// set args properties here -}); - -- **cancel**: `boolean` — Skip the exporting column when set to true -- **columnIndex**: `number` — Contains the exporting column index -- **field**: `string` — Contains the exporting column field name -- **grid?**: `GridType` — A reference to the grid owner. -- **header**: `string` — Contains the exporting column header -- **skipFormatter**: `boolean` — Export the column's data without applying its formatter, when set to true - -### [IColumnInfo](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnInfo) - -- **columnGroup?**: `string | ColumnType` -- **columnGroupParent?**: `string | ColumnType` -- **columnSpan?**: `number` -- **currencyCode?**: `string` -- **dataType?**: `GridColumnDataType` -- **dateFormat?**: `string` -- **digitsInfo?**: `string` -- **displayFormat?**: `string` -- **exportIndex?**: `number` -- **field**: `string` -- **formatter?**: `any` -- **header**: `string` -- **headerType?**: `ExportHeaderType` -- **level?**: `number` -- **pinnedIndex?**: `number` -- **rowSpan?**: `number` -- **skip**: `boolean` -- **skipFormatter?**: `boolean` -- **startIndex?**: `number` - -### [IColumnList](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnList) - -- **columns**: `IColumnInfo[]` -- **columnWidths**: `number[]` -- **indexOfLastPinnedColumn**: `number` -- **maxLevel?**: `number` -- **maxRowLevel?**: `number` - -### [IColumnMovingEndEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnMovingEndEventArgs) -Represents event arguments related to the end of a column moving operation in a grid - -- **cancel**: `boolean` — cancel returns whether the event has been intercepted and stopped -If the value becomes "true", it returns/exits from the method, instantiating the interface -- **source**: `ColumnType` — The source of the event represents the column that is being moved. -The ColumnType contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties -- **target**: `ColumnType` — The target of the event represents the column, the source is being moved to. -The ColumnType contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties - -### [IColumnMovingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnMovingEventArgs) -Represents event arguments related to a column moving operation in a grid - -- **cancel**: `boolean` — cancel returns whether the event has been intercepted and stopped -If the value becomes "true", it returns/exits from the method, instantiating the interface -- **source**: `ColumnType` — Represents the column that is being moved. -The ColumnType contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties - -### [IColumnMovingStartEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnMovingStartEventArgs) -Represents event arguments related to the start of a column moving operation in a grid. - -- **source**: `ColumnType` — Represents the column that is being moved. -The ColumnType contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties - -### [IColumnPipeArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnPipeArgs) - - -### [IColumnResizeEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnResizeEventArgs) -The event arguments when a column is being resized - -- **column**: `ColumnType` — Represents the information of the column that is being resized -- **newWidth**: `string` — Represents the new width, the column is being resized to -- **prevWidth**: `string` — Represents the old width of the column before the resizing - -### [IColumnResizingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnResizingEventArgs) -The event arguments when a column is being resized -It contains information about the column, it's old and new width -The event can be canceled - - -### [IColumnSelectionEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnSelectionEventArgs) -The event arguments when the selection state of a column is being changed -The event is cancelable - -- **added**: `string[]` — Represents an array of all added columns -Whenever a column has been selected, the array is "refreshed" with the selected columns -- **event?**: `Event` — Represents the original event, that has triggered the selection change -selecting, deselecting -- **newSelection**: `string[]` — Represents the newly selected columns -- **oldSelection**: `string[]` — Represents an array of columns, that have already been selected -- **removed**: `string[]` — Represents an array of all columns, removed from the selection -Whenever a column has been deselected, the array is "refreshed" with the columns, that have been previously selected, but are no longer - -### [IColumnSelectionState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnSelectionState) -Represents the state of the columns in the grid. - -- **field**: `string` — Represents the field name of the selected column, if any. Can be null if no column is selected. -- **range**: `string[]` — An array of strings representing the ranges of selected columns in the grid. - -### [IColumnState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnState) - -- **colEnd?**: `number` -- **collapsible?**: `boolean` -- **colStart?**: `number` -- **columnGroup**: `boolean` -- **columnLayout?**: `boolean` -- **dataType**: `GridColumnDataType` -- **disableHiding**: `boolean` -- **disablePinning**: `boolean` -- **editable**: `boolean` -- **expanded?**: `boolean` -- **field**: `string` -- **filterable**: `boolean` -- **filteringIgnoreCase**: `boolean` -- **groupable**: `boolean` -- **hasSummary**: `boolean` -- **header**: `string` -- **headerClasses**: `string` -- **headerGroupClasses**: `string` -- **hidden**: `boolean` -- **key**: `string` -- **maxWidth**: `string` -- **parent?**: `any` -- **parentKey**: `string` -- **pinned**: `boolean` -- **resizable**: `boolean` -- **rowEnd?**: `number` -- **rowStart?**: `number` -- **searchable**: `boolean` -- **sortable**: `boolean` -- **sortingIgnoreCase**: `boolean` -- **visibleWhenCollapsed?**: `boolean` -- **width**: `any` - -### [IColumnToggledEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnToggledEventArgs) -Event emitted when a checkbox in the checkbox -list of an IgxColumnActions component is clicked. - -- **checked**: `boolean` — The checked state after the action. -- **column**: `ColumnType` — The column that is toggled. - -### [IColumnVisibilityChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnVisibilityChangedEventArgs) -The event arguments after a column's visibility is changed. - -- **column**: `any` — Represents the column the event originated from -- **newValue**: `boolean` — The new hidden state that the column will have, if operation is successful. -Will be true when hiding and false when showing. - -### [IColumnVisibilityChangingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IColumnVisibilityChangingEventArgs) -The event arguments when a column's visibility is changed. -The event is cancelable -It contains information about the column and the it's visibility after the operation (will be true when hiding and false when showing) - - -### [IComboFilteringOptions](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IComboFilteringOptions) -The filtering criteria to be applied on data search - -- **caseSensitive?**: `boolean` — Defines filtering case-sensitivity -- **filteringKey?**: `string` — Defines optional key to filter against complex list items. Default to displayKey if provided. - -### [IComboItemAdditionEvent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IComboItemAdditionEvent) - -- **addedItem**: `any` -- **newCollection**: `any[]` -- **oldCollection**: `any[]` - -### [IComboResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IComboResourceStrings) - -- **igx_combo_addCustomValues_placeholder?**: `string` -- **igx_combo_aria_label_no_options?**: `string` -- **igx_combo_aria_label_options?**: `string` -- **igx_combo_clearItems_placeholder?**: `string` -- **igx_combo_empty_message?**: `string` -- **igx_combo_filter_search_placeholder?**: `string` - -### [IComboSearchInputEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IComboSearchInputEventArgs) -Event emitted when the igx-combo's search input changes - -- **searchText**: `string` — The text that has been typed into the search input - -### [IComboSelectionChangingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IComboSelectionChangingEventArgs) -Event emitted when an igx-combo's selection is changing - -- **added**: `any[]` — An array containing the items that will be added to the selection (if any) -- **displayText**: `string` — The text that will be displayed in the combo text box -- **event?**: `Event` — The user interaction that triggered the selection change -- **newSelection**: `any[]` — An array containing the items that will be selected after this event -- **newValue**: `any[]` — An array containing the values that will be selected after this event -- **oldSelection**: `any[]` — An array containing the items that are currently selected -- **oldValue**: `any[]` — An array containing the values that are currently selected -- **removed**: `any[]` — An array containing the items that will be removed from the selection (if any) - -### [IconFamily](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IconFamily) - -- **meta**: `FamilyMeta` -- **name**: `string` - -### [IconMeta](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IconMeta) - -- **family**: `string` -- **name**: `string` -- **type?**: `IconType` - -### [ICsvExportEndedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ICsvExportEndedEventArgs) - -- **csvData?**: `string` - -### [IDataCloneStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDataCloneStrategy) - -- **clone**: `any` - -### [IDateParts](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDateParts) -Interface describing Date object in parts - -- **day**: `number` -- **hours**: `number` -- **milliseconds**: `number` -- **minutes**: `number` -- **month**: `number` -- **seconds**: `number` -- **year**: `number` - -### [IDatePickerResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDatePickerResourceStrings) - -- **igx_date_picker_change_date?**: `string` -- **igx_date_picker_choose_date?**: `string` - -### [IDatePickerValidationFailedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDatePickerValidationFailedEventArgs) -Provides information about date picker reference and its previously valid value -when onValidationFailed event is fired. - -- **currentValue**: `string | Date` -- **prevValue**: `string | Date` - -### [IDateRangePickerResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDateRangePickerResourceStrings) - -- **igx_date_range_picker_date_separator?**: `string` -- **igx_date_range_picker_done_button?**: `string` - -### [IDialogCancellableEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDialogCancellableEventArgs) - - -### [IDialogEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDialogEventArgs) - -- **dialog**: `IgxDialogComponent` -- **event**: `Event` - -### [IDimensionsChange](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDimensionsChange) -Event emitted when dimension collection for rows, columns of filters is changed. - -- **dimensionCollectionType**: `PivotDimensionType` — The dimension list type - Row, Column or Filter. -- **dimensions**: `IPivotDimension[]` — The new list of dimensions. - -### [IDragBaseEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDragBaseEventArgs) - -- **originalEvent**: `PointerEvent | MouseEvent | TouchEvent` — Reference to the original event that caused the interaction with the element. -Can be PointerEvent, TouchEvent or MouseEvent. -- **owner**: `IgxDragDirective` — The owner igxDrag directive that triggered this event. -- **pageX**: `number` — The current position of the pointer on X axis when the event was triggered. -Note: The browser might trigger the event with some delay and pointer would be already inside the igxDrop. -- **pageY**: `number` — The current position of the pointer on Y axis when the event was triggered. -Note: The browser might trigger the event with some delay and pointer would be already inside the igxDrop. -- **startX**: `number` — The initial position of the pointer on X axis when the dragged element began moving -- **startY**: `number` — The initial position of the pointer on Y axis when the dragged element began moving - -### [IDragCustomTransitionArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDragCustomTransitionArgs) - -- **delay?**: `number` -- **duration?**: `number` -- **timingFunction?**: `string` - -### [IDragGhostBaseEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDragGhostBaseEventArgs) - -- **cancel**: `boolean` — Set if the ghost creation/destruction should be canceled. -- **ghostElement**: `any` — Instance to the ghost element that is created when dragging starts. -- **owner**: `IgxDragDirective` — The owner igxDrag directive that triggered this event. - -### [IDragMoveEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDragMoveEventArgs) - -- **nextPageX**: `number` — The new pageX position of the pointer that the igxDrag will use. It can be overridden to limit dragged element X movement. -- **nextPageY**: `number` — The new pageX position of the pointer that the igxDrag will use. It can be overridden to limit dragged element Y movement. - -### [IDragStartEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDragStartEventArgs) - -- **cancel**: `boolean` — Set if the the dragging should be canceled. - -### [IDropBaseEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDropBaseEventArgs) - -- **drag**: `IgxDragDirective` — The igxDrag directive instanced on an element that entered the area of the igxDrop element -- **dragData**: `any` — The data contained for the draggable element in igxDrag directive. -- **offsetX**: `number` — The current position of the pointer on X axis relative to the container that initializes the igxDrop. -Note: The browser might trigger the event with some delay and pointer would be already inside the igxDrop. -- **offsetY**: `number` — The current position of the pointer on Y axis relative to the container that initializes the igxDrop. -Note: The browser might trigger the event with some delay and pointer would be already inside the igxDrop. -- **originalEvent**: `any` — Reference to the original event that caused the draggable element to enter the igxDrop element. -Can be PointerEvent, TouchEvent or MouseEvent. -- **owner**: `IgxDropDirective` — The owner igxDrop directive that triggered this event. -- **pageX**: `number` — The current position of the pointer on X axis when the event was triggered. -Note: The browser might trigger the event with some delay and pointer would be already inside the igxDrop. -- **pageY**: `number` — The current position of the pointer on Y axis when the event was triggered. -Note: The browser might trigger the event with some delay and pointer would be already inside the igxDrop. -- **startX**: `number` — The initial position of the pointer on X axis when the dragged element began moving -- **startY**: `number` — The initial position of the pointer on Y axis when the dragged element began moving - -### [IDropDownNavigationDirective](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDropDownNavigationDirective) -Interface for an instance of IgxDropDownNavigationDirective - -- **target**: `any` -- **handleKeyDown**: `any` -- **onArrowDownKeyDown**: `any` -- **onArrowUpKeyDown**: `any` -- **onEndKeyDown**: `any` -- **onHomeKeyDown**: `any` - -### [IDropDroppedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDropDroppedEventArgs) - -- **cancel**: `boolean` — Specifies if the default drop logic related to the event should be canceled. - -### [IDropStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IDropStrategy) - -- **dropAction**: `any` - -### [IExcelExportEndedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IExcelExportEndedEventArgs) - -- **xlsx?**: `Object` - -### [IExpansionPanelEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IExpansionPanelEventArgs) - -- **event**: `Event` - -### [IExportRecord](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IExportRecord) - -- **data**: `any` -- **dimensionKeys?**: `string[]` -- **hidden?**: `boolean` -- **hierarchicalOwner?**: `string` -- **level**: `number` -- **owner?**: `string | GridType` -- **rawData?**: `any` -- **references?**: `IColumnInfo[]` -- **summaryKey?**: `string` -- **type**: `ExportRecordType` - -### [IExpressionTree](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IExpressionTree) - -- **entity?**: `string` -- **fieldName?**: `string` -- **filteringOperands**: `IFilteringExpression | IExpressionTree[]` -- **operator**: `FilteringLogic` -- **returnFields?**: `string[]` - -### [IFieldEditorOptions](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IFieldEditorOptions) - -- **dateTimeFormat?**: `string` — A custom input format string used for the built-in editors of date/time columns. -See the Editing section under https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/column-types#datetime-date-and-time - -### [IFieldPipeArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IFieldPipeArgs) - -- **currencyCode?**: `string` — The currency code of type string, default value undefined -- **digitsInfo?**: `string` — Decimal representation options, specified by a string in the following format: -{minIntegerDigits}.{minFractionDigits}-{maxFractionDigits}. -minIntegerDigits: The minimum number of integer digits before the decimal point. Default is 1. -minFractionDigits: The minimum number of digits after the decimal point. Default is 0. -maxFractionDigits: The maximum number of digits after the decimal point. Default is 3. -- **display?**: `string` — Allow us to display currency 'symbol' or 'code' or 'symbol-narrow' or our own string. -The value is of type string. By default is set to 'symbol' -- **format?**: `string` — The date/time components that a date column will display, using predefined options or a custom format string. -- **timezone?**: `string` — A timezone offset (such as '+0430'), or a standard UTC/GMT or continental US timezone abbreviation. -- **weekStart?**: `number` — The first week day to be displayed in calendar when filtering or editing a date column - -### [IFieldValidationState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IFieldValidationState) -Interface representing the validation state of a field in the grid. --field: The name of the field (property) being validated. - -- **field**: `string` - -### [IFilteringEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IFilteringEventArgs) -Represents event arguments related to filtering operations -The event is cancelable - -- **filteringExpressions**: `IFilteringExpressionsTree` — Represents the filtering expressions applied to the grid. -The expression contains information like filtering operands and operator, an expression or condition, etc. - -### [IFilteringExpression](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IFilteringExpression) -Represents filtering expressions. - -- **condition?**: `IFilteringOperation` -- **conditionName?**: `string` -- **fieldName**: `string` -- **ignoreCase?**: `boolean` -- **searchTree?**: `IExpressionTree` -- **searchVal?**: `any` - -### [IFilteringExpressionsTree](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IFilteringExpressionsTree) - -- **filteringOperands**: `IFilteringExpression | IFilteringExpressionsTree[]` -- **find?**: `any` -- **findIndex?**: `any` -- **type?**: `FilteringExpressionsTreeType` - -### [IFilteringOperation](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IFilteringOperation) -Interface describing filtering operations - -- **hidden?**: `boolean` -- **iconName**: `string` -- **isNestedQuery?**: `boolean` -- **isUnary**: `boolean` -- **logic?**: `any` -- **name**: `string` - -### [IFilteringState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IFilteringState) - -- **advancedExpressionsTree?**: `IFilteringExpressionsTree` -- **expressionsTree**: `IFilteringExpressionsTree` -- **strategy?**: `IFilteringStrategy` - -### [IFilteringStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IFilteringStrategy) - -- **filter**: `any` -- **getFilterItems**: `any` - -### [IFormattedParts](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IFormattedParts) - -- **combined**: `string` -- **literal?**: `string` -- **value**: `string` - -### [IFormattingOptions](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IFormattingOptions) - -- **day?**: `"numeric" | "2-digit"` -- **month?**: `"numeric" | "2-digit" | "short" | "long" | "narrow"` -- **weekday?**: `"short" | "long" | "narrow"` -- **year?**: `"numeric" | "2-digit"` - -### [IFormattingViews](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IFormattingViews) - -- **day?**: `boolean` -- **month?**: `boolean` -- **year?**: `boolean` - -### [IForOfDataChangeEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IForOfDataChangeEventArgs) - - -### [IForOfDataChangingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IForOfDataChangingEventArgs) - -- **containerSize**: `number` -- **state**: `IForOfState` - -### [IForOfState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IForOfState) - -- **chunkSize?**: `number` -- **startIndex?**: `number` - -### [IGridCellEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridCellEventArgs) -Represents an event argument related to grid cell interactions. - -- **cell**: `CellType` — Represents the grid cell that triggered the event. -- **event**: `Event` — Represents the original event that occurred -Examples of such events include: selecting, clicking, double clicking, etc. - -### [IGridClipboardEvent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridClipboardEvent) -The event arguments when data from a grid is being copied. - -- **cancel**: `boolean` — cancel returns whether an external event has intercepted the copying -If the value becomes "true", it returns/exits from the method, instantiating the interface -- **data**: `any[]` — data can be of any type and refers to the data that is being copied/stored to the clipboard - -### [IGridContextMenuEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridContextMenuEventArgs) -Represents an event argument for the grid contextMenu output - - -### [IGridCreatedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridCreatedEventArgs) - -- **grid**: `IgxHierarchicalGridComponent` -- **owner**: `IgxRowIslandComponent` — Provides reference to the owner component. -- **parentID**: `any` -- **parentRowData?**: `any` - -### [IGridDataBindable](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridDataBindable) - -- **data**: `any[]` -- **filteredData**: `any` - -### [IGridEditDoneEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridEditDoneEventArgs) -Represents event arguments related to grid editing completion. - -- **cellID?**: `any` -- **column?**: `ColumnType` — Optional -Represents the column information of the edited cell -- **event?**: `Event` — Optional -Represents the original event, that has triggered the edit -- **isAddRow?**: `boolean` — Optional -Indicates if the editing consists of adding a new row -- **newValue?**: `any` — Optional -Represents the value, that is being entered in the edited cell -When there is no newValue and the event has ended, the value of the cell returns to the oldValue -- **oldValue**: `any` — Represents the previous (before editing) value of the edited cell. -It's used when the event has been stopped/exited. -- **owner?**: `GridType` — Optional -Represents the grid instance that owns the edit event. -- **primaryKey**: `any` -- **rowData**: `any` — rowData represents the updated/committed data of the row after the edit (newValue) -The only case rowData (of the current object) is used directly, is when there is no rowEditing or transactions enabled -- **rowID**: `any` -- **rowKey**: `any` -- **valid?**: `boolean` — Optional -Indicates if the new value would be valid. -It can be set to return the result of the methods for validation of the grid - -### [IGridEditEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridEditEventArgs) -Represents event arguments related to grid editing. -The event is cancelable -It contains information about the row and the column, as well as the old and nwe value of the element/cell - - -### [IGridFormGroupCreatedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridFormGroupCreatedEventArgs) -Interface representing the event arguments when a form group is created in the grid. -- formGroup: The form group that is created. -- owner: The grid instance that owns the form group. - -- **formGroup**: `FormGroup` -- **owner**: `GridType` - -### [IGridGroupingStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridGroupingStrategy) -Represents a grouping strategy for the grid data, extending the Sorting Strategy interface (contains a sorting method). - -- **groupBy**: `any` - -### [IGridKeydownEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridKeydownEventArgs) -Represents an event, emitted when keydown is triggered over element inside grid's body -This event is fired only if the key combination is supported in the grid. - -- **cancel**: `boolean` — The event is cancelable -cancel returns whether the event has been intercepted and stopped -If the value becomes "true", it returns/exits from the method, instantiating the interface -- **event**: `Event` — Represents the original event, that occurred. -- **target**: `any` — Represents the information and details of the object itself -- **targetType**: `GridKeydownTargetType` — The targetType represents the type of the targeted object. For example a cell or a row - -### [IGridResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridResourceStrings) - -- **igx_grid_actions_add_child_label?**: `string` -- **igx_grid_actions_add_label?**: `string` -- **igx_grid_actions_delete_label?**: `string` -- **igx_grid_actions_edit_label?**: `string` -- **igx_grid_actions_jumpDown_label?**: `string` -- **igx_grid_actions_jumpUp_label?**: `string` -- **igx_grid_actions_pin_label?**: `string` -- **igx_grid_actions_unpin_label?**: `string` -- **igx_grid_add_row_label?**: `string` -- **igx_grid_advanced_filter_add_condition?**: `string` -- **igx_grid_advanced_filter_add_condition_root?**: `string` -- **igx_grid_advanced_filter_add_group?**: `string` -- **igx_grid_advanced_filter_add_group_root?**: `string` -- **igx_grid_advanced_filter_and_group?**: `string` -- **igx_grid_advanced_filter_and_label?**: `string` -- **igx_grid_advanced_filter_column_placeholder?**: `string` -- **igx_grid_advanced_filter_create_and_group?**: `string` -- **igx_grid_advanced_filter_create_or_group?**: `string` -- **igx_grid_advanced_filter_delete?**: `string` -- **igx_grid_advanced_filter_delete_filters?**: `string` -- **igx_grid_advanced_filter_dialog_checkbox_text?**: `string` -- **igx_grid_advanced_filter_dialog_message?**: `string` -- **igx_grid_advanced_filter_dialog_title?**: `string` -- **igx_grid_advanced_filter_drop_ghost_text?**: `string` -- **igx_grid_advanced_filter_end_group?**: `string` -- **igx_grid_advanced_filter_from_label?**: `string` -- **igx_grid_advanced_filter_initial_text?**: `string` -- **igx_grid_advanced_filter_or_group?**: `string` -- **igx_grid_advanced_filter_or_label?**: `string` -- **igx_grid_advanced_filter_query_value_placeholder?**: `string` -- **igx_grid_advanced_filter_select_entity?**: `string` -- **igx_grid_advanced_filter_select_return_field_single?**: `string` -- **igx_grid_advanced_filter_switch_group?**: `string` -- **igx_grid_advanced_filter_title?**: `string` -- **igx_grid_advanced_filter_ungroup?**: `string` -- **igx_grid_advanced_filter_value_placeholder?**: `string` -- **igx_grid_complex_filter?**: `string` -- **igx_grid_email_validation_error?**: `string` -- **igx_grid_emptyFilteredGrid_message?**: `string` -- **igx_grid_emptyGrid_message?**: `string` -- **igx_grid_excel_add_to_filter?**: `string` -- **igx_grid_excel_apply?**: `string` -- **igx_grid_excel_blanks?**: `string` -- **igx_grid_excel_boolean_filter?**: `string` -- **igx_grid_excel_cancel?**: `string` -- **igx_grid_excel_currency_filter?**: `string` -- **igx_grid_excel_custom_dialog_add?**: `string` -- **igx_grid_excel_custom_dialog_clear?**: `string` -- **igx_grid_excel_custom_dialog_header?**: `string` -- **igx_grid_excel_custom_filter?**: `string` -- **igx_grid_excel_date_filter?**: `string` -- **igx_grid_excel_deselect?**: `string` -- **igx_grid_excel_filter_clear?**: `string` -- **igx_grid_excel_filter_moving_header?**: `string` -- **igx_grid_excel_filter_moving_left?**: `string` -- **igx_grid_excel_filter_moving_left_short?**: `string` -- **igx_grid_excel_filter_moving_right?**: `string` -- **igx_grid_excel_filter_moving_right_short?**: `string` -- **igx_grid_excel_filter_sorting_asc?**: `string` -- **igx_grid_excel_filter_sorting_asc_short?**: `string` -- **igx_grid_excel_filter_sorting_desc?**: `string` -- **igx_grid_excel_filter_sorting_desc_short?**: `string` -- **igx_grid_excel_filter_sorting_header?**: `string` -- **igx_grid_excel_hide?**: `string` -- **igx_grid_excel_matches_count?**: `string` -- **igx_grid_excel_no_matches?**: `string` -- **igx_grid_excel_number_filter?**: `string` -- **igx_grid_excel_pin?**: `string` -- **igx_grid_excel_search_placeholder?**: `string` -- **igx_grid_excel_select?**: `string` -- **igx_grid_excel_select_all?**: `string` -- **igx_grid_excel_select_all_search_results?**: `string` -- **igx_grid_excel_show?**: `string` -- **igx_grid_excel_text_filter?**: `string` -- **igx_grid_excel_unpin?**: `string` -- **igx_grid_filter?**: `string` -- **igx_grid_filter_after?**: `string` -- **igx_grid_filter_all?**: `string` -- **igx_grid_filter_at?**: `string` -- **igx_grid_filter_at_after?**: `string` -- **igx_grid_filter_at_before?**: `string` -- **igx_grid_filter_before?**: `string` -- **igx_grid_filter_condition_placeholder?**: `string` -- **igx_grid_filter_contains?**: `string` -- **igx_grid_filter_doesNotContain?**: `string` -- **igx_grid_filter_doesNotEqual?**: `string` -- **igx_grid_filter_empty?**: `string` -- **igx_grid_filter_endsWith?**: `string` -- **igx_grid_filter_equals?**: `string` -- **igx_grid_filter_false?**: `string` -- **igx_grid_filter_greaterThan?**: `string` -- **igx_grid_filter_greaterThanOrEqualTo?**: `string` -- **igx_grid_filter_in?**: `string` -- **igx_grid_filter_lastMonth?**: `string` -- **igx_grid_filter_lastYear?**: `string` -- **igx_grid_filter_lessThan?**: `string` -- **igx_grid_filter_lessThanOrEqualTo?**: `string` -- **igx_grid_filter_nextMonth?**: `string` -- **igx_grid_filter_nextYear?**: `string` -- **igx_grid_filter_not_at?**: `string` -- **igx_grid_filter_notEmpty?**: `string` -- **igx_grid_filter_notIn?**: `string` -- **igx_grid_filter_notNull?**: `string` -- **igx_grid_filter_null?**: `string` -- **igx_grid_filter_operator_and?**: `string` -- **igx_grid_filter_operator_or?**: `string` -- **igx_grid_filter_row_boolean_placeholder?**: `string` -- **igx_grid_filter_row_close?**: `string` -- **igx_grid_filter_row_date_placeholder?**: `string` -- **igx_grid_filter_row_placeholder?**: `string` -- **igx_grid_filter_row_reset?**: `string` -- **igx_grid_filter_row_time_placeholder?**: `string` -- **igx_grid_filter_startsWith?**: `string` -- **igx_grid_filter_thisMonth?**: `string` -- **igx_grid_filter_thisYear?**: `string` -- **igx_grid_filter_today?**: `string` -- **igx_grid_filter_true?**: `string` -- **igx_grid_filter_yesterday?**: `string` -- **igx_grid_groupByArea_deselect_message?**: `string` -- **igx_grid_groupByArea_message?**: `string` -- **igx_grid_groupByArea_select_message?**: `string` -- **igx_grid_hiding_check_all_label?**: `string` -- **igx_grid_hiding_uncheck_all_label?**: `string` -- **igx_grid_max_length_validation_error?**: `string` -- **igx_grid_max_validation_error?**: `string` -- **igx_grid_min_length_validation_error?**: `string` -- **igx_grid_min_validation_error?**: `string` -- **igx_grid_pattern_validation_error?**: `string` -- **igx_grid_pinned_row_indicator?**: `string` -- **igx_grid_pinning_check_all_label?**: `string` -- **igx_grid_pinning_uncheck_all_label?**: `string` -- **igx_grid_pivot_aggregate_avg?**: `string` -- **igx_grid_pivot_aggregate_count?**: `string` -- **igx_grid_pivot_aggregate_date_earliest?**: `string` -- **igx_grid_pivot_aggregate_date_latest?**: `string` -- **igx_grid_pivot_aggregate_max?**: `string` -- **igx_grid_pivot_aggregate_min?**: `string` -- **igx_grid_pivot_aggregate_sum?**: `string` -- **igx_grid_pivot_aggregate_time_earliest?**: `string` -- **igx_grid_pivot_aggregate_time_latest?**: `string` -- **igx_grid_pivot_column_drop_chip?**: `string` -- **igx_grid_pivot_date_dimension_total?**: `string` -- **igx_grid_pivot_empty_column_drop_area?**: `string` -- **igx_grid_pivot_empty_filter_drop_area?**: `string` -- **igx_grid_pivot_empty_message?**: `string` -- **igx_grid_pivot_empty_row_drop_area?**: `string` -- **igx_grid_pivot_empty_value_drop_area?**: `string` -- **igx_grid_pivot_filter_drop_chip?**: `string` -- **igx_grid_pivot_row_drop_chip?**: `string` -- **igx_grid_pivot_selector_columns?**: `string` -- **igx_grid_pivot_selector_filters?**: `string` -- **igx_grid_pivot_selector_panel_empty?**: `string` -- **igx_grid_pivot_selector_rows?**: `string` -- **igx_grid_pivot_selector_values?**: `string` -- **igx_grid_pivot_value_drop_chip?**: `string` -- **igx_grid_required_validation_error?**: `string` -- **igx_grid_row_edit_btn_cancel?**: `string` -- **igx_grid_row_edit_btn_done?**: `string` -- **igx_grid_row_edit_text?**: `string` -- **igx_grid_snackbar_addrow_actiontext?**: `string` -- **igx_grid_snackbar_addrow_label?**: `string` -- **igx_grid_summary_average?**: `string` -- **igx_grid_summary_count?**: `string` -- **igx_grid_summary_earliest?**: `string` -- **igx_grid_summary_latest?**: `string` -- **igx_grid_summary_max?**: `string` -- **igx_grid_summary_min?**: `string` -- **igx_grid_summary_sum?**: `string` -- **igx_grid_toolbar_actions_filter_prompt?**: `string` -- **igx_grid_toolbar_advanced_filtering_button_label?**: `string` -- **igx_grid_toolbar_advanced_filtering_button_tooltip?**: `string` -- **igx_grid_toolbar_exporter_button_label?**: `string` -- **igx_grid_toolbar_exporter_button_tooltip?**: `string` -- **igx_grid_toolbar_exporter_csv_entry_text?**: `string` -- **igx_grid_toolbar_exporter_excel_entry_text?**: `string` -- **igx_grid_toolbar_hiding_button_tooltip?**: `string` -- **igx_grid_toolbar_hiding_title?**: `string` -- **igx_grid_toolbar_pinning_button_tooltip?**: `string` -- **igx_grid_toolbar_pinning_title?**: `string` - -### [IGridRowEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridRowEventArgs) -Represents an event argument related to grid row interactions. - -- **event**: `Event` — Represents the original event that occurred -Examples of such events include: selecting, clicking, double clicking, etc. -- **row**: `RowType` — Represents the grid row that triggered the event. - -### [IGridScrollEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridScrollEventArgs) -Event emitted when a grid is scrolled. - -- **direction**: `string` — The scroll direction - vertical or horizontal. -- **event**: `Event` — The original browser scroll event. -- **scrollPosition**: `number` — The new scroll position - -### [IGridSortingStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridSortingStrategy) -Represents a sorting strategy for the grid data -Contains a single method sort that sorts the provided data based on the given sorting expressions - -- **sort**: `any` - -### [IGridState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridState) - -- **advancedFiltering?**: `IFilteringExpressionsTree` -- **cellSelection?**: `GridSelectionRange[]` -- **columns?**: `IColumnState[]` -- **columnSelection?**: `string[]` -- **expansion?**: `any[]` -- **filtering?**: `IFilteringExpressionsTree` -- **groupBy?**: `IGroupingState` -- **id?**: `string` -- **moving?**: `boolean` -- **paging?**: `IPagingState` -- **pinningConfig?**: `IPinningConfig` -- **pivotConfiguration?**: `IPivotConfiguration` -- **rowIslands?**: `IGridStateCollection[]` -- **rowPinning?**: `any[]` -- **rowSelection?**: `any[]` -- **sorting?**: `ISortingExpression[]` - -### [IGridStateCollection](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridStateCollection) - -- **id**: `string` -- **parentRowID**: `any` -- **state**: `IGridState` - -### [IGridStateOptions](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridStateOptions) - -- **advancedFiltering?**: `boolean` -- **cellSelection?**: `boolean` -- **columns?**: `boolean` -- **columnSelection?**: `boolean` -- **expansion?**: `boolean` -- **filtering?**: `boolean` -- **groupBy?**: `boolean` -- **moving?**: `boolean` -- **paging?**: `boolean` -- **pinningConfig?**: `boolean` -- **pivotConfiguration?**: `boolean` -- **rowIslands?**: `boolean` -- **rowPinning?**: `boolean` -- **rowSelection?**: `boolean` -- **sorting?**: `boolean` - -### [IGridToolbarExportEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridToolbarExportEventArgs) -Represents the arguments for the grid toolbar export event. -It provides information about the grid instance, exporter service, export options, -and allows the event to be canceled. - -- **cancel**: `boolean` — cancel returns whether the event has been intercepted and stopped -If the value becomes "true", it returns/exits from the method, instantiating the interface -- **exporter**: `IgxBaseExporter` — The exporter is a base service. -The type (an abstract class IgxBaseExporter) has it's own properties and methods -It is used to define the format and options of the export, the exported element -and methods for preparing the data from the elements for exporting -- **grid**: `GridType` — grid represents a reference to the instance of the grid te event originated from -- **options**: `IgxExporterOptionsBase` — Represents the different settings, that can be given to an export -The type (an abstract class IgxExporterOptionsBase) has properties for column settings -(whether they should be ignored) as well as method for generating a file name - -### [IGridValidationState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridValidationState) -Interface representing the validation state of a grid. -- status: The validation status ('VALID' or 'INVALID'). -- errors: The validation errors if any. - -- **errors?**: `ValidationErrors` -- **status**: `ValidationStatus` - -### [IGridValidationStatusEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGridValidationStatusEventArgs) -Interface representing the event arguments for the grid validation status change event. -- status: The validation status ('VALID' or 'INVALID'). -- owner: The grid instance that owns the validation state. - -- **owner**: `GridType` -- **status**: `ValidationStatus` - -### [IGroupByExpandState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGroupByExpandState) - -- **expanded**: `boolean` -- **hierarchy**: `IGroupByKey[]` - -### [IGroupByKey](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGroupByKey) - -- **fieldName**: `string` -- **value**: `any` - -### [IGroupByRecord](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGroupByRecord) - -- **column?**: `ColumnType` -- **expression**: `ISortingExpression` -- **groupParent**: `IGroupByRecord` -- **groups?**: `IGroupByRecord[]` -- **height**: `number` -- **level**: `number` -- **records**: `GroupedRecords` -- **value**: `any` - -### [IGroupingDoneEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGroupingDoneEventArgs) - -- **expressions**: `ISortingExpression | ISortingExpression[]` -- **groupedColumns**: `IgxColumnComponent | IgxColumnComponent[]` -- **ungroupedColumns**: `IgxColumnComponent | IgxColumnComponent[]` - -### [IGroupingExpression](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGroupingExpression) - -- **groupingComparer?**: `any` - -### [IGroupingState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IGroupingState) - -- **defaultExpanded**: `boolean` -- **expansion**: `IGroupByExpandState[]` -- **expressions**: `IGroupingExpression[]` - -### [IgxCellTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxCellTemplateContext) - -- **$implicit**: `any` -- **additionalTemplateContext**: `any` -- **cell**: `CellType` -- **defaultErrorTemplate?**: `TemplateRef` -- **formControl?**: `FormControl` - -### [IgxColumnTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxColumnTemplateContext) - -- **$implicit**: `ColumnType` -- **column**: `ColumnType` - -### [IgxDateTimeEditorEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxDateTimeEditorEventArgs) - -- **newValue?**: `Date` -- **oldValue?**: `Date` -- **userInput**: `string` - -### [IgxDragCustomEventDetails](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxDragCustomEventDetails) - -- **originalEvent**: `any` -- **owner**: `IgxDragDirective` -- **pageX**: `number` -- **pageY**: `number` -- **startX**: `number` -- **startY**: `number` - -### [IgxExporterEvent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxExporterEvent) - -- **cancel**: `boolean` -- **exporter**: `IgxBaseExporter` -- **grid**: `GridType` -- **options**: `IgxExporterOptions` - -### [IgxFilterItem](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxFilterItem) - -- **children?**: `IgxFilterItem[]` -- **label?**: `string` -- **value**: `any` - -### [IgxGridEmptyTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxGridEmptyTemplateContext) - -- **$implicit**: `undefined` - -### [IgxGridHeaderTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxGridHeaderTemplateContext) - -- **$implicit**: `HeaderType` - -### [IgxGridMasterDetailContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxGridMasterDetailContext) - -- **$implicit**: `any` -- **index**: `number` - -### [IgxGridPaginatorTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxGridPaginatorTemplateContext) - -- **$implicit**: `GridType` - -### [IgxGridRowDragGhostContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxGridRowDragGhostContext) - -- **$implicit**: `any` -- **data**: `any` -- **grid**: `GridType` - -### [IgxGridRowEditActionsTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxGridRowEditActionsTemplateContext) - -- **$implicit**: `any` - -### [IgxGridRowEditTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxGridRowEditTemplateContext) - -- **$implicit**: `undefined` -- **endEdit**: `any` -- **rowChangesCount**: `number` - -### [IgxGridRowEditTextTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxGridRowEditTextTemplateContext) - -- **$implicit**: `number` - -### [IgxGridRowTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxGridRowTemplateContext) - -- **$implicit**: `RowType` - -### [IgxGridTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxGridTemplateContext) - -- **$implicit**: `GridType` - -### [IgxGridToolbarTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxGridToolbarTemplateContext) - -- **$implicit**: `GridType` - -### [IgxGroupByRowSelectorTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxGroupByRowSelectorTemplateContext) - -- **$implicit**: `IgxGroupByRowSelectorTemplateDetails` - -### [IgxGroupByRowSelectorTemplateDetails](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxGroupByRowSelectorTemplateDetails) - -- **groupRow**: `IGroupByRecord` -- **selectedCount**: `number` -- **totalCount**: `number` - -### [IgxGroupByRowTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxGroupByRowTemplateContext) - -- **$implicit**: `IGroupByRecord` - -### [IgxHeadSelectorTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxHeadSelectorTemplateContext) - -- **$implicit**: `IgxHeadSelectorTemplateDetails` - -### [IgxHeadSelectorTemplateDetails](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxHeadSelectorTemplateDetails) - -- **deselectAll?**: `any` -- **selectAll?**: `any` -- **selectedCount**: `number` -- **totalCount**: `number` - -### [IgxIconLoadedEvent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxIconLoadedEvent) -Event emitted when a SVG icon is loaded through -a HTTP request. - -- **family**: `string` — The font-family for the icon. Defaults to material. -- **name**: `string` — Name of the icon -- **value?**: `string` — The actual SVG text, if any - -### [IgxPivotGridValueTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxPivotGridValueTemplateContext) - -- **$implicit**: `IPivotValue` - -### [IgxRowSelectorTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxRowSelectorTemplateContext) - -- **$implicit**: `IgxRowSelectorTemplateDetails` - -### [IgxRowSelectorTemplateDetails](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxRowSelectorTemplateDetails) - -- **deselect?**: `any` -- **index**: `number` -- **key**: `any` -- **rowID**: `any` -- **select?**: `any` -- **selected**: `boolean` - -### [IgxSummaryResult](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxSummaryResult) - -- **defaultFormatting?**: `boolean` — Apply default formatting based on the grid column type. -const result: IgxSummaryResult = { - key: 'key', - label: 'label', - defaultFormatting: true -} -- **key**: `string` -- **label**: `string` -- **summaryResult**: `any` - -### [IgxSummaryTemplateContext](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxSummaryTemplateContext) - -- **$implicit**: `IgxSummaryResult[]` - -### [IgxTimePickerValidationFailedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxTimePickerValidationFailedEventArgs) - -- **currentValue**: `string | Date` -- **previousValue**: `string | Date` - -### [IgxTree](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxTree) - -- **activeNodeChanged**: `EventEmitter>` -- **animationSettings**: `ToggleAnimationSettings` -- **expandIndicator**: `TemplateRef` -- **nodeCollapsed**: `EventEmitter` -- **nodeCollapsing**: `EventEmitter` -- **nodeExpanded**: `EventEmitter` -- **nodeExpanding**: `EventEmitter` -- **nodeSelection**: `EventEmitter` -- **selection**: `IgxTreeSelectionType` -- **singleBranchExpand**: `boolean` -- **toggleNodeOnClick**: `boolean` -- **collapseAll**: `any` -- **deselectAll**: `any` -- **expandAll**: `any` -- **findNodes**: `any` - -### [IgxTreeNode](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IgxTreeNode) - -- **active**: `boolean` -- **data**: `T` -- **disabled**: `boolean` -- **expanded**: `boolean` -- **expandedChange**: `EventEmitter` -- **level**: `number` -- **loading**: `boolean` -- **parentNode?**: `IgxTreeNode` -- **path**: `IgxTreeNode[]` -- **selected**: `boolean` -- **selectedChange**: `EventEmitter` -- **collapse**: `any` -- **expand**: `any` -- **toggle**: `any` - -### [IInputResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IInputResourceStrings) - -- **igx_input_file_placeholder?**: `string` -- **igx_input_upload_button?**: `string` - -### [IListItemClickEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IListItemClickEventArgs) -Interface for the listItemClick igxList event arguments - -- **direction**: `IgxListPanState` -- **event**: `Event` -- **item**: `IgxListItemComponent` - -### [IListItemPanningEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IListItemPanningEventArgs) -Interface for the listItemPanning igxList event arguments - -- **direction**: `IgxListPanState` -- **item**: `IgxListItemComponent` -- **keepItem**: `boolean` - -### [IListResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IListResourceStrings) - -- **igx_list_loading?**: `string` -- **igx_list_no_items?**: `string` - -### [IMaskEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IMaskEventArgs) -The IgxMaskModule provides the IgxMaskDirective inside your application. - -- **formattedValue**: `string` -- **rawValue**: `string` - -### [IMultiRowLayoutNode](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IMultiRowLayoutNode) - -- **colEnd**: `number` -- **colStart**: `number` -- **columnVisibleIndex**: `number` -- **rowEnd**: `number` -- **rowStart**: `number` - -### [IPageCancellableEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPageCancellableEventArgs) - -- **current**: `number` -- **next**: `number` - -### [IPageEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPageEventArgs) - -- **current**: `number` -- **previous**: `number` - -### [IPaginatorResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPaginatorResourceStrings) - -- **igx_paginator_first_page_button_text?**: `string` -- **igx_paginator_label?**: `string` -- **igx_paginator_last_page_button_text?**: `string` -- **igx_paginator_next_page_button_text?**: `string` -- **igx_paginator_pager_text?**: `string` -- **igx_paginator_previous_page_button_text?**: `string` - -### [IPagingState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPagingState) - -- **index**: `number` -- **metadata?**: `any` -- **recordsPerPage**: `number` - -### [IPanStateChangeEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPanStateChangeEventArgs) -Interface for the panStateChange igxList event arguments - -- **item**: `IgxListItemComponent` -- **newState**: `IgxListPanState` -- **oldState**: `IgxListPanState` - -### [IPathSegment](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPathSegment) -Interface representing a segment of a path in a hierarchical grid. - -- **rowID**: `any` — The unique identifier of the row within the segment. -- **rowIslandKey**: `string` — The key representing the row's 'hierarchical level. -- **rowKey**: `any` - -### [IPinColumnCancellableEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPinColumnCancellableEventArgs) -The event arguments before a column's pin state is changed. -insertAtIndexspecifies at which index in the pinned/unpinned area the column is inserted. -Can be changed in the columnPin event. -isPinned returns the actual pin state of the column. When pinning/unpinning is successful, -the value of isPinned will change accordingly when read in the "-ing" and "-ed" event. - - -### [IPinColumnEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPinColumnEventArgs) -The event arguments after a column's pin state is changed. -insertAtIndexspecifies at which index in the pinned/unpinned area the column was inserted. -isPinned returns the actual pin state of the column after the operation completed. - -- **column**: `ColumnType` -- **insertAtIndex**: `number` — If pinned, specifies at which index in the pinned area the column is inserted. -If unpinned, specifies at which index in the unpinned area the column is inserted. -- **isPinned**: `boolean` — Returns the actual pin state of the column. -If pinning/unpinning is successful, value of isPinned will change accordingly when read in the "-ing" and "-ed" event. - -### [IPinningConfig](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPinningConfig) -An interface describing settings for row/column pinning position. - -- **columns?**: `ColumnPinningPosition` -- **rows?**: `RowPinningPosition` - -### [IPinRowEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPinRowEventArgs) -Event emitted when a row's pin state changes. -The event is cancelable - -- **insertAtIndex?**: `number` — The index at which to pin the row in the pinned rows collection. -- **isPinned**: `boolean` — Whether or not the row is pinned or unpinned. -- **row?**: `RowType` -- **rowID**: `any` — The ID of the row, that was pinned/unpinned. -ID is either the primaryKey value or the data record instance. -- **rowKey**: `any` - -### [IPivotAggregator](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPivotAggregator) -Interface describing a IPivotAggregator class. -Used for specifying custom aggregator lists. - -- **aggregator?**: `any` — Aggregator function can be a custom implementation of PivotAggregation, or -use predefined ones from IgxPivotAggregate and its variants. -- **aggregatorName?**: `PivotAggregationType` — Aggregation name that will be used from a list of predefined aggregations. -If not set will use the specified aggregator function. -- **key**: `string` — Aggregation unique key. -- **label**: `string` — Aggregation label to show in the UI. - -### [IPivotConfiguration](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPivotConfiguration) -Configuration of the pivot grid. - -- **columns**: `IPivotDimension[]` — A list of the columns. -- **columnStrategy?**: `IPivotDimensionStrategy` — A strategy to transform the columns. -- **filters?**: `IPivotDimension[]` — Dimensions to be displayed in the filter area. -- **pivotKeys?**: `IPivotKeys` — Pivot data keys used for data generation. Can be used for custom remote scenarios where the data is pre-populated. -- **rows**: `IPivotDimension[]` — A list of the rows. -- **rowStrategy?**: `IPivotDimensionStrategy` — A strategy to transform the rows. -- **values**: `IPivotValue[]` — A list of the values. - -### [IPivotConfigurationChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPivotConfigurationChangedEventArgs) -Event emitted when pivot configuration is changed. - -- **pivotConfiguration**: `IPivotConfiguration` — The new configuration. - -### [IPivotDateDimensionOptions](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPivotDateDimensionOptions) - -- **fullDate?**: `boolean` — Enabled/Disables dimensions for the full date provided -- **months?**: `boolean` — Enables/Disables dimensions per month from provided periods. -- **quarters?**: `boolean` -- **total?**: `boolean` — Enables/Disables total value of all periods. -- **years?**: `boolean` — Enables/Disables dimensions per year from provided periods. - -### [IPivotDimension](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPivotDimension) -Configuration of a pivot dimension. - -- **childLevel?**: `IPivotDimension` — Allows defining a hierarchy when multiple sub groups need to be extracted from single member. -- **dataType?**: `GridColumnDataType` — The dataType of the related data field. -- **displayName?**: `string` — Display name to show instead of the field name of this value. * -- **enabled**: `boolean` — Enables/Disables a particular dimension from pivot structure. -- **filter?**: `IFilteringExpressionsTree` — A predefined or defined via the igxPivotSelector filter expression tree for the current dimension to be applied in the filter pipe. -- **horizontalSummary?**: `boolean` -- **level?**: `number` — Level of the dimension. -- **memberFunction?**: `any` — Function that extracts the value -- **memberName**: `string` — Unique member to extract related data field value or the result of the memberFunction. -- **sortable?**: `boolean` — Enable/disable sorting for a particular dimension. True by default. -- **sortDirection?**: `SortingDirection` — The sorting direction of the current dimension. Determines the order in which the values will appear in the related dimension. -- **width?**: `string` — The width of the dimension cells to be rendered.Can be pixel, % or "auto". - -### [IPivotDimensionData](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPivotDimensionData) -Interface describing the pivot dimension data. -Contains additional information needed to render dimension headers. - -- **column**: `ColumnType` — Associated column definition. -- **dimension**: `IPivotDimension` — Associated dimension definition. -- **isChild?**: `boolean` — Whether this a child dimension. -- **prevDimensions**: `IPivotDimension[]` — List of previous dimension groups. - -### [IPivotDimensionStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPivotDimensionStrategy) -Interface describing Pivot data processing for dimensions. -Should contain a process method and return records hierarchy based on the provided dimensions. - -- **process**: `any` - -### [IPivotGridColumn](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPivotGridColumn) -Interface describing the Pivot column data. - Contains information on the related column dimensions and their values. - -- **dimensions**: `IPivotDimension[]` — List of dimensions associated with the column.* -- **dimensionValues**: `Map` — Gets/Sets the group value associated with the related column dimension by its memberName. * -- **field**: `string` -- **value**: `IPivotValue` - -### [IPivotGridGroupRecord](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPivotGridGroupRecord) - -- **height?**: `number` -- **rowSpan?**: `number` - -### [IPivotGridHorizontalGroup](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPivotGridHorizontalGroup) - -- **colSpan?**: `number` -- **colStart?**: `number` -- **dimensions?**: `IPivotDimension[]` -- **records?**: `IPivotGridRecord[]` -- **rootDimension?**: `IPivotDimension` -- **rowSpan?**: `number` -- **rowStart?**: `number` -- **value?**: `string` - -### [IPivotGridRecord](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPivotGridRecord) - -- **aggregationValues**: `Map` — Gets/Sets the aggregation value associated with the value path. Value path depends on configured column dimension hierarchy and values.* -- **children?**: `Map` — List of children records in case any row dimension member contain a hierarchy. Each dimension member contains its own hierarchy, which you can get by its memberName. * -- **dataIndex?**: `number` — The index of the record in the total view -- **dimensions**: `IPivotDimension[]` — List of dimensions associated with the record.* -- **dimensionValues**: `Map` — Gets/Sets the group value associated with the related row dimension by its memberName. * -- **level?**: `number` — Record level* -- **records?**: `any[]` — List of original data records associated with the current pivoted data. * -- **totalRecordDimensionName?**: `string` — If set, it specifies the name of the dimension, that has total record enabled. - -### [IPivotKeys](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPivotKeys) -Interface describing the Pivot data keys used for data generation. - Can be used for custom remote scenarios where the data is pre-populated. - -- **aggregations**: `string` — Field that stores aggregation values. -- **children**: `string` — Field that stores children for hierarchy building. -- **columnDimensionSeparator**: `string` — Separator used when generating the unique column field values. -- **level**: `string` — Field that stores dimension level based on its hierarchy. -- **records**: `string` — Field that stores reference to the original data records. -- **rowDimensionSeparator**: `string` — Separator used when generating the unique row field values. - -### [IPivotUISettings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPivotUISettings) - -- **horizontalSummariesPosition?**: `PivotSummaryPosition` -- **rowLayout?**: `PivotRowLayoutType` -- **showConfiguration?**: `boolean` -- **showRowHeaders?**: `boolean` - -### [IPivotValue](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPivotValue) -Configuration of a pivot value aggregation. - -- **aggregate**: `IPivotAggregator` — Active aggregator definition with key, label and aggregator. -- **aggregateList?**: `IPivotAggregator[]` — List of aggregates to show in aggregate drop-down. -- **dataType?**: `GridColumnDataType` — Enables a data type specific template of the cells -- **displayName?**: `string` — Display name to show instead of member for the column header of this value. * -- **enabled**: `boolean` — Enables/Disables a particular value from pivot aggregation. -- **formatter?**: `any` — Applies display format to cell values. -- **member**: `string` — Unique member to extract related data field value for aggregations. -- **styles?**: `any` — Allow conditionally styling of the IgxPivotGrid cells. - -### [IPositionStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IPositionStrategy) -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-position) -Position strategies determine where to display the component in the provided IgxOverlayService. - -- **settings**: `PositionSettings` — PositionSettings to use when position the component in the overlay -- **clone**: `any` -- **position**: `any` - -### [IQueryBuilderResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IQueryBuilderResourceStrings) - -- **igx_query_builder_add_condition?**: `string` -- **igx_query_builder_add_condition_root?**: `string` -- **igx_query_builder_add_group?**: `string` -- **igx_query_builder_add_group_root?**: `string` -- **igx_query_builder_all_fields?**: `string` -- **igx_query_builder_and_group?**: `string` -- **igx_query_builder_and_label?**: `string` -- **igx_query_builder_column_placeholder?**: `string` -- **igx_query_builder_condition_placeholder?**: `string` -- **igx_query_builder_date_placeholder?**: `string` -- **igx_query_builder_datetime_placeholder?**: `string` -- **igx_query_builder_delete?**: `string` -- **igx_query_builder_delete_filters?**: `string` -- **igx_query_builder_details?**: `string` -- **igx_query_builder_dialog_cancel?**: `string` -- **igx_query_builder_dialog_checkbox_text?**: `string` -- **igx_query_builder_dialog_confirm?**: `string` -- **igx_query_builder_dialog_message?**: `string` -- **igx_query_builder_dialog_title?**: `string` -- **igx_query_builder_drop_ghost_text?**: `string` -- **igx_query_builder_end_group?**: `string` -- **igx_query_builder_filter_after?**: `string` -- **igx_query_builder_filter_all?**: `string` -- **igx_query_builder_filter_at?**: `string` -- **igx_query_builder_filter_at_after?**: `string` -- **igx_query_builder_filter_at_before?**: `string` -- **igx_query_builder_filter_before?**: `string` -- **igx_query_builder_filter_contains?**: `string` -- **igx_query_builder_filter_doesNotContain?**: `string` -- **igx_query_builder_filter_doesNotEqual?**: `string` -- **igx_query_builder_filter_empty?**: `string` -- **igx_query_builder_filter_endsWith?**: `string` -- **igx_query_builder_filter_equals?**: `string` -- **igx_query_builder_filter_false?**: `string` -- **igx_query_builder_filter_greaterThan?**: `string` -- **igx_query_builder_filter_greaterThanOrEqualTo?**: `string` -- **igx_query_builder_filter_in?**: `string` -- **igx_query_builder_filter_lastMonth?**: `string` -- **igx_query_builder_filter_lastYear?**: `string` -- **igx_query_builder_filter_lessThan?**: `string` -- **igx_query_builder_filter_lessThanOrEqualTo?**: `string` -- **igx_query_builder_filter_nextMonth?**: `string` -- **igx_query_builder_filter_nextYear?**: `string` -- **igx_query_builder_filter_not_at?**: `string` -- **igx_query_builder_filter_notEmpty?**: `string` -- **igx_query_builder_filter_notIn?**: `string` -- **igx_query_builder_filter_notNull?**: `string` -- **igx_query_builder_filter_null?**: `string` -- **igx_query_builder_filter_operator_and?**: `string` -- **igx_query_builder_filter_operator_or?**: `string` -- **igx_query_builder_filter_startsWith?**: `string` -- **igx_query_builder_filter_thisMonth?**: `string` -- **igx_query_builder_filter_thisYear?**: `string` -- **igx_query_builder_filter_today?**: `string` -- **igx_query_builder_filter_true?**: `string` -- **igx_query_builder_filter_yesterday?**: `string` -- **igx_query_builder_from_label?**: `string` -- **igx_query_builder_initial_text?**: `string` -- **igx_query_builder_or_group?**: `string` -- **igx_query_builder_or_label?**: `string` -- **igx_query_builder_query_value_placeholder?**: `string` -- **igx_query_builder_search?**: `string` -- **igx_query_builder_select_all?**: `string` -- **igx_query_builder_select_entity?**: `string` -- **igx_query_builder_select_label?**: `string` -- **igx_query_builder_select_return_field_single?**: `string` -- **igx_query_builder_select_return_fields?**: `string` -- **igx_query_builder_switch_group?**: `string` -- **igx_query_builder_time_placeholder?**: `string` -- **igx_query_builder_ungroup?**: `string` -- **igx_query_builder_value_placeholder?**: `string` -- **igx_query_builder_where_label?**: `string` - -### [IRangeSliderValue](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IRangeSliderValue) - -- **lower**: `number` -- **upper**: `number` - -### [IRecordValidationState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IRecordValidationState) -Interface representing the validation state of a record in the grid. -- key: The unique identifier of the record. -- fields: An array of the validation state of individual fields in the record. - -- **fields**: `IFieldValidationState[]` -- **key**: `any` - -### [IResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IResourceStrings) - - -### [IRowDataCancelableEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IRowDataCancelableEventArgs) -Represents event arguments related to events, that can occur for rows in a grid -Example for events: adding, deleting, selection, transaction, etc. - -- **cellID?**: `any` -- **isAddRow?**: `boolean` -- **newValue?**: `any` -- **oldValue**: `any` -- **owner**: `GridType` — Represents the grid instance that owns the edit event. - -### [IRowDataEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IRowDataEventArgs) -Represents event arguments related to events, that can occur for rows in a grid -Example for events: adding, deleting, selection, transaction, etc. - -- **data**: `any` -- **owner**: `GridType` — Represents the grid instance that owns the edit event. -- **primaryKey**: `any` — Represents the unique key, the row can be associated with. -Available if primaryKey exists -- **rowData**: `any` -- **rowKey**: `any` - -### [IRowDragEndEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IRowDragEndEventArgs) -Emitted when a dragging operation is finished (when the row is dropped) - -- **animation**: `boolean` — animation returns whether the event is animated -- **dragData**: `RowType` — Represents the information of the row that is being dragged. -- **dragDirective**: `any` — Represents the drag directive or information associated with the drag operation -- **dragElement**: `HTMLElement` — Represents the HTML element itself - -### [IRowDragStartEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IRowDragStartEventArgs) -Emitted when a dragging operation is starting (when the row is "picked") -The event is cancelable - -- **dragData**: `RowType` — Represents the information of the row that is being dragged. -- **dragDirective**: `any` — Represents the drag directive or information associated with the drag operation -- **dragElement**: `HTMLElement` — Represents the HTML element itself - -### [IRowExportingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IRowExportingEventArgs) -rowExporting event arguments -this.exporterService.rowExporting.subscribe((args: IRowExportingEventArgs) => { -// set args properties here -}) - -- **cancel**: `boolean` — Skip the exporting row when set to true -- **rowData**: `any` — Contains the exporting row data -- **rowIndex**: `number` — Contains the exporting row index - -### [IRowSelectionEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IRowSelectionEventArgs) -The event arguments when the selection state of a row is being changed -The event is cancelable - -- **added**: `any[]` — Represents an array of all added rows -Whenever a row has been selected, the array is "refreshed" with the selected rows -- **allRowsSelected?**: `boolean` — Indicates whether or not all rows of the grid have been selected -- **event?**: `Event` — Represents the original event, that has triggered the selection change -selecting, deselecting -- **newSelection**: `any[]` — Represents the newly selected rows -- **oldSelection**: `any[]` — Represents an array of rows, that have already been selected -- **removed**: `any[]` — Represents an array of all rows, removed from the selection -Whenever a row has been deselected, the array is "refreshed" with the rows, -that have been previously selected, but are no longer - -### [IRowToggleEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IRowToggleEventArgs) -Represents event arguments related to the row's expansion state being changed in a grid - -- **cancel**: `boolean` — The event is cancelable -cancel returns whether the event has been intercepted and stopped -If the value becomes "true", it returns/exits from the method, instantiating the interface -- **event?**: `Event` — Optional -Represents the original event, that has triggered the expansion/collapse -- **expanded**: `boolean` — Returns the state of the row after the operation has ended -Indicating whether the row is being expanded (true) or collapsed (false) -- **rowID**: `any` — Represents the ID of the row that emitted the event (which state is changed) -- **rowKey**: `any` - -### [IScrollStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IScrollStrategy) -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-scroll). -Scroll strategies determines how the scrolling will be handled in the provided IgxOverlayService. - -- **attach**: `any` -- **detach**: `any` -- **initialize**: `any` - -### [ISearchInfo](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISearchInfo) - -- **activeMatchIndex**: `number` -- **matchInfoCache**: `any[]` - -### [ISelectionEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISelectionEventArgs) -Interface that encapsulates selectionChanging event arguments - old selection, new selection and cancel selection. - -- **newSelection**: `IgxDropDownItemBaseDirective` -- **oldSelection**: `IgxDropDownItemBaseDirective` - -### [ISelectionKeyboardState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISelectionKeyboardState) -Represents the state of the keyboard when selecting. - -- **active**: `boolean` — Indicates whether the selection is currently active (being performed). False when resetting the selection. -- **node**: `ISelectionNode` — The selected node in the grid, if any. Can be null if no node is selected. -- **range**: `GridSelectionRange` — The range of the selected cells in the grid. Can be null when resetting the selection. -- **shift**: `boolean` — Indicates whether the Shift key is currently pressed during the selection. - -### [ISelectionNode](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISelectionNode) -Represents a single selected cell or node in a grid. - -- **column**: `number` — The index of the selected column. -- **isSummaryRow?**: `boolean` — (Optional) -Indicates if the selected node is a summary row. -This property is true if the selected row is a summary row; otherwise, it is false. -- **layout?**: `IMultiRowLayoutNode` — (Optional) -Additional layout information for multi-row selection nodes. -- **row**: `number` — The index of the selected row. - -### [ISelectionPointerState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISelectionPointerState) -Represents the state of the grid selection using pointer interactions (mouse). -Extends ISelectionKeyboardState to include pointer-specific properties. - -- **ctrl**: `boolean` — Indicates whether the Ctrl key is currently pressed during the selection. -- **primaryButton**: `boolean` — Indicates whether the primary pointer button is pressed during the selection (clicked). - -### [ISimpleComboSelectionChangingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISimpleComboSelectionChangingEventArgs) -Emitted when an igx-simple-combo's selection is changing. - -- **displayText**: `string` — The text that will be displayed in the combo text box -- **newSelection**: `any` — An object which represents the item that will be selected after this event -- **newValue**: `any` — An object which represents the value that will be selected after this event -- **oldSelection**: `any` — An object which represents the item that is currently selected -- **oldValue**: `any` — An object which represents the value that is currently selected - -### [ISizeInfo](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISizeInfo) - -- **padding**: `number` -- **width**: `number` - -### [ISlideEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISlideEventArgs) - -- **carousel**: `IgxCarouselComponent` -- **slide**: `IgxSlideComponent` - -### [ISliderValueChangeEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISliderValueChangeEventArgs) - -- **oldValue**: `number | IRangeSliderValue` -- **value**: `number | IRangeSliderValue` - -### [ISortingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISortingEventArgs) -Represents event arguments related to sorting and grouping operations -The event is cancelable - -- **groupingExpressions?**: `IGroupingExpression | IGroupingExpression[]` — Optional -Represents the grouping expressions applied to the grid. -It can be a single grouping expression or an array of them -The expression contains information like the sorting expression and criteria by which the elements will be grouped -- **sortingExpressions?**: `ISortingExpression | ISortingExpression[]` — Optional -Represents the sorting expressions applied to the grid. -It can be a single sorting expression or an array of them -The expression contains information like file name, whether the letter case should be taken into account, etc. - -### [ISortingExpression](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISortingExpression) - -- **dir**: `SortingDirection` -- **fieldName**: `KeyOfOrString & string` -- **ignoreCase?**: `boolean` -- **strategy?**: `ISortingStrategy` - -### [ISortingOptions](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISortingOptions) - -- **mode**: `"single" | "multiple"` - -### [ISortingStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISortingStrategy) - -- **sort**: `any` - -### [ISplitterBarResizeEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISplitterBarResizeEventArgs) - -- **pane**: `IgxSplitterPaneComponent` -- **sibling**: `IgxSplitterPaneComponent` - -### [IStepChangedEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IStepChangedEventArgs) - -- **index**: `number` -- **owner**: `IgxStepper` — Provides reference to the owner component. - -### [IStepChangingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IStepChangingEventArgs) - -- **newIndex**: `number` -- **oldIndex**: `number` -- **owner**: `IgxStepper` — Provides reference to the owner component. - -### [ISummaryExpression](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISummaryExpression) - -- **customSummary?**: `any` -- **fieldName**: `string` - -### [ISummaryRecord](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ISummaryRecord) - -- **cellIndentation?**: `number` -- **max?**: `number` -- **summaries**: `Map` - -### [ITabsSelectedIndexChangingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ITabsSelectedIndexChangingEventArgs) - -- **cancel**: `boolean` -- **newIndex**: `number` -- **oldIndex**: `number` - -### [ITabsSelectedItemChangeEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ITabsSelectedItemChangeEventArgs) - -- **newItem**: `IgxTabItemDirective` -- **oldItem**: `IgxTabItemDirective` - -### [ITimePickerResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ITimePickerResourceStrings) - -- **igx_time_picker_cancel?**: `string` -- **igx_time_picker_change_time?**: `string` -- **igx_time_picker_choose_time?**: `string` -- **igx_time_picker_ok?**: `string` - -### [IToggleView](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IToggleView) -Common interface for Components with show and collapse functionality - -- **element**: `any` -- **close**: `any` -- **open**: `any` -- **toggle**: `any` - -### [ITooltipHideEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ITooltipHideEventArgs) - -- **cancel**: `boolean` -- **target**: `IgxTooltipTargetDirective` -- **tooltip**: `IgxTooltipDirective` - -### [ITooltipShowEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ITooltipShowEventArgs) - -- **cancel**: `boolean` -- **target**: `IgxTooltipTargetDirective` -- **tooltip**: `IgxTooltipDirective` - -### [ITreeGridRecord](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ITreeGridRecord) - -- **children?**: `ITreeGridRecord[]` -- **data**: `any` -- **expanded?**: `boolean` -- **isFilteredOutParent?**: `boolean` -- **key**: `any` -- **level?**: `number` -- **parent?**: `ITreeGridRecord` - -### [ITreeNodeEditedEvent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ITreeNodeEditedEvent) - -- **node**: `IgxTreeNode` -- **value**: `any` - -### [ITreeNodeEditingEvent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ITreeNodeEditingEvent) - -- **node**: `IgxTreeNode` -- **value**: `string` - -### [ITreeNodeSelectionEvent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ITreeNodeSelectionEvent) - -- **added**: `IgxTreeNode[]` -- **event?**: `Event` — Browser event -- **newSelection**: `IgxTreeNode[]` -- **oldSelection**: `IgxTreeNode[]` -- **removed**: `IgxTreeNode[]` - -### [ITreeNodeToggledEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ITreeNodeToggledEventArgs) - -- **node**: `IgxTreeNode` - -### [ITreeNodeTogglingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ITreeNodeTogglingEventArgs) - -- **node**: `IgxTreeNode` - -### [ITreeResourceStrings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ITreeResourceStrings) - -- **igx_collapse?**: `string` -- **igx_expand?**: `string` - -### [IValuesChange](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IValuesChange) -Event emitted when values list is changed. - -- **values**: `IPivotValue[]` — The new list of values. - -### [IViewChangeEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IViewChangeEventArgs) - -- **context**: `any` -- **owner**: `IgxTemplateOutletDirective` — Provides reference to the owner component. -- **view**: `EmbeddedViewRef` - -### [IViewDateChangeEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/IViewDateChangeEventArgs) - -- **currentValue**: `Date` -- **previousValue**: `Date` - -### [OverlayAnimationEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/OverlayAnimationEventArgs) - -- **animationPlayer**: `AnimationPlayer` — Animation player that will play the animation -- **animationType**: `"close" | "open"` — Type of animation to be played. It should be either 'open' or 'close' -- **id**: `string` — Id of the overlay generated with attach() method - -### [OverlayCancelableEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/OverlayCancelableEventArgs) - - -### [OverlayClosingEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/OverlayClosingEventArgs) - - -### [OverlayCreateSettings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/OverlayCreateSettings) - -- **injector?**: `Injector` — An Injector instance to add in the created component ref's injectors tree. - -### [OverlayEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/OverlayEventArgs) - -- **componentRef?**: `ComponentRef$1` — Available when Type is provided to the attach() method and allows access to the created Component instance -- **elementRef?**: `ElementRef` — Will provide the elementRef of the markup that will be displayed in the overlay -- **event?**: `Event` — Will provide the original keyboard event if closed from ESC or click -- **id**: `string` — Id of the overlay generated with attach() method -- **settings?**: `OverlaySettings` — Will provide the overlay settings which will be used when the component is attached - -### [OverlaySettings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/OverlaySettings) - -- **closeOnEscape?**: `boolean` — Set if the overlay should close when Esc key is pressed -- **closeOnOutsideClick?**: `boolean` — Set if the overlay should close on outside click -- **modal?**: `boolean` — Set if the overlay should be in modal mode -- **outlet?**: `ElementRef | IgxOverlayOutletDirective` — Set the outlet container to attach the overlay to -- **positionStrategy?**: `IPositionStrategy` — Position strategy to use with these settings -- **scrollStrategy?**: `IScrollStrategy` — Scroll strategy to use with these settings -- **target?**: `HTMLElement | Point` — Attaching target for the component to show - -### [PivotGridType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/PivotGridType) -An interface describing a Pivot Grid type. It is essentially the blueprint to a grid kind -Contains definitions of properties and methods, relevant to a grid kind -Extends from GridType - -- **allDimensions**: `IPivotDimension[]` — An array of all dimensions (rows and columns) in the pivot grid. -it includes hierarchical level, filters and sorting, dimensional level, etc. -- **dimensionsChange**: `EventEmitter` — Emits an event when the dimensions in the pivot grid change. -- **dimensionsSortingExpressionsChange**: `EventEmitter[]>` — Emits an event when the a dimension is sorted. -- **excelStyleFilterMaxHeight**: `string` -- **excelStyleFilterMinHeight**: `string` -- **hasMultipleValues**: `boolean` -- **pivotConfiguration**: `IPivotConfiguration` — The configuration settings for the pivot grid. -it includes dimension strategy for rows and columns, filters and data keys -- **pivotRowWidths**: `number` -- **pivotUI**: `IPivotUISettings` — Specifies whether to show the pivot configuration UI in the grid. -- **rowDimensionHeaderTemplate**: `TemplateRef` -- **rowDimensionResizing**: `boolean` -- **valueChipTemplate**: `TemplateRef` -- **valuesChange**: `EventEmitter` — Emits an event when the values in the pivot grid change. -- **getDimensionsByType**: `any` -- **getRowDimensionByName**: `any` -- **moveDimension**: `any` -- **moveValue**: `any` -- **resolveDataTypes**: `any` -- **rowDimensionWidth**: `any` -- **rowDimensionWidthToPixels**: `any` -- **setupColumns**: `any` -- **sortDimension**: `any` -- **toggleDimension**: `any` -- **toggleRow**: `any` -- **toggleValue**: `any` - -### [PivotRowHeaderGroupType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/PivotRowHeaderGroupType) - -- **grid**: `any` -- **header**: `any` -- **headerID**: `string` -- **parent**: `any` -- **rowIndex**: `number` - -### [PositionSettings](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/PositionSettings) - -- **closeAnimation?**: `AnimationReferenceMetadata` — Animation applied while overlay closes -- **horizontalDirection?**: `HorizontalAlignment` — Direction in which the component should show -- **horizontalStartPoint?**: `HorizontalAlignment` — Target's starting point -- **minSize?**: `Size` — The size up to which element may shrink when shown in elastic position strategy -- **openAnimation?**: `AnimationReferenceMetadata` — Animation applied while overlay opens -- **verticalDirection?**: `VerticalAlignment` — Direction in which the component should show -- **verticalStartPoint?**: `VerticalAlignment` — Target's starting point - -### [RowType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/RowType) -Interface representing a row in the grid. It is essentially the blueprint to a row object. -Contains definitions of properties and methods, relevant to a row - -- **addRowUI?**: `boolean` -- **beginAddRow?**: `any` — Optional -A method to handle adding a new row -- **cells?**: `QueryList | CellType[]` — Optional -A list or an array of cells, that belong to the row -- **children?**: `RowType[]` — Optional -Contains the child rows of the current row, if there are any. -- **data?**: `any` -- **delete?**: `any` — Optional -A method to handle deleting rows -- **deleted?**: `boolean` — Optional -Indicates whether the row is marked for deletion. -- **disabled?**: `boolean` — Optional -Indicates whether the current row is disabled -- **expanded?**: `boolean` — Optional -Indicates whether the current row is expanded. -The value is true, if the row is expanded and false, if it is collapsed -- **focused?**: `boolean` — Optional -Indicates whether the row is currently focused. -- **grid**: `GridType` — Represent the grid instance, the row belongs to -- **groupRow?**: `IGroupByRecord` -- **hasChildren?**: `boolean` — Optional -Indicates whether the current row has any child rows -- **index**: `number` — The index of the row within the grid -- **inEditMode?**: `boolean` — Optional -Indicates whether the row is currently being edited. -- **isGroupByRow?**: `boolean` — Indicates whether the row is grouped. -- **isSummaryRow?**: `boolean` -- **key?**: `any` -- **nativeElement?**: `HTMLElement` — Represents the native HTML element of the row itself -- **onClick?**: `any` — Optional -A method to handle click event on the row -It takes a MouseEvent as an argument -- **onRowSelectorClick?**: `any` -- **parent?**: `RowType` — Optional -Contains the parent row of the current row, if it has one. -If the parent row exist, it means that the current row is a child row -- **pin?**: `any` — Optional -A method to handle pinning a row -- **pinned?**: `boolean` — Optional -Indicates whether the current row is pinned. -- **selected?**: `boolean` — Optional -Indicates whether the current row is selected -- **summaries?**: `Map` — Optional -A map of column field names to the summary results for the row. -- **treeRow?**: `ITreeGridRecord` — Optional -Represents the hierarchical record associated with the row (for tree grids). -It is of type ITreeGridRecord, which contains the data, children, the hierarchical level, etc. -- **unpin?**: `any` — Optional -A method to handle unpinning a row, that has been pinned -- **update?**: `any` — Optional -A method to handle changing the value of elements of the row -It takes the new value as an argument -- **validation?**: `IGridValidationState` -- **viewIndex**: `number` -- **virtDirRow?**: `IgxGridForOfDirective` — Optional -Virtualization state of data record added from cache - -### [State](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/State) - -- **recordRef**: `any` -- **type**: `TransactionType` -- **value**: `any` - -### [StateUpdateEvent](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/StateUpdateEvent) - -- **actions**: `Action[]` -- **origin**: `TransactionEventOrigin` - -### [ToggleViewCancelableEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ToggleViewCancelableEventArgs) - - -### [ToggleViewEventArgs](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/ToggleViewEventArgs) - -- **event?**: `Event` -- **id**: `string` — Id of the toggle view - -### [Transaction](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/Transaction) - -- **id**: `any` -- **newValue**: `any` -- **type**: `TransactionType` - -### [TransactionService](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/TransactionService) - -- **canRedo**: `boolean` -- **canUndo**: `boolean` -- **cloneStrategy**: `IDataCloneStrategy` — Gets/Sets the data clone strategy used to clone data -- **enabled**: `boolean` — Returns whether transaction is enabled for this service -- **onStateUpdate?**: `EventEmitter` — Event fired when transaction state has changed - add transaction, commit all transactions, undo and redo -- **add**: `any` -- **clear**: `any` -- **commit**: `any` -- **endPending**: `any` -- **getAggregatedChanges**: `any` -- **getAggregatedValue**: `any` -- **getState**: `any` -- **getTransactionLog**: `any` -- **redo**: `any` -- **startPending**: `any` -- **undo**: `any` - -### [TreeGridType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/interfaces/TreeGridType) -An interface describing a Tree Grid type. It is essentially the blueprint to a grid kind -Contains definitions of properties and methods, relevant to a grid kind -Extends from GridType - -- **records**: `Map` -- **isTreeRow**: `any` - -## Enumerations - -### [AbsolutePosition](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/AbsolutePosition) -Defines the possible positions for the absolute overlay settings presets. - -- **Bottom** = "bottom" -- **Center** = "center" -- **Top** = "top" - -### [ColumnPinningPosition](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/ColumnPinningPosition) -Enumeration representing the possible positions for pinning columns. -- Start: Columns are pinned to the start of the grid. -- End: Columns are pinned to the end of the grid. - -- **End** = 1 -- **Start** = 0 - -### [CsvFileTypes](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/CsvFileTypes) -This enumeration is used to configure the default value separator -as well as the default file extension used when performing CSV exporting. - -- **CSV** = 0 — Character Separated Values, default separator is "comma", default file extension is .csv -- **TAB** = 2 — Tab Separated Values, default separator is tab, default file extension is .tab -- **TSV** = 1 — Tab Separated Values, default separator is tab, default file extension is .tsv - -### [DatePart](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/DatePart) -Specify a particular date, time or AmPm part. - -- **AmPm** = "ampm" -- **Date** = "date" -- **FractionalSeconds** = "fractionalSeconds" -- **Hours** = "hours" -- **Literal** = "literal" -- **Minutes** = "minutes" -- **Month** = "month" -- **Seconds** = "seconds" -- **Year** = "year" - -### [DateRangeType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/DateRangeType) - -- **After** = 0 -- **Before** = 1 -- **Between** = 2 -- **Specific** = 3 -- **Weekdays** = 4 -- **Weekends** = 5 - -### [Direction](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/Direction) - -- **NEXT** = 1 -- **NONE** = 0 -- **PREV** = 2 - -### [DragDirection](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/DragDirection) - -- **BOTH** = 2 -- **HORIZONTAL** = 1 -- **VERTICAL** = 0 - -### [ExportHeaderType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/ExportHeaderType) - -- **ColumnHeader** = "ColumnHeader" -- **MultiColumnHeader** = "MultiColumnHeader" -- **MultiRowHeader** = "MultiRowHeader" -- **PivotMergedHeader** = "PivotMergedHeader" -- **PivotRowHeader** = "PivotRowHeader" -- **RowHeader** = "RowHeader" - -### [ExportRecordType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/ExportRecordType) - -- **DataRecord** = "DataRecord" -- **GroupedRecord** = "GroupedRecord" -- **HeaderRecord** = "HeaderRecord" -- **HierarchicalGridRecord** = "HierarchicalGridRecord" -- **PivotGridRecord** = "PivotGridRecord" -- **SummaryRecord** = "SummaryRecord" -- **TreeGridRecord** = "TreeGridRecord" - -### [FilteringExpressionsTreeType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/FilteringExpressionsTreeType) - -- **Advanced** = 1 -- **Regular** = 0 - -### [FilteringLogic](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/FilteringLogic) - -- **And** = 0 -- **Or** = 1 - -### [HorizontalAlignment](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/HorizontalAlignment) - -- **Center** = -0.5 -- **Left** = -1 -- **Right** = 0 - -### [IgxInputState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/IgxInputState) - -- **INITIAL** = 0 -- **INVALID** = 2 -- **VALID** = 1 - -### [IgxListPanState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/IgxListPanState) - -- **LEFT** = 1 -- **NONE** = 0 -- **RIGHT** = 2 - -### [PagingError](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/PagingError) - -- **IncorrectPageIndex** = 1 -- **IncorrectRecordsPerPage** = 2 -- **None** = 0 - -### [PivotDimensionType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/PivotDimensionType) -The dimension types - Row, Column or Filter. - -- **Column** = 1 -- **Filter** = 2 -- **Row** = 0 - -### [PivotRowLayoutType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/PivotRowLayoutType) - -- **Horizontal** = "horizontal" -- **Vertical** = "vertical" - -### [PivotSummaryPosition](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/PivotSummaryPosition) - -- **Bottom** = "bottom" -- **Top** = "top" - -### [RelativePosition](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/RelativePosition) -Defines the possible positions for the relative overlay settings presets. - -- **Above** = "above" -- **After** = "after" -- **Before** = "before" -- **Below** = "below" -- **Default** = "default" - -### [RelativePositionStrategy](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/RelativePositionStrategy) -Defines the possible values of the overlays' position strategy. - -- **Auto** = "auto" -- **Connected** = "connected" -- **Elastic** = "elastic" - -### [RowPinningPosition](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/RowPinningPosition) -Enumeration representing the possible positions for pinning rows. -- Top: Rows are pinned to the top of the grid. -- Bottom: Rows are pinned to the bottom of the grid. - -- **Bottom** = 1 -- **Top** = 0 - -### [ScrollDirection](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/ScrollDirection) - -- **NEXT** = "next" -- **NONE** = "none" -- **PREV** = "prev" - -### [SortingDirection](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/SortingDirection) - -- **Asc** = 1 -- **Desc** = 2 -- **None** = 0 - -### [SplitterType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/SplitterType) -An enumeration that defines the SplitterComponent panes orientation. - -- **Horizontal** = 0 -- **Vertical** = 1 - -### [TRANSACTION_TYPE](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/TRANSACTION_TYPE) -The type of the transaction that should be provided. -When batchEditing is disabled, None is provided. -When enabled - Base is provided. -An enum instead of a boolean value leaves room for extra scenarios in the future. - -- **Base** = "Base" -- **None** = "None" - -### [TransactionEventOrigin](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/TransactionEventOrigin) - -- **ADD** = "add" -- **CLEAR** = "clear" -- **END** = "endPending" -- **REDO** = "redo" -- **UNDO** = "undo" - -### [TransactionType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/TransactionType) - -- **ADD** = "add" -- **DELETE** = "delete" -- **UPDATE** = "update" - -### [VerticalAlignment](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/VerticalAlignment) - -- **Bottom** = 0 -- **Middle** = -0.5 -- **Top** = -1 - -### [WEEKDAYS](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/enums/WEEKDAYS) - -- **FRIDAY** = 5 -- **MONDAY** = 1 -- **SATURDAY** = 6 -- **SUNDAY** = 0 -- **THURSDAY** = 4 -- **TUESDAY** = 2 -- **WEDNESDAY** = 3 - -## Type Aliases - -### [ButtonGroupAlignment](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/ButtonGroupAlignment) -`any` - -### [CalendarSelection](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/CalendarSelection) -`any` - -### [CarouselAnimationType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/CarouselAnimationType) -`any` - -### [CarouselIndicatorsOrientation](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/CarouselIndicatorsOrientation) -`any` - -### [ColumnDisplayOrder](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/ColumnDisplayOrder) -`any` - -### [DataType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/DataType) -`any` - -### [ExpansionPanelHeaderIconPosition](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/ExpansionPanelHeaderIconPosition) -`any` - -### [FilterMode](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/FilterMode) -`any` - -### [GridColumnDataType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/GridColumnDataType) -`any` - -### [GridFeatures](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/GridFeatures) -`any` - -### [GridKeydownTargetType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/GridKeydownTargetType) -`"dataCell" | "summaryCell" | "groupRow" | "hierarchicalRow" | "headerCell" | "masterDetailRow"` -Type representing the type of the target object (elements of the grid) for keydown (fired when a key is pressed) events in the grid. -- 'dataCell': Represents a data cell within the grid. It contains and displays individual data values -- 'summaryCell': Summary cells display aggregated/summarized data at the bottom of the grid. They provide insights like total record count, min/max values, etc. -- 'groupRow': Group row within the grid. Group rows are used to group related data rows by columns. Contains the related group expression, level, sub-records and group value. -- 'hierarchicalRow': Hierarchical rows are similar to group rows, but represent a more complex hierarchical structure, allowing for nested grouping -- 'headerCell': Represents a header cell within the grid. Header cells are used to display column headers, providing context and labels for the columns. -- 'masterDetailRow': Represents a grid row that can be expanded in order to show additional information - -### [GridPagingMode](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/GridPagingMode) -`any` - -### [GridSelectionMode](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/GridSelectionMode) -`any` - -### [GridSummaryCalculationMode](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/GridSummaryCalculationMode) -`any` - -### [GridSummaryPosition](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/GridSummaryPosition) -`any` - -### [GridValidationTrigger](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/GridValidationTrigger) -`"change" | "blur"` -Type representing the triggers for grid cell validation. -- 'change': Validation is triggered when the cell value changes. -- 'blur': Validation is triggered when the cell loses focus. - -### [HorizontalAnimationType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/HorizontalAnimationType) -`any` - -### [IconReference](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IconReference) -`IconMeta & FamilyMeta` - -### [IgxAvatarSize](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxAvatarSize) -`any` - -### [IgxAvatarType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxAvatarType) -`any` - -### [IgxBadgeType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxBadgeType) -`any` - -### [IgxButtonType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxButtonType) -`any` -Determines the Button type. - -### [IgxCalendarView](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxCalendarView) -`any` -Determines the Calendar active view - days, months or years. - -### [IgxCardActionsLayout](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxCardActionsLayout) -`any` - -### [IgxDividerType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxDividerType) -`any` - -### [IgxExporterOptions](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxExporterOptions) -`IgxCsvExporterOptions | IgxExcelExporterOptions` - -### [IgxIconButtonType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxIconButtonType) -`any` -Determines the Icon Button type. - -### [IgxInputGroupType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxInputGroupType) -`any` -Determines the InputGroupType. - -### [IgxProgressType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxProgressType) -`any` - -### [IgxSliderType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxSliderType) -`any` - -### [IgxStepperOrientation](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxStepperOrientation) -`any` - -### [IgxStepperTitlePosition](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxStepperTitlePosition) -`any` - -### [IgxStepType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxStepType) -`any` - -### [IgxTabsAlignment](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxTabsAlignment) -`any` - -### [IgxTextAlign](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxTextAlign) -`any` - -### [IgxTheme](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxTheme) -`any` -Determines the component theme. - -### [IgxTreeSearchResolver](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxTreeSearchResolver) -`any` -Comparer function that can be used when searching through IgxTreeNode[] - -### [IgxTreeSelectionType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/IgxTreeSelectionType) -`any` - -### [LabelPosition](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/LabelPosition) -`any` - -### [PickerInteractionMode](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/PickerInteractionMode) -`any` - -### [PivotAggregation](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/PivotAggregation) -`any` -Interface describing a PivotAggregation function. -Accepts an array of extracted data members and a array of the original data records. - -### [PivotAggregationType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/PivotAggregationType) -`"SUM" | "AVG" | "MIN" | "MAX" | "COUNT" | "LATEST" | "EARLIEST"` - -### [RadioGroupAlignment](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/RadioGroupAlignment) -`any` - -### [SelectionState](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/SelectionState) -`ISelectionKeyboardState | ISelectionPointerState` -Represents the overall state of grid selection, combining both keyboard and pointer interaction states. -It can be either an ISelectionKeyboardState or an ISelectionPointerState. - -### [Size](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/Size) -`any` - -### [SliderHandle](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/SliderHandle) -`any` - -### [TickLabelsOrientation](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/TickLabelsOrientation) -`any` - -### [TicksOrientation](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/TicksOrientation) -`any` - -### [ValidationStatus](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/ValidationStatus) -`"VALID" | "INVALID"` -Type representing the validation status. -- 'VALID': The validation status is valid. -- 'INVALID': The validation status is invalid. - -### [VerticalAnimationType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/types/VerticalAnimationType) -`any` - -## Functions - -### [changei18n](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/functions/changei18n) -`changei18n(resourceStrings: IResourceStrings): void` - -### [comboIgnoreDiacriticsFilter](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/functions/comboIgnoreDiacriticsFilter) -`comboIgnoreDiacriticsFilter(collection: T[], searchValue: string, filteringOptions: IComboFilteringOptions): T[]` -Combo filter function which does not distinguish between accented letters and their base letters. -For example, when filtering for "resume", this function will match both "resume" and "résumé". - -### [isLeap](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/functions/isLeap) -`isLeap(year: number): boolean` -Returns true for leap years, false for non-leap years. - -### [monthRange](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/functions/monthRange) -`monthRange(year: number, month: number): number[]` -Return weekday and number of days for year, month. - -### [range](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/functions/range) -`range(start: number, stop: number, step: number): any[]` - -### [weekDay](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/functions/weekDay) -`weekDay(year: number, month: number, day: number): number` - -## Variables - -### [ActionStripResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/ActionStripResourceStringsEN) -`IActionStripResourceStrings` - -### [BannerResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/BannerResourceStringsEN) -`IBannerResourceStrings` - -### [ButtonGroupAlignment](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/ButtonGroupAlignment) -`any` -Determines the Button Group alignment - -### [CalendarResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/CalendarResourceStringsEN) -`ICalendarResourceStrings` - -### [CalendarSelection](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/CalendarSelection) -`any` -Sets the selection type - single, multi or range. - -### [CarouselAnimationType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/CarouselAnimationType) -`any` - -### [CarouselIndicatorsOrientation](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/CarouselIndicatorsOrientation) -`any` - -### [CarouselResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/CarouselResourceStringsEN) -`ICarouselResourceStrings` - -### [ChipResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/ChipResourceStringsEN) -`IChipResourceStrings` - -### [ColumnDisplayOrder](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/ColumnDisplayOrder) -`any` -Enumeration representing different column display order options. - -### [ComboResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/ComboResourceStringsEN) -`IComboResourceStrings` - -### [DatePickerResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/DatePickerResourceStringsEN) -`IDatePickerResourceStrings` - -### [DateRangePickerResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/DateRangePickerResourceStringsEN) -`IDateRangePickerResourceStrings` - -### [DEFAULT_OWNER](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/DEFAULT_OWNER) -`"default"` - -### [DEFAULT_PIVOT_KEYS](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/DEFAULT_PIVOT_KEYS) -`any` -Default pivot keys used for data processing in the pivot pipes. - -### [FilterMode](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/FilterMode) -`any` -Enumeration representing different filter modes for grid filtering. -- quickFilter: Default mode with a filter row UI between the column headers and the first row of records. -- excelStyleFilter: Filter mode where an Excel-style filter is used. - -### [GRID_LEVEL_COL](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/GRID_LEVEL_COL) -`"GRID_LEVEL_COL"` - -### [GRID_PARENT](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/GRID_PARENT) -`"grid-parent"` - -### [GRID_ROOT_SUMMARY](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/GRID_ROOT_SUMMARY) -`"igxGridRootSummary"` - -### [GridPagingMode](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/GridPagingMode) -`any` -Enumeration representing different paging modes for the grid. -- Local: The grid will use local data to extract pages during paging. -- Remote: The grid will expect pages to be delivered from a remote location and will only raise events during paging interactions. - -### [GridResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/GridResourceStringsEN) -`IGridResourceStrings` - -### [GridSelectionMode](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/GridSelectionMode) -`any` -Enumeration representing different selection modes for the grid elements if can be selected. -- 'none': No selection is allowed. Default row and column selection mode. -- 'single': Only one element can be selected at a time. Selecting a new one will deselect the previously selected one. -- 'multiple': Default cell selection mode. More than one element can be selected at a time. -- 'multipleCascade': Similar to multiple selection. It is used in hierarchical or tree grids. Allows selection not only to an individual item but also all its related or nested items in a single action - -### [GridSummaryCalculationMode](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/GridSummaryCalculationMode) -`any` -Enumeration representing different calculation modes for grid summaries. -- rootLevelOnly: Summaries are calculated only for the root level. -- childLevelsOnly: Summaries are calculated only for child levels. -- rootAndChildLevels: Default value; Summaries are calculated for both root and child levels. - -### [GridSummaryPosition](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/GridSummaryPosition) -`any` -Enumeration representing the position of grid summary rows. -- top: Default value; Summary rows are displayed at the top of the grid. -- bottom: Summary rows are displayed at the bottom of the grid. - -### [HorizontalAnimationType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/HorizontalAnimationType) -`any` - -### [IGX_ACCORDION_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_ACCORDION_DIRECTIVES) -`any` - -### [IGX_ACTION_STRIP_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_ACTION_STRIP_DIRECTIVES) -`any` - -### [IGX_BANNER_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_BANNER_DIRECTIVES) -`any` - -### [IGX_BOTTOM_NAV_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_BOTTOM_NAV_DIRECTIVES) -`any` - -### [IGX_BUTTON_GROUP_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_BUTTON_GROUP_DIRECTIVES) -`any` - -### [IGX_CALENDAR_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_CALENDAR_DIRECTIVES) -`any` - -### [IGX_CALENDAR_VIEW_ITEM](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_CALENDAR_VIEW_ITEM) -`InjectionToken` - -### [IGX_CARD_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_CARD_DIRECTIVES) -`any` - -### [IGX_CAROUSEL_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_CAROUSEL_DIRECTIVES) -`any` - -### [IGX_CHIPS_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_CHIPS_DIRECTIVES) -`any` - -### [IGX_CIRCULAR_PROGRESS_BAR_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_CIRCULAR_PROGRESS_BAR_DIRECTIVES) -`any` - -### [IGX_COMBO_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_COMBO_DIRECTIVES) -`any` - -### [IGX_DATE_PICKER_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_DATE_PICKER_DIRECTIVES) -`any` - -### [IGX_DATE_RANGE_PICKER_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_DATE_RANGE_PICKER_DIRECTIVES) -`any` - -### [IGX_DIALOG_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_DIALOG_DIRECTIVES) -`any` - -### [IGX_DRAG_DROP_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_DRAG_DROP_DIRECTIVES) -`any` - -### [IGX_DROP_DOWN_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_DROP_DOWN_DIRECTIVES) -`any` - -### [IGX_EXPANSION_PANEL_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_EXPANSION_PANEL_DIRECTIVES) -`any` - -### [IGX_GRID_ACTION_STRIP_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_GRID_ACTION_STRIP_DIRECTIVES) -`any` - -### [IGX_GRID_BASE](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_GRID_BASE) -`InjectionToken` - -### [IGX_GRID_COMMON_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_GRID_COMMON_DIRECTIVES) -`any` - -### [IGX_GRID_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_GRID_DIRECTIVES) -`any` - -### [IGX_GRID_SERVICE_BASE](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_GRID_SERVICE_BASE) -`InjectionToken` - -### [IGX_GRID_VALIDATION_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_GRID_VALIDATION_DIRECTIVES) -`any` - -### [IGX_HIERARCHICAL_GRID_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_HIERARCHICAL_GRID_DIRECTIVES) -`any` - -### [IGX_INPUT_GROUP_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_INPUT_GROUP_DIRECTIVES) -`any` - -### [IGX_INPUT_GROUP_TYPE](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_INPUT_GROUP_TYPE) -`InjectionToken` -Defines the InputGroupType DI token. - -### [IGX_LINEAR_PROGRESS_BAR_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_LINEAR_PROGRESS_BAR_DIRECTIVES) -`any` - -### [IGX_LIST_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_LIST_DIRECTIVES) -`any` - -### [IGX_NAVBAR_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_NAVBAR_DIRECTIVES) -`any` - -### [IGX_NAVIGATION_DRAWER_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_NAVIGATION_DRAWER_DIRECTIVES) -`any` - -### [IGX_PAGINATOR_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_PAGINATOR_DIRECTIVES) -`any` - -### [IGX_PIVOT_GRID_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_PIVOT_GRID_DIRECTIVES) -`any` - -### [IGX_PROGRESS_BAR_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_PROGRESS_BAR_DIRECTIVES) -`any` - -### [IGX_QUERY_BUILDER_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_QUERY_BUILDER_DIRECTIVES) -`any` - -### [IGX_RADIO_GROUP_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_RADIO_GROUP_DIRECTIVES) -`any` - -### [IGX_SELECT_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_SELECT_DIRECTIVES) -`any` - -### [IGX_SIMPLE_COMBO_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_SIMPLE_COMBO_DIRECTIVES) -`any` - -### [IGX_SLIDER_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_SLIDER_DIRECTIVES) -`any` - -### [IGX_SPLITTER_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_SPLITTER_DIRECTIVES) -`any` - -### [IGX_STEPPER_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_STEPPER_DIRECTIVES) -`any` - -### [IGX_TABS_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_TABS_DIRECTIVES) -`any` - -### [IGX_TIME_PICKER_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_TIME_PICKER_DIRECTIVES) -`any` - -### [IGX_TOOLTIP_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_TOOLTIP_DIRECTIVES) -`any` - -### [IGX_TREE_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_TREE_DIRECTIVES) -`any` - -### [IGX_TREE_GRID_DIRECTIVES](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IGX_TREE_GRID_DIRECTIVES) -`any` - -### [IgxAvatarSize](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxAvatarSize) -`any` - -### [IgxAvatarType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxAvatarType) -`any` - -### [IgxBadgeType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxBadgeType) -`any` -Determines the igxBadge type - -### [IgxCalendarView](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxCalendarView) -`any` - -### [IgxCardActionsLayout](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxCardActionsLayout) -`any` - -### [IgxChipTypeVariant](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxChipTypeVariant) -`any` - -### [IgxDividerType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxDividerType) -`any` - -### [IgxGridTransaction](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxGridTransaction) -`InjectionToken` -Injection token for accessing the grid transaction object. -This allows injecting the grid transaction object into components or services. - -### [IgxProgressType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxProgressType) -`any` - -### [IgxSliderType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxSliderType) -`any` - -### [IgxStepperOrientation](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxStepperOrientation) -`any` - -### [IgxStepperTitlePosition](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxStepperTitlePosition) -`any` - -### [IgxStepType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxStepType) -`any` - -### [IgxTabsAlignment](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxTabsAlignment) -`any` - -### [IgxTextAlign](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxTextAlign) -`any` - -### [IgxTreeSelectionType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IgxTreeSelectionType) -`any` - -### [IndigoIcons](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/IndigoIcons) -`Map` - -### [InputResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/InputResourceStringsEN) -`IInputResourceStrings` - -### [LabelPosition](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/LabelPosition) -`any` - -### [ListResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/ListResourceStringsEN) -`IListResourceStrings` - -### [PaginatorResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/PaginatorResourceStringsEN) -`IPaginatorResourceStrings` - -### [PickerInteractionMode](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/PickerInteractionMode) -`any` -This enumeration is used to configure whether the date/time picker has an editable input with drop down -or is readonly - the date/time is selected only through a dialog. - -### [QueryBuilderResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/QueryBuilderResourceStringsEN) -`IQueryBuilderResourceStrings` - -### [RadioGroupAlignment](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/RadioGroupAlignment) -`any` -Determines the Radio Group alignment - -### [SliderHandle](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/SliderHandle) -`any` - -### [THEME_TOKEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/THEME_TOKEN) -`InjectionToken` - -### [TickLabelsOrientation](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/TickLabelsOrientation) -`any` -Slider Tick labels Orientation - -### [TicksOrientation](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/TicksOrientation) -`any` -Slider Ticks orientation - -### [TimePickerResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/TimePickerResourceStringsEN) -`ITimePickerResourceStrings` - -### [TreeResourceStringsEN](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/TreeResourceStringsEN) -`ITreeResourceStrings` - -### [VerticalAnimationType](https://www.infragistics.com/api/angular/igniteui-angular/21.0.x/variables/VerticalAnimationType) -`any` diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor.Documents.Core/25.1.x/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor.Documents.Core/25.1.x/llms-full.txt deleted file mode 100644 index bc97b46d6..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor.Documents.Core/25.1.x/llms-full.txt +++ /dev/null @@ -1,263 +0,0 @@ -# Ignite UI for Blazor Documents Core v25.1.x — Full API Reference - -> Complete API reference for the Ignite UI for Blazor Documents Core package (25.1.x). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: Blazor -Package: IgniteUI.Blazor.Documents.Core -Version: 25.1.x - -## Classes - -### [Colors](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Core/25.1.x/classes/Colors) -Static class that exposes various colors - -- **AliceBlue**: `Color` — Gets the color that has an ARGB value of #FFF0F8FF -- **AntiqueWhite**: `Color` — Gets the color that has an ARGB value of #FFFAEBD7 -- **Aqua**: `Color` — Gets the color that has an ARGB value of #FF00FFFF -- **Aquamarine**: `Color` — Gets the color that has an ARGB value of #FF7FFFD4 -- **Azure**: `Color` — Gets the color that has an ARGB value of #FFF0FFFF -- **Beige**: `Color` — Gets the color that has an ARGB value of #FFF5F5DC -- **Bisque**: `Color` — Gets the color that has an ARGB value of #FFFFE4C4 -- **Black**: `Color` — Gets the color that has an ARGB value of #FF000000 -- **BlanchedAlmond**: `Color` — Gets the color that has an ARGB value of #FFFFEBCD -- **Blue**: `Color` — Gets the color that has an ARGB value of #FF0000FF -- **BlueViolet**: `Color` — Gets the color that has an ARGB value of #FF8A2BE2 -- **Brown**: `Color` — Gets the color that has an ARGB value of #FFA52A2A -- **BurlyWood**: `Color` — Gets the color that has an ARGB value of #FFDEB887 -- **CadetBlue**: `Color` — Gets the color that has an ARGB value of #FF5F9EA0 -- **Chartreuse**: `Color` — Gets the color that has an ARGB value of #FF7FFF00 -- **Chocolate**: `Color` — Gets the color that has an ARGB value of #FFD2691E -- **Coral**: `Color` — Gets the color that has an ARGB value of #FFFF7F50 -- **CornflowerBlue**: `Color` — Gets the color that has an ARGB value of #FF6495ED -- **Cornsilk**: `Color` — Gets the color that has an ARGB value of #FFFFF8DC -- **Crimson**: `Color` — Gets the color that has an ARGB value of #FFDC143C -- **Cyan**: `Color` — Gets the color that has an ARGB value of #FF00FFFF -- **DarkBlue**: `Color` — Gets the color that has an ARGB value of #FF00008B -- **DarkCyan**: `Color` — Gets the color that has an ARGB value of #FF008B8B -- **DarkGoldenrod**: `Color` — Gets the color that has an ARGB value of #FFB8860B -- **DarkGray**: `Color` — Gets the color that has an ARGB value of #FFA9A9A9 -- **DarkGreen**: `Color` — Gets the color that has an ARGB value of #FF006400 -- **DarkKhaki**: `Color` — Gets the color that has an ARGB value of #FFBDB76B -- **DarkMagenta**: `Color` — Gets the color that has an ARGB value of #FF8B008B -- **DarkOliveGreen**: `Color` — Gets the color that has an ARGB value of #FF556B2F -- **DarkOrange**: `Color` — Gets the color that has an ARGB value of #FFFF8C00 -- **DarkOrchid**: `Color` — Gets the color that has an ARGB value of #FF9932CC -- **DarkRed**: `Color` — Gets the color that has an ARGB value of #FF8B0000 -- **DarkSalmon**: `Color` — Gets the color that has an ARGB value of #FFE9967A -- **DarkSeaGreen**: `Color` — Gets the color that has an ARGB value of #FF8FBC8F -- **DarkSlateBlue**: `Color` — Gets the color that has an ARGB value of #FF483D8B -- **DarkSlateGray**: `Color` — Gets the color that has an ARGB value of #FF2F4F4F -- **DarkTurquoise**: `Color` — Gets the color that has an ARGB value of #FF00CED1 -- **DarkViolet**: `Color` — Gets the color that has an ARGB value of #FF9400D3 -- **DeepPink**: `Color` — Gets the color that has an ARGB value of #FFFF1493 -- **DeepSkyBlue**: `Color` — Gets the color that has an ARGB value of #FF00BFFF -- **DimGray**: `Color` — Gets the color that has an ARGB value of #FF696969 -- **DodgerBlue**: `Color` — Gets the color that has an ARGB value of #FF1E90FF -- **Firebrick**: `Color` — Gets the color that has an ARGB value of #FFB22222 -- **FloralWhite**: `Color` — Gets the color that has an ARGB value of #FFFFFAF0 -- **ForestGreen**: `Color` — Gets the color that has an ARGB value of #FF228B22 -- **Fuchsia**: `Color` — Gets the color that has an ARGB value of #FFFF00FF -- **Gainsboro**: `Color` — Gets the color that has an ARGB value of #FFDCDCDC -- **GhostWhite**: `Color` — Gets the color that has an ARGB value of #FFF8F8FF -- **Gold**: `Color` — Gets the color that has an ARGB value of #FFFFD700 -- **Goldenrod**: `Color` — Gets the color that has an ARGB value of #FFDAA520 -- **Gray**: `Color` — Gets the color that has an ARGB value of #FF808080 -- **Green**: `Color` — Gets the color that has an ARGB value of #FF008000 -- **GreenYellow**: `Color` — Gets the color that has an ARGB value of #FFADFF2F -- **Honeydew**: `Color` — Gets the color that has an ARGB value of #FFF0FFF0 -- **HotPink**: `Color` — Gets the color that has an ARGB value of #FFFF69B4 -- **IndianRed**: `Color` — Gets the color that has an ARGB value of #FFCD5C5C -- **Indigo**: `Color` — Gets the color that has an ARGB value of #FF4B0082 -- **Ivory**: `Color` — Gets the color that has an ARGB value of #FFFFFFF0 -- **Khaki**: `Color` — Gets the color that has an ARGB value of #FFF0E68C -- **Lavender**: `Color` — Gets the color that has an ARGB value of #FFE6E6FA -- **LavenderBlush**: `Color` — Gets the color that has an ARGB value of #FFFFF0F5 -- **LawnGreen**: `Color` — Gets the color that has an ARGB value of #FF7CFC00 -- **LemonChiffon**: `Color` — Gets the color that has an ARGB value of #FFFFFACD -- **LightBlue**: `Color` — Gets the color that has an ARGB value of #FFADD8E6 -- **LightCoral**: `Color` — Gets the color that has an ARGB value of #FFF08080 -- **LightCyan**: `Color` — Gets the color that has an ARGB value of #FFE0FFFF -- **LightGoldenrodYellow**: `Color` — Gets the color that has an ARGB value of #FFFAFAD2 -- **LightGray**: `Color` — Gets the color that has an ARGB value of #FFD3D3D3 -- **LightGreen**: `Color` — Gets the color that has an ARGB value of #FF90EE90 -- **LightPink**: `Color` — Gets the color that has an ARGB value of #FFFFB6C1 -- **LightSalmon**: `Color` — Gets the color that has an ARGB value of #FFFFA07A -- **LightSeaGreen**: `Color` — Gets the color that has an ARGB value of #FF20B2AA -- **LightSkyBlue**: `Color` — Gets the color that has an ARGB value of #FF87CEFA -- **LightSlateGray**: `Color` — Gets the color that has an ARGB value of #FF778899 -- **LightSteelBlue**: `Color` — Gets the color that has an ARGB value of #FFB0C4DE -- **LightYellow**: `Color` — Gets the color that has an ARGB value of #FFFFFFE0 -- **Lime**: `Color` — Gets the color that has an ARGB value of #FF00FF00 -- **LimeGreen**: `Color` — Gets the color that has an ARGB value of #FF32CD32 -- **Linen**: `Color` — Gets the color that has an ARGB value of #FFFAF0E6 -- **Magenta**: `Color` — Gets the color that has an ARGB value of #FFFF00FF -- **Maroon**: `Color` — Gets the color that has an ARGB value of #FF800000 -- **MediumAquamarine**: `Color` — Gets the color that has an ARGB value of #FF66CDAA -- **MediumBlue**: `Color` — Gets the color that has an ARGB value of #FF0000CD -- **MediumOrchid**: `Color` — Gets the color that has an ARGB value of #FFBA55D3 -- **MediumPurple**: `Color` — Gets the color that has an ARGB value of #FF9370DB -- **MediumSeaGreen**: `Color` — Gets the color that has an ARGB value of #FF3CB371 -- **MediumSlateBlue**: `Color` — Gets the color that has an ARGB value of #FF7B68EE -- **MediumSpringGreen**: `Color` — Gets the color that has an ARGB value of #FF00FA9A -- **MediumTurquoise**: `Color` — Gets the color that has an ARGB value of #FF48D1CC -- **MediumVioletRed**: `Color` — Gets the color that has an ARGB value of #FFC71585 -- **MidnightBlue**: `Color` — Gets the color that has an ARGB value of #FF191970 -- **MintCream**: `Color` — Gets the color that has an ARGB value of #FFF5FFFA -- **MistyRose**: `Color` — Gets the color that has an ARGB value of #FFFFE4E1 -- **Moccasin**: `Color` — Gets the color that has an ARGB value of #FFFFE4B5 -- **NavajoWhite**: `Color` — Gets the color that has an ARGB value of #FFFFDEAD -- **Navy**: `Color` — Gets the color that has an ARGB value of #FF000080 -- **OldLace**: `Color` — Gets the color that has an ARGB value of #FFFDF5E6 -- **Olive**: `Color` — Gets the color that has an ARGB value of #FF808000 -- **OliveDrab**: `Color` — Gets the color that has an ARGB value of #FF6B8E23 -- **Orange**: `Color` — Gets the color that has an ARGB value of #FFFFA500 -- **OrangeRed**: `Color` — Gets the color that has an ARGB value of #FFFF4500 -- **Orchid**: `Color` — Gets the color that has an ARGB value of #FFDA70D6 -- **PaleGoldenrod**: `Color` — Gets the color that has an ARGB value of #FFEEE8AA -- **PaleGreen**: `Color` — Gets the color that has an ARGB value of #FF98FB98 -- **PaleTurquoise**: `Color` — Gets the color that has an ARGB value of #FFAFEEEE -- **PaleVioletRed**: `Color` — Gets the color that has an ARGB value of #FFDB7093 -- **PapayaWhip**: `Color` — Gets the color that has an ARGB value of #FFFFEFD5 -- **PeachPuff**: `Color` — Gets the color that has an ARGB value of #FFFFDAB9 -- **Peru**: `Color` — Gets the color that has an ARGB value of #FFCD853F -- **Pink**: `Color` — Gets the color that has an ARGB value of #FFFFC0CB -- **Plum**: `Color` — Gets the color that has an ARGB value of #FFDDA0DD -- **PowderBlue**: `Color` — Gets the color that has an ARGB value of #FFB0E0E6 -- **Purple**: `Color` — Gets the color that has an ARGB value of #FF800080 -- **Red**: `Color` — Gets the color that has an ARGB value of #FFFF0000 -- **RosyBrown**: `Color` — Gets the color that has an ARGB value of #FFBC8F8F -- **RoyalBlue**: `Color` — Gets the color that has an ARGB value of #FF4169E1 -- **SaddleBrown**: `Color` — Gets the color that has an ARGB value of #FF8B4513 -- **Salmon**: `Color` — Gets the color that has an ARGB value of #FFFA8072 -- **SandyBrown**: `Color` — Gets the color that has an ARGB value of #FFF4A460 -- **SeaGreen**: `Color` — Gets the color that has an ARGB value of #FF2E8B57 -- **SeaShell**: `Color` — Gets the color that has an ARGB value of #FFFFF5EE -- **Sienna**: `Color` — Gets the color that has an ARGB value of #FFA0522D -- **Silver**: `Color` — Gets the color that has an ARGB value of #FFC0C0C0 -- **SkyBlue**: `Color` — Gets the color that has an ARGB value of #FF87CEEB -- **SlateBlue**: `Color` — Gets the color that has an ARGB value of #FF6A5ACD -- **SlateGray**: `Color` — Gets the color that has an ARGB value of #FF708090 -- **Snow**: `Color` — Gets the color that has an ARGB value of #FFFFFAFA -- **SpringGreen**: `Color` — Gets the color that has an ARGB value of #FF00FF7F -- **SteelBlue**: `Color` — Gets the color that has an ARGB value of #FF4682B4 -- **Tan**: `Color` — Gets the color that has an ARGB value of #FFD2B48C -- **Teal**: `Color` — Gets the color that has an ARGB value of #FF008080 -- **Thistle**: `Color` — Gets the color that has an ARGB value of #FFD8BFD8 -- **Tomato**: `Color` — Gets the color that has an ARGB value of #FFFF6347 -- **Transparent**: `Color` — Gets the color that has an ARGB value of #00FFFFFF -- **Turquoise**: `Color` — Gets the color that has an ARGB value of #FF40E0D0 -- **Violet**: `Color` — Gets the color that has an ARGB value of #FFEE82EE -- **Wheat**: `Color` — Gets the color that has an ARGB value of #FFF5DEB3 -- **White**: `Color` — Gets the color that has an ARGB value of #FFFFFFFF -- **WhiteSmoke**: `Color` — Gets the color that has an ARGB value of #FFF5F5F5 -- **Yellow**: `Color` — Gets the color that has an ARGB value of #FFFFFF00 -- **YellowGreen**: `Color` — Gets the color that has an ARGB value of #FF9ACD32 - -### [DocumentEncryptedException](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Core/25.1.x/classes/DocumentEncryptedException) -Represents an error that occurs when no password is used to open an encrypted document. - -- **constructor**(): void -- **constructor**(message: string): void -- **constructor**(message: string, innerException: Exception): void - -### [DocumentsCoreResourceCustomizer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Core/25.1.x/classes/DocumentsCoreResourceCustomizer) -Class used to provide the ability to customize resource strings. - -- **constructor**(): void -- **GetCustomizedString**(name: string): string — Gets the customized string identified by the specified string resource name. -- **ResetAllCustomizedStrings**(): void — Clears all strings customized by calls to method. -- **ResetCustomizedString**(name: string): void — Resets a customized string identified by the specified string resource name so that it will load from the resource file. -- **SetCustomizedString**(name: string, customizedText: string): void — Sets a customized string identified by the specified string resource name. - -### [EncryptionAlgorithmNotSupportedException](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Core/25.1.x/classes/EncryptionAlgorithmNotSupportedException) -Represents an error that occurs an encrypted document is loaded with a supplied password, but the encryption algorithm used is unsupported. - -- **constructor**(): void -- **constructor**(info: SerializationInfo, context: StreamingContext): void -- **constructor**(message: string): void -- **constructor**(message: string, innerException: Exception): void - -### [InvalidPasswordException](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Core/25.1.x/classes/InvalidPasswordException) -Represents an error that occurs when an incorrect password is used to open document. - -- **constructor**(): void -- **constructor**(info: SerializationInfo, context: StreamingContext): void -- **constructor**(message: string): void -- **constructor**(message: string, innerException: Exception): void - -### [Color](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Core/25.1.x/classes/Color) -Represents a color - -- **constructor**(): void -- **A**: `byte` -- **B**: `byte` -- **ColorString**: `string` -- **G**: `byte` -- **R**: `byte` -- **Equals**(obj: object): bool — Determines if a Color is equivalent to another. -- **FromArgb**(a_: byte, r_: byte, g_: byte, b_: byte): Color -- **GetHashCode**(): int — Returns a code suitable for hashing -- **ToString**(): string - -## Interfaces - -### [IPackage](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Core/25.1.x/interfaces/IPackage) -Represents a container that can store multiple data objects. - -- **CreatePart(Uri, string)**: `IPackagePart` — Creates a new uncompressed part with a given URI and content type. -- **CreateRelationship(Uri, RelationshipTargetMode, string, string)**: `IPackageRelationship` — Creates a package-level relationship to a part with a given URI, target mode, relationship type, and identifier (ID). -- **GetPart(Uri)**: `IPackagePart` — Returns the part with a given URI. -- **GetParts()**: `IEnumerable` — Returns a collection of all the parts in the package. -- **GetRelationship(string)**: `IPackageRelationship` — Returns the relationship that has a specified IPackageRelationship.Id. -- **GetRelationships()**: `IEnumerable` — Returns a collection of all the package-level relationships. -- **PartExists(Uri)**: `bool` — Indicates whether a part with a given URI is in the package. - -### [IPackageFactory](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Core/25.1.x/interfaces/IPackageFactory) -Factory class used to create an IPackage given a stream and a FileMode - -- **Open(Stream, FileMode)**: `IPackage` — Opens an IPackage with a given IO stream and file mode. - -### [IPackagePart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Core/25.1.x/interfaces/IPackagePart) -Provides a base class for parts stored in a System.IO.Packaging.Package. This class is abstract. - -- **ContentType**: `string` — Gets the MIME type of the content stream. -- **CreateRelationship(Uri, RelationshipTargetMode, string, string)**: `IPackageRelationship` — Creates a part-level relationship between this IPackagePart to a specified target IPackagePart or external resource. -- **GetRelationship(string)**: `IPackageRelationship` — Returns the relationship that has a specified IPackageRelationship.Id. -- **GetRelationships()**: `IEnumerable` — Returns a collection of all the relationships that are owned by this part. -- **GetStream(FileMode, FileAccess)**: `Stream` — Returns the part content stream opened with a specified System.IO.FileMode and System.IO.FileAccess. -- **Package**: `IPackage` — Gets the parent Package of the part. -- **Uri**: `Uri` — Gets the URI of the part. - -### [IPackageRelationship](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Core/25.1.x/interfaces/IPackageRelationship) -Represents an association between a source IPackage or IPackagePart, and a target object which can be a IPackagePart or external resource. - -- **Id**: `string` — Gets a string that identifies the relationship. -- **RelationshipType**: `string` — Gets the qualified type name of the relationship. -- **SourceUri**: `Uri` — Gets the URI of the package or part that owns the relationship. -- **TargetMode**: `RelationshipTargetMode` — Gets a value that indicates whether the target of the relationship is RelationshipTargetMode.Internal or RelationshipTargetMode.External to the IPackage. -- **TargetUri**: `Uri` — Gets the URI of the target resource of the relationship. - -## Enumerations - -### [RelationshipTargetMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Core/25.1.x/enums/RelationshipTargetMode) -Specifies whether the target of an IPackageRelationship is inside or outside the IPackage. - -- **External** — The relationship references a resource that is external to the package. -- **Internal** — The relationship references a part that is inside the package. - -### [FileAccess](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Core/25.1.x/enums/FileAccess) -Specifies File access rights - -- **Read** — Read access allowed only -- **ReadWrite** — Read and write access allowed -- **Write** — Write access allowed only - -### [FileMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Core/25.1.x/enums/FileMode) -How the file is to be opened - -- **Append** — Opens an existing file, or creates a new one, and positions the file stream to the end of the file. -- **Create** — Create a new file. If the file already exists it will be overwritten. -- **CreateNew** — Create a new file. If the file already exists an exception is thrown. -- **Open** — Opens an existing file. If the file is not found an exception will be thrown. -- **OpenOrCreate** — Opens an existing file, or creates a new one. -- **Truncate** — Opens an existing file and sets it to a 0 length diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor.Documents.Excel/25.1.x/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor.Documents.Excel/25.1.x/llms-full.txt deleted file mode 100644 index 0a2b3b0f9..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor.Documents.Excel/25.1.x/llms-full.txt +++ /dev/null @@ -1,4258 +0,0 @@ -# Ignite UI for Blazor Documents Excel v25.1.x — Full API Reference - -> Complete API reference for the Ignite UI for Blazor Documents Excel package (25.1.x). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: Blazor -Package: IgniteUI.Blazor.Documents.Excel -Version: 25.1.x - -## Classes - -### [ImageWrapper](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ImageWrapper) -a class that wraps a native image - -- **constructor**(dataUrl: string): void -- **IsEquivalent**(other: ImageWrapper): bool — Detrimes if another image is equivalent - -### [AnyValueDataValidationRule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/AnyValueDataValidationRule) -Represents a data validation rule which allows any value to be set on the target cells. This would be used to provide an input message to the user when the cell was selected. - -- **constructor**(): void - -### [ArrayFormula](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ArrayFormula) -Represents an array formula for a group of cells. - -- **CellRange**: `WorksheetRegion` — Gets the cells to which the array formula is applied. -- **ClearCellRange**(): void — Removes this array formula as the formula for the cells to which it was applied. -- **Parse**(value: string, cellReferenceMode: CellReferenceMode): ArrayFormula — Parses the specified formula value and returns the array formula which was created from it. -- **Parse**(value: string, cellReferenceMode: CellReferenceMode, fileFormat: WorkbookFormat): ArrayFormula — Parses the specified formula value and returns the array formula which was created from it. -- **Parse**(value: string, cellReferenceMode: CellReferenceMode, fileFormat: WorkbookFormat, culture: CultureInfo): ArrayFormula — Parses the specified formula value and returns the array formula which was created from it. -- **Parse**(value: string, cellReferenceMode: CellReferenceMode, culture: CultureInfo): ArrayFormula — Parses the specified formula value and returns the array formula which was created from it. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, formula: ArrayFormula): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, formula: ArrayFormula, exception: FormulaParseException): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, fileFormat: WorkbookFormat, formula: ArrayFormula): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, fileFormat: WorkbookFormat, formula: ArrayFormula, exception: FormulaParseException): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, fileFormat: WorkbookFormat, culture: CultureInfo, formula: ArrayFormula): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, fileFormat: WorkbookFormat, culture: CultureInfo, formula: ArrayFormula, exception: FormulaParseException): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, culture: CultureInfo, formula: ArrayFormula): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, culture: CultureInfo, formula: ArrayFormula, exception: FormulaParseException): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. - -### [CellFill](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CellFill) -Abstract base class for the fill of a cell. - -- **constructor**(): void -- **NoColor**: `CellFill` — Gets the default cell fill, which is no background color. -- **CreateLinearGradientFill**(angle: double, color1: Color, color2: Color): CellFillLinearGradient — Creates a linear gradient that can be applied to a cell's fill. -- **CreateLinearGradientFill**(angle: double, stops: CellFillGradientStop[]): CellFillLinearGradient — Creates a linear gradient that can be applied to a cell's fill. -- **CreateLinearGradientFill**(angle: double, colorInfo1: WorkbookColorInfo, colorInfo2: WorkbookColorInfo): CellFillLinearGradient — Creates a linear gradient that can be applied to a cell's fill. -- **CreatePatternFill**(backgroundColor: Color, patternColor: Color, patternStyle: FillPatternStyle): CellFillPattern — Creates a solid color or pattern fill that can be applied to a cell. -- **CreatePatternFill**(backgroundColorInfo: WorkbookColorInfo, patternColorInfo: WorkbookColorInfo, patternStyle: FillPatternStyle): CellFillPattern — Creates a solid color or pattern fill that can be applied to a cell. -- **CreateRectangularGradientFill**(color1: Color, color2: Color): CellFillRectangularGradient — Creates a rectangular gradient that can be applied to a cell's fill. -- **CreateRectangularGradientFill**(colorInfo1: WorkbookColorInfo, colorInfo2: WorkbookColorInfo): CellFillRectangularGradient — Creates a rectangular gradient that can be applied to a cell's fill. -- **CreateRectangularGradientFill**(left: double, top: double, right: double, bottom: double, color1: Color, color2: Color): CellFillRectangularGradient — Creates a rectangular gradient that can be applied to a cell's fill. -- **CreateRectangularGradientFill**(left: double, top: double, right: double, bottom: double, stops: CellFillGradientStop[]): CellFillRectangularGradient — Creates a rectangular gradient that can be applied to a cell's fill. -- **CreateRectangularGradientFill**(left: double, top: double, right: double, bottom: double, colorInfo1: WorkbookColorInfo, colorInfo2: WorkbookColorInfo): CellFillRectangularGradient — Creates a rectangular gradient that can be applied to a cell's fill. -- **CreateSolidFill**(solidColor: Color): CellFillPattern — Creates a solid color fill that can be applied to a cell. -- **CreateSolidFill**(solidColorInfo: WorkbookColorInfo): CellFillPattern — Creates a solid color fill that can be applied to a cell. - -### [CellFillGradient](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CellFillGradient) -Abstract base class for a gradient fill of a cell. - -- **Stops**: `IList` — Gets the read-only collection of gradient stops which describe the color transitions and their positions within the gradient. -- **Equals**(obj: object): bool — Determines whether the is equal to the specified object. -- **GetHashCode**(): int — Gets the hash code for the . - -### [CellFillGradientStop](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CellFillGradientStop) -Immutable class which describes a color transition in a cell fill gradient. - -- **constructor**(color: Color, offset: double): void -- **constructor**(colorInfo: WorkbookColorInfo, offset: double): void -- **ColorInfo**: `WorkbookColorInfo` — Gets the describing the color transition for the gradient stop. -- **Offset**: `double` — Gets the position in the gradient of the color transition for the gradient stop, ranging from 0.0 to 1.0. -- **Equals**(obj: object): bool — Determines whether the is equal to the specified object. -- **GetHashCode**(): int — Gets the hash code for the . - -### [CellFillLinearGradient](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CellFillLinearGradient) -An immutable object which represents a linear gradient fill for a cell. - -- **constructor**(angle: double, stops: CellFillGradientStop[]): void -- **Angle**: `double` — Gets the angle, in degrees, of the direction of the linear gradient, going clockwise from the left-to-right direction. -- **Equals**(obj: object): bool — Determines whether the is equal to the specified object. -- **GetHashCode**(): int — Gets the hash code for the . - -### [CellFillPattern](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CellFillPattern) -An immutable object which represents a solid or pattern fill for a cell. - -- **constructor**(backgroundColorInfo: WorkbookColorInfo, patternColorInfo: WorkbookColorInfo, patternStyle: FillPatternStyle): void -- **BackgroundColorInfo**: `WorkbookColorInfo` — Gets the which describes the background color of the cell, which will only be seen if the is not None. -- **PatternColorInfo**: `WorkbookColorInfo` — Gets the which describes the pattern color of the cell, which will only be seen if the is not None or Solid. -- **PatternStyle**: `FillPatternStyle` — Gets the fill pattern for the cell. -- **Equals**(obj: object): bool — Determines whether the is equal to the specified object. -- **GetHashCode**(): int — Gets the hash code for the . - -### [CellFillRectangularGradient](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CellFillRectangularGradient) -An immutable object which represents a rectangular gradient fill for a cell. - -- **constructor**(left: double, top: double, right: double, bottom: double, stops: CellFillGradientStop[]): void -- **Bottom**: `double` — Gets the bottom edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell). -- **Left**: `double` — Gets the left edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell). -- **Right**: `double` — Gets the right edge of the inner rectangle of the gradient, ranging from 0.0 (the left of the cell) to 1.0 (the right of the cell). -- **Top**: `double` — Gets the top edge of the inner rectangle of the gradient, ranging from 0.0 (the top of the cell) to 1.0 (the bottom of the cell). -- **Equals**(obj: object): bool — Determines whether the is equal to the specified object. -- **GetHashCode**(): int — Gets the hash code for the . - -### [Chartsheet](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/Chartsheet) -A sheet in a Mirosoft Excel workbook that displays a single chart. - -- **Chart**: `WorksheetChart` — Returns the displayed in this chartsheet. -- **DisplayOptions**: `ChartsheetDisplayOptions` — Gets the object which controls the display of the chartsheet. -- **ImageBackground**: `ImageWrapper` — Gets or sets the background image for the worksheet. -- **PrintOptions**: `ChartsheetPrintOptions` — Gets the object which controls how the chartsheet prints. -- **Protection**: `ChartsheetProtection` — Returns an object that provides information used when the Chartsheet has been protected. -- **Type**: `SheetType` — Returns Chartsheet -- **Protect**(allowEditObjects: bool?, allowEditContents: bool?): void — Protects the chartsheet without a password. -- **Protect**(password: SecureString, allowEditObjects: bool?, allowEditContents: bool?): void — Protects the Chartsheet with the specified password. -- **Protect**(password: string, allowEditObjects: bool?, allowEditContents: bool?): void — Protects the Chartsheet with the specified password. - -### [ComboChartGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ComboChartGroup) -Exposes chart-level properties for which appear within a combo chart. - -- **AxisGroup**: `AxisGroup` — Returns the value with which this instance was created. -- **ChartType**: `ChartType` — Returns the value with which this instance was created. -- **DoughnutHoleSize**: `int?` — Returns or sets the size of the hole in a doughnut chart, expressed as a percentage of the size of the encompassing circle. -- **FirstSliceAngle**: `int?` — Returns or sets the angle, expressed in degrees which determines the origin of the first slice, as relative to the 12 o'clock position of the emcompassing circle. -- **GapWidth**: `int?` — Specifies the width of the gap between bars. Applicable only for bar/column charts. -- **SeriesOverlap**: `int?` — Determines the amount by which intersecting overlap, expressed as a percentage of the bar size. - -### [ComboChartGroupCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ComboChartGroupCollection) -A collection of objects for a - -- **Count**: `int` — Returns the number of items in the collection (read-only) -- **IsReadOnly**: `bool` — Determines if the collecion can be modified (read-only) -- **this[ChartType, AxisGroup]**: `ComboChartGroup` — Returns the instance associated with the specified chartType and axisGroup, or null if no such instance exists. -- **Add**(chartType: ChartType, axisGroup: AxisGroup): ComboChartGroup — Creates a new , or returns an existing one, which matches the specified chartType and axisGroup. -- **Clear**(): void — Clears the collection. -- **GetEnumerator**(): IEnumerator — Gets an enumerator for the items in the collection -- **Remove**(chartType: ChartType, axisGroup: AxisGroup): bool — Removes the specified from this collection. -- **Remove**(comboChartGroup: ComboChartGroup): bool — Removes the specified from this collection. - -### [CustomDataValidationRule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CustomDataValidationRule) -Represents a data validation rule which allows any formula to be used to validate the value applied to a cell. - -- **constructor**(): void -- **GetFormula**(address: string): string — Gets the formula used to validate the value applied to a cell. -- **GetFormula**(address: string, format: WorkbookFormat, cellReferenceMode: CellReferenceMode, culture: CultureInfo): string — Gets the formula used to validate the value applied to a cell. -- **IsEquivalentTo**(other: DataValidationRule): bool — Indicates if this rule is structurally equivalent to another. -- **SetFormula**(formula: string, address: string): void — Sets the formula used to validate the value applied to a cell. -- **SetFormula**(formula: string, address: string, format: WorkbookFormat, cellReferenceMode: CellReferenceMode, culture: CultureInfo): void — Sets the formula used to validate the value applied to a cell. - -### [CustomTableStyleCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CustomTableStyleCollection) -A collection of custom instances which can be applied to a in the . - -- **Count**: `int` — Gets the number of custom instances in the collection. -- **this[int]**: `WorksheetTableStyle` — Gets the at the specified index. -- **this[string]**: `WorksheetTableStyle` — Gets the with the specified name. -- **Add**(style: WorksheetTableStyle): void — Adds a custom to the collection. -- **Clear**(): void — Clears the collection. -- **Contains**(style: WorksheetTableStyle): bool — Determines whether the specified is contained in the collection. -- **IndexOf**(style: WorksheetTableStyle): int — Gets the index of the specified style in the collection. -- **Remove**(style: WorksheetTableStyle): bool — Removes the specified from the collection. -- **RemoveAt**(index: int): void — Removes the at the specified index. - -### [CustomView](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CustomView) -Represents a custom view in Microsoft Excel. - -- **Name**: `string` — Gets or sets the name of the custom view. -- **SaveHiddenRowsAndColumns**: `bool` — Gets the value indicating whether hidden row and column settings are saved with the custom view. -- **SavePrintOptions**: `bool` — Gets the value indicating whether print options are saved with the custom view. -- **WindowOptions**: `CustomViewWindowOptions` — Gets the window options for the workbook associated with the custom view. -- **Apply**(): void — Applies all options from the custom view to the associated workbook and its worksheets. -- **GetDisplayOptions**(worksheet: Worksheet, createIfNull: bool): CustomViewDisplayOptions — Gets the display options associated with the specified worksheet. -- **GetHiddenColumns**(worksheet: Worksheet, createIfNull: bool): HiddenColumnCollection — Gets the hidden columns associated with the specified worksheet. -- **GetHiddenRows**(worksheet: Worksheet, createIfNull: bool): HiddenRowCollection — Gets the hidden rows associated with the specified worksheet. -- **GetPrintOptions**(worksheet: Worksheet, createIfNull: bool): PrintOptions — Gets the print options associated with the specified worksheet. -- **GetSheetDisplayOptions**(sheet: Sheet, createIfNull: bool): DisplayOptionsBase — Gets the display options associated with the specified sheet. -- **GetSheetPrintOptions**(sheet: Sheet, createIfNull: bool): PrintOptionsBase — Gets the print options associated with the specified sheet. - -### [CustomViewCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CustomViewCollection) -A collection of instances in a workbook. - -- **Count**: `int` — Gets the number of custom views in the collection. -- **this[int]**: `CustomView` — Gets the custom view at the specified index. -- **Add**(name: string, savePrintOptions: bool, saveHiddenRowsAndColumns: bool): CustomView — Adds a new custom view to the collection. -- **Clear**(): void — Clears all custom views from the collection. -- **Contains**(customView: CustomView): bool — Determines whether a custom view is in this collection. -- **Remove**(customView: CustomView): bool — Removes the specified custom view from the collection. -- **RemoveAt**(index: int): void — Removes the custom view at the specified index from the collection. - -### [CustomViewDisplayOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CustomViewDisplayOptions) -Class which exposes the worksheet display options which can only be controlled through the custom view. - -- **MagnificationInCurrentView**: `int` — Gets or sets the magnification level of the worksheet in the current . -- **ResetCore**(): void — Resets the display options to their default settings. - -### [CustomViewWindowOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CustomViewWindowOptions) -Represents the workbook window options which are saved with custom views. - -- **BoundsInPixels**: `Rect` — Gets or sets the pixel bounds of the workbook's MDI child window when owning these window options is applied. -- **Maximized**: `bool` — Gets or sets the value indicating whether the workbook's MDI child window will be maximized when the owning these window options is applied. -- **ShowFormulaBar**: `bool` — Gets or sets the value indicating whether Microsoft Excel will display the formula bar when the owning these window options is applied. -- **ShowStatusBar**: `bool` — Gets or sets the value indicating whether Microsoft Excel will display the status bar when the owning these window options is applied. -- **Reset**(): void — Resets the window options to their default settings. - -### [DataValidationRule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DataValidationRule) -Base class for all data validations rules which can be applied to a cell. - -- **ErrorMessageDescription**: `string` — Gets or sets the description which appears in the dialog box when an invalid value is applied to a cell in Microsoft Excel. -- **ErrorMessageTitle**: `string` — Gets or sets the title which appears in the dialog box when an invalid value is applied to a cell in Microsoft Excel. -- **ErrorStyle**: `DataValidationErrorStyle` — Gets or sets the value which indicates whether the value is allowed when it is invalid and which options are given to the user in the error dialog shown by Microsoft Excel. -- **ImeMode**: `DataValidationImeMode` — Gets or sets the description of the Japanese input rules. -- **InputMessageDescription**: `string` — Gets or sets the description in the tooltip which appears when the user selects the cell in Microsoft Excel. -- **InputMessageTitle**: `string` — Gets or sets the title in the tooltip which appears when the user selects the cell in Microsoft Excel. -- **ShowErrorMessageForInvalidValue**: `bool` — Gets or sets the value which indicates whether the error dialog should appear in Microsoft Excel when invalid data is entered in the cell. -- **ShowInputMessage**: `bool` — Gets or sets the value which indicates whether to show the user an input prompt tooltip when the user selects the cell in Microsoft Excel. -- **Clone**(): DataValidationRule — Creates a copy of this rule which can be applied to other worksheets. -- **IsEquivalentTo**(other: DataValidationRule): bool — Indicates if this rule is structurally equivalent to another. - -### [DataValidationRuleCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DataValidationRuleCollection) -A collection of instances in a worksheet. - -- **Count**: `int` — Gets the number of data validation rules applied on the . -- **this[DataValidationRule]**: `WorksheetReferenceCollection` — Gets or sets the references which have the data validation rule applied to it. -- **Add**(rule: AnyValueDataValidationRule, cell: WorksheetCell): void — Applies an to a . -- **Add**(rule: AnyValueDataValidationRule, region: WorksheetRegion): void — Applies an to the cells in a . -- **Add**(rule: CustomDataValidationRule, cell: WorksheetCell): void — Applies an to a . -- **Add**(rule: CustomDataValidationRule, region: WorksheetRegion): void — Applies an to the cells in a . -- **Add**(rule: DataValidationRule, references: WorksheetReferenceCollection): void — Applies a data validation rule to the a set of references. -- **Add**(rule: DataValidationRule, references: WorksheetReferenceCollection, overwriteExistingRules: bool): void — Applies a data validation rule to the a set of references. -- **Add**(rule: ListDataValidationRule, cell: WorksheetCell): void — Applies an to a . -- **Add**(rule: ListDataValidationRule, region: WorksheetRegion): void — Applies an to the cells in a . -- **Add**(rule: OneConstraintDataValidationRule, cell: WorksheetCell): void — Applies an to a . -- **Add**(rule: OneConstraintDataValidationRule, region: WorksheetRegion): void — Applies an to the cells in a . -- **Add**(rule: TwoConstraintDataValidationRule, cell: WorksheetCell): void — Applies an to a . -- **Add**(rule: TwoConstraintDataValidationRule, region: WorksheetRegion): void — Applies an to the cells in a . -- **Clear**(): void — Removes all data validation rules from the . -- **Contains**(rule: DataValidationRule): bool — Determines whether the specified data validation rule exists on the . -- **Contains**(cell: WorksheetCell): bool — Determines whether the specified cell has a data validation rule applied to it. -- **Contains**(references: WorksheetReferenceCollection): bool — Determines whether the specified references collection has a data validation rule applied to any of it's cells. -- **Contains**(region: WorksheetRegion): bool — Determines whether the specified region has a data validation rule applied to any of it's cells. -- **FindRule**(cell: WorksheetCell): DataValidationRule — Find the data validation rule applied to the specified cell. -- **GetAllReferences**(rule: DataValidationRule): WorksheetReferenceCollection — Gets a collection of all the references which have the specified or an equivalent rule applied to them. -- **Remove**(rule: DataValidationRule): bool — Removes the specified rule from the . -- **Remove**(cell: WorksheetCell): bool — Removes the data validation rule form the cell if one is applied. -- **Remove**(references: WorksheetReferenceCollection): bool — Removes the data validation rule form all cells in the specified collection. -- **Remove**(region: WorksheetRegion): bool — Removes the data validation rule form all cells in the specified region. -- **TryGetReferences**(rule: DataValidationRule, references: WorksheetReferenceCollection): bool — Gets the references which have the specified rule applied to them or null if the rule is not used on the . - -### [DisplayOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DisplayOptions) -Abstract base class which exposes the various display options available for a worksheet which can be saved with both a worksheet and a custom view. - -- **FrozenPaneSettings**: `FrozenPaneSettings` — Gets the settings which control the frozen panes in the worksheet. -- **GridlineColor**: `Color` — Gets or sets the color of the gridlines on the worksheet. -- **PanesAreFrozen**: `bool` — Gets or sets the value which indicates if the panes in the worksheet are frozen. -- **ShowExpansionIndicatorBelowGroupedRows**: `ExcelDefaultableBoolean` — Gets or sets the value which indicates whether the expansion indicators should be shown below grouped, or indented rows. -- **ShowExpansionIndicatorToRightOfGroupedColumns**: `ExcelDefaultableBoolean` — Gets or sets the value which indicates whether the expansion indicators should be shown to the right of grouped, or indented rows. -- **ShowFormulasInCells**: `bool` — Gets or sets the value which indicates whether formulas are shown in cells. -- **ShowGridlines**: `bool` — Gets or sets the value which indicates whether gridlines are shown between cells. -- **ShowOutlineSymbols**: `bool` — Gets or sets the value which indicates whether outline symbols are shown for outlined columns and rows. -- **ShowRowAndColumnHeaders**: `bool` — Gets or sets the value which indicates whether to display row and column headers. -- **ShowRulerInPageLayoutView**: `bool` — Gets or sets the value which indicates whether to show rulers in the page layout view. -- **ShowZeroValues**: `bool` — Gets or sets the value which indicates whether zero values are shown in cells. -- **UnfrozenPaneSettings**: `UnfrozenPaneSettings` — Gets the settings which control the unfrozen panes in the worksheet. -- **View**: `WorksheetView` — Gets or sets the current view of the worksheet. -- **ClearSelection**(): void — Removes any saved selection information. -- **ResetCore**(): void — Resets the display options to their default settings. - -### [DisplayOptionsBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DisplayOptionsBase) -Abstract base class which exposes the various display options available for a sheet which can be saved with both a sheet and its custom view. - -- **Visibility**: `WorksheetVisibility` — Gets or sets the visibility of the sheet. -- **Reset**(): void — Resets the display options to their default settings. -- **ResetCore**(): void — Resets the display options to their default settings. - -### [DisplayValueCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DisplayValueCollection) -A collection of display text values. - -- **Count**: `int` — Gets the number of display text values in the collection. -- **this[int]**: `string` — Gets or sets the display text value at the specified index. -- **Add**(item: string): void — Adds a display text value to the collection. -- **Clear**(): void — Clears the collection. -- **Contains**(item: string): bool — Determines whether the specified value is in the collection. -- **IndexOf**(item: string): int — Gets the index of the specified display text value in the collection. -- **Insert**(index: int, item: string): void — Inserts a display text value into the collection. -- **Remove**(item: string): bool — Removes a display text value from the collection. -- **RemoveAt**(index: int): void — Removes the display text value at the specified index. - -### [DocumentProperties](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DocumentProperties) -Class which exposes the document level properties for a Microsoft Excel file. - -- **Author**: `string` — Gets or sets the author of the document. -- **Category**: `string` — Gets or sets the category of the document. -- **Comments**: `string` — Gets or sets the comments associated with the document. -- **Company**: `string` — Gets or sets the company to which the document belongs. -- **Keywords**: `string` — Gets or sets the keywords which describe the document. -- **Manager**: `string` — Gets or sets the manager associated with the document. -- **Status**: `string` — Gets or sets the current status of the document. -- **Subject**: `string` — Gets or sets the subject of the contents of the document. -- **Title**: `string` — Gets or sets the title of the document. - -### [ErrorValue](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ErrorValue) -Represents an error value in Microsoft Excel. - -- **ArgumentOrFunctionNotAvailable**: `ErrorValue` — Gets the ErrorValue representing the #N/A error. -- **Circularity**: `ErrorValue` — Gets the ErrorValue representing a circularity error. -- **DivisionByZero**: `ErrorValue` — Gets the ErrorValue representing the #DIV/0! error. -- **EmptyCellRangeIntersection**: `ErrorValue` — Gets the ErrorValue representing the #NULL! error. -- **InvalidCellReference**: `ErrorValue` — Gets the ErrorValue representing the #REF! error. -- **ValueRangeOverflow**: `ErrorValue` — Gets the ErrorValue representing the #NUM! error. -- **WrongFunctionName**: `ErrorValue` — Gets the ErrorValue representing the #NAME? error. -- **WrongOperandType**: `ErrorValue` — Gets the ErrorValue representing the #VALUE! error. -- **ToString**(): string — Gets the string representation of the error value. - -### [ExcelResourceCustomizer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ExcelResourceCustomizer) -Class used to provide the ability to customize resource strings. - -- **constructor**(): void -- **GetCustomizedString**(name: string): string — Gets the customized string identified by the specified string resource name. -- **ResetAllCustomizedStrings**(): void — Clears all strings customized by calls to method. -- **ResetCustomizedString**(name: string): void — Resets a customized string identified by the specified string resource name so that it will load from the resource file. -- **SetCustomizedString**(name: string, customizedText: string): void — Sets a customized string identified by the specified string resource name. - -### [FormattedFontBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FormattedFontBase) -Abstract base class which controls the formatting of a range of characters in a or . - -- **Bold**: `ExcelDefaultableBoolean` — Gets or sets the value indicating whether the font is bold. -- **ColorInfo**: `WorkbookColorInfo` — Gets or sets the fore color of the font. -- **Height**: `int` — Gets or sets the height of the font. -- **Italic**: `ExcelDefaultableBoolean` — Gets or sets the value indicating whether the font is italic. -- **Length**: `int` — Gets the number of characters covered by this font. Zero indicates the font controls from the to the end of the string. -- **Name**: `string` — Gets or sets the name of the font. -- **StartIndex**: `int` — Gets the index of the first character covered by this font. -- **Strikeout**: `ExcelDefaultableBoolean` — Gets or sets the value indicating whether the font is struck out. -- **SuperscriptSubscriptStyle**: `FontSuperscriptSubscriptStyle` — Gets or sets the value indicating whether the font is superscript or subscript. -- **UnderlineStyle**: `FontUnderlineStyle` — Gets or sets the underline style of the font. -- **SetFontFormatting**(source: IWorkbookFont): void — Sets all properties of this font to the properties of the specified font. - -### [FormattedString](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FormattedString) -Represents a string with mixed formatting in a cell or cell comment. - -- **constructor**(unformattedString: string): void -- **UnformattedString**: `string` — Gets or sets the unformatted string. -- **Clone**(): FormattedString — Creates a new that is a copy of this one. -- **Equals**(obj: object): bool — Determines whether the specified is equal to this . -- **GetFont**(startIndex: int): FormattedStringFont — Gets the font which controls the formatting properties in the string from the specified start index to the end of the string. -- **GetFont**(startIndex: int, length: int): FormattedStringFont — Gets the font which controls the formatting properties in the string from the specified start index for the specified number of characters. -- **GetFormattingRuns**(): IEnumerable — Gets the collection of formatting runs representing contiguous blocks of similar formatting starting at the beginning of the string. -- **GetHashCode**(): int — Calculates the has code for this . -- **ToString**(): string — Returns the that represents this . This is just the unformatted string. - -### [FormattedStringFont](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FormattedStringFont) -Controls the formatting of a range of characters in a . - -- **FormattedString**: `FormattedString` — Gets the formatted string which is controlled by this font. - -### [FormattedText](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FormattedText) -Represents text with multiple paragraphs and mixed formatting in a shape. - -- **constructor**(unformattedString: string): void -- **Paragraphs**: `FormattedTextParagraphCollection` — Gets the paragraphs in the formatted text. -- **VerticalAlignment**: `VerticalTextAlignment` — Gets or sets the vertical alignment of the formatted text in the owning shape. -- **Clone**(): FormattedText — Creates a new that is a copy of this one. -- **GetFont**(startIndex: int): FormattedTextFont — Gets the font which controls the formatting properties in the string from the specified start index to the end of the string. -- **GetFont**(startIndex: int, length: int): FormattedTextFont — Gets the font which controls the formatting properties in the string from the specified start index for the specified number of characters. -- **GetFormattingRuns**(): IEnumerable — Gets the collection of formatting runs representing contiguous blocks of similar formatting starting at the beginning of the string. -- **ToString**(): string — Returns the string that represents the , which is the unformatted string. - -### [FormattedTextFont](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FormattedTextFont) -Controls the formatting of a range of characters in . - -- **FormattedText**: `FormattedText` — Gets the which is controlled by this font. - -### [FormattedTextParagraph](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FormattedTextParagraph) -Represents a paragraph in . - -- **Alignment**: `HorizontalTextAlignment` — Gets or sets the alignment of the paragraph. -- **FormattedText**: `FormattedText` — Gets the owning to which the paragraph belongs or null if the paragraph has been removed from its owning formatted text. -- **StartIndex**: `int` — Gets the zero-based index of the paragraph's first character in the overall formatted text. -- **UnformattedString**: `string` — Gets or sets the raw string of the paragraph. - -### [FormattedTextParagraphCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FormattedTextParagraphCollection) -A collection of instances in . - -- **Count**: `int` — Gets the number of paragraphs in the collection. -- **this[int]**: `FormattedTextParagraph` — Gets the paragraph at the specified zero-based index. -- **Add**(paragraphText: string): FormattedTextParagraph — Adds a paragraph with the specified text and returns the representing the new paragraph. -- **Clear**(): void — Removes all paragraphs from the formatted text. -- **Contains**(paragraph: FormattedTextParagraph): bool — Determines whether the specified paragraph exists in the collection. -- **GetEnumerator**(): IEnumerator — Gets the enumerator to iterate over all paragraphs. -- **IndexOf**(paragraph: FormattedTextParagraph): int — Gets the zero-based index of the specified paragraph in the collection. -- **Insert**(index: int, paragraphText: string): FormattedTextParagraph — Inserts a paragraph with the specified text and returns the representing the new paragraph. -- **Remove**(paragraph: FormattedTextParagraph): bool — Removes the specified paragraph from the collection. -- **RemoveAt**(index: int): void — Removes the paragraph at the specified zero-based index in the collection. - -### [Formula](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/Formula) -Represents a formula for a cell or group of cells. - -- **ApplyTo**(cell: WorksheetCell): void — Applies the formula to the specified cell. -- **ApplyTo**(region: WorksheetRegion): void — Applies the formula to the specified region of cells. -- **ApplyTo**(regions: WorksheetRegion[]): void — Applies the formula to all specified regions of cells. -- **Equals**(formulaA: Formula, formulaB: Formula, cellReferenceMode: CellReferenceMode): bool — Determines whether two instances are equal using the specified cell reference mode. -- **Parse**(value: string, cellReferenceMode: CellReferenceMode): Formula — Parses the specified formula value and returns the formula which was created from it. -- **Parse**(value: string, cellReferenceMode: CellReferenceMode, fileFormat: WorkbookFormat): Formula — Parses the specified formula value and returns the formula which was created from it. -- **Parse**(value: string, cellReferenceMode: CellReferenceMode, fileFormat: WorkbookFormat, culture: CultureInfo): Formula — Parses the specified formula value and returns the formula which was created from it. -- **Parse**(value: string, cellReferenceMode: CellReferenceMode, culture: CultureInfo): Formula — Parses the specified formula value and returns the formula which was created from it. -- **ToString**(): string — Converts the formula to a string representation, similar to the string with which it was created. This uses the with which the formula was created to create cell reference strings. -- **ToString**(cellReferenceMode: CellReferenceMode): string — Converts the formula to a string representation, similar to the string with which it was created. -- **ToString**(cellReferenceMode: CellReferenceMode, culture: CultureInfo): string — Converts the formula to a string representation, similar to the string with which it was created. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, formula: Formula): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, formula: Formula, exception: FormulaParseException): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, fileFormat: WorkbookFormat, formula: Formula): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, fileFormat: WorkbookFormat, formula: Formula, exception: FormulaParseException): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, fileFormat: WorkbookFormat, culture: CultureInfo, formula: Formula): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, fileFormat: WorkbookFormat, culture: CultureInfo, formula: Formula, exception: FormulaParseException): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, culture: CultureInfo, formula: Formula): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. -- **TryParse**(value: string, cellReferenceMode: CellReferenceMode, culture: CultureInfo, formula: Formula, exception: FormulaParseException): bool — Parses the specified formula value. The return value indicates whether the operation succeeded. - -### [FormulaParseException](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FormulaParseException) -The exception thrown when a formula parse error occurs. - -- **constructor**(): void -- **constructor**(charIndexOfError: int, formulaValue: string, message: string, portionWithError: string): void -- **constructor**(message: string): void -- **constructor**(message: string, innerException: Exception): void -- **CharIndexOfError**: `int` — Gets the character index in the at which the parse error occurred. -- **FormulaValue**: `string` — Gets the formula string which had the error being parsed. -- **Message**: `string` — Gets the error message and the portion of the formula with the error. -- **PortionWithError**: `string` — Gets the portion of the formula which contains the error. - -### [FrozenPaneSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FrozenPaneSettings) -Class which controls the way frozen panes are arranged and used for a worksheet. - -- **FrozenColumns**: `int` — Gets or sets the number of columns frozen at the left of the worksheet. -- **FrozenRows**: `int` — Gets or sets the number of rows frozen at the top of the worksheet. -- **ResetCore**(): void — Resets the frozen pane settings to their defaults. - -### [HiddenColumnCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/HiddenColumnCollection) -A collection of hidden instances. - -- **Count**: `int` — Gets the number of columns in the collection. -- **this[int]**: `WorksheetColumn` — Gets the column at the specified index. -- **Worksheet**: `Worksheet` — Gets the worksheet associated with this collection. -- **Add**(column: WorksheetColumn): void — Adds a column to the collection. -- **Clear**(): void — Clears all columns from the collection. -- **Contains**(column: WorksheetColumn): bool — Determines whether the specified column exists in the collection. -- **Remove**(column: WorksheetColumn): bool — Removes the specified column from the collection if it exists. -- **RemoveAt**(index: int): void — Removes the column at the specified index in the collection. - -### [HiddenRowCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/HiddenRowCollection) -A collection of hidden instances. - -- **Count**: `int` — Gets the number of rows in the collection. -- **this[int]**: `WorksheetRow` — Gets the row at the specified index. -- **Worksheet**: `Worksheet` — Gets the worksheet associated with this collection. -- **Add**(row: WorksheetRow): void — Adds a row to the collection. -- **Clear**(): void — Clears all rows from the collection. -- **Contains**(row: WorksheetRow): bool — Determines whether the specified row exists in the collection. -- **Remove**(row: WorksheetRow): bool — Removes the specified row from the collection if it exists. -- **RemoveAt**(index: int): void — Removes the row at the specified index in the collection. - -### [HorizontalPageBreak](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/HorizontalPageBreak) -Represents a horizontal page break in a . - -- **constructor**(firstRowOnPage: int): void -- **constructor**(firstRowOnPage: int, printArea: WorksheetRegion): void -- **FirstRowOnPage**: `int` — Gets the 0-based index of the first row on the page after this break. - -### [HorizontalPageBreakCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/HorizontalPageBreakCollection) -A collection of horizontal page breaks on a . - - -### [LimitedValueDataValidationRule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/LimitedValueDataValidationRule) -Base class for all data validations rules which prevent certain values form being applied to a cell. - -- **AllowNull**: `bool` — Gets or sets the value which indicates whether a null, or blank, value is allowed to be set on a cell. -- **IsEquivalentTo**(other: DataValidationRule): bool — Indicates if this rule is structurally equivalent to another. - -### [ListDataValidationRule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ListDataValidationRule) -Represents a data validation rule which allows a value from a list of accepted values to be applied to a cell. - -- **constructor**(): void -- **ShowDropdown**: `bool` — Gets or sets the value which indicates whether a drop down should be displayed in Microsoft Excel with the list of accepted values. -- **GetValuesFormula**(address: string): string — Gets the formula which specifies the accepted values. -- **GetValuesFormula**(address: string, format: WorkbookFormat, cellReferenceMode: CellReferenceMode, culture: CultureInfo): string — Gets the formula which specifies the accepted values. -- **IsEquivalentTo**(other: DataValidationRule): bool — Indicates if this rule is structurally equivalent to another. -- **SetValues**(values: object[]): void — Sets the list of accepted values the cell can accept. -- **SetValuesFormula**(valuesFormula: string, address: string): void — Sets the formula which specifies the accepted values. -- **SetValuesFormula**(valuesFormula: string, address: string, format: WorkbookFormat, cellReferenceMode: CellReferenceMode, culture: CultureInfo): void — Sets the formula which specifies the accepted values. -- **TryGetValues**(values: object[]): bool — Tries to obtain the value of the constraint. - -### [NamedReference](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/NamedReference) -Represents a named reference defined in the workbook. - -- **Formula**: `string` — Gets the formula which defines the named reference. -- **IsSimpleReferenceFormula**: `bool` — Gets the value indicating whether the is a simple formula referring to a single cell, a single region, or multiple regions in the same workbook as the named reference. -- **ReferencedCell**: `WorksheetCell` — Gets the referenced by the . -- **ReferencedRegion**: `WorksheetRegion` — Gets the referenced by the . -- **ReferencedRegions**: `WorksheetRegion[]` — Gets the array of instances referenced by the . -- **SetFormula**(formula: string): void — Sets the formula for a named reference. -- **SetFormula**(formula: string, cellReferenceMode: CellReferenceMode): void — Sets the formula for a named reference. -- **SetFormula**(formula: string, cellReferenceMode: CellReferenceMode, culture: CultureInfo): void — Sets the formula for a named reference. -- **ToString**(): string — Gets the string representation of the named reference. - -### [NamedReferenceBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/NamedReferenceBase) -Abstract base class for a named reference defined in the workbook. - -- **Comment**: `string` — Gets or sets the comment associated with the named reference or table. -- **Name**: `string` — Gets or sets the name of the reference. -- **Scope**: `object` — Gets the scope of the named reference. - -### [NamedReferenceCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/NamedReferenceCollection) -A collection of instances in a workbook. - -- **Count**: `int` — Gets the number of named references in the collection. -- **this[int]**: `NamedReference` — Gets the named reference at the specified index. -- **Workbook**: `Workbook` — Gets the workbook associated with this collection. -- **Add**(name: string, formula: string): NamedReference — Adds a named reference with a scope of the collection's associated to the collection. -- **Add**(name: string, formula: string, cellReferenceMode: CellReferenceMode): NamedReference — Adds a named reference with a scope of the collection's associated to the collection. -- **Add**(name: string, formula: string, cellReferenceMode: CellReferenceMode, worksheet: Worksheet): NamedReference — Adds a named reference with a scope of a worksheet to the collection. -- **Add**(name: string, formula: string, worksheet: Worksheet): NamedReference — Adds a named reference with a scope of a worksheet to the collection. -- **Clear**(): void — Clears all named references from the collection. -- **Contains**(namedReference: NamedReference): bool — Determines whether a named reference is in the collection. -- **Find**(name: string): NamedReference — Finds a named reference in the collection with a scope of the collection's associated . -- **Find**(name: string, worksheetScope: Worksheet): NamedReference — Finds a named reference in the collection with a scope of the specified worksheet. -- **FindAll**(name: string): NamedReference[] — Finds all named references in the collection with the specified name. -- **Remove**(namedReference: NamedReference): bool — Removes the specified named reference from the collection. -- **RemoveAt**(index: int): void — Removes the named reference at the specified index in the collection. - -### [OneConstraintDataValidationRule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/OneConstraintDataValidationRule) -Represents a data validation rule which can validate the cell value against a single constraint value or formula. - -- **constructor**(): void -- **constructor**(validationOperator: OneConstraintDataValidationOperator, validationCriteria: DataValidationCriteria): void -- **ValidationOperator**: `OneConstraintDataValidationOperator` — Gets or sets the validation operator to use when comparing the cell value against the constraint value or formula. -- **GetConstraintFormula**(address: string): string — Gets the constraint formula used to validate the cell value. -- **GetConstraintFormula**(address: string, format: WorkbookFormat, cellReferenceMode: CellReferenceMode, culture: CultureInfo): string — Gets the constraint formula used to validate the cell value. -- **IsEquivalentTo**(other: DataValidationRule): bool — Indicates if this rule is structurally equivalent to another. -- **SetConstraint**(value: DateTime): void — Sets the constraint value used to validate the cell value. -- **SetConstraint**(value: double): void — Sets the constraint value used to validate the cell value. -- **SetConstraint**(value: TimeSpan): void — Sets the constraint value used to validate the cell value. -- **SetConstraintFormula**(constraintFormula: string, address: string): void — Sets the constraint formula used to validate the cell value. -- **SetConstraintFormula**(constraintFormula: string, address: string, format: WorkbookFormat, cellReferenceMode: CellReferenceMode, culture: CultureInfo): void — Sets the constraint formula used to validate the cell value. -- **TryGetConstraint**(value: DateTime): bool — Tries to obtain the value of the constraint. -- **TryGetConstraint**(value: double): bool — Tries to obtain the value of the constraint. -- **TryGetConstraint**(value: TimeSpan): bool — Tries to obtain the value of the constraint. - -### [PageBreak](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/PageBreak) -Base class for horizontal and vertical page breaks in a . - -- **PrintArea**: `WorksheetRegion` — Gets the print area in which the page break occurs. -- **Equals**(obj: object): bool — Determines whether this is equal to the specified object. -- **GetHashCode**(): int — Gets the hash code for the . - -### [PageBreakCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/PageBreakCollection) -Base class for the collections of horizontal and vertical page breaks on a . - -- **Count**: `int` — Gets the number of page breaks in this collection. -- **this[int]**: `T` — Gets the page break at the specified index. -- **Add**(pageBreak: T): void — Adds a page break to the . -- **Clear**(): void — Clears the collection of page breaks. -- **Contains**(pageBreak: T): bool — Determines whether the specified page break exists on the . -- **IndexOf**(pageBreak: T): int — Gets the 0-based index of the specified page break. -- **Remove**(pageBreak: T): bool — Removes the specified page break from the . -- **RemoveAt**(index: int): void — Removes the page break at the specified index. - -### [PaneSettingsBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/PaneSettingsBase) -Abstract base class for classes which control pane settings. - -- **FirstColumnInRightPane**: `int` — Gets or sets the first visible column in the right pane(s) of the worksheet. -- **FirstRowInBottomPane**: `int` — Gets or sets the first visible row in the bottom pane(s) of the worksheet. -- **Reset**(): void — Resets the pane settings to their defaults. -- **ResetCore**(): void — Resets the pane settings to their defaults. - -### [PrintAreasCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/PrintAreasCollection) -Gets the collection of print areas in a or a worksheet's print settings in a . - -- **Count**: `int` — Gets the number of print areas in the collection. -- **this[int]**: `WorksheetRegion` — Gets the print area at the specified index. -- **Add**(printArea: WorksheetRegion): void — Adds a print area to the collection. -- **Clear**(): void — Clears all print areas from the collection. -- **Contains**(printArea: WorksheetRegion): bool — Determines whether the specified print area is in the collection. -- **Remove**(printArea: WorksheetRegion): bool — Removes the specified print area from the collection. -- **RemoveAt**(index: int): void — Removes the print area at the specified index from the collection. - -### [PrintOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/PrintOptions) -Class which exposes the various print options available for a worksheet which can be saved with both a worksheet and a custom view. - -- **CenterHorizontally**: `bool` — Gets or sets the value indicating whether the printed pages should be centered horizontally. -- **CenterVertically**: `bool` — Gets or sets the value indicating whether the printed pages should be centered vertically. -- **ColumnsToRepeatAtLeft**: `RepeatTitleRange` — Gets or sets the range of columns which should be printed on every page. -- **HorizontalPageBreaks**: `HorizontalPageBreakCollection` — Gets the collection of horizontal page breaks in the . -- **MaxPagesHorizontally**: `int` — Gets or sets the maximum number of pages allowed in the horizontal direction to print the worksheet. -- **MaxPagesVertically**: `int` — Gets or sets the maximum number of pages allowed in the vertical direction to print the worksheet. -- **PageOrder**: `PageOrder` — Gets or sets the order in which to print pages for multiple page worksheets. -- **PrintAreas**: `PrintAreasCollection` — Gets the collection of print areas in the . -- **PrintGridlines**: `bool` — Gets or sets the value which indicates whether to print the worksheet gridlines. -- **PrintRowAndColumnHeaders**: `bool` — Gets or sets the value indicating whether to print row and column headers. -- **RowsToRepeatAtTop**: `RepeatTitleRange` — Gets or sets the range of rows which should be printed on every page. -- **ScalingFactor**: `int` — Gets or sets the scaling factor to use when printing the worksheet. -- **ScalingType**: `ScalingType` — Gets or sets the method for scaling the worksheet when it is printed. -- **VerticalPageBreaks**: `VerticalPageBreakCollection` — Gets the collection of vertical page breaks in the . -- **ClearPageBreaks**(): void — Clears all page breaks from the . -- **InsertPageBreak**(cell: WorksheetCell): void — Inserts a horizontal and/or vertical page break before the specified cell. -- **InsertPageBreak**(column: WorksheetColumn): void — Inserts a vertical page break to the left of the specified column. -- **InsertPageBreak**(row: WorksheetRow): void — Inserts a horizontal page break above the specified row. -- **Reset**(): void — Resets the print options to their default settings. - -### [PrintOptionsBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/PrintOptionsBase) -Base class which exposes the various print options available for a sheet which can be saved with both a sheet and its custom view. - -- **AlignHeadersAndFootersWithMargins**: `bool` — Gets or sets the value indicating whether to align header and footer margins with page margins. -- **BottomMargin**: `double` — Gets or sets the margin at the bottom of each printed page of the worksheet, specified in inches. -- **DraftQuality**: `bool` — Gets or sets the value indicating whether the printed pages should be printed using draft quality. -- **Footer**: `string` — Gets or sets the footer for each page of the printed worksheet. -- **FooterMargin**: `double` — Gets or sets the footer margin for each printed page of the worksheet, specified in inches. -- **Header**: `string` — Gets or sets the header for each page of the printed worksheet. -- **HeaderMargin**: `double` — Gets or sets the header margin for each printed page of the worksheet, specified in inches. -- **LeftMargin**: `double` — Gets or sets the margin at the left of each printed page of the worksheet, specified in inches. -- **NumberOfCopies**: `int` — Gets or sets the number of copies to print. -- **Orientation**: `Orientation` — Gets or sets the orientation for each page of the printed worksheet. -- **OrientationResolved**: `Orientation` — Returns the resolved orientation for each page of the printed worksheet. -- **PageNumbering**: `PageNumbering` — Gets or sets the method with which pages are numbered. -- **PaperSize**: `PaperSize` — Gets or sets the paper size for each printed page of the worksheet. -- **PrintErrors**: `PrintErrors` — Gets or sets the way error values of cells are printed. -- **PrintInBlackAndWhite**: `bool` — Gets or sets the value indicating whether the worksheet should be printed in black and white. -- **PrintNotes**: `PrintNotes` — Gets or sets the way cell comments are printed. -- **Resolution**: `int` — Gets or sets the horizontal print resolution in DPI. -- **RightMargin**: `double` — Gets or sets the margin at the right of each printed page of the worksheet, specified in inches. -- **ScaleHeadersAndFootersWithDocument**: `bool` — Gets or sets the value indicating whether to scale the headers and footers with the document scaling. -- **StartPageNumber**: `int` — Gets or sets the page number for the first printed page of the worksheet. -- **TopMargin**: `double` — Gets or sets the margin at the top of each printed page of the worksheet, specified in inches. -- **VerticalResolution**: `int` — Gets or sets the vertical print resolution in DPI. -- **Reset**(): void — Resets the print options to their default settings. - -### [RelativeIndex](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/RelativeIndex) -Represents an index relative to a region - -- **constructor**(index: int): void -- **Index**: `int` — Returns the relative index (read only) -- **CompareTo**(obj: RelativeIndex): int — Compares this instance of a to another. -- **Equals**(obj: object): bool — Checks for equality -- **GetHashCode**(): int — Calculates a number suitable for hasing -- **ToString**(): string — Returns the Index.ToString() - -### [RepeatTitleRange](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/RepeatTitleRange) -Represents a range of contiguous rows or columns which should be repeated at the top or left or printed pages of the . - -- **constructor**(startIndex: int, endIndex: int): void -- **EndIndex**: `int` — Gets the index of the last row or column in the range. -- **StartIndex**: `int` — Gets the index of the first row or column in the range. -- **Equals**(obj: object): bool — Determines whether the specified value equals this . -- **GetHashCode**(): int — Gtes the hash code for the . -- **ToString**(): string — Gets the string representation of the range. - -### [RowColumnBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/RowColumnBase) -Abstract base class for worksheet row and worksheet column. - -- **CellFormat**: `IWorksheetCellFormat` — Gets the default cell format for cells in this row or column. -- **Hidden**: `bool` — Gets or sets the value indicating whether the row or column is hidden. -- **Index**: `int` — Gets the 0-based index of the row or column in the worksheet. -- **OutlineLevel**: `int` — Gets or sets the outline level for the row or column. -- **Worksheet**: `Worksheet` — Gets the worksheet to which the row or column belongs. -- **GetResolvedCellFormat**(): IWorksheetCellFormat — Gets the resolved cell formatting for the cells in the row or column. - -### [RowColumnCollectionBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/RowColumnCollectionBase) -Base class for row collection and column collection. - - -### [ShapeFill](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ShapeFill) -Abstract base class for the fill of a shape. - -- **constructor**(): void -- **FromColor**(solidColor: Color): ShapeFill — Creates an instance to describe a solid fill outline. -- **FromColorInfo**(solidColorInfo: WorkbookColorInfo): ShapeFill — Creates an instance to describe a solid fill outline. - -### [ShapeFillSolid](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ShapeFillSolid) -Represents a shape fill with a solid color. - -- **constructor**(): void -- **constructor**(color: Color): void -- **constructor**(colorInfo: WorkbookColorInfo): void -- **ColorInfo**: `WorkbookColorInfo` — Gets or sets the describing the color of the fill. - -### [ShapeOutline](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ShapeOutline) -Abstract base class for the outline of a shape. - -- **constructor**(): void -- **FromColor**(solidColor: Color): ShapeOutline — Creates an instance to describe a solid color outline. -- **FromColorInfo**(solidColorInfo: WorkbookColorInfo): ShapeOutline — Creates an instance to describe a solid color outline. - -### [ShapeOutlineSolid](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ShapeOutlineSolid) -Represents a shape outline with a solid color. - -- **constructor**(): void -- **constructor**(color: Color): void -- **constructor**(colorInfo: WorkbookColorInfo): void -- **ColorInfo**: `WorkbookColorInfo` — Gets or sets the describing the color of the outline. - -### [Sheet](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/Sheet) -Base class for a sheet in a Microsoft Excel workbook. - -- **HasProtectionPassword**: `bool` — Returns a boolean indicating if the Sheet has been protected with a password. -- **IsProtected**: `bool` — Returns a boolean indicating if the Worksheet has been protected. -- **Name**: `string` — Gets or sets the sheet name. -- **Selected**: `bool` — Gets the value which indicates whether this worksheet is selected. -- **SheetIndex**: `int` — Gets the zero-based index of this sheet in its parent collection. -- **TabColorInfo**: `WorkbookColorInfo` — Gets or sets the to use for the associated sheet's tab in the tab bar of Microsoft Excel. -- **Type**: `SheetType` — Returns a value indicating the type of sheet -- **Workbook**: `Workbook` — Gets the that owns the worksheet. -- **MoveToSheetIndex**(index: int): void — Moves the sheet to a new position in the owning workbook's collections of sheets. -- **Unprotect**(): void — Removes the Sheet protection. -- **Unprotect**(password: SecureString): void — Attempts to use the specified password to remove the Sheet protection currently in place. -- **Unprotect**(password: string): void — Attempts to use the specified password to remove the WorkSheet protection currently in place. - -### [SheetCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/SheetCollection) -A collection of sheets in a workbook. - -- **Count**: `int` — Gets the number of sheets in the collection. -- **this[int]**: `Sheet` — Gets the sheet at the specified index. -- **this[string]**: `Sheet` — Gets the sheet with the specified name. -- **Add**(name: string, type: SheetType): Sheet — Creates a new and adds it to the collection. -- **Clear**(): void — Clears all sheets from the collection. -- **Contains**(sheet: Sheet): bool — Determines whether a sheet is in the collection. -- **Exists**(name: string): bool — Determines whether a sheet with the specified name exists in the collection. -- **IndexOf**(sheet: Sheet): int — Gets the index of the specified sheet in the collection. -- **Remove**(sheet: Sheet): bool — Removes the specified sheet from the collection. -- **RemoveAt**(index: int): void — Removes the sheet at the specified index from the collection. - -### [SheetProtection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/SheetProtection) -Provides information about the types of changes that are disabled when the associated Sheet is protected. - - -### [StandardTableStyleCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/StandardTableStyleCollection) -A collection of standard instances which can be applied to a in a . - -- **Count**: `int` — Gets the number of custom instances in the collection. -- **this[int]**: `WorksheetTableStyle` — Gets the at the specified index. -- **this[string]**: `WorksheetTableStyle` — Gets the with the specified name. - -### [TwoConstraintDataValidationRule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/TwoConstraintDataValidationRule) -Represents a data validation rule which can validate the cell value against two constraint values or formulas. - -- **constructor**(): void -- **constructor**(validationOperator: TwoConstraintDataValidationOperator, validationCriteria: DataValidationCriteria): void -- **ValidationOperator**: `TwoConstraintDataValidationOperator` — Gets or sets the validation operator to use when comparing the cell value against the constraint values or formulas. -- **GetLowerConstraintFormula**(address: string): string — Gets the lower constraint formula used to validate the cell value. -- **GetLowerConstraintFormula**(address: string, format: WorkbookFormat, cellReferenceMode: CellReferenceMode, culture: CultureInfo): string — Gets the lower constraint formula used to validate the cell value. -- **GetUpperConstraintFormula**(address: string): string — Gets the upper constraint formula used to validate the cell value. -- **GetUpperConstraintFormula**(address: string, format: WorkbookFormat, cellReferenceMode: CellReferenceMode, culture: CultureInfo): string — Gets the upper constraint formula used to validate the cell value. -- **IsEquivalentTo**(other: DataValidationRule): bool — Indicates if this rule is structurally equivalent to another. -- **SetLowerConstraint**(value: DateTime): void — Sets the lower constraint value used to validate the cell value. -- **SetLowerConstraint**(value: double): void — Sets the lower constraint value used to validate the cell value. -- **SetLowerConstraint**(value: TimeSpan): void — Sets the lower constraint value used to validate the cell value. -- **SetLowerConstraintFormula**(lowerConstraintFormula: string, address: string): void — Gets the lower constraint formula used to validate the cell value. -- **SetLowerConstraintFormula**(lowerConstraintFormula: string, address: string, format: WorkbookFormat, cellReferenceMode: CellReferenceMode, culture: CultureInfo): void — Gets the lower constraint formula used to validate the cell value. -- **SetUpperConstraint**(value: DateTime): void — Sets the upper constraint value used to validate the cell value. -- **SetUpperConstraint**(value: double): void — Sets the upper constraint value used to validate the cell value. -- **SetUpperConstraint**(value: TimeSpan): void — Sets the upper constraint value used to validate the cell value. -- **SetUpperConstraintFormula**(upperConstraintFormula: string, address: string): void — Gets the upper constraint formula used to validate the cell value. -- **SetUpperConstraintFormula**(upperConstraintFormula: string, address: string, format: WorkbookFormat, cellReferenceMode: CellReferenceMode, culture: CultureInfo): void — Gets the upper constraint formula used to validate the cell value. -- **TryGetLowerConstraint**(value: DateTime): bool — Tries to obtain the value of the lower constraint. -- **TryGetLowerConstraint**(value: double): bool — Tries to obtain the value of the lower constraint. -- **TryGetLowerConstraint**(value: TimeSpan): bool — Tries to obtain the value of the lower constraint. -- **TryGetUpperConstraint**(value: DateTime): bool — Tries to obtain the value of the upper constraint. -- **TryGetUpperConstraint**(value: double): bool — Tries to obtain the value of the upper constraint. -- **TryGetUpperConstraint**(value: TimeSpan): bool — Tries to obtain the value of the upper constraint. - -### [UnfrozenPaneSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/UnfrozenPaneSettings) -Class which controls the way unfrozen panes are arranged and used for a worksheet. - -- **FirstColumnInLeftPane**: `int` — Gets or sets the first visible column in the left pane(s) of the worksheet. -- **FirstRowInTopPane**: `int` — Gets or sets the first visible row in the top pane(s) of the worksheet. -- **LeftPaneWidth**: `int` — Gets or sets the width of the left pane in twips (1/20th of a point). -- **TopPaneHeight**: `int` — Gets or sets the height of the top pane in twips (1/20th of a point). -- **ResetCore**(): void — Resets the unfrozen pane settings to their defaults. - -### [UnknownShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/UnknownShape) -Represents an unsupported shape which has been loaded from a workbook file. - -- **ClearUnknownData**(): void — Throws an exception because all data in an unknown shape is unknown, and clearing that data would leave no data with the shape. - -### [ValueConstraintDataValidationRule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ValueConstraintDataValidationRule) -Base class for all data validations rules which compare the cell value against one or more constraint when determining the validity of the cell value. - -- **ValidationCriteria**: `DataValidationCriteria` — Gets or sets the criteria to use when validating the cell value against the constraint(s). -- **IsEquivalentTo**(other: DataValidationRule): bool — Indicates if this rule is structurally equivalent to another. - -### [VerticalPageBreak](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/VerticalPageBreak) -Represents a vertical page break in a . - -- **constructor**(firstColumOnPage: int): void -- **constructor**(firstColumOnPage: int, printArea: WorksheetRegion): void -- **FirstColumnOnPage**: `int` — Gets the 0-based index of the first column on the page after this break. - -### [VerticalPageBreakCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/VerticalPageBreakCollection) -A collection of horizontal page breaks on a . - - -### [WindowOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WindowOptions) -Abstract base class which exposes the various workbook window options available which can be saved with both a workbook and a custom view. - -- **ObjectDisplayStyle**: `ObjectDisplayStyle` — Gets or sets the way the objects and shapes are displayed in the workbook. -- **ScrollBars**: `ScrollBars` — Gets or sets the scroll bars shown in the workbook window. -- **SelectedSheet**: `Sheet` — Gets or sets the selected worksheet of the workbook. -- **SelectedWorksheet**: `Worksheet` — Gets or sets the selected worksheet of the workbook. -- **TabBarVisible**: `bool` — Gets or sets the value indicating whether the worksheet tab bar is visible. -- **TabBarWidth**: `int` — Gets or sets the width of the worksheet tab bar, expressed in 1/1000ths of the application width. -- **Reset**(): void — Resets the window options to their default settings. - -### [Workbook](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/Workbook) -Represents a Microsoft Excel workbook. - -- **constructor**(): void -- **constructor**(format: WorkbookFormat): void -- **CalculationMode**: `CalculationMode` — Gets or sets the value which indicates how a formula will be recalculated when a referenced value changes. -- **CellReferenceMode**: `CellReferenceMode` — Gets or sets the value which indicates the way cells in the workbook are referenced. -- **Culture**: `CultureInfo` — Gets or sets the culture to use as the current culture for the workbook when doing any culture-aware conversions or comparisons. -- **CurrentFormat**: `WorkbookFormat` — Gets the current format of the workbook. This is the format which will be used when saving and imposing format restrictions. -- **CustomTableStyles**: `CustomTableStyleCollection` — Gets the collection of custom table styles in the workbook. -- **CustomViews**: `CustomViewCollection` — Gets the collection of custom views for the workbook. -- **DateSystem**: `DateSystem` — Gets or sets the date system used internally by Microsoft Excel. -- **DefaultTableStyle**: `WorksheetTableStyle` — Gets or sets the default style for tables in the workbook. -- **DocumentProperties**: `DocumentProperties` — Gets the properties associated with the workbook document. -- **EditingCulture**: `CultureInfo` — The editing culture affects certain language specific features such as formatting of dates. or comparisons. -- **FileWriteProtectedBy**: `string` — Gets the name of the user who initially added file write protection to the document. -- **HasFileWriteProtectionPassword**: `bool` — Gets the value indicating whether the has a file write protection password that will be used to protect saved files or streams. -- **HasOpenPassword**: `bool` — Gets the value indicating whether the has an open password and will therefore be encrypted on subsequent saves. -- **HasProtectionPassword**: `bool` — Returns a boolean indicating if the Workbook has been protected with a password. -- **InProcessRuntime**: `IJSInProcessRuntime` — Provides the in process runtime that the workbook can use to perform operations in javascript. -- **IsFileWriteProtected**: `bool` — Gets the value indicating whether the was loaded with file write protection and the correct password has not yet been provided to ValidateFileWriteProtectionPassword. -- **IsProtected**: `bool` — Returns a boolean indicating if the Workbook has been protected. -- **IterativeCalculationsEnabled**: `bool` — Gets or sets the value which indicates whether iterations are allowed while calculating formulas containing circular references. -- **MaxChangeInIteration**: `double` — Gets or sets the maximum change of the values in a formula between iterations which will exit from iteration. -- **MaxColumnCount**: `int` — Gets the maximum number of columns allowed in each worksheet based on the . -- **MaxExcel2007CellFormatCount**: `int` — Maximum number of distinct cell formats in the workbook allowed by the Excel 2007 file format. -- **MaxExcel2007ColumnCount**: `int` — Maximum number of columns in the worksheet allowed by the Excel 2007 file format. -- **MaxExcel2007RowCount**: `int` — Maximum number of rows in the worksheet allowed by the Excel 2007 file format. -- **MaxExcelCellFormatCount**: `int` — Maximum number of distinct cell formats in the workbook allowed by the Excel 97-2003 file format. -- **MaxExcelColumnCount**: `int` — Maximum number of columns in the worksheet allowed by the Excel 97-2003 file format. -- **MaxExcelRowCount**: `int` — Maximum number of rows in the worksheet allowed by the Excel 97-2003 file format. -- **MaxExcelWorkbookFonts**: `int` — Maximum number fonts in a workbook allowed by Excel. -- **MaxRecursionIterations**: `int` — Gets or sets the maximum number of times formulas should be iteratively calculated. -- **MaxRowCount**: `int` — Gets the maximum number of rows allowed in each worksheet based on the . -- **NamedReferences**: `NamedReferenceCollection` — Gets the collection of named references in the workbook. -- **Palette**: `WorkbookColorPalette` — Gets the color palette used when the saved file is opened in Microsoft Excel 2003 and earlier versions. -- **Precision**: `Precision` — Gets or sets the precision to use when obtaining a cell's value. -- **Protected**: `bool` — Gets or sets the value which indicates whether the workbook is protected. -- **Protection**: `WorkbookProtection` — Returns an object that provides information used when the Workbook has been protected. -- **RecalculateBeforeSave**: `bool` — Gets or sets the value which indicates whether the workbook should recalculate all formulas before saving. -- **SaveExternalLinkedValues**: `bool` — Gets or sets the value which indicates whether to save values linked from external workbooks. -- **ScreenDpi**: `Size` — Gets or sets the Dpi to use when calculating row and column sizes for the workbook. If empty, the system Dpi will be used. -- **Sheets**: `SheetCollection` — Gets the collection of sheets in the workbook. -- **ShouldRemoveCarriageReturnsOnSave**: `bool` — Gets or sets the value which indicates whether carriage return characters should be removed from string values in cells when the workbook is saved to an Excel file. -- **StandardTableStyles**: `StandardTableStyleCollection` — Gets the read-only collection of preset table styles in the workbook. -- **Styles**: `WorkbookStyleCollection` — Gets the collection of custom styles in the workbook. -- **SystemDpi**: `Size` — Gets or sets the default Dpi to use when calculating row and column sizes for the workbook. If empty, the resolved system Dpi will be used. -- **ValidateFormatStrings**: `bool` — Gets or sets the value indicating whether the format strings should be validated when they are set. -- **WindowOptions**: `WorkbookWindowOptions` — Gets the options which control various workbook level display properties. -- **Worksheets**: `WorksheetCollection` — Gets the collection of worksheets in the workbook. -- **CharacterWidth256thsToPixels**(characterWidth256ths: double): double — Converts units of 1/256s of the average character width to pixels. -- **ClearConnectionData**(): void — Clears all external data connections from the . -- **ClearPivotTableData**(): void — Clears all pivot tables and associated slicers from the . -- **ClearVbaData**(): void — Clears all vba information from the . -- **CreateNewWorkbookFont**(): IWorkbookFont — Factory method which creates new workbook font. -- **CreateNewWorksheetCellFormat**(): IWorksheetCellFormat — Creates new worksheet cell format. -- **GetMaxColumnCount**(format: WorkbookFormat): int — Returns the number of columns that are supported by the specified format. -- **GetMaxRowCount**(format: WorkbookFormat): int — Returns the number of rows that are supported by the specified format. -- **GetTable**(name: string): WorksheetTable — Gets the table with the specified name. -- **GetWorkbookFormat**(fileName: string): WorkbookFormat? — Returns the WorkbookFormat based on the file extension of the specified file. -- **IsValidFunctionName**(functionName: string): bool — Gets a value indicating whether the specified function will be recognized and solved by Microsoft Excel when the workbook is saved out. -- **IsWorkbookEncrypted**(stream: Stream): bool — Determines whether the workbook in the specified stream is encrypted with an open password. -- **Load**(stream: Stream, loadOptions: WorkbookLoadOptions): Workbook — Reads a workbook from a stream. -- **PixelsToCharacterWidth256ths**(pixels: double): double — Converts pixels to units of 1/256s of the average character width. -- **Protect**(allowEditStructure: bool, allowEditWindows: bool): void — Protects the Workbook without a password. -- **Protect**(password: SecureString, allowEditStructure: bool, allowEditWindows: bool): void — Protects the worksheet with the specified password. -- **Protect**(password: string, allowEditStructure: bool, allowEditWindows: bool): void — Protects the worksheet with the specified password. -- **Recalculate**(): void — Recalculates all dirty formulas pending a calculation on the workbook. -- **Recalculate**(includeNonDirtyFormulas: bool): void — Recalculates all formulas on the workbook. -- **RegisterUserDefinedFunction**(userDefinedFunction: ExcelCalcFunction): bool — Registers a single instance. -- **RegisterUserDefinedFunctionLibrary**(assembly: Assembly): bool — Registers an assembly containing derived types. -- **ResumeCalculations**(): void — Resumes the calculation of formulas. -- **Save**(stream: Stream, packageFactory: IPackageFactory): void — Writes the workbook to a stream. -- **Save**(stream: Stream, saveOptions: WorkbookSaveOptions): void — Writes the workbook to a stream. -- **SetCurrentFormat**(format: WorkbookFormat): void — Sets the current format of the workbook. -- **SetEncryptionMode**(encryptionMode: WorkbookEncryptionMode): void — Sets the encryption modes to use to encrypt documents saved in the 2007 file formats and later. -- **SetFileWriteProtectionPassword**(password: SecureString, userName: string): void — Sets the password used to protect the file from automatic writes. -- **SetFileWriteProtectionPassword**(password: string, userName: string): void — Sets the password used to protect the file from automatic writes. -- **SetOpenPassword**(password: SecureString): void — Sets the password used to encrypt the document on subsequent saves. -- **SetOpenPassword**(password: string): void — Sets the password used to encrypt the document on subsequent saves. -- **SuspendCalculations**(): void — Temporarily suspends the calculation of formulas. -- **Unprotect**(): void — Removes the Workbook protection. -- **Unprotect**(password: SecureString): void — Attempts to use the specified password to remove the Worksheet protection currently in place. -- **Unprotect**(password: string): void — Attempts to use the specified password to remove the Worksheet protection currently in place. -- **ValidateFileWriteProtectionPassword**(password: SecureString): bool — Validates the password for a loaded with file write protection. and returns the value indicating whether the protection was successfully disabled. -- **ValidateFileWriteProtectionPassword**(password: string): bool — Validates the password for a loaded with file write protection. and returns the value indicating whether the protection was successfully disabled. - -### [WorkbookColorInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorkbookColorInfo) -An immutable object which represents a color in a Microsoft Excel workbook. - -- **constructor**(color: Color): void -- **constructor**(color: Color, transform: WorkbookColorTransform): void -- **constructor**(color: Color, tint: double): void -- **constructor**(themeColorType: WorkbookThemeColorType): void -- **constructor**(themeColorType: WorkbookThemeColorType, transform: WorkbookColorTransform): void -- **constructor**(themeColorType: WorkbookThemeColorType, tint: double): void -- **Automatic**: `WorkbookColorInfo` — Gets the automatic color, which is the window text system color. -- **Color**: `Color?` — Gets the base color associated of the . -- **IsAutomatic**: `bool` — Gets the value which indicates whether the is automatic, or the window text system color. -- **ThemeColorType**: `WorkbookThemeColorType?` — Gets the base theme color associated of the . -- **Tint**: `double?` — Gets the to apply to the base color, from -1.0 (100% darken) to 1.0 (100% lighten). -- **Transform**: `WorkbookColorTransform` — Returns the associated , or null if this instance is not associated with a transform. -- **Equals**(obj: object): bool — Determines whether the is equal to the specified object. -- **GetHashCode**(): int — Gets the hash code for the . -- **GetResolvedColor**(): Color — Gets the actual color which will be seen in Microsoft Excel if the is used. -- **GetResolvedColor**(workbook: Workbook): Color — Gets the actual color which will be seen in Microsoft Excel if the is used. -- **ToString**(): string — Gets the string representation of the . - -### [WorkbookColorPalette](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorkbookColorPalette) -Represents the color palette used when the saved file is opened in Microsoft Excel 2003 and earlier versions. - -- **Count**: `int` — Gets the number of colors in the palette, which is always 56. -- **IsCustom**: `bool` — Gets the value which indicates whether the palette has been cusotmized. -- **this[int]**: `Color` — Gets or sets a color in the palette. -- **Contains**(color: Color): bool — Determines whether the specified color is in the color palette. -- **GetIndexOfNearestColor**(color: Color): int — Gets the index of the closest color in the color palette, which will be seen when the file is opened in Microsoft Excel 2003 and older versions. -- **Reset**(): void — Resets the palette back to the default colors for Microsoft Excel. - -### [WorkbookColorTransform](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorkbookColorTransform) -Defines color transforms for a instance. - -- **constructor**(alpha: double?, luminanceModulation: double?, luminanceOffset: double?, shade: double?): void -- **Alpha**: `double?` — Defines the value of the alpha channel for the associated instance, expressed as a number between 0 and 1. -- **LuminanceModulation**: `double?` — Defines the luminance modulation for the associated instance, expressed as a fractional number. -- **LuminanceOffset**: `double?` — Defines the luminance offset for the associated instance, expressed as a fractional number. -- **Shade**: `double?` — Defines the shading for the associated instance, expressed as a fractional number. - -### [WorkbookLoadOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorkbookLoadOptions) -Contains the options related to loading a workbook from a file or stream. - -- **constructor**(packageFactory: IPackageFactory): void -- **constructor**(openPasswordSecure: SecureString, packageFactory: IPackageFactory, verifyExcel2007Xml: bool): void -- **constructor**(openPassword: string, packageFactory: IPackageFactory): void -- **AutoResumeCalculations**: `bool` — Returns or sets a boolean indicating whether the Workbook will automatically call its methods before the Load method returns. -- **Culture**: `CultureInfo` — Returns or sets the value for the property. -- **IsDuplicateFormulaParsingOptimized**: `bool` — Returns or sets a boolean indicating whether duplicate formulas parsed during the load will be optimized for faster loading of the workbook. -- **OpenPassword**: `string` — Gets or sets the password used to decrypt the document if it is encrypted. -- **OpenPasswordSecure**: `SecureString` — Gets or sets the password used to decrypt the document if it is encrypted. -- **ScreenDpi**: `Size` — Gets or sets the Dpi to use when calculating row and column sizes for the workbook. If empty, the system Dpi will be used. -- **UserDefinedFunctionLibraries**: `IList` — Returns a list of user defined function assemblies that should be registered before the workbook is loaded. -- **UserDefinedFunctions**: `IList` — Returns a list of user defined functions that should be registered before the workbook is loaded. - -### [WorkbookOptionsBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorkbookOptionsBase) -Abstract base class for or . - -- **PackageFactory**: `IPackageFactory` — Gets or sets an IPackageFactory which can be used to create or open an IPackage in a stream. - -### [WorkbookProtection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorkbookProtection) -Provides information about the types of changes that are disabled when the associated Workbook is protected. - -- **AllowEditStructure**: `bool` — Returns a boolean indicating if the sheets displayed may be modified when the Workbook is protected. -- **AllowEditWindows**: `bool` — Returns a boolean indicating if the Workbook windows may be modified when the Workbook is protected. - -### [WorkbookSaveOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorkbookSaveOptions) -Contains the options related to saving a workbook to a file or stream. - -- **constructor**(packageFactory: IPackageFactory): void - -### [WorkbookStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorkbookStyle) -Represents a complex format which can be applied to a cell's format. - -- **IsBuiltIn**: `bool` — Gets the value indicating whether the style is a built in style in Microsoft Excel. -- **Name**: `string` — Gets or sets the name of the workbook style. -- **StyleFormat**: `IWorksheetCellFormat` — Gets the cell format which applies to the workbook style. -- **Reset**(): void — Resets the style to its original state. - -### [WorkbookStyleCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorkbookStyleCollection) -A collection of workbook styles, or complex formats which can be easily applied to cells in Microsoft Excel. - -- **Count**: `int` — Gets the number of styles in the collection. -- **this[int]**: `WorkbookStyle` — Gets the style at the specified index. -- **this[string]**: `WorkbookStyle` — Gets the style with the specified name. -- **NormalStyle**: `WorkbookStyle` — Gets the default style for the workbook. -- **AddUserDefinedStyle**(styleFormat: IWorksheetCellFormat, name: string): WorkbookStyle — Adds new user defined style to the workbook. -- **AddUserDefinedStyle**(name: string): WorkbookStyle — Adds new user defined style to the workbook. -- **Clear**(): void — Clears all styles, other than the Normal style, from the collection. -- **Contains**(style: WorkbookStyle): bool — Determines whether a style is in the collection. -- **Remove**(style: WorkbookStyle): bool — Removes the specified style from the collection. -- **RemoveAt**(index: int): void — Removes the style at the specified index from the collection. -- **Reset**(): void — Resets the collection to its original state by clearing all styles and adding in preset built in styles. - -### [WorkbookWindowOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorkbookWindowOptions) -Represents the window options which are saved with the workbook. - -- **BoundsInTwips**: `Rect` — Gets or sets the bounds of the workbook's MDI child window in twips (1/20th of a point). -- **FirstVisibleTabIndex**: `int` — Gets or sets the index of the first visible tab in the worksheet tab bar. -- **Minimized**: `bool` — Gets or sets the value indicating whether the workbook's MDI child window is minimized in Microsoft Excel. -- **Reset**(): void — Resets the window options to their default settings. - -### [Worksheet](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/Worksheet) -Represents one worksheet in a Microsoft Excel workbook. - -- **Columns**: `WorksheetColumnCollection` — Gets the collection of columns in the worksheet. -- **ConditionalFormats**: `ConditionalFormatCollection` — Returns a to which can be added to control the visual attributes of a based on user-defined criteria. -- **DataTables**: `WorksheetDataTableCollection` — Gets the collection of data tables in the worksheet. -- **DataValidationRules**: `DataValidationRuleCollection` — Gets the collection of data validation rules applied to cells in the Worksheet. -- **DefaultColumnWidth**: `int` — Gets or sets the default column width including padding, in 256ths of the '0' digit character width in the workbook's default font. -- **DefaultRowHeight**: `int` — Gets or sets the default row height in twips (1/20th of a point). -- **DisplayOptions**: `WorksheetDisplayOptions` — Gets the object which controls the display of the worksheet. -- **FilterSettings**: `WorksheetFilterSettings` — Exposes methods to identify a region in the worksheet and to apply filters and optionally sort criteria to that region. -- **Hyperlinks**: `WorksheetHyperlinkCollection` — Gets the collection of hyperlinks applied to cells and regions in the Worksheet. -- **ImageBackground**: `ImageWrapper` — Gets or sets the background image for the worksheet. -- **Index**: `int` — Gets the zero-based index of this worksheet in its parent collection. -- **MergedCellsRegions**: `WorksheetMergedCellsRegionCollection` — Gets the collection of merged cell ranges in this worksheet. -- **PrintOptions**: `PrintOptions` — Gets the object which controls how the worksheet prints. -- **Protected**: `bool` — Gets or sets the protection state of Excel worksheet. -- **Protection**: `WorksheetProtection` — Returns an object that provides information used when the Worksheet has been protected. -- **Rows**: `WorksheetRowCollection` — Gets the collection of rows in the worksheet. -- **Shapes**: `WorksheetShapeCollection` — Gets the collection of shapes on the worksheet. -- **SortSettings**: `WorksheetSortSettings` — Exposes methods to identify a region in the worksheet and to apply sort criteria to that region. -- **SparklineGroups**: `SparklineGroupCollection` — Returns a collection of s (read-only) -- **Tables**: `WorksheetTableCollection` — Gets the collection of instances, or regions formatted as tables, in the worksheet. -- **Type**: `SheetType` — Returns a value indicating the type of sheet -- **DeleteCells**(region: WorksheetRegion, shiftCellsLeft: bool): void — Deletes a region of cells. -- **DeleteCells**(address: string, shiftCellsLeft: bool): void — Deletes a region of cells. -- **GetCell**(address: string): WorksheetCell — Gets the cell at the specified address or name. -- **GetCell**(address: string, cellReferenceMode: CellReferenceMode): WorksheetCell — Gets the cell at the specified address or name. -- **GetCell**(address: string, cellReferenceMode: CellReferenceMode, originCell: WorksheetCell): WorksheetCell — Gets the cell at the specified address or name. -- **GetCell**(address: string, originCell: WorksheetCell): WorksheetCell — Gets the cell at the specified address or name. -- **GetCellConditionalFormat**(rowIndex: int, columnIndex: int): CellConditionalFormat — Gets the cell conditional format for the cell at the specified row and column index. -- **GetDefaultColumnWidth**(units: WorksheetColumnWidthUnit): double — Gets the default column width in the specified units. -- **GetRegion**(address: string): WorksheetRegion — Gets the region at the specified address or name. -- **GetRegion**(address: string, cellReferenceMode: CellReferenceMode): WorksheetRegion — Gets the region at the specified address or name. -- **GetRegion**(address: string, cellReferenceMode: CellReferenceMode, originCell: WorksheetCell): WorksheetRegion — Gets the region at the specified address or name. -- **GetRegion**(address: string, originCell: WorksheetCell): WorksheetRegion — Gets the region at the specified address or name. -- **GetRegions**(address: string): WorksheetRegion[] — Gets the regions at the specified address or name. -- **GetRegions**(address: string, cellReferenceMode: CellReferenceMode): WorksheetRegion[] — Gets the regions at the specified address or name. -- **GetRegions**(address: string, cellReferenceMode: CellReferenceMode, originCell: WorksheetCell): WorksheetRegion[] — Gets the regions at the specified address or name. -- **GetRegions**(address: string, originCell: WorksheetCell): WorksheetRegion[] — Gets the regions at the specified address or name. -- **HideColumns**(startIndex: int?, count: int?): void — Hides the columns in the specified range. -- **HideRows**(startIndex: int?, count: int?): void — Hides the rows in the specified range. -- **InsertCells**(region: WorksheetRegion, shiftCellsRight: bool): void — Inserts a region of cells. -- **InsertCells**(address: string, shiftCellsRight: bool): void — Inserts a region of cells. -- **MoveToIndex**(index: int): void — Moves the worksheet to a new position in the owning workbook's collections of worksheets. -- **Protect**(allowDeletingColumns: bool?, allowDeletingRows: bool?, allowEditObjects: bool?, allowEditScenarios: bool?, allowFiltering: bool?, allowFormattingCells: bool?, allowFormattingColumns: bool?, allowFormattingRows: bool?, allowInsertingColumns: bool?, allowInsertingHyperlinks: bool?, allowInsertingRows: bool?, allowSorting: bool?, allowUsingPivotTables: bool?): void — Protects the worksheet without a password. -- **Protect**(password: SecureString, allowDeletingColumns: bool?, allowDeletingRows: bool?, allowEditObjects: bool?, allowEditScenarios: bool?, allowFiltering: bool?, allowFormattingCells: bool?, allowFormattingColumns: bool?, allowFormattingRows: bool?, allowInsertingColumns: bool?, allowInsertingHyperlinks: bool?, allowInsertingRows: bool?, allowSorting: bool?, allowUsingPivotTables: bool?): void — Protects the worksheet with the specified password. -- **Protect**(password: string, allowDeletingColumns: bool?, allowDeletingRows: bool?, allowEditObjects: bool?, allowEditScenarios: bool?, allowFiltering: bool?, allowFormattingCells: bool?, allowFormattingColumns: bool?, allowFormattingRows: bool?, allowInsertingColumns: bool?, allowInsertingHyperlinks: bool?, allowInsertingRows: bool?, allowSorting: bool?, allowUsingPivotTables: bool?): void — Protects the worksheet with the specified password. -- **SetDefaultColumnWidth**(value: double, units: WorksheetColumnWidthUnit): void — Sets the default column width in the specified units. -- **UnhideColumns**(startIndex: int?, count: int?): void — Unhides the columns in the specified range. -- **UnhideRows**(startIndex: int?, count: int?): void — Unhides the rows in the specified range. - -### [WorksheetCell](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetCell) -Represents a cell in a Microsoft Excel worksheet. - -- **AssociatedDataTable**: `WorksheetDataTable` — Gets the data table to which the cell belongs. -- **AssociatedMergedCellsRegion**: `WorksheetMergedCellsRegion` — Gets the merged cells region which contains the cell, or null if the cell is not merged. -- **AssociatedTable**: `WorksheetTable` — Gets the to which this cell belongs. -- **CellFormat**: `IWorksheetCellFormat` — Gets the cell formatting for this cell. -- **ColumnIndex**: `int` — Gets the column index of the cell. -- **Comment**: `WorksheetCellComment` — Gets or sets the comment applied to the cell. -- **DataValidationRule**: `DataValidationRule` — Gets or sets the data validation rule for the . -- **Formula**: `Formula` — Gets the formula which has been applied to the cell. -- **HasCellFormat**: `bool` — Gets the value which indicates whether the cell's format has been initialized yet. -- **HasComment**: `bool` — Get the value indicating whether the cell has an associated comment. -- **RowIndex**: `int` — Gets the row index of the cell. -- **Value**: `object` — Gets or sets the value of the cell. -- **Worksheet**: `Worksheet` — Gets the worksheet to which the cell belongs. -- **ApplyFormula**(value: string): void — Applies a formula to the cell. -- **Equals**(obj: object): bool — Determines whether the specified object is another instance which refers to the same location on the same worksheet as this cell. -- **GetBoundsInTwips**(): Rect — Gets the bounds of the cell in twips (1/20th of a point). -- **GetBoundsInTwips**(options: PositioningOptions): Rect — Gets the bounds of the cell in twips (1/20th of a point). -- **GetCellAddressString**(worksheetRow: WorksheetRow, columnIndex: int, cellReferenceMode: CellReferenceMode, includeWorksheetName: bool): string — Gets the string representation of the address of the cell. -- **GetCellAddressString**(worksheetRow: WorksheetRow, columnIndex: int, cellReferenceMode: CellReferenceMode, includeWorksheetName: bool, useRelativeColumn: bool, useRelativeRow: bool): string — Gets the string representation of the address of the cell. -- **GetHashCode**(): int — Gets the hash code of the . -- **GetHyperlink**(): WorksheetHyperlink — Gets the effective hyperlink on the cell. -- **GetResolvedCellFormat**(): IWorksheetCellFormat — Gets the resolved cell formatting for this cell. -- **GetText**(): string — Gets the text displayed in the cell. -- **GetText**(textFormatMode: TextFormatMode): string — Gets the text of the cell. -- **IsCellTypeSupported**(cellType: Type): bool — Returns True if a particular type of value can be exported to excel. -- **ToString**(): string — Gets the string representation of the address of the cell. -- **ToString**(cellReferenceMode: CellReferenceMode, includeWorksheetName: bool): string — Gets the string representation of the address of the cell. -- **ToString**(cellReferenceMode: CellReferenceMode, includeWorksheetName: bool, useRelativeColumn: bool, useRelativeRow: bool): string — Gets the string representation of the address of the cell. -- **ValidateValue**(): bool — Returns a boolean indicating if the value of the cell is valid considering the associated - -### [WorksheetCellCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetCellCollection) -A collection of cells in a row. - -- **this[int]**: `WorksheetCell` — Gets the cell at the specified column index in the owning row. -- **MaxCount**: `int` — Gets the maximum number of items allowed in this collection. - -### [WorksheetCellComment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetCellComment) -Represents a comment for a cell. - -- **constructor**(): void -- **Author**: `string` — Gets or sets the author of the comment. -- **Cell**: `WorksheetCell` — Gets the cell to which the comment is applied. -- **Sheet**: `Sheet` — Gets the worksheet on which the shape resides. -- **Text**: `FormattedString` — Gets or sets the formatted text of the comment. - -### [WorksheetChart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetChart) -Represents a chart. - -- **AutoScaling**: `bool` — True if Microsoft Excel scales a 3-D chart so that it's closer in size to the equivalent 2-D chart. The property must be True -- **AxisCollection**: `AxisCollection` — Returns the axis collection (read-only) -- **BackWall**: `Wall` — Returns a object that allows the user to format the back wall of a 3-D chart. Read-only. -- **BarShape**: `BarShape?` — Returns or sets the shape of bars. Applicable only to 3D bar-type charts. -- **BarShapeResolved**: `BarShape` — Returns the resolved value of the property. -- **ChartArea**: `ChartArea` — Returns a object that represents the complete chart area for the chart. Read-only. -- **ChartTitle**: `ChartTitle` — Returns or sets an object. -- **ChartType**: `ChartType` — Specifies the chart type. -- **ComboChartGroups**: `ComboChartGroupCollection` — Returns a collection of the instances associated with this chart. -- **DepthPercent**: `int` — Returns or sets the depth of a 3-D chart as a percentage of the chart width (between 20 and 2000 percent). -- **DisplayBlanksAs**: `DisplayBlanksAs` — Returns or sets the way that blank cells are plotted on a chart. -- **DoughnutHoleSize**: `int` — Returns or sets the size of the hole in a doughnut chart, expressed as a percentage of the size of the encompassing circle. -- **DropLines**: `ChartDropLines` — Returns or sets a instance which determines the appearance for a stock chart's drop lines. -- **FirstSliceAngle**: `int` — Returns or sets the angle which determines the origin of the first slice, as relative to the 12 o'clock position of the emcompassing circle. -- **Floor**: `Wall` — Returns a object that allows the user to format the bottom wall of a 3-D chart. Read-only. -- **GapDepth**: `int` — Returns or sets the gap depth in a 3-D chart, expressed as a percentage of the marker width. The value of this property must be between 0 and 500. -- **GapWidth**: `int` — Returns or sets the distance between the data series in a bar chart, as a percentage of the marker width. The value of this property must be between 0 and 500. -- **HeightPercent**: `int` — Returns or sets the height of a 3-D chart as a percentage of the chart width (between 5 and 500 percent). -- **HighLowLines**: `ChartHighLowLines` — Returns or sets a instance which determines the appearance for a stock chart's high/low lines. -- **Legend**: `Legend` — Returns or sets a object which represents the legend for the chart. -- **Perspective**: `int` — Returns or sets a value that represents the perspective for the 3-D chart view, expressed in degrees. -- **PlotArea**: `PlotArea` — Returns a PlotArea object that represents the plot area of a chart. Read-only. -- **PlotVisibleOnly**: `bool` — True if only visible cells are plotted. False if both visible and hidden cells are plotted. -- **RightAngleAxes**: `bool` — True if the chart axes are at right angles, independent of chart rotation or elevation. Applies only to 3-D line, column, and bar charts. -- **RotationX**: `int` — Returns or sets the rotation of a 3-D chart view around the X-axis, expressed in degrees. -- **RotationY**: `int` — Returns or sets the rotation of a 3-D chart view around the Y-axis, expressed in degrees. -- **SecondPlotSize**: `int` — Returns or sets the size of the second plot area in a 'bar of pie' or 'pie of pie' chart, expressed as a percentage of the first plot area's size. -- **SeriesCollection**: `SeriesCollection` — Returns the series collection (read-only) -- **SeriesLines**: `ChartSeriesLines` — Determines the and for the lines which connect the first and second plot areas in a 'bar of pie' or 'pie of pie' chart. -- **SeriesOverlap**: `int` — Determines the amount by which intersecting overlap, expressed as a percentage of the bar size. -- **Sheet**: `Sheet` — Gets the worksheet on which the shape resides. -- **SideWall**: `Wall` — Returns a object that allows the user to format the side wall of a 3-D chart. Read-only. -- **UpDownBars**: `UpDownBars` — Returns or sets a instance which determines the appearance for a stock chart's up/down bars. -- **VaryColors**: `bool` — Returns or sets a boolean value indicating whether the fill colors for and are automatically selected by Excel. -- **WallDefault**: `Wall` — Returns a object which represents the back and side walls, and floor of the chart. Applicable only for 3-D charts. -- **SetComboChartSourceData**(dataRange: string, seriesChartTypes: ChartType[], plotByRows: bool, cellReferenceMode: CellReferenceMode?): void — Sets the source data range for a combo chart. -- **SetSourceData**(dataRange: string, plotByRows: bool, cellReferenceMode: CellReferenceMode?): void — Sets the source data range for the chart. - -### [WorksheetCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetCollection) -A collection of worksheets in a workbook. - -- **Count**: `int` — Gets the number of worksheets in the collection. -- **this[int]**: `Worksheet` — Gets the worksheet at the specified index. -- **this[string]**: `Worksheet` — Gets the worksheet with the specified name. -- **Add**(name: string): Worksheet — Creates a new and adds it to the collection. -- **Clear**(): void — Clears all worksheets from the collection. -- **Contains**(worksheet: Worksheet): bool — Determines whether a worksheet is in the collection. -- **Exists**(name: string): bool — Determines whether a worksheet with the specified name exists in the collection. -- **IndexOf**(worksheet: Worksheet): int — Gets the index of the specified worksheet in the collection. -- **Remove**(worksheet: Worksheet): bool — Removes the specified worksheet from the collection. -- **RemoveAt**(index: int): void — Removes the worksheet at the specified index from the collection. - -### [WorksheetColumn](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetColumn) -Represents a column in a Microsoft Excel worksheet. - -- **Index**: `int` — Gets the 0-based index of the column in the worksheet. -- **Width**: `int` — Gets or sets the column width including padding, in 256ths of the '0' digit character width in the workbook's default font. -- **AutoFitWidth**(): void — Sets the to the extent required to display the contents of this column. -- **AutoFitWidth**(startRowIndex: int, endRowIndex: int): void — Sets the width to the extent required to display all of the contents for the specified range of rows. -- **CalculateAutoFitWidth**(): int — Returns the width required for the column to display all of its contents. -- **CalculateAutoFitWidth**(startRowIndex: int, endRowIndex: int): int — Returns the width required for the column to display all of the contents for the specified range of rows. -- **GetWidth**(units: WorksheetColumnWidthUnit): double — Gets the column width in the specified units, or NaN if the column has the default width. -- **SetWidth**(value: double, units: WorksheetColumnWidthUnit): void — Sets the column width in the specified units. - -### [WorksheetColumnCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetColumnCollection) -A collection of columns in a worksheet. - -- **this[int]**: `WorksheetColumn` — Gets the column at the specified index. -- **MaxCount**: `int` — Gets the maximum number of items allowed in this collection. -- **Insert**(index: int, count: int): void — Inserts one or more columns into the collection -- **Remove**(index: int, count: int): void — Removes one or more columns from the collection - -### [WorksheetDataTable](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetDataTable) -Represents a data table for a range of cells. - -- **CellsInTable**: `WorksheetRegion` — Gets or sets the region of cells in the data table. -- **ColumnInputCell**: `WorksheetCell` — Gets or sets the cell used as the column-input cell in the data table. -- **RowInputCell**: `WorksheetCell` — Gets or sets the cell used as the row-input cell in the data table. -- **Worksheet**: `Worksheet` — Gets the worksheet on which this data table resides. - -### [WorksheetDataTableCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetDataTableCollection) -A collection of instances on a worksheet. - -- **Count**: `int` — Gets the number of data tables in the collection. -- **this[int]**: `WorksheetDataTable` — Gets the data table at the specified index in the collection. -- **Add**(cellsInTable: WorksheetRegion, columnInputCell: WorksheetCell, rowInputCell: WorksheetCell): WorksheetDataTable — Creates a new data table and adds it to the collection. -- **Clear**(): void — Clears all data tables from the collection. -- **Remove**(dataTable: WorksheetDataTable): bool — Removes the specified data table from the collection. -- **RemoveAt**(index: int): void — Removes the data table at the specified index from the collection. - -### [WorksheetDisplayOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetDisplayOptions) -Class which exposes the display options which can only be controlled through the worksheet. - -- **MagnificationInNormalView**: `int` — Gets or sets the magnification level of the worksheet when it is displayed in normal view. -- **MagnificationInPageBreakView**: `int` — Gets or sets the magnification level of the worksheet when it is displayed in the page break preview. -- **MagnificationInPageLayoutView**: `int` — Gets or sets the magnification level of the worksheet when it is displayed in page layout view. -- **OrderColumnsRightToLeft**: `bool` — Gets or sets the value indicating whether the columns are ordered right to left. -- **ShowWhitespaceInPageLayoutView**: `bool` — Gets or sets the value which indicates whether to show whitespace between worksheet pages in page layout view. -- **TabColorInfo**: `WorkbookColorInfo` — Gets or sets the to use for the associated worksheet's tab in the tab bar of Microsoft Excel. -- **ResetCore**(): void — Resets the display options to their default settings. - -### [WorksheetHyperlink](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetHyperlink) -Represents a hyperlink for a cell or region. - -- **constructor**(sourceCell: WorksheetCell, target: object, displayText: string, toolTip: string): void -- **constructor**(sourceRegion: WorksheetRegion, target: object, displayText: string, toolTip: string): void -- **constructor**(sourceAddress: string, target: object, displayText: string, toolTip: string): void -- **DisplayText**: `string` — Gets or sets the text to display in the cell when the hyperlink is added to a worksheet, or null to use the target text. -- **IsSealed**: `bool` — Gets the value indicating whether the hyperlink is sealed and cannot be modified. -- **SourceAddress**: `string` — Gets or sets the address of the cell or region on which the hyperlink resides. -- **SourceCell**: `WorksheetCell` — Gets or sets the cell on which the hyperlink resides. -- **SourceRegion**: `WorksheetRegion` — Gets or sets the region on which the hyperlink resides. -- **Target**: `object` — Gets or sets the target of the hyperlink, which can be a string, , , or instance. For bookmarks in an external document, separate the sub-address with a #, such as "File.xlsx#Sheet1!C3". For email addresses, use a target string with the format "mailto:joe" or "mailto:joe". -- **TargetAddress**: `string` — Gets or sets the target address of the hyperlink. For bookmarks in an external document, separate the sub-address with a #, such as "File.xlsx#Sheet1!C3". For email addresses, use a target string with the format "mailto:joe" or "mailto:joe". -- **TargetCell**: `WorksheetCell` — Gets or sets the target cell of the hyperlink. -- **TargetNamedReference**: `NamedReference` — Gets or sets the target named reference of the hyperlink. -- **TargetRegion**: `WorksheetRegion` — Gets or sets the target region of the hyperlink. -- **ToolTip**: `string` — Gets or sets the text to use in a tool tip when hovering over the source cell or region, or null to use the default tool tip. -- **Worksheet**: `Worksheet` — Gets the worksheet to which the hyperlink belongs. -- **ToString**(): string — Gets the string representation of the hyperlink. - -### [WorksheetHyperlinkCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetHyperlinkCollection) -A collection of instances in a . - -- **Count**: `int` — Gets the number of hyperlinks on the . -- **this[int]**: `WorksheetHyperlink` — Gets the hyperlink at the specified index in the collection. -- **Add**(hyperlink: WorksheetHyperlink): void — Adds the specified hyperlink to the collection. -- **Clear**(): void — Clears all hyperlinks from the collection. -- **Contains**(hyperlink: WorksheetHyperlink): bool — Determines whether a hyperlink is in the collection. -- **GetEnumerator**(): IEnumerator — Gets an enumerator which can iterator all hyperlinks in the collection. -- **Insert**(index: int, hyperlink: WorksheetHyperlink): void — Inserts the specified hyperlink in the collection. -- **Remove**(hyperlink: WorksheetHyperlink): bool — Removes the specified hyperlink from the collection. -- **RemoveAt**(index: int): void — Removes the hyperlink at the specified index from the collection. - -### [WorksheetImage](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetImage) -Represents any image on the worksheet except the background image. - -- **constructor**(image: ImageWrapper): void - -### [WorksheetItemCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetItemCollection) -Abstract base class for collections of the main worksheet elements (rows, columns, and cells). - -- **MaxCount**: `int` — Gets the maximum number of items allowed in this collection. - -### [WorksheetMergedCellsRegion](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetMergedCellsRegion) -Represents a merged region of cells, or cells which share a value and format and appear as one cell when viewed in Microsoft Excel. - -- **CellFormat**: `IWorksheetCellFormat` — Gets the cell formatting for the merged cell region. -- **Comment**: `WorksheetCellComment` — Gets or sets the comment for the merged cells region. -- **Formula**: `Formula` — Gets the formula which has been applied to the merged region. -- **Value**: `object` — Gets or sets the value of the merged cell region. -- **GetResolvedCellFormat**(): IWorksheetCellFormat — Gets the resolved cell formatting for this merged cell region. - -### [WorksheetMergedCellsRegionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetMergedCellsRegionCollection) -A collection of instances in a . - -- **Count**: `int` — Gets the number of merged cell regions in the collection. -- **this[int]**: `WorksheetMergedCellsRegion` — Gets the merged cell region at the specified index. -- **Add**(firstRow: int, firstColumn: int, lastRow: int, lastColumn: int): WorksheetMergedCellsRegion — Creates new merged cell region and adds it to the collection. -- **Clear**(): void — Clears all merged cell regions from the collection. -- **IsOverlappingWithMergedRegion**(firstRow: int, firstColumn: int, lastRow: int, lastColumn: int): bool — Checks if any part of specified region is already a part of a merged cell region. -- **Remove**(region: WorksheetMergedCellsRegion): bool — Removes the specified merged cell region from the collection. -- **RemoveAt**(index: int): void — Removes the merged cell region at the specified index from the collection. - -### [WorksheetProtectedRange](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetProtectedRange) -Represents a range of cells in a worksheet that may be edited by the end user. - -- **constructor**(title: string): void -- **constructor**(name: string, password: SecureString): void -- **constructor**(name: string, password: string): void -- **HasPassword**: `bool` — Returns true if the range has a password associated with it. -- **IsProtected**: `bool` — Returns a boolean indicating if the range is currently locked. -- **Ranges**: `ICollection` — Returns a collection of ranges that may be edited when the worksheet is protected. -- **SecurityDescriptor**: `string` — Returns or sets the security descriptor used to define permissions for accounts that may edit the associated range without a password. -- **Title**: `string` — Returns or sets the name of the range. -- **Worksheet**: `Worksheet` — Returns the worksheet with which the edit range is associated. -- **SetPassword**(password: SecureString): void — Sets the password required to unlock the associated range of cells. -- **SetPassword**(password: string): void — Sets the password required to unlock the associated range of cells. -- **SetSecurityDescriptor**(permissions: WorksheetProtectedRangeUserPermission[]): void — Sets the property from the specified user accounts -- **Unprotect**(): void — Removes the password from the range. -- **Unprotect**(password: SecureString): void — Attempts to use the specified password to unlock the range. -- **Unprotect**(password: string): void — Attempts to use the specified password to unlock the range. - -### [WorksheetProtectedRangeCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetProtectedRangeCollection) -A collection of instances in a - -- **Count**: `int` — Gets the number of ranges in the collection. -- **this[int]**: `WorksheetProtectedRange` — Gets the range at the specified index in the collection. -- **Add**(item: WorksheetProtectedRange): void — Adds the specified range to the collection. -- **Clear**(): void — Clears all ranges from the collection. -- **Contains**(range: WorksheetProtectedRange): bool — Determines whether a range is in the collection. -- **GetEnumerator**(): IEnumerator — Gets an enumerator which can iterator all ranges in the collection. -- **Insert**(index: int, range: WorksheetProtectedRange): void — Inserts the specified range in the collection. -- **Remove**(range: WorksheetProtectedRange): bool — Removes the specified range from the collection. -- **RemoveAt**(index: int): void — Removes the range at the specified index from the collection. - -### [WorksheetProtection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetProtection) -Provides information about the types of changes that are disabled when the associated Worksheet is protected. - -- **AllowDeletingColumns**: `bool` — Returns a boolean indicating if the deletion of columns is allowed in a protected worksheet. -- **AllowDeletingRows**: `bool` — Returns a boolean indicating if the deletion of rows is allowed in a protected worksheet. -- **AllowEditObjects**: `bool` — Returns a boolean indicating if objects such as shapes, comments, charts and controls may be created or changed when the worksheet is protected. -- **AllowEditScenarios**: `bool` — Returns a boolean indicating if existing scenarios are protected when the worksheet is protected. -- **AllowFiltering**: `bool` — Returns a boolean indicating if the user may use an auto filter created before the worksheet was protected. -- **AllowFormattingCells**: `bool` — Returns a boolean indicating if the user may change the formatting of cells in a protected worksheet. -- **AllowFormattingColumns**: `bool` — Returns a boolean indicating if the user may change column information such as its width or visibility in a protected worksheet. -- **AllowFormattingRows**: `bool` — Returns a boolean indicating if the user may change row information such as its height or visibility in a protected worksheet. -- **AllowInsertingColumns**: `bool` — Returns a boolean indicating if the user may insert columns in a protected worksheet. -- **AllowInsertingHyperlinks**: `bool` — Returns a boolean indicating if the user may insert hyperlinks in unlocked cells in a protected worksheet. -- **AllowInsertingRows**: `bool` — Returns a boolean indicating if the user may insert rows in a protected worksheet. -- **AllowSorting**: `bool` — Returns a boolean indicating if the sorting is allowed in a protected worksheet. -- **AllowUsingPivotTables**: `bool` — Returns a boolean indicating if the user can change pivot tables in a protected worksheet. -- **AllowedEditRanges**: `WorksheetProtectedRangeCollection` — Returns a collection of instances that define which locked ranges of cells may be edited in a protected worksheet. -- **SelectionMode**: `WorksheetProtectedSelectionMode` — Returns or sets an enumeration used to indicate how cell selection should be affected when the associated Worksheet is protected. - -### [WorksheetReferenceCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetReferenceCollection) -A collection of cells or regions which are all on the same . - -- **constructor**(worksheet: Worksheet): void -- **constructor**(worksheet: Worksheet, references: string): void -- **constructor**(cell: WorksheetCell): void -- **constructor**(region: WorksheetRegion): void -- **CellsCount**: `int` — Gets the number of cells contains in all references in this collection. -- **Worksheet**: `Worksheet` — Gets the worksheet for which this collection contains references. -- **Add**(cell: WorksheetCell): void — Adds a cell to the collection of references. -- **Add**(region: WorksheetRegion): void — Adds a region to the collection of references. -- **Add**(references: string): void — Adds a list of references to the collection of references. -- **Add**(references: string, cellReferenceMode: CellReferenceMode): void — Adds a list of references to the collection of references. -- **Clear**(): void — Clears all references from the collection. -- **Contains**(cell: WorksheetCell): bool — Determines whether the collection contains the specified cell. -- **Contains**(region: WorksheetRegion): bool — Determines whether the collection contains the specified region. -- **GetEnumerator**(): IEnumerator — Gets an enumerator which returns all and instances in the collection of references. -- **Remove**(cell: WorksheetCell): bool — Removes a cell from the collection of references. -- **Remove**(region: WorksheetRegion): bool — Removes a region from the collection of references. -- **Remove**(references: string): bool — Removes a list of references from the collection of references. -- **Remove**(references: string, cellReferenceMode: CellReferenceMode): bool — Removes a list of references from the collection of references. -- **ToString**(): string — Returns the string value represent the cell and region addresses in the collection. -- **ToString**(cellReferenceMode: CellReferenceMode): string — Returns the string value represent the cell and region addresses in the collection. - -### [WorksheetRegion](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetRegion) -Represents a rectangular region of cells on a worksheet. - -- **constructor**(worksheet: Worksheet, firstRow: int, firstColumn: int, lastRow: int, lastColumn: int): void -- **FirstColumn**: `int` — Gets the index of the first column in the region. -- **FirstRow**: `int` — Gets the index of the first row in the region. -- **LastColumn**: `int` — Gets the index of the last column in the region. -- **LastRow**: `int` — Gets the index of the last row in the region. -- **Worksheet**: `Worksheet` — Gets the worksheet on which the region resides. -- **ApplyArrayFormula**(value: string): void — Applies a array formula to the region of cells. -- **ApplyFormula**(value: string): void — Applies a formula to the region of cells. -- **Equals**(obj: object): bool — Determines whether the specified value equals this . -- **FormatAsTable**(tableHasHeaders: bool): WorksheetTable — Formats the region as a table and adds an associated to the collection. -- **FormatAsTable**(tableHasHeaders: bool, tableStyle: WorksheetTableStyle): WorksheetTable — Formats the region as a table and adds an associated to the collection. -- **GetBoundsInTwips**(): Rect — Gets the bounds of the region in twips (1/20th of a point). -- **GetBoundsInTwips**(options: PositioningOptions): Rect — Gets the bounds of the region in twips (1/20th of a point). -- **GetHashCode**(): int — Gtes the hash code for the . -- **ToString**(): string — Gets the string representation of the range of cells in the region. -- **ToString**(cellReferenceMode: CellReferenceMode, includeWorksheetName: bool): string — Gets the string representation of the range of cells in the region. -- **ToString**(cellReferenceMode: CellReferenceMode, includeWorksheetName: bool, useRelativeColumn: bool, useRelativeRow: bool): string — Gets the string representation of the range of cells in the region. - -### [WorksheetRow](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetRow) -Represents a row in a Microsoft Excel worksheet. - -- **Cells**: `WorksheetCellCollection` — Gets the collection of cells in the row. -- **Height**: `int` — Gets or sets the height of the row in twips (1/20th of a point). -- **Index**: `int` — Gets the 0-based index of the row in the worksheet. -- **ApplyCellFormula**(columnIndex: int, formula: string, cellReferenceMode: CellReferenceMode?): void — Applies a formula to the cell at the specified column index. -- **GetCellAssociatedDataTable**(columnIndex: int): WorksheetDataTable — Gets the data table to which the cell at the specified index belongs. -- **GetCellAssociatedMergedCellsRegion**(columnIndex: int): WorksheetMergedCellsRegion — Gets the merged cells region which contains the cell at the specified index, or null if the cell is not merged. -- **GetCellAssociatedTable**(columnIndex: int): WorksheetTable — Gets the to which the cell at the specified index belongs. -- **GetCellBoundsInTwips**(columnIndex: int): Rect — Gets the bounds of the cell at the specified column index in twips (1/20th of a point). -- **GetCellBoundsInTwips**(columnIndex: int, options: PositioningOptions): Rect — Gets the bounds of the cell at the specified column index in twips (1/20th of a point). -- **GetCellComment**(columnIndex: int): WorksheetCellComment — Gets or sets the comment applied to the cell at the specified column index. -- **GetCellConditionalFormat**(columnIndex: int): CellConditionalFormat — Gets the cell conditional format for the cell at the specified column index. -- **GetCellFormat**(columnIndex: int): IWorksheetCellFormat — Gets the cell formatting for the cell at the specified column index. -- **GetCellFormula**(columnIndex: int): Formula — Gets the formula which has been applied to the cell at the specified column index. -- **GetCellHyperlink**(columnIndex: int): WorksheetHyperlink — Gets the effective hyperlink on the cell at the specified index. -- **GetCellText**(columnIndex: int): string — Gets the display text in the cell at the specified index. -- **GetCellText**(columnIndex: int, textFormatMode: TextFormatMode): string — Gets the text in the cell at the specified index. -- **GetCellValue**(columnIndex: int): object — Gets the value of the cell at the specified column index. -- **GetResolvedCellFormat**(columnIndex: int): IWorksheetCellFormat — Gets the resolved cell formatting for the cell at the specified column index. -- **SetCellComment**(columnIndex: int, comment: WorksheetCellComment): void — Sets the comment applied to the cell at the specified column index. -- **SetCellValue**(columnIndex: int, value: object): void — Sets the value of a cell at the specified column index. -- **TryGetCellFormat**(columnIndex: int, cellFormat: IWorksheetCellFormat): bool — Gets the cell formatting for the cell at the specified column index if it is allocated. -- **ValidateCellValue**(columnIndex: int): bool — Returns a boolean indicating if the value of the cell is valid considering its associated - -### [WorksheetRowCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetRowCollection) -A collection of rows in a worksheet. - -- **this[int]**: `WorksheetRow` — Gets the row at the specified index. -- **MaxCount**: `int` — Gets the maximum number of items allowed in this collection. -- **Insert**(index: int, count: int): void — Inserts one or more rows into the collection -- **Remove**(index: int, count: int): void — Removes one or more rows from the collection - -### [WorksheetShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetShape) -Abstract base class for all shapes (atomic or compound) in a worksheet. - -- **BottomRightCornerCell**: `WorksheetCell` — Gets or sets the cell where the bottom-right corner of the shape resides. -- **BottomRightCornerPosition**: `Point` — Gets or sets the position in the of the shape's bottom-right corner, expressed in percentages. -- **Fill**: `ShapeFill` — Gets or sets the fill to use in the background of the shape. -- **FlippedHorizontally**: `bool` — Gets or sets the value which indicates whether the shape is flipped horizontally along the vertical center line. -- **FlippedVertically**: `bool` — Gets or sets the value which indicates whether the shape is flipped vertically along the horizontal center line. -- **Outline**: `ShapeOutline` — Gets or sets the outline to use for the shape. -- **PositioningMode**: `ShapePositioningMode` — Gets or sets the way shapes will be repositioned in excel when cells before or within the shape are resized. -- **Sheet**: `Sheet` — Gets the worksheet on which the shape resides. -- **TopLeftCornerCell**: `WorksheetCell` — Gets or sets the cell where the top-left corner of the shape resides. -- **TopLeftCornerPosition**: `Point` — Gets or sets the position in the of the shape's top-left corner, expressed in percentages. -- **Visible**: `bool` — Gets or sets the value indicating whether the shape is visible on the worksheet. -- **Worksheet**: `Worksheet` — Gets the worksheet on which the shape resides. -- **ClearUnknownData**(): void — Clears the cached unknown shape data which was read in from a parsed excel file. -- **CreatePredefinedShape**(shapeType: PredefinedShapeType): WorksheetShape — Creates a shape which is predefined in Microsoft Excel. -- **GetBoundsInTwips**(): Rect — Gets the bounds of the shape in twips (1/20th of a point). -- **GetBoundsInTwips**(options: PositioningOptions): Rect — Gets the bounds of the shape in twips (1/20th of a point). -- **SetBoundsInTwips**(sheet: Sheet, bounds: Rect): void — Sets the bounds of the shape in twips (1/20th of a point). -- **SetBoundsInTwips**(sheet: Sheet, bounds: Rect, options: PositioningOptions): void — Sets the bounds of the shape in twips (1/20th of a point). - -### [WorksheetShapeCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetShapeCollection) -A collection of instances in a or . - -- **Count**: `int` — Gets the number of shapes in the collection. -- **this[int]**: `WorksheetShape` — Gets the shape at the specified index in the collection. -- **Add**(shapeType: PredefinedShapeType, boundsInTwips: Rect): WorksheetShape — Adds a predefined shape to the collection with the specified bounds. -- **Add**(shapeType: PredefinedShapeType, sheet: Sheet, boundsInTwips: Rect): WorksheetShape — Adds a predefined shape to the collection with the specified bounds. -- **Add**(shapeType: PredefinedShapeType, topLeftCornerCell: WorksheetCell, topLeftCornerPosition: Point, bottomRightCornerCell: WorksheetCell, bottomRightCornerPosition: Point): WorksheetShape — Adds a predefined shape to the collection with the specified anchors. -- **Add**(shape: WorksheetShape): void — Adds a shape to the collection. -- **AddChart**(chartType: ChartType, boundsInTwips: Rect, chartInitializer: Action): WorksheetChart — Adds a chart to the collection with the specified bounds. -- **AddChart**(chartType: ChartType, sheet: Sheet, boundsInTwips: Rect, chartInitializer: Action): WorksheetChart — Adds a chart to the collection with the specified bounds. -- **AddChart**(chartType: ChartType, topLeftCornerCell: WorksheetCell, topLeftCornerPosition: Point, bottomRightCornerCell: WorksheetCell, bottomRightCornerPosition: Point, chartInitializer: Action): WorksheetChart — Adds a chart to the collection with the specified bounds. -- **Clear**(): void — Clears all shapes from the collection. -- **Contains**(shape: WorksheetShape): bool — Determines whether a shape is in the collection. -- **Remove**(shape: WorksheetShape): bool — Removes the specified shape from the collection. -- **RemoveAt**(index: int): void — Removes the shape at the specified index from the collection. - -### [WorksheetShapeGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetShapeGroup) -Represents a group of shapes in a worksheet. This group is also a shape which can be positioned and contained within another group or on a worksheet. - -- **constructor**(): void - -### [WorksheetShapeGroupBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetShapeGroupBase) -Represents a group of shapes in a worksheet. This group is also a shape which can be positioned and contained within another group or on a worksheet. - -- **Shapes**: `WorksheetShapeCollection` — Gets the collection of shapes contained in the group. - -### [WorksheetShapeWithText](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetShapeWithText) -Abstract base class for all shapes that can display text. - -- **Text**: `FormattedText` — Gets or sets the formatted text of the shape. - -### [WorksheetTable](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetTable) -Represents a region of cells formatted as a table. - -- **AreaFormats**: `WorksheetTableAreaFormatsCollection` — Gets the collection of formats used for each area of the . -- **Columns**: `WorksheetTableColumnCollection` — Gets the collection of columns in the table. -- **DataAreaRegion**: `WorksheetRegion` — Gets the which represents the region of cells in the data area of the table. -- **DisplayBandedColumns**: `bool` — Gets or sets the value which indicates whether the alternate column format should be applied to the appropriate columns of the . -- **DisplayBandedRows**: `bool` — Gets or sets the value which indicates whether the alternate row format should be applied to the appropriate rows of the . -- **DisplayFirstColumnFormatting**: `bool` — Gets or sets the value which indicates whether the first column format should be applied to the appropriate column of the . -- **DisplayLastColumnFormatting**: `bool` — Gets or sets the value which indicates whether the last column format should be applied to the appropriate column of the . -- **HeaderRowRegion**: `WorksheetRegion` — Gets the which represents the region of cells in the header row of the table. -- **IsFilterUIVisible**: `bool` — Gets or sets the value indicating whether to allow filtering and show filter buttons in the table headers. -- **IsHeaderRowVisible**: `bool` — Gets or sets the value which indicates whether the row containing column headers should be displayed. -- **IsTotalsRowVisible**: `bool` — Gets or sets the value which indicates whether the row containing column totals should be displayed. -- **SortSettings**: `SortSettings` — Gets the settings which determine how the data within the table should be sorted. -- **Style**: `WorksheetTableStyle` — Gets or sets the style to use on the . -- **TotalsRowRegion**: `WorksheetRegion` — Gets the which represents the region of cells in the totals row of the table. -- **WholeTableRegion**: `WorksheetRegion` — Gets the which represents the region of cells in the whole table, including the header and totals rows, if visible. -- **Worksheet**: `Worksheet` — Gets the to which the table belongs. -- **ClearFilters**(): void — Clears all filters from the columns in the table. -- **ClearSortConditions**(): void — Clears all sort conditions from the columns in the table. -- **DeleteColumns**(tableColumnIndex: int, count: int): void — Deletes one or more columns from the table -- **DeleteDataRows**(dataRowIndex: int, count: int): void — Deletes one or more data rows from the table -- **InsertColumns**(tableColumnIndex: int, count: int): void — Inserts one or more columns into the table -- **InsertDataRows**(dataRowIndex: int, count: int): void — Inserts one or more data rows into the table -- **ReapplyFilters**(): void — Re-filters all data cells in the table based on the filters from the columns in the table. -- **ReapplySortConditions**(): void — Re-sorts all data cells in the table based on the sort conditions from the columns in the table. -- **Resize**(headerAndDataRegion: WorksheetRegion): void — Resizes the table to a new range of data on the worksheet. -- **Resize**(headerAndDataRegionAddress: string): void — Resizes the table to a new range of data on the worksheet. -- **Resize**(headerAndDataRegionAddress: string, cellReferenceMode: CellReferenceMode): void — Resizes the table to a new range of data on the worksheet. -- **ToString**(): string — Gets the string representation of the table. - -### [WorksheetTableAreaFormatsCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetTableAreaFormatsCollection) -A collection of formats for areas of a . - -- **Count**: `int` — Gets the number of area formats in the collection. -- **this[TArea]**: `IWorksheetCellFormat` — Gets the format for the specified area. -- **HasFormat**(area: TArea): bool — Determines whether the area has a non-default format applied. - -### [WorksheetTableCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetTableCollection) -The collection of instances on a . - -- **Count**: `int` — Gets the number of tables in the collection. -- **this[int]**: `WorksheetTable` — Gets the at the specified index. -- **this[string]**: `WorksheetTable` — Gets the with the specified name. -- **Add**(region: string, tableHasHeaders: bool, tableStyle: WorksheetTableStyle): WorksheetTable — Formats a region as a table and adds an associated to the collection. -- **Clear**(): void — Clears the collection and removes all tables from the worksheet. -- **Contains**(table: WorksheetTable): bool — Determines whether the specified is in the collection. -- **Exists**(name: string): bool — Determines whether a with the specified name is in the collection. -- **IndexOf**(table: WorksheetTable): int — Gets the index of the specified in the collection. -- **Remove**(table: WorksheetTable, convertToRange: bool): bool — Removes the from the collection. -- **RemoveAt**(index: int, convertToRange: bool): void — Removes the at the specified index. - -### [WorksheetTableColumn](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetTableColumn) -Represents a column in a . - -- **AreaFormats**: `WorksheetTableAreaFormatsCollection` — Gets the collection of formats used for each area of the column. -- **ColumnFormula**: `Formula` — Gets the formula associated with the data area of the column. -- **DataAreaRegion**: `WorksheetRegion` — Gets the which represents the region of cells in the data area of the column. -- **Filter**: `Filter` — Gets the filter applied to the column. -- **HeaderCell**: `WorksheetCell` — Gets the which represents the header cell for the column. -- **Index**: `int` — Gets the 0-based index of the column in the owning collection. -- **Name**: `string` — Gets or sets the name of the column. -- **SortCondition**: `SortCondition` — Gets or sets the sort condition used to sort the column in the table. -- **Table**: `WorksheetTable` — Gets the to which the column belongs. -- **TotalCell**: `WorksheetCell` — Gets the which represents the total cell for the column. -- **TotalFormula**: `Formula` — Gets or sets the formula to use in the total cell of the column. -- **TotalLabel**: `string` — Gets or sets the text label to use in the total cell of the column. -- **WholeColumnRegion**: `WorksheetRegion` — Gets the which represents the region of cells in the whole column, including the header and total cells, if visible. -- **ApplyAverageFilter**(type: AverageFilterType): AverageFilter — Applies an to the column. -- **ApplyCustomFilter**(condition: CustomFilterCondition): CustomFilter — Applies a to the column. -- **ApplyCustomFilter**(condition1: CustomFilterCondition, condition2: CustomFilterCondition, conditionalOperator: ConditionalOperator): CustomFilter — Applies a to the column. -- **ApplyDatePeriodFilter**(type: DatePeriodFilterType, value: int): DatePeriodFilter — Applies an to the column. -- **ApplyFillFilter**(fill: CellFill): FillFilter — Applies a to the column. -- **ApplyFixedValuesFilter**(includeBlanks: bool, calendarType: CalendarType, dateGroups: FixedDateGroup[]): FixedValuesFilter — Applies a to the column. -- **ApplyFixedValuesFilter**(includeBlanks: bool, calendarType: CalendarType, dateGroups: IEnumerable): FixedValuesFilter — Applies a to the column. -- **ApplyFixedValuesFilter**(includeBlanks: bool, dateGroups: IEnumerable): FixedValuesFilter — Applies a to the column. -- **ApplyFixedValuesFilter**(includeBlanks: bool, displayValues: IEnumerable): FixedValuesFilter — Applies a to the column. -- **ApplyFixedValuesFilter**(includeBlanks: bool, displayValues: string[]): FixedValuesFilter — Applies a to the column. -- **ApplyFontColorFilter**(fontColor: Color): FontColorFilter — Applies a to the column. -- **ApplyFontColorFilter**(fontColorInfo: WorkbookColorInfo): FontColorFilter — Applies a to the column. -- **ApplyIconFilter**(iconSet: FormatConditionIconSet, iconIndex: int?): IconFilter — Applies a to the column. -- **ApplyRelativeDateRangeFilter**(offset: RelativeDateRangeOffset, duration: RelativeDateRangeDuration): RelativeDateRangeFilter — Applies a to the column. -- **ApplyTopOrBottomFilter**(): TopOrBottomFilter — Applies a to the column which will filter in the top 10 values in the list of sorted values. -- **ApplyTopOrBottomFilter**(type: TopOrBottomFilterType, value: int): TopOrBottomFilter — Applies a to the column. -- **ApplyYearToDateFilter**(): YearToDateFilter — Applies a to the column. -- **ClearFilter**(): void — Removes the filter from the column if one is applied. -- **SetColumnFormula**(formula: Formula, overwriteExistingValues: bool): void — Sets the formula to use in the data cells in the column. - -### [WorksheetTableColumnCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetTableColumnCollection) -A read-only collection of all instances which exist in a . - -- **Count**: `int` — Gets the number of instances in the collection. -- **this[int]**: `WorksheetTableColumn` — Gets the at the specified index. -- **this[string]**: `WorksheetTableColumn` — Gets the with the specified name or null if it doesn't exist. -- **Contains**(column: WorksheetTableColumn): bool — Determines whether the specified is in the collection. -- **IndexOf**(column: WorksheetTableColumn): int — Gets the index of the specified in the collection. - -### [WorksheetTableStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetTableStyle) -Represents a style which can be applied to a . - -- **constructor**(name: string): void -- **AlternateColumnStripeWidth**: `int` — Gets or sets the number of columns which will span each alternate column stripe. -- **AlternateRowStripeHeight**: `int` — Gets or sets the number of rows which will span each alternate row stripe. -- **AreaFormats**: `WorksheetTableAreaFormatsCollection` — Gets the collection of formats used for each area of a to which the style is applied. -- **ColumnStripeWidth**: `int` — Gets or sets the number of columns which will span each column stripe. -- **IsCustom**: `bool` — Gets the value indicating whether the style is a custom style. -- **Name**: `string` — Gets or sets the name of the style. -- **RowStripeHeight**: `int` — Gets or sets the number of rows which will span each row stripe. -- **Clone**(name: string): WorksheetTableStyle — Duplicates the style and returns a deep copy. - -### [ArrayProxy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ArrayProxy) -Represents a two-dimensional array of instances used in calculations. - -- **constructor**(): void -- **this[int, int]**: `ExcelCalcValue` — Gets the at the specified index. -- **GetLength**(dimension: int): int — Gets the number of elements in the specified dimension of the array. - -### [ExcelCalcErrorValue](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ExcelCalcErrorValue) -Provides methods and properties used to define and manage a calculation error value. - -- **constructor**(code: ExcelCalcErrorCode): void -- **constructor**(code: ExcelCalcErrorCode, message: string): void -- **constructor**(code: ExcelCalcErrorCode, message: string, value: object): void -- **Code**: `ExcelCalcErrorCode` — Gets the error code for this class instance -- **ErrorValue**: `object` — Gets the error object for this class instance -- **Message**: `string` — Gets error message for this class instance. Note that when setting this property the message is assumed to be localized. -- **ToString**(): string — Return a string message that denotes reason for error - -### [ExcelCalcFunction](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ExcelCalcFunction) -Base class for formula functions. - -- **constructor**(): void -- **MaxArgs**: `int` — Maximum number of arguments required for the function -- **MinArgs**: `int` — Minimum number of arguments required for the function -- **Name**: `string` — Function name used to reference the function in a formula -- **CanParameterBeEnumerable**(parameterIndex: int): bool — Determines whether the parameter at the specified index will accept an enumerable reference. -- **DoesParameterAllowIntermediateResultArray**(parameterIndex: int, isCreatedFromRegionReference: bool): bool — Determines whether the function accepts an intermediate result array created by evaluating a nested function on a per-element basis of an array or region parameter when a single value is expected. -- **Evaluate**(numberStack: ExcelCalcNumberStack, argumentCount: int): ExcelCalcValue — Evaluates the function against the arguments on the number stack. -- **GetArguments**(numberStack: ExcelCalcNumberStack, argumentCount: int, skipEmptyValues: bool): ExcelCalcValue[] — A helper method for extracting the instances from the stack. -- **GetArguments**(numberStack: ExcelCalcNumberStack, argumentCount: int, skipEmptyValues: bool, skipHiddenCells: bool): ExcelCalcValue[] — A helper method for extracting the instances from the stack. -- **PerformEvaluation**(numberStack: ExcelCalcNumberStack, argumentCount: int): void — Evaluates the function against the arguments on the number stack. - -### [ExcelCalcNumberStack](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ExcelCalcNumberStack) -Stack of instances used to evaluate formulas. - -- **constructor**(): void -- **OwningCell**: `WorksheetCell` — Gets the instance whose formula is currently being solved. -- **Clear**(): void — Remove all values from number stack. -- **Count**(): int — Return the number of values on number stack -- **Peek**(): ExcelCalcValue — Return value off top of the number stack. -- **Pop**(): ExcelCalcValue — Pop value off top of the number stack. -- **Push**(value: ExcelCalcValue): void — Push a value onto number stack. -- **Reset**(elements: int): void — Clear elements off top of number stack until it contains given number of elements - -### [ExcelCalcValue](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ExcelCalcValue) -Provides methods that manage a composite data type representing a value. - -- **constructor**(): void -- **constructor**(value: object): void -- **IsArray**: `bool` — Returns whether this class instance contains an array value. -- **IsArrayGroup**: `bool` — Returns whether this class instance contains a group of array values. -- **IsBoolean**: `bool` — Returns whether this class instance contains a boolean value -- **IsDBNull**: `bool` — Returns whether this class instance contains a DBNull value -- **IsDateTime**: `bool` — Returns whether this class instance contains a DateTime value -- **IsError**: `bool` — Returns whether this class instance contains an error value -- **IsNull**: `bool` — Returns whether this class instance contains a null value -- **IsReference**: `bool` — Returns whether this class instance contains a value -- **IsString**: `bool` — Returns whether this class instance contains a string value -- **Value**: `object` — Return the underlying value -- **AreValuesEqual**(x: ExcelCalcValue, y: ExcelCalcValue): bool — Indicates if the value of the specified is equivalent to the -- **CompareTo**(value: ExcelCalcValue): int — Compares current instance with the passed in instance. Returns -1, 1 or 0 depending on whether the current instance is less than, greater than or equal to the passed in instance respectively. -- **CompareTo**(x: ExcelCalcValue, y: ExcelCalcValue): int — Compares x and y instances and returns -1 if x is less than y, 1 if x is greater than y and 0 if x and y are equal. -- **DateTimeToExcelDate**(workbook: Workbook, dateValue: DateTime): double? — Converts a DateTime to Excel's numerical representation of a date. -- **DateTimeToExcelDate**(workbook: Workbook, dateValue: DateTime, shouldCorrect1900Dates: bool): double? — Converts a DateTime to Excel's numerical representation of a date. -- **ExcelDateToDateTime**(workbook: Workbook, excelDate: double): DateTime? — Converts Excel's numerical representation of a date to a DateTime. -- **ExcelDateToDateTime**(workbook: Workbook, excelDate: double, shouldCorrect1900Dates: bool): DateTime? — Converts Excel's numerical representation of a date to a DateTime. -- **ExcelDateToTimeOfDay**(excelDate: double, useDayInfo: bool): TimeSpan — Converts Excel's numerical representation of a time of day to a TimeSpan. -- **GetResolvedValue**(): object — Gets the resolved value of the reference. This method will walk down the reference chain recursively to get the resolved value of the reference that is not just another reference. -- **GetResolvedValue**(willUseValueInCalculations: bool): object — Gets the resolved value of the reference. This method will walk down the reference chain recursively to get the resolved value of the reference that is not just another reference. -- **GetTypeCode**(): TypeCode — Returns the TypeCode for this instance -- **IsSameValue**(value: ExcelCalcValue): bool — Indicates if the specified has the save as this instance. -- **TimeOfDayToExcelDate**(timeValue: TimeSpan, useDayInfo: bool): double — Converts a TimeSpan to Excel's numerical representation of a date. -- **ToArrayProxy**(): ArrayProxy — Convert this class instance's value to an data type. -- **ToArrayProxyGroup**(): ArrayProxy[] — Convert this class instance's value to an array group data type. -- **ToBoolean**(): bool — Convert this class instance's value to a boolean data type -- **ToBoolean**(provider: IFormatProvider): bool — Convert this class instance's value to a boolean data type -- **ToByte**(): byte — Convert this class instance's value to a byte data type -- **ToByte**(provider: IFormatProvider): byte — Convert this class instance's value to a byte data type -- **ToChar**(): char — Convert this class instance's value to a char data type -- **ToChar**(provider: IFormatProvider): char — Convert this class instance's value to a char type -- **ToDateTime**(): DateTime — Convert this class instance's value to a DateTime data type -- **ToDateTime**(provider: IFormatProvider): DateTime — Convert this class instance's value to a DateTime data type -- **ToDecimal**(): decimal — Convert this class instance's value to a decimal data type -- **ToDecimal**(result: decimal): bool — Converts the to a decimal data type -- **ToDecimal**(provider: IFormatProvider): decimal — Convert this class instance's value to a decimal data type -- **ToDouble**(): double — Convert this class instance's value to a double data type -- **ToDouble**(result: double): bool — Converts the to a double data type -- **ToDouble**(provider: IFormatProvider): double — Convert this class instance's value to a double data type -- **ToErrorValue**(): ExcelCalcErrorValue — Convert this instance's value to an -- **ToInt**(): int — Convert this class instance's value to an int -- **ToInt**(provider: IFormatProvider): int — Convert this class instance's value to an int -- **ToInt16**(): short — Convert this class instance's value to a short data type -- **ToInt16**(provider: IFormatProvider): short — Convert this class instance's value to a short data type -- **ToInt32**(): int — Convert this class instance's value to a int data type -- **ToInt32**(provider: IFormatProvider): int — Convert this class instance's value to a int data type -- **ToInt64**(): long — Convert this class instance's value to a long data type -- **ToInt64**(provider: IFormatProvider): long — Convert this class instance's value to a long data type -- **ToReference**(): IExcelCalcReference — Convert this instance's value to a . -- **ToSingle**(): float — Convert this class instance's value to a float data type -- **ToSingle**(provider: IFormatProvider): float — Convert this class instance's value to a float data type -- **ToString**(): string — Returns a string representation of this instance's value. -- **ToString**(provider: IFormatProvider): string — Convert this class instance's value to a string instance data type -- **ToType**(conversionType: Type, provider: IFormatProvider): object — Convert this class instance's value to a uint data type - -### [Axis](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/Axis) -Represents a single axis in a chart. - -- **AxisBetweenCategories**: `bool` — True if the value axis crosses the category axis between categories. -- **AxisGroup**: `AxisGroup` — Returns the group for the specified axis. Read-only -- **AxisTitle**: `ChartTitle` — Returns or sets a object that represents the title of the axis. -- **BaseUnit**: `TimeUnit` — Returns or sets the base unit for the axis. -- **BaseUnitIsAuto**: `bool` — True if Excel chooses appropriate base units for the specified category axis. The default value is True. -- **CategoryType**: `CategoryType` — Returns or sets the category axis type. -- **Crosses**: `AxisCrosses` — Returns or sets the point on the specified axis where the other axis crosses. -- **CrossesAt**: `double` — Returns or sets the point on the at which the perpendicular axis intersects it. -- **DisplayUnit**: `DisplayUnit` — Returns or sets the unit label for the value axis. -- **DisplayUnitCustom**: `double` — If the value of the DisplayUnit property 'Custom' , the DisplayUnitCustom property returns or sets the value of the displayed units. The value must be from 0 through 10E307 -- **DisplayUnitLabel**: `DisplayUnitLabel` — Returns or sets an object. -- **GapWidth**: `double?` — Returns or sets a value indicating the width of the gaps between data points or series, expressed as a percentage. -- **LogBase**: `double` — Returns or sets the base of the logarithm when you are using log scales. -- **MajorGridLines**: `ChartGridLines` — Returns a object which defines the color and weight of the major ticklines. -- **MajorTickMark**: `TickMark` — Returns or sets the type of major tick mark for the specified axis. -- **MajorUnit**: `double` — Returns the major interval unit. -- **MajorUnitIsAuto**: `bool` — True if Excel calculates the major units for the value axis. -- **MajorUnitScale**: `TimeUnit` — Returns or sets the major unit scale value for the category axis when the property is set to 'TimeScale'. -- **MaximumScale**: `double` — Returns or sets the maximum value on the value axis. -- **MaximumScaleIsAuto**: `bool` — True if Excel calculates the maximum value for the value axis. -- **MinimumScale**: `double` — Returns or sets the minimum value on the value axis. -- **MinimumScaleIsAuto**: `bool` — True if Excel calculates the minimum value for the value axis. -- **MinorGridLines**: `ChartGridLines` — Returns a object which defines the color and weight of the minor ticklines. -- **MinorTickMark**: `TickMark` — Returns or sets the type of minor tick mark for the specified axis. -- **MinorUnit**: `double` — Returns the minor interval unit. -- **MinorUnitIsAuto**: `bool` — True if Excel calculates the minor units for the value axis. -- **MinorUnitScale**: `TimeUnit` — Returns or sets the minor unit scale value for the category axis when the property is set to 'TimeScale'. -- **Position**: `AxisPosition` — Returns or sets an value which determines the placement of the axis as relative to the chart space. -- **ReversePlotOrder**: `bool` — True if Excel plots data points from last to first. -- **ScaleType**: `ScaleType` — Returns or sets a value indicating whether the axis scale is linear or logarithmic. -- **TickLabelPosition**: `TickLabelPosition` — Describes the position of tick-mark labels on the specified axis. -- **TickLabelSpacing**: `int` — Returns or sets the number of categories or series between tick-mark labels. Applies only to category and series axes. Can be a value from 1 through 31999. -- **TickLabelSpacingIsAuto**: `bool` — Returns or sets whether or not the tick label spacing is automatic. -- **TickLabels**: `TickLabels` — Returns a TickLabels object that represents the tick-mark labels for the specified axis. Read-only. -- **TickLines**: `ChartTickLines` — Determines the appearance of the tick lines. -- **TickMarkSpacing**: `int` — Returns or sets the number of categories or series between tick marks. Applies only to category and series axes. Can be a value from 1 through 31999. -- **Type**: `AxisType` — Returns the type of the axis (read-only) -- **Visible**: `bool` — Returns or sets whether or not the axis is visible. -- **SetMajorMinorUnit**(majorUnit: double, minorUnit: double): void — Sets the values of the and properties. - -### [AxisCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/AxisCollection) -A collection of objects for a - -- **Count**: `int` — Returns the number of items in the collection (read-only) -- **IsReadOnly**: `bool` — Determines if the collecion can be modified (read-only) -- **this[AxisType, AxisGroup]**: `Axis` — Indexer -- **Add**(type: AxisType, group: AxisGroup): Axis — Adds a new into the collection with the specified type and groupo. -- **Clear**(): void — Clears the collection. -- **GetEnumerator**(): IEnumerator — Gets an enumerator for the items in the collection -- **Remove**(type: AxisType, group: AxisGroup): bool — Removes an axis from the collection. - -### [BoxAndWhiskerSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/BoxAndWhiskerSettings) -Exposes properties related to the BoxAndWhisker chart type. - -- **constructor**(showInnerPoints: bool, showOutlierPoints: bool, showMeanMarkers: bool, showMeanLine: bool, quartileCalculation: QuartileCalculation): void -- **QuartileCalculation**: `QuartileCalculation` — Determines the method for median calculation. -- **ShowInnerPoints**: `bool` — Determines whether inner points appear on a box and whisker chart. -- **ShowMeanLine**: `bool` — Determines whether a mean line appears on a box and whisker chart. -- **ShowMeanMarkers**: `bool` — Determines whether mean markers appear on a box and whisker chart. -- **ShowOutlierPoints**: `bool` — Determines whether outlier points appear on a box and whisker chart. - -### [CategoryAxisBinning](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CategoryAxisBinning) -Exposes properties related to category axis binning. Applicable only for Histogram and Pareto charts. - -- **constructor**(binWidth: double?, overflow: bool, overflowThreshold: double?, underflow: bool, underflowThreshold: double?): void -- **constructor**(numberOfBins: int?, overflow: bool, overflowThreshold: double?, underflow: bool, underflowThreshold: double?): void -- **BinWidth**: `double?` — Returns the number of data points in each range, i.e., how many data points exist in each bin. -- **NumberOfBins**: `int?` — Returns the total number of bins. -- **Overflow**: `bool` — Specifies whether a bin is created for all values above a given threshold. -- **OverflowThreshold**: `double?` — Determines the threshold for the bin. -- **Underflow**: `bool` — Specifies whether a bin is created for all values below a given threshold. -- **UnderflowThreshold**: `double?` — Determines the threshold for the bin. - -### [ChartArea](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartArea) -Represents the area in which the chart is displayed. - - -### [ChartAreaBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartAreaBase) -Base class for chart area elements - -- **Border**: `ChartBorder` — Determines the appearance of the border drawn around the chart element area, as well as whether a border appears. -- **Fill**: `ChartFillBase` — Returns or sets a derived object which defines the fill properties for the chart element area. -- **RoundedCorners**: `bool` — Detrmines if the chart area is displayed with rounded corners - -### [ChartBorder](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartBorder) -Represents the border of a chart element. - -- **constructor**(): void -- **LineStyle**: `BorderLineStyle` — Returns or sets the line style for the border, i.e., solid, dashed, dotted, etc. - -### [ChartDropLines](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartDropLines) -Exposes properties which control the fill and width of the drop lines in a stock chart. - -- **constructor**(): void - -### [ChartEmptyFill](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartEmptyFill) -Placeholder which indicates that no fill should be rendered for the associated chart element. - -- **constructor**(): void - -### [ChartFillBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartFillBase) -Base class for objects which relate to the background fill of a chart element. - - -### [ChartGradientFill](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartGradientFill) -Represents a gradient fill for a chart element. - -- **constructor**(gradientType: GradientType, stops: IEnumerable, angle: double): void -- **Angle**: `double` — Returns the angle defining the path along which the gradient extends; applicable only for linear gradients. -- **GradientType**: `GradientType` — Defines the style for the gradient. -- **GetStops**(): IEnumerable — Returns an enumerable list containing each associated with this gradient, ordered by their . - -### [ChartGridLines](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartGridLines) -Represents the major/minor gridlines for an . - -- **constructor**(): void -- **GridLineType**: `GridLineType` — Returns a value indicating whether this instance represents a major or minor gridline. - -### [ChartHighLowLines](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartHighLowLines) -Exposes properties which control the fill and width of the lines which depict the high and low values in a stock chart. - -- **constructor**(): void - -### [ChartLabelBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartLabelBase) -Base class for chart elements which behave as a label. - -- **NumberFormat**: `string` — Returns or sets the format to use for numbers. -- **NumberFormatLinked**: `bool` — True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). - -### [ChartLine](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartLine) -Exposes properties which control the appearance of a line in a . - -- **constructor**(): void -- **LineStyle**: `LineStyle` — Returns or sets the style for the line, i.e., solid, dashed, dotted, etc. - -### [ChartLineBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartLineBase) -Represents a or . - -- **Fill**: `ChartFillBase` — Returns or sets a derived object which defines the fill color/gradient for the line. -- **WidthInPoints**: `double` — Determines the width of the line, expressed in points. - -### [ChartObject](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartObject) -Abstract base class for objects that are exposed off a - -- **Chart**: `WorksheetChart` — Returns the owning chart (read-only) -- **Owner**: `ChartObject` — returns this object's owner. (read-only) -- **Sheet**: `Sheet` — The owning sheet (read-only) -- **Workbook**: `Workbook` — The owning workbook (read-only) -- **Worksheet**: `Worksheet` — The owning worksheet (read-only) - -### [ChartPatternFill](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartPatternFill) -Represents a pattern color fill for a chart element. - -- **constructor**(backgroundColor: WorkbookColorInfo, foregroundColor: WorkbookColorInfo, pattern: PatternType): void -- **BackgroundColor**: `WorkbookColorInfo` — Returns the color which is applied to the background of the fill. -- **ForegroundColor**: `WorkbookColorInfo` — Returns the color which is applied to the foreground of the fill. -- **Pattern**: `PatternType` — Returns the pattern style of the fill. - -### [ChartSeriesLines](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartSeriesLines) -Exposes properties which control the fill and width of the lines which connect the first and second plot areas in a 'bar of pie' or 'pie of pie' chart. - -- **constructor**(): void - -### [ChartSolidFill](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartSolidFill) -Represents a solid color fill for a chart element. - -- **constructor**(color: WorkbookColorInfo): void -- **Color**: `WorkbookColorInfo` — Returns the color which is applied to the fill. - -### [ChartTextAreaBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartTextAreaBase) -Represents the text area of a chart element. - -- **Border**: `ChartBorder` — Determines the appearance of the border drawn around the text area, as well as whether a border appears. -- **DefaultFont**: `IWorkbookFont` — Defines the font properties for each formatted run in the that has no more specific setting. Read-only. -- **Fill**: `ChartFillBase` — Returns or sets a derived object which defines the fill properties for the text area. -- **Formula**: `Formula` — The formula used to get the text displayed within the text area. (read-only). -- **HorizontalOverflow**: `TextHorizontalOverflow` — Determines whether text is allowed to continue horizontally outside the bounds of the containing element. -- **Left**: `double` — The left position of the text area (ignored unless is set to 'Custom'). -- **Position**: `ElementPosition` — Determines whether the position of the text area is automatic or custom as specified by the and properties. -- **ReadingOrder**: `ReadingOrder` — Determines the reading order -- **Rotation**: `double` — Determines the rotation of the text area, expressed in degrees. -- **Text**: `FormattedString` — Returns or sets a object which defines the text to be displayed by the associated chart element. -- **TextDirection**: `TextDirection` — Determines the orientation and direction in which text flows. -- **Top**: `double` — The top position of the text area (ignored unless is set to 'Custom'). -- **VerticalAlignment**: `VerticalTitleAlignment` — Determines the vertical alignment of the text area. -- **VerticalOverflow**: `TextVerticalOverflow` — Determines whether text is allowed to continue vertically outside the bounds of the containing element. -- **WrapText**: `bool` — Determines whether text is wrapped when it would exceed the bounds of the containing element. -- **SetFormula**(formula: string, cellReferenceMode: CellReferenceMode?): void — Assigns a new to this instance. - -### [ChartTickLines](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartTickLines) -Represents the tick lines for an . - -- **constructor**(): void - -### [ChartTitle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartTitle) -Represents the title of a or . - -- **constructor**(): void -- **Overlay**: `bool` — Determines whether the chart title is laid over the plot area. - -### [ChartsheetDisplayOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartsheetDisplayOptions) -Class which exposes the display options which can only be controlled through the chartsheet. - - -### [ChartsheetDisplayOptionsBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartsheetDisplayOptionsBase) -Base class for the display options for a chart sheet that are used for the display as well as its custom view. - -- **Magnification**: `int` — Gets or sets the magnification level of the chartsheet. -- **SizeWithWindow**: `bool` — Gets or sets whether the chart should be resized to match the size of the chart sheet window. -- **ResetCore**(): void — Resets the display options to their default settings. - -### [ChartsheetPrintOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartsheetPrintOptions) -Class which exposes the various print options available for a chartsheet which can be saved with both a chartsheet and a custom view. - - -### [ChartsheetProtection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ChartsheetProtection) -Provides information about the types of changes that are disabled when the associated Chartsheet is protected. - -- **AllowEditContents**: `bool` — Returns a boolean indicating if the chart is protected when the chartsheet is protected. -- **AllowEditObjects**: `bool` — Returns a boolean indicating if objects such as shapes and controls may be created or changed when the chartsheet is protected. - -### [CustomViewChartDisplayOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CustomViewChartDisplayOptions) -Class which exposes the chartsheet display options which can only be controlled through the custom view. - - -### [DataLabel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DataLabel) -Represents the label of a specific . - -- **constructor**(): void -- **Height**: `double` — Returns or sets a value that represents the height of the label, expressed as a ratio, relative to the size of the chart area. -- **IsDeleted**: `bool` — Returns or sets a boolean value indicating whether this label has been deleted. -- **LabelPosition**: `DataLabelPosition` — Returns or sets a value which determines the label's position as relative to the series bar/line. -- **Separator**: `string` — Returns or sets the separator used between multiple values in the label. -- **ShowBubbleSize**: `ExcelDefaultableBoolean` — Returns or sets if the bubble size is shown. Applies only to which are displayed within a bubble chart. -- **ShowCategoryName**: `ExcelDefaultableBoolean` — Returns or sets a value indicating whether the category name is shown. -- **ShowLegendKey**: `ExcelDefaultableBoolean` — Returns or sets if the key is shown. -- **ShowPercentage**: `ExcelDefaultableBoolean` — Returns or sets a value indicating whether the percentage of the range is shown. -- **ShowRange**: `ExcelDefaultableBoolean` — Returns or sets a boolean value indicating whether the data label range is shown. -- **ShowSeriesName**: `ExcelDefaultableBoolean` — Returns or sets a value indicating whether the series is shown in the label. -- **ShowValue**: `ExcelDefaultableBoolean` — Returns or sets a value indicating whether the value is shown. -- **Width**: `double` — Returns or sets a value that represents the width of the label, expressed as a ratio, relative to the size of the chart area. - -### [DataPoint](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DataPoint) -Represents the a specific data point in a . - -- **ApplyPicToEnd**: `ExcelDefaultableBoolean` — Returns or sets a value indicating whether a picture is applied to the end of the point or all points in the series. -- **ApplyPicToFront**: `ExcelDefaultableBoolean` — Returns or sets a value indicating whether a picture is applied to the front of the point or all points in the series. -- **ApplyPicToSides**: `ExcelDefaultableBoolean` — Returns or sets a value indicating whether a picture is applied to the sides of the point or all points in the series. -- **Border**: `ChartBorder` — Determines the appearance of the border drawn around the data point's area. -- **DataLabel**: `DataLabel` — Returns or sets a instance which defines the properties of the label displayed for this data point. -- **Explosion**: `int?` — Returns or sets the explosion value for a pie-chart or doughnut-chart slice. -- **Fill**: `ChartFillBase` — Returns or sets a derived object which defines the fill properties for the data point. -- **InvertIfNegative**: `ExcelDefaultableBoolean` — Returns or sets a value indicating whether the pattern is inverted in the item when it corresponds to a negative number. -- **MarkerBorder**: `ChartBorder` — Determines the appearance of the (a.k.a. outline) of the marker for this data point. -- **MarkerFill**: `ChartFillBase` — Defines the appearance of the marker for this data point. -- **MarkerSize**: `int?` — Determines the size of the marker for this data point. -- **MarkerStyle**: `MarkerStyle?` — Determines the style of the marker for this data point. -- **SetAsTotal**: `bool` — Returns or sets a boolean value indicating whether this data point represents a total or subtotal in a waterfall chart. - -### [DataPointCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DataPointCollection) -A collection of s for a - -- **Count**: `int` — Returns the number of items in the collection (read-only) -- **this[int]**: `DataPoint` — Returns the instance at the specified ordinal position within this collection. -- **Contains**(item: DataPoint): bool — Determines if the collection contains thhe item -- **GetEnumerator**(): IEnumerator — Gets an enumerator for the items in the collection -- **IndexOf**(item: DataPoint): int — Returns the index of the item in the collection - -### [DisplayUnitLabel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DisplayUnitLabel) -Represents a unit label on an axis in a chart. - -- **constructor**(): void - -### [ErrorBars](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ErrorBars) -Represents the error bars on a chart series. - -- **constructor**(): void -- **Direction**: `ErrorBarDirection` — Returns or sets a value which determines the direction in which the error bars extend from the data points. -- **EndStyle**: `EndStyleCap` — Returns or sets the end style for the error bars. -- **ErrorValueType**: `ErrorValueType` — Returns or sets a value which determines the units used to evaluate the error. -- **Fill**: `ChartFillBase` — Returns or sets a derived object which defines the fill color/gradient for the line. -- **Value**: `double` — Returns or sets a value which defines the error range. -- **WidthInPoints**: `double` — Determines the width of the line, expressed in points. - -### [GeographicMapColors](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/GeographicMapColors) -Exposes properties related to series coloring for a geographic map chart. - -- **constructor**(seriesColor: GeographicMapSeriesColor, minimum: WorkbookColorInfo, midpoint: WorkbookColorInfo, maximum: WorkbookColorInfo): void -- **Maximum**: `WorkbookColorInfo` — Returns the color used for the maximum value. -- **Midpoint**: `WorkbookColorInfo` — Returns the color used for the midpoint value. -- **Minimum**: `WorkbookColorInfo` — Returns the color used for the minimum value. -- **SeriesColor**: `GeographicMapSeriesColor` — Returns a value indicating whether a sequential (two-color) or divergent (three-color) scheme is used to color regions in a geographic map chart. - -### [GeographicMapSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/GeographicMapSettings) -Exposes properties which control the appearance and behavior of a geographic map chart. - -- **constructor**(cultureLanguage: string, cultureRegion: string, attribution: string, projection: GeographicMapProjection?, area: GeographicMappingArea?, labels: GeographicMapLabels, colors: GeographicMapColors): void -- **Area**: `GeographicMappingArea?` — Returns the mapping area for this instance. -- **Attribution**: `string` — Returns the attribution for this instance. -- **Colors**: `GeographicMapColors` — Returns a instance which defines the minimum, midpoint, and maximum colors used for the applicable areas of a geographic map chart. -- **CultureLanguage**: `string` — Returns the culture language for this instance. -- **CultureRegion**: `string` — Returns the culture region for this instance. -- **Labels**: `GeographicMapLabels` — Returns a value indicating the manner in which map area labels are displayed. -- **Projection**: `GeographicMapProjection?` — Returns the map projection for this instance. - -### [GradientStop](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/GradientStop) -Describes the location and color of a transition point in a . - -- **constructor**(color: WorkbookColorInfo, position: float): void -- **Color**: `WorkbookColorInfo` — Returns the color for this gradient stop. -- **Position**: `float` — Returns the position of this gradient stop, as a number between 0 and 1. - -### [LeaderLines](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/LeaderLines) -Represents leader lines on a chart. Leader lines connect data labels to data points. - -- **constructor**(): void - -### [Legend](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/Legend) -Represents the legend in a chart. Each chart can have only one legend. - -- **constructor**(): void -- **Border**: `ChartBorder` — Determines the appearance of the border drawn around the text area, as well as whether a border appears. -- **DefaultFont**: `IWorkbookFont` — Defines the font properties for which have no specific font settings. Read-only. -- **DefaultFontFill**: `ChartFillBase` — Returns or sets a derived object which defines the font color(s) for . -- **Fill**: `ChartFillBase` — Returns or sets a derived object which defines the fill properties for the legend's text area. -- **Height**: `double` — Returns or sets a value that represents the height of the legend area, expressed as a fraction of the chart area's height. -- **Left**: `double` — Returns or sets a value that represents the position of the left edge of the legend area, expressed as a fraction of the chart area's width. -- **LegendEntries**: `LegendEntries` — Returns a read only collection of . -- **Overlay**: `bool` — Returns or sets a boolean value indicating whether the legend can intersect with the chart's plot area. -- **Position**: `LegendPosition` — Returns or sets a value that represents the position of the legend on the chart. -- **Rotation**: `double` — Determines the rotation of the legend's text area, expressed in degrees. -- **TextDirection**: `TextDirection` — Determines the orientation and direction in which text flows. -- **Top**: `double` — Returns or sets a value that represents the position of the top edge of the legend area, expressed as a fraction of the chart area's height. -- **Width**: `double` — Returns or sets a value that represents the width of the legend area, expressed as a fraction of the chart area's width. - -### [LegendEntries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/LegendEntries) -A collection of s for a - -- **Count**: `int` — Returns the number of items in the collection (read-only) -- **this[int]**: `LegendEntry` — Indexer (read-only) -- **Contains**(item: LegendEntry): bool — Determines if the collection contains thhe item -- **GetEnumerator**(): IEnumerator — Gets an enumerator for the items in the collection -- **IndexOf**(item: LegendEntry): int — Returns the index of the item in the collection - -### [LegendEntry](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/LegendEntry) -Represents a legend entry in a chart legend. - -- **Font**: `IWorkbookFont` — Returns or sets the for this legend entry. Read-only. -- **FontFill**: `ChartFillBase` — Returns or sets a derived object which defines the font color(s) for this legend entry. -- **IsDeleted**: `bool` — Returns or sets a boolean value indicating whether this entry has been removed from the - -### [PlotArea](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/PlotArea) -Represents the area in which the chart series is plotted. - -- **Height**: `double` — Returns or sets the height of the area, expressed as a fraction of the height of the containing chart element. -- **Left**: `double` — Returns or sets a value which represents the left edge of the area, expressed as a fraction of the width of the containing chart element. -- **Position**: `ElementPosition` — Returns or sets the position of the plot area on the chart. -- **Top**: `double` — Returns or sets a value which represents the top edge of the area, expressed as a fraction of the height of the containing chart element. -- **Width**: `double` — Returns or sets the width of the area, expressed as a fraction of the width of the containing chart element. - -### [Series](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/Series) -An object that represents a specific series in a chart - -- **ApplyPicToEnd**: `bool` — Apply the picture to the end of the series. -- **ApplyPicToFront**: `bool` — Apply the picture to the front of the series. -- **ApplyPicToSides**: `bool` — Apply the picture to the sides. -- **AxisBinning**: `CategoryAxisBinning` — Returns or sets a instance which determines the binning properties for the category axis on a histogram or pareto chart. -- **AxisGroup**: `AxisGroup` — Specifies which axis group this series applies to. -- **BarShape**: `BarShape?` — Determines the shape of the bar for this series. Applicable only for 3D bar charts. -- **BarShapeResolved**: `BarShape` — Returns the resolved value of the property. -- **Border**: `ChartBorder` — Determines the appearance of the border drawn around the area. Applicable only for chart series which support fills, such as bar charts, area charts, and pie charts. -- **BoxAndWhiskerSettings**: `BoxAndWhiskerSettings` — Returns or sets a instance which determines the properties for a box and whisker chart. -- **BubbleSizes**: `SeriesValues` — Returns or sets a instance that determines the bubble sizes in a bubble chart. -- **ChartType**: `ChartType` — Specifies the type of chart for this series. Applicable only for combo charts. -- **DataLabels**: `SeriesDataLabels` — Returns a instance which applies to all instances which do not have a specific setting for a given property. -- **DataPointCollection**: `DataPointCollection` — Returns a of instances which represent the individual data points in this series. -- **ErrorBars**: `ErrorBars` — Returns or sets an object. -- **Explosion**: `int` — Returns or sets a value which determines the amount by which individual slices are offset from the center of the pie or doughnut, expressed as a percentage of the radius. -- **Fill**: `ChartFillBase` — Returns or sets a derived object which defines the fill for this series. Not applicable for line charts. -- **GeographicMapSettings**: `GeographicMapSettings` — Returns or sets a instance which defines the appearance and behavior for a geographic map chart. -- **InvertIfNegative**: `bool` — Determines if negative values will be inverted. -- **LeaderLines**: `LeaderLines` — Returns or sets the instance. -- **Line**: `ChartLine` — Determines the and of a series line. -- **MarkerBorder**: `ChartBorder` — Determines the appearance of the (a.k.a. outline) for the marker. -- **MarkerFill**: `ChartFillBase` — Defines the appearance for the marker. -- **MarkerSize**: `int` — Determines the size of the markers. -- **MarkerStyle**: `MarkerStyle` — Determines the style of the markers -- **Name**: `SeriesName` — The name of the series -- **OwningSeries**: `Series` — Returns or sets a reference to the owning . Applicable only for a line series in a Pareto chart. -- **PictureType**: `PictureType` — Determines whether pictures are scaled, stacked, or stretched. -- **PictureUnit**: `double` — Returns or sets a value which defines the unit of measure when is set to Stack. -- **PlotOrder**: `int` — The plotting order for the data series. -- **ShowDataLabels**: `bool` — Returns or sets a boolean value indicating whether to display . -- **ShowWaterfallConnectorLines**: `bool` — Returns or sets a boolean value indicating whether to display connecting lines between the data points in a waterfall chart. -- **Smooth**: `bool` — Determines whether a smoothing effect should be applied. -- **TrendlineCollection**: `TrendlineCollection` — Returns a collection of instances for this series. -- **Type**: `SeriesType` — Returns or sets a value which determines the type of this series. Applicable only for combo charts. -- **Values**: `SeriesValues` — Returns or sets a instance that contains a collection of all the values in the series. -- **XValues**: `XValues` — Returns or sets a instance that contains a collection of all the x values in the series. - -### [SeriesCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/SeriesCollection) -A collection of for a - -- **Count**: `int` — Returns the number of items in the collection (read-only) -- **IsReadOnly**: `bool` — Determines if the collecion can be modified (read-only) -- **this[int]**: `Series` — Indexer -- **Add**(): Series — Adds a new series to the collection -- **Clear**(): void — Clears the collection. -- **Contains**(item: Series): bool — Determines if the collection contains thhe item -- **GetEnumerator**(): IEnumerator — Gets an enumerator for the items in the collection -- **IndexOf**(item: Series): int — Returns the index of the item in the collection -- **Insert**(index: int): Series — Inserts a new into the collection at the specified index. -- **Remove**(item: Series): bool — Removes an item from the collection. -- **RemoveAt**(index: int): void — Removes the series at the specified index - -### [SeriesDataLabels](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/SeriesDataLabels) -Defines the properties for all displayed for this . - -- **DataLabelsRange**: `Formula` — Returns a which defines the cell range from which part or all of the label text is obtained. -- **ParentLabelLayout**: `ParentLabelLayout` — Returns or sets a value which determines the label positioning for a Treemap chart. -- **ShowLeaderLines**: `bool` — Returns or sets a boolean value indicating whether are displayed for the data labels associated with this instance. -- **SetDataLabelsRange**(formula: string, cellReferenceMode: CellReferenceMode?): void — Assigns a to the - -### [SeriesName](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/SeriesName) -Defines the name of a series - -- **constructor**(sheet: Sheet, formula: string, cellReferenceMode: CellReferenceMode?): void -- **constructor**(name: string): void -- **ToString**(): string — Gets the string representation of the . - -### [SeriesValues](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/SeriesValues) -Defines a set of values in a series - -- **constructor**(sheet: Sheet, sourceRange: string, cellReferenceMode: CellReferenceMode?, colorBy: SeriesValuesColorBy): void -- **constructor**(values: IEnumerable): void - -### [SeriesValuesBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/SeriesValuesBase) -Abstract base class that defines a set of values in a . - -- **constructor**(sheet: Sheet, formula: string, cellReferenceMode: CellReferenceMode?): void -- **constructor**(values: IEnumerable): void -- **GetValues**(): object[] — Returns an object array containing the value of each data point in the associated . - -### [TickLabels](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/TickLabels) -Represents the tick-mark labels associated with tick marks on a chart . - -- **Alignment**: `TickLabelAlignment` — Specifies the alignment of the tick labels -- **Fill**: `ChartFillBase` — Returns or sets a derived object which defines the fill applied to the background of tick labels. -- **Font**: `IWorkbookFont` — Specifies which font to use. Read-only. -- **MultiLevel**: `bool` — Specifies whether an axis is multilevel or not. -- **NumberFormat**: `string` — Returns or sets the format to use for numbers. -- **NumberFormatLinked**: `bool` — True if the number format is linked to the cells (so that the number format changes in the labels when it changes in the cells). -- **Offset**: `int` — Returns or sets a Long value that represents the distance between the levels of labels, and the distance between the first level and the axis line. -- **ReadingOrder**: `ReadingOrder` — Determines the reading order -- **Rotation**: `double` — Determines the rotation of the text area, expressed in degrees. -- **TextDirection**: `TextDirection` — Determines the orientation and direction in which text flows. - -### [Trendline](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/Trendline) -Represents a trendline. - -- **Backward**: `double` — Specifies the number of periods or units by which the trendline extends backward. -- **Forward**: `double` — Specifies the number of periods or units by which the trendline extends forward. -- **Intercept**: `double?` — Specifies the value axis intercept for the trendline. -- **Label**: `TrendlineLabel` — Returns or sets a instance which determines the text and appearance of the trendline label. -- **LegendEntry**: `LegendEntry` — Returns a instance which determines the appearance of this trendline's appearance in the . -- **Line**: `TrendlineLine` — Returns or sets a instance which controls the color and width of the trendline. -- **Name**: `string` — Specifies the name of the trendline. -- **Order**: `TrendlinePolynomialOrder` — Specifies the order/degree of the polynomial function which defines the trendline. Applicable only when the property is set to Polynomial. -- **Period**: `int` — Specifies the period for a moving-average trendline. Applicable only when the property is set to MovingAverage. -- **TrendlineType**: `TrendlineType` — Specifies the type of trendline, i.e., linear, exponential, polynomial, etc. - -### [TrendlineCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/TrendlineCollection) -A collection of objects belonging to the same . - -- **Count**: `int` — Returns the number of items in the collection (read-only) -- **IsReadOnly**: `bool` — Determines if the collecion can be modified (read-only) -- **this[int]**: `Trendline` — Returns the instance at the specified ordinal position within the collection. -- **Add**(): Trendline — Adds a new to the collection -- **Clear**(): void — Clears the collection. -- **Contains**(item: Trendline): bool — Returns a boolean value indicating whether the specified instance is contained within this collection. -- **GetEnumerator**(): IEnumerator — Gets an enumerator for the items in the collection -- **IndexOf**(item: Trendline): int — Returns the index of the item in the collection. -- **Insert**(index: int): Trendline — Inserts a new into the collection at the specified index. -- **Remove**(item: Trendline): bool — Removes an item from the collection. -- **RemoveAt**(index: int): void — Removes the series at the specified index - -### [TrendlineLabel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/TrendlineLabel) -Represents a label. - -- **constructor**(): void -- **DisplayEquation**: `bool` — Returns or sets a boolean value indicating whether the default trendline equation is displayed within the label. -- **DisplayRSquared**: `bool` — Returns or sets a boolean value indicating whether the default R-squared function is displayed within the label. - -### [TrendlineLine](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/TrendlineLine) -Represents the title of a or . - -- **constructor**(): void - -### [UpDownBar](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/UpDownBar) -Represents the bar which depicts gain or loss on a stock chart. - -- **BarType**: `UpDownBarType` — Returns a value which identifies this instance as as up or down bar. -- **Border**: `ChartBorder` — Determines the appearance of the border drawn around the bar, as well as whether a border appears. -- **Fill**: `ChartFillBase` — Returns or sets a derived object which defines the fill properties for the bar. - -### [UpDownBars](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/UpDownBars) -Represents the bars which depict gain or loss on a stock chart. - -- **constructor**(): void -- **DownBar**: `UpDownBar` — Returns an instance which controls the appearance of the down bars for a stock chart. -- **GapWidth**: `int` — Specifies the width of the gap between bars. -- **UpBar**: `UpDownBar` — Returns an instance which controls the appearance of the up bars for a stock chart. - -### [Wall](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/Wall) -Represents the walls and floor of a 3-D chart. This object isn't a collection. There's no object that represents a single wall; you must return all the walls as a unit. - -- **Border**: `ChartBorder` — Determines the appearance of the border drawn around the text area, as well as whether a border appears. -- **Fill**: `ChartFillBase` — Returns or sets a derived object which defines the fill for this series. -- **Thickness**: `int` — The thickness of the wall -- **Type**: `WallType` — Returns the type of the wall, i.e., back, side, floor, or all. - -### [XValues](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/XValues) -Defines a set of values in a series - -- **constructor**(sheet: Sheet, formula: string, cellReferenceMode: CellReferenceMode?): void -- **constructor**(values: IEnumerable): void -- **GetValues**(): object[] — Returns the actual values for this instance. - -### [AverageConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/AverageConditionalFormat) -Exposes properties which control the visual attributes of a based on whether a cell's value is above or below the average or standard deviation for the associated range. - -- **AboveBelow**: `FormatConditionAboveBelow` — Returns or sets a value which determines the manner in which cell values are compared against the average or standard deviation for the associated range. -- **NumericStandardDeviation**: `int` — Returns or sets the numeric standard deviation for this condition. Applicable only when the property is set to 'AboveStandardDeviation' or 'BelowStandardDeviation'. - -### [BlanksConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/BlanksConditionalFormat) -Exposes properties which control the visual attributes of a based on whether the cell's value is not set. - - -### [CellConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CellConditionalFormat) -Represents the aggregated conditioal format for a specific cell. It is returned via the and the methods. - -- **CellFormat**: `IWorksheetCellFormat` — Returns a cell format that represents the aggregated format for all conditional formats that apply to the cell (read-only). -- **DataBarInfo**: `CellDataBarInfo` — Returns a data bar info if applicable, otherwise null (read-only). -- **HasConditionFormatting**: `bool` — Returns whether this cell has conditional formatting applied (read-only) -- **IconInfo**: `CellIconInfo` — Returns an icon info if applicable, otherwise null (read-only). - -### [CellDataBarInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CellDataBarInfo) -Exposes the information necessary for drawing a data bar for a specific cell. - -- **AxisColor**: `WorkbookColorInfo` — The color to use to draw the axis line or null if no axis line is to be drawn (read-only). -- **AxisPosition**: `double` — Specifies the position, as a percentage of the cell width, where the axis ahould be rendered (read-only) -- **BarBorder**: `WorkbookColorInfo` — The color to use to draw the border around the data bar or null if no border is to be drawn (read-only). -- **BarColor**: `WorkbookColorInfo` — The color to use to draw the data bar (read-only). -- **BarFillType**: `DataBarFillType` — Specifies whether the data bar should be filled with a sold color or a gradient (read-only). -- **BarPositionFrom**: `double` — Species the position, as a percentage of the cell width, where the data bar should begin (read-only). -- **BarPositionTo**: `double` — Species the position, as a percentage of the cell width, where the data bar should end (read-only). -- **Direction**: `DataBarDirection` — Specifies the direction of the bata bar (read-only). -- **IsNegative**: `bool` — Returns true if the cell value is negative (read-only). -- **ShowValue**: `bool` — Returns whether the cell value is to be shown along with the data bar (read-only). - -### [CellIconInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CellIconInfo) -Exposes the information necessary for drawing an icon for a specific cell. - -- **Icon**: `FormatConditionIcon` — The icon to be drawn (read-only). -- **IconIndex**: `int` — The index of the icon in the icon set (read-only). -- **IconSet**: `FormatConditionIconSet` — The icon set (read-only). -- **ShowValue**: `bool` — Returns whether the cell value is to be shown along with the data bar (read-only). - -### [ColorScaleConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ColorScaleConditionalFormat) -Exposes properties which control the coloring of a based on the cell's value as relative to minimum, midpoint, and maximum threshold values. - -- **ColorScaleType**: `ColorScaleType` — Returns a value which identifies this instance as a 2-color or 3-color scale. -- **MaximumThreshold**: `ColorScaleCriterion` — Returns a object which defines the properties of the maximum threshold for this instance. -- **MidpointThreshold**: `ColorScaleCriterion` — Returns a object which defines the properties of the midpoint threshold for this instance. -- **MinimumThreshold**: `ColorScaleCriterion` — Returns a object which defines the properties of the minimum threshold for this instance. - -### [ColorScaleCriterion](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ColorScaleCriterion) -Defines the criterion for a threshold. - -- **FormatColor**: `WorkbookColorInfo` — Returns or sets a object which defines the color information for the threshold associated with this instance. -- **ToString**(): string — Returns the string representation of this instance. - -### [ConditionBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ConditionBase) -Abstract base class which encapsulates the condition for a formatting rule. - -- **constructor**(): void -- **ConditionType**: `FormatConditionType` — Returns a value which identifies the type of condition for this instance. -- **Priority**: `int` — Returns or sets a value which determines the order of evaluation when multiple conditional formatting rules exist. -- **Regions**: `ReadOnlyCollection` — Returns the which identifies the cell range with which this condition is associated. -- **StopIfTrue**: `bool` — Returns or sets a boolean indicating whether additional formatting rules are evaluated if this rule evaluates to true. Applicable only in the case where the containing contains more than one element. -- **Workbook**: `Workbook` — Returns a reference to the associated workbook. -- **Worksheet**: `Worksheet` — Returns a reference to the associated worksheet. -- **SetFirstPriority**(): void — Sets the value for this rule such that it is the first condition to be evaluated. Applicable only in the case where there is more than one element contained within the associated . -- **SetLastPriority**(): void — Sets the value for this rule such that it is the last condition to be evaluated. Applicable only in the case where there is more than one element contained within the associated . -- **SetRegions**(regionAddress: string, cellReferenceMode: CellReferenceMode?): void — Replaces the existing regions with new ones - -### [ConditionValue](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ConditionValue) -Exposes properties which define the value and its unit of measure for a conditional format threshold. - -- **Formula**: `Formula` — Returns the which determines whether cell values meet the criteria defined by the associated condition. -- **Value**: `double` — Returns the numeric value for this instance. -- **ValueType**: `FormatConditionValueType` — Returns a value which specifies the manner in which the threshold values for this instance are determined. -- **SetFormula**(formula: string, cellReferenceMode: CellReferenceMode?, valueType: FormatConditionValueType): void — Assigns the specified formula to the property, and assigns a value of Formula to the property. -- **SetValue**(valueType: FormatConditionValueType): void — Sets the property to the specified value. -- **SetValue**(value: double, valueType: FormatConditionValueType): void — Sets the and properties to the specified values. -- **ToString**(): string — Returns the string representation of this instance. - -### [ConditionalFormatBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ConditionalFormatBase) -Abstract base class for classes which control the visual attributes of a , based on whether the cell's value meets a logical condition. - -- **constructor**(): void -- **CellFormat**: `IWorksheetCellFormat` — Returns an interface implementation which represents the format for cells which meet the criteria associated with this condition. - -### [ConditionalFormatCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ConditionalFormatCollection) -Collection class for objects which derive from . - -- **Count**: `int` — Returns the total number of items in the collection. -- **this[int]**: `ConditionBase` — Indexer -- **AddAverageCondition**(regionAddress: string, aboveBelow: FormatConditionAboveBelow): AverageConditionalFormat — Adds a new instance to this collection. -- **AddBlanksCondition**(regionAddress: string): BlanksConditionalFormat — Adds a new instance to this collection. -- **AddColorScaleCondition**(regionAddress: string, colorScaleType: ColorScaleType): ColorScaleConditionalFormat — Adds a new instance to this collection. -- **AddDataBarCondition**(regionAddress: string): DataBarConditionalFormat — Adds a new instance to this collection. -- **AddDateTimeCondition**(regionAddress: string, dateOperator: FormatConditionTimePeriod): DateTimeConditionalFormat — Adds a new instance to this collection. -- **AddDuplicateCondition**(regionAddress: string): DuplicateConditionalFormat — Adds a new instance to this collection, configured as a duplicate value condition. -- **AddErrorsCondition**(regionAddress: string): ErrorsConditionalFormat — Adds a new instance to this collection. -- **AddFormulaCondition**(regionAddress: string, formula: string, cellReferenceMode: CellReferenceMode?): FormulaConditionalFormat — Adds a new instance to this collection. -- **AddIconSetCondition**(regionAddress: string, iconSet: FormatConditionIconSet): IconSetConditionalFormat — Adds a new instance to this collection. -- **AddNoBlanksCondition**(regionAddress: string): NoBlanksConditionalFormat — Adds a new instance to this collection. -- **AddNoErrorsCondition**(regionAddress: string): NoErrorsConditionalFormat — Adds a new instance to this collection. -- **AddOperatorCondition**(regionAddress: string, conditionOperator: FormatConditionOperator): OperatorConditionalFormat — Adds a new instance to this collection. -- **AddRankCondition**(regionAddress: string, topBottom: FormatConditionTopBottom, rank: int): RankConditionalFormat — Adds a new instance to this collection. -- **AddTextCondition**(regionAddress: string, text: string, textOperator: FormatConditionTextOperator): TextOperatorConditionalFormat — Adds a new instance to this collection. -- **AddUniqueCondition**(regionAddress: string): UniqueConditionalFormat — Adds a new instance to this collection, configured as a unique value condition. -- **Clear**(): void — Removes all items from the collection. -- **Contains**(condition: ConditionBase): bool — Returns true if the collection contains the condition -- **GetEnumerator**(): IEnumerator — Returns an enumerator for the items in the collection. -- **IndexOf**(condition: ConditionBase): int — Gets the index of the item in the collection -- **Remove**(condition: ConditionBase): bool — Removes an item from the collection -- **RemoveAt**(index: int): void — Removes an item from the collection at a specifoed index - -### [CriterionBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CriterionBase) -Base class for the and classes. - -- **Formula**: `Formula` — Returns the which determines whether cell values meet the criteria defined by the associated condition. -- **Value**: `double` — Returns the numeric value for this instance. -- **ValueType**: `FormatConditionValueType` — Returns a value which specifies the manner in which the threshold values for this instance are determined. -- **SetFormula**(formula: string, cellReferenceMode: CellReferenceMode?, valueType: FormatConditionValueType): void — Assigns the specified formula to the property, and assigns a value of Formula to the property. -- **SetValue**(valueType: FormatConditionValueType): void — Sets the property to the specified value. -- **SetValue**(value: double, valueType: FormatConditionValueType): void — Sets the and properties to the specified values. - -### [DataBarConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DataBarConditionalFormat) -Exposes properties which displays data bars in a based on the cell's value as relative to the associated range. - -- **AxisColor**: `WorkbookColorInfo` — Returns or sets a object which defines the color of the axis. -- **AxisPosition**: `DataBarAxisPosition` — Returns or sets a value which determines whether an axis is displayed. -- **BarBorderColor**: `WorkbookColorInfo` — Returns or sets a object which defines the border color of the data bar. -- **BarColor**: `WorkbookColorInfo` — Returns or sets a object which defines the fill color of the data bar. -- **BarFillType**: `DataBarFillType` — Returns or sets a value which determines whether the data bar is filled with a solid color or a gradient. -- **Direction**: `DataBarDirection` — Returns or sets a value which determines the direction in which the data bar extends. -- **FillPercentMax**: `int` — Returns or sets an integer value which determines the length of the longest data bar, expressed as a percentage of the cell's width. -- **FillPercentMin**: `int` — Returns or sets an integer value which determines the length of the shortest data bar, expressed as a percentage of the cell's width. -- **MaxPoint**: `ConditionValue` — Returns or sets a value which determines the manner in which the longest bar is evaluated for this condition. -- **MinPoint**: `ConditionValue` — Returns or sets a value which determines the manner in which the shortest bar is evaluated for this condition. -- **NegativeBarFormat**: `NegativeBarFormat` — Returns a object which defines the visual attributes of negative-value data bars. -- **ShowBorder**: `bool` — Returns or sets a boolean value indicating whether borders are displayed for both negative-value and positive-value databars. -- **ShowValue**: `bool` — Returns or sets a boolean value indicating whether the cell value is shown along with the data bar. - -### [DateTimeConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DateTimeConditionalFormat) -Exposes properties which control the visual attributes of a based on whether a cell's date/time value falls within a given range of time. - -- **DateOperator**: `FormatConditionTimePeriod` — Returns or sets a value which defines the range of time against which cell values are compared when evaluating this condition. - -### [DuplicateConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DuplicateConditionalFormat) -Exposes properties which control the visual attributes of a based on whether a cell's value is unique or duplicated across the associated range. - - -### [ErrorsConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ErrorsConditionalFormat) -Exposes properties which control the visual attributes of a based on whether the cell's value is in error. - - -### [FormulaConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FormulaConditionalFormat) -Exposes properties which control the visual attributes of a based on whether the cell's value meets the criteria defined by a . - -- **Formula**: `Formula` — Returns or sets the which defines the criteria for this condition. -- **SetFormula**(formula: string, cellReferenceMode: CellReferenceMode?): void — Assigns a new to this instance. - -### [IconCriterion](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/IconCriterion) -Defines the criterion for an threshold. - -- **Comparison**: `ThresholdComparison` — Returns or sets a value which determines whether a "greater than" or "greater than or equal to" comparison is made when comparing cell values to the of this instance. -- **Icon**: `FormatConditionIcon` — Returns or sets a value which identifies the icon displayed for this threshold as defined by the and properties. -- **IconSet**: `FormatConditionIconSet` — Returns a value which identifies the icon set that includes this icon (read-only). - -### [IconSetConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/IconSetConditionalFormat) -Exposes properties which displays icons in a based on the cell's value as relative to threshold values. - -- **IconCriteria**: `IconSetCriterionCollection` — Returns a which defines the criteria for this condition. -- **IconSet**: `FormatConditionIconSet` — Returns or sets a value which identifies the set of icons used to express this condition. -- **IsCustom**: `bool` — Returns true if the property of one or more returns a value which is from a different icon set as the one returned from the property. -- **IsReverseOrder**: `bool` — Returns or sets a boolean value indicating whether the order in which icons appear is reversed. -- **ShowValue**: `bool` — Returns or sets a boolean value indicating whether the cell value is shown along with the icon. - -### [IconSetCriterionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/IconSetCriterionCollection) -Collection class for objects of type . - -- **Count**: `int` — Returns the number of objects contained within this collection. -- **this[int]**: `IconCriterion` — Returns the object corresponding to the specified index. - -### [NegativeBarFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/NegativeBarFormat) -Exposes properties which control the appearance of negative-value . - -- **BarBorderColor**: `WorkbookColorInfo` — Returns a which defines the border color applied to data bars with a negative value. -- **BarBorderColorType**: `DataBarNegativeBarColorType` — Returns or sets a value which specifies whether the same border color as that which is used for data bars with positive cell values is also used for data bars with negative cell values. -- **BarColor**: `WorkbookColorInfo` — Returns a which defines the fill color applied to data bars with a negative value. -- **BarColorType**: `DataBarNegativeBarColorType` — Returns or sets a value which specifies whether the same color as that which is used for the positive data bars is used. - -### [NoBlanksConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/NoBlanksConditionalFormat) -Exposes properties which control the visual attributes of a based on whether the cell's value is not set. - - -### [NoErrorsConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/NoErrorsConditionalFormat) -Exposes properties which control the visual attributes of a based on whether the cell's value is in error. - - -### [OperatorConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/OperatorConditionalFormat) -Exposes properties which control the visual attributes of a based on whether the cell's value meets the criteria defined by a logical operator. - -- **Operand1**: `Formula` — Returns the which defines the criteria for the first operand of this condition. -- **Operand2**: `Formula` — Returns or sets a for the second operand which defines the criteria for this condition when the property is set to Between or NotBetween -- **Operator**: `FormatConditionOperator` — Returns a constant which determines the manner in which the cell value is compared against the property. -- **SetOperand1**(value: DateTime): void — Assigns the specified System.DateTime value to the property. -- **SetOperand1**(value: double): void — Assigns the specified System.Double value to the property. -- **SetOperand1**(value: string): void — Assigns the specified System.String value to the property. -- **SetOperand1Formula**(formula: string, cellReferenceMode: CellReferenceMode?): void — Assigns a to the property. -- **SetOperand2**(value: DateTime): void — Assigns the specified System.DateTime value to the property. -- **SetOperand2**(value: double): void — Assigns the specified System.Double value to the property. -- **SetOperand2**(value: string): void — Assigns the specified System.String value to the property. -- **SetOperand2Formula**(formula: string, cellReferenceMode: CellReferenceMode?): void — Assigns a to the property. - -### [RankConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/RankConditionalFormat) -Exposes properties which control the visual attributes of a based on whether a cell's value is within the top or bottom rank of values across the associated range. - -- **IsPercent**: `bool` — Returns or sets a boolean value indicating whether the is determined by a percentage value. -- **Rank**: `int` — Returns or sets a value which specifies either the number or percentage of the rank value for the associated condition. -- **TopBottom**: `FormatConditionTopBottom` — Returns or sets a value indicating whether a cell value must fall within the top or bottom of the ranking across the associated range. - -### [TextOperatorConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/TextOperatorConditionalFormat) -Exposes properties which control the visual attributes of a based on whether the cell's text value meets the criteria defined by a string and a value. - -- **Text**: `string` — Returns or sets the string value against which cell text is compared. -- **TextFormula**: `Formula` — Returns the which defines the string value against which cell text is compared. -- **TextOperator**: `FormatConditionTextOperator` — Returns or sets a value which determines the manner in which the cell text is compared to the value of the property. -- **SetTextFormula**(formula: string, cellReferenceMode: CellReferenceMode?): void — Assigns a to the property. - -### [ThresholdConditionBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/ThresholdConditionBase) -Base class for the , , and classes. - -- **constructor**(): void -- **Formula**: `Formula` — Returns the which determines the values to which this condition applies. -- **SetFormula**(formula: string, cellReferenceMode: CellReferenceMode?): void — Assigns a new to the property. - -### [UniqueConditionalFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/UniqueConditionalFormat) -Exposes properties which control the visual attributes of a based on whether a cell's value is unique across the associated range. - - -### [AverageFilter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/AverageFilter) -Represents a filter which can filter data based on whether the data is below or above the average of the entire data range. - -- **Average**: `double` — Gets the average that was computed the last time the filter was applied or 0 if any errors or all non-numeric values were found when applying the filter. -- **Type**: `AverageFilterType` — Gets or sets the value indicating whether to filter in values below or above the average of the data range. - -### [CustomFilter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CustomFilter) -Represents a filter which can filter data based on one or two custom conditions. - -- **Condition1**: `CustomFilterCondition` — Gets or sets the first condition by which to filter the cells in the data range. -- **Condition2**: `CustomFilterCondition` — Gets or sets the second condition by which to filter the cells in the data range. -- **ConditionalOperator**: `ConditionalOperator` — Gets or sets the operator which defines how to logically combine and - -### [CustomFilterCondition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CustomFilterCondition) -A filter condition used in a . - -- **constructor**(comparisonOperator: ExcelComparisonOperator, value: DateTime): void -- **constructor**(comparisonOperator: ExcelComparisonOperator, value: double): void -- **constructor**(comparisonOperator: ExcelComparisonOperator, value: string): void -- **constructor**(comparisonOperator: ExcelComparisonOperator, value: TimeSpan): void -- **ComparisonOperator**: `ExcelComparisonOperator` — Gets the operator which describes how the cell values should be compared against . -- **Value**: `object` — Gets the value against which the cell values should be compared. -- **Equals**(obj: object): bool — Determines whether the is equal to the specified object. -- **GetHashCode**(): int — Gets the hash code for the . - -### [DatePeriodFilter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DatePeriodFilter) -Represents a filter which can filter dates in a specific period. - -- **Type**: `DatePeriodFilterType` — Gets or sets the type of date period to filter in. -- **Value**: `int` — Gets or sets the 1-based value of the month or quarter to filter in. - -### [DateRangeFilter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DateRangeFilter) -Abstract base class for filters which filter dates based on whether they are within a specified range of dates or not. - -- **End**: `DateTime` — Gets the exclusive end date of the filtered in date range. -- **Start**: `DateTime` — Gets the inclusive start date of the filtered in date range. - -### [DynamicValuesFilter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DynamicValuesFilter) -Abstract base class for all filter types which filter data based on a dynamic condition, such as the data present in the filtered data range, the date when the filter was applied, or the date when the filter is evaluated. - - -### [FillFilter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FillFilter) -Represents a filter which will filter cells based on their background fills. - -- **Fill**: `CellFill` — Gets or sets the by which the cells should be filtered. - -### [Filter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/Filter) -Abstract base class for all filters which filters cells in a worksheet. - - -### [FixedDateGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FixedDateGroup) -Represents a fixed range of dates. - -- **constructor**(type: FixedDateGroupType, value: DateTime): void -- **End**: `DateTime` — Gets the exclusive end date of the accepted date range with a of None. -- **Start**: `DateTime` — Gets the inclusive start date of the accepted date range with a of None. -- **Type**: `FixedDateGroupType` — Gets the type, or precision, of the group. -- **Value**: `DateTime` — Gets the reference date which determines range of accepted dates. -- **Equals**(obj: object): bool — Determines whether the is equal to the specified object. -- **GetHashCode**(): int — Gets the hash code for the . -- **GetRange**(calendarType: CalendarType, start: DateTime, end: DateTime): void — Gets the accepted date range based on the specified calendar type. - -### [FixedDateGroupCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FixedDateGroupCollection) -A collection of fixed date groups. - -- **Count**: `int` — Gets the number of fixed date groups in the collection. -- **this[int]**: `FixedDateGroup` — Gets or sets the fixed date group at the specified index. -- **Add**(item: FixedDateGroup): void — Adds a fixed date group to the collection. -- **Clear**(): void — Clears the collection. -- **Contains**(item: FixedDateGroup): bool — Determines whether the specified fixed date group is in the collection. -- **IndexOf**(item: FixedDateGroup): int — Gets the index of the specified fixed date group in the collection. -- **Insert**(index: int, item: FixedDateGroup): void — Inserts a fixed date group into the collection. -- **Remove**(item: FixedDateGroup): bool — Removes the fixed date group from the collection. -- **RemoveAt**(index: int): void — Removes the fixed date group at the specified index. - -### [FixedValuesFilter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FixedValuesFilter) -Represents a filter which can filter cells based on specific, fixed values, which are allowed to display. - -- **CalendarType**: `CalendarType` — Gets or sets the calendar type used to interpret values in the collection. -- **DateGroups**: `FixedDateGroupCollection` — Gets the collection of fixed date groups which should be filtered in. -- **DisplayValues**: `DisplayValueCollection` — Gets the collection of cell text values which should be filtered in. -- **IncludeBlanks**: `bool` — Gets or sets the value which indicates whether blank cells should be filtered in. - -### [FontColorFilter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FontColorFilter) -Represents a filter which will filter cells based on their font colors. - -- **FontColorInfo**: `WorkbookColorInfo` — Gets or sets the which describes the font color by which the cells should be filtered. - -### [IconFilter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/IconFilter) -Represents a filter which can filter cells based on their conditional formatting icon. - -- **IconIndex**: `int?` — The icon set (read-only). -- **IconSet**: `FormatConditionIconSet` — The icon's index in the associated icon set or null for 'NoCellIcon' (read-only). - -### [RelativeDateRangeFilter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/RelativeDateRangeFilter) -Represents a filter which can filter date cells based on dates relative to the when the filter was applied. - -- **Duration**: `RelativeDateRangeDuration` — Gets or sets the duration of the full range of accepted dates. -- **Offset**: `RelativeDateRangeOffset` — Gets or sets the offset of relative filter (previous, current, or next). - -### [TopOrBottomFilter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/TopOrBottomFilter) -Represents a filter which can filter in cells in the upper or lower portion of the sorted values. - -- **Type**: `TopOrBottomFilterType` — Gets or sets the type of the filter. -- **Value**: `int` — Gets or sets the number or percentage of value of values which should be filtered in. - -### [WorksheetFilterSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetFilterSettings) -Exposes methods to identify a region in the wroksheet and to apply filters and optionally sort criteria to that region. - -- **Region**: `WorksheetRegion` — Returns the total region including the filter headers (read-only). -- **SortAndFilterAreaRegion**: `WorksheetRegion` — Returns the region that the filters and sort settings are applied to (read-only). -- **SortSettings**: `RelativeIndexSortSettings` — Gets the settings which determine how the data within the worksheet's filer region should be sorted. -- **ApplyAverageFilter**(relativeColumnIndex: int, type: AverageFilterType): AverageFilter — Applies an to the column. -- **ApplyCustomFilter**(relativeColumnIndex: int, condition: CustomFilterCondition): CustomFilter — Applies a to the column. -- **ApplyCustomFilter**(relativeColumnIndex: int, condition1: CustomFilterCondition, condition2: CustomFilterCondition, conditionalOperator: ConditionalOperator): CustomFilter — Applies a to the column. -- **ApplyDatePeriodFilter**(relativeColumnIndex: int, type: DatePeriodFilterType, value: int): DatePeriodFilter — Applies an to the column. -- **ApplyFillFilter**(relativeColumnIndex: int, fill: CellFill): FillFilter — Applies a to the column. -- **ApplyFixedValuesFilter**(relativeColumnIndex: int, includeBlanks: bool, calendarType: CalendarType, dateGroups: FixedDateGroup[]): FixedValuesFilter — Applies a to the column. -- **ApplyFixedValuesFilter**(relativeColumnIndex: int, includeBlanks: bool, calendarType: CalendarType, dateGroups: IEnumerable): FixedValuesFilter — Applies a to the column. -- **ApplyFixedValuesFilter**(relativeColumnIndex: int, includeBlanks: bool, dateGroups: IEnumerable): FixedValuesFilter — Applies a to the column. -- **ApplyFixedValuesFilter**(relativeColumnIndex: int, includeBlanks: bool, displayValues: IEnumerable): FixedValuesFilter — Applies a to the column. -- **ApplyFixedValuesFilter**(relativeColumnIndex: int, includeBlanks: bool, displayValues: string[]): FixedValuesFilter — Applies a to the column. -- **ApplyFontColorFilter**(relativeColumnIndex: int, fontColor: Color): FontColorFilter — Applies a to the column. -- **ApplyFontColorFilter**(relativeColumnIndex: int, fontColorInfo: WorkbookColorInfo): FontColorFilter — Applies a to the column. -- **ApplyIconFilter**(relativeColumnIndex: int, iconSet: FormatConditionIconSet, iconIndex: int?): IconFilter — Applies a to the column. -- **ApplyRelativeDateRangeFilter**(relativeColumnIndex: int, offset: RelativeDateRangeOffset, duration: RelativeDateRangeDuration): RelativeDateRangeFilter — Applies a to the column. -- **ApplyTopOrBottomFilter**(relativeColumnIndex: int): TopOrBottomFilter — Applies a to the column which will filter in the top 10 values in the list of sorted values. -- **ApplyTopOrBottomFilter**(relativeColumnIndex: int, type: TopOrBottomFilterType, value: int): TopOrBottomFilter — Applies a to the column. -- **ApplyYearToDateFilter**(relativeColumnIndex: int): YearToDateFilter — Applies a to the column. -- **ClearFilter**(relativeColumnIndex: int): void — Clears the filter that is applied to a specific column. -- **ClearFilters**(): void — Clears all previously applied filters -- **ClearRegion**(): void — Clears the region as well as any existing filters and sort criteria -- **GetFilter**(relativeColumnIndex: int): Filter — Gets the filter that is applied to a specific column. -- **ReapplyFilters**(): void — Re-filters all data cells in the filter region based on the applied filters. -- **ReapplySortConditions**(): void — Re-sorts all data cells in the region based on the sort conditions. -- **SetRegion**(address: string): void — Sets the region where the filter settings should be applied -- **SetRegion**(address: string, cellReferenceMode: CellReferenceMode): void — Sets the region where the filter settings should be applied - -### [YearToDateFilter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/YearToDateFilter) -Represents a filter which can filter in date cells if the dates occur between the start of the current year and the time when the filter is evaluated. - - -### [DiamondShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/DiamondShape) -Represents the diamond shape. - -- **constructor**(): void - -### [EllipseShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/EllipseShape) -Represents the ellipse shape. - -- **constructor**(): void - -### [HeartShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/HeartShape) -Represents the heart shape. - -- **constructor**(): void - -### [IrregularSeal1Shape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/IrregularSeal1Shape) -Represents the irregular seal 1 shape. - -- **constructor**(): void - -### [IrregularSeal2Shape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/IrregularSeal2Shape) -Represents the irregular seal 2 shape. - -- **constructor**(): void - -### [LightningBoltShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/LightningBoltShape) -Represents the lightning bolt shape. - -- **constructor**(): void - -### [LineShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/LineShape) -Represents the line shape. - -- **constructor**(): void - -### [PentagonShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/PentagonShape) -Represents the pentagon shape. - -- **constructor**(): void - -### [RectangleShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/RectangleShape) -Represents the rectangle shape. - -- **constructor**(): void - -### [RightTriangleShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/RightTriangleShape) -Represents the right triangle shape. - -- **constructor**(): void - -### [StraightConnector1Shape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/StraightConnector1Shape) -Represents the straight connector 1 shape. - -- **constructor**(): void - -### [OpenPackagingNonConformanceException](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/OpenPackagingNonConformanceException) -Thrown when a SpreadsheetMLpackage is found to be non-conformant. - -- **IPackagePart**: `IPackagePart` — Returns the IPackagePart instance which caused the exception to be thrown, or null (Nothing in VB) if the exception was not caused by a IPackagePart. -- **Reason**: `OpenPackagingNonConformanceExceptionReason` — Returns the the exception was thrown. - -### [CustomListSortCondition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/CustomListSortCondition) -Represents a sort condition which will sort cells based on a custom, ordered list of values. - -- **constructor**(sortDirection: SortDirection, list: IEnumerable): void -- **constructor**(sortDirection: SortDirection, list: string[]): void -- **constructor**(list: IEnumerable): void -- **constructor**(list: string[]): void -- **List**: `IEnumerable` — Gets the ordered list of values by which to sort. -- **Equals**(obj: object): bool — Determines whether the is equal to the specified object. -- **GetHashCode**(): int — Gets the hash code for the . - -### [FillSortCondition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FillSortCondition) -Represents a sort condition which will sort cells based on their background fill. - -- **constructor**(fill: CellFill): void -- **constructor**(fill: CellFill, sortDirection: SortDirection): void -- **Fill**: `CellFill` — Gets the by which the cells should be sorted. -- **Equals**(obj: object): bool — Determines whether the is equal to the specified object. -- **GetHashCode**(): int — Gets the hash code for the . - -### [FontColorSortCondition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/FontColorSortCondition) -Represents a sort condition which will sort cells based on their fonts colors. - -- **constructor**(fontColorInfo: WorkbookColorInfo): void -- **constructor**(fontColorInfo: WorkbookColorInfo, sortDirection: SortDirection): void -- **FontColorInfo**: `WorkbookColorInfo` — Gets the which describes the color by which the cells should be sorted. -- **Equals**(obj: object): bool — Determines whether the is equal to the specified object. -- **GetHashCode**(): int — Gets the hash code for the . - -### [IconSortCondition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/IconSortCondition) -Represents a sort condition which will sort cells based on a specific conditioanl formmat icon. - -- **constructor**(iconSet: FormatConditionIconSet, iconIndex: int?): void -- **constructor**(iconSet: FormatConditionIconSet, iconIndex: int?, sortDirection: SortDirection): void -- **IconIndex**: `int?` — The icon set (read-only). -- **IconSet**: `FormatConditionIconSet` — The icon's index in the associated icon set or null for 'NoCellIcon' (read-only). - -### [OrderedSortCondition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/OrderedSortCondition) -Represents an ordered sort condition, which can sort data in either an ascending or descending manner. - -- **constructor**(): void -- **constructor**(sortDirection: SortDirection): void - -### [RelativeIndexSortSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/RelativeIndexSortSettings) -Represents the settings which apply to sorting a region of values based on indices relative to either the Worksheet's or region. - -- **InitializeRegion**(): void — Initializes the region to null - -### [SortCondition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/SortCondition) -Abstract base class for the sort conditions which describe how to sort data in a region. - -- **SortDirection**: `SortDirection` — Gets the value which indicates the sort direction represented by the sort condition. -- **Equals**(obj: object): bool — Determines whether the is equal to the specified object. -- **GetHashCode**(): int — Gets the hash code for the . - -### [SortConditionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/SortConditionCollection) -An ordered collection of sort conditions which are applied to a sort-able regions in a worksheet. - -- **Count**: `int` — Gets the number of sort conditions in the collection. -- **this[int]**: `KeyValuePair` — Gets or sets the pair of item and sort condition at the specified index. -- **this[T]**: `SortCondition` — Gets or sets the sort condition for the specified sort-able item. -- **Add**(sortableItem: T, sortCondition: SortCondition): void — Adds a sort condition to the collection. -- **AddRange**(entries: IEnumerable>): void — Adds a range of sort conditions to the collection. -- **Clear**(): void — Clears the collection. -- **Contains**(sortCondition: SortCondition): bool — Determines whether the specified sort condition is in the collection. -- **Contains**(sortableItem: T): bool — Determines whether the specified sort-able item is in the collection. -- **IndexOf**(sortCondition: SortCondition): int — Gets the index of the specified sort condition in the collection. -- **IndexOf**(sortableItem: T): int — Gets the index of the specified sort-able item in the collection. -- **Insert**(index: int, sortableItem: T, sortCondition: SortCondition): void — Inserts a sort condition into the collection. -- **InsertRange**(index: int, entries: IEnumerable>): void — Inserts a range of sort conditions into the collection. -- **Remove**(sortCondition: SortCondition): bool — Removes a sort condition from the collection. -- **Remove**(sortableItem: T): bool — Removes a sort-able item from the collection. -- **RemoveAt**(index: int): void — Removes the sort condition at the specified index. -- **ReplaceAll**(entries: IEnumerable>): void — Clears the existing sort conditions from the collection and replaces them with new entries in a single atomic operation. - -### [SortSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/SortSettings) -Represents the settings which apply to sorting a region of values. - -- **CaseSensitive**: `bool` — Gets or sets the value which indicates whether strings should be compared case-sensitively when they are sorted. -- **SortConditions**: `SortConditionCollection` — Gets the collection of sort conditions to use when sorting the region of data. - -### [WorksheetSortSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/WorksheetSortSettings) -Exposes methods to identify a region in the wroksheet and to apply sort criteria to that region. - -- **Region**: `WorksheetRegion` — Returns the region that the filter settings is applied to (read-only). -- **SortType**: `WorksheetSortType` — Determines whether columns or rows will be sorted within the region. 'Rows' is the default. -- **ClearRegion**(): void — Clears the region as well as any existing sort criteria -- **InitializeRegion**(): void — Initializes the region to null -- **ReapplySortConditions**(): void — Re-sorts all data cells in the region based on the sort conditions. -- **SetRegion**(address: string): void — Sets the region where the filter settings should be applied -- **SetRegion**(address: string, cellReferenceMode: CellReferenceMode): void — Sets the region where the filter settings should be applied - -### [Sparkline](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/Sparkline) -Represents a sparkline cell - -- **DataRegion**: `WorksheetRegion` — The region containing the data for the sparkline (read-only) -- **DataRegionName**: `string` — A striing that describes the region containing the data for the sparkline (read-only) -- **Location**: `WorksheetRegion` — The cell location of the sparkline (read-only) - -### [SparklineCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/SparklineCollection) -A collection of s exposed from a - -- **Count**: `int` — Returns the total number of items in the collection. -- **this[int]**: `Sparkline` — Indexer -- **Add**(row: int, column: int, dataRegion: string, cellReferenceMode: CellReferenceMode?): Sparkline — Adds a new with no sparklines -- **Clear**(): void — Clears all items from the collection -- **Contains**(sparkline: Sparkline): bool — Returns true if the collection contains the item -- **GetEnumerator**(): IEnumerator — Returns an enumerator for the sparklines in the collection. -- **IndexOf**(sparkline: Sparkline): int — Gets the index of the item in the collection -- **Remove**(sparkline: Sparkline): bool — Removes a sparkline from the collection -- **RemoveAt**(index: int): void — Removes a sparkline from the collection - -### [SparklineGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/SparklineGroup) -Represents a group of s - -- **ColorAxis**: `WorkbookColorInfo` — Determines the color of the axis -- **ColorFirstPoint**: `WorkbookColorInfo` — Determines the color of the first point -- **ColorHighPoint**: `WorkbookColorInfo` — Determines the color of the high point -- **ColorLastPoint**: `WorkbookColorInfo` — Determines the color of the last point -- **ColorLowPoint**: `WorkbookColorInfo` — Determines the color of the low point -- **ColorMarkers**: `WorkbookColorInfo` — Determines the color of the markers -- **ColorNegativePoints**: `WorkbookColorInfo` — Determines the color of the negative point -- **ColorSeries**: `WorkbookColorInfo` — Determines the default color for the series -- **DateAxis**: `bool` — Determines whether to use a date axis -- **DateRange**: `WorksheetRegion` — The date range (read-only) -- **DateRangeFormula**: `Formula` — The date range formula (read-only) -- **DisplayBlanksAs**: `SparklineDisplayBlanksAs` — Determines how blanks will be displayed -- **DisplayHidden**: `bool` — Determines whether values from cells that are hidden will be displayed -- **DisplayXAxis**: `bool` — Determines if the x-axis will be displayed -- **FirstPoint**: `bool` — Determines if the first point is displayed differently. -- **Guid**: `Guid?` — A unique identifier for this group (read-only). -- **HighPoint**: `bool` — Determines if the high point is displayed differently. -- **LastPoint**: `bool` — Determines if the last point is displayed differently. -- **LineWeight**: `double` — Determines the weight of a line in points. -- **LowPoint**: `bool` — Determines if the low point is displayed differently. -- **Markers**: `bool` — Determines if markers are displayed. -- **NegativePoints**: `bool` — Determines if the negative points are displayed differently. -- **RightToLeft**: `bool` — Determines if the sparkline goes from right to left. -- **Sparklines**: `SparklineCollection` — The collection of sparklines in the group (read-only) -- **Type**: `SparklineType` — The type of sparkline -- **VerticalAxisMax**: `double` — A custom maximum value for the Y axis. -- **VerticalAxisMaxType**: `SparklineAxisMinMax` — Determines how the maximum value for the Y axis is calculated. -- **VerticalAxisMin**: `double` — A custom minimum value for the Y axis. -- **VerticalAxisMinType**: `SparklineAxisMinMax` — Determines how the minimum value for the Y axis is calculated. -- **Workbook**: `Workbook` — Returns a reference to the associated workbook. -- **Worksheet**: `Worksheet` — Returns a reference to the associated worksheet. -- **SetDateRange**(dateRange: string, cellReferenceMode: CellReferenceMode?): void — Assigns a new . - -### [SparklineGroupCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/classes/SparklineGroupCollection) -A collection of s exposed from a - -- **Count**: `int` — Returns the total number of items in the collection. -- **GenerateGuidsForGroups**: `bool` — Determines if guids will be generated for groups. -- **this[int]**: `SparklineGroup` — Indexer -- **Add**(type: SparklineType, locationRange: string, dataRange: string, groupInitializer: Action, cellReferenceMode: CellReferenceMode?): SparklineGroup — Adds a new -- **Clear**(): void — Clears all items from the collection -- **Contains**(group: SparklineGroup): bool — Returns true if the collection contains the item -- **GetEnumerator**(): IEnumerator — Returns an enumerator for the SparklineGroups in the collection. -- **IndexOf**(group: SparklineGroup): int — Gets the index of the item in the collection -- **Remove**(group: SparklineGroup): bool — Removes a group from the collection -- **RemoveAt**(index: int): void — Removes a group from the collection - -## Interfaces - -### [IWorkbookFont](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/interfaces/IWorkbookFont) -Represents a font for the cell in the related context. - -- **Bold**: `ExcelDefaultableBoolean` — Gets or sets the value which indicates whether the font is bold. -- **ColorInfo**: `WorkbookColorInfo` — Gets or sets the foreground color of the font. -- **Height**: `int` — Gets or sets the font height in twips (1/20th of a point). -- **Italic**: `ExcelDefaultableBoolean` — Gets or sets the value which indicates whether the font is italic. -- **Name**: `string` — Gets or sets the font family name. -- **SetFontFormatting(IWorkbookFont)**: `any` — Sets all font properties to specific font formatting. -- **Strikeout**: `ExcelDefaultableBoolean` — Gets or sets the value which indicates whether the font is struck out. -- **SuperscriptSubscriptStyle**: `FontSuperscriptSubscriptStyle` — Gets or sets the value which indicates whether the font is superscript or subscript. -- **UnderlineStyle**: `FontUnderlineStyle` — Gets or sets the underline style of the font. - -### [IWorksheetCellFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/interfaces/IWorksheetCellFormat) -Represents the format for the cell. - -- **Alignment**: `HorizontalCellAlignment` — Gets or sets the horizontal alignment of the content in a cell. -- **BottomBorderColorInfo**: `WorkbookColorInfo` — Gets or sets the bottom border color. -- **BottomBorderStyle**: `CellBorderLineStyle` — Gets or sets the bottom border style. -- **DiagonalBorderColorInfo**: `WorkbookColorInfo` — Gets or sets the diagonal border color. -- **DiagonalBorderStyle**: `CellBorderLineStyle` — Gets or sets the diagonal border style. -- **DiagonalBorders**: `DiagonalBorders` — Gets or sets the diagonal borders. -- **Fill**: `CellFill` — Gets or sets the fill of the cell. -- **Font**: `IWorkbookFont` — Gets or sets the default font formatting. -- **FormatOptions**: `WorksheetCellFormatOptions` — Gets or sets the groups of properties provided by the format. -- **FormatString**: `string` — Gets or sets the number format string. -- **Hidden**: `ExcelDefaultableBoolean` — Gets or sets the valid which indicates whether the cell value is hidden in protected mode. -- **Indent**: `int` — Gets or sets the indent in units of average character widths. -- **LeftBorderColorInfo**: `WorkbookColorInfo` — Gets or sets the left border color. -- **LeftBorderStyle**: `CellBorderLineStyle` — Gets or sets the left border style. -- **Locked**: `ExcelDefaultableBoolean` — Gets or sets the valid which indicates whether the cell is locked in protected mode. -- **RightBorderColorInfo**: `WorkbookColorInfo` — Gets or sets the right border color. -- **RightBorderStyle**: `CellBorderLineStyle` — Gets or sets the right border style. -- **Rotation**: `int` — Gets or sets the rotation of the cell content in degrees. -- **SetFormatting(IWorksheetCellFormat)**: `any` — Copies all cell format properties to from the specified cell format. -- **ShrinkToFit**: `ExcelDefaultableBoolean` — Gets or sets the value indicating whether the cell content will shrink to fit the cell. -- **Style**: `WorkbookStyle` — Gets or sets the parent of the format. -- **TopBorderColorInfo**: `WorkbookColorInfo` — Gets or sets the top border color. -- **TopBorderStyle**: `CellBorderLineStyle` — Gets or sets the top border style. -- **VerticalAlignment**: `VerticalCellAlignment` — Gets or sets the vertical alignment of the content in a cell. -- **WrapText**: `ExcelDefaultableBoolean` — Gets or sets the value which indicates whether text will wrap in a cell. - -### [IExcelCalcFormula](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/interfaces/IExcelCalcFormula) -Interface implemented by the formula object. - -- **AddDynamicReference(IExcelCalcReference)**: `bool` — Adds a reference created during the evaluation of the formula to the references of the formula. -- **BaseReference**: `IExcelCalcReference` — Base reference associated with the formula. -- **DynamicReferences**: `IExcelCalcReferenceCollection` — Gets the collection of reference created during the last evaluation of the formula. -- **Evaluate(IExcelCalcReference)**: `ExcelCalcValue` — Evaluate the compiled expression against the given base reference -- **FormulaString**: `string` — Formula string. -- **HasAlwaysDirty**: `bool` — Returns whether the formula contains an always dirty function. -- **References**: `IExcelCalcReferenceCollection` — Retuns a collection of references contained in the formula token string - -### [IExcelCalcReference](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/interfaces/IExcelCalcReference) -The Primary Reference Inteface. - -- **AbsoluteName**: `string` — The fully qualified unique name for the referenced element. Read Only. -- **ContainsReference(IExcelCalcReference)**: `bool` — Returns true if this reference contains inReference -- **Context**: `object` — Returns a context for the Reference. -- **CreateReference(string)**: `IExcelCalcReference` — Create a new reference relative to this reference. -- **ElementName**: `string` — The unqualified name of this referenced element. Read Only. -- **Formula**: `IExcelCalcFormula` — The , if any, associated with this Reference. If this reference can not contain a formula then null is returned. -- **IsEnumerable**: `bool` — Returns true if this reference is enumerable. -- **IsSubsetReference(IExcelCalcReference)**: `bool` — Returns true if inReference is a proper subset of this reference -- **NormalizedAbsoluteName**: `string` — Returns the normalized absolute name. Calculation engine makes use of normalized absolute names of references to compare two references and search for references. This property should return the absolute name with case insensitive parts of the absolute names converted to lower case. -- **References**: `IExcelCalcReferenceCollection` — Return a collection of references if this Reference is enumerable. An exception is thrown if this reference is not enumerable. -- **Value**: `ExcelCalcValue` — The , if any, associated with this Reference. If this reference does not contain a Value then a is returned. - -### [IExcelCalcReferenceCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/interfaces/IExcelCalcReferenceCollection) -Collection of objects - - -### [ISortable](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/interfaces/ISortable) -A type representing a range of cells which can be sorted. - -- **Index**: `int` — Gets the index of the sort-able item in its owner. - -## Enumerations - -### [CalculationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/CalculationMode) -Represents the the ways formulas are recalculated when their referenced values change. - -- **Automatic** — Formulas and data tables are automatically recalculated when the values in referenced cells change. -- **AutomaticExceptForDataTables** — Only formulas are automatically recalculated when the values in referenced cells change. Data tables must be recalculated manually. -- **Manual** — Formulas must be recalculated manually, by pressing a button in the Microsoft Excel interface. - -### [CellBorderLineStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/CellBorderLineStyle) -Represents the different cell border line styles. - -- **DashDot** — Dash-dot border. -- **DashDotDot** — Dash-dot-dot border. -- **Dashed** — Dashed border. -- **Default** — Use the default border line style. -- **Dotted** — Dotted border. -- **Double** — Double-line border. -- **Hair** — Dotted border with small dots. -- **Medium** — Medium border. -- **MediumDashDot** — Medium dash-dot border. -- **MediumDashDotDot** — Medium dash-dot-dot border. -- **MediumDashed** — Dotted border with big dots. -- **None** — No border. -- **SlantedDashDot** — Slanted dash-dot border. -- **Thick** — Thick border. -- **Thin** — Thin border. - -### [CellReferenceMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/CellReferenceMode) -Represents the various ways cells can be referenced in a formula. - -- **A1** — Cells are referenced by first specifying characters representing the column and a one-based number specifying the row (R54 or CA56). The dollar sign ($) can preface one or both identifiers to make them absolute references ($A$7). Without the dollar sign, references still use absolute row and column addresses, although shifting a formula to a new cell will perform a similar shift on all relative references. -- **R1C1** — Cells are referenced in the following format RC (R34C5 or R2C345). These indices are one-based and represent absolute references. To create a relative reference in R1C1 mode, a relative index must be placed inside square brackets following the R and/or C ( R[-1]C[5] or R9C[-3] ). An R by itself also represents a relative reference and is equivalent to R[0]. Similarly, C is equivalent to C[0], which means a formula of =RC always references the cell which contains the formula. - -### [DataValidationCriteria](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/DataValidationCriteria) -Determines what types of cell values are allowed and how the cell value is validated against the constraint(s). - -- **Date** — Dates with or without time portions are allowed as well as numbers equivalent to valid dates. When comparing against constraints, the cell value is used. -- **Decimal** — Only numbers are allowed. When comparing against constraints, the cell value is used. -- **TextLength** — Non-error values are allowed. When comparing against constraints, the length of the cell value's text equivalent is used. -- **Time** — Times are allowed are well as numbers equivalent to valid times without a date portion. When comparing against constraints, the cell value is used. -- **WholeNumber** — Only numbers are allowed and they cannot have a fractional part. When comparing against constraints, the cell value is used. - -### [DataValidationErrorStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/DataValidationErrorStyle) -Represents the various styles in which invalid values are handled by Microsoft Excel. When error messages are not shown for invalid values, the error style is ignored and all invalid values are allowed to be set on cells. - -- **Information** — Invalid values are allowed. The error dialog shown in Microsoft Excel displays an information icon and ok and cancel buttons. The ok button commits the value to the cell. The cancel button will cancel the edit and revert the cell back to the previous value it contained before the edit operation. -- **Stop** — Invalid values are not allowed. The error dialog shown in Microsoft Excel displays an error icon and retry and cancel buttons. The retry button will put focus back in the cell and allow the user to try to enter a new value. The cancel button will cancel the edit and revert the cell back to the previous value it contained before the edit operation. -- **Warning** — Invalid values are allowed. The error dialog shown in Microsoft Excel displays a warning icon, asks the user if they want to continue, and has yes, no and cancel buttons. The yes button commits the value to the cell. The no button will put focus back in the cell and allow the user to try to enter a new value. And the cancel button will cancel the edit and revert the cell back to the previous value it contained before the edit operation. - -### [DataValidationImeMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/DataValidationImeMode) -Represents the description of the Japanese input rules. - -- **Disabled** — The ime mode is disabled. -- **FullAlpha** — The ime mode is set to full-width alphanumeric. -- **FullHangul** — The ime mode is set to full-width Hangul. -- **FullKatakana** — The ime mode is set to Katakana -- **HalfAlpha** — The ime mode is set to half-width alphanumeric. -- **HalfHangul** — The ime mode is set to half-width Hangul. -- **HalfKatakana** — The ime mode is set to half-width Katakana. -- **Hiragana** — The ime mode is set to Hiragana. -- **NoControl** — The ime mode is not controlled. -- **Off** — The ime mode is off. -- **On** — The ime mode is on. - -### [DateSystem](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/DateSystem) -Represents the various ways a date can be stored internally. - -- **From1900** — Dates are stored as time elapsed since 1900. -- **From1904** — Dates are stored as time elapsed since 1904 (used mainly on Apple computers). - -### [DiagonalBorders](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/DiagonalBorders) -Represents the diagonal borders which can be displayed in cells. - -- **All** — Both diagonal borders will be displayed in the cell. -- **Default** — The default value for the diagonal borders. -- **DiagonalDown** — A diagonal border going from the top-left to bottom-right corner will be displayed in the cell. -- **DiagonalUp** — A diagonal border going from the bottom-left to top-right corner will be displayed in the cell. -- **None** — No diagonal borders will be displayed in the cell. - -### [ExcelDefaultableBoolean](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ExcelDefaultableBoolean) -Enumeration for a boolean type property that allows for a default setting. This is used in property override situations. - -- **Default** — Use the current default. -- **False** — False. -- **True** — True. - -### [FillPatternStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/FillPatternStyle) -Enumeration for fill pattern styles. Default value is used in property override situations. - -- **DiagonalCrosshatch** — Diagonal crosshatch fill pattern. -- **DiagonalStripe** — Diagonal stripe fill pattern. -- **Gray12percent** — "12.5% gray" fill pattern. -- **Gray25percent** — "25% gray" fill pattern. -- **Gray50percent** — "50% gray" fill pattern. -- **Gray6percent** — "6.25% gray" fill pattern. -- **Gray75percent** — "75% gray" fill pattern. -- **HorizontalStripe** — Horizontal stripe fill pattern. -- **None** — No fill pattern. -- **ReverseDiagonalStripe** — Reverse diagonal stripe fill pattern. -- **Solid** — Solid fill pattern with fill pattern foreground color. -- **ThickDiagonalCrosshatch** — Thick diagonal crosshatch fill pattern. -- **ThinDiagonalCrosshatch** — Thin diagonal crosshatch fill pattern. -- **ThinDiagonalStripe** — Thin diagonal stripe fill pattern. -- **ThinHorizontalCrosshatch** — Thin horizontal crosshatch fill pattern. -- **ThinHorizontalStripe** — Thin horizontal stripe fill pattern. -- **ThinReverseDiagonalStripe** — Thin reverse diagonal stripe fill pattern. -- **ThinVerticalStripe** — Thin vertical stripe fill pattern. -- **VerticalStripe** — Vertical stripe fill pattern. - -### [FontSuperscriptSubscriptStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/FontSuperscriptSubscriptStyle) -Enumeration for font superscript or subscript style. Default value is used in property override situations. - -- **Default** — Use the current default. -- **None** — No superscript or subscript style. -- **Subscript** — Subscript style. -- **Superscript** — Superscript style. - -### [FontUnderlineStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/FontUnderlineStyle) -Enumeration for font underline styles. Default value is used in property override situations. - -- **Default** — Use the current default. -- **Double** — Double underline style. -- **DoubleAccounting** — Double accounting underline style. -- **None** — No underline style. -- **Single** — Single underline style. -- **SingleAccounting** — Single accounting underline style. - -### [FormatConditionIcon](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/FormatConditionIcon) -Identifies the set of icons used by a . - -- **BlackCircle** — Microsoft.Office.Interop.Excel.xlIconBlackCircle = 32 -- **BlackCircleWithBorder** — Microsoft.Office.Interop.Excel.xlIconBlackCircleWithBorder = 13 -- **CircleWithOneWhiteQuarter** — Microsoft.Office.Interop.Excel.xlIconCircleWithOneWhiteQuarter = 33 -- **CircleWithThreeWhiteQuarters** — Microsoft.Office.Interop.Excel.xlIconCircleWithThreeWhiteQuarters = 35 -- **CircleWithTwoWhiteQuarters** — Microsoft.Office.Interop.Excel.xlIconCircleWithTwoWhiteQuarters = 34 -- **FourBars** — Microsoft.Office.Interop.Excel.xlIcon4Bars = 41 -- **FourFilledBoxes** — Microsoft.Office.Interop.Excel.xlIcon4FilledBoxes = 48 -- **GoldStar** — Microsoft.Office.Interop.Excel.xlIconGoldStar = 42 -- **GrayCircle** — Microsoft.Office.Interop.Excel.xlIconGrayCircle = 31 -- **GrayDownArrow** — Microsoft.Office.Interop.Excel.xlIconGrayDownArrow = 6 -- **GrayDownInclineArrow** — Microsoft.Office.Interop.Excel.xlIconGrayDownInclineArrow = 28 -- **GraySideArrow** — Microsoft.Office.Interop.Excel.xlIconGraySideArrow = 5 -- **GrayUpArrow** — Microsoft.Office.Interop.Excel.xlIconGrayUpArrow = 4 -- **GrayUpInclineArrow** — Microsoft.Office.Interop.Excel.xlIconGrayUpInclineArrow = 27 -- **GreenCheck** — Microsoft.Office.Interop.Excel.xlIconGreenCheck = 22 -- **GreenCheckSymbol** — Microsoft.Office.Interop.Excel.xlIconGreenCheckSymbol = 19 -- **GreenCircle** — Microsoft.Office.Interop.Excel.xlIconGreenCircle = 10 -- **GreenFlag** — Microsoft.Office.Interop.Excel.xlIconGreenFlag = 7 -- **GreenTrafficLight** — Microsoft.Office.Interop.Excel.xlIconGreenTrafficLight = 14 -- **GreenUpArrow** — Microsoft.Office.Interop.Excel.xlIconGreenUpArrow = 1 -- **GreenUpTriangle** — Microsoft.Office.Interop.Excel.xlIconGreenUpTriangle = 45 -- **HalfGoldStar** — Microsoft.Office.Interop.Excel.xlIconHalfGoldStar = 43 -- **NoCellIcon** — Microsoft.Office.Interop.Excel.xlIconNoCellIcon = -1 -- **OneBar** — Microsoft.Office.Interop.Excel.xlIcon1Bar = 38 -- **OneFilledBox** — Microsoft.Office.Interop.Excel.xlIcon1FilledBox = 51 -- **PinkCircle** — Microsoft.Office.Interop.Excel.xlIconPinkCircle = 30 -- **RedCircle** — Microsoft.Office.Interop.Excel.xlIconRedCircle = 29 -- **RedCircleWithBorder** — Microsoft.Office.Interop.Excel.xlIconRedCircleWithBorder = 12 -- **RedCross** — Microsoft.Office.Interop.Excel.xlIconRedCross = 24 -- **RedCrossSymbol** — Microsoft.Office.Interop.Excel.xlIconRedCrossSymbol = 21 -- **RedDiamond** — Microsoft.Office.Interop.Excel.xlIconRedDiamond = 18 -- **RedDownArrow** — Microsoft.Office.Interop.Excel.xlIconRedDownArrow = 3 -- **RedDownTriangle** — Microsoft.Office.Interop.Excel.xlIconRedDownTriangle = 47 -- **RedFlag** — Microsoft.Office.Interop.Excel.xlIconRedFlag = 9 -- **RedTrafficLight** — Microsoft.Office.Interop.Excel.xlIconRedTrafficLight = 16 -- **SilverStar** — Microsoft.Office.Interop.Excel.xlIconSilverStar = 44 -- **ThreeBars** — Microsoft.Office.Interop.Excel.xlIcon3Bars = 40 -- **ThreeFilledBoxes** — Microsoft.Office.Interop.Excel.xlIcon3FilledBoxes = 49 -- **TwoBars** — Microsoft.Office.Interop.Excel.xlIcon2Bars = 39 -- **TwoFilledBoxes** — Microsoft.Office.Interop.Excel.xlIcon2FilledBoxes = 50 -- **WhiteCircleAllWhiteQuarters** — Microsoft.Office.Interop.Excel.xlIconWhiteCircleAllWhiteQuarters = 36 -- **YellowCircle** — Microsoft.Office.Interop.Excel.xlIconYellowCircle = 11 -- **YellowDash** — Microsoft.Office.Interop.Excel.xlIconYellowDash = 46 -- **YellowDownInclineArrow** — Microsoft.Office.Interop.Excel.xlIconYellowDownInclineArrow = 26 -- **YellowExclamation** — Microsoft.Office.Interop.Excel.xlIconYellowExclamation = 23 -- **YellowExclamationSymbol** — Microsoft.Office.Interop.Excel.xlIconYellowExclamationSymbol = 20 -- **YellowFlag** — Microsoft.Office.Interop.Excel.xlIconYellowFlag = 8 -- **YellowSideArrow** — Microsoft.Office.Interop.Excel.xlIconYellowSideArrow = 2 -- **YellowTrafficLight** — Microsoft.Office.Interop.Excel.xlIconYellowTrafficLight = 15 -- **YellowTriangle** — Microsoft.Office.Interop.Excel.xlIconYellowTriangle = 17 -- **YellowUpInclineArrow** — Microsoft.Office.Interop.Excel.xlIconYellowUpInclineArrow = 25 -- **ZeroBars** — Microsoft.Office.Interop.Excel.xlIcon0Bars = 37 -- **ZeroFilledBoxes** — Microsoft.Office.Interop.Excel.xlIcon0FilledBoxes = 52 - -### [FormatConditionIconSet](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/FormatConditionIconSet) -Constants which identify a set of icons for an . - -- **IconSet3Arrows** — Microsoft.Office.Interop.Excel.xl3Arrows = 1 -- **IconSet3ArrowsGray** — Microsoft.Office.Interop.Excel.xl3ArrowsGray = 2 -- **IconSet3Flags** — Microsoft.Office.Interop.Excel.xl3Flags = 3 -- **IconSet3Signs** — Microsoft.Office.Interop.Excel.xl3Signs = 6 -- **IconSet3Stars** — Microsoft.Office.Interop.Excel.xl3Stars = 18 -- **IconSet3Symbols** — Microsoft.Office.Interop.Excel.xl3Symbols = 7 -- **IconSet3Symbols2** — Microsoft.Office.Interop.Excel.xl3Symbols2 = 8 -- **IconSet3TrafficLights1** — Microsoft.Office.Interop.Excel.xl3TrafficLights1 = 4 -- **IconSet3TrafficLights2** — Microsoft.Office.Interop.Excel.xl3TrafficLights2 = 5 -- **IconSet3Triangles** — Microsoft.Office.Interop.Excel.xl3Triangles = 19 -- **IconSet4Arrows** — Microsoft.Office.Interop.Excel.xl4Arrows = 9 -- **IconSet4ArrowsGray** — Microsoft.Office.Interop.Excel.xl4ArrowsGray = 10 -- **IconSet4Rating** — Microsoft.Office.Interop.Excel.xl4CRV = 12 -- **IconSet4RedToBlack** — Microsoft.Office.Interop.Excel.xl4RedToBlack = 11 -- **IconSet4TrafficLights** — Microsoft.Office.Interop.Excel.xl4TrafficLights = 13 -- **IconSet5Arrows** — Microsoft.Office.Interop.Excel.xl5Arrows = 14 -- **IconSet5ArrowsGray** — Microsoft.Office.Interop.Excel.xl5ArrowsGray = 15 -- **IconSet5Boxes** — Microsoft.Office.Interop.Excel.xl5Boxes = 20 -- **IconSet5Quarters** — Microsoft.Office.Interop.Excel.xl5Quarters = 17 -- **IconSet5Rating** — Microsoft.Office.Interop.Excel.xl5CRV = 16 - -### [HorizontalCellAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/HorizontalCellAlignment) -Enumeration for horizontal alignment styles. Default value is used in property override situations. - -- **Center** — Centered alignment. -- **CenterAcrossSelection** — Centers the contents of the left-most cell in a center across selection group. All other cells in the center across selection group must be empty. The cells are not merged, and the data may appear to be in a cell other than the left-most cell. -- **Default** — Use the current default. -- **Distributed** — Distributed alignment. -- **Fill** — Repeat cell value to fill whole cell. -- **General** — Alignment depends on underlying data type. -- **Justify** — Justify alignment. -- **Left** — Left alignment. -- **Right** — Right alignment. - -### [HorizontalTextAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/HorizontalTextAlignment) -Represents the various horizontal text alignment types. - -- **Center** — Align text in the center of the line. -- **Distributed** — Distributes the words across the entire line. -- **Justified** — Align text so it is justified across the line. -- **JustifiedLow** — Aligns the text with an adjusted kashida length for Arabic text. -- **Left** — Align the text to the left of the line. -- **Right** — Align the text to the right of the line. -- **ThaiDistributed** — Distributes Thai text by treating each character as a word. - -### [ObjectDisplayStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ObjectDisplayStyle) -Represents the various way objects and shapes are displayed in the workbook. - -- **HideAll** — No objects or shapes are shown. -- **ShowAll** — All object are be shown. -- **ShowPlaceholders** — Placeholders are shown in place of objects. - -### [OneConstraintDataValidationOperator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/OneConstraintDataValidationOperator) -Represents the various operators which can be used when validating the cell value against a constraint. - -- **EqualTo** — Only allows the cell value if it or its text length, depending on the validation criteria, is equal to the constraint applied to the validation rule. -- **GreaterThan** — Only allows the cell value if it or its text length, depending on the validation criteria, is greater than the constraint applied to the validation rule. -- **GreaterThanOrEqualTo** — Only allows the cell value if it or its text length, depending on the validation criteria, is greater than or equal to the constraint applied to the validation rule. -- **LessThan** — Only allows the cell value if it or its text length, depending on the validation criteria, is less than the constraint applied to the validation rule. -- **LessThanOrEqualTo** — Only allows the cell value if it or its text length, depending on the validation criteria, is less than or equal to the constraint applied to the validation rule. -- **NotEqualTo** — Only allows the cell value if it or its text length, depending on the validation criteria, is not equal to the constraint applied to the validation rule. - -### [Orientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/Orientation) -Represents the page orientations available when a worksheet is printed. - -- **Default** — The page is printed with the default setting. -- **Landscape** — The page is printed with the larger dimension horizontal. -- **Portrait** — The page is printed with the larger dimension vertical. - -### [PageNumbering](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/PageNumbering) -Represents the way pages are numbered when printed. - -- **Automatic** — Pages are automatically numbered based on the style of the worksheet. -- **UseStartPageNumber** — The starting page number specified is used for the first page, additional pages receive a page number that it one greater than the previous page. - -### [PageOrder](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/PageOrder) -Represents the ways to order the pages of multiple page worksheets. - -- **DownThenOver** — The first page to print is the top-left page. The next pages printed are below the first page. When there are no more pages below, the page to the right of the top-left page is printed, then the pages below it, and so on. -- **OverThenDown** — The first page to print is the top-left page. The next pages printed are right of the first page. When there are no more pages to the right, the page below the top-left page is printed, then the pages to the right of it, and so on. - -### [PaperSize](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/PaperSize) -Represents the various paper sizes available for printing. - -- **A2** — A2 420mm x 594mm -- **A3** — A3 297mm x 420mm -- **A3Extra** — A3 Extra 322mm x 445mm -- **A3ExtraTransverse** — A3 Extra Transverse 322mm x 445mm -- **A3Rotated** — A3 Rotated 420mm x 297mm -- **A3Transverse** — A3 Transverse 297mm x 420mm -- **A4** — A4 210mm x 297mm -- **A4Extra** — A4 Extra 235mm x 322mm -- **A4Plus** — A4 Plus 210mm x 330mm -- **A4Rotated** — A4 Rotated 297mm x 210mm -- **A4Small** — A4 small 210mm x 297mm -- **A4Transverse** — A4 Transverse 210mm x 297mm -- **A5** — A5 148mm x 210mm -- **A5Extra** — A5 Extra 174mm x 235mm -- **A5Rotated** — A5 Rotated 210mm x 148mm -- **A5Transverse** — A5 Transverse 148mm x 210mm -- **A6** — A6 105mm x 148mm -- **A6Rotated** — A6 Rotated 148mm x 105mm -- **B4ISO_1** — B4 (ISO) 250mm x 353mm -- **B4ISO_2** — B4 (ISO) 250mm x 353mm -- **B4JIS** — B4 (JIS) 257mm x 364mm -- **B4JISRotated** — B4 (JIS) Rotated 364mm x 257mm -- **B5ISO** — B5 (ISO) 176mm x 250mm -- **B5ISOExtra** — B5 (ISO) Extra 201mm x 276mm -- **B5JIS** — B5 (JIS) 182mm x 257mm -- **B5JISRotated** — B5 (JIS) Rotated 257mm x 182mm -- **B5JISTransverse** — B5 (JIS) Transverse 182mm x 257mm -- **B6ISO** — B6 (ISO) 125mm x 176mm -- **B6JIS** — B6 (JIS) 128mm x 182mm -- **B6JISRotated** — B6 (JIS) Rotated 182mm x 128mm -- **C** — C 17" x 22" -- **D** — D 22" x 34" -- **DblJapanesePostcard** — Dbl. Japanese Postcard 200mm x 148mm -- **DblJapanesePostcardRotated** — Dbl. Jap. Postcard Rot. 148mm x 200mm -- **E** — E 34" x 44" -- **Envelope10** — Envelope #10 4 1/8" x 9 1/2" -- **Envelope11** — Envelope #11 4 1/2" x 10 3/8" -- **Envelope12** — Envelope #12 4 3/4" x 11" -- **Envelope14** — Envelope #14 5" x 11 1/2" -- **Envelope9** — Envelope #9 3 7/8" x 8 7/8" -- **EnvelopeC3** — Envelope C3 324mm x 458mm -- **EnvelopeC4** — Envelope C4 229mm x 324mm -- **EnvelopeC5** — Envelope C5 162mm x 229mm -- **EnvelopeC6** — Envelope C6 114mm x 162mm -- **EnvelopeC6C5** — Envelope C6/C5 114mm x 229mm -- **EnvelopeDL** — Envelope DL 110mm x 220mm -- **EnvelopeInvite** — Envelope Invite 220mm x 220mm -- **EnvelopeItaly** — Envelope Italy 110mm x 230mm -- **EnvelopeMonarch** — Envelope Monarch 3 7/8" x 7 1/2" -- **Executive** — Executive 7 1/4" x 10 1/2" -- **Folio** — Folio 8 1/2" x 13" -- **GermanLegalFanfold** — German Legal Fanfold 8 1/2" x 13" -- **GermanStandardFanfold** — German Std. Fanfold 8 1/2" x 12" -- **JapanesePostcard** — Japanese Postcard 100mm x 148mm -- **JapanesePostcardRotated** — Japanese Postcard Rot. 148mm x 100mm -- **Ledger** — Ledger 17" x 11" -- **Legal** — Legal 8 1/2" x 14" -- **LegalExtra** — Legal Extra 9 1/2" x 15" -- **Letter** — Letter 8 1/2" x 11" -- **LetterExtra** — Letter Extra 9 1/2" x 12" -- **LetterExtraTransverse** — Letter Extra Transv. 9 1/2" x 12" -- **LetterPlus** — Letter Plus 8 1/2" x 12 11/16" -- **LetterRotated** — Letter Rotated 11" x 8 1/2" -- **LetterSmall** — Letter small 8 1/2" x 11" -- **LetterTransverse** — Letter Transverse 8 1/2" x 11" -- **Note** — Note 8 1/2" x 11" -- **Quarto** — Quarto 215mm x 275mm -- **Size10x11** — 10x11 10" x 11" -- **Size10x14** — 10x14 10" x 14" -- **Size11x17** — 11x17 11" x 17" -- **Size12x11** — 12x11 12" x 11" -- **Size15x11** — 15x11 15" x 11" -- **Size634Envelope** — 6 3/4 Envelope 3 5/8" x 6 1/2" -- **Size9x11** — 9x11 9" x 11" -- **Statement** — Statement 5 1/2" x 8 1/2" -- **SuperAA4** — Super A/A4 227mm x 356mm -- **SuperBA3** — Super B/A3 305mm x 487mm -- **Tabloid** — Tabloid 11" x 17" -- **TabloidExtra** — Tabloid Extra 11 11/16" x 18" -- **USStandardFanfold** — US Standard Fanfold 14 7/8" x 11" -- **Undefined** — Undefined - -### [PositioningOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/PositioningOptions) -Represents the options available for getting or setting the bounds of a shape, cell, or region. - -- **None** — No special options should be used. Get and set actual bounds on the worksheet in its current state. -- **TreatAllRowsAndColumnsAsVisible** — Ignore the value on all rows and columns. Get and set bounds as if all rows and columns were currently visible. - -### [Precision](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/Precision) -Represents the types of precision which can be used when obtaining the value of a cell. - -- **UseDisplayValues** — The display value of the cell is used. If the cell's actual value is 10.005, but it is using currency formatting, it will display as $10.01. When this cell is used in calculations, its displayed value of 10.01 will be used. -- **UseRealCellValues** — The actual value of the cell is used. If the cell's actual value is 10.005, but it is using currency formatting, it will display as $10.01. When this cell is used in calculations, its stored value of 10.005 will be used, even though the display shows a slightly different value. - -### [PredefinedShapeType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/PredefinedShapeType) -Represents the shape types that are predefined in Microsoft Excel. - -- **Diamond** — Represents the shape. -- **Ellipse** — Represents the shape. -- **Heart** — Represents the shape. -- **IrregularSeal1** — Represents the shape. -- **IrregularSeal2** — Represents the shape. -- **LightningBolt** — Represents the shape. -- **Line** — Represents the shape. -- **Pentagon** — Represents the shape. -- **Rectangle** — Represents the shape. -- **RightTriangle** — Represents the shape. -- **StraightConnector1** — Represents the shape. - -### [PrintErrors](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/PrintErrors) -Represents the various ways to print cell errors in a worksheet. - -- **DontPrint** — Errors are not prints, as though the cells containing them have no value. -- **PrintAsDashes** — Errors are printed as two dashes "--". -- **PrintAsDisplayed** — Errors are printed just as they are displayed on the worksheet. -- **PrintAsNA** — Errors are prints as "#N/A". - -### [PrintNotes](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/PrintNotes) -Represents the various ways to print cell notes. - -- **DontPrint** — Cell notes are not printed. -- **PrintAsDisplayed** — Cell notes are printed as they are shown on the worksheet. With this option, cell notes will only appear in the printed worksheet if they are displayed on the worksheet in Microsoft Excel. If the notes just show indicators in Excel, the indicators and notes will not be printed. -- **PrintAtEndOfSheet** — Cell notes are printed on the last page, after the entire worksheet has printed. - -### [ScalingType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ScalingType) -Represents the ways to scale a worksheet when it is printed. - -- **FitToPages** — The page maximums are used to determine how many pages the worksheet can be printed on. Less pages can be used if there is not enough printable content in the worksheet. -- **UseScalingFactor** — The scaling factor is used to scale the worksheet when printing. - -### [ScrollBars](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ScrollBars) -Represents the various scroll bar configurations available for the workbook. - -- **Both** — Both scroll bars are shown in Microsoft Excel. -- **Horizontal** — Only the horizontal scroll bar is shown in Microsoft Excel. -- **None** — No scroll bars are shown in Microsoft Excel. -- **Vertical** — Only the vertical scroll bar is shown in Microsoft Excel. - -### [ShapePositioningMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ShapePositioningMode) -Represents the ways shapes will be repositioned when rows and columns are resized. - -- **DontMoveOrSizeWithCells** — Shapes will not move or size with the cells. The shape will remain in its absolute pixel position of the worksheet, regardless the rows and columns resized before or inside it. -- **MoveAndSizeWithCells** — Shapes will move and size with the cells. If columns before (or rows above) the shape are expanded, the shape will shift left. If columns within a shape are expanded, the shape will be widened. -- **MoveWithCells** — Shapes will move but not size with the cells. If columns before (or rows above) the shape are expanded, the shape will shift left. If columns within a shape are expanded, the shape will not be widened. - -### [SheetType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/SheetType) -Indicates the type of workbook - -- **Chartsheet** — A sheet that displays a single -- **Worksheet** — A sheet that contains rows and columns of data. - -### [SparklineAxisMinMax](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/SparklineAxisMinMax) -Determines how the min or max axis is calculated for a - -- **Custom** — Specifies that the vertical axis minimum or maximum for each sparkline in this sparkline group is specified by the or the attribute of the . -- **Group** — Specifies that the vertical axis minimum or maximum is shared across all sparklines in this sparkline group and is calculated automatically such that the data point with the minimum or maximum value can be displayed in the plot area. -- **Individual** — Specifies that the vertical axis minimum or maximum for each sparkline in this sparkline group is calculated automatically such that the data point with the minimum or maximum value can be displayed in the plot area. - -### [SparklineDisplayBlanksAs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/SparklineDisplayBlanksAs) -Determines how blanks are displayed in a sparkline - -- **Gap** — Empty cells are not plotted. -- **Span** — Empty cells are plotted as interpolated. -- **Zero** — Empty cells are plotted as zero. - -### [SparklineType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/SparklineType) -Determines the type if sparkline - -- **Column** — A series of vertical columns -- **Line** — A line sparkline -- **WinLoss** — Positive and negative values stacked - -### [TextFormatMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/TextFormatMode) -Represents the various way to combine a cell's value and format string to get its text. - -- **AsDisplayed** — Format the cell text as it is displayed in the Microsoft Excel UI. This takes into account the cell width when formatting the text. -- **IgnoreCellWidth** — Format the cell text as if it had unlimited space in the cell. However, this will not include padding characters from the format string. - -### [TwoConstraintDataValidationOperator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/TwoConstraintDataValidationOperator) -Represents the various operators which can be used when validating the cell value against two constraints. - -- **Between** — Only allows the cell value if it or its text length, depending on the validation criteria, is between the constraints applied to the validation rule. The constraints are inclusive. -- **NotBetween** — Only allows the cell value if it or its text length, depending on the validation criteria, is not between the constraints applied to the validation rule. The constraints are exclusive. - -### [VerticalCellAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/VerticalCellAlignment) -Enumeration for vertical alignment styles. Default value is used in property override situations. - -- **Bottom** — Bottom alignment. -- **Center** — Center alignment. -- **Default** — Use the current default. -- **Distributed** — Distributed alignment. -- **Justify** — Justify alignment. -- **Top** — Top alignment. - -### [VerticalTextAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/VerticalTextAlignment) -Represents the various vertical text alignment types. - -- **Bottom** — Align the text to the bottom of the available area. -- **Center** — Align the center to the bottom of the available area. -- **Top** — Align the text to the top of the available area. - -### [WorkbookEncryptionMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/WorkbookEncryptionMode) -Represents the various encryption modes that can be used to encrypt documents saved in the 2007 file formats and later. - -- **Agile** — Agile encryption used in Excel 2010 and later -- **Standard** — Standard encryption used in Excel 2007 and later - -### [WorkbookFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/WorkbookFormat) -Represents the various file formats in which a workbook can be saved. - -- **Excel2007** — The Excel 2007 XML file format. -- **Excel2007MacroEnabled** — The Excel 2007 Macro-Enabled XML file format. -- **Excel2007MacroEnabledTemplate** — The Excel 2007 Macro-Enabled Template XML file format. -- **Excel2007Template** — The Excel 2007 Template XML file format. -- **Excel97To2003** — The Excel 97-2003 BIFF8 file format. -- **Excel97To2003Template** — The Excel 97-2003 Template BIFF8 file format. -- **StrictOpenXml** — The Strict Open XML file format (ISO/IEC 29500 Strict). - -### [WorkbookThemeColorType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/WorkbookThemeColorType) -Represents the various theme colors in a workbook. - -- **Accent1** — Represents the Accent 1 theme color. -- **Accent2** — Represents the Accent 2 theme color. -- **Accent3** — Represents the Accent 3 theme color. -- **Accent4** — Represents the Accent 4 theme color. -- **Accent5** — Represents the Accent 5 theme color. -- **Accent6** — Represents the Accent 6 theme color. -- **Dark1** — Represents the Text/Background - Dark 1 theme color. -- **Dark2** — Represents the Text/Background - Dark 2 theme color. -- **FollowedHyperlink** — Represents the Followed Hyperlink theme color. -- **Hyperlink** — Represents the Hyperlink theme color. -- **Light1** — Represents the Text/Background - Light 1 theme color. -- **Light2** — Represents the Text/Background - Light 2 theme color. - -### [WorksheetCellFormatOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/WorksheetCellFormatOptions) -Flagged enumeration which indicates which groups of formatting properties are used in a format. - -- **All** — All properties are used on the format. -- **ApplyAlignmentFormatting** — The , , , , , and properties are used on the format. -- **ApplyBorderFormatting** — The , , , , , , , , , , and properties are used on the format. -- **ApplyFillFormatting** — The property is used on the format. -- **ApplyFontFormatting** — The property is used on the format. -- **ApplyNumberFormatting** — The property is used on the format. -- **ApplyProtectionFormatting** — The property is used on the format. -- **None** — No format properties are used on the format. - -### [WorksheetColumnWidthUnit](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/WorksheetColumnWidthUnit) -Represents the various units in which a column width can be represented. - -- **Character** — The column width is represented in units of the '0' digit character width, including column padding. The digit is measured with the default font for the workbook. The padding is a few pixels on either side of the column plus an additional pixel for the gridline. -- **Character256th** — The column width is represented in 256ths of the '0' digit character width, including column padding, which means this value will be 256 times the width expressed in Character units. The digit is measured with the default font for the workbook. The padding is a few pixels on either side of the column plus an additional pixel for the gridline. These units are the units in which the and properties are expressed. -- **CharacterPaddingExcluded** — The column width is represented in units of the '0' digit character width, excluding padding. The digit is measured with the default font for the workbook. These units are the units in which Microsoft Excel displays column widths to the user and accepts new column widths from the user in the 'Column Width' dialog. -- **Pixel** — The column width is represented in pixels. -- **Point** — The column width is represented in points. -- **Twip** — The column width is represented in twips (20ths of a point). - -### [WorksheetProtectedSelectionMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/WorksheetProtectedSelectionMode) -Enumeration used to indicate which cells may be selected when the Worksheet is protected. - -- **AllCells** — All cells including locked cells may be selected. -- **NoCells** — The selection cannot be change. -- **UnlockedCells** — Only cells that are unlocked may be selected via the keyboard or mouse. Note a cell that is locked may be selected if a range selection is created between 2 unlocked cells. - -### [WorksheetSortType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/WorksheetSortType) -Determines whether worksheet rows of columns are sorted within the region - -- **Columns** — Sort columns -- **Rows** — Sort rows - -### [WorksheetTableArea](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/WorksheetTableArea) -Represents the various areas which can have a format applied at the table level. - -- **DataArea** — The format is applied to the data area of the table. -- **HeaderRow** — The format is applied to the header row of the table. All but the top border properties can be set on this area format. Setting the top border properties will cause an exception. -- **TotalsRow** — The format is applied to the totals row of the table. All but the bottom border properties can be set on this area format. Setting the bottom border properties will cause an exception. -- **WholeTable** — The format is applied to the entire table. Only the outer border properties can be set on this area format. Setting any other will cause an exception. - -### [WorksheetTableColumnArea](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/WorksheetTableColumnArea) -Represents the various areas which can have a format applied at the table column level. - -- **DataArea** — The format is applied to the data area of the table column. -- **HeaderCell** — The format is applied to the header cell of the table column. -- **TotalCell** — The format is applied to the total cell of the table column. - -### [WorksheetTableStyleArea](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/WorksheetTableStyleArea) -Represents the various areas which can have a format applied at the table style level. - -- **AlternateColumnStripe** — The format is applied to the even numbered column stripes in the table. -- **AlternateRowStripe** — The format is applied to the even numbered row stripes in the table. -- **ColumnStripe** — The format is applied to the odd numbered column stripes in the table. -- **FirstColumn** — The format is applied to the first column in the table. -- **FirstHeaderCell** — The format is applied to the first header cell in the table. -- **FirstTotalCell** — The format is applied to the first total cell in the table. -- **HeaderRow** — The format is applied to the header row in the table. -- **LastColumn** — The format is applied to the last column in the table. -- **LastHeaderCell** — The format is applied to the last header cell in the table. -- **LastTotalCell** — The format is applied to the last total cell in the table. -- **RowStripe** — The format is applied to the odd numbered row stripes in the table. -- **TotalRow** — The format is applied to the totals row in the table. -- **WholeTable** — The format is applied to the entire table. - -### [WorksheetView](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/WorksheetView) -Represents the various views for a worksheet. - -- **Normal** — The worksheet is displayed in the normal view. -- **PageBreakPreview** — This view shows a preview of where pages will break when the worksheet is printed. -- **PageLayout** — The worksheet is displayed as it will appear when printed. This view displays where printed pages will begin and end as well as any headers or footers for the workbook. This value is only supported in Excel 2007 and defaults to Normal in earlier version. - -### [WorksheetVisibility](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/WorksheetVisibility) -Represents the various visibilities of a worksheet. - -- **Hidden** — The worksheet tab is not present in the tab bar. The worksheet can be made visible from the Unhide dialog in Microsoft Excel. -- **StrongHidden** — The worksheet tab is not present in the tab bar. The worksheet can only be made visible again through a Visual Basic procedure in Microsoft Excel. The worksheet can not be made visible through the user interface. -- **Visible** — The worksheet tab is present in the tab bar. - -### [ExcelCalcErrorCode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ExcelCalcErrorCode) -Enumeration of error codes assigned to . - -- **Circularity** — Occurs when a circularity formula is used when circularities are not allowed. -- **Div** — Occurs when a number is divided by zero (0) -- **NA** — Occurs when is entered into a formula -- **Name** — Occurs when text in a formula is not recognized. -- **Null** — Occurs when there is an intersection of two references that do not contain any common cells. -- **Num** — Occurs with invalid numeric values in a formula or function -- **Reference** — Occurs when an invalid or disconnected reference is encountered while evaluating a formula -- **Value** — Occurs when the wrong type of argument or operand is used in a formula - -### [AxisCrosses](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/AxisCrosses) -Constants which describe the point at which intersect. - -- **Automatic** — The crossing point is determined automatically. -- **Custom** — A custom value is designated as the crossing point, using the property -- **Maximum** — The axes cross at the point coinciding with the axis' maximum value. -- **Minimum** — The axes cross at the point coinciding with the axis' minimum value. - -### [AxisGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/AxisGroup) -Specifies the group of the axis, i.e., whether it is a primary or secondary axis. - -- **Primary** — Primary axis group. -- **Secondary** — Secondary axis group. Invalid for in 3D charts - -### [AxisPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/AxisPosition) -Constants which determine the placement of an , as relative to the chart space. - -- **Automatic** — The axis is positioned automatically, with the value axes appearing on the left/right, and the category axes appearing on the top/bottom. -- **Bottom** — The axis appears alongside the bottom edge of the chart. -- **Left** — The axis appears alongside the left edge of the chart. -- **Right** — The axis appears alongside the right edge of the chart. -- **Top** — The axis appears alongside the top edge of the chart. - -### [AxisType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/AxisType) -Specifies the axis type. - -- **Category** — Axis displays categories. -- **SeriesAxis** — Axis displays data series along the Z-axis (3D charts only). -- **Value** — Axis displays values. - -### [BarShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/BarShape) -Constants which define the shape used by a bar chart series. - -- **Box** — Square box -- **ConeToMax** — Truncated cone-shaped bar. -- **ConeToPoint** — Cone-shaped bar extending to the series maximum. -- **Cylinder** — Cylinder shaped bar. -- **PyramidToMax** — Truncated pyramid-shaped bar. -- **PyramidToPoint** — Pyramid-shaped bar extending to the series maximum. - -### [BorderLineStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/BorderLineStyle) -Determines the style of a border line, i.e., solid, dashed, dotted, etc. - -- **Dash** — Dashed line. -- **DashDot** — Alternating dashes and dots. -- **Dot** — Dotted line. -- **LargeDash** — Large dashed line. -- **LargeDashDot** — Large alternating dashes and dots. -- **LargeDashDotDot** — Large alternating dashes and pairs of dots. -- **None** — No line. -- **Solid** — Solid line. -- **SysDash** — System-defined dashed line. -- **SysDashDot** — System-defined alternating dashes and dots. -- **SysDashDotDot** — System-defined alternating dashes and pairs of dots. -- **SysDot** — System-defined dotted line. - -### [CategoryType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/CategoryType) -Constants which define the type of a category axis. - -- **AutomaticScale** — Scale is determined automatically. -- **CategoryScale** — A category . -- **TimeScale** — A date/time . - -### [ChartType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ChartType) -Constants which identify the chart's type, i.e., area chart, bar chart, pie chart, etc. - -- **Area** — Area -- **Area3D** — 3D Area. -- **Area3DStacked** — 3D Stacked Area. -- **Area3DStacked100** — 100% Stacked Area. -- **AreaStacked** — Stacked Area. -- **AreaStacked100** — 100% Stacked Area. -- **Bar3DClustered** — 3D Clustered Bar. -- **Bar3DStacked** — 3D Stacked Bar. -- **Bar3DStacked100** — 3D 100% Stacked Bar. -- **BarClustered** — Clustered Bar. -- **BarOfPie** — Bar of Pie. -- **BarStacked** — Stacked Bar. -- **BarStacked100** — 100% Stacked Bar. -- **BoxAndWhisker** — Box and whisker (Office2016 or later) -- **Bubble** — Bubble. -- **Bubble3DEffect** — Bubble with 3D effects. -- **Column3D** — 3D Column. -- **Column3DClustered** — 3D Clustered Column. -- **Column3DStacked** — 3D Stacked Column. -- **Column3DStacked100** — 3D 100% Stacked Column. -- **ColumnClustered** — Clustered Column. -- **ColumnStacked** — Stacked Column. -- **ColumnStacked100** — 100% Stacked Column. -- **Combo** — Combination of different chart types. -- **ConeBarClustered** — Clustered Cone Bar. -- **ConeBarStacked** — Stacked Cone Bar. -- **ConeBarStacked100** — 100% Stacked Cone Bar. -- **ConeCol** — 3D Cone Column. -- **ConeColClustered** — Clustered Cone Column. -- **ConeColStacked** — Stacked Cone Column. -- **ConeColStacked100** — 100% Stacked Cone Column. -- **CylinderBarClustered** — Clustered Cylinder Bar. -- **CylinderBarStacked** — Stacked Cylinder Bar. -- **CylinderBarStacked100** — 100% Stacked Cylinder Bar. -- **CylinderCol** — 3D Cylinder Column. -- **CylinderColClustered** — Clustered Cone Column. -- **CylinderColStacked** — Stacked Cone Column. -- **CylinderColStacked100** — 100% Stacked Cylinder Column. -- **Doughnut** — Doughnut. -- **DoughnutExploded** — Exploded Doughnut. -- **Funnel** — Funnel (Office365 only) -- **Histogram** — Histogram chart (Office2016 or later) -- **Line** — Line. -- **Line3D** — 3D Line. -- **LineMarkers** — Line with Markers. -- **LineMarkersStacked** — Stacked Line with Markers. -- **LineMarkersStacked100** — 100% Stacked Line with Markers. -- **LineStacked** — Stacked Line. -- **LineStacked100** — 100% Stacked Line. -- **Pareto** — Pareto chart with bars and lines (Office2016 or later) -- **Pie** — Pie. -- **Pie3D** — 3D Pie. -- **Pie3DExploded** — Exploded 3D Pie. -- **PieExploded** — Exploded Pie. -- **PieOfPie** — Pie of Pie. -- **PyramidBarClustered** — Clustered Pyramid Bar. -- **PyramidBarStacked** — Stacked Pyramid Bar. -- **PyramidBarStacked100** — 100% Stacked Pyramid Bar. -- **PyramidCol** — 3D Pyramid Column. -- **PyramidColClustered** — Clustered Pyramid Column. -- **PyramidColStacked** — Stacked Pyramid Column. -- **PyramidColStacked100** — 100% Stacked Pyramid Column. -- **Radar** — Radar. -- **RadarFilled** — Filled Radar. -- **RadarMarkers** — Radar with Data Markers. -- **RegionMap** — Region map (geographic) chart (Office365 only) -- **StockHLC** — High-Low-Close. -- **StockOHLC** — Open-High-Low-Close. -- **StockVHLC** — Volume-High-Low-Close. -- **StockVOHLC** — Volume-Open-High-Low-Close. -- **Sunburst** — Sunburst chart (Office2016 or later) -- **Surface** — Surface (a.k.a. Contour). -- **SurfaceTopView** — 3D Surface (Top View). -- **SurfaceTopViewWireframe** — 3D Surface (Top View wireframe). -- **SurfaceWireframe** — Surface (a.k.a. Contour - wireframe). -- **Treemap** — Tree map chart (Office2016 or later) -- **Waterfall** — Waterfall chart (Office2016 or later) -- **XYScatter** — Scatter. -- **XYScatterLines** — Scatter with Lines. -- **XYScatterLinesNoMarkers** — Scatter with Lines and No Data Markers. -- **XYScatterSmooth** — Scatter with Smoothed Lines. -- **XYScatterSmoothNoMarkers** — Scatter with Smoothed Lines and No Data Markers. - -### [DataLabelPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/DataLabelPosition) -Constants which define the location at which a is positioned. - -- **Above** — The label is positioned above the associated data point. -- **Below** — The label is positioned below the associated data point. -- **BestFit** — The label is positioned where it best fits with relation to the associated pie slice. -- **Center** — The label is centered with respect to the associated data point. -- **Custom** — The label's position is explicitly defined via the and properties. -- **Default** — The label position is not specified, and is determined automatically by Excel. -- **InsideBase** — The label's left edge coincides with the left edge of the series bar/line. -- **InsideEnd** — The label's right edge coincides with the right edge of the series bar/line. -- **Left** — The label is positioned to the left of the associated data point. -- **OutsideEnd** — The label's left edge coincides with the right edge of the series bar/line. -- **Right** — The label is positioned to the right of the associated data point. - -### [DisplayBlanksAs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/DisplayBlanksAs) -Constants which define how blank cell values are plotted on the chart. - -- **Interpolated** — The value is interpolated from adjacent values. -- **NotPlotted** — Points representing blank cell values are not plotted on the chart. -- **Zero** — Blank cell values are interpreted as having a value of zero. - -### [DisplayUnit](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/DisplayUnit) -Constants which determine the unit of expression for value labels. - -- **Custom** — The property determines the display unit. -- **HundredMillions** — 100,000,000 -- **HundredThousands** — 100,000 -- **Hundreds** — 100 -- **MillionMillions** — 1,000,000,000,000 (trillions) -- **Millions** — 1,000,000 -- **None** — The raw value is displayed without special formatting. -- **Percentage** — Displays as a percentage. Applicable only to Box and Whisker, Histogram, Pareto, Sunburst, Treemap, and Waterfall chart types; if used for any other chart type, resolved to Hundreds. -- **TenMillions** — 10,000,000 -- **TenThousands** — 10,000 -- **ThousandMillions** — 1,000,000,000 (billions) -- **Thousands** — 1,000 - -### [ElementPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ElementPosition) -Constants which determine whether a chart element is positioned automatically or at a specific location in the chart space. - -- **Automatic** — The chart element is positioned automatically as appropriate for that element. For example, a is typically positioned at the top of the chart space, centered horizontally. -- **Bottom** — The chart element is positioned under the plot area, centered horizontally. Applicable only for BoxAndWhisker, Histogram, Pareto, Sunburst, Treemap, and Waterfall chart types. -- **BottomLeft** — The chart element is positioned below the plot area, horizontally aligned with the left edge. Applicable only for BoxAndWhisker, Histogram, Pareto, Sunburst, Treemap, and Waterfall chart types. -- **BottomRight** — The chart element is positioned below the plot area, horizontally aligned with the right edge. Applicable only for BoxAndWhisker, Histogram, Pareto, Sunburst, Treemap, and Waterfall chart types. -- **Custom** — Custom. -- **Left** — The chart element is positioned to the left of the plot area, centered vertically. Applicable only for BoxAndWhisker, Histogram, Pareto, Sunburst, Treemap, and Waterfall chart types. -- **LeftBottom** — The chart element is positioned to the left of the plot area, vertically aligned with the bottom edge. Applicable only for BoxAndWhisker, Histogram, Pareto, Sunburst, Treemap, and Waterfall chart types. -- **LeftTop** — The chart element is positioned to the left of the plot area, vertically aligned with the top edge. Applicable only for BoxAndWhisker, Histogram, Pareto, Sunburst, Treemap, and Waterfall chart types. -- **Right** — The chart element is positioned to the right of the plot area, centered vertically. Applicable only for BoxAndWhisker, Histogram, Pareto, Sunburst, Treemap, and Waterfall chart types. -- **RightBottom** — The chart element is positioned to the right of the plot area, vertically aligned with the bottom edge. Applicable only for BoxAndWhisker, Histogram, Pareto, Sunburst, Treemap, and Waterfall chart types. -- **RightTop** — The chart element is positioned to the right of the plot area, vertically aligned with the top edge. Applicable only for BoxAndWhisker, Histogram, Pareto, Sunburst, Treemap, and Waterfall chart types. -- **Top** — The chart element is positioned above the plot area, centered horizontally. Applicable only for BoxAndWhisker, Histogram, Pareto, Sunburst, Treemap, and Waterfall chart types. -- **TopLeft** — The chart element is positioned above the plot area, horizontally aligned with the left edge. Applicable only for BoxAndWhisker, Histogram, Pareto, Sunburst, Treemap, and Waterfall chart types. -- **TopRight** — The chart element is positioned above the plot area, horizontally aligned with the right edge. Applicable only for BoxAndWhisker, Histogram, Pareto, Sunburst, Treemap, and Waterfall chart types. - -### [EndStyleCap](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/EndStyleCap) -Constants which determine the style of the endpoint of a line on a line chart. - -- **Cap** — The line terminates with a cap. -- **NoCap** — No cap is displayed at the end of the line. - -### [ErrorBarDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ErrorBarDirection) -Constants which specify the direction in which an extends. - -- **Both** — The error bar extends in both directions. -- **Minus** — The error bar extends only in the negative direction. -- **Plus** — The error bar extends only in the positive direction. - -### [ErrorValueType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ErrorValueType) -Constants which specify the units used to depict errors on an . - -- **FixedValue** — The error range is defined by a fixed numerical value. -- **Percentage** — The error range is defined by a percentage. -- **StandardDeviation** — The error range is defined by standard deviation. -- **StandardError** — The error range is defined by standard error. - -### [GeographicMapLabels](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/GeographicMapLabels) -Constants which define the manner in which map labels are displayed. - -- **BestFit** — Map labels are displayed only for regions inside which the label can fit. -- **None** — Map labels are not displayed. -- **ShowAll** — Map labels are displayed for all regions. - -### [GeographicMapProjection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/GeographicMapProjection) -Constants which define the projection for a geographic map chart. - -- **Albers** — Albers equal-area conic projection. -- **Mercator** — Mercator cylindrical map projection. -- **Miller** — Miller cylindrical map projection. -- **Robinson** — Robinson flat map projection. - -### [GeographicMapSeriesColor](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/GeographicMapSeriesColor) -Constants which define the manner in which colors are used to depict series values in a geographic map chart. - -- **Diverging** — Three colors define the minimum, midpoint, and maximum series values. -- **Sequential** — Two colors define the minimum and maximum series values. - -### [GeographicMappingArea](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/GeographicMappingArea) -Constants which define the level of granularity for a geographic map chart. - -- **CountryOrRegion** — The entire country or region is displayed, with areas for which no series data is available appearing in a lighter color. -- **County** — A county is displayed. -- **DataOnly** — Only regions for which series data is available are displayed. -- **MultipleCountriesOrRegions** — Multiple countries or regions are displayed, with areas for which no series data is available appearing in a lighter color. -- **PostalCode** — A postal region is displayed. -- **State** — A state is displayed. -- **World** — The entire world map is displayed, with areas for which no series data is available appearing in a lighter color. - -### [GradientType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/GradientType) -Constants which determine the type of gradient applied to a . - -- **Linear** — The gradient extends in a linear direction. -- **Path** — The gradient direction is determined by the shape's path. -- **Radial** — The gradient extends along a radial curve. -- **Rectangular** — The gradient extends along a rectangular path. - -### [GridLineType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/GridLineType) -Constants which define whether a gridline is major or minor. - -- **Major** -- **Minor** - -### [LegendPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/LegendPosition) -Constants which determine the placement of the chart's . - -- **Bottom** — The legend appears at the bottom of the chart. -- **BottomLeft** — The legend appears near the bottom left corner of the chart. Supported only for Histogram, Pareto, Treemap, Sunburst, Box and Whisker, and Waterfall chart types. -- **BottomRight** — The legend appears near the bottom right corner of the chart. Supported only for Histogram, Pareto, Treemap, Sunburst, Box and Whisker, and Waterfall chart types. -- **Custom** — The legend's size and location is determined by the , , , and properties. -- **Default** — The legend position is determined automatically by Excel. -- **Left** — The legend appears near the left edge of the chart. -- **Right** — The legend appears near the right edge of the chart. -- **Top** — The legend appears at the top of the chart. -- **TopLeft** — The legend appears near the top left corner of the chart. Supported only for Histogram, Pareto, Treemap, Sunburst, Box and Whisker, and Waterfall chart types. -- **TopRight** — The legend appears near the top right corner of the chart. - -### [LineStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/LineStyle) -Determines the style of a line, i.e., solid, dashed, dotted, etc. - -- **Dash** — Dashed line. -- **DashDot** — Alternating dashes and dots. -- **Dot** — Dotted line. -- **LargeDash** — Large dashed line. -- **LargeDashDot** — Large alternating dashes and dots. -- **LargeDashDotDot** — Large alternating dashes and pairs of dots. -- **None** — No line. -- **Solid** — Solid line. -- **SysDash** — System-defined dashed line. -- **SysDashDot** — System-defined alternating dashes and dots. -- **SysDashDotDot** — System-defined alternating dashes and pairs of dots. -- **SysDot** — System-defined dotted line. - -### [MarkerStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/MarkerStyle) -Constants which determine the style of the markers displayed by line charts. - -- **Automatic** — The marker style is determined automatically. -- **Circle** — The marker is circular. -- **Dash** — The marker is a dash. -- **Diamond** — The marker is diamond-shaped. -- **Dot** — The marker is a dot or bullet. -- **None** — No marker is displayed. -- **Picture** — The marker appears as a picture. -- **Plus** — The marker appears as a plus sign (+). -- **Square** — The marker appears as a square. -- **Star** — The marker appears as a star. -- **Triangle** — The marker appears as a triangle. -- **X** — The marker appears as an 'X' - -### [ParentLabelLayout](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ParentLabelLayout) -Constants which define the label positioning for a Treemap chart. - -- **Banner** — Labels are displayed as banners. -- **None** — Labels are not displayed. -- **Overlapping** — Labels are displayed with overlapping. - -### [PatternType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/PatternType) -Constants which define the type of fill pattern applied to a shape. - -- **Pattern10Percent** — 10% of the foreground color. -- **Pattern20Percent** — 20% of the foreground color. -- **Pattern25Percent** — 25% of the foreground color. -- **Pattern30Percent** — 30% of the foreground color. -- **Pattern40Percent** — 40% of the foreground color. -- **Pattern50Percent** — 50% of the foreground color. -- **Pattern5Percent** — 5% of the foreground color. -- **Pattern60Percent** — 60% of the foreground color. -- **Pattern70Percent** — 70% of the foreground color. -- **Pattern75Percent** — 75% of the foreground color. -- **Pattern80Percent** — 80% of the foreground color. -- **Pattern90Percent** — 90% of the foreground color. -- **PatternCross** — Cross -- **PatternDarkDownwardDiagonal** — Dark Downward Diagonal -- **PatternDarkHorizontal** — Dark Horizontal -- **PatternDarkUpwardDiagonal** — Dark Upward Diagonal -- **PatternDarkVertical** — Dark Vertical -- **PatternDashedDownwardDiagonal** — Dashed Downward Diagonal -- **PatternDashedHorizontal** — Dashed Horizontal -- **PatternDashedUpwardDiagonal** — Dashed Upward Diagonal -- **PatternDashedVertical** — Dashed Vertical -- **PatternDiagonalBrick** — Diagonal Brick -- **PatternDiagonalCross** — Diagonal Cross -- **PatternDivot** — Pattern Divot -- **PatternDottedDiamond** — Dotted Diamond -- **PatternDottedGrid** — Dotted Grid -- **PatternDownwardDiagonal** — Downward Diagonal -- **PatternHorizontal** — Horizontal -- **PatternHorizontalBrick** — Horizontal Brick -- **PatternLargeCheckerBoard** — Large Checker Board -- **PatternLargeConfetti** — Large Confetti -- **PatternLargeGrid** — Large Grid -- **PatternLightDownwardDiagonal** — Light Downward Diagonal -- **PatternLightHorizontal** — Light Horizontal -- **PatternLightUpwardDiagonal** — Light Upward Diagonal -- **PatternLightVertical** — Light Vertical -- **PatternMixed** — Mixed pattern -- **PatternNarrowHorizontal** — Narrow Horizontal -- **PatternNarrowVertical** — Narrow Vertical -- **PatternOutlinedDiamond** — Outlined Diamond -- **PatternPlaid** — Plaid -- **PatternShingle** — Shingle -- **PatternSmallCheckerBoard** — Small Checker Board -- **PatternSmallConfetti** — Small Confetti -- **PatternSmallGrid** — Small Grid -- **PatternSolidDiamond** — Solid Diamond -- **PatternSphere** — Sphere -- **PatternTrellis** — Trellis -- **PatternUpwardDiagonal** — Upward Diagonal -- **PatternVertical** — Vertical -- **PatternWave** — Wave -- **PatternWeave** — Weave -- **PatternWideDownwardDiagonal** — Wide Downward Diagonal -- **PatternWideUpwardDiagonal** — Wide Upward Diagonal -- **PatternZigZag** — Zig Zag - -### [PictureType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/PictureType) -Constants which determine the manner in which a picture is displayed. - -- **Scale** — The picture is scaled to fill it's containing element. -- **Stack** — The picture is stacked or tiled to fill it's containing element. -- **Stretch** — The picture is stretched to fill it's containing element. - -### [QuartileCalculation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/QuartileCalculation) -Constants which determine the method of calculation used when determining the median for a box and whisker chart. - -- **ExclusiveMedian** — The median is excluded from the calculation if n (the number of values in the data) is odd. -- **InclusiveMedian** — The median is included in the calculation if n (the number of values in the data) is odd. - -### [ReadingOrder](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ReadingOrder) -Constants which determine the reading order. - -- **Context** — The direction is based on context. -- **LeftToRight** — The order is left-to-right. -- **RightToLeft** — The order is right-to-left. - -### [ScaleType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ScaleType) -Determines the numerical scale of the axis - -- **Linear** — The scale is linear. -- **Logarithmic** — The scale is logarithmic. - -### [SeriesType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/SeriesType) -Determines the type of . - -- **Area** — Area; used by both area and area 3D charts. -- **Bar** — Bar; used by both bar and bar 3D charts. -- **Bubble** — Bubble. -- **Line** — Line; used by line, line 3D, and stock charts. -- **Pie** — Pie; used by pie, pie 3D, doughnut, and 'of pie' charts. -- **Radar** — Radar. -- **Scatter** — Scatter. -- **Surface** — Surface; used by surface and surface 3D charts. - -### [SeriesValuesColorBy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/SeriesValuesColorBy) -Constants which determine the manner in which series values are used to color regions on a geographic map chart. - -- **NumericalValue** — The coloring of map regions is determined by the numerical value of the associated data point. -- **SecondaryCategory** — The coloring of map regions is determined by the value of the associated data point, which is assumed to represent a category. - -### [TextDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/TextDirection) -Determines the direction in which text flows. - -- **EastAsianVertical** — Text flows along the vertical plane with East Asian vertical orientation. -- **Horizontal** — Text flows along the horizontal plane. Note that under this setting, text rotation is also supported, with the angle of rotation being relative to the horizontal plane. -- **MongolianVertical** — Text flows along the vertical plane with Mongolian vertical orientation. -- **Vertical** — Text flows along the vertical plane. The plane is defined by rotating the horizontal axis by 90 degrees in the clockwise direction. -- **Vertical270** — Text flows along the vertical plane. The plane is defined by rotating the horizontal axis by 270 degrees in the clockwise direction. -- **WordArtVertical** — Text flows along the vertical plane with WordArt vertical orientation. -- **WordArtVerticalRtl** — Similar to WordArtVertical, with a right-to-left text reading direction. - -### [TextHorizontalOverflow](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/TextHorizontalOverflow) -Constants which describe whether text is allowed to continue horizontally outside the bounds of the containing element. - -- **Clip** — The text is clipped by the containing element. -- **Overflow** — The text is allowed to continue outside the bounds of the containing element. - -### [TextVerticalOverflow](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/TextVerticalOverflow) -Constants which describe whether text is allowed to continue vertically outside the bounds of the containing element. - -- **Clip** — The text is clipped by the containing element. -- **Ellipsis** — Overflowing text is truncated and an ellipsis is displayed. -- **Overflow** — The text is allowed to continue outside the bounds of the containing element. - -### [TickLabelAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/TickLabelAlignment) -Determines the alignment for axis - -- **Center** — The tick labels will be centered -- **Left** — The tick labels will be aligned on the left -- **Right** — The tick labels will be aligned on the right - -### [TickLabelPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/TickLabelPosition) -Constants which determine the placement of an axis' . - -- **High** — Tick labels appear near the highest data value. -- **Low** — Tick labels appear near the lowest data value. -- **NextToAxis** — Tick labels appear near the axis. -- **None** — Tick labels are not displayed. - -### [TickMark](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/TickMark) -Constants which determine the placement of an axis' and tick marks. - -- **Cross** — The tick marks cross the axis line. -- **Inside** — The tick marks appear on the side of the axis line closest to the inside of the plot area. -- **None** — Tick marks are not displayed. -- **Outside** — The tick marks appear on the side of the axis line closest to the outside of the plot area. - -### [TimeUnit](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/TimeUnit) -Constants which determine the unit of measure for date/time values. - -- **Days** — The Axis interval is expressed in days. -- **Months** — The Axis interval is expressed in months. -- **Years** — The Axis interval is expressed in years. - -### [TrendlinePolynomialOrder](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/TrendlinePolynomialOrder) -Constants which define the order/degree of the polynomial applied to a when the trendline type is Polynomial. - -- **Fifth** — A fifth-order/degree polynomial. -- **Fourth** — A fourth-order/degree polynomial. -- **Second** — A second-order/degree polynomial. -- **Sixth** — A sixth-order/degree polynomial. -- **Third** — A third-order/degree polynomial. - -### [TrendlineType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/TrendlineType) -Constants which define the various types of trendlines supported by a . - -- **Exponential** — The trendline is exponential. -- **Linear** — The trendline is linear. -- **Logarithmic** — The trendline is logarithmic. -- **MovingAverage** — The trendline depicts a moving average. -- **Polynomial** — The trendline depicts a polynomial of order/degree n, when n is specified by the ChartTrendline.PolynomialOrder property. -- **Power** — The trendline depicts a power curve. - -### [UpDownBarType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/UpDownBarType) -Constants which distinguish between an up or down bar in a stock chart. - -- **Down** — Down bar. -- **Up** — Up bar. - -### [VerticalTitleAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/VerticalTitleAlignment) -Determines the horizontal alignment for a title - -- **Bottom** — The title will be aligned on the bottom -- **Center** — The title will be centered vertically -- **Distributed** — The title will be distributed -- **Justify** — The title will be justified -- **Top** — The title will be aligned on the top - -### [WallType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/WallType) -Constants which determine the type of a , i.e., back, side, or floor. Applicable only for 3-D charts. - -- **All** — Applies to the back and side walls, and the floor. -- **Back** — The back wall, i.e., "behind" the plot area. -- **Floor** — The bottom wall, i.e., the floor of the chart. -- **Side** — The side wall. Note that only one side is ever visible, based on the rotation around the Y-axis. - -### [ColorScaleCriterionThreshold](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ColorScaleCriterionThreshold) -Constants which identify the threshold of a . - -- **Maximum** — Identifies the maximum threshold. -- **Midpoint** — Identifies the midpoint threshold. -- **Minimum** — Identifies the minimum threshold. - -### [ColorScaleType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ColorScaleType) -Constants which identify whether a supports two or three thresholds. Used to differentiate between a 2-color and 3-color scale. - -- **ThreeColor** — In addition to the the and thresholds, the color scale also supports a threshold. -- **TwoColor** — The color scale supports only the and thresholds. - -### [DataBarAxisPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/DataBarAxisPosition) -Constants which determine the axis position for a . - -- **Automatic** — Displays the axis at a variable position based on the ratio of the minimum negative value to the maximum positive value in the associated range. Positive values are displayed in a left-to-right direction; negative values are displayed from right to left. When all values are positive, or all values are negative, no axis is displayed. -- **Midpoint** — Displays the axis at the midpoint of the cell, regardless of the set of values in the associated range. Positive values are displayed in a left-to-right direction; negative values are displayed from right to left. -- **None** — No axis is displayed; positive and negative values are both displayed in the left-to-right direction. - -### [DataBarDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/DataBarDirection) -Constants which determine whether are filled with a solid color or with a gradient. - -- **Context** — The direction the data bar is displayed is based on context. -- **LeftToRight** — The data bar is displayed from left-to-right. -- **RightToLeft** — The data bar is displayed from right-to-left. - -### [DataBarFillType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/DataBarFillType) -Constants which determine whether are filled with a solid color or with a gradient. - -- **Gradient** — Data bars are filled with a linear gradient. -- **SolidColor** — Data bars are filled with a solid color. - -### [DataBarNegativeBarColorType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/DataBarNegativeBarColorType) -Constants which specify the manner in which the color for negative-value data bars is determined. - -- **Color** — Use the value of the property. -- **SameAsPositive** — Use the same color as that of the positive-value data bars. - -### [FormatConditionAboveBelow](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/FormatConditionAboveBelow) -Constants which specify the manner in which cell values are compared when evaluating a . - -- **AboveAverage** — The cell value must be above the average for the associated range in order to meet the associated condition. -- **AboveStandardDeviation** — The cell value must be above the standard deviation for the associated range in order to meet the associated condition. -- **BelowAverage** — The cell value must be below the average for the associated range in order to meet the associated condition. -- **BelowStandardDeviation** — The cell value must be below the standard deviation for the associated range in order to meet the associated condition. -- **EqualAboveAverage** — The cell value must be equal to or above the average for the associated range in order to meet the associated condition. -- **EqualBelowAverage** — The cell value must be equal to or below the average for the associated range in order to meet the associated condition. - -### [FormatConditionOperator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/FormatConditionOperator) -Constants which specify the manner in which a cell value is compared against one or more operands. - -- **Between** — The condition evaluates to true if the cell value is between the values of the two operands. -- **Equal** — The condition evaluates to true if the cell value is equal to the value of the operand. -- **Greater** — The condition evaluates to true if the cell value is greater than the value of the operand. -- **GreaterEqual** — The condition evaluates to true if the cell value is greater than or equal to the value of the operand. -- **Less** — The condition evaluates to true if the cell value is less than the value of the operand. -- **LessEqual** — The condition evaluates to true if the cell value is less than or equal to the value of the operand. -- **NotBetween** — The condition evaluates to true if the cell value is not between the values of the two operands. -- **NotEqual** — The condition evaluates to true if the cell value is not equal to the value of the operand. - -### [FormatConditionTextOperator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/FormatConditionTextOperator) -Constants which specify the text comparison method applied when evaluating a . - -- **BeginsWith** — The string being evaluated must begin with the value to which it is being compared in order for the condition to be met. -- **Contains** — The string being evaluated must match some part of the value to which it is being compared in order for the condition to be met. -- **DoesNotContain** — Negates the value; the string being evaluated must not match any part of the value to which it is being compared in order for the condition to be met. -- **EndsWith** — The string being evaluated must end with the value to which it is being compared in order for the condition to be met. - -### [FormatConditionTimePeriod](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/FormatConditionTimePeriod) -Constants which define the manner in which a cell's date/time value is compared when evaluating a . - -- **LastMonth** — The cell's date/time value is compared to the month before the current one. -- **LastSevenDays** — The cell's date/time value meets the condition if it lies within the range of the past seven days, without regard to the . -- **LastWeek** — The cell's date/time value is compared to the week before the current one, as defined by the . -- **NextMonth** — The cell's date/time value is compared to the month after the current one. -- **NextWeek** — The cell's date/time value is compared to the week after the current one, as defined by the . -- **ThisMonth** — The cell's date/time value is compared to the current month. -- **ThisWeek** — The cell's date/time value is compared to the current week, as defined by the . -- **Today** — The cell's date/time value is compared to the current date. -- **Tomorrow** — The cell's date/time value is compared to the day after the current date. -- **Yesterday** — The cell's date/time value is compared to the day before the current date. - -### [FormatConditionTopBottom](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/FormatConditionTopBottom) -Constans which identify whether a evaluates to true for the top or bottom ranked values across the associated range. - -- **Bottom** — The cell value must fall within the bottom ranking of values for the associated range. -- **Top** — The cell value must fall within the top ranking of values for the associated range. - -### [FormatConditionType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/FormatConditionType) -Constants which determine the criteria for a format . - -- **Average** — Cells with values which are greater than or less than the average value for the associated region are formatted. -- **Blanks** — Cells with no value are formatted. Note that foreground-related properties such as font colors are not applicable. -- **CellValue** — The format is based on the cell's value, which is evaluated against one or more conditions to determine whether the value meets a particular criteria. -- **ColorScale** — Represents a conditional formatting rule which applies gradations to cell colors to indicate relative differences in the values of cells which belong to the associated range. -- **DataBar** — Represents a conditional formatting rule which renders a color bar inside the cell to indicate relative differences in the values of cells which belong to the associated range. -- **DuplicateValues** — Cells with values which are duplicated (non-unique) across the associated range are formatted. -- **Errors** — The format is applied to cells which contain an error. -- **Expression** — The format is determined by evaluating a formula. -- **IconSets** — Represents a conditional formatting rule which displays an icon inside the cell which indicates the cell's value as relative to the highest and lowest value in the associated range. -- **NoBlanks** — Cells with a non-empty value are formatted. -- **NoErrors** — The format is applied to cells which do not contain an error. -- **Rank** — Cells with the top/bottom n values are formatted, where n represents a numeric, percentage, or percentile ranking. For example, this type can be used to to enable a 'top ten' condition. -- **TextString** — The format is determined by whether the cell's value matches a literal string value. -- **TimePeriod** — The format is determined by whether a cell's date value falls within a given period of time. -- **UniqueValues** — Cells with values which are unique across the associated range are formatted. - -### [FormatConditionValueType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/FormatConditionValueType) -Constants which identify the type of value which defines the criteria for a or . - -- **AutomaticMaximum** — The longest data bar is proportional to the highest value across the associated range. Applicable only to the class. -- **AutomaticMinimum** — The shortest data bar is proportional to the lowest value across the associated range. Applicable only to the class. -- **Formula** — The criteria is defined by a formula. -- **HighestValue** — The criteria is defined by the highest value across the associated range. -- **LowestValue** — The criteria is defined by the lowest value across the associated range. -- **Number** — The criteria is defined by a numeric value. -- **Percentage** — The criteria is defined by a percentage. -- **Percentile** — The criteria is defined by a percentile rating. - -### [ThresholdComparison](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ThresholdComparison) -Constants which determine the manner in which cell values are compared to the property when conditional criteria is evaluated by an . - -- **Greater** — The cell value must be greater than but not equal to the threshold . -- **GreaterEqual** — The cell value can be greater than or equal to the threshold . - -### [AverageFilterType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/AverageFilterType) -Represents the various types of the . - -- **AboveAverage** — Filter in values above the average of the entire range of data being filtered. -- **BelowAverage** — Filter in values below the average of the entire range of data being filtered. - -### [CalendarType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/CalendarType) -Represents the various calendar types available for the - -- **Gregorian** — The Gregorian calendar should be used. -- **GregorianArabic** — The Arabic version of the Gregorian calendar should be used. -- **GregorianMeFrench** — The Middle East French version of the Gregorian calendar should be used. -- **GregorianUs** — The US English version of the Gregorian calendar should be used. -- **GregorianXlitEnglish** — The transliterated English version of the Gregorian calendar should be used. -- **GregorianXlitFrench** — The transliterated French version of the Gregorian calendar should be used. -- **Hebrew** — The Hebrew lunar calendar, as described by the Gauss formula for Passover and The Complete Restatement of Oral Law, should be used. -- **Hijri** — The Hijri lunar calendar, as described by the Kingdom of Saudi Arabia, Ministry of Islamic Affairs, Endowments, Da‘wah and Guidance, should be used. -- **Japan** — The Japanese Emperor Era calendar, as described by Japanese Industrial Standard JIS X 0301, should be used. -- **Korea** — The Korean Tangun Era calendar, as described by Korean Law Enactment No. 4, should be used. -- **None** — Specifies that no calendar should be used. -- **Saka** — The Saka Era calendar, as described by the Calendar Reform Committee of India, as part of the Indian Ephemeris and Nautical Almanac, should be used. -- **Taiwan** — The Taiwanese calendar, as defined by the Chinese National Standard CNS 7648, should be used. -- **Thai** — The Thai calendar, as defined by the Royal Decree of H.M. King Vajiravudh (Rama VI) in Royal Gazette B. E. 2456 (1913 A.D.) and by the decree of Prime Minister Phibunsongkhram (1941 A.D.) to start the year on the Gregorian January 1 and to map year zero to Gregorian year 543 B.C., should be used. - -### [ConditionalOperator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ConditionalOperator) -Represents the various logical operators used to combine the conditions of the . - -- **And** — Filter in values where only and pass. -- **Or** — Filter in values where either or (or both) pass. - -### [DatePeriodFilterType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/DatePeriodFilterType) -Represents the various date range types which can be filtered by the . - -- **Month** — Filter in dates in a specific month of any year. -- **Quarter** — Filter in dates in a specific quarter of any year. - -### [ExcelComparisonOperator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/ExcelComparisonOperator) -Represents the various comparisons which can be used in the . - -- **BeginsWith** — Filter in string values which begin with the comparison value. -- **Contains** — Filter in string values which contain the comparison value. -- **DoesNotBeginWith** — Filter in string values which do not begin with the comparison value. -- **DoesNotContain** — Filter in string values which do not contain the comparison value. -- **DoesNotEndWith** — Filter in string values which do not end with the comparison value. -- **EndsWith** — Filter in string values which ends with the comparison value. -- **Equals** — Filter in values which are equal to the comparison value. -- **GreaterThan** — Filter in values which are greater than the comparison value. -- **GreaterThanOrEqual** — Filter in values which are greater than or equal to the comparison value. -- **LessThan** — Filter in values which are less than the comparison value. -- **LessThanOrEqual** — Filter in values which are less than or equal to the comparison value. -- **NotEqual** — Filter in values which are not equal to the comparison value. - -### [FixedDateGroupType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/FixedDateGroupType) -Represents the various types, or precisions, of a . - -- **Day** — The group represents the day in which the exists. -- **Hour** — The group represents the hour in which the exists. -- **Minute** — The group represents the minute in which the exists. -- **Month** — The group represents the month in which the exists. -- **Second** — The group represents the second in which the exists. -- **Year** — The group represents the year in which the exists. - -### [RelativeDateRangeDuration](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/RelativeDateRangeDuration) -Represents the various durations which can be filtered by the . - -- **Day** — The duration of accepted values is one day. -- **Month** — The duration of accepted values is one month. -- **Quarter** — The duration of accepted values is one quarter. -- **Week** — The duration of accepted values is one week. -- **Year** — The duration of accepted values is one year. - -### [RelativeDateRangeOffset](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/RelativeDateRangeOffset) -Represents the various relative date offsets which can be filtered by the . - -- **Current** — Filter in values in the current duration relative to the filter's creation date. -- **Next** — Filter in values in the next duration relative to the filter's creation date. -- **Previous** — Filter in values in the previous duration relative to the filter's creation date. - -### [TopOrBottomFilterType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/TopOrBottomFilterType) -Represents the various filter types available for the . - -- **BottomPercentage** — Filter in the bottom N percent of values the sorted list of values. -- **BottomValues** — Filter in the bottom N values in the sorted list of values. -- **TopPercentage** — Filter in the top N percent of values the sorted list of values. -- **TopValues** — Filter in the top N values in the sorted list of values. - -### [OpenPackagingNonConformanceExceptionReason](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/OpenPackagingNonConformanceExceptionReason) -Constants which define the reason that a was thrown. - -- **ContainsDublinCoreRefinements** — The IPackagePart in a IPackage is determined to be the core properties relationship for the package, and that IPackagePart is found to contain refinements to Dublin Core elements other than the 'dcterms:created' and 'dcterms:modified' elements. -- **ContainsXmlLanguageAttribute** — The IPackagePart in a IPackage is determined to be the core properties relationship for the package, and that IPackagePart is found to contain an element which contains the xml:lang attribute. -- **CorePropertiesRelationshipAlreadyProcessed** — The IPackagePart in a IPackage is determined to be the core properties relationship for the package, after one has already been processed. -- **DuplicatePartName** — A loaded IPackagePart has the same name as an existing one. -- **None** — Undefined; used for variable initialization. -- **UsesMarkupCompatibilityNamespace** — The IPackagePart in a IPackage is determined to be the core properties relationship for the package, and that IPackagePart is found to contain references to the Markup Compatibility namespace. -- **XmlContainsDocumentTypeDefinition** — A loaded IPackagePart is found to contain a DTD (Document Type Definition) declaration. -- **XsiTypeAttributeInvalid** — The IPackagePart in a IPackage is determined to be the core properties relationship for the package, and that IPackagePart is found to contain an element which contains the xsi:type attribute, with the exception of the 'dcterms:created' and 'dcterms:modified' elements, for which the attribute is required, and is expected to hold the value 'dcterms:W3CDTF'. - -### [OpenPackagingNonConformanceReason](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/OpenPackagingNonConformanceReason) -For internal use only. - -- **Conformant** — The IPackagePart conforms fully to the ECMA TC45 Open Packaging Conventions. -- **ContentTypeHasComments** — The package implementer shall require a content type that does not include comments and the format designer shall specify such a content type. [M1.15] -- **ContentTypeHasInvalidSyntax** — IPackage implementers shall only create and only recognize parts with a content type; format designers shall specify a content type for each part included in the format. Content types for package parts shall fit the definition and syntax for media types as specified in RFC 2616, §3.7. [M1.13] -- **ContentTypeHasInvalidWhitespace** — Content types shall not use linear white space either between the type and subtype or between an attribute and its value. Content types also shall not have leading or trailing white spaces. IPackage implementers shall create only such content types and shall require such content types when retrieving a part from a package; format designers shall specify only such content types for inclusion in the format. [M1.14] -- **ContentTypeHasParameters** — IPackage implementers and format designers shall not create content types with parameters for the package specific parts defined in this Open Packaging specification and shall treat the presence of parameters in these content types as an error. [M1.22] -- **ContentTypeMissing** — The package implementer shall require a content type and the format designer shall specify the content type. [M1.2], [M1.13] -- **CouldNotGetPackagePart** — The IPackage.GetPart method threw an exception. -- **DuplicateName** — Part name equivalence is determined by comparing part names as case-insensitive ASCII strings. Packages shall not contain equivalent part names and package implementers shall neither create nor recognize packages with equivalent part names. [M1.12] -- **GrowthHintChanged** — If the package implementer specifies a growth hint, it is set when a part is created and the package implementer shall not change the growth hint after the part has been created. [M1.16] -- **NameDerivesFromExistingPartName** — A package implementer shall neither create nor recognize a part with a part name derived from another part name by appending segments to it. [M1.11] -- **NameDoesNotStartWithForwardSlash** — A part name shall start with a forward slash (“/”) character. [M1.4] -- **NameEndsWithForwardSlash** — A part name shall not have a forward slash as the last character. [M1.5] -- **NameMissing** — The package implementer shall require a part name. [M1.1] -- **RelationshipIdInvalid** — The package implementer shall require that every Relationship element has an Id attribute, the value of which is unique within the Relationships part, and that the Id type is xsd:ID, the value of which conforms to the naming restrictions for xsd:IDas described in the W3C Recommendation “XML Schema Part 2: Datatypes.” [M1.26] -- **RelationshipNameInvalid** — The package implementer shall name relationship parts according to the special relationships part naming convention and require that parts with names that conform to this naming convention have the content type for a Relationships part. [M1.30] -- **RelationshipTargetInvalid** — The package implementer shall require the Target attribute to be a URI reference pointing to a target resource. The URI reference shall be a URI or a relative reference. [M1.28] -- **RelationshipTargetNotRelativeReference** — When set to Internal, the Target attribute shall be a relative reference and that reference is interpreted relative to the “parent” part. For package relationships, the package implementer shallresolve relative references in the Target attribute against the pack URI that identifies the entire package resource. [M1.29] -- **RelationshipTargetsOtherRelationship** — The Relationships part shall not have relationships to any other part. IPackage implementers shall enforce this requirement upon the attempt to create such a relationship and shall treat any such relationship as invalid. [M1.25] -- **RelationshipTypeInvalid** — The package implementer shall require the Type attribute to be a URI that defines the role of the relationship and the format designer shall specify such a Type. [M1.27] -- **SegmentEmpty** — A part name shall not have empty segments. [M1.3] -- **SegmentEndsWithDotCharacter** — A segment shall not end with a dot (“.”) character. [M1.9] -- **SegmentHasNonPCharCharacters** — A segment shall not hold any characters other than pchar characters. [M1.6] -- **SegmentHasPercentEncodedSlashCharacters** — A segment shall not contain percent-encoded forward slash (“/”), or backward slash (“\”) characters. [M1.7] -- **SegmentHasPercentEncodedUnreservedCharacters** — A segment shall not contain percent-encoded unreserved characters. [M1.8] -- **SegmentMissingNonDotCharacter** — A segment shall include at least one non-dot character. [M1.10] -- **XmlContentDrawsOnUndefinedNamespace** — XML content shall not contain elements or attributes drawn from “xml” or “xsi” namespaces unless they are explicitly defined in the XSD schema or by other means described in this Open Packaging specification. IPackage implementers shall enforce this requirement upon creation and retrieval of the XML content. [M1.21] -- **XmlContentInvalidForSchema** — XML content shall be valid against the corresponding XSD schema defined in this Open Packaging specification. In particular, the XML content shall not contain elements or attributes drawn from namespaces that are not explicitly defined in the corresponding XSD unless the XSD allows elements or attributes drawn from any namespace to be present in particular locations in the XML markup. IPackage implementers shall enforce this requirement upon creation and retrieval of the XML content. [M1.20] -- **XmlEncodingUnsupported** — XML content shall be encoded using either UTF-8 or UTF-16. If any part includes an encoding declaration, as defined in §4.3.3 of the XML 1.0 specification, that declaration shall not name any encoding other than UTF-8 or UTF-16. IPackage implementers shall enforce this requirement upon creation and retrieval of the XML content. [M1.17] - -### [SortDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Documents.Excel/25.1.x/enums/SortDirection) -Represents the various sort directions which can be used with a . - -- **Ascending** — Sort values in an ascending manner. -- **Descending** — Sort values in an descending manner. diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor.GridLite/25.1.x/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor.GridLite/25.1.x/llms-full.txt deleted file mode 100644 index 473dc50d3..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor.GridLite/25.1.x/llms-full.txt +++ /dev/null @@ -1,136 +0,0 @@ -# Ignite UI for Blazor GridLite v25.1.x — Full API Reference - -> Complete API reference for the Ignite UI for Blazor GridLite package (25.1.x). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: Blazor -Package: IgniteUI.Blazor.GridLite -Version: 25.1.x - -## Classes - -### [IgbColumnConfiguration](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.GridLite/25.1.x/classes/IgbColumnConfiguration) - -- **constructor**(): void -- **DataType**: `GridLiteColumnDataType?` -- **Field**: `string` -- **Filterable**: `bool` -- **FilteringCaseSensitive**: `bool` -- **Header**: `string` -- **Hidden**: `bool` -- **Resizable**: `bool` -- **Sortable**: `bool` -- **SortingCaseSensitive**: `bool` -- **Width**: `string` - -### [IgbGridLiteColumn](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.GridLite/25.1.x/classes/IgbGridLiteColumn) - -- **constructor**(): void -- **DataType**: `GridLiteColumnDataType?` -- **Field**: `string` -- **Filterable**: `bool` -- **FilteringCaseSensitive**: `bool` -- **Header**: `string` -- **Hidden**: `bool` -- **Resizable**: `bool` -- **Sortable**: `bool` -- **SortingCaseSensitive**: `bool` -- **Width**: `string` -- **BuildRenderTree**(__builder: RenderTreeBuilder): void - -### [IgbGridLiteFilterExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.GridLite/25.1.x/classes/IgbGridLiteFilterExpression) - -- **constructor**(): void -- **CaseSensitive**: `bool?` -- **Condition**: `object` -- **Criteria**: `string` -- **Key**: `string` -- **SearchTerm**: `object` - -### [IgbGridLiteFilteredEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.GridLite/25.1.x/classes/IgbGridLiteFilteredEventArgs) - -- **constructor**(): void -- **Key**: `string` -- **State**: `List` - -### [IgbGridLiteFilteringEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.GridLite/25.1.x/classes/IgbGridLiteFilteringEventArgs) - -- **constructor**(): void -- **Expressions**: `List` -- **Key**: `string` -- **Type**: `string` - -### [IgbGridLiteSortedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.GridLite/25.1.x/classes/IgbGridLiteSortedEventArgs) - -- **constructor**(): void -- **Expression**: `IgbGridLiteSortingExpression` - -### [IgbGridLiteSortingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.GridLite/25.1.x/classes/IgbGridLiteSortingEventArgs) - -- **constructor**(): void -- **Expression**: `IgbGridLiteSortingExpression` - -### [IgbGridLiteSortingExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.GridLite/25.1.x/classes/IgbGridLiteSortingExpression) - -- **constructor**(): void -- **CaseSensitive**: `bool?` -- **Direction**: `GridLiteSortingDirection` -- **Key**: `string` - -### [IgbGridLiteSortingOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.GridLite/25.1.x/classes/IgbGridLiteSortingOptions) - -- **constructor**(): void -- **Mode**: `GridLiteSortingMode` - -### [IgbGridLite](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.GridLite/25.1.x/classes/IgbGridLite) - -- **constructor**(): void -- **AdditionalAttributes**: `Dictionary` -- **AdoptRootStyles**: `bool` -- **AutoGenerate**: `bool` -- **ChildContent**: `RenderFragment` -- **Data**: `IEnumerable` -- **FilterExpressions**: `IEnumerable` -- **Filtered**: `EventCallback` -- **Filtering**: `EventCallback` -- **GridId**: `string` -- **Rendered**: `EventCallback` -- **Sorted**: `EventCallback` -- **Sorting**: `EventCallback` -- **SortingExpressions**: `IEnumerable` -- **SortingOptions**: `IgbGridLiteSortingOptions` -- **BuildRenderTree**(__builder: RenderTreeBuilder): void -- **ClearFilterAsync**(key: string): Task -- **ClearSortAsync**(key: string): Task -- **Dispose**(): void -- **FilterAsync**(expression: IgbGridLiteFilterExpression): Task -- **FilterAsync**(expressions: List): Task -- **GetColumnsAsync**(): ValueTask -- **NavigateToAsync**(row: long, field: string, activate: bool): Task -- **OnAfterRenderAsync**(firstRender: bool): Task -- **OnInitialized**(): void -- **RefreshAsync**(): Task -- **RenderAsync**(): Task -- **SetParametersAsync**(parameters: ParameterView): Task -- **SortAsync**(expressions: IgbGridLiteSortingExpression): Task -- **SortAsync**(expressions: List): Task -- **UpdateDataAsync**(newData: IEnumerable): Task - -## Enumerations - -### [GridLiteColumnDataType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.GridLite/25.1.x/enums/GridLiteColumnDataType) - -- **Boolean** -- **Date** -- **Number** -- **String** - -### [GridLiteSortingDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.GridLite/25.1.x/enums/GridLiteSortingDirection) - -- **Ascending** -- **Descending** -- **None** - -### [GridLiteSortingMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.GridLite/25.1.x/enums/GridLiteSortingMode) - -- **Multiple** -- **Single** diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor.Lite/25.1.x/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor.Lite/25.1.x/llms-full.txt deleted file mode 100644 index 29f50ac34..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor.Lite/25.1.x/llms-full.txt +++ /dev/null @@ -1,3710 +0,0 @@ -# Ignite UI for Blazor Lite v25.1.x — Full API Reference - -> Complete API reference for the Ignite UI for Blazor Lite package (25.1.x). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: Blazor -Package: IgniteUI.Blazor.Lite -Version: 25.1.x - -## Classes - -### [BaseCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/BaseCollection) - -- **constructor**(parent: object, propertyName: string): void -- **ClearItems**(): void -- **FindByName**(name: string): object -- **HasName**(name: string): bool -- **InsertItem**(index: int, item: T): void -- **RemoveItem**(index: int): void -- **Serialize**(context: SerializationContext, propertyName: string): void -- **SetItem**(index: int, item: T): void -- **ToArray**(): T[] - -### [BaseRendererControl](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/BaseRendererControl) - -- **constructor**(): void -- **AdditionalAttributes**: `Dictionary` -- **ChildContent**: `RenderFragment` -- **Class**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **EventBehavior**: `ControlEventBehavior` -- **Height**: `string` -- **IgBlazor**: `IIgniteUIBlazor` -- **NeedsDynamicContent**: `bool` -- **ParentTypeName**: `string` -- **RoundTripDateConversion**: `RoundTripDateConversion` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseCamelEnumValues**: `bool` -- **UseDirectRender**: `bool` -- **Width**: `string` -- **_cachedSerializedContent**: `string` -- **eventCallbacksCache**: `Dictionary>` -- **BuildRenderTree**(builder: RenderTreeBuilder): void -- **BuildSequenceInfo**(startSequence: int): SequenceInfo -- **Camelize**(value: string): string -- **CompareEventCallbacks**(left: T, right: T, eventFieldsDictionary: Dictionary>): bool -- **Dispose**(): void -- **Dispose**(disposing: bool): void -- **EnsureModulesLoaded**(): void -- **EnsureReady**(): Task -- **~BaseRendererControl**(): void -- **FindByName**(name: string): object -- **InvokeMethod**(methodName: string, arguments: object[], types: string[], nativeElements: ElementReference[]): Task -- **InvokeMethodSync**(methodName: string, arguments: object[], types: string[], nativeElements: ElementReference[]): object -- **IsPropDirty**(propertyName: string): bool -- **IsTransformedEnumValue**(key: string): bool -- **MarkPropDirty**(propertyName: string): void -- **NotifyClearItems**(dataSource: object): void -- **NotifyInsertItem**(dataSource: object, index: int, refItem: object): void -- **NotifyRemoveItem**(dataSource: object, index: int, oldItem: object): void -- **NotifySetItem**(dataSource: object, index: int, oldItem: object, newItem: object): void -- **NotifyUpdateItem**(dataSource: object, index: int, refItem: object, syncDataOnly: bool): void -- **OnAfterRenderAsync**(firstRender: bool): Task -- **OnElementNameChanged**(element: BaseRendererElement, oldName: string, newName: string): void -- **OnInvokeReturn**(invokeId: long, returnValue: object): void -- **OnRefChanged**(refName: string, refValue: object): void -- **ResolveDisplay**(): string -- **ResolveEventBehavior**(): ControlEventBehavior -- **ResumeNotifications**(dataSource: object, notify: bool): void -- **Serialize**(): string -- **Serialize**(context: SerializationContext, propertyName: string): void -- **SetPropertyValue**(item: object, property: PropertyInfo, value: object): void -- **SetPropertyValue**(item: object, property: PropertyInfo, jsonElement: JsonElement): void -- **SetResourceStringAsync**(grouping: string, json: string): Task -- **SetResourceStringAsync**(grouping: string, id: string, value: string): Task -- **SuspendNotifications**(dataSource: object): void -- **TemplateContentType**(templateId: string): Type -- **ToPascal**(value: string): string -- **ToSpinal**(value: string): string -- **TransformPotentialEnumValue**(key: string, value: object): object -- **TransformSimpleKey**(key: string): string - -### [BaseRendererElement](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/BaseRendererElement) - -- **constructor**(): void -- **ChildContent**: `RenderFragment` -- **CurrParent**: `object` -- **IgBlazor**: `IIgniteUIBlazor` -- **IsComponentRooted**: `bool` -- **MethodTarget**: `string` -- **Name**: `string` -- **Parent**: `object` -- **ParentTypeName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **_cachedSerializedContent**: `string` -- **_name**: `string` -- **eventCallbacksCache**: `Dictionary>` -- **BuildRenderTree**(builder: RenderTreeBuilder): void -- **CompareEventCallbacks**(left: T, right: T, eventFieldsDictionary: Dictionary>): bool -- **EnsureModulesLoaded**(): void -- **EnsureValid**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **InvokeMethod**(methodName: string, arguments: object[], types: string[], nativeElements: ElementReference[]): Task -- **InvokeMethodHelper**(target: string, methodName: string, arguments: object[], types: string[], nativeElements: ElementReference[]): Task -- **InvokeMethodHelperSync**(target: string, methodName: string, arguments: object[], types: string[], nativeElements: ElementReference[]): object -- **InvokeMethodSync**(methodName: string, arguments: object[], types: string[], nativeElements: ElementReference[]): object -- **IsPropDirty**(propertyName: string): bool -- **OnElementNameChanged**(element: BaseRendererElement, oldName: string, newName: string): void -- **Serialize**(): string -- **Serialize**(context: SerializationContext, propertyName: string): void -- **SetResourceStringAsync**(grouping: string, json: string): Task -- **SetResourceStringAsync**(grouping: string, id: string, value: string): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [ComponentRendererComponentChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/ComponentRendererComponentChangedEventArgs) - -- **constructor**(): void -- **NewComponent**: `object` -- **OldComponent**: `object` - -### [DataIntentAttribute](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/DataIntentAttribute) - -- **constructor**(intent: string): void -- **Intent**: `string` - -### [DynamicComponentChangingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/DynamicComponentChangingEventArgs) - -- **constructor**(): void -- **NewComponent**: `object` -- **OldComponent**: `object` - -### [DynamicContentHolder](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/DynamicContentHolder) - -- **constructor**(): void -- **DynamicContentInfo**: `List` -- **AddDynamicContent**(content: DynamicContentInfo): void -- **BuildRenderTree**(__builder: RenderTreeBuilder): void -- **OnDynamicChildRef**(refName: string, child: object): void -- **OnInitialized**(): void -- **RemoveDynamicContent**(content: DynamicContentInfo): void - -### [DynamicContentInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/DynamicContentInfo) - -- **constructor**(): void -- **Component**: `object` -- **ControlType**: `Type` -- **Owner**: `BaseRendererControl` -- **RefDivName**: `string` -- **RefName**: `string` -- **OnComponentChanged**(oldValue: object, component: object): void -- **UpdateContext**(context: object): void -- **UpdateTemplate**(template: object): void - -### [DynamicContentInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/DynamicContentInfo) - -- **constructor**(): void -- **Context**: `T` -- **Template**: `RenderFragment` -- **OnComponentChanged**(oldValue: object, component: object): void -- **UpdateContext**(context: object): void -- **UpdateTemplate**(template: object): void - -### [IgbAccordion](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbAccordion) - -- **constructor**(): void -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **ParentTypeName**: `string` -- **SingleExpand**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **HideAll**(): void -- **HideAllAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ShowAll**(): void -- **ShowAllAsync**(): Task - -### [IgbAccordionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbAccordionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbActiveStepChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbActiveStepChangedEventArgs) - -- **constructor**(): void -- **Detail**: `IgbActiveStepChangedEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbActiveStepChangedEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbActiveStepChangedEventArgsDetail) - -- **constructor**(): void -- **Index**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbActiveStepChangingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbActiveStepChangingEventArgs) - -- **constructor**(): void -- **Detail**: `IgbActiveStepChangingEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbActiveStepChangingEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbActiveStepChangingEventArgsDetail) - -- **constructor**(): void -- **NewIndex**: `double` -- **OldIndex**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAvatar](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbAvatar) - -- **constructor**(): void -- **Alt**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Initials**: `string` -- **Shape**: `AvatarShape` -- **Src**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbAvatarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbAvatarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBadge](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbBadge) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Outlined**: `bool` -- **Shape**: `BadgeShape` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Variant**: `StyleVariant` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbBadgeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbBadgeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBanner](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbBanner) - -- **constructor**(): void -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Open**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **Hide**(): bool -- **HideAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(): bool -- **ShowAsync**(): Task -- **Toggle**(): bool -- **ToggleAsync**(): Task - -### [IgbBannerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbBannerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBaseAlertLike](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbBaseAlertLike) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **DisplayTime**: `double` -- **KeepOpen**: `bool` -- **Open**: `bool` -- **Position**: `AbsolutePosition` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **FindByName**(name: string): object -- **Hide**(): bool -- **HideAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(): bool -- **ShowAsync**(): Task -- **Toggle**(): bool -- **ToggleAsync**(): Task - -### [IgbBaseAlertLikeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbBaseAlertLikeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBaseComboBoxLike](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbBaseComboBoxLike) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **EmitEvent**: `object` -- **KeepOpenOnOutsideClick**: `bool` -- **KeepOpenOnSelect**: `bool` -- **Open**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **Hide**(): bool -- **HideAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(): bool -- **ShowAsync**(): Task -- **Toggle**(): bool -- **ToggleAsync**(): Task - -### [IgbBaseComboBoxLikeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbBaseComboBoxLikeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBaseOptionLike](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbBaseOptionLike) - -- **constructor**(): void -- **Active**: `bool` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **Selected**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `string` -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbBaseOptionLikeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbBaseOptionLikeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbButton](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbButton) - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Variant**: `ButtonVariant` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbButtonBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbButtonBase) - -- **constructor**(): void -- **Blur**: `EventCallback` -- **BlurScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **DisplayType**: `ButtonBaseType` -- **Download**: `string` -- **Focus**: `EventCallback` -- **FocusScript**: `string` -- **Href**: `string` -- **Rel**: `string` -- **SupportsVisualChildren**: `bool` -- **Target**: `ButtonBaseTarget` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **BlurComponent**(): void -- **BlurComponentAsync**(): Task -- **Click**(): void -- **ClickAsync**(): Task -- **FindByName**(name: string): object -- **FocusComponent**(options: IgbFocusOptions): void -- **FocusComponentAsync**(options: IgbFocusOptions): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbButtonBaseModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbButtonBaseModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbButtonGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbButtonGroup) - -- **constructor**(): void -- **Alignment**: `ContentOrientation` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **Deselect**: `EventCallback` -- **DeselectScript**: `string` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **Select**: `EventCallback` -- **SelectScript**: `string` -- **SelectedItems**: `string[]` -- **Selection**: `ButtonGroupSelection` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbButtonGroupModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbButtonGroupModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbButtonModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbButtonModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCalendar](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCalendar) - -- **constructor**(): void -- **ActiveDate**: `DateTime` -- **ActiveView**: `CalendarActiveView` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **FormatOptions**: `IgbCalendarFormatOptions` -- **HeaderOrientation**: `CalendarHeaderOrientation` -- **HideHeader**: `bool` -- **HideOutsideDays**: `bool` -- **Orientation**: `ContentOrientation` -- **ResourceStrings**: `IgbCalendarResourceStrings` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **Value**: `DateTime` -- **ValueChanged**: `EventCallback` -- **Values**: `DateTime[]` -- **ValuesChanged**: `EventCallback` -- **VisibleMonths**: `double` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): DateTime -- **GetCurrentValueAsync**(): Task -- **GetCurrentValues**(): DateTime[] -- **GetCurrentValuesAsync**(): Task -- **ResolveDisplay**(): string - -### [IgbCalendarBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCalendarBase) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DisabledDates**: `IgbDateRangeDescriptor[]` -- **Locale**: `string` -- **Selection**: `CalendarSelection` -- **ShowWeekNumbers**: `bool` -- **SpecialDates**: `IgbDateRangeDescriptor[]` -- **Type**: `string` -- **WeekStart**: `WeekDays` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCalendarBaseModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCalendarBaseModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCalendarDate](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCalendarDate) - -- **constructor**(): void -- **Date**: `DateTime` -- **IsCurrentMonth**: `bool` -- **IsNextMonth**: `bool` -- **IsPrevMonth**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCalendarDateEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCalendarDateEventArgs) - -- **constructor**(): void -- **Detail**: `IgbCalendarDate` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCalendarFormatOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCalendarFormatOptions) - -- **constructor**(): void -- **Month**: `string` -- **Type**: `string` -- **Weekday**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCalendarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCalendarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCalendarResourceStrings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCalendarResourceStrings) - -- **constructor**(): void -- **EndDate**: `string` -- **NextMonth**: `string` -- **NextYear**: `string` -- **NextYears**: `string` -- **PreviousMonth**: `string` -- **PreviousYear**: `string` -- **PreviousYears**: `string` -- **SelectDate**: `string` -- **SelectMonth**: `string` -- **SelectRange**: `string` -- **SelectYear**: `string` -- **SelectedDate**: `string` -- **StartDate**: `string` -- **Type**: `string` -- **WeekLabel**: `string` -- **FindByName**(name: string): object - -### [IgbCard](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCard) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Elevated**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCardActions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCardActions) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Orientation**: `ContentOrientation` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCardActionsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCardActionsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCardContent](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCardContent) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCardContentModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCardContentModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCardHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCardHeader) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCardHeaderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCardHeaderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCardMedia](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCardMedia) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCardMediaModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCardMediaModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCardModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCardModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCarousel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCarousel) - -- **constructor**(): void -- **AnimationType**: `HorizontalTransitionAnimation` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **DisableLoop**: `bool` -- **DisablePauseOnInteraction**: `bool` -- **HideIndicators**: `bool` -- **HideNavigation**: `bool` -- **IndicatorsLabelFormat**: `string` -- **IndicatorsOrientation**: `CarouselIndicatorsOrientation` -- **Interval**: `double` -- **MaximumIndicatorsCount**: `double` -- **Paused**: `EventCallback` -- **PausedScript**: `string` -- **Playing**: `EventCallback` -- **PlayingScript**: `string` -- **SlideChanged**: `EventCallback` -- **SlideChangedScript**: `string` -- **SlidesLabelFormat**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Vertical**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrent**(): double -- **GetCurrentAsync**(): Task -- **GetIsPaused**(): bool -- **GetIsPausedAsync**(): Task -- **GetIsPlaying**(): bool -- **GetIsPlayingAsync**(): Task -- **GetTotal**(): double -- **GetTotalAsync**(): Task -- **Next**(): bool -- **NextAsync**(): Task -- **Pause**(): void -- **PauseAsync**(): Task -- **Play**(): void -- **PlayAsync**(): Task -- **Prev**(): bool -- **PrevAsync**(): Task -- **ResolveDisplay**(): string -- **Select**(index: double, animationDirection: CarouselAnimationDirection): bool -- **SelectAsync**(index: double, animationDirection: CarouselAnimationDirection): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCarouselIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCarouselIndicator) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCarouselIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCarouselIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCarouselModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCarouselModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCarouselSlide](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCarouselSlide) - -- **constructor**(): void -- **Active**: `bool` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCarouselSlideModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCarouselSlideModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCheckbox](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCheckbox) - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **Indeterminate**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbCheckboxBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCheckboxBase) - -- **constructor**(): void -- **Blur**: `EventCallback` -- **BlurScript**: `string` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Checked**: `bool` -- **CheckedChanged**: `EventCallback` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **Focus**: `EventCallback` -- **FocusScript**: `string` -- **Invalid**: `bool` -- **LabelPosition**: `ToggleLabelPosition` -- **Required**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `string` -- **BlurComponent**(): void -- **BlurComponentAsync**(): Task -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task -- **Click**(): void -- **ClickAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FocusComponent**(options: IgbFocusOptions): void -- **FocusComponentAsync**(options: IgbFocusOptions): Task -- **GetCurrentChecked**(): bool -- **GetCurrentCheckedAsync**(): Task -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task -- **ResolveDisplay**(): string -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCheckboxBaseModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCheckboxBaseModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCheckboxChangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCheckboxChangeEventArgs) - -- **constructor**(): void -- **Detail**: `IgbCheckboxChangeEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCheckboxChangeEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCheckboxChangeEventArgsDetail) - -- **constructor**(): void -- **Checked**: `bool` -- **Type**: `string` -- **Value**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCheckboxModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCheckboxModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbChip](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbChip) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **Removable**: `bool` -- **Remove**: `EventCallback` -- **RemoveScript**: `string` -- **Select**: `EventCallback` -- **SelectScript**: `string` -- **Selectable**: `bool` -- **Selected**: `bool` -- **SelectedChanged**: `EventCallback` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Variant**: `StyleVariant` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentSelected**(): bool -- **GetCurrentSelectedAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbChipModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbChipModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCircularGradient](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCircularGradient) - -- **constructor**(): void -- **Color**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Offset**: `string` -- **Opacity**: `double` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCircularGradientModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCircularGradientModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCircularProgress](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCircularProgress) - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbCircularProgressModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCircularProgressModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbComboChangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbComboChangeEventArgs) - -- **constructor**(): void -- **Detail**: `IgbComboChangeEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComboChangeEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbComboChangeEventArgsDetail) - -- **constructor**(): void -- **ChangeType**: `ComboChangeType` -- **Items**: `object[]` -- **ItemsScript**: `string` -- **NewValue**: `object[]` -- **NewValueScript**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComboModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbComboModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCombo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCombo) - -- **constructor**(): void -- **Autofocus**: `bool` -- **AutofocusList**: `bool` -- **Blur**: `EventCallback` -- **BlurScript**: `string` -- **CaseSensitiveIcon**: `bool` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **Data**: `object` -- **DataScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DisableFiltering**: `bool` -- **Disabled**: `bool` -- **DisplayKey**: `string` -- **FilteringOptions**: `IgbFilteringOptions` -- **Focus**: `EventCallback` -- **FocusScript**: `string` -- **GroupHeaderTemplate**: `RenderFragment` -- **GroupHeaderTemplateScript**: `string` -- **GroupKey**: `string` -- **GroupSorting**: `GroupingDirection` -- **Invalid**: `bool` -- **ItemTemplate**: `RenderFragment` -- **ItemTemplateScript**: `string` -- **Label**: `string` -- **Open**: `bool` -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **Outlined**: `bool` -- **Placeholder**: `string` -- **PlaceholderSearch**: `string` -- **Required**: `bool` -- **SingleSelect**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **Value**: `T[]` -- **ValueChanged**: `EventCallback` -- **ValueKey**: `string` -- **BlurComponent**(): void -- **BlurComponentAsync**(): Task -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task -- **Deselect**(items: object[]): void -- **DeselectAsync**(items: object[]): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FocusComponent**(options: IgbFocusOptions): void -- **FocusComponentAsync**(options: IgbFocusOptions): Task -- **GetCurrentValue**(): T[] -- **GetCurrentValueAsync**(): Task -- **GetSelection**(): object[] -- **GetSelectionAsync**(): Task -- **Hide**(): bool -- **HideAsync**(): Task -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task -- **ResolveDisplay**(): string -- **Select**(items: object[]): void -- **SelectAsync**(items: object[]): Task -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(): bool -- **ShowAsync**(): Task -- **Toggle**(): bool -- **ToggleAsync**(): Task - -### [IgbComponentBoolValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbComponentBoolValueChangedEventArgs) - -- **constructor**(): void -- **Detail**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComponentDataValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbComponentDataValueChangedEventArgs) - -- **constructor**(): void -- **Detail**: `object` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComponentDateValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbComponentDateValueChangedEventArgs) - -- **constructor**(): void -- **Detail**: `DateTime` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComponentRendererContainer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbComponentRendererContainer) - -- **constructor**(): void -- **ComponentType**: `Type` -- **RootComponent**: `object` -- **BuildRenderTree**(builder: RenderTreeBuilder): void - -### [IgbComponentValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbComponentValueChangedEventArgs) - -- **constructor**(): void -- **Detail**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCustomDateRange](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbCustomDateRange) - -- **constructor**(): void -- **DateRange**: `IgbDateRangeValue` -- **Label**: `string` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbDatePartDeltas](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDatePartDeltas) - -- **constructor**(): void -- **Date**: `double` -- **Hours**: `double` -- **Minutes**: `double` -- **Month**: `double` -- **Seconds**: `double` -- **Type**: `string` -- **Year**: `double` -- **FindByName**(name: string): object - -### [IgbDatePicker](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDatePicker) - -- **constructor**(): void -- **ActiveDate**: `DateTime` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **Disabled**: `bool` -- **DisabledDates**: `IgbDateRangeDescriptor[]` -- **DisplayFormat**: `string` -- **HeaderOrientation**: `CalendarHeaderOrientation` -- **HideHeader**: `bool` -- **HideOutsideDays**: `bool` -- **Input**: `EventCallback` -- **InputFormat**: `string` -- **InputScript**: `string` -- **Invalid**: `bool` -- **Label**: `string` -- **Locale**: `string` -- **Max**: `DateTime?` -- **Min**: `DateTime?` -- **Mode**: `PickerMode` -- **NonEditable**: `bool` -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **Orientation**: `ContentOrientation` -- **Outlined**: `bool` -- **Placeholder**: `string` -- **Prompt**: `string` -- **ReadOnly**: `bool` -- **Required**: `bool` -- **ResourceStrings**: `IgbCalendarResourceStrings` -- **ShowWeekNumbers**: `bool` -- **SpecialDates**: `IgbDateRangeDescriptor[]` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **Value**: `DateTime?` -- **ValueChanged**: `EventCallback` -- **VisibleMonths**: `double` -- **WeekStart**: `WeekDays` -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task -- **Clear**(): void -- **ClearAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): DateTime? -- **GetCurrentValueAsync**(): Task -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task -- **ResolveDisplay**(): string -- **Select**(): void -- **SelectAsync**(): Task -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task -- **SetRangeText**(replacement: string, start: double, end: double, mode: RangeTextSelectMode): void -- **SetRangeTextAsync**(replacement: string, start: double, end: double, mode: RangeTextSelectMode): Task -- **SetSelectionRange**(start: double, end: double, direction: SelectionRangeDirection): void -- **SetSelectionRangeAsync**(start: double, end: double, direction: SelectionRangeDirection): Task -- **StepDown**(datePart: DatePart, delta: double): void -- **StepDownAsync**(datePart: DatePart, delta: double): Task -- **StepUp**(datePart: DatePart, delta: double): void -- **StepUpAsync**(datePart: DatePart, delta: double): Task - -### [IgbDatePickerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDatePickerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDateRangeDescriptor](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDateRangeDescriptor) - -- **constructor**(): void -- **DateRange**: `object` -- **RangeType**: `DateRangeType` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbDateRangePicker](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDateRangePicker) - -- **constructor**(): void -- **ActiveDate**: `DateTime` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **CustomRanges**: `IgbCustomDateRange[]` -- **Disabled**: `bool` -- **DisabledDates**: `IgbDateRangeDescriptor[]` -- **DisplayFormat**: `string` -- **HeaderOrientation**: `ContentOrientation` -- **HideHeader**: `bool` -- **HideOutsideDays**: `bool` -- **Input**: `EventCallback` -- **InputFormat**: `string` -- **InputScript**: `string` -- **Invalid**: `bool` -- **Label**: `string` -- **LabelEnd**: `string` -- **LabelStart**: `string` -- **Locale**: `string` -- **Max**: `DateTime?` -- **Min**: `DateTime?` -- **Mode**: `PickerMode` -- **NonEditable**: `bool` -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **Orientation**: `ContentOrientation` -- **Outlined**: `bool` -- **Placeholder**: `string` -- **PlaceholderEnd**: `string` -- **PlaceholderStart**: `string` -- **Prompt**: `string` -- **ReadOnly**: `bool` -- **Required**: `bool` -- **ResourceStrings**: `IgbDateRangePickerResourceStrings` -- **ShowWeekNumbers**: `bool` -- **SpecialDates**: `IgbDateRangeDescriptor[]` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UsePredefinedRanges**: `bool` -- **UseTwoInputs**: `bool` -- **Value**: `IgbDateRangeValue` -- **ValueChanged**: `EventCallback` -- **VisibleMonths**: `double` -- **WeekStart**: `WeekDays` -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task -- **Clear**(): void -- **ClearAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): IgbDateRangeValue -- **GetCurrentValueAsync**(): Task -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task -- **ResolveDisplay**(): string -- **Select**(value: IgbDateRangeValue): void -- **SelectAsync**(value: IgbDateRangeValue): Task -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task - -### [IgbDateRangePickerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDateRangePickerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDateRangePickerResourceStrings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDateRangePickerResourceStrings) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbDateRangeValue](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDateRangeValue) - -- **constructor**(): void -- **End**: `DateTime` -- **Start**: `DateTime` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbDateRangeValueDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDateRangeValueDetail) - -- **constructor**(): void -- **End**: `DateTime` -- **Start**: `DateTime` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDateRangeValueEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDateRangeValueEventArgs) - -- **constructor**(): void -- **Detail**: `IgbDateRangeValueDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDateTimeInput](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDateTimeInput) - -- **constructor**(): void -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DirectRenderElementName**: `string` -- **DisplayFormat**: `string` -- **InputFormat**: `string` -- **Locale**: `string` -- **Max**: `DateTime?` -- **Min**: `DateTime?` -- **SpinDelta**: `IgbDatePartDeltas` -- **SpinLoop**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `DateTime?` -- **ValueChanged**: `EventCallback` -- **Clear**(): void -- **ClearAsync**(): Task -- **ConnectedCallback**(): void -- **ConnectedCallbackAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): DateTime? -- **GetCurrentValueAsync**(): Task -- **ResolveDisplay**(): string -- **StepDown**(): void -- **StepDown**(datePart: DatePart): void -- **StepDown**(datePart: DatePart, delta: double): void -- **StepDownAsync**(): Task -- **StepDownAsync**(datePart: DatePart): Task -- **StepDownAsync**(datePart: DatePart, delta: double): Task -- **StepUp**(): void -- **StepUp**(datePart: DatePart): void -- **StepUp**(datePart: DatePart, delta: double): void -- **StepUpAsync**(): Task -- **StepUpAsync**(datePart: DatePart): Task -- **StepUpAsync**(datePart: DatePart, delta: double): Task - -### [IgbDateTimeInputModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDateTimeInputModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDialog](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDialog) - -- **constructor**(): void -- **CloseOnOutsideClick**: `bool` -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **HideDefaultAction**: `bool` -- **KeepOpenOnEscape**: `bool` -- **Open**: `bool` -- **ReturnValue**: `string` -- **SupportsVisualChildren**: `bool` -- **Title**: `string` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **Hide**(): bool -- **HideAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(): bool -- **ShowAsync**(): Task -- **Toggle**(): bool -- **ToggleAsync**(): Task - -### [IgbDialogModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDialogModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDivider](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDivider) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **LineType**: `DividerType` -- **Middle**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Vertical**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDividerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDividerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDragService](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDragService) - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDragServiceModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDragServiceModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDropdown](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDropdown) - -- **constructor**(): void -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **ContentItems**: `IgbDropdownItemCollection` -- **DirectRenderElementName**: `string` -- **Distance**: `double` -- **Flip**: `bool` -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **ParentTypeName**: `string` -- **Placement**: `PopoverPlacement` -- **SameWidth**: `bool` -- **ScrollStrategy**: `PopoverScrollStrategy` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ClearSelection**(): void -- **ClearSelectionAsync**(): Task -- **DisconnectedCallback**(): void -- **DisconnectedCallbackAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetGroups**(): IgbDropdownGroup[] -- **GetGroupsAsync**(): Task -- **GetItems**(): IgbDropdownItem[] -- **GetItemsAsync**(): Task -- **GetSelectedItem**(): IgbDropdownItem -- **GetSelectedItemAsync**(): Task -- **NavigateTo**(index: object): IgbDropdownItem -- **NavigateToAsync**(index: object): Task -- **ResolveDisplay**(): string -- **Select**(value: object): IgbDropdownItem -- **SelectAsync**(value: object): Task -- **Show**(target_: object): void -- **ShowAsync**(target_: object): Task -- **Toggle**(target_: object): void -- **ToggleAsync**(target_: object): Task - -### [IgbDropdownGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDropdownGroup) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDropdownGroupModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDropdownGroupModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDropdownHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDropdownHeader) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDropdownHeaderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDropdownHeaderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDropdownItem](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDropdownItem) - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **DropdownParent**: `BaseRendererControl` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task -- **ResolveDisplay**(): string - -### [IgbDropdownItemCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDropdownItemCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbDropdownItemComponentEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDropdownItemComponentEventArgs) - -- **constructor**(): void -- **Detail**: `IgbDropdownItem` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDropdownItemModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDropdownItemModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDropdownModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbDropdownModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExpansionPanel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbExpansionPanel) - -- **constructor**(): void -- **AccordionParent**: `BaseRendererControl` -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **IndicatorPosition**: `ExpansionPanelIndicatorPosition` -- **Open**: `bool` -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ConnectedCallback**(): void -- **ConnectedCallbackAsync**(): Task -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **Hide**(): bool -- **HideAsync**(): Task -- **OnInitializedAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(): bool -- **ShowAsync**(): Task -- **Toggle**(): bool -- **ToggleAsync**(): Task - -### [IgbExpansionPanelComponentEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbExpansionPanelComponentEventArgs) - -- **constructor**(): void -- **Detail**: `IgbExpansionPanel` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbExpansionPanelModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbExpansionPanelModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFilteringOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbFilteringOptions) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbFocusOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbFocusOptions) - -- **constructor**(): void -- **PreventScroll**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFormatSpecifier](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbFormatSpecifier) - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **GetLocalCulture**(): string -- **GetLocalCultureAsync**(): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFormatSpecifierModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbFormatSpecifierModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbIcon](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbIcon) - -- **constructor**(): void -- **Collection**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **IconName**: `string` -- **Mirrored**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ConnectedCallback**(): void -- **ConnectedCallbackAsync**(): Task -- **DisconnectedCallback**(): void -- **DisconnectedCallbackAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **RegisterIcon**(name: string, url: string, collection: string): void -- **RegisterIconAsync**(name: string, url: string, collection: string): Task -- **RegisterIconFromText**(name: string, iconText: string, collection: string): void -- **RegisterIconFromTextAsync**(name: string, iconText: string, collection: string): Task -- **ResolveDisplay**(): string -- **SetIconRef**(name: string, collection: string, icon: IgbIconMeta): void -- **SetIconRefAsync**(name: string, collection: string, icon: IgbIconMeta): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbIconButton](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbIconButton) - -- **constructor**(): void -- **Collection**: `string` -- **DirectRenderElementName**: `string` -- **IconName**: `string` -- **Mirrored**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Variant**: `IconButtonVariant` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **RegisterIcon**(name: string, url: string, collection: string): void -- **RegisterIconAsync**(name: string, url: string, collection: string): Task -- **RegisterIconFromText**(name: string, iconText: string, collection: string): void -- **RegisterIconFromTextAsync**(name: string, iconText: string, collection: string): Task -- **ResolveDisplay**(): string - -### [IgbIconButtonModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbIconButtonModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbIconMeta](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbIconMeta) - -- **constructor**(): void -- **Collection**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbIconModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbIconModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbInput](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbInput) - -- **constructor**(): void -- **Autocomplete**: `string` -- **Autofocus**: `bool` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DirectRenderElementName**: `string` -- **DisplayType**: `InputType` -- **InputMode**: `string` -- **Max**: `double?` -- **MaxLength**: `double?` -- **Min**: `double?` -- **MinLength**: `double?` -- **Pattern**: `string` -- **Step**: `double?` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ValidateOnly**: `bool` -- **Value**: `string` -- **ValueChanged**: `EventCallback` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): string -- **GetCurrentValueAsync**(): Task -- **ResolveDisplay**(): string -- **Select**(): void -- **SelectAsync**(): Task -- **SetParametersAsync**(parameters: ParameterView): Task -- **StepDown**(n: double): void -- **StepDownAsync**(n: double): Task -- **StepUp**(n: double): void -- **StepUpAsync**(n: double): Task - -### [IgbInputBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbInputBase) - -- **constructor**(): void -- **Blur**: `EventCallback` -- **BlurScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **Focus**: `EventCallback` -- **FocusScript**: `string` -- **InputOcurred**: `EventCallback` -- **InputOcurredScript**: `string` -- **Invalid**: `bool` -- **Label**: `string` -- **Outlined**: `bool` -- **Placeholder**: `string` -- **ReadOnly**: `bool` -- **Required**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ValueChanging**: `EventCallback` -- **BlurComponent**(): void -- **BlurComponentAsync**(): Task -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task -- **FindByName**(name: string): object -- **FocusComponent**(options: IgbFocusOptions): void -- **FocusComponentAsync**(options: IgbFocusOptions): Task -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task -- **ResolveDisplay**(): string -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **SetParametersAsync**(parameters: ParameterView): Task -- **SetRangeText**(replacement: string, start: double, end: double, selectMode: RangeTextSelectMode): void -- **SetRangeTextAsync**(replacement: string, start: double, end: double, selectMode: RangeTextSelectMode): Task -- **SetSelectionRange**(start: double, end: double, direction: SelectionRangeDirection): void -- **SetSelectionRangeAsync**(start: double, end: double, direction: SelectionRangeDirection): Task - -### [IgbInputBaseModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbInputBaseModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbInputModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbInputModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbKeyBindingHandler](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbKeyBindingHandler) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbKeyBindingOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbKeyBindingOptions) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbLinearProgress](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbLinearProgress) - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **LabelAlign**: `LinearProgressLabelAlign` -- **Striped**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbLinearProgressModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbLinearProgressModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbList](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbList) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbListHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbListHeader) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbListHeaderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbListHeaderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbListItem](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbListItem) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Selected**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbListItemModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbListItemModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbListModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbListModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbMaskInput](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbMaskInput) - -- **constructor**(): void -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DirectRenderElementName**: `string` -- **Mask**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `string` -- **ValueChanged**: `EventCallback` -- **ValueMode**: `MaskInputValueMode` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): string -- **GetCurrentValueAsync**(): Task -- **ResolveDisplay**(): string - -### [IgbMaskInputBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbMaskInputBase) - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **Prompt**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ConnectedCallback**(): void -- **ConnectedCallbackAsync**(): Task -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **Select**(): void -- **SelectAsync**(): Task - -### [IgbMaskInputBaseModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbMaskInputBaseModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbMaskInputModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbMaskInputModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNavDrawer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbNavDrawer) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Open**: `bool` -- **Position**: `NavDrawerPosition` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **Hide**(): bool -- **HideAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(): bool -- **ShowAsync**(): Task -- **Toggle**(): bool -- **ToggleAsync**(): Task - -### [IgbNavDrawerHeaderItem](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbNavDrawerHeaderItem) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbNavDrawerHeaderItemModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbNavDrawerHeaderItemModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNavDrawerItem](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbNavDrawerItem) - -- **constructor**(): void -- **Active**: `bool` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbNavDrawerItemModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbNavDrawerItemModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNavDrawerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbNavDrawerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNavbar](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbNavbar) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbNavbarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbNavbarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNumberEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbNumberEventArgs) - -- **constructor**(): void -- **Detail**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbNumberFormatSpecifier](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbNumberFormatSpecifier) - -- **constructor**(): void -- **CompactDisplay**: `string` -- **Currency**: `string` -- **CurrencyCode**: `string` -- **CurrencyDisplay**: `string` -- **CurrencySign**: `string` -- **Locale**: `string` -- **LocaleMatcher**: `string` -- **MaximumFractionDigits**: `int` -- **MaximumSignificantDigits**: `int` -- **MinimumFractionDigits**: `int` -- **MinimumIntegerDigits**: `int` -- **MinimumSignificantDigits**: `int` -- **Notation**: `string` -- **NumberingSystem**: `string` -- **SignDisplay**: `string` -- **Style**: `string` -- **Type**: `string` -- **Unit**: `string` -- **UnitDisplay**: `string` -- **UseGrouping**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbNumberFormatSpecifierModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbNumberFormatSpecifierModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbProgressBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbProgressBase) - -- **constructor**(): void -- **AnimationDuration**: `double` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **HideLabel**: `bool` -- **Indeterminate**: `bool` -- **LabelFormat**: `string` -- **Max**: `double` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `double` -- **Variant**: `StyleVariant` -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbProgressBaseModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbProgressBaseModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRadio](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRadio) - -- **constructor**(): void -- **Blur**: `EventCallback` -- **BlurScript**: `string` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Checked**: `bool` -- **CheckedChanged**: `EventCallback` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **Focus**: `EventCallback` -- **FocusScript**: `string` -- **Invalid**: `bool` -- **LabelPosition**: `ToggleLabelPosition` -- **Required**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `string` -- **BlurComponent**(): void -- **BlurComponentAsync**(): Task -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task -- **Click**(): void -- **ClickAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FocusComponent**(options: IgbFocusOptions): void -- **FocusComponentAsync**(options: IgbFocusOptions): Task -- **GetCurrentChecked**(): bool -- **GetCurrentCheckedAsync**(): Task -- **ReportValidity**(): bool -- **ReportValidityAsync**(): Task -- **ResolveDisplay**(): string -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbRadioChangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRadioChangeEventArgs) - -- **constructor**(): void -- **Detail**: `IgbRadioChangeEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRadioChangeEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRadioChangeEventArgsDetail) - -- **constructor**(): void -- **Checked**: `bool` -- **Type**: `string` -- **Value**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRadioGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRadioGroup) - -- **constructor**(): void -- **Alignment**: `ContentOrientation` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `string` -- **ValueChanged**: `EventCallback` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): string -- **GetCurrentValueAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbRadioGroupModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRadioGroupModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRadioModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRadioModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRangeSlider](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRangeSlider) - -- **constructor**(): void -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DirectRenderElementName**: `string` -- **Input**: `EventCallback` -- **InputScript**: `string` -- **Lower**: `double` -- **SupportsVisualChildren**: `bool` -- **ThumbLabelLower**: `string` -- **ThumbLabelUpper**: `string` -- **Type**: `string` -- **Upper**: `double` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbRangeSliderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRangeSliderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRangeSliderValue](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRangeSliderValue) - -- **constructor**(): void -- **Lower**: `double` -- **Type**: `string` -- **Upper**: `double` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRangeSliderValueEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRangeSliderValueEventArgs) - -- **constructor**(): void -- **Detail**: `IgbRangeSliderValue` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRating](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRating) - -- **constructor**(): void -- **AllowReset**: `bool` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **Hover**: `EventCallback` -- **HoverPreview**: `bool` -- **HoverScript**: `string` -- **Invalid**: `bool` -- **Label**: `string` -- **Max**: `double` -- **ReadOnly**: `bool` -- **Single**: `bool` -- **Step**: `double` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `double` -- **ValueChanged**: `EventCallback` -- **ValueFormat**: `string` -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): double -- **GetCurrentValueAsync**(): Task -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task -- **ResolveDisplay**(): string -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **SetParametersAsync**(parameters: ParameterView): Task -- **StepDown**(n: double): void -- **StepDownAsync**(n: double): Task -- **StepUp**(n: double): void -- **StepUpAsync**(n: double): Task - -### [IgbRatingModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRatingModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRatingSymbol](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRatingSymbol) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ConnectedCallback**(): void -- **ConnectedCallbackAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbRatingSymbolModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRatingSymbolModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRipple](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRipple) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbRippleModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbRippleModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSelect](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSelect) - -- **constructor**(): void -- **Autofocus**: `bool` -- **Blur**: `EventCallback` -- **BlurScript**: `string` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **Distance**: `double` -- **Focus**: `EventCallback` -- **FocusScript**: `string` -- **Invalid**: `bool` -- **Label**: `string` -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **Outlined**: `bool` -- **ParentTypeName**: `string` -- **Placeholder**: `string` -- **Placement**: `PopoverPlacement` -- **Required**: `bool` -- **ScrollStrategy**: `PopoverScrollStrategy` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `string` -- **ValueChanged**: `EventCallback` -- **BlurComponent**(): void -- **BlurComponentAsync**(): Task -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task -- **ClearSelection**(): void -- **ClearSelectionAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FocusComponent**(options: IgbFocusOptions): void -- **FocusComponentAsync**(options: IgbFocusOptions): Task -- **GetCurrentValue**(): string -- **GetCurrentValueAsync**(): Task -- **GetGroups**(): IgbSelectGroup[] -- **GetGroupsAsync**(): Task -- **GetItems**(): IgbSelectItem[] -- **GetItemsAsync**(): Task -- **GetSelectedItem**(): IgbSelectItem -- **GetSelectedItemAsync**(): Task -- **ReportValidity**(): bool -- **ReportValidityAsync**(): Task -- **ResolveDisplay**(): string -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task - -### [IgbSelectGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSelectGroup) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **Items**: `IgbSelectItem[]` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbSelectGroupModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSelectGroupModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSelectHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSelectHeader) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbSelectHeaderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSelectHeaderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSelectItem](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSelectItem) - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **SelectParent**: `BaseRendererControl` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task -- **ResolveDisplay**(): string - -### [IgbSelectItemComponentEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSelectItemComponentEventArgs) - -- **constructor**(): void -- **Detail**: `IgbSelectItem` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSelectItemModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSelectItemModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSelectModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSelectModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSlider](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSlider) - -- **constructor**(): void -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DirectRenderElementName**: `string` -- **Input**: `EventCallback` -- **InputScript**: `string` -- **Invalid**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `double` -- **ValueChanged**: `EventCallback` -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): double -- **GetCurrentValueAsync**(): Task -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task -- **ResolveDisplay**(): string -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task -- **StepDown**(stepDecrement: double): void -- **StepDownAsync**(stepDecrement: double): Task -- **StepUp**(stepIncrement: double): void -- **StepUpAsync**(stepIncrement: double): Task - -### [IgbSliderBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSliderBase) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **DiscreteTrack**: `bool` -- **HidePrimaryLabels**: `bool` -- **HideSecondaryLabels**: `bool` -- **HideTooltip**: `bool` -- **Locale**: `string` -- **LowerBound**: `double` -- **Max**: `double` -- **Min**: `double` -- **PrimaryTicks**: `double` -- **SecondaryTicks**: `double` -- **Step**: `double` -- **SupportsVisualChildren**: `bool` -- **TickLabelRotation**: `SliderTickLabelRotation` -- **TickOrientation**: `SliderTickOrientation` -- **Type**: `string` -- **UpperBound**: `double` -- **UseDirectRender**: `bool` -- **ValueFormat**: `string` -- **ValueFormatOptions**: `IgbNumberFormatSpecifier` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbSliderBaseModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSliderBaseModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSliderLabel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSliderLabel) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbSliderLabelModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSliderLabelModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSliderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSliderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSnackbar](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSnackbar) - -- **constructor**(): void -- **Action**: `EventCallback` -- **ActionScript**: `string` -- **ActionText**: `string` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbSnackbarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSnackbarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStep](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbStep) - -- **constructor**(): void -- **Active**: `bool` -- **Complete**: `bool` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **Invalid**: `bool` -- **Optional**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbStepModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbStepModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStepper](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbStepper) - -- **constructor**(): void -- **ActiveStepChanged**: `EventCallback` -- **ActiveStepChangedScript**: `string` -- **ActiveStepChanging**: `EventCallback` -- **ActiveStepChangingScript**: `string` -- **AnimationDuration**: `double` -- **ContentTop**: `bool` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **HorizontalAnimation**: `HorizontalTransitionAnimation` -- **Linear**: `bool` -- **Orientation**: `StepperOrientation` -- **StepType**: `StepperStepType` -- **Steps**: `IgbStep[]` -- **SupportsVisualChildren**: `bool` -- **TitlePosition**: `StepperTitlePosition` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **VerticalAnimation**: `StepperVerticalAnimation` -- **ConnectedCallback**(): void -- **ConnectedCallbackAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **NavigateTo**(index: double): void -- **NavigateToAsync**(index: double): Task -- **Next**(): void -- **NextAsync**(): Task -- **Prev**(): void -- **PrevAsync**(): Task -- **Reset**(): void -- **ResetAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbStepperModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbStepperModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSwitch](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSwitch) - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbSwitchModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbSwitchModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTab](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTab) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **Label**: `string` -- **Selected**: `bool` -- **SelectedChanged**: `EventCallback` -- **SupportsVisualChildren**: `bool` -- **TabsParent**: `BaseRendererControl` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbTabComponentEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTabComponentEventArgs) - -- **constructor**(): void -- **Detail**: `IgbTab` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTabHeaderElement](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTabHeaderElement) - -- **constructor**(): void -- **DragService**: `IgbDragService` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTabHeaderElementModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTabHeaderElementModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTabModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTabModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTabs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTabs) - -- **constructor**(): void -- **Activation**: `TabsActivation` -- **ActualTabsCollection**: `IgbTabs_TabCollection` -- **Alignment**: `TabsAlignment` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **ContentTabsCollection**: `IgbTabs_TabCollection` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **ParentTypeName**: `string` -- **SupportsVisualChildren**: `bool` -- **TabsCollection**: `IgbTabs_TabCollection` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetSelected**(): string -- **GetSelectedAsync**(): Task -- **ResolveDisplay**(): string -- **Select**(id: string): void -- **SelectAsync**(id: string): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbTabsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTabsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTabs_TabCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTabs_TabCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbTemplateContent](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTemplateContent) - -- **constructor**(): void -- **Context**: `T` -- **Template**: `RenderFragment` -- **BuildRenderTree**(__builder: RenderTreeBuilder): void -- **Update**(): void - -### [IgbTextarea](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTextarea) - -- **constructor**(): void -- **Autocapitalize**: `string` -- **Autocomplete**: `string` -- **Blur**: `EventCallback` -- **BlurScript**: `string` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **Focus**: `EventCallback` -- **FocusScript**: `string` -- **Input**: `EventCallback` -- **InputMode**: `string` -- **InputScript**: `string` -- **Invalid**: `bool` -- **Label**: `string` -- **MaxLength**: `double` -- **MinLength**: `double` -- **Outlined**: `bool` -- **Placeholder**: `string` -- **ReadOnly**: `bool` -- **Required**: `bool` -- **Resize**: `TextareaResize` -- **Rows**: `double` -- **Spellcheck**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ValidateOnly**: `bool` -- **Value**: `string` -- **ValueChanged**: `EventCallback` -- **Wrap**: `TextareaWrap` -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): string -- **GetCurrentValueAsync**(): Task -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task -- **ResolveDisplay**(): string -- **Select**(): void -- **SelectAsync**(): Task -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **SetRangeText**(replacement: string, start: double, end: double, selectMode: RangeTextSelectMode): void -- **SetRangeTextAsync**(replacement: string, start: double, end: double, selectMode: RangeTextSelectMode): Task -- **SetSelectionRange**(start: double, end: double, direction: SelectionRangeDirection): void -- **SetSelectionRangeAsync**(start: double, end: double, direction: SelectionRangeDirection): Task - -### [IgbTextareaModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTextareaModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTile](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTile) - -- **constructor**(): void -- **ColSpan**: `double` -- **ColStart**: `double?` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **DisableFullscreen**: `bool` -- **DisableMaximize**: `bool` -- **DisableResize**: `bool` -- **Maximized**: `bool` -- **Position**: `double` -- **RowSpan**: `double` -- **RowStart**: `double?` -- **SupportsVisualChildren**: `bool` -- **TileDragCancel**: `EventCallback` -- **TileDragCancelScript**: `string` -- **TileDragEnd**: `EventCallback` -- **TileDragEndScript**: `string` -- **TileDragStart**: `EventCallback` -- **TileDragStartScript**: `string` -- **TileFullscreen**: `EventCallback` -- **TileFullscreenScript**: `string` -- **TileManagerParent**: `BaseRendererControl` -- **TileMaximize**: `EventCallback` -- **TileMaximizeScript**: `string` -- **TileResizeCancel**: `EventCallback` -- **TileResizeCancelScript**: `string` -- **TileResizeEnd**: `EventCallback` -- **TileResizeEndScript**: `string` -- **TileResizeStart**: `EventCallback` -- **TileResizeStartScript**: `string` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetFullscreen**(): bool -- **GetFullscreenAsync**(): Task -- **OnInitializedAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbTileChangeStateEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTileChangeStateEventArgs) - -- **constructor**(): void -- **Detail**: `IgbTileChangeStateEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTileChangeStateEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTileChangeStateEventArgsDetail) - -- **constructor**(): void -- **State**: `bool` -- **Tile**: `IgbTile` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTileComponentEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTileComponentEventArgs) - -- **constructor**(): void -- **Detail**: `IgbTile` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTileManager](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTileManager) - -- **constructor**(): void -- **ColumnCount**: `double` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **DragMode**: `TileManagerDragMode` -- **Gap**: `string` -- **MinColumnWidth**: `string` -- **MinRowHeight**: `string` -- **ParentTypeName**: `string` -- **ResizeMode**: `TileManagerResizeMode` -- **SupportsVisualChildren**: `bool` -- **TileDragCancel**: `EventCallback` -- **TileDragCancelScript**: `string` -- **TileDragEnd**: `EventCallback` -- **TileDragEndScript**: `string` -- **TileDragStart**: `EventCallback` -- **TileDragStartScript**: `string` -- **TileFullscreen**: `EventCallback` -- **TileFullscreenScript**: `string` -- **TileMaximize**: `EventCallback` -- **TileMaximizeScript**: `string` -- **TileResizeCancel**: `EventCallback` -- **TileResizeCancelScript**: `string` -- **TileResizeEnd**: `EventCallback` -- **TileResizeEndScript**: `string` -- **TileResizeStart**: `EventCallback` -- **TileResizeStartScript**: `string` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetTiles**(): IgbTile[] -- **GetTilesAsync**(): Task -- **LoadLayout**(data: string): void -- **LoadLayoutAsync**(data: string): Task -- **ResolveDisplay**(): string -- **SaveLayout**(): string -- **SaveLayoutAsync**(): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbTileManagerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTileManagerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTileModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTileModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToast](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbToast) - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbToastModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbToastModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToggleButton](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbToggleButton) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **Selected**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `string` -- **BlurComponent**(): void -- **BlurComponentAsync**(): Task -- **Click**(): void -- **ClickAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FocusComponent**(options: IgbFocusOptions): void -- **FocusComponentAsync**(options: IgbFocusOptions): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbToggleButtonModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbToggleButtonModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTooltip](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTooltip) - -- **constructor**(): void -- **Anchor**: `string` -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **DisableArrow**: `bool` -- **HideDelay**: `double` -- **HideTriggers**: `string` -- **Message**: `string` -- **Offset**: `double` -- **Open**: `bool` -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **Placement**: `PopoverPlacement` -- **ShowDelay**: `double` -- **ShowTriggers**: `string` -- **Sticky**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **WithArrow**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **Hide**(): bool -- **HideAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(target: string): bool -- **ShowAsync**(target: string): Task -- **Toggle**(): bool -- **ToggleAsync**(): Task - -### [IgbTooltipModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTooltipModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTree](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTree) - -- **constructor**(): void -- **ActiveItem**: `EventCallback` -- **ActiveItemScript**: `string` -- **ContentItems**: `IgbTreeItemCollection` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **ItemCollapsed**: `EventCallback` -- **ItemCollapsedScript**: `string` -- **ItemCollapsing**: `EventCallback` -- **ItemCollapsingScript**: `string` -- **ItemExpanded**: `EventCallback` -- **ItemExpandedScript**: `string` -- **ItemExpanding**: `EventCallback` -- **ItemExpandingScript**: `string` -- **ParentTypeName**: `string` -- **Selection**: `TreeSelection` -- **SelectionChanged**: `EventCallback` -- **SelectionChangedScript**: `string` -- **SingleBranchExpand**: `bool` -- **SupportsVisualChildren**: `bool` -- **ToggleNodeOnClick**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ConnectedCallback**(): void -- **ConnectedCallbackAsync**(): Task -- **EnsureModulesLoaded**(): void -- **ExpandToItem**(item: IgbTreeItem): void -- **ExpandToItemAsync**(item: IgbTreeItem): Task -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbTreeItem](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTreeItem) - -- **constructor**(): void -- **Active**: `bool` -- **DefaultEventBehavior**: `ControlEventBehavior` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` -- **Expanded**: `bool` -- **Label**: `string` -- **Level**: `double` -- **Loading**: `bool` -- **Parent**: `IgbTreeItem` -- **Selected**: `bool` -- **SupportsVisualChildren**: `bool` -- **TreeParent**: `BaseRendererControl` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `object` -- **Collapse**(): void -- **CollapseAsync**(): Task -- **CollapseWithEvent**(): void -- **CollapseWithEventAsync**(): Task -- **ConnectedCallback**(): void -- **ConnectedCallbackAsync**(): Task -- **DisconnectedCallback**(): void -- **DisconnectedCallbackAsync**(): Task -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **Expand**(): void -- **ExpandAsync**(): Task -- **ExpandWithEvent**(): void -- **ExpandWithEventAsync**(): Task -- **FindByName**(name: string): object -- **GetPath**(): IgbTreeItem[] -- **GetPathAsync**(): Task -- **OnInitializedAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Toggle**(): void -- **ToggleAsync**(): Task - -### [IgbTreeItemCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTreeItemCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbTreeItemComponentEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTreeItemComponentEventArgs) - -- **constructor**(): void -- **Detail**: `IgbTreeItem` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTreeItemModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTreeItemModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTreeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTreeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTreeSelectionEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTreeSelectionEventArgs) - -- **constructor**(): void -- **Detail**: `IgbTreeSelectionEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTreeSelectionEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbTreeSelectionEventArgsDetail) - -- **constructor**(): void -- **NewSelection**: `IgbTreeItem[]` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbVoidEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgbVoidEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgniteUIBlazor](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgniteUIBlazor) - -- **constructor**(runtime: IJSRuntime): void -- **constructor**(runtime: IJSRuntime, settings: IIgniteUIBlazorSettings): void -- **JsRuntime**: `IJSRuntime` -- **Settings**: `IIgniteUIBlazorSettings` -- **WebCallback**: `WebCallback` -- **IsLoadRequested**(moduleName: string): bool -- **IsRuntimeValid**(reevaluate: bool): bool -- **MarkIsLoadRequested**(moduleName: string): void -- **RequestLoad**(moduleName: string): void - -### [IgniteUIBlazorSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgniteUIBlazorSettings) - -- **constructor**(): void -- **ForceJsonDataMarshalling**: `bool` -- **JsonSerializerOptions**: `IgniteUIJsonSerializerOptions` -- **ModulesToLoad**: `ReadOnlyCollection` -- **Create**(): IgniteUIBlazorSettings -- **ShouldForceJsonDataMarshalling**(): IgniteUIBlazorSettings -- **WithForceJsonDataMarshalling**(forceJsonDataMarshalling: bool): IgniteUIBlazorSettings -- **WithJsonSerializerOptions**(options: IgniteUIJsonSerializerOptions): IgniteUIBlazorSettings -- **WithModulesToLoad**(modulesToLoad: ReadOnlyCollection): IgniteUIBlazorSettings - -### [IgniteUIJsonSerializerOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/IgniteUIJsonSerializerOptions) - -- **constructor**(): void -- **constructor**(options: IgniteUIJsonSerializerOptions): void -- **constructor**(maxDepth: int): void -- **MaxDepth**: `int` - -### [LocalJson](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/LocalJson) - -- **constructor**(json: string): void -- **Json**: `string` -- **From**(json: string): LocalJson - -### [MarshalByValueFactory](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/MarshalByValueFactory) - -- **constructor**(): void - -### [ModuleLoader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/ModuleLoader) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor, moduleName: string): bool -- **Load**(runtime: IIgniteUIBlazor, moduleName: string): void -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor, moduleName: string): void - -### [RemoteJson](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/RemoteJson) - -- **constructor**(uri: string): void -- **Uri**: `string` -- **From**(uri: string): RemoteJson -- **WithUri**(uri: string): RemoteJson - -### [SequenceInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/SequenceInfo) - -- **AttributeKeys**: `ReadOnlyCollection` -- **MaxSequence**: `int` -- **GetSequence**(key: string): int - -### [SerializationContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/SerializationContext) - -- **constructor**(writer: Utf8JsonWriter, filter: SerializationFilter): void -- **Filter**: `SerializationFilter` -- **Writer**: `Utf8JsonWriter` - -### [TypedDynamicContent](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/TypedDynamicContent) - -- **constructor**(t: Type): void -- **GetInstanceAsync**(): Task -- **OnComponentChanged**(oldValue: object, component: object): void - -### [WCAttributeNameAttribute](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/WCAttributeNameAttribute) - -- **constructor**(alternateName: string): void -- **Name**: `string` - -### [WCEnumNameAttribute](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/WCEnumNameAttribute) - -- **constructor**(alternateName: string): void -- **Name**: `string` - -### [WCWidgetMemberNameAttribute](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/WCWidgetMemberNameAttribute) - -- **constructor**(alternateName: string): void -- **Name**: `string` - -### [WebCallback](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/WebCallback) - -- **constructor**(): void -- **IsReady**: `bool` -- **AdjustDynamicContent**(containerId: string, contentType: string, templateId: string, contentId: string, actionType: string, args: string): void -- **AdjustDynamicContentBatch**(containerId: string, batch: string): void -- **OnInvokeReturn**(containerId: string, invokeId: long, returnValue: object): void -- **OnRaiseEvent**(containerId: string, name: string, propertyName: string, args: string): void -- **OnReady**(): void -- **Register**(control: BaseRendererControl): void - -### [_Imports](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/_Imports) - -- **constructor**(): void -- **Execute**(): void - -### [InfragisticsBlazorExtensions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/classes/InfragisticsBlazorExtensions) - -- **AddIgniteUIBlazor**(collection: IServiceCollection, settings: IIgniteUIBlazorSettings, modulesToLoad: Type[]): IServiceCollection -- **AddIgniteUIBlazor**(collection: IServiceCollection, modulesToLoad: Type[]): IServiceCollection - -## Interfaces - -### [IDataIntentAttribute](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/interfaces/IDataIntentAttribute) - -- **Intent**: `string` - -### [IIgniteUIBlazor](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/interfaces/IIgniteUIBlazor) - -- **IsLoadRequested(string)**: `bool` -- **IsRuntimeValid(bool)**: `bool` -- **JsRuntime**: `IJSRuntime` -- **MarkIsLoadRequested(string)**: `any` -- **RequestLoad(string)**: `any` -- **Settings**: `IIgniteUIBlazorSettings` -- **WebCallback**: `WebCallback` - -### [IIgniteUIBlazorSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/interfaces/IIgniteUIBlazorSettings) - -- **ForceJsonDataMarshalling**: `bool` -- **JsonSerializerOptions**: `IgniteUIJsonSerializerOptions` -- **ModulesToLoad**: `ReadOnlyCollection` - -### [JsonSerializable](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/interfaces/JsonSerializable) - -- **Serialize(SerializationContext, string)**: `any` - -## Enumerations - -### [AbsolutePosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/AbsolutePosition) - -- **Bottom** -- **Middle** -- **Top** - -### [AvatarShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/AvatarShape) - -- **Circle** -- **Rounded** -- **Square** - -### [BadgeShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/BadgeShape) - -- **Rounded** -- **Square** - -### [ButtonBaseTarget](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/ButtonBaseTarget) - -- **_blank** -- **_parent** -- **_self** -- **_top** - -### [ButtonBaseType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/ButtonBaseType) - -- **Button** -- **Reset** -- **Submit** - -### [ButtonGroupSelection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/ButtonGroupSelection) - -- **Multiple** -- **Single** -- **SingleRequired** - -### [ButtonVariant](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/ButtonVariant) - -- **Contained** -- **Fab** -- **Flat** -- **Outlined** - -### [CalendarActiveView](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/CalendarActiveView) - -- **Days** -- **Months** -- **Years** - -### [CalendarHeaderOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/CalendarHeaderOrientation) - -- **Horizontal** -- **Vertical** - -### [CalendarSelection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/CalendarSelection) - -- **Multiple** -- **Range** -- **Single** - -### [CarouselAnimationDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/CarouselAnimationDirection) - -- **Next** -- **Prev** - -### [CarouselIndicatorsOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/CarouselIndicatorsOrientation) - -- **End** -- **Start** - -### [ComboChangeType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/ComboChangeType) - -- **Addition** -- **Deselection** -- **Selection** - -### [ContentOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/ContentOrientation) - -- **Horizontal** -- **Vertical** - -### [ControlEventBehavior](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/ControlEventBehavior) - -- **Auto** -- **Immediate** -- **Queued** - -### [DatePart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/DatePart) - -- **AmPm** -- **Date** -- **Hours** -- **Minutes** -- **Month** -- **Seconds** -- **Year** - -### [DateRangeType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/DateRangeType) - -- **After** -- **Before** -- **Between** -- **Specific** -- **Weekdays** -- **Weekends** - -### [DividerType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/DividerType) - -- **Dashed** -- **Solid** - -### [ExpansionPanelIndicatorPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/ExpansionPanelIndicatorPosition) - -- **End** -- **None** -- **Start** - -### [GroupingDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/GroupingDirection) - -- **Asc** -- **Desc** -- **None** - -### [HorizontalTransitionAnimation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/HorizontalTransitionAnimation) - -- **Fade** -- **None** -- **Slide** - -### [IconButtonVariant](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/IconButtonVariant) - -- **Contained** -- **Flat** -- **Outlined** - -### [InputType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/InputType) - -- **Email** -- **Number** -- **Password** -- **Search** -- **Tel** -- **Text** -- **Url** - -### [KeyBindingTrigger](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/KeyBindingTrigger) - -- **Keydown** -- **KeydownRepeat** -- **Keyup** - -### [LinearProgressLabelAlign](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/LinearProgressLabelAlign) - -- **Bottom** -- **BottomEnd** -- **BottomStart** -- **Top** -- **TopEnd** -- **TopStart** - -### [MaskInputValueMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/MaskInputValueMode) - -- **Raw** -- **WithFormatting** - -### [NavDrawerPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/NavDrawerPosition) - -- **Bottom** -- **End** -- **Relative** -- **Start** -- **Top** - -### [PaneActionBehavior](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/PaneActionBehavior) - -- **AllPanes** -- **SelectedPane** - -### [PickerMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/PickerMode) - -- **Dialog** -- **Dropdown** - -### [PopoverPlacement](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/PopoverPlacement) - -- **Bottom** -- **BottomEnd** -- **BottomStart** -- **Left** -- **LeftEnd** -- **LeftStart** -- **Right** -- **RightEnd** -- **RightStart** -- **Top** -- **TopEnd** -- **TopStart** - -### [PopoverScrollStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/PopoverScrollStrategy) - -- **Block** -- **Close** -- **Scroll** - -### [RangeTextSelectMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/RangeTextSelectMode) - -- **End** -- **Preserve** -- **Select** -- **Start** - -### [ResizerLocation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/ResizerLocation) - -- **Bottom** -- **BottomLeft** -- **BottomRight** -- **Left** -- **Right** -- **Top** -- **TopLeft** -- **TopRight** - -### [RoundTripDateConversion](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/RoundTripDateConversion) - -- **Auto** -- **Local** -- **UTC** - -### [SelectionRangeDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/SelectionRangeDirection) - -- **Backward** -- **Forward** -- **None** - -### [SliderTickLabelRotation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/SliderTickLabelRotation) - -- **NegativeNinety** -- **Ninety** -- **Zero** - -### [SliderTickOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/SliderTickOrientation) - -- **End** -- **Mirror** -- **Start** - -### [StepperOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/StepperOrientation) - -- **Horizontal** -- **Vertical** - -### [StepperStepType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/StepperStepType) - -- **Full** -- **Indicator** -- **Title** - -### [StepperTitlePosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/StepperTitlePosition) - -- **Auto** -- **Bottom** -- **End** -- **Start** -- **Top** - -### [StepperVerticalAnimation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/StepperVerticalAnimation) - -- **Fade** -- **Grow** -- **None** - -### [StyleVariant](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/StyleVariant) - -- **Danger** -- **Info** -- **Primary** -- **Success** -- **Warning** - -### [TabsActivation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/TabsActivation) - -- **Auto** -- **Manual** - -### [TabsAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/TabsAlignment) - -- **Center** -- **End** -- **Justify** -- **Start** - -### [TextareaResize](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/TextareaResize) - -- **Auto** -- **None** -- **Vertical** - -### [TextareaWrap](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/TextareaWrap) - -- **Hard** -- **Off** -- **Soft** - -### [TileManagerDragMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/TileManagerDragMode) - -- **None** -- **Tile** -- **TileHeader** - -### [TileManagerResizeMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/TileManagerResizeMode) - -- **Always** -- **Hover** -- **None** - -### [ToggleLabelPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/ToggleLabelPosition) - -- **After** -- **Before** - -### [TreeSelection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/TreeSelection) - -- **Cascade** -- **Multiple** -- **None** - -### [UnpinnedLocation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/UnpinnedLocation) - -- **Bottom** -- **Left** -- **Right** -- **Top** - -### [WeekDays](https://www.infragistics.com/api/blazor/IgniteUI.Blazor.Lite/25.1.x/enums/WeekDays) - -- **Friday** -- **Monday** -- **Saturday** -- **Sunday** -- **Thursday** -- **Tuesday** -- **Wednesday** diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor/25.1.x/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor/25.1.x/llms-full.txt deleted file mode 100644 index 697a30392..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/blazor-api/IgniteUI.Blazor/25.1.x/llms-full.txt +++ /dev/null @@ -1,30438 +0,0 @@ -# Ignite UI for Blazor v25.1.x — Full API Reference - -> Complete API reference for the Ignite UI for Blazor package (25.1.x). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: Blazor -Package: IgniteUI.Blazor -Version: 25.1.x - -## Classes - -### [BaseAlertLikePosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/BaseAlertLikePosition) - -- **Bottom**: `AbsolutePosition` -- **Middle**: `AbsolutePosition` -- **Top**: `AbsolutePosition` - -### [BaseCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/BaseCollection) - -- **constructor**(parent: object, propertyName: string): void -- **ClearItems**(): void -- **FindByName**(name: string): object -- **HasName**(name: string): bool -- **InsertItem**(index: int, item: T): void -- **RemoveItem**(index: int): void -- **Serialize**(context: SerializationContext, propertyName: string): void -- **SetItem**(index: int, item: T): void -- **ToArray**(): T[] - -### [BaseRendererControl](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/BaseRendererControl) - -- **constructor**(): void -- **AdditionalAttributes**: `Dictionary` -- **ChildContent**: `RenderFragment` -- **Class**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **EventBehavior**: `ControlEventBehavior` — Gets or sets how events are bubbled up from JavaScript to Blazor. -- **Height**: `string` -- **IgBlazor**: `IIgniteUIBlazor` -- **NeedsDynamicContent**: `bool` -- **ParentTypeName**: `string` -- **RoundTripDateConversion**: `RoundTripDateConversion` — Gets or sets what type of date conversion to make when round tripping dates. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseCamelEnumValues**: `bool` -- **UseDirectRender**: `bool` -- **Width**: `string` -- **_cachedSerializedContent**: `string` -- **eventCallbacksCache**: `Dictionary>` -- **BuildRenderTree**(builder: RenderTreeBuilder): void -- **BuildSequenceInfo**(startSequence: int): SequenceInfo -- **Camelize**(value: string): string -- **CompareEventCallbacks**(left: T, right: T, eventFieldsDictionary: Dictionary>): bool -- **Dispose**(): void -- **Dispose**(disposing: bool): void -- **EnsureModulesLoaded**(): void -- **EnsureReady**(): Task -- **~BaseRendererControl**(): void -- **FindByName**(name: string): object -- **InvokeMethod**(methodName: string, arguments: object[], types: string[], nativeElements: ElementReference[]): Task -- **InvokeMethodSync**(methodName: string, arguments: object[], types: string[], nativeElements: ElementReference[]): object -- **IsPropDirty**(propertyName: string): bool -- **IsTransformedEnumValue**(key: string): bool -- **MarkPropDirty**(propertyName: string): void -- **NotifyClearItems**(dataSource: object): void -- **NotifyInsertItem**(dataSource: object, index: int, refItem: object): void -- **NotifyRemoveItem**(dataSource: object, index: int, oldItem: object): void -- **NotifySetItem**(dataSource: object, index: int, oldItem: object, newItem: object): void -- **NotifyUpdateItem**(dataSource: object, index: int, refItem: object, syncDataOnly: bool): void -- **OnAfterRenderAsync**(firstRender: bool): Task -- **OnElementNameChanged**(element: BaseRendererElement, oldName: string, newName: string): void -- **OnInvokeReturn**(invokeId: long, returnValue: object): void -- **OnRefChanged**(refName: string, refValue: object): void -- **ResolveDisplay**(): string -- **ResolveEventBehavior**(): ControlEventBehavior — Resolves the components event behavior if Auto is selected. -- **ResumeNotifications**(dataSource: object, notify: bool): void — Resumes data change notifications. -- **Serialize**(): string -- **Serialize**(context: SerializationContext, propertyName: string): void -- **SetPropertyValue**(item: object, property: PropertyInfo, value: object): void -- **SetPropertyValue**(item: object, property: PropertyInfo, jsonElement: JsonElement): void -- **SetResourceStringAsync**(grouping: string, json: string): Task -- **SetResourceStringAsync**(grouping: string, id: string, value: string): Task -- **SuspendNotifications**(dataSource: object): void — Prevents data change notifications from be propagated to the component. -- **TemplateContentType**(templateId: string): Type -- **ToPascal**(value: string): string -- **ToSpinal**(value: string): string -- **TransformPotentialEnumValue**(key: string, value: object): object -- **TransformSimpleKey**(key: string): string - -### [BaseRendererElement](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/BaseRendererElement) - -- **constructor**(): void -- **ChildContent**: `RenderFragment` -- **CurrParent**: `object` -- **IgBlazor**: `IIgniteUIBlazor` -- **IsComponentRooted**: `bool` -- **MethodTarget**: `string` -- **Name**: `string` -- **Parent**: `object` -- **ParentTypeName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **_cachedSerializedContent**: `string` -- **_name**: `string` -- **eventCallbacksCache**: `Dictionary>` -- **BuildRenderTree**(builder: RenderTreeBuilder): void -- **CompareEventCallbacks**(left: T, right: T, eventFieldsDictionary: Dictionary>): bool -- **EnsureModulesLoaded**(): void -- **EnsureValid**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **InvokeMethod**(methodName: string, arguments: object[], types: string[], nativeElements: ElementReference[]): Task -- **InvokeMethodHelper**(target: string, methodName: string, arguments: object[], types: string[], nativeElements: ElementReference[]): Task -- **InvokeMethodHelperSync**(target: string, methodName: string, arguments: object[], types: string[], nativeElements: ElementReference[]): object -- **InvokeMethodSync**(methodName: string, arguments: object[], types: string[], nativeElements: ElementReference[]): object -- **IsPropDirty**(propertyName: string): bool -- **OnElementNameChanged**(element: BaseRendererElement, oldName: string, newName: string): void -- **Serialize**(): string -- **Serialize**(context: SerializationContext, propertyName: string): void -- **SetResourceStringAsync**(grouping: string, json: string): Task -- **SetResourceStringAsync**(grouping: string, id: string, value: string): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [Brush](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/Brush) - -- **constructor**(): void -- **BrushType**: `BrushType` -- **FromString**(value: string): Brush -- **Serialize**(): string -- **Serialize**(context: SerializationContext, propertyName: string): void - -### [ButtonGroupAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/ButtonGroupAlignment) - -- **Horizontal**: `ContentOrientation` -- **Vertical**: `ContentOrientation` - -### [CalendarBaseSelection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/CalendarBaseSelection) - -- **Multiple**: `CalendarSelection` -- **Range**: `CalendarSelection` -- **Single**: `CalendarSelection` - -### [CalendarOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/CalendarOrientation) - -- **Horizontal**: `ContentOrientation` -- **Vertical**: `ContentOrientation` - -### [CardActionsOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/CardActionsOrientation) - -- **Horizontal**: `ContentOrientation` -- **Vertical**: `ContentOrientation` - -### [CarouselAnimationType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/CarouselAnimationType) - -- **Fade**: `HorizontalTransitionAnimation` -- **None**: `HorizontalTransitionAnimation` -- **Slide**: `HorizontalTransitionAnimation` - -### [CheckboxBaseLabelPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/CheckboxBaseLabelPosition) - -- **After**: `ToggleLabelPosition` -- **Before**: `ToggleLabelPosition` - -### [Color](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/Color) - -- **constructor**(): void -- **A**: `byte` -- **B**: `byte` -- **G**: `byte` -- **R**: `byte` -- **Equals**(obj: object): bool -- **FromArgb**(a_: byte, r_: byte, g_: byte, b_: byte): Color -- **GetHashCode**(): int - -### [ComponentRendererComponentChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/ComponentRendererComponentChangedEventArgs) - -- **constructor**(): void -- **NewComponent**: `object` -- **OldComponent**: `object` - -### [DataIntentAttribute](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/DataIntentAttribute) - -- **constructor**(intent: string): void -- **Intent**: `string` - -### [DataSeriesMemberIntentAttribute](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/DataSeriesMemberIntentAttribute) -Represents attribute for specifying member intent of data series - -- **constructor**(memberIntent: DataSeriesIntent): void -- **MemberIntent**: `DataSeriesIntent` — Gets member intent of data series - -### [DataSeriesTitleAttribute](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/DataSeriesTitleAttribute) -Represents attribute for specifying title of data series - -- **constructor**(title: string): void -- **MemberIntent**: `DataSeriesIntent` — Gets member intent of data series -- **Title**: `string` — Gets title of data series - -### [DatePickerHeaderOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/DatePickerHeaderOrientation) - -- **Horizontal**: `CalendarHeaderOrientation` -- **Vertical**: `CalendarHeaderOrientation` - -### [DatePickerMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/DatePickerMode) - -- **Dialog**: `PickerMode` -- **Dropdown**: `PickerMode` - -### [DatePickerOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/DatePickerOrientation) - -- **Horizontal**: `ContentOrientation` -- **Vertical**: `ContentOrientation` - -### [DropdownPlacement](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/DropdownPlacement) - -- **Bottom**: `PopoverPlacement` -- **BottomEnd**: `PopoverPlacement` -- **BottomStart**: `PopoverPlacement` -- **Left**: `PopoverPlacement` -- **LeftEnd**: `PopoverPlacement` -- **LeftStart**: `PopoverPlacement` -- **Right**: `PopoverPlacement` -- **RightEnd**: `PopoverPlacement` -- **RightStart**: `PopoverPlacement` -- **Top**: `PopoverPlacement` -- **TopEnd**: `PopoverPlacement` -- **TopStart**: `PopoverPlacement` - -### [DropdownScrollStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/DropdownScrollStrategy) - -- **Block**: `PopoverScrollStrategy` -- **Close**: `PopoverScrollStrategy` -- **Scroll**: `PopoverScrollStrategy` - -### [DynamicComponentChangingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/DynamicComponentChangingEventArgs) - -- **constructor**(): void -- **NewComponent**: `object` -- **OldComponent**: `object` - -### [DynamicContentHolder](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/DynamicContentHolder) - -- **constructor**(): void -- **DynamicContentInfo**: `LinkedList` -- **AddDynamicContent**(content: DynamicContentInfo): void -- **BuildRenderTree**(__builder: RenderTreeBuilder): void -- **OnDynamicChildRef**(refName: string, child: object): void -- **OnInitialized**(): void -- **Refresh**(): void -- **RemoveDynamicContent**(content: DynamicContentInfo): void - -### [DynamicContentInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/DynamicContentInfo) - -- **constructor**(): void -- **Component**: `object` -- **ControlType**: `Type` -- **Owner**: `BaseRendererControl` -- **RefDivName**: `string` -- **RefName**: `string` -- **OnComponentChanged**(oldValue: object, component: object): void -- **UpdateContext**(context: object): void -- **UpdateTemplate**(template: object): void - -### [DynamicContentInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/DynamicContentInfo) - -- **constructor**(): void -- **Context**: `T` -- **Template**: `RenderFragment` -- **OnComponentChanged**(oldValue: object, component: object): void -- **UpdateContext**(context: object): void -- **UpdateTemplate**(template: object): void - -### [FastReflectionHelper](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/FastReflectionHelper) -A reflection strategy that uses either traditional reflection or compiled lambda expressions to get property values from an object. - -- **constructor**(): void -- **constructor**(useTraditionalReflection: bool, propertyName: string): void -- **Invalid**: `bool` — Returns true if the fast reflection helper is invalid, probably due to a lack of a property name. -- **PropertyName**: `string` — Gets or sets the property name of the current FastReflectionHelper object. -- **UseTraditionalReflection**: `bool` — Indicates that current FastReflectionHelper object is not using compiled expressions. -- **GetPropertyValue**(item: object): object — Gets the property value from the specified item. -- **GetPropertyValue**(itemType: Type, item: object): object — Gets the property value for the specified item. -- **SetPropertyValue**(item: object, value: object): void — Sets the property value for the specified item. - -### [FilterFactory](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/FilterFactory) -Assists in building filters to use with the grids and datasources. - -- **constructor**(): void -- **Instance**: `FilterFactory` — A singleton instance of the factory. -- **TodayOverride**: `DateTime` — Gets or sets an override for todays date which is used in many date expressions. -- **Add**(left: IgbFilterExpression, right: IgbFilterExpression): IgbFilterExpression — Creates an Add expression given a left and right expression. -- **And**(left: IgbFilterExpression, right: IgbFilterExpression): IgbFilterExpression — Creates an And expression given a left and right expression. -- **Build**(callback: DataSourceFilterBuilderBuildCallback): IgbFilterExpression — Calls a callback providing a factory for use within the callback. -- **Cast**(expression: IgbFilterExpression, type: DataSourceSchemaPropertyType): IgbFilterExpression — Creates a Cast expression. -- **Ceiling**(expression: IgbFilterExpression): IgbFilterExpression — Creates a Ceiling expression given an expression. -- **Concat**(expression: IgbFilterExpression, toAppend: IgbFilterExpression): IgbFilterExpression — Creates a Concat expression. -- **Concat**(expression: IgbFilterExpression, toAppend: string): IgbFilterExpression — Creates a Concat expression. -- **Contains**(wholeString: IgbFilterExpression, subString: IgbFilterExpression): IgbFilterExpression — Creates a Contains expression. -- **Contains**(wholeString: IgbFilterExpression, subString: string): IgbFilterExpression — Creates a Contains expression. -- **Date**(expression: IgbFilterExpression): IgbFilterExpression — Creates a Date expression. -- **Day**(expression: IgbFilterExpression): IgbFilterExpression — Creates a Day expression. -- **Divide**(left: IgbFilterExpression, right: IgbFilterExpression): IgbFilterExpression — Creates a Divide expression given a left and right expression. -- **EndsWith**(wholeString: IgbFilterExpression, subString: IgbFilterExpression): IgbFilterExpression — Creates an EndsWith expression. -- **EndsWith**(wholeString: IgbFilterExpression, subString: string): IgbFilterExpression — Creates a EndsWith expression. -- **Env**(varName: IgbFilterExpression): IgbFilterExpression — Creates an Env expression. -- **Equal**(left: IgbFilterExpression, right: IgbFilterExpression): IgbFilterExpression — Creates an Equal expression given a left and right expression. -- **Floor**(expression: IgbFilterExpression): IgbFilterExpression — Creates a Floor expression. -- **GreaterThan**(left: IgbFilterExpression, right: IgbFilterExpression): IgbFilterExpression — Creates a Greater Than expression given a left and right expression. -- **GreaterThanOrEqual**(left: IgbFilterExpression, right: IgbFilterExpression): IgbFilterExpression — Creates a Greater Than Or Equal expression given a left and right expression. -- **Group**(expression: IgbFilterExpression): IgbFilterExpression — Creates a grouping expression. -- **Hour**(expression: IgbFilterExpression): IgbFilterExpression — Creates an Hour expression. -- **IndexOf**(target: IgbFilterExpression, toFind: IgbFilterExpression): IgbFilterExpression — Creates an IndexOf expression. -- **IndexOf**(target: IgbFilterExpression, toFind: string): IgbFilterExpression — Creates an IndexOf expression. -- **IsOf**(expression: IgbFilterExpression, type: DataSourceSchemaPropertyType): IgbFilterExpression — Creates an IsOf expression. -- **Length**(expression: IgbFilterExpression): IgbFilterExpression — Creates a Length expression. -- **LessThan**(left: IgbFilterExpression, right: IgbFilterExpression): IgbFilterExpression — Creates a Less Than expression given a left and right expression. -- **LessThanOrEqual**(left: IgbFilterExpression, right: IgbFilterExpression): IgbFilterExpression — Creates a Less Than Or Equal expression given a left and right expression. -- **Literal**(value: object): IgbFilterExpression — Creates a literal value expression. -- **Minute**(expression: IgbFilterExpression): IgbFilterExpression — Creates a Minute expression. -- **Modulus**(left: IgbFilterExpression, right: IgbFilterExpression): IgbFilterExpression — Creates a Modulus expression given a left and right expression. -- **Month**(expression: IgbFilterExpression): IgbFilterExpression — Creates a Month expression. -- **Multiply**(left: IgbFilterExpression, right: IgbFilterExpression): IgbFilterExpression — Creates a Multiply expression given a left and right expression. -- **Not**(expression: IgbFilterExpression): IgbFilterExpression — Creates an Not expression given an expression. -- **NotEqual**(left: IgbFilterExpression, right: IgbFilterExpression): IgbFilterExpression — Creates a Not Equal expression given a left and right expression. -- **Now**(): IgbFilterExpression — Creates a Now expression which returns the current date/time. -- **Or**(left: IgbFilterExpression, right: IgbFilterExpression): IgbFilterExpression — Creates an Or expression given a left and right expression. -- **Property**(propertyName: string): IgbFilterExpression — Creates a property access expression. -- **Replace**(target: IgbFilterExpression, toFind: IgbFilterExpression, replacement: IgbFilterExpression): IgbFilterExpression — Creates a Replace expression. -- **Replace**(target: IgbFilterExpression, toFind: IgbFilterExpression, replacement: string): IgbFilterExpression — Creates a Replace expression. -- **Replace**(target: IgbFilterExpression, toFind: string, replacement: IgbFilterExpression): IgbFilterExpression — Creates a Replace expression. -- **Replace**(target: IgbFilterExpression, toFind: string, replacement: string): IgbFilterExpression — Creates a Replace expression. -- **Round**(expression: IgbFilterExpression): IgbFilterExpression — Creates a Round expression. -- **Second**(expression: IgbFilterExpression): IgbFilterExpression — Creates a Second expression. -- **StartsWith**(wholeString: IgbFilterExpression, subString: IgbFilterExpression): IgbFilterExpression — Creates a StartsWith expression. -- **StartsWith**(wholeString: IgbFilterExpression, subString: string): IgbFilterExpression — Creates an StartsWith expression. -- **Substring**(wholeString: IgbFilterExpression, startIndex: IgbFilterExpression): IgbFilterExpression — Creates an StartsWith expression. -- **Substring**(expression: IgbFilterExpression, startIndex: IgbFilterExpression, length: IgbFilterExpression): IgbFilterExpression — Creates an StartsWith expression. -- **Substring**(expression: IgbFilterExpression, startIndex: IgbFilterExpression, length: int): IgbFilterExpression — Creates an StartsWith expression. -- **Substring**(wholeString: IgbFilterExpression, startIndex: int): IgbFilterExpression — Creates an StartsWith expression. -- **Substring**(expression: IgbFilterExpression, startIndex: int, length: IgbFilterExpression): IgbFilterExpression — Creates an StartsWith expression. -- **Substring**(expression: IgbFilterExpression, startIndex: int, length: int): IgbFilterExpression — Creates an StartsWith expression. -- **Subtract**(left: IgbFilterExpression, right: IgbFilterExpression): IgbFilterExpression — Creates a Subtract expression given a left and right expression. -- **Time**(expression: IgbFilterExpression): IgbFilterExpression — Creates a Time expression. -- **ToLower**(expression: IgbFilterExpression): IgbFilterExpression — Creates a ToLower expression. -- **ToUpper**(expression: IgbFilterExpression): IgbFilterExpression — Creates a ToUpper expression. -- **Trim**(expression: IgbFilterExpression): IgbFilterExpression — Creates a Trim expression. -- **Year**(expression: IgbFilterExpression): IgbFilterExpression — Creates a Year expression. - -### [GlobalAnimationState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/GlobalAnimationState) - -- **Instance**: `GlobalAnimationState` -- **GetAnimationIdleVersionNumber**(): int -- **IsAnimationActive**(): bool -- **NotifyAnimationEnd**(): void -- **NotifyAnimationStart**(): void -- **QueueForAnimationIdle**(action: Action, version: int): void -- **QueueForAnimationIdleWithTimeout**(action: Action, version: int, timeout: int): void -- **SetExecutionContext**(executionContext: IExecutionContext): void - -### [GradientStop](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/GradientStop) - -- **constructor**(): void -- **constructor**(color: Color, offset: double): void -- **Color**: `Color` -- **Offset**: `double` -- **Serialize**(): string - -### [HorizontalLabelFormatSpecifiers](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/HorizontalLabelFormatSpecifiers) - -- **constructor**(): void -- **ParentTypeName**: `string` -- **SparklineParent**: `BaseRendererControl` -- **Dispose**(): void -- **OnInitializedAsync**(): Task - -### [IgbAbsoluteVolumeOscillatorIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAbsoluteVolumeOscillatorIndicator) -Represents a IgbDataChart Absolute Volume Oscillator indicator series. - -- **constructor**(): void -- **LongPeriod**: `int` — Gets or sets the short moving average period for the current AbsoluteVolumeOscillatorIndicator object. The typical, and initial, value for long AVO periods is 30. -- **ShortPeriod**: `int` — Gets or sets the short moving average period for the current AbsoluteVolumeOscillatorIndicator object. The typical, and initial, value for short AVO periods is 10. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbAbsoluteVolumeOscillatorIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAbsoluteVolumeOscillatorIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbAccordion](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAccordion) -The Accordion is a container-based component that can house multiple expansion panels and offers keyboard navigation. - -- **constructor**(): void -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **ParentTypeName**: `string` -- **SingleExpand**: `bool` — Allows only one panel to be expanded at a time. false -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **HideAll**(): void -- **HideAllAsync**(): Task — Hides all of the child expansion panels' contents. -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ShowAll**(): void -- **ShowAllAsync**(): Task — Shows all of the child expansion panels' contents. - -### [IgbAccordionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAccordionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbAccumulationDistributionIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAccumulationDistributionIndicator) -Represents a IgbDataChart Accumulation/Distribution indicator series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbAccumulationDistributionIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAccumulationDistributionIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbActionStrip](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbActionStrip) - -- **constructor**(): void -- **ActionButtons**: `IgbGridActionsBaseDirectiveCollection` — ActionButton as ContentChildren inside the Action Strip -- **ActualActionButtons**: `IgbGridActionsBaseDirectiveCollection` -- **ContentActionButtons**: `IgbGridActionsBaseDirectiveCollection` -- **GridBaseDirectiveParent**: `BaseRendererControl` -- **Hidden**: `bool` -- **HierarchicalGridParent**: `BaseRendererControl` -- **ParentTypeName**: `string` -- **ResourceStrings**: `IgbActionStripResourceStrings` — Gets/Sets the resource strings. By default it uses EN resources. -- **RowIslandParent**: `BaseRendererElement` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **Hide**(): void -- **HideAsync**(): Task — Hiding the Action Strip and removing it from its current context element. this.actionStrip.hide(); -- **OnInitializedAsync**(): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(context: object): void -- **ShowAsync**(context: object): Task — Showing the Action Strip and appending it the specified context element. context this.actionStrip.show(row); - -### [IgbActionStripCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbActionStripCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbActionStripModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbActionStripModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbActionStripResourceStrings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbActionStripResourceStrings) - -- **constructor**(): void -- **Igx_action_strip_button_more_title**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbActiveNodeChangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbActiveNodeChangeEventArgs) -Emitted when the active node is changed - -- **constructor**(): void -- **Detail**: `IgbActiveNodeChangeEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbActiveNodeChangeEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbActiveNodeChangeEventArgsDetail) -Emitted when the active node is changed - -- **constructor**(): void -- **Column**: `double` — Represents the column index of the active node -- **Level**: `double` — Optional Represents the hierarchical level of the active node -- **Row**: `double` — Represents the row index of the active node -- **Tag**: `GridKeydownTargetType` — Represents the type of the active node. The GridKeydownTargetType is an enum or that specifies the possible target types -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbActivePaneEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbActivePaneEventArgs) - -- **constructor**(): void -- **Detail**: `IgbActivePaneEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbActivePaneEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbActivePaneEventArgsDetail) - -- **constructor**(): void -- **NewPane**: `IgbContentPane` — Gets the new active pane. -- **OldPane**: `IgbContentPane` — Gets the old active pane. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbActiveStepChangedArgsEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbActiveStepChangedArgsEventArgs) - -- **constructor**(): void - -### [IgbActiveStepChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbActiveStepChangedEventArgs) - -- **constructor**(): void -- **Detail**: `IgbActiveStepChangedEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbActiveStepChangedEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbActiveStepChangedEventArgsDetail) - -- **constructor**(): void -- **Index**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbActiveStepChangingArgsEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbActiveStepChangingArgsEventArgs) - -- **constructor**(): void - -### [IgbActiveStepChangingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbActiveStepChangingEventArgs) - -- **constructor**(): void -- **Detail**: `IgbActiveStepChangingEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbActiveStepChangingEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbActiveStepChangingEventArgsDetail) - -- **constructor**(): void -- **NewIndex**: `double` -- **OldIndex**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAlignLinearGraphLabelEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAlignLinearGraphLabelEventArgs) -Represents event argument for AlignLinearGraphLabel. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAlignRadialGaugeLabelEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAlignRadialGaugeLabelEventArgs) -Represents event argument for AlignRadialGaugeLabel. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAnchoredCategorySeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAnchoredCategorySeries) -Represents the base class for all IgbDataChart anchored category/value series. - -- **constructor**(): void -- **ActualTrendLineBrush**: `string` — Gets the effective TrendLineBrush for this series. -- **ConsolidatedItemHitTestBehavior**: `ConsolidatedItemHitTestBehavior` — Determines the item returned in hit-testing when the pointer is over an object which represents several consolidated items. -- **HighlightedValueMemberPath**: `string` — Gets or sets the value mapping property for the current series object. -- **MarkerCollisionAvoidance**: `CategorySeriesMarkerCollisionAvoidance` — The desired behavior for markers in this series which are placed too close together for the current view, resulting in a collision. -- **TrendLineBrush**: `string` — Gets or sets the brush to use to draw the trend line. -- **TrendLineDashArray**: `double[]` — Gets or sets a collection of double values that indicate the pattern of dashes and gaps that is used to draw the trend line for the current series object. -- **TrendLinePeriod**: `int` — Gets or sets the trend line period for the current series. -- **TrendLineThickness**: `double` — Gets or sets the thickness of the current series object's trend line. -- **TrendLineType**: `TrendLineType` — Gets or sets the trend type for the current series object. -- **Type**: `string` -- **ValueMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series value in the Data Legend. -- **ValueMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series value in the Data Legend. -- **ValueMemberPath**: `string` — Gets or sets the value mapping property for the current series object. -- **FindByName**(name: string): object -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **GetSeriesValueType**(mode: ValueLayerValueMode): double[] -- **GetSeriesValueTypeAsync**(mode: ValueLayerValueMode): Task — Gets a numeric value from the numeric axis associated with this series that matches the desired value mode. -- **GetSeriesValueTypePosition**(mode: ValueLayerValueMode): Point -- **GetSeriesValueTypePositionAsync**(mode: ValueLayerValueMode): Task — Gets position of series value for specified layer value mode -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the series to display the item for the specified data item. - -### [IgbAnchoredRadialSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAnchoredRadialSeries) -Represents the base class for all IgbDataChart anchored radial category series. - -- **constructor**(): void -- **ActualTrendLineBrush**: `string` — Gets the effective TrendLineBrush for this series. -- **HighlightedValueMemberPath**: `string` — Gets or sets the value mapping property for the current series object. -- **TrendLineBrush**: `string` — Gets or sets the brush that specifies how to the current series object's Trend line is drawn. -- **TrendLineDashArray**: `double[]` — Gets or sets a collection of double values that indicate the pattern of dashes and gaps that is used to draw the trend line for the current series object. -- **TrendLinePeriod**: `int` — Gets or sets the trend line period for the current series. The typical, and initial, value for bollinger band periods is 20. -- **TrendLineThickness**: `double` — Gets or sets the thickness of the current series object's trend line. -- **TrendLineType**: `TrendLineType` — Gets or sets the trend type for the current series object. -- **TrendLineZIndex**: `int` — Sets or Gets the Z index of the trendline. -- **Type**: `string` -- **UseCategoryNormalizedValues**: `bool` — Gets or sets whether to normalize the values against the category values if using a proportional category axis. -- **ValueMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series value in the Data Legend. -- **ValueMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series value in the Data Legend. -- **ValueMemberPath**: `string` — Gets or sets the item path that provides the values for the current series. -- **FindByName**(name: string): object -- **GetCategoryWidth**(): double -- **GetCategoryWidthAsync**(): Task — Returns the width of the category grouping this series is in. -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **GetNextOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetNextOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetOffsetValue**(): double -- **GetOffsetValueAsync**(): Task — Returns the offset value for this series if grouped on a category axis. -- **GetPreviousOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetPreviousOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetSeriesValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the specified item into the view. - -### [IgbAnnotationLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAnnotationLayer) -Represents the base class for annotation layer types. Annotations will usually disable some of the default hover/touch behaviors of the chart when they are introduced to the series collection. In return they provide some valuable information as the cursor is moved by hovering over the chart, or performing a press-hold-drag interaction in touch mode. - -- **constructor**(): void -- **ActualAppearanceMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the annotation layer color based on the target series. -- **ActualDashArray**: `double[]` — Gets or sets the mode used for shifting the annotation layer color based on the target series. -- **ActualDashCap**: `PenLineCap` — Gets or sets the mode used for shifting the annotation layer color based on the target series. -- **ActualHorizontalAppearanceMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the annotation layer color based on the target series. -- **ActualHorizontalDashArray**: `double[]` — Gets or sets the mode used for shifting the annotation layer color based on the target series. -- **ActualHorizontalShiftAmount**: `double` — Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0. -- **ActualShiftAmount**: `double` — Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0. -- **ActualVerticalAppearanceMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the annotation layer color based on the target series. -- **ActualVerticalDashArray**: `double[]` — Gets or sets the mode used for shifting the annotation layer color based on the target series. -- **ActualVerticalShiftAmount**: `double` — Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0. -- **AppearanceMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the annotation layer color based on the target series. -- **CursorPosition**: `Point` — Gets or sets the world position to use instead of the pointer position for this annotation layer. If you set this value, rather than responding to the pointer, this layer will be fixed on the provided world position. A world position has x and y values that range from 0 to 1 that represent the global position of the cursor relative to the entire ranges of the axes. The default of (NaN, NaN) means that the layer should react to pointer movement. -- **CursorPositionUpdatesOnMove**: `bool` — Gets or sets whether the annotation layer updates on moving cursor position -- **HorizontalAppearanceMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the annotation layer color based on the target series. -- **HorizontalDashArray**: `double[]` — Gets or sets the mode used for shifting the annotation layer color based on the target series. -- **HorizontalShiftAmount**: `double` — Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0. -- **IsDefaultCrosshairDisabled**: `bool` — Gets or sets whether the series viewer's default crosshair should be disabled by the presence of this layer. -- **ShiftAmount**: `double` — Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0. -- **ShouldRenderAsOverlay**: `bool` — Gets or sets whether this layer renders as an overlay or not. -- **Type**: `string` -- **UseIndex**: `bool` — Gets or sets whether this series should take up an index for auto brush coloring. -- **UseLegend**: `bool` — Gets or sets whether this series interacts with the chart legend. -- **VerticalAppearanceMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the annotation layer color based on the target series. -- **VerticalDashArray**: `double[]` — Gets or sets the mode used for shifting the annotation layer color based on the target series. -- **VerticalShiftAmount**: `double` — Gets or sets the percentage amount to shift the appearance mode by. Value must range between -1.0 to 1.0. -- **FindByName**(name: string): object - -### [IgbAnnotationLayerProxyModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAnnotationLayerProxyModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbApplyButtonClickEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbApplyButtonClickEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbArcGISOnlineMapImagery](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbArcGISOnlineMapImagery) -UI element class used to display ArcGIS Online Map imagery in the IgbGeographicMap. - -- **constructor**(): void -- **DefaultTokenTimeout**: `int` — Gets or Sets the Default Token Timeout before the Token Expires, this value is in Minutes -- **IsMapPublic**: `bool` — Gets or sets the IsMapPublic variable. A value of false requires authentication parameters. -- **MapServerUri**: `string` — Gets or sets the map tile server uri. -- **Password**: `string` — Gets or sets the Password. -- **RefererUri**: `string` — Contains the User Supplied Referer Uri to be used in Token Generation. -- **TokenGenerationEndPoint**: `string` — Gets or Sets the current endpoint to retrieve the token. -- **Type**: `string` -- **UserName**: `string` — Gets or sets the UserName. -- **UserToken**: `string` — Gets or sets the UserToken. -- **AcquireNewToken**(): void -- **AcquireNewTokenAsync**(): Task — Retreives a new token based on the preconfigured parameters and updates the UserToken field, Normal this is called automatically. The is provided to the end-user to allow them to reteive tokens on their onw. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbArcGISOnlineMapImageryModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbArcGISOnlineMapImageryModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbAreaFragment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAreaFragment) -Represents one part of a StackedAreaSeries. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbAreaFragmentModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAreaFragmentModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbAreaSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAreaSeries) -Represents a IgbDataChart area series. Displays trend over time or ordered categories. Useful when there are many data points and the order is important. - -- **constructor**(): void -- **Type**: `string` -- **UnknownValuePlotting**: `UnknownValuePlotting` — Determines how unknown values will be plotted on the chart. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbAreaSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAreaSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbAssigningCategoryMarkerStyleEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningCategoryMarkerStyleEventArgs) -Represents event arguments class for the AssigningCategoryStyleEvent - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAssigningCategoryStyleEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningCategoryStyleEventArgs) -Represents event arguments class for the AssigningCategoryStyleEvent - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAssigningCategoryStyleEventArgsBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningCategoryStyleEventArgsBase) -Represents event arguments base class for the AssigningCategoryStyleEventArgsBase - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbAssigningPolarMarkerStyleEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningPolarMarkerStyleEventArgs) -Represents event arguments class for the AssigningPolarStyleEvent - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAssigningPolarStyleEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningPolarStyleEventArgs) -Represents event arguments class for the AssigningPolarStyleEvent - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAssigningPolarStyleEventArgsBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningPolarStyleEventArgsBase) -Represents event arguments base class for the AssigningCategoryStyleEventArgsBase - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbAssigningRadialMarkerStyleEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningRadialMarkerStyleEventArgs) -Represents event arguments class for the AssigningRadialStyleEvent - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAssigningRadialStyleEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningRadialStyleEventArgs) -Represents event arguments class for the AssigningRadialStyleEvent - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAssigningRadialStyleEventArgsBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningRadialStyleEventArgsBase) -Represents event arguments base class for the AssigningCategoryStyleEventArgsBase - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbAssigningScatterMarkerStyleEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningScatterMarkerStyleEventArgs) -Represents event arguments class for the AssigningScatterStyleEvent - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAssigningScatterStyleEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningScatterStyleEventArgs) -Represents event arguments class for the AssigningScatterStyleEvent - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAssigningScatterStyleEventArgsBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningScatterStyleEventArgsBase) -Represents event arguments base class for the AssigningCategoryStyleEventArgsBase - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbAssigningSeriesShapeStyleEventArgsBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningSeriesShapeStyleEventArgsBase) -Represents event arguments class for the AssigningCategoryStyleEvent - -- **constructor**(): void -- **RadiusX**: `double` — Gets or sets corner radius X to use for the current item, if applicable. -- **RadiusY**: `double` — Gets or sets corner radius Y to use for the current item, if applicable. -- **StrokeDashArray**: `double[]` — Gets or sets stroke dash array to use for the current item. -- **StrokeThickness**: `double` — Gets or sets stroke thickness to use for the current item. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbAssigningSeriesStyleEventArgsBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningSeriesStyleEventArgsBase) -Represents event arguments base class for the AssigningCategoryStyleEventArgsBase - -- **constructor**(): void -- **EndDate**: `DateTime` — Gets the end date, if applicable -- **EndIndex**: `int` — Gets the end index -- **FadeOpacity**: `double` — Gets or sets opacity to use for the current item. -- **Fill**: `string` — Gets or sets fill brush to use for the current item. -- **FocusHighlightingInfo**: `IgbHighlightingInfo` — Gets or sets focus highlighting info -- **GetItems**: `string` — Gets a function that will return the items associated with this event. -- **GetItemsScript**: `string` — Provides a means of setting GetItems in the JavaScript environment. -- **HasDateRange**: `bool` — Gets if this event has a valid date range -- **HighlightingHandled**: `bool` — Gets or sets if highlighting was handled by this event handler, and whether internal highlighting logic should be skipped. -- **HighlightingInfo**: `IgbHighlightingInfo` — Gets or sets highlighting info -- **IsNegativeShape**: `bool` — Gets if the current shape is identified as a negative shape if this series supports discrete negative shapes. -- **IsThumbnail**: `bool` — Gets if the current event is being raised for the thumbnail image. -- **MaxAllSeriesFocusHighlightingProgress**: `double` — Gets the max focus highlighting progress from all series. -- **MaxAllSeriesHighlightingProgress**: `double` — Gets the max highlighting progress from all series. -- **MaxAllSeriesSelectionHighlightingProgress**: `double` — Gets the max selection highlighting progress from all series. -- **Opacity**: `double` — Gets or sets opacity to use for the current item. -- **SelectionHighlightingInfo**: `IgbHighlightingInfo` — Gets or sets selection highlighting info -- **StartDate**: `DateTime` — Gets the start date, if applicable -- **StartIndex**: `int` — Gets the start index -- **Stroke**: `string` — Gets or sets stroke to use for the current item. -- **SumAllSeriesFocusHighlightingProgress**: `double` — Gets the sum of focus highlighting progress from all series. -- **SumAllSeriesHighlightingProgress**: `double` — Gets the sum of highlighting progress from all series. -- **SumAllSeriesSelectionHighlightingProgress**: `double` — Gets the sum of selection highlighting progress from all series. -- **TotalAllSeriesFocusHighWaterMark**: `double` — Gets the high water mark focus highlighting progress. -- **TotalAllSeriesFocusHighlightingProgress**: `double` — Gets the average of selection highlighting progress from all the series. -- **TotalAllSeriesHighWaterMark**: `double` — Gets the high water mark highlighting progress. -- **TotalAllSeriesHighlightingProgress**: `double` — Gets the average of highlighting progress from all the series. -- **TotalAllSeriesSelectionHighWaterMark**: `double` — Gets the high water mark selection highlighting progress. -- **TotalAllSeriesSelectionHighlightingProgress**: `double` — Gets the average of selection highlighting progress from all the series. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbAssigningShapeMarkerStyleEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningShapeMarkerStyleEventArgs) -Represents event arguments class for the AssigningShapeStyleEvent - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAssigningShapeStyleEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningShapeStyleEventArgs) -Represents event arguments class for the AssigningShapeStyleEvent - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAssigningShapeStyleEventArgsBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAssigningShapeStyleEventArgsBase) -Represents event arguments base class for the AssigningCategoryStyleEventArgsBase - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbAsyncCompletedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAsyncCompletedEventArgs) - -- **constructor**(): void -- **Cancelled**: `bool` -- **Type**: `string` -- **UserState**: `object` -- **UserStateScript**: `string` — Provides a means of setting UserState in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAvatar](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAvatar) -An avatar component is used as a representation of a user identity typically in a user profile. - -- **constructor**(): void -- **Alt**: `string` — Alternative text for the image. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Initials**: `string` — Initials to use as a fallback when no image is available. -- **Shape**: `AvatarShape` — The shape of the avatar. -- **Src**: `string` — The image source to use. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbAvatarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAvatarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbAverageDirectionalIndexIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAverageDirectionalIndexIndicator) -Represents a IgbDataChart Average Directional indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current AverageDirectionalIndexIndicator object. The typical, and initial, value for AverageDirectionalIndexIndicator periods is 14. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbAverageDirectionalIndexIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAverageDirectionalIndexIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbAverageTrueRangeIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAverageTrueRangeIndicator) -Represents a IgbDataChart Average True Range indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current AverageTrueRangeSeries object. The typical, and initial, value for AverageTrueRange periods is 14. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbAverageTrueRangeIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAverageTrueRangeIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbAxis](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAxis) -Represents the base class from which all axis types are derived. - -- **constructor**(): void -- **ActualAnnotations**: `IgbAxisAnnotationCollection` -- **ActualLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ActualMajorStroke**: `string` — Gets or sets the ActualMajorStroke property. -- **ActualMinorStroke**: `string` — Gets or sets the ActualMinorStroke property. -- **ActualStroke**: `string` — Gets or sets the effective stroke used for the axis. -- **Annotations**: `IgbAxisAnnotationCollection` — Gets the current annotations for the axis. -- **CoercionMethods**: `object` — Gets or sets the coercion methods to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be re-imported into the chart. -- **CoercionMethodsScript**: `string` — Provides a means of setting CoercionMethods in the JavaScript environment. -- **CompanionAxisCrossingAxis**: `IgbAxis` — Gets or sets crossing axis for the companion axis. -- **CompanionAxisCrossingAxisName**: `string` — Gets or sets the name to use to resolve companionAxisCrossingAxis from markup. -- **CompanionAxisCrossingAxisScript**: `string` — Provides a means of setting CompanionAxisCrossingAxis in the JavaScript environment. -- **CompanionAxisCrossingValue**: `double` — Gets or sets crossing value for the companion axis. -- **CompanionAxisEnabled**: `bool` — Gets or sets whether or not the companion axis is enabled for this axis. -- **CompanionAxisIsInverted**: `FeatureState` — Gets or sets whether or not the companion axis is inverted. -- **CompanionAxisLabelAngle**: `double` — Gets or sets label angle on the companion axis. -- **CompanionAxisLabelColor**: `string` — Gets or sets color of labels on the companion axis. -- **CompanionAxisLabelExtent**: `double` — Gets or sets extent of labels on the companion axis. -- **CompanionAxisLabelHorizontalAlignment**: `HorizontalAlignment` — Gets or sets horizontal alignment of labels on the companion axis. -- **CompanionAxisLabelLocation**: `AxisLabelsLocation` — Gets or sets location of labels on the companion axis. -- **CompanionAxisLabelOpposite**: `bool` — Gets or sets whether or not the companion axis has opposite location of this axis. -- **CompanionAxisLabelVerticalAlignment**: `VerticalAlignment` — Gets or sets vertical alignment of the companion axis. -- **CompanionAxisLabelVisible**: `FeatureState` — Gets or sets whether or not the companion axis has visible labels. -- **CompanionAxisMajorStroke**: `string` — Gets or sets stroke of major gridlines on the companion axis. -- **CompanionAxisMajorStrokeThickness**: `double` — Gets or sets thickness of major gridlines on the companion axis. -- **CompanionAxisMinExtent**: `double` — Gets or sets label angle on the companion axis. -- **CompanionAxisMinorStroke**: `string` — Gets or sets stroke of minior gridlines on the companion axis. -- **CompanionAxisMinorStrokeThickness**: `double` — Gets or sets thickness of minior gridlines on the companion axis. -- **CompanionAxisShouldAutoTruncateAnnotations**: `FeatureState` — Gets or sets whether or not the companion axis should auto truncate annotations. -- **CompanionAxisShouldAvoidAnnotationCollisions**: `FeatureState` — Gets or sets whether or not the companion axis should avoid annotation collisions. -- **CompanionAxisShouldKeepAnnotationsInView**: `FeatureState` — Gets or sets whether or not the companion axis should keep annotations in view. -- **CompanionAxisStrip**: `string` — Gets or sets color of strips on the companion axis. -- **CompanionAxisStroke**: `string` — Gets or sets color of line stroke on the companion axis. -- **CompanionAxisStrokeThickness**: `double` — Gets or sets label angle on the companion axis. -- **CompanionAxisSyncronizedWithPrimaryAxis**: `bool` — Gets or sets whether or not the companion axis is syncronized with properties of primary axis unless CompanionAxis* properties are set -- **CompanionAxisTickLength**: `double` — Gets or sets length of ticks on the companion axis. -- **CompanionAxisTickStroke**: `string` — Gets or sets color of ticks on the companion axis. -- **CompanionAxisTickStrokeThickness**: `double` — Gets or sets label angle on the companion axis. -- **CompanionAxisTitle**: `string` — Gets or sets title on the companion axis. -- **ContentAnnotations**: `IgbAxisAnnotationCollection` -- **ContentLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **CrossingAxis**: `IgbAxis` — Gets or sets the CrossingAxis property. -- **CrossingAxisName**: `string` — Gets or sets the name to use to resolve crossingAxis from markup. -- **CrossingAxisScript**: `string` — Provides a means of setting CrossingAxis in the JavaScript environment. -- **CrossingValue**: `object` — Gets or sets the CrossingValue property. -- **EnhancedIntervalMinimumCharacters**: `int` — Gets or sets the minimum desired characters to be displayed for horizontal axes when using advanced label heuristics. -1 will attempt to adjust the interval to precisely fit the horizontal labels. -- **EnhancedIntervalPreferMoreCategoryLabels**: `bool` — Gets or sets whether the enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval. -- **ExpectFunctions**: `bool` — Gets or sets whether the series should expect that properties in its items source may be functions that need to be evaluated to yield their value. This defaults to false, as there will be a subtle performance impact to using this feature. This value must be set before assigning an item's source to take effect. -- **FormatLabelScript**: `string` — Provides a means of setting FormatLabel in the JavaScript environment. -- **IsCompanionAxis**: `bool` — Gets whether this is companion axis automatically created for a primary axis -- **IsDisabled**: `bool` — Gets or sets the IsDisabled property. If true, the axis will not be rendered. -- **IsInverted**: `bool` — Gets or sets the IsInverted property. -- **Label**: `string` -- **LabelAngle**: `double` — Gets or sets the angle of the {0}. -- **LabelBottomMargin**: `double` — Margin applied below the {0}. -- **LabelExtent**: `double` — Distance between the axis and the edge of the control. -- **LabelFontFamily**: `string` -- **LabelFontSize**: `double` -- **LabelFontStyle**: `string` -- **LabelFontWeight**: `string` -- **LabelFormat**: `string` — Gets or sets the label format string to use for the label. -- **LabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the LabelFormat string. -- **LabelHorizontalAlignment**: `HorizontalAlignment` — Gets or sets the horizontal alignment of the {0}. -- **LabelLeftMargin**: `double` — Margin applied to the left of the {0}. -- **LabelLocation**: `AxisLabelsLocation` — Gets or sets the location of the {0}. -- **LabelMaximumExtent**: `double` — Maximum distance between the axis and the edge of the control. -- **LabelMaximumExtentPercentage**: `double` — Maximum distance between the axis and the edge of the control, relative to Chart size. -- **LabelRightMargin**: `double` — Margin applied to the right of the {0}. -- **LabelShowFirstLabel**: `bool` — Gets or sets whether the first label is displayed when the zoom level is set to 1. -- **LabelTextColor**: `string` — The color of the {0}. -- **LabelTopMargin**: `double` — Margin applied above the {0}. -- **LabelVerticalAlignment**: `VerticalAlignment` — Gets or sets the vertical alignment of the {0}. -- **LabelVisibility**: `Visibility` — Gets or sets the visibility of the {0}. -- **MajorStroke**: `string` — Gets or sets the MajorStroke property. -- **MajorStrokeDashArray**: `double[]` — Gets or sets the MajorStrokeDashArray property. -- **MajorStrokeThickness**: `double` — Gets or sets the MajorStrokeThickness property. -- **MinorStroke**: `string` — Gets or sets the MinorStroke property. -- **MinorStrokeDashArray**: `double[]` — Gets or sets the MinorStrokeDashArray property. -- **MinorStrokeThickness**: `double` — Gets or sets the MinorStrokeThickness property. -- **ParentTypeName**: `string` -- **RangeChanged**: `EventCallback` -- **RangeChangedScript**: `string` -- **RenderRequested**: `EventCallback` -- **RenderRequestedScript**: `string` -- **SeriesViewerParent**: `BaseRendererControl` -- **ShouldAutoTruncateAnnotations**: `bool` — Gets or sets whether annotations on this axis will automatically truncate themselves to avoid colliding with each other. This only works if the ShouldAvoidAnnotationCollisions property is enabled. -- **ShouldAvoidAnnotationCollisions**: `bool` — Gets or sets whether annotations should be shifted to avoid collision, even if this would result in them appearing where they shouldn't be along the scale. -- **ShouldKeepAnnotationsInView**: `bool` — ets or sets whether annotations should be kept in view, even if they aren't positioned where they should appear on the scale. -- **Strip**: `string` — Gets or sets the Strip property. -- **Stroke**: `string` — Gets or sets the Stroke property. -- **StrokeDashArray**: `double[]` — Gets or sets the StrokeDashArray property. -- **StrokeThickness**: `double` — Gets or sets the StrokeThickness property. -- **TickLength**: `double` — Gets or sets the TickLength property. -- **TickStroke**: `string` — Gets or sets the TickStroke property. -- **TickStrokeDashArray**: `double[]` — Gets or sets the TickStrokeDashArray property. -- **TickStrokeThickness**: `double` — Gets or sets the TickStrokeThickness property. -- **Title**: `string` — Gets or sets the Title property. -- **TitleAngle**: `double` — Gets or sets the angle of the {0}. -- **TitleBottomMargin**: `double` — Margin applied below the {0}. -- **TitleExtent**: `double` — Distance between the axis and the edge of the control. -- **TitleFontFamily**: `string` -- **TitleFontSize**: `double` -- **TitleFontStyle**: `string` -- **TitleFontWeight**: `string` -- **TitleHorizontalAlignment**: `HorizontalAlignment` — Gets or sets the horizontal alignment of the {0}. -- **TitleLeftMargin**: `double` — Margin applied to the left of the {0}. -- **TitleLocation**: `AxisLabelsLocation` — Gets or sets the location of the {0}. -- **TitleMaximumExtent**: `double` — Maximum distance between the axis and the edge of the control. -- **TitleMaximumExtentPercentage**: `double` — Maximum distance between the axis and the edge of the control, relative to Chart size. -- **TitlePosition**: `AxisTitlePosition` — Gets or sets the title position relative to the axis labels. -- **TitleRightMargin**: `double` — Margin applied to the right of the {0}. -- **TitleShowFirstLabel**: `bool` — Gets or sets whether the first label is displayed when the zoom level is set to 1. -- **TitleTextColor**: `string` — The color of the {0}. -- **TitleTopMargin**: `double` — Margin applied above the {0}. -- **TitleVerticalAlignment**: `VerticalAlignment` — Gets or sets the vertical alignment of the {0}. -- **TitleVisibility**: `Visibility` — Gets or sets the visibility of the {0}. -- **Type**: `string` -- **UseEnhancedIntervalManagement**: `bool` — Gets or sets whether to use more advanced heuristics when determining the initial number of labels to render, before resolving collisions, etc. -- **UsePerLabelHeightMeasurement**: `bool` — Gets or sets whether to use label height measurement when determining the initial number of labels to render, before resolving collisions, etc. -- **BindAxes**(Axes: IgbAxis[]): void -- **Dispose**(): void -- **FindByName**(name: string): object -- **GetFullRange**(): double[] -- **GetFullRangeAsync**(): Task -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **GetValueLabel**(value: double): string -- **GetValueLabelAsync**(value: double): Task — Gets the label for a data item. -- **OnInitializedAsync**(): Task -- **RenderAxis**(): void -- **RenderAxisAsync**(): Task — Renders the axis with no animation. -- **ResetCachedEnhancedInterval**(): void -- **ResetCachedEnhancedIntervalAsync**(): Task — If using enhanced interval management and precise interval fitting, this will reset the cached maximum label width, and recalculate using the current labels. -- **ScaleValue**(unscaledValue: double): double -- **ScaleValueAsync**(unscaledValue: double): Task — Scales a value from axis space into screen space. - -### [IgbAxisAnnotation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAxisAnnotation) -Represents an axis annotation - -- **constructor**(): void -- **ActualLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **AxisParent**: `BaseRendererElement` -- **Background**: `string` — Gets or sets the background to use for tha axis annotation box. -- **BackgroundCornerRadius**: `double` — Gets or sets the corner radius to use for the axis annotation borders. -- **BackgroundPaddingBottom**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **BackgroundPaddingLeft**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **BackgroundPaddingRight**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **BackgroundPaddingTop**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **BadgeBackground**: `string` — Gets or sets the background color to use for the badge inside the axis annotation box. -- **BadgeCornerRadius**: `double` — Gets or sets the corner radius for the badge inside the axis annotation box. -- **BadgeImagePath**: `string` — Gets or sets the image path to use for the badge. -- **BadgeMargin**: `double` — Gets or sets the spacing between the badge and text inside the axis annotation box. -- **BadgeOutline**: `string` — Gets or sets the outline color to use for the badge inside the axis annotation box. -- **BadgeOutlineThickness**: `double` — Gets or sets the outline thickness for the badge inside the axis annotation box. -- **BadgeSize**: `double` — Gets or sets the size of the badge inside the axis annotation box. -- **ContentLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **FormatLabelScript**: `string` — Provides a means of setting FormatLabel in the JavaScript environment. -- **IsBadgeEnabled**: `bool` — Gets or sets whether the badge is enabled in the annotation. -- **IsPillShaped**: `bool` — Gets or sets whether the annotation is pill shaped. This will automatically adjust the background corner radius to make it appear pill shaped. -- **LabelFormat**: `string` — Gets or sets the label format string to use for the label. -- **LabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the LabelFormat string. -- **Outline**: `string` — Gets or sets the Outline to use for tha axis annotation box. -- **ParentTypeName**: `string` -- **StrokeThickness**: `double` — Gets or sets the border stroke thickness to use for tha axis annotation box. -- **Text**: `string` — Gets or sets the text that should be displayed for the annotation. Leave null to display the value automatically. -- **TextColor**: `string` — Gets or sets the color to use for the text in the annotation. -- **Type**: `string` -- **Value**: `object` — Gets or sets the value at which this annotation is displayed on the axis. -- **Dispose**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task -- **ResetCachedExtent**(): void -- **ResetCachedExtentAsync**(): Task -- **ResolveLabelValue**(): string -- **ResolveLabelValueAsync**(): Task - -### [IgbAxisAnnotationCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAxisAnnotationCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbAxisCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAxisCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbAxisMatcher](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAxisMatcher) - -- **constructor**(): void -- **AxisType**: `string` — If set, tries to match an Axis based on its type, to be used with the typed index, if desired. -- **Index**: `int` — If set, tries to match a Axis based on index -- **MemberPath**: `string` — If set, tries to match a Axis based on a member path, combined with MemberPathType. -- **MemberPathType**: `string` — Combined with MemberPath allows you to select a Axis by member path. -- **Title**: `string` — If set, tries to match a Axis based on its title. -- **Type**: `string` -- **TypedIndex**: `int` — If set, indicates that the nth axis of a type should be used. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAxisMatcherModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAxisMatcherModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbAxisMouseEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAxisMouseEventArgs) - -- **constructor**(): void -- **Axis**: `IgbAxis` -- **AxisDateValue**: `DateTime` -- **AxisScript**: `string` — Provides a means of setting Axis in the JavaScript environment. -- **AxisValue**: `double` -- **ChartPosition**: `Point` -- **Label**: `string` -- **LabelContext**: `object` -- **LabelContextScript**: `string` — Provides a means of setting LabelContext in the JavaScript environment. -- **PlotAreaPosition**: `Point` -- **Type**: `string` -- **WorldPosition**: `Point` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAxisRangeChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAxisRangeChangedEventArgs) -Provides data for Axis RangeChanged events. - -- **constructor**(): void -- **MaximumValue**: `double` — Gets the maximum value after the range changed. The reported maximum is the effective, not the set value. -- **MinimumValue**: `double` — Gets the minimum value after the range changed. The reported minimum is the effective, not the set value. -- **OldMaximumValue**: `double` — Gets the maximum value before the range changed. The reported maximum is the effective, not the set value. -- **OldMinimumValue**: `double` — Gets the minimum value before the range changed. The reported minimum is the effective, not the set value. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbAzureMapsImagery](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAzureMapsImagery) -UI element class used to display AzureMaps imagery in the GeographicMap. - -- **constructor**(): void -- **ApiKey**: `string` — Gets or sets a subscription key required by the Azure Maps imagery service. For more information see https://learn.microsoft.com/en-us/azure/azure-maps/azure-maps-authentication#shared-key-authentication. -- **ApiVersion**: `string` — Gets or sets the API version used by the Azure Maps imagery service. For more information see Render API version in https://learn.microsoft.com/en-us/azure/azure-maps/rest-api-azure-maps#latest-release. -- **CultureName**: `string` — Gets or sets the culture name for this tile source. -- **ImageryStyle**: `AzureMapsImageryStyle` — Gets or sets a map style of the Azure Maps imagery tiles. For example: Road map style. -- **LocalizedView**: `string` — Gets or sets a string that specifies which maps to show for geopolitically disputed regions. For more information see https://learn.microsoft.com/en-us/rest/api/maps/render/get-map-tile#localizedmapview. -- **Timestamp**: `DateTime` — Gets or sets a specific date and time for the map. Note that not all tilesets support this option and those that do might have restrictions. For more information see https://learn.microsoft.com/en-us/rest/api/maps/render/get-map-tile#uri-parameters. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbAzureMapsImageryModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbAzureMapsImageryModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBadge](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBadge) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Dot**: `bool` — Sets whether to render a dot type badge. When enabled, the badge appears as a small dot without any content. false -- **Outlined**: `bool` — Sets whether to draw an outlined version of the badge. false -- **Shape**: `BadgeShape` — The shape of the badge. 'rounded' -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Variant**: `StyleVariant` — The type (style variant) of the badge. 'primary' -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbBadgeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBadgeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBanner](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBanner) -The igc-banner component displays important and concise message(s) for a user to address, that is specific to a page or feature. - -- **constructor**(): void -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Open**: `bool` — Determines whether the banner is being shown/hidden. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **Hide**(): bool -- **HideAsync**(): Task — Hides the banner if not already hidden. Returns true when the animation has completed. -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(): bool -- **ShowAsync**(): Task — Shows the banner if not already shown. Returns true when the animation has completed. -- **Toggle**(): bool -- **ToggleAsync**(): Task — Toggles between shown/hidden state. Returns true when the animation has completed. - -### [IgbBannerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBannerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBarFragment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBarFragment) -Represents one part of a StackedBarSeries. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetExactItemIndex**(world: Point): double -- **GetExactItemIndexAsync**(world: Point): Task — Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex. -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetSeriesValueBoundingBox**(world: Point): Rect -- **GetSeriesValueBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. - -### [IgbBarFragmentModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBarFragmentModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBarSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBarSeries) -Represents a IgbDataChart bar series. - -- **constructor**(): void -- **RadiusX**: `double` — Gets or sets the x-radius of the ellipse that is used to round the corners of the bar. -- **RadiusY**: `double` — Gets or sets the y-radius of the ellipse that is used to round the corners of the bar. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItemSpan**(): double -- **GetItemSpanAsync**(): Task — For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. -- **GetSeriesValueBoundingBox**(world: Point): Rect -- **GetSeriesValueBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the series to display the item for the specified data item. - -### [IgbBarSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBarSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBaseAlertLike](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseAlertLike) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **DisplayTime**: `double` — Determines the duration in ms in which the component will be visible. -- **KeepOpen**: `bool` — Determines whether the component should close after the displayTime is over. -- **Open**: `bool` — Whether the component is in shown state. -- **Position**: `AbsolutePosition` — Sets the position of the component in the viewport. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **FindByName**(name: string): object -- **Hide**(): bool -- **HideAsync**(): Task — Closes the component. -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(): bool -- **ShowAsync**(): Task — Opens the component. -- **Toggle**(): bool -- **ToggleAsync**(): Task — Toggles the open state of the component. - -### [IgbBaseAlertLikeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseAlertLikeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBaseComboBoxLike](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseComboBoxLike) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **EmitEvent**: `object` -- **KeepOpenOnOutsideClick**: `bool` — Whether the component dropdown should be kept open on clicking outside of it. -- **KeepOpenOnSelect**: `bool` — Whether the component dropdown should be kept open on selection. -- **Open**: `bool` — Sets the open state of the component. -- **Type**: `string` -- **FindByName**(name: string): object -- **Hide**(): bool -- **HideAsync**(): Task — Hides the component. -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(): bool -- **ShowAsync**(): Task — Shows the component. -- **Toggle**(): bool -- **ToggleAsync**(): Task — Toggles the open state of the component. - -### [IgbBaseComboBoxLikeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseComboBoxLikeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBaseDataSource](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseDataSource) -Provides a base implementation of IDataSource that data source implementations can further extend. - -- **constructor**(): void -- **ActualCount**: `int` — Gets the current actual full count of the items in the data source. -- **DeferAutoRefresh**: `bool` — Gets or sets whether the auto refresh mechanism of the data source is currently defered. The data source will not react to most setting changes while this is set to true an will instead defer processing. Setting this value to false will queue a new refresh. -- **FirstVisibleIndexRequested**: `int` — Gets or sets which index consumers of the data source desire to be the current first visible index. A grid, for example, would indicate the current visible top row, and update this as that changes. -- **IncludeSummaryRowsInSection**: `bool` — Gets or sets whether the data source should include summary rows inside the group when summaries are present. -- **IsBatchingEnabled**: `bool` — Gets or sets whether batch edits are enabled. -- **IsReadOnly**: `bool` — Gets or sets whether the data source is read-only or not. -- **IsSectionCollapsable**: `bool` — Gets or sets if sections are collapsable. -- **IsSectionContentVisible**: `bool` — Gets or sets whether content besides the section headers are displayed. -- **IsSectionExpandedDefault**: `bool` — Gets or sets whether sections default to expanded or collapsed when they are created. -- **IsSectionHeaderNormalRow**: `bool` — Gets or sets whether the section headers are treated as normal rows. -- **IsSectionSummaryRowsAtBottom**: `bool` — Gets or sets whether the summary rows within a section are placed at the bottom of the section, otherwise they will be placed at the top. -- **LastVisibleIndexRequested**: `int` — Gets or sets which index consumers of the data source desire to be the current last visible index. A grid, for example, would indicate the current visible top row, and update this as that changes. -- **PrimaryKey**: `string[]` — Gets or sets a list of property references that indicate the user provided primary key of the items in the data source. Consumers of the data source will often need to uniquely identify items in the data source. For this purpose a primary key should be specified. -- **PropertiesRequested**: `string[]` — Gets or sets a list of property references for the properties desired by the consumer of the data source. If known, the data source may take steps to request only those properties, or to ensure that those properties are included, rather than the default behavior for this type of data source. -- **PropertiesRequestedChanged**: `EventCallback` -- **PropertiesRequestedChangedScript**: `string` -- **RootSummariesChanged**: `EventCallback` -- **RootSummariesChangedScript**: `string` -- **RowExpansionChanged**: `EventCallback` -- **RowExpansionChangedScript**: `string` -- **SchemaChanged**: `EventCallback` -- **SchemaChangedScript**: `string` -- **SchemaIncludedProperties**: `string[]` — Gets or sets what properties should be included when resolving the datasource schema. If null, all properties are included. -- **SectionHeaderDisplayMode**: `DataSourceSectionHeaderDisplayMode` — Gets or sets how section headers are displayed. -- **ShouldEmitSectionFooters**: `bool` -- **ShouldEmitSectionHeaders**: `bool` -- **ShouldEmitShiftedRows**: `bool` -- **ShouldEmitSummaryRows**: `bool` -- **Type**: `string` -- **AcceptPendingCommit**(commitID: int): void -- **AcceptPendingCommitAsync**(commitID: int): Task — Accepts a commit with the provided ID. -- **AcceptPendingTransaction**(transactionID: int): void -- **AcceptPendingTransactionAsync**(transactionID: int): Task — Save a specific pending transaction. -- **AddItem**(item: object): void -- **AddItemAsync**(item: object): Task -- **CancelEdits**(): void -- **CancelEditsAsync**(): Task — Cancels any batched edits that may exist. -- **ClearPinnedRows**(): void -- **ClearPinnedRowsAsync**(): Task -- **Clone**(): DataSource -- **CloneAsync**(): Task — Clones this data source instance, copying the summary, grouping, filter and sorting settings into the new instance. -- **CloneProperties**(dataSource: DataSource): void -- **ClonePropertiesAsync**(dataSource: DataSource): Task — Clones the properties over to the provided datasource. -- **CommitEdits**(isPending: bool): int -- **CommitEditsAsync**(isPending: bool): Task — Commit the current edits to the datasource. -- **FindByName**(name: string): object -- **FlushAutoRefresh**(): void -- **FlushAutoRefreshAsync**(): Task — Called to make sure a queued refresh of the data source has been applied before continuing. Should only be needed if you are trying to synchronously examine the results of changing settings on the data source. Note, for a virtual data source, the data source itself may be waiting for other synchronous requests to actualize data. This call will not wait for those, but will only make sure the appropriate requests are in flight from the settings changes -- **GetAggregatedChanges**(commitID: int): IgbDataSourceAggregatedResult[] -- **GetAggregatedChangesAsync**(commitID: int): Task — Returns a set of changes that have been made to the data however have not been committed yet. -- **GetIsRowExpandedAtIndex**(rowIndex: int): bool -- **GetIsRowExpandedAtIndexAsync**(rowIndex: int): Task — Gets the expansion state for a row. -- **GetItemAtIndex**(index: int): object -- **GetItemAtIndexAsync**(index: int): Task — Returns the item at the specific index in the data source. This index is based on the data source's current view of the data, not the actual underlying indexes of the original source. -- **GetItemFromKey**(key: object[]): object -- **GetItemFromKeyAsync**(key: object[]): Task -- **GetItemProperty**(item: object, propertyName: string): object -- **GetItemPropertyAsync**(item: object, propertyName: string): Task -- **GetItemPropertyAtIndex**(index: int, valueName: string): object -- **GetItemPropertyAtIndexAsync**(index: int, valueName: string): Task -- **GetMainValuePath**(rowType: DataSourceRowType): string -- **GetMainValuePathAsync**(rowType: DataSourceRowType): Task -- **GetRootSummaryResults**(): IgbDataGridSummaryResult[] -- **GetRootSummaryResultsAsync**(): Task — Gets the summary results for the root level. -- **GetRootSummaryRowCount**(): int -- **GetRootSummaryRowCountAsync**(): Task — Gets the number of summary rows at the root level. -- **GetRowCount**(): int -- **GetRowCountAsync**(): Task — Gets the current actual full count of the items in the data source. -- **GetRowLevel**(rowIndex: int): int -- **GetRowLevelAsync**(rowIndex: int): Task — Gets the hierarchy level of the row. -- **GetRowType**(rowIndex: int): DataSourceRowType -- **GetRowTypeAsync**(rowIndex: int): Task -- **GetSectionSummaryResults**(sectionIndex: int): IgbDataGridSummaryResult[][] -- **GetSectionSummaryResultsAsync**(sectionIndex: int): Task — Gets the summary results for a specific section. -- **GetStickyRowPriority**(row: int): int -- **GetStickyRowPriorityAsync**(row: int): Task -- **GetTransactionErrorByID**(transactionID: int): string -- **GetTransactionErrorByIDAsync**(transactionID: int): Task — Returns an error, if any, associated with a specific transaction. -- **GetTransactionErrorByKey**(key: object[], propertyPath: string): string -- **GetTransactionErrorByKeyAsync**(key: object[], propertyPath: string): Task -- **GetTransactionID**(key: object[], propertyPath: string): int -- **GetTransactionIDAsync**(key: object[], propertyPath: string): Task -- **HasAdd**(item: object): bool -- **HasAddAsync**(item: object): Task — Returns whether the item is an uncommitted add. -- **HasDelete**(key: object[]): bool -- **HasDeleteAsync**(key: object[]): Task -- **HasEdit**(key: object[], propertyPath: string): bool -- **HasEditAsync**(key: object[], propertyPath: string): Task -- **IndexOfItem**(item: object): int -- **IndexOfItemAsync**(item: object): Task — Called to return the index for an item contained in the data source, or -1, if the item can't be found, or this action isn't currently supported. -- **IndexOfKey**(key: object[]): int -- **IndexOfKeyAsync**(key: object[]): Task -- **IsExclusivelySticky**(row: int): bool -- **IsExclusivelyStickyAsync**(row: int): Task -- **IsPendingCommit**(commitID: int): bool -- **IsPendingCommitAsync**(commitID: int): Task — Returns whether a commit is pending or not. -- **IsPendingTransaction**(transactionID: int): bool -- **IsPendingTransactionAsync**(transactionID: int): Task — Returns whether a transaction pending or not. -- **IsPlaceholderItem**(index: int): bool -- **IsPlaceholderItemAsync**(index: int): Task — Returns true if the item at the requested index is a placeholder item and has not been actualized. -- **IsRowPinned**(row: int): bool -- **IsRowPinnedAsync**(row: int): Task -- **IsRowSpanning**(rowType: DataSourceRowType): bool -- **IsRowSpanningAsync**(rowType: DataSourceRowType): Task -- **NotifyClearItems**(): void -- **NotifyClearItemsAsync**(): Task — Manually notifies the data source that the data it has bound to has been cleared and needs to be re-examined. This should not be necessary to call if the data that the data source is bound to is already observable. -- **NotifyInsertItem**(index: int, newItem: object): void -- **NotifyInsertItemAsync**(index: int, newItem: object): Task -- **NotifyRemoveItem**(index: int, oldItem: object): void -- **NotifyRemoveItemAsync**(index: int, oldItem: object): Task -- **NotifySetItem**(index: int, oldItem: object, newItem: object): void -- **NotifySetItemAsync**(index: int, oldItem: object, newItem: object): Task -- **PinRow**(key: object[]): void -- **PinRowAsync**(key: object[]): Task -- **QueueAutoRefresh**(): void -- **QueueAutoRefreshAsync**(): Task — Called to manually queue a refresh of the data source. -- **Redo**(): void -- **RedoAsync**(): Task — Redo the last undo. -- **Refresh**(): void -- **RefreshAsync**(): Task — Called to synchronously refresh the data source. -- **RejectPendingCommit**(commitID: int): void -- **RejectPendingCommitAsync**(commitID: int): Task — Cancel a commit with the provided ID. -- **RejectPendingTransaction**(transactionID: int): void -- **RejectPendingTransactionAsync**(transactionID: int): Task — Rejects a pending transaction. -- **RemoveItem**(item: object): void -- **RemoveItemAsync**(item: object): Task — Removes an item from the datasource. -- **RemoveItemByKey**(key: object[]): void -- **RemoveItemByKeyAsync**(key: object[]): Task -- **ResolveSchemaPropertyType**(propertyPath: string): DataSourceSchemaPropertyType -- **ResolveSchemaPropertyTypeAsync**(propertyPath: string): Task — Resolve a property or property path to its value type. -- **SetCustomizedStringAsync**(language: string, json: string): Task — Provide a new set of localized strings to use for a given languange. -- **SetCustomizedStringAsync**(language: string, id: string, value: string): Task — Provide a new set of localized strings to use for a given languange. -- **SetIsRowExpandedAtIndex**(rowIndex: int, isExpanded: bool): void -- **SetIsRowExpandedAtIndexAsync**(rowIndex: int, isExpanded: bool): Task -- **SetTransactionError**(transactionID: int, message: string): void -- **SetTransactionErrorAsync**(transactionID: int, message: string): Task -- **Undo**(): void -- **UndoAsync**(): Task — Undo the last edit. -- **UnpinRow**(key: object[]): void -- **UnpinRowAsync**(key: object[]): Task -- **UpdatePropertyAtKey**(key: object[], propertyPath: string, value: object, isPending: bool): int -- **UpdatePropertyAtKeyAsync**(key: object[], propertyPath: string, value: object, isPending: bool): Task - -### [IgbBaseEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseEventArgs) - -- **constructor**(): void -- **Detail**: `IgbBaseEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbBaseEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseEventArgsDetail) - -- **constructor**(): void -- **Owner**: `object` — Provides reference to the owner component. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbBaseExporter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseExporter) - -- **constructor**(): void -- **ColumnExporting**: `EventCallback` -- **ColumnExportingScript**: `string` -- **ExportEnded**: `EventCallback` -- **ExportEndedScript**: `string` -- **RowExporting**: `EventCallback` -- **RowExportingScript**: `string` -- **Type**: `string` -- **ExportData**(data: object[], options: IgbExporterOptionsBase): void -- **ExportDataAsync**(data: object[], options: IgbExporterOptionsBase): Task -- **ExportGrid**(grid: object, options: IgbExporterOptionsBase): void -- **ExportGridAsync**(grid: object, options: IgbExporterOptionsBase): Task -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbBaseGenericDataSource](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseGenericDataSource) -The base class for generic data sources. - -- **constructor**(): void -- **FilterExpressions**: `IgbFilterExpressionCollection` — Gets the current filter that is applied to the data source. -- **GroupDescriptions**: `IgbDataSourceGroupDescriptionCollection` — Gets the current grouping that is applied to the data source. -- **SortDescriptions**: `IgbDataSourceSortDescriptionCollection` — Gets the current sort that is applied to the data source. -- **SummaryDescriptions**: `IgbDataSourceSummaryDescriptionCollection` — Gets the current summaries that are applied to the data source. -- **Type**: `string` -- **FindByName**(name: string): object -- **GetCurrentFilterExpressions**(): IgbFilterExpressionCollection -- **GetCurrentFilterExpressionsAsync**(): Task -- **GetCurrentGroupDescriptions**(): IgbDataSourceGroupDescriptionCollection -- **GetCurrentGroupDescriptionsAsync**(): Task -- **GetCurrentSortDescriptions**(): IgbDataSourceSortDescriptionCollection -- **GetCurrentSortDescriptionsAsync**(): Task -- **GetCurrentSummaryDescriptions**(): IgbDataSourceSummaryDescriptionCollection -- **GetCurrentSummaryDescriptionsAsync**(): Task -- **QueueAutoRefresh**(): void -- **QueueAutoRefreshAsync**(): Task — Called to manually queue a refresh of the data source. - -### [IgbBaseOptionLike](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseOptionLike) - -- **constructor**(): void -- **Active**: `bool` — Whether the item is active. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — Whether the item is disabled. -- **Selected**: `bool` — Whether the item is selected. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `string` — The current value of the item. If not specified, the element's text content is used. -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbBaseOptionLikeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseOptionLikeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBaseSearchInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseSearchInfo) - -- **constructor**(): void -- **CaseSensitive**: `bool` -- **Content**: `string` -- **ExactMatch**: `bool` -- **MatchCount**: `double` -- **SearchText**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbBaseToolbarColumnActionsDirective](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseToolbarColumnActionsDirective) - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbBaseToolbarColumnActionsDirectiveModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseToolbarColumnActionsDirectiveModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBaseToolbarDirective](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBaseToolbarDirective) -Base class for the pinning/hiding column and exporter actions. - -- **constructor**(): void -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **ColumnListHeight**: `string` — Sets the height of the column list in the dropdown. -- **ColumnToggle**: `EventCallback` -- **ColumnToggleScript**: `string` -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **OverlaySettings**: `IgbOverlaySettings` — Sets overlay settings -- **Prompt**: `string` — The placeholder text for the search input. -- **Title**: `string` — Title text for the column action component -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbBingMapsMapImagery](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBingMapsMapImagery) -UI element class used to display BingMapsMap imagery in the IgbGeographicMap. - -- **constructor**(): void -- **ActualBingImageryRestUri**: `string` — Gets or sets the Actual Bing Imagery Rest Uri. -- **ActualSubDomains**: `string[]` — Gets or sets the actual collection of image uri subdomains. -- **ActualTilePath**: `string` — Gets or sets the actual map tile image uri. -- **ApiKey**: `string` — Gets or sets an API key required by the Bing Maps imagery service. This key must be obtained from the http://www.bingmapsportal.com website. -- **BingImageryRestUri**: `string` — Gets or sets the Bing Imagery Rest Uri. -- **CultureName**: `string` — Gets or sets the culture name for this tile source. -- **ImageryStyle**: `BingMapsImageryStyle` — Gets or sets a map style of the Bing Maps imagery tiles. For example: Aerial, AerialWithLabels, or Road map style. -- **IsDeferredLoad**: `bool` — Gets or sets whether the Bing Maps service should be auto-initialized upon valid property values. -- **IsInitialized**: `bool` — Gets a status whether the Bing Maps service is initialized. -- **SubDomains**: `string[]` — Gets or sets the collection of image uri subdomains. -- **TilePath**: `string` — Gets or sets the map tile image uri. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **RequestMapSettings**(): void -- **RequestMapSettingsAsync**(): Task — Will Connect to the Bing Rest API and retrieve the required TilePath and Subdomains from the service. This requires a valid API key to already be set. - -### [IgbBingMapsMapImageryModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBingMapsMapImageryModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBollingerBandWidthIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBollingerBandWidthIndicator) -Represents a IgbDataChart Bollinger Bandwidth indicator series. - -- **constructor**(): void -- **Multiplier**: `double` — Gets or sets the multiplier for the Bollinger Band width. The typical, and initial, value for Bollinger Band width multiplier is 2. -- **Period**: `int` — Gets or sets the moving average period for the Bollinger Band Width Indicator. The typical, and initial, value for CCI periods is 20. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbBollingerBandWidthIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBollingerBandWidthIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBollingerBandsOverlay](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBollingerBandsOverlay) -Represents a IgbDataChart Bollinger Bands financial overlay series. - -- **constructor**(): void -- **Multiplier**: `double` — Gets or sets the moving average period for the current BollingerBandOverlay object. The typical, and initial, value for Bollinger band multipliers is 2. -- **Period**: `int` — Gets or sets the moving average period for the current BollingerBandOverlay object. The typical, and initial, value for Bollinger band periods is 14. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetNextOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetNextOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetPreviousOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetPreviousOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetSeriesValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task - -### [IgbBollingerBandsOverlayModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBollingerBandsOverlayModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBrushScale](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBrushScale) -Represents a base class for brush scales. - -- **constructor**(): void -- **Brushes**: `string` — Gets the brushes collection used by this scale. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetBrush**(index: int): string -- **GetBrushAsync**(index: int): Task — Gets a brush from the brushes collection by index. -- **NotifySeries**(): void -- **NotifySeriesAsync**(): Task — Notify attached series about changes to this scale -- **RegisterSeries**(series: IgbSeries): void -- **RegisterSeriesAsync**(series: IgbSeries): Task — Registers a series with the scale. Under normal circumstances you should not need to call this manually. -- **UnregisterSeries**(series: IgbSeries): void -- **UnregisterSeriesAsync**(series: IgbSeries): Task — Unregisters a series with the scale. Under normal circumstances you should not need to call this manually. - -### [IgbBrushScaleModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBrushScaleModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBubbleSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBubbleSeries) -Represents a IgbDataChart bubble series. - -- **constructor**(): void -- **FillMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series' fill value in the Data Legend. -- **FillMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series' fill value in the Data Legend. -- **FillMemberPath**: `string` — Gets or sets the fill mapping property for the current series object. -- **FillScale**: `IgbBrushScale` — Gets or sets the brush scale for the fill brush of markers. -- **FillScaleUseGlobalValues**: `bool` — Gets or sets whether or not the FillScale uses global min/max values of FillMemberPath from multiple series. This setting applies only if multiple series are using the same FillScale. -- **LabelMemberPath**: `string` — Gets or sets the Label mapping property for the current series object. -- **MarkerBrushBrightness**: `double` — Gets or sets brightness of the marker fill. Using negative value will change marker fill to darker color and positive value will change marker fill to brighter color Note you can use any values between minimum value of -1 (darkest fill) and maximum value of 1 (brightest fill) -- **MarkerOutlineBrightness**: `double` — Gets or sets brightness of the marker outline. Using negative value will change marker outline to darker color and positive value will change marker outline to brighter color Note you can use any values between minimum value of -1 (darkest outline) and maximum value of 1 (brightest outline) -- **MarkerOutlineUsesFillScale**: `bool` — Gets or sets whether or not the marker outline should use FillScale like the marker fill does. This setting applies only if the current series has a FillScale set and it overrides MarkerOutline setting. -- **RadiusMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series' radius value in the Data Legend. -- **RadiusMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series' radius value in the Data Legend. -- **RadiusMemberPath**: `string` — Gets or sets the radius mapping property for the current series object. -- **RadiusScale**: `IgbSizeScale` — Gets or sets the radius size scale for the bubbles. -- **RadiusScaleUseGlobalValues**: `bool` — Gets or sets the whether or not the RadiusScale uses global values of RadiusMemberPath from multiple series. This setting applies only if multiple series are using the same RadiusScale. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. - -### [IgbBubbleSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBubbleSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBulletGraph](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBulletGraph) -Represents a bullet graph. - -- **constructor**(): void -- **ActualHighlightValueDisplayMode**: `HighlightedValueDisplayMode` — Gets whether and how to display the highlighted value. -- **ActualHighlightValueOpacity**: `double` — Gets the actual opacity of the primary needle while highlighting -- **ActualLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ActualMaximumValue**: `double` — Gets the resolved maximum value of the scale. -- **ActualMaximumValueChanged**: `Action` -- **ActualMaximumValueChangedScript**: `string` -- **ActualMinimumValue**: `double` — Gets the resolved minimum value of the scale. -- **ActualMinimumValueChanged**: `Action` -- **ActualMinimumValueChangedScript**: `string` -- **ActualPixelScalingRatio**: `double` — Gets the actual pixel scaling ratio used to affect the pixel density of the control. -- **ActualRanges**: `IgbLinearGraphRangeCollection` -- **AlignLabel**: `EventCallback` -- **AlignLabelScript**: `string` -- **BackingBrush**: `string` — Gets or sets the brush to use to fill the backing of the bullet graph. -- **BackingInnerExtent**: `double` — Gets or sets the inner extent of the bullet graph backing. -- **BackingOuterExtent**: `double` — Gets or sets the outer extent of the bullet graph backing. -- **BackingOutline**: `string` — Gets or sets the brush to use for the outline of the backing. -- **BackingStrokeThickness**: `double` — Gets or sets the stroke thickness of the backing outline. -- **ContentLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ContentRanges**: `IgbLinearGraphRangeCollection` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Font**: `string` — Gets or sets the font. -- **FontBrush**: `string` — Gets or sets the brush to use for the label font. -- **FormatLabel**: `EventCallback` -- **FormatLabelScript**: `string` -- **HighlightValue**: `double` — Gets or sets the highlight value at which to point the secondary needle of the gauge. -- **HighlightValueDisplayMode**: `HighlightedValueDisplayMode` — Gets or sets whether and how to display the highlighted value. -- **HighlightValueOpacity**: `double` — Gets or sets the opacity of the primary needle while highlighting -- **Interval**: `double` — Gets or sets the interval to use for the scale. -- **IsScaleInverted**: `bool` — Gets or sets a value indicating whether the scale is inverted. When the scale is inverted the direction in which the scale values increase is right to left. -- **LabelExtent**: `double` — Gets or sets the position at which to put the labels as a value from 0 to 1, measured from the bottom of the scale. Values further from zero than 1 can be used to hide the labels of the bullet graph. -- **LabelFormat**: `string` — Gets or sets the label composite format used when creating label values. -- **LabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the LabelFormat string. -- **LabelInterval**: `double` — Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale. -- **LabelsPostInitial**: `double` — A value to start adding labels, added to the scale's MinimumValue. -- **LabelsPreTerminal**: `double` — A value to stop adding labels, subtracted from the scale's MaximumValue. -- **LabelsVisible**: `bool` — Gets or sets whether the labels are visible in the gauge. -- **MaximumValue**: `double` — Gets or sets the maximum value of the scale. -- **MergeViewports**: `bool` — Gets or sets whether the scale viewport will be merged with backing viewport. -- **MinimumValue**: `double` — Gets or sets the minimum value of the scale. -- **MinorTickBrush**: `string` — Gets or sets the brush to use for the minor tickmarks. -- **MinorTickCount**: `double` — Gets or sets the number of minor tickmarks to place between major tickmarks. -- **MinorTickEndExtent**: `double` — Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **MinorTickStartExtent**: `double` — Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **MinorTickStrokeThickness**: `double` — Gets or sets the stroke thickness to use when rendering minor ticks. -- **Orientation**: `LinearScaleOrientation` — Gets or sets the orientation of the scale. -- **ParentTypeName**: `string` -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **RangeBrushes**: `string` — Gets or sets a collection of brushes to be used as the palette for bullet graph ranges. -- **RangeInnerExtent**: `double` — Gets or sets the position at which to start rendering the ranges, measured from the front/bottom of the control as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **RangeOuterExtent**: `double` — Gets or sets the position at which to stop rendering the range as a value from 0 to 1 measured from the front/bottom of the bullet graph. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **RangeOutlines**: `string` — Gets or sets a collection of brushes to be used as the palette for bullet graph outlines. -- **Ranges**: `IgbLinearGraphRangeCollection` — Gets or sets the scale ranges to render on the bullet graph. -- **ScaleBackgroundBrush**: `string` — Gets or sets the background brush for the scale. -- **ScaleBackgroundOutline**: `string` — Gets or sets the background outline for the scale. -- **ScaleBackgroundThickness**: `double` — Gets or sets the background outline thickness for the scale. -- **ScaleEndExtent**: `double` — Gets or sets the position at which to stop rendering the scale as a value from 0 to 1, measured from the front/bottom of the bullet graph. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **ScaleStartExtent**: `double` — Gets or sets the position at which to start rendering the scale, measured from the front/bottom of the bullet graph as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **ShowToolTip**: `bool` — Gets or sets a value indicating whether tooltips are enabled. -- **ShowToolTipTimeout**: `int` — Gets or sets the time in milliseconds that tooltip appearance is delayed with. -- **TargetValue**: `double` — Gets or sets the value indicated by the target value bar. -- **TargetValueBreadth**: `double` — Get or sets the breadth of the target value element. -- **TargetValueBrush**: `string` — Gets or sets the brush to use when rendering the fill of the comparative marker. -- **TargetValueInnerExtent**: `double` — Gets or sets the position at which to start rendering the target value, measured from the front/bottom of the control as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **TargetValueName**: `string` — Gets or sets the name used for the target value. The name is displayed in the default target value tooltip. -- **TargetValueOuterExtent**: `double` — Gets or sets the position at which to start rendering the target value, measured from the front/bottom of the control as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **TargetValueOutline**: `string` — Gets or sets the brush to use when rendering the outline of the target value. -- **TargetValueStrokeThickness**: `double` — Gets or sets the stroke thickness of the outline of the target value bar. -- **TickBrush**: `string` — Gets or sets the brush to use for the major tickmarks. -- **TickEndExtent**: `double` — Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **TickStartExtent**: `double` — Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the bullet graph. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **TickStrokeThickness**: `double` — Gets or sets the stroke thickness to use when rendering ticks. -- **TicksPostInitial**: `double` — A value to start adding tickmarks, added to the scale's MinimumValue. -- **TicksPreTerminal**: `double` — A value to stop adding tickmarks, subtracted from the scale's MaximumValue. -- **TransitionDuration**: `int` — Gets or sets the number of milliseconds over which changes to the bullet graph should be animated. -- **TransitionProgress**: `double` — Gets the transition progress of the animation when the control is animating. -- **Type**: `string` -- **Value**: `double` — Gets or sets the value at which the bar ends. -- **ValueBrush**: `string` — Gets or sets the brush to use for the actual value element. -- **ValueInnerExtent**: `double` — Gets or sets the position at which to start rendering the actual value geometries, measured from the front/bottom of the bullet graph as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **ValueName**: `string` — Gets or sets the name used for actual value. -- **ValueOuterExtent**: `double` — Gets or sets the position at which to stop rendering the actual value geometries as a value from 0 to 1 measured from the front/bottom of the bullet graph. Values further from zero than 1 can be used to make this extend further than the normal size of the bullet graph. -- **ValueOutline**: `string` — Gets or sets the brush to use for the outline of actual value element. -- **ValueStrokeThickness**: `double` — Gets or sets the stroke thickness to use when rendering single actual value element. -- **ContainerResized**(): void -- **ContainerResizedAsync**(): Task — Notify that the container has resized. -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Returns visuals as a serialized string. -- **FindByName**(name: string): object -- **Flush**(): void -- **FlushAsync**(): Task — Use to force the bullet graph to finish any deferred work before printing or evaluating its visual. -- **GetCurrentActualMaximumValue**(): double -- **GetCurrentActualMaximumValueAsync**(): Task -- **GetCurrentActualMinimumValue**(): double -- **GetCurrentActualMinimumValueAsync**(): Task -- **GetCurrentHighlightValue**(): double -- **GetCurrentHighlightValueAsync**(): Task -- **GetValueForPoint**(point: Point): double -- **GetValueForPointAsync**(point: Point): Task — Gets the value for the main scale of the bullet graph for a given point within the bounds of the bullet graph. -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task — Provide a container for the bullet graph. -- **StyleUpdated**(): void -- **StyleUpdatedAsync**(): Task — Notify that the bullet graph styling has updated. - -### [IgbBulletGraphCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBulletGraphCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbBulletGraphModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbBulletGraphModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbButton](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbButton) -Represents a clickable button, used to submit forms or anywhere in a document for accessible, standard button functionality. - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Variant**: `ButtonVariant` — Sets the variant of the button. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbButtonBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbButtonBase) - -- **constructor**(): void -- **Blur**: `EventCallback` -- **BlurScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — The disabled state of the component -- **DisplayType**: `ButtonBaseType` — The type of the button. Defaults to button. -- **Download**: `string` — Prompts to save the linked URL instead of navigating to it. -- **Focus**: `EventCallback` -- **FocusScript**: `string` -- **Href**: `string` — The URL the button points to. -- **Rel**: `string` — The relationship of the linked URL. See https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types -- **SupportsVisualChildren**: `bool` -- **Target**: `ButtonBaseTarget` — Where to display the linked URL, as the name for a browsing context. -- **Type**: `string` -- **UseDirectRender**: `bool` -- **BlurComponent**(): void -- **BlurComponentAsync**(): Task — Removes focus from the button. -- **Click**(): void -- **ClickAsync**(): Task — Simulates a mouse click on the element -- **FindByName**(name: string): object -- **FocusComponent**(options: IgbFocusOptions): void -- **FocusComponentAsync**(options: IgbFocusOptions): Task — Sets focus in the button. -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbButtonBaseModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbButtonBaseModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbButtonGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbButtonGroup) -The igc-button-group groups a series of igc-toggle-buttons together, exposing features such as layout and selection. - -- **constructor**(): void -- **Alignment**: `ContentOrientation` — Sets the orientation of the buttons in the group. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Deselect**: `EventCallback` -- **DeselectScript**: `string` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — Disables all buttons inside the group. -- **Select**: `EventCallback` -- **SelectScript**: `string` -- **SelectedItems**: `string[]` -- **Selection**: `ButtonGroupSelection` — Controls the mode of selection for the button group. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbButtonGroupModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbButtonGroupModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbButtonModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbButtonModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbByLevelTreeGridMergeStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbByLevelTreeGridMergeStrategy) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbCalculatedColumn](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalculatedColumn) -Represents a column that is calculated based on the values of other columns. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbCalendar](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalendar) -Represents a calendar that lets users to select a date value in a variety of different ways. - -- **constructor**(): void -- **ActiveDate**: `DateTime` — Sets the date which is shown in view and is highlighted. By default it is the current date. -- **ActiveView**: `CalendarActiveView` — The current active view of the component. "days" -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **FormatOptions**: `IgbCalendarFormatOptions` — The options used to format the months and the weekdays in the calendar views. -- **HeaderOrientation**: `CalendarHeaderOrientation` — The orientation of the calendar header. "horizontal" -- **HideHeader**: `bool` — Whether to render the calendar header part. When the calendar selection is set to multiple the header is always hidden. false -- **HideOutsideDays**: `bool` — Whether to show the dates that do not belong to the current active month. false -- **Orientation**: `ContentOrientation` — The orientation of the calendar months when more than one month is being shown. "horizontal" -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **Value**: `DateTime` -- **ValueChanged**: `EventCallback` -- **Values**: `DateTime[]` -- **ValuesChanged**: `EventCallback` -- **VisibleMonths**: `double` — The number of months displayed in the days view. 1 -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): DateTime -- **GetCurrentValueAsync**(): Task -- **GetCurrentValues**(): DateTime[] -- **GetCurrentValuesAsync**(): Task -- **ResolveDisplay**(): string -- **SetCustomizedStringAsync**(language: string, values: Dictionary): Task — Provide a new set of localized strings to use for a given languange. -- **SetCustomizedStringAsync**(language: string, json: string): Task — Provide a new set of localized strings to use for a given languange. -- **SetCustomizedStringAsync**(language: string, id: string, value: string): Task — Provide a new set of localized strings to use for a given languange. - -### [IgbCalendarBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalendarBase) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DisabledDates**: `IgbDateRangeDescriptor[]` — Gets/Sets the disabled dates for the component. -- **Locale**: `string` — Gets/Sets the locale used for formatting and displaying the dates in the component. -- **ResourceStrings**: `IgbCalendarResourceStrings` — The resource strings for localization. -- **Selection**: `CalendarSelection` — Sets the type of selection in the component. single -- **ShowWeekNumbers**: `bool` — Whether to show the week numbers. false -- **SpecialDates**: `IgbDateRangeDescriptor[]` — Gets/Sets the special dates for the component. -- **Type**: `string` -- **WeekStart**: `WeekDays` — Gets/Sets the first day of the week. sunday -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCalendarBaseModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalendarBaseModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCalendarDate](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalendarDate) - -- **constructor**(): void -- **Date**: `DateTime` -- **IsCurrentMonth**: `bool` -- **IsNextMonth**: `bool` -- **IsPrevMonth**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCalendarDateEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalendarDateEventArgs) - -- **constructor**(): void -- **Detail**: `IgbCalendarDate` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCalendarFormatOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalendarFormatOptions) - -- **constructor**(): void -- **Month**: `string` -- **Type**: `string` -- **Weekday**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCalendarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalendarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCalendarResourceStrings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalendarResourceStrings) - -- **constructor**(): void -- **EndDate**: `string` -- **NextMonth**: `string` -- **NextYear**: `string` -- **NextYears**: `string` -- **PreviousMonth**: `string` -- **PreviousYear**: `string` -- **PreviousYears**: `string` -- **SelectDate**: `string` -- **SelectMonth**: `string` -- **SelectRange**: `string` -- **SelectYear**: `string` -- **SelectedDate**: `string` -- **StartDate**: `string` -- **Type**: `string` -- **WeekLabel**: `string` -- **FindByName**(name: string): object - -### [IgbCalloutAnnotation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalloutAnnotation) -Represents a callout annotation - -- **constructor**(): void -- **Background**: `string` — Gets or sets the background to use for tha axis annotation box. -- **BackgroundCornerRadius**: `double` — Gets or sets the corner radius to use for the callout borders. -- **BackgroundPaddingBottom**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **BackgroundPaddingLeft**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **BackgroundPaddingRight**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **BackgroundPaddingTop**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **BadgeBackground**: `string` — Gets or sets the background of badge in the callout annotation. -- **BadgeCorner**: `double` — Gets or sets the corner radius of badge in the callout annotation. -- **BadgeGap**: `double` — Gets or sets the space between badge and text in the callout annotation. -- **BadgeHeight**: `double` — Gets or sets the height of badge in the callout annotation. -- **BadgeImage**: `string` — Gets or sets the image url displayed as a badge in the callout annotation. -- **BadgeOutline**: `string` — Gets or sets the outline of badge in the callout annotation. -- **BadgeThickness**: `double` — Gets or sets the thickness of badge in the callout annotation. -- **BadgeVisible**: `bool` — Gets or sets the badge is visible in callout annotation. -- **BadgeWidth**: `double` — Gets or sets the width of badge in the callout annotation. -- **Content**: `object` — Gets or sets the Content that should be annotated. -- **ContentScript**: `string` — Provides a means of setting Content in the JavaScript environment. -- **FormatLabelScript**: `string` — Provides a means of setting FormatLabel in the JavaScript environment. -- **ItemColor**: `string` — Gets or sets the ItemColor to which the callout pertains to. Leave unset for an automatic value. -- **Key**: `object` — Gets or sets the Key that should be annotated. -- **KeyScript**: `string` — Provides a means of setting Key in the JavaScript environment. -- **LeaderBrush**: `string` — Gets or sets the LeaderBrush to use for tha axis annotation box. -- **Outline**: `string` — Gets or sets the Outline to use for tha axis annotation box. -- **Series**: `IgbSeries` — Gets or sets the series to which the callout pertains to. Leave unset for an automatic value. -- **StrokeThickness**: `double` — Gets or sets the border stroke thickness to use for tha axis annotation box. -- **Text**: `string` — Gets or sets the text that should be displayed for the annotation. Leave null to display the value automatically. -- **TextColor**: `string` — Gets or sets the color to use for the text in the annotation. -- **Type**: `string` -- **XValue**: `object` — Gets or sets the XValue at which this annotation is displayed on the axis. -- **XValueScript**: `string` — Provides a means of setting XValue in the JavaScript environment. -- **YValue**: `object` — Gets or sets the YValue at which this annotation is displayed on the axis. -- **YValueScript**: `string` — Provides a means of setting YValue in the JavaScript environment. -- **FindByName**(name: string): object - -### [IgbCalloutAnnotationCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalloutAnnotationCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbCalloutBadgeInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalloutBadgeInfo) -Provides info about callout badge - -- **constructor**(): void -- **BadgeCorner**: `double` — Gets or sets the corner badge in the callout. -- **BadgeGap**: `double` — Gets or sets the gap between badge and text in the callout. -- **BadgeHeight**: `double` — Gets or sets badge height in the callout. -- **BadgeImage**: `string` — Gets or sets the image path for badge displayed in the callout. -- **BadgeThickness**: `double` — Gets or sets badge thickness in the callout. -- **BadgeVisible**: `bool` — Gets or sets whether the badge is visible in the callout. -- **BadgeWidth**: `double` — Gets or sets badge width in the callout. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbCalloutContentUpdatingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalloutContentUpdatingEventArgs) -Represents event arguments for updating content of callout layer - -- **constructor**(): void -- **Content**: `object` — Gets or sets content displayed by callout layer -- **ContentScript**: `string` — Provides a means of setting Content in the JavaScript environment. -- **Item**: `object` — Gets data item associated with callout layer -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Type**: `string` -- **XValue**: `object` — Gets data X-value associated with callout layer -- **XValueScript**: `string` — Provides a means of setting XValue in the JavaScript environment. -- **YValue**: `object` — Gets data Y-value associated with callout layer -- **YValueScript**: `string` — Provides a means of setting YValue in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCalloutLabelUpdatingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalloutLabelUpdatingEventArgs) -Represents event arguments for updating label of callout layer - -- **constructor**(): void -- **Item**: `object` — Gets data item associated with callout layer -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Label**: `object` — Gets or sets label displayed by callout layer -- **LabelScript**: `string` — Provides a means of setting Label in the JavaScript environment. -- **Series**: `IgbSeries` — Gets series associated with callout item, if available -- **SeriesName**: `string` — Gets series name associated with callout item, if available -- **Type**: `string` -- **XValue**: `object` — Gets data X-value associated with callout layer -- **XValueScript**: `string` — Provides a means of setting XValue in the JavaScript environment. -- **YValue**: `object` — Gets data Y-value associated with callout layer -- **YValueScript**: `string` — Provides a means of setting YValue in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCalloutLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalloutLayer) -Represents an annotation layer that displays crosshair lines that cross through the closest value of the target series under the cursor. - -- **constructor**(): void -- **AllowedPositions**: `IgbCalloutPlacementPositionsCollection` — Gets or sets the allowed positions that the callout layer is allowed to use. -- **AutoCalloutLabelPrecision**: `int` — Gets or sets the precision to use when values are used for the auto callout labels. -- **AutoCalloutVisibilityMode**: `AutoCalloutVisibilityMode` — Gets or sets the rules for when the callouts should be visible. -- **CalloutBackground**: `string` — Gets or sets the brush that specifies how the backgrounds for the callouts of the layer are painted. Leave unset for an automatic value. -- **CalloutBadgeBackground**: `string` — Gets or sets the badge background in callout annotation. -- **CalloutBadgeCorner**: `double` — Gets or sets the corner radius of badge in callout annotation -- **CalloutBadgeGap**: `double` — Gets or sets the gap between badge and text in callout annotation -- **CalloutBadgeHeight**: `double` — Gets or sets the the badge height in callout annotation. -- **CalloutBadgeImageMemberPath**: `string` — Gets or sets the mapping property for an image displayed in the badge of callout annotation -- **CalloutBadgeMatchSeries**: `bool` — Gets or sets whether or not the callout badge matches appearance of target series. -- **CalloutBadgeOutline**: `string` — Gets or sets the badge outline in callout annotation. -- **CalloutBadgeThickness**: `double` — Gets or sets the the badge thickness in callout annotation. -- **CalloutBadgeVisible**: `bool` — Gets or sets the badge is visible in callout annotation. -- **CalloutBadgeWidth**: `double` — Gets or sets the the badge width in callout annotation. -- **CalloutCollisionMode**: `CalloutCollisionMode` — Gets or sets the strategy to use for avoiding collisions between the callouts in this layer. Leave unset for an automatic value. -- **CalloutContentUpdating**: `EventCallback` -- **CalloutContentUpdatingScript**: `string` -- **CalloutCornerRadius**: `double` — Gets or sets the corner radius to use for the callout borders. -- **CalloutDarkTextColor**: `string` — Gets or sets the dark color to use for the callout text. Leave unset for an automatic value. -- **CalloutExpandsAxisBufferEnabled**: `bool` — Gets or sets whether or not callouts expand axis buffer for extra space for their render around data points. -- **CalloutExpandsAxisBufferMaxHeight**: `double` — Gets or sets the maximum vertical axis buffer for positioning callouts. -- **CalloutExpandsAxisBufferMaxWidth**: `double` — Gets or sets the maximum horizontal axis buffer for positioning callouts. -- **CalloutExpandsAxisBufferMinHeight**: `double` — Gets or sets the minimum vertical axis buffer for positioning callouts. -- **CalloutExpandsAxisBufferMinWidth**: `double` — Gets or sets the minimum horizontal axis buffer for positioning callouts. -- **CalloutExpandsAxisBufferOnInitialVisibility**: `bool` — Gets or sets whether or not recalculate callouts expand axis buffer on rendering frame. -- **CalloutExpandsAxisBufferOnlyWhenVisible**: `bool` — Gets or sets whether or not callouts expand axis buffer only when callouts are visible in the chart. -- **CalloutInterpolatedValuePrecision**: `int` — Gets or sets the precision to use displaying values for interpolated crosshair positions. -- **CalloutLabelUpdating**: `EventCallback` -- **CalloutLabelUpdatingScript**: `string` -- **CalloutLeaderBrush**: `string` — Gets or sets the brush that specifies how the leader lines for the callouts of the layer are painted. -- **CalloutLightTextColor**: `string` — Gets or sets the light color to use for the callout text. Leave unset for an automatic value. -- **CalloutOutline**: `string` — Gets or sets the brush that specifies how the outlines for the callouts of the layer are painted. -- **CalloutPaddingBottom**: `double` — Gets or sets the bottom padding to use within the callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **CalloutPaddingLeft**: `double` — Gets or sets the left padding to use withing the callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **CalloutPaddingRight**: `double` — Gets or sets the right padding to use within the callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **CalloutPaddingTop**: `double` — Gets or sets the top padding to use within the callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **CalloutPositionPadding**: `double` — Gets or sets the padding to add to the callout positioning. Leave unset for an automatic value. -- **CalloutRenderStyleUpdating**: `EventCallback` -- **CalloutRenderStyleUpdatingScript**: `string` -- **CalloutSeriesSelecting**: `EventCallback` -- **CalloutSeriesSelectingScript**: `string` -- **CalloutStrokeThickness**: `double` — Gets or sets the stroke thickness for the callout backing. Leave unset for an automatic value. -- **CalloutStyleUpdating**: `EventCallback` -- **CalloutStyleUpdatingScript**: `string` -- **CalloutSuspendedWhenShiftingToVisible**: `bool` — Gets or sets whether or not suspend refresh of callouts while they shift from hidden to visible -- **CalloutTextColor**: `string` — Gets or sets the color to use for the callout text. Leave unset for an automatic value. -- **CollisionChannel**: `string` — Gets or sets a channel name to identify other callout layers within the chart to share collision information with. -- **ContentMemberPath**: `string` — Gets or sets the content mapping property for the callouts. -- **HighlightedValueLabelMode**: `HighlightedValueLabelMode` — Gets or sets whether to use values, rather than labels for auto callout labels. -- **IsAutoCalloutBehaviorEnabled**: `bool` — Gets or sets how to select the final value to annotate. -- **IsCalloutOffsettingEnabled**: `bool` — Gets or sets whether to allow the callouts to be variable distances from the target points, for supporting collision modes. -- **IsCustomCalloutRenderStyleEnabled**: `bool` — Gets or sets whether to allow for custom callout styles. -- **IsCustomCalloutStyleEnabled**: `bool` — Gets or sets whether to allow for custom callout styles. -- **KeyMemberPath**: `string` — Gets or sets the key mapping property for the callouts. -- **LabelFormat**: `string` — Gets or sets the label format string to use for the label. -- **LabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the LabelFormat string. -- **LabelMemberPath**: `string` — Gets or sets the label mapping property for the callouts. -- **ShouldTruncateOnBoundaryCollisions**: `bool` — Gets or sets whether the callouts that collide with the boundary should be truncated. -- **TargetSeries**: `IgbSeries` — Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously. -- **TargetSeriesName**: `string` — Gets or sets the name of the series series to target this annotation to. If null, this annotation targets all series simultaneously. -- **TargetSeriesScript**: `string` — Provides a means of setting TargetSeries in the JavaScript environment. -- **TextStyle**: `string` — Gets or sets the stroke thickness for the axis annotation backing. Leave unset for an automatic value. -- **Type**: `string` -- **UseAutoContrastingLabelColors**: `bool` — Gets or sets whether to the label color is automatically decided between a light and dark option for contrast. -- **UseInterpolatedValueForAutoCalloutLabels**: `bool` — Gets or sets whether to use values, rather than labels for auto callout labels. -- **UseItemColorForFill**: `bool` — Gets or sets whether to the series color as the outline of the callout. -- **UseItemColorForOutline**: `bool` — Gets or sets whether to the series item color as the outline of the callout. -- **UseSeriesColorForOutline**: `bool` — Gets or sets whether to the series color as the outline of the callout. -- **UseValueForAutoCalloutLabels**: `bool` — Gets or sets whether to use values, rather than labels for auto callout labels. -- **XMemberPath**: `string` — Gets or sets the label mapping property for the callouts. -- **YMemberPath**: `string` — Gets or sets the label mapping property for the callouts. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **InvalidateCalloutContent**(): void -- **InvalidateCalloutContentAsync**(): Task — Invalidates content of callout layer -- **RecalculateAxisRangeBuffer**(): void -- **RecalculateAxisRangeBufferAsync**(): Task — Resets actual visiable range margin -- **RefreshAxisBufferAndCalloutPositions**(): void -- **RefreshAxisBufferAndCalloutPositionsAsync**(): Task — Refresh axis buffer and callouts rendering -- **RefreshLabelPositions**(): void -- **RefreshLabelPositionsAsync**(): Task — Force the callout labels to reevaluate their positions. - -### [IgbCalloutLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalloutLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCalloutPlacementPositionsCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalloutPlacementPositionsCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbCalloutRenderStyleUpdatingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalloutRenderStyleUpdatingEventArgs) - -- **constructor**(): void -- **ActualPosition**: `CalloutPlacementPositions` -- **Background**: `string` -- **BackgroundCorner**: `double` -- **BadgeBackground**: `string` -- **BadgeImage**: `string` -- **BadgeOutline**: `string` -- **BadgeThickness**: `double` -- **Height**: `double` -- **Item**: `object` -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **LabelPositionX**: `double` -- **LabelPositionY**: `double` -- **LeaderBrush**: `string` -- **Outline**: `string` -- **Series**: `IgbSeries` -- **StrokeThickness**: `double` -- **TargetPositionX**: `double` -- **TargetPositionY**: `double` -- **TextColor**: `string` -- **Type**: `string` -- **Width**: `double` -- **XValue**: `object` -- **XValueScript**: `string` — Provides a means of setting XValue in the JavaScript environment. -- **YValue**: `object` -- **YValueScript**: `string` — Provides a means of setting YValue in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCalloutSeriesSelectingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalloutSeriesSelectingEventArgs) -Represents event arguments for selecting callout layer - -- **constructor**(): void -- **Item**: `object` — Gets data item associated with callout layer -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Series**: `IgbSeries` — Gets or sets series object associated with callout layer -- **SeriesName**: `string` — Gets or sets series name associated with callout layer -- **Type**: `string` -- **XValue**: `object` — Gets data X-value associated with callout layer -- **XValueScript**: `string` — Provides a means of setting XValue in the JavaScript environment. -- **YValue**: `object` — Gets data Y-value associated with callout layer -- **YValueScript**: `string` — Provides a means of setting YValue in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCalloutStyleUpdatingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCalloutStyleUpdatingEventArgs) -Event arguments for the CalloutStyleUpdating event - -- **constructor**(): void -- **BacgkroundPaddingBottom**: `double` -- **BacgkroundPaddingLeft**: `double` -- **BacgkroundPaddingRight**: `double` -- **BacgkroundPaddingTop**: `double` -- **Background**: `string` — Gets or sets the background of the callout. -- **BackgroundCorner**: `double` -- **BadgeBackground**: `string` — Gets or sets badge fill in the callout. -- **BadgeCorner**: `double` -- **BadgeGap**: `double` — Gets or sets the gap between badge and text in the callout. -- **BadgeHeight**: `double` — Gets or sets badge height in the callout. -- **BadgeImage**: `string` — Gets or sets the path to an image displayed in the callout. -- **BadgeOutline**: `string` — Gets or sets badge outline in the callout. -- **BadgeThickness**: `double` — Gets or sets badge thickness in the callout. -- **BadgeVisible**: `bool` — Gets or sets whether the badge is visible in the callout. -- **BadgeWidth**: `double` — Gets or sets badge width in the callout. -- **Item**: `object` — Gets data item associated with the callout. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **LeaderBrush**: `string` — Gets or sets the leader brush of the callout. -- **Outline**: `string` — Gets or sets the outline of the callout. -- **Series**: `IgbSeries` — Gets data series associated with the callout. -- **StrokeThickness**: `double` — Gets or sets the stroke thickness of the callout. -- **TextColor**: `string` — Gets or sets the text color of the callout. -- **Type**: `string` -- **XValue**: `object` — Gets X-position of data item associated with the callout. -- **XValueScript**: `string` — Provides a means of setting XValue in the JavaScript environment. -- **YValue**: `object` — Gets Y-position of data item associated with the callout. -- **YValueScript**: `string` — Provides a means of setting YValue in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCancelButtonClickEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCancelButtonClickEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCancelEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCancelEventArgs) - -- **constructor**(): void -- **Cancel**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCancelableBrowserEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCancelableBrowserEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCancelableBrowserEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCancelableBrowserEventArgsDetail) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCancelableEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCancelableEventArgs) - -- **constructor**(): void -- **Detail**: `IgbCancelableEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCancelableEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCancelableEventArgsDetail) - -- **constructor**(): void -- **Cancel**: `bool` — Provides the ability to cancel the event. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCancellingMultiScaleImageEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCancellingMultiScaleImageEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **Uri**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCaptureImageSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCaptureImageSettings) - -- **constructor**(): void -- **AddToClipboard**: `bool` -- **Format**: `CaptureImageFormat` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbCard](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCard) -A container component that wraps different elements related to a single subject. The card component provides a flexible container for organizing content such as headers, media, text content, and actions. Card Title Card Subtitle Card content goes here Action - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Elevated**: `bool` — Sets the card to have an elevated appearance with shadow. When false, the card uses an outlined style with a border. false -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCardActions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCardActions) -A container component for card action items such as buttons or icon buttons. Actions can be positioned at the start, center, or end of the container. Like Share - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Orientation**: `ContentOrientation` — The orientation of the actions layout. 'horizontal' -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCardActionsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCardActionsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCardContent](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCardContent) -A container component for the card's main text content. This component should be used within an igc-card element to display the primary content. This is the main content of the card. It can contain any text or HTML content. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCardContentModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCardContentModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCardHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCardHeader) -A container component for the card's header section. Displays header content including an optional thumbnail, title, subtitle, and additional content. Card Title Card Subtitle - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCardHeaderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCardHeaderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCardMedia](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCardMedia) -A container component for card media content such as images, GIFs, or videos. This component should be used within an igc-card element to display visual content. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCardMediaModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCardMediaModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCardModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCardModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCarousel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCarousel) -The igc-carousel presents a set of igc-carousel-slides by sequentially displaying a subset of one or more slides. - -- **constructor**(): void -- **AnimationType**: `HorizontalTransitionAnimation` — The animation type. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **DisableLoop**: `bool` — Whether the carousel should skip rotating to the first slide after it reaches the last. -- **DisablePauseOnInteraction**: `bool` — Whether the carousel should ignore use interactions and not pause on them. -- **HideIndicators**: `bool` — Whether the carousel should render the indicator controls (dots). -- **HideNavigation**: `bool` — Whether the carousel should skip rendering of the default navigation buttons. -- **IndicatorsLabelFormat**: `string` — The format used to set the aria-label on the carousel indicators. Instances of '{0}' will be replaced with the index of the corresponding slide. -- **IndicatorsOrientation**: `CarouselIndicatorsOrientation` — Sets the orientation of the indicator controls (dots). -- **Interval**: `double` — The duration in milliseconds between changing the active slide. -- **MaximumIndicatorsCount**: `double` — Controls the maximum indicator controls (dots) that can be shown. Default value is 10. -- **Paused**: `EventCallback` -- **PausedScript**: `string` -- **Playing**: `EventCallback` -- **PlayingScript**: `string` -- **SlideChanged**: `EventCallback` -- **SlideChangedScript**: `string` -- **SlidesLabelFormat**: `string` — The format used to set the aria-label on the carousel slides and the text displayed when the number of indicators is greater than tha maximum indicator count. Instances of '{0}' will be replaced with the index of the corresponding slide. Instances of '{1}' will be replaced with the total amount of slides. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Vertical**: `bool` — Whether the carousel has vertical alignment. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrent**(): double -- **GetCurrentAsync**(): Task -- **GetIsPaused**(): bool -- **GetIsPausedAsync**(): Task -- **GetIsPlaying**(): bool -- **GetIsPlayingAsync**(): Task -- **GetTotal**(): double -- **GetTotalAsync**(): Task -- **Next**(): bool -- **NextAsync**(): Task — Switches to the next slide, runs any animations, and returns if the operation was successful. -- **Pause**(): void -- **PauseAsync**(): Task — Pauses the carousel rotation of slides. -- **Play**(): void -- **PlayAsync**(): Task — Resumes playing of the carousel slides. -- **Prev**(): bool -- **PrevAsync**(): Task — Switches to the previous slide, runs any animations, and returns if the operation was successful. -- **ResolveDisplay**(): string -- **Select**(index: double, animationDirection: CarouselAnimationDirection?): bool -- **SelectAsync**(index: double, animationDirection: CarouselAnimationDirection?): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCarouselIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCarouselIndicator) -Used when a custom indicator needs to be passed to the igc-carousel component. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCarouselIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCarouselIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCarouselModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCarouselModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCarouselSlide](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCarouselSlide) -A single content container within a set of containers used in the context of an igc-carousel. - -- **constructor**(): void -- **Active**: `bool` — The current active slide for the carousel component. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCarouselSlideModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCarouselSlideModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCategoryAngleAxis](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryAngleAxis) -Represents a IgbDataChart category angle axis. Useful for displaying radial categories. - -- **constructor**(): void -- **ActualInterval**: `double` — Gets the effective value for the current Interval. -- **ActualIntervalChanged**: `Action` -- **ActualIntervalChangedScript**: `string` -- **ActualMinorInterval**: `double` — Gets the effective value for the current MinorInterval. -- **CompanionAxisInterval**: `double` — Gets or sets interval of labels on the companion axis. -- **CompanionAxisLabelMode**: `AxisAngleLabelMode` — Gets or sets the mode axis labels will operate for the companion axis. -- **CompanionAxisMinorInterval**: `double` — Gets or sets label angle on the companion axis. -- **CompanionAxisStartAngleOffset**: `double` — Gets or sets angle in degress that the chart's 0th angle should be offset for the companion axis -- **Interval**: `double` — Gets or sets the frequency of displayed labels. -- **LabelMode**: `AxisAngleLabelMode` — Indicates the mode axis labels will operate in. -- **MinorInterval**: `double` — Gets or sets the frequency of displayed minor lines. -- **StartAngleOffset**: `double` — Indicates the angle in degress that the chart's 0th angle should be offset. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentActualInterval**(): double -- **GetCurrentActualIntervalAsync**(): Task -- **GetScaledAngle**(unscaledAngle: double): double -- **GetScaledAngleAsync**(unscaledAngle: double): Task — Gets the scaled angle in radians from the raw axis value. -- **GetUnscaledAngle**(scaledAngle: double): double -- **GetUnscaledAngleAsync**(scaledAngle: double): Task — Gets the raw axis value from the scaled angle in radians. - -### [IgbCategoryAngleAxisModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryAngleAxisModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCategoryAxisBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryAxisBase) -Represents the base class for all IgbDataChart category-based axes. - -- **constructor**(): void -- **DataSource**: `object` — Gets or sets the ItemsSource property for the current axis. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **Gap**: `double` — Gets or sets the amount of space between adjacent categories for the current axis object. -- **ItemsCount**: `int` — Gets the number of items in the current category axis items source. -- **ItemsCountChanged**: `Action` -- **ItemsCountChangedScript**: `string` -- **MaximumGap**: `double` — Gets or sets the maximum gap value to allow. This defaults to 1.0. -- **MinimumGapSize**: `double` — Gets or sets the minimum amount of pixels to use for the gap between categories, if possible. -- **Overlap**: `double` — Gets or sets the amount of overlap between adjacent categories for the current axis object. -- **Type**: `string` -- **UseClusteringMode**: `bool` — Gets or sets whether the category axis should use clustering display mode even if no series are present that would force clustering mode. -- **FindByName**(name: string): object -- **GetCategoryBoundingBox**(point: Point, useInterpolation: bool, singularWidth: double): Rect -- **GetCategoryBoundingBoxAsync**(point: Point, useInterpolation: bool, singularWidth: double): Task -- **GetCategoryBoundingBoxHelper**(point: Point, useInterpolation: bool, singularWidth: double, isVertical: bool): Rect -- **GetCategoryBoundingBoxHelperAsync**(point: Point, useInterpolation: bool, singularWidth: double, isVertical: bool): Task -- **GetCurrentItemsCount**(): int -- **GetCurrentItemsCountAsync**(): Task -- **GetFullRange**(): double[] -- **GetFullRangeAsync**(): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **NotifyClearItems**(): void -- **NotifyClearItemsAsync**(): Task — Used to manually notify the axis that the data source has reset or cleared its items. -- **NotifyInsertItem**(index: int, newItem: object): void -- **NotifyInsertItemAsync**(index: int, newItem: object): Task -- **NotifyRemoveItem**(index: int, oldItem: object): void -- **NotifyRemoveItemAsync**(index: int, oldItem: object): Task -- **NotifySetItem**(index: int, oldItem: object, newItem: object): void -- **NotifySetItemAsync**(index: int, oldItem: object, newItem: object): Task -- **UnscaleValue**(unscaledValue: double): double -- **UnscaleValueAsync**(unscaledValue: double): Task — Unscales a value from screen space into axis space. - -### [IgbCategoryChart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryChart) -Represents a chart with an ordinal X-axis and a numeric Y-axis. - -- **constructor**(): void -- **AutoExpandMarginExtraPadding**: `double` — Gets or sets the extra amount the series viewer should auto expand margins to accommodate the initial horizontal axis labels. -- **AutoExpandMarginMaximumValue**: `double` — Gets or sets the maximum amount the series viewer should auto expand margins to accommodate the initial horizontal axis labels. -- **AutoMarginAndAngleUpdateMode**: `AutoMarginsAndAngleUpdateMode` — Gets or sets a whether the series viewer should auto expand margins to accommodate the initial horizontal axis labels. -- **ChartType**: `CategoryChartType` — Gets or sets the type of chart series to generate from the data. -- **IsCategoryHighlightingEnabled**: `bool` — Gets or sets whether the category should be highlighted when hovered -- **IsItemHighlightingEnabled**: `bool` — Gets or sets whether the item should be highlighted when hovered -- **IsSplineShapePartOfRange**: `bool` — Gets or sets whether to include the spline shape in the axis range requested of the axis for spline type series. -- **IsTransitionInEnabled**: `bool` — Gets or sets whether animation of series plots is enabled when the chart is loading into view -- **MarkerCollisionAvoidance**: `CategorySeriesMarkerCollisionAvoidance` — Gets or sets the behavior for markers in each series which are placed too close together for the current view, resulting in a collision. -- **NeedsDynamicContent**: `bool` -- **NegativeBrushes**: `string` — Gets or sets the palette used for coloring negative items of Waterfall chart type. -- **NegativeOutlines**: `string` — Brushes to use for drawing negative elements, when using a chart type with contextual coloring, such as Waterfall. -- **ShouldAutoExpandMarginForInitialLabels**: `bool` — Gets or sets a whether the series viewer should auto expand margins to accommodate the initial horizontal axis labels. -- **ShouldConsiderAutoRotationForInitialLabels**: `bool` — Gets or sets a whether the series viewer should consider auto rotating labels to fit them in the initial view. This implies that ShouldAutoExpandMarginForInitialLabels is true. -- **TooltipTemplate**: `RenderFragment` -- **TransitionInDuration**: `int` — Gets or sets the duration used for animating series plots when the chart is loading into view -- **TransitionInEasingFunction**: `string` — Gets or sets the easing function used for animating series plots when the chart is loading into view -- **TransitionInEasingFunctionScript**: `string` — Provides a means of setting TransitionInEasingFunction in the JavaScript environment. -- **TransitionInMode**: `CategoryTransitionInMode` — Gets or sets the method that determines how to animate series plots when the chart is loading into view -- **TransitionInSpeedType**: `TransitionInSpeedType` — Gets or sets the arrival speed used for animating series plots when the chart is loading into view -- **TransitionOutDuration**: `int` — Gets or sets the duration used for animating series plots when the series is leaving view -- **TransitionOutEasingFunction**: `string` — Gets or sets the easing function used for animating series plots when the chart is loading into view -- **TransitionOutEasingFunctionScript**: `string` — Provides a means of setting TransitionOutEasingFunction in the JavaScript environment. -- **Type**: `string` -- **XAxisEnhancedIntervalPreferMoreCategoryLabels**: `bool` — Gets or sets whether the x axis enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval. -- **XAxisGap**: `double` — Gets or sets the amount of space between adjacent categories for the X-axis. -- **XAxisInterval**: `double` — Gets or sets the frequency of displayed labels along the X-axis. -- **XAxisMaximumGap**: `double` — Gets or sets the maximum gap value to allow. This defaults to 1.0. -- **XAxisMinimumGapSize**: `double` — Gets or sets the minimum amount of pixels to use for the gap between categories, if possible. -- **XAxisMinorInterval**: `double` — Gets or sets the frequency of displayed minor lines along the X-axis. -- **XAxisOverlap**: `double` — Gets or sets the amount of overlap between adjacent categories for the X-axis. -- **XAxisZoomMaximumCategoryRange**: `double` — Gets or sets number of visible categories at maximum zooming level -- **XAxisZoomMaximumItemSpan**: `double` — Gets or sets maximum pixel span of series item that will be visible at maximum zooming level This property ensures that series item does not get stretch above specified value. -- **XAxisZoomToCategoryRange**: `double` — Gets or sets number of categories that the chart will zoom in and fill plot area -- **XAxisZoomToCategoryStart**: `double` — Gets or sets starting category that chart will move its zoom window. Acceptable value is between 0 and number of data items -- **XAxisZoomToItemSpan**: `double` — Gets or sets pixel span of series item that will be used to zoom chart such that the item has desired span Chart will automatically zoom in until series item has specified pixel span. -- **YAxisAbbreviateLargeNumbers**: `bool` — Gets or sets whether the large numbers on the Y-axis labels are abbreviated. -- **YAxisAutoRangeBufferMode**: `AxisRangeBufferMode` — Gets or sets how the numeric axis will adjust its range buffer to less closely fix the data from the series. -- **YAxisEnhancedIntervalPreferMoreCategoryLabels**: `bool` — Gets or sets whether the y axis enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval. -- **YAxisFavorLabellingScaleEnd**: `bool` — Gets or sets whether the axis should favor emitting a label at the end of the scale. -- **YAxisInterval**: `double` — Gets or sets the distance between each label and grid line along the Y-axis. -- **YAxisIsLogarithmic**: `bool` — Gets or sets whether the Y-axis should use a logarithmic scale instead of a linear one. -- **YAxisLogarithmBase**: `int` — Gets or sets the base value to use in the log function when mapping the position of data items along the Y-axis. -- **YAxisMaximumValue**: `double` — Gets or sets the data value corresponding to the maximum value of the Y-axis. -- **YAxisMinimumValue**: `double` — Gets or sets the data value corresponding to the minimum value of the Y-axis. -- **YAxisMinorInterval**: `double` — Gets or sets the frequency of displayed minor lines along the Y-axis. -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Export serialized visual data. -- **FindByName**(name: string): object -- **GetCurrentXAxisActualMaximum**(): double -- **GetCurrentXAxisActualMaximumAsync**(): Task -- **GetCurrentXAxisActualMinimum**(): double -- **GetCurrentXAxisActualMinimumAsync**(): Task -- **GetCurrentYAxisActualMaximum**(): double -- **GetCurrentYAxisActualMaximumAsync**(): Task -- **GetCurrentYAxisActualMinimum**(): double -- **GetCurrentYAxisActualMinimumAsync**(): Task -- **RecalculateMarginAutoExpansion**(): void -- **RecalculateMarginAutoExpansionAsync**(): Task - -### [IgbCategoryChartCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryChartCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCategoryChartModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryChartModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCategoryChartToolbarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryChartToolbarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCategoryDateTimeXAxis](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryDateTimeXAxis) -Represents a category-based horizontal X axis that uses a DateTime scale. - -- **constructor**(): void -- **ActualInterval**: `long` — Gets the effective value for the current Interval. -- **ActualIntervalChanged**: `Action` -- **ActualIntervalChangedScript**: `string` -- **ActualMinorInterval**: `long` — Gets the effective value for the current MinorInterval. -- **ActualMinorIntervalChanged**: `Action` -- **ActualMinorIntervalChangedScript**: `string` -- **DisplayType**: `TimeAxisDisplayType` — Gets or sets the axis display type. Continuous display type divides the axis into even intervals, where labels will not necessarily be aligned with data points. Discrete display type will not use a constant interval, but will align each label with its data point. -- **Interval**: `long` — Gets or sets the X axis time interval. -- **MinorInterval**: `long` — Gets or sets the frequency of displayed minor lines. -- **Type**: `string` -- **UnevenlySpacedLabels**: `bool` — Gets or sets whether the axis labels can be unevenly spaced -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentActualInterval**(): long -- **GetCurrentActualIntervalAsync**(): Task -- **GetCurrentActualMinorInterval**(): long -- **GetCurrentActualMinorIntervalAsync**(): Task -- **ScrollIntoView**(minimum: DateTime, maximum: DateTime): void -- **ScrollIntoViewAsync**(minimum: DateTime, maximum: DateTime): Task - -### [IgbCategoryDateTimeXAxisModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryDateTimeXAxisModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCategoryHighlightLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryHighlightLayer) -Represents an annotation layer that targets a category axis, or all category axes in the chart. If the axis contains any series that are aligned between major gridlines of the axis (column, waterfall, etc) this will render a shape that fills the current category. Otherwise it will render a band with an adjustable thickness at the closest gridline to the pointer position. Setting UseIterpolation to true will cause the x position in the latter case to become affixed to the x position of the pointer. - -- **constructor**(): void -- **BandHighlightWidth**: `double` — Gets or sets the width to use for the highlight region if drawing a band rather than filling a category. -- **TargetAxis**: `IgbCategoryAxisBase` — Gets or sets the axis to target this annotation to. If null, this annotation targets all category axes simultaneously. -- **TargetAxisName**: `string` — Gets or sets the name to use to resolve targetAxis from markup. -- **TargetAxisScript**: `string` — Provides a means of setting TargetAxis in the JavaScript environment. -- **Type**: `string` -- **UseInterpolation**: `bool` — Gets or sets whether to use value interpolation when drawing a line through the best value for the pointer position. -- **BindAxes**(Axes: IgbAxis[]): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbCategoryHighlightLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryHighlightLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCategoryItemHighlightLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryItemHighlightLayer) -Represents an annotation layer that highlights items in a series that use a category axis either by drawing a banded shape at their position, or by rendering a marker at their position. Depending on the type of series, the default highlight will be affected. To override the type of highlight used, you can set the HighlightType property. - -- **constructor**(): void -- **BandHighlightWidth**: `double` — Gets or sets the width to use for the highlight region if highlighting items in a grid aligned series (line, spline, etc), with a banded shape. -- **HighlightType**: `CategoryItemHighlightType` — Gets or sets which type of highlight shape to use when highlighting items. -- **MarkerBrush**: `string` — Gets or sets which color to use for the marker when highlighting items, if appropriate. -- **MarkerOutline**: `string` — Gets or sets which outline color to use for the marker when highlighting items, if appropriate. -- **MarkerTemplate**: `object` — Gets or sets the template to use for marker visuals for the current series object. -- **MarkerTemplateScript**: `string` — Provides a means of setting MarkerTemplate in the JavaScript environment. -- **MarkerType**: `MarkerType` — Gets or sets which type of marker to use when highlighting items, if appropriate. -- **SkipUnknownValues**: `bool` — Gets or sets whether to skip unknown values when searching for series values. -- **TargetSeries**: `IgbSeries` — Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously. -- **TargetSeriesName**: `string` — Gets or sets the name of the series to target this annotation to. If null, this annotation targets all series simultaneously. -- **TargetSeriesScript**: `string` — Provides a means of setting TargetSeries in the JavaScript environment. -- **Type**: `string` -- **UseInterpolation**: `bool` — Gets or sets whether to use value interpolation when drawing a line through the best value for the pointer position. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbCategoryItemHighlightLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryItemHighlightLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCategorySeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategorySeries) -Represents the base class for IgbDataChart category series. - -- **constructor**(): void -- **AssigningCategoryMarkerStyle**: `Action` -- **AssigningCategoryMarkerStyleScript**: `string` -- **AssigningCategoryStyle**: `Action` -- **AssigningCategoryStyleScript**: `string` -- **CategoryCollisionMode**: `CategoryCollisionMode` — Gets or sets the category collision mode selection behavior to use for the series. -- **IsCustomCategoryMarkerStyleAllowed**: `bool` — Gets or sets whether this category series should allow custom style overrides of its individual marker visuals. -- **IsCustomCategoryStyleAllowed**: `bool` — Gets or sets whether this category series should allow custom style overrides of its individual visuals. -- **IsTransitionInEnabled**: `bool` — Gets or sets whether the series should transition into the plot area when a new data source is assigned. Note: Transitions are not currently supported for stacked series. -- **TransitionInMode**: `CategoryTransitionInMode` — Gets or sets the method by which to animate the data into the chart when the chart data source is swapped. Note: Transitions are not currently supported for stacked series. -- **Type**: `string` -- **UseHighMarkerFidelity**: `bool` — Sets or Gets whether to increase marker fidelity for extreme data shapes that have lots of Y variation over short X intervals. -- **FindByName**(name: string): object -- **GetCategoryWidth**(): double -- **GetCategoryWidthAsync**(): Task — Returns the width of the category grouping this series is in. -- **GetExactItemIndex**(world: Point): double -- **GetExactItemIndexAsync**(world: Point): Task — Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex. -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemIndex**(world: Point): int -- **GetItemIndexAsync**(world: Point): Task — Gets the index of the item based on world coordinates. -- **GetOffsetValue**(): double -- **GetOffsetValueAsync**(): Task — Returns the offset value for this series if grouped on a category axis. - -### [IgbCategoryToolTipLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryToolTipLayer) -Represents an annotation layer that displays grouped tooltips for series that use a category axis. - -- **constructor**(): void -- **TargetAxis**: `IgbAxis` — Gets or sets the Axis to target this annotation to. If null, this annotation layer will not render content. -- **TargetAxisName**: `string` — Gets or sets the name to use to resolve targetAxis from markup. -- **TargetAxisScript**: `string` — Provides a means of setting TargetAxis in the JavaScript environment. -- **ToolTipBackground**: `string` — Gets or sets the background of the tooltip containers. -- **ToolTipBorderBrush**: `string` — Gets or sets the border color of the tooltip containers. -- **ToolTipBorderThickness**: `double` — Gets or sets the border thickness of the tooltip containers. -- **ToolTipPosition**: `CategoryTooltipLayerPosition` — Gets or sets the Position to apply to the tooltip containers. -- **Type**: `string` -- **UseInterpolation**: `bool` — Gets or sets whether to use value interpolation when drawing the tooltips. -- **BindAxes**(Axes: IgbAxis[]): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **HideToolTips**(): void -- **HideToolTipsAsync**(): Task — Hides any tooltips presented by the layer, if any. - -### [IgbCategoryToolTipLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryToolTipLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCategoryXAxis](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryXAxis) -Represents a IgbDataChart category X axis. - -- **constructor**(): void -- **ActualInterval**: `double` — Gets the effective value for the current Interval. -- **ActualIntervalChanged**: `Action` -- **ActualIntervalChangedScript**: `string` -- **ActualMinorInterval**: `double` — Gets the effective value for the current MinorInterval. -- **ActualMinorIntervalChanged**: `Action` -- **ActualMinorIntervalChangedScript**: `string` -- **CompanionAxisInterval**: `double` — Gets or sets interval of labels on the companion axis. -- **CompanionAxisMinorInterval**: `double` — Gets or sets label angle on the companion axis. -- **Interval**: `double` — Gets or sets the frequency of displayed labels. -- **MinorInterval**: `double` — Gets or sets the frequency of displayed minor lines. -- **Type**: `string` -- **ZoomMaximumCategoryRange**: `double` — Gets or sets number of visible categories at maximum zooming level -- **ZoomMaximumItemSpan**: `double` — Gets or sets maximum pixel span of series item that will be visible at maximum zooming level This property ensures that series item does not get stretch above specified value. -- **ZoomToCategoryRange**: `double` — Gets or sets range of categories that the chart will zoom in to and fill plot area -- **ZoomToCategoryStart**: `double` — Gets or sets starting category that chart will move its zoom window. Acceptable value is between 0 and number of data items -- **ZoomToItemSpan**: `double` — Gets or sets pixel span of series item that will be used to zoom chart such that the item has desired span Chart will automatically zoom in until series item has specified pixel span. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentActualInterval**(): double -- **GetCurrentActualIntervalAsync**(): Task -- **GetCurrentActualMinorInterval**(): double -- **GetCurrentActualMinorIntervalAsync**(): Task -- **GetWindowZoomFromCategories**(categoriesCount: double): double -- **GetWindowZoomFromCategoriesAsync**(categoriesCount: double): Task — Gets window zoom scale required to zoom to specified number of categories -- **GetWindowZoomFromItemSpan**(pixels: double): double -- **GetWindowZoomFromItemSpanAsync**(pixels: double): Task — Gets window zoom scale required to zoom to specified span of series item -- **ScrollIntoView**(item: object): void -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the specified item into view. -- **ScrollRangeIntoView**(minimum: double, maximum: double): void -- **ScrollRangeIntoViewAsync**(minimum: double, maximum: double): Task - -### [IgbCategoryXAxisModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryXAxisModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCategoryYAxis](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryYAxis) -Represents a IgbDataChart category Y axis. - -- **constructor**(): void -- **ActualInterval**: `double` — Gets the effective value for the current Interval. -- **ActualIntervalChanged**: `Action` -- **ActualIntervalChangedScript**: `string` -- **ActualMinorInterval**: `double` — Gets the effective value for the current MinorInterval. -- **ActualMinorIntervalChanged**: `Action` -- **ActualMinorIntervalChangedScript**: `string` -- **CompanionAxisInterval**: `double` — Gets or sets interval of labels on the companion axis. -- **CompanionAxisMinorInterval**: `double` — Gets or sets label angle on the companion axis. -- **Interval**: `double` — Gets or sets the frequency of displayed labels. -- **MinorInterval**: `double` — Gets or sets the frequency of displayed minor lines. -- **Type**: `string` -- **ZoomMaximumCategoryRange**: `double` — Gets or sets number of visible categories at maximum zooming level -- **ZoomMaximumItemSpan**: `double` — Gets or sets maximum pixel span of series item that will be visible at maximum zooming level This property ensures that series item does not get stretch above specified value. -- **ZoomToCategoryRange**: `double` — Gets or sets range of categories that the chart will zoom in and fill plot area -- **ZoomToCategoryStart**: `double` — Gets or sets starting category that chart will move its zoom window. Acceptable value is between 0 and number of data items -- **ZoomToItemSpan**: `double` — Gets or sets pixel span of series item that will be used to zoom chart such that the item has desired span Chart will automatically zoom in until series item has specified pixel span. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCategoryBoundingBox**(point: Point, useInterpolation: bool, singularWidth: double): Rect -- **GetCategoryBoundingBoxAsync**(point: Point, useInterpolation: bool, singularWidth: double): Task -- **GetCurrentActualInterval**(): double -- **GetCurrentActualIntervalAsync**(): Task -- **GetCurrentActualMinorInterval**(): double -- **GetCurrentActualMinorIntervalAsync**(): Task -- **GetWindowZoomFromCategories**(categoriesCount: double): double -- **GetWindowZoomFromCategoriesAsync**(categoriesCount: double): Task — Gets window zoom scale required to zoom to specified number of categories -- **GetWindowZoomFromItemSpan**(pixels: double): double -- **GetWindowZoomFromItemSpanAsync**(pixels: double): Task — Gets window zoom scale required to zoom to specified span of series item -- **ScrollIntoView**(item: object): void -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the specified item into view. -- **ScrollRangeIntoView**(minimum: double, maximum: double): void -- **ScrollRangeIntoViewAsync**(minimum: double, maximum: double): Task - -### [IgbCategoryYAxisModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCategoryYAxisModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCellInfo) -Represents info about the current cell. - -- **constructor**(): void -- **ActionManager**: `CellActionManager` — Gets the action manager to propagate actions back to the grid. -- **ActivationBorder**: `string` — Gets the actual background color of the cell -- **ActivationBorderBottomWidth**: `int` — Gets or sets the bottom activation border to use for the content. -- **ActivationBorderLeftWidth**: `int` — Gets or sets the left activation border to use for the content. -- **ActivationBorderRightWidth**: `int` — Gets or sets the right activation border to use for the content. -- **ActivationBorderTopWidth**: `int` — Gets or sets the top activation border to use for the content. -- **ActivationStatus**: `double` — Gets the amount that the cell is activated. This is a value between 0 and 1. -- **ActualBackground**: `string` — Gets the actual background color of the cell -- **ActualBorder**: `string` — Gets the actual background color of the cell -- **ActualBorderBottomWidth**: `int` — Gets or sets the actual bottom border to use for the content. -- **ActualBorderLeftWidth**: `int` — Gets or sets the actual left border to use for the content. -- **ActualBorderRightWidth**: `int` — Gets or sets the actual right border to use for the content. -- **ActualBorderTopWidth**: `int` — Gets or sets the actual top border to use for the content. -- **ActualContentOpacity**: `double` — Gets the actual content opacity of the cell. -- **ActualFontFamily**: `string` -- **ActualFontSize**: `double` -- **ActualFontStyle**: `string` -- **ActualFontWeight**: `string` -- **ActualOpacity**: `double` — Gets the actual opacity of the cell. -- **ActualPaddingBottom**: `int` — Gets or sets the bottom padding to use for the content. -- **ActualPaddingLeft**: `int` — Gets or sets the left padding to use for the content. -- **ActualPaddingRight**: `int` — Gets or sets the right padding to use for the content. -- **ActualPaddingTop**: `int` — Gets or sets the top padding to use for the content. -- **ActualTextColor**: `string` — Gets the actual color of the text for the cell, if any. -- **Background**: `string` — Gets or sets the background color of the cell. -- **Border**: `string` — Gets or sets the border color of the cell. -- **BorderBottomWidth**: `int` — Gets or sets the bottom border to use for the content. -- **BorderLeftWidth**: `int` — Gets or sets the left border to use for the content. -- **BorderRightWidth**: `int` — Gets or sets the right border to use for the content. -- **BorderTopWidth**: `int` — Gets or sets the top border to use for the content. -- **ContentOpacity**: `double` — Gets or sets the opacity of the content of the cell. -- **DataRow**: `int` — Gets the absolute data row for the current cell. -- **DeletedTextColor**: `string` — Gets or sets the text color for cells in deleted rows. -- **EditError**: `string` — Gets or sets the error message for the cell. -- **EditFontFamily**: `string` -- **EditFontSize**: `double` -- **EditFontStyle**: `string` -- **EditFontWeight**: `string` -- **EditID**: `int` -- **EditOpacity**: `double` — Gets or sets the opacity for cells that have unsaved edits. -- **ErrorBorder**: `string` — Gets or sets the error border color of the cell. -- **ErrorBorderBottomWidth**: `int` — Gets or sets the bottom error border to use for the content. -- **ErrorBorderLeftWidth**: `int` — Gets or sets the left error border to use for the content. -- **ErrorBorderRightWidth**: `int` — Gets or sets the right error border to use for the content. -- **ErrorBorderTopWidth**: `int` — Gets or sets the top error border to use for the content. -- **FilterRowBackground**: `string` — Gets or sets the background color for filter row. -- **FontFamily**: `string` -- **FontSize**: `double` -- **FontStyle**: `string` -- **FontWeight**: `string` -- **Height**: `int` — Gets the height of the cell. -- **HorizontalAlignment**: `CellContentHorizontalAlignment` — Gets or sets the horiztonal alignment of the cell content. -- **HoverBackground**: `string` — Gets or sets the hover background color of the cell. -- **HoverStatus**: `double` — Gets the amount that the cell is hovered. This is a value between 0 and 1. -- **HoverTextColor**: `string` — Gets or sets the hover text color of the cell. -- **Indent**: `int` — Gets the indent level of the cell. -- **IsBorderDirty**: `bool` — Gets if the content of the cell is dirty. -- **IsCollapsable**: `bool` — Gets if the cell needs to display an expansion indicator. -- **IsContentDirty**: `bool` — Gets if the content of the cell is dirty. -- **IsDataDirty**: `bool` — Gets if the data of the cell is dirty. -- **IsDeleted**: `bool` — Gets whether the cell is part of a deleted row. -- **IsEdited**: `bool` — Gets whether the cell has been edited. -- **IsExpanded**: `bool` — Gets the expansion state of the cell. -- **IsFilterRow**: `bool` — Gets if this cell is in the filter row. -- **IsHitTestVisible**: `bool` — Gets or sets whether the cell is hit test visible. -- **IsHoverable**: `bool` — Gets whether the cell is hoverable or not. -- **IsInEditMode**: `bool` — Gets whether the cell is in edit mode. -- **IsLastStickyRow**: `bool` — Gets if this cell is the last row that can stick to the top of the grid. -- **IsLayerDirty**: `bool` — Gets if the layer of the cell is dirty. -- **IsPlaceholdContentNeeded**: `bool` — Gets if placeholder content is needed when virtualized. -- **IsPositionDirty**: `bool` — Gets if the position of the cell is dirty. -- **IsRowPinned**: `bool` — Gets if this cell belongs to a row that has been marked as pinned. -- **IsRowSticky**: `bool` — Gets if this cell belongs to a row that will stick to the top of the grid. -- **IsSelected**: `bool` — Gets if the cell is selected. -- **IsSizeDirty**: `bool` — Gets if the size of the cell is dirty. -- **IsStateDirty**: `bool` — Gets if the layer of the cell is dirty. -- **LastStickyRowBackground**: `string` — Gets or sets the color for the last row in the sticky row area. -- **LineBreakMode**: `TextCellLineBreakMode` — Gets or sets the line break mode to use if text is present in the cell. -- **Opacity**: `double` — Gets or sets the opacity of the cell. -- **OriginalValue**: `object` — Gets or sets the original value for the cell, before processing. -- **OriginalValueScript**: `string` — Provides a means of setting OriginalValue in the JavaScript environment. -- **PaddingBottom**: `int` — Gets or sets the bottom padding to use for the content. -- **PaddingLeft**: `int` — Gets or sets the left padding to use for the content. -- **PaddingRight**: `int` — Gets or sets the right padding to use for the content. -- **PaddingTop**: `int` — Gets or sets the top padding to use for the content. -- **Pinned**: `PinnedPositions` — Gets the fixed column position of this cell. -- **PinnedRowBackground**: `string` — Gets or sets the background color for the cell that has been marked as pinned. -- **PinnedRowOpacity**: `double` — Gets or sets the color to use for displaying text. -- **RenderValue**: `string` — Gets or sets the text value, if any, which was rendered by a text cell. -- **RowItem**: `object` -- **RowItemScript**: `string` — Provides a means of setting RowItem in the JavaScript environment. -- **SelectedBackground**: `string` — Gets or sets the selected background color of the cell. -- **SelectedStatus**: `double` — Gets the amount that the cell is selected. This is a value between 0 and 1. -- **SnappedX**: `int` — Gets the pixel snapped X position of the cell within the content. -- **SnappedY**: `int` — Gets the snapped Y position of the cell within the content. -- **SortDirection**: `ColumnSortDirection` — Gets the current sort direction for the column containing the cell. -- **SortIndicatorColor**: `string` — Gets or sets the color for the sort indicator icon. -- **StickyRowBackground**: `string` — Gets or sets the background color for the cell when it is stuck to the top of the grid as a pinned row. -- **StyleKey**: `string` — Gets the style key of the current cell, used for recycling. -- **SuffixIconCollectionName**: `string` — Gets or sets the icon to display in the suffix area of the cell. -- **SuffixIconFill**: `string` — Gets or sets the fill color of the suffix icon. -- **SuffixIconName**: `string` — Gets or sets the icon to display in the suffix area of the cell. -- **SuffixIconStroke**: `string` — Gets or sets the stroke color of the suffix icon. -- **SuffixIconViewBoxHeight**: `double` — Gets or sets the suffix icon's viewbox height. -- **SuffixIconViewBoxLeft**: `double` — Gets or sets the suffix icon's viewbox x coordinate. -- **SuffixIconViewBoxTop**: `double` — Gets or sets the suffix icon's viewbox y coordinate. -- **SuffixIconViewBoxWidth**: `double` — Gets or sets the suffix icon's viewbox width. -- **SuffixMargin**: `double` — Gets or sets the suffix margin. -- **SuffixText**: `string` — Gets or sets the text to display in the suffix area of the cell. -- **SuffixTextColor**: `string` — Gets or sets the color of the suffix text for the cell, if any. -- **SuffixTextFontFamily**: `string` -- **SuffixTextFontSize**: `double` -- **SuffixTextFontStyle**: `string` -- **SuffixTextFontWeight**: `string` -- **TextColor**: `string` — Gets or sets the color of the text for the cell, if any. -- **TextDecoration**: `TextCellDecoration` — Gets or sets the text decorations to apply to the cell text. -- **Type**: `string` -- **UserFormattedValue**: `string` — If set, this text will be used when rendering the cell value. -- **VerticalAlignment**: `CellContentVerticalAlignment` — Gets or sets the vertical alignment of the cell content. -- **VirtualizationPercentage**: `double` — Gets or sets the virtualization percentage value. This is between 0 an 1, and indicates how virtual the content is at present. -- **Width**: `int` — Gets the width of the cell. -- **X**: `double` — Gets the X position of the cell within the content. -- **Y**: `double` — Gets the Y position of the cell within the content. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **GetNamedValue**(valueName: string): object -- **GetNamedValueAsync**(valueName: string): Task — Gets a named value from the cell. -- **HasNamedValue**(valueName: string): bool -- **HasNamedValueAsync**(valueName: string): Task — Returns if there is a named value stored for the cell. -- **IsCustomFieldDirty**(propertyName: string): bool -- **IsCustomFieldDirtyAsync**(propertyName: string): Task -- **IsDirty**(propertyName: string): bool -- **IsDirtyAsync**(propertyName: string): Task — Gets if a named property is dirty. -- **IsDirtyById**(propertyId_: int): bool -- **IsDirtyByIdAsync**(propertyId_: int): Task — Gets if a named property is dirty. -- **RemoveNamedValue**(valueName: string): void -- **RemoveNamedValueAsync**(valueName: string): Task — Removes a named value from the cell. -- **SetNamedValue**(valueName: string, value: object): void -- **SetNamedValueAsync**(valueName: string, value: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCellKey](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCellKey) -An indentifier for a specific cell in the grid. - -- **constructor**(): void -- **ColumnUniqueKey**: `string` — Gets or sets the column name associated with the cell. All columns in the grid must have a unique name. That unique name is what is used for this property. -- **PrimaryKey**: `IgbPrimaryKeyValue` — Gets or sets the primary key of the row associated with the cell. -- **ResolvedColumn**: `IgbDataGridColumn` -- **RowItem**: `object` — Gets or sets the row data object associated with the cell. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCellKeyModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCellKeyModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCellPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCellPosition) -The event is triggered when getting the current position of a certain cell - -- **constructor**(): void -- **RowIndex**: `double` — It returns the position (index) of the row, the cell is in -- **Type**: `string` -- **VisibleColumnIndex**: `double` — It returns the position (index) of the column, the cell is in Counts only the visible (non hidden) columns -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCellRange](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCellRange) -An indentifier for a specific cell in the grid. - -- **constructor**(): void -- **EndColumn**: `int` — Gets or sets the end column of the range. -- **EndRow**: `int` — Gets or sets the end row of the range. -- **StartColumn**: `int` — Gets or sets the start column of the range. -- **StartRow**: `int` — Gets or sets the start row of the range. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCellRangeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCellRangeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCellStyleRequestedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCellStyleRequestedEventArgs) -Information about the style request for a cell. - -- **constructor**(): void -- **ResolvedValue**: `object` — The resolved value for the cell. -- **ResolvedValueScript**: `string` — Provides a means of setting ResolvedValue in the JavaScript environment. -- **RowNumber**: `int` — The row number for the cell. -- **StyleKey**: `string` — The proposed style key for the cell. Used for recycling the cell. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCellTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCellTemplateContext) - -- **constructor**(): void -- **AdditionalTemplateContext**: `object` -- **Cell**: `IgbCellType` -- **Implicit**: `object` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCellType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCellType) -Interface representing a cell in the grid. It is essentially the blueprint to a cell object. Contains definitions of properties and methods, relevant to a cell - -- **constructor**(): void -- **Active**: `bool` — Indicates whether the cell is currently active (focused). -- **CellID**: `object` — Optional; The cellID is the unique key, used to identify the cell -- **Column**: `IgbColumn` — Represents the column that the cell belongs to. -- **EditMode**: `bool` — Indicates whether the cell is currently in edit mode. -- **EditValue**: `object` — The value to display when the cell is in edit mode. -- **Editable**: `bool` — Indicates whether the cell can be edited. -- **Grid**: `IgbGridBaseDirective` — Represents the grid instance containing the cell -- **Id**: `IgbGridCellIdentifier` — Optional; An object identifying the cell. It contains rowID, columnID, and rowIndex of the cell. -- **Readonly**: `bool` -- **Selected**: `bool` — Indicates whether the cell is currently selected. It is false, if the sell is not selected, and true, if it is. -- **Title**: `object` — An optional title to display for the cell -- **Type**: `string` -- **Validation**: `IgbGridValidationState` — Optional; An object representing the validation state of the cell. Whether it's valid or invalid, and if it has errors -- **Value**: `object` — The current value of the cell. -- **VisibleColumnIndex**: `double` — The index of the column that the cell belongs to. It counts only the visible (not hidden) columns -- **Width**: `string` — The CSS width of the cell as a string. -- **CalculateSizeToFit**(range: object): double -- **CalculateSizeToFitAsync**(range: object): Task — Optional; A method definition to calculate the size of the cell to fit the content The method can be used to calculate the size of the cell with the longest content and resize all cells to that size -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetEditMode**(value: bool): void -- **SetEditModeAsync**(value: bool): Task — A method definition to start or end the edit mode of the cell. It takes a boolean value as an argument -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void -- **Update**(value: object): void -- **UpdateAsync**(value: object): Task — A method definition to update the value of the cell. - -### [IgbChaikinOscillatorIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChaikinOscillatorIndicator) -Represents the IgbDataChart Chaikin Oscillator indicator series. - -- **constructor**(): void -- **LongPeriod**: `int` — Gets or sets the long moving average period for the current ChaikinOscillatorIndicator object. The typical, and initial, value for long CHO periods is 10. -- **ShortPeriod**: `int` — Gets or sets the short moving average period for the current ChaikinOscillatorIndicator object. The typical, and initial, value for short CHO periods is 3. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbChaikinOscillatorIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChaikinOscillatorIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbChaikinVolatilityIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChaikinVolatilityIndicator) -Represents a IgbDataChart Chaikin Volatility indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current ChaikinVolatilityIndicator object. The typical, and initial, value for ChaikinVolatilityIndicator periods is 10. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbChaikinVolatilityIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChaikinVolatilityIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbChartCursorEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartCursorEventArgs) -Provides data for IgbDataChart mouse button related events. - -- **constructor**(): void -- **Item**: `object` — Gets the ItemsSource item associated with the current event. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Series**: `IgbSeries` — Gets the series associated with the current event. -- **SeriesViewer**: `IgbSeriesViewer` — Gets the Chart associated with the current event. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbChartGroupDescription](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartGroupDescription) -Represents an element in the current grouping applied to a data source or provider. Changes to this object are not observed or expected after it is initially assigned to a collection. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbChartGroupDescriptionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartGroupDescriptionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbChartGroupDescriptionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartGroupDescriptionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbChartMouseEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartMouseEventArgs) -Provides data for IgbDataChart mouse button related events. - -- **constructor**(): void -- **Chart**: `IgbSeriesViewer` — Gets the Chart associated with the current event. -- **ChartPosition**: `Point` — Gets the mouse position relative to the chart. -- **Item**: `object` — Gets the ItemsSource item associated with the current event. -- **OriginalSource**: `object` — Gets a reference to the object that raised the event. -- **OriginalSourceScript**: `string` — Provides a means of setting OriginalSource in the JavaScript environment. -- **PlotAreaPosition**: `Point` — Gets the mouse position relative to the plot area. -- **Series**: `IgbSeries` — Gets the series associated with the current event. -- **SeriesScript**: `string` — Provides a means of setting Series in the JavaScript environment. -- **Type**: `string` -- **WorldPosition**: `Point` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **GetPosition**(relativeTo: object): Point -- **GetPositionAsync**(relativeTo: object): Task — Returns the x- and y- coordinates of the mouse pointer position, optionally evaluated against the origin of a supplied UIElement. -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbChartResizeIdleEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartResizeIdleEventArgs) -Provides information about the chart going idle from being resized. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbChartSelectedItemCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartSelectedItemCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbChartSelection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartSelection) -Represents a selected item within the chart. This should be treated as immutable while in the selected items collection. Changes while part of the collection will not be respected. - -- **constructor**(): void -- **Item**: `object` -- **Matcher**: `IgbSeriesMatcher` — If set, allows for selecting a series based on a matcher. This should resolve to a single static series at the time that the chart selection is added to selected items. It will not be re-evaluated while the ChartSelection is in the selected items. -- **Series**: `IgbSeries` -- **SeriesScript**: `string` — Provides a means of setting Series in the JavaScript environment. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbChartSelectionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartSelectionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbChartSeriesEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartSeriesEventArgs) -Represents event arguments for chart's SeriesAdded and SeriesRemoved events - -- **constructor**(): void -- **Series**: `IgbSeries` — Gets the series. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbChartSortDescription](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartSortDescription) -Represents an element in the current sort applied to a data source or provider. Changes to this object are not observed or expected after it is initially assigned to a collection. - -- **constructor**(): void -- **Field**: `string` — Gets or sets the property being sorted. -- **SortDirection**: `ListSortDirection` — Gets or sets the direction to sort based on the property. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbChartSortDescriptionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartSortDescriptionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbChartSortDescriptionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartSortDescriptionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbChartSummaryDescription](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartSummaryDescription) -Represents a summary that is applied to a datasource. Changes to this object are not observed or expected after it is initially assigned to a collection. - -- **constructor**(): void -- **Alias**: `string` — Gets or sets an alias for the summary. Currently only used in aggregated data situations. -- **CalculatorDisplayName**: `string` — Gets or sets the name to use when displaying the calculator name. -- **Field**: `string` -- **Operand**: `DataSourceSummaryOperand` -- **ProvideCalculator**: `EventCallback` -- **ProvideCalculatorScript**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbChartSummaryDescriptionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartSummaryDescriptionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbChartSummaryDescriptionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChartSummaryDescriptionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCheckbox](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCheckbox) -A check box allowing single values to be selected/deselected. - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **Indeterminate**: `bool` — Draws the checkbox in indeterminate state. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbCheckboxBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCheckboxBase) - -- **constructor**(): void -- **Blur**: `EventCallback` -- **BlurScript**: `string` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Checked**: `bool` — The checked state of the control. -- **CheckedChanged**: `EventCallback` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — The disabled state of the component -- **Focus**: `EventCallback` -- **FocusScript**: `string` -- **Invalid**: `bool` — Control the validity of the control. -- **LabelPosition**: `ToggleLabelPosition` — The label position of the control. -- **Required**: `bool` — Makes the control a required field in a form context. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `string` — The value attribute of the control. -- **BlurComponent**(): void -- **BlurComponentAsync**(): Task — Removes focus from the control. -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task — Checks for validity of the control and emits the invalid event if it invalid. -- **Click**(): void -- **ClickAsync**(): Task — Simulates a click on the control. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FocusComponent**(options: IgbFocusOptions): void -- **FocusComponentAsync**(options: IgbFocusOptions): Task — Sets focus on the control. -- **GetCurrentChecked**(): bool -- **GetCurrentCheckedAsync**(): Task -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task — Checks for validity of the control and shows the browser message if it invalid. -- **ResolveDisplay**(): string -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task — Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid. -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCheckboxBaseModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCheckboxBaseModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCheckboxChangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCheckboxChangeEventArgs) - -- **constructor**(): void -- **Detail**: `IgbCheckboxChangeEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCheckboxChangeEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCheckboxChangeEventArgsDetail) - -- **constructor**(): void -- **Checked**: `bool` -- **Type**: `string` -- **Value**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCheckboxList](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCheckboxList) - -- **constructor**(): void -- **ActualSelectAllCaptionTextColor**: `string` — Gets or sets the color to use for the actual header selectAllCaption text. -- **BackgroundColor**: `string` — Gets or sets the color to use for the background of the component. -- **BaseTheme**: `BaseControlTheme` — Gets or Sets the property name that contains the values. -- **CellFontFamily**: `string` -- **CellFontSize**: `double` -- **CellFontStyle**: `string` -- **CellFontWeight**: `string` -- **CheckboxAlignedRight**: `bool` — Gets or sets whether checkbox should be displayed to the right. -- **CheckboxCheckedBackgroundColor**: `string` — Gets or sets the checkbox background color when checked. -- **CheckboxCheckedBorderColor**: `string` — Gets or sets the checkbox border color when checked. -- **CheckboxCornerRadius**: `double` — Gets or sets the corner radius to use for the checkbox. -- **CheckboxTickColor**: `string` — Gets or sets the checkbox tick color. -- **CheckboxUncheckedBackgroundColor**: `string` — Gets or sets the checkbox background color when unchecked. -- **CheckboxUncheckedBorderColor**: `string` — Gets or sets the checkbox border color when unchecked. -- **CheckedChanged**: `Action` -- **CheckedChangedScript**: `string` -- **DataLegendTarget**: `object` -- **DataLegendTargetScript**: `string` — Provides a means of setting DataLegendTarget in the JavaScript environment. -- **DataMemberPath**: `string` — Gets or Sets the property name that contains the values. -- **DataSource**: `object` — Gets or sets the data or data source instance to which to bind the grid. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or Sets the property name that contains the values. -- **FilterPlaceholderText**: `string` — Gets or Sets the property name that contains the values. -- **IndexType**: `CheckboxListIndexType` — Gets or Sets the property name that contains the values. -- **IndexTypeChanged**: `EventCallback` -- **IndexTypeChangedScript**: `string` -- **IsRowHoverEnabled**: `bool` — Gets or sets whether row hover highlighting is enabled. -- **Keys**: `IgbGridSelectedKeysCollection` — Gets the collection responsible for selection in the CheckboxList. Selection is determined by two factors: whether everything is selected or deselected and the values present in this collection. If everything is selected then any items in this collection will be deselected. If everything is deselected then any items in this collection will be selected. The CheckboxList defaults all items as deselected. This state can change when you use the SelectAll and DeselectAll methods. -- **KeysCleared**: `EventCallback` -- **KeysClearedScript**: `string` -- **LabelClickTriggersChange**: `bool` — Gets or sets the search background color. -- **LabelClicked**: `Action` -- **LabelClickedScript**: `string` -- **PrimaryKey**: `string[]` — Gets or sets the primary key to use for the CheckboxList. -- **PropertyTypeMemberPath**: `string` -- **RowHeight**: `int` — Gets or Sets the property name that contains the values. -- **RowHoverBackgroundColor**: `string` — Gets or sets the color to use when hovering over a grid row. -- **ScrollbarBackground**: `string` — Gets or sets the scrollbar background color. -- **ScrollbarStyle**: `ScrollbarStyle` — Gets or sets the style of scrollbar. -- **SearchBackgroundColor**: `string` — Gets or sets the search background color. -- **SearchBorderColor**: `string` — Gets or sets the search border color. -- **SearchFontFamily**: `string` -- **SearchFontSize**: `double` -- **SearchFontStyle**: `string` -- **SearchFontWeight**: `string` -- **SearchIconColor**: `string` — Gets or sets the search icon color. -- **SearchInputType**: `InputGroupDisplayType` — Gets or Sets the property name that contains the values. -- **SearchTextColor**: `string` — Gets or sets the search text color. -- **SelectAllCaption**: `string` — Gets / sets the caption of the "Select All" checkbox. -- **SelectAllCaptionTextColor**: `string` — Gets or sets the color to use for the "Select All" label. -- **SelectAllCheckboxChanged**: `Action` -- **SelectAllCheckboxChangedScript**: `string` -- **SelectedKeyAdded**: `Action` -- **SelectedKeyAddedScript**: `string` -- **SelectedKeyRemoved**: `Action` -- **SelectedKeyRemovedScript**: `string` -- **SelectedMemberPath**: `string` — Gets or Sets the property name that contains the values. -- **ShowFilter**: `bool` — Gets or sets whether the filter input is visible. -- **ShowSelectAll**: `bool` — Gets / sets whether the "Select all" checkbox is visible. -- **SubtitleMemberPath**: `string` — Gets or Sets the property name that contains the values. -- **TextColor**: `string` — Gets or sets the color to use for the text of the component. -- **Type**: `string` -- **AddKeyValue**(value: object[]): void -- **AddKeyValueAsync**(value: object[]): Task -- **DeselectAll**(): void -- **DeselectAllAsync**(): Task — Deselects all the items in the checkbox list. -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualModel**(): string -- **ExportSerializedVisualModelAsync**(): Task — Returns a serialized copy of the exported visual model -- **ExportVisualModel**(): object -- **ExportVisualModelAsync**(): Task — Exports visual information about the current state of the grid. -- **FindByName**(name: string): object -- **IsEverythingSelected**(): bool -- **IsEverythingSelectedAsync**(): Task — Returns true if all of the items are selected / checked; otherwise false. -- **IsNothingSelected**(): bool -- **IsNothingSelectedAsync**(): Task — Returns true if no items are selected / checked; otherwise false. -- **NotifyClearItems**(): void -- **NotifyClearItemsAsync**(): Task — Manually notifies the checkboxlist's grid that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the grid is bound to is already observable. -- **NotifyInsertItem**(index: int, newItem: object): void -- **NotifyInsertItemAsync**(index: int, newItem: object): Task -- **NotifyRemoveItem**(index: int, oldItem: object): void -- **NotifyRemoveItemAsync**(index: int, oldItem: object): Task -- **NotifySetItem**(index: int, oldItem: object, newItem: object): void -- **NotifySetItemAsync**(index: int, oldItem: object, newItem: object): Task -- **Refresh**(): void -- **RefreshAsync**(): Task -- **RemoveKeyValue**(value: object[]): void -- **RemoveKeyValueAsync**(value: object[]): Task -- **SelectAll**(): void -- **SelectAllAsync**(): Task — selects all the items in the checkbox list. - -### [IgbCheckboxListIndexTypeChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCheckboxListIndexTypeChangedEventArgs) - -- **constructor**(): void -- **NewValue**: `CheckboxListIndexType` -- **OldValue**: `CheckboxListIndexType` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCheckboxListKeysClearedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCheckboxListKeysClearedEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCheckboxListModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCheckboxListModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCheckboxModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCheckboxModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCheckedChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCheckedChangedEventArgs) - -- **constructor**(): void -- **Index**: `int` -- **IsChecked**: `bool` -- **PrimaryKey**: `object[]` -- **PrimaryKeyScript**: `string` — Provides a means of setting PrimaryKey in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbChip](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChip) -Chips help people enter information, make selections, filter content, or trigger actions. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — Sets the disabled state for the chip. -- **Removable**: `bool` — Defines if the chip is removable or not. -- **Remove**: `EventCallback` -- **RemoveScript**: `string` -- **Select**: `EventCallback` -- **SelectScript**: `string` -- **Selectable**: `bool` — Defines if the chip is selectable or not. -- **Selected**: `bool` — Defines if the chip is selected or not. -- **SelectedChanged**: `EventCallback` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Variant**: `StyleVariant` — A property that sets the color variant of the chip component. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentSelected**(): bool -- **GetCurrentSelectedAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbChipModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbChipModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCircularGradient](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCircularGradient) -Used for defining gradient stops in the igc-circular-progress. For each igc-circular-gradient defined as gradient slot of igc-circular-progress element would be created a SVG stop element. The values passed as color, offset and opacity would be set as stop-color, offset and stop-opacity of the SVG element without further validations. - -- **constructor**(): void -- **Color**: `string` — Defines the color of the gradient stop -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Offset**: `string` — Defines where the gradient stop is placed along the gradient vector -- **Opacity**: `double` — Defines the opacity of the gradient stop -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCircularGradientModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCircularGradientModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCircularProgress](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCircularProgress) -A circular progress indicator used to express unspecified wait time or display the length of a process. - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbCircularProgressModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCircularProgressModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbClipboardOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbClipboardOptions) -An interface describing settings for clipboard options - -- **constructor**(): void -- **CopyFormatters**: `bool` — Apply the columns formatters (if any) on the data in the clipboard output. -- **CopyHeaders**: `bool` — Include the columns headers in the clipboard output. -- **Enabled**: `bool` — Enables/disables the copy behavior -- **Separator**: `string` — The separator used for formatting the copy output. Defaults to \t. -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbColorEditor](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColorEditor) - -- **constructor**(): void -- **AllowTextInput**: `bool` — Gets or sets the AllowTextInput property to detirmine if entering text into the input is allowed -- **BaseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the date picker. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or sets the display density to use for the date pcicker. -- **GotFocus**: `EventCallback` -- **GotFocusScript**: `string` -- **IconColor**: `string` — Gets or Sets the text color -- **IsDisabled**: `bool` -- **IsFixed**: `bool` — Indicates that the editor dropdown will position itself relative to the window instead of the document. -- **Label**: `string` — Gets or Sets the property name that contains the label. -- **LabelFontFamily**: `string` -- **LabelFontSize**: `double` -- **LabelFontStyle**: `string` -- **LabelFontWeight**: `string` -- **LabelTextColor**: `string` — Gets or sets the color to use for the text. -- **LostFocus**: `EventCallback` -- **LostFocusScript**: `string` -- **OpenAsChild**: `bool` — Indicates that the dropdown should open as a child of the color editor. -- **OpenOnFocus**: `bool` — Gets or sets the AllowTextInput property to detirmine if entering text into the input is allowed -- **ShowClearButton**: `bool` — Gets or sets the ShowClearButton property to detirmine if the clear button is shown -- **TextColor**: `string` — Gets or Sets the text color -- **TextFontFamily**: `string` -- **TextFontSize**: `double` -- **TextFontStyle**: `string` -- **TextFontWeight**: `string` -- **Type**: `string` -- **UseTopLayer**: `bool` — Indicates that the dropdown will place itself into the browser top layer. -- **Value**: `string` — Gets or Sets color value of the editor. -- **ValueChanged**: `Action` -- **ValueChangedScript**: `string` -- **ValueChanging**: `Action` -- **ValueChangingScript**: `string` -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualModel**(): string -- **ExportSerializedVisualModelAsync**(): Task — Returns a serialized copy of the exported visual model -- **ExportVisualModel**(): object -- **ExportVisualModelAsync**(): Task — Exports visual information about the current state of the color editor. -- **FindByName**(name: string): object -- **GetCurrentValue**(): string -- **GetCurrentValueAsync**(): Task -- **Select**(): void -- **SelectAsync**(): Task - -### [IgbColorEditorGotFocusEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColorEditorGotFocusEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColorEditorLostFocusEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColorEditorLostFocusEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColorEditorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColorEditorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColorEditorPanel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColorEditorPanel) - -- **constructor**(): void -- **ActualPixelScalingRatio**: `double` -- **BackgroundColor**: `string` — Gets or Sets the selected color background color -- **BaseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the ColorEditorPanel. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or sets the display density to use for the ColorEditorPanel. -- **FocusColorBorderColor**: `string` — Gets or Sets the focus color border color -- **FontFamily**: `string` -- **FontSize**: `double` -- **FontStyle**: `string` -- **FontWeight**: `string` -- **HoverBackgroundColor**: `string` — Gets or Sets the focus date background color -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **SelectedColorBorderColor**: `string` — Gets or Sets the selected color boreder color -- **SelectedFocusDateBackgroundColor**: `string` — Gets or Sets the selected color border color -- **TextColor**: `string` — Gets or Sets the selected date text color -- **Type**: `string` -- **Value**: `string` — Gets or Sets the value for the color editor panel. -- **ValueChanged**: `EventCallback` -- **ValueChangedScript**: `string` -- **ValueChanging**: `Action` -- **ValueChangingScript**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): string -- **GetCurrentValueAsync**(): Task - -### [IgbColorEditorPanelClosedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColorEditorPanelClosedEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColorEditorPanelModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColorEditorPanelModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColorEditorPanelSelectedValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColorEditorPanelSelectedValueChangedEventArgs) - -- **constructor**(): void -- **NewValue**: `string` -- **OldValue**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColorScale](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColorScale) -Base class for classes which provide colors corresponding to numeric values within a known list of numeric values. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbColumn](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumn) - -- **constructor**(): void -- **AdditionalTemplateContext**: `object` -- **AutosizeHeader**: `bool` -- **BodyTemplate**: `RenderFragment` — Returns a reference to the bodyTemplate. let bodyTemplate = this.column.bodyTemplate; IgxColumnComponent -- **BodyTemplateScript**: `string` — Provides a means of setting BodyTemplate in the JavaScript environment. -- **CellClasses**: `object` -- **CellClassesScript**: `string` — Provides a means of setting CellClasses in the JavaScript environment. -- **CellStyles**: `object` -- **CellStylesScript**: `string` — Provides a means of setting CellStyles in the JavaScript environment. -- **ColEnd**: `double` -- **ColStart**: `double` -- **ColumnGroupParent**: `BaseRendererElement` -- **DataType**: `GridColumnDataType` -- **DisableHiding**: `bool` — Gets whether the hiding is disabled. let isHidingDisabled = this.column.disableHiding; IgxColumnComponent -- **DisablePinning**: `bool` — Gets whether the pinning is disabled. let isPinningDisabled = this.column.disablePinning; IgxColumnComponent -- **DisabledSummaries**: `string[]` -- **Editable**: `bool` — Gets whether the column is editable. Default value is false. let isEditable = this.column.editable; IgxColumnComponent -- **EditorOptions**: `IgbColumnEditorOptions` -- **ErrorTemplate**: `RenderFragment` — Returns a reference to the validation error template. let errorTemplate = this.column.errorTemplate; -- **ErrorTemplateScript**: `string` — Provides a means of setting ErrorTemplate in the JavaScript environment. -- **ExpandedChange**: `EventCallback` -- **ExpandedChangeScript**: `string` -- **Field**: `string` -- **FilterCellTemplate**: `RenderFragment` — Returns a reference to the filterCellTemplate. let filterCellTemplate = this.column.filterCellTemplate; IgxColumnComponent -- **FilterCellTemplateScript**: `string` — Provides a means of setting FilterCellTemplate in the JavaScript environment. -- **Filterable**: `bool` -- **FilteringIgnoreCase**: `bool` -- **Filters**: `IgbFilteringOperand` — Gets the column filters. let columnFilters = this.column.filters' IgxColumnComponent -- **FormatterScript**: `string` — Provides a means of setting Formatter in the JavaScript environment. -- **GridBaseDirectiveParent**: `BaseRendererControl` -- **Groupable**: `bool` -- **HasSummary**: `bool` — Gets a value indicating whether the summary for the column is enabled. let hasSummary = this.column.hasSummary; IgxColumnComponent -- **Header**: `string` -- **HeaderClasses**: `string` -- **HeaderGroupClasses**: `string` -- **HeaderGroupStyles**: `object` -- **HeaderStyles**: `object` -- **HeaderTemplate**: `RenderFragment` — Returns a reference to the header template. let headerTemplate = this.column.headerTemplate; IgxColumnComponent -- **HeaderTemplateScript**: `string` — Provides a means of setting HeaderTemplate in the JavaScript environment. -- **Hidden**: `bool` — Gets whether the column is hidden. let isHidden = this.column.hidden; IgxColumnComponent -- **HiddenChange**: `EventCallback` -- **HiddenChangeScript**: `string` -- **HierarchicalGridParent**: `BaseRendererControl` -- **InlineEditorTemplate**: `RenderFragment` — Returns a reference to the inline editor template. let inlineEditorTemplate = this.column.inlineEditorTemplate; IgxColumnComponent -- **InlineEditorTemplateScript**: `string` — Provides a means of setting InlineEditorTemplate in the JavaScript environment. -- **MaxWidth**: `string` -- **Merge**: `bool` -- **MinWidth**: `string` -- **ParentColumn**: `object` — Sets/gets the parent column. let parentColumn = this.column.parent; this.column.parent = higherLevelColumn; -- **Pinned**: `bool` — Gets whether the column is pinned. let isPinned = this.column.pinned; IgxColumnComponent -- **PinnedChange**: `EventCallback` -- **PinnedChangeScript**: `string` -- **PinningPosition**: `ColumnPinningPosition` — Gets the pinning position of the column. let pinningPosition = this.column.pinningPosition; -- **PipeArgs**: `IgbColumnPipeArgs` -- **Resizable**: `bool` -- **RowEnd**: `double` -- **RowIslandParent**: `BaseRendererElement` -- **RowStart**: `double` -- **Searchable**: `bool` -- **Selectable**: `bool` — Returns if the column is selectable. let columnSelectable = this.column.selectable; IgxColumnComponent -- **Selected**: `bool` — Returns if the column is selected. let isSelected = this.column.selected; IgxColumnComponent -- **SortStrategy**: `IgbSortingStrategy` — Gets the column sortStrategy. let sortStrategy = this.column.sortStrategy IgxColumnComponent -- **Sortable**: `bool` -- **SortingIgnoreCase**: `bool` -- **Summaries**: `object` — Gets the column summaries. let columnSummaries = this.column.summaries; IgxColumnComponent -- **SummariesScript**: `string` — Provides a means of setting Summaries in the JavaScript environment. -- **SummaryFormatterScript**: `string` — Provides a means of setting SummaryFormatter in the JavaScript environment. -- **SummaryTemplate**: `RenderFragment` — Returns a reference to the summaryTemplate. let summaryTemplate = this.column.summaryTemplate; IgxColumnComponent -- **SummaryTemplateScript**: `string` — Provides a means of setting SummaryTemplate in the JavaScript environment. -- **Title**: `string` -- **Type**: `string` -- **VisibleWhenCollapsed**: `bool` -- **Width**: `string` — Gets the width of the column. let columnWidth = this.column.width; IgxColumnComponent -- **WidthChange**: `EventCallback` -- **WidthChangeScript**: `string` -- **Autosize**(byHeaderOnly: bool): void -- **AutosizeAsync**(byHeaderOnly: bool): Task — Autosize the column to the longest currently visible cell value, including the header cell. @ViewChild('grid') grid: IgxGridComponent; let column = this.grid.columnList.filter(c => c.field === 'ID')[0]; column.autosize(); IgxColumnComponent byHeaderOnly Set if column should be autosized based only on the header content. -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **GetChildColumns**(): IgbColumn[] -- **GetChildColumnsAsync**(): Task -- **GetColumnLayoutChild**(): bool -- **GetColumnLayoutChildAsync**(): Task -- **GetFilteringExpressionsTree**(): IgbFilteringExpressionsTree -- **GetFilteringExpressionsTreeAsync**(): Task -- **GetIndex**(): double -- **GetIndexAsync**(): Task -- **GetLevel**(): double -- **GetLevelAsync**(): Task -- **GetTopLevelParent**(): IgbColumn -- **GetTopLevelParentAsync**(): Task -- **GetVisibleIndex**(): double -- **GetVisibleIndexAsync**(): Task -- **Move**(index: double): void -- **MoveAsync**(index: double): Task — Moves a column to the specified visible index. If passed index is invalid, or if column would receive a different visible index after moving, moving is not performed. If passed index would move the column to a different column group. moving is not performed. column.move(index); IgxColumnComponent -- **OnInitializedAsync**(): Task -- **Pin**(index: double, pinningPosition: ColumnPinningPosition?): bool -- **PinAsync**(index: double, pinningPosition: ColumnPinningPosition?): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void -- **Unpin**(index: double): bool -- **UnpinAsync**(index: double): Task — Unpins the column and place it at the provided index in the unpinned area. Defaults to index 0 if not provided, or to the initial index in the unpinned area. Returns true if the column is successfully unpinned. Returns false if the column cannot be unpinned. Column cannot be unpinned if: Is already unpinned index argument is out of range let success = this.column.unpin(); IgxColumnComponent - -### [IgbColumnChooser](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnChooser) - -- **constructor**(): void -- **BackgroundColor**: `string` — Gets or Sets the property name that contains the values. -- **BaseTheme**: `BaseControlTheme` — Gets or Sets the property name that contains the values. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or Sets the property name that contains the values. -- **FilterPlaceholderText**: `string` — Gets or Sets the property name that contains the values. -- **TargetGrid**: `IgbDataGrid` — Gets or Sets the property name that contains the values. -- **TargetGridScript**: `string` — Provides a means of setting TargetGrid in the JavaScript environment. -- **Title**: `string` — Gets or Sets the property name that contains the values. -- **TitleColor**: `string` — Gets or Sets the property name that contains the values. -- **TitleFontFamily**: `string` -- **TitleFontSize**: `double` -- **TitleFontStyle**: `string` -- **TitleFontWeight**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbColumnChooserModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnChooserModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbColumnComparisonFilterCondition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnComparisonFilterCondition) - -- **constructor**(): void -- **IsCaseSensitive**: `bool` -- **Operator**: `ColumnComparisonConditionOperatorType` -- **Type**: `string` -- **Value**: `object` -- **ValueScript**: `string` — Provides a means of setting Value in the JavaScript environment. -- **FindByName**(name: string): object - -### [IgbColumnComponentEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnComponentEventArgs) - -- **constructor**(): void -- **Detail**: `IgbColumn` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnCustomFilterCondition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnCustomFilterCondition) - -- **constructor**(): void -- **Id**: `string` — Gets or sets the ID of the custom filter to be used. -- **Index**: `int` — Gets or sets the index of the custom filter in the column FilterOperands collection. -- **Type**: `string` -- **Value**: `object` — Gets or sets the value of the custom filter condition. -- **ValueScript**: `string` — Provides a means of setting Value in the JavaScript environment. -- **FindByName**(name: string): object - -### [IgbColumnDependenciesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnDependenciesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnEditorOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnEditorOptions) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbColumnExchanger](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnExchanger) -Indicates a column that should be exchanged with another. - -- **constructor**(): void -- **TargetIndex**: `int` — The desired location of the new column -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbColumnExchangersCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnExchangersCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbColumnExportingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnExportingEventArgs) -columnExporting event arguments this.exporterService.columnExporting.subscribe((args: IColumnExportingEventArgs) => { // set args properties here }); - -- **constructor**(): void -- **Detail**: `IgbColumnExportingEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnExportingEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnExportingEventArgsDetail) -columnExporting event arguments this.exporterService.columnExporting.subscribe((args: IColumnExportingEventArgs) => { // set args properties here }); - -- **constructor**(): void -- **Cancel**: `bool` — Skip the exporting column when set to true -- **ColumnIndex**: `double` — Contains the exporting column index -- **Field**: `string` — Contains the exporting column field name -- **Grid**: `IgbGridBaseDirective` — A reference to the grid owner. -- **Header**: `string` — Contains the exporting column header -- **SkipFormatter**: `bool` — Export the column's data without applying its formatter, when set to true -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnFilterCondition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnFilterCondition) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **IsGroup**(): bool -- **IsGroupAsync**(): Task - -### [IgbColumnFilterConditionGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnFilterConditionGroup) - -- **constructor**(): void -- **Item**: `IgbColumnFilterCondition` -- **Type**: `string` -- **UsesOrOperator**: `bool` -- **Add**(condition: IgbColumnFilterCondition): void -- **AddAsync**(condition: IgbColumnFilterCondition): Task -- **Clear**(): void -- **ClearAsync**(): Task -- **FindByName**(name: string): object -- **IsGroup**(): bool -- **IsGroupAsync**(): Task -- **Remove**(condition: IgbColumnFilterCondition): void -- **RemoveAsync**(condition: IgbColumnFilterCondition): Task -- **RemoveAt**(index: int): void -- **RemoveAtAsync**(index: int): Task -- **ToArray**(): IgbColumnFilterCondition[] -- **ToArrayAsync**(): Task - -### [IgbColumnFragment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnFragment) -Represents one part of a StackedColumnSeries. - -- **constructor**(): void -- **RadiusX**: `double` — Gets or sets the x-radius of the ellipse that is used to round the corners of the column. -- **RadiusY**: `double` — Gets or sets the y-radius of the ellipse that is used to round the corners of the column. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemIndex**(world: Point): int -- **GetItemIndexAsync**(world: Point): Task — Gets the index of the item that resides at the provided world coordinates. -- **GetSeriesValueBoundingBox**(world: Point): Rect -- **GetSeriesValueBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. - -### [IgbColumnFragmentModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnFragmentModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnGroup) -Ignite UI for Angular Column Group IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxColumnGroupComponent, IgxRowIslandComponent - -- **constructor**(): void -- **ActualChildren**: `IgbColumnCollection` -- **Children**: `IgbColumnCollection` -- **Collapsible**: `bool` -- **CollapsibleIndicatorTemplate**: `RenderFragment` — Allows you to define a custom template for expand/collapse indicator IgxColumnGroupComponent -- **CollapsibleIndicatorTemplateScript**: `string` — Provides a means of setting CollapsibleIndicatorTemplate in the JavaScript environment. -- **ContentChildren**: `IgbColumnCollection` -- **Expanded**: `bool` -- **ParentTypeName**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnGroupDescription](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnGroupDescription) -Represents an element in the current grouping applied to a data source or provider. Changes to this object are not observed or expected after it is initially assigned to a collection. - -- **constructor**(): void -- **DisplayFormat**: `string` — Gets or sets the display format for the group text in the group header. -- **DisplayFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the DisplayFormat string. -- **DisplayName**: `string` — Gets or sets the display text for the group name. -- **FormatText**: `EventCallback` -- **FormatTextScript**: `string` -- **Type**: `string` -- **ValueFormat**: `string` — Gets or sets the format string for the group value. -- **ValueFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the ValueFormat string. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnGroupDescriptionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnGroupDescriptionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbColumnGroupDescriptionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnGroupDescriptionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnGroupModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnGroupModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnGrouping](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnGrouping) - -- **constructor**(): void -- **BackgroundColor**: `string` — Gets or sets the background of the group by area. -- **BaseTheme**: `BaseControlTheme` — Gets or Sets the property name that contains the values. -- **ColumnGroupTitleFontFamily**: `string` -- **ColumnGroupTitleFontSize**: `double` -- **ColumnGroupTitleFontStyle**: `string` -- **ColumnGroupTitleFontWeight**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or Sets the property name that contains the values. -- **IconColor**: `string` — Gets or Sets the property name that contains the values. -- **ItemBackgroundColor**: `string` — Gets or sets the background color of the column items in the group area. -- **ItemHoverBackgroundColor**: `string` — Gets or sets the background color of the column items when hovered by the mouse. -- **TargetGrid**: `IgbDataGrid` — Gets or Sets the property name that contains the values. -- **TargetGridScript**: `string` — Provides a means of setting TargetGrid in the JavaScript environment. -- **TextColor**: `string` — Gets or Sets the property name that contains the values. -- **Title**: `string` — Gets or Sets the property name that contains the values. -- **TitleColor**: `string` — Gets or Sets the property name that contains the values. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualModel**(): string -- **ExportSerializedVisualModelAsync**(): Task — Returns a serialized copy of the exported visual model -- **ExportVisualModel**(): object -- **ExportVisualModelAsync**(): Task — Exports visual information about the current state of the grid. -- **FindByName**(name: string): object - -### [IgbColumnGroupingModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnGroupingModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnHiddenChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnHiddenChangedEventArgs) - -- **constructor**(): void -- **Column**: `IgbDataGridColumn` -- **IsHidden**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnLayout](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnLayout) -Column layout for declaration of Multi-row Layout IgxGridComponent - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnLayoutModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnLayoutModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnMovingEndEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnMovingEndEventArgs) -Represents event arguments related to the end of a column moving operation in a grid - -- **constructor**(): void -- **Detail**: `IgbColumnMovingEndEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnMovingEndEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnMovingEndEventArgsDetail) -Represents event arguments related to the end of a column moving operation in a grid - -- **constructor**(): void -- **Cancel**: `bool` — cancel returns whether the event has been intercepted and stopped If the value becomes "true", it returns/exits from the method, instantiating the interface -- **Source**: `IgbColumn` — The source of the event represents the column that is being moved. The ColumnType contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties -- **Target**: `IgbColumn` — The target of the event represents the column, the source is being moved to. The ColumnType contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnMovingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnMovingEventArgs) -Represents event arguments related to a column moving operation in a grid - -- **constructor**(): void -- **Detail**: `IgbColumnMovingEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnMovingEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnMovingEventArgsDetail) -Represents event arguments related to a column moving operation in a grid - -- **constructor**(): void -- **Cancel**: `bool` — cancel returns whether the event has been intercepted and stopped If the value becomes "true", it returns/exits from the method, instantiating the interface -- **Source**: `IgbColumn` — Represents the column that is being moved. The ColumnType contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnMovingSeparator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnMovingSeparator) - -- **constructor**(): void -- **ActualOpacity**: `double` -- **Opacity**: `double` -- **SeparatorWidth**: `int` — Gets or sets the separator width for this column. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbColumnMovingSeparatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnMovingSeparatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnMovingStartEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnMovingStartEventArgs) -Represents event arguments related to the start of a column moving operation in a grid. - -- **constructor**(): void -- **Detail**: `IgbColumnMovingStartEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnMovingStartEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnMovingStartEventArgsDetail) -Represents event arguments related to the start of a column moving operation in a grid. - -- **constructor**(): void -- **Source**: `IgbColumn` — Represents the column that is being moved. The ColumnType contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnPinnedChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnPinnedChangedEventArgs) -Event arguments for the ColumnPinnedChanged event. - -- **constructor**(): void -- **Column**: `IgbDataGridColumn` — The column whose pinned state has changed. -- **Pinned**: `PinnedPositions` — The new pinned state for the column. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnPinning](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnPinning) - -- **constructor**(): void -- **BackgroundColor**: `string` — Gets or Sets the property name that contains the values. -- **BaseTheme**: `BaseControlTheme` — Gets or Sets the property name that contains the values. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or Sets the property name that contains the values. -- **FilterPlaceholderText**: `string` — Gets or Sets the property name that contains the values. -- **TargetGrid**: `IgbDataGrid` — Gets or Sets the property name that contains the values. -- **TargetGridScript**: `string` — Provides a means of setting TargetGrid in the JavaScript environment. -- **Title**: `string` — Gets or Sets the property name that contains the values. -- **TitleColor**: `string` — Gets or Sets the property name that contains the values. -- **TitleFontFamily**: `string` -- **TitleFontSize**: `double` -- **TitleFontStyle**: `string` -- **TitleFontWeight**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbColumnPinningModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnPinningModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnPipeArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnPipeArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbColumnPropertySetter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnPropertySetter) -Indicates that a specified column should have a specified property set to a value. - -- **constructor**(): void -- **ColumnName**: `string` — The name or key of the column to change the property of -- **PropertyName**: `string` — The name of the property to change -- **Type**: `string` -- **Value**: `object` — The new value of the property -- **ValueScript**: `string` — Provides a means of setting Value in the JavaScript environment. -- **FindByName**(name: string): object - -### [IgbColumnPropertySettersCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnPropertySettersCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbColumnResizeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnResizeEventArgs) -The event arguments when a column is being resized - -- **constructor**(): void -- **Detail**: `IgbColumnResizeEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnResizeEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnResizeEventArgsDetail) -The event arguments when a column is being resized - -- **constructor**(): void -- **Column**: `IgbColumn` — Represents the information of the column that is being resized -- **NewWidth**: `string` — Represents the new width, the column is being resized to -- **PrevWidth**: `string` — Represents the old width of the column before the resizing -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnResizingSeparator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnResizingSeparator) - -- **constructor**(): void -- **ActualOpacity**: `double` -- **Opacity**: `double` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbColumnResizingSeparatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnResizingSeparatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnSelectionEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnSelectionEventArgs) -The event arguments when the selection state of a column is being changed The event is cancelable - -- **constructor**(): void -- **Detail**: `IgbColumnSelectionEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnSelectionEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnSelectionEventArgsDetail) -The event arguments when the selection state of a column is being changed The event is cancelable - -- **constructor**(): void -- **Added**: `string[]` — Represents an array of all added columns Whenever a column has been selected, the array is "refreshed" with the selected columns -- **Cancel**: `bool` — Provides the ability to cancel the event. -- **NewSelection**: `string[]` — Represents the newly selected columns -- **OldSelection**: `string[]` — Represents an array of columns, that have already been selected -- **Owner**: `object` — Provides reference to the owner component. -- **Removed**: `string[]` — Represents an array of all columns, removed from the selection Whenever a column has been deselected, the array is "refreshed" with the columns, that have been previously selected, but are no longer -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnSeries) -Represents a IgbDataChart column series. Compare values across categories by using vertical rectangles. Use it when the order of categories is not important or for displaying item counts such as a histogram. - -- **constructor**(): void -- **ConsolidatedColumnVerticalPosition**: `ConsolidatedItemsPosition` — The positioning logic to use for columns which have been consolidated into a single visual element. -- **RadiusX**: `double` — Gets or sets the x-radius of the ellipse that is used to round the corners of the column. -- **RadiusY**: `double` — Gets or sets the y-radius of the ellipse that is used to round the corners of the column. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItemSpan**(): double -- **GetItemSpanAsync**(): Task — For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. -- **GetSeriesValueBoundingBox**(world: Point): Rect -- **GetSeriesValueBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. - -### [IgbColumnSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnSortDescription](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnSortDescription) -Represents an element in the current sort applied to a data source or provider. Changes to this object are not observed or expected after it is initially assigned to a collection. - -- **constructor**(): void -- **Field**: `string` — Gets or sets the property being sorted. -- **SortDirection**: `ListSortDirection` — Gets or sets the direction to sort based on the property. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnSortDescriptionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnSortDescriptionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbColumnSortDescriptionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnSortDescriptionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnState) - -- **constructor**(): void -- **ColEnd**: `double` -- **ColStart**: `double` -- **Collapsible**: `bool` -- **ColumnGroup**: `bool` -- **ColumnLayout**: `bool` -- **DataType**: `GridColumnDataType` -- **DisableHiding**: `bool` -- **DisablePinning**: `bool` -- **Editable**: `bool` -- **Expanded**: `bool` -- **Field**: `string` -- **Filterable**: `bool` -- **FilteringIgnoreCase**: `bool` -- **Groupable**: `bool` -- **HasSummary**: `bool` -- **Header**: `string` -- **HeaderClasses**: `string` -- **HeaderGroupClasses**: `string` -- **Hidden**: `bool` -- **Key**: `string` -- **MaxWidth**: `string` -- **Parent**: `object` -- **ParentKey**: `string` -- **Pinned**: `bool` -- **Resizable**: `bool` -- **RowEnd**: `double` -- **RowStart**: `double` -- **Searchable**: `bool` -- **Sortable**: `bool` -- **SortingIgnoreCase**: `bool` -- **Type**: `string` -- **VisibleWhenCollapsed**: `bool` -- **Width**: `object` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnSummaryDescription](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnSummaryDescription) -Represents a summary that is applied to a datasource. Changes to this object are not observed or expected after it is initially assigned to a collection. - -- **constructor**(): void -- **CalculatorDisplayName**: `string` — Gets or sets the name to use when displaying the calculator name. -- **DisplayFormat**: `string` — Gets or sets the display format for the summary when in list display mode. -- **DisplayFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the DisplayFormat string. -- **DisplayName**: `string` — Gets or sets the display name for the summary. -- **Field**: `string` -- **FormatText**: `EventCallback` -- **FormatTextScript**: `string` -- **MaxFractionDigits**: `int` — Gets or sets the maximum fraction digits. If a format is specificied this value is ignored. -- **Operand**: `DataSourceSummaryOperand` -- **ProvideCalculator**: `EventCallback` -- **ProvideCalculatorScript**: `string` -- **ShouldDisplay**: `bool` — Gets or sets whether the summary value should be displayed. -- **Type**: `string` -- **ValueFormat**: `string` — Gets or sets the format string for the summary value. -- **ValueFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the ValueFormat string. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnSummaryDescriptionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnSummaryDescriptionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbColumnSummaryDescriptionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnSummaryDescriptionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnSupportingCalculation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnSupportingCalculation) -Represents a calculation strategy that takes in a column of values and returns a resulting column of values. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbColumnTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnTemplateContext) - -- **constructor**(): void -- **Column**: `IgbColumn` -- **Implicit**: `IgbColumn` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnToggledEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnToggledEventArgs) -Event emitted when a checkbox in the checkbox list of an IgxColumnActions component is clicked. - -- **constructor**(): void -- **Detail**: `IgbColumnToggledEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnToggledEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnToggledEventArgsDetail) -Event emitted when a checkbox in the checkbox list of an IgxColumnActions component is clicked. - -- **constructor**(): void -- **Checked**: `bool` — The checked state after the action. -- **Column**: `IgbColumn` — The column that is toggled. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnVisibilityChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnVisibilityChangedEventArgs) -The event arguments after a column's visibility is changed. - -- **constructor**(): void -- **Detail**: `IgbColumnVisibilityChangedEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnVisibilityChangedEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnVisibilityChangedEventArgsDetail) -The event arguments after a column's visibility is changed. - -- **constructor**(): void -- **Column**: `object` — Represents the column the event originated from -- **NewValue**: `bool` — The new hidden state that the column will have, if operation is successful. Will be true when hiding and false when showing. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnVisibilityChangingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnVisibilityChangingEventArgs) -The event arguments when a column's visibility is changed. The event is cancelable It contains information about the column and the it's visibility after the operation (will be true when hiding and false when showing) - -- **constructor**(): void -- **Detail**: `IgbColumnVisibilityChangingEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnVisibilityChangingEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnVisibilityChangingEventArgsDetail) -The event arguments when a column's visibility is changed. The event is cancelable It contains information about the column and the it's visibility after the operation (will be true when hiding and false when showing) - -- **constructor**(): void -- **Cancel**: `bool` — Provides the ability to cancel the event. -- **Column**: `object` — Represents the column the event originated from -- **NewValue**: `bool` — The new hidden state that the column will have, if operation is successful. Will be true when hiding and false when showing. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnWidth](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnWidth) -Represents a width of a column. - -- **constructor**(): void -- **constructor**(width: double): void -- **constructor**(value: double, isStarSized: bool): void -- **constructor**(value: double, minimumWidth: double, isStarSized: bool): void -- **IsStarSized**: `bool` — Gets or sets whether to use star sizing for the column's width -- **MinimumWidth**: `double` — Gets or sets a minimum width to use when star sizing. -- **Type**: `string` -- **Value**: `double` — Gets or sets the fixed width or the proportional width of the column, depending on whether this width is a star width. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **Parse**(value: string): IgbColumnWidth -- **Star**(value: double): IgbColumnWidth -- **Star**(value: double, minimumWidth: double): IgbColumnWidth -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void -- **WithMinimum**(minimumWidth: double): IgbColumnWidth - -### [IgbColumnWidthModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnWidthModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbColumnsAutoGeneratedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnsAutoGeneratedEventArgs) - -- **constructor**(): void -- **Detail**: `IgbColumnsAutoGeneratedEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbColumnsAutoGeneratedEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbColumnsAutoGeneratedEventArgsDetail) - -- **constructor**(): void -- **Columns**: `IgbColumnCollection` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComboBoxColumn](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComboBoxColumn) -A combobox column. - -- **constructor**(): void -- **ActualDataSource**: `IgbBaseDataSource` -- **DataSource**: `object` — Gets or sets the ComboBox data source. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **ParentTypeName**: `string` -- **TextField**: `string` — Gets or sets the ComboBox text field. -- **Type**: `string` -- **ValueField**: `string` — Gets or sets the ComboBox value field. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComboBoxColumnModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComboBoxColumnModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbComboChangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComboChangeEventArgs) - -- **constructor**(): void -- **Detail**: `IgbComboChangeEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComboChangeEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComboChangeEventArgsDetail) - -- **constructor**(): void -- **ChangeType**: `ComboChangeType` -- **Items**: `object[]` -- **ItemsScript**: `string` — Provides a means of setting Items in the JavaScript environment. -- **NewValue**: `object[]` -- **NewValueScript**: `string` — Provides a means of setting NewValue in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComboEditor](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComboEditor) - -- **constructor**(): void -- **ActualBackgroundColor**: `string` — Gets the actual opacity to use for the underline ripple element. -- **ActualBaseTheme**: `BaseControlTheme` — Gets the actual display baseTheme to use for the component. -- **ActualBorderColor**: `string` — Gets the actual item background color. -- **ActualBorderWidth**: `double` — Gets the actual item border width. -- **ActualContentPaddingBottom**: `double` -- **ActualContentPaddingLeft**: `double` -- **ActualContentPaddingRight**: `double` -- **ActualContentPaddingTop**: `double` -- **ActualCornerRadiusBottomLeft**: `double` -- **ActualCornerRadiusBottomRight**: `double` -- **ActualCornerRadiusTopLeft**: `double` -- **ActualCornerRadiusTopRight**: `double` -- **ActualDensity**: `ControlDisplayDensity` — Gets the actual display Density to use for the component. -- **ActualFocusBorderColor**: `string` — Gets the actual item border color. -- **ActualFocusBorderWidth**: `double` — Gets the actual item border width. -- **ActualFocusUnderlineColor**: `string` — Gets the actual color to use for the underline element when focused. -- **ActualFocusUnderlineOpacity**: `double` — Gets the actual opacity to use for the underline element when focused. -- **ActualFocusUnderlineRippleOpacity**: `double` — Gets the actual opacity to use for the underline ripple element when focused. -- **ActualHoverUnderlineColor**: `string` — Gets the actual color to use for the underline element. -- **ActualHoverUnderlineOpacity**: `double` — Gets the actual opacity to use for the underline element when hovered. -- **ActualHoverUnderlineWidth**: `double` — Gets the width to use for the underline element when hovered. -- **ActualLabelTextColor**: `string` — Gets the actual color to use for the text color. -- **ActualLabelVisible**: `bool` — Gets or sets the visibility of the label. -- **ActualNoMatchesFoundLabel**: `string` — Gets the actual text to display on the list when no suggested matches are found. -- **ActualNoMatchesFoundLabelBackgroundColor**: `string` — Gets the actual color to use for the "no matches found" label. -- **ActualNoMatchesFoundLabelTextColor**: `string` — Gets the actual color to use for the "no matches found" label. -- **ActualTextColor**: `string` — Gets the actual color to use for the text color. -- **ActualUnderlineColor**: `string` — Gets the actual color to use for the underline element. -- **ActualUnderlineOpacity**: `double` — Gets the actual opacity to use for the underline element. -- **ActualUnderlineRippleColor**: `string` — Gets the actual color to use for the underline ripple element. -- **ActualUnderlineRippleOpacity**: `double` — Gets the actual opacity to use for the underline ripple element. -- **ActualUnderlineRippleWidth**: `double` — Gets the actual width to use for the underline element. -- **ActualUnderlineWidth**: `double` — Gets the actual width to use for the underline element. -- **ActualValueField**: `string[]` — Gets the actual name of the field in the data source will be used as the Value of the ComboEditor. -- **AllowFilter**: `bool` — Whether to allow filtering of the combo -- **BackgroundColor**: `string` — Gets or sets the background color to use for the input group. -- **BaseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the component. -- **BorderColor**: `string` — Gets or sets the color to use the border of the input group. -- **BorderWidth**: `double` — Gets or sets the border width to use for the border of the item group. -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Changing**: `EventCallback` -- **ChangingScript**: `string` -- **ContentPaddingBottom**: `double` -- **ContentPaddingLeft**: `double` -- **ContentPaddingRight**: `double` -- **ContentPaddingTop**: `double` -- **CornerRadiusBottomLeft**: `double` -- **CornerRadiusBottomRight**: `double` -- **CornerRadiusTopLeft**: `double` -- **CornerRadiusTopRight**: `double` -- **DataSource**: `object` — Gets or sets the data to which to bind the combo box list. This can be some type of array or list, or it can be an IDataSource instance. -- **DataSourceDesiredProperties**: `string[]` — Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or sets the display Density to use for the buttons and dropdown grid. -- **DropDownButtonVisible**: `bool` — Gets or sets the visibility of the drop down button. -- **Fields**: `string[]` — Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source. -- **FocusBorderColor**: `string` — Gets or sets the color to use the hovered background of the inputs in the group. -- **FocusBorderWidth**: `double` — Gets or sets the border width to use for the border of the item group when focused. -- **FocusUnderlineColor**: `string` — Gets or sets the color to use for the underline element. -- **FocusUnderlineOpacity**: `double` — Gets or sets the color to use for the underline element. -- **FocusUnderlineRippleOpacity**: `double` — Gets or sets the opacity to use for the underline ripple element when focused. -- **FontFamily**: `string` -- **FontSize**: `double` -- **FontStyle**: `string` -- **FontWeight**: `string` -- **GotFocus**: `EventCallback` -- **GotFocusScript**: `string` -- **HoverUnderlineColor**: `string` — Gets or sets the color to use for the underline element. -- **HoverUnderlineOpacity**: `double` — Gets or sets the color to use for the underline element. -- **HoverUnderlineWidth**: `double` — Gets or sets the width to use for the underline element when hovered. -- **IsFixed**: `bool` — Indicates that the dropdown will position itself relative to the window instead of the document. -- **KeyDown**: `EventCallback` -- **KeyDownScript**: `string` -- **Label**: `string` — The text displayed in the label portion of the control. -- **LabelFontFamily**: `string` -- **LabelFontSize**: `double` -- **LabelFontStyle**: `string` -- **LabelFontWeight**: `string` -- **LabelTextColor**: `string` — Gets or sets the color to use for the text. -- **LostFocus**: `EventCallback` -- **LostFocusScript**: `string` -- **NoMatchesFoundLabel**: `string` — Gets or sets the text to display on the list when no suggested matches are found. -- **NoMatchesFoundLabelBackgroundColor**: `string` — Gets or sets the color to use for the "no matches found" label. -- **NoMatchesFoundLabelFontFamily**: `string` -- **NoMatchesFoundLabelFontSize**: `double` -- **NoMatchesFoundLabelFontStyle**: `string` -- **NoMatchesFoundLabelFontWeight**: `string` -- **NoMatchesFoundLabelTextColor**: `string` — Gets or sets the color to use for the "no matches found" label. -- **OpenAsChild**: `bool` — Indicates that the dropdown should open as a child of the combobox. -- **Placeholder**: `string` — Placeholder text which gives the user a hint about what kind of text is expected. -- **SelectedValueChanged**: `EventCallback` -- **SelectedValueChangedScript**: `string` -- **Text**: `string` — The text displayed in the edit portion of the control. -- **TextChanged**: `EventCallback` -- **TextChangedScript**: `string` -- **TextColor**: `string` — Gets or sets the color to use for the text. -- **TextField**: `string` — Determines the name of the field in the data source will be used as the Text of the ComboEditor. -- **TextValueChanged**: `EventCallback` -- **TextValueChangedScript**: `string` -- **Type**: `string` -- **UnderlineColor**: `string` — Gets or sets the color to use for the underline element. -- **UnderlineOpacity**: `double` — Gets or sets the color to use for the underline element. -- **UnderlineRippleColor**: `string` — Gets or sets the color to use for the underline ripple element. -- **UnderlineRippleOpacity**: `double` — Gets or sets the opacity to use for the underline ripple element. -- **UnderlineRippleWidth**: `double` — Gets or sets the width to use for the underline element. -- **UnderlineWidth**: `double` — Gets or sets the width to use for the underline element. -- **UseTopLayer**: `bool` — Indicates that the dropdown will place itself into the browser top layer. -- **Value**: `object` — Gets or sets the Value of the combo. -- **ValueChanged**: `EventCallback` -- **ValueChangedScript**: `string` -- **ValueField**: `string[]` — Sets or gets the user provided primary key to assume for the data. Certain functionality of the combo (such as the the current Value) requires a way to uniquely identify items in order to work correctly. If a primary key cannot be inferred from the data source, you may need to provide one here. -- **CloseUp**(): void -- **CloseUpAsync**(): Task — Programmatically closes the list. -- **DropDown**(): void -- **DropDownAsync**(): Task — Programmatically drops down the list. -- **EnableDisableFiltering**(allowFilter: bool): void -- **EnableDisableFilteringAsync**(allowFilter: bool): Task -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualModel**(): string -- **ExportSerializedVisualModelAsync**(): Task — Returns a serialized copy of the exported visual model -- **ExportVisualModel**(): object -- **ExportVisualModelAsync**(): Task — Exports visual information about the current state of the grid. -- **FindByName**(name: string): object -- **GetCurrentText**(): string -- **GetCurrentTextAsync**(): Task -- **GetCurrentValue**(): object -- **GetCurrentValueAsync**(): Task -- **Select**(): void -- **SelectAsync**(): Task — Selects all the text in the combo input area. -- **SelectGridRow**(index: int): void -- **SelectGridRowAsync**(index: int): Task -- **VerifyDisplayText**(): void -- **VerifyDisplayTextAsync**(): Task - -### [IgbComboEditorGotFocusEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComboEditorGotFocusEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComboEditorLostFocusEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComboEditorLostFocusEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComboEditorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComboEditorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbComboEditorTextChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComboEditorTextChangedEventArgs) - -- **constructor**(): void -- **NewText**: `string` -- **OldText**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComboEditorValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComboEditorValueChangedEventArgs) - -- **constructor**(): void -- **NewValue**: `object` -- **NewValueScript**: `string` — Provides a means of setting NewValue in the JavaScript environment. -- **OldValue**: `object` -- **OldValueScript**: `string` — Provides a means of setting OldValue in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComboModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComboModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCombo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCombo) -The Combo component is similar to the Select component in that it provides a list of options from which the user can make a selection. In contrast to the Select component, the Combo component displays all options in a virtualized list of items, meaning the combo box can simultaneously show thousands of options, where one or more options can be selected. Additionally, users can create custom item templates, allowing for robust data visualization. The Combo component features case-sensitive filtering, grouping, complex data binding, dynamic addition of values and more. - -- **constructor**(): void -- **Autofocus**: `bool` — The autofocus attribute of the control. -- **AutofocusList**: `bool` — Focuses the list of options when the menu opens. -- **Blur**: `EventCallback` -- **BlurScript**: `string` -- **CaseSensitiveIcon**: `bool` — Enables the case sensitive search icon in the filtering input. -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **Data**: `object` — The data source used to generate the list of options. -- **DataScript**: `string` — Provides a means of setting Data in the JavaScript environment. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DisableClear**: `bool` — Hides the clear button. false -- **DisableFiltering**: `bool` — Disables the filtering of the list of options. false -- **Disabled**: `bool` — The disabled state of the component -- **DisplayKey**: `string` — The key in the data source used to display items in the list. -- **FilteringOptions**: `IgbFilteringOptions` -- **Focus**: `EventCallback` -- **FocusScript**: `string` -- **GroupHeaderTemplate**: `RenderFragment` -- **GroupHeaderTemplateScript**: `string` — Provides a means of setting GroupHeaderTemplate in the JavaScript environment. -- **GroupKey**: `string` — The key in the data source used to group items in the list. -- **GroupSorting**: `GroupingDirection` — Sorts the items in each group by ascending or descending order. asc {"asc" | "desc" | "none"} -- **Invalid**: `bool` — Control the validity of the control. -- **ItemTemplate**: `RenderFragment` -- **ItemTemplateScript**: `string` — Provides a means of setting ItemTemplate in the JavaScript environment. -- **Label**: `string` — The label attribute of the control. -- **Open**: `bool` — Sets the open state of the component. -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **Outlined**: `bool` — The outlined attribute of the control. -- **Placeholder**: `string` — The placeholder attribute of the control. -- **PlaceholderSearch**: `string` — The placeholder attribute of the search input. -- **Required**: `bool` — Makes the control a required field in a form context. -- **SingleSelect**: `bool` — Enables single selection mode and moves item filtering to the main input. false -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **Value**: `T[]` -- **ValueChanged**: `EventCallback` -- **ValueKey**: `string` — The key in the data source used when selecting items. -- **BlurComponent**(): void -- **BlurComponentAsync**(): Task — Removes focus from the component. -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task — Checks for validity of the control and emits the invalid event if it invalid. -- **Deselect**(items: object[]): void -- **DeselectAsync**(items: object[]): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FocusComponent**(options: IgbFocusOptions): void -- **FocusComponentAsync**(options: IgbFocusOptions): Task — Sets focus on the component. -- **GetCurrentValue**(): T[] -- **GetCurrentValueAsync**(): Task -- **GetSelection**(): object[] -- **GetSelectionAsync**(): Task -- **Hide**(): bool -- **HideAsync**(): Task — Hides the list of options. -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task — Checks for validity of the control and shows the browser message if it invalid. -- **ResolveDisplay**(): string -- **Select**(items: object[]): void -- **SelectAsync**(items: object[]): Task -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task — Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid. -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(): bool -- **ShowAsync**(): Task — Shows the list of options. -- **Toggle**(): bool -- **ToggleAsync**(): Task — Toggles the list of options. - -### [IgbCommodityChannelIndexIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCommodityChannelIndexIndicator) -Represents a IgbDataChart Commodity Channel Index indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current CCISeries object. The typical, and initial, value for CCI periods is 20. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbCommodityChannelIndexIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCommodityChannelIndexIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbComponentArrayDataValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComponentArrayDataValueChangedEventArgs) - -- **constructor**(): void -- **Detail**: `object[]` -- **DetailScript**: `string` — Provides a means of setting Detail in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComponentBoolValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComponentBoolValueChangedEventArgs) - -- **constructor**(): void -- **Detail**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComponentDataValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComponentDataValueChangedEventArgs) - -- **constructor**(): void -- **Detail**: `object` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComponentDateValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComponentDateValueChangedEventArgs) - -- **constructor**(): void -- **Detail**: `DateTime` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbComponentRendererContainer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComponentRendererContainer) - -- **constructor**(): void -- **ComponentType**: `Type` -- **RootComponent**: `object` -- **BuildRenderTree**(builder: RenderTreeBuilder): void - -### [IgbComponentValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbComponentValueChangedEventArgs) - -- **constructor**(): void -- **Detail**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbContentChildCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbContentChildCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbContentPane](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbContentPane) - -- **constructor**(): void -- **AcceptsInnerDock**: `bool` — Determines whether the end user can inner dock another pane in this one. Defaults to true. -- **AllowClose**: `bool` — Determines whether the end user is allowed to close the pane. Defaults to true. -- **AllowDocking**: `bool` — Determines whether the end user is allowed to dock the pane. Defaults to true. -- **AllowFloating**: `bool` — Determines whether the end user is allowed to make the pane floating. Defaults to true. -- **AllowMaximize**: `bool` — Determines whether the end user is allowed to maximize the pane. -- **AllowPinning**: `bool` — Determines whether the end user is allowed to pin/unpin the pane. Defaults to true. -- **ContentId**: `string` — The slot attribute's value of the content element. -- **Disabled**: `bool` — Determines whether a pane is disabled. Defaults to false. -- **DocumentOnly**: `bool` — Marks that a content pane can be docked only inside a document host. -- **FloatingHeaderId**: `string` — The slot attribute's value of the floating header element. If not set, the headerId property value is used. -- **Header**: `string` — The text header of the content pane. Even if header slot templates are used, the text header is used for aria label. -- **HeaderId**: `string` — The slot attribute's value of the content pane header element. If not set, the header property value is used. -- **Hidden**: `bool` — Determines whether a pane is hidden in the UI. Defaults to false. -- **Id**: `string` — The id of the pane. If not set the Dock Manager generates it automatically. -- **IsMaximized**: `bool` — Determines whether a content pane is maximized or not. Defaults to false. -- **IsPinned**: `bool` — Determines whether a content pane is pinned or not. Defaults to true. -- **PaneType**: `DockManagerPaneType` — The type of the pane. -- **Size**: `double` — The size of the pane relative to its sibling panes' sizes. Defaults to 100. -- **TabHeaderId**: `string` — The slot attribute's value of the tab header element. If not set, the header property value is used. -- **Type**: `string` -- **UnpinnedHeaderId**: `string` — The slot attribute's value of the unpinned header element. If not set, the header property value is used. -- **UnpinnedLocation**: `UnpinnedLocation` — The desired unpinned location of the content pane. If not set the Dock Manager automatically calculates it based on the location of the pane relatively to the document host. If more than one document host is presented, the closest one in the pane hierarchy will be used for the calculation. If there is no document host, the default location is left. -- **UnpinnedSize**: `double` — The absolute size of the pane in an unpinned state. Defaults to 200. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbContentPaneCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbContentPaneCollection) - -- **constructor**(): void -- **constructor**(parent: object, propertyName: string): void - -### [IgbContentPaneModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbContentPaneModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbContourValueResolver](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbContourValueResolver) -Class used to determine the numeric values of contour lines, given a larger list of numeric values. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbCrosshairLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCrosshairLayer) -Represents an annotation layer that displays crosshair lines that cross through the closest value of the target series under the cursor. - -- **constructor**(): void -- **HorizontalLineStroke**: `string` — Gets or sets the color to use for the horizontal line. Leave null for an automatic value. -- **HorizontalLineVisibility**: `Visibility` — Gets or sets whether to display the horizontal line. -- **IsAxisAnnotationEnabled**: `bool` — Gets or sets whether to draw annotations over the axes where the crosshair meets with them. -- **SkipAxisAnnotationOnInvalidData**: `bool` — Gets or sets whether axis annotation are skipped for invalid data in a given position. -- **SkipAxisAnnotationOnZeroValueFragments**: `bool` — Gets or sets whether axis annotation are skipped for zero-value fragments in a given position. -- **SkipUnknownValues**: `bool` — Gets or sets whether to skip unknown values when searching for series values. -- **TargetSeries**: `IgbSeries` — Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously. -- **TargetSeriesName**: `string` — Gets or sets the name of the series to target this annotation to. If null, this annotation targets all series simultaneously. -- **TargetSeriesScript**: `string` — Provides a means of setting TargetSeries in the JavaScript environment. -- **Type**: `string` -- **UseInterpolation**: `bool` — Gets or sets whether to use value interpolation when drawing a line through the best value for the cursor position. -- **VerticalLineStroke**: `string` — Gets or sets the color to use for vertical line. Leave null for an automatic value. -- **VerticalLineVisibility**: `Visibility` — Gets or sets whether to display the vertical line. -- **XAxisAnnotationBackground**: `string` — Gets or sets the color to use for the x axis annotation backing. Leave unset for an automatic value. -- **XAxisAnnotationBackgroundCornerRadius**: `double` — Gets or sets the corner radius to use for the x axis annotation backing. Leave unset for an automatic value. -- **XAxisAnnotationFormatLabelScript**: `string` -- **XAxisAnnotationInterpolatedValuePrecision**: `int` — Gets or sets the precision to use displaying values for interpolated crosshair positions. -- **XAxisAnnotationOutline**: `string` — Gets or sets the color to use for the x axis annotation outline. Leave unset for an automatic value. -- **XAxisAnnotationPaddingBottom**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **XAxisAnnotationPaddingLeft**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **XAxisAnnotationPaddingRight**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **XAxisAnnotationPaddingTop**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **XAxisAnnotationStrokeThickness**: `double` — Gets or sets the stroke thickness for the x axis annotation backing. Leave unset for an automatic value. -- **XAxisAnnotationTextColor**: `string` — Gets or sets the color to use for the x axis annotation text. Leave unset for an automatic value. -- **YAxisAnnotationBackground**: `string` — Gets or sets the color to use for the y axis annotation backing. Leave unset for an automatic value. -- **YAxisAnnotationBackgroundCornerRadius**: `double` — Gets or sets the corner radius to use for the y axis annotation backing. Leave unset for an automatic value. -- **YAxisAnnotationFormatLabelScript**: `string` -- **YAxisAnnotationInterpolatedValuePrecision**: `int` — Gets or sets the precision to use displaying values for interpolated crosshair positions. -- **YAxisAnnotationOutline**: `string` — Gets or sets the color to use for the y axis annotation outline. Leave unset for an automatic value. -- **YAxisAnnotationPaddingBottom**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **YAxisAnnotationPaddingLeft**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **YAxisAnnotationPaddingRight**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **YAxisAnnotationPaddingTop**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **YAxisAnnotationStrokeThickness**: `double` — Gets or sets the stroke thickness for the y axis annotation backing. Leave unset for an automatic value. -- **YAxisAnnotationTextColor**: `string` — Gets or sets the color to use for the y axis annotation text. Leave unset for an automatic value. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbCrosshairLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCrosshairLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCustomContourValueResolver](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCustomContourValueResolver) -ContourValueResolver class which fires an event to resolve the contour values. - -- **constructor**(): void -- **GetCustomContourValues**: `EventCallback` -- **GetCustomContourValuesScript**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbCustomContourValueResolverEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCustomContourValueResolverEventArgs) -Provides data for GetCustomContourValues event. - -- **constructor**(): void -- **ContourValues**: `double[]` -- **Type**: `string` -- **Values**: `double[]` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbCustomContourValueResolverModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCustomContourValueResolverModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCustomDateRange](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCustomDateRange) - -- **constructor**(): void -- **DateRange**: `IgbDateRangeValue` -- **Label**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbCustomIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCustomIndicator) -Represents a IgbDataChart Custom Indicator series. The indicator value is calculated in the user specified Indicator event handler. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbCustomIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCustomIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCustomIndicatorNameCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCustomIndicatorNameCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbCustomMapImagery](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCustomMapImagery) -Represents a CustomMapImagery MapImagery - -- **constructor**(): void -- **GetTileImageUri**: `Action` -- **GetTileImageUriScript**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbCustomMapImageryModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCustomMapImageryModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCustomPaletteBrushScale](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCustomPaletteBrushScale) -Represents a brush scale that uses index-based brush selection mode. - -- **constructor**(): void -- **BrushSelectionMode**: `BrushSelectionMode` — Gets or sets the brush selection mode. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetBrush1**(index: int, total: int): string -- **GetBrush1Async**(index: int, total: int): Task - -### [IgbCustomPaletteBrushScaleModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCustomPaletteBrushScaleModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbCustomPaletteColorScale](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCustomPaletteColorScale) -ColorScale class for selecting a color from a given palette, or interpolating between adjacent colors in that palette. - -- **constructor**(): void -- **InterpolationMode**: `ColorScaleInterpolationMode` — The approach to use when getting a color from the palette. -- **MaximumValue**: `double` — The highest value to assign a color. Any given value greater than this value will be made Transparent. -- **MinimumValue**: `double` — The lowest value to assign a color. Any given value less than this value will be made Transparent. -- **Palette**: `string` — A list of colors to select from or interpolate between. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbCustomPaletteColorScaleModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbCustomPaletteColorScaleModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDVInteractivityModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDVInteractivityModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDashboardTile](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTile) - -- **constructor**(): void -- **ActualBrushes**: `string` — Gets the actual palette of brushes to use for coloring the chart series. -- **ActualCustomizations**: `IgbDashboardTileCustomizationCollection` -- **ActualOutlines**: `string` — Gets the actual palette of brushes to use for outlines on the chart series. -- **AutoCalloutsVisible**: `bool` — Gets or sets if the auto value callouts should be displayed. -- **BackgroundColor**: `string` — Gets or sets the color to use for the background of the component. -- **BaseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the checkbox. -- **Brushes**: `string` — Gets or sets the palette of brushes to use for coloring the dashboard tile. -- **CategoryAxisMajorStroke**: `string` — Gets the brush to use for the Category axis major strokes, if applicable. -- **ChangingContent**: `EventCallback` -- **ChangingContentScript**: `string` -- **ContentCustomizations**: `IgbDashboardTileCustomizationCollection` -- **CrosshairsAnnotationEnabled**: `bool` — Gets or sets whether annotations are shown along the axis for crosshair values -- **CrosshairsDisplayMode**: `CrosshairsDisplayMode` — Gets or sets the crosshairs to be displayed. -- **Customizations**: `IgbDashboardTileCustomizationCollection` — Gets a collection where you can add customization that will be applied to the generated visualizations. -- **DataSource**: `object` — Gets or sets a collection of data items used to generate the dashboard tile. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or sets the display density to use for the toolbar. -- **ExcludedProperties**: `string[]` — Gets or sets a set of property paths that should be excluded from consideration by the category chart. -- **FilterExpressions**: `IgbFilterExpressionCollection` — Gets the current filter that is applied to the chart. Collection can be updated to modify the filter for the chart. Once filter expressions are in this collection, the chart will no longer listen for changes on their properties. -- **FilterStringErrorsParsing**: `EventCallback` -- **FilterStringErrorsParsingScript**: `string` -- **FinalValueAnnotationsVisible**: `bool` — Gets or sets whether annotations for the final value of each series is displayed on the axis. -- **GroupDescriptions**: `IgbDashboardTileSortDescriptionCollection` — Gets the current grouping that is applied to the grid. Collection can be updated to modify the grouping for the grid. Once grouping descriptions are in this collection, the grid will no longer listen for changes on their properties. -- **GroupSortDescriptions**: `IgbDashboardTileSortDescriptionCollection` -- **GroupSorts**: `string` — Gets or sets the sorts to apply after grouping has been applied. -- **HighlightFilterExpressions**: `IgbFilterExpressionCollection` — Gets the current highlight filter that is applied to the chart. Collection can be updated to modify the highlight filter for the chart. Once filter expressions are in this collection, the chart will no longer listen for changes on their properties. -- **HighlightedDataSource**: `object` — Gets or sets a collection of data items used to generate the dashboard tile. -- **HighlightedDataSourceScript**: `string` — Provides a means of setting HighlightedDataSource in the JavaScript environment. -- **HighlightedValuesDisplayMode**: `SeriesHighlightedValuesDisplayMode` — Gets or sets whether and how to display highlighted values for the series. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse. This property applies to Category Chart and Financial Chart controls. -- **IncludedProperties**: `string[]` — Gets or sets a set of property paths that should be included for consideration by the category chart, leaving the remainder excluded. If null, all properties will be considered. -- **InitialFilter**: `string` — Gets or sets the filter to apply to the chart. This property will become ignored if the filter is changed outside of this property. -- **InitialFilterExpressions**: `IgbFilterExpressionCollection` — Gets the initial filters that are applied to the chart. -- **InitialGroupDescriptions**: `IgbDashboardTileSortDescriptionCollection` — Gets the initial groupings that are applied to the chart. -- **InitialGroupSortDescriptions**: `IgbDashboardTileSortDescriptionCollection` — Gets the initial sorts that are applied to the chart after groupings and summaries are applied. -- **InitialGroups**: `string` — Gets or sets the groupings to apply to the chart. This property will become ignored if sorts are changed outside of this property. -- **InitialHighlightFilter**: `string` — Gets or sets the filter to apply to the chart. This property will become ignored if the filter is changed outside of this property. -- **InitialHighlightFilterExpressions**: `IgbFilterExpressionCollection` — Gets the initial highlight filters that are applied to the chart. -- **InitialSortDescriptions**: `IgbDashboardTileSortDescriptionCollection` — Gets the initial sorts that are applied to the chart. -- **InitialSorts**: `string` — Gets or sets the sorts to apply to the chart. This property will become ignored if sorts are changed outside of this property. -- **InitialSummaries**: `string` — Gets or sets the summaries to apply to the chart. This property will become ignored if sorts are changed outside of this property. -- **InitialSummaryDescriptions**: `IgbDashboardTileSummaryDescriptionCollection` — Gets the initial summaries that are applied to the chart. -- **IsUserAnnotationsEnabled**: `bool` — Gets or sets whether initiating user annotations from the toolbar is enabled. -- **Outlines**: `string` — Gets or sets the palette of brushes to use for outlines on the dashboard tile. -- **ParentTypeName**: `string` -- **SelectedSeriesItems**: `IgbChartSelectedItemCollection` — Gets the currently selected data items. Adding or removing data items from this collection will select or deselect the visuals associated with those items. -- **ShouldAvoidAxisAnnotationCollisions**: `bool` — Gets or sets whether annotations for the final value of each series is displayed on the axis. -- **ShouldDisplayMockData**: `bool` — Gets or sets whether the dashboard tile should display mock data when the data source has not been provided, if supported for this type of chart. -- **ShouldUseSkeletonStyleForMockData**: `bool` — Gets or sets whether the dashboard tile should use a faded skeleton style for mock data. -- **SortDescriptions**: `IgbDashboardTileSortDescriptionCollection` — Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties. -- **SummaryDescriptions**: `IgbDashboardTileSummaryDescriptionCollection` — Gets the current summaries that are applied to the grid. -- **TileTitle**: `string` — Gets or sets text to display above the plot area. -- **TrendLineBrushes**: `string` — Gets or sets the palette of brushes to used for coloring trend lines in this chart. -- **TrendLineType**: `TrendLineType` — Gets or sets the formula used for calculating trend lines in this chart. -- **TrendLineTypes**: `IgbTrendLineTypeCollection` — Gets or sets what trendlines to use in the chart. -- **Type**: `string` -- **UserAnnotationInformationRequested**: `EventCallback` -- **UserAnnotationInformationRequestedScript**: `string` -- **UserAnnotationToolTipContentUpdating**: `EventCallback` -- **UserAnnotationToolTipContentUpdatingScript**: `string` -- **ValidVisualizationTypePriorityThreshold**: `double` — Gets or sets the crosshairs to be displayed. -- **ValidVisualizationTypes**: `DashboardTileVisualizationType[]` — Gets the current set of valid visualization types for the data. -- **ValueLines**: `IgbValueModeCollection` — Gets or sets what value lines to use in the chart. -- **ValueLinesBrushes**: `string` — Gets or sets the palette of brushes to use for coloring the value lines present in the ValueLines property. -- **ValueLinesGlobalAverageBrush**: `string` — Gets or sets the color for GlobalAverage value lines. -- **ValueLinesGlobalMaximumBrush**: `string` — Gets or sets the color for GlobalMaximum value lines. -- **ValueLinesGlobalMinimumBrush**: `string` — Gets or sets the color for GlobalMinimum value lines. -- **VisualizationType**: `DashboardTileVisualizationType` — Gets or sets the crosshairs to be displayed. -- **CancelAnnotationFlow**(annotationFlowId: string): void -- **CancelAnnotationFlowAsync**(annotationFlowId: string): Task -- **ClearSettings**(): void -- **ClearSettingsAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FinishAnnotationFlow**(flowInformation: IgbUserAnnotationInformation): void -- **FinishAnnotationFlowAsync**(flowInformation: IgbUserAnnotationInformation): Task -- **GetCurrentSelectedSeriesItems**(): IgbChartSelectedItemCollection -- **GetCurrentSelectedSeriesItemsAsync**(): Task -- **GetSettingsValue**(key: string): object -- **GetSettingsValueAsync**(key: string): Task -- **HasModifiedSettings**(): bool -- **HasModifiedSettingsAsync**(): Task -- **LoadAnnotationsFromJson**(jsonString: string): void -- **LoadAnnotationsFromJsonAsync**(jsonString: string): Task -- **OnUIReady**(): void -- **OnUIReadyAsync**(): Task -- **RemoveSettingsValue**(key: string): void -- **RemoveSettingsValueAsync**(key: string): Task -- **ResetAnnotations**(): void -- **ResetAnnotationsAsync**(): Task -- **ResetZoom**(): void -- **ResetZoomAsync**(): Task — Resets the zoom level to default. -- **SaveAnnotationsToJson**(): string -- **SaveAnnotationsToJsonAsync**(): Task -- **StartCreatingAnnotation**(): void -- **StartCreatingAnnotationAsync**(): Task -- **StartDeletingAnnotation**(): void -- **StartDeletingAnnotationAsync**(): Task -- **UpdateSettingsValue**(key: string, value: object): void -- **UpdateSettingsValueAsync**(key: string, value: object): Task -- **ZoomIn**(percentage: double): void -- **ZoomInAsync**(percentage: double): Task -- **ZoomOut**(percentage: double): void -- **ZoomOutAsync**(percentage: double): Task — Performs zoom out action on the chart by specified percentage of current window rect - -### [IgbDashboardTileChangingContentEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileChangingContentEventArgs) - -- **constructor**(): void -- **ContentJson**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDashboardTileCustomization](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileCustomization) - -- **constructor**(): void -- **CollectionIndex**: `int` -- **IsCollectionInsertionAtEnd**: `bool` -- **IsCollectionInsertionAtIndex**: `bool` -- **IsCollectionInsertionAtStart**: `bool` -- **IsCollectionRemovaltIndex**: `bool` -- **MatchParentIndex**: `int` -- **MatchType**: `string` -- **Order**: `int` -- **PropertyName**: `string` -- **PropertyValue**: `object` -- **PropertyValueScript**: `string` — Provides a means of setting PropertyValue in the JavaScript environment. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbDashboardTileCustomizationCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileCustomizationCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbDashboardTileCustomizationModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileCustomizationModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDashboardTileFilterStringErrorsParsingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileFilterStringErrorsParsingEventArgs) -Represents event arguments for when there are errors parsing the filter string - -- **constructor**(): void -- **Errors**: `string` — Gets the errors from parsing the filter string. -- **PropertyName**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDashboardTileGroupDescription](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileGroupDescription) -Represents an element in the current grouping applied to a data source or provider. Changes to this object are not observed or expected after it is initially assigned to a collection. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDashboardTileGroupDescriptionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileGroupDescriptionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbDashboardTileGroupDescriptionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileGroupDescriptionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDashboardTileModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDashboardTileSortDescription](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileSortDescription) -Represents an element in the current sort applied to a data source or provider. Changes to this object are not observed or expected after it is initially assigned to a collection. - -- **constructor**(): void -- **Field**: `string` — Gets or sets the property being sorted. -- **SortDirection**: `ListSortDirection` — Gets or sets the direction to sort based on the property. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDashboardTileSortDescriptionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileSortDescriptionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbDashboardTileSortDescriptionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileSortDescriptionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDashboardTileSummaryDescription](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileSummaryDescription) -Represents a summary that is applied to a datasource. Changes to this object are not observed or expected after it is initially assigned to a collection. - -- **constructor**(): void -- **Alias**: `string` — Gets or sets an alias for the summary. Currently only used in aggregated data situations. -- **CalculatorDisplayName**: `string` — Gets or sets the name to use when displaying the calculator name. -- **Field**: `string` -- **Operand**: `DataSourceSummaryOperand` -- **ProvideCalculator**: `EventCallback` -- **ProvideCalculatorScript**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDashboardTileSummaryDescriptionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileSummaryDescriptionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbDashboardTileSummaryDescriptionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDashboardTileSummaryDescriptionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataAnnotationAxisLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationAxisLayer) -Represents a base annotation layer that displays annotations over an axis. - -- **constructor**(): void -- **AnnotationBackground**: `string` — Gets or sets the color used for backing of the axis annotation. -- **AnnotationBackgroundMatchLayer**: `bool` — Gets or sets whether the annotation background matches brush of the layer -- **AnnotationBackgroundMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the background of axis annotation. -- **AnnotationBackgroundShift**: `double` — Gets or sets the percentage used to shift AnnotationBackground. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **AnnotationBadgeBackground**: `string` — Gets or sets background of the badge annotations. -- **AnnotationBadgeCornerRadius**: `double` — Gets or sets border radius of the badge annotations. -- **AnnotationBadgeEnabled**: `bool` — Gets or sets whether the badge are rendered in annotations. -- **AnnotationBadgeImagePath**: `string` — Gets or sets a member path for displaying an image in the badge annotations. -- **AnnotationBadgeMargin**: `double` — Gets or sets margin of the badge annotations. -- **AnnotationBadgeOutline**: `string` — Gets or sets border outline of the badge annotations. -- **AnnotationBadgeOutlineThickness**: `double` — Gets or sets border thickness of the badge annotations. -- **AnnotationBadgeSize**: `double` — Gets or sets size of the badge annotations. -- **AnnotationBorderColor**: `string` — Gets or sets the color used for border color of the axis annotation. -- **AnnotationBorderMatchLayer**: `bool` — Gets or sets whether the annotation border matches outline of the layer (if it has a fill visual) otherwise brush of the layer -- **AnnotationBorderMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting border color of the axis annotation. -- **AnnotationBorderRadius**: `double` — Gets or sets the border radius used for displaying the axis annotation. -- **AnnotationBorderShift**: `double` — Gets or sets the percentage amount used to shift AnnotationBorderColor. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **AnnotationBorderThickness**: `double` — Gets or sets border thickness of the axis annotations. -- **AnnotationLabelDisplayMode**: `DataAnnotationDisplayMode` — Gets or sets display mode of label on axis annotation. -- **AnnotationLabelVisible**: `bool` — Gets or sets whether to show all annotations over target axis -- **AnnotationPaddingBottom**: `double` -- **AnnotationPaddingLeft**: `double` -- **AnnotationPaddingRight**: `double` -- **AnnotationPaddingTop**: `double` -- **AnnotationTextColor**: `string` — Gets or sets the text color used in the axis annotation. -- **AnnotationTextColorMatchLayer**: `bool` — Gets or sets whether the annotation text color matches brush of the layer -- **AnnotationTextColorMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the text color in axis annotation. -- **AnnotationTextColorShift**: `double` — Gets or sets the percentage used to shift AnnotationTextColor. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **AnnotationValueMaxPrecision**: `int` — Gets or sets maximum precision for displaying values on axis annotation. -- **AnnotationValueMinPrecision**: `int` — Gets or sets minimum precision for displaying values on axis annotation. -- **TargetAxis**: `IgbAxis` — Gets or sets the target axis for this annotation. If null, this annotation will use TargetMode to determine target axis. -- **TargetAxisName**: `string` — Gets or sets the name to use to resolve targetAxis from markup. -- **TargetAxisScript**: `string` — Provides a means of setting TargetAxis in the JavaScript environment. -- **TargetMode**: `DataAnnotationTargetMode` — Gets or sets the mode for targeting axes present in the chart. Defaults to targeting all category-axes present in the chart -- **Type**: `string` -- **BindAxes**(Axes: IgbAxis[]): void -- **FindByName**(name: string): object - -### [IgbDataAnnotationBandLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationBandLayer) -Represents an annotation layer that renders bands (line with breadth) at locations of x/y values mapped to these properties: StartValueXMemberPath StartValueYMemberPath EndValueXMemberPath EndValueYMemberPath AnnotationBreadthMemberPath - -- **constructor**(): void -- **AnnotationBreadthMemberPath**: `string` — Gets or sets name of data column with breath/size of shape annotations. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbDataAnnotationBandLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationBandLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataAnnotationInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationInfo) -Represents data annotation - -- **constructor**(): void -- **Background**: `string` -- **BorderColor**: `string` -- **BorderRadius**: `double` -- **BorderThickness**: `double` -- **DataIndex**: `double` -- **DataLabelX**: `string` -- **DataLabelY**: `string` -- **DataValueX**: `double` -- **DataValueY**: `double` -- **IsCenterLabel**: `bool` -- **IsEndLabel**: `bool` -- **IsStartLabel**: `bool` -- **IsXAxisBadgeEnabled**: `bool` — Sets whether the x axis badge is enabled or not. -- **IsYAxisBadgeEnabled**: `bool` — Sets whether the y axis badge is enabled or not. -- **TextColor**: `string` -- **Type**: `string` -- **XAxisBadgeBackground**: `string` — Sets the x axis badge background color. -- **XAxisBadgeImagePath**: `string` — Sets the path to an image to use in the x axis badge. -- **XAxisBadgeMargin**: `double` — Sets the margin between the x axis badge and annotation text. -- **XAxisBadgeOutline**: `string` — Sets the x axis badge border color. -- **XAxisBadgeOutlineThickness**: `double` — Sets the x axis badge border thickness. -- **XAxisBadgeRadius**: `double` — Sets the x axis badge border radius. -- **XAxisBadgeSize**: `double` — Sets the size of the x axis badge. -- **XAxisLabel**: `string` -- **XAxisPixel**: `double` -- **XAxisUserAnnotation**: `IgbUserBaseAnnotation` — Sets whether the x axis badge is enabled or not. -- **XAxisValue**: `double` -- **XAxisWindow**: `double` -- **YAxisBadgeBackground**: `string` — Sets the y axis badge background color. -- **YAxisBadgeImagePath**: `string` — Sets the path to an image to use in the y axis badge. -- **YAxisBadgeMargin**: `double` — Sets the margin between the y axis badge and annotation text. -- **YAxisBadgeOutline**: `string` — Sets the y axis badge border color. -- **YAxisBadgeOutlineThickness**: `double` — Sets the y axis badge border thickness. -- **YAxisBadgeRadius**: `double` — Sets the y axis badge border radius. -- **YAxisBadgeSize**: `double` — Sets the size of the y axis badge. -- **YAxisLabel**: `string` -- **YAxisPixel**: `double` -- **YAxisUserAnnotation**: `IgbUserBaseAnnotation` — Sets whether the y axis badge is enabled or not. -- **YAxisValue**: `double` -- **YAxisWindow**: `double` -- **FindByName**(name: string): object - -### [IgbDataAnnotationItem](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationItem) -Represents a definition of data annotation displayed by the DataAnnotationShapeLayer - -- **constructor**(): void -- **CenterLabelX**: `string` — Gets or sets a label displayed at center annotation shape on x-axis -- **CenterLabelY**: `string` — Gets or sets a label displayed at center annotation shape on y-axis -- **DataIndex**: `int` — Gets data index associated with the annotation -- **EndLabelX**: `string` — Gets or sets a label displayed at end annotation shape on x-axis -- **EndLabelY**: `string` — Gets or sets a label displayed at end annotation shape on y-axis -- **ShapeBrush**: `string` — Gets or sets fill brush of the annotation shape -- **ShapeCenterX**: `double` — Gets X coordinate for the center of annotation shape -- **ShapeCenterY**: `double` — Gets Y coordinate for the center of annotation shape -- **ShapeEndX**: `double` — Gets X coordinate for the end of annotation shape -- **ShapeEndY**: `double` — Gets Y coordinate for the end of annotation shape -- **ShapeOutline**: `string` — Gets or sets outline brush of the annotation shape -- **ShapeStartX**: `double` — Gets X coordinate for the start of annotation shape -- **ShapeStartY**: `double` — Gets Y coordinate for the start of annotation shape -- **ShapeThickness**: `double` — Gets or sets outline thickness of the annotation shape -- **StartLabelX**: `string` — Gets or sets a label displayed at start annotation shape on x-axis -- **StartLabelY**: `string` — Gets or sets a label displayed at start annotation shape on y-axis -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbDataAnnotationLineLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationLineLayer) -Represents an annotation layer that renders lines at locations of x/y values mapped to these properties: StartValueXMemberPath StartValueYMemberPath EndValueXMemberPath EndValueYMemberPath - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbDataAnnotationLineLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationLineLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataAnnotationPointLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationPointLayer) -Represents a base of annotation layers that render shapes at locations of x/y values mapped to these properties: StartValueXMemberPath StartValueYMemberPath EndValueXMemberPath EndValueYMemberPath - -- **constructor**(): void -- **AnnotationBadgeBackgroundXMemberPath**: `string` — Gets or sets a member path for background of the badge annotations on x-axis. -- **AnnotationBadgeBackgroundYMemberPath**: `string` — Gets or sets a member path for background of the badge annotations on y-axis. -- **AnnotationBadgeEnabledXMemberPath**: `string` — Gets or sets a member path for visibility of the badge annotations on x-axis. -- **AnnotationBadgeEnabledYMemberPath**: `string` — Gets or sets a member path for visibility of the badge annotations on y-axis. -- **AnnotationBadgeImageXMemberPath**: `string` — Gets or sets a member path for displaying an image in the badge annotations on x-axis. -- **AnnotationBadgeImageYMemberPath**: `string` — Gets or sets a member path for displaying an image in the badge annotations on y-axis. -- **AnnotationBadgeOutlineXMemberPath**: `string` — Gets or sets a member path for outline of the badge annotations on x-axis. -- **AnnotationBadgeOutlineYMemberPath**: `string` — Gets or sets a member path for outline of the badge annotations on y-axis. -- **CenterLabelXDisplayMode**: `DataAnnotationDisplayMode` — Gets or sets display mode of label in the annotation on x-axis. -- **CenterLabelXMemberPath**: `string` — Gets or sets mapping custom label at the center of the annotations on x-axis. -- **CenterLabelYDisplayMode**: `DataAnnotationDisplayMode` — Gets or sets display mode of label in the annotation on y-axis. -- **CenterLabelYMemberPath**: `string` — Gets or sets mapping custom label at the center of the annotations on y-axis. -- **EndLabelXDisplayMode**: `DataAnnotationDisplayMode` — Gets or sets display mode of label at the end annotation on x-axis. -- **EndLabelXMemberPath**: `string` — Gets or sets mapping custom label at the end of annotations on x-axis. -- **EndLabelYDisplayMode**: `DataAnnotationDisplayMode` — Gets or sets display mode of label at the end annotation on y-axis. -- **EndLabelYMemberPath**: `string` — Gets or sets mapping custom label at the end of annotations on y-axis. -- **EndValueXMemberPath**: `string` — Gets or sets name of data column with x-positions for end of annotation. -- **EndValueYMemberPath**: `string` — Gets or sets name of data column with y-positions for end of annotation. -- **StartLabelXDisplayMode**: `DataAnnotationDisplayMode` — Gets or sets display mode of label in the start annotation on x-axis. -- **StartLabelXMemberPath**: `string` — Gets or sets mapping custom label at the start of annotations on x-axis. -- **StartLabelYDisplayMode**: `DataAnnotationDisplayMode` — Gets or sets display mode of label in the start annotation on y-axis. -- **StartLabelYMemberPath**: `string` — Gets or sets mapping custom label at the start of annotations on y-axis. -- **StartValueXMemberPath**: `string` — Gets or sets name of data column with x-positions for the start of annotations. -- **StartValueYMemberPath**: `string` — Gets or sets name of data column with y-positions for the start of annotations. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbDataAnnotationRangeLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationRangeLayer) -Represents a base of annotation layers that render from start/end range - -- **constructor**(): void -- **CenterLabelBackground**: `string` — Gets or sets the background used for displaying the center annotation label. -- **CenterLabelBorderColor**: `string` — Gets or sets the border color used for displaying the center annotation label. -- **CenterLabelTextColor**: `string` — Gets or sets the text color used for displaying the center annotation label. -- **EndLabelBackground**: `string` — Gets or sets the background used for displaying the end annotation label. -- **EndLabelBorderColor**: `string` — Gets or sets the border used for displaying the end annotation label. -- **EndLabelTextColor**: `string` — Gets or sets the text color used for displaying the end annotation label. -- **StartLabelBackground**: `string` — Gets or sets the background used for displaying the start annotation label. -- **StartLabelBorderColor**: `string` — Gets or sets the border color used for displaying Start annotation label. -- **StartLabelTextColor**: `string` — Gets or sets the text color used for displaying the start annotation label. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbDataAnnotationRectLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationRectLayer) -Represents an annotation layer that renders rectangles at locations of x/y values mapped to these properties: StartValueXMemberPath StartValueYMemberPath EndValueXMemberPath EndValueYMemberPath - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbDataAnnotationRectLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationRectLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataAnnotationShapeLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationShapeLayer) -Represents a base annotation layer that renders shapes defined by derived data annotation, e.g. line, strip, slice, rect, band - -- **constructor**(): void -- **AnnotationShapeVisible**: `bool` — Gets or sets whether to draw shape of annotations in the plot area -- **IsTargetingHorizontalAxis**: `bool` — Gets whether the annotation layer is currently targeting horizontal axis. -- **ItemsUseWorldCoordinates**: `bool` — Gets or sets whether the data items of the annotations use world coordinates (0.0 - 1.0) or they default to using axes coordinates (data indexes for category axis or data values for numeric axis). -- **OverlayText**: `string` — Gets or sets the text that will be displayed as the overlay annotation. -- **OverlayTextAngle**: `double` — Gets or sets the angle rotation (in degrees) of the overlay text in relation to shape of data annotation. -- **OverlayTextBackground**: `string` — Gets or sets the background the overlay text. -- **OverlayTextBackgroundMatchLayer**: `bool` — Gets or sets whether the overlay text background matches brush of the layer -- **OverlayTextBackgroundMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the background of overlay text based on the target series. -- **OverlayTextBackgroundShift**: `double` — Gets or sets the shift of the overlay background based on OverlayTextBackgroundMode. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **OverlayTextBorderColor**: `string` — Gets or sets the border stroke of the overlay text. -- **OverlayTextBorderMatchLayer**: `bool` — Gets or sets whether the overlay text border matches brush of the layer -- **OverlayTextBorderMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the border of overlay text based on the target series. -- **OverlayTextBorderRadius**: `double` — Gets or sets the border corner of the overlay text. -- **OverlayTextBorderShift**: `double` — Gets or sets the shift of the overlay border based on OverlayTextBorderMode. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **OverlayTextBorderThickness**: `double` — Gets or sets the border thickness of the overlay text. -- **OverlayTextColor**: `string` — Gets or sets the color the overlay text. -- **OverlayTextColorMatchLayer**: `bool` — Gets or sets whether the overlay text color matches brush of the layer -- **OverlayTextColorMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the background of overlay text based on the target series. -- **OverlayTextColorShift**: `double` — Gets or sets the shift of the overlay text color based on OverlayTextColorMode. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **OverlayTextFontFamily**: `string` -- **OverlayTextFontSize**: `double` -- **OverlayTextFontStyle**: `string` -- **OverlayTextFontWeight**: `string` -- **OverlayTextHorizontalMargin**: `double` — Gets or sets the horizontal margin of the overlay text in relation to shape of data annotation. -- **OverlayTextHorizontalPadding**: `double` — Gets or sets the horizontal padding of the overlay text in relation to shape of data annotation. -- **OverlayTextLocation**: `OverlayTextLocation` — Gets or sets location of the overlay text in relation to shape of data annotation. -- **OverlayTextMemberPath**: `string` — Gets or sets name of data column with text that will be displayed as overlay text. -- **OverlayTextVerticalMargin**: `double` — Gets or sets the vertical margin of the overlay text in relation to shape of data annotation. -- **OverlayTextVerticalPadding**: `double` — Gets or sets the vertical padding of the overlay text in relation to shape of data annotation. -- **OverlayTextVisible**: `bool` — Gets or sets whether the overlay text is visible in shape of data annotation -- **StylingAxisAnnotation**: `EventCallback` -- **StylingAxisAnnotationScript**: `string` -- **StylingOverlayText**: `EventCallback` -- **StylingOverlayTextScript**: `string` -- **StylingShapeAnnotation**: `EventCallback` -- **StylingShapeAnnotationScript**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromWorld**(world: Point): Point -- **FromWorldAsync**(world: Point): Task — Converts world coordinate (0.0 - 1.0) to pixel coordinate that is relative to component's size -- **FromWorldX**(x: double): double -- **FromWorldXAsync**(x: double): Task — Converts world X coordinate (0.0 - 1.0) to pixel coordinate that is relative to component's width -- **FromWorldY**(y: double): double -- **FromWorldYAsync**(y: double): Task — Converts world Y coordinate (0.0 - 1.0) to pixel coordinate that is relative to component's height -- **ToWorld**(pixel: Point): Point -- **ToWorldAsync**(pixel: Point): Task — Converts pixel coordinate (relative to component's size) to world coordinate (0.0 - 1.0) -- **ToWorldX**(x: double): double -- **ToWorldXAsync**(x: double): Task — Converts pixel X coordinate (relative to component's width) to world coordinate (0.0 - 1.0) -- **ToWorldY**(y: double): double -- **ToWorldYAsync**(y: double): Task — Converts pixel Y coordinate (relative to component's height) to world coordinate (0.0 - 1.0) - -### [IgbDataAnnotationSliceLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationSliceLayer) -Represents an annotation layer that renders vertical or horizontal slices/lines at values mapped to AnnotationValueMemberPath property horizontal slices/lines when TargetAxis is set to Y-axis vertical slices/lines when TargetAxis is set to X-axis - -- **constructor**(): void -- **AnnotationBadgeBackgroundMemberPath**: `string` — Gets or sets a member path for background of the badge annotations on an axis. -- **AnnotationBadgeEnabledMemberPath**: `string` — Gets or sets a member path for visibility of the badge annotations on an axis. -- **AnnotationBadgeImageMemberPath**: `string` — Gets or sets a member path for image of the badge annotations on an axis. -- **AnnotationBadgeOutlineMemberPath**: `string` — Gets or sets a member path for outline of the badge annotations on an axis. -- **AnnotationLabelMemberPath**: `string` — Gets or sets mapping custom label on axis annotations. -- **AnnotationValueMemberPath**: `string` — Gets or sets name of data column with values used to position annotations. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbDataAnnotationSliceLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationSliceLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataAnnotationStripLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationStripLayer) -Represents an annotation layer that renders vertical or horizontal strips between values mapped to these properties: StartValueMemberPath EndValueMemberPath - -- **constructor**(): void -- **AnnotationBadgeBackgroundMemberPath**: `string` — Gets or sets a member path for background of the badge annotations on an axis. -- **AnnotationBadgeEnabledMemberPath**: `string` — Gets or sets a member path for visibility of the badge annotations on an axis. -- **AnnotationBadgeImageMemberPath**: `string` — Gets or sets a member path for image of the badge annotations on an axis. -- **AnnotationBadgeOutlineMemberPath**: `string` — Gets or sets a member path for outline of the badge annotations on an axis. -- **CenterLabelDisplayMode**: `DataAnnotationDisplayMode` — Gets or sets display mode of label in the center annotation. -- **CenterLabelMemberPath**: `string` — Gets or sets mapping custom label between start and end of data annotations. -- **EndLabelDisplayMode**: `DataAnnotationDisplayMode` — Gets or sets display mode of label at the end annotation. -- **EndLabelMemberPath**: `string` — Gets or sets mapping custom label at the end of annotations. -- **EndValueMemberPath**: `string` — Gets or sets name of data column with positions for end of annotation. -- **StartLabelDisplayMode**: `DataAnnotationDisplayMode` — Gets or sets display mode of label in the start annotation. -- **StartLabelMemberPath**: `string` — Gets or sets mapping custom label at the start of annotations. -- **StartValueMemberPath**: `string` — Gets or sets name of data column with positions for the start of annotations. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbDataAnnotationStripLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataAnnotationStripLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataBindingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataBindingEventArgs) -Information about the data binding taking place. - -- **constructor**(): void -- **ResolvedValue**: `object` — The resolved value for the cell. -- **ResolvedValueScript**: `string` — Provides a means of setting ResolvedValue in the JavaScript environment. -- **RowObject**: `object` — The data for the row in which the cell is contained. -- **RowObjectScript**: `string` — Provides a means of setting RowObject in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataChart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChart) -Represents a chart area containing axes, series, an optional legend and other hosted content. - -- **constructor**(): void -- **ActualAxes**: `IgbAxisCollection` -- **ActualPlotAreaMarginBottom**: `double` — Gets the actual resolved bottom plot area margin; -- **ActualPlotAreaMarginLeft**: `double` — Gets the actual resolved left plot area margin; -- **ActualPlotAreaMarginRight**: `double` — Gets the actual resolved right plot area margin; -- **ActualPlotAreaMarginTop**: `double` — Gets the actual resolved top plot area margin; -- **ActualWindowScaleHorizontal**: `double` — A number between 0 and 1 determining the scale of the horizontal zoom. -- **ActualWindowScaleVertical**: `double` — A number between 0 and 1 determining the scale of the vertical zoom. -- **AlignsGridLinesToPixels**: `bool` — Gets or sets a value indicating whether grid and tick lines are aligned to device pixels. -- **AutoExpandMarginExtraPadding**: `double` — Gets or sets the extra amount the series viewer should auto expand margins to accomodate the initial horizontal axis labels. -- **AutoExpandMarginMaximumValue**: `double` — Gets or sets the maximum amount the series viewer should auto expand margins to accomodate the initial horizontal axis labels. -- **AutoMarginAndAngleUpdateMode**: `AutoMarginsAndAngleUpdateMode` — Gets or sets a whether the series viewer should consider auto rotating labels to fit them in the initial view. This implies that ShouldAutoExpandMarginForInitialLabels is true. -- **Axes**: `IgbAxisCollection` — Gets the current Chart object's child DataChartAxes. -- **ComputedPlotAreaMarginMode**: `ComputedPlotAreaMarginMode` — Gets or sets mode to use for automatically calculating the plot area margin. -- **ContentAxes**: `IgbAxisCollection` -- **DefaultAxisMajorStroke**: `string` — Gets or sets the DefaultAxisMajorStroke property. -- **DefaultAxisMinorStroke**: `string` — Gets or sets the DefaultAxisMinorStroke property. -- **DefaultAxisStroke**: `string` — Gets or sets the DefaultAxisStroke property. -- **FullAxes**: `IgbAxisCollection` -- **GridMode**: `GridMode` — Gets or sets how grid lines are rendered in relation to series. -- **IsHorizontalZoomEnabled**: `bool` — Gets or sets horizontal zoomability of the current control -- **IsSquare**: `bool` — Gets or sets whether to use a square aspect ratio for the chart. This is locked to true for polar and radial charts. -- **IsVerticalZoomEnabled**: `bool` — Gets or sets vertical zoomability of the current control -- **NeedsDynamicContent**: `bool` -- **PlotAreaMarginBottom**: `double` — Margin applied below the plot area. -- **PlotAreaMarginLeft**: `double` — Margin applied to the left of the plot area. -- **PlotAreaMarginRight**: `double` — Margin applied to the right of the plot area. -- **PlotAreaMarginTop**: `double` — Margin applied above the plot area. -- **SeriesPlotAreaMarginHorizontalMode**: `SeriesPlotAreaMarginHorizontalMode` — Gets or sets horizontal mode to use for automatically calculating the plot area margin based ont the series. -- **SeriesPlotAreaMarginVerticalMode**: `SeriesPlotAreaMarginVerticalMode` — Gets or sets vertical mode to use for automatically calculating the plot area margin based ont the series. -- **ShouldAutoExpandMarginForInitialLabels**: `bool` — Gets or sets a whether the series viewer should auto expand margins to accomodate the initial horizontal axis labels. -- **ShouldConsiderAutoRotationForInitialLabels**: `bool` — Gets or sets a whether the series viewer should consider auto rotating labels to fit them in the initial view. This implies that ShouldAutoExpandMarginForInitialLabels is true. -- **ShouldSuppressAxisLabelTruncation**: `bool` — Gets or sets a whether the series viewer should suppress truncation of axis labels. -- **SuppressAutoMarginAndAngleRecalculation**: `bool` — Gets or sets a whether the series viewer should suppress auto recalculating margin and axis label angles. -- **Type**: `string` -- **WindowScaleHorizontal**: `double` — A number between 0 and 1 determining the scale of the horizontal zoom. -- **WindowScaleVertical**: `double` — A number between 0 and 1 determining the scale of the vertical zoom. -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Export serialized visual data. -- **FindByName**(name: string): object -- **GetAllAxes**(): IgbAxis[] -- **RecalculateAutoLabelsAngle**(): void -- **RecalculateAutoLabelsAngleAsync**(): Task -- **RecalculateMarginAutoExpansion**(): void -- **RecalculateMarginAutoExpansionAsync**(): Task -- **RefreshComputedPlotAreaMargin**(): void -- **RefreshComputedPlotAreaMarginAsync**(): Task -- **StyleUpdated**(): void -- **StyleUpdatedAsync**(): Task — Notifies the chart that the CSS styles in effect have been updated. - -### [IgbDataChartAnnotationModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartAnnotationModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartCategoryCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartCategoryCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartCategoryModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartCategoryModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartCategoryTrendLineModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartCategoryTrendLineModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartDashboardTileModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartDashboardTileModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartExtendedAxesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartExtendedAxesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartFinancialCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartFinancialCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartFinancialIndicatorsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartFinancialIndicatorsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartFinancialModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartFinancialModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartFinancialOverlaysModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartFinancialOverlaysModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartInteractivityModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartInteractivityModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartMouseButtonEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartMouseButtonEventArgs) -Provides data for IgbDataChart mouse button related events. - -- **constructor**(): void -- **Chart**: `IgbSeriesViewer` — Gets the Chart associated with the current event. -- **ChartPosition**: `Point` — Gets the mouse position relative to the chart. -- **Handled**: `bool` — Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. -- **Item**: `object` — Gets the ItemsSource item associated with the current event. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **OriginalSource**: `object` — Gets a reference to the object that raised the event. -- **OriginalSourceScript**: `string` — Provides a means of setting OriginalSource in the JavaScript environment. -- **PlotAreaPosition**: `Point` — Gets the mouse position relative to the plot area. -- **Series**: `IgbSeries` — Gets the series associated with the current event. -- **Type**: `string` -- **WorldPosition**: `Point` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **GetPosition**(relativeTo: object): Point -- **GetPositionAsync**(relativeTo: object): Task — Returns the x- and y- coordinates of the mouse pointer position, optionally evaluated against the origin of a supplied UIElement. -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataChartPolarCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartPolarCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartPolarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartPolarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartRadialCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartRadialCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartRadialModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartRadialModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartScatterCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartScatterCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartScatterModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartScatterModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartShapeCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartShapeCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartShapeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartShapeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartStackedModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartStackedModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartToolbarIconsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartToolbarIconsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartToolbarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartToolbarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartVerticalCategoryCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartVerticalCategoryCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartVerticalCategoryModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartVerticalCategoryModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataChartVisualDataModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataChartVisualDataModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataCloneStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataCloneStrategy) - -- **constructor**(): void -- **Type**: `string` -- **Clone**(data: object): object -- **CloneAsync**(data: object): Task — Clones provided data data primitive value, date and object to be cloned deep copy of provided value -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDataContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataContext) -Represents the data currently in context. - -- **constructor**(): void -- **ActualItemBrush**: `string` — Gets the actual resolved brush in use for the item that is in context. -- **Item**: `object` — Gets the item that is in context. -- **ItemBrush**: `string` — Gets the potential brush in usage for the item in context. -- **ItemLabel**: `object` — Gets the label in use for the item in context, if available. -- **ItemLabelScript**: `string` — Provides a means of setting ItemLabel in the JavaScript environment. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **LegendLabel**: `object` — Gets the legend label to use for the item in context, if available. -- **LegendLabelScript**: `string` — Provides a means of setting LegendLabel in the JavaScript environment. -- **Outline**: `string` — Gets the outline in use for the item in context. -- **Thickness**: `double` — Gets the thickness of the item in context. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataGrid](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGrid) -An advanced grid for displaying data. - -- **constructor**(): void -- **ActivationMode**: `GridActivationMode` — Sets or gets the grid selection mode. -- **ActiveCell**: `IgbGridCellPosition` — Gets or sets the position of the active cell. -- **ActiveCellChanged**: `Action` -- **ActiveCellChangedScript**: `string` -- **ActualBackground**: `string` — Gets the actual background for the grid. -- **ActualBorder**: `string` — Gets the actual border color around the grid. -- **ActualColumns**: `IgbGridColumnCollection` -- **ActualColumnsChanged**: `Action` -- **ActualColumnsChangedScript**: `string` -- **ActualDataSource**: `IgbBaseDataSource` -- **ActualHeaderHeight**: `int` — Gets the height used for the header row. -- **ActualPrimaryKey**: `string[]` — Gets either the inferred primary key from the data source, or the user provided primary key, if present. Represents the actual primary key that the grid will use in operations that require it. -- **ActualPrimaryKeyChanged**: `EventCallback` -- **ActualPrimaryKeyChangedScript**: `string` -- **ActualRowHeight**: `int` — Gets the actual height for the rows in the grid. -- **AllowCopyOperation**: `bool` -- **AnimationSettings**: `IgbGridAnimationSettings` — Sets or gets the default animation settings for the grid. -- **AutoAcceptEdits**: `bool` — Gets or sets whether to automatically accept edits or require explicit acceptance or rejections of edits when handling the CellValueChanging or DataCommitting events. When True, nothing is required on the part of the developer in order for edits to be accepted. In order to validate and reject a user cell edit you must explicitly handle the CellValueChanging event and call the RejectEdit method using the edit ID provided by the event. In order to reject a whole commit you need to handle the DataComitting event and explicitly call the RejectCommit method using the commit ID provided by the event. When False, cell edits are not immediately accepted until you explicitly call the AcceptEdit method using the edit ID provided by the CellValueChanging event. If you do not handle this event then edits will be auto accepted. -- **AutoGenerateColumns**: `bool` — Configures whether or not the grid will autogenerate columns when the data source is set. -- **AutoGenerateDesiredProperties**: `string[]` — Gets or sets the desired properties the grid will automatically generate columns for. -- **Background**: `string` — Gets or sets the background for the grid. -- **Border**: `string` — Gets or sets the border color around the grid. -- **BorderWidthBottom**: `double` -- **BorderWidthLeft**: `double` -- **BorderWidthRight**: `double` -- **BorderWidthTop**: `double` -- **CellBackground**: `string` — Gets or sets the default background color to use for content cells -- **CellClicked**: `Action` -- **CellClickedScript**: `string` -- **CellDataLoadedAnimationMode**: `CellDataLoadedAnimationMode` — Sets or gets the cell data loaded animation mode to use. -- **CellEditEnded**: `Action` -- **CellEditEndedScript**: `string` -- **CellEditStarted**: `Action` -- **CellEditStartedScript**: `string` -- **CellFontFamily**: `string` -- **CellFontSize**: `double` -- **CellFontStyle**: `string` -- **CellFontWeight**: `string` -- **CellPointerDown**: `Action` -- **CellPointerDownScript**: `string` -- **CellPointerUp**: `Action` -- **CellPointerUpScript**: `string` -- **CellPreviewPointerDown**: `Action` -- **CellPreviewPointerDownScript**: `string` -- **CellPreviewPointerUp**: `Action` -- **CellPreviewPointerUpScript**: `string` -- **CellSelectedBackground**: `string` — Gets or sets the default background color to use for content cells when a row is in a selected state -- **CellSelectionAnimationMode**: `CellSelectionAnimationMode` — Sets or gets the cell selection animation mode to use. -- **CellTextColor**: `string` — Gets or sets the default text color to use for content cells -- **CellValueChanging**: `Action` -- **CellValueChangingScript**: `string` -- **ClearSelectionOnEscape**: `bool` — Gets or sets whether selection is cleared when pressing the Escape key. -- **ColumnAddingAnimationMode**: `ColumnShowingAnimationMode` — Sets or gets the Column Adding Animation mode to use. -- **ColumnExchangingAnimationMode**: `ColumnExchangingAnimationMode` — Sets or gets the column exchanging animation mode to use. -- **ColumnHiddenChanged**: `Action` -- **ColumnHiddenChangedScript**: `string` -- **ColumnHidingAnimationMode**: `ColumnHidingAnimationMode` — Sets or gets the column hiding animation mode to use. -- **ColumnMovingAnimationMode**: `ColumnMovingAnimationMode` — Sets or gets the column moving animation mode to use. -- **ColumnMovingMode**: `ColumnMovingMode` — Gets or sets the type column moving to use. -- **ColumnMovingSeparator**: `IgbColumnMovingSeparator` — Gets or sets the column resizing seperator settings. -- **ColumnMovingSeparatorBackground**: `string` — Gets or sets the default background color to use for column moving separator. -- **ColumnMovingSeparatorOpacity**: `double` — Gets or sets the opacity of the column moving separator. -- **ColumnMovingSeparatorWidth**: `int` — Sets or gets the width to use for the column resizing separator. -- **ColumnOptionsAccentColor**: `string` -- **ColumnOptionsBackground**: `string` — Gets or sets the column options dropdown background color. -- **ColumnOptionsGroupHeaderBackground**: `string` — Gets or sets the background color for group headers inside the column options menu. -- **ColumnOptionsGroupHeaderTextColor**: `string` — Gets or sets the text color for group headers inside the column options menu. -- **ColumnOptionsIconAlignment**: `ColumnOptionsIconAlignment` — Gets or sets the column options icon alignment in header cells. -- **ColumnOptionsIconBehavior**: `ColumnOptionsIconBehavior` — Gets or sets how the column options icon will behave inside header cells. -- **ColumnOptionsIconColor**: `string` — Gets or sets the column options icon color in header cells. -- **ColumnOptionsSeparatorColor**: `string` — Gets or sets the color of separators inside the column options menu. -- **ColumnOptionsTextColor**: `string` — Gets or sets the text color for text inside the column options menu. -- **ColumnPinnedChanged**: `Action` -- **ColumnPinnedChangedScript**: `string` -- **ColumnPropertyUpdatingAnimationMode**: `ColumnPropertyUpdatingAnimationMode` — Sets or gets the Column Property Updating Animation mode to use. -- **ColumnResizingAnimationMode**: `ColumnResizingAnimationMode` — Sets or gets the column resizing animation mode to use. Only applies when resizing in Deferred mode. -- **ColumnResizingMode**: `ColumnResizingMode` — Gets or sets the type of column resizing to use. -- **ColumnResizingSeparator**: `IgbColumnResizingSeparator` — Gets or sets the column resizing seperator settings. -- **ColumnResizingSeparatorBackground**: `string` — Gets or sets the default background color to use for column resizing separator. -- **ColumnResizingSeparatorOpacity**: `double` — Gets or sets the opacity of the column Resizing separator. -- **ColumnResizingSeparatorWidth**: `int` — Sets or gets the width to use for the column resizing separator. -- **ColumnShowingAnimationMode**: `ColumnShowingAnimationMode` — Sets or gets the column showing animation mode to use. -- **ColumnWidthChanged**: `Action` -- **ColumnWidthChangedScript**: `string` -- **Columns**: `IgbGridColumnCollection` — Gets the column definitions that are assigned to the grid. This collection can be modified to add or remove columns in the grid. -- **ColumnsAutoGenerated**: `Action` -- **ColumnsAutoGeneratedScript**: `string` -- **ContentColumns**: `IgbGridColumnCollection` -- **CornerRadiusBottomLeft**: `double` -- **CornerRadiusBottomRight**: `double` -- **CornerRadiusTopLeft**: `double` -- **CornerRadiusTopRight**: `double` -- **CustomFilterRequested**: `Action` -- **DataCommitted**: `Action` -- **DataCommittedScript**: `string` -- **DataCommitting**: `Action` — Called when edits are about to be committed to the datasource. -- **DataSource**: `object` — Gets or sets the data to which to bind the grid. This can be some type of array or list, or it can be an IDataSource instance. -- **DataSourceDesiredProperties**: `string[]` — Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DefaultColumnMinWidth**: `double` — Gets or sets the default minimum width to use on all columns. Ignored if NaN. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DeferEventForRowDragSelection**: `bool` — Gets or sets whether to defer the SelectedItemsChanged and SelectedKeysChanged events till after the drag selection has completed. -- **DeletedTextColor**: `string` — Gets or sets the text color for unsaved deleted rows. -- **Density**: `ControlDisplayDensity` — Gets or sets the display density to use for the grid. -- **EditFontFamily**: `string` -- **EditFontSize**: `double` -- **EditFontStyle**: `string` -- **EditFontWeight**: `string` -- **EditMode**: `EditModeType` — Gets or sets the type of edit mode -- **EditModeClickAction**: `EditModeClickAction` — Gets or sets the type of click action required to enter edit mode. -- **EditOnKeyPress**: `bool` — Gets or sets whether edit mode will begin as soon as you start typing while a cell is active. -- **EditOpacity**: `double` — Gets or sets the default opacity for unsaved cell edits. -- **EditRowBorder**: `string` — Gets or sets the border color for rows being edited. -- **EditRowBorderWidthBottom**: `double` -- **EditRowBorderWidthLeft**: `double` -- **EditRowBorderWidthRight**: `double` -- **EditRowBorderWidthTop**: `double` -- **EnterBehavior**: `EnterKeyBehaviors` — Gets or sets the behavior of the Enter key. -- **EnterBehaviorAfterEdit**: `EnterKeyBehaviorAfterEdit` — Gets or sets the behavior of the enter key when exiting edit mode. -- **FilterComparisonType**: `FilterComparisonType` — Gets or sets whether UI filters are case sensitive or not. -- **FilterExpressions**: `IgbFilterExpressionCollection` — Gets the current filter that is applied to the grid. Collection can be updated to modify the filter for the grid. Once filter expresisons are in this collection, the grid will no longer listen for changes on their properties. -- **FilterExpressionsChanged**: `Action` -- **FilterExpressionsChangedScript**: `string` -- **FilterExpressionsChanging**: `Action` -- **FilterExpressionsChangingScript**: `string` -- **FilterLogicalOperator**: `FilterLogicalOperator` — Gets or sets how filters set through the filter UI are combined. -- **FilterUIType**: `FilterUIType` — Gets or sets which filter UI type to use. -- **GroupDescriptions**: `IgbColumnGroupDescriptionCollection` — Gets the current grouping that is applied to the grid. Collection can be updated to modify the grouping for the grid. Once grouping descriptions are in this collection, the grid will no longer listen for changes on their properties. -- **GroupDescriptionsChanged**: `Action` -- **GroupDescriptionsChangedScript**: `string` -- **GroupHeaderDisplayMode**: `GroupHeaderDisplayMode` — Gets or sets how group headers are displayed when there are multiple groups defined in the grid. -- **GroupSummaryDisplayMode**: `GroupSummaryDisplayMode` — Gets or sets the display mode summaries will use inside groups. -- **HeaderBackground**: `string` — Gets or sets the default background color to use for header cells -- **HeaderClickAction**: `HeaderClickAction` — Returns/sets the action to take when a column header is clicked. -- **HeaderFontFamily**: `string` -- **HeaderFontSize**: `double` -- **HeaderFontStyle**: `string` -- **HeaderFontWeight**: `string` -- **HeaderHeight**: `int` — Gets or sets the height to use for the header row. -- **HeaderRowSeparator**: `IgbHeaderRowSeparator` — Gets or sets the header row seperator settings. -- **HeaderRowSeparatorBackground**: `string` -- **HeaderSeparator**: `IgbHeaderSeparator` — Gets or sets the header seperator settings. -- **HeaderSeparatorBackground**: `string` — Gets or sets the default background color to use for header separators. -- **HeaderSeparatorWidth**: `int` — Gets or sets the width of the header separators. -- **HeaderSortIndicatorColor**: `string` — Gets or sets the default text color to use for content cells -- **HeaderSortIndicatorStyle**: `SortIndicatorStyle` — Gets or sets the default render style for sort indicators in header cells. -- **HeaderTextColor**: `string` — Gets or sets the default text color to use for header cells -- **InitialGroupDescriptions**: `IgbColumnGroupDescriptionCollection` — Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties. -- **InitialGroups**: `string` -- **InitialSortDescriptions**: `IgbColumnSortDescriptionCollection` — Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties. -- **InitialSorts**: `string` -- **InitialSummaries**: `string` -- **InitialSummaryDescriptions**: `IgbColumnSummaryDescriptionCollection` — Gets the current summaries that are applied to the grid. -- **IsActiveCellStyleEnabled**: `bool` — Gets or sets whether the active cell style will be applied to cells when made active. -- **IsColumnOptionsEnabled**: `bool` — Gets or sets whether to show the column options UI in the headers for columns. -- **IsColumnOptionsGroupingEnabled**: `bool` — Gets or sets whether to show the grouping option in the column options menu. -- **IsColumnOptionsSummariesEnabled**: `bool` — Gets or sets whether to show the summaries option in the column options menu. -- **IsGroupByAreaVisible**: `bool` — Gets or sets whether to show the column grouping UI above the headers of the grid. -- **IsGroupCollapsable**: `bool` — Gets or sets whether group headers are collapsable. -- **IsGroupExpandedDefault**: `bool` — Gets or sets whether groups are expanded or collapsed by default. -- **IsGroupRowSticky**: `bool` — Gets or sets if group rows will stick to the top of the grid. -- **IsHeaderSeparatorVisible**: `bool` — Gets or sets if header separators are rendered. -- **IsPagerVisible**: `bool` — Gets or sets whether to show the pager or not. -- **IsPlaceholderRenderingEnabled**: `bool` — Configures whether or not place holders are used for cells who do not have their data yet. -- **IsRowHoverEnabled**: `bool` — Gets or sets whether the row will highlight when hovered. -- **IsToolbarColumnChooserVisible**: `bool` — Gets or sets whether to show the column chooser button in the toolbar. -- **IsToolbarColumnPinningVisible**: `bool` — Gets or sets whether to show the column pinning button in the toolbar. -- **IsToolbarVisible**: `bool` — Gets or sets whether to show the toolbar. -- **LastStickyRowBackground**: `string` — Gets or sets the default color to use for the last sticky row -- **MergedCellEvaluationCriteria**: `MergedCellEvaluationCriteria` — Gets or sets how cells are evaluated for merging. -- **MergedCellMode**: `MergedCellMode` — Gets or sets if and how cell merging is performed for all fields. -- **MergedCellVerticalAlignment**: `CellContentVerticalAlignment` — Gets or sets the vertical alignment to use for the merged cell content. -- **MouseDragSelectionEnabled**: `bool` — Gets or sets the ability to select rows or cells via mouse dragging. Currently only applies when SelectionMode is MultipleRow or RangeCell. -- **NeedsDynamicContent**: `bool` -- **NotifyOnAllSelectionChanges**: `bool` — Gets or sets if the grid should notify on programmatic selection changes as well as changes from the UI. -- **PageSize**: `int` — Gets or sets the size of each page when the pager is visible. -- **ParentTypeName**: `string` -- **PinnedAreaSeparator**: `IgbPinnedAreaSeparator` — Gets or sets the pinned area separator settings. -- **PinnedAreaSeparatorWidth**: `int` — Gets or sets the width of the pinned area separators. -- **PinnedItems**: `IgbGridSelectedItemsCollection` — Gets which items are currently pinned in the grid. Collection can be updated to programatically pin items. -- **PinnedKeys**: `IgbGridSelectedKeysCollection` — Gets which primary keys are currently pinned in the grid. Collection can be updated to programatically pin items. -- **PinnedRowBackground**: `string` — Gets or sets the default color to use for pinned rows -- **PinnedRowOpacity**: `double` — Gets or sets the default opacity to use for pinned rows -- **PrimaryKey**: `string[]` — Sets or gets the user provided primary key to assume for the data. Certain functionality of the grid requires a way to uniquely identify items in order to work correctly. If a primary key cannot be inferred from the data source, you may need to provide one here. -- **ReactsToFilterChanges**: `bool` — Sets or gets whether the grid will react to filter changes. -- **ReactsToGroupChanges**: `bool` — Sets or gets whether the grid will react to group changes. -- **ReactsToSortChanges**: `bool` — Sets or gets whether the grid will react to sort changes. -- **ResponsiveStates**: `IgbResponsiveStatesCollection` — A set of states that can be applied to the columns of the grid based on available space. -- **RootSummariesChanged**: `EventCallback` -- **RootSummariesChangedScript**: `string` -- **RowEditEnded**: `Action` — Called when a row has finished editing. -- **RowEditStarted**: `Action` -- **RowEditStartedScript**: `string` -- **RowHeight**: `int` — Gets or sets the height to use for the rows in the grid. If not set the grid will use the default value for the set display density. -- **RowHoverAnimationMode**: `RowHoverAnimationMode` — Sets or gets the row hover animation mode to use. -- **RowHoverBackground**: `string` — Gets or sets the background color for rows when hovered. -- **RowHoverTextColor**: `string` — Gets or sets the text color for rows when hovered. -- **RowSelectionAnimationMode**: `RowSelectionAnimationMode` — Sets or gets the row selection animation mode to use. -- **RowSeparator**: `IgbRowSeparator` — Gets or sets the row seperator settings. -- **RowSeparatorBackground**: `string` — Gets or sets the default background color to use for row separators -- **RowSeparatorHeight**: `int` — Sets or gets the height to use for the row separators. -- **RowSeparatorLastStickyRowBackground**: `string` — Gets or sets the default last sticky row background color to use for row separators -- **RowSeparatorPinnedRowBackground**: `string` — Gets or sets the pinned row background color to use for row separators -- **RowSeparatorStickyRowBackground**: `string` — Gets or sets the default sticky row background color to use for row separators -- **ScrollbarBackground**: `string` — Gets or sets the scrollbar background color. -- **ScrollbarStyle**: `ScrollbarStyle` — Gets or sets the style of scrollbar. -- **SectionHeader**: `IgbSectionHeader` — Gets or sets the header type used for sectioning off groups of rows. -- **SectionHeaderBackground**: `string` — Gets or sets the default background color to use for section header cells -- **SectionHeaderFontFamily**: `string` -- **SectionHeaderFontSize**: `double` -- **SectionHeaderFontStyle**: `string` -- **SectionHeaderFontWeight**: `string` -- **SectionHeaderSelectedBackground**: `string` — Gets or sets the default background color to use for section header cells when a row is in a selected state -- **SectionHeaderTextColor**: `string` — Gets or sets the default text color to use for section header cells -- **SelectedCellRanges**: `IgbGridSelectedCellRangesCollection` — Gets which cell ranges are currently selected in the grid. Collection can be updated to programatically select cells. -- **SelectedCellRangesChanged**: `Action` -- **SelectedCellRangesChangedScript**: `string` -- **SelectedCells**: `IgbGridSelectedCellsCollection` — Gets which cells are currently selected in the grid. Collection can be updated to programatically select cells. -- **SelectedCellsChanged**: `Action` -- **SelectedCellsChangedScript**: `string` -- **SelectedItems**: `IgbGridSelectedItemsCollection` — Gets which items are currently selected in the grid. Collection can be updated to programatically select items. -- **SelectedItemsChanged**: `Action` -- **SelectedItemsChangedScript**: `string` -- **SelectedKeys**: `IgbGridSelectedKeysCollection` — Gets which primary key values are currently selected in the grid. Collection can be updated to programatically select items. -- **SelectedKeysChanged**: `Action` -- **SelectedKeysChangedScript**: `string` -- **SelectionBehavior**: `GridSelectionBehavior` — Sets or gets how selection behaves in the grid. -- **SelectionChanged**: `Action` -- **SelectionChangedScript**: `string` -- **SelectionMode**: `DataGridSelectionMode` — Sets or gets the grid selection mode. -- **ShiftSectionContent**: `bool` — Gets or sets if the section header content should be shifted into the normal column scrollable area when there are pinned columns -- **SizeChanged**: `EventCallback` -- **SizeChangedScript**: `string` -- **SortDescriptions**: `IgbColumnSortDescriptionCollection` — Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties. -- **SortDescriptionsChanged**: `Action` -- **SortDescriptionsChangedScript**: `string` -- **StickyRowBackground**: `string` — Gets or sets the default color to use for sticky rows -- **StopPropagation**: `bool` — Prevents mouse events from bubbling out of the grid. -- **SummaryDescriptions**: `IgbColumnSummaryDescriptionCollection` — Gets the current summaries that are applied to the grid. -- **SummaryDescriptionsChanged**: `Action` -- **SummaryDescriptionsChangedScript**: `string` -- **SummaryRootBackground**: `string` — Gets or sets the default background color to use for summary cells at the root level. -- **SummaryRootLabelFontFamily**: `string` -- **SummaryRootLabelFontSize**: `double` -- **SummaryRootLabelFontStyle**: `string` -- **SummaryRootLabelFontWeight**: `string` -- **SummaryRootLabelTextColor**: `string` — Gets or sets the default text color to use for summary labels in summary cells at the root level. -- **SummaryRootSelectedBackground**: `string` — Gets or sets the default background color to use for summary cells at the root level. -- **SummaryRootValueFontFamily**: `string` -- **SummaryRootValueFontSize**: `double` -- **SummaryRootValueFontStyle**: `string` -- **SummaryRootValueFontWeight**: `string` -- **SummaryRootValueTextColor**: `string` — Gets or sets the default text color to use for summary cells at the root level. -- **SummaryRowRoot**: `IgbSummaryRowRoot` — Gets or sets the cell definition used for summary rows at the root level. -- **SummaryRowSection**: `IgbSummaryRowSection` — Gets or sets the cell definition used for summary rows at the section level. -- **SummaryScope**: `SummaryScope` — Gets or sets the scope which summaries are calculated for. -- **SummarySectionBackground**: `string` — Gets or sets the default background color to use for summary cells at the section level. -- **SummarySectionLabelFontFamily**: `string` -- **SummarySectionLabelFontSize**: `double` -- **SummarySectionLabelFontStyle**: `string` -- **SummarySectionLabelFontWeight**: `string` -- **SummarySectionLabelTextColor**: `string` — Gets or sets the default text color to use for summary labels in summary cells at the section level. -- **SummarySectionSelectedBackground**: `string` — Gets or sets the default background color to use for summary cells at the section level. -- **SummarySectionValueFontFamily**: `string` -- **SummarySectionValueFontSize**: `double` -- **SummarySectionValueFontStyle**: `string` -- **SummarySectionValueFontWeight**: `string` -- **SummarySectionValueTextColor**: `string` — Gets or sets the default text color to use for summary cells at the section level. -- **Theme**: `BaseControlTheme` — Gets or sets the base theme used by the grid. -- **TodayOverride**: `DateTime` -- **ToolbarColumnChooserText**: `string` — Gets or sets the column chooser button text to use in the toolbar. -- **ToolbarColumnChooserTitle**: `string` — Gets or sets the column chooser title text to use in the toolbar. -- **ToolbarColumnPinningText**: `string` — Gets or sets the column pinning button text to use in the toolbar. -- **ToolbarColumnPinningTitle**: `string` — Gets or sets the column pinning title text to use in the toolbar. -- **ToolbarTitle**: `string` — Gets or sets the title text to use in the toolbar. -- **Type**: `string` -- **AcceptCommit**(commitID: int): void -- **AcceptCommitAsync**(commitID: int): Task — Accepts a specific commit to the datasource. -- **AcceptEdit**(editID: int): void -- **AcceptEditAsync**(editID: int): Task — Accept a pending edit turning it into a real edit. -- **CanCommit**(): bool -- **CanCommitAsync**(): Task -- **CanMoveColumnLeft**(columnIndex: int): bool -- **CanMoveColumnLeftAsync**(columnIndex: int): Task — Returns true if a column can be moved to the left of it's current position; otherwise false. -- **CanMoveColumnRight**(columnIndex: int): bool -- **CanMoveColumnRightAsync**(columnIndex: int): Task — Returns true if a column can be moved to the right of it's current position; otherwise false. -- **CanRedo**(): bool -- **CanRedoAsync**(): Task -- **CanUndo**(): bool -- **CanUndoAsync**(): Task -- **CancelEdits**(): void -- **CancelEditsAsync**(): Task — Cancels any edits that may exist in the datasource. -- **CommitEdits**(): void -- **CommitEditsAsync**(): Task — Commits any edits that may exist in the datasource. -- **DataIndexOfItem**(item: object): int -- **DataIndexOfItemAsync**(item: object): Task — Returns the data index of an item within the bound data source. -- **DeselectAllRows**(): void -- **DeselectAllRowsAsync**(): Task — Deselects all currently selected rows. -- **EndEditMode**(commit: bool): void -- **EndEditModeAsync**(commit: bool): Task -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualModel**(): string -- **ExportSerializedVisualModelAsync**(): Task — Returns a serialized copy of the exported visual model -- **ExportVisualModel**(): object -- **ExportVisualModelAsync**(): Task — Exports visual information about the current state of the grid. -- **FindByName**(name: string): object -- **Flush**(): void -- **FlushAsync**(): Task — Makes sure pending work has completed if the grid need to be synchronously examined. -- **GetColumnAtRenderedIndex**(index: int): IgbDataGridColumn -- **GetColumnAtRenderedIndexAsync**(index: int): Task — Gets the column that appears at the index specified. This is not the columns actual index in the column's collection but the index for how it appears visually in the grid. -- **GetCurrentActiveCell**(): IgbGridCellPosition -- **GetCurrentActiveCellAsync**(): Task -- **GetCurrentActualColumns**(): IgbGridColumnCollection -- **GetCurrentActualColumnsAsync**(): Task -- **GetCurrentActualPrimaryKey**(): string[] -- **GetCurrentActualPrimaryKeyAsync**(): Task -- **GetCurrentFilterExpressions**(): IgbFilterExpressionCollection -- **GetCurrentFilterExpressionsAsync**(): Task -- **GetCurrentGroupDescriptions**(): IgbColumnGroupDescriptionCollection -- **GetCurrentGroupDescriptionsAsync**(): Task -- **GetCurrentSelectedCellRanges**(): IgbGridSelectedCellRangesCollection -- **GetCurrentSelectedCellRangesAsync**(): Task -- **GetCurrentSelectedCells**(): IgbGridSelectedCellsCollection -- **GetCurrentSelectedCellsAsync**(): Task -- **GetCurrentSelectedItems**(): IgbGridSelectedItemsCollection -- **GetCurrentSelectedItemsAsync**(): Task -- **GetCurrentSelectedKeys**(): IgbGridSelectedKeysCollection -- **GetCurrentSelectedKeysAsync**(): Task -- **GetCurrentSortDescriptions**(): IgbColumnSortDescriptionCollection -- **GetCurrentSortDescriptionsAsync**(): Task -- **GetCurrentSummaryDescriptions**(): IgbColumnSummaryDescriptionCollection -- **GetCurrentSummaryDescriptionsAsync**(): Task -- **GetDataURLFromCache**(iconCollection: string, iconName: string): string -- **GetDataURLFromCacheAsync**(iconCollection: string, iconName: string): Task -- **GetFirstVisibleIndex**(): int -- **GetFirstVisibleIndexAsync**(): Task — Gets the first visible index in the grid. -- **GetHitCell**(x: double, y: double): IgbCellInfo -- **GetHitCellAsync**(x: double, y: double): Task -- **GetIconFromCache**(iconCollection: string, iconName: string): string -- **GetIconFromCacheAsync**(iconCollection: string, iconName: string): Task -- **GetIconSource**(iconCollection: string, iconName: string): object -- **GetIconSourceAsync**(iconCollection: string, iconName: string): Task -- **GetLastVisibleIndex**(): int -- **GetLastVisibleIndexAsync**(): Task — Gets the last visible index in the grid. -- **GetMultiPathSVGFromCache**(iconCollection: string, iconName: string): string[] -- **GetMultiPathSVGFromCacheAsync**(iconCollection: string, iconName: string): Task -- **GetRootSummaryResults**(): IgbDataGridSummaryResult[] -- **GetRootSummaryResultsAsync**(): Task — Gets the summary results for root level. -- **GetSectionSummaryResults**(sectionIndex: int): IgbDataGridSummaryResult[][] -- **GetSectionSummaryResultsAsync**(sectionIndex: int): Task — Gets the summary results for a specific section. -- **InvalidateVisibleRows**(): void -- **InvalidateVisibleRowsAsync**(): Task — Invalidates the bound data for the rows currently visible. -- **LoadLayout**(json: string): void -- **LoadLayoutAsync**(json: string): Task — Loads the layout chnages that have been made to the grid -- **MoveColumn**(oldIndex: int, newIndex: int): void -- **MoveColumnAsync**(oldIndex: int, newIndex: int): Task -- **MoveColumnLeft**(columnIndex: int): void -- **MoveColumnLeftAsync**(columnIndex: int): Task — Moves a column to the left, if possible. -- **MoveColumnRight**(columnIndex: int): void -- **MoveColumnRightAsync**(columnIndex: int): Task — Moves a column to the right, if possible. -- **NotifyScrollStart**(): void -- **NotifyScrollStartAsync**(): Task -- **NotifyScrollStop**(): void -- **NotifyScrollStopAsync**(): Task -- **PinColumn**(column: IgbDataGridColumn, position: PinnedPositions): void -- **PinColumnAsync**(column: IgbDataGridColumn, position: PinnedPositions): Task -- **Redo**(): void -- **RedoAsync**(): Task — Redo the last edit. -- **Refresh**(): void -- **RefreshAsync**(): Task — Forces a refresh of the grid content. -- **RegisterIconFromDataURL**(iconCollection: string, iconName: string, dataURL: string): void -- **RegisterIconFromDataURLAsync**(iconCollection: string, iconName: string, dataURL: string): Task -- **RegisterIconFromText**(iconCollection: string, iconName: string, iconText: string): void -- **RegisterIconFromTextAsync**(iconCollection: string, iconName: string, iconText: string): Task -- **RegisterIconSource**(iconCollection: string, iconName: string, source: object): void -- **RegisterIconSourceAsync**(iconCollection: string, iconName: string, source: object): Task -- **RegisterMultiPathSVG**(iconCollection: string, iconName: string, multiPathSVG: string[]): void -- **RegisterMultiPathSVGAsync**(iconCollection: string, iconName: string, multiPathSVG: string[]): Task -- **RejectCommit**(commitID: int): void -- **RejectCommitAsync**(commitID: int): Task -- **RejectEdit**(editID: int): void -- **RejectEditAsync**(editID: int): Task — Reject a pending edit. -- **RemoveItem**(item: object): void -- **RemoveItemAsync**(item: object): Task — Removes an item by its instance. -- **RemoveItemByKey**(key: object[]): void -- **RemoveItemByKeyAsync**(key: object[]): Task -- **ResolveCellValue**(cellKey: IgbCellKey): object -- **ResolveCellValueAsync**(cellKey: IgbCellKey): Task -- **ResolveCellValueFromPosition**(row: int, column: int): object -- **ResolveCellValueFromPositionAsync**(row: int, column: int): Task -- **SaveLayout**(): string -- **SaveLayoutAsync**(): Task — Saves the layout chnages that have been made to the grid -- **ScrollToColumnByIndex**(columnNumber: double): void -- **ScrollToColumnByIndexAsync**(columnNumber: double): Task — Scrolls the grid to given column, by index -- **ScrollToItem**(item: object): bool -- **ScrollToItemAsync**(item: object): Task — Scrolls to an item, if found. -- **ScrollToLastRowByIndex**(rowNumber: double): void -- **ScrollToLastRowByIndexAsync**(rowNumber: double): Task — Scrolls the grid so that a row is the last visible, by index. -- **ScrollToPrimaryKey**(key: object[]): bool -- **ScrollToPrimaryKeyAsync**(key: object[]): Task -- **ScrollToRowByIndex**(rowNumber: double): void -- **ScrollToRowByIndexAsync**(rowNumber: double): Task — Scrolls the grid to given row, by index -- **SelectAllRows**(): void -- **SelectAllRowsAsync**(): Task — Selects all of the rows in the grid. -- **SetActiveResponsiveState**(name: string): void -- **SetActiveResponsiveStateAsync**(name: string): Task — Manually set the active responsive state of the grid. -- **SetCustomizedStringAsync**(language: string, values: Dictionary): Task — Provide a new set of localized strings to use for a given languange. -- **SetCustomizedStringAsync**(language: string, json: string): Task — Provide a new set of localized strings to use for a given languange. -- **SetCustomizedStringAsync**(language: string, id: string, value: string): Task — Provide a new set of localized strings to use for a given languange. -- **SetEditError**(editID: int, errorMessage: string): void -- **SetEditErrorAsync**(editID: int, errorMessage: string): Task -- **StartEditMode**(): void -- **StartEditModeAsync**(): Task — Start edit mode on the active cell. -- **Undo**(): void -- **UndoAsync**(): Task — Undo the last edit. -- **UpdatePropertyAtKey**(key: object[], propertyPath: string, value: object): void -- **UpdatePropertyAtKeyAsync**(key: object[], propertyPath: string, value: object): Task - -### [IgbDataGridAllColumnsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridAllColumnsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataGridCellEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridCellEventArgs) -Information about the cell in context. - -- **constructor**(): void -- **Button**: `MouseButton` — Gets which click type it is. -- **CellInfo**: `IgbCellInfo` — Gets information about the cell in context. -- **Grid**: `IgbDataGrid` — Gets the grid owning the cell. -- **IsDoubleClick**: `bool` — Is this a double click? -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataGridColumn](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridColumn) -A column in the data grid. - -- **constructor**(): void -- **ActualColumnOptionsAccentColor**: `string` -- **ActualColumnOptionsBackground**: `string` — Gets or sets the column options dropdown background color. -- **ActualColumnOptionsGroupHeaderBackground**: `string` — Gets or sets the background color for group headers inside the column options menu. -- **ActualColumnOptionsGroupHeaderTextColor**: `string` — Gets the actual text color for group headers inside the column options menu. -- **ActualColumnOptionsIconAlignment**: `ColumnOptionsIconAlignment` — Gets the actual column options icon alignment for this column. -- **ActualColumnOptionsIconBehavior**: `ColumnOptionsIconBehavior` — Gets or sets how the column option icon will behave in the column header. -- **ActualColumnOptionsIconColor**: `string` — Gets the actual column options icon color for this column. -- **ActualColumnOptionsSeparatorColor**: `string` — Gets or sets the color of separators inside the column options menu. -- **ActualColumnOptionsTextColor**: `string` — Gets or sets the text color for text inside the column options menu. -- **ActualDeletedTextColor**: `string` — Gets the actual text color used for deleted rows. -- **ActualEditOpacity**: `double` — Gets the actual opacity for unsaved edited cell values. -- **ActualHeaderText**: `string` — Gets the actual text displayed in the header of the column -- **ActualHeaderTextChanged**: `EventCallback` -- **ActualHeaderTextChangedScript**: `string` -- **ActualHoverBackground**: `string` — Gets the actual background color that is used for the cells when they are hovered. -- **ActualIsColumnOptionsEnabled**: `bool` — Gets the actual state of the column options for this column. -- **ActualIsColumnOptionsGroupingEnabled**: `bool` — Gets the actual state of grouping menu in the column options for this column. -- **ActualIsColumnOptionsSummariesEnabled**: `bool` — Gets the actual state of summaries menu in the column options for this column. -- **ActualRowHoverTextColor**: `string` — Gets the actual text color that is used for the cells when they are hovered. -- **ActualSelectedBackground**: `string` — Gets the actual background color that is used for the cells when they are selected -- **AnimationSettings**: `IgbGridColumnAnimationSettings` — Gets or sets the animation settings to use for this column. -- **ColumnOptionsAccentColor**: `string` -- **ColumnOptionsBackground**: `string` — Gets or sets the column options dropdown background color. -- **ColumnOptionsGroupHeaderBackground**: `string` — Gets or sets the background color for group headers inside the column options menu. -- **ColumnOptionsGroupHeaderTextColor**: `string` — Gets or sets the text color for group headers inside the column options menu. -- **ColumnOptionsIconAlignment**: `ColumnOptionsIconAlignment` — Gets or sets whether the column options icon is aligned opposite the header text or not. -- **ColumnOptionsIconBehavior**: `ColumnOptionsIconBehavior` — Gets or sets how the column option icon will behave in the column header. -- **ColumnOptionsIconColor**: `string` — Gets or sets the column options icon color for this column. -- **ColumnOptionsSeparatorColor**: `string` — Gets or sets the color of separators inside the column options menu. -- **ColumnOptionsTextColor**: `string` — Gets or sets the text color for text inside the column options menu. -- **DataGridParent**: `BaseRendererControl` -- **DeletedTextColor**: `string` — Gets or sets the text color used for deleted rows. -- **EditFontFamily**: `string` -- **EditFontSize**: `double` -- **EditFontStyle**: `string` -- **EditFontWeight**: `string` -- **EditOpacity**: `double` — Gets or sets the opacity to use for unsaved edited cell values. -- **Field**: `string` — Gets or sets the key used for the column binding -- **Filter**: `IgbColumnFilterCondition` — Gets or sets a filter to apply on the values of this column -- **FilterComparisonType**: `FilterComparisonType` — Gets or sets whether UI filters are case sensitive or not. -- **FilterExpression**: `IgbFilterExpression` — Gets or sets a filter to apply to the values of this column. -- **FilterOperands**: `IgbGridFilterOperandsCollection` — Gets a list of the current custom filters for this column. -- **FormatCell**: `Action` -- **FormatCellScript**: `string` -- **Header**: `IgbHeader` — Gets or sets the header definition for this column. -- **HeaderText**: `string` — Gets or sets the text displayed in the header of the column -- **IsAutoGenerated**: `bool` — Gets whether this column was auto generated. -- **IsColumnOptionsEnabled**: `bool` — Gets or sets the preferred state of the column options for this column. If the feature is disabled at the grid level then it will be disabled for the column regardless of what this is set to. -- **IsColumnOptionsGroupingEnabled**: `bool` — Gets or sets whether to show the grouping option in the column options menu for this column. -- **IsColumnOptionsSummariesEnabled**: `bool` — Gets or sets whether to show the summaries option in the column options menu for this column. -- **IsEditable**: `bool` — Gets or sets if the column is editable. -- **IsFilteringEnabled**: `bool` — Gets or sets whether filtering is enabled for this column. -- **IsFromMarkup**: `bool` — Gets whether this column was projected from markup/templates and is constrained. -- **IsHidden**: `bool` — Gets or sets whether or not a column is hidden from the grid -- **IsResizingEnabled**: `bool` — Gets or sets whether resizing is enabled for this column. -- **MergedCellEvaluationCriteria**: `MergedCellEvaluationCriteria` — Gets or sets how cells are evaluated for merging. -- **MergedCellMode**: `MergedCellMode` — Gets or sets if and how cell merging is performed for this field. -- **MergedCellPaddingBottom**: `int` — Gets or sets the amount of bottom padding to use for the cell content of this column. -- **MergedCellPaddingLeft**: `int` — Gets or sets the amount of left padding to use for the cell content for this column. -- **MergedCellPaddingRight**: `int` — Gets or sets the amount of right padding to use for the cell content of this column. -- **MergedCellPaddingTop**: `int` — Gets or sets the amount of top padding to use for the cell content for this column. -- **MergedCellVerticalAlignment**: `CellContentVerticalAlignment` — Gets or sets the vertical alignment to use for the merged cell content. -- **MinWidth**: `double` — Gets or sets the minimum width to use for this column. Overrides the DefaultColumnMinWidth from the grid, if set. -- **PaddingBottom**: `int` — Gets or sets the amount of bottom padding to use for the cell content of this column. -- **PaddingLeft**: `int` — Gets or sets the amount of left padding to use for the cell content for this column. -- **PaddingRight**: `int` — Gets or sets the amount of right padding to use for the cell content of this column. -- **PaddingTop**: `int` — Gets or sets the amount of top padding to use for the cell content for this column. -- **Pinned**: `PinnedPositions` — Gets or sets the current fixed position for this column. -- **RowHoverBackground**: `string` — Gets or sets the background color to use for the cells when the row is hovered. -- **RowHoverTextColor**: `string` — Gets or sets the text color to use for the cells when the row is hovered. -- **SelectedBackground**: `string` — Gets or sets the background color to use for the cells when they are selected -- **ShouldRemoveWhenHidden**: `bool` — Gets or sets if a column should be removed from the grid when it is fully hidden -- **SortDirection**: `ColumnSortDirection` — Gets the current sort direction (None, Ascending, Descending) for this column. -- **SuffixIconCollectionName**: `string` — Gets or sets the icon to use in the suffix area of the cells in this column. -- **SuffixIconFill**: `string` — Gets or sets the fill color of suffix icon. -- **SuffixIconName**: `string` — Gets or sets the icon to use in the suffix area of the cells in this column. -- **SuffixIconStroke**: `string` — Gets or sets the stroke color of suffix icon. -- **SuffixIconViewBoxHeight**: `double` — Gets or sets the suffix icon's viewbox height. -- **SuffixIconViewBoxLeft**: `double` — Gets or sets the suffix icon's viewbox x coordinate. -- **SuffixIconViewBoxTop**: `double` — Gets or sets the suffix icon's viewbox y coordinate. -- **SuffixIconViewBoxWidth**: `double` — Gets or sets the suffix icon's viewbox width. -- **SuffixMargin**: `double` — Gets or sets the suffix margin. -- **SuffixText**: `string` — Gets or sets the text to display in the suffix area of cells in this column. -- **SuffixTextColor**: `string` — Gets or sets the color of the text in the suffix area of the cells in this column. -- **SuffixTextFontFamily**: `string` -- **SuffixTextFontSize**: `double` -- **SuffixTextFontStyle**: `string` -- **SuffixTextFontWeight**: `string` -- **TextDecoration**: `TextCellDecoration` — Gets or sets the text decoration to apply to cells in this column. -- **Type**: `string` -- **Width**: `IgbColumnWidth` — Gets or sets the width to use for this column. -- **ApplyCustomFilter**(filterID: string, index: int, value: object): void -- **ApplyCustomFilterAsync**(filterID: string, index: int, value: object): Task -- **Dispose**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **GetCurrentActualHeaderText**(): string -- **GetCurrentActualHeaderTextAsync**(): Task -- **GetNamedHeaderValue**(valueName: string): object -- **GetNamedHeaderValueAsync**(valueName: string): Task — Gets the value of a named header value for this column by name. -- **GetUniqueKey**(): string -- **GetUniqueKeyAsync**(): Task — Get the unique key used to identify this column. -- **HasNamedHeaderValue**(valueName: string): bool -- **HasNamedHeaderValueAsync**(valueName: string): Task — Returns if there is a named header value with a given name. -- **HasNamedHeaderValues**(): bool -- **HasNamedHeaderValuesAsync**(): Task — Returns if the column has named header values. -- **OnInitializedAsync**(): Task -- **RemoveNamedHeaderValue**(valueName: string): void -- **RemoveNamedHeaderValueAsync**(valueName: string): Task — Removes a named header value with the given name from the named header values for this column. -- **SetNamedHeaderValue**(valueName: string, animationType: CellPropertyAnimationType, value: object): void -- **SetNamedHeaderValueAsync**(valueName: string, animationType: CellPropertyAnimationType, value: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataGridComparisonOperatorSelector](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridComparisonOperatorSelector) -A dropdown selector for choosing which comparison operator to use. - -- **constructor**(): void -- **Background**: `string` — Gets or sets the background color. -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **CustomFilterID**: `string` — Gets the ID for the custom filter that is selected. Value must be 'Custom' for this property to be valid. -- **CustomFilterIndex**: `int` — Gets the index for the custom filter that is selected. Value must be 'Custom' for this property to be valid. -- **DataType**: `DataSourceSchemaPropertyType` — Gets or sets the data type. Used to determine what operators are available. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **MaxHeight**: `int` -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **TextColor**: `string` — Gets or sets the text color. -- **Type**: `string` -- **Value**: `ColumnComparisonConditionOperatorType` — Gets or sets the value of the selector. -- **ValueChanged**: `EventCallback` -- **ValueChangedScript**: `string` -- **AddCustomOperator**(name: string, icon: string, id: string, index: int): void -- **AddCustomOperatorAsync**(name: string, icon: string, id: string, index: int): Task -- **ClearCustomOperators**(): void -- **ClearCustomOperatorsAsync**(): Task -- **Close**(): void -- **CloseAsync**(): Task -- **Dispose**(): void -- **DisposeAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetDropdownHeight**(): int -- **GetDropdownHeightAsync**(): Task -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task -- **SelectCustomFilter**(id: string, index: int): void -- **SelectCustomFilterAsync**(id: string, index: int): Task -- **Toggle**(): void -- **ToggleAsync**(): Task - -### [IgbDataGridCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataGridExpansionIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridExpansionIndicator) - -- **constructor**(): void -- **ActualPixelScalingRatio**: `double` — Gets the actual pixel scaling ratio used to affect the pixel density of the control. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **IconColor**: `string` — Gets or sets the color of the indicator. -- **IsAnimationEnabled**: `bool` — Gets or sets whether animations are enabled. -- **IsExpanded**: `bool` — Gets or sets the expansion state of the indicator. -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **NotifySizeChanged**(width: double, height: double): void -- **NotifySizeChangedAsync**(width: double, height: double): Task - -### [IgbDataGridFilterDialog](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridFilterDialog) -An advanced grid for displaying data. - -- **constructor**(): void -- **ActualPixelScalingRatio**: `double` — Gets the actual pixel scaling ratio used to affect the pixel density of the control. -- **ColumnOptionsAccentColor**: `string` -- **ColumnOptionsBackground**: `string` — Gets or sets the column options dropdown background color. -- **ColumnOptionsGroupHeaderBackground**: `string` — Gets or sets the background color for group headers inside the column options menu. -- **ColumnOptionsGroupHeaderTextColor**: `string` — Gets or sets the text color for group headers inside the column options menu. -- **ColumnOptionsSeparatorColor**: `string` — Gets or sets the color of separators inside the column options menu. -- **ColumnOptionsTextColor**: `string` — Gets or sets the text color for text inside the column options menu. -- **CommandCompleted**: `string` -- **CommandCompletedScript**: `string` — Provides a means of setting CommandCompleted in the JavaScript environment. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DialogOpening**: `EventCallback` -- **DialogOpeningScript**: `string` -- **FilterChanged**: `EventCallback` -- **FilterChangedScript**: `string` -- **FilterChanging**: `EventCallback` -- **FilterChangingScript**: `string` -- **IconColor**: `string` -- **InvalidateActions**: `string` -- **InvalidateActionsScript**: `string` — Provides a means of setting InvalidateActions in the JavaScript environment. -- **IsAnimationEnabled**: `bool` -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **RenderCompleted**: `Action` -- **RenderCompletedScript**: `string` -- **Type**: `string` -- **ViewSize**: `double` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetDesiredToolbarActions**(): IgbToolActionInfo[] -- **GetDesiredToolbarActionsAsync**(): Task -- **HideIcon**(): void -- **HideIconAsync**(): Task -- **NotifyCellSizeChanged**(): void -- **NotifyCellSizeChangedAsync**(): Task -- **NotifySizeChanged**(width: double, height: double): void -- **NotifySizeChangedAsync**(width: double, height: double): Task -- **ShowIcon**(): void -- **ShowIconAsync**(): Task - -### [IgbDataGridLocaleEnModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridLocaleEnModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataGridModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataGridPager](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridPager) - -- **constructor**(): void -- **ActualBackground**: `string` — Gets or sets the background color to use. -- **ActualBorder**: `string` — Gets or sets the border color around the grid. -- **Background**: `string` — Gets or sets the background color to use. -- **Border**: `string` — Gets or sets the border color around the grid. -- **CurrentPage**: `int` — Gets or sets the current page for the pager. -- **DataSource**: `object` — Gets or sets the data source for the pager. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **FontFamily**: `string` -- **FontSize**: `double` -- **FontStyle**: `string` -- **FontWeight**: `string` -- **PageChanged**: `EventCallback` -- **PageChangedScript**: `string` -- **PageCount**: `int` — Gets the page count. -- **PageSize**: `int` — Gets or sets the page size. -- **PagerText**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualModel**(): string -- **ExportSerializedVisualModelAsync**(): Task — Returns a serialized copy of the exported visual model -- **ExportVisualModel**(): object -- **ExportVisualModelAsync**(): Task — Exports visual information about the current state of the grid. -- **FindByName**(name: string): object -- **FirstPage**(): void -- **FirstPageAsync**(): Task -- **LastPage**(): void -- **LastPageAsync**(): Task -- **NextPage**(): void -- **NextPageAsync**(): Task -- **PreviousPage**(): void -- **PreviousPageAsync**(): Task -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task - -### [IgbDataGridPagerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridPagerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataGridSortIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridSortIndicator) -An advanced grid for displaying data. - -- **constructor**(): void -- **ActualPixelScalingRatio**: `double` — Gets the actual pixel scaling ratio used to affect the pixel density of the control. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **IconColor**: `string` -- **IsAnimationEnabled**: `bool` -- **IsHitTestVisible**: `bool` -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **RenderCompleted**: `Action` -- **RenderCompletedScript**: `string` -- **SortDirection**: `ColumnSortDirection` -- **SortIndicatorStyle**: `SortIndicatorStyle` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetDesiredScale**(): double -- **GetDesiredScaleAsync**(): Task -- **NotifyCellSizeChanged**(): void -- **NotifyCellSizeChangedAsync**(): Task -- **NotifySizeChanged**(width: double, height: double): void -- **NotifySizeChangedAsync**(width: double, height: double): Task - -### [IgbDataGridSummaryResult](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridSummaryResult) -Represents the result of a summary. - -- **constructor**(): void -- **GroupKey**: `object[]` — Gets the group key which tells us which group the summary belongs to. This can be null if the summary is a root level summary. -- **GroupKeyScript**: `string` — Provides a means of setting GroupKey in the JavaScript environment. -- **Operand**: `DataSourceSummaryOperand` — Gets the summary operand. -- **PropertyName**: `string` — Gets the summary property name. -- **ShouldDisplay**: `bool` — Gets if this summary should be rendered in the output or not. Set to false for information only summaries. -- **SummaryIndex**: `int` — Gets the index of the summary description associated with this result. -- **Type**: `string` -- **Value**: `object` — Gets the summary value. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataGridToolbar](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridToolbar) - -- **constructor**(): void -- **BackgroundColor**: `string` — Gets or Sets the property name that contains the values. -- **BaseTheme**: `BaseControlTheme` — Gets or Sets the property name that contains the values. -- **BorderWidthBottom**: `double` -- **BorderWidthLeft**: `double` -- **BorderWidthRight**: `double` -- **BorderWidthTop**: `double` -- **ColumnChooser**: `bool` — Gets or Sets the property name that contains the values. -- **ColumnChooserText**: `string` — Gets or Sets the property name that contains the values. -- **ColumnChooserTitle**: `string` — Gets or Sets the property name that contains the values. -- **ColumnPinning**: `bool` — Gets or Sets the property name that contains the values. -- **ColumnPinningText**: `string` — Gets or Sets the property name that contains the values. -- **ColumnPinningTitle**: `string` — Gets or Sets the property name that contains the values. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or Sets the property name that contains the values. -- **DialogBackgroundColor**: `string` — Gets or Sets the property name that contains the values. -- **TargetGrid**: `IgbDataGrid` — Gets or Sets the property name that contains the values. -- **TargetGridScript**: `string` — Provides a means of setting TargetGrid in the JavaScript environment. -- **ToolbarTitle**: `string` — Gets or Sets the property name that contains the values. -- **ToolbarTitleColor**: `string` — Gets or Sets the property name that contains the values. -- **ToolbarTitleFontFamily**: `string` -- **ToolbarTitleFontSize**: `double` -- **ToolbarTitleFontStyle**: `string` -- **ToolbarTitleFontWeight**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualModel**(): string -- **ExportSerializedVisualModelAsync**(): Task — Returns a serialized copy of the exported visual model -- **ExportVisualModel**(): object -- **ExportVisualModelAsync**(): Task — Exports visual information about the current state of the toolbar. -- **FindByName**(name: string): object - -### [IgbDataGridToolbarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataGridToolbarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataLegend](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataLegend) -Represents data legend that displays information about each series including values and summaries. - -- **constructor**(): void -- **ActualBackground**: `string` — Gets the effective background of the data legend. -- **ActualBadgesVisible**: `bool` — Gets whether or not at least one badge is visible based on BadgesShape and setting of a row's IsVisble in StyleSeriesRow event -- **ActualBorderBrush**: `string` — Gets the effective border brush of the data legend. -- **ActualBorderThicknessBottom**: `double` -- **ActualBorderThicknessLeft**: `double` -- **ActualBorderThicknessRight**: `double` -- **ActualBorderThicknessTop**: `double` -- **ActualPixelScalingRatio**: `double` — Gets the actual pixel scaling ratio used to affect the pixel density of the control. -- **BadgeMarginBottom**: `double` -- **BadgeMarginLeft**: `double` -- **BadgeMarginRight**: `double` -- **BadgeMarginTop**: `double` -- **BadgeShape**: `LegendItemBadgeShape` — Gets or sets the BadgeShape for the data legend. -- **CalculateColumnSummary**: `EventCallback` -- **CalculateColumnSummaryScript**: `string` -- **ContentBackground**: `string` — Gets or sets the background of the data legend. -- **ContentBorderBrush**: `string` — Gets or sets the border color of the data legend. -- **ContentBorderThickness**: `double` — Gets or sets the border thickness of the data legend. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **ExcludedColumns**: `string[]` — Gets or sets names of data columns or their labels to exclude from displaying in the data legend, e.g. "High, Low" or "H, L" -- **ExcludedSeries**: `string[]` — Gets or sets indexes, titles, or names of series to exclude from displaying in the data legend, e.g. "0, 1" or "Series1 Title, Series2 Title" -- **GroupRowMarginBottom**: `double` -- **GroupRowMarginLeft**: `double` -- **GroupRowMarginRight**: `double` -- **GroupRowMarginTop**: `double` -- **GroupRowVisible**: `bool` — Gets or sets whether to show Header row. -- **GroupTextColor**: `string` — Gets or sets the Group text color. -- **GroupTextFontFamily**: `string` -- **GroupTextFontSize**: `double` -- **GroupTextFontStyle**: `string` -- **GroupTextFontWeight**: `string` -- **GroupTextMarginBottom**: `double` -- **GroupTextMarginLeft**: `double` -- **GroupTextMarginRight**: `double` -- **GroupTextMarginTop**: `double` -- **HeaderFormatCulture**: `string` — Gets or sets globalization culture applied to header only when it displays dates that are fetched from date/time axes -- **HeaderFormatDate**: `DataLegendHeaderDateMode` — Gets or sets date format for the header only when it displays dates that are fetched from date/time axes -- **HeaderFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the HeaderFormatString string. -- **HeaderFormatString**: `string` — Gets or sets the format string for header text displayed in the data legend. -- **HeaderFormatTime**: `DataLegendHeaderTimeMode` — Gets or sets time format for the header only when it displays dates that are fetched from date/time axes -- **HeaderRowMarginBottom**: `double` -- **HeaderRowMarginLeft**: `double` -- **HeaderRowMarginRight**: `double` -- **HeaderRowMarginTop**: `double` -- **HeaderRowVisible**: `bool` — Gets or sets whether to show Header row. -- **HeaderText**: `string` — Gets or sets the HeaderText for the data legend. -- **HeaderTextColor**: `string` — Gets or sets the header text color. -- **HeaderTextFontFamily**: `string` -- **HeaderTextFontSize**: `double` -- **HeaderTextFontStyle**: `string` -- **HeaderTextFontWeight**: `string` -- **HeaderTextMarginBottom**: `double` -- **HeaderTextMarginLeft**: `double` -- **HeaderTextMarginRight**: `double` -- **HeaderTextMarginTop**: `double` -- **IncludedColumns**: `string[]` — Gets or sets names of data columns or their labels to include in displaying in the data legend, e.g. "High, Low" or "H, L" -- **IncludedSeries**: `string[]` — Gets or sets indexes, titles, or names of series to include in displaying in the data legend, e.g. "0, 1" or "Series1 Title, Series2 Title" -- **IsEmbeddedInDataTooltip**: `bool` — Gets or sets whether the legend is embedded in a DataTooltip -- **LabelDisplayMode**: `DataLegendLabelMode` — Gets or sets the mode for displaying labels before series values in the data legend, e.g. O: H: L: C: for financial series -- **LabelTextColor**: `string` — Gets or sets the units text color. -- **LabelTextFontFamily**: `string` -- **LabelTextFontSize**: `double` -- **LabelTextFontStyle**: `string` -- **LabelTextFontWeight**: `string` -- **LabelTextMarginBottom**: `double` -- **LabelTextMarginLeft**: `double` -- **LabelTextMarginRight**: `double` -- **LabelTextMarginTop**: `double` -- **LayoutMode**: `DataLegendLayoutMode` — Gets or sets the layout of content in the data legend -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **ShouldUpdateWhenSeriesDataChanges**: `bool` — Gets or sets whether the data legend should update when the series data is mutated. -- **StyleGroupRow**: `EventCallback` -- **StyleGroupRowScript**: `string` -- **StyleHeaderRow**: `EventCallback` -- **StyleHeaderRowScript**: `string` -- **StyleSeriesColumn**: `EventCallback` -- **StyleSeriesColumnScript**: `string` -- **StyleSeriesRow**: `EventCallback` -- **StyleSeriesRowScript**: `string` -- **StyleSummaryColumn**: `EventCallback` -- **StyleSummaryColumnScript**: `string` -- **StyleSummaryRow**: `EventCallback` -- **StyleSummaryRowScript**: `string` -- **SummaryLabelText**: `string` — Gets or sets the units text for the data legend. -- **SummaryLabelTextColor**: `string` — Gets or sets the units text color. -- **SummaryLabelTextFontFamily**: `string` -- **SummaryLabelTextFontSize**: `double` -- **SummaryLabelTextFontStyle**: `string` -- **SummaryLabelTextFontWeight**: `string` -- **SummaryRowMarginBottom**: `double` -- **SummaryRowMarginLeft**: `double` -- **SummaryRowMarginRight**: `double` -- **SummaryRowMarginTop**: `double` -- **SummaryTitleText**: `string` — Gets or sets the SummaryTitleText for the data legend. -- **SummaryTitleTextColor**: `string` — Gets or sets the summary text color. -- **SummaryTitleTextFontFamily**: `string` -- **SummaryTitleTextFontSize**: `double` -- **SummaryTitleTextFontStyle**: `string` -- **SummaryTitleTextFontWeight**: `string` -- **SummaryTitleTextMarginBottom**: `double` -- **SummaryTitleTextMarginLeft**: `double` -- **SummaryTitleTextMarginRight**: `double` -- **SummaryTitleTextMarginTop**: `double` -- **SummaryType**: `DataLegendSummaryType` — Gets or sets the SummaryType for the data legend. -- **SummaryUnitsText**: `string` — Gets or sets the units text for the data legend. -- **SummaryUnitsTextColor**: `string` — Gets or sets the units text color. -- **SummaryUnitsTextFontFamily**: `string` -- **SummaryUnitsTextFontSize**: `double` -- **SummaryUnitsTextFontStyle**: `string` -- **SummaryUnitsTextFontWeight**: `string` -- **SummaryValueTextColor**: `string` — Gets or sets the units text color. -- **SummaryValueTextFontFamily**: `string` -- **SummaryValueTextFontSize**: `double` -- **SummaryValueTextFontStyle**: `string` -- **SummaryValueTextFontWeight**: `string` -- **Target**: `object` — Gets or sets the target for the data legend. -- **TargetCursorPositionX**: `double` — Gets or sets horizontal position (between 0.0 and 1.0) in viewport of the target component -- **TargetCursorPositionY**: `double` — Gets or sets vertical position (between 0.0 and 1.0) in viewport of the target component -- **TargetScript**: `string` — Provides a means of setting Target in the JavaScript environment. -- **TitleTextColor**: `string` — Gets or sets the display text color. -- **TitleTextFontFamily**: `string` -- **TitleTextFontSize**: `double` -- **TitleTextFontStyle**: `string` -- **TitleTextFontWeight**: `string` -- **TitleTextMarginBottom**: `double` -- **TitleTextMarginLeft**: `double` -- **TitleTextMarginRight**: `double` -- **TitleTextMarginTop**: `double` -- **Type**: `string` -- **UnitsDisplayMode**: `DataLegendUnitsMode` — Gets or sets the UnitsMode for the data legend. -- **UnitsText**: `string` — Gets or sets the units text for the data legend. -- **UnitsTextColor**: `string` — Gets or sets the units text color. -- **UnitsTextFontFamily**: `string` -- **UnitsTextFontSize**: `double` -- **UnitsTextFontStyle**: `string` -- **UnitsTextFontWeight**: `string` -- **UnitsTextMarginBottom**: `double` -- **UnitsTextMarginLeft**: `double` -- **UnitsTextMarginRight**: `double` -- **UnitsTextMarginTop**: `double` -- **ValueFormatAbbreviation**: `DataAbbreviationMode` — Gets or sets mode for abbreviating large numbers displayed in the legend -- **ValueFormatCulture**: `string` — Gets or sets globalization culture when displaying values as currencies, e.g. use "en-GB" to display British pound symbol when the ValueFormatMode property is set to 'Currency' mode -- **ValueFormatCurrencyCode**: `string` — Gets or sets the currency code used for displaying currency symbol next to values, e.g. USD for $, EUR for € -- **ValueFormatMaxFractions**: `int` — Gets or sets maximum digits for formatting numbers displayed in the legend -- **ValueFormatMinFractions**: `int` — Gets or sets minimum digits for formatting numbers displayed in the legend -- **ValueFormatMode**: `DataLegendValueMode` — Gets or sets the mode for displaying values in the data legend, e.g. Currency ($500.25), Decimal (500.25), Integer (500) -- **ValueFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the ValueFormatString string. -- **ValueFormatString**: `string` — Gets or sets the format string for values displayed in the data legend. -- **ValueFormatUseGrouping**: `bool` — Gets or sets whether or not use grouping separator, e.g, 15,000 for 15000 -- **ValueRowMarginBottom**: `double` -- **ValueRowMarginLeft**: `double` -- **ValueRowMarginRight**: `double` -- **ValueRowMarginTop**: `double` -- **ValueRowVisible**: `bool` — Gets or sets whether to show series rows. -- **ValueTextColor**: `string` — Gets or sets the units text color. -- **ValueTextFontFamily**: `string` -- **ValueTextFontSize**: `double` -- **ValueTextFontStyle**: `string` -- **ValueTextFontWeight**: `string` -- **ValueTextMarginBottom**: `double` -- **ValueTextMarginLeft**: `double` -- **ValueTextMarginRight**: `double` -- **ValueTextMarginTop**: `double` -- **ValueTextUseSeriesColors**: `bool` — Gets or sets whether to use series colors when displaying values in the legend -- **ValueTextWhenMissingData**: `string` — Gets or sets text displayed when data column is missing a value, e.g. "no data" -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Returns the legend visuals expressed as a serialized string. -- **FindByName**(name: string): object -- **Flush**(): void -- **FlushAsync**(): Task — Forces any pending refresh to the legend to be finished. -- **GetAbbreviatedNumber**(number: double, mode: DataAbbreviationMode, minDigits: int, maxDigits: int): double -- **GetAbbreviatedNumberAsync**(number: double, mode: DataAbbreviationMode, minDigits: int, maxDigits: int): Task -- **GetAbbreviatedString**(number: double, mode: DataAbbreviationMode, minDigits: int, maxDigits: int): string -- **GetAbbreviatedStringAsync**(number: double, mode: DataAbbreviationMode, minDigits: int, maxDigits: int): Task -- **GetAbbreviatedSymbol**(number: double, mode: DataAbbreviationMode, minDigits: int, maxDigits: int): string -- **GetAbbreviatedSymbolAsync**(number: double, mode: DataAbbreviationMode, minDigits: int, maxDigits: int): Task -- **NotifySizeChanged**(): void -- **NotifySizeChangedAsync**(): Task — Notifies the legend about changes to size - -### [IgbDataLegendModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataLegendModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataLegendSeriesContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataLegendSeriesContext) -Represent info about series values - -- **constructor**(): void -- **SeriesFamily**: `string` — Gets a family of series that the current series belongs to, e.g. Category, Range, Financial, etc. -- **Type**: `string` -- **FindByName**(name: string): object -- **GetSeriesValue**(type: DataLegendSeriesValueType): double -- **GetSeriesValueAsync**(type: DataLegendSeriesValueType): Task — Gets value info for the series value type -- **GetSeriesValueInfo**(type: DataLegendSeriesValueType): IgbDataLegendSeriesValueInfo -- **GetSeriesValueInfoAsync**(type: DataLegendSeriesValueType): Task — Creates an instance of DataLegendSeriesContext -- **GetSeriesValues**(): double[] -- **GetSeriesValuesAsync**(): Task — Gets all values that a series renders at the current data point -- **SetSeriesValue**(type: DataLegendSeriesValueType, value: double): void -- **SetSeriesValueAsync**(type: DataLegendSeriesValueType, value: double): Task -- **SetSeriesValueInfo**(type: DataLegendSeriesValueType, valueInfo: IgbDataLegendSeriesValueInfo): void -- **SetSeriesValueInfoAsync**(type: DataLegendSeriesValueType, valueInfo: IgbDataLegendSeriesValueInfo): Task - -### [IgbDataLegendSeriesGroupInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataLegendSeriesGroupInfo) -Represent info about series values - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbDataLegendSeriesValueInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataLegendSeriesValueInfo) -Represent info about series values - -- **constructor**(): void -- **AllowLabels**: `bool` — Gets or sets whether the label text is allowed by the series, e.g. "H:" -- **AllowUnits**: `bool` — Gets or sets whether the unit text is allowed by the series, e.g. "Hz" -- **FormatAllowAbbreviation**: `bool` — Gets or sets whether or not allow displaying value with abbreviation -- **FormatAllowCurrency**: `bool` — Gets or sets whether or not allow displaying value as currency -- **FormatAllowDecimal**: `bool` — Gets or sets whether or not allow displaying value as decimal -- **FormatAllowInteger**: `bool` — Gets or sets whether or not allow displaying value as integer -- **FormatAllowPercent**: `bool` — Gets or sets whether or not allow displaying value as percentage -- **FormatMaxFractions**: `int` — Gets or sets maximum digits used for displaying faction of the value -- **FormatMinFractions**: `int` — Gets or sets minimum digits used for displaying faction of the value -- **FormatUseNegativeColor**: `bool` — Gets or sets whether or not use conditional color -- **FormatUsePositiveColor**: `bool` — Gets or sets whether or not use conditional color -- **FormatWithSeriesColor**: `string` — Gets value color used by the series -- **Index**: `int` — Gets the index of series -- **IsExcludeByDefault**: `bool` — Gets or sets whether this value is excluded/hidden by default in Data Legend -- **MemberLabel**: `string` — Gets or sets member path for the series value, e.g. "High" -- **MemberPath**: `string` — Gets or sets member path for the series value, e.g. "HighPrice" -- **MemberSymbol**: `string` — Gets or sets label for the series value, e.g. "H:" -- **MemberUnit**: `string` — Gets or sets unit text for the value, e.g. "Hz" -- **OrderIndex**: `int` -- **Type**: `string` -- **Value**: `double` — Gets value of series -- **ValueNegativePrefix**: `string` — Gets or sets prefix for negative value -- **ValueNegativeSuffix**: `string` — Gets or sets suffix for negative value -- **ValuePositivePrefix**: `string` — Gets or sets prefix for positive value -- **ValuePositiveSuffix**: `string` — Gets or sets suffix for positive value -- **ValueType**: `DataLegendSeriesValueType` — Gets or sets type of value -- **FindByName**(name: string): object - -### [IgbDataLegendStylingColumnEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataLegendStylingColumnEventArgs) -Represents styling event args for a column in data legend - -- **constructor**(): void -- **ColumnIndex**: `int` — Gets index of column -- **GroupName**: `string` — Gets the group name associated with the column of Data Legend -- **LabelText**: `string` — Gets or sets label text displayed before value text in the column -- **LabelTextColor**: `string` — Gets or sets color of label text -- **SeriesIndex**: `int` — Gets index of series -- **SeriesTitle**: `string` — Gets title of series -- **Type**: `string` -- **UnitsText**: `string` — Gets or sets unit text displayed after value text in the column -- **UnitsTextColor**: `string` — Gets or sets color of value text -- **ValueAbbreviation**: `DataAbbreviationMode` — Gets a mode used to abbreviate original value to ValueText -- **ValueMemberLabel**: `string` — Gets label of data column that corresponds to the value, e.g. "Open" -- **ValueMemberPath**: `string` — Gets name of data column that corresponds to the value, e.g. "OpenPrice" -- **ValueOriginal**: `double` — Gets original value of series without any abbreviation or formatting -- **ValueText**: `string` — Gets or sets value text displayed value text in the column -- **ValueTextColor**: `string` — Gets or sets color of unit text -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataLegendStylingRowEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataLegendStylingRowEventArgs) -Represents styling event args for a row in data legend - -- **constructor**(): void -- **BadgeShape**: `LegendItemBadgeShape` — Gets or sets shape of legend badge in the Data Legend -- **GroupName**: `string` — Gets the group name associated with a row of Data Legend -- **IsBadgeVisible**: `bool` — Gets or sets whether the legend badge is visible in the Data Legend -- **IsRowVisible**: `bool` — Gets or sets whether the whole row is visible in the Data Legend -- **SeriesIndex**: `int` — Gets index of series in the chart -- **SeriesTitle**: `string` — Gets title of series in the chart -- **TitleText**: `string` — Gets or sets title text displayed in a row of Data Legend -- **TitleTextColor**: `string` — Gets or sets color of title text -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataLegendSummaryColumn](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataLegendSummaryColumn) -Represent a column in summary row - -- **constructor**(): void -- **Type**: `string` -- **AddLabel**(label: string): void -- **AddLabelAsync**(label: string): Task — Add label in the summary column -- **AddUnits**(units: string): void -- **AddUnitsAsync**(units: string): Task — Add unit in the summary column -- **AddValue**(value: double): void -- **AddValueAsync**(value: double): Task — Add a value in the summary column -- **FindByName**(name: string): object - -### [IgbDataLegendSummaryEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataLegendSummaryEventArgs) -Represents event argument for DataLegendSummaryCalculationCustom - -- **constructor**(): void -- **ColumnMemberPath**: `string` — Gets member path to identify a column -- **ColumnValues**: `double[]` — Gets actual values in the current a column -- **SummaryLabel**: `string` — Gets or sets text displayed or left side of SummaryValue -- **SummaryUnits**: `string` — Gets or sets text displayed or right side of SummaryValue -- **SummaryValue**: `double` — Gets or sets summary values displayed below data column -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataPieBaseChart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataPieBaseChart) -Represents a base class for PieBase chart control that can plot scatter data - -- **constructor**(): void -- **AngleAxisFavorLabellingScaleEnd**: `bool` — Gets or sets whether to favor labelling the end of the scale. -- **AngleAxisInterval**: `double` — Gets or sets the frequency of displayed labels along the X-axis. -- **AngleAxisMinorInterval**: `double` — Gets or sets the frequency of displayed minor lines along the X-axis. -- **DarkSliceLabelColor**: `string` — Gets or sets the Dark color to use for slice labels. -- **FireMouseLeaveOnManipulationStart**: `bool` — Gets or sets whether the mouse leave event should fire when a manipulation is starting. -- **InnerExtent**: `double` — Defines the percentage of the maximum radius extent to leave blank at the center of the chart. Should be a value between 0.0 and 1.0. -- **LabelMemberPath**: `string` — Gets or sets the overridden value member path to use. -- **LegendEmptyValuesMode**: `LegendEmptyValuesMode` -- **LegendLabelMemberPath**: `string` — Gets or sets the legend label member path to use. -- **LegendOthersSliceLabelFormat**: `string` — Gets or sets the label format for the LegendOthersSlices. -- **LegendOthersSliceLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the labels for the LegendOthersSlices. -- **LegendSliceLabelContentMode**: `RadialLabelMode` — Gets or sets the label of the Others slice. -- **LegendSliceLabelFormat**: `string` — Gets or sets the label format for the LegendSlices. -- **LegendSliceLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the labels for the LegendSlices. -- **LightSliceLabelColor**: `string` — Gets or sets the light color to use for slice labels. -- **MarkerCollision**: `CollisionAvoidanceType` — Gets or sets collision avoidance between markers on series that support this behaviour. -- **OthersCategoryBrush**: `string` — Gets or sets the palette of brushes to use for coloring the chart series. -- **OthersCategoryOutline**: `string` — Gets or sets the brush to use as the outline of the Others slice. -- **OthersCategoryText**: `string` — Gets or sets the label of the Others slice. -- **OthersCategoryThreshold**: `double` — Gets or sets the threshold value that determines if slices are grouped into the Others slice. -- **OthersCategoryType**: `OthersCategoryType` — Gets or sets whether to use numeric or percent-based threshold value. -- **OthersSliceLabelFormat**: `string` — Gets or sets the label format for the OthersSlices. -- **OthersSliceLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the labels for the OthersSlices. -- **RadiusExtent**: `double` — Gets or sets the extent of the chart's radius. Value between 0 and 1. -- **RadiusX**: `double` — Gets or sets the x-radius of the ellipse that is used to round the corners of the slice. -- **RadiusY**: `double` — Gets or sets the y-radius of the ellipse that is used to round the corners of the slice. -- **SelectionThickness**: `double` — Gets or sets line thickness when the series is selected. -- **SliceLabelContentMode**: `RadialLabelMode` — Gets or sets the label of the Others slice. -- **SliceLabelContentSeparator**: `string` — Gets or sets the label of the Others slice. -- **SliceLabelFormat**: `string` — Gets or sets the label format for the slices. -- **SliceLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the labels for the slices. -- **SliceLabelPositionMode**: `CalloutCollisionMode` — Defines the positioning mode of the slice labels for the pie chart. -- **StartAngle**: `double` — Gets or sets the start angle to use for the pie chart measured in degrees from the positive x axis. -- **SweepDirection**: `PieChartSweepDirection` — Defines the percentage of the maximum radius extent to leave blank at the center of the chart. Should be a value between 0.0 and 1.0. -- **Type**: `string` -- **UseInsetOutlines**: `bool` — Specifies that slice outlines should be drawn inside the slice rather than halfway in and halfway out. -- **ValueAxisAbbreviateLargeNumbers**: `bool` — Gets or sets whether the large numbers on the Y-axis labels are abbreviated. -- **ValueAxisAutoRangeBufferMode**: `AxisRangeBufferMode` — Gets or sets how the numeric axis will adjust its range buffer to less closely fix the data from the series. -- **ValueAxisFavorLabellingScaleEnd**: `bool` — Gets or sets whether the axis should favor emitting a label at the end of the scale. -- **ValueAxisInterval**: `double` — Gets or sets the distance between each label and grid line along the Y-axis. -- **ValueAxisIsLogarithmic**: `bool` — Gets or sets whether the Y-axis should use a logarithmic scale instead of a linear one. -- **ValueAxisLogarithmBase**: `int` — Gets or sets the base value to use in the log function when mapping the position of data items along the Y-axis. -- **ValueAxisMaximumValue**: `double` — Gets or sets the data value corresponding to the maximum value of the Y-axis. -- **ValueAxisMinimumValue**: `double` — Gets or sets the data value corresponding to the minimum value of the Y-axis. -- **ValueAxisMinorInterval**: `double` — Gets or sets the frequency of displayed minor lines along the Y-axis. -- **ValueMemberPath**: `string` — Gets or sets the overridden value member path to use. -- **FindByName**(name: string): object -- **GetOthersContext**(): IgbOthersCategoryContext -- **GetOthersContextAsync**(): Task — Gets the Others context which provides a current list of items in Others slice. - -### [IgbDataPieChart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataPieChart) -Represents a DataPie chart control that can plot DataPie data - -- **constructor**(): void -- **ChartType**: `DataPieChartType` — Gets or sets the type of chart series to generate from the data. -- **IsTransitionInEnabled**: `bool` — Gets or sets whether animation of series plots is enabled when the chart is loading into view -- **TransitionInDuration**: `int` — Gets or sets the duration used for animating series plots when the chart is loading into view -- **TransitionInEasingFunction**: `string` — Gets or sets the easing function used for animating series plots when the chart is loading into view -- **TransitionInEasingFunctionScript**: `string` — Provides a means of setting TransitionInEasingFunction in the JavaScript environment. -- **TransitionInMode**: `CategoryTransitionInMode` — Gets or sets the method that determines how to animate series plots when the chart is loading into view -- **TransitionInSpeedType**: `TransitionInSpeedType` — Gets or sets the arrival speed used for animating series plots when the chart is loading into view -- **TransitionOutDuration**: `int` — Gets or sets the duration used for animating series plots when the series is leaving view -- **TransitionOutEasingFunction**: `string` — Gets or sets the easing function used for animating series plots when the chart is loading into view -- **TransitionOutEasingFunctionScript**: `string` — Provides a means of setting TransitionOutEasingFunction in the JavaScript environment. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Export serialized visual data. -- **FindByName**(name: string): object - -### [IgbDataPieChartCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataPieChartCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataPieChartModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataPieChartModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataPieChartToolbarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataPieChartToolbarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataSourceAggregatedResult](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceAggregatedResult) -Represents the result of all changes applied to a specific item. - -- **constructor**(): void -- **Item**: `object` — Gets the item associated with the change -- **Keys**: `string[]` — Gets the property names that were updated. -- **TransactionType**: `TransactionType` — Gets the type of update that was applied to this item. -- **Type**: `string` -- **Values**: `object[]` — Gets the property values that were updated. -- **ValuesScript**: `string` — Provides a means of setting Values in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataSourceDataProviderSchemaChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceDataProviderSchemaChangedEventArgs) -Provides information about a schema change event. - -- **constructor**(): void -- **Count**: `int` — Represents the current full count for the data provider. May be -1 if this information is not available yet. -- **Schema**: `DataSourceSchema` — Represents the current schema for the data provider. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataSourceGroupDescription](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceGroupDescription) - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataSourceGroupDescriptionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceGroupDescriptionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbDataSourceGroupDescriptionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceGroupDescriptionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataSourcePropertiesRequestedChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourcePropertiesRequestedChangedEventArgs) -Provides information about a properties requested changed event. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataSourceRootSummariesChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceRootSummariesChangedEventArgs) -Provides information about row expansion or collapse. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataSourceRowExpansionChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceRowExpansionChangedEventArgs) -Provides information about row expansion or collapse. - -- **constructor**(): void -- **NewState**: `bool` — The new state of the row. True is expanded, False is collapsed. -- **OldState**: `bool` — The previous state of the row. True is expanded, False is collapsed. -- **RowIndex**: `int` — The index of the row being expanded or collapsed. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataSourceSchemaChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceSchemaChangedEventArgs) -Provides information about a schema change event that has occurred. - -- **constructor**(): void -- **Count**: `int` — Gets the current full count of items in the data source. -- **Schema**: `DataSourceSchema` — Gets the new schema that has been provided. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataSourceSortDescription](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceSortDescription) - -- **constructor**(): void -- **Field**: `string` — Gets or sets the property being sorted. -- **SortDirection**: `ListSortDirection` — Gets or sets the direction to sort based on the property. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataSourceSortDescriptionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceSortDescriptionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbDataSourceSortDescriptionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceSortDescriptionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataSourceSpecialRow](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceSpecialRow) - -- **constructor**(): void -- **Keys**: `string[]` -- **Level**: `int` -- **RowType**: `DataSourceRowType` -- **SectionKeys**: `string[]` -- **SectionValues**: `object[]` -- **SectionValuesScript**: `string` — Provides a means of setting SectionValues in the JavaScript environment. -- **SummaryResults**: `IgbDataGridSummaryResult[]` -- **TargetRow**: `object` -- **Type**: `string` -- **Values**: `object[]` -- **ValuesScript**: `string` — Provides a means of setting Values in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataSourceSummaryDescription](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceSummaryDescription) - -- **constructor**(): void -- **Alias**: `string` — Gets or sets an alias for the summary. Currently only used in aggregated data situations. -- **CalculatorDisplayName**: `string` — Gets or sets the name to use when displaying the calculator name. -- **Field**: `string` -- **Operand**: `DataSourceSummaryOperand` -- **ProvideCalculator**: `EventCallback` -- **ProvideCalculatorScript**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDataSourceSummaryDescriptionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceSummaryDescriptionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbDataSourceSummaryDescriptionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceSummaryDescriptionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataSourceSupportingCalculation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataSourceSupportingCalculation) -Represents a calculation strategy that uses the calculation data source to product a column of values. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbDataToolTipLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataToolTipLayer) -Represents an annotation layer that displays grouped tooltips with summaries for series. - -- **constructor**(): void -- **ActualGroupedPositionModeX**: `DataTooltipGroupedPositionX` — Gets the actual resolved tooltip position mode on the X axis for grouped series. -- **ActualGroupedPositionModeY**: `DataTooltipGroupedPositionY` — Gets the actual resolved tooltip position mode on the Y axis for grouped series. -- **ActualGroupingMode**: `DataToolTipLayerGroupingMode` — Gets the actual resolved tooltip layer grouping mode. -- **BadgeMarginBottom**: `double` -- **BadgeMarginLeft**: `double` -- **BadgeMarginRight**: `double` -- **BadgeMarginTop**: `double` -- **BadgeShape**: `LegendItemBadgeShape` — Gets or sets the BadgeShape for the data legend. -- **DefaultPositionOffsetX**: `double` — Gets or sets the default offset of the tooltip layer on the X axis. -- **DefaultPositionOffsetY**: `double` — Gets or sets the default offset of the tooltip layer on the Y axis. -- **ExcludedColumns**: `string[]` — Gets or sets names of data columns or their labels to exclude from displaying in the data tooltip, e.g. "High, Low" or "H, L" -- **ExcludedSeries**: `string[]` — Gets or sets indexes, titles, or names of series to exclude from displaying in the data legend, e.g. "0, 1" or "Series1 Title, Series2 Title" -- **GroupRowMarginBottom**: `double` -- **GroupRowMarginLeft**: `double` -- **GroupRowMarginRight**: `double` -- **GroupRowMarginTop**: `double` -- **GroupRowVisible**: `bool` — Gets or sets whether to show Header row. -- **GroupTextColor**: `string` — Gets or sets the Group text color. -- **GroupTextFontFamily**: `string` -- **GroupTextFontSize**: `double` -- **GroupTextFontStyle**: `string` -- **GroupTextFontWeight**: `string` -- **GroupTextMarginBottom**: `double` -- **GroupTextMarginLeft**: `double` -- **GroupTextMarginRight**: `double` -- **GroupTextMarginTop**: `double` -- **GroupedPositionModeX**: `DataTooltipGroupedPositionX` — Gets or sets the tooltip position mode on the X axis for grouped series. -- **GroupedPositionModeY**: `DataTooltipGroupedPositionY` — Gets or sets the tooltip position mode on the Y axis for grouped series. -- **GroupingMode**: `DataToolTipLayerGroupingMode` — Gets or sets the grouping mode to apply to use for the tooltip layer. -- **HeaderFormatCulture**: `string` — Gets or sets globalization culture when displaying header as date time -- **HeaderFormatDate**: `DataLegendHeaderDateMode` — Gets or sets date format for the header -- **HeaderFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the HeaderFormatString string. -- **HeaderFormatString**: `string` — Gets or sets the format string for header text displayed in the data legend. -- **HeaderFormatTime**: `DataLegendHeaderTimeMode` — Gets or sets time format for the header -- **HeaderRowMarginBottom**: `double` -- **HeaderRowMarginLeft**: `double` -- **HeaderRowMarginRight**: `double` -- **HeaderRowMarginTop**: `double` -- **HeaderRowVisible**: `bool` — Gets or sets whether to show Header row. -- **HeaderText**: `string` — Gets or sets the HeaderText for the data legend. -- **HeaderTextColor**: `string` — Gets or sets the header text color. -- **HeaderTextFontFamily**: `string` -- **HeaderTextFontSize**: `double` -- **HeaderTextFontStyle**: `string` -- **HeaderTextFontWeight**: `string` -- **HeaderTextMarginBottom**: `double` -- **HeaderTextMarginLeft**: `double` -- **HeaderTextMarginRight**: `double` -- **HeaderTextMarginTop**: `double` -- **IncludedColumns**: `string[]` — Gets or sets names of data columns or their labels to include in displaying in the data tooltip, e.g. "High, Low" or "H, L" -- **IncludedSeries**: `string[]` — Gets or sets indexes, titles, or names of series to include in displaying in the data legend, e.g. "0, 1" or "Series1 Title, Series2 Title" -- **LabelDisplayMode**: `DataLegendLabelMode` — Gets or sets the mode for displaying labels before series values in the data legend, e.g. O: H: L: C: for financial series -- **LabelTextColor**: `string` — Gets or sets the units text color. -- **LabelTextFontFamily**: `string` -- **LabelTextFontSize**: `double` -- **LabelTextFontStyle**: `string` -- **LabelTextFontWeight**: `string` -- **LabelTextMarginBottom**: `double` -- **LabelTextMarginLeft**: `double` -- **LabelTextMarginRight**: `double` -- **LabelTextMarginTop**: `double` -- **LayoutMode**: `DataLegendLayoutMode` — Gets or sets the layout of content in the data legend -- **PositionOffsetX**: `double` — Gets or sets the offset of the tooltip layer on the X axis. -- **PositionOffsetY**: `double` — Gets or sets the offset of the tooltip layer on the Y axis. -- **ShouldUpdateWhenSeriesDataChanges**: `bool` — Gets or sets whether the data legend should update when the series data is mutated. -- **SummaryLabelText**: `string` — Gets or sets the units text for the data legend. -- **SummaryLabelTextColor**: `string` — Gets or sets the units text color. -- **SummaryLabelTextFontFamily**: `string` -- **SummaryLabelTextFontSize**: `double` -- **SummaryLabelTextFontStyle**: `string` -- **SummaryLabelTextFontWeight**: `string` -- **SummaryRowMarginBottom**: `double` -- **SummaryRowMarginLeft**: `double` -- **SummaryRowMarginRight**: `double` -- **SummaryRowMarginTop**: `double` -- **SummaryTitleText**: `string` — Gets or sets the SummaryTitleText for the data legend. -- **SummaryTitleTextColor**: `string` — Gets or sets the summary text color. -- **SummaryTitleTextFontFamily**: `string` -- **SummaryTitleTextFontSize**: `double` -- **SummaryTitleTextFontStyle**: `string` -- **SummaryTitleTextFontWeight**: `string` -- **SummaryTitleTextMarginBottom**: `double` -- **SummaryTitleTextMarginLeft**: `double` -- **SummaryTitleTextMarginRight**: `double` -- **SummaryTitleTextMarginTop**: `double` -- **SummaryType**: `DataLegendSummaryType` — Gets or sets the SummaryType for the data legend. -- **SummaryUnitsText**: `string` — Gets or sets the units text for the data legend. -- **SummaryUnitsTextColor**: `string` — Gets or sets the units text color. -- **SummaryUnitsTextFontFamily**: `string` -- **SummaryUnitsTextFontSize**: `double` -- **SummaryUnitsTextFontStyle**: `string` -- **SummaryUnitsTextFontWeight**: `string` -- **SummaryValueTextColor**: `string` — Gets or sets the units text color. -- **SummaryValueTextFontFamily**: `string` -- **SummaryValueTextFontSize**: `double` -- **SummaryValueTextFontStyle**: `string` -- **SummaryValueTextFontWeight**: `string` -- **TargetAxis**: `IgbAxis` — Gets or sets the Axis to target this annotation to. If null, this annotation layer will not render content. -- **TargetAxisName**: `string` — Gets or sets the name to use to resolve targetAxis from markup. -- **TargetAxisScript**: `string` — Provides a means of setting TargetAxis in the JavaScript environment. -- **TitleTextColor**: `string` — Gets or sets the display text color. -- **TitleTextFontFamily**: `string` -- **TitleTextFontSize**: `double` -- **TitleTextFontStyle**: `string` -- **TitleTextFontWeight**: `string` -- **TitleTextMarginBottom**: `double` -- **TitleTextMarginLeft**: `double` -- **TitleTextMarginRight**: `double` -- **TitleTextMarginTop**: `double` -- **ToolTipBackground**: `string` — Gets or sets the background of the tooltip containers. -- **ToolTipBorderBrush**: `string` — Gets or sets the border color of the tooltip containers. -- **ToolTipBorderThickness**: `double` — Gets or sets the border thickness of the tooltip containers. -- **Type**: `string` -- **UnitsDisplayMode**: `DataLegendUnitsMode` — Gets or sets the UnitsMode for the data legend. -- **UnitsText**: `string` — Gets or sets the units text for the data legend. -- **UnitsTextColor**: `string` — Gets or sets the units text color. -- **UnitsTextFontFamily**: `string` -- **UnitsTextFontSize**: `double` -- **UnitsTextFontStyle**: `string` -- **UnitsTextFontWeight**: `string` -- **UnitsTextMarginBottom**: `double` -- **UnitsTextMarginLeft**: `double` -- **UnitsTextMarginRight**: `double` -- **UnitsTextMarginTop**: `double` -- **UseInterpolation**: `bool` — Gets or sets whether to use value interpolation when drawing the tooltips. -- **ValueFormatAbbreviation**: `DataAbbreviationMode` — Gets or sets mode for abbreviating large numbers displayed in the legend -- **ValueFormatCulture**: `string` — Gets or sets globalization culture when displaying values as currencies, e.g. use "en-GB" to display British pound symbol when the ValueFormatMode property is set to 'Currency' mode -- **ValueFormatMaxFractions**: `int` — Gets or sets maximum digits for formatting numbers displayed in the legend -- **ValueFormatMinFractions**: `int` — Gets or sets minimum digits for formatting numbers displayed in the legend -- **ValueFormatMode**: `DataLegendValueMode` — Gets or sets the mode for displaying values in the data legend, e.g. Currency ($500.25), Decimal (500.25), Integer (500) -- **ValueFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the ValueFormatString string. -- **ValueFormatString**: `string` — Gets or sets the format string for values displayed in the data legend. -- **ValueFormatUseGrouping**: `bool` — Gets or sets whether or not use grouping separator, e.g, 15,000 for 15000 -- **ValueRowMarginBottom**: `double` -- **ValueRowMarginLeft**: `double` -- **ValueRowMarginRight**: `double` -- **ValueRowMarginTop**: `double` -- **ValueRowVisible**: `bool` — Gets or sets whether to show series rows. -- **ValueTextColor**: `string` — Gets or sets the units text color. -- **ValueTextFontFamily**: `string` -- **ValueTextFontSize**: `double` -- **ValueTextFontStyle**: `string` -- **ValueTextFontWeight**: `string` -- **ValueTextMarginBottom**: `double` -- **ValueTextMarginLeft**: `double` -- **ValueTextMarginRight**: `double` -- **ValueTextMarginTop**: `double` -- **ValueTextUseSeriesColors**: `bool` — Gets or sets whether to use series colors when displaying values in the legend -- **ValueTextWhenMissingData**: `string` — Gets or sets text displayed when data column is missing a value, e.g. "no data" -- **BindAxes**(Axes: IgbAxis[]): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **HideToolTips**(): void -- **HideToolTipsAsync**(): Task — Hides any tooltips presented by the layer, if any. -- **HideToolTipsImmediate**(): void -- **HideToolTipsImmediateAsync**(): Task — Hides any tooltips presented by the layer, if any. - -### [IgbDataToolTipLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataToolTipLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleCsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleCsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleDaModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleDaModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleDeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleDeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleEnModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleEnModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleEsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleEsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleFrModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleFrModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleHuModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleHuModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleItModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleItModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleJaModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleJaModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleKoModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleKoModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleNbModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleNbModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleNlModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleNlModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocalePlModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocalePlModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocalePtModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocalePtModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleRoModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleRoModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleSvModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleSvModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleTrModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleTrModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleZhHansModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleZhHansModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDataVisualizationLocaleZhHantModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDataVisualizationLocaleZhHantModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDatePartDeltas](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDatePartDeltas) - -- **constructor**(): void -- **Date**: `double` -- **Hours**: `double` -- **Minutes**: `double` -- **Month**: `double` -- **Seconds**: `double` -- **Type**: `string` -- **Year**: `double` -- **FindByName**(name: string): object - -### [IgbDatePicker](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDatePicker) -igc-date-picker is a feature rich component used for entering a date through manual text input or choosing date values from a calendar dialog that pops up. - -- **constructor**(): void -- **ActiveDate**: `DateTime` — Gets/Sets the date which is shown in the calendar picker and is highlighted. By default it is the current date. -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **Disabled**: `bool` — The disabled state of the component -- **DisabledDates**: `IgbDateRangeDescriptor[]` — Gets/sets disabled dates. -- **DisplayFormat**: `string` — Format to display the value in when not editing. Defaults to the locale format if not set. -- **HeaderOrientation**: `CalendarHeaderOrientation` — The orientation of the calendar header. -- **HideHeader**: `bool` — Determines whether the calendar hides its header. -- **HideOutsideDays**: `bool` — Controls the visibility of the dates that do not belong to the current month. -- **Input**: `EventCallback` -- **InputFormat**: `string` — The date format to apply on the input. Defaults to the current locale Intl.DateTimeFormat -- **InputScript**: `string` -- **Invalid**: `bool` — Control the validity of the control. -- **Label**: `string` — The label of the datepicker. -- **Locale**: `string` — Gets/Sets the locale used for formatting the display value. -- **Max**: `DateTime?` — The maximum value required for the date picker to remain valid. -- **Min**: `DateTime?` — The minimum value required for the date picker to remain valid. -- **Mode**: `PickerMode` — Determines whether the calendar is opened in a dropdown or a modal dialog -- **NonEditable**: `bool` — Whether to allow typing in the input. -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **Orientation**: `ContentOrientation` — The orientation of the multiple months displayed in the calendar's days view. -- **Outlined**: `bool` — Whether the control will have outlined appearance. -- **Placeholder**: `string` — The placeholder attribute of the control. -- **Prompt**: `string` — The prompt symbol to use for unfilled parts of the mask. -- **ReadOnly**: `bool` — Makes the control a readonly field. -- **Required**: `bool` — Makes the control a required field in a form context. -- **ResourceStrings**: `IgbCalendarResourceStrings` — The resource strings for localization. -- **ShowWeekNumbers**: `bool` — Whether to show the number of the week in the calendar. -- **SpecialDates**: `IgbDateRangeDescriptor[]` — Gets/sets special dates. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **Value**: `DateTime?` — The value of the picker -- **ValueChanged**: `EventCallback` -- **VisibleMonths**: `double` — The number of months displayed in the calendar. -- **WeekStart**: `WeekDays` — Sets the start day of the week for the calendar. -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task — Checks for validity of the control and emits the invalid event if it invalid. -- **Clear**(): void -- **ClearAsync**(): Task — Clears the input part of the component of any user input -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): DateTime? -- **GetCurrentValueAsync**(): Task -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task — Checks for validity of the control and shows the browser message if it invalid. -- **ResolveDisplay**(): string -- **Select**(): void -- **SelectAsync**(): Task — Selects the text in the input of the component -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task — Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid. -- **StepDown**(datePart: DatePart?, delta: double): void -- **StepDownAsync**(datePart: DatePart?, delta: double): Task -- **StepUp**(datePart: DatePart?, delta: double): void -- **StepUpAsync**(datePart: DatePart?, delta: double): Task - -### [IgbDatePickerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDatePickerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDateRangeDescriptor](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateRangeDescriptor) - -- **constructor**(): void -- **DateRange**: `object` -- **RangeType**: `DateRangeType` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbDateRangePicker](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateRangePicker) -The igc-date-range-picker allows the user to select a range of dates. - -- **constructor**(): void -- **ActiveDate**: `DateTime` — Gets/Sets the date which is shown in the calendar picker and is highlighted. By default it is the current date. -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **CustomRanges**: `IgbCustomDateRange[]` — Renders chips with custom ranges based on the elements of the array. -- **Disabled**: `bool` — The disabled state of the component -- **DisabledDates**: `IgbDateRangeDescriptor[]` — Gets/sets disabled dates. -- **DisplayFormat**: `string` — Format to display the value in when not editing. Defaults to the locale format if not set. -- **HeaderOrientation**: `ContentOrientation` — The orientation of the calendar header. -- **HideHeader**: `bool` — Determines whether the calendar hides its header. -- **HideOutsideDays**: `bool` — Controls the visibility of the dates that do not belong to the current month. -- **Input**: `EventCallback` -- **InputFormat**: `string` — The date format to apply on the inputs. Defaults to the current locale Intl.DateTimeFormat -- **InputScript**: `string` -- **Invalid**: `bool` — Control the validity of the control. -- **Label**: `string` — The label of the control (single input). -- **LabelEnd**: `string` — The label attribute of the end input. -- **LabelStart**: `string` — The label attribute of the start input. -- **Locale**: `string` — The locale settings used to display the value. -- **Max**: `DateTime?` — The maximum value required for the date range picker to remain valid. -- **Min**: `DateTime?` — The minimum value required for the date range picker to remain valid. -- **Mode**: `PickerMode` — Determines whether the calendar is opened in a dropdown or a modal dialog -- **NonEditable**: `bool` — Whether to allow typing in the input. -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **Orientation**: `ContentOrientation` — The orientation of the multiple months displayed in the calendar's days view. -- **Outlined**: `bool` — Whether the control will have outlined appearance. -- **Placeholder**: `string` — The placeholder attribute of the control (single input). -- **PlaceholderEnd**: `string` — The placeholder attribute of the end input. -- **PlaceholderStart**: `string` — The placeholder attribute of the start input. -- **Prompt**: `string` — The prompt symbol to use for unfilled parts of the mask. -- **ReadOnly**: `bool` — Makes the control a readonly field. -- **Required**: `bool` — Makes the control a required field in a form context. -- **ResourceStrings**: `IgbDateRangePickerResourceStrings` — The resource strings of the date range picker. -- **ShowWeekNumbers**: `bool` — Whether to show the number of the week in the calendar. -- **SpecialDates**: `IgbDateRangeDescriptor[]` — Gets/sets special dates. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UsePredefinedRanges**: `bool` — Whether the control will show chips with predefined ranges. -- **UseTwoInputs**: `bool` — Use two inputs to display the date range values. Makes the input editable in dropdown mode. -- **Value**: `IgbDateRangeValue` — The value of the picker -- **ValueChanged**: `EventCallback` -- **VisibleMonths**: `double` -- **WeekStart**: `WeekDays` — Sets the start day of the week for the calendar. -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task — Checks for validity of the control and emits the invalid event if it invalid. -- **Clear**(): void -- **ClearAsync**(): Task — Clears the input parts of the component of any user input -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): IgbDateRangeValue -- **GetCurrentValueAsync**(): Task -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task — Checks for validity of the control and shows the browser message if it invalid. -- **ResolveDisplay**(): string -- **Select**(value: IgbDateRangeValue): void -- **SelectAsync**(value: IgbDateRangeValue): Task — Selects a date range value in the picker -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task — Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid. - -### [IgbDateRangePickerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateRangePickerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDateRangePickerResourceStrings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateRangePickerResourceStrings) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbDateRangeValue](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateRangeValue) - -- **constructor**(): void -- **End**: `DateTime` -- **Start**: `DateTime` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDateRangeValueDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateRangeValueDetail) - -- **constructor**(): void -- **End**: `DateTime` -- **Start**: `DateTime` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDateRangeValueEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateRangeValueEventArgs) - -- **constructor**(): void -- **Detail**: `IgbDateRangeValueDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDateTimeCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateTimeCellInfo) -Backing information about a date time cell for the grid. - -- **constructor**(): void -- **DateTimeFormat**: `DateTimeFormats` — Sets or gets the simple DateTimeFormat to use for the cell. -- **DateTimeValue**: `DateTime` — Sets or gets the DateTime value for the cell. -- **FormatOverride**: `object` — The format options to apply to the value -- **FormatOverrideScript**: `string` — Provides a means of setting FormatOverride in the JavaScript environment. -- **FormatSpecifiers**: `IgbFormatSpecifierCollection` -- **FormatStringOverride**: `string` — The format string to apply to the value -- **IsOffsetValue**: `bool` — Sets or gets whether the value to use is a DateTimeOffset value. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDateTimeColumn](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateTimeColumn) -A column for displaying date/time values. - -- **constructor**(): void -- **ActualEditorDataSource**: `IgbBaseDataSource` -- **ActualFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ContentFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **DateTimeFormat**: `DateTimeFormats` — Gets or sets the date time format to use for this column. If FormatString is specificied this value is ignored. -- **EditorDataSource**: `object` — Gets or sets the ComboBox data source. -- **EditorDataSourceScript**: `string` — Provides a means of setting EditorDataSource in the JavaScript environment. -- **EditorFormatString**: `string` — Gets or sets the format string to use when editing dates. -- **EditorTextField**: `string` — Gets or sets the ComboBox text field. -- **EditorType**: `EditorType` — Gets or sets the editor type used for editing cells in this column. -- **EditorValueField**: `string` — Gets or sets the ComboBox value field. -- **FormatOverride**: `object` — Gets or sets the INTL DateTimeFormat object to use for formatting the date values. -- **FormatOverrideScript**: `string` — Provides a means of setting FormatOverride in the JavaScript environment. -- **FormatSpecifiers**: `IgbFormatSpecifierCollection` -- **FormatString**: `string` — Gets or sets the format string to apply to the value. If set, the other value formatting properties on this column are ignored. -- **ParentTypeName**: `string` -- **ShowTodayButton**: `bool` — Gets or sets the ShowTodayButton property to detirmine if the today button is shown -- **Type**: `string` -- **BuildRenderTree**(builder: RenderTreeBuilder): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDateTimeColumnModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateTimeColumnModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDateTimeFormatSpecifier](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateTimeFormatSpecifier) - -- **constructor**(): void -- **Calendar**: `string` -- **DateStyle**: `string` -- **Day**: `string` -- **DayPeriod**: `string` -- **Era**: `string` -- **FormatMatcher**: `string` -- **FractionalSecondDigits**: `int` -- **Hour**: `string` -- **Hour12**: `string` -- **HourCycle**: `string` -- **Locale**: `string` -- **LocaleMatcher**: `string` -- **Minute**: `string` -- **Month**: `string` -- **NumberingSystem**: `string` -- **Second**: `string` -- **TimeStyle**: `string` -- **TimeZone**: `string` -- **TimeZoneName**: `string` -- **Type**: `string` -- **WeekDay**: `string` -- **Year**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDateTimeFormatSpecifierModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateTimeFormatSpecifierModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDateTimeInput](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateTimeInput) -A date time input is an input field that lets you set and edit the date and time in a chosen input element using customizable display and input formats. - -- **constructor**(): void -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DirectRenderElementName**: `string` -- **DisplayFormat**: `string` — Format to display the value in when not editing. Defaults to the locale format if not set. -- **InputFormat**: `string` — The date format to apply on the input. -- **Locale**: `string` — Gets/Sets the locale used for formatting the display value. -- **Max**: `DateTime?` — The maximum value required for the input to remain valid. -- **Min**: `DateTime?` — The minimum value required for the input to remain valid. -- **SpinDelta**: `IgbDatePartDeltas` — Delta values used to increment or decrement each date part on step actions. All values default to 1. -- **SpinLoop**: `bool` — Sets whether to loop over the currently spun segment. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `DateTime?` — The value of the input. -- **ValueChanged**: `EventCallback` -- **Clear**(): void -- **ClearAsync**(): Task — Clears the input element of user input. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): DateTime? -- **GetCurrentValueAsync**(): Task -- **ResolveDisplay**(): string -- **StepDown**(): void -- **StepDown**(datePart: DatePart): void -- **StepDown**(datePart: DatePart?, delta: double): void -- **StepDownAsync**(): Task -- **StepDownAsync**(datePart: DatePart): Task -- **StepDownAsync**(datePart: DatePart?, delta: double): Task -- **StepUp**(): void -- **StepUp**(datePart: DatePart): void -- **StepUp**(datePart: DatePart?, delta: double): void -- **StepUpAsync**(): Task -- **StepUpAsync**(datePart: DatePart): Task -- **StepUpAsync**(datePart: DatePart?, delta: double): Task - -### [IgbDateTimeInputModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateTimeInputModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDateValidationContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDateValidationContext) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbDefaultMergeStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDefaultMergeStrategy) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **Instance**(): IgbDefaultMergeStrategy -- **InstanceAsync**(): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDefaultTreeGridMergeStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDefaultTreeGridMergeStrategy) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbDefinitionBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDefinitionBase) -Base class for various definition types for the grid. - -- **constructor**(): void -- **ActivationBorder**: `string` — Gets or sets the background color to use. -- **ActivationBorderBottomWidth**: `int` — Gets or sets the amount of bottom activation border to use for the cell content of this column. -- **ActivationBorderLeftWidth**: `int` — Gets or sets the amount of left activation border to use for the cell content for this column. -- **ActivationBorderRightWidth**: `int` — Gets or sets the amount of right activation border to use for the cell content of this column. -- **ActivationBorderTopWidth**: `int` — Gets or sets the amount of top activation border to use for the cell content for this column. -- **ActualActivationBorder**: `string` — Gets the actual background color that will be used. -- **ActualBackground**: `string` — Gets the actual background color that will be used. -- **ActualBarBackground**: `string` — Gets the actual color used for value bars. -- **ActualBarCornerRadius**: `int` — Gets the actual stroke thickness used for value bars. -- **ActualBarOutline**: `string` — Gets the actual Outline color used for value bars. -- **ActualBarStrokeThickness**: `int` — Gets the actual stroke thickness used for value bars. -- **ActualBorder**: `string` — Gets the actual border color that will be used. -- **ActualConditionalStyles**: `IgbGridConditionalStyleCollection` -- **ActualErrorBorder**: `string` — Gets the actual error border color that will be used. -- **ActualLastStickyRowBackground**: `string` — Gets the actual color for the last row in the sticky row area. -- **ActualLineBreakMode**: `TextCellLineBreakMode` — Gets the actual line break mode which will be used if text is present in the cell. -- **ActualPinnedRowBackground**: `string` — Gets the actual background color for cells belonging to rows marked as pinned. -- **ActualPinnedRowOpacity**: `double` — Gets or sets the color to use for displaying text. -- **ActualStickyRowBackground**: `string` — Gets the actual background color for content that sticks to the top of the grid. -- **ActualTextColor**: `string` — Gets the actual color used for displaying text. -- **Background**: `string` — Gets or sets the background color to use. -- **BarBackground**: `string` — Gets or sets the color to use for value bars. -- **BarCornerRadius**: `int` — Gets or sets the stroke thickness to use for value bars. -- **BarOutline**: `string` — Gets or sets the Outline color to use for value bars. -- **BarStrokeThickness**: `int` — Gets or sets the stroke thickness to use for value bars. -- **Border**: `string` — Gets or sets the background color to use. -- **BorderBottomWidth**: `int` — Gets or sets the amount of bottom border to use for the cell content of this column. -- **BorderLeftWidth**: `int` — Gets or sets the amount of left border to use for the cell content for this column. -- **BorderRightWidth**: `int` — Gets or sets the amount of right border to use for the cell content of this column. -- **BorderTopWidth**: `int` — Gets or sets the amount of top border to use for the cell content for this column. -- **CellStyleKeyRequested**: `Action` -- **CellStyleKeyRequestedScript**: `string` -- **ConditionalStyles**: `IgbGridConditionalStyleCollection` — Gets the style key information to use for judging when a property will be set later by a style -- **ContentConditionalStyles**: `IgbGridConditionalStyleCollection` -- **ContentOpacity**: `double` — Gets or sets the opacity of the content. -- **DataBinding**: `Action` -- **DataBindingScript**: `string` -- **DataBound**: `Action` -- **DataBoundScript**: `string` -- **ErrorBorder**: `string` — Gets or sets the error border color to use. -- **ErrorBorderBottomWidth**: `int` -- **ErrorBorderLeftWidth**: `int` -- **ErrorBorderRightWidth**: `int` -- **ErrorBorderTopWidth**: `int` -- **FontFamily**: `string` -- **FontSize**: `double` -- **FontStyle**: `string` -- **FontWeight**: `string` -- **HorizontalAlignment**: `CellContentHorizontalAlignment` — Gets or sets the horizontal alignment to use for the cell content. -- **IsBarSupported**: `bool` — Gets or sets whether the bar is supported. -- **LastStickyRowBackground**: `string` — Gets or sets the color for the last row in the sticky row area. -- **LineBreakMode**: `TextCellLineBreakMode` — Gets or sets the line breaking mode to use if text is present in the cell. -- **ParentTypeName**: `string` -- **PinnedRowBackground**: `string` — Gets or sets the background color for cells belonging to rows marked as pinned. -- **PinnedRowOpacity**: `double` — Gets or sets the color to use for displaying text. -- **StickyRowBackground**: `string` — Gets or sets the background color for content that sticks to the top of the grid. -- **TextColor**: `string` — Gets or sets the color to use for displaying text. -- **Type**: `string` -- **VerticalAlignment**: `CellContentVerticalAlignment` — Gets or sets the vertical alignment to use for the cell content. -- **FindByName**(name: string): object -- **GetNamedValue**(valueName: string): object -- **GetNamedValueAsync**(valueName: string): Task — Gets the value for a named value from this definition. -- **HasNamedValue**(valueName: string): bool -- **HasNamedValueAsync**(valueName: string): Task — Returns if this definition has a named value with a given name. -- **HasNamedValues**(): bool -- **HasNamedValuesAsync**(): Task — Returns if this definition has named value. -- **IsStyleTransitioningOut**(style: IgbGridConditionalStyle): bool -- **IsStyleTransitioningOutAsync**(style: IgbGridConditionalStyle): Task -- **RemoveNamedValue**(valueName: string): void -- **RemoveNamedValueAsync**(valueName: string): Task — Removes the named value from this definition by name. -- **SetNamedValue**(valueName: string, animationType: CellPropertyAnimationType, value: object): void -- **SetNamedValueAsync**(valueName: string, animationType: CellPropertyAnimationType, value: object): Task -- **TransitionStyleIn**(style: IgbGridConditionalStyle): void -- **TransitionStyleInAsync**(style: IgbGridConditionalStyle): Task -- **TransitionStyleOut**(style: IgbGridConditionalStyle): void -- **TransitionStyleOutAsync**(style: IgbGridConditionalStyle): Task - -### [IgbDetrendedPriceOscillatorIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDetrendedPriceOscillatorIndicator) -Represents a IgbDataChart Detrended Price Oscillator indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current DetrendedPriceOscillatorIndicator object. The typical, and initial, value for DPO periods is 20. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbDetrendedPriceOscillatorIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDetrendedPriceOscillatorIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDialog](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDialog) -Represents a Dialog component. - -- **constructor**(): void -- **CloseOnOutsideClick**: `bool` — Whether the dialog should be closed when clicking outside of it. -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **HideDefaultAction**: `bool` — Whether to hide the default action button for the dialog. When there is projected content in the footer slot this property has no effect. -- **KeepOpenOnEscape**: `bool` — Whether the dialog should be kept open when pressing the 'Escape' button. -- **Open**: `bool` — Whether the dialog is opened. -- **ReturnValue**: `string` — Sets the return value for the dialog. -- **SupportsVisualChildren**: `bool` -- **Title**: `string` — Sets the title of the dialog. -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **Hide**(): bool -- **HideAsync**(): Task — Closes the dialog. -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(): bool -- **ShowAsync**(): Task — Opens the dialog. -- **Toggle**(): bool -- **ToggleAsync**(): Task — Toggles the open state of the dialog. - -### [IgbDialogModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDialogModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDimensionsChange](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDimensionsChange) -Event emitted when dimension collection for rows, columns of filters is changed. - -- **constructor**(): void -- **DimensionCollectionType**: `PivotDimensionType` — The dimension list type - Row, Column or Filter. -- **Dimensions**: `IgbPivotDimension[]` — The new list of dimensions. -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDimensionsChangeDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDimensionsChangeDetail) -Event emitted when dimension collection for rows, columns of filters is changed. - -- **constructor**(): void -- **DimensionCollectionType**: `PivotDimensionType` — The dimension list type - Row, Column or Filter. -- **Dimensions**: `IgbPivotDimension[]` — The new list of dimensions. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDimensionsChangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDimensionsChangeEventArgs) - -- **constructor**(): void -- **Detail**: `IgbDimensionsChangeDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDivider](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDivider) -The igc-divider allows the content author to easily create a horizontal/vertical rule as a break between content to better organize information on a page. --color - Sets the color of the divider. --inset - Shrinks the divider by the given amount from the start. If middle is set it will shrink from both sides. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **LineType**: `DividerType` — Whether to render a solid or a dashed divider line. 'solid' -- **Middle**: `bool` — When set and inset is provided, it will shrink the divider line from both sides. false -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Vertical**: `bool` — Whether to render a vertical divider line. false -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDividerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDividerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDockManager](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDockManager) -Describes a Dock Manager component. - -- **constructor**(): void -- **ActivePane**: `IgbContentPane` — Gets/sets the active pane of the Dock Manager. -- **AllowFloatingPanesResize**: `bool` — Determines whether the end user is allowed to resize floating panes. Defaults to true. -- **AllowInnerDock**: `bool` — Determines whether the end user is allowed to inner dock panes. Defaults to true. -- **AllowMaximize**: `bool` — Determines whether the end user is allowed to maximize panes. Defaults to true. -- **AllowSplitterDock**: `bool` — Determines whether the end user can dock the dragged pane directly in the parent split pane by dragging it over a splitter. If enabled, a docking indicator will be shown over the splitter's drag handler. Defaults to false. -- **CloseBehavior**: `PaneActionBehavior` — Determines whether the selected pane or all panes are closed when clicking the close button of a pane within a dockable TabGroup. Defaults to 'allPanes'. -- **ContainedInBoundaries**: `bool` — Determines whether the floating panes are kept inside the Dock Manager boundaries. Defaults to false. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DisableKeyboardNavigation**: `bool` — Disables the built-in keyboard shortcuts for pane navigation. Defaults to false. -- **DraggedPane**: `IgbDockManagerPane` — Gets/sets the currently dragged pane. -- **DropPosition**: `IgbDockManagerPoint` — Gets/sets the current drop position when performing custom drag/drop. -- **Layout**: `IgbDockManagerLayout` — Gets/sets the layout configuration of the Dock Manager. -- **LayoutChange**: `EventCallback` -- **LayoutChangeScript**: `string` -- **LayoutChanged**: `EventCallback` -- **MaximizedPane**: `IgbDockManagerPane` — Gets/sets the maximized pane. -- **ProximityDock**: `bool` — Determines whether the end user can dock the dragged pane by dragging it close to the target pane edges. If enabled, docking indicators are not visible. Defaults to false. -- **ResourceStrings**: `IgbDockManagerResourceStrings` — Gets/sets the resource strings. -- **ShowHeaderIconOnHover**: `DockManagerShowHeaderIconOnHover` — Determines which tab header icons should show when hovering over the tab with the mouse. Defaults to none. -- **ShowPaneHeaders**: `DockManagerShowPaneHeaders` — Determines whether pane headers are only shown on hover or always visible. Defaults to 'always'. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UnpinBehavior**: `PaneActionBehavior` — Determines whether the selected pane or all panes are unpinned when clicking the unpin button of a pane within a dockable TabGroup. Defaults to 'allPanes'. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FocusPane**(contentId: string): void -- **FocusPaneAsync**(contentId: string): Task — Focuses a pane from the layout. -- **GetCurrentLayout**(): IgbDockManagerLayout -- **GetCurrentLayoutAsync**(): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDockManagerLayout](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDockManagerLayout) -Describes a Dock Manager layout. - -- **constructor**(): void -- **FloatingPanes**: `IgbSplitPaneCollection` — The floating panes of the layout. -- **RootPane**: `IgbSplitPane` — The root split pane of the layout. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void -- **WithFloatingPanes**(panes: IgbSplitPane[]): IgbDockManagerLayout - -### [IgbDockManagerLayoutModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDockManagerLayoutModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDockManagerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDockManagerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDockManagerPane](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDockManagerPane) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDockManagerPaneCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDockManagerPaneCollection) - -- **constructor**(): void -- **constructor**(parent: object, propertyName: string): void - -### [IgbDockManagerPoint](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDockManagerPoint) - -- **constructor**(): void -- **Type**: `string` -- **X**: `double` -- **Y**: `double` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDockManagerPointModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDockManagerPointModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDockManagerResourceStrings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDockManagerResourceStrings) -Describes dock manager resource strings. - -- **constructor**(): void -- **Close**: `string` -- **Documents**: `string` -- **Maximize**: `string` -- **Minimize**: `string` -- **MoreOptions**: `string` -- **MoreTabs**: `string` -- **Panes**: `string` -- **Pin**: `string` -- **Type**: `string` -- **Unpin**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDockManagerResourceStringsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDockManagerResourceStringsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDockPaneAction](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDockPaneAction) - -- **constructor**(): void -- **ActionType**: `PaneDragActionType` -- **DockingIndicator**: `IgbDockingIndicator` -- **TargetPane**: `IgbDockManagerPane` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDockPaneActionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDockPaneActionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDockingIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDockingIndicator) - -- **constructor**(): void -- **Direction**: `string` — Gets a value indicating the direction of the docking indicator. -- **IsRoot**: `bool` — Gets a value indicating whether the docking indicator is a root one. -- **Position**: `DockingIndicatorPosition` — Gets the position of the docking indicator. -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDockingIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDockingIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentHost](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentHost) - -- **constructor**(): void -- **Id**: `string` — The id of the pane. If not set the Dock Manager generates it automatically. -- **PaneType**: `DockManagerPaneType` — The type of the pane. -- **RootPane**: `IgbSplitPane` — The root split pane of the document host. -- **Size**: `double` — The size of the pane relative to its sibling panes' sizes. Defaults to 100. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDocumentHostModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentHostModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleBgModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleBgModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleCsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleCsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleDaModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleDaModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleDeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleDeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleEnModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleEnModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleEsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleEsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleFrModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleFrModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleHuModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleHuModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleItModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleItModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleJaModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleJaModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleNbModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleNbModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleNlModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleNlModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocalePlModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocalePlModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocalePtModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocalePtModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleRoModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleRoModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleRuModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleRuModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleSvModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleSvModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleTrModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleTrModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleZhHansModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleZhHansModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDocumentsCoreLocaleZhHantModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDocumentsCoreLocaleZhHantModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDomainChart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDomainChart) -Represents a base class for all domain charts that can plot scatter data and shapefiles - -- **constructor**(): void -- **ActualBrushes**: `string` — Gets the actual palette of brushes to use for coloring the chart series. -- **ActualOutlines**: `string` — Gets the actual palette of brushes to use for outlines on the chart series. -- **AlignsGridLinesToPixels**: `bool` — Gets or sets a value indicating whether grid and tick lines are aligned to device pixels. -- **AnimateSeriesWhenAxisRangeChanges**: `bool` — Gets or sets whether the series animations should be allowed when a range change has been detected on an axis. -- **AreaFillOpacity**: `double` — Gets or sets the fill opacity for all series that have area visuals in this chart. -- **AutoCalloutsVisible**: `bool` — Gets or sets if the auto value callouts should be displayed. -- **BottomMargin**: `double` — Gets or sets the bottom margin around the chart content. -- **Brushes**: `string` — Gets or sets the palette of brushes to use for coloring the chart series. -- **CalloutCollisionMode**: `CalloutCollisionMode` — Gets or sets if event annotations should be displayed. -- **CalloutLabelUpdating**: `Action` -- **CalloutLabelUpdatingScript**: `string` -- **CalloutRenderStyleUpdating**: `Action` -- **CalloutRenderStyleUpdatingScript**: `string` -- **CalloutStyleUpdating**: `Action` -- **CalloutStyleUpdatingEventEnabled**: `bool` — Gets or sets if event annotations should be displayed. -- **CalloutStyleUpdatingScript**: `string` -- **CalloutsAllowedPositions**: `IgbCalloutPlacementPositionsCollection` — Gets or sets the allowed positions that the callout layer is allowed to use. -- **CalloutsAutoLabelPrecision**: `int` — Gets or sets the amount of precision to apply to the auto callout labels. -- **CalloutsBackground**: `string` — Gets or sets color of the callout background. -- **CalloutsContentMemberPath**: `string` — Gets or sets the member path of the content data for the callouts. -- **CalloutsDarkTextColor**: `string` — Gets or sets the text color on light callout background. -- **CalloutsDataSource**: `object` — Gets or sets the collection of callout data to be annotated. -- **CalloutsDataSourceScript**: `string` — Provides a means of setting CalloutsDataSource in the JavaScript environment. -- **CalloutsFontFamily**: `string` -- **CalloutsFontSize**: `double` -- **CalloutsFontStyle**: `string` -- **CalloutsFontWeight**: `string` -- **CalloutsLabelMemberPath**: `string` — Gets or sets the member path of the label data for the callouts. -- **CalloutsLeaderBrush**: `string` — Gets or sets color of callout's leader lines. -- **CalloutsLightTextColor**: `string` — Gets or sets the text color on dark callout background. -- **CalloutsOutline**: `string` — Gets or sets color of the callout outlines. -- **CalloutsStrokeThickness**: `double` — Gets or sets if the thickness that should be used for the callout outlines. -- **CalloutsTextColor**: `string` — Gets or sets text color of callout. -- **CalloutsUseAutoContrastingLabelColors**: `bool` — Gets or sets whether to the label color is automatically decided between a light and dark option for contrast. -- **CalloutsUseItemColorForFill**: `bool` — Gets or sets if the series item color should be used for the callout fills. -- **CalloutsUseItemColorForOutline**: `bool` — Gets or sets if the series item color should be used for the callout outlines. -- **CalloutsVisible**: `bool` — Gets or sets if callouts should be displayed. -- **CalloutsXMemberPath**: `string` — Gets or sets the member path of the X data for the callouts. -- **CalloutsYMemberPath**: `string` — Gets or sets the member path of the Y data for the callouts. -- **ChartTitle**: `string` — Gets or sets text to display above the plot area. -- **ComputedPlotAreaMarginMode**: `ComputedPlotAreaMarginMode` — Gets or sets mode to use for automatically calculating the plot area margin. -- **CrosshairsAnnotationEnabled**: `bool` — Gets or sets whether annotations are shown along the axis for crosshair values -- **CrosshairsAnnotationXAxisBackground**: `string` — Gets or sets the background of crosshair annotation on x-axis. -- **CrosshairsAnnotationXAxisPrecision**: `int` — Gets or sets precision on interpolated values of crosshairs on x-axis. -- **CrosshairsAnnotationXAxisTextColor**: `string` — Gets or sets the text color of crosshair annotation on x-axis. -- **CrosshairsAnnotationYAxisBackground**: `string` — Gets or sets the background of crosshair annotation on y-axis. -- **CrosshairsAnnotationYAxisPrecision**: `int` — Gets or sets precision on interpolated values of crosshairs on y-axis. -- **CrosshairsAnnotationYAxisTextColor**: `string` — Gets or sets the text color of crosshair annotation on y-axis. -- **CrosshairsDisplayMode**: `CrosshairsDisplayMode` — Gets or sets the crosshairs to be displayed. -- **CrosshairsLineHorizontalStroke**: `string` — Gets or sets the color to apply to horizontal crosshairs line. -- **CrosshairsLineThickness**: `double` — Gets or sets thickness of crosshairs lines. -- **CrosshairsLineVerticalStroke**: `string` — Gets or sets the color to apply to vertical crosshairs line. -- **CrosshairsSkipInvalidData**: `bool` — Gets or sets whether axis annotation are skipped for invalid data in a given position. -- **CrosshairsSkipZeroValueFragments**: `bool` — Gets or sets whether axis annotation are skipped for zero-value fragments in a given position. -- **CrosshairsSnapToData**: `bool` — Gets or sets whether crosshairs will snap to the nearest data point. -- **DataSource**: `object` — Gets or sets a collection of data items used to generate the chart. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DataToolTipBadgeMarginBottom**: `double` -- **DataToolTipBadgeMarginLeft**: `double` -- **DataToolTipBadgeMarginRight**: `double` -- **DataToolTipBadgeMarginTop**: `double` -- **DataToolTipBadgeShape**: `LegendItemBadgeShape` — Gets or sets the BadgeShape for the data legend. -- **DataToolTipDefaultPositionOffsetX**: `double` — Gets or sets the offset of the tooltip layer on the X axis. -- **DataToolTipDefaultPositionOffsetY**: `double` — Gets or sets the offset of the tooltip layer on the Y axis. -- **DataToolTipExcludedColumns**: `string[]` — Gets or sets names of data columns or their labels to exclude from displaying in the data legend, e.g. "High, Low" or "H, L" -- **DataToolTipExcludedSeries**: `string[]` — Gets or sets indexes, titles, or names of series to exclude from displaying in the data tooltip, e.g. "0, 1" or "Series1 Title, Series2 Title" -- **DataToolTipGroupRowMarginBottom**: `double` -- **DataToolTipGroupRowMarginLeft**: `double` -- **DataToolTipGroupRowMarginRight**: `double` -- **DataToolTipGroupRowMarginTop**: `double` -- **DataToolTipGroupRowVisible**: `bool` — Gets or sets whether to show Group row. -- **DataToolTipGroupTextColor**: `string` — Gets or sets the Group text color. -- **DataToolTipGroupTextFontFamily**: `string` -- **DataToolTipGroupTextFontSize**: `double` -- **DataToolTipGroupTextFontStyle**: `string` -- **DataToolTipGroupTextFontWeight**: `string` -- **DataToolTipGroupTextMarginBottom**: `double` -- **DataToolTipGroupTextMarginLeft**: `double` -- **DataToolTipGroupTextMarginRight**: `double` -- **DataToolTipGroupTextMarginTop**: `double` -- **DataToolTipGroupedPositionModeX**: `DataTooltipGroupedPositionX` — Gets or sets the tooltip position mode on the X axis for grouped series. -- **DataToolTipGroupedPositionModeY**: `DataTooltipGroupedPositionY` — Gets or sets the tooltip position mode on the Y axis for grouped series. -- **DataToolTipGroupingMode**: `DataToolTipLayerGroupingMode` -- **DataToolTipHeaderFormatCulture**: `string` — Gets or sets globalization culture when displaying header as date time -- **DataToolTipHeaderFormatDate**: `DataLegendHeaderDateMode` — Gets or sets date format for the header -- **DataToolTipHeaderFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the HeaderFormatString string. -- **DataToolTipHeaderFormatString**: `string` — Gets or sets the format string for header text displayed in the data legend. -- **DataToolTipHeaderFormatTime**: `DataLegendHeaderTimeMode` — Gets or sets time format for the header -- **DataToolTipHeaderRowMarginBottom**: `double` -- **DataToolTipHeaderRowMarginLeft**: `double` -- **DataToolTipHeaderRowMarginRight**: `double` -- **DataToolTipHeaderRowMarginTop**: `double` -- **DataToolTipHeaderRowVisible**: `bool` — Gets or sets whether to show Header row. -- **DataToolTipHeaderText**: `string` — Gets or sets the HeaderText for the data legend. -- **DataToolTipHeaderTextColor**: `string` — Gets or sets the header text color. -- **DataToolTipHeaderTextFontFamily**: `string` -- **DataToolTipHeaderTextFontSize**: `double` -- **DataToolTipHeaderTextFontStyle**: `string` -- **DataToolTipHeaderTextFontWeight**: `string` -- **DataToolTipHeaderTextMarginBottom**: `double` -- **DataToolTipHeaderTextMarginLeft**: `double` -- **DataToolTipHeaderTextMarginRight**: `double` -- **DataToolTipHeaderTextMarginTop**: `double` -- **DataToolTipIncludedColumns**: `string[]` — Gets or sets names of data columns or their labels to include in displaying in the data legend, e.g. "High, Low" or "H, L" -- **DataToolTipIncludedSeries**: `string[]` — Gets or sets indexes, titles, or names of series to include in displaying in the data tooltip, e.g. "0, 1" or "Series1 Title, Series2 Title" -- **DataToolTipLabelDisplayMode**: `DataLegendLabelMode` — Gets or sets the mode for displaying labels before series values in the data legend, e.g. O: H: L: C: for financial series -- **DataToolTipLabelTextColor**: `string` — Gets or sets the units text color. -- **DataToolTipLabelTextFontFamily**: `string` -- **DataToolTipLabelTextFontSize**: `double` -- **DataToolTipLabelTextFontStyle**: `string` -- **DataToolTipLabelTextFontWeight**: `string` -- **DataToolTipLabelTextMarginBottom**: `double` -- **DataToolTipLabelTextMarginLeft**: `double` -- **DataToolTipLabelTextMarginRight**: `double` -- **DataToolTipLabelTextMarginTop**: `double` -- **DataToolTipPositionOffsetX**: `double` — Gets or sets the offset of the tooltip layer on the X axis. -- **DataToolTipPositionOffsetY**: `double` — Gets or sets the offset of the tooltip layer on the Y axis. -- **DataToolTipShouldUpdateWhenSeriesDataChanges**: `bool` — Gets or sets whether the data legend should update when the series data is mutated. -- **DataToolTipSummaryLabelText**: `string` — Gets or sets the units text for the data legend. -- **DataToolTipSummaryLabelTextColor**: `string` — Gets or sets the units text color. -- **DataToolTipSummaryLabelTextFontFamily**: `string` -- **DataToolTipSummaryLabelTextFontSize**: `double` -- **DataToolTipSummaryLabelTextFontStyle**: `string` -- **DataToolTipSummaryLabelTextFontWeight**: `string` -- **DataToolTipSummaryRowMarginBottom**: `double` -- **DataToolTipSummaryRowMarginLeft**: `double` -- **DataToolTipSummaryRowMarginRight**: `double` -- **DataToolTipSummaryRowMarginTop**: `double` -- **DataToolTipSummaryTitleText**: `string` — Gets or sets the SummaryTitleText for the data legend. -- **DataToolTipSummaryTitleTextColor**: `string` — Gets or sets the summary text color. -- **DataToolTipSummaryTitleTextFontFamily**: `string` -- **DataToolTipSummaryTitleTextFontSize**: `double` -- **DataToolTipSummaryTitleTextFontStyle**: `string` -- **DataToolTipSummaryTitleTextFontWeight**: `string` -- **DataToolTipSummaryTitleTextMarginBottom**: `double` -- **DataToolTipSummaryTitleTextMarginLeft**: `double` -- **DataToolTipSummaryTitleTextMarginRight**: `double` -- **DataToolTipSummaryTitleTextMarginTop**: `double` -- **DataToolTipSummaryType**: `DataLegendSummaryType` — Gets or sets the SummaryType for the data legend. -- **DataToolTipSummaryUnitsText**: `string` — Gets or sets the units text for the data legend. -- **DataToolTipSummaryUnitsTextColor**: `string` — Gets or sets the units text color. -- **DataToolTipSummaryUnitsTextFontFamily**: `string` -- **DataToolTipSummaryUnitsTextFontSize**: `double` -- **DataToolTipSummaryUnitsTextFontStyle**: `string` -- **DataToolTipSummaryUnitsTextFontWeight**: `string` -- **DataToolTipSummaryValueTextColor**: `string` — Gets or sets the units text color. -- **DataToolTipSummaryValueTextFontFamily**: `string` -- **DataToolTipSummaryValueTextFontSize**: `double` -- **DataToolTipSummaryValueTextFontStyle**: `string` -- **DataToolTipSummaryValueTextFontWeight**: `string` -- **DataToolTipTitleTextColor**: `string` — Gets or sets the display text color. -- **DataToolTipTitleTextFontFamily**: `string` -- **DataToolTipTitleTextFontSize**: `double` -- **DataToolTipTitleTextFontStyle**: `string` -- **DataToolTipTitleTextFontWeight**: `string` -- **DataToolTipTitleTextMarginBottom**: `double` -- **DataToolTipTitleTextMarginLeft**: `double` -- **DataToolTipTitleTextMarginRight**: `double` -- **DataToolTipTitleTextMarginTop**: `double` -- **DataToolTipUnitsDisplayMode**: `DataLegendUnitsMode` — Gets or sets the UnitsMode for the data legend. -- **DataToolTipUnitsText**: `string` — Gets or sets the units text for the data legend. -- **DataToolTipUnitsTextColor**: `string` — Gets or sets the units text color. -- **DataToolTipUnitsTextFontFamily**: `string` -- **DataToolTipUnitsTextFontSize**: `double` -- **DataToolTipUnitsTextFontStyle**: `string` -- **DataToolTipUnitsTextFontWeight**: `string` -- **DataToolTipUnitsTextMarginBottom**: `double` -- **DataToolTipUnitsTextMarginLeft**: `double` -- **DataToolTipUnitsTextMarginRight**: `double` -- **DataToolTipUnitsTextMarginTop**: `double` -- **DataToolTipValueFormatAbbreviation**: `DataAbbreviationMode` — Gets or sets mode for abbreviating large numbers displayed in the legend -- **DataToolTipValueFormatCulture**: `string` — Gets or sets globalization culture when displaying values as currencies, e.g. use "en-GB" to display British pound symbol when the ValueFormatMode property is set to 'Currency' mode -- **DataToolTipValueFormatMaxFractions**: `int` — Gets or sets maximum digits for formatting numbers displayed in the legend -- **DataToolTipValueFormatMinFractions**: `int` — Gets or sets minimum digits for formatting numbers displayed in the legend -- **DataToolTipValueFormatMode**: `DataLegendValueMode` — Gets or sets the mode for displaying values in the data legend, e.g. Currency ($500.25), Decimal (500.25), Integer (500) -- **DataToolTipValueFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the ValueFormatString string. -- **DataToolTipValueFormatString**: `string` — Gets or sets the format string for values displayed in the data legend. -- **DataToolTipValueFormatUseGrouping**: `bool` — Gets or sets whether or not use grouping separator, e.g, 15,000 for 15000 -- **DataToolTipValueRowMarginBottom**: `double` -- **DataToolTipValueRowMarginLeft**: `double` -- **DataToolTipValueRowMarginRight**: `double` -- **DataToolTipValueRowMarginTop**: `double` -- **DataToolTipValueRowVisible**: `bool` — Gets or sets whether to show series rows. -- **DataToolTipValueTextColor**: `string` — Gets or sets the units text color. -- **DataToolTipValueTextFontFamily**: `string` -- **DataToolTipValueTextFontSize**: `double` -- **DataToolTipValueTextFontStyle**: `string` -- **DataToolTipValueTextFontWeight**: `string` -- **DataToolTipValueTextMarginBottom**: `double` -- **DataToolTipValueTextMarginLeft**: `double` -- **DataToolTipValueTextMarginRight**: `double` -- **DataToolTipValueTextMarginTop**: `double` -- **DataToolTipValueTextUseSeriesColors**: `bool` — Gets or sets whether to use series colors when displaying values in the legend -- **DataToolTipValueTextWhenMissingData**: `string` — Gets or sets text displayed when data column is missing a value, e.g. "no data" -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **ExcludedProperties**: `string[]` — Gets or sets a set of property paths that should be excluded from consideration by the category chart. -- **FilterExpressions**: `IgbFilterExpressionCollection` — Gets the current filter that is applied to the chart. Collection can be updated to modify the filter for the chart. Once filter expressions are in this collection, the chart will no longer listen for changes on their properties. -- **FilterStringErrorsParsing**: `EventCallback` -- **FilterStringErrorsParsingScript**: `string` -- **FinalValueAnnotationsBackground**: `string` — Gets or sets the background of final value annotation. -- **FinalValueAnnotationsPrecision**: `int` — Gets or sets precision on final value annotation. -- **FinalValueAnnotationsTextColor**: `string` — Gets or sets the text color of final value annotation. -- **FinalValueAnnotationsVisible**: `bool` — Gets or sets whether annotations for the final value of each series is displayed on the axis. -- **FocusBrush**: `string` — Gets or sets the focus brush to use for the series. -- **FocusDismissDelayMilliseconds**: `int` — Gets or sets the time to wait before visually dismissing a focus highlight. -- **FocusMode**: `SeriesSelectionMode` — Gets or sets the focus mode to use for the series in the component, when supported. -- **FocusTransitionDuration**: `int` — Gets or sets the duration used for animating Focus changes -- **FocusedSeriesItems**: `IgbChartSelectedItemCollection` — Gets the currently focused data items. Adding or removing data items from this collection will focus or blur the visuals associated with those items. -- **FocusedSeriesItemsChanged**: `EventCallback` -- **FocusedSeriesItemsChangedScript**: `string` -- **GroupDescriptions**: `IgbChartSortDescriptionCollection` — Gets the current grouping that is applied to the grid. Collection can be updated to modify the grouping for the grid. Once grouping descriptions are in this collection, the grid will no longer listen for changes on their properties. -- **GroupSortDescriptions**: `IgbChartSortDescriptionCollection` -- **GroupSorts**: `string` — Gets or sets the sorts to apply after grouping has been applied. -- **HighlightFilterExpressions**: `IgbFilterExpressionCollection` — Gets the current highlight filter that is applied to the chart. Collection can be updated to modify the highlight filter for the chart. Once filter expressions are in this collection, the chart will no longer listen for changes on their properties. -- **HighlightedDataSource**: `object` — Gets or sets a collection of data items used to generate the chart. -- **HighlightedDataSourceScript**: `string` — Provides a means of setting HighlightedDataSource in the JavaScript environment. -- **HighlightedLegendItemVisibility**: `Visibility` — Gets or sets whether the chart can highlight series through user interactions. This property applies to Category Chart and Financial Chart controls. -- **HighlightedValuesDisplayMode**: `SeriesHighlightedValuesDisplayMode` — Gets or sets whether and how to display highlighted values for the series. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse. This property applies to Category Chart and Financial Chart controls. -- **HighlightingBehavior**: `SeriesHighlightingBehavior` — Gets or sets the highlighting Behavior to use for the series in the component, when supported. This takes precedence over the series level IsHighlightingEnabled. -- **HighlightingDismissDelayMilliseconds**: `int` — Gets or sets the time to wait before visually dismissing a highlight. -- **HighlightingFadeOpacity**: `double` — Gets or sets the target opacity to fade to for fade style highlighting. -- **HighlightingMode**: `SeriesHighlightingMode` — Gets or sets the highlighting mode to use for the series in the component, when supported. This takes precedence over the series level IsHighlightingEnabled. -- **HighlightingTransitionDuration**: `int` — Gets or sets the duration used for animating highlighting changes -- **HorizontalViewScrollbarCornerRadius**: `double` — Gets or sets the corner radius to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarFill**: `string` — Gets or sets the fill to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarHeight**: `double` — Gets or sets the height to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarInset**: `double` — Gets or sets the inset distance to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarMaxOpacity**: `double` — Gets or sets the max opacity to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarMode**: `SeriesViewerScrollbarMode` — Gets or sets the horizontal scrollbar mode to use for the series viewer. -- **HorizontalViewScrollbarOutline**: `string` — Gets or sets the outline to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarPosition**: `SeriesViewerHorizontalScrollbarPosition` — Gets or sets the position to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarShouldAddAutoTrackInsets**: `bool` — Gets or sets whether to use automatic track insets for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarStrokeThickness**: `double` — Gets or sets the stroke thickness to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarTrackEndInset**: `double` — Gets or sets the track end inset to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarTrackStartInset**: `double` — Gets or sets the track start inset to use for the horizontal scrollbar in the component, when enabled. -- **IncludedProperties**: `string[]` — Gets or sets a set of property paths that should be included for consideration by the category chart, leaving the remainder excluded. If null, all properties will be considered. -- **InitialFilter**: `string` — Gets or sets the filter to apply to the chart. This property will become ignored if the filter is changed outside of this property. -- **InitialFilterExpressions**: `IgbFilterExpressionCollection` — Gets the initial filters that are applied to the chart. -- **InitialGroupDescriptions**: `IgbChartSortDescriptionCollection` — Gets the initial groupings that are applied to the chart. -- **InitialGroupSortDescriptions**: `IgbChartSortDescriptionCollection` — Gets the initial sorts that are applied to the chart after groupings and summaries are applied. -- **InitialGroups**: `string` — Gets or sets the groupings to apply to the chart. This property will become ignored if sorts are changed outside of this property. -- **InitialHighlightFilter**: `string` — Gets or sets the filter to apply to the chart. This property will become ignored if the filter is changed outside of this property. -- **InitialHighlightFilterExpressions**: `IgbFilterExpressionCollection` — Gets the initial highlight filters that are applied to the chart. -- **InitialSortDescriptions**: `IgbChartSortDescriptionCollection` — Gets the initial sorts that are applied to the chart. -- **InitialSorts**: `string` — Gets or sets the sorts to apply to the chart. This property will become ignored if sorts are changed outside of this property. -- **InitialSummaries**: `string` — Gets or sets the summaries to apply to the chart. This property will become ignored if sorts are changed outside of this property. -- **InitialSummaryDescriptions**: `IgbChartSummaryDescriptionCollection` — Gets the initial summaries that are applied to the chart. -- **IsHorizontalZoomEnabled**: `bool` — Gets or sets whether the chart can be horizontally zoomed through user interactions. -- **IsSeriesHighlightingEnabled**: `bool` — Gets or sets whether the chart can highlight series through user interactions. This property applies to Category Chart and Financial Chart controls. -- **IsUserAnnotationsEnabled**: `bool` — Gets or sets whether initiating user annotations from the toolbar is enabled. -- **IsVerticalZoomEnabled**: `bool` — Gets or sets whether the chart can be vertically zoomed through user interactions. -- **LeftMargin**: `double` — Gets or sets the left margin of the chart content. -- **Legend**: `IgbLegendBase` — Gets or sets the legend to connect this chart to. -- **LegendHighlightingMode**: `LegendHighlightingMode` — Gets or sets the highlighting mode to use for the legend linked to the component, when supported. -- **LegendItemBadgeMode**: `LegendItemBadgeMode` — Gets or sets the mode of legend badges representing all series displayed in a legend linked to this component. -- **LegendItemBadgeShape**: `LegendItemBadgeShape` — Gets or sets the type of legend badges representing all series displayed in a legend linked to this component -- **LegendItemVisibility**: `Visibility` — Gets or sets whether to show the legend items for the series. -- **LegendScript**: `string` — Provides a means of setting Legend in the JavaScript environment. -- **MarkerAutomaticBehavior**: `MarkerAutomaticBehavior` — Gets or sets the default marker type for all series plotted in this chart. -- **MarkerBrushes**: `string` — Gets or sets the palette of brushes used for rendering fill area of data point markers. -- **MarkerFillMode**: `MarkerFillMode` — Gets or sets the MarkerFillMode for all series that support markers in this chart. -- **MarkerFillOpacity**: `double` — Gets or sets the Marker Fill Opacity for all series that support markers in this chart. -- **MarkerMaxCount**: `int` — Gets or sets the maximum number of markers displayed in the plot area of the chart. -- **MarkerOutlineMode**: `MarkerOutlineMode` — Gets or sets the MarkerOutlineMode for all series that support markers in this chart. -- **MarkerOutlines**: `string` — Gets or sets the palette of brushes used for rendering outlines of data point markers. -- **MarkerThickness**: `double` — Gets or sets the Marker Thickness for all series that support markers in this chart. -- **MarkerTypes**: `IgbMarkerTypeCollection` — Gets or sets the marker shapes used for indicating location of data points in this chart. -- **OutlineMode**: `SeriesOutlineMode` — Gets or sets the OutlineMode for all series in this chart. -- **Outlines**: `string` — Gets or sets the palette of brushes to use for outlines on the chart series. -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **PlotAreaMarginBottom**: `double` — Margin applied below the plot area. -- **PlotAreaMarginLeft**: `double` — Margin applied to the Left of the plot area. -- **PlotAreaMarginRight**: `double` — Margin applied to the right of the plot area. -- **PlotAreaMarginTop**: `double` — Margin applied to the Top of the plot area. -- **PlotAreaPointerDown**: `EventCallback` -- **PlotAreaPointerDownScript**: `string` -- **PlotAreaPointerEnter**: `EventCallback` -- **PlotAreaPointerEnterScript**: `string` -- **PlotAreaPointerLeave**: `EventCallback` -- **PlotAreaPointerLeaveScript**: `string` -- **PlotAreaPointerMove**: `Action` -- **PlotAreaPointerMoveScript**: `string` -- **PlotAreaPointerUp**: `EventCallback` -- **PlotAreaPointerUpScript**: `string` -- **Resolution**: `double` — Gets or sets the rendering resolution for all series in this chart. -- **RightMargin**: `double` — Gets or sets the right margin of the chart content. -- **SelectedSeriesItems**: `IgbChartSelectedItemCollection` — Gets the currently selected data items. Adding or removing data items from this collection will select or deselect the visuals associated with those items. -- **SelectedSeriesItemsChanged**: `EventCallback` -- **SelectedSeriesItemsChangedScript**: `string` -- **SelectionBehavior**: `SeriesSelectionBehavior` — Gets or sets the selection behavior to use for the series in the component, when supported. -- **SelectionBrush**: `string` — Gets or sets the selection brush to use for the series. -- **SelectionDismissDelayMilliseconds**: `int` — Gets or sets the time to wait before visually dismissing a selection highlight -- **SelectionMode**: `SeriesSelectionMode` — Gets or sets the selection mode to use for the series in the component, when supported. -- **SelectionTransitionDuration**: `int` — Gets or sets the duration used for animating Selection changes -- **SeriesAdded**: `EventCallback` -- **SeriesAddedScript**: `string` -- **SeriesClick**: `EventCallback` -- **SeriesClickScript**: `string` -- **SeriesPlotAreaMarginHorizontalMode**: `SeriesPlotAreaMarginHorizontalMode` — Gets or sets horizontal mode to use for automatically calculating the plot area margin based ont the series. -- **SeriesPlotAreaMarginVerticalMode**: `SeriesPlotAreaMarginVerticalMode` — Gets or sets vertical mode to use for automatically calculating the plot area margin based ont the series. -- **SeriesPointerDown**: `EventCallback` -- **SeriesPointerDownScript**: `string` -- **SeriesPointerEnter**: `EventCallback` -- **SeriesPointerEnterScript**: `string` -- **SeriesPointerLeave**: `EventCallback` -- **SeriesPointerLeaveScript**: `string` -- **SeriesPointerMove**: `Action` -- **SeriesPointerMoveScript**: `string` -- **SeriesPointerUp**: `EventCallback` -- **SeriesPointerUpScript**: `string` -- **SeriesRemoved**: `EventCallback` -- **SeriesRemovedScript**: `string` -- **SeriesValueLayerUseLegend**: `bool` — Gets or sets if the chart should use the legend for value layers that target series. -- **ShouldAvoidAxisAnnotationCollisions**: `bool` — Gets or sets whether annotations for the final value of each series is displayed on the axis. -- **ShouldDisplayMockData**: `bool` — Gets or sets whether the chart should display mock data when the data source has not been provided, if supported for this type of chart. -- **ShouldPanOnMaximumZoom**: `bool` — Gets or sets a whether the chart should pan its content when zoo,ing in passed max zoom level. -- **ShouldSimulateHoverMoveCrosshairPoint**: `bool` — Gets or sets whether calling SimulateHover should shift the crosshair point. -- **ShouldUseSkeletonStyleForMockData**: `bool` — Gets or sets whether the chart should use a faded skeleton style for mock data. -- **SortDescriptions**: `IgbChartSortDescriptionCollection` — Gets the current sort that is applied to the grid. Collection can be updated to modify the sort for the grid. Once sort descriptions are in this collection, the grid will no longer listen for changes on their properties. -- **Subtitle**: `string` — Gets or sets text to display below the Title, above the plot area. -- **SubtitleAlignment**: `HorizontalAlignment` — Gets or sets horizontal alignment which determines the subtitle position, relative to the left and right edges of the control. -- **SubtitleBottomMargin**: `double` — Gets or sets the bottom margin of chart subtitle -- **SubtitleLeftMargin**: `double` — Gets or sets the left margin of chart subtitle -- **SubtitleRightMargin**: `double` — Gets or sets the right margin of chart subtitle -- **SubtitleTextColor**: `string` — Gets or sets color of chart subtitle -- **SubtitleTextStyle**: `string` — Gets or sets CSS font property for the chart subtitle -- **SubtitleTopMargin**: `double` — Gets or sets the top margin of chart subtitle -- **SummaryDescriptions**: `IgbChartSummaryDescriptionCollection` — Gets the current summaries that are applied to the grid. -- **Thickness**: `double` — Gets or sets the thickness for all series in this chart. Depending on the ChartType, this can be the main brush used, or just the outline. -- **TitleAlignment**: `HorizontalAlignment` — Gets or sets horizontal alignment which determines the title position, relative to the left and right edges of the control. -- **TitleBottomMargin**: `double` — Gets or sets the bottom margin of chart title -- **TitleLeftMargin**: `double` — Gets or sets the left margin of chart title -- **TitleRightMargin**: `double` — Gets or sets the right margin of chart title -- **TitleTextColor**: `string` — Gets or sets color of chart title -- **TitleTextStyle**: `string` — Gets or sets CSS font property for the chart title -- **TitleTopMargin**: `double` — Gets or sets the top margin of chart title -- **ToolTipType**: `ToolTipType` — Gets or sets the style of tooltip to be displayed. -- **TopMargin**: `double` — Gets or sets the top margin of the chart content. -- **TransitionDuration**: `int` — Gets or sets the duration used for animating series plots when the data is changing -- **TransitionEasingFunction**: `string` — Gets or sets the easing function used for animating series plots when the data is changing. -- **TransitionEasingFunctionScript**: `string` — Provides a means of setting TransitionEasingFunction in the JavaScript environment. -- **TrendLineBrushes**: `string` — Gets or sets the palette of brushes to used for coloring trend lines in this chart. -- **TrendLineLayerUseLegend**: `bool` — Gets or sets if the chart should use the legend for trendline layers. -- **TrendLinePeriod**: `int` -- **TrendLineThickness**: `double` — Gets or sets the thickness of the trend lines in this chart. -- **TrendLineType**: `TrendLineType` — Gets or sets the formula used for calculating trend lines in this chart. -- **TrendLineTypes**: `IgbTrendLineTypeCollection` — Gets or sets what trendlines to use in the chart. -- **Type**: `string` -- **UnknownValuePlotting**: `UnknownValuePlotting` — Gets or sets the behavior that determines how unknown values will be plotted on the chart. -- **UseValueForAutoCalloutLabels**: `bool` — Gets or sets if event annotations should be displayed. -- **UserAnnotationInformationRequested**: `EventCallback` -- **UserAnnotationInformationRequestedScript**: `string` -- **UserAnnotationToolTipContentUpdating**: `EventCallback` -- **UserAnnotationToolTipContentUpdatingScript**: `string` -- **ValueLines**: `IgbValueModeCollection` — Gets or sets what value lines to use in the chart. -- **ValueLinesBrushes**: `string` — Gets or sets the palette of brushes to use for coloring the value lines present in the ValueLines property. -- **ValueLinesThickness**: `double` — Gets or sets thickness of value lines. -- **VerticalViewScrollbarCornerRadius**: `double` — Gets or sets the corner radius to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarFill**: `string` — Gets or sets the fill to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarInset**: `double` — Gets or sets the inset distance to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarMaxOpacity**: `double` — Gets or sets the max opacity to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarMode**: `SeriesViewerScrollbarMode` — Gets or sets the vertical scrollbar mode to use for the series viewer. -- **VerticalViewScrollbarOutline**: `string` — Gets or sets the outline to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarPosition**: `SeriesViewerVerticalScrollbarPosition` — Gets or sets the position to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarShouldAddAutoTrackInsets**: `bool` — Gets or sets whether to use automatic track insets for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarStrokeThickness**: `double` — Gets or sets the stroke thickness to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarTrackEndInset**: `double` — Gets or sets the track end inset to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarTrackStartInset**: `double` — Gets or sets the track start inset to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarWidth**: `double` — Gets or sets the width to use for the vertical scrollbar in the component, when enabled. -- **WindowRect**: `Rect` — Gets or sets the rectangle representing the current scroll and zoom state of the chart. -- **WindowRectMinHeight**: `double` — Sets or gets the minimum height that the window rect is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. -- **WindowRectMinWidth**: `double` — Sets or gets the minimum width that the window rect is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. -- **WindowSizeMinHeight**: `double` — Sets or gets minimum pixel height that the window is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. -- **WindowSizeMinWidth**: `double` — Sets or gets minimum pixel width that the window is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. -- **CancelAnnotationFlow**(annotationFlowId: string): void -- **CancelAnnotationFlowAsync**(annotationFlowId: string): Task -- **Destroy**(): void -- **DestroyAsync**(): Task — Destroy this control -- **ExportDomainChartTestingInfo**(): IgbDomainChartTestingInfo -- **ExportDomainChartTestingInfoAsync**(): Task -- **FindByName**(name: string): object -- **FinishAnnotationFlow**(flowInformation: IgbUserAnnotationInformation): void -- **FinishAnnotationFlowAsync**(flowInformation: IgbUserAnnotationInformation): Task -- **Flush**(): void -- **FlushAsync**(): Task — Forces any pending refresh to the chart to be finished. -- **GetCurrentFocusedSeriesItems**(): IgbChartSelectedItemCollection -- **GetCurrentFocusedSeriesItemsAsync**(): Task -- **GetCurrentSelectedSeriesItems**(): IgbChartSelectedItemCollection -- **GetCurrentSelectedSeriesItemsAsync**(): Task -- **HideToolTip**(): void -- **HideToolTipAsync**(): Task — Hides the active main tooltip, if displayed. -- **LoadAnnotationsFromJson**(jsonString: string): void -- **LoadAnnotationsFromJsonAsync**(jsonString: string): Task -- **NotifyClearItems**(source_: object): void -- **NotifyClearItemsAsync**(source_: object): Task — Used to manually notify the chart that the data source has reset or cleared its items. -- **NotifyInsertItem**(source_: object, index: int, newItem: object): void -- **NotifyInsertItemAsync**(source_: object, index: int, newItem: object): Task -- **NotifyRemoveItem**(source_: object, index: int, oldItem: object): void -- **NotifyRemoveItemAsync**(source_: object, index: int, oldItem: object): Task -- **NotifyResized**(): void -- **NotifyResizedAsync**(): Task — Called when the control has been resized. -- **NotifySeriesDataChanged**(): void -- **NotifySeriesDataChangedAsync**(): Task -- **NotifySetItem**(source_: object, index: int, oldItem: object, newItem: object): void -- **NotifySetItemAsync**(source_: object, index: int, oldItem: object, newItem: object): Task -- **NotifyVisualPropertiesChanged**(): void -- **NotifyVisualPropertiesChangedAsync**(): Task -- **OnDetach**(): void -- **OnDetachAsync**(): Task -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task — Provides a container for this control -- **ReplayTransitionIn**(): void -- **ReplayTransitionInAsync**(): Task — Replays transition-in animation on all series in the chart. -- **ResetAnnotations**(): void -- **ResetAnnotationsAsync**(): Task -- **ResetZoom**(): void -- **ResetZoomAsync**(): Task — Resets the zoom level to default. -- **SaveAnnotationsToJson**(): string -- **SaveAnnotationsToJsonAsync**(): Task -- **SetCustomizedStringAsync**(language: string, json: string): Task — Provide a new set of localized strings to use for a given languange. -- **SetCustomizedStringAsync**(language: string, id: string, value: string): Task — Provide a new set of localized strings to use for a given languange. -- **SimulateClick**(point: Point): void -- **SimulateClickAsync**(point: Point): Task -- **SimulateHover**(point: Point): void -- **SimulateHoverAsync**(point: Point): Task -- **SimulatePlotPointerUp**(point: Point): void -- **SimulatePlotPointerUpAsync**(point: Point): Task -- **SimulatePressAndHold**(point: Point): void -- **SimulatePressAndHoldAsync**(point: Point): Task -- **StartCreatingAnnotation**(): void -- **StartCreatingAnnotationAsync**(): Task -- **StartDeletingAnnotation**(): void -- **StartDeletingAnnotationAsync**(): Task -- **ZoomIn**(v: double): void -- **ZoomInAsync**(v: double): Task — Performs zoom in action on the chart by specified percentage of current window rect -- **ZoomOut**(v: double): void -- **ZoomOutAsync**(v: double): Task — Performs zoom out action on the chart by specified percentage of current window rect - -### [IgbDomainChartPlotAreaPointerEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDomainChartPlotAreaPointerEventArgs) -Represents event arguments for chart's SeriesAdded and SeriesRemoved events - -- **constructor**(): void -- **ChartPosition**: `Point` — Gets the mouse position relative to the chart. -- **PlotAreaPosition**: `Point` — Gets the pointer position relative to the plot area. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDomainChartSeriesPointerEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDomainChartSeriesPointerEventArgs) -Represents event arguments for chart's SeriesAdded and SeriesRemoved events - -- **constructor**(): void -- **ChartPosition**: `Point` — Gets the mouse position relative to the chart. -- **Item**: `object` — Gets the item hit by the pointer. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **PlotAreaPosition**: `Point` — Gets the pointer position relative to the plot area. -- **Series**: `IgbSeries` — Gets the series hit by the pointer. -- **Type**: `string` -- **WorldPosition**: `Point` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDomainChartTestingInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDomainChartTestingInfo) - -- **constructor**(): void -- **MainDataChart**: `IgbDataChart` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbDoubleValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDoubleValueChangedEventArgs) -Provides data for double value change events. - -- **constructor**(): void -- **NewValue**: `double` — Gets the new value. -- **OldValue**: `double` — Gets the value before the change. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDoughnutChart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDoughnutChart) -Represents concentric circles divided on arcs depending on data. - -- **constructor**(): void -- **ActualPixelScalingRatio**: `double` — Resolved pixel scaling ratio. Unless explicitly overridden by the IgbDoughnutChart.PixelScalingRatio property, this one returns the default ratio enforced by device. High resolution devices will initialize this property to a higher value. -- **ActualSeries**: `IgbRingSeriesCollection` -- **AllowSliceExplosion**: `bool` — Gets or sets whether the slices can be exploded. -- **AllowSliceSelection**: `bool` — Gets or sets whether the slices can be selected. -- **ContentSeries**: `IgbRingSeriesCollection` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **HoleDimensionsChanged**: `EventCallback` -- **HoleDimensionsChangedScript**: `string` -- **InnerExtent**: `double` — Gets or sets the inner extent of the doughnut chart. It is percent from the outer ring's radius. -- **IsSurfaceInteractionDisabled**: `bool` — Gets or sets whether all surface interactions with the plot area should be disabled. -- **ParentTypeName**: `string` -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **SelectedSliceFill**: `string` — Gets or sets the fill brush. -- **SelectedSliceOpacity**: `double` — Gets or sets the opacity. -- **SelectedSliceStroke**: `string` — Gets or sets the stroke brush. -- **SelectedSliceStrokeThickness**: `double` — Gets or sets the stroke thickness. -- **Series**: `IgbRingSeriesCollection` — Gets the current SeriesViewer object's child Series. -- **SliceClick**: `EventCallback` -- **SliceClickScript**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Returns the chart visuals expressed as a serialized string. -- **FindByName**(name: string): object -- **Flush**(): void -- **FlushAsync**(): Task — Use to force the doughnut chart to finish any deferred work before printing or evaluating its visual. -- **GetCenterCoordinates**(): Point -- **GetCenterCoordinatesAsync**(): Task — Gets the center coordinates of the doughnut chart's center presenter. -- **GetContainerID**(): string -- **GetContainerIDAsync**(): Task — Gets the ID of the UI container. -- **GetHoleRadius**(): double -- **GetHoleRadiusAsync**(): Task — Gets the hole radius of the doughnut chart's center presenter. -- **NotifyClearItems**(source_: object): void -- **NotifyClearItemsAsync**(source_: object): Task — Used to manually notify the chart that the data source has reset or cleared its items. -- **NotifyInsertItem**(source_: object, index: int, newItem: object): void -- **NotifyInsertItemAsync**(source_: object, index: int, newItem: object): Task -- **NotifyRemoveItem**(source_: object, index: int, oldItem: object): void -- **NotifyRemoveItemAsync**(source_: object, index: int, oldItem: object): Task -- **NotifyResized**(): void -- **NotifyResizedAsync**(): Task — Called when the control has been resized. -- **NotifySetItem**(source_: object, index: int, oldItem: object, newItem: object): void -- **NotifySetItemAsync**(source_: object, index: int, oldItem: object, newItem: object): Task -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task — Called by the UI framework to provide a UI container for rendering this control. - -### [IgbDoughnutChartCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDoughnutChartCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDoughnutChartInteractivityModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDoughnutChartInteractivityModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDoughnutChartModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDoughnutChartModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDownloadingMultiScaleImageEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDownloadingMultiScaleImageEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **Uri**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDragService](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDragService) - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDragServiceModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDragServiceModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDropdown](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDropdown) -Represents a DropDown component. - -- **constructor**(): void -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **ContentItems**: `IgbDropdownItemCollection` -- **DirectRenderElementName**: `string` -- **Distance**: `double` — The distance from the target element. -- **Flip**: `bool` — Whether the component should be flipped to the opposite side of the target once it's about to overflow the visible area. When true, once enough space is detected on its preferred side, it will flip back. -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **ParentTypeName**: `string` -- **Placement**: `PopoverPlacement` — The preferred placement of the component around the target element. -- **SameWidth**: `bool` — Whether the dropdown's width should be the same as the target's one. -- **ScrollStrategy**: `PopoverScrollStrategy` — Determines the behavior of the component during scrolling of the parent container. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ClearSelection**(): void -- **ClearSelectionAsync**(): Task — Clears the current selection of the dropdown. -- **DisconnectedCallback**(): void -- **DisconnectedCallbackAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetGroups**(): IgbDropdownGroup[] -- **GetGroupsAsync**(): Task -- **GetItems**(): IgbDropdownItem[] -- **GetItemsAsync**(): Task -- **GetSelectedItem**(): IgbDropdownItem -- **GetSelectedItemAsync**(): Task -- **NavigateTo**(index: object): IgbDropdownItem -- **NavigateToAsync**(index: object): Task — Navigates to the item at the specified index. If it exists, returns the found item, otherwise - null. -- **ResolveDisplay**(): string -- **Select**(value: object): IgbDropdownItem -- **SelectAsync**(value: object): Task — Selects the item with the specified value. If it exists, returns the found item, otherwise - null. -- **Show**(target_: object): void -- **ShowAsync**(target_: object): Task — Shows the dropdown. -- **Toggle**(target_: object): void -- **ToggleAsync**(target_: object): Task — Toggles the open state of the dropdown. - -### [IgbDropdownGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDropdownGroup) -A container for a group of igc-dropdown-item components. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDropdownGroupModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDropdownGroupModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDropdownHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDropdownHeader) -Represents a header item in a igc-dropdown list. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbDropdownHeaderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDropdownHeaderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDropdownItem](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDropdownItem) -Represents an item in a dropdown list. - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **DropdownParent**: `BaseRendererControl` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task -- **ResolveDisplay**(): string - -### [IgbDropdownItemCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDropdownItemCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbDropdownItemComponentEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDropdownItemComponentEventArgs) - -- **constructor**(): void -- **Detail**: `IgbDropdownItem` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbDropdownItemModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDropdownItemModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbDropdownModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbDropdownModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbEaseOfMovementIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbEaseOfMovementIndicator) -Represents a IgbDataChart Ease of Movement indicator series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbEaseOfMovementIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbEaseOfMovementIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbEditRowDefinition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbEditRowDefinition) -Represents a base class used to configure the appearance of the column header cells. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbEditRowDefinitionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbEditRowDefinitionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbEditorCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbEditorCellInfo) -Represents info about the current cell. - -- **constructor**(): void -- **DataType**: `DataSourceSchemaPropertyType` — Gets or sets the data type associated with the cell being edited. -- **DateFormatString**: `string` -- **EditTarget**: `IgbCellInfo` — Gets or sets the edit target for this cell. -- **EditValue**: `object` — Gets or sets the user selected value. -- **EditValueScript**: `string` — Provides a means of setting EditValue in the JavaScript environment. -- **EditorDataSource**: `object` — Gets or sets the data source to use for the editor where it makes sense. -- **EditorDataSourceScript**: `string` — Provides a means of setting EditorDataSource in the JavaScript environment. -- **EditorTextField**: `string` — Gets or sets the editors display member. -- **EditorType**: `EditorType` — Gets or sets the type of editor to use while cell editing. -- **EditorValueField**: `string[]` — Gets or sets the editors value member. -- **ErrorMessage**: `string` — Gets or sets the error message to display in the editor cell. -- **IsHidden**: `bool` — Gets whether the editor cell is hidden or not. -- **ShowTodayButton**: `bool` -- **TargetColumn**: `int` — Gets the column index that the editor cell is targeting for edit. -- **TargetRow**: `int` — Gets the row index that the editor cell is targeting for edit. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbEditorDefinition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbEditorDefinition) -Represents a base class used to configure the appearance of the column header cells. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbEditorDefinitionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbEditorDefinitionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbEditorRowCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbEditorRowCellInfo) -Represents info about the current cell. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbEntityType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbEntityType) -Describes an entity in the QueryBuilder. An entity represents a logical grouping of fields and can have nested child entities. - -- **constructor**(): void -- **ChildEntities**: `IgbEntityType[]` — Optional child entities. This allows building hierarchical or nested query structures. -- **Fields**: `IgbFieldType[]` — The list of fields that belong to this entity. -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbExcelLocaleBgModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleBgModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleCsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleCsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleDaModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleDaModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleDeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleDeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleEnModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleEnModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleEsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleEsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleFrModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleFrModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleHuModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleHuModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleItModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleItModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleJaModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleJaModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleNbModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleNbModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleNlModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleNlModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocalePlModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocalePlModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocalePtModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocalePtModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleRoModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleRoModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleRuModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleRuModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleSvModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleSvModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleTrModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleTrModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleZhHansModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleZhHansModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExcelLocaleZhHantModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExcelLocaleZhHantModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExpansionPanel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExpansionPanel) -The Expansion Panel Component provides a way to display information in a toggleable way - compact summary view containing title and description and expanded detail view containing additional content to the summary header. - -- **constructor**(): void -- **AccordionParent**: `BaseRendererControl` -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — Get/Set whether the expansion panel is disabled. Disabled panels are ignored for user interactions. -- **IndicatorPosition**: `ExpansionPanelIndicatorPosition` — The indicator position of the expansion panel. -- **Open**: `bool` — Indicates whether the contents of the control should be visible. -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **Hide**(): bool -- **HideAsync**(): Task — Hides the panel content. -- **OnInitializedAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(): bool -- **ShowAsync**(): Task — Shows the panel content. -- **Toggle**(): bool -- **ToggleAsync**(): Task — Toggles the panel open/close state. - -### [IgbExpansionPanelComponentEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExpansionPanelComponentEventArgs) - -- **constructor**(): void -- **Detail**: `IgbExpansionPanel` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbExpansionPanelModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExpansionPanelModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbExporterEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExporterEventArgs) - -- **constructor**(): void -- **Detail**: `IgbExporterEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbExporterEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExporterEventArgsDetail) - -- **constructor**(): void -- **Cancel**: `bool` -- **Exporter**: `IgbBaseExporter` -- **Grid**: `IgbGridBaseDirective` -- **Options**: `IgbExporterOptionsBase` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbExporterOptionsBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExporterOptionsBase) - -- **constructor**(): void -- **AlwaysExportHeaders**: `bool` — Specifies whether the headers should be exported if there is no data. let alwaysExportHeaders = this.exportOptions.alwaysExportHeaders; this.exportOptions.alwaysExportHeaders = false; IgxExporterOptionsBase -- **ExportSummaries**: `bool` — Specifies whether the exported data should include column summaries. let exportSummaries = this.exportOptions.exportSummaries; this.exportOptions.exportSummaries = true; IgxExporterOptionsBase -- **FileName**: `string` — Gets the file name which will be used for the exporting operation. let fileName = this.exportOptions.fileName; IgxExporterOptionsBase -- **FreezeHeaders**: `bool` — Specifies whether the exported data should have frozen headers. let freezeHeaders = this.exportOptions.freezeHeaders; this.exportOptions.freezeHeaders = true; IgxExporterOptionsBase -- **IgnoreColumnsOrder**: `bool` — Specifies if the exporter should ignore the current column order in the IgxGrid. let ignoreColumnsOrder = this.exportOptions.ignoreColumnsOrder; this.exportOptions.ignoreColumnsOrder = true; IgxExporterOptionsBase -- **IgnoreColumnsVisibility**: `bool` — Specifies whether hidden columns should be exported. let ignoreColumnsVisibility = this.exportOptions.ignoreColumnsVisibility; this.exportOptions.ignoreColumnsVisibility = true; IgxExporterOptionsBase -- **IgnoreFiltering**: `bool` — Specifies whether filtered out rows should be exported. let ignoreFiltering = this.exportOptions.ignoreFiltering; this.exportOptions.ignoreFiltering = true; IgxExporterOptionsBase -- **IgnoreGrouping**: `bool` — Specifies whether the exported data should be grouped as in the provided IgxGrid. let ignoreGrouping = this.exportOptions.ignoreGrouping; this.exportOptions.ignoreGrouping = true; IgxExporterOptionsBase -- **IgnoreMultiColumnHeaders**: `bool` — Specifies whether the exported data should include multi column headers as in the provided IgxGrid. let ignoreMultiColumnHeaders = this.exportOptions.ignoreMultiColumnHeaders; this.exportOptions.ignoreMultiColumnHeaders = true; IgxExporterOptionsBase -- **IgnoreSorting**: `bool` — Specifies whether the exported data should be sorted as in the provided IgxGrid. When you export grouped data, setting ignoreSorting to true will cause the grouping to fail because it relies on the sorting of the records. let ignoreSorting = this.exportOptions.ignoreSorting; this.exportOptions.ignoreSorting = true; IgxExporterOptionsBase -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbExpressionTree](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExpressionTree) - -- **constructor**(): void -- **Entity**: `string` -- **FieldName**: `string` -- **FilteringOperands**: `IgbExpressionTreeOrFilteringExpression[]` -- **Operator**: `FilteringLogic` -- **ReturnFields**: `string[]` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbExpressionTreeDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExpressionTreeDetail) - -- **constructor**(): void -- **Entity**: `string` -- **FieldName**: `string` -- **FilteringOperands**: `IgbExpressionTreeOrFilteringExpression[]` -- **Operator**: `FilteringLogic` -- **ReturnFields**: `string[]` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbExpressionTreeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExpressionTreeEventArgs) - -- **constructor**(): void -- **Detail**: `IgbExpressionTreeDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbExpressionTreeOrFilteringExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbExpressionTreeOrFilteringExpression) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbFastStochasticOscillatorIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFastStochasticOscillatorIndicator) -Represents a IgbDataChart Fast Stochastic Oscillator indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current FastStochasticOscillatorIndicator object. The typical, and initial, value for FastStochasticOscillatorIndicator periods is 14. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbFastStochasticOscillatorIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFastStochasticOscillatorIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFieldEditorOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFieldEditorOptions) - -- **constructor**(): void -- **DateTimeFormat**: `string` — A custom input format string used for the built-in editors of date/time columns. See the Editing section under https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/column-types#datetime-date-and-time -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbFieldPipeArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFieldPipeArgs) - -- **constructor**(): void -- **CurrencyCode**: `string` — The currency code of type string, default value undefined -- **DigitsInfo**: `string` — Decimal representation options, specified by a string in the following format: {minIntegerDigits}.{minFractionDigits}-{maxFractionDigits}. minIntegerDigits: The minimum number of integer digits before the decimal point. Default is 1. minFractionDigits: The minimum number of digits after the decimal point. Default is 0. maxFractionDigits: The maximum number of digits after the decimal point. Default is 3. -- **Display**: `string` — Allow us to display currency 'symbol' or 'code' or 'symbol-narrow' or our own string. The value is of type string. By default is set to 'symbol' -- **Format**: `string` — The date/time components that a date column will display, using predefined options or a custom format string. -- **Timezone**: `string` — A timezone offset (such as '+0430'), or a standard UTC/GMT or continental US timezone abbreviation. -- **Type**: `string` -- **WeekStart**: `double` — The first week day to be displayed in calendar when filtering or editing a date column -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbFieldType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFieldType) -Describes a field that can be used in the Grid and QueryBuilder components. - -- **constructor**(): void -- **DataType**: `GridColumnDataType` — The data type of the field. -- **DefaultDateTimeFormat**: `string` — Default date/time format for Date/Time fields. -- **DefaultTimeFormat**: `string` — Default time format for Date/Time fields. -- **EditorOptions**: `IgbFieldEditorOptions` — Options for the editor associated with this field. -- **Field**: `string` — The internal field name, used in expressions and queries. -- **Filters**: `IgbFilteringOperand` — Optional filtering operands that apply to this field. -- **Header**: `string` — Optional column header for UI display purposes. -- **Label**: `string` — Display label for the field. -- **PipeArgs**: `IgbFieldPipeArgs` — Optional arguments for any pipe applied to the field. -- **Type**: `string` -- **FindByName**(name: string): object -- **Formatter**(value: object, rowData: object): object -- **FormatterAsync**(value: object, rowData: object): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbFilterCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilterCellInfo) -Represents info about the current cell. - -- **constructor**(): void -- **ClearIconLeft**: `double` -- **ClearIconTop**: `double` -- **DataType**: `DataSourceSchemaPropertyType` — Gets or sets whether the cell is hit test visible. -- **EditorLeft**: `double` -- **EditorTop**: `double` -- **Filter**: `IgbColumnFilterCondition` — Gets or sets the current filter to display in the cell. -- **FilterExpression**: `IgbFilterExpression` — Gets or sets the current filter expression applied to the column. -- **FilterOperands**: `IgbGridFilterOperandsCollection` -- **FilterValue**: `object` -- **FilterValueScript**: `string` — Provides a means of setting FilterValue in the JavaScript environment. -- **OperatorType**: `ColumnComparisonConditionOperatorType` -- **SelectorLeft**: `double` -- **SelectorTop**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFilterDialogRenderCompletedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilterDialogRenderCompletedEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFilterExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilterExpression) -Represents a filter expression for use with the grids and data sources. - -- **constructor**(): void -- **IsAutoGenerated**: `bool` -- **IsFunction**: `bool` — Gets whether the expression is a function. -- **IsLiteral**: `bool` — Gets whether the expression is a literal. -- **IsNull**: `bool` — Gets whether the expresssion is null. -- **IsOperation**: `bool` — Gets whether the expression is an operation. -- **IsPropertyReference**: `bool` — Gets whether the expression is a property reference. -- **IsWrapper**: `bool` — Gets whether the expression is a wrapper expression. -- **Precedence**: `int` -- **Type**: `string` -- **Add**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Add expression of the current expression and right. -- **Add**(literalValue: object): IgbFilterExpression — Returns an expression that is an Add expression of the current expression and literal value. -- **And**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an And expression of the current expression and right. -- **Cast**(propertyType: DataSourceSchemaPropertyType): IgbFilterExpression — Returns an expression that is an Cast expression of the current expression and propertyType. -- **Cast**(objectType: string): IgbFilterExpression — Returns an expression that is an Cast expression of the current expression and propertyType. -- **Ceiling**(): IgbFilterExpression — Returns an expression that is an Ceiling expression of the current expression. -- **Concat**(toAppend: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Concat expression of the current expression and toAppend. -- **Concat**(toAppend: string): IgbFilterExpression — Returns an expression that is an Contains expression of the current expression and subString. -- **Contains**(subString: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Contains expression of the current expression and subString. -- **Contains**(subString: string): IgbFilterExpression — Returns an expression that is an Contains expression of the current expression and subString. -- **Date**(): IgbFilterExpression — Returns an expression that is an Date expression of the current expression. -- **Day**(): IgbFilterExpression — Returns an expression that is an Day expression of the current expression. -- **Divide**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is a Divide expression of the current expression and right. -- **Divide**(literalValue: object): IgbFilterExpression — Returns an expression that is a Divide expression of the current expression and literalValue. -- **DividedBy**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is a Divide expression of the current expression and right. -- **DividedBy**(literalValue: object): IgbFilterExpression — Returns an expression that is a Divide expression of the current expression and literalValue. -- **EndsWith**(subString: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an EndsWith expression of the current expression and subString. -- **EndsWith**(subString: string): IgbFilterExpression — Returns an expression that is an EndsWith expression of the current expression and subString. -- **Env**(varName: string): IgbFilterExpression -- **EnvAsync**(varName: string): Task — Returns an environment variable, if applicable. -- **FindByName**(name: string): object -- **Floor**(): IgbFilterExpression — Returns an expression that is a Floor expression of the current expression. -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **Function**(func: FilterExpressionFunctionType, args: IgbFilterExpression[]): IgbFunctionFilterExpression — Creates an function filter expression. -- **Group**(): IgbFilterExpression — Returns an expression that is a group expression of the current expression. -- **Hour**(): IgbFilterExpression — Returns an expression that is an Hour expression of the current expression. -- **IndexOf**(toFind: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an IndexOf expression of the current expression and toFind. -- **IndexOf**(toFind: string): IgbFilterExpression — Returns an expression that is an IndexOf expression of the current expression and toFind. -- **IsEqualTo**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an IsEqualTo expression of the current expression and right. -- **IsEqualTo**(literalValue: object): IgbFilterExpression — Returns an expression that is an IsEqualTo expression of the current expression and right. -- **IsGreaterThan**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an IsGreaterThan expression of the current expression and right. -- **IsGreaterThan**(literalValue: object): IgbFilterExpression — Returns an expression that is an IsGreaterThan expression of the current expression and right. -- **IsGreaterThanOrEqualTo**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an IsGreaterThanOrEqualTo expression of the current expression and right. -- **IsGreaterThanOrEqualTo**(literalValue: object): IgbFilterExpression — Returns an expression that is an IsGreaterThanOrEqualTo expression of the current expression and right. -- **IsLessThan**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an IsLessThan expression of the current expression and right. -- **IsLessThan**(literalValue: object): IgbFilterExpression — Returns an expression that is an IsGreaterThanOrEqualTo expression of the current expression and right. -- **IsLessThanOrEqualTo**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an IsLessThanOrEqualTo expression of the current expression and right. -- **IsLessThanOrEqualTo**(literalValue: object): IgbFilterExpression — Returns an expression that is an IsGreaterThanOrEqualTo expression of the current expression and right. -- **IsNotEqualTo**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an IsNotEqualTo expression of the current expression and right. -- **IsNotEqualTo**(literalValue: object): IgbFilterExpression — Returns an expression that is an IsNotEqualTo expression of the current expression and right. -- **IsOf**(propertyType: DataSourceSchemaPropertyType): IgbFilterExpression — Returns an expression that is an IsOf expression of the current expression and propertyType. -- **IsOf**(objectType: string): IgbFilterExpression — Returns an expression that is an IsOf expression of the current expression and propertyType. -- **Length**(): IgbFilterExpression — Returns an expression that is an Length expression of the current expression. -- **Literal**(literal: object): IgbLiteralFilterExpression — Builds a literal value expression for the provided value. -- **MarkAutoGenerated**(): void -- **MarkAutoGeneratedAsync**(): Task -- **Minus**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Subtract expression of the current expression and right. -- **Minus**(literalValue: object): IgbFilterExpression — Returns an expression that is an Subtract expression of the current expression and right. -- **Minute**(): IgbFilterExpression — Returns an expression that is an Minute expression of the current expression. -- **Modulo**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Modulus expression of the current expression and right. -- **Modulo**(literalValue: object): IgbFilterExpression — Returns an expression that is an Modulus expression of the current expression and right. -- **Month**(): IgbFilterExpression — Returns an expression that is an Month expression of the current expression. -- **Multiply**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Multiply expression of the current expression and right. -- **Multiply**(literalValue: object): IgbFilterExpression — Returns an expression that is an Multiply expression of the current expression and right. -- **Not**(): IgbFilterExpression — Returns an expression that is a Not expression of the current expression. -- **Now**(): IgbFilterExpression — Returns an expression that is an Now expression. -- **NullLiteral**(): IgbLiteralFilterExpression — Builds a null literal expression. -- **Operation**(left: IgbFilterExpression, op: FilterExpressionOperatorType, right: IgbFilterExpression): IgbOperationFilterExpression — Creates an operator filter expression. -- **Operation**(left: IgbFilterExpression, op: FilterExpressionOperatorType, value: object): IgbOperationFilterExpression — Creates an operator filter expression. -- **Operation**(propertyName: string, op: FilterExpressionOperatorType, right: IgbFilterExpression): IgbOperationFilterExpression — Creates an operator filter expression. -- **Operation**(propertyName: string, op: FilterExpressionOperatorType, value: object): IgbOperationFilterExpression — Creates an operator filter expression. -- **Or**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Or expression of the current expression and right. -- **Plus**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Add expression of the current expression and right. -- **Plus**(literalValue: object): IgbFilterExpression — Returns an expression that is an Add expression of the current expression and literalValue. -- **Property**(propertyName: string): IgbPropertyReferenceFilterExpression — Builds a property access expression for the provided property. -- **Replace**(toFind: IgbFilterExpression, replacement: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Replace expression of the current expression. -- **Replace**(toFind: IgbFilterExpression, replacement: string): IgbFilterExpression — Returns an expression that is an Replace expression of the current expression. -- **Replace**(toFind: string, replacement: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Replace expression of the current expression. -- **Replace**(toFind: string, replacement: string): IgbFilterExpression — Returns an expression that is an Replace expression of the current expression. -- **Round**(): IgbFilterExpression — Returns an expression that is an Round expression of the current expression. -- **Second**(): IgbFilterExpression — Returns an expression that is an Second expression of the current expression. -- **StartsWith**(subString: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an StartsWith expression of the current expression. -- **StartsWith**(subString: string): IgbFilterExpression — Returns an expression that is an StartsWith expression of the current expression. -- **Substring**(startIndex: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Substring expression of the current expression. -- **Substring**(startIndex: IgbFilterExpression, length: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Substring expression of the current expression. -- **Substring**(startIndex: IgbFilterExpression, length: int): IgbFilterExpression — Returns an expression that is an Substring expression of the current expression. -- **Substring**(startIndex: int): IgbFilterExpression — Returns an expression that is an Substring expression of the current expression. -- **Substring**(startIndex: int, length: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Substring expression of the current expression. -- **Substring**(startIndex: int, length: int): IgbFilterExpression — Returns an expression that is an Substring expression of the current expression. -- **Subtract**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Subtract expression of the current expression and right. -- **Subtract**(literalValue: object): IgbFilterExpression — Returns an expression that is an Subtract expression of the current expression and right. -- **Time**(): IgbFilterExpression — Returns an expression that is an Time expression of the current expression. -- **Times**(right: IgbFilterExpression): IgbFilterExpression — Returns an expression that is an Multiply expression of the current expression and right. -- **Times**(literalValue: object): IgbFilterExpression — Returns an expression that is an Multiply expression of the current expression and right. -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToLower**(): IgbFilterExpression — Returns an expression that is an ToLower expression of the current expression. -- **ToUpper**(): IgbFilterExpression — Returns an expression that is an ToUpper expression of the current expression. -- **Trim**(): IgbFilterExpression — Returns an expression that is an Trim expression of the current expression. -- **UnquotedLiteral**(literal: string): IgbLiteralFilterExpression — Builds a literal value expression for the provided value which should be left unquoted. -- **Year**(): IgbFilterExpression — Returns an expression that is an Year expression of the current expression. - -### [IgbFilterExpressionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilterExpressionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbFilterOperand](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilterOperand) -A filter operand. - -- **constructor**(): void -- **ComboColumnParent**: `BaseRendererElement` -- **DateTimeColumnParent**: `BaseRendererElement` -- **DisplayName**: `string` — Gets or sets the name for display of this custom filter. -- **EditorType**: `EditorType` — The type of editor to use in the filter cell. Combo is not currently supported. -- **FilterFactory**: `FilterFactory` — Gets the FilterFactory to assists in building filters. -- **FilterRequested**: `Func` -- **ID**: `string` — Gets or sets the ID of the filter. Must be unique from other filters in the column. -- **Icon**: `string` — Gets or sets the SVG path to use for the operand icon in the filter cell. -- **ImageColumnParent**: `BaseRendererElement` -- **IsInputRequired**: `bool` — Gets or sets whether this filter requires input. -- **NumericColumnParent**: `BaseRendererElement` -- **TemplateColumnParent**: `BaseRendererElement` -- **TextColumnParent**: `BaseRendererElement` -- **Type**: `string` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FilteringExpression**(value: object): IgbFilterExpression — Returns a custom filter expression to be used for filtering. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **OnInitializedAsync**(): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFilterOperandModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilterOperandModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFilterRowDefinition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilterRowDefinition) -Represents a base class used to configure the appearance of the column header cells. - -- **constructor**(): void -- **PaddingBottom**: `int` — Gets or sets the amount of bottom padding to use for the cell content of this column. -- **PaddingLeft**: `int` — Gets or sets the amount of left padding to use for the cell content for this column. -- **PaddingRight**: `int` — Gets or sets the amount of right padding to use for the cell content of this column. -- **PaddingTop**: `int` — Gets or sets the amount of top padding to use for the cell content for this column. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFilterRowDefinitionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilterRowDefinitionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFilterStringErrorsParsingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilterStringErrorsParsingEventArgs) -Represents event arguments for when there are errors parsing the filter string - -- **constructor**(): void -- **Errors**: `string` — Gets the errors from parsing the filter string. -- **PropertyName**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFilteringEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilteringEventArgs) -Represents event arguments related to filtering operations The event is cancelable - -- **constructor**(): void -- **Detail**: `IgbFilteringEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFilteringEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilteringEventArgsDetail) -Represents event arguments related to filtering operations The event is cancelable - -- **constructor**(): void -- **Cancel**: `bool` — Provides the ability to cancel the event. -- **FilteringExpressions**: `IgbFilteringExpressionsTree` — Represents the filtering expressions applied to the grid. The expression contains information like filtering operands and operator, an expression or condition, etc. -- **Owner**: `object` — Provides reference to the owner component. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFilteringExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilteringExpression) -Represents filtering expressions. - -- **constructor**(): void -- **Condition**: `IgbFilteringOperation` -- **ConditionName**: `string` -- **FieldName**: `string` -- **IgnoreCase**: `bool` -- **SearchTree**: `IgbExpressionTree` -- **SearchVal**: `object` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFilteringExpressionsTree](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilteringExpressionsTree) - -- **constructor**(): void -- **Entity**: `string` -- **FieldName**: `string` -- **FilteringOperands**: `IgbFilteringExpressionsTreeOrFilteringExpression[]` -- **Operator**: `FilteringLogic` -- **Owner**: `object` — Provides reference to the owner component. -- **ReturnFields**: `string[]` -- **TreeType**: `FilteringExpressionsTreeType` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFilteringExpressionsTreeDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilteringExpressionsTreeDetail) - -- **constructor**(): void -- **Entity**: `string` -- **FieldName**: `string` -- **FilteringOperands**: `IgbFilteringExpressionsTreeOrFilteringExpression[]` -- **Operator**: `FilteringLogic` -- **Owner**: `object` — Provides reference to the owner component. -- **ReturnFields**: `string[]` -- **TreeType**: `FilteringExpressionsTreeType` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFilteringExpressionsTreeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilteringExpressionsTreeEventArgs) - -- **constructor**(): void -- **Detail**: `IgbFilteringExpressionsTreeDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFilteringExpressionsTreeOrFilteringExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilteringExpressionsTreeOrFilteringExpression) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbFilteringExpressionsTreeOrFilteringOperation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilteringExpressionsTreeOrFilteringOperation) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbFilteringOperand](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilteringOperand) -Provides base filtering operations Implementations should be Singleton - -- **constructor**(): void -- **Operations**: `IgbFilteringOperation[]` -- **Type**: `string` -- **Append**(operation: IgbFilteringOperation): void -- **AppendAsync**(operation: IgbFilteringOperation): Task — Adds a new condition to the filtering operations. operation The filtering operation. -- **Condition**(name: string): IgbFilteringOperation -- **ConditionAsync**(name: string): Task — Returns an instance of the condition with the specified name. name The name of the condition. -- **ConditionList**(): string[] -- **ConditionListAsync**(): Task — Returns an array of names of the conditions which are visible in the filtering UI -- **FindByName**(name: string): object -- **Instance**(): IgbFilteringOperand -- **InstanceAsync**(): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbFilteringOperation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilteringOperation) -Interface describing filtering operations - -- **constructor**(): void -- **Hidden**: `bool` -- **IconName**: `string` -- **IsNestedQuery**: `bool` -- **IsUnary**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFilteringOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilteringOptions) - -- **constructor**(): void -- **CaseSensitive**: `bool` -- **FilterKey**: `string` -- **MatchDiacritics**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbFilteringStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFilteringStrategy) - -- **constructor**(): void -- **Type**: `string` -- **Filter**(data: object[], expressionsTree: IgbFilteringExpressionsTree, advancedExpressionsTree: IgbFilteringExpressionsTree, grid: IgbGridBaseDirective): object[] -- **FilterAsync**(data: object[], expressionsTree: IgbFilteringExpressionsTree, advancedExpressionsTree: IgbFilteringExpressionsTree, grid: IgbGridBaseDirective): Task -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbFinalValueLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinalValueLayer) -Represents an annotation layer that displays crosshair lines that cross through the closest value of the target series under the cursor. - -- **constructor**(): void -- **AxisAnnotationBackground**: `string` — Gets or sets the color to use for the axis annotation backing. Leave unset for an automatic value. -- **AxisAnnotationBackgroundCornerRadius**: `double` — Gets or sets the corner radius to use for the axis annotation backing. Leave unset for an automatic value. -- **AxisAnnotationFormatLabelScript**: `string` -- **AxisAnnotationInterpolatedValuePrecision**: `int` — Gets or sets the precision to use displaying values for interpolated crosshair positions. -- **AxisAnnotationOutline**: `string` — Gets or sets the color to use for the axis annotation outline. Leave unset for an automatic value. -- **AxisAnnotationPaddingBottom**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **AxisAnnotationPaddingLeft**: `double` — Gets or sets the left padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **AxisAnnotationPaddingRight**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **AxisAnnotationPaddingTop**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **AxisAnnotationStrokeThickness**: `double` — Gets or sets the stroke thickness for the axis annotation backing. Leave unset for an automatic value. -- **AxisAnnotationTextColor**: `string` — Gets or sets the color to use for the axis annotation text. Leave unset for an automatic value. -- **FinalValueSelectionMode**: `FinalValueSelectionMode` — Gets or sets how to select the final value to annotate. -- **TargetSeries**: `IgbSeries` — Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously. -- **TargetSeriesName**: `string` — Gets or sets the name of the series to target this annotation to. If null, this annotation targets all series simultaneously. -- **TargetSeriesScript**: `string` — Provides a means of setting TargetSeries in the JavaScript environment. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbFinalValueLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinalValueLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFinancialCalculationDataSource](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialCalculationDataSource) -Represents the data contract between a financial series and the decoupled calculation responsibilities which implement its mathmatical logic. - -- **constructor**(): void -- **CalculateCount**: `int` — The number of items from the starting index from which to calculate -- **CalculateFrom**: `int` — The starting index from which to calculate -- **Count**: `int` — The count of the values in the series. -- **LongPeriod**: `int` — The long period to use when calculating, if applicable. -- **MaximumValue**: `double` — If the calculation determines the range of indicator values, it will set the minimum and maximux properties. -- **MinimumValue**: `double` — If the calculation determines the range of indicator values, it will set the minimum and maximux properties. -- **Multiplier**: `double` — If the calculation supports some sort of scaling factor, this value will be used. -- **Period**: `int` — The period to use when calculating, if applicable. -- **ShortPeriod**: `int` — The short period to use when calculating, if applicable. -- **SpecifiesRange**: `bool` — The calculation strategy should set this to true if it specifes the minimum and maximum value properties. -- **TrueLow**: `IgbCalculatedColumn` — An enumerable list of true low values provided by the series to use in calculations. -- **TrueRange**: `IgbCalculatedColumn` — And enumerable list of true range values provided by the series to use in calculations. -- **Type**: `string` -- **TypicalColumn**: `IgbCalculatedColumn` — An enumerable list of typical prices provided by the series to use in calculations. -- **FindByName**(name: string): object - -### [IgbFinancialCalculationSupportingCalculations](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialCalculationSupportingCalculations) -Represents a contract between the financial series and the calculation strategies detailing the supporting calculation strategies that the financial series will provide in order for the indicator calculations to be performed. - -- **constructor**(): void -- **EMA**: `IgbColumnSupportingCalculation` — The strategy provided to calculate an exponential moving average for a collection. -- **LongPriceOscillatorAverage**: `IgbDataSourceSupportingCalculation` — The strategy provided to calculate the long period moving average for price oscillator indicators. -- **LongVolumeOscillatorAverage**: `IgbDataSourceSupportingCalculation` — The strategy provided to calculate the long period moving average for volume oscillator indicators. -- **MakeSafe**: `string` — The strategy provided to make doubles safe for plotting, by default will just make zero if the value is invalid. -- **MakeSafeScript**: `string` — Provides a means of setting MakeSafe in the JavaScript environment. -- **MovingSum**: `IgbColumnSupportingCalculation` — The strategy provided to calculate a moving sum for a collection. -- **SMA**: `IgbColumnSupportingCalculation` — The strategy provided to calculate a simple moving average for a collection. -- **STDEV**: `IgbColumnSupportingCalculation` — The strategy provided to calculate a standard deviation for a collection. -- **ShortPriceOscillatorAverage**: `IgbDataSourceSupportingCalculation` — The strategy provided to calculate the short period moving average for price oscillator indicators. -- **ShortVolumeOscillatorAverage**: `IgbDataSourceSupportingCalculation` — The strategy provided to calculate the short period moving average for volume oscillator indicators. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbFinancialChart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialChart) -Represents a chart with an ordinal X-axis and a numeric Y-axis. - -- **constructor**(): void -- **ApplyCustomIndicatorsScript**: `string` -- **ChartType**: `FinancialChartType` — The type of price series to display in the main chart. -- **CustomIndicatorNames**: `string[]` — The names of custom indicators to add to the chart. -- **IndicatorBrushes**: `string` — Brushes to use for financial indicators. -- **IndicatorDisplayTypes**: `IgbIndicatorDisplayTypeCollection` — The display types of financial indicators. -- **IndicatorLongPeriod**: `int` — The long period of financial indicators, where applicable. -- **IndicatorMultiplier**: `double` — The multiplier of financial indicators, e.g. BollingerBandWidth indicator. -- **IndicatorNegativeBrushes**: `string` — Brushes to use for negative elements in financial indicators. -- **IndicatorPeriod**: `int` — The period of financial indicators, where applicable. -- **IndicatorShortPeriod**: `int` — The short period of financial indicators, where applicable. -- **IndicatorSignalPeriod**: `int` — The signal period of financial indicators, where applicable. -- **IndicatorSmoothingPeriod**: `int` — The smoothing period of financial indicators, where applicable. -- **IndicatorThickness**: `double` — The outline or stroke thickness of financial indicators. -- **IndicatorTypes**: `IgbFinancialIndicatorTypeCollection` — A collection indicating what financial indicator types to display on the Financial Chart. -- **IsHorizontalZoomEnabled**: `bool` — Gets or sets whether the chart can be horizontally zoomed through user interactions. -- **IsLegendVisible**: `bool` — Gets or sets weather or not a legend is visible between toolbar and chart's plot area -- **IsToolbarVisible**: `bool` — A boolean property controlling the visibility of the toolbar. -- **IsVerticalZoomEnabled**: `bool` — Gets or sets whether the chart can be vertically zoomed through user interactions. -- **IsWindowSyncedToVisibleRange**: `bool` — A boolean indicating whether the chart should automatically zoom in vertically on the currently visible range of data. -- **LeftMargin**: `double` — Gets or sets the left margin of the chart content. -- **NeedsDynamicContent**: `bool` -- **NegativeBrushes**: `string` — Gets or sets the palette used for coloring negative items of Waterfall chart type. -- **NegativeOutlines**: `string` — Brushes to use for drawing negative elements, when using a chart type with contextual coloring, such as Waterfall. -- **OverlayBrushes**: `string` — Brushes to use for filling financial overlays. -- **OverlayMultiplier**: `double` — The multiplier of financial overlay, e.g. BollingerBands overlay. -- **OverlayOutlines**: `string` — Brushes to use for outlining financial overlays. -- **OverlayThickness**: `double` — The outline thickness of financial overlays. -- **OverlayTypes**: `IgbFinancialOverlayTypeCollection` — A collection indicating what financial overlay types to display on the Financial Chart. -- **RangeSelectorOptions**: `IgbFinancialChartRangeSelectorOptionCollection` — A FinancialChartRangeSelectorOptionCollection containing the available range selector options on the toolbar. -- **Resolution**: `double` — Gets or sets the rendering resolution for all series in this chart. -- **ToolbarHeight**: `double` -- **TooltipTemplate**: `RenderFragment` -- **Type**: `string` -- **VolumeBrushes**: `string` — Brushes to use for filling volume series in the volume pane. -- **VolumeOutlines**: `string` — Brushes to use for outlining volume series in the volume pane. -- **VolumeThickness**: `double` — The outline thickness of volume series in the volume pane. -- **VolumeType**: `FinancialChartVolumeType` — The type of series to display in the volume pane. -- **XAxisBreaks**: `IgbTimeAxisBreakCollection` — Gets a collection of time axis breaks on x-axis. You can add time axis breaks to exclude plotting of data points in specified range of dates -- **XAxisEnhancedIntervalPreferMoreCategoryLabels**: `bool` — Gets or sets whether the x axis enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval. -- **XAxisMaximumValue**: `DateTime` — Gets or sets maximum value on x-axis -- **XAxisMinimumValue**: `DateTime` — Gets or sets minimum value on x-axis -- **XAxisMode**: `FinancialChartXAxisMode` — The scaling mode of the X-axis. -- **XAxisZoomMaximumCategoryRange**: `double` — Gets or sets number of visible categories at maximum zooming level -- **XAxisZoomMaximumItemSpan**: `double` — Gets or sets maximum pixel span of series item that will be visible at maximum zooming level This property ensures that series item does not get stretch above specified value. -- **XAxisZoomToCategoryRange**: `double` — Gets or sets number of categories that the chart will zoom in and fill plot area -- **XAxisZoomToCategoryStart**: `double` — Gets or sets starting category that chart will move its zoom window. Acceptable value is between 0 and number of data items -- **XAxisZoomToItemSpan**: `double` — Gets or sets pixel span of series item that will be used to zoom chart such that the item has desired span Chart will automatically zoom in until series item has specified pixel span. -- **YAxisAbbreviateLargeNumbers**: `bool` — Gets or sets whether the large numbers on the Y-axis labels are abbreviated. -- **YAxisEnhancedIntervalPreferMoreCategoryLabels**: `bool` — Gets or sets whether the y axis enhanced interval management should prefer to show all the labels if possible without collisions for supported types of category axes. This is for use with EnhancedIntervalMinimumCharacters = -1 and axes that have an integral interval. -- **YAxisInterval**: `double` — Gets or sets the distance between each label and grid line along the Y-axis. -- **YAxisIsLogarithmic**: `bool` — Gets or sets whether the Y-axis should use a logarithmic scale instead of a linear one. -- **YAxisLabelHorizontalAlignment**: `HorizontalAlignment` — Gets or sets Horizontal alignment of Y-axis labels. -- **YAxisLogarithmBase**: `int` — Gets or sets the base value to use in the log function when mapping the position of data items along the Y-axis. -- **YAxisMaximumValue**: `double` — Gets or sets the data value corresponding to the maximum value of the Y-axis. -- **YAxisMinimumValue**: `double` — Gets or sets the data value corresponding to the minimum value of the Y-axis. -- **YAxisMinorInterval**: `double` — Gets or sets the frequency of displayed minor lines along the Y-axis. -- **YAxisMode**: `FinancialChartYAxisMode` — The scaling mode of the Y-axis. -- **ZoomSliderType**: `FinancialChartZoomSliderType` — Gets or sets type of series to display in the zoom slider pane. -- **ZoomSliderXAxisMajorStroke**: `string` — Gets or sets stroke brush of major gridlines on x-axis of the zoom slider pane -- **ZoomSliderXAxisMajorStrokeThickness**: `double` — Gets or sets thickness of major gridlines on x-axis of the zoom slider pane -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Returns visuals as a serialized string. -- **FindByName**(name: string): object -- **NotifyClearItems**(source_: object): void -- **NotifyClearItemsAsync**(source_: object): Task — Used to manually notify the chart that the data source has reset or cleared its items. -- **NotifyInsertItem**(source_: object, index: int, newItem: object): void -- **NotifyInsertItemAsync**(source_: object, index: int, newItem: object): Task -- **NotifyRemoveItem**(source_: object, index: int, oldItem: object): void -- **NotifyRemoveItemAsync**(source_: object, index: int, oldItem: object): Task -- **NotifySetItem**(source_: object, index: int, oldItem: object, newItem: object): void -- **NotifySetItemAsync**(source_: object, index: int, oldItem: object, newItem: object): Task -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task — Called by the UI framework to provide a UI container for rendering this control. - -### [IgbFinancialChartCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialChartCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFinancialChartCustomIndicatorArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialChartCustomIndicatorArgs) -Event arguments for the Financial Chart's custom indicator event. - -- **constructor**(): void -- **Index**: `int` — An integer representing the position of the associated custom indicator in its host. -- **Series**: `IgbSeries` — The Series in context. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFinancialChartModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialChartModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFinancialChartRangeSelectorOptionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialChartRangeSelectorOptionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbFinancialEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialEventArgs) -Parameterizes a financial calculation event. - -- **constructor**(): void -- **Count**: `int` — The number of positions that should be calculated from the start. -- **DataSource**: `IgbFinancialCalculationDataSource` — The data to use for the calculation. -- **Position**: `int` — The beginning position that should be calculated from. -- **SupportingCalculations**: `IgbFinancialCalculationSupportingCalculations` — The supporting calculations to use in the calculation. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFinancialIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialIndicator) -Represents the base functionality for a IgbDataChart financial indicator series. - -- **constructor**(): void -- **ActualTrendLineBrush**: `string` — Gets the effective TrendLineBrush for this indicator. -- **DisplayType**: `IndicatorDisplayType` — Gets or sets the display for the current FinancialIndicator object. -- **IgnoreFirst**: `int` — Gets or sets the number of values to hide at the beginning of the indicator. -- **TrendLineBrush**: `string` — Gets or sets the brush to use to draw the trend line. -- **TrendLineDashArray**: `double[]` — Gets or sets a collection of double values that indicate the pattern of dashes and gaps that is used to draw the trend line for the current indicator object. -- **TrendLinePeriod**: `int` — Gets or sets the trend line period for the current series. -- **TrendLineThickness**: `double` — Gets or sets the thickness of the current indicator object's trend line. -- **TrendLineType**: `TrendLineType` — Gets or sets the trend type for the current indicator series. -- **Type**: `string` -- **FindByName**(name: string): object -- **GetNextOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetNextOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetPreviousOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetPreviousOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetSeriesValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValueBoundingBox**(world: Point): Rect -- **GetSeriesValueBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the series to display the item for the specified data item. - -### [IgbFinancialIndicatorTypeCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialIndicatorTypeCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbFinancialLegend](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialLegend) -Represents a legend that displays information about each series, most often used in financial charting. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbFinancialLegendModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialLegendModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFinancialOverlay](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialOverlay) -Represents the base functionality for a IgbDataChart financial overlay series. - -- **constructor**(): void -- **IgnoreFirst**: `int` — Gets or sets the number of values to hide at the beginning of the indicator. -- **Type**: `string` -- **FindByName**(name: string): object -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the series to display the item for the specified data item. - -### [IgbFinancialOverlayTypeCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialOverlayTypeCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbFinancialPriceSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialPriceSeries) -Represents a IgbDataChart financial price series that renders as Candlestick or OHLC representations. - -- **constructor**(): void -- **ActualTrendLineBrush**: `string` — Gets the effective TrendLineBrush for this FinancialPriceSeries. -- **CategoryCollisionMode**: `CategoryCollisionMode` — Gets or sets the category collision mode selection behavior to use for the series. -- **CloseMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series' Close value in the Data Legend. -- **CloseMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series' Close value in the Data Legend. -- **DisplayType**: `PriceDisplayType` — Gets or sets the display type for the current FinancialPriceSeries object. -- **HighMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series' High value in the Data Legend. -- **HighMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series' High value in the Data Legend. -- **LowMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series' Low value in the Data Legend. -- **LowMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series' Low value in the Data Legend. -- **NegativeOutline**: `string` — Brush to use for outlining negative elements in the series. -- **OpenMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series' Open value in the Data Legend. -- **OpenMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series' Open value in the Data Legend. -- **TrendLineBrush**: `string` — Gets or sets the brush to use to draw the trend line. -- **TrendLineDashArray**: `double[]` — Gets or sets a collection of double values that indicate the pattern of dashes and gaps that is used to draw the trend line for the current FinancialPriceSeries object. -- **TrendLinePeriod**: `int` — Gets or sets the trend line period for the current series. -- **TrendLineThickness**: `double` — Gets or sets the thickness of the current FinancialPriceSeries object's trend line. -- **TrendLineType**: `TrendLineType` — Gets or sets the trend type for the current financial series. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItemSpan**(): double -- **GetItemSpanAsync**(): Task — For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. -- **GetSeriesValueBoundingBox**(world: Point): Rect -- **GetSeriesValueBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. -- **GetSeriesValueType**(mode: ValueLayerValueMode): double[] -- **GetSeriesValueTypeAsync**(mode: ValueLayerValueMode): Task — Gets a numeric value from the numeric axis associated with this series that matches the desired value mode. -- **GetSeriesValueTypePosition**(mode: ValueLayerValueMode): Point -- **GetSeriesValueTypePositionAsync**(mode: ValueLayerValueMode): Task — Gets position of series value for specified layer value mode -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the series to display the item for the specified data item. -- **SetNegativeColors**(negativeBrush: string, negativeOutline: string): void -- **SetNegativeColorsAsync**(negativeBrush: string, negativeOutline: string): Task - -### [IgbFinancialPriceSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialPriceSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFinancialSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFinancialSeries) -Represents the base class for all financial indicator and overlay series. - -- **constructor**(): void -- **AssigningCategoryStyle**: `Action` -- **AssigningCategoryStyleScript**: `string` -- **CloseMemberPath**: `string` — Gets or sets the close mapping property for the current series object. -- **HighMemberPath**: `string` — Gets or sets the high mapping property for the current series object. -- **HighlightedCloseMemberPath**: `string` — Gets or sets the highlighted Y value mapping property for the current series object. -- **HighlightedHighMemberPath**: `string` — Gets or sets the highlighted Y value mapping property for the current series object. -- **HighlightedLowMemberPath**: `string` — Gets or sets the highlighted X value mapping property for the current series object. -- **HighlightedOpenMemberPath**: `string` — Gets or sets the highlighted X value mapping property for the current series object. -- **HighlightedVolumeMemberPath**: `string` — Gets or sets the highlighted Y value mapping property for the current series object. -- **IsCustomCategoryStyleAllowed**: `bool` — Gets or sets whether this category series should allow custom style overrides of its individual visuals. -- **IsTransitionInEnabled**: `bool` — Gets or sets whether the series should transition into the plot area when a new data source is assigned. Note: Transitions are not currently supported for stacked series. -- **LowMemberPath**: `string` — Gets or sets the low mapping property for the current series object. -- **NegativeBrush**: `string` — Gets or sets the brush to use for negative portions of the series. -- **OpenMemberPath**: `string` — Gets or sets the open mapping property for the current series object. -- **TransitionInMode**: `CategoryTransitionInMode` — Gets or sets the method by which to animate the data into the chart when the chart data source is swapped. Note: Transitions are not currently supported for stacked series. -- **Type**: `string` -- **Typical**: `EventCallback` -- **TypicalBasedOn**: `EventCallback` -- **TypicalBasedOnScript**: `string` -- **TypicalScript**: `string` -- **VolumeMemberPath**: `string` — Gets or sets the volume mapping property for the current series object. -- **XAxis**: `IgbCategoryAxisBase` — Gets or sets the effective x-axis for the current FinancialSeries object. -- **XAxisName**: `string` — Gets or sets the name to use to resolve xAxis from markup. -- **XAxisScript**: `string` — Provides a means of setting XAxis in the JavaScript environment. -- **YAxis**: `IgbNumericYAxis` — Gets or sets the effective y-axis for the current FinancialSeries object. -- **YAxisName**: `string` — Gets or sets the name to use to resolve yAxis from markup. -- **YAxisScript**: `string` — Provides a means of setting YAxis in the JavaScript environment. -- **BindAxes**(Axes: IgbAxis[]): void -- **CanUseAsXAxis**(axis: object): bool -- **CanUseAsXAxisAsync**(axis: object): Task — Determine if object can be used as XAxis -- **CanUseAsYAxis**(axis: object): bool -- **CanUseAsYAxisAsync**(axis: object): Task — Determine if object can be used as YAxis -- **FindByName**(name: string): object -- **GetCategoryWidth**(): double -- **GetCategoryWidthAsync**(): Task — Returns the width of the category grouping this series is in. -- **GetExactItemIndex**(world: Point): double -- **GetExactItemIndexAsync**(world: Point): Task — Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex. -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemIndex**(world: Point): int -- **GetItemIndexAsync**(world: Point): Task — Gets the index of the item that resides at the provided world coordinates. -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **GetNextOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetNextOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetOffsetValue**(): double -- **GetOffsetValueAsync**(): Task — Returns the offset value for this series if grouped on a category axis. -- **GetPreviousOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetPreviousOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetSeriesCloseValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesCloseValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesCloseValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesCloseValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesHighValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesHighValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesHighValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesHighValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesLowValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesLowValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesLowValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesLowValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesOpenValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesOpenValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesOpenValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesOpenValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesVolumeValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesVolumeValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesVolumeValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesVolumeValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **SetNegativeColors**(negativeBrush: string, negativeOutline: string): void -- **SetNegativeColorsAsync**(negativeBrush: string, negativeOutline: string): Task - -### [IgbFloatPaneAction](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFloatPaneAction) - -- **constructor**(): void -- **ActionType**: `PaneDragActionType` -- **Height**: `double` -- **Location**: `IgbDockManagerPoint` -- **Type**: `string` -- **Width**: `double` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFloatPaneActionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFloatPaneActionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFloatingPaneResizeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFloatingPaneResizeEventArgs) - -- **constructor**(): void -- **Detail**: `IgbFloatingPaneResizeEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFloatingPaneResizeEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFloatingPaneResizeEventArgsDetail) - -- **constructor**(): void -- **ResizerLocation**: `ResizerLocation` — Gets the edge/corner that is being dragged. -- **SourcePane**: `IgbSplitPane` — Gets the source pane that triggers the resize operation. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFloatingPaneResizeMoveEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFloatingPaneResizeMoveEventArgs) - -- **constructor**(): void -- **Detail**: `IgbFloatingPaneResizeMoveEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFloatingPaneResizeMoveEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFloatingPaneResizeMoveEventArgsDetail) - -- **constructor**(): void -- **NewHeight**: `double` — Gets the pane's height after the resizing operation. -- **NewLocation**: `IgbDockManagerPoint` — Gets the pane's floating location after the resizing operation. -- **NewWidth**: `double` — Gets the pane's width after the resizing operation. -- **OldHeight**: `double` — Gets the pane's height before the resizing operation. -- **OldLocation**: `IgbDockManagerPoint` — Gets the pane's floating location before the resizing operation. -- **OldWidth**: `double` — Gets the pane's width before the resizing operation. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFocusOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFocusOptions) - -- **constructor**(): void -- **PreventScroll**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbForOfDataChangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbForOfDataChangeEventArgs) - -- **constructor**(): void -- **Detail**: `IgbForOfDataChangeEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbForOfDataChangeEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbForOfDataChangeEventArgsDetail) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbForOfDataChangingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbForOfDataChangingEventArgs) - -- **constructor**(): void -- **Detail**: `IgbForOfDataChangingEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbForOfDataChangingEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbForOfDataChangingEventArgsDetail) - -- **constructor**(): void -- **ContainerSize**: `double` -- **State**: `IgbForOfState` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbForOfState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbForOfState) - -- **constructor**(): void -- **ChunkSize**: `double` -- **StartIndex**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbForOfStateDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbForOfStateDetail) - -- **constructor**(): void -- **ChunkSize**: `double` -- **StartIndex**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbForOfStateEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbForOfStateEventArgs) - -- **constructor**(): void -- **Detail**: `IgbForOfStateDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbForceIndexIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbForceIndexIndicator) -Represents a IgbDataChart Force Index indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current AverageTrueRangeSeries object. The typical, and initial, value for ForceIndiex periods is 0. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbForceIndexIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbForceIndexIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFormatCellEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFormatCellEventArgs) - -- **constructor**(): void -- **IsGroup**: `bool` — The cell is part of a grouping row. -- **IsSummary**: `bool` — The cell is part of a summary row. -- **Item**: `object` — Gets the data item associated with the cell. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Row**: `int` — Gets the row index of the cell to format. -- **Text**: `string` — Sets the formatted text to display in the cell. -- **Type**: `string` -- **Value**: `object` — Gets the value that is to be displayed in the cell. -- **ValueScript**: `string` — Provides a means of setting Value in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFormatGroupTextEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFormatGroupTextEventArgs) - -- **constructor**(): void -- **FormattedText**: `string` — Gets or sets the final text that will be displayed in the group header. -- **FormattedValue**: `string` — Gets the group value as text, formatted based on the GroupDescription's ValueFormat. -- **GroupName**: `string` — Gets the group name. -- **GroupValue**: `object` — Gets the original value before formatting. -- **GroupValueScript**: `string` — Provides a means of setting GroupValue in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFormatLinearGraphLabelEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFormatLinearGraphLabelEventArgs) -Represents event argument for FormatLinearGraphLabel. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFormatRadialGaugeLabelEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFormatRadialGaugeLabelEventArgs) -Represents event argument for FormatRadialGaugeLabel. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFormatSpecifier](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFormatSpecifier) - -- **constructor**(): void -- **AxisParent**: `BaseRendererElement` -- **DateTimeColumnParent**: `BaseRendererElement` -- **HorizontalLabelFormatSpecifiersParent**: `BaseRendererElement` -- **LegendLabelFormatSpecifiersParent**: `BaseRendererElement` -- **LegendOthersLabelFormatSpecifiersParent**: `BaseRendererElement` -- **LinearGraphParent**: `BaseRendererControl` -- **NumericColumnParent**: `BaseRendererElement` -- **OthersLabelFormatSpecifiersParent**: `BaseRendererElement` -- **PieChartBaseParent**: `BaseRendererControl` -- **RadialGaugeParent**: `BaseRendererControl` -- **RingSeriesBaseParent**: `BaseRendererElement` -- **Type**: `string` -- **VerticalLabelFormatSpecifiersParent**: `BaseRendererElement` -- **XAxisLabelFormatSpecifiersParent**: `BaseRendererElement` -- **YAxisLabelFormatSpecifiersParent**: `BaseRendererElement` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **GetLocalCulture**(): string -- **GetLocalCultureAsync**(): Task -- **OnInitializedAsync**(): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFormatSpecifierCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFormatSpecifierCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbFormatSpecifierModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFormatSpecifierModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFormatSummaryTextEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFormatSummaryTextEventArgs) - -- **constructor**(): void -- **DisplayName**: `string` — Gets the summary display name. -- **Field**: `string` — Gets the summary property name. -- **FormattedResult**: `string` — Gets or sets the summary value as formatted text. Setting this property will only affect summary cells. -- **FormattedText**: `string` — Gets or sets the final text that will be displayed in the group header. -- **SummaryResult**: `object` — Gets the original value before formatting. -- **SummaryResultScript**: `string` — Provides a means of setting SummaryResult in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFragmentBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFragmentBase) -Represents one part of a stacked series. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task - -### [IgbFullStochasticOscillatorIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFullStochasticOscillatorIndicator) -Represents a IgbDataChart Full Stochastic Oscillator indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current FullStochasticOscillatorIndicator object. The typical, and initial, value for FullStochasticOscillatorIndicator periods is 14. -- **SmoothingPeriod**: `int` — Gets or sets the moving average SmoothingPeriod for the current FullStochasticOscillatorIndicator object. The typical, and initial, value for FullStochasticOscillatorIndicator SmoothingPeriod is 3. -- **TriggerPeriod**: `int` — Gets or sets the moving average TriggerPeriod for the current FullStochasticOscillatorIndicator object. The typical, and initial, value for FullStochasticOscillatorIndicator TriggerPeriod is 3. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbFullStochasticOscillatorIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFullStochasticOscillatorIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFunctionFilterExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFunctionFilterExpression) -Represents a filter expression that is a function applied to some parameter expressions. - -- **constructor**(): void -- **FunctionArguments**: `IgbFilterExpressionCollection` — Gets the arguments of the function. -- **FunctionType**: `FilterExpressionFunctionType` — Gets or sets the function type of the function. -- **HasFunctionArguments**: `bool` — Gets whether the expression has arguments specified. -- **IsFunction**: `bool` — Gets if the expression is a function expression. -- **Precedence**: `int` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFunnelChart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFunnelChart) -Represents a funnel chart. - -- **constructor**(): void -- **ActualHighlightValueDisplayMode**: `HighlightedValueDisplayMode` — Gets whether and how to display the highlighted value. -- **ActualHighlightValueOpacity**: `double` — Gets the actual opacity of the primary needle while highlighting -- **AllowSliceSelection**: `bool` — Gets or sets whether to allow slices to be selected. -- **BottomEdgeWidth**: `double` — Gets or sets the percentage (from near 0 to 1) of space the bottom edge of the funnel should take. -- **Brushes**: `string` — Gets or sets the palette of brushes to use for coloring the slices. -- **DataSource**: `object` — Gets or sets the ItemsSource for the funnel chart. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **FormatInnerLabel**: `string` — Gets or sets the formatter function for inner labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to the funnel chart. -- **FormatInnerLabelScript**: `string` — Provides a means of setting FormatInnerLabel in the JavaScript environment. -- **FormatOuterLabel**: `string` — Gets or sets the formatter function for outer labels. Function should return string and it takes 3 parameters: 1st-value of item to format, 2nd-index of item within data, 3rd-reference to the funnel chart. -- **FormatOuterLabelScript**: `string` — Provides a means of setting FormatOuterLabel in the JavaScript environment. -- **FunnelSliceDisplay**: `FunnelSliceDisplay` — Gets or sets how the heights of the funnel slices should be configured. -- **HighlightValueDisplayMode**: `HighlightedValueDisplayMode` — Gets or sets whether and how to display the highlighted value. -- **HighlightValueOpacity**: `double` — Gets or sets the opacity while highlighting -- **HighlightedValueMemberPath**: `string` — Gets or sets the highlighted value member path for the funnel chart. -- **InnerLabelMemberPath**: `string` — Gets or sets the InnerLabel mapping property for the current series object. -- **InnerLabelVisibility**: `Visibility` — Gets or sets whether the inner labels are visible. -- **IsInverted**: `bool` — Gets or sets if the funnel should be rendered inverted. -- **LegendItemBadgeTemplate**: `object` — Gets or sets the LegendItemBadgeTemplate to use for the legend items. -- **LegendItemBadgeTemplateScript**: `string` — Provides a means of setting LegendItemBadgeTemplate in the JavaScript environment. -- **OuterLabelAlignment**: `OuterLabelAlignment` — Gets or sets which side of the chart the outer labels should appear. -- **OuterLabelMemberPath**: `string` — Gets or sets the OuterLabel mapping property for the current series object. -- **OuterLabelTextColor**: `string` — Gets or sets the brush used for the outer labels. -- **OuterLabelTextStyle**: `string` — Gets or sets the text style for outer labels -- **OuterLabelVisibility**: `Visibility` — Gets or sets whether the outer labels are visible. -- **OutlineThickness**: `double` — Gets or sets the thickness of outline around slices. -- **Outlines**: `string` — Gets or sets the palette of brushes to use for outlines on the slices. -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **SelectedItems**: `IgbFunnelChartSelectedItemsCollection` — Represents the current selected items. -- **SelectedItemsChanged**: `EventCallback` -- **SelectedItemsChangedScript**: `string` -- **SelectedSliceFill**: `string` — Gets or sets the fill brush. -- **SelectedSliceOpacity**: `double` — Gets or sets the opacity. -- **SelectedSliceStroke**: `string` — Gets or sets the stroke brush. -- **SelectedSliceStrokeThickness**: `double` — Gets or sets the stroke thickness. -- **SliceClicked**: `EventCallback` -- **SliceClickedScript**: `string` -- **SliceEnter**: `EventCallback` -- **SliceEnterScript**: `string` -- **SliceHover**: `EventCallback` -- **SliceHoverScript**: `string` -- **SliceLeave**: `EventCallback` -- **SliceLeaveScript**: `string` -- **TextColor**: `string` — Gets or sets the brush used for the inner labels. -- **TextStyle**: `string` — Gets or sets the text style for inner labels -- **TransitionDuration**: `int` — Gets or sets how long the animations should take to run. -- **Type**: `string` -- **UnselectedSliceFill**: `string` — Gets or sets the fill brush. -- **UnselectedSliceOpacity**: `double` — Gets or sets the opacity. -- **UnselectedSliceStroke**: `string` — Gets or sets the stroke brush. -- **UnselectedSliceStrokeThickness**: `double` — Gets or sets the stroke thickness. -- **UseBezierCurve**: `bool` — Gets or sets whether to use a Bezier curve to define the funnel. -- **UseOuterLabelsForLegend**: `bool` — Gets or sets whether to use the outer labels to identify the legend items. -- **UseUnselectedStyle**: `bool` — Gets or sets whether to use the unselected style on unselected slices. -- **ValueMemberPath**: `string` — Gets or sets the value member path for the funnel chart. -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Exports and serializes the chart visuals. -- **FindByName**(name: string): object -- **Flush**(): void -- **FlushAsync**(): Task — Use to force the funnel chart to finish any deferred work before printing or evaluating its visual. -- **GetCurrentSelectedItems**(): IgbFunnelChartSelectedItemsCollection -- **GetCurrentSelectedItemsAsync**(): Task -- **NotifyClearItems**(source_: object): void -- **NotifyClearItemsAsync**(source_: object): Task — Manually notifies the chart's data source that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the chart is bound to is already observable. -- **NotifyInsertItem**(source_: object, index: int, newItem: object): void -- **NotifyInsertItemAsync**(source_: object, index: int, newItem: object): Task -- **NotifyRemoveItem**(source_: object, index: int, oldItem: object): void -- **NotifyRemoveItemAsync**(source_: object, index: int, oldItem: object): Task -- **NotifyResized**(): void -- **NotifyResizedAsync**(): Task — Notifies the controller and view about a size change. -- **NotifySetItem**(source_: object, index: int, oldItem: object, newItem: object): void -- **NotifySetItemAsync**(source_: object, index: int, oldItem: object, newItem: object): Task -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task — Provides container for funnel chart -- **ToggleSelection**(index: int): void -- **ToggleSelectionAsync**(index: int): Task — Toggle selection of item at index. - -### [IgbFunnelChartCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFunnelChartCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFunnelChartModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFunnelChartModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbFunnelChartSelectedItemsChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFunnelChartSelectedItemsChangedEventArgs) -Provides data for the SelectedItemsChanged event. - -- **constructor**(): void -- **CurrentItems**: `IgbFunnelChartSelectedItemsCollection` — A list of the current items selected. -- **NewItems**: `IgbFunnelChartSelectedItemsCollection` — A list of the items being selected. -- **OldItems**: `IgbFunnelChartSelectedItemsCollection` — A list of the previously selected items. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFunnelChartSelectedItemsCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFunnelChartSelectedItemsCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbFunnelDataContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFunnelDataContext) -Represents contextual data for the funnel chart. - -- **constructor**(): void -- **Index**: `int` — The index of the data item that is in context. -- **Item**: `object` — The data item that is in context. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbFunnelSliceClickedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFunnelSliceClickedEventArgs) -Information about the clicked slice. - -- **constructor**(): void -- **Bounds**: `Rect` — The bounds of the slice. -- **Index**: `int` — The index of the clicked slice. -- **Item**: `object` — The data item for the clicked slice. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFunnelSliceDataContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFunnelSliceDataContext) -Represents the funnel slice data currently in context. - -- **constructor**(): void -- **ItemOutline**: `string` — Gets or sets the Outline to use to color the item. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbFunnelSliceEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbFunnelSliceEventArgs) -Information about the clicked slice. - -- **constructor**(): void -- **Bounds**: `Rect` — The bounds of the slice. -- **Index**: `int` — The index of the slice. -- **Item**: `object` — The data item for the clicked slice. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Position**: `Point` — The position of the mouse relative to the funnel chart. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGenericInternalVirtualDataSource](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGenericInternalVirtualDataSource) - -- **constructor**(): void -- **IsAggregationSupported**: `bool` -- **IsClone**: `bool` -- **PageRequested**: `EventCallback` -- **PageRequestedScript**: `string` -- **Type**: `string` -- **AddSchemaProperty**(propertyName: string, propertyType: GenericDataSourceSchemaPropertyType): void -- **AddSchemaPropertyAsync**(propertyName: string, propertyType: GenericDataSourceSchemaPropertyType): Task -- **AddSummaryDate**(propertyName: string, operand: DataSourceSummaryOperand, value: DateTime): void -- **AddSummaryDateAsync**(propertyName: string, operand: DataSourceSummaryOperand, value: DateTime): Task -- **AddSummaryDouble**(propertyName: string, operand: DataSourceSummaryOperand, value: double): void -- **AddSummaryDoubleAsync**(propertyName: string, operand: DataSourceSummaryOperand, value: double): Task -- **AddSummaryInt**(propertyName: string, operand: DataSourceSummaryOperand, value: int): void -- **AddSummaryIntAsync**(propertyName: string, operand: DataSourceSummaryOperand, value: int): Task -- **AddSummaryString**(propertyName: string, operand: DataSourceSummaryOperand, value: string): void -- **AddSummaryStringAsync**(propertyName: string, operand: DataSourceSummaryOperand, value: string): Task -- **Clone**(): DataSource -- **CloneAsync**(): Task — Clones this data source instance, copying the summary, grouping, filter and sorting settings into the new instance. -- **FillColumnBool**(column: string, values: bool[]): void -- **FillColumnBoolAsync**(column: string, values: bool[]): Task -- **FillColumnDate**(column: string, values: DateTime[]): void -- **FillColumnDateAsync**(column: string, values: DateTime[]): Task -- **FillColumnDouble**(column: string, values: double[]): void -- **FillColumnDoubleAsync**(column: string, values: double[]): Task -- **FillColumnInt**(column: string, values: int[]): void -- **FillColumnIntAsync**(column: string, values: int[]): Task -- **FillColumnString**(column: string, values: string[]): void -- **FillColumnStringAsync**(column: string, values: string[]): Task -- **FillCount**(count: int): void -- **FillCountAsync**(count: int): Task — Provides the row count for the datasource. The datasource obtains this from the page request so be must be called after FillPageStart. -- **FillGroupEnd**(): void -- **FillGroupEndAsync**(): Task — Ends the current group. -- **FillGroupStart**(startIndex: int, endIndex: int): void -- **FillGroupStartAsync**(startIndex: int, endIndex: int): Task -- **FillGroupValueDate**(propertyName: string, value: DateTime): void -- **FillGroupValueDateAsync**(propertyName: string, value: DateTime): Task -- **FillGroupValueDouble**(propertyName: string, value: double): void -- **FillGroupValueDoubleAsync**(propertyName: string, value: double): Task -- **FillGroupValueInt**(propertyName: string, value: int): void -- **FillGroupValueIntAsync**(propertyName: string, value: int): Task -- **FillGroupValueString**(propertyName: string, value: string): void -- **FillGroupValueStringAsync**(propertyName: string, value: string): Task -- **FillPageEnd**(): void -- **FillPageEndAsync**(): Task — Ends the current page. Must be called after FillPageStart. -- **FillPageStart**(requestId: int): void -- **FillPageStartAsync**(requestId: int): Task — Starts filling a page for the specified request. Must later be followed by FillPageEnd to complete the request. -- **FindByName**(name: string): object - -### [IgbGenericVirtualDataSource](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGenericVirtualDataSource) - -- **constructor**(): void -- **PageRequested**: `Action` -- **PageRequestedScript**: `string` -- **Type**: `string` -- **AddSchemaProperty**(propertyName: string, propertyType: GenericDataSourceSchemaPropertyType): void -- **AddSchemaPropertyAsync**(propertyName: string, propertyType: GenericDataSourceSchemaPropertyType): Task -- **AddSummaryDate**(propertyName: string, operand: DataSourceSummaryOperand, value: DateTime): void -- **AddSummaryDateAsync**(propertyName: string, operand: DataSourceSummaryOperand, value: DateTime): Task -- **AddSummaryDouble**(propertyName: string, operand: DataSourceSummaryOperand, value: double): void -- **AddSummaryDoubleAsync**(propertyName: string, operand: DataSourceSummaryOperand, value: double): Task -- **AddSummaryInt**(propertyName: string, operand: DataSourceSummaryOperand, value: int): void -- **AddSummaryIntAsync**(propertyName: string, operand: DataSourceSummaryOperand, value: int): Task -- **AddSummaryString**(propertyName: string, operand: DataSourceSummaryOperand, value: string): void -- **AddSummaryStringAsync**(propertyName: string, operand: DataSourceSummaryOperand, value: string): Task -- **FillColumnBool**(column: string, values: bool[]): void -- **FillColumnBoolAsync**(column: string, values: bool[]): Task -- **FillColumnDate**(column: string, values: DateTime[]): void -- **FillColumnDateAsync**(column: string, values: DateTime[]): Task -- **FillColumnDouble**(column: string, values: double[]): void -- **FillColumnDoubleAsync**(column: string, values: double[]): Task -- **FillColumnInt**(column: string, values: int[]): void -- **FillColumnIntAsync**(column: string, values: int[]): Task -- **FillColumnString**(column: string, values: string[]): void -- **FillColumnStringAsync**(column: string, values: string[]): Task -- **FillCount**(count: int): void -- **FillCountAsync**(count: int): Task — Provides the row count for the datasource. The datasource obtains this from the page request so be must be called after FillPageStart. -- **FillGroupEnd**(): void -- **FillGroupEndAsync**(): Task — Ends the current group. -- **FillGroupStart**(startIndex: int, endIndex: int): void -- **FillGroupStartAsync**(startIndex: int, endIndex: int): Task -- **FillGroupValueDate**(propertyName: string, value: DateTime): void -- **FillGroupValueDateAsync**(propertyName: string, value: DateTime): Task -- **FillGroupValueDouble**(propertyName: string, value: double): void -- **FillGroupValueDoubleAsync**(propertyName: string, value: double): Task -- **FillGroupValueInt**(propertyName: string, value: int): void -- **FillGroupValueIntAsync**(propertyName: string, value: int): Task -- **FillGroupValueString**(propertyName: string, value: string): void -- **FillGroupValueStringAsync**(propertyName: string, value: string): Task -- **FillPageEnd**(): void -- **FillPageEndAsync**(): Task — Ends the current page. Must be called after FillPageStart. -- **FillPageStart**(requestId: int): void -- **FillPageStartAsync**(requestId: int): Task — Starts filling a page for the specified request. Must later be followed by FillPageEnd to complete the request. -- **FindByName**(name: string): object - -### [IgbGenericVirtualDataSourceModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGenericVirtualDataSourceModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGeographicContourLineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicContourLineSeries) -Represents a class for Geographic Contour Series displayed on a map. - -- **constructor**(): void -- **ActualFillScale**: `IgbValueBrushScale` — Gets actual fill scale that is set on the FillScale property or default FillScale -- **FillScale**: `IgbValueBrushScale` — The ValueBrushScale to use when determining Brushes for each contour line, based on the values found in ValueMemberPath. -- **TriangulationStatusChanged**: `EventCallback` -- **TriangulationStatusChangedScript**: `string` -- **Type**: `string` -- **ValueMemberPath**: `string` — The name of the property from which to retrieve the numeric values from the ItemsSource items. -- **ValueResolver**: `IgbContourValueResolver` — The ContourValueResolver used to determine the numeric values of contours. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGeographicContourLineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicContourLineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGeographicHighDensityScatterSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicHighDensityScatterSeries) -Series class for a geographic map with points marked at given locations. - -- **constructor**(): void -- **HeatMaximum**: `double` — Gets or sets the value that maps to the maximum heat color. -- **HeatMaximumColor**: `string` — Gets or sets the color to use for the maximum end of the scale. -- **HeatMinimum**: `double` — Gets or sets the density value that maps to the minimum heat color. -- **HeatMinimumColor**: `string` — Gets or sets the color to use for the minimum end of the scale. -- **LatitudeMemberPath**: `string` — The name of the property of ItemsSource items which contains the latitude coordinate of the symbol. -- **LongitudeMemberPath**: `string` — The name of the property of ItemsSource items which contains the longitude coordinate of the symbol. -- **PointExtent**: `int` — Gets or sets the the pixel extent of the square data points that are rendered. -- **ProgressiveLoad**: `bool` — Gets or sets the whether to progressively load the data into the chart. -- **ProgressiveLoadStatusChanged**: `EventCallback` -- **ProgressiveLoadStatusChangedScript**: `string` -- **ProgressiveStatus**: `int` — Represents the current status of the progressive load of the series. It will range from 0 to 100, where 100 is fully loaded. -- **Type**: `string` -- **UseBruteForce**: `bool` — Gets or sets the whether to use use brute force mode. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGeographicHighDensityScatterSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicHighDensityScatterSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGeographicMap](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicMap) -Represents the Infragistics IgbGeographicMap control. - -- **constructor**(): void -- **ActualWindowScale**: `double` — A number between 0 and 1 determining the scale of the horizontal/vertical zoom. -- **ActualWorldRect**: `Rect` — Gets the actual value of the WorldRect. -- **BackgroundContent**: `IgbGeographicMapImagery` — A UIElement to display behind all series, inside the viewport of the IgbGeographicMap control. -- **BackgroundTilingMode**: `MapBackgroundTilingMode` — Gets or sets if the map should horizontally wrap. -- **ImageTilesReady**: `Action` -- **ImageTilesReadyScript**: `string` -- **IsHorizontalWrappingEnabled**: `bool` — Gets or sets if the map should horizontally wrap. -- **NeedsDynamicContent**: `bool` -- **ResizeBehavior**: `MapResizeBehavior` — Gets or sets the behavior to use during resize. -- **SuppressZoomResetOnWorldRectChange**: `bool` — Gets or sets whether skip resetting the zoom when the world rect changes. -- **Type**: `string` -- **UseWorldRectForZoomBounds**: `bool` — Gets or sets whether to use the uncoerced world rect to constrain the zoom bounds. -- **WindowScale**: `double` — A number between 0 and 1 determining the scale of the horizontal/vertical zoom. -- **WorldRect**: `Rect` — Gets or sets the world bounding rectangle. -- **Zoomable**: `bool` — Gets or sets zoomability of the current control -- **ClearTileCache**(): void -- **ClearTileCacheAsync**(): Task — Removes all cached tile images from the map imagery assigned to the map's background content. -- **ConvertGeographicToZoom**(geographic: Rect, extraPixelPadding: double): Rect -- **ConvertGeographicToZoomAsync**(geographic: Rect, extraPixelPadding: double): Task -- **DeferredRefresh**(): void -- **DeferredRefreshAsync**(): Task — Calls for a deferred refresh to the GeographicMap's background. -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task — Returns the chart visuals expressed as a ChartVisualData object. -- **FindByName**(name: string): object -- **GetActualWindowScaleHorizontal**(): double -- **GetActualWindowScaleHorizontalAsync**(): Task — Gets actual window scale for horizontal dimension of the control -- **GetActualWindowScaleVertical**(): double -- **GetActualWindowScaleVerticalAsync**(): Task — Gets actual window scale for vertical dimension of the control -- **GetCurrentActualWorldRect**(): Rect -- **GetCurrentActualWorldRectAsync**(): Task — Gets current world rect in geographic coordinates -- **GetGeographicFromZoom**(windowRect: Rect): Rect -- **GetGeographicFromZoomAsync**(windowRect: Rect): Task — Given a WindowRect and the current plot area, get the geographic region represented by that WindowRect. -- **GetGeographicPoint**(pixelCoordinate: Point): Point -- **GetGeographicPointAsync**(pixelCoordinate: Point): Task — Convert a pixel-based coordinate to a geographic coordinate. -- **GetPixelPoint**(geographicCoordinate: Point): Point -- **GetPixelPointAsync**(geographicCoordinate: Point): Task — Convert a geographic coordinate to a pixel-based coordinate. -- **GetWindowPoint**(geographicCoordinate: Point): Point -- **GetWindowPointAsync**(geographicCoordinate: Point): Task — Convert a geographic coordinate to a pixel-based coordinate. -- **GetZoomFromGeographicPoints**(northWest: Point, southEast: Point): Rect -- **GetZoomFromGeographicPointsAsync**(northWest: Point, southEast: Point): Task -- **GetZoomFromGeographicRect**(geographic: Rect): Rect -- **GetZoomFromGeographicRectAsync**(geographic: Rect): Task — Given the current plot area of the control and a geographic region, get the WindowRect that would encompass that geographic region. -- **GetZoomRectFromGeoRect**(geographic: Rect): Rect -- **GetZoomRectFromGeoRectAsync**(geographic: Rect): Task — Given the current plot area of the control and a geographic region, get the WindowRect that would encompass that geographic region. -- **StyleUpdated**(): void -- **StyleUpdatedAsync**(): Task — Notifies the chart that the CSS styles in effect have been updated. -- **UpdateWorldRect**(worldRect: Rect): void -- **UpdateWorldRectAsync**(worldRect: Rect): Task — Updates world rect in geographic coordinates -- **UpdateZoomWindow**(zoomWindow: Rect): void -- **UpdateZoomWindowAsync**(zoomWindow: Rect): Task — Updates zoom window using window coordinates -- **ZoomToGeographic**(geographic: Rect): void -- **ZoomToGeographicAsync**(geographic: Rect): Task — Zoom in to the geographic region specified, when possible (may need to wait for map to be initialized). - -### [IgbGeographicMapCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicMapCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGeographicMapDashboardTileModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicMapDashboardTileModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGeographicMapImagery](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicMapImagery) -Control class used for displaying multi-scale TileSource imagery. Designed to be used for background imagery in the IgbGeographicMap. - -- **constructor**(): void -- **CancellingImage**: `Action` -- **CancellingImageScript**: `string` -- **DownloadingImage**: `Action` -- **DownloadingImageScript**: `string` -- **ImageTilesReady**: `EventCallback` -- **ImageTilesReadyScript**: `string` -- **ImagesChanged**: `Action` -- **ImagesChangedScript**: `string` -- **IsHorizontalWrappingEnabled**: `bool` — Gets or sets if horizontal wrapping is enabled for the imagery. -- **Opacity**: `double` -- **Referer**: `string` — Gets or sets the referer sent in the headers of the tile request. -- **Type**: `string` -- **UserAgent**: `string` — Gets or sets the UserAgent sent in the headers of the tile request. -- **WindowRect**: `Rect` — A rectangle representing the portion of the map imagery currently in view. -- **ClearTileCache**(): void -- **ClearTileCacheAsync**(): Task — Removes all cached tile Imagery from the -- **FindByName**(name: string): object - -### [IgbGeographicMapModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicMapModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGeographicMapSeriesHost](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicMapSeriesHost) -Base class for hosting chart series in a IgbGeographicMap. - -- **constructor**(): void -- **CoercionMethods**: `object` — Gets or sets the coercion methods to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be reimported into the chart. -- **CoercionMethodsScript**: `string` — Provides a means of setting CoercionMethods in the JavaScript environment. -- **Type**: `string` -- **VisibleFromScale**: `double` — The minimum scale at which this series becomes visible. -- **FindByName**(name: string): object -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemSpan**(): double -- **GetItemSpanAsync**(): Task — For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **GetNextOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetNextOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetPreviousOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetPreviousOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetSeriesHighValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesHighValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesHighValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesHighValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesLowValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesLowValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesLowValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesLowValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValueBoundingBox**(world: Point): Rect -- **GetSeriesValueBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. -- **GetSeriesValueFromSeriesPixel**(mouse: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueFromSeriesPixelAsync**(mouse: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValueMarkerBoundingBox**(world: Point): Rect -- **GetSeriesValueMarkerBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided. -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValuePositionFromSeriesPixel**(mouse: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionFromSeriesPixelAsync**(mouse: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **NotifyIndexedPropertiesChanged**(): void -- **NotifyIndexedPropertiesChangedAsync**(): Task — Called to notify about changes to indexed-based properties, e.g. Brushes, Outlines, MarkerBrushes, MarkerOutlines and refresh series -- **RenderSeries**(animate: bool): void -- **RenderSeriesAsync**(animate: bool): Task — Renders the series. -- **StyleUpdated**(): void -- **StyleUpdatedAsync**(): Task — Called when this series' Style is updated. - -### [IgbGeographicMarkerSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicMarkerSeries) -Base class for creating marker series in a IgbGeographicMap. - -- **constructor**(): void -- **ActualMarkerBrush**: `string` — Gets the effective marker brush for the current series object. -- **ActualMarkerOutline**: `string` — Gets the effective marker outline for the current series object. -- **ActualMarkerTemplate**: `object` — Gets the effective marker template for the current series object. -- **ActualMarkerTemplateScript**: `string` — Provides a means of setting ActualMarkerTemplate in the JavaScript environment. -- **MarkerBrush**: `string` — Gets or sets the brush that specifies how the current series object's marker interiors are painted. -- **MarkerFillMode**: `MarkerFillMode` — Gets or sets whether the marker fill is based on the marker outline of the series rather than the marker brushes collection. -- **MarkerOutline**: `string` — Gets or sets the brush that specifies how the current series object's marker outlines are painted. -- **MarkerOutlineMode**: `MarkerOutlineMode` — Gets or sets whether the marker outline is based on the marker brush of the series rather than the marker outlines collection. -- **MarkerTemplate**: `object` — Gets or sets the MarkerTemplate for the current series object. -- **MarkerTemplateScript**: `string` — Provides a means of setting MarkerTemplate in the JavaScript environment. -- **MarkerThickness**: `double` — Gets or sets thickness of the marker outline -- **MarkerType**: `MarkerType` — Gets or sets the marker type for the current series object. -- **MaximumMarkers**: `int` — Gets or sets the maximum number of markerItems displayed by the current series. If more than the specified number of markerItems are visible, the series will automatically choose a representative set. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGeographicMarkerSeriesBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicMarkerSeriesBase) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGeographicPolylineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicPolylineSeries) -Series class used for displaying multiple polylines, in a geographic context, for datasources which contain multiple lists of points. - -- **constructor**(): void -- **ShapeFill**: `string` — Gets or sets the fill brush. -- **ShapeOpacity**: `double` — Gets or sets the opacity. -- **ShapeStroke**: `string` — Gets or sets the stroke brush. -- **ShapeStrokeThickness**: `double` — Gets or sets the stroke thickness. -- **ShapeStyleSelector**: `object` — The StyleSelector which is used to select a style for each Shape. -- **ShapeStyleSelectorScript**: `string` — Provides a means of setting ShapeStyleSelector in the JavaScript environment. -- **StyleShape**: `EventCallback` -- **StyleShapeScript**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGeographicPolylineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicPolylineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGeographicProportionalSymbolSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicProportionalSymbolSeries) -Series class for a geographic map with points marked at given locations. - -- **constructor**(): void -- **AssigningScatterMarkerStyle**: `Action` -- **AssigningScatterMarkerStyleScript**: `string` -- **AssigningScatterStyle**: `Action` -- **AssigningScatterStyleScript**: `string` -- **FillMemberPath**: `string` — Gets or sets the fill mapping property for the current series object. -- **FillScale**: `IgbBrushScale` — Gets or sets the brush scale for the marker brush. -- **FillScaleUseGlobalValues**: `bool` — Gets or sets the whether or not the FillScale uses global values of FillMemberPath of multiple series. This setting applies only if multiple series are using the same FillScale. -- **IsCustomScatterMarkerStyleAllowed**: `bool` — Gets or sets whether this Scatter series should allow custom style overrides of its individual marker visuals. -- **IsCustomScatterStyleAllowed**: `bool` — Gets or sets whether this Scatter series should allow custom style overrides of its individual visuals. -- **ItemSearchMode**: `ScatterItemSearchMode` — Gets or sets the mode the series will use to find the closest point to the cursor. -- **ItemSearchThreshold**: `int` — Gets or sets the threshold to use when searching for items using ItemSearchMode. -- **LabelMemberPath**: `string` — Gets or sets the Label mapping property for the current series object. -- **LatitudeMemberPath**: `string` — The name of the property of ItemsSource items which contains the latitude coordinate of the symbol. -- **LongitudeMemberPath**: `string` — The name of the property of ItemsSource items which contains the longitude coordinate of the symbol. -- **MarkerBrushBrightness**: `double` — Gets or sets brightness of the marker fill. Using negative value will change marker fill to darker color and positive value will change marker fill to brighter color Note you can use any values between minimum value of -1 (darkest fill) and maximum value of 1 (brightest fill) -- **MarkerOutlineBrightness**: `double` — Gets or sets brightness of the marker outline. Using negative value will change marker outline to darker color and positive value will change marker outline to brighter color Note you can use any values between minimum value of -1 (darkest outline) and maximum value of 1 (brightest outline) -- **MarkerOutlineUsesFillScale**: `bool` — Gets or sets whether or not the marker outline should use FillScale like the marker fill does. This setting applies only if the current series has a FillScale set and it overrides MarkerOutline setting. -- **RadiusMemberPath**: `string` — Gets or sets the radius mapping property for the current series object. -- **RadiusScale**: `IgbSizeScale` — Gets or sets the radius size scale for the bubbles. -- **RadiusScaleUseGlobalValues**: `bool` — Gets or sets the whether or not the RadiusScale uses global values of RadiusMemberPath of multiple series. This setting applies only if multiple series are using the same RadiusScale. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGeographicProportionalSymbolSeriesBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicProportionalSymbolSeriesBase) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGeographicProportionalSymbolSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicProportionalSymbolSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGeographicScatterAreaSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicScatterAreaSeries) -Series class which draws a colored 2D surface, in a geographic context, based on a triangulation of XY data with numeric values assigned to each point. - -- **constructor**(): void -- **ActualColorScale**: `IgbColorScale` — Gets actual color scale that is set on ColorScale property or default ColorScale -- **ColorMemberPath**: `string` — The name of the property on each data item containing a numeric value which can be converted to a color by the ColorScale. -- **ColorScale**: `IgbColorScale` — The ColorScale used to resolve the color values of points in the series. -- **TriangulationStatusChanged**: `EventCallback` -- **TriangulationStatusChangedScript**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **UpdateActualColorScale**(): void -- **UpdateActualColorScaleAsync**(): Task — Updates ActualColorScale properties using HostedSeries's ColorScale properties - -### [IgbGeographicScatterAreaSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicScatterAreaSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGeographicShapeSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicShapeSeries) -Series class which renders polygons as Paths, in a geographic context, based on lists of points in the ItemsSource. - -- **constructor**(): void -- **ActualMarkerBrush**: `string` — Gets the effective marker brush for the current series object. -- **ActualMarkerOutline**: `string` — Gets the effective marker outline for the current series object. -- **ActualMarkerTemplate**: `object` — Gets the effective marker template for the current series object. -- **ActualMarkerTemplateScript**: `string` — Provides a means of setting ActualMarkerTemplate in the JavaScript environment. -- **MarkerBrush**: `string` — Gets or sets the brush that specifies how the current series object's marker interiors are painted. -- **MarkerCollisionAvoidance**: `CollisionAvoidanceType` — The desired behavior for markers in this series which are placed too close together for the current view, resulting in a collision. -- **MarkerFillMode**: `MarkerFillMode` — Gets or sets whether the marker brush is based on the marker outline of the series rather than the marker brushes collection. -- **MarkerOutline**: `string` — Gets or sets the brush that specifies how the current series object's marker outlines are painted. -- **MarkerOutlineMode**: `MarkerOutlineMode` — Gets or sets whether the marker outline is based on the marker brush of the series rather than the marker outlines collection. -- **MarkerTemplate**: `object` — Gets or sets the MarkerTemplate for the current series object. -- **MarkerTemplateScript**: `string` — Provides a means of setting MarkerTemplate in the JavaScript environment. -- **MarkerThickness**: `double` — Gets or sets thickness of the marker outline -- **MarkerType**: `MarkerType` — Gets or sets the marker type for the current series object. -- **ShapeFill**: `string` — Gets or sets the fill brush. -- **ShapeOpacity**: `double` — Gets or sets the opacity. -- **ShapeStroke**: `string` — Gets or sets the stroke brush. -- **ShapeStrokeThickness**: `double` — Gets or sets the stroke thickness. -- **ShapeStyleSelector**: `object` — The StyleSelector which is used to select a style for each Shape. -- **ShapeStyleSelectorScript**: `string` — Provides a means of setting ShapeStyleSelector in the JavaScript environment. -- **StyleShape**: `EventCallback` -- **StyleShapeScript**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGeographicShapeSeriesBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicShapeSeriesBase) -Base class for series which render polygons on a map. - -- **constructor**(): void -- **AssigningShapeMarkerStyle**: `Action` -- **AssigningShapeMarkerStyleScript**: `string` -- **AssigningShapeStyle**: `Action` -- **AssigningShapeStyleScript**: `string` -- **FillMemberPath**: `string` — Gets or sets the fill mapping property for the current series object. -- **FillScale**: `IgbBrushScale` — Gets or sets the brush scale for the fill brush of markers. -- **FillScaleUseGlobalValues**: `bool` — Gets or sets whether or not the FillScale uses global min/max values of FillMemberPath from multiple series. This setting applies only if multiple series are using the same FillScale. -- **IsCustomShapeMarkerStyleAllowed**: `bool` — Gets or sets whether this Shape series should allow custom style overrides of its individual marker visuals. -- **IsCustomShapeStyleAllowed**: `bool` — Gets or sets whether this Shape series should allow custom style overrides of its individual visuals. -- **ItemSearchMode**: `ShapeItemSearchMode` — Gets or sets the mode the series will use to find the closest point to the cursor. -- **ItemSearchPointsThreshold**: `int` — Gets or sets the points threshold to use when searching for items using ItemSearchMode. -- **ItemSearchThreshold**: `int` — Gets or sets the threshold to use when searching for items using ItemSearchMode. -- **ShapeFilterResolution**: `double` — The resolution at which to filter out shapes in the series. For example, if the ShapeFilterResolution is set to 3, then elements with a bounding rectangle smaller than 3 X 3 pixels will be filtered out. -- **ShapeMemberPath**: `string` — The name of the property on ItemsSource items which, for each shape, contains a list of points to be converted to a polygon. -- **ShapefileDataSource**: `IgbShapeDataSource` — Set a shapefile datasource to use with the series. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGeographicShapeSeriesBaseBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicShapeSeriesBaseBase) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGeographicShapeSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicShapeSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGeographicSymbolSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicSymbolSeries) -Series class for a geographic map with points marked at given locations. - -- **constructor**(): void -- **AssigningScatterMarkerStyle**: `Action` -- **AssigningScatterMarkerStyleScript**: `string` -- **AssigningScatterStyle**: `Action` -- **AssigningScatterStyleScript**: `string` -- **IsCustomScatterMarkerStyleAllowed**: `bool` — Gets or sets whether this Scatter series should allow custom style overrides of its individual marker visuals. -- **IsCustomScatterStyleAllowed**: `bool` — Gets or sets whether this Scatter series should allow custom style overrides of its individual visuals. -- **ItemSearchMode**: `ScatterItemSearchMode` — Gets or sets the mode the series will use to find the closest point to the cursor. -- **ItemSearchThreshold**: `int` — Gets or sets the threshold to use when searching for items using ItemSearchMode. -- **LatitudeMemberPath**: `string` — The name of the property of ItemsSource items which contains the latitude coordinate of the symbol. -- **LongitudeMemberPath**: `string` — The name of the property of ItemsSource items which contains the longitude coordinate of the symbol. -- **MarkerCollisionAvoidance**: `CollisionAvoidanceType` — The desired behavior for markers in this series which are placed too close together for the current view, resulting in a collision. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGeographicSymbolSeriesBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicSymbolSeriesBase) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGeographicSymbolSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicSymbolSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGeographicTileSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicTileSeries) -Series class used for displaying a tile set, and using shapes to define the areas that should be rendered. - -- **constructor**(): void -- **ImageTilesReady**: `EventCallback` -- **ImageTilesReadyScript**: `string` -- **TileImagery**: `IgbGeographicMapImagery` — The MapImagery which is used to provide the tiles for display. -- **Type**: `string` -- **ClearTileCache**(): void -- **ClearTileCacheAsync**(): Task — Removes all cached tile Imagery from the -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGeographicTileSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicTileSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGeographicXYTriangulatingSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicXYTriangulatingSeries) -Base class for geographic series which triangulate XY data prior to rendering. - -- **constructor**(): void -- **LatitudeMemberPath**: `string` — The name of the property from which to extract the Latitude for each item in the ItemsSource. -- **LongitudeMemberPath**: `string` — The name of the property from which to extract the Longitude for each item in the ItemsSource. -- **TriangleVertexMemberPath1**: `string` — The name of the property of the TrianglesSource items which, for each triangle, contains the index of the first vertex point in the ItemsSource. -- **TriangleVertexMemberPath2**: `string` — The name of the property of the TrianglesSource items which, for each triangle, contains the index of the second vertex point in the ItemsSource. -- **TriangleVertexMemberPath3**: `string` — The name of the property of the TrianglesSource items which, for each triangle, contains the index of the third vertex point in the ItemsSource. -- **TrianglesSource**: `object` — The source of triangulation data. -- **TrianglesSourceScript**: `string` — Provides a means of setting TrianglesSource in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGeographicXYTriangulatingSeriesBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGeographicXYTriangulatingSeriesBase) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGetTileImageUriArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGetTileImageUriArgs) -Event arguments for GetTileImageUri event - -- **constructor**(): void -- **TileImageUri**: `string` — Gets or sets the tile's image URI -- **TileLevel**: `int` — Gets or sets the tile level. -- **TilePositionX**: `int` — Gets or sets the tile's X position -- **TilePositionY**: `int` — Gets or sets the tile's Y position -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGotFocusEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGotFocusEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGrid](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGrid) - -- **constructor**(): void -- **Data**: `object` -- **DataPreLoad**: `EventCallback` -- **DataPreLoadScript**: `string` -- **DataScript**: `string` — Provides a means of setting Data in the JavaScript environment. -- **DetailTemplate**: `RenderFragment` — Returns a reference to the master-detail template. let detailTemplate = this.grid.detailTemplate; IgxColumnComponent -- **DetailTemplateScript**: `string` — Provides a means of setting DetailTemplate in the JavaScript environment. -- **DropAreaMessage**: `string` -- **DropAreaTemplate**: `RenderFragment` -- **DropAreaTemplateScript**: `string` — Provides a means of setting DropAreaTemplate in the JavaScript environment. -- **GroupByRowSelectorTemplate**: `RenderFragment` — Gets the group by row selector template. -- **GroupByRowSelectorTemplateScript**: `string` — Provides a means of setting GroupByRowSelectorTemplate in the JavaScript environment. -- **GroupRowTemplate**: `RenderFragment` — Gets/Sets the template reference for the group row. const groupRowTemplate = this.grid.groupRowTemplate; this.grid.groupRowTemplate = myRowTemplate; -- **GroupRowTemplateScript**: `string` — Provides a means of setting GroupRowTemplate in the JavaScript environment. -- **GroupStrategy**: `IgbGridGroupingStrategy` -- **GroupingDone**: `EventCallback` -- **GroupingDoneScript**: `string` -- **GroupingExpansionState**: `IgbGroupByExpandState[]` -- **GroupingExpansionStateChange**: `EventCallback` -- **GroupingExpansionStateChangeScript**: `string` -- **GroupingExpressions**: `IgbGroupingExpression[]` -- **GroupingExpressionsChange**: `EventCallback` -- **GroupingExpressionsChangeScript**: `string` -- **GroupsExpanded**: `bool` -- **HideGroupedColumns**: `bool` -- **Id**: `string` -- **ShowGroupArea**: `bool` -- **TotalItemCount**: `double` — Gets/Sets the total number of records in the data source. This property is required for remote grid virtualization to function when it is bound to remote data. const itemCount = this.grid1.totalItemCount; this.grid1.totalItemCount = 55; -- **Type**: `string` -- **BeginAddRowByIndex**(index: double): void -- **BeginAddRowByIndexAsync**(index: double): Task — Enters add mode by spawning the UI at the specified index. Accepted values for index are integers from 0 to this.grid.dataView.length this.grid.beginAddRowByIndex(0); index - The index to spawn the UI at. Accepts integers from 0 to this.grid.dataView.length -- **ClearGrouping**(name: string): void -- **ClearGroupingAsync**(name: string): Task — Clears grouping for particular column, array of columns or all columns. Clears all grouping in the grid, if no parameter is passed. If a parameter is provided, clears grouping for a particular column or an array of columns. this.grid.clearGrouping(); //clears all grouping this.grid.clearGrouping("ID"); //ungroups a single column this.grid.clearGrouping(["ID", "Column1", "Column2"]); //ungroups multiple columns name Name of column or array of column names to be ungrouped. -- **DeselectRowsInGroup**(groupRow: IgbGroupByRecord): void -- **DeselectRowsInGroupAsync**(groupRow: IgbGroupByRecord): Task — Deselect all rows within a group. groupRow The group record which rows would be deselected. public groupRow: IGroupByRecord; this.grid.deselectRowsInGroup(this.groupRow); -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FullyExpandGroup**(groupRow: IgbGroupByRecord): void -- **FullyExpandGroupAsync**(groupRow: IgbGroupByRecord): Task — Expands the specified group and all of its parent groups. groupRow The group record to fully expand. public groupRow: IGroupByRecord; this.grid.fullyExpandGroup(this.groupRow); -- **GetCellByColumn**(rowIndex: double, columnField: string): IgbCellType -- **GetCellByColumnAsync**(rowIndex: double, columnField: string): Task -- **GetCellByKey**(rowSelector: object, columnField: string): IgbCellType -- **GetCellByKeyAsync**(rowSelector: object, columnField: string): Task -- **GetData**(): object -- **GetGroupsRecords**(): IgbGroupByRecord[] -- **GetGroupsRecordsAsync**(): Task -- **GetRowByIndex**(index: double): IgbRowType -- **GetRowByIndexAsync**(index: double): Task — Returns the IgxGridRow by index. const myRow = grid.getRowByIndex(1); index -- **GetRowByKey**(key: object): IgbRowType -- **GetRowByKeyAsync**(key: object): Task — Returns IgxGridRow object by the specified primary key. Requires that the primaryKey property is set. const myRow = this.grid1.getRowByKey("cell5"); keyValue -- **GetSelectedCells**(): IgbCellType[] -- **GetSelectedCellsAsync**(): Task -- **GetSelectedData**(formatters: bool, headers: bool): object[] -- **GetSelectedDataAsync**(formatters: bool, headers: bool): Task -- **GroupBy**(expression: IgbGroupingExpression[]): void -- **GroupByAsync**(expression: IgbGroupingExpression[]): Task -- **IsExpandedGroup**(group: IgbGroupByRecord): bool -- **IsExpandedGroupAsync**(group: IgbGroupByRecord): Task — Returns if a group is expanded or not. group The group record. public groupRow: IGroupByRecord; const expandedGroup = this.grid.isExpandedGroup(this.groupRow); -- **PinRow**(rowID: object, index: double): bool -- **PinRowAsync**(rowID: object, index: double): Task -- **SelectRowsInGroup**(groupRow: IgbGroupByRecord, clearPrevSelection: bool): void -- **SelectRowsInGroupAsync**(groupRow: IgbGroupByRecord, clearPrevSelection: bool): Task -- **ToggleAllGroupRows**(): void -- **ToggleAllGroupRowsAsync**(): Task — Toggles the expansion state of all group rows recursively. this.grid.toggleAllGroupRows; -- **ToggleGroup**(groupRow: IgbGroupByRecord): void -- **ToggleGroupAsync**(groupRow: IgbGroupByRecord): Task — Toggles the expansion state of a group. groupRow The group record to toggle. public groupRow: IGroupByRecord; const toggleExpGroup = this.grid.toggleGroup(this.groupRow); -- **UnpinRow**(rowID: object): bool -- **UnpinRowAsync**(rowID: object): Task - -### [IgbGridActionsBaseDirective](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridActionsBaseDirective) - -- **constructor**(): void -- **ActionStripParent**: `BaseRendererElement` -- **AsMenuItems**: `bool` -- **Type**: `string` -- **Dispose**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGridActionsBaseDirectiveCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridActionsBaseDirectiveCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridActionsBaseDirectiveModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridActionsBaseDirectiveModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridActiveCellChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridActiveCellChangedEventArgs) -Information about the change to the selected cells in the grid. - -- **constructor**(): void -- **NewActiveCell**: `IgbGridCellPosition` — The new active cell. -- **OldActiveCell**: `IgbGridCellPosition` — The old active cell. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridAnimationPhaseSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridAnimationPhaseSettings) -This class is used to group the settings to define an animation phase. - -- **constructor**(): void -- **DesiredSubItemDurationMilliseconds**: `int` — The desired amount of time each item animating should take, in milliseconds -- **DurationMilliseconds**: `int` — The duration of an animation, in milliseconds -- **EasingFunctionType**: `GridEasingFunctionType` — Configures the Easing function used to animate the individual items -- **HoldInitialMilliseconds**: `int` — The amount of time to delay an animation, in milliseconds. -- **PerItemDelayMilliseconds**: `int` — The amount of time to delay each item animating, in milliseconds -- **ShouldItemsFinishSimultaneously**: `bool` — Configures whether all items animating should finish simultaneously -- **SubItemDurationMilliseconds**: `int` — The amount of time each item animating should take, in milliseconds -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGridAnimationSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridAnimationSettings) -Animation settings for the grid. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGridBaseDirective](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridBaseDirective) - -- **constructor**(): void -- **ActionStripComponents**: `IgbActionStripCollection` -- **ActiveNodeChange**: `EventCallback` -- **ActiveNodeChangeScript**: `string` -- **ActualActionStripComponents**: `IgbActionStripCollection` -- **ActualColumnList**: `IgbColumnCollection` -- **ActualPaginationComponents**: `IgbPaginatorCollection` -- **ActualStateComponents**: `IgbStateCollection` -- **ActualToolbar**: `IgbGridToolbarCollection` -- **AddRowEmptyTemplate**: `RenderFragment` -- **AddRowEmptyTemplateScript**: `string` — Provides a means of setting AddRowEmptyTemplate in the JavaScript environment. -- **AdvancedFilteringExpressionsTree**: `IgbFilteringExpressionsTree` — Gets/Sets the advanced filtering state. let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree; this.grid.advancedFilteringExpressionsTree = logic; -- **AdvancedFilteringExpressionsTreeChange**: `EventCallback` -- **AdvancedFilteringExpressionsTreeChangeScript**: `string` -- **AllowAdvancedFiltering**: `bool` -- **AllowFiltering**: `bool` -- **AutoGenerate**: `bool` -- **AutoGenerateExclude**: `string[]` -- **BatchEditing**: `bool` -- **CellClick**: `EventCallback` -- **CellClickScript**: `string` -- **CellEdit**: `EventCallback` -- **CellEditDone**: `Action` -- **CellEditEnter**: `EventCallback` -- **CellEditEnterScript**: `string` -- **CellEditExit**: `EventCallback` -- **CellEditExitScript**: `string` -- **CellEditScript**: `string` -- **CellMergeMode**: `GridCellMergeMode` — Gets/Sets cell merge mode. -- **CellSelection**: `GridSelectionMode` — Gets/Sets cell selection mode. By default the cell selection mode is multiple selectionMode: GridSelectionMode -- **ClipboardOptions**: `IgbClipboardOptions` — Controls the copy behavior of the grid. -- **ColumnInit**: `EventCallback` -- **ColumnInitScript**: `string` -- **ColumnList**: `IgbColumnCollection` -- **ColumnMoving**: `EventCallback` -- **ColumnMovingEnd**: `EventCallback` -- **ColumnMovingEndScript**: `string` -- **ColumnMovingScript**: `string` -- **ColumnMovingStart**: `EventCallback` -- **ColumnMovingStartScript**: `string` -- **ColumnPin**: `EventCallback` -- **ColumnPinScript**: `string` -- **ColumnPinned**: `EventCallback` -- **ColumnPinnedScript**: `string` -- **ColumnResized**: `EventCallback` -- **ColumnResizedScript**: `string` -- **ColumnSelection**: `GridSelectionMode` — Gets/Sets column selection mode By default the row selection mode is none selectionMode: GridSelectionMode -- **ColumnSelectionChanging**: `EventCallback` -- **ColumnSelectionChangingScript**: `string` -- **ColumnVisibilityChanged**: `EventCallback` -- **ColumnVisibilityChangedScript**: `string` -- **ColumnVisibilityChanging**: `EventCallback` -- **ColumnVisibilityChangingScript**: `string` -- **ColumnWidth**: `string` -- **ColumnsAutogenerated**: `EventCallback` -- **ColumnsAutogeneratedScript**: `string` -- **ContentActionStripComponents**: `IgbActionStripCollection` -- **ContentColumnList**: `IgbColumnCollection` -- **ContentPaginationComponents**: `IgbPaginatorCollection` -- **ContentStateComponents**: `IgbStateCollection` -- **ContentToolbar**: `IgbGridToolbarCollection` -- **ContextMenu**: `EventCallback` -- **ContextMenuScript**: `string` -- **DataChanged**: `EventCallback` -- **DataChangedScript**: `string` -- **DataChanging**: `EventCallback` -- **DataChangingScript**: `string` -- **DataCloneStrategy**: `IgbDataCloneStrategy` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DoubleClick**: `EventCallback` -- **DoubleClickScript**: `string` -- **DragGhostCustomTemplate**: `RenderFragment` — Gets the custom template, if any, used for row drag ghost. -- **DragGhostCustomTemplateScript**: `string` — Provides a means of setting DragGhostCustomTemplate in the JavaScript environment. -- **DragIndicatorIconTemplate**: `RenderFragment` — The custom template, if any, that should be used when rendering the row drag indicator icon -- **DragIndicatorIconTemplateScript**: `string` — Provides a means of setting DragIndicatorIconTemplate in the JavaScript environment. -- **EmptyFilteredGridMessage**: `string` -- **EmptyGridMessage**: `string` -- **EmptyGridTemplate**: `RenderFragment` -- **EmptyGridTemplateScript**: `string` — Provides a means of setting EmptyGridTemplate in the JavaScript environment. -- **ExcelStyleHeaderIconTemplate**: `RenderFragment` — Gets the excel style header icon. -- **ExcelStyleHeaderIconTemplateScript**: `string` — Provides a means of setting ExcelStyleHeaderIconTemplate in the JavaScript environment. -- **FilterMode**: `FilterMode` -- **FilterStrategy**: `IgbFilteringStrategy` -- **Filtering**: `EventCallback` -- **FilteringDone**: `EventCallback` -- **FilteringDoneScript**: `string` -- **FilteringExpressionsTree**: `IgbFilteringExpressionsTree` -- **FilteringExpressionsTreeChange**: `EventCallback` -- **FilteringExpressionsTreeChangeScript**: `string` -- **FilteringLogic**: `FilteringLogic` -- **FilteringScript**: `string` -- **FormGroupCreated**: `EventCallback` -- **FormGroupCreatedScript**: `string` -- **GridCopy**: `EventCallback` -- **GridCopyScript**: `string` -- **GridKeydown**: `EventCallback` -- **GridKeydownScript**: `string` -- **GridScroll**: `EventCallback` -- **GridScrollScript**: `string` -- **HeadSelectorTemplate**: `RenderFragment` — Gets the header row selector template. -- **HeadSelectorTemplateScript**: `string` — Provides a means of setting HeadSelectorTemplate in the JavaScript environment. -- **HeaderCollapsedIndicatorTemplate**: `RenderFragment` — Gets the row collapse indicator template. -- **HeaderCollapsedIndicatorTemplateScript**: `string` — Provides a means of setting HeaderCollapsedIndicatorTemplate in the JavaScript environment. -- **HeaderExpandedIndicatorTemplate**: `RenderFragment` — Gets the header expand indicator template. -- **HeaderExpandedIndicatorTemplateScript**: `string` — Provides a means of setting HeaderExpandedIndicatorTemplate in the JavaScript environment. -- **HideRowSelectors**: `bool` — Gets/Sets if the row selectors are hidden. By default row selectors are shown -- **IsLoading**: `bool` -- **ItemRequested**: `Action` -- **LoadingGridTemplate**: `RenderFragment` -- **LoadingGridTemplateScript**: `string` — Provides a means of setting LoadingGridTemplate in the JavaScript environment. -- **Locale**: `string` — Gets/Sets the locale. If not set, returns browser's language. -- **Moving**: `bool` — Controls whether columns moving is enabled in the grid. -- **NeedsDynamicContent**: `bool` -- **Outlet**: `IgbOverlayOutletDirective` — Gets/Sets the outlet used to attach the grid's overlays to. If set, returns the outlet defined outside the grid. Otherwise returns the grid's internal outlet directive. -- **PaginationComponents**: `IgbPaginatorCollection` -- **PagingMode**: `GridPagingMode` -- **ParentTypeName**: `string` -- **Pinning**: `IgbPinningConfig` -- **PrimaryKey**: `string` -- **RangeSelected**: `EventCallback` -- **RangeSelectedScript**: `string` -- **Rendered**: `EventCallback` -- **RenderedScript**: `string` -- **ResourceStrings**: `IgbGridResourceStrings` — Gets/Sets the resource strings. By default it uses EN resources. -- **RowAdd**: `EventCallback` -- **RowAddScript**: `string` -- **RowAddTextTemplate**: `RenderFragment` — Gets the row add text template. -- **RowAddTextTemplateScript**: `string` — Provides a means of setting RowAddTextTemplate in the JavaScript environment. -- **RowAdded**: `Action` -- **RowClasses**: `object` -- **RowClassesScript**: `string` — Provides a means of setting RowClasses in the JavaScript environment. -- **RowClick**: `EventCallback` -- **RowClickScript**: `string` -- **RowCollapsedIndicatorTemplate**: `RenderFragment` — Gets the row collapse indicator template. -- **RowCollapsedIndicatorTemplateScript**: `string` — Provides a means of setting RowCollapsedIndicatorTemplate in the JavaScript environment. -- **RowDelete**: `EventCallback` -- **RowDeleteScript**: `string` -- **RowDeleted**: `Action` -- **RowDragEnd**: `EventCallback` -- **RowDragEndScript**: `string` -- **RowDragStart**: `EventCallback` -- **RowDragStartScript**: `string` -- **RowDraggable**: `bool` -- **RowEdit**: `EventCallback` -- **RowEditActionsTemplate**: `RenderFragment` — Gets the row edit actions template. -- **RowEditActionsTemplateScript**: `string` — Provides a means of setting RowEditActionsTemplate in the JavaScript environment. -- **RowEditDone**: `EventCallback` -- **RowEditDoneScript**: `string` -- **RowEditEnter**: `EventCallback` -- **RowEditEnterScript**: `string` -- **RowEditExit**: `EventCallback` -- **RowEditExitScript**: `string` -- **RowEditScript**: `string` -- **RowEditTextTemplate**: `RenderFragment` — Gets the row edit text template. -- **RowEditTextTemplateScript**: `string` — Provides a means of setting RowEditTextTemplate in the JavaScript environment. -- **RowEditable**: `bool` -- **RowExpandedIndicatorTemplate**: `RenderFragment` — Gets the row expand indicator template. -- **RowExpandedIndicatorTemplateScript**: `string` — Provides a means of setting RowExpandedIndicatorTemplate in the JavaScript environment. -- **RowHeight**: `double` -- **RowPinned**: `EventCallback` -- **RowPinnedScript**: `string` -- **RowPinning**: `EventCallback` -- **RowPinningScript**: `string` -- **RowSelection**: `GridSelectionMode` — Gets/Sets row selection mode By default the row selection mode is 'none' Note that in IgxGrid and IgxHierarchicalGrid 'multipleCascade' behaves like 'multiple' -- **RowSelectionChanging**: `EventCallback` -- **RowSelectionChangingScript**: `string` -- **RowSelectorTemplate**: `RenderFragment` — Gets the row selector template. -- **RowSelectorTemplateScript**: `string` — Provides a means of setting RowSelectorTemplate in the JavaScript environment. -- **RowStyles**: `object` -- **RowStylesScript**: `string` — Provides a means of setting RowStyles in the JavaScript environment. -- **RowToggle**: `EventCallback` -- **RowToggleScript**: `string` -- **SelectRowOnClick**: `bool` — Gets/Sets whether clicking over a row should select/deselect it By default it is set to true enabled: boolean -- **Selected**: `EventCallback` -- **SelectedRows**: `object[]` -- **SelectedRowsChange**: `EventCallback` -- **SelectedRowsChangeScript**: `string` -- **SelectedRowsChanged**: `EventCallback` -- **SelectedScript**: `string` -- **ShouldGenerate**: `bool` — Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid -- **ShowSummaryOnCollapse**: `bool` -- **SnackbarDisplayTime**: `double` — Gets/Sets the display time for the row adding snackbar notification. By default it is 6000ms. -- **SortAscendingHeaderIconTemplate**: `RenderFragment` — The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in asc order. -- **SortAscendingHeaderIconTemplateScript**: `string` — Provides a means of setting SortAscendingHeaderIconTemplate in the JavaScript environment. -- **SortDescendingHeaderIconTemplate**: `RenderFragment` — The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in desc order. -- **SortDescendingHeaderIconTemplateScript**: `string` — Provides a means of setting SortDescendingHeaderIconTemplate in the JavaScript environment. -- **SortHeaderIconTemplate**: `RenderFragment` — Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted. -- **SortHeaderIconTemplateScript**: `string` — Provides a means of setting SortHeaderIconTemplate in the JavaScript environment. -- **SortStrategy**: `IgbGridSortingStrategy` -- **Sorting**: `EventCallback` -- **SortingDone**: `EventCallback` -- **SortingDoneScript**: `string` -- **SortingExpressions**: `IgbSortingExpression[]` -- **SortingExpressionsChange**: `EventCallback` -- **SortingExpressionsChangeScript**: `string` -- **SortingOptions**: `IgbSortingOptions` -- **SortingScript**: `string` -- **StateComponents**: `IgbStateCollection` -- **SummaryCalculationMode**: `GridSummaryCalculationMode` -- **SummaryPosition**: `GridSummaryPosition` -- **SummaryRowHeight**: `double` — Get/Set IgxSummaryRow height -- **Toolbar**: `IgbGridToolbarCollection` -- **ToolbarExporting**: `EventCallback` -- **ToolbarExportingScript**: `string` -- **TotalRecords**: `double` — Returns the total number of records. Only functions when paging is enabled. const totalRecords = this.grid.totalRecords; -- **Type**: `string` -- **ValidationStatusChange**: `EventCallback` -- **ValidationStatusChangeScript**: `string` -- **ValidationTrigger**: `GridValidationTrigger` -- **AddRow**(item: object): void — Adds a new row to the grid. If the grid is bound to RemoteJson or LocalJson then you must provide a dictionary or json string with the row data to add. -- **AddRowAsync**(item: object): Task — Adds a new row to the grid. If the grid is bound to RemoteJson or LocalJson then you must provide a dictionary or json string with the row data to add. -- **BeginAddRowById**(rowID: object, asChild: bool): void -- **BeginAddRowByIdAsync**(rowID: object, asChild: bool): Task -- **ClearCellSelection**(): void -- **ClearCellSelectionAsync**(): Task — Deselect selected cells. this.grid.clearCellSelection(); -- **ClearFilter**(name: string): void -- **ClearFilterAsync**(name: string): Task — If name is provided, clears the filtering state of the corresponding IgxColumnComponent. Otherwise clears the filtering state of all IgxColumnComponents. this.grid.clearFilter(); name -- **ClearSearch**(): void -- **ClearSearchAsync**(): Task — Removes all the highlights in the cell. this.grid.clearSearch(); -- **ClearSort**(name: string): void -- **ClearSortAsync**(name: string): Task — If name is provided, clears the sorting state of the corresponding IgxColumnComponent. otherwise clears the sorting state of all IgxColumnComponent. this.grid.clearSort(); name -- **CloseAdvancedFilteringDialog**(applyChanges: bool): void -- **CloseAdvancedFilteringDialogAsync**(applyChanges: bool): Task — Closes the advanced filtering dialog. applyChanges indicates whether the changes should be applied -- **CollapseAll**(): void -- **CollapseAllAsync**(): Task — Collapses all rows. this.grid.collapseAll(); -- **CollapseRow**(rowID: object): void -- **CollapseRowAsync**(rowID: object): Task — Collapses the row by its id. ID is either the primaryKey value or the data record instance. this.grid.collapseRow(rowID); rowID The row id - primaryKey value or the data record instance. -- **DeleteRow**(rowSelector: object): object — Deletes a row from the grid. -- **DeleteRowAsync**(rowSelector: object): Task — Deletes a row from the grid. -- **DeselectAllColumns**(): void -- **DeselectAllColumnsAsync**(): Task — Deselects all columns this.grid.deselectAllColumns(); -- **DeselectAllRows**(onlyFilterData: bool): void -- **DeselectAllRowsAsync**(onlyFilterData: bool): Task — Deselects all rows By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows. If you set the parameter onlyFilterData to false that will deselect all rows in the grid exept deleted rows. this.grid.deselectAllRows(); onlyFilterData -- **DeselectColumns**(columns: string[]): void -- **DeselectColumnsAsync**(columns: string[]): Task -- **DeselectRows**(rowIDs: object[]): void -- **DeselectRowsAsync**(rowIDs: object[]): Task -- **DisableSummaries**(rest: object[]): void -- **DisableSummariesAsync**(rest: object[]): Task -- **EnableSummaries**(rest: object[]): void -- **EnableSummariesAsync**(rest: object[]): Task -- **ExpandAll**(): void -- **ExpandAllAsync**(): Task — Expands all rows. this.grid.expandAll(); -- **ExpandRow**(rowID: object): void -- **ExpandRowAsync**(rowID: object): Task — Expands the row by its id. ID is either the primaryKey value or the data record instance. this.grid.expandRow(rowID); rowID The row id - primaryKey value or the data record instance. -- **Filter**(name: string, value: object, conditionOrExpressionTree: IgbFilteringExpressionsTreeOrFilteringOperation, ignoreCase: bool): void -- **FilterAsync**(name: string, value: object, conditionOrExpressionTree: IgbFilteringExpressionsTreeOrFilteringOperation, ignoreCase: bool): Task -- **FilterGlobal**(value: object, condition: object, ignoreCase: object): void -- **FilterGlobalAsync**(value: object, condition: object, ignoreCase: object): Task -- **FindByName**(name: string): object -- **FindNext**(text: string, caseSensitive: bool, exactMatch: bool): double -- **FindNextAsync**(text: string, caseSensitive: bool, exactMatch: bool): Task -- **FindPrev**(text: string, caseSensitive: bool, exactMatch: bool): double -- **FindPrevAsync**(text: string, caseSensitive: bool, exactMatch: bool): Task -- **GetColumnByName**(name: string): IgbColumn -- **GetColumnByNameAsync**(name: string): Task — Returns the IgxColumnComponent by field name. const myCol = this.grid1.getColumnByName("ID"); name -- **GetColumnByVisibleIndex**(index: double): IgbColumn -- **GetColumnByVisibleIndexAsync**(index: double): Task -- **GetColumns**(): IgbColumn[] -- **GetColumnsAsync**(): Task -- **GetCurrentActualColumnList**(): IgbColumnCollection -- **GetCurrentActualColumnListAsync**(): Task -- **GetCurrentSelectedRows**(): object[] -- **GetCurrentSelectedRowsAsync**(): Task -- **GetData**(): object -- **GetDataView**(): object[] -- **GetDataViewAsync**(): Task -- **GetDefaultRowHeight**(): double -- **GetDefaultRowHeightAsync**(): Task -- **GetFilteredData**(): object -- **GetFilteredDataAsync**(): Task -- **GetFilteredSortedData**(): object[] -- **GetFilteredSortedDataAsync**(): Task -- **GetHeaderGroupWidth**(column: IgbColumn): string -- **GetHeaderGroupWidthAsync**(column: IgbColumn): Task — Gets the width to be set on IgxGridHeaderGroupComponent. -- **GetHiddenColumnsCount**(): double -- **GetHiddenColumnsCountAsync**(): Task -- **GetLastSearchInfo**(): IgbSearchInfo -- **GetLastSearchInfoAsync**(): Task -- **GetNextCell**(currRowIndex: double, curVisibleColIndex: double, callback: object): IgbCellPosition -- **GetNextCellAsync**(currRowIndex: double, curVisibleColIndex: double, callback: object): Task -- **GetPinnedColumns**(): IgbColumn[] -- **GetPinnedColumnsAsync**(): Task -- **GetPinnedColumnsCount**(): double -- **GetPinnedColumnsCountAsync**(): Task -- **GetPinnedEndColumns**(): IgbColumn[] -- **GetPinnedEndColumnsAsync**(): Task -- **GetPinnedEndWidth**(takeHidden: bool): void -- **GetPinnedEndWidthAsync**(takeHidden: bool): Task — Gets calculated width of the pinned areas. const pinnedWidth = this.grid.getPinnedEndWidth(); takeHidden If we should take into account the hidden columns in the pinned area. -- **GetPinnedStartColumns**(): IgbColumn[] -- **GetPinnedStartColumnsAsync**(): Task -- **GetPinnedStartWidth**(takeHidden: bool): void -- **GetPinnedStartWidthAsync**(takeHidden: bool): Task — Gets calculated width of the pinned areas. const pinnedWidth = this.grid.getPinnedStartWidth(); takeHidden If we should take into account the hidden columns in the pinned area. -- **GetPreviousCell**(currRowIndex: double, curVisibleColIndex: double, callback: object): IgbCellPosition -- **GetPreviousCellAsync**(currRowIndex: double, curVisibleColIndex: double, callback: object): Task -- **GetRowData**(rowSelector: object): object -- **GetRowDataAsync**(rowSelector: object): Task — Returns the data that is contained in the row component. If the primary key is not specified the row selector match the row data. const data = grid.getRowData(94741); rowSelector correspond to rowID -- **GetSelectedColumnsData**(formatters: bool, headers: bool): void -- **GetSelectedColumnsDataAsync**(formatters: bool, headers: bool): Task -- **GetSelectedData**(formatters: bool, headers: bool): void -- **GetSelectedDataAsync**(formatters: bool, headers: bool): Task -- **GetSelectedRanges**(): IgbGridSelectionRange[] -- **GetSelectedRangesAsync**(): Task — Get the currently selected ranges in the grid. -- **GetUnpinnedColumns**(): IgbColumn[] -- **GetUnpinnedColumnsAsync**(): Task -- **GetVirtualizationState**(): IgbForOfState -- **GetVirtualizationStateAsync**(): Task -- **GetVisibleColumns**(): IgbColumn[] -- **GetVisibleColumnsAsync**(): Task -- **IsRecordPinnedByIndex**(rowIndex: double): void -- **IsRecordPinnedByIndexAsync**(rowIndex: double): Task — Returns whether the record is pinned or not. rowIndex Index of the record in the filteredSortedData collection. -- **MarkForCheck**(): void -- **MarkForCheckAsync**(): Task — Triggers change detection for the IgxGridComponent. Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed. May degrade performance if used when not needed, or if misused: // DON'Ts: // don't call markForCheck from inside a loop // don't call markForCheck when a primitive has changed grid.data.forEach(rec => { rec = newValue; grid.markForCheck(); }); // DOs // call markForCheck after updating a nested property grid.data.forEach(rec => { rec.nestedProp1.nestedProp2 = newValue; }); grid.markForCheck(); grid.markForCheck(); -- **MoveColumn**(column: IgbColumn, target: IgbColumn, pos: DropPosition?): void -- **MoveColumnAsync**(column: IgbColumn, target: IgbColumn, pos: DropPosition?): Task -- **NavigateTo**(rowIndex: double, visibleColIndex: double, cb: object): void -- **NavigateToAsync**(rowIndex: double, visibleColIndex: double, cb: object): Task -- **OnRowAddedOverride**(args: IgbRowDataEventArgs): void -- **OpenAdvancedFilteringDialog**(overlaySettings: IgbOverlaySettings): void -- **OpenAdvancedFilteringDialogAsync**(overlaySettings: IgbOverlaySettings): Task — Opens the advanced filtering dialog. -- **PinColumn**(columnName: string, index: double, pinningPosition: ColumnPinningPosition?): bool -- **PinColumnAsync**(columnName: string, index: double, pinningPosition: ColumnPinningPosition?): Task -- **PropagateValues**(item: object, props: Dictionary, createNewIfPossible: bool): void -- **RecalculateAutoSizes**(): void -- **RecalculateAutoSizesAsync**(): Task — Recalculates all widths of columns that have size set to auto. this.grid1.recalculateAutoSizes(); -- **Reflow**(): void -- **ReflowAsync**(): Task — Recalculates grid width/height dimensions. Should be run when changing DOM elements dimentions manually that affect the grid's size. this.grid.reflow(); -- **RefreshSearch**(updateActiveInfo: bool, endEdit: bool): double -- **RefreshSearchAsync**(updateActiveInfo: bool, endEdit: bool): Task -- **ResumeNotifications**(): void — Resumes data change notifications. -- **SelectAllColumns**(): void -- **SelectAllColumnsAsync**(): Task — Selects all columns this.grid.deselectAllColumns(); -- **SelectAllRows**(onlyFilterData: bool): void -- **SelectAllRowsAsync**(onlyFilterData: bool): Task — Selects all rows By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows. If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows. this.grid.selectAllRows(); this.grid.selectAllRows(false); onlyFilterData -- **SelectColumns**(columns: string[], clearCurrentSelection: bool): void -- **SelectColumnsAsync**(columns: string[], clearCurrentSelection: bool): Task -- **SelectRange**(arg: IgbGridSelectionRange[]): void -- **SelectRangeAsync**(arg: IgbGridSelectionRange[]): Task -- **SelectRows**(rowIDs: object[], clearCurrentSelection: bool): void -- **SelectRowsAsync**(rowIDs: object[], clearCurrentSelection: bool): Task -- **SelectedColumns**(): IgbColumn[] -- **SelectedColumnsAsync**(): Task — Get current selected columns. Returns an array with selected columns const selectedColumns = this.grid.selectedColumns(); -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Sort**(expression: IgbSortingExpression[]): void -- **SortAsync**(expression: IgbSortingExpression[]): Task -- **SuspendNotifications**(): void — Prevents data change notifications from be propagated to the component. -- **ToggleColumnVisibility**(args: IgbColumnVisibilityChangedEventArgs): void -- **ToggleColumnVisibilityAsync**(args: IgbColumnVisibilityChangedEventArgs): Task — Toggles the specified column's visibility. this.grid1.toggleColumnVisibility({ column: this.grid1.columns[0], newValue: true }); -- **ToggleRow**(rowID: object): void -- **ToggleRowAsync**(rowID: object): Task — Toggles the row by its id. ID is either the primaryKey value or the data record instance. this.grid.toggleRow(rowID); rowID The row id - primaryKey value or the data record instance. -- **UnpinColumn**(columnName: string, index: double): bool -- **UnpinColumnAsync**(columnName: string, index: double): Task -- **UpdateCell**(value: object, rowSelector: object, column: string): void — Updates the cell value at the specified location. -- **UpdateCellAsync**(value: object, rowSelector: object, column: string): Task — Updates the cell value at the specified location. -- **UpdateProperty**(item: object, propertyName: string, value: object): void -- **UpdateRow**(value: Dictionary, rowSelector: object): void — Updates the data in a row. -- **UpdateRowAsync**(value: Dictionary, rowSelector: object): Task — Updates the data in a row. - -### [IgbGridCellEditEndedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridCellEditEndedEventArgs) - -- **constructor**(): void -- **Column**: `IgbDataGridColumn` — Gets the column of the cell that ended editing. -- **Item**: `object` — Gets the row item. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Row**: `int` — Gets the row index of the cell that ended editing. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridCellEditStartedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridCellEditStartedEventArgs) - -- **constructor**(): void -- **Column**: `IgbDataGridColumn` — Gets the column of the cell that started editing. -- **Item**: `object` — Gets the row item. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Row**: `int` — Gets the row index of the cell that started editing. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridCellEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridCellEventArgs) -Represents an event argument related to grid cell interactions. - -- **constructor**(): void -- **Detail**: `IgbGridCellEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridCellEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridCellEventArgsDetail) -Represents an event argument related to grid cell interactions. - -- **constructor**(): void -- **Cell**: `IgbCellType` — Represents the grid cell that triggered the event. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridCellIdentifier](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridCellIdentifier) - -- **constructor**(): void -- **ColumnID**: `int` -- **RowID**: `string` -- **RowIndex**: `int` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridCellPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridCellPosition) - -- **constructor**(): void -- **ColumnUniqueKey**: `string` — Gets or sets the column position of the cell. Can be null for spanning elements like section headers. -- **RowIndex**: `int` — Gets or sets the row position of the cell. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridCellPositionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridCellPositionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridCellValueChangingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridCellValueChangingEventArgs) -Event arguments for the CellValueChanging event - -- **constructor**(): void -- **CellInfo**: `IgbCellInfo` — Gets the cell that was edited. -- **Column**: `IgbDataGridColumn` — Gets the column the cell belongs to. -- **ColumnScript**: `string` — Provides a means of setting Column in the JavaScript environment. -- **EditID**: `int` — Gets the edit ID for this value change. -- **Item**: `object` — Gets the row item associated with the change. -- **NewValue**: `object` — Gets the new cell value. -- **OldValue**: `object` — Gets the old cell value. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridClipboardEvent](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridClipboardEvent) -The event arguments when data from a grid is being copied. - -- **constructor**(): void -- **Cancel**: `bool` — cancel returns whether an external event has intercepted the copying If the value becomes "true", it returns/exits from the method, instantiating the interface -- **Data**: `object[]` — data can be of any type and refers to the data that is being copied/stored to the clipboard -- **DataScript**: `string` — Provides a means of setting Data in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGridClipboardEventDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridClipboardEventDetail) -The event arguments when data from a grid is being copied. - -- **constructor**(): void -- **Cancel**: `bool` — cancel returns whether an external event has intercepted the copying If the value becomes "true", it returns/exits from the method, instantiating the interface -- **Data**: `object[]` — data can be of any type and refers to the data that is being copied/stored to the clipboard -- **DataScript**: `string` — Provides a means of setting Data in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridClipboardEventEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridClipboardEventEventArgs) - -- **constructor**(): void -- **Detail**: `IgbGridClipboardEventDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridColumnAnimationSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnAnimationSettings) -Column animation settings for the grid. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGridColumnButtonOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnButtonOptions) - -- **constructor**(): void -- **ApplyButtonCaption**: `string` -- **ApplyButtonClick**: `EventCallback` -- **ApplyButtonClickScript**: `string` -- **CancelButtonCaption**: `string` -- **CancelButtonClick**: `EventCallback` -- **CancelButtonClickScript**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGridColumnButtonOptionsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnButtonOptionsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridColumnCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridColumnFilterOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnFilterOptions) - -- **constructor**(): void -- **ActualFilterListDensity**: `ControlDisplayDensity` — Gets the actual display filterListDensity to use for the component. -- **ClearColumnFiltersCaption**: `string` -- **FilterListDensity**: `ControlDisplayDensity` — Gets or sets the display Density to use for the buttons in the component. -- **FilterListPlaceholderText**: `string` -- **TextFilterCaption**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **OnApply**(): void -- **OnApplyAsync**(): Task - -### [IgbGridColumnFilterOptionsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnFilterOptionsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridColumnGroupOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnGroupOptions) - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGridColumnGroupOptionsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnGroupOptionsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridColumnHideOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnHideOptions) - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGridColumnHideOptionsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnHideOptionsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridColumnMoveOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnMoveOptions) - -- **constructor**(): void -- **MoveLeftCaption**: `string` -- **MoveRightCaption**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGridColumnMoveOptionsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnMoveOptionsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridColumnOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnOptions) - -- **constructor**(): void -- **ActualFilterListDensity**: `ControlDisplayDensity` — Gets the actual display filterListDensity to use for the component. -- **ActualSummaryListDensity**: `ControlDisplayDensity` — Gets the actual display density used for the summary list menu. -- **ApplyButtonClick**: `EventCallback` -- **ApplyButtonClickScript**: `string` -- **ApplyFiltersButtonCaption**: `string` -- **CancelButtonClick**: `EventCallback` -- **CancelButtonClickScript**: `string` -- **CancelFiltersButtonCaption**: `string` -- **ClearColumnFiltersCaption**: `string` -- **ColumnNameFontFamily**: `string` -- **ColumnNameFontSize**: `double` -- **ColumnNameFontStyle**: `string` -- **ColumnNameFontWeight**: `string` -- **FilterListDensity**: `ControlDisplayDensity` — Gets or sets the display Density to use for the buttons in the component. -- **FilterListPlaceholderText**: `string` -- **FilterOptionsVisible**: `bool` -- **GroupOptionsVisible**: `bool` -- **HeaderVisible**: `bool` -- **HideOptionsVisible**: `bool` -- **MoveHeaderCaption**: `string` -- **MoveLeftCaption**: `string` -- **MoveOptionsVisible**: `bool` -- **MoveRightCaption**: `string` -- **PaddingBottom**: `int` — Gets or sets the amount of left padding to use for the bottom edge of the component. -- **PaddingLeft**: `int` — Gets or sets the amount of left padding to use for the left edge of the component. -- **PaddingRight**: `int` — Gets or sets the amount of left padding to use for the right edge of the component. -- **PaddingTop**: `int` — Gets or sets the amount of left padding to use for the top edge of the component. -- **PinHeaderCaption**: `string` -- **PinLeftCaption**: `string` -- **PinOptionsVisible**: `bool` -- **PinRightCaption**: `string` -- **SortAscendingCaption**: `string` -- **SortDescendingCaption**: `string` -- **SortHeaderCaption**: `string` -- **SortOptionsVisible**: `bool` -- **SummaryListBackground**: `string` — Gets or sets the background color for the summary options menu. -- **SummaryListDensity**: `ControlDisplayDensity` — Gets or sets the display density to use for the summary list menu. -- **SummaryListTextColor**: `string` — Gets or sets the text color for the summary options menu. -- **SummaryOptionsVisible**: `bool` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGridColumnOptionsBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnOptionsBase) - -- **constructor**(): void -- **ActualBaseTheme**: `BaseControlTheme` — Gets the actual display baseTheme to use for the component. -- **ActualButtonDensity**: `ControlDisplayDensity` — Gets the actual display buttonDensity to use for the component. -- **ActualDensity**: `ControlDisplayDensity` — Gets the actual display density to use for the component. -- **AutoSize**: `bool` — Gets or sets the autoSize for which this AutoSizeOptions will apply. -- **BackgroundColor**: `string` — Gets or sets the color to use for the background of the component. -- **BaseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the component. -- **ButtonDensity**: `ControlDisplayDensity` — Gets or sets the display Density to use for the buttons in the component. -- **ButtonFontFamily**: `string` -- **ButtonFontSize**: `double` -- **ButtonFontStyle**: `string` -- **ButtonFontWeight**: `string` -- **Column**: `IgbDataGridColumn` — Gets or sets the column for which this ColumnOptions will apply. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or sets the display density to use for the component. -- **LabelFontFamily**: `string` -- **LabelFontSize**: `double` -- **LabelFontStyle**: `string` -- **LabelFontWeight**: `string` -- **TextColor**: `string` — Gets or sets the color to use for the text of the component. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGridColumnOptionsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnOptionsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridColumnOptionsSectionBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnOptionsSectionBase) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **OnApply**(): void -- **OnApplyAsync**(): Task -- **OnCancel**(): void -- **OnCancelAsync**(): Task - -### [IgbGridColumnOptionsSimpleSectionBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnOptionsSimpleSectionBase) - -- **constructor**(): void -- **Caption**: `string` -- **ShowCaption**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGridColumnPinOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnPinOptions) - -- **constructor**(): void -- **PinLeftCaption**: `string` -- **PinRightCaption**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGridColumnPinOptionsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnPinOptionsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridColumnSortOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnSortOptions) - -- **constructor**(): void -- **AscendingCaption**: `string` -- **DescendingCaption**: `string` -- **SortDirection**: `ColumnSortDirection` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGridColumnSortOptionsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnSortOptionsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridColumnSummaryOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnSummaryOptions) - -- **constructor**(): void -- **ActiveCount**: `int` -- **ActualSummaryListDensity**: `ControlDisplayDensity` — Gets the actual display density used for the summary list. -- **SummaryCaption**: `string` — Gets or sets the text inside the summary button. -- **SummaryListBackground**: `string` -- **SummaryListDensity**: `ControlDisplayDensity` — Gets or sets the display density used for the summary list. -- **SummaryListTextColor**: `string` -- **Type**: `string` -- **CloseMenu**(): void -- **CloseMenuAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **OnApply**(): void -- **OnApplyAsync**(): Task -- **OnCancel**(): void -- **OnCancelAsync**(): Task - -### [IgbGridColumnSummaryOptionsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnSummaryOptionsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridColumnWidthChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnWidthChangedEventArgs) -Event arguments for the GridColumnWidthChanged event. - -- **constructor**(): void -- **Column**: `IgbDataGridColumn` — The column whose Width has changed -- **ColumnScript**: `string` — Provides a means of setting Column in the JavaScript environment. -- **NewWidth**: `IgbColumnWidth` — The new column width. -- **OldWidth**: `IgbColumnWidth` — The old column width. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridColumnsAutoGeneratedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnsAutoGeneratedEventArgs) -Information about the generated columns. - -- **constructor**(): void -- **Columns**: `IgbGridColumnCollection` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridColumnsChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridColumnsChangedEventArgs) -Information about the generated columns. - -- **constructor**(): void -- **Columns**: `IgbGridColumnCollection` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridCompoundConditionalStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridCompoundConditionalStyle) - -- **constructor**(): void -- **Type**: `string` -- **ActualNeedsFieldMaximum**(): bool -- **ActualNeedsFieldMaximumAsync**(): Task -- **ActualNeedsFieldMinimum**(): bool -- **ActualNeedsFieldMinimumAsync**(): Task -- **ActualNeedsFieldSum**(): bool -- **ActualNeedsFieldSumAsync**(): Task -- **FindByName**(name: string): object -- **GetSubStyles**(): IgbGridConditionalStyleCollection -- **GetSubStylesAsync**(): Task - -### [IgbGridConditionFilterStringErrorsParsingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridConditionFilterStringErrorsParsingEventArgs) -Represents event arguments for when there are errors parsing the filter string - -- **constructor**(): void -- **Errors**: `string` — Gets the errors from parsing the filter string. -- **PropertyName**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridConditionalStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridConditionalStyle) - -- **constructor**(): void -- **ActualProperties**: `IgbGridConditionalStylePropertyCollection` -- **Condition**: `IgbFilterExpression` -- **ConditionString**: `string` -- **ContentProperties**: `IgbGridConditionalStylePropertyCollection` -- **FilterStringErrorsParsing**: `EventCallback` -- **FilterStringErrorsParsingScript**: `string` -- **IsFieldMaximumNeeded**: `bool` -- **IsFieldMinimumNeeded**: `bool` -- **IsFieldSumNeeded**: `bool` -- **IsTransitionInEnabled**: `bool` -- **ParentTypeName**: `string` -- **Properties**: `IgbGridConditionalStylePropertyCollection` -- **PropertyUpdated**: `EventCallback` -- **PropertyUpdatedScript**: `string` -- **StyleKey**: `string` -- **Type**: `string` -- **ActualNeedsFieldMaximum**(): bool -- **ActualNeedsFieldMaximumAsync**(): Task -- **ActualNeedsFieldMinimum**(): bool -- **ActualNeedsFieldMinimumAsync**(): Task -- **ActualNeedsFieldSum**(): bool -- **ActualNeedsFieldSumAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **RequiresGlobalValues**(): bool -- **RequiresGlobalValuesAsync**(): Task - -### [IgbGridConditionalStyleCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridConditionalStyleCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridConditionalStyleFontInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridConditionalStyleFontInfo) - -- **constructor**(): void -- **FontFamily**: `string` -- **FontSize**: `double` -- **FontStyle**: `string` -- **FontWeight**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGridConditionalStyleFontInfoModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridConditionalStyleFontInfoModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridConditionalStyleModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridConditionalStyleModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridConditionalStyleProperty](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridConditionalStyleProperty) - -- **constructor**(): void -- **ActualInputValueExpression**: `IgbFilterExpression` -- **ActualMaximumInputValueExpression**: `IgbFilterExpression` -- **ActualMinimumInputValueExpression**: `IgbFilterExpression` -- **ActualSumInputValueExpression**: `IgbFilterExpression` -- **BoolValue**: `bool` -- **BrushValue**: `string` -- **ColorCollection**: `string` -- **DateValue**: `DateTime` -- **DoubleValue**: `double` -- **FilterStringErrorsParsing**: `EventCallback` -- **FilterStringErrorsParsingScript**: `string` -- **FontValue**: `IgbGridConditionalStyleFontInfo` -- **InputValueExpression**: `IgbFilterExpression` -- **InputValueExpressionString**: `string` -- **IntValue**: `int` -- **MaximumColor**: `string` -- **MaximumInputValue**: `object` -- **MaximumInputValueExpression**: `IgbFilterExpression` -- **MaximumInputValueExpressionString**: `string` -- **MaximumInputValueScript**: `string` — Provides a means of setting MaximumInputValue in the JavaScript environment. -- **MaximumType**: `GridConditionalStyleBoundType` -- **MinimumColor**: `string` -- **MinimumInputValue**: `object` -- **MinimumInputValueExpression**: `IgbFilterExpression` -- **MinimumInputValueExpressionString**: `string` -- **MinimumInputValueScript**: `string` — Provides a means of setting MinimumInputValue in the JavaScript environment. -- **MinimumType**: `GridConditionalStyleBoundType` -- **ObjectValue**: `object` -- **PropertyName**: `string` -- **ShouldSetValue**: `bool` -- **StringValue**: `string` -- **StylingType**: `GridConditionalStylePropertyStylingType` -- **SumInputValue**: `object` -- **SumInputValueExpression**: `IgbFilterExpression` -- **SumInputValueExpressionString**: `string` -- **SumInputValueScript**: `string` — Provides a means of setting SumInputValue in the JavaScript environment. -- **Type**: `string` -- **ValueCollection**: `object[]` -- **ValueCollectionScript**: `string` — Provides a means of setting ValueCollection in the JavaScript environment. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGridConditionalStylePropertyCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridConditionalStylePropertyCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridConditionalStylePropertyModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridConditionalStylePropertyModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridContextMenuEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridContextMenuEventArgs) -Represents an event argument for the grid contextMenu output - -- **constructor**(): void -- **Detail**: `IgbGridContextMenuEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridContextMenuEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridContextMenuEventArgsDetail) -Represents an event argument for the grid contextMenu output - -- **constructor**(): void -- **Cell**: `IgbCellType` — Represents the grid cell that triggered the event. -- **Row**: `IgbRowType` — Represents the grid row that triggered the event. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridCreatedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridCreatedEventArgs) - -- **constructor**(): void -- **Detail**: `IgbGridCreatedEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridCreatedEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridCreatedEventArgsDetail) - -- **constructor**(): void -- **Grid**: `IgbHierarchicalGrid` -- **Owner**: `IgbRowIsland` -- **ParentID**: `object` -- **ParentRowData**: `object` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridCustomFilterRequestedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridCustomFilterRequestedEventArgs) - -- **constructor**(): void -- **Column**: `IgbDataGridColumn` — The column that requested the filter. -- **Expression**: `IgbFilterExpression` — Sets the filter expression to be used. -- **Filter**: `IgbFilterOperand` — The custom filter that was chosen. -- **FilterFactory**: `FilterFactory` — Gets the FilterFactory to assists in building filters. -- **Type**: `string` -- **Value**: `object` — The value that was provided in the editor for the filter. -- **ValueScript**: `string` — Provides a means of setting Value in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridDataCommittedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridDataCommittedEventArgs) -Event arguments for the DataCommitted event. - -- **constructor**(): void -- **Changes**: `IgbDataSourceAggregatedResult[]` — Gets a list of the changes that were committed. -- **CommitID**: `int` — Gets the ID for this commit. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridDataCommittingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridDataCommittingEventArgs) -Event arguments for the DataCommitting event. - -- **constructor**(): void -- **Changes**: `IgbDataSourceAggregatedResult[]` — Gets a list of changes that are about to be committed. -- **CommitID**: `int` — The ID for the commit. Use this as the argument for the AcceptCommit or RejectCommit methods. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridEditDoneEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridEditDoneEventArgs) -Represents event arguments related to grid editing completion. - -- **constructor**(): void -- **Detail**: `IgbGridEditDoneEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridEditDoneEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridEditDoneEventArgsDetail) -Represents event arguments related to grid editing completion. - -- **constructor**(): void -- **CellID**: `IgbGridCellIdentifier` -- **Column**: `IgbColumn` — Optional Represents the column information of the edited cell -- **IsAddRow**: `bool` — Optional Indicates if the editing consists of adding a new row -- **NewValue**: `object` — Optional Represents the value, that is being entered in the edited cell When there is no newValue and the event has ended, the value of the cell returns to the oldValue -- **OldValue**: `object` — Represents the previous (before editing) value of the edited cell. It's used when the event has been stopped/exited. -- **Owner**: `IgbGridBaseDirective` — Optional Represents the grid instance that owns the edit event. -- **PrimaryKey**: `object` -- **RowData**: `object` — rowData represents the updated/committed data of the row after the edit (newValue) The only case rowData (of the current object) is used directly, is when there is no rowEditing or transactions enabled -- **RowID**: `object` -- **RowKey**: `object` -- **Type**: `string` -- **Valid**: `bool` — Optional Indicates if the new value would be valid. It can be set to return the result of the methods for validation of the grid -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridEditEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridEditEventArgs) -Represents event arguments related to grid editing. The event is cancelable It contains information about the row and the column, as well as the old and nwe value of the element/cell - -- **constructor**(): void -- **Detail**: `IgbGridEditEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridEditEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridEditEventArgsDetail) -Represents event arguments related to grid editing. The event is cancelable It contains information about the row and the column, as well as the old and nwe value of the element/cell - -- **constructor**(): void -- **Cancel**: `bool` — Provides the ability to cancel the event. -- **CellID**: `IgbGridCellIdentifier` -- **Column**: `IgbColumn` — Optional Represents the column information of the edited cell -- **IsAddRow**: `bool` — Optional Indicates if the editing consists of adding a new row -- **NewValue**: `object` — Optional Represents the value, that is being entered in the edited cell When there is no newValue and the event has ended, the value of the cell returns to the oldValue -- **OldValue**: `object` — Represents the previous (before editing) value of the edited cell. It's used when the event has been stopped/exited. -- **Owner**: `IgbGridBaseDirective` — Optional Represents the grid instance that owns the edit event. -- **PrimaryKey**: `object` -- **RowData**: `object` — rowData represents the updated/committed data of the row after the edit (newValue) The only case rowData (of the current object) is used directly, is when there is no rowEditing or transactions enabled -- **RowID**: `object` -- **RowKey**: `object` -- **Type**: `string` -- **Valid**: `bool` — Optional Indicates if the new value would be valid. It can be set to return the result of the methods for validation of the grid -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridEditingActions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridEditingActions) -Grid Editing Actions for the Action Strip IgxActionStripComponent - -- **constructor**(): void -- **AddChild**: `bool` — An input to enable/disable action strip child row adding button -- **AddRow**: `bool` — An input to enable/disable action strip row adding button -- **DeleteRow**: `bool` — An input to enable/disable action strip row deleting button -- **EditRow**: `bool` — An input to enable/disable action strip row editing button -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **StartEdit**(evt: object): void -- **StartEditAsync**(evt: object): Task — Enter row or cell edit mode depending the grid rowEditable option this.gridEditingActions.startEdit(); - -### [IgbGridEditingActionsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridEditingActionsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridEmptyTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridEmptyTemplateContext) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridFilterDialogFilterChangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridFilterDialogFilterChangeEventArgs) - -- **constructor**(): void -- **Filter**: `IgbColumnFilterCondition` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridFilterDialogOpeningEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridFilterDialogOpeningEventArgs) - -- **constructor**(): void -- **Column**: `IgbDataGridColumn` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridFilterDialogViewModel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridFilterDialogViewModel) - -- **constructor**(): void -- **IsTopLevelOr**: `bool` -- **MaxGroupingLevels**: `int` -- **PropertyType**: `DataSourceSchemaPropertyType` -- **Rows**: `IgbGridFilterDialogViewModelRowCollection` -- **Type**: `string` -- **AddNewRow**(): void -- **AddNewRowAsync**(): Task -- **CanGroupRange**(startIndex: int, endIndex: int): bool -- **CanGroupRangeAsync**(startIndex: int, endIndex: int): Task -- **FindByName**(name: string): object -- **GroupRange**(startIndex: int, endIndex: int, isOrGrouping: bool): void -- **GroupRangeAsync**(startIndex: int, endIndex: int, isOrGrouping: bool): Task -- **TargetingRange**(startIndex: int, endIndex: int): bool -- **TargetingRangeAsync**(startIndex: int, endIndex: int): Task -- **ToggleRange**(startIndex: int, endIndex: int): void -- **ToggleRangeAsync**(startIndex: int, endIndex: int): Task -- **UngroupRange**(startIndex: int, endIndex: int): void -- **UngroupRangeAsync**(startIndex: int, endIndex: int): Task - -### [IgbGridFilterDialogViewModelGrouping](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridFilterDialogViewModelGrouping) - -- **constructor**(): void -- **EndIndex**: `int` -- **IsOrGrouping**: `bool` -- **StartIndex**: `int` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGridFilterDialogViewModelGroupingLevel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridFilterDialogViewModelGroupingLevel) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridFilterDialogViewModelGroupingLevelCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridFilterDialogViewModelGroupingLevelCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridFilterDialogViewModelRow](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridFilterDialogViewModelRow) - -- **constructor**(): void -- **CurrentOperator**: `string` -- **Operand1**: `object` -- **Operand1Script**: `string` — Provides a means of setting Operand1 in the JavaScript environment. -- **Operand2**: `object` -- **Operand2Script**: `string` — Provides a means of setting Operand2 in the JavaScript environment. -- **OperandNumber**: `int[]` -- **Operators**: `string[]` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGridFilterDialogViewModelRowCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridFilterDialogViewModelRowCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridFilterExpressionsEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridFilterExpressionsEventArgs) - -- **constructor**(): void -- **FilterExpressions**: `IgbFilterExpressionCollection` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridFilterOperandsCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridFilterOperandsCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridFormGroupCreatedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridFormGroupCreatedEventArgs) -Interface representing the event arguments when a form group is created in the grid. formGroup: The form group that is created. owner: The grid instance that owns the form group. - -- **constructor**(): void -- **Detail**: `IgbGridFormGroupCreatedEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridFormGroupCreatedEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridFormGroupCreatedEventArgsDetail) -Interface representing the event arguments when a form group is created in the grid. formGroup: The form group that is created. owner: The grid instance that owns the form group. - -- **constructor**(): void -- **Owner**: `IgbGridBaseDirective` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridGroupDescriptionsChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridGroupDescriptionsChangedEventArgs) -Information about the current grouping applied to the grid. - -- **constructor**(): void -- **GroupDescriptions**: `IgbColumnGroupDescriptionCollection` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridGroupingStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridGroupingStrategy) -Represents a grouping strategy for the grid data, extending the Sorting Strategy interface (contains a sorting method). - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGridHeaderTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridHeaderTemplateContext) - -- **constructor**(): void -- **Implicit**: `IgbHeaderType` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridKeydownEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridKeydownEventArgs) -Represents an event, emitted when keydown is triggered over element inside grid's body This event is fired only if the key combination is supported in the grid. - -- **constructor**(): void -- **Detail**: `IgbGridKeydownEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridKeydownEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridKeydownEventArgsDetail) -Represents an event, emitted when keydown is triggered over element inside grid's body This event is fired only if the key combination is supported in the grid. - -- **constructor**(): void -- **Cancel**: `bool` — The event is cancelable cancel returns whether the event has been intercepted and stopped If the value becomes "true", it returns/exits from the method, instantiating the interface -- **Target**: `object` — Represents the information and details of the object itself -- **TargetType**: `GridKeydownTargetType` — The targetType represents the type of the targeted object. For example a cell or a row -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridMasterDetailContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridMasterDetailContext) - -- **constructor**(): void -- **Implicit**: `object` -- **Index**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridMergeStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridMergeStrategy) -Merge strategy interface. - -- **constructor**(): void -- **Type**: `string` -- **Comparer**(prevRecord: object, record: object, field: string): bool -- **ComparerAsync**(prevRecord: object, record: object, field: string): Task -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGridModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridPaginatorTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridPaginatorTemplateContext) - -- **constructor**(): void -- **Implicit**: `IgbGridBaseDirective` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridPinningActions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridPinningActions) -Grid Pinning Actions for the Action Strip IgxActionStripComponent - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **Pin**(evt: object): void -- **PinAsync**(evt: object): Task — Pin the row according to the context. this.gridPinningActions.pin(); -- **ScrollToRow**(evt: object): void -- **ScrollToRowAsync**(evt: object): Task -- **Unpin**(evt: object): void -- **UnpinAsync**(evt: object): Task — Unpin the row according to the context. this.gridPinningActions.unpin(); - -### [IgbGridPinningActionsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridPinningActionsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridResourceStrings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridResourceStrings) - -- **constructor**(): void -- **Igx_grid_actions_add_child_label**: `string` -- **Igx_grid_actions_add_label**: `string` -- **Igx_grid_actions_delete_label**: `string` -- **Igx_grid_actions_edit_label**: `string` -- **Igx_grid_actions_jumpDown_label**: `string` -- **Igx_grid_actions_jumpUp_label**: `string` -- **Igx_grid_actions_pin_label**: `string` -- **Igx_grid_actions_unpin_label**: `string` -- **Igx_grid_add_row_label**: `string` -- **Igx_grid_advanced_filter_add_condition**: `string` -- **Igx_grid_advanced_filter_add_condition_root**: `string` -- **Igx_grid_advanced_filter_add_group**: `string` -- **Igx_grid_advanced_filter_add_group_root**: `string` -- **Igx_grid_advanced_filter_and_group**: `string` -- **Igx_grid_advanced_filter_and_label**: `string` -- **Igx_grid_advanced_filter_column_placeholder**: `string` -- **Igx_grid_advanced_filter_create_and_group**: `string` -- **Igx_grid_advanced_filter_create_or_group**: `string` -- **Igx_grid_advanced_filter_delete**: `string` -- **Igx_grid_advanced_filter_delete_filters**: `string` -- **Igx_grid_advanced_filter_dialog_checkbox_text**: `string` -- **Igx_grid_advanced_filter_dialog_message**: `string` -- **Igx_grid_advanced_filter_dialog_title**: `string` -- **Igx_grid_advanced_filter_drop_ghost_text**: `string` -- **Igx_grid_advanced_filter_end_group**: `string` -- **Igx_grid_advanced_filter_from_label**: `string` -- **Igx_grid_advanced_filter_initial_text**: `string` -- **Igx_grid_advanced_filter_or_group**: `string` -- **Igx_grid_advanced_filter_or_label**: `string` -- **Igx_grid_advanced_filter_query_value_placeholder**: `string` -- **Igx_grid_advanced_filter_select_entity**: `string` -- **Igx_grid_advanced_filter_select_return_field_single**: `string` -- **Igx_grid_advanced_filter_switch_group**: `string` -- **Igx_grid_advanced_filter_title**: `string` -- **Igx_grid_advanced_filter_ungroup**: `string` -- **Igx_grid_advanced_filter_value_placeholder**: `string` -- **Igx_grid_complex_filter**: `string` -- **Igx_grid_email_validation_error**: `string` -- **Igx_grid_emptyFilteredGrid_message**: `string` -- **Igx_grid_emptyGrid_message**: `string` -- **Igx_grid_excel_add_to_filter**: `string` -- **Igx_grid_excel_apply**: `string` -- **Igx_grid_excel_blanks**: `string` -- **Igx_grid_excel_boolean_filter**: `string` -- **Igx_grid_excel_cancel**: `string` -- **Igx_grid_excel_currency_filter**: `string` -- **Igx_grid_excel_custom_dialog_add**: `string` -- **Igx_grid_excel_custom_dialog_clear**: `string` -- **Igx_grid_excel_custom_dialog_header**: `string` -- **Igx_grid_excel_custom_filter**: `string` -- **Igx_grid_excel_date_filter**: `string` -- **Igx_grid_excel_deselect**: `string` -- **Igx_grid_excel_filter_clear**: `string` -- **Igx_grid_excel_filter_moving_header**: `string` -- **Igx_grid_excel_filter_moving_left**: `string` -- **Igx_grid_excel_filter_moving_left_short**: `string` -- **Igx_grid_excel_filter_moving_right**: `string` -- **Igx_grid_excel_filter_moving_right_short**: `string` -- **Igx_grid_excel_filter_sorting_asc**: `string` -- **Igx_grid_excel_filter_sorting_asc_short**: `string` -- **Igx_grid_excel_filter_sorting_desc**: `string` -- **Igx_grid_excel_filter_sorting_desc_short**: `string` -- **Igx_grid_excel_filter_sorting_header**: `string` -- **Igx_grid_excel_hide**: `string` -- **Igx_grid_excel_matches_count**: `string` -- **Igx_grid_excel_no_matches**: `string` -- **Igx_grid_excel_number_filter**: `string` -- **Igx_grid_excel_pin**: `string` -- **Igx_grid_excel_search_placeholder**: `string` -- **Igx_grid_excel_select**: `string` -- **Igx_grid_excel_select_all**: `string` -- **Igx_grid_excel_select_all_search_results**: `string` -- **Igx_grid_excel_show**: `string` -- **Igx_grid_excel_text_filter**: `string` -- **Igx_grid_excel_unpin**: `string` -- **Igx_grid_filter**: `string` -- **Igx_grid_filter_after**: `string` -- **Igx_grid_filter_all**: `string` -- **Igx_grid_filter_at**: `string` -- **Igx_grid_filter_at_after**: `string` -- **Igx_grid_filter_at_before**: `string` -- **Igx_grid_filter_before**: `string` -- **Igx_grid_filter_condition_placeholder**: `string` -- **Igx_grid_filter_contains**: `string` -- **Igx_grid_filter_doesNotContain**: `string` -- **Igx_grid_filter_doesNotEqual**: `string` -- **Igx_grid_filter_empty**: `string` -- **Igx_grid_filter_endsWith**: `string` -- **Igx_grid_filter_equals**: `string` -- **Igx_grid_filter_false**: `string` -- **Igx_grid_filter_greaterThan**: `string` -- **Igx_grid_filter_greaterThanOrEqualTo**: `string` -- **Igx_grid_filter_in**: `string` -- **Igx_grid_filter_lastMonth**: `string` -- **Igx_grid_filter_lastYear**: `string` -- **Igx_grid_filter_lessThan**: `string` -- **Igx_grid_filter_lessThanOrEqualTo**: `string` -- **Igx_grid_filter_nextMonth**: `string` -- **Igx_grid_filter_nextYear**: `string` -- **Igx_grid_filter_notEmpty**: `string` -- **Igx_grid_filter_notIn**: `string` -- **Igx_grid_filter_notNull**: `string` -- **Igx_grid_filter_not_at**: `string` -- **Igx_grid_filter_null**: `string` -- **Igx_grid_filter_operator_and**: `string` -- **Igx_grid_filter_operator_or**: `string` -- **Igx_grid_filter_row_boolean_placeholder**: `string` -- **Igx_grid_filter_row_close**: `string` -- **Igx_grid_filter_row_date_placeholder**: `string` -- **Igx_grid_filter_row_placeholder**: `string` -- **Igx_grid_filter_row_reset**: `string` -- **Igx_grid_filter_row_time_placeholder**: `string` -- **Igx_grid_filter_startsWith**: `string` -- **Igx_grid_filter_thisMonth**: `string` -- **Igx_grid_filter_thisYear**: `string` -- **Igx_grid_filter_today**: `string` -- **Igx_grid_filter_true**: `string` -- **Igx_grid_filter_yesterday**: `string` -- **Igx_grid_groupByArea_deselect_message**: `string` -- **Igx_grid_groupByArea_message**: `string` -- **Igx_grid_groupByArea_select_message**: `string` -- **Igx_grid_hiding_check_all_label**: `string` -- **Igx_grid_hiding_uncheck_all_label**: `string` -- **Igx_grid_max_length_validation_error**: `string` -- **Igx_grid_max_validation_error**: `string` -- **Igx_grid_min_length_validation_error**: `string` -- **Igx_grid_min_validation_error**: `string` -- **Igx_grid_pattern_validation_error**: `string` -- **Igx_grid_pinned_row_indicator**: `string` -- **Igx_grid_pinning_check_all_label**: `string` -- **Igx_grid_pinning_uncheck_all_label**: `string` -- **Igx_grid_pivot_aggregate_avg**: `string` -- **Igx_grid_pivot_aggregate_count**: `string` -- **Igx_grid_pivot_aggregate_date_earliest**: `string` -- **Igx_grid_pivot_aggregate_date_latest**: `string` -- **Igx_grid_pivot_aggregate_max**: `string` -- **Igx_grid_pivot_aggregate_min**: `string` -- **Igx_grid_pivot_aggregate_sum**: `string` -- **Igx_grid_pivot_aggregate_time_earliest**: `string` -- **Igx_grid_pivot_aggregate_time_latest**: `string` -- **Igx_grid_pivot_column_drop_chip**: `string` -- **Igx_grid_pivot_date_dimension_total**: `string` -- **Igx_grid_pivot_empty_column_drop_area**: `string` -- **Igx_grid_pivot_empty_filter_drop_area**: `string` -- **Igx_grid_pivot_empty_message**: `string` -- **Igx_grid_pivot_empty_row_drop_area**: `string` -- **Igx_grid_pivot_empty_value_drop_area**: `string` -- **Igx_grid_pivot_filter_drop_chip**: `string` -- **Igx_grid_pivot_row_drop_chip**: `string` -- **Igx_grid_pivot_selector_columns**: `string` -- **Igx_grid_pivot_selector_filters**: `string` -- **Igx_grid_pivot_selector_panel_empty**: `string` -- **Igx_grid_pivot_selector_rows**: `string` -- **Igx_grid_pivot_selector_values**: `string` -- **Igx_grid_pivot_value_drop_chip**: `string` -- **Igx_grid_required_validation_error**: `string` -- **Igx_grid_row_edit_btn_cancel**: `string` -- **Igx_grid_row_edit_btn_done**: `string` -- **Igx_grid_row_edit_text**: `string` -- **Igx_grid_snackbar_addrow_actiontext**: `string` -- **Igx_grid_snackbar_addrow_label**: `string` -- **Igx_grid_summary_average**: `string` -- **Igx_grid_summary_count**: `string` -- **Igx_grid_summary_earliest**: `string` -- **Igx_grid_summary_latest**: `string` -- **Igx_grid_summary_max**: `string` -- **Igx_grid_summary_min**: `string` -- **Igx_grid_summary_sum**: `string` -- **Igx_grid_toolbar_actions_filter_prompt**: `string` -- **Igx_grid_toolbar_advanced_filtering_button_label**: `string` -- **Igx_grid_toolbar_advanced_filtering_button_tooltip**: `string` -- **Igx_grid_toolbar_exporter_button_label**: `string` -- **Igx_grid_toolbar_exporter_button_tooltip**: `string` -- **Igx_grid_toolbar_exporter_csv_entry_text**: `string` -- **Igx_grid_toolbar_exporter_excel_entry_text**: `string` -- **Igx_grid_toolbar_hiding_button_tooltip**: `string` -- **Igx_grid_toolbar_hiding_title**: `string` -- **Igx_grid_toolbar_pinning_button_tooltip**: `string` -- **Igx_grid_toolbar_pinning_title**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGridRow](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridRow) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **GetContext**(col: object, row: object): void -- **GetContextAsync**(col: object, row: object): Task -- **GetContextMRL**(pinnedCols: object, row: object): void -- **GetContextMRLAsync**(pinnedCols: object, row: object): Task - -### [IgbGridRowDragGhostContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridRowDragGhostContext) - -- **constructor**(): void -- **Data**: `object` -- **Grid**: `IgbGridBaseDirective` -- **Implicit**: `object` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridRowEditActionsTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridRowEditActionsTemplateContext) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridRowEditEndedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridRowEditEndedEventArgs) - -- **constructor**(): void -- **Item**: `object` — Gets the row item. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Row**: `int` — Gets the row that ended editing. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridRowEditStartedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridRowEditStartedEventArgs) - -- **constructor**(): void -- **Item**: `object` — Gets the row item. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Row**: `int` — Gets the row that started editing. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridRowEditTextTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridRowEditTextTemplateContext) - -- **constructor**(): void -- **Implicit**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridRowEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridRowEventArgs) -Represents an event argument related to grid row interactions. - -- **constructor**(): void -- **Detail**: `IgbGridRowEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridRowEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridRowEventArgsDetail) -Represents an event argument related to grid row interactions. - -- **constructor**(): void -- **Event**: `object` — Represents the original event that occurred Examples of such events include: selecting, clicking, double clicking, etc. -- **Row**: `IgbRowType` — Represents the grid row that triggered the event. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridRowTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridRowTemplateContext) - -- **constructor**(): void -- **Implicit**: `IgbRowType` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridScrollEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridScrollEventArgs) -Event emitted when a grid is scrolled. - -- **constructor**(): void -- **Detail**: `IgbGridScrollEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridScrollEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridScrollEventArgsDetail) -Event emitted when a grid is scrolled. - -- **constructor**(): void -- **Direction**: `string` — The scroll direction - vertical or horizontal. -- **ScrollPosition**: `double` — The new scroll position -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridSelectedCellRangesChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSelectedCellRangesChangedEventArgs) -Information about the change to the selected cell ranges in the grid. - -- **constructor**(): void -- **AddedRanges**: `IgbGridSelectedCellRangesCollection` — The cell ranges added to the selection. -- **CurrentRanges**: `IgbGridSelectedCellRangesCollection` — The cell ranges currently in the selection. -- **RemovedRanges**: `IgbGridSelectedCellRangesCollection` — The cell ranges removed from the selection. -- **Type**: `string` -- **UpdatedRanges**: `IgbGridSelectedCellRangesCollection` — The cell ranges that have been updated by the grid. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridSelectedCellRangesCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSelectedCellRangesCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridSelectedCellsChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSelectedCellsChangedEventArgs) -Information about the change to the selected cells in the grid. - -- **constructor**(): void -- **AddedCells**: `IgbGridSelectedCellsCollection` — The cells added to the selection. -- **CurrentCells**: `IgbGridSelectedCellsCollection` — The current cells in the selection. -- **RemovedCells**: `IgbGridSelectedCellsCollection` — The cells removed from the selection. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridSelectedCellsCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSelectedCellsCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridSelectedItemsChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSelectedItemsChangedEventArgs) -Information about the changing selected items in the grid. - -- **constructor**(): void -- **AddedItems**: `IgbGridSelectedItemsCollection` — The items added to the selection. -- **CurrentItems**: `IgbGridSelectedItemsCollection` — The items added to the selection. -- **RemovedItems**: `IgbGridSelectedItemsCollection` — The items removed from the selection. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridSelectedItemsCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSelectedItemsCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridSelectedKeysChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSelectedKeysChangedEventArgs) -Information about the change to the selected keys in the grid. - -- **constructor**(): void -- **AddedKeys**: `IgbGridSelectedKeysCollection` — The keys added to the selection. -- **CurrentKeys**: `IgbGridSelectedKeysCollection` — All keys in the selection. -- **RemovedKeys**: `IgbGridSelectedKeysCollection` — The keys removed from the selection. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridSelectedKeysCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSelectedKeysCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridSelectionChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSelectionChangedEventArgs) -Event arguments for the SelectionChanged event. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridSelectionRange](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSelectionRange) -Represents a range selection between certain rows and columns of the grid. Range selection can be made either through drag selection or through keyboard selection. - -- **constructor**(): void -- **ColumnEnd**: `double` — The identifier or index of the ending column of the selection range. It can be either a string representing the column's field name or a numeric index. -- **ColumnStart**: `double` — The identifier or index of the starting column of the selection range. It can be either a string representing the column's field name or a numeric index. -- **RowEnd**: `double` — The index of the ending row of the selection range. -- **RowStart**: `double` — The index of the starting row of the selection range. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridSelectionRangeDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSelectionRangeDetail) -Represents a range selection between certain rows and columns of the grid. Range selection can be made either through drag selection or through keyboard selection. - -- **constructor**(): void -- **ColumnEnd**: `double` — The identifier or index of the ending column of the selection range. It can be either a string representing the column's field name or a numeric index. -- **ColumnStart**: `double` — The identifier or index of the starting column of the selection range. It can be either a string representing the column's field name or a numeric index. -- **RowEnd**: `double` — The index of the ending row of the selection range. -- **RowStart**: `double` — The index of the starting row of the selection range. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridSelectionRangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSelectionRangeEventArgs) - -- **constructor**(): void -- **Detail**: `IgbGridSelectionRangeDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridSizeChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSizeChangedEventArgs) -Event arguments for the SizeChanged event. - -- **constructor**(): void -- **Height**: `double` — The new height. -- **Type**: `string` -- **Width**: `double` — The new width. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridSortDescriptionsChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSortDescriptionsChangedEventArgs) -Information about the current sorting applied to the grid. - -- **constructor**(): void -- **SortDescriptions**: `IgbColumnSortDescriptionCollection` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridSortingStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSortingStrategy) -Represents a sorting strategy for the grid data Contains a single method sort that sorts the provided data based on the given sorting expressions - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGridState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridState) -State component allows saving and restoring the state of the grid features. IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, * - -- **constructor**(): void -- **GridBaseDirectiveParent**: `BaseRendererControl` -- **HierarchicalGridParent**: `BaseRendererControl` -- **StateParsed**: `EventCallback` -- **StateParsedScript**: `string` -- **Type**: `string` -- **ApplyState**(state: IgbGridStateInfo, features: string[]): void -- **ApplyStateAsync**(state: IgbGridStateInfo, features: string[]): Task -- **ApplyStateFromString**(state: string, features: string[]): void -- **ApplyStateFromStringAsync**(state: string, features: string[]): Task -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetState**(features: string[]): IgbGridStateInfo -- **GetStateAsString**(features: string[]): string -- **GetStateAsStringAsync**(features: string[]): Task -- **GetStateAsync**(features: string[]): Task -- **OnInitializedAsync**(): Task - -### [IgbGridStateBaseDirective](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridStateBaseDirective) - -- **constructor**(): void -- **Options**: `IgbGridStateOptions` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGridStateBaseDirectiveModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridStateBaseDirectiveModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridStateCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridStateCollection) - -- **constructor**(): void -- **Id**: `string` -- **ParentRowID**: `object` -- **State**: `IgbGridState` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridStateInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridStateInfo) - -- **constructor**(): void -- **AdvancedFiltering**: `IgbFilteringExpressionsTree` -- **CellSelection**: `IgbGridSelectionRange[]` -- **ColumnSelection**: `string[]` -- **Columns**: `IgbColumnState[]` -- **Expansion**: `object[]` -- **ExpansionScript**: `string` — Provides a means of setting Expansion in the JavaScript environment. -- **Filtering**: `IgbFilteringExpressionsTree` -- **GroupBy**: `IgbGroupingState` -- **Id**: `string` -- **Moving**: `bool` -- **Paging**: `IgbPagingState` -- **PinningConfig**: `IgbPinningConfig` -- **PivotConfiguration**: `IgbPivotConfiguration` -- **RowIslands**: `IgbGridStateCollection[]` -- **RowPinning**: `object[]` -- **RowPinningScript**: `string` — Provides a means of setting RowPinning in the JavaScript environment. -- **RowSelection**: `object[]` -- **RowSelectionScript**: `string` — Provides a means of setting RowSelection in the JavaScript environment. -- **Sorting**: `IgbSortingExpression[]` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridStateInfoDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridStateInfoDetail) - -- **constructor**(): void -- **AdvancedFiltering**: `IgbFilteringExpressionsTree` -- **CellSelection**: `IgbGridSelectionRange[]` -- **ColumnSelection**: `string[]` -- **Columns**: `IgbColumnState[]` -- **Expansion**: `object[]` -- **ExpansionScript**: `string` — Provides a means of setting Expansion in the JavaScript environment. -- **Filtering**: `IgbFilteringExpressionsTree` -- **GroupBy**: `IgbGroupingState` -- **Id**: `string` -- **Moving**: `bool` -- **Paging**: `IgbPagingState` -- **PinningConfig**: `IgbPinningConfig` -- **PivotConfiguration**: `IgbPivotConfiguration` -- **RowIslands**: `IgbGridStateCollection[]` -- **RowPinning**: `object[]` -- **RowPinningScript**: `string` — Provides a means of setting RowPinning in the JavaScript environment. -- **RowSelection**: `object[]` -- **RowSelectionScript**: `string` — Provides a means of setting RowSelection in the JavaScript environment. -- **Sorting**: `IgbSortingExpression[]` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridStateInfoEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridStateInfoEventArgs) - -- **constructor**(): void -- **Detail**: `IgbGridStateInfoDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridStateModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridStateModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridStateOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridStateOptions) - -- **constructor**(): void -- **AdvancedFiltering**: `bool` -- **CellSelection**: `bool` -- **ColumnSelection**: `bool` -- **Columns**: `bool` -- **Expansion**: `bool` -- **Filtering**: `bool` -- **GroupBy**: `bool` -- **Moving**: `bool` -- **Paging**: `bool` -- **PinningConfig**: `bool` -- **PivotConfiguration**: `bool` -- **RowIslands**: `bool` -- **RowPinning**: `bool` -- **RowSelection**: `bool` -- **Sorting**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGridSummaryDescriptionsChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridSummaryDescriptionsChangedEventArgs) -Information about the current summaries applied to the grid. - -- **constructor**(): void -- **SummaryDescriptions**: `IgbColumnSummaryDescriptionCollection` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridTemplateContext) - -- **constructor**(): void -- **Implicit**: `IgbGridBaseDirective` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridToolbar](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbar) -Provides a context-aware container component for UI operations for the grid components. IgxGridToolbarModule IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent - -- **constructor**(): void -- **ActualTools**: `IgbGridToolbarContentCollection` -- **ContentTools**: `IgbGridToolbarContentCollection` -- **Grid**: `IgbGridBaseDirective` — Gets/sets the grid component for the toolbar component. -- **GridBaseDirectiveParent**: `BaseRendererControl` -- **HierarchicalGridParent**: `BaseRendererControl` -- **ParentTypeName**: `string` -- **RowIslandParent**: `BaseRendererElement` -- **ShowProgress**: `bool` — When enabled, shows the indeterminate progress bar. By default this will be toggled, when the default exporter component is present and an exporting is in progress. -- **SupportsVisualChildren**: `bool` -- **Tools**: `IgbGridToolbarContentCollection` -- **Type**: `string` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGridToolbarActions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarActions) -Provides a way to template the action portion of the toolbar in the grid. IgxGridToolbarModule IgxGridToolbarComponent - -- **constructor**(): void -- **Actions**: `IgbGridToolbarBaseActionCollection` -- **ActualActions**: `IgbGridToolbarBaseActionCollection` -- **ContentActions**: `IgbGridToolbarBaseActionCollection` -- **ParentTypeName**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGridToolbarActionsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarActionsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridToolbarAdvancedFiltering](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarAdvancedFiltering) -Provides a pre-configured button to open the advanced filtering dialog of the grid. IgxGridToolbarModule IgxGridToolbarComponent, IgxGridToolbarActionsComponent Custom text - -- **constructor**(): void -- **OverlaySettings**: `IgbOverlaySettings` -- **ParentTypeName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGridToolbarAdvancedFilteringModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarAdvancedFilteringModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridToolbarBaseAction](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarBaseAction) - -- **constructor**(): void -- **GridToolbarActionsParent**: `BaseRendererElement` -- **Type**: `string` -- **Dispose**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task - -### [IgbGridToolbarBaseActionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarBaseActionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridToolbarCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridToolbarContent](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarContent) - -- **constructor**(): void -- **GridToolbarParent**: `BaseRendererElement` -- **Type**: `string` -- **Dispose**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task - -### [IgbGridToolbarContentCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarContentCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbGridToolbarExportEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarExportEventArgs) -Represents the arguments for the grid toolbar export event. It provides information about the grid instance, exporter service, export options, and allows the event to be canceled. - -- **constructor**(): void -- **Detail**: `IgbGridToolbarExportEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridToolbarExportEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarExportEventArgsDetail) -Represents the arguments for the grid toolbar export event. It provides information about the grid instance, exporter service, export options, and allows the event to be canceled. - -- **constructor**(): void -- **Cancel**: `bool` — cancel returns whether the event has been intercepted and stopped If the value becomes "true", it returns/exits from the method, instantiating the interface -- **Exporter**: `IgbBaseExporter` — The exporter is a base service. The type (an abstract class IgxBaseExporter) has it's own properties and methods It is used to define the format and options of the export, the exported element and methods for preparing the data from the elements for exporting -- **Grid**: `IgbGridBaseDirective` — grid represents a reference to the instance of the grid te event originated from -- **Options**: `IgbExporterOptionsBase` — Represents the different settings, that can be given to an export The type (an abstract class IgxExporterOptionsBase) has properties for column settings (whether they should be ignored) as well as method for generating a file name -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridToolbarExporter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarExporter) -Provides a pre-configured exporter component for the grid. This component still needs the actual exporter service(s) provided in the DI chain in order to export something. IgxGridToolbarModule IgxGridToolbarComponent, IgxGridToolbarActionsComponent - -- **constructor**(): void -- **ExportCSV**: `bool` — Show entry for CSV export. -- **ExportEnded**: `EventCallback` -- **ExportEndedScript**: `string` -- **ExportExcel**: `bool` — Show entry for Excel export. -- **ExportPDF**: `bool` — Show entry for PDF export. -- **ExportStarted**: `EventCallback` -- **ExportStartedScript**: `string` -- **Filename**: `string` — The name for the exported file. -- **ParentTypeName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **ExportGrid**(type: GridToolbarExporterType): void -- **ExportGridAsync**(type: GridToolbarExporterType): Task — Export the grid's data type File type to export -- **FindByName**(name: string): object - -### [IgbGridToolbarExporterModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarExporterModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridToolbarHiding](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarHiding) -Provides a pre-configured column hiding component for the grid. IgxGridToolbarModule IgxGridToolbarComponent, IgxGridToolbarActionsComponent - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGridToolbarHidingModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarHidingModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridToolbarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridToolbarPinning](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarPinning) -Provides a pre-configured column pinning component for the grid. IgxGridToolbarModule IgxGridToolbarComponent, IgxGridToolbarActionsComponent - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbGridToolbarPinningModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarPinningModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridToolbarTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarTemplateContext) - -- **constructor**(): void -- **Implicit**: `IgbGridBaseDirective` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridToolbarTitle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarTitle) -Provides a way to template the title portion of the toolbar in the grid. IgxGridToolbarModule IgxGridToolbarComponent My custom title - -- **constructor**(): void -- **ParentTypeName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGridToolbarTitleModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridToolbarTitleModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbGridValidationState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridValidationState) -Interface representing the validation state of a grid. status: The validation status ('VALID' or 'INVALID'). errors: The validation errors if any. - -- **constructor**(): void -- **Errors**: `IgbValidationErrors` -- **Status**: `ValidationStatus` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGridValidationStatusEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridValidationStatusEventArgs) -Interface representing the event arguments for the grid validation status change event. status: The validation status ('VALID' or 'INVALID'). owner: The grid instance that owns the validation state. - -- **constructor**(): void -- **Detail**: `IgbGridValidationStatusEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGridValidationStatusEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGridValidationStatusEventArgsDetail) -Interface representing the event arguments for the grid validation status change event. status: The validation status ('VALID' or 'INVALID'). owner: The grid instance that owns the validation state. - -- **constructor**(): void -- **Owner**: `IgbGridBaseDirective` -- **Status**: `ValidationStatus` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGroupByExpandState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGroupByExpandState) - -- **constructor**(): void -- **Expanded**: `bool` -- **Hierarchy**: `IgbGroupByKey[]` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGroupByExpandStateEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGroupByExpandStateEventArgs) - -- **constructor**(): void -- **Detail**: `IgbGroupByExpandState[]` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGroupByKey](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGroupByKey) - -- **constructor**(): void -- **FieldName**: `string` -- **Type**: `string` -- **Value**: `object` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGroupByRecord](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGroupByRecord) - -- **constructor**(): void -- **Column**: `IgbColumn` -- **Expression**: `IgbSortingExpression` -- **GroupParent**: `IgbGroupByRecord` -- **Groups**: `IgbGroupByRecord[]` -- **Height**: `double` -- **Level**: `double` -- **Records**: `object[]` -- **RecordsScript**: `string` — Provides a means of setting Records in the JavaScript environment. -- **Type**: `string` -- **Value**: `object` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGroupByResult](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGroupByResult) - -- **constructor**(): void -- **Data**: `object[]` -- **DataScript**: `string` — Provides a means of setting Data in the JavaScript environment. -- **Metadata**: `IgbGroupByRecord[]` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGroupByRowSelectorTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGroupByRowSelectorTemplateContext) - -- **constructor**(): void -- **Implicit**: `IgbGroupByRowSelectorTemplateDetails` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGroupByRowSelectorTemplateDetails](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGroupByRowSelectorTemplateDetails) - -- **constructor**(): void -- **GroupRow**: `IgbGroupByRecord` -- **SelectedCount**: `double` -- **TotalCount**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbGroupByRowTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGroupByRowTemplateContext) - -- **constructor**(): void -- **Implicit**: `IgbGroupByRecord` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGroupData](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGroupData) -Object used to store group information for group headers. - -- **constructor**(): void -- **FormattedText**: `string` — The value as formatted text. -- **GroupName**: `string` — The grouping key. -- **GroupValue**: `object` — The group value. -- **GroupValueScript**: `string` — Provides a means of setting GroupValue in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbGroupingDoneEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGroupingDoneEventArgs) - -- **constructor**(): void -- **Detail**: `IgbGroupingDoneEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGroupingDoneEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGroupingDoneEventArgsDetail) - -- **constructor**(): void -- **Expressions**: `IgbSortingExpression[]` -- **GroupedColumns**: `IgbColumn[]` -- **Type**: `string` -- **UngroupedColumns**: `IgbColumn[]` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGroupingExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGroupingExpression) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGroupingExpressionEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGroupingExpressionEventArgs) - -- **constructor**(): void -- **Detail**: `IgbGroupingExpression[]` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbGroupingState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbGroupingState) - -- **constructor**(): void -- **DefaultExpanded**: `bool` -- **Expansion**: `IgbGroupByExpandState[]` -- **Expressions**: `IgbGroupingExpression[]` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbHeadSelectorTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHeadSelectorTemplateContext) - -- **constructor**(): void -- **Implicit**: `IgbHeadSelectorTemplateDetails` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbHeadSelectorTemplateDetails](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHeadSelectorTemplateDetails) - -- **constructor**(): void -- **SelectedCount**: `double` -- **TotalCount**: `double` -- **Type**: `string` -- **DeselectAll**(): void -- **DeselectAllAsync**(): Task -- **FindByName**(name: string): object -- **SelectAll**(): void -- **SelectAllAsync**(): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHeader) -Represents a base class used to configure the appearance of the column header cells. - -- **constructor**(): void -- **ActualSortIndicatorColor**: `string` — Gets the actual background color that is used for the cells when they are selected -- **ActualSortIndicatorStyle**: `SortIndicatorStyle` -- **PaddingBottom**: `int` — Gets or sets the amount of bottom padding to use for the cell content. -- **PaddingLeft**: `int` — Gets or sets the amount of left padding to use for the cell content. -- **PaddingRight**: `int` — Gets or sets the amount of right padding to use for the cell content. -- **PaddingTop**: `int` — Gets or sets the amount of top padding to use for the cell content. -- **SortIndicatorColor**: `string` — Gets or sets the color to use for the sort indicator icon -- **SortIndicatorStyle**: `SortIndicatorStyle` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbHeaderRowSeparator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHeaderRowSeparator) -Represents a Header Row separator. This is used to visually separate the header row from the rest of the rows in a grid. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbHeaderRowSeparatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHeaderRowSeparatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbHeaderSeparator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHeaderSeparator) - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbHeaderSeparatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHeaderSeparatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbHeaderType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHeaderType) -Interface representing a header cell in the grid. It is essentially the blueprint to a header cell object. Contains definitions of properties, relevant to the header - -- **constructor**(): void -- **Column**: `IgbColumn` — The column that the header cell represents. -- **Selectable**: `bool` — Indicates whether the cell can be selected -- **Selected**: `bool` — Indicates whether the cell is currently selected -- **SortDirection**: `SortingDirection` — Represents the sorting direction of the column (ascending, descending or none). -- **Sorted**: `bool` — Indicates whether the column is currently sorted. -- **Title**: `bool` — Indicates whether the column header is a title cell. -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbHeatTileGenerator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHeatTileGenerator) - -- **constructor**(): void -- **BlurRadius**: `double` -- **LogarithmBase**: `double` -- **MaxBlurRadius**: `double` -- **MaximumColor**: `string` -- **MaximumValue**: `double` -- **MinimumColor**: `string` -- **MinimumValue**: `double` -- **ScaleColorOffsets**: `double[]` -- **ScaleColors**: `Color[]` -- **Type**: `string` -- **UseBlurRadiusAdjustedForZoom**: `bool` -- **UseGlobalMinMax**: `bool` -- **UseGlobalMinMaxAdjustedForZoom**: `bool` -- **UseLogarithmicScale**: `bool` -- **UseWebWorkers**: `bool` -- **Values**: `double[]` -- **WebWorkerInstance**: `object` -- **WebWorkerInstanceScript**: `string` — Provides a means of setting WebWorkerInstance in the JavaScript environment. -- **WebWorkerScriptPath**: `string` -- **XValues**: `double[]` -- **YValues**: `double[]` -- **Destroy**(): void -- **DestroyAsync**(): Task -- **FindByName**(name: string): object - -### [IgbHeatTileGeneratorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHeatTileGeneratorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbHierarchicalGrid](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHierarchicalGrid) -Hierarchical grid IgxHierarchicalGridModule - -- **constructor**(): void -- **ActualChildLayoutList**: `IgbRowIslandCollection` -- **ChildLayoutList**: `IgbRowIslandCollection` -- **ContentChildLayoutList**: `IgbRowIslandCollection` -- **Data**: `object` -- **DataScript**: `string` — Provides a means of setting Data in the JavaScript environment. -- **ExpandChildren**: `bool` -- **Id**: `string` -- **ParentTypeName**: `string` -- **TotalItemCount**: `double` — Gets/Sets the total number of records in the data source. This property is required for remote grid virtualization to function when it is bound to remote data. const itemCount = this.grid1.totalItemCount; this.grid1.totalItemCount = 55; -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCellByColumn**(rowIndex: double, columnField: string): IgbCellType -- **GetCellByColumnAsync**(rowIndex: double, columnField: string): Task -- **GetCellByKey**(rowSelector: object, columnField: string): IgbCellType -- **GetCellByKeyAsync**(rowSelector: object, columnField: string): Task -- **GetDefaultExpandState**(record: object): void -- **GetDefaultExpandStateAsync**(record: object): Task -- **GetForeignKey**(): object -- **GetForeignKeyAsync**(): Task -- **GetRowByIndex**(index: double): IgbRowType -- **GetRowByIndexAsync**(index: double): Task — Returns the RowType by index. const myRow = this.grid1.getRowByIndex(1); index -- **GetRowByKey**(key: object): IgbRowType -- **GetRowByKeyAsync**(key: object): Task — Returns the RowType by key. const myRow = this.grid1.getRowByKey(1); key -- **GetSelectedCells**(): IgbCellType[] -- **GetSelectedCellsAsync**(): Task -- **PinRow**(rowID: object, index: double): bool -- **PinRowAsync**(rowID: object, index: double): Task -- **UnpinRow**(rowID: object): bool -- **UnpinRowAsync**(rowID: object): Task - -### [IgbHierarchicalGridBaseDirective](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHierarchicalGridBaseDirective) - -- **constructor**(): void -- **DataPreLoad**: `EventCallback` -- **DataPreLoadScript**: `string` -- **HasChildrenKey**: `string` -- **RootGrid**: `IgbGridBaseDirective` -- **ShowExpandAll**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbHierarchicalGridModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHierarchicalGridModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbHierarchicalRingSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHierarchicalRingSeries) -Represents a IgbDoughnutChart hierarchical series. - -- **constructor**(): void -- **ChildrenMemberPath**: `string` — Gets or sets the property name that contains the children items collection. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbHierarchicalRingSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHierarchicalRingSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbHighDensityScatterSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHighDensityScatterSeries) -Represents a IgbDataChart series where a high volume of scatter points can be displayed. - -- **constructor**(): void -- **HeatMaximum**: `double` — Gets or sets the value that maps to the maximum heat color. -- **HeatMaximumColor**: `string` — Gets or sets the color to use for the maximum end of the scale. -- **HeatMinimum**: `double` — Gets or sets the density value that maps to the minimum heat color. -- **HeatMinimumColor**: `string` — Gets or sets the color to use for the minimum end of the scale. -- **PointExtent**: `int` — Gets or sets the the pixel extent of the square data points that are rendered. -- **ProgressiveLoad**: `bool` — Gets or sets the whether to progressively load the data into the chart. -- **ProgressiveLoadStatusChanged**: `EventCallback` -- **ProgressiveLoadStatusChangedScript**: `string` -- **ProgressiveStatus**: `int` — Represents the current status of the progressive load of the series. It will range from 0 to 100, where 100 is fully loaded. -- **Type**: `string` -- **UseBruteForce**: `bool` — Gets or sets the whether to use use brute force mode. -- **XAxis**: `IgbNumericXAxis` — Gets or sets the effective x-axis for the current object. -- **XAxisName**: `string` — Gets or sets the name to use to resolve xAxis from markup. -- **XAxisScript**: `string` — Provides a means of setting XAxis in the JavaScript environment. -- **XMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series X value in the Data Legend. -- **XMemberAsLegendUnit**: `string` — Gets or sets the unit after displayed after series X value in the Data Legend. -- **XMemberPath**: `string` — Gets or sets the x value mapping property for the current series object. -- **YAxis**: `IgbNumericYAxis` — Gets or sets the effective y-axis for the current object. -- **YAxisName**: `string` — Gets or sets the name to use to resolve yAxis from markup. -- **YAxisScript**: `string` — Provides a means of setting YAxis in the JavaScript environment. -- **YMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series Y value in the Data Legend. -- **YMemberAsLegendUnit**: `string` — Gets or sets the unit after displayed after series Y value in the Data Legend. -- **YMemberPath**: `string` — Gets or sets the y value mapping property for the current series object. -- **BindAxes**(Axes: IgbAxis[]): void -- **CanUseAsXAxis**(axis: object): bool -- **CanUseAsXAxisAsync**(axis: object): Task — Determine if object can be used as XAxis -- **CanUseAsYAxis**(axis: object): bool -- **CanUseAsYAxisAsync**(axis: object): Task — Determine if object can be used as YAxis -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the series to display the item for the specified data item. - -### [IgbHighDensityScatterSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHighDensityScatterSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbHighlightingInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHighlightingInfo) -Contains contextual information about a highlighting. - -- **constructor**(): void -- **Context**: `object` — The context for the highlight. -- **ContextScript**: `string` — Provides a means of setting Context in the JavaScript environment. -- **EndIndex**: `int` — The index of the last highlighted item. -- **IsExclusive**: `bool` — TODO -- **IsFullRange**: `bool` — True if this HighlightingInfo represents a full selection of the data. -- **IsMarker**: `bool` — True if this HighlightingInfo represents a marker highlighting. -- **Progress**: `double` — A number between 0 and 1 representing the progress of the highlighting. -- **StartIndex**: `int` — The index of the first highlighted item. -- **State**: `HighlightingState` — The state of the highlighting. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbHoleDimensionsChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHoleDimensionsChangedEventArgs) -EventArgs class holding information about the dimensions of a hole in a doughnut chart. - -- **constructor**(): void -- **Center**: `Point` — The center point of the hole. -- **Radius**: `double` — The radius of the hole. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbHorizontalAnchoredCategorySeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHorizontalAnchoredCategorySeries) -Base class for anchored category series with a category x-axis and a numeric y-axis. - -- **constructor**(): void -- **Type**: `string` -- **XAxis**: `IgbCategoryAxisBase` — Gets or sets the effective x-axis for this series. -- **XAxisName**: `string` — Gets or sets the name to use to resolve xAxis from markup. -- **XAxisScript**: `string` — Provides a means of setting XAxis in the JavaScript environment. -- **YAxis**: `IgbNumericYAxis` — Gets or sets the effective y-axis for this series. -- **YAxisName**: `string` — Gets or sets the name to use to resolve yAxis from markup. -- **YAxisScript**: `string` — Provides a means of setting YAxis in the JavaScript environment. -- **BindAxes**(Axes: IgbAxis[]): void -- **CanUseAsXAxis**(axis: object): bool -- **CanUseAsXAxisAsync**(axis: object): Task — Determine if object can be used as XAxis -- **CanUseAsYAxis**(axis: object): bool -- **CanUseAsYAxisAsync**(axis: object): Task — Determine if object can be used as YAxis -- **FindByName**(name: string): object -- **GetCategoryWidth**(): double -- **GetCategoryWidthAsync**(): Task — Returns the width of the category grouping this series is in. -- **GetNextOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetNextOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetOffsetValue**(): double -- **GetOffsetValueAsync**(): Task — Returns the offset value for this series if grouped on a category axis. -- **GetPreviousOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetPreviousOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetSeriesValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValueMarkerBoundingBox**(world: Point): Rect -- **GetSeriesValueMarkerBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided. -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task - -### [IgbHorizontalAnchoredCategorySeriesProxyModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHorizontalAnchoredCategorySeriesProxyModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbHorizontalPropertyEditorDataSource](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHorizontalPropertyEditorDataSource) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbHorizontalRangeCategorySeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHorizontalRangeCategorySeries) -Base class for ranged category series with a category X-axis and a numeric Y-axis. - -- **constructor**(): void -- **HighMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series' High value in the Data Legend. -- **HighMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series' High value in the Data Legend. -- **LowMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series' Low value in the Data Legend. -- **LowMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series' Low value in the Data Legend. -- **Type**: `string` -- **XAxis**: `IgbCategoryAxisBase` — Gets or sets the effective x-axis for the current CategorySeries object. -- **XAxisName**: `string` — Gets or sets the name to use to resolve xAxis from markup. -- **XAxisScript**: `string` — Provides a means of setting XAxis in the JavaScript environment. -- **YAxis**: `IgbNumericYAxis` — Gets or sets the effective y-axis for the current CategorySeries object. -- **YAxisName**: `string` — Gets or sets the name to use to resolve yAxis from markup. -- **YAxisScript**: `string` — Provides a means of setting YAxis in the JavaScript environment. -- **BindAxes**(Axes: IgbAxis[]): void -- **CanUseAsXAxis**(axis: object): bool -- **CanUseAsXAxisAsync**(axis: object): Task — Determine if object can be used as XAxis -- **CanUseAsYAxis**(axis: object): bool -- **CanUseAsYAxisAsync**(axis: object): Task — Determine if object can be used as YAxis -- **FindByName**(name: string): object -- **GetCategoryWidth**(): double -- **GetCategoryWidthAsync**(): Task — Returns the width of the category grouping this series is in. -- **GetNextOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetNextOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetOffsetValue**(): double -- **GetOffsetValueAsync**(): Task — Returns the offset value for this series if grouped on a category axis. -- **GetPreviousOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetPreviousOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetSeriesHighValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesHighValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesHighValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesHighValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesLowValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesLowValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesLowValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesLowValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task - -### [IgbHorizontalRangeCategorySeriesProxyModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHorizontalRangeCategorySeriesProxyModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbHorizontalStackedSeriesBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbHorizontalStackedSeriesBase) -Base class for stacked series with a category x-axis and a numeric y-axis. - -- **constructor**(): void -- **Type**: `string` -- **XAxis**: `IgbCategoryAxisBase` — Gets or sets the effective x-axis for this series. -- **XAxisName**: `string` — Gets or sets the name to use to resolve xAxis from markup. -- **XAxisScript**: `string` — Provides a means of setting XAxis in the JavaScript environment. -- **YAxis**: `IgbNumericYAxis` — Gets or sets the effective y-axis for this series. -- **YAxisName**: `string` — Gets or sets the name to use to resolve yAxis from markup. -- **YAxisScript**: `string` — Provides a means of setting YAxis in the JavaScript environment. -- **BindAxes**(Axes: IgbAxis[]): void -- **CanUseAsXAxis**(axis: object): bool -- **CanUseAsXAxisAsync**(axis: object): Task — Determine if object can be used as XAxis -- **CanUseAsYAxis**(axis: object): bool -- **CanUseAsYAxisAsync**(axis: object): Task — Determine if object can be used as YAxis -- **FindByName**(name: string): object -- **GetCategoryWidth**(): double -- **GetCategoryWidthAsync**(): Task — Returns the width of the category grouping this series is in. -- **GetOffsetValue**(): double -- **GetOffsetValueAsync**(): Task — Returns the offset value for this series if grouped on a category axis. - -### [IgbIcon](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbIcon) -The icon component allows visualizing collections of pre-registered SVG icons. - -- **constructor**(): void -- **Collection**: `string` — The name of the registered collection for look up of icons. Defaults to default. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **IconName**: `string` — The name of the icon glyph to draw. -- **Mirrored**: `bool` — Whether to flip the icon. Useful for RTL layouts. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ConnectedCallback**(): void -- **ConnectedCallbackAsync**(): Task -- **DisconnectedCallback**(): void -- **DisconnectedCallbackAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **RegisterIcon**(name: string, url: string, collection: string): void -- **RegisterIconAsync**(name: string, url: string, collection: string): Task -- **RegisterIconFromText**(name: string, iconText: string, collection: string): void -- **RegisterIconFromTextAsync**(name: string, iconText: string, collection: string): Task -- **ResolveDisplay**(): string -- **SetIconRef**(name: string, collection: string, icon: IgbIconMeta): void -- **SetIconRefAsync**(name: string, collection: string, icon: IgbIconMeta): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbIconButton](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbIconButton) - -- **constructor**(): void -- **Collection**: `string` — The name of the icon collection. -- **DirectRenderElementName**: `string` -- **IconName**: `string` — The name of the icon. -- **Mirrored**: `bool` — Whether to flip the icon button. Useful for RTL layouts. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Variant**: `IconButtonVariant` — The visual variant of the icon button. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **RegisterIcon**(name: string, url: string, collection: string): void -- **RegisterIconAsync**(name: string, url: string, collection: string): Task -- **RegisterIconFromText**(name: string, iconText: string, collection: string): void -- **RegisterIconFromTextAsync**(name: string, iconText: string, collection: string): Task -- **ResolveDisplay**(): string - -### [IgbIconButtonModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbIconButtonModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbIconMeta](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbIconMeta) - -- **constructor**(): void -- **Collection**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbIconModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbIconModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbImageCapturedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbImageCapturedEventArgs) - -- **constructor**(): void -- **Base64Data**: `string` — Gets the captured image as Base64. -- **Image**: `object` — Gets the captured image. -- **ImageScript**: `string` — Provides a means of setting Image in the JavaScript environment. -- **Settings**: `IgbCaptureImageSettings` — Gets the settings used to capture the image. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbImageCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbImageCellInfo) -Backing information for an image cell in the grid. - -- **constructor**(): void -- **ImagePath**: `string` — Sets or gets the resource path to use to get the image for the cell. -- **ImageResourceType**: `ImageResourceType` — Sets or gets the image resource type. Indicates which type of resource should be fetched and how ImagePath should be interpreted. -- **ImageStretchOption**: `ImageStretchOptions` — Sets or gets the image stretching behavior for the image. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbImageColumn](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbImageColumn) -Represents an Image grid column, used to allow the developer to display an image in a cell. - -- **constructor**(): void -- **ActualEditorDataSource**: `IgbBaseDataSource` -- **EditorDataSource**: `object` — Gets or sets the ComboBox data source. -- **EditorDataSourceScript**: `string` — Provides a means of setting EditorDataSource in the JavaScript environment. -- **EditorTextField**: `string` — Gets or sets the ComboBox text field. -- **EditorType**: `EditorType` — Gets or sets the editor type used for editing cells in this column. -- **EditorValueField**: `string` — Gets or sets the ComboBox value field. -- **ImageStretchOption**: `ImageStretchOptions` — Gets or sets the stretch option to use when rendering images -- **ParentTypeName**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbImageColumnModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbImageColumnModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbImageLoadEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbImageLoadEventArgs) -Represents event arguments for updating label of callout layer - -- **constructor**(): void -- **Data**: `object` — Gets loaded data -- **DataScript**: `string` — Provides a means of setting Data in the JavaScript environment. -- **Error**: `string` — Gets error message on failed loading data -- **Path**: `string` — Gets URL path of loaded data -- **Status**: `ImageLoadStatus` — Gets status of loading data -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbImageTilesReadyEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbImageTilesReadyEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbImagesChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbImagesChangedEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbIndexCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbIndexCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbIndicatorDisplayTypeCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbIndicatorDisplayTypeCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbIndicatorProxyModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbIndicatorProxyModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbIndicatorsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbIndicatorsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbInput](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbInput) - -- **constructor**(): void -- **Autocomplete**: `string` — The autocomplete attribute of the control. -- **Autofocus**: `bool` — The autofocus attribute of the control. -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DirectRenderElementName**: `string` -- **DisplayType**: `InputType` — The type attribute of the control. -- **InputMode**: `string` — The input mode attribute of the control. See relevant MDN article -- **Max**: `double?` — The max attribute of the control. -- **MaxLength**: `double?` — The maximum string length of the control. -- **Min**: `double?` — The min attribute of the control. -- **MinLength**: `double?` — The minimum string length required by the control. -- **Pattern**: `string` — The pattern attribute of the control. -- **ReadOnly**: `bool` — Makes the control a readonly field. false -- **Step**: `double?` — The step attribute of the control. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ValidateOnly**: `bool` — Enables validation rules to be evaluated without restricting user input. This applies to the maxLength property for string-type inputs or allows spin buttons to exceed the predefined min/max limits for number-type inputs. false -- **Value**: `string` — The value of the control. -- **ValueChanged**: `EventCallback` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): string -- **GetCurrentValueAsync**(): Task -- **ResolveDisplay**(): string -- **SetParametersAsync**(parameters: ParameterView): Task -- **StepDown**(n: double): void -- **StepDownAsync**(n: double): Task — Decrements the numeric value of the input by one or more steps. -- **StepUp**(n: double): void -- **StepUpAsync**(n: double): Task — Increments the numeric value of the input by one or more steps. - -### [IgbInputBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbInputBase) - -- **constructor**(): void -- **Blur**: `EventCallback` -- **BlurScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — The disabled state of the component -- **Focus**: `EventCallback` -- **FocusScript**: `string` -- **InputOcurred**: `EventCallback` -- **InputOcurredScript**: `string` -- **Invalid**: `bool` — Control the validity of the control. -- **Label**: `string` — The label for the control. -- **Outlined**: `bool` — Whether the control will have outlined appearance. false -- **Placeholder**: `string` — The placeholder attribute of the control. -- **Required**: `bool` — Makes the control a required field in a form context. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ValueChanging**: `EventCallback` -- **BlurComponent**(): void -- **BlurComponentAsync**(): Task — Removes focus from the control. -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task — Checks for validity of the control and emits the invalid event if it invalid. -- **FindByName**(name: string): object -- **FocusComponent**(options: IgbFocusOptions): void -- **FocusComponentAsync**(options: IgbFocusOptions): Task — Sets focus on the control. -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task — Checks for validity of the control and shows the browser message if it invalid. -- **ResolveDisplay**(): string -- **Select**(): void -- **SelectAsync**(): Task — Selects all the text inside the input. -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task — Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid. -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **SetParametersAsync**(parameters: ParameterView): Task - -### [IgbInputBaseModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbInputBaseModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbInputChangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbInputChangeEventArgs) - -- **constructor**(): void -- **IsCompositionInProgress**: `bool` -- **Type**: `string` -- **Value**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbInputModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbInputModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbItemLegend](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbItemLegend) -Represents a legend that displays an item for each point in the series. - -- **constructor**(): void -- **Orientation**: `LegendOrientation` — Gets or sets the current Legend object's orientation. -- **TextColor**: `string` — Gets or sets color of text -- **TextStyle**: `string` — Gets or sets style of text. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbItemLegendModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbItemLegendModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbItemRequestedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbItemRequestedEventArgs) - -- **constructor**(): void -- **Item**: `object` — Gets or sets the item being requested. -- **Values**: `Dictionary` — Gets or sets the values that will be propagated to the requested item when the event is complete. -- **ValuesPropagated**: `bool` — Gets or sets whether the values have already been propagated to the item. Set this to true if you do not want the values propagated after the event is completed. - -### [IgbItemToolTipLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbItemToolTipLayer) -Represents an annotation layer that displays tooltips for all target series individually. - -- **constructor**(): void -- **SkipUnknownValues**: `bool` — Gets or sets whether to skip past unknown values when searching for series values. -- **TargetSeries**: `IgbSeries` — Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously. -- **TargetSeriesName**: `string` — Gets or sets the name of the series series to target this annotation to. If null, this annotation targets all series simultaneously. -- **TargetSeriesScript**: `string` — Provides a means of setting TargetSeries in the JavaScript environment. -- **ToolTipBackground**: `string` — Gets or sets the background of the tooltip containers. -- **ToolTipBorderBrush**: `string` — Gets or sets the border color of the tooltip containers. -- **ToolTipBorderThickness**: `double` — Gets or sets the border thickness of the tooltip containers. -- **Type**: `string` -- **UseInterpolation**: `bool` — Gets or sets whether to use value interpolation when drawing the tooltips. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **HideToolTips**(): void -- **HideToolTipsAsync**(): Task — Hides any tooltips presented by the layer, if any. -- **HideToolTipsImmediate**(): void -- **HideToolTipsImmediateAsync**(): Task — Hides any tooltips presented by the layer, if any. - -### [IgbItemToolTipLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbItemToolTipLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbItemwiseStrategyBasedIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbItemwiseStrategyBasedIndicator) -Financial indicator base class for doing calculating an itemwize indicator. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **ResolveIsItemwise**(): bool -- **ResolveIsItemwiseAsync**(): Task — This is a marker method to distinguish this from a public api perspective on some platforms compared to the base strategy based indicators. - -### [IgbKeyBindingHandler](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbKeyBindingHandler) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbKeyBindingOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbKeyBindingOptions) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbKeyEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbKeyEventArgs) -Event args for KeyUp and KeyDown events. - -- **constructor**(): void -- **Alt**: `bool` — Gets a value indicating whether the ALT key was pressed. -- **Ctrl**: `bool` — Gets a value indicating whether the CTRL key was pressed. -- **DefaultPrevented**: `bool` — Gets whether the PreventDefault method was called. -- **KeyCode**: `int` — Gets the keyboard code for a KeyDown or KeyUp event. -- **Modifiers**: `ModifierKeys` — Gets the modifier flags for a KeyDown or KeyUp event. The flags indicate which combination of CTRL, SHIFT, and ALT keys was pressed. -- **OriginalEvent**: `object` -- **OriginalEventScript**: `string` — Provides a means of setting OriginalEvent in the JavaScript environment. -- **Shift**: `bool` — Gets a value indicating whether the SHIFT key was pressed. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **PreventDefault**(): void -- **PreventDefaultAsync**(): Task — Tells the user agent that if the event does not get explicitly handled, its default action should not be taken as it normally would be. -- **StopPropagation**(): void -- **StopPropagationAsync**(): Task — Prevent the event from bubbling up. -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLabelClickEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLabelClickEventArgs) -Contains PieChart label click event data. - -- **constructor**(): void -- **AllowSliceClick**: `bool` — Gets and sets whether or not the owning pie chart should fire its SliceClick event -- **Item**: `object` — Gets the slice data context. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLabelFormatOverrideEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLabelFormatOverrideEventArgs) -Event args used byt the LabelFormatOverride Delegate to provide a way to override default label functionality.. - -- **constructor**(): void -- **DateTime**: `DateTime` — The DateTime the override is invoked with. -- **Format**: `IgbTimeAxisLabelFormat` — The format to which this override is attached. -- **Label**: `string` — Gets or sets the label that should be used. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLastMonthExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLastMonthExpression) -Requests an expression for the LastMonth filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLastQuarterExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLastQuarterExpression) -Represents an expression for the LastQuarter filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLastSevenDaysExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLastSevenDaysExpression) -Requests an expression for the LastSevenDays filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLastThirtyDaysExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLastThirtyDaysExpression) -Requests an expression for the LastThirtyDays filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLastThreeSixtyFiveDaysExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLastThreeSixtyFiveDaysExpression) -Requests an expression for the LastThreeSixtyFiveDays filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLastWeekExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLastWeekExpression) -Requests an expression for the LastWeek filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLastYearExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLastYearExpression) -Requests an expression for the LastYear filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLayoutChangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLayoutChangeEventArgs) - -- **constructor**(): void -- **Detail**: `IgbDockManagerLayout` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLayoutPrimaryKeyValue](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLayoutPrimaryKeyValue) -A primary key value. - -- **constructor**(): void -- **Key**: `string[]` — The primary key associated with this value. -- **Type**: `string` -- **Value**: `object[]` — The value of the keys for this primary key value. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLayoutPrimaryKeyValueModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLayoutPrimaryKeyValueModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbLayoutSelectedItemsCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLayoutSelectedItemsCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbLayoutSelectedKeysCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLayoutSelectedKeysCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbLegend](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLegend) -Represents a legend in a IgbDataChart control. - -- **constructor**(): void -- **Orientation**: `LegendOrientation` — Gets or sets the current Legend object's orientation. -- **TextColor**: `string` — Gets or sets color of text -- **TextStyle**: `string` — Gets or sets style of text. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbLegendBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLegendBase) -Represents the base class for a legend in IgbDataChart. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **LegendItemMouseEnter**: `EventCallback` -- **LegendItemMouseEnterScript**: `string` -- **LegendItemMouseLeave**: `EventCallback` -- **LegendItemMouseLeaveScript**: `string` -- **LegendItemMouseLeftButtonDown**: `EventCallback` -- **LegendItemMouseLeftButtonDownScript**: `string` -- **LegendItemMouseLeftButtonUp**: `EventCallback` -- **LegendItemMouseLeftButtonUpScript**: `string` -- **LegendItemMouseMove**: `EventCallback` -- **LegendItemMouseMoveScript**: `string` -- **LegendTextContentChanged**: `EventCallback` -- **LegendTextContentChangedScript**: `string` -- **Type**: `string` -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Returns the legend visuals expressed as a serialized string. -- **FindByName**(name: string): object -- **FlushTextContentChangedCheck**(): void -- **FlushTextContentChangedCheckAsync**(): Task — Use to force the Legend to check for differences in text content. -- **SimulateClick**(point: Point): void -- **SimulateClickAsync**(point: Point): Task -- **SimulateHover**(point: Point): void -- **SimulateHoverAsync**(point: Point): Task -- **SimulateMouseLeave**(): void -- **SimulateMouseLeaveAsync**(): Task - -### [IgbLegendModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLegendModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbLegendMouseButtonEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLegendMouseButtonEventArgs) -Provides data for legend mouse button related events. - -- **constructor**(): void -- **Handled**: `bool` — Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. -- **Item**: `object` — Gets the ItemsSource item associated with the current event. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **LegendItem**: `object` — The legend item that was the target of the mouse event. -- **LegendItemScript**: `string` — Provides a means of setting LegendItem in the JavaScript environment. -- **OriginalSource**: `object` — Gets a reference to the object that raised the event. -- **OriginalSourceScript**: `string` — Provides a means of setting OriginalSource in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLegendMouseEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLegendMouseEventArgs) -Provides data for legend mouse button related events. - -- **constructor**(): void -- **Item**: `object` — Gets the ItemsSource item associated with the current event. -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **LegendItem**: `object` — The legend item in context. -- **LegendItemScript**: `string` — Provides a means of setting LegendItem in the JavaScript environment. -- **OriginalSource**: `object` — Gets a reference to the object that raised the event. -- **OriginalSourceScript**: `string` — Provides a means of setting OriginalSource in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLegendTextContentChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLegendTextContentChangedEventArgs) -Provides data for legend's text content changed event. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLineFragment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLineFragment) -Represents one part of a StackedLineSeries. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbLineFragmentModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLineFragmentModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbLineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLineSeries) -Represents a IgbDataChart line series. Displays trend over time or ordered categories. Useful when there are many data points and the order is important. - -- **constructor**(): void -- **Type**: `string` -- **UnknownValuePlotting**: `UnknownValuePlotting` — Determines how unknown values will be plotted on the chart. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbLineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbLinearContourValueResolver](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLinearContourValueResolver) -ContourValueResolver class which resolves contour lines to be distributed at linear intervals from the data minimum to the data maximum. - -- **constructor**(): void -- **Type**: `string` -- **ValueCount**: `int` — Gets or sets how many contour values to return. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbLinearContourValueResolverModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLinearContourValueResolverModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbLinearGauge](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLinearGauge) -A linear gauge for displaying a single value on a defined scale. - -- **constructor**(): void -- **ActualHighlightValueDisplayMode**: `HighlightedValueDisplayMode` — Gets whether and how to display the highlighted value. -- **ActualHighlightValueOpacity**: `double` — Gets the actual opacity of the primary needle while highlighting -- **ActualLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ActualMaximumValue**: `double` — Gets the resolved maximum value of the scale. -- **ActualMaximumValueChanged**: `Action` -- **ActualMaximumValueChangedScript**: `string` -- **ActualMinimumValue**: `double` — Gets the resolved minimum value of the scale. -- **ActualMinimumValueChanged**: `Action` -- **ActualMinimumValueChangedScript**: `string` -- **ActualPixelScalingRatio**: `double` — Gets the actual pixel scaling ratio used to affect the pixel density of the control. -- **ActualRanges**: `IgbLinearGraphRangeCollection` -- **AlignLabel**: `EventCallback` -- **AlignLabelScript**: `string` -- **BackingBrush**: `string` — Gets or sets the brush to use to fill the backing of the linear gauge. -- **BackingInnerExtent**: `double` — Gets or sets the inner extent of the linear gauge backing. -- **BackingOuterExtent**: `double` — Gets or sets the outer extent of the linear gauge backing. -- **BackingOutline**: `string` — Gets or sets the brush to use for the outline of the backing. -- **BackingStrokeThickness**: `double` — Gets or sets the stroke thickness of the backing outline. -- **ContentLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ContentRanges**: `IgbLinearGraphRangeCollection` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Font**: `string` — Gets or sets the font. -- **FontBrush**: `string` — Gets or sets the brush to use for the label font. -- **FormatLabel**: `EventCallback` -- **FormatLabelScript**: `string` -- **HighlightValue**: `double` — Gets or sets the highlight value at which to point the secondary needle of the gauge. -- **HighlightValueChanged**: `Action` -- **HighlightValueChangedScript**: `string` -- **HighlightValueDisplayMode**: `HighlightedValueDisplayMode` — Gets or sets whether and how to display the highlighted value. -- **HighlightValueOpacity**: `double` — Gets or sets the opacity of the primary needle while highlighting -- **Interval**: `double` — Gets or sets the interval to use for the scale. -- **IsHighlightNeedleDraggingEnabled**: `bool` — Gets or sets whether highlight needle dragging is enabled or not. -- **IsNeedleDraggingEnabled**: `bool` — Gets or sets whether needle dragging is enabled or not. -- **IsScaleInverted**: `bool` — Gets or sets a value indicating whether the scale is inverted. When the scale is inverted the direction in which the scale values increase is right to left. -- **LabelExtent**: `double` — Gets or sets the position at which to put the labels as a value from 0 to 1, measured from the bottom of the scale. Values further from zero than 1 can be used to hide the labels of the linear gauge. -- **LabelFormat**: `string` — Gets or sets the label composite format used when creating label values. -- **LabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the LabelFormat string. -- **LabelInterval**: `double` — Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale. -- **LabelsPostInitial**: `double` — A value to start adding labels, added to the scale's MinimumValue. -- **LabelsPreTerminal**: `double` — A value to stop adding labels, subtracted from the scale's MaximumValue. -- **LabelsVisible**: `bool` — Gets or sets whether the labels are visible in the gauge. -- **MaximumValue**: `double` — Gets or sets the maximum value of the scale. -- **MergeViewports**: `bool` — Gets or sets whether the scale viewport will be merged with backing viewport. -- **MinimumValue**: `double` — Gets or sets the minimum value of the scale. -- **MinorTickBrush**: `string` — Gets or sets the brush to use for the minor tickmarks. -- **MinorTickCount**: `double` — Gets or sets the number of minor tickmarks to place between major tickmarks. -- **MinorTickEndExtent**: `double` — Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **MinorTickStartExtent**: `double` — Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **MinorTickStrokeThickness**: `double` — Gets or sets the stroke thickness to use when rendering minor ticks. -- **NeedleBreadth**: `double` — Gets or sets the needle breadth. -- **NeedleBrush**: `string` — Gets or sets the brush to use for needle element. -- **NeedleInnerBaseWidth**: `double` — Gets or sets the width of the needle's inner base. -- **NeedleInnerExtent**: `double` — Gets or sets the position at which to start rendering the needle geometry, measured from the front/bottom of the linear gauge as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **NeedleInnerPointExtent**: `double` — Gets or sets the extent of the needle's inner point. -- **NeedleInnerPointWidth**: `double` — Gets or sets the width of the needle's inner point. -- **NeedleName**: `string` — Gets or sets the name used for needle. -- **NeedleOuterBaseWidth**: `double` — Gets or sets the width of the needle's outer base. -- **NeedleOuterExtent**: `double` — Gets or sets the position at which to stop rendering the needle geometry as a value from 0 to 1 measured from the front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **NeedleOuterPointExtent**: `double` — Gets or sets the extent of the needle's outer point. -- **NeedleOuterPointWidth**: `double` — Gets or sets the width of the needle's outer point. -- **NeedleOutline**: `string` — Gets or sets the brush to use for the outline of needle element. -- **NeedleShape**: `LinearGraphNeedleShape` — Gets or sets the shape to use when rendering the needle from a number of options. -- **NeedleStrokeThickness**: `double` — Gets or sets the stroke thickness to use when rendering single actual value element. -- **Orientation**: `LinearScaleOrientation` — Gets or sets the orientation of the scale. -- **ParentTypeName**: `string` -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **RangeBrushes**: `string` — Gets or sets a collection of brushes to be used as the palette for linear gauge ranges. -- **RangeInnerExtent**: `double` — Gets or sets the position at which to start rendering the ranges, measured from the front/bottom of the control as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **RangeOuterExtent**: `double` — Gets or sets the position at which to stop rendering the range as a value from 0 to 1 measured from the front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **RangeOutlines**: `string` — Gets or sets a collection of brushes to be used as the palette for linear gauge outlines. -- **Ranges**: `IgbLinearGraphRangeCollection` — Gets or sets the scale ranges to render on the linear gauge. -- **ScaleBrush**: `string` — Gets or sets the brush to use to fill the scale of the linear gauge. -- **ScaleEndExtent**: `double` — Gets or sets the position at which to stop rendering the scale as a value from 0 to 1, measured from the front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **ScaleInnerExtent**: `double` — Gets or sets the position at which to start rendering the scale, measured from the bottom/front (when orientation is horizontal/vertical) of the control as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **ScaleOuterExtent**: `double` — Gets or sets the position at which to stop rendering the scale as a value from 0 to 1 measured from the bottom/front (when orientation is horizontal/vertical) of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **ScaleOutline**: `string` — Gets or sets the brush to use for the outline of the scale. -- **ScaleStartExtent**: `double` — Gets or sets the position at which to start rendering the scale, measured from the front/bottom of the linear gauge as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **ScaleStrokeThickness**: `double` — Gets or sets the stroke thickness of the scale outline. -- **ShowToolTip**: `bool` — Gets or sets a value indicating whether tooltips are enabled. -- **ShowToolTipTimeout**: `int` — Gets or sets the time in milliseconds that tooltip appearance is delayed with. -- **TickBrush**: `string` — Gets or sets the brush to use for the major tickmarks. -- **TickEndExtent**: `double` — Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **TickStartExtent**: `double` — Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the front/bottom of the linear gauge. Values further from zero than 1 can be used to make this extend further than the normal size of the linear gauge. -- **TickStrokeThickness**: `double` — Gets or sets the stroke thickness to use when rendering ticks. -- **TicksPostInitial**: `double` — A value to start adding tickmarks, added to the scale's MinimumValue. -- **TicksPreTerminal**: `double` — A value to stop adding tickmarks, subtracted from the scale's MaximumValue. -- **TransitionDuration**: `int` — Gets or sets the number of milliseconds over which changes to the linear gauge should be animated. -- **TransitionProgress**: `double` — Gets the transition progress of the animation when the control is animating. -- **Type**: `string` -- **Value**: `double` — Gets or sets the value at which the needle is positioned. -- **ValueChanged**: `Action` -- **ValueChangedScript**: `string` -- **ContainerResized**(): void -- **ContainerResizedAsync**(): Task -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Returns visuals as a serialized string. -- **FindByName**(name: string): object -- **Flush**(): void -- **FlushAsync**(): Task — Use to force the linear gauge to finish any deferred work before printing or evaluating its visual. -- **GetCurrentActualMaximumValue**(): double -- **GetCurrentActualMaximumValueAsync**(): Task -- **GetCurrentActualMinimumValue**(): double -- **GetCurrentActualMinimumValueAsync**(): Task -- **GetCurrentHighlightValue**(): double -- **GetCurrentHighlightValueAsync**(): Task -- **GetCurrentValue**(): double -- **GetCurrentValueAsync**(): Task -- **GetValueForPoint**(point: Point): double -- **GetValueForPointAsync**(point: Point): Task — Gets the value for the main scale of the gauge for a given point within the bounds of the gauge. -- **HighlightNeedleContainsPoint**(point: Point, isFinger: bool): bool -- **HighlightNeedleContainsPointAsync**(point: Point, isFinger: bool): Task -- **NeedleContainsPoint**(point: Point, isFinger: bool): bool -- **NeedleContainsPointAsync**(point: Point, isFinger: bool): Task -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task — Called by the UI framework to provide a UI container for rendering this control. -- **StyleUpdated**(): void -- **StyleUpdatedAsync**(): Task - -### [IgbLinearGaugeCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLinearGaugeCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbLinearGaugeDashboardTileModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLinearGaugeDashboardTileModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbLinearGaugeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLinearGaugeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbLinearGraphRange](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLinearGraphRange) -Represents a range in the IgbBulletGraph and IgbLinearGauge controls. - -- **constructor**(): void -- **Brush**: `string` — Gets or sets the brush to use to fill the range. -- **EndValue**: `double` — Gets or sets the value at which the range ends along the scale. -- **InnerEndExtent**: `double` — Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to end rendering the inner edge of the range. Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. -- **InnerStartExtent**: `double` — Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to start rendering the inner edge of the range. Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. -- **LinearGraphParent**: `BaseRendererControl` -- **OuterEndExtent**: `double` — Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to end rendering the outer edge of the range. Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. -- **OuterStartExtent**: `double` — Gets or sets the distance measured from the front/bottom of the bullet graph (from 0 to 1) at which to start rendering the outer edge of the range. Values further from zero than 1 can be used to make this extend further than the normal width/height of the bullet graph. -- **Outline**: `string` — Gets or sets the outline to use when rendering the range. -- **StartValue**: `double` — Gets or sets the value at which the range starts along the scale. -- **StrokeThickness**: `double` — Gets or sets the stroke thickness to use when rendering this range's outline. -- **Type**: `string` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task - -### [IgbLinearGraphRangeCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLinearGraphRangeCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbLinearGraphRangeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLinearGraphRangeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbLinearProgress](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLinearProgress) -A linear progress indicator used to express unspecified wait time or display the length of a process. - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **LabelAlign**: `LinearProgressLabelAlign` — The position for the default label of the control. -- **Striped**: `bool` — Sets the striped look of the control. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbLinearProgressModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLinearProgressModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbList](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbList) -Displays a collection of data items in a templatable list format. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbListHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListHeader) -Header list item. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbListHeaderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListHeaderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbListItem](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListItem) -The list-item component is a container intended for row items in the list component. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Selected**: `bool` — Defines if the list item is selected or not. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbListItemModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListItemModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbListModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbListPanel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanel) - -- **constructor**(): void -- **ActivationBorder**: `string` — Gets or sets the activation border color to use. -- **ActivationBorderBottomWidth**: `int` — Gets or sets the amount of bottom activation border to use for the cell content of this column. -- **ActivationBorderLeftWidth**: `int` — Gets or sets the amount of left activation border to use for the cell content for this column. -- **ActivationBorderRightWidth**: `int` — Gets or sets the amount of right activation border to use for the cell content of this column. -- **ActivationBorderTopWidth**: `int` — Gets or sets the amount of top activation border to use for the cell content for this column. -- **ActivationMode**: `ListPanelActivationMode` — Sets or gets the grid selection mode. -- **ActiveRow**: `int` — Gets or sets the position of the active row. -- **ActiveRowChanged**: `Action` -- **ActiveRowChangedScript**: `string` -- **ActualPrimaryKey**: `string[]` — Gets either the inferred primary key from the data source, or the user provided primary key, if present. Represents the actual primary key that the grid will use in operations that require it. -- **ActualPrimaryKeyChanged**: `EventCallback` -- **ActualPrimaryKeyChangedScript**: `string` -- **ActualRowHeight**: `double` -- **BackgroundColor**: `string` — Gets or sets the color to use for the background of the component. -- **CellFontFamily**: `string` -- **CellFontSize**: `double` -- **CellFontStyle**: `string` -- **CellFontWeight**: `string` -- **ContentRefreshed**: `Action` -- **ContentRefreshedScript**: `string` -- **DataSource**: `object` — Gets or sets the data to which to bind the grid. This can be some type of array or list, or it can be an IDataSource instance. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **IsActiveRowStyleEnabled**: `bool` — Gets or sets whether the active row style will be applied to rows when made active. -- **IsCustomRowHeightEnabled**: `bool` — Gets or sets the color to use for the background of the component. -- **ItemClicked**: `EventCallback` -- **ItemClickedScript**: `string` -- **ItemHeightRequested**: `EventCallback` -- **ItemHeightRequestedScript**: `string` -- **ItemRebind**: `Action` -- **ItemRebindScript**: `string` -- **ItemRecycled**: `Action` -- **ItemRecycledScript**: `string` -- **ItemSpacing**: `double` — Gets or sets the spacing between items. -- **ItemWidthRequested**: `EventCallback` -- **ItemWidthRequestedScript**: `string` -- **NormalBackground**: `string` — Gets or sets the background color to use. -- **NotifyOnAllSelectionChanges**: `bool` — Gets or sets if the grid should notify on programmatic selection changes as well as changes from the UI. -- **Orientation**: `ListPanelOrientation` — Gets or sets the color to use for the background of the component. -- **PrimaryKey**: `string[]` — Sets or gets the user provided primary key to assume for the data. Certain functionality of the grid requires a way to uniquely identify items in order to work correctly. If a primary key cannot be inferred from the data source, you may need to provide one here. -- **RowHeight**: `int` — Gets or Sets the property name that contains the values. -- **RowUpdating**: `EventCallback` -- **RowUpdatingScript**: `string` -- **SchemaIncludedProperties**: `string[]` — Gets either the filtered properties to include in the schema of the data source. -- **ScrollbarBackground**: `string` — Gets or sets the scrollbar background color. -- **ScrollbarStyle**: `ScrollbarStyle` — Gets or sets the style of scrollbar. -- **SelectedBackground**: `string` — Gets or sets the background color to use for the cells when they are selected -- **SelectedItems**: `IgbListPanelSelectedItemsCollection` — Gets which items are currently selected in the grid. Collection can be updated to programatically select items. -- **SelectedItemsChanged**: `Action` -- **SelectedItemsChangedScript**: `string` -- **SelectedKeys**: `IgbListPanelSelectedKeysCollection` — Gets which primary key values are currently selected in the grid. Collection can be updated to programatically select items. -- **SelectedKeysChanged**: `Action` -- **SelectedKeysChangedScript**: `string` -- **SelectionBehavior**: `ListPanelSelectionBehavior` — Sets or gets how selection behaves in the grid. -- **SelectionChanged**: `Action` -- **SelectionChangedScript**: `string` -- **SelectionMode**: `ListPanelSelectionMode` — Sets or gets the grid selection mode. -- **TextColor**: `string` — Gets or sets the color to use for the text of the component. -- **Type**: `string` -- **DataIndexOfItem**(item: object): int -- **DataIndexOfItemAsync**(item: object): Task — Returns the data index of an item within the bound data source. -- **DeselectAllRows**(): void -- **DeselectAllRowsAsync**(): Task — Deselects all currently selected rows. -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object -- **GetCurrentActiveRow**(): int -- **GetCurrentActiveRowAsync**(): Task -- **GetCurrentActualPrimaryKey**(): string[] -- **GetCurrentActualPrimaryKeyAsync**(): Task -- **GetCurrentSelectedItems**(): IgbListPanelSelectedItemsCollection -- **GetCurrentSelectedItemsAsync**(): Task -- **GetCurrentSelectedKeys**(): IgbListPanelSelectedKeysCollection -- **GetCurrentSelectedKeysAsync**(): Task -- **GetFirstVisibleIndex**(): int -- **GetFirstVisibleIndexAsync**(): Task — Gets the first visible index in the grid. -- **GetItemKey**(primaryKey: string[], item_: object): IgbListPanelPrimaryKeyValue -- **GetItemKeyAsync**(primaryKey: string[], item_: object): Task -- **GetLastVisibleIndex**(): int -- **GetLastVisibleIndexAsync**(): Task — Gets the last visible index in the grid. -- **GetRowKey**(primaryKey: string[], rowIndex: int): IgbListPanelPrimaryKeyValue -- **GetRowKeyAsync**(primaryKey: string[], rowIndex: int): Task -- **InvalidateVisibleItems**(): void -- **InvalidateVisibleItemsAsync**(): Task — Invalidates the bound data for the rows currently visible. -- **ScrollToLastRowByIndex**(rowNumber: double): void -- **ScrollToLastRowByIndexAsync**(rowNumber: double): Task — Scrolls the grid so that a row is the last visible, by index. -- **ScrollToRowByIndex**(rowNumber: double): void -- **ScrollToRowByIndexAsync**(rowNumber: double): Task — Scrolls the grid to given row, by index -- **SelectAllRows**(): void -- **SelectAllRowsAsync**(): Task — Selects all of the rows in the grid. - -### [IgbListPanelActiveRowChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelActiveRowChangedEventArgs) -Information about the change to the selected cells in the grid. - -- **constructor**(): void -- **NewActiveRow**: `int` — The new active row. -- **OldActiveRow**: `int` — The old active row. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbListPanelContentRebindEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelContentRebindEventArgs) -Information about list item content that was just rebound. - -- **constructor**(): void -- **RowObject**: `object` — The model that is rebinding. -- **RowObjectScript**: `string` — Provides a means of setting RowObject in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbListPanelContentRecycledEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelContentRecycledEventArgs) -Information about list item content that was just recycled. - -- **constructor**(): void -- **RowObject**: `object` — The model that was recycled. -- **RowObjectScript**: `string` — Provides a means of setting RowObject in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbListPanelContentRefreshedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelContentRefreshedEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbListPanelItemEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelItemEventArgs) -Event arguments for the SelectionChanged event. - -- **constructor**(): void -- **IsDoubleClick**: `bool` -- **IsLeftButton**: `bool` -- **ItemInfo**: `IgbListPanelItemModel` -- **ListPanel**: `IgbListPanel` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbListPanelItemModel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelItemModel) - -- **constructor**(): void -- **DataRow**: `int` -- **IsActivated**: `bool` -- **IsActivationSupported**: `bool` -- **IsModelDirty**: `bool` -- **IsSelected**: `bool` -- **Left**: `double` -- **RowHeight**: `double` -- **RowObject**: `object` -- **RowObjectScript**: `string` — Provides a means of setting RowObject in the JavaScript environment. -- **Top**: `double` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbListPanelModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbListPanelPrimaryKeyValue](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelPrimaryKeyValue) -A primary key value. - -- **constructor**(): void -- **Key**: `string[]` — The primary key associated with this value. -- **Type**: `string` -- **Value**: `object[]` — The value of the keys for this primary key value. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbListPanelPrimaryKeyValueModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelPrimaryKeyValueModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbListPanelSelectedItemsChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelSelectedItemsChangedEventArgs) -Information about the changing selected items in the grid. - -- **constructor**(): void -- **AddedItems**: `IgbListPanelSelectedItemsCollection` — The items added to the selection. -- **CurrentItems**: `IgbListPanelSelectedItemsCollection` — The items added to the selection. -- **RemovedItems**: `IgbListPanelSelectedItemsCollection` — The items removed from the selection. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbListPanelSelectedItemsCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelSelectedItemsCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbListPanelSelectedKeysChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelSelectedKeysChangedEventArgs) -Information about the change to the selected keys in the grid. - -- **constructor**(): void -- **AddedKeys**: `IgbListPanelSelectedKeysCollection` — The keys added to the selection. -- **CurrentKeys**: `IgbListPanelSelectedKeysCollection` — All keys in the selection. -- **RemovedKeys**: `IgbListPanelSelectedKeysCollection` — The keys removed from the selection. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbListPanelSelectedKeysCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelSelectedKeysCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbListPanelSelectionChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelSelectionChangedEventArgs) -Event arguments for the SelectionChanged event. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbListPanelTemplateHeightRequestedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelTemplateHeightRequestedEventArgs) - -- **constructor**(): void -- **DataItem**: `object` -- **DataItemScript**: `string` — Provides a means of setting DataItem in the JavaScript environment. -- **DataRow**: `int` -- **Height**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbListPanelTemplateItemUpdatingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelTemplateItemUpdatingEventArgs) - -- **constructor**(): void -- **AvailableWidth**: `double` -- **Content**: `object` -- **ContentScript**: `string` — Provides a means of setting Content in the JavaScript environment. -- **Model**: `IgbListPanelItemModel` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbListPanelTemplateWidthRequestedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbListPanelTemplateWidthRequestedEventArgs) - -- **constructor**(): void -- **DataItem**: `object` -- **DataItemScript**: `string` — Provides a means of setting DataItem in the JavaScript environment. -- **DataRow**: `int` -- **Type**: `string` -- **Width**: `double` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLiteralFilterExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLiteralFilterExpression) -Represents a literal value filter expression. - -- **constructor**(): void -- **IsLiteral**: `bool` — Gets if the expression is a literal value. -- **IsNull**: `bool` — Gets if the expression is a null value. -- **LeaveUnquoted**: `bool` — Gets or sets whether the value should be emitted unquoted. -- **LiteralValue**: `object` — Gets or sets the literal value to use. -- **Precedence**: `int` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbLocalDataSource](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLocalDataSource) -A local data source which has synchronous access to its data items. - -- **constructor**(): void -- **DataSource**: `object` — Gets or sets the backing data for the data source. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **Type**: `string` -- **ClearPinnedRows**(): void -- **ClearPinnedRowsAsync**(): Task -- **Clone**(): DataSource -- **CloneAsync**(): Task — Clones this data source instance, copying the summary, grouping, filter and sorting settings into the new instance. -- **FindByName**(name: string): object -- **GetIsRowExpandedAtIndex**(rowIndex: int): bool -- **GetIsRowExpandedAtIndexAsync**(rowIndex: int): Task — Gets the expansion state for a row. -- **GetItemAtIndex**(index: int): object -- **GetItemAtIndexAsync**(index: int): Task — Returns the item at the specific index in the data source. This index is based on the data source's current view of the data, not the actual underlying indexes of the original source. -- **GetItemFromKey**(key: object[]): object -- **GetItemFromKeyAsync**(key: object[]): Task -- **GetItemPropertyAtIndex**(index: int, valueName: string): object -- **GetItemPropertyAtIndexAsync**(index: int, valueName: string): Task -- **GetRootSummaryResults**(): IgbDataGridSummaryResult[] -- **GetRootSummaryResultsAsync**(): Task — Gets the summary results for the root level. -- **GetRootSummaryRowCount**(): int -- **GetRootSummaryRowCountAsync**(): Task — Gets the number of summary rows at the root level. -- **GetRowLevel**(rowIndex: int): int -- **GetRowLevelAsync**(rowIndex: int): Task — Gets the hierarchy level of the row. -- **GetRowType**(rowIndex: int): DataSourceRowType -- **GetRowTypeAsync**(rowIndex: int): Task -- **GetSectionSummaryResults**(sectionIndex: int): IgbDataGridSummaryResult[][] -- **GetSectionSummaryResultsAsync**(sectionIndex: int): Task — Gets the summary results for a specific section. -- **GetStickyRowPriority**(row: int): int -- **GetStickyRowPriorityAsync**(row: int): Task -- **IndexOfItem**(item: object): int -- **IndexOfItemAsync**(item: object): Task — Called to return the index for an item contained in the data source, or -1, if the item can't be found, or this action isn't currently supported. -- **IndexOfKey**(key: object[]): int -- **IndexOfKeyAsync**(key: object[]): Task -- **IsExclusivelySticky**(row: int): bool -- **IsExclusivelyStickyAsync**(row: int): Task -- **IsRowPinned**(row: int): bool -- **IsRowPinnedAsync**(row: int): Task -- **PinRow**(key: object[]): void -- **PinRowAsync**(key: object[]): Task -- **SetIsRowExpandedAtIndex**(rowIndex: int, isExpanded: bool): void -- **SetIsRowExpandedAtIndexAsync**(rowIndex: int, isExpanded: bool): Task -- **UnpinRow**(key: object[]): void -- **UnpinRowAsync**(key: object[]): Task - -### [IgbLocalDataSourceModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLocalDataSourceModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbLostFocusEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbLostFocusEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbMarkerSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMarkerSeries) -Represents the base class for series containing markers. - -- **constructor**(): void -- **ActualMarkerBrush**: `string` — Gets the effective marker brush for the current series object. -- **ActualMarkerOutline**: `string` — Gets the effective marker outline for the current series object. -- **ActualMarkerTemplate**: `object` — Gets the effective marker template for the current series object. -- **ActualMarkerTemplateScript**: `string` — Provides a means of setting ActualMarkerTemplate in the JavaScript environment. -- **ActualMarkerType**: `MarkerType` — Represents the resolved marker type for the series. -- **IsCustomMarkerCircular**: `bool` — Gets or sets whether the marker for the current series object should be treated as circular. -- **MarkerBrush**: `string` — Gets or sets the brush that specifies how the current series object's marker interiors are painted. -- **MarkerFillMode**: `MarkerFillMode` — Gets or sets whether the marker fill is based on the marker outline of the series rather than the marker brushes collection. -- **MarkerOutline**: `string` — Gets or sets the brush that specifies how the current series object's marker outlines are painted. -- **MarkerOutlineMode**: `MarkerOutlineMode` — Gets or sets whether the marker outline is based on the marker brush of the series rather than the marker outlines collection. -- **MarkerTemplate**: `object` — Gets or sets the MarkerTemplate for the current series object. -- **MarkerTemplateScript**: `string` — Provides a means of setting MarkerTemplate in the JavaScript environment. -- **MarkerThickness**: `double` — Gets or sets thickness of the marker outline -- **MarkerType**: `MarkerType` — Gets or sets the marker type for the current series object. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbMarkerTypeCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMarkerTypeCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbMarketFacilitationIndexIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMarketFacilitationIndexIndicator) -Represents a IgbDataChart Market Facilitation Index indicator series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbMarketFacilitationIndexIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMarketFacilitationIndexIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbMaskInput](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMaskInput) -A masked input is an input field where a developer can control user input and format the visible value, based on configurable rules - -- **constructor**(): void -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `string` — The value of the input. Regardless of the currently set value-mode, an empty value will return an empty string. -- **ValueChanged**: `EventCallback` -- **ValueMode**: `MaskInputValueMode` — Dictates the behavior when retrieving the value of the control: raw: Returns clean input (e.g. "5551234567") withFormatting: Returns with mask formatting (e.g. "(555) 123-4567") Empty values always return an empty string, regardless of the value mode. 'raw' -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): string -- **GetCurrentValueAsync**(): Task -- **ResolveDisplay**(): string - -### [IgbMaskInputBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMaskInputBase) - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **Mask**: `string` — The masked pattern of the component. 'CCCCCCCCCC' -- **Prompt**: `string` — The prompt symbol to use for unfilled parts of the mask pattern. '_' -- **ReadOnly**: `bool` — Makes the control a readonly field. false -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbMaskInputBaseModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMaskInputBaseModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbMaskInputModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMaskInputModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbMassIndexIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMassIndexIndicator) -Represents a IgbDataChart Mass Index indicator series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbMassIndexIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMassIndexIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbMedianPriceIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMedianPriceIndicator) -Represents a IgbDataChart Median Price indicator series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbMedianPriceIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMedianPriceIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbMoneyFlowIndexIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMoneyFlowIndexIndicator) -Represents a IgbDataChart Money Flow Index indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current MoneyFlowIndexIndicator object. The typical, and initial, value for MoneyFlowIndexIndicator periods is 14. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbMoneyFlowIndexIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMoneyFlowIndexIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbMonthToDateExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMonthToDateExpression) -Requests an expression for the MonthToDate filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbMoveFloatingPaneAction](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMoveFloatingPaneAction) - -- **constructor**(): void -- **ActionType**: `PaneDragActionType` -- **NewLocation**: `IgbDockManagerPoint` -- **OldLocation**: `IgbDockManagerPoint` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbMoveFloatingPaneActionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMoveFloatingPaneActionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbMoveTabAction](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMoveTabAction) - -- **constructor**(): void -- **ActionType**: `PaneDragActionType` -- **NewIndex**: `double` -- **OldIndex**: `double` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbMoveTabActionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMoveTabActionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbMovingAverageConvergenceDivergenceIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMovingAverageConvergenceDivergenceIndicator) -Represents a IgbDataChart Moving Average Convergence/Divergence (MACD) indicator series. - -- **constructor**(): void -- **LongPeriod**: `int` — Gets or sets the long moving average period for the current MovingAverageConvergenceDivergenceIndicator object. The typical, and initial, value for long MACD periods is 30. -- **ShortPeriod**: `int` — Gets or sets the short moving average period for the current MovingAverageConvergenceDivergenceIndicator object. The typical, and initial, value for short MACD periods is 10. -- **SignalPeriod**: `int` — Gets or sets the long moving average period for the current MovingAverageConvergenceDivergenceIndicator object. The typical, and initial, value for long PVO periods is 30. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbMovingAverageConvergenceDivergenceIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMovingAverageConvergenceDivergenceIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbMultiColumnComboBox](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMultiColumnComboBox) - -- **constructor**(): void -- **ActualBackgroundColor**: `string` — Gets the actual opacity to use for the underline ripple element. -- **ActualBaseTheme**: `BaseControlTheme` — Gets the actual display baseTheme to use for the component. -- **ActualBorderColor**: `string` — Gets the actual item background color. -- **ActualBorderWidth**: `double` — Gets the actual item border width. -- **ActualContentPaddingBottom**: `double` -- **ActualContentPaddingLeft**: `double` -- **ActualContentPaddingRight**: `double` -- **ActualContentPaddingTop**: `double` -- **ActualCornerRadiusBottomLeft**: `double` -- **ActualCornerRadiusBottomRight**: `double` -- **ActualCornerRadiusTopLeft**: `double` -- **ActualCornerRadiusTopRight**: `double` -- **ActualDensity**: `ControlDisplayDensity` — Gets the actual display Density to use for the component. -- **ActualFocusBorderColor**: `string` — Gets the actual item border color. -- **ActualFocusBorderWidth**: `double` — Gets the actual item border width. -- **ActualFocusUnderlineColor**: `string` — Gets the actual color to use for the underline element when focused. -- **ActualFocusUnderlineOpacity**: `double` — Gets the actual opacity to use for the underline element when focused. -- **ActualFocusUnderlineRippleOpacity**: `double` — Gets the actual opacity to use for the underline ripple element when focused. -- **ActualHoverUnderlineColor**: `string` — Gets the actual color to use for the underline element. -- **ActualHoverUnderlineOpacity**: `double` — Gets the actual opacity to use for the underline element when hovered. -- **ActualHoverUnderlineWidth**: `double` — Gets the width to use for the underline element when hovered. -- **ActualLabelTextColor**: `string` — Gets the actual color to use for the text color. -- **ActualLabelVisible**: `bool` — Gets or sets the visibility of the label. -- **ActualNoMatchesFoundLabel**: `string` — Gets the actual text to display on the list when no suggested matches are found. -- **ActualNoMatchesFoundLabelBackgroundColor**: `string` — Gets the actual color to use for the "no matches found" label. -- **ActualNoMatchesFoundLabelTextColor**: `string` — Gets the actual color to use for the "no matches found" label. -- **ActualTextColor**: `string` — Gets the actual color to use for the text color. -- **ActualUnderlineColor**: `string` — Gets the actual color to use for the underline element. -- **ActualUnderlineOpacity**: `double` — Gets the actual opacity to use for the underline element. -- **ActualUnderlineRippleColor**: `string` — Gets the actual color to use for the underline ripple element. -- **ActualUnderlineRippleOpacity**: `double` — Gets the actual opacity to use for the underline ripple element. -- **ActualUnderlineRippleWidth**: `double` — Gets the actual width to use for the underline element. -- **ActualUnderlineWidth**: `double` — Gets the actual width to use for the underline element. -- **ActualValueField**: `string[]` — Gets the actual name of the field in the data source will be used as the Value of the MultiColumnComboBox. -- **AllowFilter**: `bool` — Whether to allow filtering of the combo -- **BackgroundColor**: `string` — Gets or sets the background color to use for the input group. -- **BaseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the component. -- **BorderColor**: `string` — Gets or sets the color to use the border of the input group. -- **BorderWidth**: `double` — Gets or sets the border width to use for the border of the item group. -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Changing**: `EventCallback` -- **ChangingScript**: `string` -- **ColumnHeadersVisible**: `bool` — Gets or sets the visibility of the drop down button. -- **ContentPaddingBottom**: `double` -- **ContentPaddingLeft**: `double` -- **ContentPaddingRight**: `double` -- **ContentPaddingTop**: `double` -- **CornerRadiusBottomLeft**: `double` -- **CornerRadiusBottomRight**: `double` -- **CornerRadiusTopLeft**: `double` -- **CornerRadiusTopRight**: `double` -- **DataSource**: `object` — Gets or sets the data to which to bind the combo box list. This can be some type of array or list, or it can be an IDataSource instance. -- **DataSourceDesiredProperties**: `string[]` — Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DefaultColumnWidth**: `double` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or sets the display Density to use for the buttons and dropdown grid. -- **DropDownButtonVisible**: `bool` — Gets or sets the visibility of the drop down button. -- **Fields**: `string[]` — Gets or sets the desired properties for the data source to load. If specified the data source may decide to constrain the properties it fetches to these properties and must make sure that at least those properties are loaded, rather than the default behavior for that data source. -- **FocusBorderColor**: `string` — Gets or sets the color to use the hovered background of the inputs in the group. -- **FocusBorderWidth**: `double` — Gets or sets the border width to use for the border of the item group when focused. -- **FocusUnderlineColor**: `string` — Gets or sets the color to use for the underline element. -- **FocusUnderlineOpacity**: `double` — Gets or sets the color to use for the underline element. -- **FocusUnderlineRippleOpacity**: `double` — Gets or sets the opacity to use for the underline ripple element when focused. -- **FontFamily**: `string` -- **FontSize**: `double` -- **FontStyle**: `string` -- **FontWeight**: `string` -- **GotFocus**: `EventCallback` -- **GotFocusScript**: `string` -- **HoverUnderlineColor**: `string` — Gets or sets the color to use for the underline element. -- **HoverUnderlineOpacity**: `double` — Gets or sets the color to use for the underline element. -- **HoverUnderlineWidth**: `double` — Gets or sets the width to use for the underline element when hovered. -- **IsFixed**: `bool` — Indicates that the dropdown will position itself relative to the window instead of the document. -- **KeyDown**: `EventCallback` -- **KeyDownScript**: `string` -- **Label**: `string` — The text displayed in the label portion of the control. -- **LabelFontFamily**: `string` -- **LabelFontSize**: `double` -- **LabelFontStyle**: `string` -- **LabelFontWeight**: `string` -- **LabelTextColor**: `string` — Gets or sets the color to use for the text. -- **LostFocus**: `EventCallback` -- **LostFocusScript**: `string` -- **NoMatchesFoundLabel**: `string` — Gets or sets the text to display on the list when no suggested matches are found. -- **NoMatchesFoundLabelBackgroundColor**: `string` — Gets or sets the color to use for the "no matches found" label. -- **NoMatchesFoundLabelFontFamily**: `string` -- **NoMatchesFoundLabelFontSize**: `double` -- **NoMatchesFoundLabelFontStyle**: `string` -- **NoMatchesFoundLabelFontWeight**: `string` -- **NoMatchesFoundLabelTextColor**: `string` — Gets or sets the color to use for the "no matches found" label. -- **OpenAsChild**: `bool` — Indicates that the dropdown should open as a child of the combobox. -- **Placeholder**: `string` — Placeholder text which gives the user a hint about what kind of text is expected. -- **RowSeparatorsVisible**: `bool` — Gets or sets the visibility of the row separators in the drop down. -- **SelectedValueChanged**: `EventCallback` -- **SelectedValueChangedScript**: `string` -- **ShowClearButton**: `bool` — Gets or sets the ShowClearButton property to detirmine if the clear button is shown -- **SortMode**: `SortMode` — Returns/sets the action to take when a column header is clicked. -- **Text**: `string` — The text displayed in the edit portion of the control. -- **TextChanged**: `EventCallback` -- **TextChangedScript**: `string` -- **TextColor**: `string` — Gets or sets the color to use for the text. -- **TextField**: `string` — Determines the name of the field in the data source will be used as the Text of the MultiColumnComboBox. -- **TextValueChanged**: `EventCallback` -- **TextValueChangedScript**: `string` -- **Type**: `string` -- **UnderlineColor**: `string` — Gets or sets the color to use for the underline element. -- **UnderlineOpacity**: `double` — Gets or sets the color to use for the underline element. -- **UnderlineRippleColor**: `string` — Gets or sets the color to use for the underline ripple element. -- **UnderlineRippleOpacity**: `double` — Gets or sets the opacity to use for the underline ripple element. -- **UnderlineRippleWidth**: `double` — Gets or sets the width to use for the underline element. -- **UnderlineWidth**: `double` — Gets or sets the width to use for the underline element. -- **UseTopLayer**: `bool` — Indicates that the dropdown will place itself into the browser top layer. -- **Value**: `object` — Gets or sets the Value of the combo. -- **ValueChanged**: `EventCallback` -- **ValueChangedScript**: `string` -- **ValueField**: `string[]` — Sets or gets the user provided primary key to assume for the data. Certain functionality of the combo (such as the the current Value) requires a way to uniquely identify items in order to work correctly. If a primary key cannot be inferred from the data source, you may need to provide one here. -- **CloseUp**(): void -- **CloseUpAsync**(): Task — Programmatically closes the list. -- **DropDown**(): void -- **DropDownAsync**(): Task — Programmatically drops down the list. -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualModel**(): string -- **ExportSerializedVisualModelAsync**(): Task — Returns a serialized copy of the exported visual model -- **ExportVisualModel**(): object -- **ExportVisualModelAsync**(): Task — Exports visual information about the current state of the grid. -- **FindByName**(name: string): object -- **GetCurrentText**(): string -- **GetCurrentTextAsync**(): Task -- **GetCurrentValue**(): object -- **GetCurrentValueAsync**(): Task -- **Select**(): void -- **SelectAsync**(): Task — Selects all the text in the combo input area. - -### [IgbMultiColumnComboBoxModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMultiColumnComboBoxModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbMultiColumnComboBoxTextChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMultiColumnComboBoxTextChangedEventArgs) - -- **constructor**(): void -- **NewText**: `string` -- **OldText**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbMultiColumnComboBoxValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMultiColumnComboBoxValueChangedEventArgs) - -- **constructor**(): void -- **NewValue**: `object` -- **NewValueScript**: `string` — Provides a means of setting NewValue in the JavaScript environment. -- **OldValue**: `object` -- **OldValueScript**: `string` — Provides a means of setting OldValue in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbMultiSlider](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMultiSlider) - -- **constructor**(): void -- **ActualPixelScalingRatio**: `double` -- **AreThumbCalloutsEnabled**: `bool` -- **BarBrush**: `string` -- **BarExtent**: `double` -- **BarOutline**: `string` -- **BarStrokeThickness**: `double` -- **CalloutBrush**: `string` -- **CalloutOutline**: `string` -- **CalloutStrokeThickness**: `double` -- **CalloutTextColor**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **EndInset**: `double` -- **Max**: `double` -- **Min**: `double` -- **Orientation**: `MultiSliderOrientation` -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **RangeThumbBrush**: `string` -- **RangeThumbOutline**: `string` -- **RangeThumbRidgesBrush**: `string` -- **RangeThumbStrokeThickness**: `double` -- **ResolvingToolTipValue**: `Action` -- **ResolvingToolTipValueScript**: `string` -- **StartInset**: `double` -- **Step**: `double` -- **ThumbBrush**: `string` -- **ThumbCalloutFontFamily**: `string` -- **ThumbCalloutFontSize**: `double` -- **ThumbCalloutFontStyle**: `string` -- **ThumbCalloutFontWeight**: `string` -- **ThumbHeight**: `double` -- **ThumbOutline**: `string` -- **ThumbRidgesBrush**: `string` -- **ThumbStrokeThickness**: `double` -- **ThumbValueChanged**: `EventCallback` -- **ThumbValueChangedScript**: `string` -- **ThumbValueChanging**: `EventCallback` -- **ThumbValueChangingScript**: `string` -- **ThumbWidth**: `double` -- **Thumbs**: `IgbMultiSliderThumbCollection` — Gets the column definitions that are assigned to the grid. This collection can be modified to add or remove columns in the grid. -- **TrackEndInset**: `double` -- **TrackStartInset**: `double` -- **Type**: `string` -- **WindowRect**: `Rect` -- **YMax**: `double` -- **YMin**: `double` -- **YStep**: `double` -- **YTrackEndInset**: `double` -- **YTrackStartInset**: `double` -- **YValue**: `double` -- **YValueChanged**: `EventCallback` -- **YValueChangedScript**: `string` -- **YValueChanging**: `EventCallback` -- **YValueChangingScript**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **Flush**(): void -- **FlushAsync**(): Task -- **Hide**(): void -- **HideAsync**(): Task — Hides the ZoomSlider. -- **OnAttachedToUI**(): void -- **OnAttachedToUIAsync**(): Task -- **OnDetachedFromUI**(): void -- **OnDetachedFromUIAsync**(): Task -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task — Called by the UI framework to provide a UI container for rendering this control. -- **Show**(): void -- **ShowAsync**(): Task — Shows the ZoomSlider. -- **TrackDirty**(): void -- **TrackDirtyAsync**(): Task - -### [IgbMultiSliderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMultiSliderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbMultiSliderResolvingToolTipValueEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMultiSliderResolvingToolTipValueEventArgs) - -- **constructor**(): void -- **Position**: `double` -- **Type**: `string` -- **Value**: `object` -- **ValueScript**: `string` — Provides a means of setting Value in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbMultiSliderThumb](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMultiSliderThumb) - -- **constructor**(): void -- **PropertyUpdated**: `EventCallback` -- **PropertyUpdatedScript**: `string` -- **Range**: `object` -- **RangePosition**: `MultiSliderThumbRangePosition` -- **RangeScript**: `string` — Provides a means of setting Range in the JavaScript environment. -- **Type**: `string` -- **Value**: `double` -- **FindByName**(name: string): object -- **Push**(amount: double): double -- **PushAsync**(amount: double): Task - -### [IgbMultiSliderThumbCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMultiSliderThumbCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbMultiSliderThumbValueChangingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMultiSliderThumbValueChangingEventArgs) - -- **constructor**(): void -- **Thumb**: `IgbMultiSliderThumb` -- **Type**: `string` -- **Value**: `double` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbMultiSliderTrackThumbRange](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMultiSliderTrackThumbRange) - -- **constructor**(): void -- **HigherThumb**: `IgbMultiSliderThumb` -- **LowerThumb**: `IgbMultiSliderThumb` -- **MaxWidth**: `double` -- **MinWidth**: `double` -- **Position**: `double` -- **Type**: `string` -- **Width**: `double` -- **FindByName**(name: string): object - -### [IgbMultiSliderYValueChangingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbMultiSliderYValueChangingEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **Value**: `double` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbNavDrawer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNavDrawer) -Represents a side navigation container that provides quick access between views. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Open**: `bool` — Determines whether the drawer is opened. -- **Position**: `NavDrawerPosition` — The position of the drawer. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **Hide**(): bool -- **HideAsync**(): Task — Closes the drawer. -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(): bool -- **ShowAsync**(): Task — Opens the drawer. -- **Toggle**(): bool -- **ToggleAsync**(): Task — Toggles the open state of the drawer. - -### [IgbNavDrawerHeaderItem](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNavDrawerHeaderItem) -A wrapper for navigation drawer's header. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbNavDrawerHeaderItemModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNavDrawerHeaderItemModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNavDrawerItem](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNavDrawerItem) -Represents a navigation drawer item. - -- **constructor**(): void -- **Active**: `bool` — Determines whether the drawer is active. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — Determines whether the drawer is disabled. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbNavDrawerItemModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNavDrawerItemModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNavDrawerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNavDrawerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNavbar](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNavbar) -A navigation bar component is used to facilitate navigation through a series of hierarchical screens within an app. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbNavbarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNavbarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNegativeVolumeIndexIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNegativeVolumeIndexIndicator) -Represents a IgbDataChart Negative Volume Index indicator (NVI) series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbNegativeVolumeIndexIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNegativeVolumeIndexIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNextMonthExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNextMonthExpression) -Requests an expression for the NextMonth filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbNextQuarterExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNextQuarterExpression) -Represents an expression for the NextQuarter filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbNextWeekExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNextWeekExpression) -Requests an expression for the NextWeek filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbNextYearExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNextYearExpression) -Requests an expression for the NextYear filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbNumberAbbreviatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumberAbbreviatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNumberEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumberEventArgs) - -- **constructor**(): void -- **Detail**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbNumberFormatSpecifier](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumberFormatSpecifier) - -- **constructor**(): void -- **CompactDisplay**: `string` -- **Currency**: `string` -- **CurrencyCode**: `string` -- **CurrencyDisplay**: `string` -- **CurrencySign**: `string` -- **Locale**: `string` -- **LocaleMatcher**: `string` -- **MaximumFractionDigits**: `int` -- **MaximumSignificantDigits**: `int` -- **MinimumFractionDigits**: `int` -- **MinimumIntegerDigits**: `int` -- **MinimumSignificantDigits**: `int` -- **Notation**: `string` -- **NumberingSystem**: `string` -- **SignDisplay**: `string` -- **Style**: `string` -- **Type**: `string` -- **Unit**: `string` -- **UnitDisplay**: `string` -- **UseGrouping**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbNumberFormatSpecifierModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumberFormatSpecifierModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNumericAngleAxis](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumericAngleAxis) -Represents a IgbDataChart angle based axis for polar series. - -- **constructor**(): void -- **CompanionAxisLabelMode**: `AxisAngleLabelMode` — Gets or sets the mode axis labels will operate for the companion axis. -- **CompanionAxisStartAngleOffset**: `double` — Gets or sets angle in degress that the chart's 0th angle should be offset for the companion axis -- **LabelMode**: `AxisAngleLabelMode` — Indicates the mode axis labels will operate in. -- **StartAngleOffset**: `double` — Indicates the angle in degress that the chart's 0th angle should be offset. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetScaledAngle**(unscaledAngle: double): double -- **GetScaledAngleAsync**(unscaledAngle: double): Task — Gets the scaled angle value in radians based on the raw input. -- **GetUnscaledAngle**(scaledAngle: double): double -- **GetUnscaledAngleAsync**(scaledAngle: double): Task — Gets the raw axis value back from the angle that would be used on the chart. - -### [IgbNumericAngleAxisModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumericAngleAxisModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNumericAxisBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumericAxisBase) -Represents the base class for all IgbDataChart numeric axes. - -- **constructor**(): void -- **AbbreviateLargeNumbers**: `bool` — A boolean indicating whether or not to abbreviate large numbers. -- **AbbreviatedLabelFormat**: `string` — Gets or sets the label format string to use for the label. -- **AbbreviatedLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the AbbreviatedLabelFormat string. -- **ActualInterval**: `double` — Gets the effective value for the current Interval. -- **ActualIntervalChanged**: `Action` -- **ActualIntervalChangedScript**: `string` -- **ActualIsLogarithmic**: `bool` — Determines if the axis has a valid logarithmic scale. -- **ActualMaxPrecision**: `int` — Gets the effective value for the current max precision. -- **ActualMaximumValue**: `double` — Gets the effective maximum value for the current numeric axis object. -- **ActualMaximumValueChanged**: `Action` -- **ActualMaximumValueChangedScript**: `string` -- **ActualMinimumValue**: `double` — Gets the effective minimum value for the current numeric axis object. -- **ActualMinimumValueChanged**: `Action` -- **ActualMinimumValueChangedScript**: `string` -- **ActualMinorInterval**: `double` — Gets the effective value for the current MinorInterval. -- **ActualMinorIntervalChanged**: `Action` -- **ActualMinorIntervalChangedScript**: `string` -- **ActualVisibleMaximumValue**: `double` — Gets the effective visible maximum value for the current numeric axis object. -- **ActualVisibleMinimumValue**: `double` — Gets the effective minimum value for the current numeric axis object. -- **AutoRangeBufferMode**: `AxisRangeBufferMode` — Gets or sets how the numeric axis will adjust its range buffer to less closely fix the data from the series. -- **CompanionAxisInterval**: `double` — Gets or sets interval of labels on the companion axis. -- **CompanionAxisIsLogarithmic**: `FeatureState` — Gets or sets whether or not the companion axis is logarithmic. -- **CompanionAxisLogarithmBase**: `double` — Gets or sets logarithm base on the companion axis. -- **CompanionAxisMaximumValue**: `double` — Gets or sets maximum value the companion axis. -- **CompanionAxisMinimumValue**: `double` — Gets or sets minimum value the companion axis. -- **CompanionAxisMinorInterval**: `double` — Gets or sets interval of minor gridlines on the companion axis. -- **FavorLabellingScaleEnd**: `bool` — Gets or sets whether the axis should favor emitting a label at the end of the scale. -- **FormatAbbreviatedLabelScript**: `string` — Provides a means of setting FormatAbbreviatedLabel in the JavaScript environment. -- **Interval**: `double` — Gets or sets the Interval property. -- **IsFormattingAbbreviatedLargeNumber**: `bool` -- **IsLogarithmic**: `bool` — Gets or sets the IsLogarithmic property. -- **LogarithmBase**: `int` — Gets or sets the LogarithmBase property. -- **MaxPrecision**: `int` — Gets or sets the the maximum precision to use for the auto interval. -- **MaximumValue**: `double` — Gets or sets the MaximumValue property. -- **MinimumValue**: `double` — Gets or sets the MinimumValue property. -- **MinorInterval**: `double` — Gets or sets the MinorInterval property. -- **ReferenceValue**: `double` — Gets or sets the ReferenceValue property. -- **ShouldApplyMaxPrecisionWhenZoomed**: `bool` — Gets or sets the the maximum precision to use for the auto interval. -- **Type**: `string` -- **FindByName**(name: string): object -- **GetCurrentActualInterval**(): double -- **GetCurrentActualIntervalAsync**(): Task -- **GetCurrentActualMaximumValue**(): double -- **GetCurrentActualMaximumValueAsync**(): Task -- **GetCurrentActualMinimumValue**(): double -- **GetCurrentActualMinimumValueAsync**(): Task -- **GetCurrentActualMinorInterval**(): double -- **GetCurrentActualMinorIntervalAsync**(): Task -- **GetFullRange**(): double[] -- **GetFullRangeAsync**(): Task -- **UnscaleValue**(unscaledValue: double): double -- **UnscaleValueAsync**(unscaledValue: double): Task — Unscales a value from screen space into axis space. - -### [IgbNumericCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumericCellInfo) -Backing information for a numeric cell in the grid. - -- **constructor**(): void -- **FormatOverride**: `object` — The format options to apply to the value -- **FormatOverrideScript**: `string` — Provides a means of setting FormatOverride in the JavaScript environment. -- **FormatSpecifiers**: `IgbFormatSpecifierCollection` -- **FormatStringOverride**: `string` — The format string to apply to the value -- **HasDecimalValue**: `bool` — Sets or gets whether there is a decimal numeric value to use for the cell. -- **MaxFractionDigits**: `int` — The maximum number of decimal places to display when formatting -- **MinFractionDigits**: `int` — The minimum number of decimal places to display when formatting -- **MinIntegerDigits**: `int` — The minimum number of integer digits to display when formatting -- **NegativePrefix**: `string` — Sets or gets the text prepended to a negative numeric value -- **NegativeSuffix**: `string` — Sets or gets the text appended to a negative numeric value -- **NumericValue**: `double` — Sets or gets the numeric value to use for the cell. -- **PositivePrefix**: `string` — Sets or gets the text prepended to a positive numeric value -- **PositiveSuffix**: `string` — Sets or gets the text appended to a positive numeric value -- **ShowGroupingSeparator**: `bool` — Sets or gets if the grouping separator is shown -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbNumericColumn](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumericColumn) -Represents a Numeric grid column, used to allow the developer to display a formatted number in a cell. - -- **constructor**(): void -- **ActualEditorDataSource**: `IgbBaseDataSource` -- **ActualFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ContentFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **EditorDataSource**: `object` — Gets or sets the ComboBox data source. -- **EditorDataSourceScript**: `string` — Provides a means of setting EditorDataSource in the JavaScript environment. -- **EditorTextField**: `string` — Gets or sets the ComboBox text field. -- **EditorType**: `EditorType` — Gets or sets the editor type used for editing cells in this column. -- **EditorValueField**: `string` — Gets or sets the ComboBox value field. -- **FormatOverride**: `object` — Gets or sets the INTL NumericFormat object to use for formatting the date values. -- **FormatOverrideScript**: `string` — Provides a means of setting FormatOverride in the JavaScript environment. -- **FormatSpecifiers**: `IgbFormatSpecifierCollection` -- **FormatString**: `string` — Gets or sets the format string to apply to the value. If set, the other value formatting properties on this column are ignored. -- **MaxFractionDigits**: `int` — Gets or sets the maximum fraction digits. If FormatString is specificied this value is ignored. -- **MinFractionDigits**: `int` — Gets or sets the minimum fraction digits. If FormatString is specificied this value is ignored. -- **MinIntegerDigits**: `int` — Gets or sets the minimum integer digits. If FormatString is specificied this value is ignored. -- **NegativePrefix**: `string` — Gets or sets the string to prefix a negative value. If FormatString is specificied this value is ignored. -- **NegativeSuffix**: `string` — Gets or sets the string to suffix a negative value. If FormatString is specificied this value is ignored. -- **ParentTypeName**: `string` -- **PositivePrefix**: `string` — Gets or sets the string to prefix a positive value. If FormatString is specificied this value is ignored. -- **PositiveSuffix**: `string` — Gets or sets the string to suffix a positive value. If FormatString is specificied this value is ignored. -- **ShowGroupingSeparator**: `bool` — Gets or sets whether to show a grouping separator. If FormatString is specificied this value is ignored. -- **Type**: `string` -- **BuildRenderTree**(builder: RenderTreeBuilder): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbNumericColumnModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumericColumnModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNumericRadiusAxis](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumericRadiusAxis) -Represents a IgbDataChart radius axis for polar and radial series. - -- **constructor**(): void -- **InnerRadiusExtentScale**: `double` — Defines the percentage of the maximum radius extent to leave blank at the center of the chart. Should be a value between 0.0 and 1.0. -- **RadiusExtentScale**: `double` — Defines the percentage of the maximum radius extent to use as the maximum radius. Should be a value between 0.0 and 1.0. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetScaledValue**(unscaledValue: double): double -- **GetScaledValueAsync**(unscaledValue: double): Task — Returns a world coordinates radius length (0 - 0.5) from a raw axis value. -- **GetUnscaledValue**(scaledValue: double): double -- **GetUnscaledValueAsync**(scaledValue: double): Task — Returns a raw axis value from the world coordinates radius length provided. - -### [IgbNumericRadiusAxisModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumericRadiusAxisModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNumericXAxis](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumericXAxis) -Represents a IgbDataChart numeric X axis. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ScrollRangeIntoView**(minimum: double, maximum: double): void -- **ScrollRangeIntoViewAsync**(minimum: double, maximum: double): Task - -### [IgbNumericXAxisModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumericXAxisModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbNumericYAxis](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumericYAxis) -Represents a IgbDataChart numeric Y axis. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ScrollRangeIntoView**(minimum: double, maximum: double): void -- **ScrollRangeIntoViewAsync**(minimum: double, maximum: double): Task - -### [IgbNumericYAxisModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbNumericYAxisModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbObjectCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbObjectCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbOffsettableWeekExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOffsettableWeekExpression) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbOnBalanceVolumeIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOnBalanceVolumeIndicator) -Represents a IgbDataChart On Balance Bolume indicator series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbOnBalanceVolumeIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOnBalanceVolumeIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbOnClosedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOnClosedEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbOnCollapsedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOnCollapsedEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbOnExpandedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOnExpandedEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbOnPopupEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOnPopupEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbOpenStreetMapImagery](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOpenStreetMapImagery) -UI element class used to display OpenStreetMap imagery in the IgbGeographicMap. - -- **constructor**(): void -- **TilePath**: `string` — Gets or sets the tile path URL. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbOpenStreetMapImageryModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOpenStreetMapImageryModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbOperationFilterExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOperationFilterExpression) -Represents a filter expression that is an operator being applied to other expressions. - -- **constructor**(): void -- **HasLeft**: `bool` — Gets if the operation has a left hand side. -- **HasOperator**: `bool` — Gets if there is an operator set for the expression. -- **HasPropertyName**: `bool` — Gets if the operation applies directly to a property name. -- **HasRight**: `bool` — Gets if there is a right hand side to the epxression. -- **HasValue**: `bool` — Gets if the opration has a right hand side. -- **IsComparisonOperation**: `bool` — Gets if the operation is a comparison operation. -- **IsOperation**: `bool` — Gets if the expression is an operation. -- **Left**: `IgbFilterExpression` — Gets or sets the left hand side expression. -- **Operator**: `FilterExpressionOperatorType` — Gets or sets the operator to use for the expression. -- **Precedence**: `int` -- **PropertyName**: `string` — Gets or sets the property name the operation applies to, if any. -- **Right**: `IgbFilterExpression` — Gets or sets the right hand side expression. -- **Type**: `string` -- **Value**: `object` — Gets the literal value associated with the operation, if any. -- **ValueScript**: `string` — Provides a means of setting Value in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbOperatorSelectorClosingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOperatorSelectorClosingEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbOperatorSelectorOpeningEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOperatorSelectorOpeningEventArgs) -Event arguments for the Opening event. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbOperatorSelectorValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOperatorSelectorValueChangedEventArgs) -Event arguments for the ComparisonOperatorSelector ValueChanged event. - -- **constructor**(): void -- **NewValue**: `ColumnComparisonConditionOperatorType` -- **OldValue**: `ColumnComparisonConditionOperatorType` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbOrdinalTimeXAxis](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOrdinalTimeXAxis) -A horizontal axis that uses an ordinal DateTime scale. - -- **constructor**(): void -- **DateTimeMemberPath**: `string` — Gets or sets the DateTime mapping property for the axis. -- **LabelFormats**: `IgbTimeAxisLabelFormatCollection` — A list of axis label formats to apply, which are selected according to the visible axis range. -- **LabellingMode**: `TimeAxisLabellingMode` — Gets or sets the labelling mode to use when the automatic label formats are applied. -- **MaximumValue**: `DateTime` — Sets the maximum DateTime value to be displayed on this axis. -- **MinimumValue**: `DateTime` — Sets the minimum DateTime value to be displayed on this axis. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetValueLabel**(value: double): string -- **GetValueLabelAsync**(value: double): Task — Gets the label for a data item. - -### [IgbOrdinalTimeXAxisModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOrdinalTimeXAxisModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbOthersCategoryContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOthersCategoryContext) - -- **constructor**(): void -- **Items**: `object[]` — Gets the items in the others category. -- **ItemsScript**: `string` — Provides a means of setting Items in the JavaScript environment. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbOthersCategoryContextModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOthersCategoryContextModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbOverlayOutletDirective](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOverlayOutletDirective) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbOverlayProxyModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOverlayProxyModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbOverlaySettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOverlaySettings) - -- **constructor**(): void -- **CloseOnEscape**: `bool` — Set if the overlay should close when Esc key is pressed -- **CloseOnOutsideClick**: `bool` — Set if the overlay should close on outside click -- **Modal**: `bool` — Set if the overlay should be in modal mode -- **PositionStrategy**: `IgbPositionStrategy` — Position strategy to use with these settings -- **ScrollStrategy**: `IgbScrollStrategy` — Scroll strategy to use with these settings -- **Target**: `object` — Attaching target for the component to show -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbOverlayTextInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOverlayTextInfo) -Represents data annotation - -- **constructor**(): void -- **Background**: `string` — Gets or sets background of the overlay text -- **BackgroundMode**: `AnnotationAppearanceMode` — Gets or sets appearance mode of the overlay text background -- **BackgroundShift**: `double` — Gets or sets appearance shift of the overlay text background -- **BorderMode**: `AnnotationAppearanceMode` — Gets or sets appearance mode of the overlay text border -- **BorderRadius**: `double` — Gets or sets boarder border radius of the overlay text -- **BorderShift**: `double` — Gets or sets appearance shift of the overlay text border -- **BorderStroke**: `string` — Gets or sets border stroke of the overlay text -- **BorderThickness**: `double` — Gets or sets boarder thickness of the overlay text -- **HorizontalMargin**: `double` — Gets or sets Horizontal Margin for the overlay text -- **HorizontalPadding**: `double` — Gets or sets Horizontal Padding for the overlay text -- **ShapeBrush**: `string` — Gets or sets shape brush associated with the overlay text -- **ShapeOutline**: `string` — Gets or sets shape outline associated with the overlay text -- **TextAngle**: `double` — Gets or sets rotation angle of the overlay text -- **TextColor**: `string` — Gets or sets color of the overlay text -- **TextColorMode**: `AnnotationAppearanceMode` — Gets or sets appearance mode of the overlay text color -- **TextColorShift**: `double` — Gets or sets appearance shift of the overlay text color -- **TextContent**: `string` — Gets or sets content of the overlay text -- **TextLocation**: `OverlayTextLocation` — Gets or sets location of the overlay text in relation to shape annotation -- **TextVisible**: `bool` — Gets or sets visibility of the overlay text -- **Type**: `string` -- **VerticalMargin**: `double` — Gets or sets Vertical Margin for the overlay text -- **VerticalPadding**: `double` — Gets or sets Vertical Padding for the overlay text -- **FindByName**(name: string): object - -### [IgbOverlayTextUpdatingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOverlayTextUpdatingEventArgs) -Represents an event arguments for styling Overlay Text - -- **constructor**(): void -- **Background**: `string` — Gets or sets background of the overlay text -- **BackgroundMode**: `AnnotationAppearanceMode` — Gets or sets appearance mode of the overlay text background -- **BackgroundShift**: `double` — Gets or sets appearance shift of the overlay text background -- **BorderMode**: `AnnotationAppearanceMode` — Gets or sets appearance mode of the overlay text border -- **BorderRadius**: `double` — Gets or sets boarder border radius of the overlay text -- **BorderShift**: `double` — Gets or sets appearance shift of the overlay text border -- **BorderStroke**: `string` — Gets or sets border stroke of the overlay text -- **BorderThickness**: `double` — Gets or sets boarder thickness of the overlay text -- **DataIndex**: `int` — Gets data index associated with the overlay text -- **HorizontalMargin**: `double` — Gets or sets Horizontal Margin for the overlay text -- **HorizontalPadding**: `double` — Gets or sets Horizontal Padding for the overlay text -- **ShapeBrush**: `string` — Gets or sets shape brush associated with the overlay text -- **ShapeOutline**: `string` — Gets or sets shape outline associated with the overlay text -- **TextAngle**: `double` — Gets or sets rotation angle of the overlay text -- **TextColor**: `string` — Gets or sets color of the overlay text -- **TextColorMode**: `AnnotationAppearanceMode` — Gets or sets appearance mode of the overlay text color -- **TextColorShift**: `double` — Gets or sets appearance shift of the overlay text color -- **TextContent**: `string` — Gets or sets content of the overlay text -- **TextEmpty**: `bool` — Gets or sets visibility of the overlay text -- **TextLocation**: `OverlayTextLocation` — Gets or sets location of the overlay text in relation to shape annotation -- **TextVisible**: `bool` — Gets or sets visibility of the overlay text -- **Type**: `string` -- **VerticalMargin**: `double` — Gets or sets Vertical Margin for the overlay text -- **VerticalPadding**: `double` — Gets or sets Vertical Padding for the overlay text -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbOverlaysModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbOverlaysModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPageCancellableEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPageCancellableEventArgs) - -- **constructor**(): void -- **Detail**: `IgbPageCancellableEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPageCancellableEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPageCancellableEventArgsDetail) - -- **constructor**(): void -- **Current**: `double` -- **Next**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPageChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPageChangedEventArgs) - -- **constructor**(): void -- **Data**: `object[]` — Gets the data for the page that just changed. -- **DataScript**: `string` — Provides a means of setting Data in the JavaScript environment. -- **Page**: `int` — Gets the index for the page that just changed. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPageEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPageEventArgs) - -- **constructor**(): void -- **Detail**: `IgbPageEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPageEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPageEventArgsDetail) - -- **constructor**(): void -- **Current**: `double` -- **Previous**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPageRequestedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPageRequestedEventArgs) -Information about the requested page. - -- **constructor**(): void -- **DataSourceId**: `int` — The Unique ID for the data source making the request. -- **IsSchemaRequest**: `bool` — The data source is requesting the schema for the data. -- **PageIndex**: `int` — The page index being requested. -- **PageSize**: `int` — The page size being requested. -- **RequestId**: `int` — The unique ID for the page request. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPagedDataSource](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPagedDataSource) -This is a helper class for the DataGrid pager. It has to be in the DV.Shared project because it uses the old generator which will conflict with this class if it existed inside the Grid project which uses the new API gen stuff. It conflicts because LocalDataSource is all using the old generator. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **GetItemProperty**(item: object, propertyName: string): object -- **GetItemPropertyAsync**(item: object, propertyName: string): Task -- **GetItemPropertyAtIndex**(index: int, valueName: string): object -- **GetItemPropertyAtIndexAsync**(index: int, valueName: string): Task -- **IsPlaceholderItem**(index: int): bool -- **IsPlaceholderItemAsync**(index: int): Task — Returns true if the item at the requested index is a placeholder item and has not been actualized. -- **SetSchema**(schema: DataSourceSchema): void -- **SetSchemaAsync**(schema: DataSourceSchema): Task - -### [IgbPaginator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaginator) -Paginator component description IgxGridComponent, IgxTreeGridComponent, IgxHierarchicalGridComponent, IgxPivotGridComponent, * - -- **constructor**(): void -- **GridBaseDirectiveParent**: `BaseRendererControl` -- **HierarchicalGridParent**: `BaseRendererControl` -- **OverlaySettings**: `IgbOverlaySettings` -- **Page**: `double` — Gets/Sets the current page of the paginator. The default is 0. let page = this.paginator.page; IgxPaginatorComponent -- **PageChange**: `EventCallback` -- **PageChangeScript**: `string` -- **Paging**: `EventCallback` -- **PagingDone**: `EventCallback` -- **PagingDoneScript**: `string` -- **PagingScript**: `string` -- **PerPage**: `double` — Gets/Sets the number of visible items per page in the paginator. The default is 15. let itemsPerPage = this.paginator.perPage; IgxPaginatorComponent -- **PerPageChange**: `EventCallback` -- **PerPageChangeScript**: `string` -- **ResourceStrings**: `IgbPaginatorResourceStrings` — An accessor that sets the resource strings. By default it uses EN resources. -- **RowIslandParent**: `BaseRendererElement` -- **SelectOptions**: `double[]` — Sets custom options in the select of the paginator let options = this.paginator.selectOptions; IgxPaginatorComponent -- **TotalPages**: `double` — Total pages calculated from totalRecords and perPage -- **TotalRecords**: `double` — Sets the total records. let totalRecords = this.paginator.totalRecords; IgxPaginatorComponent -- **Type**: `string` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetIsFirstPage**(): bool -- **GetIsFirstPageAsync**(): Task -- **GetIsLastPage**(): bool -- **GetIsLastPageAsync**(): Task -- **NextPage**(): void -- **NextPageAsync**(): Task — Goes to the next page of the IgxPaginatorComponent, if the paginator is not already at the last page. this.paginator.nextPage(); IgxPaginatorComponent -- **OnInitializedAsync**(): Task -- **Paginate**(val: double): void -- **PaginateAsync**(val: double): Task — Goes to the desired page index. this.paginator.paginate(1); val IgxPaginatorComponent -- **PreviousPage**(): void -- **PreviousPageAsync**(): Task — Goes to the previous page of the IgxPaginatorComponent, if the paginator is not already at the first page. this.paginator.previousPage(); IgxPaginatorComponent -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbPaginatorCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaginatorCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbPaginatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaginatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPaginatorResourceStrings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaginatorResourceStrings) - -- **constructor**(): void -- **Igx_paginator_first_page_button_text**: `string` -- **Igx_paginator_label**: `string` -- **Igx_paginator_last_page_button_text**: `string` -- **Igx_paginator_next_page_button_text**: `string` -- **Igx_paginator_pager_text**: `string` -- **Igx_paginator_previous_page_button_text**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbPagingState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPagingState) - -- **constructor**(): void -- **Index**: `double` -- **RecordsPerPage**: `double` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneCloseEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneCloseEventArgs) - -- **constructor**(): void -- **Detail**: `IgbPaneCloseEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneCloseEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneCloseEventArgsDetail) - -- **constructor**(): void -- **Panes**: `IgbContentPaneCollection` — Gets/sets the panes that are about to close. -- **SourcePane**: `IgbDockManagerPane` — Get the source pane that triggers the close. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneDragAction](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneDragAction) - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneDragActionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneDragActionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPaneDragEndEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneDragEndEventArgs) - -- **constructor**(): void -- **Detail**: `IgbPaneDragEndEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneDragEndEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneDragEndEventArgsDetail) - -- **constructor**(): void -- **Panes**: `IgbContentPaneCollection` — Gets the panes that end dragging. -- **SourcePane**: `IgbDockManagerPane` — Gets the source pane that ends dragging. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneDragOverEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneDragOverEventArgs) - -- **constructor**(): void -- **Detail**: `IgbPaneDragOverEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneDragOverEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneDragOverEventArgsDetail) - -- **constructor**(): void -- **Action**: `IgbPaneDragAction` — Gets information about the action being performed. -- **IsValid**: `bool` — Gets/sets whether the action is valid. -- **Panes**: `IgbContentPaneCollection` — Gets the panes that are dragged over. -- **SourcePane**: `IgbDockManagerPane` — Gets the source pane that triggers the drag over. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneDragStartEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneDragStartEventArgs) - -- **constructor**(): void -- **Detail**: `IgbPaneDragStartEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneDragStartEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneDragStartEventArgsDetail) - -- **constructor**(): void -- **Panes**: `IgbContentPaneCollection` — Gets the panes that are about to get dragged. -- **SourcePane**: `IgbDockManagerPane` — Gets the source pane that triggers the drag start. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneHeaderConnectionEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneHeaderConnectionEventArgs) - -- **constructor**(): void -- **Detail**: `IgbPaneHeaderConnectionEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneHeaderConnectionEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneHeaderConnectionEventArgsDetail) - -- **constructor**(): void -- **Element**: `IgbPaneHeaderElement` — The header element that is being connected/disconnected. -- **Pane**: `IgbContentPane` — The pane whose header is being connected/disconnected. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneHeaderElement](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneHeaderElement) -Describes a pane header element. - -- **constructor**(): void -- **DragService**: `IgbDragService` — Gets/sets the drag service. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneHeaderElementModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneHeaderElementModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPanePinnedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPanePinnedEventArgs) - -- **constructor**(): void -- **Detail**: `IgbPanePinnedEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPanePinnedEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPanePinnedEventArgsDetail) - -- **constructor**(): void -- **Location**: `UnpinnedLocation` — Gets the unpinned location. -- **NewValue**: `bool` — Gets the new pinned value. -- **Panes**: `IgbContentPaneCollection` — Gets/sets the panes that are about to get pinned/unpinned. -- **SourcePane**: `IgbContentPane` — Gets the source pane that triggers the pinned state change. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneScrollEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneScrollEventArgs) - -- **constructor**(): void -- **Detail**: `IgbPaneScrollEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPaneScrollEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPaneScrollEventArgsDetail) - -- **constructor**(): void -- **Pane**: `IgbContentPane` — Gets the content pane that is scrolled. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPercentChangeYAxis](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPercentChangeYAxis) -A horizontal axis that uses a DateTime scale. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbPercentChangeYAxisModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPercentChangeYAxisModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPercentagePriceOscillatorIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPercentagePriceOscillatorIndicator) -Represents a IgbDataChart percentage price oscillator series. - -- **constructor**(): void -- **LongPeriod**: `int` — Gets or sets the long moving average period for the current PercentagePriceOscillatorIndicator object. The typical, and initial, value for long PVO periods is 30. -- **ShortPeriod**: `int` — Gets or sets the short moving average period for the current PercentagePriceOscillatorIndicator object. The typical, and initial, value for short PPO periods is 10. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbPercentagePriceOscillatorIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPercentagePriceOscillatorIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPercentageVolumeOscillatorIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPercentageVolumeOscillatorIndicator) -Represents a IgbDataChart Percentage Volume Oscillator (PVO) series. - -- **constructor**(): void -- **LongPeriod**: `int` — Gets or sets the short moving average period for the current PercentageVolumeOscillatorIndicator object. The typical, and initial, value for long PVO periods is 30. -- **ShortPeriod**: `int` — Gets or sets the short moving average period for the current PercentageVolumeOscillatorIndicator object. The typical, and initial, value for short PVO periods is 10. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbPercentageVolumeOscillatorIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPercentageVolumeOscillatorIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPieChart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPieChart) -Represents Infragistics IgbPieChart control. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbPieChartBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPieChartBase) -Represents the base class for the pie chart. - -- **constructor**(): void -- **ActualBrushes**: `string` — Gets the actual palette of brushes to use for coloring the slices. -- **ActualLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ActualLabelInnerColor**: `string` — Gets the actual color for labels rendered inside of the pie chart. -- **ActualLabelOuterColor**: `string` — Gets the actual color for labels rendered outside of the pie chart. -- **ActualLegendItemBadgeTemplate**: `object` — Gets the actual legend item badge template used by the pie chart. -- **ActualLegendItemBadgeTemplateScript**: `string` — Provides a means of setting ActualLegendItemBadgeTemplate in the JavaScript environment. -- **ActualLegendLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ActualLegendOthersLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ActualOthersLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ActualOutlines**: `string` — Gets the actual palette of brushes to use for outlines on the slices. -- **ActualPixelScalingRatio**: `double` — Resolved pixel scaling ratio. Unless explicitly overridden by the PieChartBase.PixelScalingRatio property, this one returns the default ratio enforced by device. High resolution devices will initialize this property to a higher value. -- **AllowSliceExplosion**: `bool` — Gets or sets whether the slices can be exploded. -- **AllowSliceSelection**: `bool` — Gets or sets whether the slices can be selected. -- **Brushes**: `string` — Gets or sets the palette of brushes to use for coloring the slices. -- **ContentLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ContentLegendLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ContentLegendOthersLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ContentOthersLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **DataSource**: `object` — Gets or sets the data source for the chart. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **ExplodedRadius**: `double` — Determines how much the exploded slice is offset from the center. Value between 0 and 1. -- **ExplodedSlices**: `int[]` — Gets or sets the collection of exploded slice indices. -- **FormatLabelScript**: `string` — Provides a means of setting FormatLabel in the JavaScript environment. -- **FormatLegendLabel**: `string` — Sets or gets a function which takes an object that produces a formatted label for displaying in the chart's legend. -- **FormatLegendLabelScript**: `string` — Provides a means of setting FormatLegendLabel in the JavaScript environment. -- **InnerExtent**: `double` — Gets or sets the amount of space between the center and the start of the arc. This property should be set between 0 and 1. -- **IsDragInteractionEnabled**: `bool` — Gets or sets whether the pie chart will handle drag interaction and make them avaiilable in its events. -- **IsSurfaceInteractionDisabled**: `bool` — Gets or sets whether all surface interactions with the plot area should be disabled. -- **LabelClick**: `EventCallback` -- **LabelClickScript**: `string` -- **LabelExtent**: `double` — Gets or sets the pixel amount by which the labels are offset from the edge of the slices. -- **LabelFormat**: `string` — Gets or sets the label format string to use for the label. -- **LabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the LabelFormat string. -- **LabelInnerColor**: `string` — Gets or sets the color for labels rendered inside of the pie chart. -- **LabelMemberPath**: `string` — Gets or sets the property name that contains the labels. -- **LabelOuterColor**: `string` — Gets or sets the color for labels rendered outside of the pie chart. -- **LabelsPosition**: `LabelsPosition` — Gets or sets the position of chart labels. -- **LeaderLineMargin**: `double` — Gets or sets the margin between a label and the end of its leader line. The default is 6 pixels. -- **LeaderLineType**: `LeaderLineType` — Gets or sets what type of leader lines will be used for the outside end labels. -- **LeaderLineVisibility**: `Visibility` — Gets or sets whether the leader lines are visible. -- **Legend**: `IgbLegendBase` — Gets or sets the legend used for the current chart. -- **LegendEmptyValuesMode**: `LegendEmptyValuesMode` — Determines display mode for zero values in the legend. For example, handling zero values as valid slices and providing them with proper appearance settings. -- **LegendItemBadgeTemplate**: `object` — Gets or sets the LegendItemBadgeTemplate property. -- **LegendItemBadgeTemplateScript**: `string` — Provides a means of setting LegendItemBadgeTemplate in the JavaScript environment. -- **LegendItemTemplate**: `object` — Gets or sets the LegendItemTemplate property. -- **LegendItemTemplateScript**: `string` — Provides a means of setting LegendItemTemplate in the JavaScript environment. -- **LegendLabelFormat**: `string` — Gets or sets the label format string to use for the label. -- **LegendLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the LegendLabelFormat string. -- **LegendLabelMemberPath**: `string` — Gets or sets the property name that contains the legend labels. -- **LegendOthersLabelFormat**: `string` — Gets or sets the label format string to use for the label. -- **LegendOthersLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the LegendOthersLabelFormat string. -- **LegendScript**: `string` — Provides a means of setting Legend in the JavaScript environment. -- **OthersCategoryFill**: `string` — Gets or sets the fill brush. -- **OthersCategoryOpacity**: `double` — Gets or sets the opacity. -- **OthersCategoryStroke**: `string` — Gets or sets the stroke brush. -- **OthersCategoryStrokeThickness**: `double` — Gets or sets the stroke thickness. -- **OthersCategoryText**: `string` — Gets or sets the label of the Others slice. -- **OthersCategoryThreshold**: `double` — Gets or sets the threshold value that determines if slices are grouped into the Others slice. -- **OthersCategoryType**: `OthersCategoryType` — Gets or sets whether to use numeric or percent-based threshold value. -- **OthersLabelFormat**: `string` — Gets or sets the label format string to use for the label. -- **OthersLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the OthersLabelFormat string. -- **Outlines**: `string` — Gets or sets the palette of brushes to use for outlines on the slices. -- **ParentTypeName**: `string` -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **RadiusFactor**: `double` — Gets or sets the scaling factor of the chart's radius. Value between 0 and 1. -- **SelectedItem**: `object` — Gets or sets the currently selected data item. If a different data item is provided the pie chart will select the slice associated with the new item. -- **SelectedItemChanged**: `EventCallback` -- **SelectedItemChangedScript**: `string` -- **SelectedItemChanging**: `EventCallback` -- **SelectedItemChangingScript**: `string` -- **SelectedItems**: `IgbObjectCollection` — Gets the currently selected data items. Adding or removing data items from this collection will select or deselect the slices associated with those items. -- **SelectedItemsChanged**: `EventCallback` -- **SelectedItemsChangedScript**: `string` -- **SelectedItemsChanging**: `EventCallback` -- **SelectedItemsChangingScript**: `string` -- **SelectedSliceFill**: `string` — Gets or sets the fill brush. -- **SelectedSliceOpacity**: `double` — Gets or sets the opacity. -- **SelectedSliceStroke**: `string` — Gets or sets the stroke brush. -- **SelectedSliceStrokeThickness**: `double` — Gets or sets the stroke thickness. -- **SelectionMode**: `SliceSelectionMode` — Gets or sets which mode to use for selecting slices. -- **ShouldDisplayMockData**: `bool` — Gets or sets whether the pie chart should display mock data when data isn't present. -- **ShouldUseSkeletonStyleForMockData**: `bool` — Gets or sets whether the pie chart should use a skeleton style for mock data. -- **SliceClick**: `EventCallback` -- **SliceClickScript**: `string` -- **SliceEnter**: `EventCallback` -- **SliceEnterScript**: `string` -- **SliceHover**: `EventCallback` -- **SliceHoverScript**: `string` -- **SliceLeave**: `EventCallback` -- **SliceLeaveScript**: `string` -- **StartAngle**: `double` — Gets or sets the starting angle of the chart. -- **SweepDirection**: `SweepDirection` — Gets or sets the rotational direction of the chart. -- **TextStyle**: `string` — Manually overrides the style to use for the labels. -- **Type**: `string` -- **ValueMemberPath**: `string` — Gets or Sets the property name that contains the values. -- **Destroy**(): void -- **DestroyAsync**(): Task — Invoked when the instance is being destroyed. -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Returns the chart visuals expressed as a serialized string. -- **FindByName**(name: string): object -- **Flush**(): void -- **FlushAsync**(): Task — Use to force the pie chart to finish any deferred work before printing or evaluating its visual. -- **GetCurrentSelectedItem**(): object -- **GetCurrentSelectedItemAsync**(): Task -- **GetCurrentSelectedItems**(): IgbObjectCollection -- **GetCurrentSelectedItemsAsync**(): Task -- **NotifyClearItems**(source_: object): void -- **NotifyClearItemsAsync**(source_: object): Task — Manually notifies the pie chart's data source that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the pie chart is bound to is already observable. -- **NotifyContainerResized**(): void -- **NotifyContainerResizedAsync**(): Task — Notification from the containing object that the container has been resized. -- **NotifyInsertItem**(source_: object, index: int, newItem: object): void -- **NotifyInsertItemAsync**(source_: object, index: int, newItem: object): Task -- **NotifyRemoveItem**(source_: object, index: int, oldItem: object): void -- **NotifyRemoveItemAsync**(source_: object, index: int, oldItem: object): Task -- **NotifySetItem**(source_: object, index: int, oldItem: object, newItem: object): void -- **NotifySetItemAsync**(source_: object, index: int, oldItem: object, newItem: object): Task -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task — Invoked by the containing object to provide reference to the container. -- **RemoveWidgetLevelDataSource**(): void -- **RemoveWidgetLevelDataSourceAsync**(): Task — Resets items data source. -- **SetWidgetLevelDataSource**(source_: object): void -- **SetWidgetLevelDataSourceAsync**(source_: object): Task — Assigns data source for the items. -- **SimulateLeftClick**(point: Point): void -- **SimulateLeftClickAsync**(point: Point): Task — Simulates a mouse click action at the specified point. -- **StyleUpdated**(): void -- **StyleUpdatedAsync**(): Task — Invoked when style is updated. - -### [IgbPieChartCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPieChartCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPieChartDashboardTileModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPieChartDashboardTileModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPieChartModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPieChartModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPieSliceDataContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPieSliceDataContext) -DataContext for a pie slice. - -- **constructor**(): void -- **IsOthersSlice**: `bool` — Gets or sets whether this slice is an Others slice or not. -- **PercentValue**: `double` — Gets or sets the value of this slice as a percentage of the total pie. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPieSliceOthersContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPieSliceOthersContext) -Represents the selected data contained inside the Others slice. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbPinColumnCancellableEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPinColumnCancellableEventArgs) -The event arguments before a column's pin state is changed. insertAtIndexspecifies at which index in the pinned/unpinned area the column is inserted. Can be changed in the columnPin event. isPinned returns the actual pin state of the column. When pinning/unpinning is successful, the value of isPinned will change accordingly when read in the "-ing" and "-ed" event. - -- **constructor**(): void -- **Detail**: `IgbPinColumnCancellableEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPinColumnCancellableEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPinColumnCancellableEventArgsDetail) -The event arguments before a column's pin state is changed. insertAtIndexspecifies at which index in the pinned/unpinned area the column is inserted. Can be changed in the columnPin event. isPinned returns the actual pin state of the column. When pinning/unpinning is successful, the value of isPinned will change accordingly when read in the "-ing" and "-ed" event. - -- **constructor**(): void -- **Cancel**: `bool` — Provides the ability to cancel the event. -- **Column**: `IgbColumn` -- **InsertAtIndex**: `double` — If pinned, specifies at which index in the pinned area the column is inserted. If unpinned, specifies at which index in the unpinned area the column is inserted. -- **IsPinned**: `bool` — Returns the actual pin state of the column. If pinning/unpinning is successful, value of isPinned will change accordingly when read in the "-ing" and "-ed" event. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPinColumnEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPinColumnEventArgs) -The event arguments after a column's pin state is changed. insertAtIndexspecifies at which index in the pinned/unpinned area the column was inserted. isPinned returns the actual pin state of the column after the operation completed. - -- **constructor**(): void -- **Detail**: `IgbPinColumnEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPinColumnEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPinColumnEventArgsDetail) -The event arguments after a column's pin state is changed. insertAtIndexspecifies at which index in the pinned/unpinned area the column was inserted. isPinned returns the actual pin state of the column after the operation completed. - -- **constructor**(): void -- **Column**: `IgbColumn` -- **InsertAtIndex**: `double` — If pinned, specifies at which index in the pinned area the column is inserted. If unpinned, specifies at which index in the unpinned area the column is inserted. -- **IsPinned**: `bool` — Returns the actual pin state of the column. If pinning/unpinning is successful, value of isPinned will change accordingly when read in the "-ing" and "-ed" event. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPinRowEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPinRowEventArgs) -Event emitted when a row's pin state changes. The event is cancelable - -- **constructor**(): void -- **Detail**: `IgbPinRowEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPinRowEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPinRowEventArgsDetail) -Event emitted when a row's pin state changes. The event is cancelable - -- **constructor**(): void -- **Cancel**: `bool` — Provides the ability to cancel the event. -- **InsertAtIndex**: `double` — The index at which to pin the row in the pinned rows collection. -- **IsPinned**: `bool` — Whether or not the row is pinned or unpinned. -- **Owner**: `object` — Provides reference to the owner component. -- **Row**: `IgbRowType` -- **RowID**: `object` — The ID of the row, that was pinned/unpinned. ID is either the primaryKey value or the data record instance. -- **RowKey**: `object` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPinnedAreaSeparator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPinnedAreaSeparator) - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbPinnedAreaSeparatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPinnedAreaSeparatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPinningConfig](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPinningConfig) -An interface describing settings for row/column pinning position. - -- **constructor**(): void -- **Columns**: `ColumnPinningPosition` -- **Rows**: `RowPinningPosition` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPivotAggregator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotAggregator) -Interface describing a IPivotAggregator class. Used for specifying custom aggregator lists. - -- **constructor**(): void -- **AggregatorName**: `PivotAggregationType` — Aggregation name that will be used from a list of predefined aggregations. If not set will use the specified aggregator function. -- **AggregatorScript**: `string` — Provides a means of setting Aggregator in the JavaScript environment. -- **Key**: `string` — Aggregation unique key. -- **Label**: `string` — Aggregation label to show in the UI. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPivotConfiguration](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotConfiguration) -Configuration of the pivot grid. - -- **constructor**(): void -- **ColumnStrategy**: `IgbPivotDimensionStrategy` — A strategy to transform the columns. -- **Columns**: `IgbPivotDimension[]` — A list of the columns. -- **Filters**: `IgbPivotDimension[]` — Dimensions to be displayed in the filter area. -- **PivotKeys**: `IgbPivotKeys` — Pivot data keys used for data generation. Can be used for custom remote scenarios where the data is pre-populated. -- **RowStrategy**: `IgbPivotDimensionStrategy` — A strategy to transform the rows. -- **Rows**: `IgbPivotDimension[]` — A list of the rows. -- **Type**: `string` -- **Values**: `IgbPivotValue[]` — A list of the values. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPivotConfigurationChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotConfigurationChangedEventArgs) -Event emitted when pivot configuration is changed. - -- **constructor**(): void -- **Detail**: `IgbPivotConfigurationChangedEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPivotConfigurationChangedEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotConfigurationChangedEventArgsDetail) -Event emitted when pivot configuration is changed. - -- **constructor**(): void -- **PivotConfiguration**: `IgbPivotConfiguration` — The new configuration. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPivotDataSelector](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotDataSelector) - -- **constructor**(): void -- **ColumnsExpanded**: `bool` -- **ColumnsExpandedChange**: `EventCallback` -- **ColumnsExpandedChangeScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **FiltersExpanded**: `bool` -- **FiltersExpandedChange**: `EventCallback` -- **FiltersExpandedChangeScript**: `string` -- **Grid**: `IgbPivotGrid` — Sets the grid. -- **GridScript**: `string` — Provides a means of setting Grid in the JavaScript environment. -- **RowsExpanded**: `bool` -- **RowsExpandedChange**: `EventCallback` -- **RowsExpandedChangeScript**: `string` -- **Type**: `string` -- **ValuesExpanded**: `bool` -- **ValuesExpandedChange**: `EventCallback` -- **ValuesExpandedChangeScript**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbPivotDataSelectorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotDataSelectorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPivotDateDimension](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotDateDimension) - -- **constructor**(): void -- **BaseDimension**: `IgbPivotDimension` — Gets/Sets the base dimension that is used by this class to determine the other dimensions and their values. Having base dimension set is required in order for the Date Dimensions to show. -- **DataType**: `GridColumnDataType` — Gets/Sets data type -- **DisplayName**: `string` -- **Enabled**: `bool` — Enables/Disables a particular dimension from pivot structure. -- **Options**: `IgbPivotDateDimensionOptions` — Gets/Sets the options for the predefined date dimensions whether to show quarter, years and etc. -- **ResourceStrings**: `IgbGridResourceStrings` — Gets/Sets the resource strings. By default it uses EN resources. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPivotDateDimensionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotDateDimensionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPivotDateDimensionOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotDateDimensionOptions) - -- **constructor**(): void -- **FullDate**: `bool` — Enabled/Disables dimensions for the full date provided -- **Months**: `bool` — Enables/Disables dimensions per month from provided periods. -- **Quarters**: `bool` -- **Total**: `bool` — Enables/Disables total value of all periods. -- **Type**: `string` -- **Years**: `bool` — Enables/Disables dimensions per year from provided periods. -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbPivotDimension](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotDimension) -Configuration of a pivot dimension. - -- **constructor**(): void -- **ChildLevel**: `IgbPivotDimension` — Allows defining a hierarchy when multiple sub groups need to be extracted from single member. -- **DataType**: `GridColumnDataType` — The dataType of the related data field. -- **DisplayName**: `string` — Display name to show instead of the field name of this value. * -- **Enabled**: `bool` — Enables/Disables a particular dimension from pivot structure. -- **Filter**: `IgbFilteringExpressionsTree` — A predefined or defined via the igxPivotSelector filter expression tree for the current dimension to be applied in the filter pipe. -- **HorizontalSummary**: `bool` -- **Level**: `double` — Level of the dimension. -- **MemberFunctionScript**: `string` -- **MemberName**: `string` — Unique member to extract related data field value or the result of the memberFunction. -- **SortDirection**: `SortingDirection` — The sorting direction of the current dimension. Determines the order in which the values will appear in the related dimension. -- **Sortable**: `bool` — Enable/disable sorting for a particular dimension. True by default. -- **Type**: `string` -- **Width**: `string` — The width of the dimension cells to be rendered.Can be pixel, % or "auto". -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPivotDimensionDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotDimensionDetail) -Configuration of a pivot dimension. - -- **constructor**(): void -- **ChildLevel**: `IgbPivotDimension` — Allows defining a hierarchy when multiple sub groups need to be extracted from single member. -- **DataType**: `GridColumnDataType` — The dataType of the related data field. -- **DisplayName**: `string` — Display name to show instead of the field name of this value. * -- **Enabled**: `bool` — Enables/Disables a particular dimension from pivot structure. -- **Filter**: `IgbFilteringExpressionsTree` — A predefined or defined via the igxPivotSelector filter expression tree for the current dimension to be applied in the filter pipe. -- **HorizontalSummary**: `bool` -- **Level**: `double` — Level of the dimension. -- **MemberFunctionScript**: `string` -- **MemberName**: `string` — Unique member to extract related data field value or the result of the memberFunction. -- **SortDirection**: `SortingDirection` — The sorting direction of the current dimension. Determines the order in which the values will appear in the related dimension. -- **Sortable**: `bool` — Enable/disable sorting for a particular dimension. True by default. -- **Type**: `string` -- **Width**: `string` — The width of the dimension cells to be rendered.Can be pixel, % or "auto". -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPivotDimensionEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotDimensionEventArgs) - -- **constructor**(): void -- **Detail**: `IgbPivotDimensionDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPivotDimensionStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotDimensionStrategy) -Interface describing Pivot data processing for dimensions. Should contain a process method and return records hierarchy based on the provided dimensions. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbPivotGrid](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotGrid) - -- **constructor**(): void -- **AutoGenerateConfig**: `bool` -- **Data**: `object` -- **DataScript**: `string` — Provides a means of setting Data in the JavaScript environment. -- **DefaultExpandState**: `bool` — Gets/Sets the default expand state for all rows. -- **DimensionInit**: `EventCallback` -- **DimensionInitScript**: `string` -- **DimensionsChange**: `EventCallback` -- **DimensionsChangeScript**: `string` -- **DimensionsSortingExpressionsChange**: `EventCallback` -- **DimensionsSortingExpressionsChangeScript**: `string` -- **EmptyPivotGridTemplate**: `RenderFragment` -- **EmptyPivotGridTemplateScript**: `string` — Provides a means of setting EmptyPivotGridTemplate in the JavaScript environment. -- **PivotConfiguration**: `IgbPivotConfiguration` -- **PivotConfigurationChange**: `EventCallback` -- **PivotConfigurationChangeScript**: `string` -- **PivotConfigurationChanged**: `EventCallback` -- **PivotUI**: `IgbPivotUISettings` -- **RowDimensionHeaderTemplate**: `RenderFragment` -- **RowDimensionHeaderTemplateScript**: `string` — Provides a means of setting RowDimensionHeaderTemplate in the JavaScript environment. -- **SuperCompactMode**: `bool` -- **Type**: `string` -- **ValueChipTemplate**: `RenderFragment` -- **ValueChipTemplateScript**: `string` — Provides a means of setting ValueChipTemplate in the JavaScript environment. -- **ValueInit**: `EventCallback` -- **ValueInitScript**: `string` -- **ValuesChange**: `EventCallback` -- **ValuesChangeScript**: `string` -- **AutoSizeRowDimension**(dimension: IgbPivotDimension): void -- **AutoSizeRowDimensionAsync**(dimension: IgbPivotDimension): Task — Auto-sizes row dimension cells. Only sizes based on the dimension cells in view. this.grid.autoSizeRowDimension(dimension); dimension The row dimension to size. -- **EnsureModulesLoaded**(): void -- **FilterDimension**(dimension: IgbPivotDimension, value: object, conditionOrExpressionTree: IgbFilteringExpressionsTreeOrFilteringOperation): void -- **FilterDimensionAsync**(dimension: IgbPivotDimension, value: object, conditionOrExpressionTree: IgbFilteringExpressionsTreeOrFilteringOperation): Task -- **FindByName**(name: string): object -- **GetAllDimensions**(): IgbPivotDimension[] -- **GetAllDimensionsAsync**(): Task -- **GetColumnGroupExpandState**(col: IgbColumn): void -- **GetColumnGroupExpandStateAsync**(col: IgbColumn): Task -- **GetCurrentPivotConfiguration**(): IgbPivotConfiguration -- **GetCurrentPivotConfigurationAsync**(): Task -- **GetDimensionsSortingExpressions**(): IgbSortingExpression[] -- **GetDimensionsSortingExpressionsAsync**(): Task -- **InsertDimensionAt**(dimension: IgbPivotDimension, targetCollectionType: PivotDimensionType, index: double): void -- **InsertDimensionAtAsync**(dimension: IgbPivotDimension, targetCollectionType: PivotDimensionType, index: double): Task -- **InsertValueAt**(value: IgbPivotValue, index: double): void -- **InsertValueAtAsync**(value: IgbPivotValue, index: double): Task -- **MoveDimension**(dimension: IgbPivotDimension, targetCollectionType: PivotDimensionType, index: double): void -- **MoveDimensionAsync**(dimension: IgbPivotDimension, targetCollectionType: PivotDimensionType, index: double): Task -- **MoveValue**(value: IgbPivotValue, index: double): void -- **MoveValueAsync**(value: IgbPivotValue, index: double): Task -- **NotifyDimensionChange**(regenerateColumns: bool): void -- **NotifyDimensionChangeAsync**(regenerateColumns: bool): Task — Notifies for dimension change. -- **RemoveDimension**(dimension: IgbPivotDimension): void -- **RemoveDimensionAsync**(dimension: IgbPivotDimension): Task — Removes dimension from its currently collection. This is different than toggleDimension that enabled/disables the dimension. This completely removes the specified dimension from the collection. this.grid.removeDimension(dimension); dimension The dimension to be removed. -- **RemoveValue**(value: IgbPivotValue): void -- **RemoveValueAsync**(value: IgbPivotValue): Task — Removes value from collection. This is different than toggleValue that enabled/disables the value. This completely removes the specified value from the collection. this.grid.removeValue(dimension); value The value to be removed. -- **SortDimension**(dimension: IgbPivotDimension, sortDirection: SortingDirection): void -- **SortDimensionAsync**(dimension: IgbPivotDimension, sortDirection: SortingDirection): Task -- **ToggleColumn**(col: IgbColumn): void -- **ToggleColumnAsync**(col: IgbColumn): Task -- **ToggleDimension**(dimension: IgbPivotDimension): void -- **ToggleDimensionAsync**(dimension: IgbPivotDimension): Task — Toggles the dimension's enabled state on or off. The dimension remains in its current collection. This just changes its enabled state. this.grid.toggleDimension(dimension); dimension The dimension to be toggled. -- **ToggleRowGroup**(col: IgbColumn, newState: bool): void -- **ToggleRowGroupAsync**(col: IgbColumn, newState: bool): Task -- **ToggleValue**(value: IgbPivotValue): void -- **ToggleValueAsync**(value: IgbPivotValue): Task — Toggles the value's enabled state on or off. The value remains in its current collection. This just changes its enabled state. this.grid.toggleValue(value); value The value to be toggled. - -### [IgbPivotGridColumn](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotGridColumn) -Interface describing the Pivot column data. Contains information on the related column dimensions and their values. - -- **constructor**(): void -- **Dimensions**: `IgbPivotDimension[]` — List of dimensions associated with the column.* -- **Field**: `string` -- **Type**: `string` -- **Value**: `IgbPivotValue` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbPivotGridModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotGridModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPivotGridRecord](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotGridRecord) - -- **constructor**(): void -- **DataIndex**: `double` — The index of the record in the total view -- **Dimensions**: `IgbPivotDimension[]` — List of dimensions associated with the record.* -- **Level**: `double` — Record level* -- **Records**: `object[]` — List of original data records associated with the current pivoted data. * -- **RecordsScript**: `string` — Provides a means of setting Records in the JavaScript environment. -- **TotalRecordDimensionName**: `string` — If set, it specifies the name of the dimension, that has total record enabled. -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbPivotGridValueTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotGridValueTemplateContext) - -- **constructor**(): void -- **Implicit**: `IgbPivotValue` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPivotKeys](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotKeys) -Interface describing the Pivot data keys used for data generation. Can be used for custom remote scenarios where the data is pre-populated. - -- **constructor**(): void -- **Aggregations**: `string` — Field that stores aggregation values. -- **Children**: `string` — Field that stores children for hierarchy building. -- **ColumnDimensionSeparator**: `string` — Separator used when generating the unique column field values. -- **Level**: `string` — Field that stores dimension level based on its hierarchy. -- **Records**: `string` — Field that stores reference to the original data records. -- **RowDimensionSeparator**: `string` — Separator used when generating the unique row field values. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPivotUISettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotUISettings) - -- **constructor**(): void -- **HorizontalSummariesPosition**: `PivotSummaryPosition` -- **RowLayout**: `PivotRowLayoutType` -- **ShowConfiguration**: `bool` -- **ShowRowHeaders**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbPivotValue](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotValue) -Configuration of a pivot value aggregation. - -- **constructor**(): void -- **Aggregate**: `IgbPivotAggregator` — Active aggregator definition with key, label and aggregator. -- **AggregateList**: `IgbPivotAggregator[]` — List of aggregates to show in aggregate drop-down. -- **DataType**: `GridColumnDataType` — Enables a data type specific template of the cells -- **DisplayName**: `string` — Display name to show instead of member for the column header of this value. * -- **Enabled**: `bool` — Enables/Disables a particular value from pivot aggregation. -- **FormatterScript**: `string` -- **Member**: `string` — Unique member to extract related data field value for aggregations. -- **Styles**: `object` — Allow conditionally styling of the IgxPivotGrid cells. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPivotValueDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotValueDetail) -Configuration of a pivot value aggregation. - -- **constructor**(): void -- **Aggregate**: `IgbPivotAggregator` — Active aggregator definition with key, label and aggregator. -- **AggregateList**: `IgbPivotAggregator[]` — List of aggregates to show in aggregate drop-down. -- **DataType**: `GridColumnDataType` — Enables a data type specific template of the cells -- **DisplayName**: `string` — Display name to show instead of member for the column header of this value. * -- **Enabled**: `bool` — Enables/Disables a particular value from pivot aggregation. -- **FormatterScript**: `string` -- **Member**: `string` — Unique member to extract related data field value for aggregations. -- **Styles**: `object` — Allow conditionally styling of the IgxPivotGrid cells. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPivotValueEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPivotValueEventArgs) - -- **constructor**(): void -- **Detail**: `IgbPivotValueDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPlotAreaMouseButtonEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPlotAreaMouseButtonEventArgs) -Provides data for IgbDataChart mouse button related events. - -- **constructor**(): void -- **ChartPosition**: `Point` -- **ManipulationOccurred**: `bool` -- **PlotAreaPosition**: `Point` -- **Type**: `string` -- **Viewer**: `IgbSeriesViewer` — Gets the Chart associated with the current event. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPlotAreaMouseEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPlotAreaMouseEventArgs) -Provides data for IgbDataChart mouse button related events. - -- **constructor**(): void -- **ChartPosition**: `Point` -- **IsDuringManipulation**: `bool` -- **PlotAreaPosition**: `Point` -- **Type**: `string` -- **Viewer**: `IgbSeriesViewer` — Gets the Chart associated with the current event. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPointSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPointSeries) -Represents a IgbDataChart point series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbPointSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPointSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPolarAreaSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPolarAreaSeries) -Represents a IgbDataChart polar area series. - -- **constructor**(): void -- **Type**: `string` -- **UnknownValuePlotting**: `UnknownValuePlotting` — Determines how unknown values will be plotted on the chart. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbPolarAreaSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPolarAreaSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPolarBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPolarBase) -Represents the base class from which all IgbDataChart polar series are derived. - -- **constructor**(): void -- **ActualItemSearchMode**: `ScatterItemSearchMode` -- **ActualTrendLineBrush**: `string` — Gets the effective TrendLineBrush for this series. -- **AngleAxis**: `IgbNumericAngleAxis` — Gets the effective angle axis for the current series object. -- **AngleAxisName**: `string` — Gets or sets the name to use to resolve angleAxis from markup. -- **AngleAxisScript**: `string` — Provides a means of setting AngleAxis in the JavaScript environment. -- **AngleMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series' angle value in the Data Legend. -- **AngleMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series' angle value in the Data Legend. -- **AngleMemberPath**: `string` — Gets or sets the path to use to find the angle values for the series. -- **AssigningPolarMarkerStyle**: `Action` -- **AssigningPolarMarkerStyleScript**: `string` -- **AssigningPolarStyle**: `Action` -- **AssigningPolarStyleScript**: `string` -- **ClipSeriesToBounds**: `bool` — Gets or sets whether to clip the series to the bounds. -- **HighlightedAngleMemberPath**: `string` — Gets or sets the highlighted angle value mapping property for the current series object. -- **HighlightedRadiusMemberPath**: `string` — Gets or sets the highlighted radius value mapping property for the current series object. -- **IsCustomPolarMarkerStyleAllowed**: `bool` — Gets or sets whether this Polar series should allow custom style overrides of its individual marker visuals. -- **IsCustomPolarStyleAllowed**: `bool` — Gets or sets whether this Polar series should allow custom style overrides of its individual visuals. -- **ItemSearchMode**: `ScatterItemSearchMode` — Gets or sets the mode the series will use to find the closest point to the cursor. -- **ItemSearchThreshold**: `int` — Gets or sets the threshold to use when searching for items using ItemSearchMode. -- **MaximumMarkers**: `int` — Gets or sets the maximum number of markers displayed by the current series. If more than the specified number of markers are visible, the polar series will automatically choose a representative set. -- **RadiusAxis**: `IgbNumericRadiusAxis` — Gets the effective radius axis for the current series object. -- **RadiusAxisName**: `string` — Gets or sets the name to use to resolve radiusAxis from markup. -- **RadiusAxisScript**: `string` — Provides a means of setting RadiusAxis in the JavaScript environment. -- **RadiusMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series' radius value in the Data Legend. -- **RadiusMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series' radius value in the Data Legend. -- **RadiusMemberPath**: `string` — Gets or sets the path to use to get the radius values for the series. -- **TrendLineBrush**: `string` — Gets or sets the brush that specifies how the current series object's trend line is drawn. -- **TrendLineDashArray**: `double[]` — Gets or sets a collection of double values that indicate the pattern of dashes and gaps that is used to draw the trend line for the current series object. -- **TrendLinePeriod**: `int` — Gets or sets the moving average period for the current series object. -- **TrendLineThickness**: `double` — Gets or sets the thickness of the current series object's trend line. -- **TrendLineType**: `TrendLineType` — Gets or sets the trend type for the current series object. -- **TrendLineZIndex**: `int` — Sets or Gets the Trendline Z index. -- **Type**: `string` -- **UseCartesianInterpolation**: `bool` — Gets or sets whether Cartesian Interpolation should be used rather than Archimedian spiral based interpolation. -- **BindAxes**(Axes: IgbAxis[]): void -- **CanUseAsAngleAxis**(axis: object): bool -- **CanUseAsAngleAxisAsync**(axis: object): Task — Determine if object can be used as AngleAxis -- **CanUseAsRadiusAxis**(axis: object): bool -- **CanUseAsRadiusAxisAsync**(axis: object): Task — Determine if object can be used as RadiusAxis -- **FindByName**(name: string): object -- **GetExactItemIndex**(world: Point): double -- **GetExactItemIndexAsync**(world: Point): Task — Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex. -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemIndex**(world: Point): int -- **GetItemIndexAsync**(world: Point): Task — Gets the index of the item that resides at the provided world coordinates. -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **GetSeriesValueMarkerBoundingBox**(world: Point): Rect -- **GetSeriesValueMarkerBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided. -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetUnscaledPosition**(pos: Point): Point -- **GetUnscaledPositionAsync**(pos: Point): Task — Gets an unscaled position in terms of axis values from a viewport position. -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the requested item into view, if possible. - -### [IgbPolarLineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPolarLineSeries) -Represents a IgbDataChart polar line series. - -- **constructor**(): void -- **Type**: `string` -- **UnknownValuePlotting**: `UnknownValuePlotting` — Determines how unknown values will be plotted on the chart. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbPolarLineSeriesBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPolarLineSeriesBase) -Represents the base class from which all IgbDataChart polar line series are derived. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbPolarLineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPolarLineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPolarScatterSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPolarScatterSeries) -Represents a IgbDataChart polar scatter series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbPolarScatterSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPolarScatterSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPolarSplineAreaSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPolarSplineAreaSeries) -Represents a IgbDataChart polar spline area series. - -- **constructor**(): void -- **Stiffness**: `double` — Gets or sets the Stiffness property. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbPolarSplineAreaSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPolarSplineAreaSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPolarSplineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPolarSplineSeries) -Represents a IgbDataChart polar spline series. - -- **constructor**(): void -- **Stiffness**: `double` — Gets or sets the Stiffness property. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbPolarSplineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPolarSplineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPopup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPopup) - -- **constructor**(): void -- **ActualAmbientShadowColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **ActualElevation**: `int` — Gets or sets the elevation of the border shadow -- **ActualPenumbraShadowColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **ActualUmbraShadowColor**: `string` — Gets or sets the color to use for the check mark when the checkbox is checked. -- **AnimationDuration**: `int` — Gets or sets the duration of the Popup and Closeup animations in milliseconds. -- **AnimationEnabled**: `bool` — Gets or sets whether the popup and closeup animations are animated. -- **AnimationType**: `PopupAnimationType` — Gets or sets the type of animation to use when the popup opens and closes. -- **Background**: `string` — Gets or sets the background color of the popup. -- **CornerRadius**: `double` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DisableHitTestDuringAnimation**: `bool` — Gets or sets whether to disable hit testing during the open and close animations. -- **Elevation**: `int` — Gets or sets the elevation to use for the button regardless of type. -- **IsClosing**: `bool` — Gets whether the popup is in the middle of closing or not. -- **IsFixed**: `bool` — Indicates that the popup will position itself relative to the window instead of the document. -- **IsFocusable**: `bool` -- **IsHitTestVisible**: `bool` — Gets or sets whether to disable hit testing on the popup. -- **IsPointerEnabled**: `bool` — Gets or sets whether to show a pointer off the side of the popup towards the popup target. -- **IsShowing**: `bool` — Gets whether the popup is in the middle of opening or not. -- **MeasuringContentSize**: `EventCallback` -- **MeasuringContentSizeScript**: `string` -- **OnClosed**: `EventCallback` -- **OnClosedScript**: `string` -- **OnPopup**: `EventCallback` -- **OnPopupScript**: `string` -- **PointerBackground**: `string` — Gets or sets the pointer background color. -- **PointerPosition**: `PopupPointerPosition` — Gets or sets the pointer position. -- **PointerSize**: `double` — Gets or sets the pointer size. -- **Type**: `string` -- **UseTopLayer**: `bool` — Indicates that the popup will place itself into the browser top layer. -- **Close**(): void -- **CloseAsync**(): Task — Closes the popup. -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualModel**(): string -- **ExportSerializedVisualModelAsync**(): Task — Returns a serialized copy of the exported visual model -- **ExportVisualModel**(): object -- **ExportVisualModelAsync**(): Task — Exports visual information about the current state of the grid. -- **FindByName**(name: string): object -- **ShowRelativeToExclusionRect**(exclusionRect: Rect, popupDirection: PopupDirection, popupAlignment: PopupAlignment): void -- **ShowRelativeToExclusionRectAsync**(exclusionRect: Rect, popupDirection: PopupDirection, popupAlignment: PopupAlignment): Task - -### [IgbPopupMeasuringContentSizeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPopupMeasuringContentSizeEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPopupModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPopupModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPositionSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPositionSettings) - -- **constructor**(): void -- **HorizontalDirection**: `GridHorizontalAlignment` — Direction in which the component should show -- **HorizontalStartPoint**: `GridHorizontalAlignment` — Target's starting point -- **MinSize**: `IgbSize` — The size up to which element may shrink when shown in elastic position strategy -- **Offset**: `double` — The offset of the element from the target in pixels -- **Type**: `string` -- **VerticalDirection**: `GridVerticalAlignment` — Direction in which the component should show -- **VerticalStartPoint**: `GridVerticalAlignment` — Target's starting point -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbPositionStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPositionStrategy) -Documentation Position strategies determine where to display the component in the provided IgxOverlayService. - -- **constructor**(): void -- **Settings**: `IgbPositionSettings` — PositionSettings to use when position the component in the overlay -- **Type**: `string` -- **Clone**(): IgbPositionStrategy -- **CloneAsync**(): Task — Clone the strategy instance. settings.positionStrategy.clone(); -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbPositiveVolumeIndexIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPositiveVolumeIndexIndicator) -Represents a IgbDataChart Positive Volume Index (PVI) indicator series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbPositiveVolumeIndexIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPositiveVolumeIndexIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPriceChannelOverlay](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPriceChannelOverlay) -Represents a IgbDataChart Financial Price Channel Overlay series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current PriceChannelOverlay object. The typical, and initial, value for Bollinger band periods is 14. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetNextOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetNextOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetPreviousOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetPreviousOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetSeriesValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task - -### [IgbPriceChannelOverlayModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPriceChannelOverlayModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPriceVolumeTrendIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPriceVolumeTrendIndicator) -Represents a IgbDataChart Price Volume Trend Indicator series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbPriceVolumeTrendIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPriceVolumeTrendIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPrimaryKeyValue](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPrimaryKeyValue) -A primary key value. - -- **constructor**(): void -- **constructor**(key: string[], value: object[]): void -- **Key**: `string[]` — The primary key associated with this value. -- **Type**: `string` -- **Value**: `object[]` — The value of the keys for this primary key value. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPrimaryKeyValueModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPrimaryKeyValueModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbProgressBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbProgressBase) - -- **constructor**(): void -- **AnimationDuration**: `double` — Animation duration in milliseconds. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **HideLabel**: `bool` — Shows/hides the label of the control. -- **Indeterminate**: `bool` — The indeterminate state of the control. -- **LabelFormat**: `string` — Format string for the default label of the control. Placeholders: {0} - current value of the control. {1} - max value of the control. -- **Max**: `double` — Maximum value of the control. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `double` — The value of the control. -- **Variant**: `StyleVariant` — The variant of the control. -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbProgressBaseModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbProgressBaseModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbProgressiveLoadStatusEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbProgressiveLoadStatusEventArgs) -Provides information about the progressive load progress of the HighDensityScatterSeries. - -- **constructor**(): void -- **CurrentStatus**: `int` — The current status from 0 to 100 of the progressive load. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPropertyEditor](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyEditor) - -- **constructor**(): void -- **ActualDataSource**: `IgbPropertyEditorPropertyDescriptionCollection` — Gets the actaul data or data source instance to which to bind the grid. -- **BackgroundColor**: `string` — Gets or sets the color to use for the background of the component. -- **BaseTheme**: `BaseControlTheme` — Gets or Sets the property name that contains the values. -- **CellFontFamily**: `string` -- **CellFontSize**: `double` -- **CellFontStyle**: `string` -- **CellFontWeight**: `string` -- **ComponentRenderer**: `object` -- **ComponentRendererScript**: `string` — Provides a means of setting ComponentRenderer in the JavaScript environment. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or Sets the property name that contains the values. -- **DescriptionContext**: `object` -- **DescriptionContextScript**: `string` — Provides a means of setting DescriptionContext in the JavaScript environment. -- **DescriptionType**: `string` -- **FilterPlaceholderText**: `string` — Gets or Sets the property name that contains the values. -- **IsHorizontal**: `bool` -- **IsIndirectModeEnabled**: `bool` -- **IsWrappingEnabled**: `bool` -- **Properties**: `IgbPropertyEditorPropertyDescriptionCollection` — Gets or sets the data or data source instance to which to bind the grid. -- **RowHeight**: `int` — Gets or Sets the property name that contains the values. -- **SearchInputType**: `InputGroupDisplayType` — Gets or Sets the property name that contains the values. -- **Target**: `object` -- **TargetScript**: `string` — Provides a means of setting Target in the JavaScript environment. -- **TextColor**: `string` — Gets or sets the color to use for the text of the component. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetDesiredSize**(): Size -- **GetDesiredSizeAsync**(): Task -- **NotifyClearItems**(): void -- **NotifyClearItemsAsync**(): Task — Manually notifies the checkboxlist's grid that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the grid is bound to is already observable. -- **NotifyInsertItem**(index: int, newItem: object): void -- **NotifyInsertItemAsync**(index: int, newItem: object): Task -- **NotifyRemoveItem**(index: int, oldItem: object): void -- **NotifyRemoveItemAsync**(index: int, oldItem: object): Task -- **NotifySetItem**(index: int, oldItem: object, newItem: object): void -- **NotifySetItemAsync**(index: int, oldItem: object, newItem: object): Task - -### [IgbPropertyEditorDataSource](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyEditorDataSource) - -- **constructor**(): void -- **Context**: `object` -- **ContextScript**: `string` — Provides a means of setting Context in the JavaScript environment. -- **DescriptionType**: `string` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbPropertyEditorDescriptionObject](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyEditorDescriptionObject) - -- **constructor**(): void -- **DescriptionType**: `string` -- **Properties**: `IgbPropertyEditorPropertyDescriptionCollection` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbPropertyEditorDescriptionObjectCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyEditorDescriptionObjectCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbPropertyEditorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyEditorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPropertyEditorPanel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyEditorPanel) - -- **constructor**(): void -- **ActualDataSource**: `IgbPropertyEditorPropertyDescriptionCollection` — Gets the actaul data or data source instance to which to bind the grid. -- **ActualProperties**: `IgbPropertyEditorPropertyDescriptionCollection` -- **ActualRowHeight**: `double` -- **BackgroundColor**: `string` — Gets or sets the color to use for the background of the component. -- **CellFontFamily**: `string` -- **CellFontSize**: `double` -- **CellFontStyle**: `string` -- **CellFontWeight**: `string` -- **ComponentRenderer**: `object` -- **ComponentRendererScript**: `string` — Provides a means of setting ComponentRenderer in the JavaScript environment. -- **ContentProperties**: `IgbPropertyEditorPropertyDescriptionCollection` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DescriptionContext**: `object` -- **DescriptionContextScript**: `string` — Provides a means of setting DescriptionContext in the JavaScript environment. -- **DescriptionType**: `string` -- **IsHorizontal**: `bool` -- **IsIndirectModeEnabled**: `bool` -- **IsWrappingEnabled**: `bool` -- **ParentTypeName**: `string` -- **Properties**: `IgbPropertyEditorPropertyDescriptionCollection` — Gets or sets the data or data source instance to which to bind the grid. -- **RowHeight**: `int` — Gets or Sets the property name that contains the values. -- **Target**: `object` -- **TargetScript**: `string` — Provides a means of setting Target in the JavaScript environment. -- **TextColor**: `string` — Gets or sets the color to use for the text of the component. -- **Type**: `string` -- **UpdateMode**: `PropertyEditorPanelUpdateMode` — Gets or Sets the property name that contains the values. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **NotifyClearItems**(): void -- **NotifyClearItemsAsync**(): Task — Manually notifies the checkboxlist's grid that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the grid is bound to is already observable. -- **NotifyInsertItem**(index: int, newItem: object): void -- **NotifyInsertItemAsync**(index: int, newItem: object): Task -- **NotifyRemoveItem**(index: int, oldItem: object): void -- **NotifyRemoveItemAsync**(index: int, oldItem: object): Task -- **NotifySetItem**(index: int, oldItem: object, newItem: object): void -- **NotifySetItemAsync**(index: int, oldItem: object, newItem: object): Task - -### [IgbPropertyEditorPanelModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyEditorPanelModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPropertyEditorPropertyDescription](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyEditorPropertyDescription) - -- **constructor**(): void -- **ButtonClicked**: `Action` -- **ButtonClickedScript**: `string` -- **Changed**: `Action` -- **ChangedScript**: `string` -- **CoercedComplexValue**: `IgbPropertyEditorDescriptionObject` -- **CoercedComplexValues**: `IgbPropertyEditorDescriptionObjectCollection` -- **CoercedPrimitiveValue**: `object` -- **CoercedValueType**: `PropertyEditorValueType` -- **CoercingValue**: `Action` -- **CoercingValueScript**: `string` -- **ComplexValue**: `IgbPropertyEditorDescriptionObject` -- **ComplexValues**: `IgbPropertyEditorDescriptionObjectCollection` -- **DropDownNames**: `string[]` -- **DropDownValues**: `string[]` -- **EditorWidth**: `double` -- **ElementDescriptionType**: `string` -- **Label**: `string` -- **LabelWidth**: `double` -- **Max**: `double` -- **Min**: `double` -- **PrimitiveValue**: `object` -- **Properties**: `IgbPropertyEditorPropertyDescriptionCollection` -- **PropertyDescriptionType**: `string` -- **PropertyEditorPanelParent**: `BaseRendererControl` -- **PropertyPath**: `string` -- **ShouldOverrideDefaultEditor**: `bool` -- **Step**: `double` -- **Subtitle**: `string` -- **TargetPropertyUpdating**: `Action` -- **TargetPropertyUpdatingScript**: `string` -- **Type**: `string` -- **UseCoercedValue**: `bool` -- **ValueType**: `PropertyEditorValueType` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentPrimitiveValue**(): object -- **GetCurrentPrimitiveValueAsync**(): Task -- **OnInitializedAsync**(): Task - -### [IgbPropertyEditorPropertyDescriptionButtonClickEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyEditorPropertyDescriptionButtonClickEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPropertyEditorPropertyDescriptionChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyEditorPropertyDescriptionChangedEventArgs) - -- **constructor**(): void -- **NewValue**: `object` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPropertyEditorPropertyDescriptionCoercingValueEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyEditorPropertyDescriptionCoercingValueEventArgs) - -- **constructor**(): void -- **ComplexValue**: `IgbPropertyEditorDescriptionObject` -- **ComplexValues**: `IgbPropertyEditorDescriptionObjectCollection` -- **Type**: `string` -- **Value**: `object` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPropertyEditorPropertyDescriptionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyEditorPropertyDescriptionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbPropertyEditorPropertyDescriptionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyEditorPropertyDescriptionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbPropertyEditorPropertyDescriptionTargetPropertyUpdatingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyEditorPropertyDescriptionTargetPropertyUpdatingEventArgs) - -- **constructor**(): void -- **PropertyPath**: `string` -- **Target**: `object` -- **TargetScript**: `string` — Provides a means of setting Target in the JavaScript environment. -- **Type**: `string` -- **Value**: `object` -- **ValueScript**: `string` — Provides a means of setting Value in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPropertyReferenceFilterExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyReferenceFilterExpression) -Represents a filter expression that is a property access. - -- **constructor**(): void -- **IsPropertyReference**: `bool` — Gets if the expression is a property reference. -- **Precedence**: `int` -- **PropertyReference**: `string` — Gets/sets the property reference -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbPropertyUpdatedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbPropertyUpdatedEventArgs) -EventArgs class for property updated events. - -- **constructor**(): void -- **NewValue**: `object` — New or current value of the property being updated. -- **NewValueScript**: `string` — Provides a means of setting NewValue in the JavaScript environment. -- **OldValue**: `object` — Old or previous value of the property being updated. -- **OldValueScript**: `string` — Provides a means of setting OldValue in the JavaScript environment. -- **PropertyName**: `string` — Name of the property being updated. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbProportionalCategoryAngleAxis](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbProportionalCategoryAngleAxis) -Represents a IgbDataChart category angle axis. Useful for displaying radial categories. - -- **constructor**(): void -- **OthersCategoryText**: `string` — Gets or sets the label of the Others slice. -- **OthersCategoryThreshold**: `double` — Gets or sets the threshold value that determines if categories are grouped into the Others category. -- **OthersCategoryType**: `OthersCategoryType` — Gets or sets whether to use numeric or percent-based threshold value. -- **Type**: `string` -- **ValueMemberPath**: `string` — Gets or sets the Value mapping property for the axis. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetNormalizingValueAtIndex**(index: int, fallbackValue: double): double -- **GetNormalizingValueAtIndexAsync**(index: int, fallbackValue: double): Task -- **GetPercentageValue**(labelIndex: int): double -- **GetPercentageValueAsync**(labelIndex: int): Task -- **GetScaledAngle**(unscaledAngle: double): double -- **GetScaledAngleAsync**(unscaledAngle: double): Task — Gets a scaled value inside the viewport. -- **GetUnscaledAngle**(scaledAngle: double): double -- **GetUnscaledAngleAsync**(scaledAngle: double): Task — Returns an unscaled value from a scaled value based on the amount of data. -- **GetValueLabel**(value: double): string -- **GetValueLabelAsync**(value: double): Task — Gets the label for a data item. -- **IsOthersValue**(index: int): bool -- **IsOthersValueAsync**(index: int): Task - -### [IgbProportionalCategoryAngleAxisModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbProportionalCategoryAngleAxisModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbProvideCalculatorEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbProvideCalculatorEventArgs) -Event arguments for the ProvideCalculator event. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbQ1Expression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbQ1Expression) -Requests an expression for the Q1 filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbQ2Expression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbQ2Expression) -Requests an expression for the Q2 filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbQ3Expression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbQ3Expression) -Requests an expression for the Q3 filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbQ4Expression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbQ4Expression) -Requests an expression for the Q4 filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbQuarterToDateExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbQuarterToDateExpression) -Requests an expression for the QuarterToDate filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbQueryBuilder](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbQueryBuilder) - -- **constructor**(): void -- **ActualQueryBuilderHeaderCollection**: `IgbQueryBuilderHeaderCollection` -- **ContentQueryBuilderHeaderCollection**: `IgbQueryBuilderHeaderCollection` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DisableEntityChange**: `bool` — Disables subsequent entity changes at the root level after the initial selection. -- **DisableReturnFieldsChange**: `bool` — Disables return fields changes at the root level. -- **Entities**: `IgbEntityType[]` — Gets the list of entities available for the IgxQueryBuilderComponent. Each entity describes a logical group of fields that can be used in queries. An entity can optionally have child entities, allowing nested sub-queries. An array of { EntityType} objects. -- **ExpressionTree**: `IgbExpressionTree` — Returns the expression tree. -- **ExpressionTreeChange**: `EventCallback` -- **ExpressionTreeChangeScript**: `string` -- **Locale**: `string` — Gets the locale of the query builder. If not set, defaults to application's locale. -- **ParentTypeName**: `string` -- **QueryBuilderHeaderCollection**: `IgbQueryBuilderHeaderCollection` -- **SearchValueTemplate**: `RenderFragment` — Sets/gets the search value template. -- **SearchValueTemplateScript**: `string` — Provides a means of setting SearchValueTemplate in the JavaScript environment. -- **ShowEntityChangeDialog**: `bool` — Gets/sets whether the confirmation dialog should be shown when changing entity. Default value is true. -- **Type**: `string` -- **CanCommit**(): bool -- **CanCommitAsync**(): Task — Returns whether the expression tree can be committed in the current state. -- **Commit**(): void -- **CommitAsync**(): Task — Commits the expression tree in the current state if it is valid. If not throws an exception. -- **Discard**(): void -- **DiscardAsync**(): Task — Discards all unsaved changes to the expression tree. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbQueryBuilderHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbQueryBuilderHeader) -IgxQueryBuilderComponent - -- **constructor**(): void -- **ParentTypeName**: `string` -- **QueryBuilderParent**: `BaseRendererControl` -- **ShowLegend**: `bool` — Show/hide the legend. -- **SupportsVisualChildren**: `bool` -- **Title**: `string` — Sets the title of the IgxQueryBuilderHeaderComponent. -- **Type**: `string` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbQueryBuilderHeaderCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbQueryBuilderHeaderCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbQueryBuilderHeaderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbQueryBuilderHeaderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbQueryBuilderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbQueryBuilderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbQueryBuilderSearchValueContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbQueryBuilderSearchValueContext) - -- **constructor**(): void -- **Implicit**: `object` -- **SelectedCondition**: `string` -- **SelectedField**: `IgbFieldType` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRadialAreaSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialAreaSeries) -Represents a IgbDataChart radial area series. - -- **constructor**(): void -- **Type**: `string` -- **UnknownValuePlotting**: `UnknownValuePlotting` — Determines how unknown values will be plotted on the chart. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbRadialAreaSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialAreaSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRadialBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialBase) -Represents the base class for all IgbDataChart radial series - -- **constructor**(): void -- **AngleAxis**: `IgbCategoryAngleAxis` — Gets the effective angle axis for the current series object. -- **AngleAxisName**: `string` — Gets or sets the name to use to resolve angleAxis from markup. -- **AngleAxisScript**: `string` — Provides a means of setting AngleAxis in the JavaScript environment. -- **AssigningRadialMarkerStyle**: `Action` -- **AssigningRadialMarkerStyleScript**: `string` -- **AssigningRadialStyle**: `Action` -- **AssigningRadialStyleScript**: `string` -- **AutoCalloutLabelPrecision**: `int` — Gets or sets the format string to use for the auto callout labels for the others category. -- **AutoCalloutLabelValueSeparator**: `string` — Gets or sets the labelling mode to use for the auto callouts in preference to their mode. -- **AutoCalloutOthersLabelFormat**: `string` — Gets or sets the format string to use for the auto callout labels for the others category. -- **AutoCalloutOthersLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the auto callouts for the others category. -- **AutoCalloutPercentagePrecision**: `int` — Gets or sets the format string to use for the auto callout labels for the others category. -- **AutoCalloutRadialLabelMode**: `RadialLabelMode` — Gets or sets the labelling mode to use for the auto callouts in preference to their mode. -- **CategoryCollisionMode**: `CategoryCollisionMode` — Gets or sets the category collision mode selection behavior to use for the series. -- **ClipSeriesToBounds**: `bool` — Gets or sets whether to clip the series to the bounds. -- **IsCustomRadialMarkerStyleAllowed**: `bool` — Gets or sets whether this Radial series should allow custom style overrides of its individual marker visuals. -- **IsCustomRadialStyleAllowed**: `bool` — Gets or sets whether this Radial series should allow custom style overrides of its individual visuals. -- **IsTransitionInEnabled**: `bool` — Gets or sets whether the series should transition into the plot area when a new data source is assigned. Note: Transitions are not currently supported for stacked series. -- **LegendProportionalRadialLabelFormat**: `string` — Gets or sets the format string to use for the auto callout labels for the others category. -- **LegendProportionalRadialLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the auto callouts for the others category. -- **LegendRadialLabelMode**: `RadialLabelMode` — Gets or sets the labelling mode to use for the auto callouts in preference to their mode. -- **OthersCategoryBrush**: `string` — Gets or sets the OthersCategoryBrush property. -- **OthersCategoryOutline**: `string` — Gets or sets the OthersCategoryOutline property. -- **OthersLegendProportionalRadialLabelFormat**: `string` — Gets or sets the format string to use for the auto callout labels for the others category. -- **OthersLegendProportionalRadialLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the auto callouts for the others category. -- **OthersProportionalRadialLabelFormat**: `string` — Gets or sets the format string to use for the auto callout labels for the others category. -- **OthersProportionalRadialLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the auto callouts for the others category. -- **ProportionalRadialLabelFormat**: `string` — Gets or sets the format string to use for the auto callout labels for the others category. -- **ProportionalRadialLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the auto callouts for the others category. -- **TransitionInMode**: `CategoryTransitionInMode` — Gets or sets the method by which to animate the data into the chart when the chart data source is swapped. Note: Transitions are not currently supported for stacked series. -- **Type**: `string` -- **ValueAxis**: `IgbNumericRadiusAxis` — Gets the effective value axis for the current series object. -- **ValueAxisName**: `string` — Gets or sets the name to use to resolve valueAxis from markup. -- **ValueAxisScript**: `string` — Provides a means of setting ValueAxis in the JavaScript environment. -- **BindAxes**(Axes: IgbAxis[]): void -- **CanUseAsAngleAxis**(axis: object): bool -- **CanUseAsAngleAxisAsync**(axis: object): Task — Determine if object can be used as AngleAxis -- **CanUseAsValueAxis**(axis: object): bool -- **CanUseAsValueAxisAsync**(axis: object): Task — Determine if object can be used as ValueAxis -- **FindByName**(name: string): object -- **GetAngleFromWorld**(world: Point): double -- **GetAngleFromWorldAsync**(world: Point): Task — Gets the angle to the provided world position from the center of the radial series. -- **GetCategoryWidth**(): double -- **GetCategoryWidthAsync**(): Task — Returns the width of the category grouping this series is in. -- **GetExactItemIndex**(world: Point): double -- **GetExactItemIndexAsync**(world: Point): Task — Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex. -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemIndex**(world: Point): int -- **GetItemIndexAsync**(world: Point): Task — Get the index of the item near the provided world coordinates. -- **GetOffsetValue**(): double -- **GetOffsetValueAsync**(): Task — Returns the offset value for this series if grouped on a category axis. -- **GetUnscaledPosition**(pos: Point): Point -- **GetUnscaledPositionAsync**(pos: Point): Task — Gets an unscaled position in terms of axis values from a viewport position. -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the specified item into the view. - -### [IgbRadialBaseChart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialBaseChart) -Represents a base class for domain charts with X/Y axes - -- **constructor**(): void -- **ActualAngleAxisLabelTextColor**: `string` — Gets the actual color of labels on the X-axis -- **ActualValueAxisLabelTextColor**: `string` — Gets the actual color of labels on the Y-axis -- **AngleAxisExtent**: `double` — Gets or sets the distance between the X-axis and the bottom of the chart. -- **AngleAxisFormatLabel**: `string` — Gets or sets function which takes an context object and returns a formatted label for the X-axis. -- **AngleAxisFormatLabelScript**: `string` — Provides a means of setting AngleAxisFormatLabel in the JavaScript environment. -- **AngleAxisInverted**: `bool` — Gets or sets whether to invert the direction of the X-axis by placing the first data items on the right side of the chart. -- **AngleAxisLabel**: `object` — Gets or sets the format for labels along the X-axis. -- **AngleAxisLabelAngle**: `double` — Gets or sets the angle of rotation for labels along the X-axis. -- **AngleAxisLabelBottomMargin**: `double` — Gets or sets the bottom margin of labels on the X-axis -- **AngleAxisLabelFormat**: `string` — Gets or sets the format string for the X axis label. -- **AngleAxisLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the AngleAxisLabelFormat string. -- **AngleAxisLabelHorizontalAlignment**: `HorizontalAlignment` — Gets or sets Horizontal alignment of X-axis labels. -- **AngleAxisLabelLeftMargin**: `double` — Gets or sets the left margin of labels on the X-axis -- **AngleAxisLabelLocation**: `AngleAxisLabelLocation` — Gets or sets location of X-axis labels, relative to the plot area. -- **AngleAxisLabelRightMargin**: `double` — Gets or sets the right margin of labels on the X-axis -- **AngleAxisLabelScript**: `string` — Provides a means of setting AngleAxisLabel in the JavaScript environment. -- **AngleAxisLabelTextColor**: `string` — Gets or sets color of labels on the X-axis -- **AngleAxisLabelTextStyle**: `string` — Gets or sets CSS font property for labels on X-axis -- **AngleAxisLabelTopMargin**: `double` — Gets or sets the top margin of labels on the X-axis -- **AngleAxisLabelVerticalAlignment**: `VerticalAlignment` — Gets or sets Vertical alignment of X-axis labels. -- **AngleAxisLabelVisibility**: `Visibility` — Gets or sets Visibility of X-axis labels. -- **AngleAxisMajorStroke**: `string` — Gets or sets the color to apply to major gridlines along the X-axis. -- **AngleAxisMajorStrokeThickness**: `double` — Gets or sets the thickness to apply to major gridlines along the X-axis. -- **AngleAxisMaximumExtent**: `double` — Gets or sets the maximum distance between the X-axis and the bottom of the chart. -- **AngleAxisMaximumExtentPercentage**: `double` — Gets or sets the maximum width between the X-axis and the bottom of the chart, as a percentage of total chart width. -- **AngleAxisMinorStroke**: `string` — Gets or sets the color to apply to minor gridlines along the X-axis. -- **AngleAxisMinorStrokeThickness**: `double` — Gets or sets the thickness to apply to minor gridlines along the X-axis. -- **AngleAxisStrip**: `string` — Gets or sets the color to apply to stripes along the X-axis. -- **AngleAxisStroke**: `string` — Gets or sets the color to apply to the X-axis line. -- **AngleAxisStrokeThickness**: `double` — Gets or sets the thickness to apply to the X-axis line. -- **AngleAxisTickLength**: `double` — Gets or sets the length of tickmarks along the X-axis. -- **AngleAxisTickStroke**: `string` — Gets or sets the color to apply to tickmarks along the X-axis. -- **AngleAxisTickStrokeThickness**: `double` — Gets or sets the thickness to apply to tickmarks along the X-axis. -- **AngleAxisTitle**: `string` — Gets or sets the Text to display below the X-axis. -- **AngleAxisTitleAlignment**: `HorizontalAlignment` — Gets or sets Horizontal alignment of the X-axis title. -- **AngleAxisTitleAngle**: `double` — Gets or sets the angle of rotation for the X-axis title. -- **AngleAxisTitleBottomMargin**: `double` — Gets or sets the bottom margin of a title on the X-axis -- **AngleAxisTitleLeftMargin**: `double` — Gets or sets the left margin of a title on the X-axis -- **AngleAxisTitleMargin**: `double` — Gets or sets the margin around a title on the X-axis -- **AngleAxisTitleRightMargin**: `double` — Gets or sets the right margin of a title on the X-axis -- **AngleAxisTitleTextColor**: `string` — Gets or sets color of title on the X-axis -- **AngleAxisTitleTextStyle**: `string` — Gets or sets CSS font property for title on X-axis -- **AngleAxisTitleTopMargin**: `double` — Gets or sets the top margin of a title on the X-axis -- **Type**: `string` -- **ValueAxisExtent**: `double` — Gets or sets the distance between the Y-axis and the left edge of the chart. -- **ValueAxisFormatLabel**: `string` — Gets or sets function which takes a context object and returns a formatted label for the Y-axis. -- **ValueAxisFormatLabelScript**: `string` — Provides a means of setting ValueAxisFormatLabel in the JavaScript environment. -- **ValueAxisInverted**: `bool` — Gets or sets whether to invert the direction of the Y-axis by placing the minimum numeric value at the top of the chart. -- **ValueAxisLabel**: `object` — Gets or sets the property or string from which the labels are derived. -- **ValueAxisLabelAngle**: `double` — Gets or sets the angle of rotation for labels along the Y-axis. -- **ValueAxisLabelBottomMargin**: `double` — Gets or sets the bottom margin of labels on the Y-axis -- **ValueAxisLabelFormat**: `string` — Gets or sets the format string for the Y axis label. -- **ValueAxisLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the ValueAxisLabelFormat string. -- **ValueAxisLabelHorizontalAlignment**: `HorizontalAlignment` — Gets or sets Horizontal alignment of Y-axis labels. -- **ValueAxisLabelLeftMargin**: `double` — Gets or sets the left margin of labels on the Y-axis -- **ValueAxisLabelLocation**: `ValueAxisLabelLocation` — Gets or sets location of Y-axis labels, relative to the plot area. -- **ValueAxisLabelRightMargin**: `double` — Gets or sets the right margin of labels on the Y-axis -- **ValueAxisLabelScript**: `string` — Provides a means of setting ValueAxisLabel in the JavaScript environment. -- **ValueAxisLabelTextColor**: `string` — Gets or sets color of labels on the Y-axis -- **ValueAxisLabelTextStyle**: `string` — Gets or sets CSS font property for labels on Y-axis -- **ValueAxisLabelTopMargin**: `double` — Gets or sets the top margin of labels on the Y-axis -- **ValueAxisLabelVerticalAlignment**: `VerticalAlignment` — Gets or sets Vertical alignment of Y-axis labels. -- **ValueAxisLabelVisibility**: `Visibility` — Gets or sets Visibility of Y-axis labels. -- **ValueAxisMajorStroke**: `string` — Gets or sets the color to apply to major gridlines along the Y-axis. -- **ValueAxisMajorStrokeThickness**: `double` — Gets or sets the thickness to apply to major gridlines along the Y-axis. -- **ValueAxisMaximumExtent**: `double` — Gets or sets the distance between the Y-axis and the left edge of the chart. -- **ValueAxisMaximumExtentPercentage**: `double` — Gets or sets the distance between the Y-axis and the left edge of the chart. -- **ValueAxisMinorStroke**: `string` — Gets or sets the color to apply to minor gridlines along the Y-axis. -- **ValueAxisMinorStrokeThickness**: `double` — Gets or sets the thickness to apply to minor gridlines along the Y-axis. -- **ValueAxisStrip**: `string` — Gets or sets the color to apply to stripes along the Y-axis. -- **ValueAxisStroke**: `string` — Gets or sets the color to apply to the Y-axis line. -- **ValueAxisStrokeThickness**: `double` — Gets or sets the thickness to apply to the Y-axis line. -- **ValueAxisTickLength**: `double` — Gets or sets the length of tickmarks along the Y-axis. -- **ValueAxisTickStroke**: `string` — Gets or sets the color to apply to tickmarks along the Y-axis. -- **ValueAxisTickStrokeThickness**: `double` — Gets or sets the thickness to apply to tickmarks along the Y-axis. -- **ValueAxisTitle**: `string` — Gets or sets the Text to display to the left of the Y-axis. -- **ValueAxisTitleAlignment**: `VerticalAlignment` — Gets or sets Vertical alignment of the Y-axis title. -- **ValueAxisTitleAngle**: `double` — Gets or sets the angle of rotation for the Y-axis title. -- **ValueAxisTitleBottomMargin**: `double` — Gets or sets the bottom margin of a title on the Y-axis -- **ValueAxisTitleLeftMargin**: `double` — Gets or sets the left margin of a title on the Y-axis -- **ValueAxisTitleMargin**: `double` — Gets or sets the margin around a title on the Y-axis -- **ValueAxisTitleRightMargin**: `double` — Gets or sets the right margin of a title on the Y-axis -- **ValueAxisTitleTextColor**: `string` — Gets or sets color of title on the Y-axis -- **ValueAxisTitleTextStyle**: `string` — Gets or sets CSS font property for title on Y-axis -- **ValueAxisTitleTopMargin**: `double` — Gets or sets the top margin of a title on the Y-axis -- **FindByName**(name: string): object -- **GetScaledAngle**(unscaledValue: double): double -- **GetScaledAngleAsync**(unscaledValue: double): Task — Converts the given visual location to a data value. -- **GetScaledValue**(unscaledValue: double): double -- **GetScaledValueAsync**(unscaledValue: double): Task — Converts the given visual location to a data value. -- **GetUnscaledAngle**(scaledValue: double): double -- **GetUnscaledAngleAsync**(scaledValue: double): Task — Converts the given data value to a visual location. -- **GetUnscaledValue**(scaledValue: double): double -- **GetUnscaledValueAsync**(scaledValue: double): Task — Converts the given data value to a visual location. -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task — Called by the UI framework to provide a UI container for rendering this control. - -### [IgbRadialColumnSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialColumnSeries) -Represents a IgbDataChart radial column series. Compare values across categories by using radial rectangles. - -- **constructor**(): void -- **RadiusX**: `double` — Gets or sets the x-radius of the ellipse that is used to round the corners of the column. -- **RadiusY**: `double` — Gets or sets the y-radius of the ellipse that is used to round the corners of the column. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItemSpan**(): double -- **GetItemSpanAsync**(): Task — For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. - -### [IgbRadialColumnSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialColumnSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRadialGauge](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialGauge) -A radial gauge for displaying a single value on a defined scale. - -- **constructor**(): void -- **ActualHighlightValueDisplayMode**: `HighlightedValueDisplayMode` — Gets whether and how to display the highlighted value. -- **ActualHighlightValueOpacity**: `double` — Gets the actual opacity of the primary needle while highlighting -- **ActualLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ActualMaximumValue**: `double` — Gets the resolved maximum value of the scale. -- **ActualMaximumValueChanged**: `Action` -- **ActualMaximumValueChangedScript**: `string` -- **ActualMinimumValue**: `double` — Gets the resolved minimum value of the scale. -- **ActualMinimumValueChanged**: `Action` -- **ActualMinimumValueChangedScript**: `string` -- **ActualPixelScalingRatio**: `double` — Gets the actual pixel scaling ratio used to affect the pixel density of the control. -- **ActualRanges**: `IgbRadialGaugeRangeCollection` -- **AlignHighlightLabel**: `EventCallback` -- **AlignHighlightLabelScript**: `string` -- **AlignLabel**: `EventCallback` -- **AlignLabelScript**: `string` -- **AlignSubtitle**: `EventCallback` -- **AlignSubtitleScript**: `string` -- **AlignTitle**: `EventCallback` -- **AlignTitleScript**: `string` -- **BackingBrush**: `string` — Gets or sets the brush to use to fill the backing of the gauge. -- **BackingCornerRadius**: `double` — Gets or sets the corner rounding radius to use for the fitted scale backings. -- **BackingInnerExtent**: `double` — Gets or sets the inner extent of the gauge backing. -- **BackingOuterExtent**: `double` — Gets or sets the outer extent of the gauge backing. -- **BackingOutline**: `string` — Gets or sets the brush to use for the outline of the backing. -- **BackingOversweep**: `double` — Gets or sets the over sweep angle to apply to the backing if it is displaying fitted (in degrees). Must be greater or equal to 0. -- **BackingShape**: `RadialGaugeBackingShape` — Gets or sets the type of shape to use for the backing of the gauge. -- **BackingStrokeThickness**: `double` — Gets or sets the stroke thickness of the backing outline. -- **CenterX**: `double` — Gets or sets the x position of the center of the gauge with the value ranging from 0 to 1. -- **CenterY**: `double` — Gets or sets the y position of the center of the gauge with the value ranging from 0 to 1. -- **ContentLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ContentRanges**: `IgbRadialGaugeRangeCollection` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DuplicateLabelOmissionStrategy**: `RadialGaugeDuplicateLabelOmissionStrategy` — Gets or sets the strategy to use for omitting labels if the first and last label have the same value. -- **Font**: `string` — Gets or sets the font. -- **FontBrush**: `string` — Gets or sets the brush to use for the label font. -- **FormatHighlightLabel**: `EventCallback` -- **FormatHighlightLabelScript**: `string` -- **FormatLabel**: `EventCallback` -- **FormatLabelScript**: `string` -- **FormatSubtitle**: `EventCallback` -- **FormatSubtitleScript**: `string` -- **FormatTitle**: `EventCallback` -- **FormatTitleScript**: `string` -- **HighlightLabelAngle**: `double` — Gets or sets the angle for the highlight label in degrees. -- **HighlightLabelBrush**: `string` — Gets or sets the brush to use for rendering highlight text -- **HighlightLabelDisplaysValue**: `bool` — Gets or sets the highlight label shows values of the gauge. -- **HighlightLabelExtent**: `double` — Gets or sets the angle for the highlight label in degrees. -- **HighlightLabelFontFamily**: `string` -- **HighlightLabelFontSize**: `double` -- **HighlightLabelFontStyle**: `string` -- **HighlightLabelFontWeight**: `string` -- **HighlightLabelFormat**: `string` — Gets or sets the format used when creating highlight label. -- **HighlightLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the HighlightLabelFormat string. -- **HighlightLabelSnapsToNeedlePivot**: `bool` — Gets or sets whether or not the highlight label should snap angle position to needle pivot (opposite of needle pointer). -- **HighlightLabelText**: `string` — Gets or sets the text displayed for the highlight label of the gauge. -- **HighlightValue**: `double` — Gets or sets the highlight value at which to point the secondary needle of the gauge. -- **HighlightValueChanged**: `Action` -- **HighlightValueChangedScript**: `string` -- **HighlightValueDisplayMode**: `HighlightedValueDisplayMode` — Gets or sets whether and how to display the highlighted value. -- **HighlightValueOpacity**: `double` — Gets or sets the opacity of the primary needle while highlighting -- **Interval**: `double` — Gets or sets the interval to use for the scale. -- **IsHighlightNeedleDraggingConstrained**: `bool` — Gets or sets whether the needle is constrained within the minimum and maximum value range during dragging. -- **IsHighlightNeedleDraggingEnabled**: `bool` — Gets or sets whether needle dragging is enabled or not. -- **IsNeedleDraggingConstrained**: `bool` — Gets or sets whether the needle is constrained within the minimum and maximum value range during dragging. -- **IsNeedleDraggingEnabled**: `bool` — Gets or sets whether needle dragging is enabled or not. -- **LabelExtent**: `double` — Gets or sets the position at which to put the labels as a value from 0 to 1, measured form the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **LabelFormat**: `string` — Gets or sets the label composite format used when creating label values. -- **LabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the LabelFormat string. -- **LabelInterval**: `double` — Gets or sets the interval to use for rendering labels. This defaults to be the same interval as the tickmarks on the scale. -- **MaximumValue**: `double` — Gets or sets the maximum value of the scale. -- **MinimumValue**: `double` — Gets or sets the minimum value of the scale. -- **MinorTickBrush**: `string` — Gets or sets the brush to use for the minor tickmarks. -- **MinorTickCount**: `double` — Gets or sets the number of minor tickmarks to place between major tickmarks. -- **MinorTickEndExtent**: `double` — Gets or sets the position at which to stop rendering the minor tickmarks as a value from 0 to 1, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **MinorTickStartExtent**: `double` — Gets or sets the position at which to start rendering the minor tickmarks as a value from 0 to 1, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **MinorTickStrokeThickness**: `double` — Gets or sets the stroke thickness to use when rendering minor ticks. -- **NeedleBaseFeatureExtent**: `double` — Gets or sets the extent of the feature which is closest to the base (e.g. a bulb) with a value from -1 to 1. Note: Only some needle shapes respect this property, namely: NeedleWithBulb, RectangleWithBulb, TrapezoidWithBulb, and TriangleWithBulb. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **NeedleBaseFeatureWidthRatio**: `double` — Gets or sets the width of the needle at its feature which is closest to the base (e.g. a bulb) with a value from 0 to 1. Note: Only some needle shapes respect this property, namely: NeedleWithBulb, RectangleWithBulb, TrapezoidWithBulb, and TriangleWithBulb. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **NeedleBrush**: `string` — Gets or sets the brush to use when rendering the fill of the needle. -- **NeedleEndExtent**: `double` — Gets or sets the extent (from -1 to 1) at which to end rendering the needle, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **NeedleEndWidthRatio**: `double` — Gets or sets the width of the needle at its point using a value from (0 to 1). Note: Only some needle shapes respect this property. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **NeedleOutline**: `string` — Gets or sets the brush to use when rendering the outline of the needle. -- **NeedlePivotBrush**: `string` — Gets or sets the brush to use for filling the needle cap. Note: this only applies to certain cap shapes. -- **NeedlePivotInnerWidthRatio**: `double` — Gets or sets the width of the inner cutout section of the needle cap with a value from 0 to 1. Note: Will only take effect if you have a cap set on the needle that has a cutout section. -- **NeedlePivotOutline**: `string` — Gets or sets the brush to use for the outlines of the needle cap. -- **NeedlePivotShape**: `RadialGaugePivotShape` — Gets or sets the shape to use for the needle cap. -- **NeedlePivotStrokeThickness**: `double` — Gets or sets the stroke thickness to use for the outline of the needle cap. -- **NeedlePivotWidthRatio**: `double` — Gets or sets the width of the cap of the needle with a value from 0 to 1. Note: Will only take effect if you have a cap set on the needle. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **NeedlePointFeatureExtent**: `double` — Gets or sets the extent of the feature which is closest to the point (e.g. the tapering point of a needle) with a value from -1 to 1. Note: Only some needle shapes respect this property. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **NeedlePointFeatureWidthRatio**: `double` — Gets or sets the width of the needle at its feature which is closest to the point (e.g. the tapering point of a needle) with a value from 0 to 1. Note: Only some needle shapes respect this property. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **NeedleShape**: `RadialGaugeNeedleShape` — Gets or sets the shape to use when rendering the needle from a number of options. -- **NeedleStartExtent**: `double` — Gets or sets the extent (from -1 to 1) at which to start rendering the needle, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **NeedleStartWidthRatio**: `double` — Gets or sets the width of the needle at its point using a value from (0 to 1). Note: Only some needle shapes respect this property. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **NeedleStrokeThickness**: `double` — Gets or sets the stroke thickness of the needle outline. -- **OpticalScalingEnabled**: `bool` — Gets or sets the title uses optical scaling when the gauge is resized. -- **OpticalScalingRatio**: `double` — Gets the optical scaling ratio calculated by dividing minimum gauge size by value of OpticalScalingSize property. -- **OpticalScalingSize**: `double` — Gets or sets the size at which labels have 100% optical scaling, e.g. labels will have larger fonts when gauge's size is larger -- **ParentTypeName**: `string` -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **RadiusMultiplier**: `double` — Gets or sets the multiplying factor to apply to the normal radius of the gauge. The radius of the gauge is defined by the minimum of the width and height of the control divided by 2.0. This introduces a multiplicative factor to that value. -- **RangeBrushes**: `string` — Gets or sets a collection of brushes to be used as the palette for gauge ranges. -- **RangeOutlines**: `string` — Gets or sets a collection of brushes to be used as the palette for gauge outlines. -- **Ranges**: `IgbRadialGaugeRangeCollection` — Gets or sets the ranges to render on the gauge. -- **ScaleBrush**: `string` — Gets or sets the brush to use to fill the background of the scale. -- **ScaleEndAngle**: `double` — Gets or sets the end angle for the scale in degrees. -- **ScaleEndExtent**: `double` — Gets or sets the position at which to stop rendering the scale as a value from 0 to 1 measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **ScaleOversweep**: `double` — Gets or sets the extra degrees of sweep to apply to the scale background. Must be greater or equal to 0. -- **ScaleOversweepShape**: `RadialGaugeScaleOversweepShape` — Gets or sets the oversweep shape to use for the excess fill area for the scale. -- **ScaleStartAngle**: `double` — Gets or sets the start angle for the scale in degrees. -- **ScaleStartExtent**: `double` — Gets or sets the position at which to start rendering the scale, measured from the center of the gauge as a value from 0 to 1. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **ScaleSweepDirection**: `SweepDirection` — Gets or sets the direction in which the scale sweeps around the center from the start angle to end angle. -- **SubtitleAngle**: `double` — Gets or sets the angle for the inner label in degrees. -- **SubtitleBrush**: `string` — Gets or sets the brush to use for rendering inner unit text -- **SubtitleDisplaysValue**: `bool` — Gets or sets the subtitle show values of the gauge. -- **SubtitleExtent**: `double` — Gets or sets the angle for the inner label in degrees. -- **SubtitleFontFamily**: `string` -- **SubtitleFontSize**: `double` -- **SubtitleFontStyle**: `string` -- **SubtitleFontWeight**: `string` -- **SubtitleFormat**: `string` — Gets or sets the subtitle format used when creating subtitle label. -- **SubtitleFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the SubtitleFormat string. -- **SubtitleSnapsToNeedlePivot**: `bool` — Gets or sets whether or not the subtitle should snap angle position to needle pivot (opposite of needle pointer). -- **SubtitleText**: `string` — Gets or sets the text displayed in the subtitle of the gauge. -- **TickBrush**: `string` — Gets or sets the brush to use for the major tickmarks. -- **TickEndExtent**: `double` — Gets or sets the position at which to stop rendering the major tickmarks as a value from 0 to 1, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **TickStartExtent**: `double` — Gets or sets the position at which to start rendering the major tickmarks as a value from 0 to 1, measured from the center of the gauge. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **TickStrokeThickness**: `double` — Gets or sets the stroke thickness to use when rendering ticks. -- **TitleAngle**: `double` — Gets or sets the angle for the inner label in degrees. -- **TitleBrush**: `string` — Gets or sets the brush to use for rendering inner unit text -- **TitleDisplaysValue**: `bool` — Gets or sets the title show values of the gauge. -- **TitleExtent**: `double` — Gets or sets the angle for the inner label in degrees. -- **TitleFontFamily**: `string` -- **TitleFontSize**: `double` -- **TitleFontStyle**: `string` -- **TitleFontWeight**: `string` -- **TitleFormat**: `string` — Gets or sets the title format used when creating title label. -- **TitleFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the TitleFormat string. -- **TitleSnapsToNeedlePivot**: `bool` — Gets or sets whether or not the title should snap angle position to needle pivot (opposite of needle pointer). -- **TitleText**: `string` — Gets or sets the text displayed in the title of the gauge. -- **TransitionDuration**: `int` — Gets or sets the number of milliseconds over which changes to the gauge should be animated. -- **TransitionProgress**: `double` — Gets the transition progress of the animation when the control is animating. -- **Type**: `string` -- **Value**: `double` — Gets or sets the value at which to point the needle of the gauge. -- **ValueChanged**: `Action` -- **ValueChangedScript**: `string` -- **ContainerResized**(): void -- **ContainerResizedAsync**(): Task -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Returns visuals as a serialized string. -- **FindByName**(name: string): object -- **Flush**(): void -- **FlushAsync**(): Task — Use to force the radial gauge to finish any deferred work before printing or evaluating its visual. -- **GetCurrentActualMaximumValue**(): double -- **GetCurrentActualMaximumValueAsync**(): Task -- **GetCurrentActualMinimumValue**(): double -- **GetCurrentActualMinimumValueAsync**(): Task -- **GetCurrentHighlightValue**(): double -- **GetCurrentHighlightValueAsync**(): Task -- **GetCurrentValue**(): double -- **GetCurrentValueAsync**(): Task -- **GetPointForValue**(value: double, extent: double): Point -- **GetPointForValueAsync**(value: double, extent: double): Task -- **GetValueForPoint**(point: Point): double -- **GetValueForPointAsync**(point: Point): Task — Gets the value for the main scale of the gauge for a given point within the bounds of the gauge. -- **HighlightNeedleContainsPoint**(point: Point, isFinger: bool): bool -- **HighlightNeedleContainsPointAsync**(point: Point, isFinger: bool): Task -- **NeedleContainsPoint**(point: Point, isFinger: bool): bool -- **NeedleContainsPointAsync**(point: Point, isFinger: bool): Task -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task — Called by the UI framework to provide a UI container for rendering this control. -- **ScaleValue**(value: double): double -- **ScaleValueAsync**(value: double): Task — Scales a value on the gauge's main scale to an angle around the center point of the gauge, in radians. -- **StyleUpdated**(): void -- **StyleUpdatedAsync**(): Task -- **UnscaleValue**(angle: double): double -- **UnscaleValueAsync**(angle: double): Task — Unscales a value from an angle in radians to the represented value along the main scale of the gauge. - -### [IgbRadialGaugeCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialGaugeCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRadialGaugeDashboardTileModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialGaugeDashboardTileModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRadialGaugeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialGaugeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRadialGaugeRange](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialGaugeRange) -Represents a range in the IgbRadialGauge control. - -- **constructor**(): void -- **Brush**: `string` — Gets or sets the brush to use to fill the range. -- **EndValue**: `double` — Gets or sets the value at which the range ends along the scale. -- **InnerEndExtent**: `double` — Gets or sets the distance from the center of the gauge (from 0 to 1) at which to end rendering the inner sweep of the range. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **InnerStartExtent**: `double` — Gets or sets the distance from the center of the gauge (from 0 to 1) at which to start rendering the inner sweep of the range. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **OuterEndExtent**: `double` — Gets or sets the distance from the center of the gauge (from 0 to 1) at which to end rendering the outer sweep of the range. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **OuterStartExtent**: `double` — Gets or sets the distance from the center of the gauge (from 0 to 1) at which to start rendering the outer sweep of the range. Values further from zero than 1 can be used to make this extend further than the normal radius of the gauge. -- **Outline**: `string` — Gets or sets the outline to use when rendering the range. -- **RadialGaugeParent**: `BaseRendererControl` -- **StartValue**: `double` — Gets or sets the value at which the range starts along the scale. -- **StrokeThickness**: `double` — Gets or sets the stroke thickness to use when rendering this range's outline. -- **Type**: `string` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task - -### [IgbRadialGaugeRangeCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialGaugeRangeCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbRadialGaugeRangeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialGaugeRangeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRadialLineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialLineSeries) -Represents a IgbDataChart radial line series. - -- **constructor**(): void -- **Type**: `string` -- **UnknownValuePlotting**: `UnknownValuePlotting` — Determines how unknown values will be plotted on the chart. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbRadialLineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialLineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRadialPieSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialPieSeries) -Represents a IgbDataChart radial pie series. Compare values across categories by using radial pie slices. - -- **constructor**(): void -- **LegendEmptyValuesMode**: `LegendEmptyValuesMode` — Determines display mode for zero values in the legend. -- **LegendLabelMemberPath**: `string` — Gets or sets the property name that contains the legend labels. -- **RadiusX**: `double` — Gets or sets the x-radius of the ellipse that is used to round the corners of the column. -- **RadiusY**: `double` — Gets or sets the y-radius of the ellipse that is used to round the corners of the column. -- **Type**: `string` -- **UseInsetOutlines**: `bool` — Specifies that slice outlines should be drawn inside the slice rather than halfway in and halfway out. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItemSpan**(): double -- **GetItemSpanAsync**(): Task — For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. -- **GetSeriesValueBoundingBox**(world: Point): Rect -- **GetSeriesValueBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. - -### [IgbRadialPieSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadialPieSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRadio](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadio) - -- **constructor**(): void -- **Blur**: `EventCallback` -- **BlurScript**: `string` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Checked**: `bool` — The checked state of the control. -- **CheckedChanged**: `EventCallback` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — The disabled state of the component -- **Focus**: `EventCallback` -- **FocusScript**: `string` -- **Invalid**: `bool` — Control the validity of the control. -- **LabelPosition**: `ToggleLabelPosition` — The label position of the radio control. -- **Required**: `bool` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `string` — The value attribute of the control. -- **BlurComponent**(): void -- **BlurComponentAsync**(): Task — Removes focus from the radio control. -- **CheckValidity**(): bool -- **CheckValidityAsync**(): Task — Checks for validity of the control and emits the invalid event if it invalid. -- **Click**(): void -- **ClickAsync**(): Task — Simulates a click on the radio control. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FocusComponent**(options: IgbFocusOptions): void -- **FocusComponentAsync**(options: IgbFocusOptions): Task — Sets focus on the radio control. -- **GetCurrentChecked**(): bool -- **GetCurrentCheckedAsync**(): Task -- **ReportValidity**(): bool -- **ReportValidityAsync**(): Task — Checks for validity of the control and shows the browser message if it invalid. -- **ResolveDisplay**(): string -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task — Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid. -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbRadioChangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadioChangeEventArgs) - -- **constructor**(): void -- **Detail**: `IgbRadioChangeEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRadioChangeEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadioChangeEventArgsDetail) - -- **constructor**(): void -- **Checked**: `bool` -- **Type**: `string` -- **Value**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRadioGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadioGroup) -The igc-radio-group component unifies one or more igc-radio buttons. - -- **constructor**(): void -- **Alignment**: `ContentOrientation` — Alignment of the radio controls inside this group. -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `string` — Gets/Sets the checked igc-radio element that matches value -- **ValueChanged**: `EventCallback` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): string -- **GetCurrentValueAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbRadioGroupModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadioGroupModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRadioModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRadioModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRangeAreaSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRangeAreaSeries) -Represents a IgbDataChart range area series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbRangeAreaSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRangeAreaSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRangeCategorySeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRangeCategorySeries) -Represents the base class for all IgbDataChart ranged category/value series. - -- **constructor**(): void -- **HighMemberPath**: `string` — Gets or sets the value mapping property for the current series object. -- **HighlightedHighMemberPath**: `string` — Gets or sets the highlighted High value mapping property for the current series object. -- **HighlightedLowMemberPath**: `string` — Gets or sets the highlighted low value mapping property for the current series object. -- **LowMemberPath**: `string` — Gets or sets the value mapping property for the current series object. -- **Type**: `string` -- **FindByName**(name: string): object -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the series to display the item for the specified data item. - -### [IgbRangeColumnSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRangeColumnSeries) -Represents a IgbDataChart range column series. - -- **constructor**(): void -- **RadiusX**: `double` — Gets or sets the x-radius of the ellipse that is used to round the corners of the column. -- **RadiusY**: `double` — Gets or sets the y-radius of the ellipse that is used to round the corners of the column. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItemSpan**(): double -- **GetItemSpanAsync**(): Task — For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. -- **GetSeriesValueBoundingBox**(world: Point): Rect -- **GetSeriesValueBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. - -### [IgbRangeColumnSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRangeColumnSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRangeSlider](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRangeSlider) -A range slider component used to select two numeric values within a range. - -- **constructor**(): void -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DirectRenderElementName**: `string` -- **Input**: `EventCallback` -- **InputScript**: `string` -- **Lower**: `double` — The current value of the lower thumb. -- **SupportsVisualChildren**: `bool` -- **ThumbLabelLower**: `string` — The aria label for the lower thumb. -- **ThumbLabelUpper**: `string` — The aria label for the upper thumb. -- **Type**: `string` -- **Upper**: `double` — The current value of the upper thumb. -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbRangeSliderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRangeSliderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRangeSliderValue](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRangeSliderValue) - -- **constructor**(): void -- **Lower**: `double` -- **Type**: `string` -- **Upper**: `double` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRangeSliderValueEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRangeSliderValueEventArgs) - -- **constructor**(): void -- **Detail**: `IgbRangeSliderValue` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRateOfChangeAndMomentumIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRateOfChangeAndMomentumIndicator) -Represents a IgbDataChart Rate of Change and Momentum indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current AverageTrueRangeSeries object. The typical, and initial, value for AverageTrueRange periods is 14. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbRateOfChangeAndMomentumIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRateOfChangeAndMomentumIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRating](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRating) -Rating provides insight regarding others' opinions and experiences, and can allow the user to submit a rating of their own --symbol-size - The size of the symbols. --symbol-full-color - The color of the filled symbol. --symbol-empty-color - The color of the empty symbol. --symbol-full-filter - The filter(s) used for the filled symbol. --symbol-empty-filter - The filter(s) used for the empty symbol. - -- **constructor**(): void -- **AllowReset**: `bool` — Whether to reset the rating when the user selects the same value. -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — The disabled state of the component -- **Hover**: `EventCallback` -- **HoverPreview**: `bool` — Sets hover preview behavior for the component -- **HoverScript**: `string` -- **Invalid**: `bool` — Control the validity of the control. -- **Label**: `string` — The label of the control. -- **Max**: `double` — The maximum value for the rating. If there are projected symbols, the maximum value will be resolved based on the number of symbols. 5 -- **ReadOnly**: `bool` — Makes the control a readonly field. -- **Single**: `bool` — Toggles single selection visual mode. false -- **Step**: `double` — The minimum value change allowed. Valid values are in the interval between 0 and 1 inclusive. 1 -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `double` — The current value of the component 0 -- **ValueChanged**: `EventCallback` -- **ValueFormat**: `string` — A format string which sets aria-valuetext. Instances of '{0}' will be replaced with the current value of the control and instances of '{1}' with the maximum value for the control. Important for screen-readers and useful for localization. -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task — Checks for validity of the control and emits the invalid event if it invalid. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): double -- **GetCurrentValueAsync**(): Task -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task — Checks for validity of the control and shows the browser message if it invalid. -- **ResolveDisplay**(): string -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task — Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid. -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **SetParametersAsync**(parameters: ParameterView): Task -- **StepDown**(n: double): void -- **StepDownAsync**(n: double): Task — Decrements the value of the control by n steps multiplied by the step factor. -- **StepUp**(n: double): void -- **StepUpAsync**(n: double): Task — Increments the value of the control by n steps multiplied by the step factor. - -### [IgbRatingModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRatingModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRatingSymbol](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRatingSymbol) -Used when a custom icon/symbol/element needs to be passed to the igc-rating component. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ConnectedCallback**(): void -- **ConnectedCallbackAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbRatingSymbolModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRatingSymbolModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRectChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRectChangedEventArgs) -Provides data for rectangle changed events. - -- **constructor**(): void -- **NewRect**: `Rect` — Gets the new rectangle. -- **OldRect**: `Rect` — Gets the rectangle before the change. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRefreshCompletedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRefreshCompletedEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRelativeStrengthIndexIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRelativeStrengthIndexIndicator) -Represents a IgbDataChart Relative Strength Index indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current RelativeStrengthIndexIndicator object. The typical, and initial, value for RSI periods is 14. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbRelativeStrengthIndexIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRelativeStrengthIndexIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRenderRequestedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRenderRequestedEventArgs) -EventArgs class for RenderRequested events. - -- **constructor**(): void -- **Animate**: `bool` — True if animation is requested. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbResponsivePhase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbResponsivePhase) -Describes one phase of a responsive state to apply to the grid. - -- **constructor**(): void -- **DelayMilliseconds**: `int` — The amount of time to delay the responsive phase from starting, in milliseconds -- **Type**: `string` -- **AddColumnExchanger**(exchanger: IgbColumnExchanger): IgbResponsivePhase -- **AddColumnExchangerAsync**(exchanger: IgbColumnExchanger): Task — Adds a column exchanger the the phase. -- **AddColumnPropertySetter**(setter: IgbColumnPropertySetter): IgbResponsivePhase -- **AddColumnPropertySetterAsync**(setter: IgbColumnPropertySetter): Task — Adds a column property setter to the phase. -- **ColumnExchanger**(): IgbResponsivePhase -- **ColumnExchangerAsync**(): Task — Adds a column exchanger to the phase and returns it. -- **ColumnPropertySetter**(): IgbColumnPropertySetter -- **ColumnPropertySetterAsync**(): Task — Adds a column property setter to the phase, and returns it. -- **FindByName**(name: string): object - -### [IgbResponsivePhasesCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbResponsivePhasesCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbResponsiveState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbResponsiveState) -Describes a state that the grid can enter based on a set of responsive conditions. - -- **constructor**(): void -- **IsManualState**: `bool` — Configures this responsive state to only be manually actived -- **MaximumWidth**: `double` — Gets or sets the maximum width for which this state is active. -- **MinimumWidth**: `double` — Gets or sets the minimum width for which this state is active. -- **StateEntered**: `EventCallback` -- **StateEnteredScript**: `string` -- **StateEntering**: `EventCallback` -- **StateEnteringScript**: `string` -- **StateExited**: `EventCallback` -- **StateExitedScript**: `string` -- **Type**: `string` -- **AddResponsivePhase**(phase: IgbResponsivePhase): IgbResponsiveState -- **AddResponsivePhaseAsync**(phase: IgbResponsivePhase): Task — Adds a responsive phase to the state. -- **FindByName**(name: string): object -- **ResponsivePhase**(): IgbResponsivePhase -- **ResponsivePhaseAsync**(): Task — Adds a responsive phase to the state and returns it. - -### [IgbResponsiveStateEnteredEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbResponsiveStateEnteredEventArgs) -Information about the entered action. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbResponsiveStateEnteringEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbResponsiveStateEnteringEventArgs) -Information about the entering action. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbResponsiveStateExitedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbResponsiveStateExitedEventArgs) -Information about the exited state. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbResponsiveStatesCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbResponsiveStatesCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbRing](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRing) -Represents data for Ring.RingControl element. - -- **constructor**(): void -- **Center**: `Point` — Gets the center point of the ring. -- **ControlSize**: `Size` — Gets the size of the ring. -- **Index**: `int` — Gets the index of ring in the chart. -- **InnerExtend**: `double` — Gets the inner extend of the ring in percentage. -- **RingBreadth**: `double` — Gets the ring breadth. -- **RingSeries**: `IgbRingSeriesBase` — Gets reference to ring series. -- **Type**: `string` -- **FindByName**(name: string): object -- **PrepareArcs**(): void -- **PrepareArcsAsync**(): Task — Prepares data needed to create Arcs. -- **RenderArcs**(): bool -- **RenderArcsAsync**(): Task — Renders the arcs. - -### [IgbRingSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRingSeries) -Represents one ring in IgbDoughnutChart series. - -- **constructor**(): void -- **Ring**: `IgbRing` — Gets reference to the ring data. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbRingSeriesBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRingSeriesBase) -Represents a IgbDoughnutChart base series. - -- **constructor**(): void -- **ActualLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ActualLegendLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ActualLegendOthersLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ActualOthersLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **Brushes**: `string` — Gets or sets the palette of brushes to use for coloring the slices. -- **ContentLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ContentLegendLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ContentLegendOthersLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ContentOthersLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **DataSource**: `object` — Gets or sets the data source for the chart. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DoughnutChartParent**: `BaseRendererControl` -- **FormatLabelScript**: `string` — Provides a means of setting FormatLabel in the JavaScript environment. -- **FormatLegendLabel**: `string` — Sets or gets a function which takes an object that produces a formatted label for displaying in the chart's legend. -- **FormatLegendLabelScript**: `string` — Provides a means of setting FormatLegendLabel in the JavaScript environment. -- **IsSurfaceInteractionDisabled**: `bool` — Gets or sets whether all surface interactions with the plot area should be disabled. -- **LabelExtent**: `double` — Gets or sets the pixel amount by which the labels are offset from the edge of the slices. -- **LabelFormat**: `string` — Gets or sets the label format string to use for the label. -- **LabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the LabelFormat string. -- **LabelInnerColor**: `string` — Gets or sets the color for labels rendered inside of the pie chart. -- **LabelMemberPath**: `string` — Gets or sets the property name that contains the labels. -- **LabelOuterColor**: `string` — Gets or sets the color for labels rendered outside of the pie chart. -- **LabelsPosition**: `LabelsPosition` — Gets or sets the position of chart labels. -- **LeaderLineFill**: `string` — Gets or sets the fill brush. -- **LeaderLineMargin**: `double` — Gets or sets the margin between a label and its leader line. The default is 6 pixels. -- **LeaderLineOpacity**: `double` — Gets or sets the opacity. -- **LeaderLineStroke**: `string` — Gets or sets the stroke brush. -- **LeaderLineStrokeThickness**: `double` — Gets or sets the stroke thickness. -- **LeaderLineType**: `LeaderLineType` — Gets or sets what type of leader lines will be used for the outside end labels. -- **LeaderLineVisibility**: `Visibility` — Gets or sets whether the leader lines are visible. -- **Legend**: `IgbLegendBase` — Gets or sets the legend used for the current chart. -- **LegendLabelFormat**: `string` — Gets or sets the label format string to use for the label. -- **LegendLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the LegendLabelFormat string. -- **LegendLabelMemberPath**: `string` — Gets or sets the property name that contains the legend labels. -- **LegendOthersLabelFormat**: `string` — Gets or sets the label format string to use for the label. -- **LegendOthersLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the LegendOthersLabelFormat string. -- **LegendScript**: `string` — Provides a means of setting Legend in the JavaScript environment. -- **OthersCategoryFill**: `string` — Gets or sets the fill brush. -- **OthersCategoryOpacity**: `double` — Gets or sets the opacity. -- **OthersCategoryStroke**: `string` — Gets or sets the stroke brush. -- **OthersCategoryStrokeThickness**: `double` — Gets or sets the stroke thickness. -- **OthersCategoryText**: `string` — Gets or sets the label of the Others slice. -- **OthersCategoryThreshold**: `double` — Gets or sets the threshold value that determines if slices are grouped into the Others slice. -- **OthersCategoryType**: `OthersCategoryType` — Gets or sets whether to use numeric or percent-based threshold value. -- **OthersLabelFormat**: `string` — Gets or sets the label format string to use for the label. -- **OthersLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the OthersLabelFormat string. -- **Outlines**: `string` — Gets or sets the palette of brushes to use for outlines on the slices. -- **ParentTypeName**: `string` -- **PropertyUpdated**: `EventCallback` -- **PropertyUpdatedScript**: `string` -- **RadiusFactor**: `double` — Gets or sets the scaling factor of the chart's radius. Value between 0 and 1. -- **SelectedSliceFill**: `string` — Gets or sets the fill brush. -- **SelectedSliceOpacity**: `double` — Gets or sets the opacity. -- **SelectedSliceStroke**: `string` — Gets or sets the stroke brush. -- **SelectedSliceStrokeThickness**: `double` — Gets or sets the stroke thickness. -- **StartAngle**: `double` — Gets or sets the starting angle of the chart. -- **TextStyle**: `string` — Gets or sets the text style to use for labels. -- **Type**: `string` -- **ValueMemberPath**: `string` — Gets or Sets the property name that contains the values. -- **Dispose**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task — Called by the UI framework to provide a UI container for rendering this control. - -### [IgbRingSeriesCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRingSeriesCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbRingSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRingSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRipple](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRipple) -A ripple can be applied to an element to represent interactive surface. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbRippleModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRippleModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRowDataCancelableEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowDataCancelableEventArgs) - -- **constructor**(): void -- **Detail**: `IgbRowDataCancelableEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowDataCancelableEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowDataCancelableEventArgsDetail) - -- **constructor**(): void -- **CellID**: `IgbGridCellIdentifier` -- **Data**: `object` -- **IsAddRow**: `bool` -- **NewValue**: `object` -- **OldValue**: `object` -- **Owner**: `IgbGridBaseDirective` -- **PrimaryKey**: `object` — Represents the unique key, the row can be associated with. Available if primaryKey exists -- **RowData**: `object` -- **RowKey**: `object` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowDataEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowDataEventArgs) -Represents event arguments related to events, that can occur for rows in a grid Example for events: adding, deleting, selection, transaction, etc. - -- **constructor**(): void -- **Detail**: `IgbRowDataEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowDataEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowDataEventArgsDetail) -Represents event arguments related to events, that can occur for rows in a grid Example for events: adding, deleting, selection, transaction, etc. - -- **constructor**(): void -- **Data**: `object` -- **PrimaryKey**: `object` — Represents the unique key, the row can be associated with. Available if primaryKey exists -- **RowData**: `object` -- **RowKey**: `object` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowDirective](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowDirective) - -- **constructor**(): void -- **Data**: `object` — The data passed to the row component. // get the row data for the first selected row let selectedRowData = this.grid.selectedRows[0].data; -- **Disabled**: `bool` — Sets whether this specific row has disabled functionality for editing and row selection. Default value is false. this.grid.selectedRows[0].pinned = true; -- **Expanded**: `bool` — Gets the expanded state of the row. let isExpanded = row.expanded; -- **Index**: `double` — The index of the row. // get the index of the second selected row let selectedRowIndex = this.grid.selectedRows[1].index; -- **Pinned**: `bool` — Sets whether the row is pinned. Default value is false. this.grid.selectedRows[0].pinned = true; -- **Type**: `string` -- **BeginAddRow**(): void -- **BeginAddRowAsync**(): Task — Spawns the add row UI for the specific row. const row = this.grid1.getRowByIndex(1); row.beginAddRow(); -- **Del**(): void -- **DelAsync**(): Task — Removes the specified row from the grid's data source. This method emits rowDeleted event. // delete the third selected row from the grid this.grid.selectedRows[2].delete(); -- **FindByName**(name: string): object -- **IsCellActive**(visibleColumnIndex: object): void -- **IsCellActiveAsync**(visibleColumnIndex: object): Task -- **Pin**(): void -- **PinAsync**(): Task — Pins the specified row. This method emits rowPinning`rowPinned` event. // pin the selected row from the grid this.grid.selectedRows[0].pin(); -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Unpin**(): void -- **UnpinAsync**(): Task — Unpins the specified row. This method emits rowPinning`rowPinned` event. // unpin the selected row from the grid this.grid.selectedRows[0].unpin(); -- **Update**(value: object): void -- **UpdateAsync**(value: object): Task — Updates the specified row object and the data source record with the passed value. // update the second selected row's value let newValue = "Apple"; this.grid.selectedRows[1].update(newValue); - -### [IgbRowDragEndEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowDragEndEventArgs) -Emitted when a dragging operation is finished (when the row is dropped) - -- **constructor**(): void -- **Detail**: `IgbRowDragEndEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowDragEndEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowDragEndEventArgsDetail) -Emitted when a dragging operation is finished (when the row is dropped) - -- **constructor**(): void -- **Animation**: `bool` — animation returns whether the event is animated -- **DragData**: `IgbRowType` — Represents the information of the row that is being dragged. -- **DragDirective**: `object` — Represents the drag directive or information associated with the drag operation -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowDragStartEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowDragStartEventArgs) -Emitted when a dragging operation is starting (when the row is "picked") The event is cancelable - -- **constructor**(): void -- **Detail**: `IgbRowDragStartEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowDragStartEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowDragStartEventArgsDetail) -Emitted when a dragging operation is starting (when the row is "picked") The event is cancelable - -- **constructor**(): void -- **Cancel**: `bool` — Provides the ability to cancel the event. -- **DragData**: `IgbRowType` — Represents the information of the row that is being dragged. -- **DragDirective**: `object` — Represents the drag directive or information associated with the drag operation -- **Owner**: `object` — Provides reference to the owner component. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowExportingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowExportingEventArgs) -rowExporting event arguments this.exporterService.rowExporting.subscribe((args: IRowExportingEventArgs) => { // set args properties here }) - -- **constructor**(): void -- **Detail**: `IgbRowExportingEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowExportingEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowExportingEventArgsDetail) -rowExporting event arguments this.exporterService.rowExporting.subscribe((args: IRowExportingEventArgs) => { // set args properties here }) - -- **constructor**(): void -- **Cancel**: `bool` — Skip the exporting row when set to true -- **RowData**: `object` — Contains the exporting row data -- **RowIndex**: `double` — Contains the exporting row index -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowIsland](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowIsland) -Row island IgxHierarchicalGridModule IgxHierarchicalGridComponent, IgxRowIslandComponent - -- **constructor**(): void -- **ActionStripComponents**: `IgbActionStripCollection` -- **ActiveNodeChange**: `EventCallback` -- **ActiveNodeChangeScript**: `string` -- **ActualActionStripComponents**: `IgbActionStripCollection` -- **ActualChildLayoutList**: `IgbRowIslandCollection` -- **ActualPaginationComponents**: `IgbPaginatorCollection` -- **ActualToolbar**: `IgbGridToolbarCollection` -- **AddRowEmptyTemplate**: `RenderFragment` -- **AddRowEmptyTemplateScript**: `string` — Provides a means of setting AddRowEmptyTemplate in the JavaScript environment. -- **AdvancedFilteringExpressionsTree**: `IgbFilteringExpressionsTree` — Gets/Sets the advanced filtering state. let advancedFilteringExpressionsTree = this.grid.advancedFilteringExpressionsTree; this.grid.advancedFilteringExpressionsTree = logic; -- **AdvancedFilteringExpressionsTreeChange**: `EventCallback` -- **AdvancedFilteringExpressionsTreeChangeScript**: `string` -- **AllowAdvancedFiltering**: `bool` -- **AllowFiltering**: `bool` -- **AutoGenerate**: `bool` -- **AutoGenerateExclude**: `string[]` -- **BatchEditing**: `bool` -- **CellClick**: `EventCallback` -- **CellClickScript**: `string` -- **CellEdit**: `EventCallback` -- **CellEditEnter**: `EventCallback` -- **CellEditEnterScript**: `string` -- **CellEditExit**: `EventCallback` -- **CellEditExitScript**: `string` -- **CellEditScript**: `string` -- **CellMergeMode**: `GridCellMergeMode` — Gets/Sets cell merge mode. -- **CellSelection**: `GridSelectionMode` — Gets/Sets cell selection mode. By default the cell selection mode is multiple selectionMode: GridSelectionMode -- **ChildDataKey**: `string` — Sets the key of the row island by which child data would be taken from the row data if such is provided. -- **ChildLayoutList**: `IgbRowIslandCollection` -- **ClipboardOptions**: `IgbClipboardOptions` — Controls the copy behavior of the grid. -- **ColumnInit**: `EventCallback` -- **ColumnInitScript**: `string` -- **ColumnList**: `IgbColumnCollection` -- **ColumnMoving**: `EventCallback` -- **ColumnMovingEnd**: `EventCallback` -- **ColumnMovingEndScript**: `string` -- **ColumnMovingScript**: `string` -- **ColumnMovingStart**: `EventCallback` -- **ColumnMovingStartScript**: `string` -- **ColumnPin**: `EventCallback` -- **ColumnPinScript**: `string` -- **ColumnPinned**: `EventCallback` -- **ColumnPinnedScript**: `string` -- **ColumnResized**: `EventCallback` -- **ColumnResizedScript**: `string` -- **ColumnSelection**: `GridSelectionMode` — Gets/Sets column selection mode By default the row selection mode is none selectionMode: GridSelectionMode -- **ColumnSelectionChanging**: `EventCallback` -- **ColumnSelectionChangingScript**: `string` -- **ColumnVisibilityChanged**: `EventCallback` -- **ColumnVisibilityChangedScript**: `string` -- **ColumnVisibilityChanging**: `EventCallback` -- **ColumnVisibilityChangingScript**: `string` -- **ColumnWidth**: `string` -- **ColumnsAutogenerated**: `EventCallback` -- **ColumnsAutogeneratedScript**: `string` -- **ContentActionStripComponents**: `IgbActionStripCollection` -- **ContentChildLayoutList**: `IgbRowIslandCollection` -- **ContentPaginationComponents**: `IgbPaginatorCollection` -- **ContentToolbar**: `IgbGridToolbarCollection` -- **ContextMenu**: `EventCallback` -- **ContextMenuScript**: `string` -- **DataChanged**: `EventCallback` -- **DataChangedScript**: `string` -- **DataChanging**: `EventCallback` -- **DataChangingScript**: `string` -- **DataCloneStrategy**: `IgbDataCloneStrategy` -- **DataPreLoad**: `EventCallback` -- **DataPreLoadScript**: `string` -- **DoubleClick**: `EventCallback` -- **DoubleClickScript**: `string` -- **DragGhostCustomTemplate**: `RenderFragment` — Gets the custom template, if any, used for row drag ghost. -- **DragGhostCustomTemplateScript**: `string` — Provides a means of setting DragGhostCustomTemplate in the JavaScript environment. -- **DragIndicatorIconTemplate**: `RenderFragment` — The custom template, if any, that should be used when rendering the row drag indicator icon -- **DragIndicatorIconTemplateScript**: `string` — Provides a means of setting DragIndicatorIconTemplate in the JavaScript environment. -- **EmptyFilteredGridMessage**: `string` -- **EmptyGridMessage**: `string` -- **EmptyGridTemplate**: `RenderFragment` -- **EmptyGridTemplateScript**: `string` — Provides a means of setting EmptyGridTemplate in the JavaScript environment. -- **ExcelStyleHeaderIconTemplate**: `RenderFragment` — Gets the excel style header icon. -- **ExcelStyleHeaderIconTemplateScript**: `string` — Provides a means of setting ExcelStyleHeaderIconTemplate in the JavaScript environment. -- **ExpandChildren**: `bool` -- **FilterMode**: `FilterMode` -- **FilterStrategy**: `IgbFilteringStrategy` -- **Filtering**: `EventCallback` -- **FilteringDone**: `EventCallback` -- **FilteringDoneScript**: `string` -- **FilteringExpressionsTree**: `IgbFilteringExpressionsTree` -- **FilteringExpressionsTreeChange**: `EventCallback` -- **FilteringExpressionsTreeChangeScript**: `string` -- **FilteringLogic**: `FilteringLogic` -- **FilteringScript**: `string` -- **FormGroupCreated**: `EventCallback` -- **FormGroupCreatedScript**: `string` -- **GridCopy**: `EventCallback` -- **GridCopyScript**: `string` -- **GridCreated**: `EventCallback` -- **GridCreatedScript**: `string` -- **GridInitialized**: `EventCallback` -- **GridInitializedScript**: `string` -- **GridKeydown**: `EventCallback` -- **GridKeydownScript**: `string` -- **GridScroll**: `EventCallback` -- **GridScrollScript**: `string` -- **HasChildrenKey**: `string` -- **HeadSelectorTemplate**: `RenderFragment` — Gets the header row selector template. -- **HeadSelectorTemplateScript**: `string` — Provides a means of setting HeadSelectorTemplate in the JavaScript environment. -- **HeaderCollapsedIndicatorTemplate**: `RenderFragment` — Gets the row collapse indicator template. -- **HeaderCollapsedIndicatorTemplateScript**: `string` — Provides a means of setting HeaderCollapsedIndicatorTemplate in the JavaScript environment. -- **HeaderExpandedIndicatorTemplate**: `RenderFragment` — Gets the header expand indicator template. -- **HeaderExpandedIndicatorTemplateScript**: `string` — Provides a means of setting HeaderExpandedIndicatorTemplate in the JavaScript environment. -- **Height**: `string` -- **HideRowSelectors**: `bool` — Gets/Sets if the row selectors are hidden. By default row selectors are shown -- **HierarchicalGridParent**: `BaseRendererControl` -- **IsLoading**: `bool` -- **LoadingGridTemplate**: `RenderFragment` -- **LoadingGridTemplateScript**: `string` — Provides a means of setting LoadingGridTemplate in the JavaScript environment. -- **Locale**: `string` — Gets/Sets the locale. If not set, returns browser's language. -- **Moving**: `bool` — Controls whether columns moving is enabled in the grid. -- **PaginationComponents**: `IgbPaginatorCollection` -- **PagingMode**: `GridPagingMode` -- **ParentTypeName**: `string` -- **Pinning**: `IgbPinningConfig` -- **PrimaryKey**: `string` -- **RangeSelected**: `EventCallback` -- **RangeSelectedScript**: `string` -- **Rendered**: `EventCallback` -- **RenderedScript**: `string` -- **ResourceStrings**: `IgbGridResourceStrings` — Gets/Sets the resource strings. By default it uses the root grid resources. -- **RowAdd**: `EventCallback` -- **RowAddScript**: `string` -- **RowAddTextTemplate**: `RenderFragment` — Gets the row add text template. -- **RowAddTextTemplateScript**: `string` — Provides a means of setting RowAddTextTemplate in the JavaScript environment. -- **RowClasses**: `object` -- **RowClassesScript**: `string` — Provides a means of setting RowClasses in the JavaScript environment. -- **RowClick**: `EventCallback` -- **RowClickScript**: `string` -- **RowCollapsedIndicatorTemplate**: `RenderFragment` — Gets the row collapse indicator template. -- **RowCollapsedIndicatorTemplateScript**: `string` — Provides a means of setting RowCollapsedIndicatorTemplate in the JavaScript environment. -- **RowDelete**: `EventCallback` -- **RowDeleteScript**: `string` -- **RowDragEnd**: `EventCallback` -- **RowDragEndScript**: `string` -- **RowDragStart**: `EventCallback` -- **RowDragStartScript**: `string` -- **RowDraggable**: `bool` -- **RowEdit**: `EventCallback` -- **RowEditActionsTemplate**: `RenderFragment` — Gets the row edit actions template. -- **RowEditActionsTemplateScript**: `string` — Provides a means of setting RowEditActionsTemplate in the JavaScript environment. -- **RowEditDone**: `EventCallback` -- **RowEditDoneScript**: `string` -- **RowEditEnter**: `EventCallback` -- **RowEditEnterScript**: `string` -- **RowEditExit**: `EventCallback` -- **RowEditExitScript**: `string` -- **RowEditScript**: `string` -- **RowEditTextTemplate**: `RenderFragment` — Gets the row edit text template. -- **RowEditTextTemplateScript**: `string` — Provides a means of setting RowEditTextTemplate in the JavaScript environment. -- **RowEditable**: `bool` -- **RowExpandedIndicatorTemplate**: `RenderFragment` — Gets the row expand indicator template. -- **RowExpandedIndicatorTemplateScript**: `string` — Provides a means of setting RowExpandedIndicatorTemplate in the JavaScript environment. -- **RowHeight**: `double` -- **RowIslandParent**: `BaseRendererElement` -- **RowPinned**: `EventCallback` -- **RowPinnedScript**: `string` -- **RowPinning**: `EventCallback` -- **RowPinningScript**: `string` -- **RowSelection**: `GridSelectionMode` — Gets/Sets row selection mode By default the row selection mode is 'none' Note that in IgxGrid and IgxHierarchicalGrid 'multipleCascade' behaves like 'multiple' -- **RowSelectionChanging**: `EventCallback` -- **RowSelectionChangingScript**: `string` -- **RowSelectorTemplate**: `RenderFragment` — Gets the row selector template. -- **RowSelectorTemplateScript**: `string` — Provides a means of setting RowSelectorTemplate in the JavaScript environment. -- **RowStyles**: `object` -- **RowStylesScript**: `string` — Provides a means of setting RowStyles in the JavaScript environment. -- **RowToggle**: `EventCallback` -- **RowToggleScript**: `string` -- **SelectRowOnClick**: `bool` — Gets/Sets whether clicking over a row should select/deselect it By default it is set to true enabled: boolean -- **Selected**: `EventCallback` -- **SelectedRows**: `object[]` -- **SelectedRowsChange**: `EventCallback` -- **SelectedRowsChangeScript**: `string` -- **SelectedRowsChanged**: `EventCallback` -- **SelectedScript**: `string` -- **ShouldGenerate**: `bool` — Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid -- **ShowExpandAll**: `bool` -- **ShowSummaryOnCollapse**: `bool` -- **SnackbarDisplayTime**: `double` — Gets/Sets the display time for the row adding snackbar notification. By default it is 6000ms. -- **SortAscendingHeaderIconTemplate**: `RenderFragment` — The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in asc order. -- **SortAscendingHeaderIconTemplateScript**: `string` — Provides a means of setting SortAscendingHeaderIconTemplate in the JavaScript environment. -- **SortDescendingHeaderIconTemplate**: `RenderFragment` — The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in desc order. -- **SortDescendingHeaderIconTemplateScript**: `string` — Provides a means of setting SortDescendingHeaderIconTemplate in the JavaScript environment. -- **SortHeaderIconTemplate**: `RenderFragment` — Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted. -- **SortHeaderIconTemplateScript**: `string` — Provides a means of setting SortHeaderIconTemplate in the JavaScript environment. -- **SortStrategy**: `IgbGridSortingStrategy` -- **Sorting**: `EventCallback` -- **SortingDone**: `EventCallback` -- **SortingDoneScript**: `string` -- **SortingExpressions**: `IgbSortingExpression[]` -- **SortingExpressionsChange**: `EventCallback` -- **SortingExpressionsChangeScript**: `string` -- **SortingOptions**: `IgbSortingOptions` -- **SortingScript**: `string` -- **SummaryCalculationMode**: `GridSummaryCalculationMode` -- **SummaryPosition**: `GridSummaryPosition` -- **SummaryRowHeight**: `double` — Get/Set IgxSummaryRow height -- **Toolbar**: `IgbGridToolbarCollection` -- **ToolbarExporting**: `EventCallback` -- **ToolbarExportingScript**: `string` -- **TotalRecords**: `double` — Returns the total number of records. Only functions when paging is enabled. const totalRecords = this.grid.totalRecords; -- **Type**: `string` -- **ValidationStatusChange**: `EventCallback` -- **ValidationStatusChangeScript**: `string` -- **ValidationTrigger**: `GridValidationTrigger` -- **Width**: `string` — Gets/Sets the width of the grid. let gridWidth = this.grid.width; -- **BeginAddRowById**(rowID: object, asChild: bool): void -- **BeginAddRowByIdAsync**(rowID: object, asChild: bool): Task -- **ClearCellSelection**(): void -- **ClearCellSelectionAsync**(): Task — Deselect selected cells. this.grid.clearCellSelection(); -- **ClearFilter**(name: string): void -- **ClearFilterAsync**(name: string): Task — If name is provided, clears the filtering state of the corresponding IgxColumnComponent. Otherwise clears the filtering state of all IgxColumnComponents. this.grid.clearFilter(); name -- **ClearSearch**(): void -- **ClearSearchAsync**(): Task — Removes all the highlights in the cell. this.grid.clearSearch(); -- **ClearSort**(name: string): void -- **ClearSortAsync**(name: string): Task — If name is provided, clears the sorting state of the corresponding IgxColumnComponent. otherwise clears the sorting state of all IgxColumnComponent. this.grid.clearSort(); name -- **CloseAdvancedFilteringDialog**(applyChanges: bool): void -- **CloseAdvancedFilteringDialogAsync**(applyChanges: bool): Task — Closes the advanced filtering dialog. applyChanges indicates whether the changes should be applied -- **CollapseAll**(): void -- **CollapseAllAsync**(): Task — Collapses all rows. this.grid.collapseAll(); -- **CollapseRow**(rowID: object): void -- **CollapseRowAsync**(rowID: object): Task — Collapses the row by its id. ID is either the primaryKey value or the data record instance. this.grid.collapseRow(rowID); rowID The row id - primaryKey value or the data record instance. -- **DeselectAllColumns**(): void -- **DeselectAllColumnsAsync**(): Task — Deselects all columns this.grid.deselectAllColumns(); -- **DeselectAllRows**(onlyFilterData: bool): void -- **DeselectAllRowsAsync**(onlyFilterData: bool): Task — Deselects all rows By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows. If you set the parameter onlyFilterData to false that will deselect all rows in the grid exept deleted rows. this.grid.deselectAllRows(); onlyFilterData -- **DeselectColumns**(columns: string[]): void -- **DeselectColumnsAsync**(columns: string[]): Task -- **DeselectRows**(rowIDs: object[]): void -- **DeselectRowsAsync**(rowIDs: object[]): Task -- **DisableSummaries**(rest: object[]): void -- **DisableSummariesAsync**(rest: object[]): Task -- **Dispose**(): void -- **EnableSummaries**(rest: object[]): void -- **EnableSummariesAsync**(rest: object[]): Task -- **EnsureModulesLoaded**(): void -- **ExpandAll**(): void -- **ExpandAllAsync**(): Task — Expands all rows. this.grid.expandAll(); -- **ExpandRow**(rowID: object): void -- **ExpandRowAsync**(rowID: object): Task — Expands the row by its id. ID is either the primaryKey value or the data record instance. this.grid.expandRow(rowID); rowID The row id - primaryKey value or the data record instance. -- **Filter**(name: string, value: object, conditionOrExpressionTree: IgbFilteringExpressionsTreeOrFilteringOperation, ignoreCase: bool): void -- **FilterAsync**(name: string, value: object, conditionOrExpressionTree: IgbFilteringExpressionsTreeOrFilteringOperation, ignoreCase: bool): Task -- **FilterGlobal**(value: object, condition: object, ignoreCase: object): void -- **FilterGlobalAsync**(value: object, condition: object, ignoreCase: object): Task -- **FindByName**(name: string): object -- **FindNext**(text: string, caseSensitive: bool, exactMatch: bool): double -- **FindNextAsync**(text: string, caseSensitive: bool, exactMatch: bool): Task -- **FindPrev**(text: string, caseSensitive: bool, exactMatch: bool): double -- **FindPrevAsync**(text: string, caseSensitive: bool, exactMatch: bool): Task -- **GetColumnByName**(name: string): IgbColumn -- **GetColumnByNameAsync**(name: string): Task — Returns the IgxColumnComponent by field name. const myCol = this.grid1.getColumnByName("ID"); name -- **GetColumnByVisibleIndex**(index: double): IgbColumn -- **GetColumnByVisibleIndexAsync**(index: double): Task -- **GetColumns**(): IgbColumn[] -- **GetColumnsAsync**(): Task -- **GetCurrentSelectedRows**(): object[] -- **GetCurrentSelectedRowsAsync**(): Task -- **GetDefaultRowHeight**(): double -- **GetDefaultRowHeightAsync**(): Task -- **GetHeaderGroupWidth**(column: IgbColumn): string -- **GetHeaderGroupWidthAsync**(column: IgbColumn): Task — Gets the width to be set on IgxGridHeaderGroupComponent. -- **GetNextCell**(currRowIndex: double, curVisibleColIndex: double, callback: object): IgbCellPosition -- **GetNextCellAsync**(currRowIndex: double, curVisibleColIndex: double, callback: object): Task -- **GetPinnedEndWidth**(takeHidden: bool): void -- **GetPinnedEndWidthAsync**(takeHidden: bool): Task — Gets calculated width of the pinned areas. const pinnedWidth = this.grid.getPinnedEndWidth(); takeHidden If we should take into account the hidden columns in the pinned area. -- **GetPinnedStartWidth**(takeHidden: bool): void -- **GetPinnedStartWidthAsync**(takeHidden: bool): Task — Gets calculated width of the pinned areas. const pinnedWidth = this.grid.getPinnedStartWidth(); takeHidden If we should take into account the hidden columns in the pinned area. -- **GetPreviousCell**(currRowIndex: double, curVisibleColIndex: double, callback: object): IgbCellPosition -- **GetPreviousCellAsync**(currRowIndex: double, curVisibleColIndex: double, callback: object): Task -- **GetRowData**(rowSelector: object): object -- **GetRowDataAsync**(rowSelector: object): Task — Returns the data that is contained in the row component. If the primary key is not specified the row selector match the row data. const data = grid.getRowData(94741); rowSelector correspond to rowID -- **GetSelectedColumnsData**(formatters: bool, headers: bool): void -- **GetSelectedColumnsDataAsync**(formatters: bool, headers: bool): Task -- **GetSelectedData**(formatters: bool, headers: bool): void -- **GetSelectedDataAsync**(formatters: bool, headers: bool): Task -- **GetSelectedRanges**(): IgbGridSelectionRange[] -- **GetSelectedRangesAsync**(): Task — Get the currently selected ranges in the grid. -- **IsRecordPinnedByIndex**(rowIndex: double): void -- **IsRecordPinnedByIndexAsync**(rowIndex: double): Task — Returns whether the record is pinned or not. rowIndex Index of the record in the filteredSortedData collection. -- **MarkForCheck**(): void -- **MarkForCheckAsync**(): Task — Triggers change detection for the IgxGridComponent. Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed. May degrade performance if used when not needed, or if misused: // DON'Ts: // don't call markForCheck from inside a loop // don't call markForCheck when a primitive has changed grid.data.forEach(rec => { rec = newValue; grid.markForCheck(); }); // DOs // call markForCheck after updating a nested property grid.data.forEach(rec => { rec.nestedProp1.nestedProp2 = newValue; }); grid.markForCheck(); grid.markForCheck(); -- **MoveColumn**(column: IgbColumn, target: IgbColumn, pos: DropPosition?): void -- **MoveColumnAsync**(column: IgbColumn, target: IgbColumn, pos: DropPosition?): Task -- **NavigateTo**(rowIndex: double, visibleColIndex: double, cb: object): void -- **NavigateToAsync**(rowIndex: double, visibleColIndex: double, cb: object): Task -- **OnInitializedAsync**(): Task -- **OpenAdvancedFilteringDialog**(overlaySettings: IgbOverlaySettings): void -- **OpenAdvancedFilteringDialogAsync**(overlaySettings: IgbOverlaySettings): Task — Opens the advanced filtering dialog. -- **PinColumn**(columnName: string, index: double, pinningPosition: ColumnPinningPosition?): bool -- **PinColumnAsync**(columnName: string, index: double, pinningPosition: ColumnPinningPosition?): Task -- **RecalculateAutoSizes**(): void -- **RecalculateAutoSizesAsync**(): Task — Recalculates all widths of columns that have size set to auto. this.grid1.recalculateAutoSizes(); -- **RefreshSearch**(updateActiveInfo: bool, endEdit: bool): double -- **RefreshSearchAsync**(updateActiveInfo: bool, endEdit: bool): Task -- **SelectAllColumns**(): void -- **SelectAllColumnsAsync**(): Task — Selects all columns this.grid.deselectAllColumns(); -- **SelectAllRows**(onlyFilterData: bool): void -- **SelectAllRowsAsync**(onlyFilterData: bool): Task — Selects all rows By default if filtering is in place, selectAllRows() and deselectAllRows() select/deselect all filtered rows. If you set the parameter onlyFilterData to false that will select all rows in the grid exept deleted rows. this.grid.selectAllRows(); this.grid.selectAllRows(false); onlyFilterData -- **SelectColumns**(columns: string[], clearCurrentSelection: bool): void -- **SelectColumnsAsync**(columns: string[], clearCurrentSelection: bool): Task -- **SelectRange**(arg: IgbGridSelectionRange[]): void -- **SelectRangeAsync**(arg: IgbGridSelectionRange[]): Task -- **SelectRows**(rowIDs: object[], clearCurrentSelection: bool): void -- **SelectRowsAsync**(rowIDs: object[], clearCurrentSelection: bool): Task -- **SelectedColumns**(): IgbColumn[] -- **SelectedColumnsAsync**(): Task — Get current selected columns. Returns an array with selected columns const selectedColumns = this.grid.selectedColumns(); -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Sort**(expression: IgbSortingExpression[]): void -- **SortAsync**(expression: IgbSortingExpression[]): Task -- **ToggleColumnVisibility**(args: IgbColumnVisibilityChangedEventArgs): void -- **ToggleColumnVisibilityAsync**(args: IgbColumnVisibilityChangedEventArgs): Task — Toggles the specified column's visibility. this.grid1.toggleColumnVisibility({ column: this.grid1.columns[0], newValue: true }); -- **ToggleRow**(rowID: object): void -- **ToggleRowAsync**(rowID: object): Task — Toggles the row by its id. ID is either the primaryKey value or the data record instance. this.grid.toggleRow(rowID); rowID The row id - primaryKey value or the data record instance. -- **UnpinColumn**(columnName: string, index: double): bool -- **UnpinColumnAsync**(columnName: string, index: double): Task - -### [IgbRowIslandCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowIslandCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbRowIslandModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowIslandModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRowSelectionEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowSelectionEventArgs) -The event arguments when the selection state of a row is being changed The event is cancelable - -- **constructor**(): void -- **Detail**: `IgbRowSelectionEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowSelectionEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowSelectionEventArgsDetail) -The event arguments when the selection state of a row is being changed The event is cancelable - -- **constructor**(): void -- **Added**: `object[]` — Represents an array of all added rows Whenever a row has been selected, the array is "refreshed" with the selected rows -- **AddedScript**: `string` — Provides a means of setting Added in the JavaScript environment. -- **AllRowsSelected**: `bool` — Indicates whether or not all rows of the grid have been selected -- **Cancel**: `bool` — Provides the ability to cancel the event. -- **NewSelection**: `object[]` — Represents the newly selected rows -- **NewSelectionScript**: `string` — Provides a means of setting NewSelection in the JavaScript environment. -- **OldSelection**: `object[]` — Represents an array of rows, that have already been selected -- **OldSelectionScript**: `string` — Provides a means of setting OldSelection in the JavaScript environment. -- **Owner**: `object` — Provides reference to the owner component. -- **Removed**: `object[]` — Represents an array of all rows, removed from the selection Whenever a row has been deselected, the array is "refreshed" with the rows, that have been previously selected, but are no longer -- **RemovedScript**: `string` — Provides a means of setting Removed in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowSelectorTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowSelectorTemplateContext) - -- **constructor**(): void -- **Implicit**: `IgbRowSelectorTemplateDetails` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowSelectorTemplateDetails](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowSelectorTemplateDetails) - -- **constructor**(): void -- **Index**: `double` -- **Key**: `object` -- **RowID**: `object` -- **Selected**: `bool` -- **Type**: `string` -- **Deselect**(): void -- **DeselectAsync**(): Task -- **FindByName**(name: string): object -- **Select**(): void -- **SelectAsync**(): Task -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbRowSeparator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowSeparator) -Represents a Row separator, this is used to visually separate the rows in a grid - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbRowSeparatorInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowSeparatorInfo) -Represents backing information for the row separators. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowSeparatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowSeparatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbRowToggleEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowToggleEventArgs) -Represents event arguments related to the row's expansion state being changed in a grid - -- **constructor**(): void -- **Detail**: `IgbRowToggleEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowToggleEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowToggleEventArgsDetail) -Represents event arguments related to the row's expansion state being changed in a grid - -- **constructor**(): void -- **Cancel**: `bool` — The event is cancelable cancel returns whether the event has been intercepted and stopped If the value becomes "true", it returns/exits from the method, instantiating the interface -- **Expanded**: `bool` — Returns the state of the row after the operation has ended Indicating whether the row is being expanded (true) or collapsed (false) -- **RowID**: `object` — Represents the ID of the row that emitted the event (which state is changed) -- **RowKey**: `object` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbRowType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbRowType) -Interface representing a row in the grid. It is essentially the blueprint to a row object. Contains definitions of properties and methods, relevant to a row - -- **constructor**(): void -- **AddRowUI**: `bool` -- **Cells**: `IgbCellType[]` — Optional A list or an array of cells, that belong to the row -- **Children**: `IgbRowType[]` — Optional Contains the child rows of the current row, if there are any. -- **Data**: `object` -- **Deleted**: `bool` — Optional Indicates whether the row is marked for deletion. -- **Disabled**: `bool` — Optional Indicates whether the current row is disabled -- **EphemeralKey**: `string` -- **Expanded**: `bool` — Optional Indicates whether the current row is expanded. The value is true, if the row is expanded and false, if it is collapsed -- **Focused**: `bool` — Optional Indicates whether the row is currently focused. -- **Grid**: `IgbGridBaseDirective` — Represent the grid instance, the row belongs to -- **GroupRow**: `IgbGroupByRecord` -- **HasChildren**: `bool` — Optional Indicates whether the current row has any child rows -- **InEditMode**: `bool` — Optional Indicates whether the row is currently being edited. -- **Index**: `double` — The index of the row within the grid -- **IsGroupByRow**: `bool` — Indicates whether the row is grouped. -- **IsSummaryRow**: `bool` -- **Key**: `object` -- **MethodTarget**: `string` -- **Pinned**: `bool` — Optional Indicates whether the current row is pinned. -- **RowParent**: `IgbRowType` — Optional Contains the parent row of the current row, if it has one. If the parent row exist, it means that the current row is a child row -- **Selected**: `bool` — Optional Indicates whether the current row is selected -- **TreeRow**: `IgbTreeGridRecord` — Optional Represents the hierarchical record associated with the row (for tree grids). It is of type ITreeGridRecord, which contains the data, children, the hierarchical level, etc. -- **Type**: `string` -- **Validation**: `IgbGridValidationState` -- **ViewIndex**: `double` -- **Del**(): object -- **DelAsync**(): Task — Optional A method to handle deleting rows -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **Pin**(): void -- **PinAsync**(): Task — Optional A method to handle pinning a row -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void -- **Unpin**(): void -- **UnpinAsync**(): Task — Optional A method to handle unpinning a row, that has been pinned -- **Update**(value: object): void -- **UpdateAsync**(value: object): Task — Optional A method to handle changing the value of elements of the row It takes the new value as an argument - -### [IgbScaleLegend](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScaleLegend) -Represents a legend that indicates the size and the color scale for a collection of series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbScaleLegendModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScaleLegendModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbScalerParams](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScalerParams) -Class containing several properties which are used as parameters passed to scaling operations in a SeriesViewer. - -- **constructor**(): void -- **ReferenceValue**: `double` — The series reference value. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbScatterAreaSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterAreaSeries) -Series class which draws a colored 2D surface based on a triangulation of XY data with numeric values assigned to each point. - -- **constructor**(): void -- **ActualColorScale**: `IgbColorScale` — Gets actual color scale that is set on ColorScale property or default ColorScale -- **ColorMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series color value in the Data Legend. -- **ColorMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series color value in the Data Legend. -- **ColorMemberPath**: `string` — Gets or sets the name of the property on each data item containing a numeric value which can be converted to a color by the ColorScale. -- **ColorScale**: `IgbColorScale` — Gets or sets ColorScale used to resolve the color values of points in the series. -- **Type**: `string` -- **AttachImage**(image: object): void -- **AttachImageAsync**(image: object): Task — Attaches an image to the view of this series -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **UpdateActualColorScale**(): void -- **UpdateActualColorScaleAsync**(): Task — Updates ActualColorScale properties when the ColorScale property has changed - -### [IgbScatterAreaSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterAreaSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbScatterBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterBase) -Represents the base class for all IgbDataChart scatter series - -- **constructor**(): void -- **ActualItemSearchMode**: `ScatterItemSearchMode` -- **ActualTrendLineBrush**: `string` — Gets the effective TrendLineBrush for this series. -- **AssigningScatterMarkerStyle**: `Action` -- **AssigningScatterMarkerStyleScript**: `string` -- **AssigningScatterStyle**: `Action` -- **AssigningScatterStyleScript**: `string` -- **HighlightedXMemberPath**: `string` — Gets or sets the highlighted X value mapping property for the current series object. -- **HighlightedYMemberPath**: `string` — Gets or sets the highlighted Y value mapping property for the current series object. -- **IsCustomScatterMarkerStyleAllowed**: `bool` — Gets or sets whether this Scatter series should allow custom style overrides of its individual marker visuals. -- **IsCustomScatterStyleAllowed**: `bool` — Gets or sets whether this Scatter series should allow custom style overrides of its individual visuals. -- **ItemSearchMode**: `ScatterItemSearchMode` — Gets or sets the mode the series will use to find the closest point to the cursor. -- **ItemSearchThreshold**: `int` — Gets or sets the threshold to use when searching for items using ItemSearchMode. -- **MarkerCollisionAvoidance**: `CollisionAvoidanceType` — The desired behavior for markers in this series which are placed too close together for the current view, resulting in a collision. -- **MaximumMarkers**: `int` — Gets or sets the maximum number of markerItems displayed by the current series. If more than the specified number of markerItems are visible, the series will automatically choose a representative set. -- **TrendLineBrush**: `string` — Gets or sets the brush to use to draw the trend line. -- **TrendLineDashArray**: `double[]` — Gets or sets a collection of double values that indicate the pattern of dashes and gaps that is used to draw the trend line for the current scatter series object. -- **TrendLinePeriod**: `int` — Gets or sets the moving average period for the current scatter series object. -- **TrendLineThickness**: `double` — Gets or sets the thickness of the current scatter series object's trend line. -- **TrendLineType**: `TrendLineType` — Gets or sets the trend type for the current scatter series. -- **TrendLineZIndex**: `int` — Gets or sets the Z-Index of the trend line. Values greater than 1000 will result in the trend line being rendered in front of the series data. -- **Type**: `string` -- **XAxis**: `IgbNumericXAxis` — Gets or sets the effective x-axis for the current object. -- **XAxisName**: `string` — Gets or sets the name to use to resolve xAxis from markup. -- **XAxisScript**: `string` — Provides a means of setting XAxis in the JavaScript environment. -- **XMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series X value in the Data Legend. -- **XMemberAsLegendUnit**: `string` — Gets or sets the unit after displayed after series X value in the Data Legend. -- **XMemberPath**: `string` — Gets or sets the value mapping property for the current series object. -- **YAxis**: `IgbNumericYAxis` — Gets or sets the effective y-axis for the current object. -- **YAxisName**: `string` — Gets or sets the name to use to resolve yAxis from markup. -- **YAxisScript**: `string` — Provides a means of setting YAxis in the JavaScript environment. -- **YMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series Y value in the Data Legend. -- **YMemberAsLegendUnit**: `string` — Gets or sets the unit after displayed after series Y value in the Data Legend. -- **YMemberPath**: `string` — Gets or sets the value mapping property for the current series object. -- **BindAxes**(Axes: IgbAxis[]): void -- **CanUseAsXAxis**(axis: object): bool -- **CanUseAsXAxisAsync**(axis: object): Task — Determine if object can be used as XAxis -- **CanUseAsYAxis**(axis: object): bool -- **CanUseAsYAxisAsync**(axis: object): Task — Determine if object can be used as YAxis -- **FindByName**(name: string): object -- **GetExactItemIndex**(world: Point): double -- **GetExactItemIndexAsync**(world: Point): Task — Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex. -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemIndex**(world: Point): int -- **GetItemIndexAsync**(world: Point): Task — Gets the index of the item that resides at the provided world coordinates. -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **GetSeriesValueMarkerBoundingBox**(world: Point): Rect -- **GetSeriesValueMarkerBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided. -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValueType**(mode: ValueLayerValueMode): double[] -- **GetSeriesValueTypeAsync**(mode: ValueLayerValueMode): Task — Gets the numeric values from the X and Y axis associated with this scatter series that matches the desired value mode. -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the series to display the item for the specified data item. - -### [IgbScatterContourSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterContourSeries) -Series class for rendering isarithmic contours based on a triangulation of X+Y+Value points in the ItemsSource. - -- **constructor**(): void -- **ActualFillScale**: `IgbValueBrushScale` — Gets actual fill scale that is set on the FillScale property or default FillScale -- **FillScale**: `IgbValueBrushScale` — Gets or sets the ValueBrushScale to use when determining Brushes for each contour line, based on the values found in ValueMemberPath. -- **Type**: `string` -- **ValueMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series value in the Data Legend. -- **ValueMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series value in the Data Legend. -- **ValueMemberPath**: `string` — Gets or set the name of the property from which to retrieve the numeric values from the ItemsSource items. -- **ValueResolver**: `IgbContourValueResolver` — Gets or set the ContourValueResolver used to determine the numeric values of contours. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. - -### [IgbScatterContourSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterContourSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbScatterLineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterLineSeries) -Represents a IgbDataChart scatter line series - -- **constructor**(): void -- **Type**: `string` -- **UnknownValuePlotting**: `UnknownValuePlotting` — Determines how unknown values will be plotted on the chart. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbScatterLineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterLineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbScatterPolygonSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterPolygonSeries) -Series class which renders polygons as Paths based on lists of points in the ItemsSource. - -- **constructor**(): void -- **ActualMarkerBrush**: `string` — Gets the effective marker brush for the current series object. -- **ActualMarkerOutline**: `string` — Gets the effective marker outline for the current series object. -- **ActualMarkerTemplate**: `object` — Gets the effective marker template for the current series object. -- **ActualMarkerTemplateScript**: `string` — Provides a means of setting ActualMarkerTemplate in the JavaScript environment. -- **MarkerBrush**: `string` — Gets or sets the brush that specifies how the current series object's marker interiors are painted. -- **MarkerCollisionAvoidance**: `CollisionAvoidanceType` — The desired behavior for markers in this series which are placed too close together for the current view, resulting in a collision. -- **MarkerFillMode**: `MarkerFillMode` — Gets or sets whether the marker fill is based on the marker outline of the series rather than the marker brushes collection. -- **MarkerOutline**: `string` — Gets or sets the brush that specifies how the current series object's marker outlines are painted. -- **MarkerOutlineMode**: `MarkerOutlineMode` — Gets or sets whether the marker outline is based on the marker brush of the series rather than the marker outlines collection. -- **MarkerTemplate**: `object` — Gets or sets the MarkerTemplate for the current series object. -- **MarkerTemplateScript**: `string` — Provides a means of setting MarkerTemplate in the JavaScript environment. -- **MarkerThickness**: `double` — Gets or sets thickness of the marker outline -- **MarkerType**: `MarkerType` — Gets or sets the marker type for the current series object. -- **ShapeStyle**: `IgbStyle` — The default style to apply to all Shapes in the series. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetSeriesValueMarkerBoundingBox**(world: Point): Rect -- **GetSeriesValueMarkerBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided. - -### [IgbScatterPolygonSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterPolygonSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbScatterPolylineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterPolylineSeries) -Series class used for displaying multiple polylines for datasources which contain multiple lists of points. - -- **constructor**(): void -- **ShapeStyle**: `IgbStyle` — The default style to apply to all Shapes in the series. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbScatterPolylineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterPolylineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbScatterSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterSeries) -Represents a IgbDataChart scatter series - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbScatterSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbScatterSplineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterSplineSeries) -Represents a IgbDataChart scatter spline series - -- **constructor**(): void -- **Stiffness**: `double` — Gets or sets the Stiffness property. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbScatterSplineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterSplineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbScatterTriangulationSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScatterTriangulationSeries) -Base class for series which triangulate XY data prior to rendering. - -- **constructor**(): void -- **TriangleVertexMemberPath1**: `string` — The name of the property of the TrianglesSource items which, for each triangle, contains the index of the first vertex point in the ItemsSource. -- **TriangleVertexMemberPath2**: `string` — The name of the property of the TrianglesSource items which, for each triangle, contains the index of the second vertex point in the ItemsSource. -- **TriangleVertexMemberPath3**: `string` — The name of the property of the TrianglesSource items which, for each triangle, contains the index of the third vertex point in the ItemsSource. -- **TrianglesSource**: `object` — The source of triangulation data. -- **TrianglesSourceScript**: `string` — Provides a means of setting TrianglesSource in the JavaScript environment. -- **TriangulationStatusChanged**: `EventCallback` -- **TriangulationStatusChangedScript**: `string` -- **Type**: `string` -- **XAxis**: `IgbNumericXAxis` — The X-Axis for this series. -- **XAxisName**: `string` — Gets or sets the name to use to resolve xAxis from markup. -- **XAxisScript**: `string` — Provides a means of setting XAxis in the JavaScript environment. -- **XMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series X value in the Data Legend. -- **XMemberAsLegendUnit**: `string` — Gets or sets the unit after displayed after series X value in the Data Legend. -- **XMemberPath**: `string` — The name of the property from which to extract the X-coordinate for each item in the ItemsSource. -- **YAxis**: `IgbNumericYAxis` — The Y-Axis for this series. -- **YAxisName**: `string` — Gets or sets the name to use to resolve yAxis from markup. -- **YAxisScript**: `string` — Provides a means of setting YAxis in the JavaScript environment. -- **YMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series Y value in the Data Legend. -- **YMemberAsLegendUnit**: `string` — Gets or sets the unit after displayed after series Y value in the Data Legend. -- **YMemberPath**: `string` — The name of the property from which to extract the Y-coordinate for each item in the ItemsSource. -- **BindAxes**(Axes: IgbAxis[]): void -- **CanUseAsXAxis**(axis: object): bool -- **CanUseAsXAxisAsync**(axis: object): Task — Determine if object can be used as XAxis -- **CanUseAsYAxis**(axis: object): bool -- **CanUseAsYAxisAsync**(axis: object): Task — Determine if object can be used as YAxis -- **FindByName**(name: string): object -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. - -### [IgbScrollStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbScrollStrategy) -Documentation. Scroll strategies determines how the scrolling will be handled in the provided IgxOverlayService. - -- **constructor**(): void -- **Type**: `string` -- **Attach**(): void -- **AttachAsync**(): Task — Attaches the strategy settings.scrollStrategy.attach(); -- **Detach**(): void -- **DetachAsync**(): Task — Detaches the strategy settings.scrollStrategy.detach(); -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbSearchInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSearchInfo) - -- **constructor**(): void -- **ActiveMatchIndex**: `double` -- **MatchInfoCache**: `object[]` -- **MatchInfoCacheScript**: `string` — Provides a means of setting MatchInfoCache in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbSectionFooter](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSectionFooter) -Used to configure the appearance of the section footer cells. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbSectionFooterModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSectionFooterModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSectionHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSectionHeader) -Used to configure the appearance of the section header cells. - -- **constructor**(): void -- **ActualSelectedBackground**: `string` -- **IsCollapsable**: `bool` -- **PaddingBottom**: `int` — Gets or sets the amount of bottom padding to use for the cell content of this column. -- **PaddingLeft**: `int` — Gets or sets the amount of left padding to use for the cell content for this column. -- **PaddingRight**: `int` — Gets or sets the amount of right padding to use for the cell content of this column. -- **PaddingTop**: `int` — Gets or sets the amount of top padding to use for the cell content for this column. -- **SelectedBackground**: `string` -- **SummaryDisplayMode**: `GroupSummaryDisplayMode` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbSectionHeaderCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSectionHeaderCellInfo) -Backing information for a section header cell in the grid. - -- **constructor**(): void -- **ResolvedSummaryText**: `string` — Sets or gets the resolved summary text for the section header cell. -- **ResolvedText**: `string` — Sets or gets the resolved text for the section header cell. -- **SummaryDisplayMode**: `GroupSummaryDisplayMode` — Sets or gets how summaries are displayed in the section header cell. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSectionHeaderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSectionHeaderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSectionInformation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSectionInformation) -Represents information about a section in a data source. - -- **constructor**(): void -- **EndIndex**: `int` — Gets the end index for the group. -- **GroupKeyProperties**: `string[]` — Gets the key properties for the group. -- **GroupKeyValues**: `object[]` — Gets the key values for the group. -- **GroupKeyValuesScript**: `string` — Provides a means of setting GroupKeyValues in the JavaScript environment. -- **StartIndex**: `int` — Gets the start index for the group. -- **SummaryResults**: `IgbDataGridSummaryResult[]` — Gets the summary results for the group. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSelect](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelect) -Represents a control that provides a menu of options. - -- **constructor**(): void -- **Autofocus**: `bool` — The autofocus attribute of the control. -- **Blur**: `EventCallback` -- **BlurScript**: `string` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — The disabled state of the component -- **Distance**: `double` — The distance of the select dropdown from its input. -- **Focus**: `EventCallback` -- **FocusScript**: `string` -- **Invalid**: `bool` — Control the validity of the control. -- **Label**: `string` — The label attribute of the control. -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **Outlined**: `bool` — The outlined attribute of the control. -- **ParentTypeName**: `string` -- **Placeholder**: `string` — The placeholder attribute of the control. -- **Placement**: `PopoverPlacement` — The preferred placement of the select dropdown around its input. -- **Required**: `bool` — Makes the control a required field in a form context. -- **ScrollStrategy**: `PopoverScrollStrategy` — Determines the behavior of the component during scrolling of the parent container. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `string` — The value attribute of the control. -- **ValueChanged**: `EventCallback` -- **BlurComponent**(): void -- **BlurComponentAsync**(): Task — Removes focus from the component. -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task — Checks for validity of the control and emits the invalid event if it invalid. -- **ClearSelection**(): void -- **ClearSelectionAsync**(): Task — Resets the current value and selection of the component. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FocusComponent**(options: IgbFocusOptions): void -- **FocusComponentAsync**(options: IgbFocusOptions): Task — Sets focus on the component. -- **GetCurrentValue**(): string -- **GetCurrentValueAsync**(): Task -- **GetGroups**(): IgbSelectGroup[] -- **GetGroupsAsync**(): Task -- **GetItems**(): IgbSelectItem[] -- **GetItemsAsync**(): Task -- **GetSelectedItem**(): IgbSelectItem -- **GetSelectedItemAsync**(): Task -- **ReportValidity**(): bool -- **ReportValidityAsync**(): Task — Checks the validity of the control and moves the focus to it if it is not valid. -- **ResolveDisplay**(): string -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task — Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid. - -### [IgbSelectAllCheckboxChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelectAllCheckboxChangedEventArgs) - -- **constructor**(): void -- **IsChecked**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSelectGroup](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelectGroup) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — Whether the group item and all its children are disabled. -- **Items**: `IgbSelectItem[]` — All child igc-select-items. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbSelectGroupModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelectGroupModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSelectHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelectHeader) -Represents a header item in an igc-select component. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbSelectHeaderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelectHeaderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSelectItem](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelectItem) -Represents an item in a select list. - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **SelectParent**: `BaseRendererControl` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task -- **ResolveDisplay**(): string - -### [IgbSelectItemComponentEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelectItemComponentEventArgs) - -- **constructor**(): void -- **Detail**: `IgbSelectItem` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSelectItemModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelectItemModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSelectModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelectModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSelectedItemChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelectedItemChangedEventArgs) -Provides data for the SelectedItemChanged event. - -- **constructor**(): void -- **NewItem**: `object` — The newly selected item. -- **OldItem**: `object` — The previously selected item. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSelectedItemChangingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelectedItemChangingEventArgs) -Provides data for the SelectedItemChanging event. - -- **constructor**(): void -- **Cancel**: `bool` — Set this to true in order to stop the SelectedItem from changing. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSelectedItemsChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelectedItemsChangedEventArgs) -Provides data for the SelectedItemsChanged event. - -- **constructor**(): void -- **CurrentItems**: `IgbObjectCollection` — A list of the current items selected. -- **NewItems**: `IgbObjectCollection` — A list of the items being selected. -- **OldItems**: `IgbObjectCollection` — A list of the previously selected items. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSelectedItemsChangingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelectedItemsChangingEventArgs) -Provides data for the SelectedItemsChanging event. - -- **constructor**(): void -- **Cancel**: `bool` — Set this to true in order to stop the SelectedItems collection from changing. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSelectedValueChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSelectedValueChangedEventArgs) - -- **constructor**(): void -- **NewValue**: `DateTime` -- **OldValue**: `DateTime` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSeries) -Represents the base class for all IgbDataChart series. - -- **constructor**(): void -- **ActualAreaFillOpacity**: `double` — Gets the actual opacity applied to the area fill visual. -- **ActualBrush**: `string` — Gets the effective brush for the current series object. -- **ActualFocusBrush**: `string` — Gets the effective emphasis brush for the current series object. -- **ActualFocusMode**: `SeriesSelectionMode` — Gets actual Selection mode -- **ActualHighlightedValuesFadeOpacity**: `double` — Gets actual HighlightedValues fade opacity -- **ActualHighlightingFadeOpacity**: `double` — Gets actual highlighting fade opacity -- **ActualHighlightingMode**: `SeriesHighlightingMode` — Gets actual highlighting mode -- **ActualHitTestMode**: `SeriesHitTestMode` — Resolved method of hit testing to use when pointing to items in the chart. -- **ActualLayers**: `IgbSeriesLayerCollection` — Gets the actual extra layers for the series. -- **ActualLegendItemBadgeBrush**: `string` — Gets the effective legend badge fill for the current series. -- **ActualLegendItemBadgeOutline**: `string` — Gets the effective legend badge outline for the current series. -- **ActualLegendItemBadgeTemplate**: `object` — Gets the actual legend item badge template used by the series. -- **ActualLegendItemBadgeTemplateScript**: `string` — Provides a means of setting ActualLegendItemBadgeTemplate in the JavaScript environment. -- **ActualMarkerFillOpacity**: `double` — Gets the actual opacity applied to the fill of the markers. -- **ActualOutline**: `string` — Gets the effective outline for the current series object. -- **ActualResolution**: `double` -- **ActualSelectionBrush**: `string` — Gets the effective emphasis brush for the current series object. -- **ActualSelectionMode**: `SeriesSelectionMode` — Gets actual Selection mode -- **ActualThickness**: `double` — Gets the effective Thickness for the current series object. -- **AreaFillOpacity**: `double` — Gets or sets the opacity applied to the area fill visual. -- **AttachTooltipToRoot**: `bool` — Gets or sets whether the tooltip will be attached to the root, when set to false it will be a child of the chart. -- **AutoCalloutLabelFormat**: `string` — Gets or sets the AutoCalloutLabel format string to use for the AutoCalloutLabel. -- **AutoCalloutLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the AutoCalloutLabelFormat string. -- **AutoCalloutValueLabelFormat**: `string` — Gets or sets the AutoCalloutLabel format string to use for the AutoCalloutLabel. -- **AutoCalloutValueLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the AutoCalloutValueLabelFormat string. -- **Brush**: `string` — Gets or sets the brush to use for the series. -- **CoercionMethods**: `object` — Gets or sets the coercion methods to use when loading data from data sources. Should be specified before setting any member paths, if being used. Setting it later will not cause data to be reimported into the chart. -- **CoercionMethodsScript**: `string` — Provides a means of setting CoercionMethods in the JavaScript environment. -- **DashArray**: `double[]` — Gets or sets a collection of Double values that indicate the pattern of dashes and gaps that is used to outline the current series object. -- **DataLegendGroup**: `string` — Gets or sets a name used for grouping multiple series in the Data Legend -- **DataSource**: `object` — Gets or sets the ItemsSource property for the current series object. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DiscreteLegendItemTemplate**: `object` — Gets or sets the DiscreteLegendItemTemplate property. -- **DiscreteLegendItemTemplateScript**: `string` — Provides a means of setting DiscreteLegendItemTemplate in the JavaScript environment. -- **ExpectFunctions**: `bool` — Gets or sets whether the series should expect that properties in its items source may be functions that need to be evaluated to yield their value. This defaults to false, as there will be a subtle performance impact to using this feature. This value must be set before assigning an item's source to take effect. -- **FinalValue**: `double` — The final value of this series. -- **FocusBrush**: `string` — Gets or sets the Focus brush to use for the series. -- **HighlightedDataSource**: `object` — Gets or sets the data to highlight for the series. -- **HighlightedDataSourceScript**: `string` — Provides a means of setting HighlightedDataSource in the JavaScript environment. -- **HighlightedLegendItemVisibility**: `Visibility` — Gets or sets whether the highlighted values layer should have a legend item. -- **HighlightedTitleSuffix**: `string` — Gets or sets the HighlightedTitleSuffix property. -- **HighlightedValuesDataLegendGroup**: `string` — Gets or sets a name used for grouping highlighted series in the Data Legend -- **HighlightedValuesDisplayMode**: `SeriesHighlightedValuesDisplayMode` — Gets or sets whether and how to display highlighted values for the series. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse. -- **HighlightedValuesExtraPropertyOverlays**: `IgbSeriesLayerPropertyOverlayCollection` — Gets the current extra layers for the series. -- **HighlightedValuesFadeOpacity**: `double` — Gets or sets the target opacity to fade to for fade style HighlightedValues. -- **HighlightingFadeOpacity**: `double` — Gets or sets the target opacity to fade to for fade style highlighting. -- **HitTestMode**: `SeriesHitTestMode` — Method of hit testing to use when pointing to items in this series. -- **Index**: `int` — Gets the Index property. -- **IsActualLegendFinancial**: `bool` — Gets or sets whether the ActualLegend is FinancialLegend or normal Legend. -- **IsComponentHighlightingModeIgnored**: `bool` — Gets or sets whether the component level highlight mode is ignored. -- **IsDefaultToolTipSelected**: `bool` — Gets if the default tooltip has been selected for display. -- **IsDropShadowEnabled**: `bool` — Gets or sets whether drop shadow should be enabled for this series. -- **IsHighlightingEnabled**: `bool` — Gets or sets whether highlighting should be enabled for this series, if this type of series supports highlighting. -- **Layers**: `IgbSeriesLayerCollection` — Gets the current extra layers for the series. -- **Legend**: `IgbLegendBase` — Gets or sets a legend for the current series object. -- **LegendItemBadgeMode**: `LegendItemBadgeMode` — Gets or sets the mode of legend badge representing the current series in a legend. -- **LegendItemBadgeShape**: `LegendItemBadgeShape` — Gets or sets the type of legend badge representing the current series in a legend. -- **LegendItemBadgeTemplate**: `object` — Gets or sets the LegendItemBadgeTemplate property. -- **LegendItemBadgeTemplateScript**: `string` — Provides a means of setting LegendItemBadgeTemplate in the JavaScript environment. -- **LegendItemTemplate**: `object` — Gets or sets the LegendItemTemplate property. -- **LegendItemTemplateScript**: `string` — Provides a means of setting LegendItemTemplate in the JavaScript environment. -- **LegendItemVisibility**: `Visibility` — Gets or sets whether or not the current series will have a legend item displayed in a legend. -- **LegendScript**: `string` — Provides a means of setting Legend in the JavaScript environment. -- **LineCap**: `PenLineCap` — Gets or sets the style of the starting point of any lines or polylines representing this series. -- **LineJoin**: `PenLineJoin` — Gets or sets the brush that specifies current series object's line join style. -- **MarkerFillOpacity**: `double` — Gets or sets the opacity applied to the fill of the markers. -- **MouseOverEnabled**: `bool` — Gets or sets the whether the chart reacts to mouse move events. -- **Opacity**: `double` -- **Outline**: `string` — Gets or sets the brush to use for the outline of the series. -- **OutlineMode**: `SeriesOutlineMode` — Gets or sets the outline mode to use for the series. -- **PercentChange**: `double` — The percent change from the beginning to the end of this series. -- **RenderRequested**: `Action` -- **RenderRequestedScript**: `string` -- **Resolution**: `double` — Gets or sets the current series object's rendering resolution. -- **SafeActualBrush**: `string` — Gets the effective brush for the current series object with opacity removed so its contrasty for use as a font color. -- **SelectionBrush**: `string` — Gets or sets the selection brush to use for the series. -- **SelectionThickness**: `double` — Gets or sets the width of the current series object's line thickness when the series is selected. -- **SeriesViewerParent**: `BaseRendererControl` -- **ShadowBlur**: `double` — Gets or sets the shadow blur. -- **ShadowColor**: `string` — Gets or sets the drop shadow color. -- **ShadowOffsetX**: `double` — Gets or sets the drop shadow x-offset. -- **ShadowOffsetY**: `double` — Gets or sets the drop shadow y-offset. -- **ShouldAnimateOnDataSourceSwap**: `bool` — Gets or sets whether and how to display highlighted values for the series. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse. -- **ShouldHideAutoCallouts**: `bool` — Gets or sets whether this series should suppress it's auto callouts -- **ShouldRemoveHighlightedDataOnLayerHidden**: `bool` — Gets or sets whether the opacity should be automatically shifted for the safe actual brush. -- **ShouldShiftOpacityForSafeActualBrush**: `bool` — Gets or sets whether the opacity should be automatically shifted for the safe actual brush. -- **ShowDefaultTooltip**: `bool` — Gets or sets whether default tooltip will be shown. -- **Thickness**: `double` — Gets or sets the width of the current series object's line thickness. -- **Title**: `string` -- **TooltipTemplate**: `RenderFragment` -- **TransitionDuration**: `int` — Gets or sets the duration of the current series' morph. -- **TransitionEasingFunction**: `string` — Gets or sets the easing function used to morph the current series. -- **TransitionEasingFunctionScript**: `string` — Provides a means of setting TransitionEasingFunction in the JavaScript environment. -- **TransitionInDuration**: `int` — Gets or sets the duration of the current series' transition in morph. -- **TransitionInEasingFunction**: `string` — Gets or sets the EasingFunction used to morph the current series during the initial transition. -- **TransitionInEasingFunctionScript**: `string` — Provides a means of setting TransitionInEasingFunction in the JavaScript environment. -- **TransitionInSpeedType**: `TransitionInSpeedType` — Gets or sets the duration of the current series' transition in morph. -- **TransitionOutCompleted**: `EventCallback` -- **TransitionOutCompletedScript**: `string` -- **TransitionOutDuration**: `int` — Gets or sets the duration of the current series' transition out morph. -- **TransitionOutEasingFunction**: `string` — Gets or sets the EasingFunction used to morph the current series during the initial transition. -- **TransitionOutEasingFunctionScript**: `string` — Provides a means of setting TransitionOutEasingFunction in the JavaScript environment. -- **TransitionOutSpeedType**: `TransitionOutSpeedType` — Gets or sets the duration of the current series' transition out morph. -- **Type**: `string` -- **UseItemWiseColors**: `bool` — Gets or sets whether the series should use individual palette colors for each item. -- **UseSingleShadow**: `bool` — Gets or sets whether drop shadow is applied to the whole series visual or to each of the individual shapes forming the series. -- **Visibility**: `Visibility` -- **VisibleRangeMarginBottom**: `double` — Gets or sets the bottom margin to use when getting a visible axis range for the series. -- **VisibleRangeMarginLeft**: `double` — Gets or sets the left margin to use when getting a visible axis range for the series. -- **VisibleRangeMarginRight**: `double` — Gets or sets the right margin to use when getting a visible axis range for the series. -- **VisibleRangeMarginTop**: `double` — Gets or sets the top margin to use when getting a visible axis range for the series. -- **VisibleRangeMode**: `SeriesVisibleRangeMode` — Gets or sets the visible range mode to use. -- **BindAxes**(Axes: IgbAxis[]): void -- **BindSeries**(Series: IgbSeries[]): void -- **Dispose**(): void -- **FindByName**(name: string): object -- **FromWorldPosition**(world: Point): Point -- **FromWorldPositionAsync**(world: Point): Task — Converts a point from world coordinates to coordinates within the viewport of the series. -- **GetEffectiveViewport**(): Rect -- **GetEffectiveViewportAsync**(): Task — Gets the effective viewport, adjusted to account for margins and other factors. -- **GetExactItemIndex**(world: Point): double -- **GetExactItemIndexAsync**(world: Point): Task — Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex. -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemIndex**(world: Point): int -- **GetItemIndexAsync**(world: Point): Task — Gets the item index associated with the specified world position -- **GetItemSpan**(): double -- **GetItemSpanAsync**(): Task — For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMainContentViewport**(): Rect -- **GetMainContentViewportAsync**(): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **GetNextOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetNextOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetPreviousOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetPreviousOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetSeriesHighValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesHighValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesHighValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesHighValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesLowValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesLowValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesLowValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesLowValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValueBoundingBox**(world: Point): Rect -- **GetSeriesValueBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. -- **GetSeriesValueFromSeriesPixel**(mouse: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueFromSeriesPixelAsync**(mouse: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValueMarkerBoundingBox**(world: Point): Rect -- **GetSeriesValueMarkerBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided. -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValuePositionFromSeriesPixel**(mouse: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionFromSeriesPixelAsync**(mouse: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValueType**(mode: ValueLayerValueMode): double[] -- **GetSeriesValueTypeAsync**(mode: ValueLayerValueMode): Task — Gets the data values of each axis associated with the specified value type. For example, if you specify mode as Maximum then it will return the maximum numerical value for each axis. For non-numerical axes it will return NaN. -- **GetSeriesValueTypePosition**(mode: ValueLayerValueMode): Point -- **GetSeriesValueTypePositionAsync**(mode: ValueLayerValueMode): Task — Gets position of series value for specified layer value mode -- **GetUnscaledPosition**(pos: Point): Point -- **GetUnscaledPositionAsync**(pos: Point): Task — Gets an unscaled position in terms of axis values from a viewport position. -- **HideToolTips**(): void -- **HideToolTipsAsync**(): Task — Hides any internal tooltips presented by the series, if any. -- **HideToolTipsImmediate**(): void -- **HideToolTipsImmediateAsync**(): Task — Hides any internal tooltips presented by the series, if any. -- **MoveCursorPoint**(point: Point): void -- **MoveCursorPointAsync**(point: Point): Task — Moves the cursor point to the provided world position. Some series may react to the current cursor position. -- **NotifyIndexedPropertiesChanged**(): void -- **NotifyIndexedPropertiesChangedAsync**(): Task — Called to notify about changes to indexed-based properties, e.g. Brushes, Outlines, MarkerBrushes, MarkerOutlines and refresh series -- **NotifyVisualPropertiesChanged**(): void -- **NotifyVisualPropertiesChangedAsync**(): Task — Notifies the series that a visual property has changed, requiring a visual update. -- **OnInitializedAsync**(): Task -- **PlayTransitionIn**(): void -- **PlayTransitionInAsync**(): Task — Plays the assigned transition out animation, if any. -- **PlayTransitionOut**(): void -- **PlayTransitionOutAndRemove**(): void -- **PlayTransitionOutAndRemoveAsync**(): Task — Plays the assigned transition out animation, if any. -- **PlayTransitionOutAsync**(): Task — Plays the assigned transition out animation, if any. -- **RemoveAllAlternateViews**(): void -- **RemoveAllAlternateViewsAsync**(): Task — Removes all alternate views of this series. -- **RemoveAlternateView**(viewIdentifier: string): void -- **RemoveAlternateViewAsync**(viewIdentifier: string): Task — Removes an alternate view of this series. -- **RemoveAxes**(): void -- **RemoveAxesAsync**(): Task — Call to null out the axes of the series; -- **RenderSeries**(animate: bool): void -- **RenderSeriesAsync**(animate: bool): Task — Renders the series. -- **ReplayTransitionIn**(): void -- **ReplayTransitionInAsync**(): Task — Replays the assigned transition in animation, if any. -- **ResolveTooltipBrush**(): string -- **ResolveTooltipBrushAsync**(): Task — Gets the brush for tooltip labels. -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Requests that the provided item should be brought into view if possible. -- **SetNegativeColors**(negativeBrush: string, negativeOutline: string): void -- **SetNegativeColorsAsync**(negativeBrush: string, negativeOutline: string): Task -- **SimulateHover**(point: Point): void -- **SimulateHoverAsync**(point: Point): Task — Simulates a pointer hover over the series surface. -- **StyleUpdated**(): void -- **StyleUpdatedAsync**(): Task — Called when this series' Style is updated. -- **ToWorldPosition**(seriesPoint: Point): Point -- **ToWorldPositionAsync**(seriesPoint: Point): Task — Converts a point from coordinates within the series plot area to a world position within axis space. -- **ToWorldRect**(rect: Rect): Rect -- **ToWorldRectAsync**(rect: Rect): Task — Converts a rect from coordinates within the series plot area to a world position within axis space. - -### [IgbSeriesCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSeriesCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbSeriesLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSeriesLayer) -Represents an axis annotation - -- **constructor**(): void -- **PropertyOverlays**: `IgbSeriesLayerPropertyOverlayCollection` — Gets the current extra layers for the series. -- **Type**: `string` -- **ZIndex**: `double` — Gets or sets the ZIndex to use for layering the series layers. -- **FindByName**(name: string): object -- **PlayTransitionIn**(): void -- **PlayTransitionInAsync**(): Task -- **PlayTransitionOutAndRemove**(): void -- **PlayTransitionOutAndRemoveAsync**(): Task - -### [IgbSeriesLayerCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSeriesLayerCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbSeriesLayerPropertyOverlay](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSeriesLayerPropertyOverlay) -Represents an axis annotation - -- **constructor**(): void -- **CurrentValuePropertyName**: `string` — Gets or sets the property from which to get the current value, if different from property name. -- **IsAlwaysApplied**: `bool` — Gets or sets whether this property overlay should be applied to the source or target even if the source property wasn't mutated. -- **IsSourceOverlay**: `bool` — Gets or sets whether this property overlay targets the source series instead of the current layer while the layer is present. -- **PropertyName**: `string` — Gets or sets the property to overlay on the series or series layer. -- **PropertyUpdated**: `EventCallback` -- **PropertyUpdatedScript**: `string` -- **Type**: `string` -- **Value**: `object` — Gets or sets the value to overlay on the series or series layer. -- **ValueResolving**: `EventCallback` -- **ValueResolvingScript**: `string` -- **ValueScript**: `string` — Provides a means of setting Value in the JavaScript environment. -- **FindByName**(name: string): object - -### [IgbSeriesLayerPropertyOverlayCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSeriesLayerPropertyOverlayCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbSeriesLayerPropertyOverlayValueResolvingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSeriesLayerPropertyOverlayValueResolvingEventArgs) -Provides data for Axis RangeChanged events. - -- **constructor**(): void -- **Type**: `string` -- **Value**: `object` -- **ValueScript**: `string` — Provides a means of setting Value in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSeriesMatcher](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSeriesMatcher) - -- **constructor**(): void -- **Index**: `int` — If set, tries to match a series based on index -- **MemberPath**: `string` — If set, tries to match a series based on a member path, combined with MemberPathType. -- **MemberPathType**: `string` — Combined with MemberPath allows you to select a series by member path. -- **Title**: `string` — If set, tries to match a series based on its title. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSeriesMatcherModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSeriesMatcherModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSeriesViewer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSeriesViewer) -Represents a control for viewing series objects. - -- **constructor**(): void -- **ActualContentHitTestMode**: `ChartHitTestMode` — Resolved method of hit testing used when the pointer is over elements in the chart. -- **ActualInteractionPixelScalingRatio**: `double` — Resolved method of pixel scaling to use during end user interaction with the chart. -- **ActualPixelScalingRatio**: `double` — Gets the resolved pixel scaling ratio. -- **ActualSeries**: `IgbSeriesCollection` -- **ActualWindowPositionHorizontal**: `double` — A number between 0 and 1 determining the position of the horizontal scroll. -- **ActualWindowPositionVertical**: `double` — A number between 0 and 1 determining the position of the vertical scroll. -- **ActualWindowRect**: `Rect` — Gets the actual value of the window rectangle, which represents the current zoom level. -- **ActualWindowRectChanged**: `Action` -- **ActualWindowRectChangedScript**: `string` -- **ActualWindowRectMinHeight**: `double` — Gets the actual minimum height that the window rect is allowed to reach before being clamped. -- **ActualWindowRectMinWidth**: `double` — Gets the actual minimum width that the window rect is allowed to reach before being clamped. -- **AnimateSeriesWhenAxisRangeChanges**: `bool` — Gets or sets whether the series animations should be allowed when a range change has been detected on an axis. -- **AutoMarginHeight**: `double` — Sets or gets the automatic height to add when automatically adding margins to the chart. -- **AutoMarginWidth**: `double` — Sets or gets the automatic width to add when automatically adding margins to the chart. -- **AxisLabelMouseClick**: `Action` -- **AxisLabelMouseClickScript**: `string` -- **AxisLabelMouseDown**: `Action` -- **AxisLabelMouseDownScript**: `string` -- **AxisLabelMouseEnter**: `Action` -- **AxisLabelMouseEnterScript**: `string` -- **AxisLabelMouseLeave**: `Action` -- **AxisLabelMouseLeaveScript**: `string` -- **AxisLabelMouseOver**: `Action` -- **AxisLabelMouseOverScript**: `string` -- **AxisLabelMouseUp**: `Action` -- **AxisLabelMouseUpScript**: `string` -- **AxisPanelMouseClick**: `Action` -- **AxisPanelMouseClickScript**: `string` -- **AxisPanelMouseDown**: `Action` -- **AxisPanelMouseDownScript**: `string` -- **AxisPanelMouseEnter**: `Action` -- **AxisPanelMouseEnterScript**: `string` -- **AxisPanelMouseLeave**: `Action` -- **AxisPanelMouseLeaveScript**: `string` -- **AxisPanelMouseOver**: `Action` -- **AxisPanelMouseOverScript**: `string` -- **AxisPanelMouseUp**: `Action` -- **AxisPanelMouseUpScript**: `string` -- **BottomMargin**: `double` — Sets or gets the bottom margin to use around the chart content. -- **Brushes**: `string` — Gets or sets the palette of brushes used for fill of plotted series. -- **ChartTitle**: `string` — Text to display above the plot area. -- **ContentHitTestMode**: `ChartHitTestMode` — Determines the method of hit testing used when mousing over elements in the chart. -- **ContentSeries**: `IgbSeriesCollection` -- **CrosshairPoint**: `Point` — Gets or sets the cross hair point (in world coordinates) -- **CrosshairVisibility**: `Visibility` — Gets or sets the current SeriesViewer's crosshair visibility override. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DefaultInteraction**: `InteractionState` — Gets or sets the DefaultInteraction property. -- **DragModifier**: `ModifierKeys` — Gets or sets the current SeriesViewer's DragModifier property. -- **EffectiveViewport**: `Rect` — Gets the EffectiveViewport rectangle, representing the effective viewport area after margins have been subtracted. -- **FireMouseLeaveOnManipulationStart**: `bool` — Gets or sets how the mouse leave event fires when a manipulation is started. -- **FocusBrush**: `string` — Gets or sets the Focus brush to use for the series. -- **FocusDismissDelayMilliseconds**: `int` — Gets or sets the amount of time to delay before dismissing a selection effect. -- **FocusMode**: `SeriesSelectionMode` — Gets or sets the focus mode to use for the series in the component, when supported. -- **FocusTransitionDuration**: `int` — Gets or sets the duration the Focus/de-Focus effects. -- **FocusedSeriesItems**: `IgbChartSelectedItemCollection` — Gets the currently focused data items. Adding or removing data items from this collection will focus or blur the visuals associated with those items. -- **FocusedSeriesItemsChanged**: `EventCallback` -- **FocusedSeriesItemsChangedScript**: `string` -- **FullSeries**: `IgbSeriesCollection` -- **GridAreaRectChanged**: `Action` -- **GridAreaRectChangedScript**: `string` -- **HighlightedValuesDisplayMode**: `SeriesHighlightedValuesDisplayMode` — Gets or sets whether and how to display highlighted values for the series by default. Note, this is distinct from the highlighting feature that indicates what is closest or under the mouse. -- **HighlightingBehavior**: `SeriesHighlightingBehavior` — Gets or sets the highlighting Behavior to use for the series in the component, when supported. This takes precedence over the series level IsHighlightingEnabled. -- **HighlightingDismissDelayMilliseconds**: `int` — Gets or sets the amount of time to delay before dismissing a selection effect. -- **HighlightingFadeOpacity**: `double` — Gets or sets the target opacity to fade to for fade style highlighting. -- **HighlightingMode**: `SeriesHighlightingMode` — Gets or sets the highlighting mode to use for the series in the component, when supported. This takes precedence over the series level IsHighlightingEnabled. -- **HighlightingTransitionDuration**: `int` — Gets or sets the duration the highlighting/de-highlighting effects. -- **HorizontalCrosshairBrush**: `string` — Gets or sets the current SeriesViewer's crosshair horizontal brush override. -- **HorizontalViewScrollbarCornerRadius**: `double` — Gets or sets the corner radius to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarFill**: `string` — Gets or sets the fill to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarHeight**: `double` — Gets or sets the height to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarInset**: `double` — Gets or sets the inset distance to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarMaxOpacity**: `double` — Gets or sets the max opacity to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarMode**: `SeriesViewerScrollbarMode` — Gets or sets the horizontal scrollbar mode to use for the series viewer. -- **HorizontalViewScrollbarOutline**: `string` — Gets or sets the outline to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarPosition**: `SeriesViewerHorizontalScrollbarPosition` — Gets or sets the position to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarShouldAddAutoTrackInsets**: `bool` — Gets or sets whether to use automatic track insets for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarStrokeThickness**: `double` — Gets or sets the stroke thickness to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarTrackEndInset**: `double` — Gets or sets the track end inset to use for the horizontal scrollbar in the component, when enabled. -- **HorizontalViewScrollbarTrackStartInset**: `double` — Gets or sets the track start inset to use for the horizontal scrollbar in the component, when enabled. -- **ImageCaptured**: `Action` -- **ImageCapturedScript**: `string` -- **InteractionOverride**: `InteractionState` — Gets or sets the InteractionOverride property. -- **InteractionPixelScalingRatio**: `double` — Method of pixel scaling to use during end user interaction with the chart. -- **IsAntiAliasingEnabledDuringInteraction**: `bool` — Gets or sets the IsAntiAliasingEnabledDuringInteraction property. -- **IsPagePanningAllowed**: `bool` — Gets or sets the whether the series viewer can allow the page to pan if a control pan is not possible in the requested direction. -- **IsSurfaceInteractionDisabled**: `bool` — Gets or sets whether all surface interactions with the plot area should be disabled. -- **IsUserAnnotationsEnabled**: `bool` — Gets or sets whether initiating user annotations from the toolbar is enabled. -- **IsWindowSyncedToVisibleRange**: `bool` — Gets or sets whether to sync the vertical aspect of the window with the contained series content. This is only supported for a subset of the available series. -- **LeftMargin**: `double` — Sets or gets the left margin to use around the chart content. -- **Legend**: `IgbLegendBase` — Gets or sets which legend to use for all series in this SeriesViewer, unless otherwise specified by the Series.Legend property. -- **LegendHighlightingMode**: `LegendHighlightingMode` — Gets or sets the highlighting mode to use for the legend linked to the component, when supported. -- **LegendItemBadgeMode**: `LegendItemBadgeMode` — Gets or sets the mode of legend badges representing all series in this chart. -- **LegendItemBadgeShape**: `LegendItemBadgeShape` — Gets or sets type of legend badges representing all series displayed in a legend linked to this component -- **LegendScript**: `string` — Provides a means of setting Legend in the JavaScript environment. -- **MarkerAutomaticBehavior**: `MarkerAutomaticBehavior` — Gets or sets the marker mode used for assigning a marker type to series when the marker type is automatic. -- **MarkerBrushes**: `string` — Gets or sets the palette of brushes used for fill of marker series. -- **MarkerOutlines**: `string` — Gets or sets the palette of brushes used for outlines of plotted markers. -- **Outlines**: `string` — Gets or sets the palette of brushes used for outlines of plotted series. -- **PanModifier**: `ModifierKeys` — Gets or sets the current SeriesViewer's PanModifier property. -- **ParentTypeName**: `string` -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **PlotAreaBackground**: `string` — Gets or sets the brush used as the background for the current SeriesViewer object's plot area. -- **PlotAreaClicked**: `EventCallback` -- **PlotAreaClickedScript**: `string` -- **PlotAreaMouseEnter**: `Action` -- **PlotAreaMouseEnterScript**: `string` -- **PlotAreaMouseLeave**: `Action` -- **PlotAreaMouseLeaveScript**: `string` -- **PlotAreaMouseLeftButtonDown**: `EventCallback` -- **PlotAreaMouseLeftButtonDownScript**: `string` -- **PlotAreaMouseLeftButtonUp**: `EventCallback` -- **PlotAreaMouseLeftButtonUpScript**: `string` -- **PlotAreaMouseOver**: `Action` -- **PlotAreaMouseOverScript**: `string` -- **PreferHigherResolutionTiles**: `bool` — Gets or sets whether the series viewer should prefer selecting higher resolution tiles over lower resolution tiles when performing tile zooming. Setting this to true will lower performance but increase quality. -- **PreviewPathFill**: `string` — Gets or sets the brush used as the fill for the current SeriesViewer object's preview path. Null is treated as auto. -- **PreviewPathOpacity**: `double` — Gets or sets the opacity used as for the fill for the current SeriesViewer object's preview path. Null is treated as auto. -- **PreviewPathStroke**: `string` — Gets or sets the brush used as the border for the current SeriesViewer object's preview path. Null is treated as auto. -- **PreviewRect**: `Rect` — Gets or sets the preview rectangle. -- **RefreshCompleted**: `Action` -- **RefreshCompletedScript**: `string` -- **ResizeIdle**: `EventCallback` -- **ResizeIdleMilliseconds**: `int` — Gets or sets the milliseconds before the chart will fire the resize idle event after the last resize. -- **ResizeIdleScript**: `string` -- **RightButtonDefaultInteraction**: `InteractionState` — Gets or sets the RightButtonDefaultInteraction property. -- **RightMargin**: `double` — Sets or gets the right margin to use around the chart content. -- **ScrollbarsAnimationDuration**: `int` — Gets or sets the duration of the scrollbar effects. -- **SelectedSeriesItems**: `IgbChartSelectedItemCollection` — Gets the currently selected data items. Adding or removing data items from this collection will select or deselect the visuals associated with those items. -- **SelectedSeriesItemsChanged**: `EventCallback` -- **SelectedSeriesItemsChangedScript**: `string` -- **SelectionBehavior**: `SeriesSelectionBehavior` — Gets or sets the selection behavior to use for the series in the component, when supported. -- **SelectionBrush**: `string` — Gets or sets the selection brush to use for the series. -- **SelectionDismissDelayMilliseconds**: `int` — Gets or sets the amount of time to delay before dismissing a selection effect. -- **SelectionMode**: `SeriesSelectionMode` — Gets or sets the selection mode to use for the series in the component, when supported. -- **SelectionModifier**: `ModifierKeys` — Gets or sets the current SeriesViewer's SelectionModifier property. -- **SelectionTransitionDuration**: `int` — Gets or sets the duration the selection/de-Selection effects. -- **Series**: `IgbSeriesCollection` — Gets the current SeriesViewer object's child Series. -- **SeriesClick**: `EventCallback` -- **SeriesClickScript**: `string` -- **SeriesCursorMouseMove**: `Action` -- **SeriesCursorMouseMoveScript**: `string` -- **SeriesMouseEnter**: `EventCallback` -- **SeriesMouseEnterScript**: `string` -- **SeriesMouseLeave**: `EventCallback` -- **SeriesMouseLeaveScript**: `string` -- **SeriesMouseLeftButtonDown**: `EventCallback` -- **SeriesMouseLeftButtonDownScript**: `string` -- **SeriesMouseLeftButtonUp**: `EventCallback` -- **SeriesMouseLeftButtonUpScript**: `string` -- **SeriesMouseMove**: `Action` -- **SeriesMouseMoveScript**: `string` -- **SeriesValueLayerUseLegend**: `bool` — Gets or sets whether the series animations should be allowed when a range change has been detected on an axis. -- **ShouldMatchZOrderToSeriesOrder**: `bool` — Gets or sets whether to match the z order of the series to their positional order in the series collection, regardless of mutation. -- **ShouldPanOnMaximumZoom**: `bool` — Gets or sets a whether the chart should pan its content when zooming in passed max zoom level. -- **ShouldSimulateHoverMoveCrosshairPoint**: `bool` — Gets or sets whether calling SimulateHover should shift the crosshair point. -- **SizeChanged**: `Action` -- **SizeChangedScript**: `string` -- **Subtitle**: `string` — Gets or sets the Subtitle property. -- **SubtitleBottomMargin**: `double` — Margin applied below the subtitle. -- **SubtitleHorizontalAlignment**: `HorizontalAlignment` — Gets or sets the SubtitleHorizontalAlignment property. -- **SubtitleLeftMargin**: `double` — Margin applied to the left of the subtitle. -- **SubtitleRightMargin**: `double` — Margin applied to the right of the subtitle. -- **SubtitleTextColor**: `string` — Gets or sets the Color used for the Subtitle Text. -- **SubtitleTextStyle**: `string` — Font settings for the subtitle. -- **SubtitleTopMargin**: `double` — Margin applied above the subtitle. -- **SyncChannel**: `string` — Sets or gets the Synchronization channel to use for the SeriesViewer. -- **TitleBottomMargin**: `double` — Margin applied below the title. -- **TitleHorizontalAlignment**: `HorizontalAlignment` — Gets or sets the TitleHorizontalAlignment property. -- **TitleLeftMargin**: `double` — Margin applied to the left of the title. -- **TitleRightMargin**: `double` — Margin applied to the right of the title. -- **TitleTextColor**: `string` — Gets or sets the Color used for the Title Text. -- **TitleTextStyle**: `string` — Font settings for the title. -- **TitleTopMargin**: `double` — Margin applied above the title. -- **TopMargin**: `double` — Sets or gets the top margin to use around the chart content. -- **Type**: `string` -- **UseTiledZooming**: `bool` — Gets or sets whether the series viewer should use cached tiles during zooms rather than the default live content. -- **UserAnnotationInformationRequested**: `EventCallback` -- **UserAnnotationInformationRequestedScript**: `string` -- **UserAnnotationToolTipContentUpdating**: `EventCallback` -- **UserAnnotationToolTipContentUpdatingScript**: `string` -- **VerticalCrosshairBrush**: `string` — Gets or sets the current SeriesViewer's crosshair vertical brush override. -- **VerticalViewScrollbarCornerRadius**: `double` — Gets or sets the corner radius to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarFill**: `string` — Gets or sets the fill to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarInset**: `double` — Gets or sets the inset distance to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarMaxOpacity**: `double` — Gets or sets the max opacity to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarMode**: `SeriesViewerScrollbarMode` — Gets or sets the vertical scrollbar mode to use for the series viewer. -- **VerticalViewScrollbarOutline**: `string` — Gets or sets the outline to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarPosition**: `SeriesViewerVerticalScrollbarPosition` — Gets or sets the position to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarShouldAddAutoTrackInsets**: `bool` — Gets or sets whether to use automatic track insets for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarStrokeThickness**: `double` — Gets or sets the stroke thickness to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarTrackEndInset**: `double` — Gets or sets the track end inset to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarTrackStartInset**: `double` — Gets or sets the track start inset to use for the vertical scrollbar in the component, when enabled. -- **VerticalViewScrollbarWidth**: `double` — Gets or sets the width to use for the vertical scrollbar in the component, when enabled. -- **ViewerManipulationEnding**: `Action` -- **ViewerManipulationEndingScript**: `string` -- **ViewerManipulationStarting**: `Action` -- **ViewerManipulationStartingScript**: `string` -- **ViewportRect**: `Rect` — Gets the viewport rectangle associated with the SeriesViewer, the physical dimensions of the plot area. -- **WindowPositionHorizontal**: `double` — A number between 0 and 1 determining the position of the horizontal scroll. -- **WindowPositionVertical**: `double` — A number between 0 and 1 determining the position of the vertical scroll. -- **WindowRect**: `Rect` — A rectangle representing the portion of the SeriesViewer currently in view. -- **WindowRectChanged**: `Action` -- **WindowRectChangedScript**: `string` -- **WindowRectMinHeight**: `double` — Sets or gets the minimum height that the window rect is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. -- **WindowRectMinWidth**: `double` — Sets or gets the minimum width that the window rect is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. -- **WindowResponse**: `WindowResponse` — The response to user panning and zooming: whether to update the view immediately while the user action is happening, or to defer the update to after the user action is complete. The user action will be an action such as a mouse drag which causes panning and/or zooming to occur. -- **WindowSizeMinHeight**: `double` — Sets or gets minimum pixel height that the window is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. -- **WindowSizeMinWidth**: `double` — Sets or gets minimum pixel width that the window is allowed to reach before being clamped. Decrease this value if you want to allow for further zooming into the viewer. If this value is lowered too much it can cause graphical corruption due to floating point arithmetic inaccuracy. -- **ZoomCoercionMode**: `ZoomCoercionMode` — Gets or sets zoom is constrained to within the axes. Setting this to false is a preview feature at the present time. -- **ZoomTileCacheSize**: `int` — Gets or sets the maximum number of zoom tiles that the series viewer should cache while in tiled zooming mode. -- **CancelAnnotationFlow**(annotationFlowID: string): void -- **CancelAnnotationFlowAsync**(annotationFlowID: string): Task -- **CancelCreatingAnnotation**(): void -- **CancelCreatingAnnotationAsync**(): Task -- **CancelDeletingAnnotation**(): void -- **CancelDeletingAnnotationAsync**(): Task -- **CancelManipulation**(): void -- **CancelManipulationAsync**(): Task -- **CaptureImage**(settings: IgbCaptureImageSettings): void -- **CaptureImageAsync**(settings: IgbCaptureImageSettings): Task -- **ClearTileZoomCache**(): void -- **ClearTileZoomCacheAsync**(): Task — Clears the tile zoom tile cache so that new tiles will be generated. Only applies if the viewer is using a tile based zoom. -- **Destroy**(): void -- **DestroyAsync**(): Task — Release any resources held by the control. -- **EndTiledZoomingIfRunning**(): void -- **EndTiledZoomingIfRunningAsync**(): Task — Manually ends a tiled zoom if one is running. -- **FindByName**(name: string): object -- **FinishAnnotationFlow**(info: IgbUserAnnotationInformation): void -- **FinishAnnotationFlowAsync**(info: IgbUserAnnotationInformation): Task -- **FinishCreatingAnnotation**(): void -- **FinishCreatingAnnotationAsync**(): Task -- **FinishDeletingAnnotation**(): void -- **FinishDeletingAnnotationAsync**(): Task -- **Flush**(): void -- **FlushAsync**(): Task — Use to force the SeriesViewer to finish any deferred work before printing or evaluating its visual. -- **GetActualWindowScaleHorizontal**(): double -- **GetActualWindowScaleHorizontalAsync**(): Task — Gets actual window scale for horizontal dimension of the control -- **GetActualWindowScaleVertical**(): double -- **GetActualWindowScaleVerticalAsync**(): Task — Gets actual window scale for vertical dimension of the control -- **GetAllAxes**(): IgbAxis[] -- **GetAllSeries**(): IgbSeries[] -- **GetAnimationIdleVersionNumber**(): int -- **GetAnimationIdleVersionNumberAsync**(): Task -- **GetCurrentActualWindowRect**(): Rect -- **GetCurrentActualWindowRectAsync**(): Task -- **GetCurrentFocusedSeriesItems**(): IgbChartSelectedItemCollection -- **GetCurrentFocusedSeriesItemsAsync**(): Task -- **GetCurrentSelectedSeriesItems**(): IgbChartSelectedItemCollection -- **GetCurrentSelectedSeriesItemsAsync**(): Task -- **GetCurrentViewportRect**(): Rect -- **GetCurrentViewportRectAsync**(): Task -- **GetCurrentWindowRect**(): Rect -- **GetCurrentWindowRectAsync**(): Task -- **HideToolTip**(): void -- **HideToolTipAsync**(): Task — Hides the active main tooltip, if displayed. -- **IsAnimationActive**(): bool -- **IsAnimationActiveAsync**(): Task -- **LoadAnnotationsFromJson**(jsonString: string): void -- **LoadAnnotationsFromJsonAsync**(jsonString: string): Task -- **NotifyContainerResized**(): void -- **NotifyContainerResizedAsync**(): Task — Notification from the containing object that the container has been resized. -- **NotifySeriesDataChanged**(): void -- **NotifySeriesDataChangedAsync**(): Task -- **RenderToImage**(width: double, height: double): object -- **RenderToImageAsync**(width: double, height: double): Task -- **ResetAnnotations**(): void -- **ResetAnnotationsAsync**(): Task -- **ResetZoom**(): void -- **ResetZoomAsync**(): Task — Resets the zoom level to default. -- **SaveAnnotationsToJson**(): string -- **SaveAnnotationsToJsonAsync**(): Task -- **SimulateClick**(point: Point): void -- **SimulateClickAsync**(point: Point): Task -- **SimulateHover**(point: Point): void -- **SimulateHoverAsync**(point: Point): Task -- **SimulateMouseLeave**(): void -- **SimulateMouseLeaveAsync**(): Task -- **SimulatePlotPointerUp**(point: Point): void -- **SimulatePlotPointerUpAsync**(point: Point): Task -- **SimulatePressAndHold**(point: Point): void -- **SimulatePressAndHoldAsync**(point: Point): Task -- **StartCreatingAnnotation**(): void -- **StartCreatingAnnotationAsync**(): Task -- **StartDeletingAnnotation**(): void -- **StartDeletingAnnotationAsync**(): Task -- **StartTiledZoomingIfNecessary**(): void -- **StartTiledZoomingIfNecessaryAsync**(): Task — Manually starts a tiled zoom if one isn't already running. -- **ZoomIn**(percentage: double): void -- **ZoomInAsync**(percentage: double): Task — Performs zoom in action on the chart by specified percentage of current window rect -- **ZoomOut**(percentage: double): void -- **ZoomOutAsync**(percentage: double): Task — Performs zoom out action on the chart by specified percentage of current window rect - -### [IgbSeriesViewerManipulationEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSeriesViewerManipulationEventArgs) - -- **constructor**(): void -- **DragSelectRectangle**: `Rect` -- **IsDragSelect**: `bool` -- **IsDragSelectCancelled**: `bool` -- **IsDragZoom**: `bool` -- **IsZoomPan**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSeriesViewerSelectedSeriesItemsChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSeriesViewerSelectedSeriesItemsChangedEventArgs) -Provides data for the SelectedItemsChanged event. - -- **constructor**(): void -- **CurrentItems**: `IgbChartSelectedItemCollection` — A list of the current items selected. -- **NewItems**: `IgbChartSelectedItemCollection` — A list of the items being selected. -- **OldItems**: `IgbChartSelectedItemCollection` — A list of the previously selected items. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSeriesViewerSelectedSeriesItemsChangingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSeriesViewerSelectedSeriesItemsChangingEventArgs) -Provides data for the SelectedItemsChanging event. - -- **constructor**(): void -- **Cancel**: `bool` — Set this to true in order to stop the SelectedItems collection from changing. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbShapeDataSource](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbShapeDataSource) -Class used to convert Shapefiles into CLR objects. - -- **constructor**(): void -- **ComputedWorldRect**: `Rect` — Gets the world bounding rectangle, based on the filtered shapes -- **DatabaseSource**: `string` — The Uri of the .dbf portion of the Shapefile. -- **DeferImportCompleted**: `bool` — The Uri of the .shp portion of the Shapefile. -- **Filter**: `EventCallback` -- **FilterScript**: `string` -- **ImportCompleted**: `EventCallback` -- **ImportCompletedScript**: `string` -- **ImportPending**: `EventCallback` -- **ImportPendingScript**: `string` -- **ShapefileSource**: `string` — The Uri of the .shp portion of the Shapefile. -- **Type**: `string` -- **WorldRect**: `Rect` — Gets the world bounding rectangle, as read from the header of the Shapefile. -- **FindByName**(name: string): object -- **GetLargestShapeBoundsForRecord**(index: int): Rect -- **GetLargestShapeBoundsForRecordAsync**(index: int): Task -- **GetMaxLongitude**(recordIndex: int, useLargestShape: bool, fromLongitude: double, toLongitude: double): double -- **GetMaxLongitudeAsync**(recordIndex: int, useLargestShape: bool, fromLongitude: double, toLongitude: double): Task -- **GetRecord**(index: int): IgbShapefileRecord -- **GetRecordAsync**(index: int): Task -- **GetRecordBounds**(index: int): Rect -- **GetRecordBoundsAsync**(index: int): Task -- **GetRecordFieldNames**(index: int): string[] -- **GetRecordFieldNamesAsync**(index: int): Task -- **GetRecordValue**(index: int, fieldName: string): object -- **GetRecordValueAsync**(index: int, fieldName: string): Task -- **GetRecordValues**(fieldName: string): object[] -- **GetRecordValuesAsync**(fieldName: string): Task -- **GetRecordsCount**(): int -- **GetRecordsCountAsync**(): Task -- **GetWorldBounds**(useComputed: bool): Rect -- **GetWorldBoundsAsync**(useComputed: bool): Task -- **RemoveRecord**(index: int): void -- **RemoveRecordAsync**(index: int): Task -- **SendImportCompleted**(): void -- **SendImportCompletedAsync**(): Task -- **SetRecordValue**(index: int, fieldName: string, value: object): void -- **SetRecordValueAsync**(index: int, fieldName: string, value: object): Task -- **SetRecordValues**(fieldName: string, values: object[]): void -- **SetRecordValuesAsync**(fieldName: string, values: object[]): Task -- **SetWorldBounds**(setComputed: bool, bounds: Rect): void -- **SetWorldBoundsAsync**(setComputed: bool, bounds: Rect): Task -- **ShiftAllShapes**(offsetX: double, offsetY: double): void -- **ShiftAllShapesAsync**(offsetX: double, offsetY: double): Task -- **ShiftShapes**(recordIndex: int, offsetX: double, offsetY: double): void -- **ShiftShapesAsync**(recordIndex: int, offsetX: double, offsetY: double): Task - -### [IgbShapeDataSourceModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbShapeDataSourceModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbShapeFilterRecordEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbShapeFilterRecordEventArgs) - -- **constructor**(): void -- **Record**: `IgbShapefileRecord` -- **ShouldInclude**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbShapeSeriesBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbShapeSeriesBase) -Series class for rendering polygons. - -- **constructor**(): void -- **ActualItemSearchMode**: `ShapeItemSearchMode` -- **AssigningShapeMarkerStyle**: `Action` -- **AssigningShapeMarkerStyleScript**: `string` -- **AssigningShapeStyle**: `Action` -- **AssigningShapeStyleScript**: `string` -- **FillMemberPath**: `string` — Gets or sets the fill mapping property for the current series object. -- **FillScale**: `IgbBrushScale` — Gets or sets the brush scale for the fill brush of markers. -- **FillScaleUseGlobalValues**: `bool` — Gets or sets whether or not the FillScale uses global min/max values of FillMemberPath from multiple series. This setting applies only if multiple series are using the same FillScale. -- **HighlightedShapeMemberPath**: `string` — Gets or sets the value mapping property for the current series object. -- **IsCustomShapeMarkerStyleAllowed**: `bool` — Gets or sets whether this Shape series should allow custom style overrides of its individual marker visuals. -- **IsCustomShapeStyleAllowed**: `bool` — Gets or sets whether this Shape series should allow custom style overrides of its individual visuals. -- **ItemSearchMode**: `ShapeItemSearchMode` — Gets or sets the mode the series will use to find the closest point to the cursor. -- **ItemSearchPointsThreshold**: `int` — Gets or sets the points threshold to use when searching for items using ItemSearchMode. -- **ItemSearchThreshold**: `int` — Gets or sets the threshold to use when searching for items using ItemSearchMode. -- **ShapeFilterResolution**: `double` — The resolution at which to filter out shapes in the series. For example, if the ShapeFilterResolution is set to 3, then elements with a bounding rectangle smaller than 3 X 3 pixels will be filtered out. -- **ShapeMemberPath**: `string` — The name of the property on ItemsSource items which, for each shape, contains a list of points to be converted to a polygon. -- **StyleShape**: `Action` -- **StyleShapeScript**: `string` -- **Type**: `string` -- **XAxis**: `IgbNumericXAxis` — Gets or sets the effective x-axis for the current ScatterBase object. -- **XAxisName**: `string` — Gets or sets the name to use to resolve xAxis from markup. -- **XAxisScript**: `string` — Provides a means of setting XAxis in the JavaScript environment. -- **YAxis**: `IgbNumericYAxis` — Gets or sets the effective y-axis for the current ScatterBase object. -- **YAxisName**: `string` — Gets or sets the name to use to resolve yAxis from markup. -- **YAxisScript**: `string` — Provides a means of setting YAxis in the JavaScript environment. -- **BindAxes**(Axes: IgbAxis[]): void -- **CanUseAsXAxis**(axis: object): bool -- **CanUseAsXAxisAsync**(axis: object): Task — Determine if object can be used as XAxis -- **CanUseAsYAxis**(axis: object): bool -- **CanUseAsYAxisAsync**(axis: object): Task — Determine if object can be used as YAxis -- **FindByName**(name: string): object -- **GetExactItemIndex**(world: Point): double -- **GetExactItemIndexAsync**(world: Point): Task — Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex. -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task - -### [IgbShapefileRecord](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbShapefileRecord) -Represents a record of data from a Shapefile (.shp and .dbf). - -- **constructor**(): void -- **Bounds**: `Rect` — Gets the bounds for the shapes -- **FieldValues**: `object` -- **FieldValuesScript**: `string` — Provides a means of setting FieldValues in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **GetFieldValue**(fieldName: string): object -- **GetFieldValueAsync**(fieldName: string): Task -- **SetFieldValue**(fieldName: string, value: object): void -- **SetFieldValueAsync**(fieldName: string, value: object): Task - -### [IgbSize](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSize) - -- **constructor**(): void -- **Height**: `double` — Gets or sets the vertical component of Size -- **Type**: `string` -- **Width**: `double` — Gets or sets the horizontal component of Size -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbSizeScale](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSizeScale) -Represents a scale that is used determine an object's size. - -- **constructor**(): void -- **GlobalMaximum**: `double` — Gets or sets global maximum value that will be mapped to MaxumumValue of this scale -- **GlobalMinimum**: `double` — Gets or sets global minimum value that will be mapped to MinumumValue of this scale -- **IsLogarithmic**: `bool` — Gets or sets whether the scale is logarithmic. -- **LogarithmBase**: `int` — Gets or sets the logarithm base for this scale. -- **MaximumValue**: `double` — Gets or sets the maximum size (in pixels) for this scale. -- **MinimumValue**: `double` — Gets or sets the minimum size (in pixels) for this scale. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentGlobalMaximum**(): double -- **GetCurrentGlobalMaximumAsync**(): Task -- **GetCurrentGlobalMinimum**(): double -- **GetCurrentGlobalMinimumAsync**(): Task - -### [IgbSizeScaleModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSizeScaleModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSliceClickEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSliceClickEventArgs) -Contains PieChart click event data. - -- **constructor**(): void -- **Bounds**: `Rect` — Gets the bounds of the slice. -- **DataContext**: `object` — Gets the slice data context. -- **DataContextScript**: `string` — Provides a means of setting DataContext in the JavaScript environment. -- **EndAngle**: `double` — Gets the end angle of the slice. -- **Fill**: `string` — Gets the fill color of the slice. -- **Index**: `int` — Gets the index of the slice that was clicked. -- **IsExploded**: `bool` — Gets or sets whether the slice is exploded. -- **IsOthersSlice**: `bool` — Gets whether the current slice is part of the others slice. -- **IsSelected**: `bool` — Gets or sets whether the slice is selected. -- **Origin**: `Point` — Gets the origin location of the slice. -- **OriginalEvent**: `object` — Holds a reference to the original event that triggered slice click. -- **OriginalEventScript**: `string` — Provides a means of setting OriginalEvent in the JavaScript environment. -- **Outline**: `string` — Gets the outline color of the slice. -- **Radius**: `double` — Gets the radius of the slice. -- **StartAngle**: `double` — Gets the start angle of the slice. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSliceEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSliceEventArgs) -Contains PieChart click event data. - -- **constructor**(): void -- **Bounds**: `Rect` — Gets the bounds of the slice. -- **DataContext**: `object` — Gets the slice data context. -- **DataContextScript**: `string` — Provides a means of setting DataContext in the JavaScript environment. -- **EndAngle**: `double` — Gets the end angle of the slice. -- **Fill**: `string` — Gets the fill color of the slice. -- **Index**: `int` — Gets the index of the slice that was clicked. -- **IsExploded**: `bool` — Gets or sets whether the slice is exploded. -- **IsOthersSlice**: `bool` — Gets whether the current slice is part of the others slice. -- **IsSelected**: `bool` — Gets or sets whether the slice is selected. -- **Origin**: `Point` — Gets the origin location of the slice. -- **OriginalEvent**: `object` — Holds a reference to the original event that triggered slice click. -- **OriginalEventScript**: `string` — Provides a means of setting OriginalEvent in the JavaScript environment. -- **Outline**: `string` — Gets the outline color of the slice. -- **Position**: `Point` — Gets the position of the mouse relative to the pie chart. -- **Radius**: `double` — Gets the radius of the slice. -- **StartAngle**: `double` — Gets the start angle of the slice. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSlider](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSlider) -A slider component used to select numeric value within a range. - -- **constructor**(): void -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DirectRenderElementName**: `string` -- **Input**: `EventCallback` -- **InputScript**: `string` -- **Invalid**: `bool` — Control the validity of the control. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `double` — The current value of the component. -- **ValueChanged**: `EventCallback` -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task — Checks for validity of the control and emits the invalid event if it invalid. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): double -- **GetCurrentValueAsync**(): Task -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task — Checks for validity of the control and shows the browser message if it invalid. -- **ResolveDisplay**(): string -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task — Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid. -- **StepDown**(stepDecrement: double): void -- **StepDownAsync**(stepDecrement: double): Task — Decrements the value of the slider by stepDecrement * step, where stepDecrement defaults to 1. stepDecrement Optional step decrement. If no parameter is passed, it defaults to 1. -- **StepUp**(stepIncrement: double): void -- **StepUpAsync**(stepIncrement: double): Task — Increments the value of the slider by stepIncrement * step, where stepIncrement defaults to 1. stepIncrement Optional step increment. If no parameter is passed, it defaults to 1. - -### [IgbSliderBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSliderBase) - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — Disables the UI interactions of the slider. -- **DiscreteTrack**: `bool` — Marks the slider track as discrete so it displays the steps. If the step is 0, the slider will remain continuos even if discreteTrack is true. -- **HidePrimaryLabels**: `bool` — Hides the primary tick labels. -- **HideSecondaryLabels**: `bool` — Hides the secondary tick labels. -- **HideTooltip**: `bool` — Hides the thumb tooltip. -- **Locale**: `string` — The locale used to format the thumb and tick label values in the slider. -- **LowerBound**: `double` — The lower bound of the slider value. If not set, the min value is applied. -- **Max**: `double` — The maximum value of the slider scale. Defaults to 100. If max is less than min the call is a no-op. If labels are provided (projected), then max is always set to the number of labels. If upperBound ends up being greater than than the current max value, it is automatically assigned the new max value. -- **Min**: `double` — The minimum value of the slider scale. Defaults to 0. If min is greater than max the call is a no-op. If labels are provided (projected), then min is always set to 0. If lowerBound ends up being less than than the current min value, it is automatically assigned the new min value. -- **PrimaryTicks**: `double` — The number of primary ticks. It defaults to 0 which means no primary ticks are displayed. -- **SecondaryTicks**: `double` — The number of secondary ticks. It defaults to 0 which means no secondary ticks are displayed. -- **Step**: `double` — Specifies the granularity that the value must adhere to. If set to 0 no stepping is implied and any value in the range is allowed. If labels are provided (projected) then the step is always assumed to be 1 since it is a discrete slider. -- **SupportsVisualChildren**: `bool` -- **TickLabelRotation**: `SliderTickLabelRotation` — The degrees for the rotation of the tick labels. Defaults to 0. -- **TickOrientation**: `SliderTickOrientation` — Changes the orientation of the ticks. -- **Type**: `string` -- **UpperBound**: `double` — The upper bound of the slider value. If not set, the max value is applied. -- **UseDirectRender**: `bool` -- **ValueFormat**: `string` — String format used for the thumb and tick label values in the slider. -- **ValueFormatOptions**: `IgbNumberFormatSpecifier` — Number format options used for the thumb and tick label values in the slider. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbSliderBaseModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSliderBaseModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSliderLabel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSliderLabel) -Allows formatting the values of the slider as string values. The text content of the slider labels is used for thumb and tick labels. When slider labels are provided, the min, max and step properties are automatically calculated so that they do not allow values that do not map to the provided labels. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbSliderLabelModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSliderLabelModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSliderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSliderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSlowStochasticOscillatorIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSlowStochasticOscillatorIndicator) -Represents a IgbDataChart Slow Stochastic Oscillator indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current SlowStochasticOscillatorIndicator object. The typical, and initial, value for SlowStochasticOscillatorIndicator periods is 14. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbSlowStochasticOscillatorIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSlowStochasticOscillatorIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSnackbar](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSnackbar) -A snackbar component is used to provide feedback about an operation by showing a brief message at the bottom of the screen. - -- **constructor**(): void -- **Action**: `EventCallback` -- **ActionScript**: `string` -- **ActionText**: `string` — The snackbar action button. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbSnackbarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSnackbarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSortIndicatorRenderCompletedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSortIndicatorRenderCompletedEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSortingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSortingEventArgs) -Represents event arguments related to sorting and grouping operations The event is cancelable - -- **constructor**(): void -- **Detail**: `IgbSortingEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSortingEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSortingEventArgsDetail) -Represents event arguments related to sorting and grouping operations The event is cancelable - -- **constructor**(): void -- **Cancel**: `bool` — Provides the ability to cancel the event. -- **GroupingExpressions**: `IgbGroupingExpression[]` — Optional Represents the grouping expressions applied to the grid. It can be a single grouping expression or an array of them The expression contains information like the sorting expression and criteria by which the elements will be grouped -- **Owner**: `object` — Provides reference to the owner component. -- **SortingExpressions**: `IgbSortingExpression[]` — Optional Represents the sorting expressions applied to the grid. It can be a single sorting expression or an array of them The expression contains information like file name, whether the letter case should be taken into account, etc. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSortingExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSortingExpression) - -- **constructor**(): void -- **Dir**: `SortingDirection` -- **FieldName**: `string` -- **IgnoreCase**: `bool` -- **Strategy**: `IgbSortingStrategy` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSortingExpressionEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSortingExpressionEventArgs) - -- **constructor**(): void -- **Detail**: `IgbSortingExpression[]` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSortingOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSortingOptions) - -- **constructor**(): void -- **Mode**: `SortingOptionsMode` -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbSortingStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSortingStrategy) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbSparkline](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSparkline) -Represents a sparkline chart. - -- **constructor**(): void -- **ActualHorizontalLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ActualPixelScalingRatio**: `double` — Gets the actual scaling value used by the component to affect the pixel density of the control. -- **ActualVerticalLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **Brush**: `string` — Gets or sets the sparkline brush. -- **ContentHorizontalLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ContentVerticalLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **DataSource**: `object` — Gets or sets the ItemsSource of the sparkline. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DisplayNormalRangeInFront**: `bool` — Gets or sets the position of the normal range on the sparkline. -- **DisplayType**: `SparklineDisplayType` — Gets or sets the display type of the sparkline. -- **FirstMarkerBrush**: `string` — Gets or sets the first marker brush of the sparkline. -- **FirstMarkerSize**: `double` — Gets or sets the first marker size of the sparkline. -- **FirstMarkerVisibility**: `Visibility` — Gets or sets the first marker visibility of the sparkline. -- **FormatLabel**: `string` — Sets or gets a function which takes an object that produces a formatted label for displaying in the chart. -- **FormatLabelScript**: `string` — Provides a means of setting FormatLabel in the JavaScript environment. -- **HighMarkerBrush**: `string` — Gets or sets the high marker brush of the sparkline. -- **HighMarkerSize**: `double` — Gets or sets the high marker size of the sparkline. -- **HighMarkerVisibility**: `Visibility` — Gets or sets the high marker visibility of the sparkline. -- **HorizontalAxisBrush**: `string` — Gets or sets the horizontal axis line brush of the sparkline. -- **HorizontalAxisLabel**: `object` — The value or content to display on the horizontal axis. -- **HorizontalAxisLabelScript**: `string` — Provides a means of setting HorizontalAxisLabel in the JavaScript environment. -- **HorizontalAxisVisibility**: `Visibility` — Gets or sets the display state of the horizontal axis. -- **HorizontalLabelFormat**: `string` — Gets or sets the label composite format used when creating label values. -- **HorizontalLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the HorizontalLabelFormat string. -- **LabelMemberPath**: `string` — String identifier of a column or property name to get labels from on each item in the data source. These labels will be retrieved from the first and last item, and displayed by the horizontal axis. -- **LastMarkerBrush**: `string` — Gets or sets the last marker brush of the sparkline. -- **LastMarkerSize**: `double` — Gets or sets the last marker size of the sparkline. -- **LastMarkerVisibility**: `Visibility` — Gets or sets the last marker visibility of the sparkline. -- **LineThickness**: `double` — Gets or sets the line thickness of the sparkline. -- **LowMarkerBrush**: `string` — Gets or sets the low marker brush of the sparkline. -- **LowMarkerSize**: `double` — Gets or sets the low marker size of the sparkline. -- **LowMarkerVisibility**: `Visibility` — Gets or sets the low marker visibility of the sparkline. -- **MarkerBrush**: `string` — Gets or sets the marker brush of the sparkline. -- **MarkerSize**: `double` — Gets or sets the marker size of the sparkline. -- **MarkerVisibility**: `Visibility` — Gets or sets the marker visibility of the sparkline. -- **Maximum**: `double` — Gets or sets the maximum value of the y axis. -- **Minimum**: `double` — Gets or sets the minimum value of the y axis. -- **NegativeBrush**: `string` — Gets or sets the negative brush of the sparkline. -- **NegativeMarkerBrush**: `string` — Gets or sets the negative marker brush of the sparkline. -- **NegativeMarkerSize**: `double` — Gets or sets the negative marker size of the sparkline. -- **NegativeMarkerVisibility**: `Visibility` — Gets or sets the negative marker visibility of the sparkline. -- **NormalRangeFill**: `string` — Gets or sets the normal range brush of the sparkline. -- **NormalRangeMaximum**: `double` — Gets or sets the maximum value of the normal range. -- **NormalRangeMinimum**: `double` — Gets or sets the minimum value of the normal range. -- **NormalRangeVisibility**: `Visibility` — Gets or sets the normal range visibility of the sparkline. -- **ParentTypeName**: `string` -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **TrendLineBrush**: `string` — Gets or sets the trendline brush of the sparkline. -- **TrendLinePeriod**: `int` — Gets or sets the trendline period used by the sparkline. -- **TrendLineThickness**: `double` — Gets or sets the thickness of the sparkline's trendline. -- **TrendLineType**: `TrendLineType` — Gets or sets the type of trendline used by the sparkline. -- **Type**: `string` -- **UnknownValuePlotting**: `UnknownValuePlotting` — Gets or sets the way null values are interpreted. -- **ValueMemberPath**: `string` — Gets or sets the string path to the value column. -- **VerticalAxisBrush**: `string` — Gets or sets the vertical axis line brush of the sparkline. -- **VerticalAxisLabel**: `object` — The value or content to display on the vertical axis. -- **VerticalAxisLabelScript**: `string` — Provides a means of setting VerticalAxisLabel in the JavaScript environment. -- **VerticalAxisVisibility**: `Visibility` — Gets or sets the display state of the vertical axis. -- **VerticalLabelFormat**: `string` — Gets or sets the label composite format used when creating label values. -- **VerticalLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the VerticalLabelFormat string. -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Returns visuals as a serialized string. -- **FindByName**(name: string): object -- **NotifyClearItems**(source_: object): void -- **NotifyClearItemsAsync**(source_: object): Task — Used to manually notify the IgbSparkline that the data source has reset or cleared its items. Invoking this method is only necessary if that datasource is not observable. -- **NotifyInsertItem**(source_: object, index: int, newItem: object): void -- **NotifyInsertItemAsync**(source_: object, index: int, newItem: object): Task -- **NotifyRemoveItem**(source_: object, index: int, oldItem: object): void -- **NotifyRemoveItemAsync**(source_: object, index: int, oldItem: object): Task -- **NotifyResized**(): void -- **NotifyResizedAsync**(): Task — Notify that the control has resized. -- **NotifySetItem**(source_: object, index: int, oldItem: object, newItem: object): void -- **NotifySetItemAsync**(source_: object, index: int, oldItem: object, newItem: object): Task -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task — Provides a container to the sparkline control. - -### [IgbSparklineCoreModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSparklineCoreModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSparklineModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSparklineModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSplineAreaFragment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSplineAreaFragment) -Represents one part of a StackedSplineAreaSeries. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbSplineAreaFragmentModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSplineAreaFragmentModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSplineAreaSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSplineAreaSeries) -Represents a IgbDataChart spline area series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbSplineAreaSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSplineAreaSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSplineFragment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSplineFragment) -Represents one part of a StackedSplineSeries. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbSplineFragmentBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSplineFragmentBase) -Represents one part in a StackedSplineSeries or StackedSplineAreaSeries. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task - -### [IgbSplineFragmentModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSplineFragmentModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSplineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSplineSeries) -Represents a IgbDataChart spline series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbSplineSeriesBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSplineSeriesBase) -Represents the base class for all IgbDataChart spline series. - -- **constructor**(): void -- **IsSplineShapePartOfRange**: `bool` — Gets or sets whether to include the spline shape in the axis range requested of the axis. -- **SplineType**: `SplineType` — Gets or sets the type of spline to be rendered. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbSplineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSplineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSplitPane](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSplitPane) - -- **constructor**(): void -- **AllowEmpty**: `bool` — Determines whether the pane should present in the UI when empty. -- **FloatingHeight**: `double` — The absolute height of the pane. Applies only for floating panes. Defaults to 100. -- **FloatingLocation**: `IgbDockManagerPoint` — The absolute location point of the pane. Applies only for floating panes. -- **FloatingResizable**: `bool` — Determines whether floating pane resizing is allowed. Applies only for floating panes. -- **FloatingWidth**: `double` — The absolute width of the pane. Applies only for floating panes. Defaults to 100. -- **Id**: `string` — The id of the pane. If not set the Dock Manager generates it automatically. -- **IsMaximized**: `bool` — Determines whether a split pane is maximized or not. Defaults to false. -- **Orientation**: `SplitPaneOrientation` — The orientation of the split pane. -- **PaneType**: `DockManagerPaneType` — The type of the pane. -- **Panes**: `IgbDockManagerPaneCollection` — The child panes of the split pane. -- **Size**: `double` — The size of the pane relative to its sibling panes' sizes. Defaults to 100. -- **Type**: `string` -- **UseFixedSize**: `bool` — Determines whether child panes are sized in pixels (instead of relatively to their siblings) and can be resized beyond the viewport, allowing scrollable overflow within the container. Defaults to false. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void -- **WithPanes**(panes: IgbDockManagerPane[]): IgbSplitPane - -### [IgbSplitPaneCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSplitPaneCollection) - -- **constructor**(): void -- **constructor**(parent: object, propertyName: string): void - -### [IgbSplitPaneModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSplitPaneModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSplitterResizeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSplitterResizeEventArgs) - -- **constructor**(): void -- **Orientation**: `SplitPaneOrientation` — Gets the pane's orientation. -- **Pane**: `IgbDockManagerPane` — Gets the pane being resized with the splitter. -- **PaneHeight**: `double` — Gets the pane's height. -- **PaneWidth**: `double` — Gets the pane's width. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbStacked100AreaSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStacked100AreaSeries) -Represents a stacked area series, where values are presented as percentages of the total. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbStacked100AreaSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStacked100AreaSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStacked100BarSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStacked100BarSeries) -Represents a IgbDataChart stacked100 bar series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbStacked100BarSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStacked100BarSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStacked100ColumnSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStacked100ColumnSeries) -Represents a IgbDataChart stacked100 column series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbStacked100ColumnSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStacked100ColumnSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStacked100LineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStacked100LineSeries) -Represents a IgbDataChart stacked100 line series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbStacked100LineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStacked100LineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStacked100SplineAreaSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStacked100SplineAreaSeries) -Represents a IgbDataChart stacked100 spline area series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbStacked100SplineAreaSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStacked100SplineAreaSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStacked100SplineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStacked100SplineSeries) -Represents a IgbDataChart stacked100 spline series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbStacked100SplineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStacked100SplineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStackedAreaSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedAreaSeries) -Represents a IgbDataChart stacked area series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbStackedAreaSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedAreaSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStackedBarSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedBarSeries) -Represents a IgbDataChart stacked bar series. - -- **constructor**(): void -- **RadiusX**: `double` — Gets or sets the x-radius of the ellipse that is used to round the corners of the bar. -- **RadiusY**: `double` — Gets or sets the y-radius of the ellipse that is used to round the corners of the bar. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemIndex**(world: Point): int -- **GetItemIndexAsync**(world: Point): Task — Gets the index of the item that resides at the provided world coordinates. -- **GetItemSpan**(): double -- **GetItemSpanAsync**(): Task — For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the series to display the item for the specified data item. - -### [IgbStackedBarSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedBarSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStackedColumnSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedColumnSeries) -Represents a IgbDataChart stacked column series. - -- **constructor**(): void -- **RadiusX**: `double` — Gets or sets the x-radius of the ellipse that is used to round the corners of the column. -- **RadiusY**: `double` — Gets or sets the y-radius of the ellipse that is used to round the corners of the column. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItemSpan**(): double -- **GetItemSpanAsync**(): Task — For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. - -### [IgbStackedColumnSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedColumnSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStackedFragmentSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedFragmentSeries) -Represents a non-visual child of StackedSeriesBase. - -- **constructor**(): void -- **ActualAreaFillOpacity**: `double` — Gets the series ActualAreaFillOpacity. This property only applies for area-like series. -- **ActualBrush**: `string` — Gets the actual brush used by the series. -- **ActualDataLegendGroup**: `string` — Gets the label displayed before series value in the Data Legend. -- **ActualHighlightedValuesDataLegendGroup**: `string` — Gets the label displayed before series value in the Data Legend. -- **ActualHighlightedValuesDisplayMode**: `SeriesHighlightedValuesDisplayMode` — Gets the actual mode for displaying highlighted values. -- **ActualHighlightingFadeOpacity**: `double` — Gets the actual target opacity to fade to for fade style highlighting. -- **ActualIsDropShadowEnabled**: `bool` — Gets whether drop shadow is actually enabled for this series. -- **ActualIsSplineShapePartOfRange**: `bool` — Gets whether the spline part is considered to be part of the range -- **ActualIsTransitionInEnabled**: `bool` — Gets the the resolved value of whether transition in is enabled. -- **ActualLegendItemBadgeMode**: `LegendItemBadgeMode` — Gets the actual LegendItemBadgeMode of the series. -- **ActualLegendItemBadgeShape**: `LegendItemBadgeShape` — Gets the actual LegendItemBadgeShape of the series. -- **ActualLegendItemBadgeTemplate**: `object` — Gets the actual legend item badge template used by the series. -- **ActualLegendItemBadgeTemplateScript**: `string` — Provides a means of setting ActualLegendItemBadgeTemplate in the JavaScript environment. -- **ActualLegendItemTemplate**: `object` — Gets the actual legend item template used by the series. -- **ActualLegendItemTemplateScript**: `string` — Provides a means of setting ActualLegendItemTemplate in the JavaScript environment. -- **ActualLegendItemVisibility**: `Visibility` — Gets the actual visibility of the legend items in the series. -- **ActualLineCap**: `PenLineCap` — Gets the actual end cap used by the series. -- **ActualMarkerBrush**: `string` — Gets the actual marker brush of the series. -- **ActualMarkerFillMode**: `MarkerFillMode` — Gets whether the marker fill is based on the marker outline of the series rather than the marker brushes collection. -- **ActualMarkerFillOpacity**: `double` — Gets the actual opacity to use for hte marker fills. -- **ActualMarkerOutline**: `string` — Gets the actual marker outline of the series. -- **ActualMarkerOutlineMode**: `MarkerOutlineMode` — Gets whether the marker outline is based on the marker brush of the series rather than the marker outlines collection. -- **ActualMarkerTemplate**: `object` — Gets the actual marker template used by the series. -- **ActualMarkerTemplateScript**: `string` — Provides a means of setting ActualMarkerTemplate in the JavaScript environment. -- **ActualMarkerThickness**: `double` — Gets actual marker thickness of this stacked fragment. -- **ActualMarkerType**: `MarkerType` — Gets the actual marker type set used in the series. -- **ActualOpacity**: `double` — Gets the series opacity. -- **ActualOutline**: `string` — Gets the series outline. -- **ActualOutlineMode**: `SeriesOutlineMode` — Gets the actual outline mode to use for the fragment. -- **ActualRadiusX**: `double` — Gets the actual corner radius of the series -- **ActualRadiusY**: `double` — Gets the actual corner radius of the series -- **ActualShadowBlur**: `double` — Gets the actual shadow blur used by the series. -- **ActualShadowColor**: `string` — Gets actual the drop shadow color used by the series. -- **ActualShadowOffsetX**: `double` — Gets the actual drop shadow x-offset applied to the series. -- **ActualShadowOffsetY**: `double` — Gets the actual drop shadow y-offset applied to the series. -- **ActualThickness**: `double` — Gets or sets the thickness of this stacked fragment. -- **ActualTransitionDuration**: `int` — Gets the series transition duration. -- **ActualTransitionEasingFunction**: `string` — Gets the series transition easing function. -- **ActualTransitionEasingFunctionScript**: `string` — Provides a means of setting ActualTransitionEasingFunction in the JavaScript environment. -- **ActualTransitionInDuration**: `int` — Gets the resolved transition in duration -- **ActualTransitionInEasingFunction**: `string` — Gets the series transition easing function. -- **ActualTransitionInEasingFunctionScript**: `string` — Provides a means of setting ActualTransitionInEasingFunction in the JavaScript environment. -- **ActualTransitionInMode**: `CategoryTransitionInMode` — Gets the series transition easing function. -- **ActualTransitionInSpeedType**: `TransitionInSpeedType` — Gets the series transition easing function. -- **ActualUseSingleShadow**: `bool` — Gets whether drop shadow is actually applied to the whole StackedFragmentSeries visual or to each of the individual shapes forming the StackedFragmentSeries. -- **ActualValueMemberAsLegendLabel**: `string` — Gets the label displayed before series value in the Data Legend. -- **ActualValueMemberAsLegendUnit**: `string` — Gets the unit displayed after series value in the Data Legend. -- **ActualVisibility**: `Visibility` — Gets the actual visibility of the stacked fragment. -- **AreaFillOpacity**: `double` — Gets or sets the AreaFillOpacity of the stacked fragment. This property only applies for area-like series. -- **AssigningCategoryMarkerStyle**: `Action` -- **AssigningCategoryMarkerStyleScript**: `string` -- **AssigningCategoryStyle**: `Action` -- **AssigningCategoryStyleScript**: `string` -- **Brush**: `string` — Gets or sets the brush of the stacked fragment. -- **DashArray**: `double[]` — Gets or sets a collection of Double values that indicate the pattern of dashes and gaps that is used to outline the current series object. -- **DataLegendGroup**: `string` — Gets or sets a name used for grouping multiple fragment series in the Data Legend -- **DataSource**: `object` — Gets or sets the ItemsSource property for the current series object. Normally you will want to provide data to the parent series instead. But if you have data as individual columns, it can be assigned here. The data must be aligned and have the same number of items for each fragment. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **HighlightedDataSource**: `object` — Gets or sets the HighlightedItemsSource property for the current series object. -- **HighlightedDataSourceScript**: `string` — Provides a means of setting HighlightedDataSource in the JavaScript environment. -- **HighlightedValuesDataLegendGroup**: `string` — Gets or sets a name used for grouping highlighted series in the Data Legend -- **HighlightingFadeOpacity**: `double` — Gets or sets the target opacity to fade to for fade style highlighting. -- **IsCustomCategoryMarkerStyleAllowed**: `bool` — Gets or sets whether this category series should allow custom style overrides of its individual marker visuals. -- **IsCustomCategoryStyleAllowed**: `bool` — Gets or sets whether this category series should allow custom style overrides of its individual visuals. -- **IsDropShadowEnabled**: `bool` — Gets or sets whether drop shadow should be enabled for this series. -- **IsSplineShapePartOfRange**: `bool` — Gets or sets whether to include the spline shape in the axis range requested of the axis. -- **IsTransitionInEnabled**: `bool` — Gets or sets whether the series should transition into the plot area when a new data source is assigned. Note: Transitions are not currently supported for stacked series. -- **LegendItemBadgeMode**: `LegendItemBadgeMode` — Gets or sets the mode of legend badge representing the current series in a legend. -- **LegendItemBadgeShape**: `LegendItemBadgeShape` — Gets or sets the type of legend badge representing the current series in a legend. -- **LegendItemBadgeTemplate**: `object` — Gets or sets the LegendItemBadgeTemplate property. -- **LegendItemBadgeTemplateScript**: `string` — Provides a means of setting LegendItemBadgeTemplate in the JavaScript environment. -- **LegendItemTemplate**: `object` — Gets or sets the LegendItemTemplate property. -- **LegendItemTemplateScript**: `string` — Provides a means of setting LegendItemTemplate in the JavaScript environment. -- **LegendItemVisibility**: `Visibility` — Gets or sets the legend item visibility for the current series object. -- **LineCap**: `PenLineCap` — The style of the end points of any lines or polylines representing this series. -- **MarkerBrush**: `string` — Gets or sets the brush that specifies how the current series object's marker interiors are painted. -- **MarkerFillMode**: `MarkerFillMode` — Gets or sets whether the marker fill is based on the marker outline of the series rather than the marker brushes collection. -- **MarkerFillOpacity**: `double` — Gets or sets the opacity to use for the marker fills. -- **MarkerOutline**: `string` — Gets or sets the brush that specifies how the current series object's marker outlines are painted. -- **MarkerOutlineMode**: `MarkerOutlineMode` — Gets or sets whether the marker outline is based on the marker brush of the series rather than the marker outlines collection. -- **MarkerTemplate**: `object` — Gets or sets the MarkerTemplate for the current series object. -- **MarkerTemplateScript**: `string` — Provides a means of setting MarkerTemplate in the JavaScript environment. -- **MarkerThickness**: `double` — Gets or sets the width of the current series object's marker thickness. -- **MarkerType**: `MarkerType` — Gets or sets the marker type for the current series object. -- **Opacity**: `double` — Gets or sets the Opacity of the stacked fragment. -- **Outline**: `string` — Gets or sets the brush to use for the outline of the series. -- **OutlineMode**: `SeriesOutlineMode` — Gets or sets the outline mode to use for the fragment. -- **ParentOrLocalBrush**: `string` — Gets the resolved brush used between the local series and the parent series. -- **PropertyUpdated**: `EventCallback` -- **PropertyUpdatedScript**: `string` -- **RadiusX**: `double` — Gets or sets the x-radius of the ellipse that is used to round the corners of the column. This only applies to Bar and Column series. -- **RadiusY**: `double` — Gets or sets the y-radius of the ellipse that is used to round the corners of the column. This only applies to Bar and Column series. -- **ShadowBlur**: `double` — Gets or sets the shadow blur. -- **ShadowColor**: `string` — Gets or sets the drop shadow color. -- **ShadowOffsetX**: `double` — Gets or sets the drop shadow x-offset. -- **ShadowOffsetY**: `double` — Gets or sets the drop shadow y-offset. -- **StackedSeriesBaseParent**: `BaseRendererElement` -- **Thickness**: `double` — Gets or sets the width of the current series object's line thickness. -- **Title**: `object` — Gets or sets the Title property. -- **TransitionDuration**: `int` — Gets or sets the duration of the current series's morph. -- **TransitionEasingFunction**: `string` — Gets or sets the EasingFunction used to morph the current series. -- **TransitionEasingFunctionScript**: `string` — Provides a means of setting TransitionEasingFunction in the JavaScript environment. -- **TransitionInDuration**: `int` — Gets or sets the duration of the current series's transition in morph. -- **TransitionInEasingFunction**: `string` — Gets or sets the EasingFunction used to morph the current series during the initial transition. -- **TransitionInEasingFunctionScript**: `string` — Provides a means of setting TransitionInEasingFunction in the JavaScript environment. -- **TransitionInMode**: `CategoryTransitionInMode` — Gets or sets the method by which to animate the data into the chart when the chart data source is swapped. Note: Transitions are not currently supported for stacked series. -- **TransitionInSpeedType**: `TransitionInSpeedType` — Gets or sets the duration of the current series's transition in morph. -- **Type**: `string` -- **UseSingleShadow**: `bool` — Gets or sets whether drop shadow is applied to the whole StackedFragmentSeries visual or to each of the individual shapes forming the StackedFragmentSeries. -- **ValueMemberAsLegendLabel**: `string` — Gets or sets the label displayed before series value in the Data Legend. -- **ValueMemberAsLegendUnit**: `string` — Gets or sets the unit displayed after series value in the Data Legend. -- **ValueMemberPath**: `string` — Gets or sets the value mapping property for the current series object. -- **Visibility**: `Visibility` — Gets or sets the Visibility of the stacked fragment. -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromWorldPosition**(world: Point): Point -- **FromWorldPositionAsync**(world: Point): Task — Converts a point from world coordinates to coordinates within the viewport of the series. -- **GetEffectiveViewport**(): Rect -- **GetEffectiveViewportAsync**(): Task — Gets the effective viewport, adjusted to account for margins and other factors. -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemIndex**(world: Point): int -- **GetItemIndexAsync**(world: Point): Task — Gets the item index associated with the specified world position -- **GetItemSpan**(): double -- **GetItemSpanAsync**(): Task — For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. -- **GetNextOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetNextOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetPreviousOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetPreviousOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetSeriesHighValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesHighValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesHighValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesHighValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesLowValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesLowValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesLowValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesLowValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValueBoundingBox**(world: Point): Rect -- **GetSeriesValueBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. -- **GetSeriesValueFromSeriesPixel**(mouse: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueFromSeriesPixelAsync**(mouse: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValueMarkerBoundingBox**(world: Point): Rect -- **GetSeriesValueMarkerBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided. -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValuePositionFromSeriesPixel**(mouse: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionFromSeriesPixelAsync**(mouse: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **MoveCursorPoint**(point: Point): void -- **MoveCursorPointAsync**(point: Point): Task — Moves the cursor point to the provided world position. Some series may react to the current cursor position. -- **NotifyVisualPropertiesChanged**(): void -- **NotifyVisualPropertiesChangedAsync**(): Task — Notifies the series that a visual property has changed, requiring a visual update. -- **OnInitializedAsync**(): Task -- **ReplayTransitionIn**(): void -- **ReplayTransitionInAsync**(): Task -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Requests that the provided item should be brought into view if possible. -- **SimulateHover**(point: Point): void -- **SimulateHoverAsync**(point: Point): Task — Simulates a pointer hover over the series surface. -- **ToWorldPosition**(seriesPoint: Point): Point -- **ToWorldPositionAsync**(seriesPoint: Point): Task — Converts a point from coordinates within the series plot area to a world position within axis space. - -### [IgbStackedFragmentSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedFragmentSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStackedLineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedLineSeries) -Represents a stacked series, where the points in each series are connected with a line. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbStackedLineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedLineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStackedSeriesBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedSeriesBase) -Represents a base class for stacked series. - -- **constructor**(): void -- **ActualSeries**: `IgbStackedSeriesCollection` -- **AutoGenerateSeries**: `bool` — Gets or sets whether series should be automatically generated. Reqiures the use of GroupBy as the ItemsSource. -- **ContentSeries**: `IgbStackedSeriesCollection` -- **ParentTypeName**: `string` -- **ReverseLegendOrder**: `bool` — Gets or sets whether the order of the fragment series should be reversed in the legend. -- **Series**: `IgbStackedSeriesCollection` — Contains one or more stacked fragments. -- **SeriesCreated**: `EventCallback` -- **SeriesCreatedScript**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **NotifyIndexedPropertiesChanged**(): void -- **NotifyIndexedPropertiesChangedAsync**(): Task — Called to notify about changes to indexed-based properties, e.g. Brushes, Outlines, MarkerBrushes, MarkerOutlines and refresh series -- **ReplayTransitionIn**(): void -- **ReplayTransitionInAsync**(): Task — Replays the assigned transition in animation, if any. -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Scrolls the series to display the item for the specified data item. -- **SimulateHover**(point: Point): void -- **SimulateHoverAsync**(point: Point): Task — Simulates a pointer hover over the series surface. - -### [IgbStackedSeriesCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedSeriesCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbStackedSeriesCreatedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedSeriesCreatedEventArgs) -Provides data for IgbDataChart stacked series. - -- **constructor**(): void -- **Brush**: `string` — Gets or sets the series brush. -- **DashArray**: `double[]` — Gets or sets the series stroke dash array. -- **Index**: `int` — Gets the index of the series. -- **LegendItemBadgeTemplate**: `object` — Gets or sets the series legend item badge templae. -- **LegendItemBadgeTemplateScript**: `string` — Provides a means of setting LegendItemBadgeTemplate in the JavaScript environment. -- **LegendItemTemplate**: `object` — Gets or sets the series legend item template. -- **LegendItemTemplateScript**: `string` — Provides a means of setting LegendItemTemplate in the JavaScript environment. -- **LegendItemVisibility**: `Visibility` — Gets or sets the visibility of the series legend. -- **LineCap**: `PenLineCap` -- **MarkerBrush**: `string` — Gets or sets the series marker brush. -- **MarkerOutline**: `string` — Gets or sets the series marker outline. -- **MarkerStyle**: `IgbStyle` — Gets or sets the series marker style. -- **MarkerTemplate**: `object` — Gets or sets the series marker template. -- **MarkerTemplateScript**: `string` — Provides a means of setting MarkerTemplate in the JavaScript environment. -- **MarkerThickness**: `double` — Gets or sets the series marker thickness. -- **MarkerType**: `MarkerType` — Gets or sets the series marker type. -- **Outline**: `string` — Gets or sets the series outline brush. -- **Thickness**: `double` — Gets or sets the series outline thickness. -- **Title**: `object` — Gets or sets the series title. -- **TitleScript**: `string` — Provides a means of setting Title in the JavaScript environment. -- **TransitionDuration**: `int` — Gets or sets the animation transition duration for the series. -- **TransitionEasingFunction**: `string` — Gets or sets the animation easing function for the series. -- **TransitionEasingFunctionScript**: `string` — Provides a means of setting TransitionEasingFunction in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbStackedSplineAreaSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedSplineAreaSeries) -Represents a IgbDataChart stacked spline area series. - -- **constructor**(): void -- **IsSplineShapePartOfRange**: `bool` — Gets or sets whether to include the spline shape in the axis range requested of the axis. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbStackedSplineAreaSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedSplineAreaSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStackedSplineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedSplineSeries) -Represents a IgbDataChart stacked spline series. - -- **constructor**(): void -- **IsSplineShapePartOfRange**: `bool` — Gets or sets whether to include the spline shape in the axis range requested of the axis. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbStackedSplineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStackedSplineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStandardDeviationIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStandardDeviationIndicator) -Represents a IgbDataChart Standard Deviation indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current StandardDeviationIndicator object. The typical, and initial, value for STDEV periods is 20. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbStandardDeviationIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStandardDeviationIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStateCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStateCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbStep](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStep) -The step component is used within the igc-stepper element and it holds the content of each step. It also supports custom indicators, title and subtitle. - -- **constructor**(): void -- **Active**: `bool` — Gets/sets whether the step is activе. -- **Complete**: `bool` — Gets/sets whether the step is completed. When set to true the following separator is styled solid. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — Gets/sets whether the step is interactable. -- **Invalid**: `bool` — Gets/sets whether the step is invalid. -- **Optional**: `bool` — Gets/sets whether the step is optional. Optional steps validity does not affect the default behavior when the stepper is in linear mode i.e. if optional step is invalid the user could still move to the next step. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbStepAreaSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStepAreaSeries) -Represents a IgbDataChart step area series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbStepAreaSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStepAreaSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStepLineSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStepLineSeries) -Represents a IgbDataChart step line series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbStepLineSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStepLineSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStepModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStepModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStepper](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStepper) -IgxStepper provides a wizard-like workflow by dividing content into logical steps. The stepper component allows the user to navigate between multiple steps. It supports horizontal and vertical orientation as well as keyboard navigation and provides API methods to control the active step. - -- **constructor**(): void -- **ActiveStepChanged**: `EventCallback` -- **ActiveStepChangedScript**: `string` -- **ActiveStepChanging**: `EventCallback` -- **ActiveStepChangingScript**: `string` -- **AnimationDuration**: `double` — The animation duration in either vertical or horizontal mode. -- **ContentTop**: `bool` — Get/Set whether the content is displayed above the steps. Default value is false and the content is below the steps. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **HorizontalAnimation**: `HorizontalTransitionAnimation` — The animation type when in horizontal mode. -- **Linear**: `bool` — Get/Set whether the stepper is linear. If the stepper is in linear mode and if the active step is valid only then the user is able to move forward. -- **Orientation**: `StepperOrientation` — Gets/Sets the orientation of the stepper. Default value is horizontal. -- **StepType**: `StepperStepType` — Get/Set the type of the steps. Default value is full. -- **Steps**: `IgbStep[]` — Returns all of the stepper's steps. -- **SupportsVisualChildren**: `bool` -- **TitlePosition**: `StepperTitlePosition` — Get/Set the position of the steps title. The default value is auto. When the stepper is horizontally orientated the title is positioned below the indicator. When the stepper is horizontally orientated the title is positioned on the right side of the indicator. -- **Type**: `string` -- **UseDirectRender**: `bool` -- **VerticalAnimation**: `StepperVerticalAnimation` — The animation type when in vertical mode. -- **ConnectedCallback**(): void -- **ConnectedCallbackAsync**(): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **NavigateTo**(index: double): void -- **NavigateToAsync**(index: double): Task — Activates the step at a given index. -- **Next**(): void -- **NextAsync**(): Task — Activates the next enabled step. -- **Prev**(): void -- **PrevAsync**(): Task — Activates the previous enabled step. -- **Reset**(): void -- **ResetAsync**(): Task — Resets the stepper to its initial state i.e. activates the first step. The steps' content will not be automatically reset. -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbStepperModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStepperModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStochRSIIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStochRSIIndicator) -Represents a IgbDataChart StochRSI indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current StochRSIIndicator object. The typical, and initial, value for StochRSI periods is 14. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbStochRSIIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStochRSIIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbStockChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStockChangedEventArgs) -Represents event arguments for FDC3 MessageRecived - -- **constructor**(): void -- **AddedSymbols**: `string[]` — Gets array of added stock symbols -- **RemovedSymbols**: `string[]` — Gets array of removed stock symbols -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbStraightNumericAxisBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStraightNumericAxisBase) -Defines a set of basic methods and properties used to create a StraightNumeric axis. - -- **constructor**(): void -- **ScaleMode**: `NumericScaleMode` — Gets or sets the axis scale mode. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbStrategyBasedIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStrategyBasedIndicator) -A base class for indicator series with simple calculations that separates the calculation responsibility from the other responsibilities of the financial series, this enables easier unit testing and decoupling of individual calculation strategies. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStyle) -A class that exposes style realted properties. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbStyleSelector](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStyleSelector) -Base class for selecting styles for DependencyObjects based on their associated data items. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbStyleShapeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbStyleShapeEventArgs) - -- **constructor**(): void -- **Item**: `object` -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **ShapeFill**: `string` — Gets or sets the fill brush. -- **ShapeOpacity**: `double` — Gets or sets the opacity. -- **ShapeStroke**: `string` — Gets or sets the stroke brush. -- **ShapeStrokeThickness**: `double` — Gets or sets the stroke thickness. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSubDomainsCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSubDomainsCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbSummaryCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSummaryCellInfo) -Backing information for a section header cell in the grid. - -- **constructor**(): void -- **ResolvedSummaryLabel**: `string` — Sets or gets the resolved summary label for the summary cell. -- **ResolvedSummaryValue**: `string` — Sets or gets the resolved summary value for the sumamry cell. -- **SummaryLabelFontFamily**: `string` -- **SummaryLabelFontSize**: `double` -- **SummaryLabelFontStyle**: `string` -- **SummaryLabelFontWeight**: `string` -- **SummaryLabelTextColor**: `string` — Gets or sets the color of the text for the summary label in the cell. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSummaryChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSummaryChangedEventArgs) -Event args for the SummaryChanged event. - -- **constructor**(): void -- **ID**: `string` — Gets the unique ID for the changed summary. -- **IsEnabled**: `bool` — Gets the current state of the changed summary. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSummaryChooserModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSummaryChooserModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSummaryData](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSummaryData) -Object used to store summary information for group headers. - -- **constructor**(): void -- **FormattedText**: `string` -- **FormattedValue**: `string` -- **SummaryName**: `string` -- **SummaryOperand**: `DataSourceSummaryOperand` -- **SummaryValue**: `object` -- **SummaryValueScript**: `string` — Provides a means of setting SummaryValue in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbSummaryExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSummaryExpression) - -- **constructor**(): void -- **FieldName**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSummaryResult](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSummaryResult) - -- **constructor**(): void -- **DefaultFormatting**: `bool` — Apply default formatting based on the grid column type. const result: IgxSummaryResult = { key: 'key', label: 'label', defaultFormatting: true } IgxSummaryResult -- **Key**: `string` -- **Label**: `string` -- **Result**: `object` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSummaryRow](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSummaryRow) - -- **constructor**(): void -- **ActualSelectedBackground**: `string` — Gets the actual background color for summary cells when selected. -- **ActualSummaryLabelTextColor**: `string` — Gets the actual text color for the summary labels. -- **PaddingBottom**: `int` — Gets or sets the amount of bottom padding to use for the cell content of this column. -- **PaddingLeft**: `int` — Gets or sets the amount of left padding to use for the cell content for this column. -- **PaddingRight**: `int` — Gets or sets the amount of right padding to use for the cell content of this column. -- **PaddingTop**: `int` — Gets or sets the amount of top padding to use for the cell content for this column. -- **SelectedBackground**: `string` — Gets or sets the background color for summary cells when selected. -- **SummaryLabelFontFamily**: `string` -- **SummaryLabelFontSize**: `double` -- **SummaryLabelFontStyle**: `string` -- **SummaryLabelFontWeight**: `string` -- **SummaryLabelTextColor**: `string` — Gets or sets the text color for the summary labels. -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbSummaryRowRoot](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSummaryRowRoot) - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbSummaryRowRootModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSummaryRowRootModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSummaryRowSection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSummaryRowSection) - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbSummaryRowSectionModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSummaryRowSectionModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbSummaryTemplateContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSummaryTemplateContext) - -- **constructor**(): void -- **Implicit**: `IgbSummaryResult[]` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbSwitch](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSwitch) -Similar to a checkbox, a switch controls the state of a single setting on or off. - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbSwitchModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbSwitchModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTRIXIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTRIXIndicator) -Represents a IgbDataChart TRIX indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current TRIXIndicator object. The typical, and initial, value for TRIX periods is 15. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbTRIXIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTRIXIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTab](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTab) -A tab element slotted into an igc-tabs container. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — Determines whether the tab is disabled. -- **Label**: `string` — The tab item label. -- **Selected**: `bool` — Determines whether the tab is selected. -- **SelectedChanged**: `EventCallback` -- **SupportsVisualChildren**: `bool` -- **TabsParent**: `BaseRendererControl` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbTabComponentEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTabComponentEventArgs) - -- **constructor**(): void -- **Detail**: `IgbTab` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTabGroupPane](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTabGroupPane) - -- **constructor**(): void -- **AllowEmpty**: `bool` — Determines whether the pane should present in the UI when empty. -- **Id**: `string` — The id of the pane. If not set the Dock Manager generates it automatically. -- **IsMaximized**: `bool` — Determines whether a tab group is maximized or not. Defaults to false. -- **PaneType**: `DockManagerPaneType` — The type of the pane. -- **Panes**: `IgbContentPaneCollection` — The child content panes of the tab group. -- **SelectedIndex**: `double` — The index of the selected tab. -- **Size**: `double` — The size of the pane relative to its sibling panes' sizes. Defaults to 100. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void -- **WithPanes**(panes: IgbContentPane[]): IgbTabGroupPane - -### [IgbTabGroupPaneModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTabGroupPaneModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTabHeaderConnectionEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTabHeaderConnectionEventArgs) - -- **constructor**(): void -- **Detail**: `IgbTabHeaderConnectionEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTabHeaderConnectionEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTabHeaderConnectionEventArgsDetail) - -- **constructor**(): void -- **Element**: `IgbTabHeaderElement` — The tab header element that is being connected/disconnected. -- **Pane**: `IgbContentPane` — The pane whose tab header is being connected/disconnected. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTabHeaderElement](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTabHeaderElement) -Describes a tab header element. - -- **constructor**(): void -- **DragService**: `IgbDragService` — Gets/sets the drag service. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTabHeaderElementModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTabHeaderElementModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTabModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTabModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTabs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTabs) - -- **constructor**(): void -- **Activation**: `TabsActivation` — Determines the tab activation. When set to auto, the tab is instantly selected while navigating with the Left/Right Arrows, Home or End keys and the corresponding panel is displayed. When set to manual, the tab is only focused. The selection happens after pressing Space or Enter. -- **ActualTabsCollection**: `IgbTabs_TabCollection` -- **Alignment**: `TabsAlignment` — Sets the alignment for the tab headers -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **ContentTabsCollection**: `IgbTabs_TabCollection` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **ParentTypeName**: `string` -- **SupportsVisualChildren**: `bool` -- **TabsCollection**: `IgbTabs_TabCollection` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetSelected**(): string -- **GetSelectedAsync**(): Task -- **ResolveDisplay**(): string -- **Select**(id: string): void -- **SelectAsync**(id: string): Task — Selects the specified tab and displays the corresponding panel. -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbTabsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTabsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTabs_TabCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTabs_TabCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbTemplateCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTemplateCellInfo) -Represents backing information for a template cell. - -- **constructor**(): void -- **Type**: `string` -- **Value**: `object` — Sets or gets the value to provide to the template. -- **ValueScript**: `string` — Provides a means of setting Value in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTemplateCellUpdatingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTemplateCellUpdatingEventArgs) -Information about the cell that has content which is being created or updated. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTemplateColumn](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTemplateColumn) -A column with customizable content. - -- **constructor**(): void -- **CellUpdating**: `Action` -- **CellUpdatingScript**: `string` -- **ParentTypeName**: `string` -- **Template**: `RenderFragment` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTemplateColumnModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTemplateColumnModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTemplateContent](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTemplateContent) - -- **constructor**(): void -- **Context**: `T` -- **Template**: `RenderFragment` -- **BuildRenderTree**(__builder: RenderTreeBuilder): void -- **Update**(): void - -### [IgbTemplateHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTemplateHeader) -A type of header with customizable content. - -- **constructor**(): void -- **CellUpdating**: `Action` -- **CellUpdatingScript**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTemplateHeaderCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTemplateHeaderCellInfo) -Backing information for the template header cells. - -- **constructor**(): void -- **IsFilterUIVisible**: `bool` — Sets or gets whether the filter UI should be visible in the header. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTemplateHeaderCellUpdatingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTemplateHeaderCellUpdatingEventArgs) -Information about the header cell that has content which is being created or updated. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTemplateHeaderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTemplateHeaderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTemplateSectionHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTemplateSectionHeader) -Used to configure the appearance of the section header cells. - -- **constructor**(): void -- **CellUpdating**: `Action` -- **CellUpdatingScript**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbTemplateSectionHeaderCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTemplateSectionHeaderCellInfo) -Backing information for a template section header cell in the grid. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTemplateSectionHeaderCellUpdatingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTemplateSectionHeaderCellUpdatingEventArgs) -Information about the cell that has content which is being created or updated. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTemplateSectionHeaderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTemplateSectionHeaderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTextCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTextCellInfo) -Backing information for a text cell in the grid. - -- **constructor**(): void -- **TextValue**: `string` — Sets or gets the text value for the cell. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTextColumn](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTextColumn) -Represents a Text grid column, used to allow the developer to display a formatted text in a cell. - -- **constructor**(): void -- **ActualEditorDataSource**: `IgbBaseDataSource` -- **EditorDataSource**: `object` — Gets or sets the ComboBox data source. -- **EditorDataSourceScript**: `string` — Provides a means of setting EditorDataSource in the JavaScript environment. -- **EditorTextField**: `string` — Gets or sets the ComboBox text field. -- **EditorType**: `EditorType` — Gets or sets the editor type used for editing cells in this column. -- **EditorValueField**: `string` — Gets or sets the ComboBox value field. -- **ParentTypeName**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTextColumnModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTextColumnModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTextHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTextHeader) -Represents a class used to configure the appearance of a text column header cells. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTextHeaderCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTextHeaderCellInfo) -Backing information for a text header cell. - -- **constructor**(): void -- **ColumnOptionsAccentColor**: `string` -- **ColumnOptionsBackground**: `string` — Gets or sets the column options dropdown background color. -- **ColumnOptionsGroupHeaderBackground**: `string` — Gets or sets the background color for group headers inside the column options menu. -- **ColumnOptionsGroupHeaderTextColor**: `string` — Gets or sets the text color for group headers inside the column options menu. -- **ColumnOptionsIconAlignment**: `ColumnOptionsIconAlignment` — Gets or sets the alignment of the column options icon within the header cell. -- **ColumnOptionsIconBehavior**: `ColumnOptionsIconBehavior` — Gets or sets how the column option icon will behave in the header. -- **ColumnOptionsIconColor**: `string` — Gets or sets the color for the column options icon in the header. -- **ColumnOptionsSeparatorColor**: `string` — Gets or sets the color of separators inside the column options menu. -- **ColumnOptionsTextColor**: `string` — Gets or sets the text color for text inside the column options menu. -- **ColumnOptionsTheme**: `BaseControlTheme` — Gets or sets the column options theme. -- **IsColumnOptionsEnabled**: `bool` — Sets or gets whether the filter UI should be visible in the header. -- **SortIndicatorStyle**: `SortIndicatorStyle` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTextHeaderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTextHeaderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTextIconSetConditionalStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTextIconSetConditionalStyle) - -- **constructor**(): void -- **IconType**: `TextIconSetBuiltInTypes` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetSubStyles**(): IgbGridConditionalStyleCollection -- **GetSubStylesAsync**(): Task - -### [IgbTextIconSetConditionalStyleModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTextIconSetConditionalStyleModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTextarea](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTextarea) -This element represents a multi-line plain-text editing control, useful when you want to allow users to enter a sizeable amount of free-form text, for example a comment on a review or feedback form. - -- **constructor**(): void -- **Autocapitalize**: `string` — Controls whether and how text input is automatically capitalized as it is entered/edited by the user. MDN documentation. -- **Autocomplete**: `string` — Specifies what if any permission the browser has to provide for automated assistance in filling out form field values, as well as guidance to the browser as to the type of information expected in the field. Refer to this page for additional information. -- **Blur**: `EventCallback` -- **BlurScript**: `string` -- **Change**: `EventCallback` -- **ChangeScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — The disabled state of the component -- **Focus**: `EventCallback` -- **FocusScript**: `string` -- **Input**: `EventCallback` -- **InputMode**: `string` — Hints at the type of data that might be entered by the user while editing the element or its contents. This allows a browser to display an appropriate virtual keyboard. MDN documentation -- **InputScript**: `string` -- **Invalid**: `bool` — Control the validity of the control. -- **Label**: `string` — The label for the control. -- **MaxLength**: `double` — The maximum number of characters (UTF-16 code units) that the user can enter. If this value isn't specified, the user can enter an unlimited number of characters. -- **MinLength**: `double` — The minimum number of characters (UTF-16 code units) required that the user should enter. -- **Outlined**: `bool` — Whether the control will have outlined appearance. -- **Placeholder**: `string` — The placeholder attribute of the control. -- **ReadOnly**: `bool` — Makes the control a readonly field. -- **Required**: `bool` — Makes the control a required field in a form context. -- **Resize**: `TextareaResize` — Controls whether the control can be resized. When auto is set, the control will try to expand and fit its content. -- **Rows**: `double` — The number of visible text lines for the control. If it is specified, it must be a positive integer. If it is not specified, the default value is 3. -- **Spellcheck**: `bool` — Controls whether the element may be checked for spelling errors. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ValidateOnly**: `bool` — Enables validation rules to be evaluated without restricting user input. This applies to the maxLength property when it is defined. -- **Value**: `string` — The value of the component -- **ValueChanged**: `EventCallback` -- **Wrap**: `TextareaWrap` — Indicates how the control should wrap the value for form submission. Refer to this page on MDN for explanation of the available values. -- **CheckValidity**(): void -- **CheckValidityAsync**(): Task — Checks for validity of the control and emits the invalid event if it invalid. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetCurrentValue**(): string -- **GetCurrentValueAsync**(): Task -- **ReportValidity**(): void -- **ReportValidityAsync**(): Task — Checks for validity of the control and shows the browser message if it invalid. -- **ResolveDisplay**(): string -- **Select**(): void -- **SelectAsync**(): Task — Selects all text within the control. -- **SetCustomValidity**(message: string): void -- **SetCustomValidityAsync**(message: string): Task — Sets a custom validation message for the control. As long as message is not empty, the control is considered invalid. -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbTextareaModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTextareaModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbThemeProvider](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbThemeProvider) -A theme provider component that uses Lit context to provide theme information to descendant components. This component allows you to scope a theme to a specific part of the page. All library components within this provider will use the specified theme instead of the global theme. When using the theme provider, it must be registered before any descendant components that will consume the theme context. This ensures the context provider is available when descendant components attempt to consume it. import { defineComponents, IgcThemeProviderComponent, IgcButtonComponent } from 'igniteui-webcomponents'; // Register theme provider first, then descendant components defineComponents(IgcThemeProviderComponent, IgcButtonComponent); Material Dark Button Fluent Light Button - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Theme**: `Theme` — The theme to provide to descendant components. 'bootstrap' -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Variant**: `ThemeVariant` — The theme variant to provide to descendant components. 'light' -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbThemeProviderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbThemeProviderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbThisMonthExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbThisMonthExpression) -Requests an expression for the ThisMonth filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbThisQuarterExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbThisQuarterExpression) -Represents an expression for the ThisQuarter filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbThisWeekExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbThisWeekExpression) -Requests an expression for the ThisWeek filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbThisYearExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbThisYearExpression) -Requests an expression for the ThisYear filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTile](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTile) -The tile component is used within the igc-tile-manager as a container for displaying various types of information. - -- **constructor**(): void -- **ColSpan**: `double` — The number of columns the tile will span. When setting a value that is less than 1, it will be coerced to 1. 1 -- **ColStart**: `double?` — The starting column for the tile. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **DisableFullscreen**: `bool` — Whether to disable the rendering of the tile fullscreen-action slot and its default fullscreen action button. false -- **DisableMaximize**: `bool` — Whether to disable the rendering of the tile maximize-action slot and its default maximize action button. false -- **DisableResize**: `bool` — Indicates whether to disable tile resize behavior regardless ot its tile manager parent settings. false -- **Maximized**: `bool` — Indicates whether the tile occupies all available space within the layout. -- **Position**: `double` — Gets/sets the tile's visual position in the layout. Corresponds to the CSS order property. -- **RowSpan**: `double` — The number of rows the tile will span. When setting a value that is less than 1, it will be coerced to 1. 1 -- **RowStart**: `double?` — The starting row for the tile. -- **SupportsVisualChildren**: `bool` -- **TileDragCancel**: `EventCallback` -- **TileDragCancelScript**: `string` -- **TileDragEnd**: `EventCallback` -- **TileDragEndScript**: `string` -- **TileDragStart**: `EventCallback` -- **TileDragStartScript**: `string` -- **TileFullscreen**: `EventCallback` -- **TileFullscreenScript**: `string` -- **TileManagerParent**: `BaseRendererControl` -- **TileMaximize**: `EventCallback` -- **TileMaximizeScript**: `string` -- **TileResizeCancel**: `EventCallback` -- **TileResizeCancelScript**: `string` -- **TileResizeEnd**: `EventCallback` -- **TileResizeEndScript**: `string` -- **TileResizeStart**: `EventCallback` -- **TileResizeStartScript**: `string` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetFullscreen**(): bool -- **GetFullscreenAsync**(): Task -- **OnInitializedAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbTileChangeStateEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTileChangeStateEventArgs) - -- **constructor**(): void -- **Detail**: `IgbTileChangeStateEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTileChangeStateEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTileChangeStateEventArgsDetail) - -- **constructor**(): void -- **State**: `bool` -- **Tile**: `IgbTile` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTileComponentEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTileComponentEventArgs) - -- **constructor**(): void -- **Detail**: `IgbTile` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTileGeneratorMapImagery](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTileGeneratorMapImagery) -Represents a CustomMapImagery MapImagery - -- **constructor**(): void -- **TileGenerator**: `IgbTileGenerator` — Gets or sets the culture name for this tile source. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbTileGeneratorMapImageryModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTileGeneratorMapImageryModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTileManager](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTileManager) -The tile manager component enables the dynamic arrangement, resizing, and interaction of tiles. --column-count - The number of columns for the tile manager. The column-count attribute sets this variable. --min-col-width - The minimum size of the columns in the tile-manager. The min-column-width attribute sets this variable. --min-row-height - The minimum size of the rows in the tile-manager. The min-row-height attribute sets this variable. --grid-gap - The gap size of the underlying CSS grid container. The gap attributes sts this variable. - -- **constructor**(): void -- **ColumnCount**: `double` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **DragMode**: `TileManagerDragMode` — Whether drag and drop operations are enabled. none -- **Gap**: `string` — Sets the gap size between tiles in the tile manager. -- **MinColumnWidth**: `string` — Sets the minimum width for a column unit in the tile manager. -- **MinRowHeight**: `string` — Sets the minimum height for a row unit in the tile manager. -- **ParentTypeName**: `string` -- **ResizeMode**: `TileManagerResizeMode` — Whether resize operations are enabled. none -- **SupportsVisualChildren**: `bool` -- **TileDragCancel**: `EventCallback` -- **TileDragCancelScript**: `string` -- **TileDragEnd**: `EventCallback` -- **TileDragEndScript**: `string` -- **TileDragStart**: `EventCallback` -- **TileDragStartScript**: `string` -- **TileFullscreen**: `EventCallback` -- **TileFullscreenScript**: `string` -- **TileMaximize**: `EventCallback` -- **TileMaximizeScript**: `string` -- **TileResizeCancel**: `EventCallback` -- **TileResizeCancelScript**: `string` -- **TileResizeEnd**: `EventCallback` -- **TileResizeEndScript**: `string` -- **TileResizeStart**: `EventCallback` -- **TileResizeStartScript**: `string` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetTiles**(): IgbTile[] -- **GetTilesAsync**(): Task -- **LoadLayout**(data: string): void -- **LoadLayoutAsync**(data: string): Task — Restores a previously serialized state produced by saveLayout. -- **ResolveDisplay**(): string -- **SaveLayout**(): string -- **SaveLayoutAsync**(): Task — Returns the properties of the current tile collections as a JSON payload. The content of the tiles is not serialized or saved. Only tile properties are serialized. -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbTileManagerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTileManagerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTileModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTileModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTileSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTileSeries) -Represents a tile series class that can render imagery tiles - -- **constructor**(): void -- **TileImagery**: `IgbGeographicMapImagery` — The MapImagery which is used to provide the tiles for display. -- **Type**: `string` -- **DeferredRefresh**(): void -- **DeferredRefreshAsync**(): Task — Defers rendering of the series -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbTileSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTileSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTimeAxisBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTimeAxisBase) -Represents an category-based horizontal X axis that uses a DateTime scale. - -- **constructor**(): void -- **ActualMaximumValue**: `DateTime` — Gets the coerced maximum value. -- **ActualMaximumValueChanged**: `Action` -- **ActualMaximumValueChangedScript**: `string` -- **ActualMinimumValue**: `DateTime` — Gets the coerced minimum value. -- **ActualMinimumValueChanged**: `Action` -- **ActualMinimumValueChangedScript**: `string` -- **DateTimeMemberPath**: `string` — Gets or sets the DateTime mapping property for the axis. -- **IsDataPreSorted**: `bool` — Gets or sets whether the data assigned to the date time axis should be considered pre-sorted by date/time. -- **MaximumValue**: `DateTime` — Gets or sets the axis MaximumValue. -- **MinimumValue**: `DateTime` — Gets or sets the axis MinimumValue. -- **Type**: `string` -- **FindByName**(name: string): object -- **GetCurrentActualMaximumValue**(): DateTime -- **GetCurrentActualMaximumValueAsync**(): Task -- **GetCurrentActualMinimumValue**(): DateTime -- **GetCurrentActualMinimumValueAsync**(): Task -- **GetFullRange**(): double[] -- **GetFullRangeAsync**(): Task -- **GetIndexClosestToUnscaledValue**(unscaledValue: double): int -- **GetIndexClosestToUnscaledValueAsync**(unscaledValue: double): Task — Gets the index of the data item with the value nearest the given value. -- **GetItemValue**(item: object, memberPathName: string): object -- **GetItemValueAsync**(item: object, memberPathName: string): Task -- **GetMemberPathValue**(memberPathName: string): string -- **GetMemberPathValueAsync**(memberPathName: string): Task — Gets the value of a requested member path from the series. -- **NotifyDataChanged**(): void -- **NotifyDataChangedAsync**(): Task — Updates the axis when the data has been changed. - -### [IgbTimeAxisBreak](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTimeAxisBreak) -Settings for breaks on a time axis. - -- **constructor**(): void -- **End**: `DateTime` — The end time of the axis break. -- **Interval**: `TimeSpan` — The interval at which to repeat this break, expressed as a TimeSpan. -- **Start**: `DateTime` — The start time of the axis break. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbTimeAxisBreakCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTimeAxisBreakCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbTimeAxisBreakModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTimeAxisBreakModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTimeAxisInterval](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTimeAxisInterval) -Settings for an interval on a time axis. - -- **constructor**(): void -- **Interval**: `double` — The interval, expressed as a multiple of IntervalType. -- **IntervalType**: `TimeAxisIntervalType` — The unit of time for this interval. -- **Range**: `TimeSpan` — The visible axis range at which to apply this interval. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbTimeAxisIntervalCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTimeAxisIntervalCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbTimeAxisIntervalModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTimeAxisIntervalModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTimeAxisLabelFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTimeAxisLabelFormat) -Settings for a label format on a time axis. - -- **constructor**(): void -- **Format**: `string` — The DateTime format string to apply. -- **LabelFormatOverride**: `EventCallback` -- **LabelFormatOverrideScript**: `string` -- **Range**: `TimeSpan` — The visible axis range at which to apply this label format. -- **RepeatedDayFormat**: `string` — The DateTime format string to apply, if the day is repeated from the prior date. -- **RepeatedMonthFormat**: `string` — The DateTime format string to apply, if the month is repeated from the prior date. -- **RepeatedYearFormat**: `string` — The DateTime format string to apply, if the year is repeated from the prior date. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbTimeAxisLabelFormatCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTimeAxisLabelFormatCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbTimeAxisLabelFormatModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTimeAxisLabelFormatModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTimeXAxis](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTimeXAxis) -A horizontal axis that uses a DateTime scale. - -- **constructor**(): void -- **Breaks**: `IgbTimeAxisBreakCollection` — TimeAxisBreaks to apply to this axis, representing spans of time to omit, such as weekends. -- **Intervals**: `IgbTimeAxisIntervalCollection` — A list of axis label intervals to apply, which are selected according to the visible axis range. -- **LabelFormats**: `IgbTimeAxisLabelFormatCollection` — A list of axis label formats to apply, which are selected according to the visible axis range. -- **LabellingMode**: `TimeAxisLabellingMode` — Gets or sets the labelling mode to use when the automatic label formats are applied. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetIndexClosestToUnscaledValue**(unscaledValue: double): int -- **GetIndexClosestToUnscaledValueAsync**(unscaledValue: double): Task — Gets the index of the data item with the value nearest the given value. -- **GetValueLabel**(value: double): string -- **GetValueLabelAsync**(value: double): Task — Gets the label for a data item. - -### [IgbTimeXAxisModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTimeXAxisModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToast](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToast) -A toast component is used to show a notification - -- **constructor**(): void -- **DirectRenderElementName**: `string` -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **ResolveDisplay**(): string - -### [IgbToastModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToastModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTodayExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTodayExpression) -Requests an expression for the Today filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToggleButton](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToggleButton) -The igc-toggle-button wraps a native button element and exposes additional value and selected properties. It is used in the context of an igc-button-group to facilitate the creation of group/toolbar like UX behaviors. - -- **constructor**(): void -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — Determines whether the button is disabled. -- **Selected**: `bool` — Determines whether the button is selected. -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `string` — The value attribute of the control. -- **BlurComponent**(): void -- **BlurComponentAsync**(): Task — Removes focus from the button. -- **Click**(): void -- **ClickAsync**(): Task — Simulates a mouse click on the element. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FocusComponent**(options: IgbFocusOptions): void -- **FocusComponentAsync**(options: IgbFocusOptions): Task — Sets focus on the button. -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbToggleButtonModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToggleButtonModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToggleViewCancelableEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToggleViewCancelableEventArgs) - -- **constructor**(): void -- **Detail**: `IgbToggleViewCancelableEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToggleViewCancelableEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToggleViewCancelableEventArgsDetail) - -- **constructor**(): void -- **Id**: `string` — Id of the toggle view -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToggleViewEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToggleViewEventArgs) - -- **constructor**(): void -- **Detail**: `IgbToggleViewEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToggleViewEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToggleViewEventArgsDetail) - -- **constructor**(): void -- **Id**: `string` — Id of the toggle view -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTomorrowExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTomorrowExpression) -Requests an expression for the Tomorrow filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolAction](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolAction) -Represents base class for all tool actions in toolbar - -- **constructor**(): void -- **AccentColor**: `string` -- **Actions**: `IgbToolActionCollection` — Gets the sub actions associated with this tool action. -- **ActualAccentColor**: `string` -- **ActualActions**: `IgbToolActionCollection` -- **ActualBackground**: `string` — Gets the actual background used by the tool action. -- **ActualDensity**: `ControlDisplayDensity` — Gets the resolved display density to use for the action. -- **ActualDisabledTextColor**: `string` — Gets the actual label text color when the tool is disabled. -- **ActualHighlightColor**: `string` -- **ActualHighlightRadius**: `double` -- **ActualHighlightWidth**: `double` -- **ActualHoverBackground**: `string` — Gets the actual hover background used by the tool action. -- **ActualIconFill**: `string` — Gets the actual icon fill color. -- **ActualIconHeight**: `double` — Gets the actual icon height used. -- **ActualIconStroke**: `string` — Gets the actual icon stroke color. -- **ActualIconWidth**: `double` — Gets the actual icon width used. -- **ActualPaddingBottom**: `double` -- **ActualPaddingLeft**: `double` -- **ActualPaddingRight**: `double` -- **ActualPaddingTop**: `double` -- **ActualSubtitleTextColor**: `string` — Gets the actual label text color. -- **ActualTextColor**: `string` — Gets the actual label text color. -- **AfterId**: `string` — Gets or sets the Id of the action that this action will be inserted after. -- **Background**: `string` — Gets or sets the background color of the tool action. -- **BeforeId**: `string` — Gets or sets the Id of the action that this action will be inserted before. -- **CloseOnExecute**: `bool` — Gets or sets if the tool action will close its parent dropdown when executed by the user. -- **CommandArgument**: `string` -- **CommandArgumentValue**: `object` -- **CommandId**: `string` -- **ContentActions**: `IgbToolActionCollection` -- **ContextBindings**: `IgbToolContextBindingCollection` — Gets the context bindings for this tool action. -- **Density**: `ControlDisplayDensity` — Gets or sets the display density to use for the action. -- **DisabledTextColor**: `string` — Gets or sets the label text color when the tool is disabled. -- **FontFamily**: `string` -- **FontSize**: `double` -- **FontStyle**: `string` -- **FontWeight**: `string` -- **Height**: `double` — Gets or sets the height to use for this tool action. -- **HighlightColor**: `string` -- **HighlightRadius**: `double` -- **HighlightWidth**: `double` -- **HoverBackground**: `string` — Gets or sets the hover background for this tool action. -- **IconCollectionName**: `string` -- **IconFill**: `string` — Gets or sets the icon fill color. -- **IconFillColors**: `string` — Gets or sets the icon fill colors. -- **IconHeight**: `double` — Gets or sets the height of the icon. -- **IconName**: `string` -- **IconStroke**: `string` — Gets or sets the icon stroke color. -- **IconStrokeColors**: `string` — Gets or sets the icon stroke colors. -- **IconStrokeWidth**: `double` — Gets or sets the icon viewbox width. -- **IconViewBoxHeight**: `double` — Gets or sets the icon viewbox height. -- **IconViewBoxLeft**: `double` — Gets or sets the icon viewbox left. -- **IconViewBoxTop**: `double` — Gets or sets the icon viewbox top. -- **IconViewBoxWidth**: `double` — Gets or sets the icon viewbox width. -- **IconWidth**: `double` — Gets or sets the width of the icon. -- **IsDisabled**: `bool` -- **IsHighlighted**: `bool` -- **OnCommand**: `EventCallback` -- **OnCommandScript**: `string` -- **OverlayId**: `string` — Sets to the Id of the action that this action will overlay itself on to. -- **PaddingBottom**: `double` -- **PaddingLeft**: `double` -- **PaddingRight**: `double` -- **PaddingTop**: `double` -- **ParentId**: `string` -- **ParentTypeName**: `string` -- **Performed**: `EventCallback` -- **PerformedScript**: `string` -- **SubPanelRowHeight**: `int` — Gets or sets the height to use for the sub panel if different than default -- **Subtitle**: `string` — Gets or sets the subtitle of the tool. -- **SubtitleFontFamily**: `string` -- **SubtitleFontSize**: `double` -- **SubtitleFontStyle**: `string` -- **SubtitleFontWeight**: `string` -- **SubtitleTextColor**: `string` — Gets or sets the label text color. -- **TextColor**: `string` — Gets or sets the label text color. -- **Title**: `string` — Gets or sets the title of the tool. -- **TitleHorizontalAlignment**: `HorizontalAlignment` — Gets or sets the title horizontal alignment. -- **ToolActionParent**: `BaseRendererElement` -- **ToolbarParent**: `BaseRendererControl` -- **Type**: `string` -- **Visibility**: `Visibility` — Gets or sets the tool action visibility. -- **Width**: `double` — Gets or sets the width to use for this tool action. -- **CloseSubmenu**(): void -- **CloseSubmenuAsync**(): Task -- **Dispose**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task -- **OpenSubMenu**(): void -- **OpenSubMenuAsync**(): Task - -### [IgbToolActionButton](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionButton) - -- **constructor**(): void -- **CornerRadius**: `double` — Gets or sets the button corner radius. -- **DisplayType**: `ToolActionButtonDisplayType` — Gets or sets the display type for the button. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object - -### [IgbToolActionButtonInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionButtonInfo) -Represents info for toolbar icon - -- **constructor**(): void -- **DisplayType**: `ToolActionButtonInfoDisplayType` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionButtonModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionButtonModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionButtonPair](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionButtonPair) - -- **constructor**(): void -- **ActualLeftIconFill**: `string` — Gets the actual LeftIcon fill color. -- **ActualLeftIconStroke**: `string` — Gets the actual LeftIcon stroke color. -- **ActualRightIconFill**: `string` — Gets the actual RightIcon fill color. -- **ActualRightIconStroke**: `string` — Gets the actual RightIcon stroke color. -- **CornerRadius**: `double` — Gets or sets the button corner radius. -- **DisplayType**: `ToolActionButtonGroupDisplayType` — Gets or sets the display type for the button. -- **IsToggleDisabled**: `bool` -- **LeftCommandArgument**: `string` -- **LeftIconCollectionName**: `string` -- **LeftIconFill**: `string` — Gets or sets the LeftIcon fill color. -- **LeftIconFillColors**: `string` — Gets or sets the LeftIcon fill colors. -- **LeftIconName**: `string` -- **LeftIconStroke**: `string` — Gets or sets the LeftIcon stroke color. -- **LeftIconStrokeColors**: `string` — Gets or sets the LeftIcon stroke colors. -- **LeftIconStrokeWidth**: `double` — Gets or sets the LeftIcon viewbox width. -- **LeftIconViewBoxHeight**: `double` — Gets or sets the LeftIcon viewbox height. -- **LeftIconViewBoxLeft**: `double` — Gets or sets the LeftIcon viewbox left. -- **LeftIconViewBoxTop**: `double` — Gets or sets the LeftIcon viewbox top. -- **LeftIconViewBoxWidth**: `double` — Gets or sets the LeftIcon viewbox width. -- **LeftIsDisabled**: `bool` -- **LeftIsSelected**: `bool` -- **LeftTitle**: `string` — Gets or sets the title of the left button. -- **RightCommandArgument**: `string` -- **RightIconCollectionName**: `string` -- **RightIconFill**: `string` — Gets or sets the RightIcon fill color. -- **RightIconFillColors**: `string` — Gets or sets the RightIcon fill colors. -- **RightIconName**: `string` -- **RightIconStroke**: `string` — Gets or sets the RightIcon stroke color. -- **RightIconStrokeColors**: `string` — Gets or sets the RightIcon stroke colors. -- **RightIconStrokeWidth**: `double` — Gets or sets the RightIcon viewbox width. -- **RightIconViewBoxHeight**: `double` — Gets or sets the RightIcon viewbox height. -- **RightIconViewBoxLeft**: `double` — Gets or sets the RightIcon viewbox left. -- **RightIconViewBoxTop**: `double` — Gets or sets the RightIcon viewbox top. -- **RightIconViewBoxWidth**: `double` — Gets or sets the RightIcon viewbox width. -- **RightIsDisabled**: `bool` -- **RightIsSelected**: `bool` -- **RightTitle**: `string` — Gets or sets the title of the Right button. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object - -### [IgbToolActionButtonPairInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionButtonPairInfo) -Represents info for toolbar icon - -- **constructor**(): void -- **IsToggleDisabled**: `bool` — Gets or sets whether toggle is disabled for the buttons -- **LeftCommandArgument**: `string` — Gets or sets the left button's command's argument -- **LeftIconCollectionName**: `string` — Gets or sets the collection name of left icon -- **LeftIconFill**: `string` — Gets or sets the left icon fill color. -- **LeftIconName**: `string` — Gets or sets the left icon name -- **LeftIconStroke**: `string` — Gets or sets the left icon stroke color. -- **LeftIconStrokeWidth**: `double` — Gets or sets the left icon stroke width. -- **LeftIconViewBoxHeight**: `double` — Sets left icon's viewbox height. -- **LeftIconViewBoxLeft**: `double` — Sets the left icon's viewbox left position. -- **LeftIconViewBoxTop**: `double` — Sets the left icon's viewbox top position. -- **LeftIconViewBoxWidth**: `double` — Sets the left icon's viewbox width. -- **LeftTitle**: `string` — Gets or sets left display label -- **RightCommandArgument**: `string` — Gets or sets the right button's command argument -- **RightIconCollectionName**: `string` — Gets or sets collection name of right icon -- **RightIconFill**: `string` — Gets or sets the left icon fill color. -- **RightIconName**: `string` — Gets or sets right icon name -- **RightIconStroke**: `string` — Gets or sets the left icon stroke color. -- **RightIconStrokeWidth**: `double` — Gets or sets the left icon stroke width. -- **RightIconViewBoxHeight**: `double` — Sets right icon's viewbox height. -- **RightIconViewBoxLeft**: `double` — Sets the right icon's viewbox left position. -- **RightIconViewBoxTop**: `double` — Sets the right icon's viewbox top position. -- **RightIconViewBoxWidth**: `double` — Sets the right icon's viewbox width. -- **RightTitle**: `string` — Gets or sets the right display label -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionButtonPairModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionButtonPairModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionCheckbox](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionCheckbox) - -- **constructor**(): void -- **ActualCheckedBackgroundColor**: `string` — Gets the actual background color of the checkbox when in the checked state. -- **ActualCheckedBorderColor**: `string` — Gets the actual border color of the checkbox when in the checked state. -- **ActualUncheckedBackgroundColor**: `string` — Gets the actual background color of the checkbox when in the unchecked state. -- **ActualUncheckedBorderColor**: `string` — Gets the actual border color of the checkbox when in the unchecked state. -- **CheckedBackgroundColor**: `string` — Gets or sets the background color of the checkbox when in the checked state. -- **CheckedBorderColor**: `string` — Gets or sets the border color of the checkbox when in the checked state. -- **IsChecked**: `bool` — Gets or sets if the tool action is checked. -- **Type**: `string` -- **UncheckedBackgroundColor**: `string` — Gets or sets the background color of the checkbox when in the unchecked state. -- **UncheckedBorderColor**: `string` — Gets or sets the border color of the checkbox when in the unchecked state. -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object - -### [IgbToolActionCheckboxInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionCheckboxInfo) -Represents info for toolbar checkbox - -- **constructor**(): void -- **IsChecked**: `bool` — Sets if the tool action is checked. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionCheckboxList](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionCheckboxList) - -- **constructor**(): void -- **ActualCheckedBackgroundColor**: `string` — Gets the actual background color of the checkbox when in the checked state. -- **ActualCheckedBorderColor**: `string` — Gets the actual border color of the checkbox when in the checked state. -- **ActualUncheckedBackgroundColor**: `string` — Gets the actual background color of the checkbox when in the unchecked state. -- **ActualUncheckedBorderColor**: `string` — Gets the actual border color of the checkbox when in the unchecked state. -- **CheckedBackgroundColor**: `string` — Gets or sets the background color of the checkbox when in the checked state. -- **CheckedBorderColor**: `string` — Gets or sets the border color of the checkbox when in the checked state. -- **DataMemberPath**: `string` — Gets or sets if the tool action is checked. -- **DataSource**: `object` — Gets or sets if the tool action is checked. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **IndexType**: `ToolActionCheckboxListIndexType` -- **PrimaryKey**: `string[]` — Gets or sets if the tool action is checked. -- **SelectedKeys**: `IgbLayoutSelectedKeysCollection` -- **SelectedMemberPath**: `string` — Gets or sets if the tool action is checked. -- **ShowSelectAll**: `bool` — Gets or sets if the select all row is shown. -- **Type**: `string` -- **UncheckedBackgroundColor**: `string` — Gets or sets the background color of the checkbox when in the unchecked state. -- **UncheckedBorderColor**: `string` — Gets or sets the border color of the checkbox when in the unchecked state. -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object - -### [IgbToolActionCheckboxListInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionCheckboxListInfo) -Represents info for toolbar checkbox list - -- **constructor**(): void -- **DataMemberPath**: `string` -- **DataSource**: `object` — Sets the items for the ToolAction -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **PrimaryKey**: `string[]` -- **SelectedMemberPath**: `string` -- **ShowSelectAll**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionCheckboxListModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionCheckboxListModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionCheckboxModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionCheckboxModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbToolActionColorEditor](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionColorEditor) - -- **constructor**(): void -- **Type**: `string` -- **Value**: `string` — Gets or sets the value for the input. -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object - -### [IgbToolActionColorEditorInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionColorEditorInfo) - -- **constructor**(): void -- **Type**: `string` -- **Value**: `string` — Sets the initial number value for the input. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionColorEditorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionColorEditorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionCombo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionCombo) - -- **constructor**(): void -- **DataSource**: `object` — Gets or sets if the tool action is checked. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DisplayMemberPath**: `string` — Gets or sets the field to use to get the displayed values. -- **SelectedValues**: `IgbLayoutSelectedItemsCollection` -- **Type**: `string` -- **ValueMemberPath**: `string` — Gets or sets the field to use to get the values to use. -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object - -### [IgbToolActionComboInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionComboInfo) - -- **constructor**(): void -- **DataSource**: `object` — Sets the items for the ToolAction -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DisplayMemberPath**: `string` -- **SelectedValues**: `object[]` -- **SelectedValuesScript**: `string` — Provides a means of setting SelectedValues in the JavaScript environment. -- **Type**: `string` -- **ValueMemberPath**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionComboModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionComboModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionEventDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionEventDetail) - -- **constructor**(): void -- **ActionId**: `string` -- **ActionType**: `ToolActionType` -- **BoolValue**: `bool` -- **DateTimeValue**: `DateTime` -- **IsModified**: `bool` -- **NumberValue**: `double` -- **StringValue**: `string` -- **Type**: `string` -- **UntypedValue**: `object` -- **UntypedValueScript**: `string` — Provides a means of setting UntypedValue in the JavaScript environment. -- **FindByName**(name: string): object - -### [IgbToolActionEventDetailCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionEventDetailCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbToolActionFieldSelector](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionFieldSelector) - -- **constructor**(): void -- **ActualPaddingBottom**: `double` -- **ActualPaddingLeft**: `double` -- **ActualPaddingRight**: `double` -- **ActualPaddingTop**: `double` -- **Aggregations**: `IgbToolActionFieldSelectorAggregationsCollection` — Gets or sets a list of aggregations to use, if null a default list is used instead. If list provided has custom aggregations the data source is never updated. -- **DataSource**: `object` — Gets or sets if the tool action is checked. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **FieldType**: `ToolActionFieldSelectorType` — Gets or sets if the tool action is checked. -- **LegendTarget**: `object` -- **LegendTargetScript**: `string` — Provides a means of setting LegendTarget in the JavaScript environment. -- **PaddingBottom**: `double` -- **PaddingLeft**: `double` -- **PaddingRight**: `double` -- **PaddingTop**: `double` -- **SelectedAggregations**: `IgbToolActionFieldSelectorSelectedAggregationsCollection` — Used to set default values when using custom aggregations, will be overriden otherwise -- **SingleSelection**: `bool` — Gets or sets if the list only takes one selection at a time. -- **Type**: `string` -- **UpdateDataSource**: `bool` — Gets or sets if the data source has to be updated when changes are made. -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbToolActionFieldSelectorAggregation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionFieldSelectorAggregation) - -- **constructor**(): void -- **Label**: `string` -- **Operand**: `DataSourceSummaryOperand` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionFieldSelectorAggregationModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionFieldSelectorAggregationModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionFieldSelectorAggregationsCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionFieldSelectorAggregationsCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbToolActionFieldSelectorInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionFieldSelectorInfo) - -- **constructor**(): void -- **Aggregations**: `object[]` -- **AggregationsScript**: `string` — Provides a means of setting Aggregations in the JavaScript environment. -- **DataSource**: `object` -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **FieldType**: `ToolActionFieldSelectorInfoType` -- **Rules**: `object[]` -- **RulesScript**: `string` — Provides a means of setting Rules in the JavaScript environment. -- **SelectedAggregations**: `object[]` -- **SelectedAggregationsScript**: `string` — Provides a means of setting SelectedAggregations in the JavaScript environment. -- **SingleSelection**: `bool` -- **Type**: `string` -- **UpdateDataSource**: `bool` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionFieldSelectorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionFieldSelectorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionFieldSelectorSelectedAggregation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionFieldSelectorSelectedAggregation) - -- **constructor**(): void -- **AggregationName**: `string` -- **AggregationOperand**: `DataSourceSummaryOperand` -- **Field**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionFieldSelectorSelectedAggregationModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionFieldSelectorSelectedAggregationModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionFieldSelectorSelectedAggregationsCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionFieldSelectorSelectedAggregationsCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbToolActionGroupHeader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionGroupHeader) - -- **constructor**(): void -- **ActualBackIconColor**: `string` — Gets the actual back icon color. -- **BackIconColor**: `string` — Gets or sets the icon color for the back button. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object - -### [IgbToolActionGroupHeaderInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionGroupHeaderInfo) -Represents info for toolbar group - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionGroupHeaderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionGroupHeaderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionIconButton](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionIconButton) - -- **constructor**(): void -- **ActualContentPaddingBottom**: `double` -- **ActualContentPaddingLeft**: `double` -- **ActualContentPaddingRight**: `double` -- **ActualContentPaddingTop**: `double` -- **ActualTooltipDelay**: `int` — Gets the actual delay before the tooltip is displayed (in milliseconds). -- **ContentPaddingBottom**: `double` -- **ContentPaddingLeft**: `double` -- **ContentPaddingRight**: `double` -- **ContentPaddingTop**: `double` -- **PopupOpening**: `EventCallback` -- **PopupOpeningScript**: `string` -- **TooltipDelay**: `int` — Gets or sets how long it takes before the tooltip is displayed (in milliseconds). -- **Type**: `string` -- **CloseSubmenu**(): void -- **CloseSubmenuAsync**(): Task -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object -- **OpenSubMenu**(): void -- **OpenSubMenuAsync**(): Task - -### [IgbToolActionIconButtonInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionIconButtonInfo) -Represents info for toolbar icon - -- **constructor**(): void -- **IsMenuOpenOnStart**: `bool` — Sets if the submenu should be open immediately when ready. -- **TooltipDelay**: `int` — Sets the delay before the tooltip is shown. Also used for submenus. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionIconButtonModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionIconButtonModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionIconMenu](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionIconMenu) - -- **constructor**(): void -- **ActualArrowStroke**: `string` — Gets the actual stroke color of the arrow icon. -- **ArrowStroke**: `string` — Gets or sets the stroke color of the arrow icon. -- **ShowArrowIcon**: `bool` — Gets or sets whether the arrow icon should be shown. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object - -### [IgbToolActionIconMenuInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionIconMenuInfo) -Represents info for toolbar icon menu - -- **constructor**(): void -- **ShowArrowIcon**: `bool` — Sets if the menu should show the arrow icon next to its icon -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionIconMenuModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionIconMenuModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionInfo) -Represents info for toolbar action - -- **constructor**(): void -- **Actions**: `IgbToolActionInfo[]` — Sets the submenu actions for the icon button. -- **CloseOnExecute**: `bool` — Sets if the menu will close when the action is executed. -- **CommandArgument**: `string` — Gets or sets commands's argument -- **CommandArgumentValue**: `object` — Gets or sets commands's value -- **CommandArgumentValueScript**: `string` — Provides a means of setting CommandArgumentValue in the JavaScript environment. -- **CommandId**: `string` — Gets or sets command's ID -- **ContextBindings**: `IgbToolContextBindingInfo[]` — Sets the context bindings for the tool action. -- **Density**: `ToolActionInfoDensity` — Sets the desnity to use for the tool. -- **DisabledTextColor**: `string` — Sets the text color to use when the action is disabled. -- **Height**: `double` — Sets the height of the tool. -- **IconCollectionName**: `string` — Gets or sets top name of icons collaction -- **IconFill**: `string` — Sets the icon fill color. -- **IconHeight**: `double` — Sets the icon height. -- **IconName**: `string` — Gets or sets icon name -- **IconStroke**: `string` — Sets the icon stroke color. -- **IconStrokeWidth**: `double` — Sets the icon stroke thickness. -- **IconViewBoxHeight**: `double` — Sets icon viewbox height. -- **IconViewBoxLeft**: `double` — Sets the icon viewbox left position. -- **IconViewBoxTop**: `double` — Sets the icon viewbox top position. -- **IconViewBoxWidth**: `double` — Sets the icon viewbox width. -- **IconWidth**: `double` — Sets the icon width. -- **IsDisabled**: `bool` — Sets whether the action is disabled. -- **IsHighlighted**: `bool` — Sets whether the action is highlighted. -- **PaddingBottom**: `double` — Gets or sets bottom padding -- **PaddingLeft**: `double` — Gets or sets left padding -- **PaddingRight**: `double` — Gets or sets right padding -- **PaddingTop**: `double` — Gets or sets top padding -- **ParentId**: `string` — Gets or sets parent's ID -- **SubPanelRowHeight**: `int` — Sets the height of the sub panel if different than default. -- **Subtitle**: `string` — Gets or sets display subtitle -- **TextColor**: `string` — Sets the text color to use. -- **Title**: `string` — Gets or sets display label -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionLabel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionLabel) - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object - -### [IgbToolActionLabelInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionLabelInfo) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionLabelModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionLabelModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionNumberInput](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionNumberInput) - -- **constructor**(): void -- **Type**: `string` -- **Value**: `double` — Gets or sets the value for the input. -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object - -### [IgbToolActionNumberInputInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionNumberInputInfo) -Represents info for toolbar number input - -- **constructor**(): void -- **Type**: `string` -- **Value**: `double` — Sets the initial number value for the input. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionNumberInputModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionNumberInputModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionPerformedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionPerformedEventArgs) - -- **constructor**(): void -- **Detail**: `IgbToolActionEventDetail` -- **DetailCollection**: `IgbToolActionEventDetailCollection` -- **IsAggregate**: `bool` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionPopupOpeningEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionPopupOpeningEventArgs) - -- **constructor**(): void -- **Cancel**: `bool` -- **SourceAction**: `IgbToolAction` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionRadio](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionRadio) - -- **constructor**(): void -- **ActualCheckedBackgroundColor**: `string` — Gets the actual background color of the radio when in the checked state. -- **ActualCheckedBorderColor**: `string` — Gets the actual border color of the radio when in the checked state. -- **ActualUncheckedBackgroundColor**: `string` — Gets the actual background color of the radio when in the unchecked state. -- **ActualUncheckedBorderColor**: `string` — Gets the actual border color of the radio when in the unchecked state. -- **Channel**: `string` — Gets or sets the channel this radio button belongs to. -- **CheckedBackgroundColor**: `string` — Gets or sets the background color of the radio when in the checked state. -- **CheckedBorderColor**: `string` — Gets or sets the border color of the radio when in the checked state. -- **IsChecked**: `bool` — Gets or sets if the tool action is checked. -- **IsManual**: `bool` — Gets or sets if the checked state of the radio is handled manually by the user. The radio well not become selected when clicked if this property is true. -- **Type**: `string` -- **UncheckedBackgroundColor**: `string` — Gets or sets the background color of the radio when in the unchecked state. -- **UncheckedBorderColor**: `string` — Gets or sets the border color of the radio when in the unchecked state. -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object - -### [IgbToolActionRadioInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionRadioInfo) -Represents info for toolbar radio - -- **constructor**(): void -- **Channel**: `string` — Sets the radio channel of the tool action. -- **IsChecked**: `bool` — Sets the initial check state of the tool action. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionRadioModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionRadioModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionSeparator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionSeparator) - -- **constructor**(): void -- **IsGroupHeaderSeparator**: `bool` — Gets or sets whether to use group header styling or regular styling on this separator. -- **Size**: `double` — Gets or sets the size of the separator. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object - -### [IgbToolActionSeparatorInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionSeparatorInfo) -Represents info for toolbar separator - -- **constructor**(): void -- **IsGroupHeaderSeparator**: `bool` — Sets which styling the separator will use. -- **Size**: `double` — Sets the size of the separator. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionSeparatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionSeparatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionSubPanel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionSubPanel) - -- **constructor**(): void -- **ItemSpacing**: `double` — Gets or sets the spacing between items. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object - -### [IgbToolActionSubPanelInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionSubPanelInfo) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionSubPanelModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionSubPanelModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolActionTextInput](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionTextInput) - -- **constructor**(): void -- **Type**: `string` -- **Value**: `string` — Gets or sets the value for the input. -- **EnsureModulesLoaded**(): void -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object - -### [IgbToolActionTextInputInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionTextInputInfo) -Represents info for toolbar number input - -- **constructor**(): void -- **Type**: `string` -- **Value**: `string` — Sets the initial number value for the input. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolActionTextInputModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolActionTextInputModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolCommand](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolCommand) -Represents a toolbar command - -- **constructor**(): void -- **ArgumentsList**: `IgbToolCommandArgumentCollection` — Gets a list of toolbar command arguments -- **CommandId**: `string` — Gets acommand ID -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolCommandArgument](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolCommandArgument) -Represents an argument for toolbar command - -- **constructor**(): void -- **ArgumentName**: `string` — Gets argument name -- **Type**: `string` -- **Value**: `object` — Gets argument value -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolCommandArgumentCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolCommandArgumentCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbToolCommandEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolCommandEventArgs) - -- **constructor**(): void -- **CloseOnExecute**: `bool` -- **Command**: `IgbToolCommand` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolContextBinding](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolContextBinding) - -- **constructor**(): void -- **BindingMode**: `ToolContextBindingMode` -- **ContextKey**: `string` -- **PropertyName**: `string` -- **PropertyUpdated**: `EventCallback` -- **PropertyUpdatedScript**: `string` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbToolContextBindingCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolContextBindingCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbToolContextBindingInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolContextBindingInfo) - -- **constructor**(): void -- **BindingMode**: `ToolContextBindingMode` -- **ContextKey**: `string` -- **PropertyName**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolPanel](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolPanel) - -- **constructor**(): void -- **AccentColor**: `string` -- **Actions**: `IgbToolActionCollection` — Gets or sets the data or data source instance to which to bind the grid. -- **ActualAccentColor**: `string` -- **ActualBackgroundColor**: `string` -- **ActualCheckedBackgroundColor**: `string` — Gets the actual background color of the radio when in the checked state. -- **ActualCheckedBorderColor**: `string` — Gets the actual border color of the radio when in the checked state. -- **ActualDensity**: `ControlDisplayDensity` — Gets the resolved display density to use for the toolbar. -- **ActualDisabledTextColor**: `string` -- **ActualDropdownDelay**: `int` — Gets the actual dropdown delay. -- **ActualGroupHeaderBackgroundColor**: `string` -- **ActualGroupHeaderSeparatorBackgroundColor**: `string` -- **ActualGroupHeaderSubtitleTextColor**: `string` -- **ActualGroupHeaderTextColor**: `string` -- **ActualHighlightColor**: `string` -- **ActualHighlightRadius**: `double` -- **ActualHighlightWidth**: `double` -- **ActualHoverBackgroundColor**: `string` -- **ActualIconFill**: `string` — Gets the actual icon fill color. -- **ActualIconStroke**: `string` — Gets the actual icon stroke color. -- **ActualMenuArrowStroke**: `string` — Gets the actual stroke color for all icon menu dropdown arrows. -- **ActualSeparatorBackgroundColor**: `string` -- **ActualSeparatorHorizontalPaddingBottom**: `double` -- **ActualSeparatorHorizontalPaddingLeft**: `double` -- **ActualSeparatorHorizontalPaddingRight**: `double` -- **ActualSeparatorHorizontalPaddingTop**: `double` -- **ActualSeparatorVerticalPaddingBottom**: `double` -- **ActualSeparatorVerticalPaddingLeft**: `double` -- **ActualSeparatorVerticalPaddingRight**: `double` -- **ActualSeparatorVerticalPaddingTop**: `double` -- **ActualSubmenuBackgroundColor**: `string` -- **ActualSubtitleTextColor**: `string` -- **ActualTextColor**: `string` -- **ActualToolTipBackgroundColor**: `string` — Gets the actual tooltip background color. -- **ActualToolTipCornerRadius**: `double` — Gets the actual tooltip corner radius. -- **ActualToolTipElevation**: `double` — Gets the actual shadow elevation used by the tooltip. -- **ActualToolTipTextColor**: `string` -- **ActualUncheckedBackgroundColor**: `string` — Gets the actual background color of the radio when in the unchecked state. -- **ActualUncheckedBorderColor**: `string` — Gets the actual border color of the radio when in the unchecked state. -- **BackgroundColor**: `string` — Gets or sets the color to use for the background of the component. -- **BaseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the checkbox. -- **CellFontFamily**: `string` -- **CellFontSize**: `double` -- **CellFontStyle**: `string` -- **CellFontWeight**: `string` -- **CheckedBackgroundColor**: `string` — Gets or sets the background color of the radio when in the checked state. -- **CheckedBorderColor**: `string` — Gets or sets the border color of the radio when in the checked state. -- **ContentRefreshed**: `EventCallback` -- **ContentRefreshedScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or sets the display density to use for the toolbar. -- **DisabledTextColor**: `string` — Gets or sets the color to use for the text in disabled tool actions. -- **DropdownClickBuffer**: `int` — Gets or sets the amount of time to wait when clicking on the icon menu button while the dropdown is opening. If a click was executed within this buffer window the dropdown will be left open. Otherwise it will close it. Setting a negative value will always keep the dropdown open during a hover open and will require an extra click to close. -- **DropdownDelay**: `int` — Gets or sets the dropdown delay time in milliseconds. -- **GroupHeaderBackgroundColor**: `string` — Gets or sets the group header background color. -- **GroupHeaderFontFamily**: `string` -- **GroupHeaderFontSize**: `double` -- **GroupHeaderFontStyle**: `string` -- **GroupHeaderFontWeight**: `string` -- **GroupHeaderSeparatorBackgroundColor**: `string` — Gets or sets the group header separator background color. -- **GroupHeaderSubtitleTextColor**: `string` — Gets or sets the text color for group header subtitle. -- **GroupHeaderTextColor**: `string` — Gets or sets the text color for group header tool actions. -- **HighlightColor**: `string` -- **HighlightRadius**: `double` -- **HighlightWidth**: `double` -- **HoverBackgroundColor**: `string` — Gets or sets the hover background color. -- **IconFill**: `string` — Gets or sets the fill color of icons in the ToolPanel. -- **IconStroke**: `string` — Gets or sets the stroke color of icons in the ToolPanel. -- **ItemSpacing**: `double` — Gets or sets the spacing between items -- **MenuArrowStroke**: `string` — Gets or sets the stroke color for all icon menu dropdown arrows. -- **NestedActionMode**: `NestedActionMode` — Gets or sets the mode used when displaying nested actions. -- **OnCommand**: `EventCallback` -- **OnCommandScript**: `string` -- **Orientation**: `ToolPanelOrientation` — Gets or sets the color to use for the background of the component. -- **RowHeight**: `int` — Gets or sets the row height for the panel. -- **ScrollbarStyle**: `ScrollbarStyle` — Gets or sets the style of scrollbar. -- **SeparatorBackgroundColor**: `string` — Gets or sets the separator background color. -- **SeparatorHorizontalPaddingBottom**: `double` — Gets or sets the bottom padding for separators in the horizontal orientation. -- **SeparatorHorizontalPaddingLeft**: `double` — Gets or sets the left padding for separators in the horizontal orientation. -- **SeparatorHorizontalPaddingRight**: `double` — Gets or sets the right padding for separators in the horizontal orientation. -- **SeparatorHorizontalPaddingTop**: `double` — Gets or sets the top padding for separators in the horizontal orientation. -- **SeparatorVerticalPaddingBottom**: `double` — Gets or sets the bottom padding for separators in the vertical orientation. -- **SeparatorVerticalPaddingLeft**: `double` — Gets or sets the left padding for separators in the vertical orientation. -- **SeparatorVerticalPaddingRight**: `double` — Gets or sets the right padding for separators in the vertical orientation. -- **SeparatorVerticalPaddingTop**: `double` — Gets or sets the top padding for separators in the vertical orientation. -- **ShowOnHover**: `bool` — Gets or sets if the tool actions should display their submenus on mouse hover. -- **ShowTooltipOnHover**: `bool` — Gets or sets if the tool action icon buttons should display their tooltips on mouse hover. -- **StopPropagation**: `bool` — Prevents clicks on the tool actions from bubbling. -- **SubmenuBackgroundColor**: `string` — Gets or sets the background color for submenus. -- **SubtitleFontFamily**: `string` -- **SubtitleFontSize**: `double` -- **SubtitleFontStyle**: `string` -- **SubtitleFontWeight**: `string` -- **SubtitleTextColor**: `string` — Gets or sets the color to use for the subtitle of the component. -- **TextColor**: `string` — Gets or sets the color to use for the text of the component. -- **ToolTipBackgroundColor**: `string` — Gets or sets the tooltip background color. -- **ToolTipCornerRadius**: `double` — Gets or sets the tooltip corner radius. -- **ToolTipElevation**: `double` — Gets or sets the shadow elevation for the tooltip. -- **ToolTipTextColor**: `string` — Gets or sets the tooltip text color. -- **Type**: `string` -- **UncheckedBackgroundColor**: `string` — Gets or sets the background color of the radio when in the unchecked state. -- **UncheckedBorderColor**: `string` — Gets or sets the border color of the radio when in the unchecked state. -- **CloseSubmenus**(): void -- **CloseSubmenusAsync**(): Task — Forces any open sub menus to close. -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task -- **FindByName**(name: string): object -- **FlushRefresh**(): void -- **FlushRefreshAsync**(): Task -- **GetBoolContextItem**(key: string): bool -- **GetBoolContextItemAsync**(key: string): Task -- **GetBrushContextItem**(key: string): string -- **GetBrushContextItemAsync**(key: string): Task -- **GetColorContextItem**(key: string): string -- **GetColorContextItemAsync**(key: string): Task -- **GetDataContextItem**(key: string): object -- **GetDataContextItemAsync**(key: string): Task -- **GetDoubleContextItem**(key: string): double -- **GetDoubleContextItemAsync**(key: string): Task -- **GetIntContextItem**(key: string): int -- **GetIntContextItemAsync**(key: string): Task -- **GetStringContextItem**(key: string): string -- **GetStringContextItemAsync**(key: string): Task -- **Refresh**(): void -- **RefreshAsync**(): Task -- **SetBoolContextItem**(key: string, value: bool): void -- **SetBoolContextItemAsync**(key: string, value: bool): Task -- **SetBrushContextItem**(key: string, value: string): void -- **SetBrushContextItemAsync**(key: string, value: string): Task -- **SetColorContextItem**(key: string, value: string): void -- **SetColorContextItemAsync**(key: string, value: string): Task -- **SetDataContextItem**(key: string, value: object): void -- **SetDataContextItemAsync**(key: string, value: object): Task -- **SetDoubleContextItem**(key: string, value: double): void -- **SetDoubleContextItemAsync**(key: string, value: double): Task -- **SetIntContextItem**(key: string, value: int): void -- **SetIntContextItemAsync**(key: string, value: int): Task -- **SetStringContextItem**(key: string, value: string): void -- **SetStringContextItemAsync**(key: string, value: string): Task - -### [IgbToolPanelContentRefreshedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolPanelContentRefreshedEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolPanelContextChangedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolPanelContextChangedEventArgs) - -- **constructor**(): void -- **ContextKey**: `string` -- **NewValue**: `object` -- **NewValueScript**: `string` — Provides a means of setting NewValue in the JavaScript environment. -- **OldValue**: `object` -- **OldValueScript**: `string` — Provides a means of setting OldValue in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolPanelContextSwappedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolPanelContextSwappedEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolPanelModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolPanelModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolbar](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolbar) - -- **constructor**(): void -- **AccentColor**: `string` -- **Actions**: `IgbToolActionCollection` — Gets or sets the data or data source instance to which to bind the grid. -- **ActualActions**: `IgbToolActionCollection` — Gets or sets the data or data source instance to which to bind the grid. -- **AutoGeneratedActions**: `IgbToolActionCollection` — Gets or sets the data or data source instance to which to bind the grid. -- **BackgroundColor**: `string` — Gets or sets the color to use for the background of the component. -- **BaseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the checkbox. -- **CellFontFamily**: `string` -- **CellFontSize**: `double` -- **CellFontStyle**: `string` -- **CellFontWeight**: `string` -- **CheckedBackgroundColor**: `string` — Gets or sets the background color of the radio when in the checked state. -- **CheckedBorderColor**: `string` — Gets or sets the border color of the radio when in the checked state. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or sets the display density to use for the toolbar. -- **DisabledTextColor**: `string` — Gets or sets the color to use for the text in disabled tool actions. -- **DropdownClickBuffer**: `int` — Gets or sets the amount of time to wait when clicking on the icon menu button while the dropdown is opening. If a click was executed within this buffer window the dropdown will be left open. Otherwise it will close it. Setting a negative value will always keep the dropdown open during a hover open and will require an extra click to close. -- **DropdownDelay**: `int` — Gets or sets the dropdown delay time in milliseconds. -- **GroupHeaderBackgroundColor**: `string` — Gets or sets the group header background color. -- **GroupHeaderFontFamily**: `string` -- **GroupHeaderFontSize**: `double` -- **GroupHeaderFontStyle**: `string` -- **GroupHeaderFontWeight**: `string` -- **GroupHeaderSubtitleTextColor**: `string` — Gets or sets the text color for group header subtitles. -- **GroupHeaderTextColor**: `string` — Gets or sets the text color for group header tool actions. -- **HighlightColor**: `string` -- **HighlightRadius**: `double` -- **HighlightWidth**: `double` -- **HoverBackgroundColor**: `string` — Gets or sets the hover background color. -- **IconFill**: `string` — Gets or sets the fill color of icons in the ToolPanel. -- **IconStroke**: `string` — Gets or sets the stroke color of icons in the ToolPanel. -- **MenuArrowStroke**: `string` — Gets or sets the stroke color for all icon menu dropdown arrows. -- **OnCommand**: `EventCallback` -- **OnCommandScript**: `string` -- **Orientation**: `ToolbarOrientation` — Gets or sets the orientation of the toolbar. -- **ParentTypeName**: `string` -- **RowHeight**: `int` — Gets or sets the row height that should be used. -- **ScrollbarStyle**: `ScrollbarStyle` — Gets or sets the style of scrollbar. -- **SeparatorBackgroundColor**: `string` — Gets or sets the separator background color. -- **SeparatorHorizontalPaddingBottom**: `double` — Gets or sets the bottom padding for separators in the horizontal orientation. -- **SeparatorHorizontalPaddingLeft**: `double` — Gets or sets the left padding for separators in the horizontal orientation. -- **SeparatorHorizontalPaddingRight**: `double` — Gets or sets the right padding for separators in the horizontal orientation. -- **SeparatorHorizontalPaddingTop**: `double` — Gets or sets the top padding for separators in the horizontal orientation. -- **SeparatorVerticalPaddingBottom**: `double` — Gets or sets the bottom padding for separators in the vertical orientation. -- **SeparatorVerticalPaddingLeft**: `double` — Gets or sets the left padding for separators in the vertical orientation. -- **SeparatorVerticalPaddingRight**: `double` — Gets or sets the right padding for separators in the vertical orientation. -- **SeparatorVerticalPaddingTop**: `double` — Gets or sets the top padding for separators in the vertical orientation. -- **ShowOnHover**: `bool` — Gets or sets if the tool actions should display their submenus on mouse hover. -- **ShowTooltipOnHover**: `bool` — Gets or sets if the tool action icon buttons should display their tooltips on mouse hover. -- **StopPropagation**: `bool` — Prevents clicks on the tool actions from bubbling. -- **SubMenuClosing**: `EventCallback` -- **SubMenuClosingScript**: `string` -- **SubMenuOpening**: `EventCallback` -- **SubMenuOpeningScript**: `string` -- **SubmenuBackgroundColor**: `string` — Gets or sets the background color for submenus. -- **SubtitleFontFamily**: `string` -- **SubtitleFontSize**: `double` -- **SubtitleFontStyle**: `string` -- **SubtitleFontWeight**: `string` -- **SubtitleTextColor**: `string` — Gets or sets the text color for subtitles. -- **Target**: `object` — Gets or sets a target component which the toolbar can request actions from. -- **TargetScript**: `string` — Provides a means of setting Target in the JavaScript environment. -- **TextColor**: `string` — Gets or sets the color to use for the text of the component. -- **ToolTipBackgroundColor**: `string` — Gets or sets the tooltip background color. -- **ToolTipCornerRadius**: `double` — Gets or sets the tooltip corner radius. -- **ToolTipElevation**: `double` — Gets or sets the shadow elevation for the tooltip. -- **ToolTipTextColor**: `string` — Gets or sets the tooltip text color. -- **Type**: `string` -- **UncheckedBackgroundColor**: `string` — Gets or sets the background color of the radio when in the unchecked state. -- **UncheckedBorderColor**: `string` — Gets or sets the border color of the radio when in the unchecked state. -- **CloseSubmenus**(): void -- **CloseSubmenusAsync**(): Task — Forces any open sub menus to close. -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Returns a serialized copy of the exported visual model -- **ExportVisualData**(): object -- **ExportVisualDataAsync**(): Task — Exports visual information about the current state of the grid. -- **FindByName**(name: string): object -- **FlushRefresh**(): void -- **FlushRefreshAsync**(): Task -- **GetBoolContextItem**(key: string): bool -- **GetBoolContextItemAsync**(key: string): Task -- **GetBrushContextItem**(key: string): string -- **GetBrushContextItemAsync**(key: string): Task -- **GetColorContextItem**(key: string): string -- **GetColorContextItemAsync**(key: string): Task -- **GetDataContextItem**(key: string): object -- **GetDataContextItemAsync**(key: string): Task -- **GetDataURLFromCache**(iconCollection: string, iconName: string): string -- **GetDataURLFromCacheAsync**(iconCollection: string, iconName: string): Task -- **GetDesiredSize**(): Size -- **GetDesiredSizeAsync**(): Task — Get the desired size the toolbar wants to be. -- **GetDoubleContextItem**(key: string): double -- **GetDoubleContextItemAsync**(key: string): Task -- **GetExternalDataContextItem**(key: string): object -- **GetExternalDataContextItemAsync**(key: string): Task -- **GetExternalDoubleContextItem**(key: string): double -- **GetExternalDoubleContextItemAsync**(key: string): Task -- **GetExternalIntContextItem**(key: string): int -- **GetExternalIntContextItemAsync**(key: string): Task -- **GetIconFromCache**(iconCollection: string, iconName: string): string -- **GetIconFromCacheAsync**(iconCollection: string, iconName: string): Task -- **GetIconSource**(iconCollection: string, iconName: string): object -- **GetIconSourceAsync**(iconCollection: string, iconName: string): Task -- **GetIntContextItem**(key: string): int -- **GetIntContextItemAsync**(key: string): Task -- **GetMultiPathSVGFromCache**(iconCollection: string, iconName: string): string[] -- **GetMultiPathSVGFromCacheAsync**(iconCollection: string, iconName: string): Task -- **GetStringContextItem**(key: string): string -- **GetStringContextItemAsync**(key: string): Task -- **IsOpen**(): bool -- **IsOpenAsync**(): Task — Is a dropdown menu or tooltip currently open. -- **OnCommandStateChanged**(id: string, type: ToolCommandStateType, value: object): void -- **OnCommandStateChangedAsync**(id: string, type: ToolCommandStateType, value: object): Task -- **RegisterIconFromDataURL**(iconCollection: string, iconName: string, dataURL: string): void -- **RegisterIconFromDataURLAsync**(iconCollection: string, iconName: string, dataURL: string): Task -- **RegisterIconFromText**(iconCollection: string, iconName: string, iconText: string): void -- **RegisterIconFromTextAsync**(iconCollection: string, iconName: string, iconText: string): Task -- **RegisterIconSource**(iconCollection: string, iconName: string, source: object): void -- **RegisterIconSourceAsync**(iconCollection: string, iconName: string, source: object): Task -- **RegisterMultiPathSVG**(iconCollection: string, iconName: string, multiPathSVG: string[]): void -- **RegisterMultiPathSVGAsync**(iconCollection: string, iconName: string, multiPathSVG: string[]): Task -- **SetBoolContextItem**(key: string, value: bool): void -- **SetBoolContextItemAsync**(key: string, value: bool): Task -- **SetBrushContextItem**(key: string, value: string): void -- **SetBrushContextItemAsync**(key: string, value: string): Task -- **SetColorContextItem**(key: string, value: string): void -- **SetColorContextItemAsync**(key: string, value: string): Task -- **SetDataContextItem**(key: string, value: object): void -- **SetDataContextItemAsync**(key: string, value: object): Task -- **SetDoubleContextItem**(key: string, value: double): void -- **SetDoubleContextItemAsync**(key: string, value: double): Task -- **SetExternalDataContextItem**(key: string, value: object): void -- **SetExternalDataContextItemAsync**(key: string, value: object): Task -- **SetExternalDoubleContextItem**(key: string, value: object): void -- **SetExternalDoubleContextItemAsync**(key: string, value: object): Task -- **SetExternalIntContextItem**(key: string, value: object): void -- **SetExternalIntContextItemAsync**(key: string, value: object): Task -- **SetIntContextItem**(key: string, value: int): void -- **SetIntContextItemAsync**(key: string, value: int): Task -- **SetStringContextItem**(key: string, value: string): void -- **SetStringContextItemAsync**(key: string, value: string): Task - -### [IgbToolbarModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolbarModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbToolbarSubMenuClosingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolbarSubMenuClosingEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbToolbarSubMenuOpeningEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbToolbarSubMenuOpeningEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTooltip](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTooltip) -Provides a way to display supplementary information related to an element when a user interacts with it (e.g., hover, focus). It offers features such as placement customization, delays, sticky mode, and animations. - -- **constructor**(): void -- **Anchor**: `string` — An element instance or an IDREF to use as the anchor for the tooltip. Trying to bind to an IDREF that does not exist in the current DOM root at will not work. In such scenarios, it is better to get a DOM reference and pass it to the tooltip instance. -- **Closed**: `EventCallback` -- **ClosedScript**: `string` -- **Closing**: `EventCallback` -- **ClosingScript**: `string` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **DisableArrow**: `bool` — Whether to disable the rendering of the arrow indicator for the tooltip. -- **HideDelay**: `double` — Specifies the number of milliseconds that should pass before hiding the tooltip. 300 -- **HideTriggers**: `string` — Which event triggers will hide the tooltip. Expects a comma separate string of different event triggers. pointerleave, click -- **Message**: `string` — Specifies a plain text as tooltip content. -- **Offset**: `double` — The offset of the tooltip from the anchor in pixels. 6 -- **Open**: `bool` — Whether the tooltip is showing. false -- **Opened**: `EventCallback` -- **OpenedScript**: `string` -- **Opening**: `EventCallback` -- **OpeningScript**: `string` -- **Placement**: `PopoverPlacement` — Where to place the floating element relative to the parent anchor element. bottom -- **ShowDelay**: `double` — Specifies the number of milliseconds that should pass before showing the tooltip. 200 -- **ShowTriggers**: `string` — Which event triggers will show the tooltip. Expects a comma separate string of different event triggers. pointerenter -- **Sticky**: `bool` — Specifies if the tooltip remains visible until the user closes it via the close button or Esc key. false -- **SupportsVisualChildren**: `bool` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **WithArrow**: `bool` — Whether to render an arrow indicator for the tooltip. false -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **Hide**(): bool -- **HideAsync**(): Task — Hides the tooltip if not already hidden. -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Show**(target: string): bool -- **ShowAsync**(target: string): Task — Shows the tooltip if not already showing. If a target is provided, sets it as a transient anchor. -- **Toggle**(): bool -- **ToggleAsync**(): Task — Toggles the tooltip between shown/hidden state - -### [IgbTooltipModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTooltipModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTrailingTwelveMonthsExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTrailingTwelveMonthsExpression) -Requests an expression for the TrailingTwelveMonths filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTransactionService](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTransactionService) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbTransactionState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTransactionState) -Represents the final state of items with all transactions combined. - -- **constructor**(): void -- **Id**: `object` — Gets or sets the ID for the state. I.e. an items primary key. -- **IdScript**: `string` — Provides a means of setting Id in the JavaScript environment. -- **TransactionType**: `TransactionType` — Gets or sets how this state was created. -- **Type**: `string` -- **Value**: `object` — Gets or sets the final value with all transaction deltas combined. -- **ValueScript**: `string` — Provides a means of setting Value in the JavaScript environment. -- **Version**: `object` — Gets or sets the version data for this item. Used for concurrency. -- **VersionScript**: `string` — Provides a means of setting Version in the JavaScript environment. -- **FindByName**(name: string): object - -### [IgbTransitionOutCompletedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTransitionOutCompletedEventArgs) -EventArgs class for TransitionOutCompleted events. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTree](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTree) -The tree allows users to represent hierarchical data in a tree-view structure, maintaining parent-child relationships, as well as to define static tree-view structure without a corresponding data model. - -- **constructor**(): void -- **ActiveItem**: `EventCallback` -- **ActiveItemScript**: `string` -- **ContentItems**: `IgbTreeItemCollection` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **ItemCollapsed**: `EventCallback` -- **ItemCollapsedScript**: `string` -- **ItemCollapsing**: `EventCallback` -- **ItemCollapsingScript**: `string` -- **ItemExpanded**: `EventCallback` -- **ItemExpandedScript**: `string` -- **ItemExpanding**: `EventCallback` -- **ItemExpandingScript**: `string` -- **ParentTypeName**: `string` -- **Selection**: `TreeSelection` — The selection state of the tree. -- **SelectionChanged**: `EventCallback` -- **SelectionChangedScript**: `string` -- **SingleBranchExpand**: `bool` — Whether a single or multiple of a parent's child items can be expanded. -- **SupportsVisualChildren**: `bool` -- **ToggleNodeOnClick**: `bool` — Whether clicking over nodes will change their expanded state or not. -- **Type**: `string` -- **UseDirectRender**: `bool` -- **ConnectedCallback**(): void -- **ConnectedCallbackAsync**(): Task -- **EnsureModulesLoaded**(): void -- **ExpandToItem**(item: IgbTreeItem): void -- **ExpandToItemAsync**(item: IgbTreeItem): Task -- **FindByName**(name: string): object -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbTreeGrid](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreeGrid) - -- **constructor**(): void -- **CascadeOnDelete**: `bool` -- **ChildDataKey**: `string` -- **Data**: `object` -- **DataScript**: `string` — Provides a means of setting Data in the JavaScript environment. -- **ExpansionDepth**: `double` -- **ForeignKey**: `string` -- **HasChildrenKey**: `string` -- **Id**: `string` -- **ProcessedRootRecords**: `IgbTreeGridRecord[]` — Returns an array of processed (filtered and sorted) root ITreeGridRecords. // gets the processed root record with index=2 const states = this.grid.processedRootRecords[2]; IgxTreeGridComponent -- **RootRecords**: `IgbTreeGridRecord[]` — Returns an array of the root level ITreeGridRecords. // gets the root record with index=2 const states = this.grid.rootRecords[2]; IgxTreeGridComponent -- **RowLoadingIndicatorTemplate**: `RenderFragment` -- **RowLoadingIndicatorTemplateScript**: `string` — Provides a means of setting RowLoadingIndicatorTemplate in the JavaScript environment. -- **Type**: `string` -- **AddRow**(item: object, parentRowID: object): void — Adds a new row to the grid. If the grid is bound to RemoteJson or LocalJson then you must provide a dictionary or json string with the row data to add. -- **AddRowAsync**(item: object, parentRowID: object): Task — Adds a new row to the grid. If the grid is bound to RemoteJson or LocalJson then you must provide a dictionary or json string with the row data to add. -- **BeginAddRowByIndex**(index: double, asChild: bool): void -- **BeginAddRowByIndexAsync**(index: double, asChild: bool): Task -- **CollapseAll**(): void -- **CollapseAllAsync**(): Task — Collapses all rows. this.grid.collapseAll(); IgxTreeGridComponent -- **EnsureModulesLoaded**(): void -- **ExpandAll**(): void -- **ExpandAllAsync**(): Task — Expands all rows. this.grid.expandAll(); IgxTreeGridComponent -- **FindByName**(name: string): object -- **GetCellByColumn**(rowIndex: double, columnField: string): IgbCellType -- **GetCellByColumnAsync**(rowIndex: double, columnField: string): Task -- **GetCellByKey**(rowSelector: object, columnField: string): IgbCellType -- **GetCellByKeyAsync**(rowSelector: object, columnField: string): Task -- **GetData**(): object -- **GetDefaultExpandState**(record: IgbTreeGridRecord): bool -- **GetDefaultExpandStateAsync**(record: IgbTreeGridRecord): Task -- **GetRowByIndex**(index: double): IgbRowType -- **GetRowByIndexAsync**(index: double): Task — Returns the IgxTreeGridRow by index. const myRow = treeGrid.getRowByIndex(1); index -- **GetRowByKey**(key: object): IgbRowType -- **GetRowByKeyAsync**(key: object): Task — Returns the RowType object by the specified primary key. const myRow = this.treeGrid.getRowByIndex(1); index -- **GetSelectedCells**(): IgbCellType[] -- **GetSelectedCellsAsync**(): Task -- **GetSelectedData**(formatters: bool, headers: bool): object[] -- **GetSelectedDataAsync**(formatters: bool, headers: bool): Task -- **PinRow**(rowID: object, index: double): bool -- **PinRowAsync**(rowID: object, index: double): Task -- **UnpinRow**(rowID: object): bool -- **UnpinRowAsync**(rowID: object): Task - -### [IgbTreeGridModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreeGridModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTreeGridRecord](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreeGridRecord) - -- **constructor**(): void -- **Children**: `IgbTreeGridRecord[]` -- **Data**: `object` -- **Expanded**: `bool` -- **IsFilteredOutParent**: `bool` -- **Key**: `object` -- **Level**: `double` -- **RecordParent**: `IgbTreeGridRecord` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTreeItem](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreeItem) -The tree-item component represents a child item of the tree component or another tree item. - -- **constructor**(): void -- **Active**: `bool` — Marks the item as the tree's active item. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **DirectRenderElementName**: `string` -- **Disabled**: `bool` — Get/Set whether the tree item is disabled. Disabled items are ignored for user interactions. -- **Expanded**: `bool` — The tree item expansion state. -- **Label**: `string` — The tree item label. -- **Level**: `double` — The depth of the item, relative to the root. -- **Loading**: `bool` — To be used for load-on-demand scenarios in order to specify whether the item is loading data. -- **Parent**: `IgbTreeItem` — The parent item of the current tree item (if any) -- **Selected**: `bool` — The tree item selection state. -- **SupportsVisualChildren**: `bool` -- **TreeParent**: `BaseRendererControl` -- **Type**: `string` -- **UseDirectRender**: `bool` -- **Value**: `object` — The value entry that the tree item is visualizing. Required for searching through items. any -- **Collapse**(): void -- **CollapseAsync**(): Task — Collapses the tree item. -- **CollapseWithEvent**(): void -- **CollapseWithEventAsync**(): Task — Collapses the tree item. -- **ConnectedCallback**(): void -- **ConnectedCallbackAsync**(): Task -- **DisconnectedCallback**(): void -- **DisconnectedCallbackAsync**(): Task -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **Expand**(): void -- **ExpandAsync**(): Task — Expands the tree item. -- **ExpandWithEvent**(): void -- **ExpandWithEventAsync**(): Task — Expands the tree item. -- **FindByName**(name: string): object -- **GetPath**(): IgbTreeItem[] -- **GetPathAsync**(): Task -- **OnInitializedAsync**(): Task -- **ResolveDisplay**(): string -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **Toggle**(): void -- **ToggleAsync**(): Task — Toggles tree item expansion state. - -### [IgbTreeItemCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreeItemCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbTreeItemComponentEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreeItemComponentEventArgs) - -- **constructor**(): void -- **Detail**: `IgbTreeItem` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTreeItemModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreeItemModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTreeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTreeSelectionChangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreeSelectionChangeEventArgs) - -- **constructor**(): void - -### [IgbTreeSelectionEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreeSelectionEventArgs) - -- **constructor**(): void -- **Detail**: `IgbTreeSelectionEventArgsDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTreeSelectionEventArgsDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreeSelectionEventArgsDetail) - -- **constructor**(): void -- **NewSelection**: `IgbTreeItem[]` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTreemap](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreemap) - -- **constructor**(): void -- **ActualHighlightingMode**: `TreemapHighlightingMode` — Gets the actual highlighting mode used. -- **ActualInteractionPixelScalingRatio**: `double` — Gets or sets the resolved scaling value used to affect the pixel density of the control while it is animating. -- **ActualPixelScalingRatio**: `double` -- **ActualStyleMappings**: `IgbTreemapNodeStyleMappingCollection` -- **BreadcrumbSequence**: `string` — Gets or sets the root title to use for breadcrumbs. -- **ContentStyleMappings**: `IgbTreemapNodeStyleMappingCollection` -- **CustomValueMemberPath**: `string` — Gets or sets the path to use to get the custom value of the items. -- **DarkTextColor**: `string` — Gets or sets the dark text color to use for the nodes. -- **DataSource**: `object` — Gets or sets the (possibly hierarchical) data to assign to the TreeMap. -- **DataSourceScript**: `string` — Provides a means of setting DataSource in the JavaScript environment. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **FillBrushes**: `string` — Gets or sets brushes to use for the fill scale. -- **FillScaleLogarithmBase**: `int` — Gets or sets the logarithm base to use if the fill scale is logarithmic. -- **FillScaleMaximumValue**: `double` — Gets or sets the maximum value to use for the fill scale. -- **FillScaleMinimumValue**: `double` — Gets or sets the minimum value to use for the fill scale. -- **FillScaleMode**: `TreemapFillScaleMode` — Gets or sets mode to use for the fill scale. -- **FocusItem**: `object` — Gets or sets the item to drill to in the treemap. -- **FocusItemScript**: `string` — Provides a means of setting FocusItem in the JavaScript environment. -- **FontFamily**: `string` -- **FontSize**: `double` -- **FontStyle**: `string` -- **FontWeight**: `string` -- **HeaderBackground**: `string` — Gets or sets the background to use for the header. -- **HeaderDarkTextColor**: `string` — Gets or sets the dark text color to use for the header. -- **HeaderDisplayMode**: `TreemapHeaderDisplayMode` — Gets or sets the font to use for header nodes -- **HeaderFontFamily**: `string` -- **HeaderFontSize**: `double` -- **HeaderFontStyle**: `string` -- **HeaderFontWeight**: `string` -- **HeaderHeight**: `double` — Gets or sets the height to use for the header. -- **HeaderHoverBackground**: `string` — Gets or sets the background to use for the header when it is hovered. -- **HeaderHoverDarkTextColor**: `string` — Gets or sets the dark text color to use for the header when hovered. -- **HeaderHoverTextColor**: `string` — Gets or sets the text color to use for the header. -- **HeaderLabelBottomMargin**: `double` — Gets or sets the bottom margin to use for the header. -- **HeaderLabelLeftMargin**: `double` — Gets or sets the left margin to use for the header. -- **HeaderLabelRightMargin**: `double` — Gets or sets the right margin to use for the header. -- **HeaderLabelTopMargin**: `double` — Gets or sets the top margin to use for the header. -- **HeaderTextColor**: `string` — Gets or sets the text color to use for the header. -- **HighlightedDataSource**: `object` — Gets or sets the data to highlight. -- **HighlightedDataSourceScript**: `string` — Provides a means of setting HighlightedDataSource in the JavaScript environment. -- **HighlightedValueMemberPath**: `string` — Gets or sets the highlighted value mapping property. -- **HighlightedValueOpacity**: `double` — Gets or sets the opacity applied to the node underneath the highlighted value. -- **HighlightedValuesDisplayMode**: `TreemapHighlightedValueDisplayMode` — Gets or sets the display mode for highlighted values. -- **HighlightingFadeOpacity**: `double` — Gets or sets the opacity to use for nodes that are not highlighted when HighlightingMode is set to FadeOthers. -- **HighlightingMode**: `TreemapHighlightingMode` — Gets or sets the highlighting mode to use. -- **HighlightingTransitionDuration**: `int` — Gets or sets the number of milliseconds over which the highlighting effect will render. -- **IdMemberPath**: `string` — Gets or sets the path to use to get the id of the items. -- **InteractionPixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control while it is animating. -- **IsFillScaleLogarithmic**: `bool` — Gets or sets whether the fill scale is logarithmic. -- **LabelBottomMargin**: `double` — Gets or sets the bottom margin to use for the labels. -- **LabelHorizontalAlignment**: `HorizontalAlignment` — Gets or sets the horizontal alignment to use for the node labels. -- **LabelHorizontalFitMode**: `TreemapLabelHorizontalFitMode` — Gets or sets the horizontal fit mode to use for the node labels. -- **LabelLeftMargin**: `double` — Gets or sets the left margin to use for the labels. -- **LabelMemberPath**: `string` — Gets or sets the path to use to get the Label of the items. -- **LabelRightMargin**: `double` — Gets or sets the right margin to use for the labels. -- **LabelTopMargin**: `double` — Gets or sets the top margin to use for the labels. -- **LabelVerticalAlignment**: `VerticalAlignment` — Gets or sets the vertical alignment to use for the node labels. -- **LabelVerticalFitMode**: `TreemapLabelVerticalFitMode` — Gets or sets the vertical fit mode to use for the node labels. -- **LayoutOrientation**: `TreemapOrientation` — Gets or sets the orientation to use for the stripped and slice and dice layout types. -- **LayoutType**: `TreemapLayoutType` — Gets or sets the type of layout to use for the nodes. -- **MinimumDisplaySize**: `double` — Gets or sets the minimum size (width or height) to display a node. -- **NodeOpacity**: `double` — Gets or sets the opacity to use for the nodes. -- **NodePointerEnter**: `Action` -- **NodePointerEnterScript**: `string` -- **NodePointerLeave**: `Action` -- **NodePointerLeaveScript**: `string` -- **NodePointerOver**: `Action` -- **NodePointerOverScript**: `string` -- **NodePointerPressed**: `EventCallback` -- **NodePointerPressedScript**: `string` -- **NodePointerReleased**: `EventCallback` -- **NodePointerReleasedScript**: `string` -- **NodeRenderStyling**: `EventCallback` -- **NodeRenderStylingScript**: `string` -- **NodeStyling**: `EventCallback` -- **NodeStylingScript**: `string` -- **Outline**: `string` — Gets or sets the outline to use for the nodes. -- **OverlayHeaderBackground**: `string` — Gets or sets the background to use for the overlay header. -- **OverlayHeaderHoverBackground**: `string` — Gets or sets the background to use for the overlay header when it is hovered. -- **OverlayHeaderLabelBottomMargin**: `double` — Gets or sets the bottom margin to use for the overlay header. -- **OverlayHeaderLabelLeftMargin**: `double` — Gets or sets the left margin to use for the overlay header. -- **OverlayHeaderLabelRightMargin**: `double` — Gets or sets the right margin to use for the overlay header. -- **OverlayHeaderLabelTopMargin**: `double` — Gets or sets the top margin to use for the overlay header. -- **ParentIdMemberPath**: `string` — Gets or sets the path to use to get the Parent of the items. -- **ParentNodeBottomMargin**: `double` — Gets or sets the bottom margin to use for the parent nodes. -- **ParentNodeBottomPadding**: `double` — Gets or sets the bottom padding to use for the parent nodes. -- **ParentNodeLeftMargin**: `double` — Gets or sets the left margin to use for the parent nodes. -- **ParentNodeLeftPadding**: `double` — Gets or sets the left padding to use for the parent nodes. -- **ParentNodeRightMargin**: `double` — Gets or sets the right margin to use for the parent nodes. -- **ParentNodeRightPadding**: `double` — Gets or sets the right padding to use for the parent nodes. -- **ParentNodeTopMargin**: `double` — Gets or sets the top margin to use for the parent nodes. -- **ParentNodeTopPadding**: `double` — Gets or sets the top padding to use for the parent nodes. -- **ParentTypeName**: `string` -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **RootTitle**: `string` — Gets or sets the root title to use for breadcrumbs. -- **StrokeThickness**: `double` — Gets or sets the stroke thickness to use for the node outline. -- **StyleMappings**: `IgbTreemapNodeStyleMappingCollection` — Represents a series of mappings to provide style to various nodes within the treemap. -- **TextColor**: `string` — Gets or sets the text color to use for the nodes. -- **TransitionDuration**: `int` — Gets or sets the number of milliseconds over which changes to the gauge should be animated. -- **Type**: `string` -- **ValueMemberPath**: `string` — Gets or sets path to use to get the values from the items. -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualData**(): string -- **ExportSerializedVisualDataAsync**(): Task — Returns visuals as a serialized string. -- **FindByName**(name: string): object -- **Flush**(): void -- **FlushAsync**(): Task -- **MarkDirty**(): void -- **MarkDirtyAsync**(): Task -- **NotifyClearItems**(source_: object): void -- **NotifyClearItemsAsync**(source_: object): Task — Manually notifies the treemap's data source that the data it has bound to has been cleared and needs to be re-examined. This should not be called if the data that the pie chart is bound to is already observable. -- **NotifyInsertItem**(source_: object, index: int, newItem: object): void -- **NotifyInsertItemAsync**(source_: object, index: int, newItem: object): Task -- **NotifyRemoveItem**(source_: object, index: int, oldItem: object): void -- **NotifyRemoveItemAsync**(source_: object, index: int, oldItem: object): Task -- **NotifySetItem**(source_: object, index: int, oldItem: object, newItem: object): void -- **NotifySetItemAsync**(source_: object, index: int, oldItem: object, newItem: object): Task -- **NotifySizeChanged**(): void -- **NotifySizeChangedAsync**(): Task -- **OnAttachedToUI**(): void -- **OnAttachedToUIAsync**(): Task -- **OnDetachedFromUI**(): void -- **OnDetachedFromUIAsync**(): Task -- **SimulateHover**(point: Point): void -- **SimulateHoverAsync**(point: Point): Task - -### [IgbTreemapModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreemapModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTreemapNodePointerEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreemapNodePointerEventArgs) - -- **constructor**(): void -- **CustomValue**: `object` -- **CustomValueScript**: `string` — Provides a means of setting CustomValue in the JavaScript environment. -- **IsHandled**: `bool` -- **IsOverHeader**: `bool` -- **IsRightButton**: `bool` -- **Item**: `object` -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Label**: `string` -- **ParentItem**: `object` -- **ParentItemScript**: `string` — Provides a means of setting ParentItem in the JavaScript environment. -- **ParentLabel**: `string` -- **ParentSum**: `double` -- **ParentValue**: `double` -- **Position**: `Point` -- **Sum**: `double` -- **Type**: `string` -- **Value**: `double` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTreemapNodeStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreemapNodeStyle) -Represents a style to apply to a treemap node. - -- **constructor**(): void -- **FadeOpacity**: `double` — Gets or sets the fade opacity that should be used when highlighting. -- **Fill**: `string` — Gets or sets the fill color to use for the nodes. -- **HeaderBackground**: `string` — Gets or sets the background to use for the header. -- **HeaderHeight**: `double` — Gets or sets the height to use for the header. -- **HeaderHoverBackground**: `string` — Gets or sets the background to use for the header when it is hovered. -- **HeaderHoverTextColor**: `string` — Gets or sets the text color to use for the header. -- **HeaderLabelBottomMargin**: `double` — Gets or sets the bottom margin to use for the labels. -- **HeaderLabelLeftMargin**: `double` — Gets or sets the left margin to use for the header. -- **HeaderLabelRightMargin**: `double` — Gets or sets the right margin to use for the header. -- **HeaderLabelTopMargin**: `double` — Gets or sets the top margin to use for the header. -- **HeaderTextColor**: `string` — Gets or sets the text color to use for the header. -- **HighlightingHandled**: `bool` — Gets or sets if highlighting was handled, and whether internal highlighting logic should be skipped. -- **Label**: `string` — Gets or sets the label to use for the node. -- **LabelBottomMargin**: `double` — Gets or sets the bottom margin to use for the labels. -- **LabelHorizontalAlignment**: `HorizontalAlignment` — Gets or sets the horizontal alignment to use for the node labels. -- **LabelLeftMargin**: `double` — Gets or sets the left margin to use for the labels. -- **LabelRightMargin**: `double` — Gets or sets the right margin to use for the labels. -- **LabelTopMargin**: `double` — Gets or sets the top margin to use for the labels. -- **LabelVerticalAlignment**: `VerticalAlignment` — Gets or sets the vertical alignment to use for the node labels. -- **Opacity**: `double` — Gets or sets the opacity to use for the node. -- **Outline**: `string` — Gets or sets the outline to use for the nodes. -- **StrokeThickness**: `double` — Gets or sets the stroke thickness to use for the node outline. -- **TextColor**: `string` — Gets or sets the text color to use for the nodes. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbTreemapNodeStyleMapping](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreemapNodeStyleMapping) -Represents a style to apply to a set of nodes in the treemap. - -- **constructor**(): void -- **MappingMode**: `TreemapValueMappingMode` — Gets or sets the mapping mode to use to evaluate whether the mapping applies. -- **MaximumValue**: `double` — Gets or sets the maximum value to which the mapping applies. -- **MinimumValue**: `double` — Gets or sets the minimum value to which the mapping applies. -- **TargetType**: `TreemapNodeStyleMappingTargetType` — Gets or sets the unique name of the mapping. -- **TreemapParent**: `BaseRendererControl` -- **Type**: `string` -- **Value**: `object` — Gets or sets the value to which the mapping applies. -- **Dispose**(): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **OnInitializedAsync**(): Task - -### [IgbTreemapNodeStyleMappingCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreemapNodeStyleMappingCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbTreemapNodeStyleMappingModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreemapNodeStyleMappingModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTreemapNodeStyleModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreemapNodeStyleModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTreemapNodeStylingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTreemapNodeStylingEventArgs) - -- **constructor**(): void -- **CustomValue**: `object` -- **CustomValueScript**: `string` — Provides a means of setting CustomValue in the JavaScript environment. -- **HighlightingHandled**: `bool` — Sets whether the user handled the highlighting themselves. If so we won't run any of our default highlight styling. -- **HighlightingInfo**: `IgbHighlightingInfo` — Gets highlighting information for the current node. Null if no highlight is in progress. -- **IsHighlightInProgress**: `bool` — Gets whether a highlight is currently in progress. -- **IsParent**: `bool` -- **Item**: `object` -- **ItemScript**: `string` — Provides a means of setting Item in the JavaScript environment. -- **Label**: `string` -- **ParentItem**: `object` -- **ParentItemScript**: `string` — Provides a means of setting ParentItem in the JavaScript environment. -- **ParentLabel**: `string` -- **ParentSum**: `double` -- **ParentValue**: `double` -- **Style**: `IgbTreemapNodeStyle` -- **Sum**: `double` -- **TotalHighlightProgress**: `double` — Gets the overall highlight progress. -- **Type**: `string` -- **Value**: `double` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTrendLineLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTrendLineLayer) -Represents the class of the value overlay. The value overlay is a line or circle representing a value on an axis. - -- **constructor**(): void -- **ActualTargetSeries**: `IgbSeries` — Gets the actual series being targeted by this annotation. -- **ActualTargetSeriesScript**: `string` — Provides a means of setting ActualTargetSeries in the JavaScript environment. -- **TargetSeries**: `IgbSeries` — Gets or sets the series to target this annotation to. -- **TargetSeriesName**: `string` — Gets or sets the name to use to resolve targetSeries from markup. -- **TargetSeriesScript**: `string` — Provides a means of setting TargetSeries in the JavaScript environment. -- **TrendLinePeriod**: `int` — Gets or sets the trend line period for the target series. -- **TrendLineType**: `TrendLineType` — Gets or sets the trend type for the current series object. -- **Type**: `string` -- **BindSeries**(Series: IgbSeries[]): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetManagerIdentifier**(): string -- **GetManagerIdentifierAsync**(): Task - -### [IgbTrendLineLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTrendLineLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbTrendLineTypeCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTrendLineTypeCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbTriangulationDataSource](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTriangulationDataSource) -Class for converting Itf files into enumerable triangulations. - -- **constructor**(): void -- **ImportCompleted**: `EventCallback` -- **ImportCompletedScript**: `string` -- **Type**: `string` -- **FindByName**(name: string): object - -### [IgbTriangulationStatusEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTriangulationStatusEventArgs) - -- **constructor**(): void -- **CurrentStatus**: `int` — The current status from 0 to 100 of the progressive triangulation. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbTypicalPriceIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTypicalPriceIndicator) -Represents a IgbDataChart Typical Price indicator series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbTypicalPriceIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbTypicalPriceIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUltimateOscillatorIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUltimateOscillatorIndicator) -Represents a IgbDataChart Ultimate Oscillator indicator series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbUltimateOscillatorIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUltimateOscillatorIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleBgModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleBgModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleCsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleCsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleDaModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleDaModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleDeModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleDeModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleEnModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleEnModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleEsModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleEsModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleFrModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleFrModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleHuModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleHuModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleItModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleItModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleJaModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleJaModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleNbModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleNbModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleNlModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleNlModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocalePlModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocalePlModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocalePtModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocalePtModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleRoModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleRoModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleRuModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleRuModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleSvModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleSvModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleTrModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleTrModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleZhHansModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleZhHansModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUndoLocaleZhHantModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUndoLocaleZhHantModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUploadDataCompletedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUploadDataCompletedEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbUploadStringCompletedEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUploadStringCompletedEventArgs) - -- **constructor**(): void -- **Result**: `string` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbUserAnnotationCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserAnnotationCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbUserAnnotationInformation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserAnnotationInformation) - -- **constructor**(): void -- **AnnotationData**: `string` -- **AnnotationId**: `string` -- **BadgeColor**: `string` -- **BadgeImageUri**: `string` -- **DialogSuggestedXLocation**: `double` -- **DialogSuggestedYLocation**: `double` -- **Label**: `string` -- **MainColor**: `string` -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbUserAnnotationInformationEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserAnnotationInformationEventArgs) - -- **constructor**(): void -- **AnnotationInfo**: `IgbUserAnnotationInformation` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbUserAnnotationInformationModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserAnnotationInformationModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUserAnnotationLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserAnnotationLayer) -Represents an user annotation layer that can define UserPointAnnotation, UserSliceAnnotation, UserStripAnnotation - -- **constructor**(): void -- **Annotations**: `IgbUserAnnotationCollection` — Gets user annotations -- **StylingAxisAnnotation**: `EventCallback` -- **StylingAxisAnnotationScript**: `string` -- **StylingPointAnnotation**: `EventCallback` -- **StylingPointAnnotationScript**: `string` -- **StylingSliceAnnotation**: `EventCallback` -- **StylingSliceAnnotationScript**: `string` -- **StylingStripAnnotation**: `EventCallback` -- **StylingStripAnnotationScript**: `string` -- **Type**: `string` -- **UserAnnotationInformationRequested**: `EventCallback` -- **UserAnnotationInformationRequestedScript**: `string` -- **CancelAnnotationFlow**(annotationFlowID: string): void -- **CancelAnnotationFlowAsync**(annotationFlowID: string): Task -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FinishAnnotationFlow**(info: IgbUserAnnotationInformation): void -- **FinishAnnotationFlowAsync**(info: IgbUserAnnotationInformation): Task -- **LoadAnnotationsFromJson**(jsonString: string): void -- **LoadAnnotationsFromJsonAsync**(jsonString: string): Task -- **SaveAnnotationsToJson**(): string -- **SaveAnnotationsToJsonAsync**(): Task - -### [IgbUserAnnotationLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserAnnotationLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUserAnnotationToolTipContentUpdatingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserAnnotationToolTipContentUpdatingEventArgs) -Information about the user annotation content which is being created or updated. - -- **constructor**(): void -- **AnnotationInfo**: `IgbUserAnnotationInformation` -- **Content**: `object` -- **ContentScript**: `string` — Provides a means of setting Content in the JavaScript environment. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbUserAnnotationToolTipLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserAnnotationToolTipLayer) -Represents an annotation layer that displays tooltips for all target series individually. - -- **constructor**(): void -- **ContentUpdating**: `Action` -- **ContentUpdatingScript**: `string` -- **SkipUnknownValues**: `bool` — Gets or sets whether to skip past unknown values when searching for series values. -- **TargetSeries**: `IgbSeries` — Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously. -- **TargetSeriesName**: `string` — Gets or sets the name of the series series to target this annotation to. If null, this annotation targets all series simultaneously. -- **TargetSeriesScript**: `string` — Provides a means of setting TargetSeries in the JavaScript environment. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **HideToolTips**(): void -- **HideToolTipsAsync**(): Task — Hides any tooltips presented by the layer, if any. -- **HideToolTipsImmediate**(): void -- **HideToolTipsImmediateAsync**(): Task — Hides any tooltips presented by the layer, if any. - -### [IgbUserAnnotationToolTipLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserAnnotationToolTipLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUserAxisAnnotation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserAxisAnnotation) -Represents an user annotation for rendering annotation of axis label - -- **constructor**(): void -- **TargetAxis**: `IgbAxis` — Gets or sets the target axis that will display the annotation. -- **TargetAxisMatcher**: `IgbAxisMatcher` — Gets or sets a matcher for matching an axis that will display the annotation. -- **TargetAxisName**: `string` — Gets or sets the name to use to resolve targetAxis from markup. -- **TargetAxisScript**: `string` — Provides a means of setting TargetAxis in the JavaScript environment. -- **Type**: `string` -- **Value**: `double` — Gets or sets the value that determines location of annotation on axis. -- **BindAxes**(Axes: IgbAxis[]): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbUserAxisAnnotationModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserAxisAnnotationModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUserAxisAnnotationStylingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserAxisAnnotationStylingEventArgs) -Represents the event arguments for the UserAxisAnnotation styling events. - -- **constructor**(): void -- **Annotation**: `IgbUserAxisAnnotation` — The annotation to style. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbUserBaseAnnotation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserBaseAnnotation) -Represents base class for all user annotations, e.g. UserPointAnnotation, UserSliceAnnotation, UserStripAnnotation, UserAxisAnnotation - -- **constructor**(): void -- **AnnotationData**: `string` — Gets or sets the additional data that should be stored with the annotation. -- **BadgeBackground**: `string` — Gets or sets the background of badge annotation. -- **BadgeCornerRadius**: `double` — Gets or sets border radius of the badge annotations. -- **BadgeImagePath**: `string` — Gets or sets image path for displayed in the badge annotations. -- **BadgeMargin**: `double` — Gets or sets margin of the badge annotations. -- **BadgeOutline**: `string` — Gets or sets the outline of badge annotation. -- **BadgeSize**: `double` — Gets or sets size of the badge annotations. -- **BadgeThickness**: `double` — Gets or sets thickness of the badge annotations. -- **BadgeVisible**: `bool` — Gets or sets whether to draw the badge in annotation -- **Identifier**: `string` -- **IsPillShaped**: `bool` — Gets or sets whether the annotation is pill shaped. -- **IsVisible**: `bool` — Gets or sets whether to the annotations is rendered -- **Label**: `string` — Gets or sets the text that should be displayed on axis annotation. -- **LabelBackground**: `string` — Gets or sets the background text displayed in the annotation. -- **LabelBorderColor**: `string` — Gets or sets the border color of the axis annotation. -- **LabelBorderRadius**: `double` — Gets or sets the border radius of the annotation. -- **LabelBorderThickness**: `double` — Gets or sets border thickness of the axis annotations. -- **LabelColor**: `string` — Gets or sets the color of text displayed in the annotation. -- **LabelPadding**: `double` — Gets or sets padding around the label in annotation. -- **Type**: `string` -- **BindAxes**(Axes: IgbAxis[]): void -- **BindSeries**(Series: IgbSeries[]): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbUserPointAnnotation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserPointAnnotation) -Represents an user annotation for rendering data point annotation on a series - -- **constructor**(): void -- **TargetSeries**: `IgbSeries` — Gets or sets the target series that will display the annotation. -- **TargetSeriesMatcher**: `IgbSeriesMatcher` — Gets or sets a matcher for matching a series that will display the annotation. -- **TargetSeriesName**: `string` — Gets or sets the name to use to resolve targetSeries from markup. -- **TargetSeriesScript**: `string` — Provides a means of setting TargetSeries in the JavaScript environment. -- **Type**: `string` -- **XValue**: `double` — Gets or sets the value that determines location of the annotation in the coordinates of x-axis. -- **YValue**: `double` — Gets or sets the value that determines location of the annotation in the coordinates of y-axis. -- **BindSeries**(Series: IgbSeries[]): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbUserPointAnnotationModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserPointAnnotationModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUserPointAnnotationStylingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserPointAnnotationStylingEventArgs) -Represents the event arguments for the UserAxisAnnotation styling events. - -- **constructor**(): void -- **Annotation**: `IgbUserPointAnnotation` — The annotation to style. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbUserShapeAnnotation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserShapeAnnotation) -Represents base class for rendering an annotation with shape of slice of strip - -- **constructor**(): void -- **OverlayText**: `string` — Gets or sets the text that should be overlayed in plot area of the chart. -- **OverlayTextAngle**: `double` — Gets or sets the angle rotation (in degrees) of the overlay text in relation to the annotation shape. -- **OverlayTextBackground**: `string` — Gets or sets the background the overlay text. -- **OverlayTextBackgroundMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the background of overlay text. -- **OverlayTextBackgroundShift**: `double` — Gets or sets the shift of the overlay background based on OverlayTextBackgroundMode. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **OverlayTextBorderColor**: `string` — Gets or sets the border color of the overlay text. -- **OverlayTextBorderMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the border of overlay text. -- **OverlayTextBorderRadius**: `double` — Gets or sets the border radius corner of the overlay text. -- **OverlayTextBorderShift**: `double` — Gets or sets the shift of the overlay border based on OverlayTextBorderMode. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **OverlayTextBorderThickness**: `double` — Gets or sets the border thickness of the overlay text. -- **OverlayTextColor**: `string` — Gets or sets the color the overlay text. -- **OverlayTextColorMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the background of overlay text. -- **OverlayTextColorShift**: `double` — Gets or sets the shift of the overlay text color based on OverlayTextColorMode. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **OverlayTextFontFamily**: `string` -- **OverlayTextFontSize**: `double` -- **OverlayTextFontStyle**: `string` -- **OverlayTextFontWeight**: `string` -- **OverlayTextHorizontalMargin**: `double` — Gets or sets the horizontal margin of the overlay text in relation to the annotation shape. -- **OverlayTextHorizontalPadding**: `double` — Gets or sets the horizontal padding of the overlay text in relation to the annotation shape. -- **OverlayTextLocation**: `OverlayTextLocation` — Gets or sets location of the overlay text in relation to the annotation shape. -- **OverlayTextVerticalMargin**: `double` — Gets or sets the vertical margin of the overlay text in relation to the annotation shape. -- **OverlayTextVerticalPadding**: `double` — Gets or sets the vertical padding of the overlay text in relation to the annotation shape. -- **OverlayTextVisible**: `bool` — Gets or sets whether the overlay text is visible in plot area of the chart -- **ShapeBackground**: `string` — Gets or sets background of the annotation shape displayed in the plot area of the chart. -- **ShapeOutline**: `string` — Gets or sets border color of the annotation shape displayed in the plot area of the chart. -- **ShapeThickness**: `double` — Gets or sets border thickness of the annotation shape displayed in the plot area of the chart. -- **Type**: `string` -- **ValueDisplayMode**: `DataAnnotationDisplayMode` — Gets or sets display mode of label in the center annotation. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbUserSliceAnnotation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserSliceAnnotation) -Represents an user annotation for rendering data slice annotation - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbUserSliceAnnotationModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserSliceAnnotationModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUserSliceAnnotationStylingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserSliceAnnotationStylingEventArgs) -Represents the event arguments for the UserAxisAnnotation styling events. - -- **constructor**(): void -- **Annotation**: `IgbUserSliceAnnotation` — The annotation to style. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbUserStripAnnotation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserStripAnnotation) -Represents an user annotation for rendering data strip annotation - -- **constructor**(): void -- **EndLabel**: `string` — Gets or sets optional text displayed in the label at the end of annotation. -- **EndLabelBackground**: `string` — Gets or sets background of the label at the end of annotation. -- **EndLabelBorderColor**: `string` — Gets or sets border color of the label at the end of annotation. -- **EndLabelColor**: `string` — Gets or sets text color of the label at the end of annotation. -- **EndValue**: `double` — Gets or sets the value that determines end of the annotation on an axis. -- **EndValueDisplayMode**: `DataAnnotationDisplayMode` — Gets or sets display mode of end value of annotation. -- **StartLabel**: `string` — Gets or sets optional text displayed in the label at the start of annotation. -- **StartLabelBackground**: `string` — Gets or sets background of the label at the start of annotation. -- **StartLabelBorderColor**: `string` — Gets or sets border color of the label at the start of annotation. -- **StartLabelColor**: `string` — Gets or sets text color of the label at the start of annotation. -- **StartValue**: `double` — Gets or sets the value that determines start of the annotation on an axis. -- **StartValueDisplayMode**: `DataAnnotationDisplayMode` — Gets or sets display mode of start value of annotation. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbUserStripAnnotationModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserStripAnnotationModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbUserStripAnnotationStylingEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbUserStripAnnotationStylingEventArgs) -Represents the event arguments for the UserAxisAnnotation styling events. - -- **constructor**(): void -- **Annotation**: `IgbUserStripAnnotation` — The annotation to style. -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbValidationErrors](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbValidationErrors) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbValueBrushScale](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbValueBrushScale) -Represents a brush scale that uses value-based brush selection. - -- **constructor**(): void -- **IsLogarithmic**: `bool` — Gets or sets whether the scale is logarithmic. -- **LogarithmBase**: `int` — Gets or sets the logarithm base for this scale. -- **MaximumValue**: `double` — Gets or sets the maximum value for this scale. -- **MinimumValue**: `double` — Gets or sets the minimum value for this scale. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbValueBrushScaleModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbValueBrushScaleModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbValueLayer](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbValueLayer) -Represents an annotation layer that displays crosshair lines that cross through the closest value of the target series under the cursor. - -- **constructor**(): void -- **ActualValueLayerBrush**: `string` — Gets the effective brush for the current value layer. Can be null for value modes that target multiple series. -- **HorizontalLineStroke**: `string` — Gets or sets the color to use for the horizontal line. Leave null for an automatic value. -- **IsAxisAnnotationEnabled**: `bool` — Gets or sets whether to draw annotations over the axes where the crosshair meets with them. -- **OverlayText**: `string` — Gets or sets the text that will be displayed as the overlay annotation. -- **OverlayTextAngle**: `double` — Gets or sets the angle rotation (in degrees) of the overlay text in relation to shape of data annotation. -- **OverlayTextBackground**: `string` — Gets or sets the background the overlay text. -- **OverlayTextBackgroundMatchLayer**: `bool` — Gets or sets whether the overlay text background matches brush of the layer -- **OverlayTextBackgroundMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the background of overlay text based on the target series. -- **OverlayTextBackgroundShift**: `double` — Gets or sets the shift of the overlay background based on OverlayTextBackgroundMode. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **OverlayTextBorderColor**: `string` — Gets or sets the border stroke of the overlay text. -- **OverlayTextBorderMatchLayer**: `bool` — Gets or sets whether the overlay text border matches brush of the layer -- **OverlayTextBorderMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the border of overlay text based on the target series. -- **OverlayTextBorderRadius**: `double` — Gets or sets the border corner of the overlay text. -- **OverlayTextBorderShift**: `double` — Gets or sets the shift of the overlay border based on OverlayTextBorderMode. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **OverlayTextBorderThickness**: `double` — Gets or sets the border thickness of the overlay text. -- **OverlayTextColor**: `string` — Gets or sets the color the overlay text. -- **OverlayTextColorMatchLayer**: `bool` — Gets or sets whether the overlay text color matches brush of the layer -- **OverlayTextColorMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the background of overlay text based on the target series. -- **OverlayTextColorShift**: `double` — Gets or sets the shift of the overlay text color based on OverlayTextColorMode. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **OverlayTextFontFamily**: `string` -- **OverlayTextFontSize**: `double` -- **OverlayTextFontStyle**: `string` -- **OverlayTextFontWeight**: `string` -- **OverlayTextHorizontalMargin**: `double` — Gets or sets the horizontal margin of the overlay text in relation to shape of data annotation. -- **OverlayTextHorizontalPadding**: `double` — Gets or sets the horizontal padding of the overlay text in relation to shape of data annotation. -- **OverlayTextLocation**: `OverlayTextLocation` — Gets or sets location of the overlay text in relation to shape of data annotation. -- **OverlayTextVerticalMargin**: `double` — Gets or sets the vertical margin of the overlay text in relation to shape of data annotation. -- **OverlayTextVerticalPadding**: `double` — Gets or sets the vertical padding of the overlay text in relation to shape of data annotation. -- **OverlayTextVisible**: `bool` — Gets or sets whether the overlay text is visible in shape of data annotation -- **SkipUnknownValues**: `bool` — Gets or sets whether to skip unknown values when searching for series values. -- **StylingOverlayText**: `EventCallback` -- **StylingOverlayTextScript**: `string` -- **TargetAxis**: `IgbAxis` — Gets or sets the axis to target this annotation to. If null, this annotation targets all value axis simultaneously. -- **TargetAxisName**: `string` — Gets or sets the name to use to resolve targetAxis from markup. -- **TargetAxisScript**: `string` — Provides a means of setting TargetAxis in the JavaScript environment. -- **TargetSeries**: `IgbSeries` — Gets or sets the series to target this annotation to. If null, this annotation targets all series simultaneously. -- **TargetSeriesName**: `string` — Gets or sets the name to use to resolve targetSeries from markup. -- **TargetSeriesScript**: `string` — Provides a means of setting TargetSeries in the JavaScript environment. -- **Type**: `string` -- **UseInterpolation**: `bool` — Gets or sets whether to use value interpolation when drawing a line through the best value for the cursor position. -- **ValueMode**: `ValueLayerValueMode` — Gets or sets the value mode for the overlay. -- **VerticalLineStroke**: `string` — Gets or sets the color to use for vertical line. Leave null for an automatic value. -- **XAxisAnnotationBackground**: `string` — Gets or sets the color to use for the x axis annotation backing. Leave unset for an automatic value. -- **XAxisAnnotationBackgroundCornerRadius**: `double` — Gets or sets the corner radius to use for the x axis annotation backing. Leave unset for an automatic value. -- **XAxisAnnotationFormatLabel**: `string` — Sets or gets a function which takes an object that produces a formatted label for the x axis annotation. -- **XAxisAnnotationFormatLabelScript**: `string` — Provides a means of setting XAxisAnnotationFormatLabel in the JavaScript environment. -- **XAxisAnnotationInterpolatedValuePrecision**: `int` — Gets or sets the precision to use displaying values for interpolated crosshair positions. -- **XAxisAnnotationOutline**: `string` — Gets or sets the color to use for the x axis annotation outline. Leave unset for an automatic value. -- **XAxisAnnotationPaddingBottom**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **XAxisAnnotationPaddingLeft**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **XAxisAnnotationPaddingRight**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **XAxisAnnotationPaddingTop**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **XAxisAnnotationStrokeThickness**: `double` — Gets or sets the stroke thickness for the x axis annotation backing. Leave unset for an automatic value. -- **XAxisAnnotationTextColor**: `string` — Gets or sets the color to use for the x axis annotation text. Leave unset for an automatic value. -- **YAxisAnnotationBackground**: `string` — Gets or sets the color to use for the y axis annotation backing. Leave unset for an automatic value. -- **YAxisAnnotationBackgroundCornerRadius**: `double` — Gets or sets the corner radius to use for the y axis annotation backing. Leave unset for an automatic value. -- **YAxisAnnotationFormatLabel**: `string` — Sets or gets a function which takes an object that produces a formatted label for the y axis annotation. -- **YAxisAnnotationFormatLabelScript**: `string` — Provides a means of setting YAxisAnnotationFormatLabel in the JavaScript environment. -- **YAxisAnnotationInterpolatedValuePrecision**: `int` — Gets or sets the precision to use displaying values for interpolated crosshair positions. -- **YAxisAnnotationOutline**: `string` — Gets or sets the color to use for the y axis annotation outline. Leave unset for an automatic value. -- **YAxisAnnotationPaddingBottom**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **YAxisAnnotationPaddingLeft**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **YAxisAnnotationPaddingRight**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **YAxisAnnotationPaddingTop**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **YAxisAnnotationStrokeThickness**: `double` — Gets or sets the stroke thickness for the y axis annotation backing. Leave unset for an automatic value. -- **YAxisAnnotationTextColor**: `string` — Gets or sets the color to use for the y axis annotation text. Leave unset for an automatic value. -- **BindAxes**(Axes: IgbAxis[]): void -- **BindSeries**(Series: IgbSeries[]): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetSeriesValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task - -### [IgbValueLayerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbValueLayerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbValueModeCollection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbValueModeCollection) - -- **constructor**(parent: object, propertyName: string): void - -### [IgbValueOverlay](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbValueOverlay) -Represents the class of the value overlay. The value overlay is a line or circle representing a value on an axis. - -- **constructor**(): void -- **Axis**: `IgbAxis` — Gets or sets the axis used by the value overlay. -- **AxisAnnotationBackground**: `string` — Gets or sets the color to use for the axis annotation backing. Leave unset for an automatic value. -- **AxisAnnotationBackgroundCornerRadius**: `double` — Gets or sets the corner radius to use for the axis annotation backing. Leave unset for an automatic value. -- **AxisAnnotationFormatLabel**: `string` — Sets or gets a function which takes an object that produces a formatted label for the axis annotation. -- **AxisAnnotationFormatLabelScript**: `string` — Provides a means of setting AxisAnnotationFormatLabel in the JavaScript environment. -- **AxisAnnotationInterpolatedValuePrecision**: `int` — Gets or sets the precision to use displaying values for interpolated positions. -- **AxisAnnotationOutline**: `string` — Gets or sets the color to use for the axis annotation outline. Leave unset for an automatic value. -- **AxisAnnotationPaddingBottom**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **AxisAnnotationPaddingLeft**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **AxisAnnotationPaddingRight**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **AxisAnnotationPaddingTop**: `double` — Gets or sets the padding to use withing the axis annotation callout. Leaving this NaN will use an automatic value related to the axis label margins. -- **AxisAnnotationStrokeThickness**: `double` — Gets or sets the stroke thickness for the axis annotation backing. Leave unset for an automatic value. -- **AxisAnnotationTextColor**: `string` — Gets or sets the color to use for the axis annotation text. Leave unset for an automatic value. -- **AxisName**: `string` — Gets or sets the name to use to resolve axis from markup. -- **AxisScript**: `string` — Provides a means of setting Axis in the JavaScript environment. -- **DateValue**: `DateTime` — Gets or sets the value of the overlay as a date. If this is set to something other than the minimum date, then it will be preferred over the Value property. -- **IsAxisAnnotationEnabled**: `bool` — Gets or sets whether to draw annotations over the axes where the crosshair meets with them. -- **OverlayText**: `string` — Gets or sets the text that will be displayed as the overlay annotation. -- **OverlayTextAngle**: `double` — Gets or sets the angle rotation (in degrees) of the overlay text in relation to shape of data annotation. -- **OverlayTextBackground**: `string` — Gets or sets the background the overlay text. -- **OverlayTextBackgroundMatchLayer**: `bool` — Gets or sets whether the overlay text background matches brush of the layer -- **OverlayTextBackgroundMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the background of overlay text based on the target series. -- **OverlayTextBackgroundShift**: `double` — Gets or sets the shift of the overlay background based on OverlayTextBackgroundMode. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **OverlayTextBorderColor**: `string` — Gets or sets the border stroke of the overlay text. -- **OverlayTextBorderMatchLayer**: `bool` — Gets or sets whether the overlay text border matches brush of the layer -- **OverlayTextBorderMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the border of overlay text based on the target series. -- **OverlayTextBorderRadius**: `double` — Gets or sets the border corner of the overlay text. -- **OverlayTextBorderShift**: `double` — Gets or sets the shift of the overlay border based on OverlayTextBorderMode. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **OverlayTextBorderThickness**: `double` — Gets or sets the border thickness of the overlay text. -- **OverlayTextColor**: `string` — Gets or sets the color the overlay text. -- **OverlayTextColorMatchLayer**: `bool` — Gets or sets whether the overlay text color matches brush of the layer -- **OverlayTextColorMode**: `AnnotationAppearanceMode` — Gets or sets the mode used for shifting the background of overlay text based on the target series. -- **OverlayTextColorShift**: `double` — Gets or sets the shift of the overlay text color based on OverlayTextColorMode. Value must range between -1.0 to 1.0, where 0 means no color shift. -- **OverlayTextFontFamily**: `string` -- **OverlayTextFontSize**: `double` -- **OverlayTextFontStyle**: `string` -- **OverlayTextFontWeight**: `string` -- **OverlayTextHorizontalMargin**: `double` — Gets or sets the horizontal margin of the overlay text in relation to shape of data annotation. -- **OverlayTextHorizontalPadding**: `double` — Gets or sets the horizontal padding of the overlay text in relation to shape of data annotation. -- **OverlayTextLocation**: `OverlayTextLocation` — Gets or sets location of the overlay text in relation to shape of data annotation. -- **OverlayTextVerticalMargin**: `double` — Gets or sets the vertical margin of the overlay text in relation to shape of data annotation. -- **OverlayTextVerticalPadding**: `double` — Gets or sets the vertical padding of the overlay text in relation to shape of data annotation. -- **OverlayTextVisible**: `bool` — Gets or sets whether the overlay text is visible in shape of data annotation -- **StylingOverlayText**: `EventCallback` -- **StylingOverlayTextScript**: `string` -- **Type**: `string` -- **Value**: `double` — Gets or sets the value of the overlay. -- **BindAxes**(Axes: IgbAxis[]): void -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemIndex**(world: Point): int -- **GetItemIndexAsync**(world: Point): Task — Gets the item index associated with the specified world position -- **GetLabel**(value: double): string -- **GetLabelAsync**(value: double): Task — Gets the label for a data item. -- **GetSeriesValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **ScrollIntoView**(item: object): bool -- **ScrollIntoViewAsync**(item: object): Task — Requests that the provided item should be brought into view if possible. - -### [IgbValueOverlayModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbValueOverlayModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbValuesChange](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbValuesChange) -Event emitted when values list is changed. - -- **constructor**(): void -- **Type**: `string` -- **Values**: `IgbPivotValue[]` — The new list of values. -- **FindByName**(name: string): object -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task - -### [IgbValuesChangeDetail](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbValuesChangeDetail) -Event emitted when values list is changed. - -- **constructor**(): void -- **Type**: `string` -- **Values**: `IgbPivotValue[]` — The new list of values. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **SetNativeElement**(element: object): void -- **SetNativeElementAsync**(element: object): Task -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbValuesChangeEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbValuesChangeEventArgs) - -- **constructor**(): void -- **Detail**: `IgbValuesChangeDetail` -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbVerticalAnchoredCategorySeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbVerticalAnchoredCategorySeries) -Represents a vertically laid out category based series. - -- **constructor**(): void -- **Type**: `string` -- **XAxis**: `IgbNumericXAxis` — Gets or sets the effective x-axis for the current CategorySeries object. -- **XAxisName**: `string` — Gets or sets the name to use to resolve xAxis from markup. -- **XAxisScript**: `string` — Provides a means of setting XAxis in the JavaScript environment. -- **YAxis**: `IgbCategoryYAxis` — Gets or sets the effective y-axis for the current CategorySeries object. -- **YAxisName**: `string` — Gets or sets the name to use to resolve yAxis from markup. -- **YAxisScript**: `string` — Provides a means of setting YAxis in the JavaScript environment. -- **BindAxes**(Axes: IgbAxis[]): void -- **CanUseAsXAxis**(axis: object): bool -- **CanUseAsXAxisAsync**(axis: object): Task — Determine if object can be used as XAxis -- **CanUseAsYAxis**(axis: object): bool -- **CanUseAsYAxisAsync**(axis: object): Task — Determine if object can be used as YAxis -- **FindByName**(name: string): object -- **GetCategoryWidth**(): double -- **GetCategoryWidthAsync**(): Task — Returns the width of the category grouping this series is in. -- **GetExactItemIndex**(world: Point): double -- **GetExactItemIndexAsync**(world: Point): Task — Gets the precise item index, if possible, based on the closeness to the previous or next whole integer. If the series cannot provide this information, GetExactItemIndex will return the same integer value as GetItemIndex. -- **GetItem**(world: Point): object -- **GetItemAsync**(world: Point): Task — Gets the item that is the best match for the specified world coordinates. -- **GetItemIndex**(world: Point): int -- **GetItemIndexAsync**(world: Point): Task — Gets the index of the item that resides at the provided world coordinates. -- **GetNextOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetNextOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetOffsetValue**(): double -- **GetOffsetValueAsync**(): Task — Returns the offset value for this series if grouped on a category axis. -- **GetPreviousOrExactIndex**(world: Point, skipUnknowns: bool): int -- **GetPreviousOrExactIndexAsync**(world: Point, skipUnknowns: bool): Task -- **GetSeriesValue**(world: Point, useInterpolation: bool, skipUnknowns: bool): double -- **GetSeriesValueAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task -- **GetSeriesValueMarkerBoundingBox**(world: Point): Rect -- **GetSeriesValueMarkerBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value marker bounding box within the series that has the best value match for the world position provided. -- **GetSeriesValuePosition**(world: Point, useInterpolation: bool, skipUnknowns: bool): Point -- **GetSeriesValuePositionAsync**(world: Point, useInterpolation: bool, skipUnknowns: bool): Task - -### [IgbVerticalSeparatorCellInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbVerticalSeparatorCellInfo) -Represents backing information for vertical separators. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbVerticalStackedSeriesBase](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbVerticalStackedSeriesBase) -Base class for stacked series with a numeric x-axis and a category y-axis. - -- **constructor**(): void -- **Type**: `string` -- **XAxis**: `IgbNumericXAxis` — Gets or sets the effective x-axis for the current CategorySeries object. -- **XAxisName**: `string` — Gets or sets the name to use to resolve xAxis from markup. -- **XAxisScript**: `string` — Provides a means of setting XAxis in the JavaScript environment. -- **YAxis**: `IgbCategoryYAxis` — Gets or sets the effective y-axis for the current CategorySeries object. -- **YAxisName**: `string` — Gets or sets the name to use to resolve yAxis from markup. -- **YAxisScript**: `string` — Provides a means of setting YAxis in the JavaScript environment. -- **BindAxes**(Axes: IgbAxis[]): void -- **CanUseAsXAxis**(axis: object): bool -- **CanUseAsXAxisAsync**(axis: object): Task — Determine if object can be used as XAxis -- **CanUseAsYAxis**(axis: object): bool -- **CanUseAsYAxisAsync**(axis: object): Task — Determine if object can be used as YAxis -- **FindByName**(name: string): object -- **GetCategoryWidth**(): double -- **GetCategoryWidthAsync**(): Task — Returns the width of the category grouping this series is in. -- **GetOffsetValue**(): double -- **GetOffsetValueAsync**(): Task — Returns the offset value for this series if grouped on a category axis. - -### [IgbVirtualDataSource](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbVirtualDataSource) -A virtual data source which may not have synchronous access to all its data items, and resulting may synchronously return placeholders for items that have yet to be actualized. - -- **constructor**(): void -- **ActualPageSize**: `int` — Gets the actual resolved page size that will be used. -- **ConcurrencyTag**: `string` — Gets or sets the field to use for concurrency. I.e. for odata, RowVersion for sql, etc. -- **IsBatchingEnabled**: `bool` — Gets whether batch edits are enabled. Setting this property will have no effect. -- **IsSectionCollapsable**: `bool` — Gets or sets if sections are collapsable. -- **IsSectionExpandedDefault**: `bool` — Gets or sets whether sections default to expanded or collapsed when they are created. -- **MaxCachedPages**: `int` — Gets or sets the maximum number of data pages to cache in the data source before the oldest pages will start being evicted. -- **PageSizeRequested**: `int` — Gets or sets the desired page size. This may or may not be respected by the underlying provider, or its connected services. -- **Type**: `string` -- **Clone**(): DataSource -- **CloneAsync**(): Task — Clones this data source instance, copying the summary, grouping, filter and sorting settings into the new instance. -- **CloneProperties**(dataSource: DataSource): void -- **ClonePropertiesAsync**(dataSource: DataSource): Task — Clones the properties over to the provided datasource. -- **FindByName**(name: string): object -- **GetIsRowExpandedAtIndex**(rowIndex: int): bool -- **GetIsRowExpandedAtIndexAsync**(rowIndex: int): Task — Gets the expansion state for a row. -- **GetItemAtIndex**(index: int): object -- **GetItemAtIndexAsync**(index: int): Task — Gets the item at the requested index. May return null, in which case you may want to check if that null represents a placeholder for a virtual item. -- **GetItemFromKey**(key: object[]): object -- **GetItemFromKeyAsync**(key: object[]): Task -- **GetItemPropertyAtIndex**(index: int, valueName: string): object -- **GetItemPropertyAtIndexAsync**(index: int, valueName: string): Task -- **GetRootSummaryResults**(): IgbDataGridSummaryResult[] -- **GetRootSummaryResultsAsync**(): Task — Gets the summary results for the root level. -- **GetRootSummaryRowCount**(): int -- **GetRootSummaryRowCountAsync**(): Task — Gets the number of summary rows at the root level. -- **GetRowLevel**(rowIndex: int): int -- **GetRowLevelAsync**(rowIndex: int): Task — Gets the hierarchy level of the row. -- **GetRowType**(rowIndex: int): DataSourceRowType -- **GetRowTypeAsync**(rowIndex: int): Task -- **GetSectionSummaryResults**(sectionIndex: int): IgbDataGridSummaryResult[][] -- **GetSectionSummaryResultsAsync**(sectionIndex: int): Task — Gets the summary results for a specific section. -- **GetStickyRowPriority**(row: int): int -- **GetStickyRowPriorityAsync**(row: int): Task -- **GetUnrealizedCount**(): int -- **GetUnrealizedCountAsync**(): Task — Gets the number of unrealized or virtual items. -- **IndexOfItem**(item: object): int -- **IndexOfItemAsync**(item: object): Task — Called to return the index for an item contained in the data source, or -1, if the item can't be found, or this action isn't currently supported. -- **IndexOfKey**(key: object[]): int -- **IndexOfKeyAsync**(key: object[]): Task -- **IsExclusivelySticky**(row: int): bool -- **IsExclusivelyStickyAsync**(row: int): Task -- **IsPlaceholderItem**(index: int): bool -- **IsPlaceholderItemAsync**(index: int): Task — Returns whether the item at the requested index is a placeholder for a virtual item which has yet to be loaded. -- **IsRowPinned**(row: int): bool -- **IsRowPinnedAsync**(row: int): Task -- **PinRow**(key: object[]): void -- **PinRowAsync**(key: object[]): Task -- **RemoveItemByKey**(key: object[]): void -- **RemoveItemByKeyAsync**(key: object[]): Task -- **SetIsRowExpandedAtIndex**(rowIndex: int, isExpanded: bool): void -- **SetIsRowExpandedAtIndexAsync**(rowIndex: int, isExpanded: bool): Task -- **TransformPage**(pageIndex: int): int[] -- **TransformPageAsync**(pageIndex: int): Task -- **UnpinRow**(key: object[]): void -- **UnpinRowAsync**(key: object[]): Task -- **UpdatePropertyAtKey**(key: object[], propertyPath: string, value: object, isPending: bool): int -- **UpdatePropertyAtKeyAsync**(key: object[], propertyPath: string, value: object, isPending: bool): Task - -### [IgbVoidEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbVoidEventArgs) - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbWaterfallSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbWaterfallSeries) -Represents a IgbDataChart waterfall column series. - -- **constructor**(): void -- **NegativeBrush**: `string` — Gets or sets the brush to use for negative portions of the series. -- **NegativeOutline**: `string` — Brush to use for outlining negative elements in the waterfall series. -- **RadiusX**: `double` — Gets or sets the x-radius of the ellipse that is used to round the corners of the column. -- **RadiusY**: `double` — Gets or sets the y-radius of the ellipse that is used to round the corners of the column. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **GetItemSpan**(): double -- **GetItemSpanAsync**(): Task — For a category plotted series, returns the current width of the items within the categories. This only returns a value if the items have some form of width (e.g. columns, bars, etc.) otherwise 0 is returned. -- **GetSeriesValueBoundingBox**(world: Point): Rect -- **GetSeriesValueBoundingBoxAsync**(world: Point): Task — If possible, will return the best available value bounding box within the series that has the best value match for the world position provided. -- **SetNegativeColors**(negativeBrush: string, negativeOutline: string): void -- **SetNegativeColorsAsync**(negativeBrush: string, negativeOutline: string): Task - -### [IgbWaterfallSeriesModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbWaterfallSeriesModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbWeightedCloseIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbWeightedCloseIndicator) -Represents a IgbDataChart Weigted Close indicator series. - -- **constructor**(): void -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbWeightedCloseIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbWeightedCloseIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbWilliamsPercentRIndicator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbWilliamsPercentRIndicator) -Represents a IgbDataChart Williams %R indicator series. - -- **constructor**(): void -- **Period**: `int` — Gets or sets the moving average period for the current StandardDeviationIndicator object. The typical, and initial, value for Williams %R periods is 14. -- **Type**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object - -### [IgbWilliamsPercentRIndicatorModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbWilliamsPercentRIndicatorModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbWrapperExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbWrapperExpression) -Base class for a wrapped expression. - -- **constructor**(): void -- **Expression**: `IgbFilterExpression` — The expression this wrapper will be working off of. -- **InnerExpression**: `IgbFilterExpression` — Gets the wrapped expression. -- **IsWrapper**: `bool` — Gets whether the expression is a wrapper expression. -- **Precedence**: `int` — Indicates the precedence of the operation, if applicable. -- **PropertyName**: `string` — Gets the property name associated with the wrapped expression, if any. -- **Type**: `string` -- **EnsureInnerExpression**(): void -- **EnsureInnerExpressionAsync**(): Task -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbXCalendarLocaleEnModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbXCalendarLocaleEnModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbXDatePicker](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbXDatePicker) - -- **constructor**(): void -- **AllowTextInput**: `bool` — Gets or sets the AllowTextInput property to detirmine if entering text into the input is allowed -- **BaseTheme**: `BaseControlTheme` — Gets or sets the base built in theme to use for the date picker. -- **Changing**: `EventCallback` -- **ChangingScript**: `string` -- **DateFormat**: `DateFormats` — Gets or sets the date time format to use for this column. If FormatString is specificied this value is ignored. -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **Density**: `ControlDisplayDensity` — Gets or sets the display density to use for the date pcicker. -- **FirstDayOfWeek**: `DayOfWeek` — Gets or sets the FirstDayOfWeek property to detirmine first day of the week -- **FirstWeekOfYear**: `FirstWeek` — Gets or sets the FirstWeekOfYear property to detirmine first week of the year -- **FormatString**: `string` — Gets or sets the Format property to detirmine the format of the date in the input -- **GotFocus**: `EventCallback` -- **GotFocusScript**: `string` -- **IconColor**: `string` — Gets or Sets the text color -- **IsDisabled**: `bool` -- **IsFixed**: `bool` — Indicates that the calendar dropdown will position itself relative to the window instead of the document. -- **KeyDown**: `EventCallback` -- **KeyDownScript**: `string` -- **Label**: `string` — Gets or Sets the property name that contains the label. -- **LabelFontFamily**: `string` -- **LabelFontSize**: `double` -- **LabelFontStyle**: `string` -- **LabelFontWeight**: `string` -- **LabelTextColor**: `string` — Gets or sets the color to use for the text. -- **LostFocus**: `EventCallback` -- **LostFocusScript**: `string` -- **MaxDate**: `DateTime` — Gets or Sets the property name that contains the MaxDate. -- **MinDate**: `DateTime` — Gets or Sets the property name that contains the MinDate. -- **OpenAsChild**: `bool` — Indicates that the dropdown should open as a child of the date picker. -- **OpenOnFocus**: `bool` — Gets or sets the AllowTextInput property to detirmine if entering text into the input is allowed -- **Placeholder**: `string` — Gets or Sets the property name that contains the placeholder. -- **SelectedValueChanged**: `Action` -- **SelectedValueChangedScript**: `string` -- **ShowClearButton**: `bool` — Gets or sets the ShowClearButton property to detirmine if the clear button is shown -- **ShowTodayButton**: `bool` — Gets or sets the ShowTodayButton property to detirmine if the today button is shown -- **ShowWeekNumbers**: `bool` — Gets or sets the ShowWeekNumbers property to detirmine if the week numbers are shown -- **TextColor**: `string` — Gets or Sets the text color -- **TextFontFamily**: `string` -- **TextFontSize**: `double` -- **TextFontStyle**: `string` -- **TextFontWeight**: `string` -- **Today**: `DateTime` — Gets or Sets the property name that contains the values. -- **Type**: `string` -- **UseTopLayer**: `bool` — Indicates that the dropdown will place itself into the browser top layer. -- **Value**: `DateTime` — Gets or Sets the property name that contains the values. -- **ValueChanged**: `EventCallback` -- **ValueChangedScript**: `string` -- **EnsureModulesLoaded**(): void -- **ExportSerializedVisualModel**(): string -- **ExportSerializedVisualModelAsync**(): Task — Returns a serialized copy of the exported visual model -- **ExportVisualModel**(): object -- **ExportVisualModelAsync**(): Task — Exports visual information about the current state of the grid. -- **FindByName**(name: string): object -- **GetCurrentValue**(): DateTime -- **GetCurrentValueAsync**(): Task -- **Select**(): void -- **SelectAsync**(): Task -- **SetCustomizedStringAsync**(language: string, values: Dictionary): Task — Provide a new set of localized strings to use for a given languange. -- **SetCustomizedStringAsync**(language: string, json: string): Task — Provide a new set of localized strings to use for a given languange. -- **SetCustomizedStringAsync**(language: string, id: string, value: string): Task — Provide a new set of localized strings to use for a given languange. - -### [IgbXDatePickerModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbXDatePickerModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbXYChart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbXYChart) -Represents a base class for domain charts with X/Y axes - -- **constructor**(): void -- **ActualXAxisLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ActualXAxisLabelTextColor**: `string` — Gets the actual color of labels on the X-axis -- **ActualYAxisLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ActualYAxisLabelTextColor**: `string` — Gets the actual color of labels on the Y-axis -- **ContentXAxisLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ContentYAxisLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` -- **ParentTypeName**: `string` -- **Type**: `string` -- **XAxisExtent**: `double` — Gets or sets the distance between the X-axis and the bottom of the chart. -- **XAxisFormatLabel**: `string` — Gets or sets function which takes an context object and returns a formatted label for the X-axis. -- **XAxisFormatLabelScript**: `string` — Provides a means of setting XAxisFormatLabel in the JavaScript environment. -- **XAxisInverted**: `bool` — Gets or sets whether to invert the direction of the X-axis by placing the first data items on the right side of the chart. -- **XAxisLabel**: `object` — Gets or sets the format for labels along the X-axis. -- **XAxisLabelAngle**: `double` — Gets or sets the angle of rotation for labels along the X-axis. -- **XAxisLabelBottomMargin**: `double` — Gets or sets the bottom margin of labels on the X-axis -- **XAxisLabelFormat**: `string` — Gets or sets the format string for the X axis label. -- **XAxisLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the XAxisLabelFormat string. -- **XAxisLabelHorizontalAlignment**: `HorizontalAlignment` — Gets or sets Horizontal alignment of X-axis labels. -- **XAxisLabelLeftMargin**: `double` — Gets or sets the left margin of labels on the X-axis -- **XAxisLabelLocation**: `XAxisLabelLocation` — Gets or sets location of X-axis labels, relative to the plot area. -- **XAxisLabelRightMargin**: `double` — Gets or sets the right margin of labels on the X-axis -- **XAxisLabelScript**: `string` — Provides a means of setting XAxisLabel in the JavaScript environment. -- **XAxisLabelTextColor**: `string` — Gets or sets color of labels on the X-axis -- **XAxisLabelTextStyle**: `string` — Gets or sets CSS font property for labels on X-axis -- **XAxisLabelTopMargin**: `double` — Gets or sets the top margin of labels on the X-axis -- **XAxisLabelVerticalAlignment**: `VerticalAlignment` — Gets or sets Vertical alignment of X-axis labels. -- **XAxisLabelVisibility**: `Visibility` — Gets or sets Visibility of X-axis labels. -- **XAxisMajorStroke**: `string` — Gets or sets the color to apply to major gridlines along the X-axis. -- **XAxisMajorStrokeThickness**: `double` — Gets or sets the thickness to apply to major gridlines along the X-axis. -- **XAxisMaximumExtent**: `double` — Gets or sets the distance between the X-axis and the bottom of the chart. -- **XAxisMaximumExtentPercentage**: `double` — Gets or sets the distance between the X-axis and the bottom of the chart. -- **XAxisMinorStroke**: `string` — Gets or sets the color to apply to minor gridlines along the X-axis. -- **XAxisMinorStrokeThickness**: `double` — Gets or sets the thickness to apply to minor gridlines along the X-axis. -- **XAxisStrip**: `string` — Gets or sets the color to apply to stripes along the X-axis. -- **XAxisStroke**: `string` — Gets or sets the color to apply to the X-axis line. -- **XAxisStrokeThickness**: `double` — Gets or sets the thickness to apply to the X-axis line. -- **XAxisTickLength**: `double` — Gets or sets the length of tickmarks along the X-axis. -- **XAxisTickStroke**: `string` — Gets or sets the color to apply to tickmarks along the X-axis. -- **XAxisTickStrokeThickness**: `double` — Gets or sets the thickness to apply to tickmarks along the X-axis. -- **XAxisTitle**: `string` — Gets or sets the Text to display below the X-axis. -- **XAxisTitleAlignment**: `HorizontalAlignment` — Gets or sets Horizontal alignment of the X-axis title. -- **XAxisTitleAngle**: `double` — Gets or sets the angle of rotation for the X-axis title. -- **XAxisTitleBottomMargin**: `double` — Gets or sets the bottom margin of a title on the X-axis -- **XAxisTitleLeftMargin**: `double` — Gets or sets the left margin of a title on the X-axis -- **XAxisTitleMargin**: `double` — Gets or sets the margin around a title on the X-axis -- **XAxisTitleRightMargin**: `double` — Gets or sets the right margin of a title on the X-axis -- **XAxisTitleTextColor**: `string` — Gets or sets color of title on the X-axis -- **XAxisTitleTextStyle**: `string` — Gets or sets CSS font property for title on X-axis -- **XAxisTitleTopMargin**: `double` — Gets or sets the top margin of a title on the X-axis -- **YAxisExtent**: `double` — Gets or sets the distance between the Y-axis and the left edge of the chart. -- **YAxisFormatLabel**: `string` — Gets or sets function which takes a context object and returns a formatted label for the Y-axis. -- **YAxisFormatLabelScript**: `string` — Provides a means of setting YAxisFormatLabel in the JavaScript environment. -- **YAxisInverted**: `bool` — Gets or sets whether to invert the direction of the Y-axis by placing the minimum numeric value at the top of the chart. -- **YAxisLabel**: `object` — Gets or sets the property or string from which the labels are derived. -- **YAxisLabelAngle**: `double` — Gets or sets the angle of rotation for labels along the Y-axis. -- **YAxisLabelBottomMargin**: `double` — Gets or sets the bottom margin of labels on the Y-axis -- **YAxisLabelFormat**: `string` — Gets or sets the format string for the Y axis label. -- **YAxisLabelFormatSpecifiers**: `IgbFormatSpecifierCollection` — Gets or sets the format specifiers to use with the YAxisLabelFormat string. -- **YAxisLabelHorizontalAlignment**: `HorizontalAlignment` — Gets or sets Horizontal alignment of Y-axis labels. -- **YAxisLabelLeftMargin**: `double` — Gets or sets the left margin of labels on the Y-axis -- **YAxisLabelLocation**: `YAxisLabelLocation` — Gets or sets location of Y-axis labels, relative to the plot area. -- **YAxisLabelRightMargin**: `double` — Gets or sets the right margin of labels on the Y-axis -- **YAxisLabelScript**: `string` — Provides a means of setting YAxisLabel in the JavaScript environment. -- **YAxisLabelTextColor**: `string` — Gets or sets color of labels on the Y-axis -- **YAxisLabelTextStyle**: `string` — Gets or sets CSS font property for labels on Y-axis -- **YAxisLabelTopMargin**: `double` — Gets or sets the top margin of labels on the Y-axis -- **YAxisLabelVerticalAlignment**: `VerticalAlignment` — Gets or sets Vertical alignment of Y-axis labels. -- **YAxisLabelVisibility**: `Visibility` — Gets or sets Visibility of Y-axis labels. -- **YAxisMajorStroke**: `string` — Gets or sets the color to apply to major gridlines along the Y-axis. -- **YAxisMajorStrokeThickness**: `double` — Gets or sets the thickness to apply to major gridlines along the Y-axis. -- **YAxisMaximumExtent**: `double` — Gets or sets the distance between the Y-axis and the left edge of the chart. -- **YAxisMaximumExtentPercentage**: `double` — Gets or sets the distance between the Y-axis and the left edge of the chart. -- **YAxisMinorStroke**: `string` — Gets or sets the color to apply to minor gridlines along the Y-axis. -- **YAxisMinorStrokeThickness**: `double` — Gets or sets the thickness to apply to minor gridlines along the Y-axis. -- **YAxisStrip**: `string` — Gets or sets the color to apply to stripes along the Y-axis. -- **YAxisStroke**: `string` — Gets or sets the color to apply to the Y-axis line. -- **YAxisStrokeThickness**: `double` — Gets or sets the thickness to apply to the Y-axis line. -- **YAxisTickLength**: `double` — Gets or sets the length of tickmarks along the Y-axis. -- **YAxisTickStroke**: `string` — Gets or sets the color to apply to tickmarks along the Y-axis. -- **YAxisTickStrokeThickness**: `double` — Gets or sets the thickness to apply to tickmarks along the Y-axis. -- **YAxisTitle**: `string` — Gets or sets the Text to display to the left of the Y-axis. -- **YAxisTitleAlignment**: `VerticalAlignment` — Gets or sets Vertical alignment of the Y-axis title. -- **YAxisTitleAngle**: `double` — Gets or sets the angle of rotation for the Y-axis title. -- **YAxisTitleBottomMargin**: `double` — Gets or sets the bottom margin of a title on the Y-axis -- **YAxisTitleLeftMargin**: `double` — Gets or sets the left margin of a title on the Y-axis -- **YAxisTitleMargin**: `double` — Gets or sets the margin around a title on the Y-axis -- **YAxisTitleRightMargin**: `double` — Gets or sets the right margin of a title on the Y-axis -- **YAxisTitleTextColor**: `string` — Gets or sets color of title on the Y-axis -- **YAxisTitleTextStyle**: `string` — Gets or sets CSS font property for title on Y-axis -- **YAxisTitleTopMargin**: `double` — Gets or sets the top margin of a title on the Y-axis -- **FindByName**(name: string): object -- **GetScaledValueX**(unscaledValue: double): double -- **GetScaledValueXAsync**(unscaledValue: double): Task — Converts the given visual location to a data value. -- **GetScaledValueY**(unscaledValue: double): double -- **GetScaledValueYAsync**(unscaledValue: double): Task — Converts the given visual location to a data value. -- **GetUnscaledValueX**(scaledValue: double): double -- **GetUnscaledValueXAsync**(scaledValue: double): Task — Converts the given data value to a visual location. -- **GetUnscaledValueY**(scaledValue: double): double -- **GetUnscaledValueYAsync**(scaledValue: double): Task — Converts the given data value to a visual location. -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task — Called by the UI framework to provide a UI container for rendering this control. - -### [IgbYearToDateExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbYearToDateExpression) -Requests an expression for the YearToDate filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbYesterdayExpression](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbYesterdayExpression) -Requests an expression for the Yesterday filter. - -- **constructor**(): void -- **Type**: `string` -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgbZoomSlider](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbZoomSlider) - -- **constructor**(): void -- **ActualPixelScalingRatio**: `double` -- **AreThumbCalloutsEnabled**: `bool` -- **BarBrush**: `string` -- **BarExtent**: `double` -- **BarOutline**: `string` -- **BarStrokeThickness**: `double` -- **DefaultEventBehavior**: `ControlEventBehavior` — Gets the components default event behavior. -- **EndInset**: `double` -- **HigherCalloutBrush**: `string` -- **HigherCalloutOutline**: `string` -- **HigherCalloutStrokeThickness**: `double` -- **HigherCalloutTextColor**: `string` -- **HigherShadeBrush**: `string` -- **HigherShadeOutline**: `string` -- **HigherShadeStrokeThickness**: `double` -- **HigherThumbBrush**: `string` -- **HigherThumbHeight**: `double` -- **HigherThumbOutline**: `string` -- **HigherThumbRidgesBrush**: `string` -- **HigherThumbStrokeThickness**: `double` -- **HigherThumbWidth**: `double` -- **LowerCalloutBrush**: `string` -- **LowerCalloutOutline**: `string` -- **LowerCalloutStrokeThickness**: `double` -- **LowerCalloutTextColor**: `string` -- **LowerShadeBrush**: `string` -- **LowerShadeOutline**: `string` -- **LowerShadeStrokeThickness**: `double` -- **LowerThumbBrush**: `string` -- **LowerThumbHeight**: `double` -- **LowerThumbOutline**: `string` -- **LowerThumbRidgesBrush**: `string` -- **LowerThumbStrokeThickness**: `double` -- **LowerThumbWidth**: `double` -- **MaxZoomWidth**: `double` -- **MinZoomWidth**: `double` -- **Orientation**: `ZoomSliderOrientation` -- **PanTransitionDuration**: `int` -- **PixelScalingRatio**: `double` — Gets or sets the scaling value used to affect the pixel density of the control. -- **RangeThumbBrush**: `string` -- **RangeThumbOutline**: `string` -- **RangeThumbRidgesBrush**: `string` -- **RangeThumbStrokeThickness**: `double` -- **ResolvingAxisValue**: `Action` -- **ResolvingAxisValueScript**: `string` -- **StartInset**: `double` -- **ThumbCalloutFontFamily**: `string` -- **ThumbCalloutFontSize**: `double` -- **ThumbCalloutFontStyle**: `string` -- **ThumbCalloutFontWeight**: `string` -- **TrackEndInset**: `double` -- **TrackStartInset**: `double` -- **Type**: `string` -- **WindowRect**: `Rect` -- **WindowRectChanged**: `Action` -- **WindowRectChangedScript**: `string` -- **EnsureModulesLoaded**(): void -- **FindByName**(name: string): object -- **Flush**(): void -- **FlushAsync**(): Task -- **Hide**(): void -- **HideAsync**(): Task — Hides the ZoomSlider. -- **OnAttachedToUI**(): void -- **OnAttachedToUIAsync**(): Task -- **OnDetachedFromUI**(): void -- **OnDetachedFromUIAsync**(): Task -- **ProvideContainer**(container: object): void -- **ProvideContainerAsync**(container: object): Task — Called by the UI framework to provide a UI container for rendering this control. -- **Show**(): void -- **ShowAsync**(): Task — Shows the ZoomSlider. -- **TrackDirty**(): void -- **TrackDirtyAsync**(): Task - -### [IgbZoomSliderModule](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbZoomSliderModule) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor): bool -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor): void -- **Register**(runtime: IIgniteUIBlazor): void - -### [IgbZoomSliderResolvingAxisValueEventArgs](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgbZoomSliderResolvingAxisValueEventArgs) - -- **constructor**(): void -- **Position**: `double` -- **Type**: `string` -- **Value**: `object` -- **ValueScript**: `string` — Provides a means of setting Value in the JavaScript environment. -- **FindByName**(name: string): object -- **FromEventJson**(control: BaseRendererControl, args: Dictionary): void -- **ToEventJson**(control: BaseRendererControl, args: Dictionary): void - -### [IgniteUIBlazor](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgniteUIBlazor) - -- **constructor**(runtime: IJSRuntime): void -- **constructor**(runtime: IJSRuntime, settings: IIgniteUIBlazorSettings): void -- **JsRuntime**: `IJSRuntime` -- **Settings**: `IIgniteUIBlazorSettings` -- **WebCallback**: `WebCallback` -- **IsLoadRequested**(moduleName: string): bool -- **IsRuntimeValid**(reevaluate: bool): bool -- **MarkIsLoadRequested**(moduleName: string): void -- **RequestLoad**(moduleName: string): void - -### [IgniteUIBlazorSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgniteUIBlazorSettings) - -- **constructor**(): void -- **ForceJsonDataMarshalling**: `bool` -- **JsonSerializerOptions**: `IgniteUIJsonSerializerOptions` -- **ModulesToLoad**: `ReadOnlyCollection` -- **Create**(): IgniteUIBlazorSettings -- **ShouldForceJsonDataMarshalling**(): IgniteUIBlazorSettings -- **WithForceJsonDataMarshalling**(forceJsonDataMarshalling: bool): IgniteUIBlazorSettings -- **WithJsonSerializerOptions**(options: IgniteUIJsonSerializerOptions): IgniteUIBlazorSettings -- **WithModulesToLoad**(modulesToLoad: ReadOnlyCollection): IgniteUIBlazorSettings - -### [IgniteUIJsonSerializerOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/IgniteUIJsonSerializerOptions) - -- **constructor**(): void -- **constructor**(options: IgniteUIJsonSerializerOptions): void -- **constructor**(maxDepth: int): void -- **MaxDepth**: `int` - -### [LegendLabelFormatSpecifiers](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/LegendLabelFormatSpecifiers) - -- **constructor**(): void -- **ParentTypeName**: `string` -- **PieChartBaseParent**: `BaseRendererControl` -- **RingSeriesBaseParent**: `BaseRendererElement` -- **Dispose**(): void -- **OnInitializedAsync**(): Task - -### [LegendOthersLabelFormatSpecifiers](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/LegendOthersLabelFormatSpecifiers) - -- **constructor**(): void -- **ParentTypeName**: `string` -- **PieChartBaseParent**: `BaseRendererControl` -- **RingSeriesBaseParent**: `BaseRendererElement` -- **Dispose**(): void -- **OnInitializedAsync**(): Task - -### [LinearGradientBrush](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/LinearGradientBrush) - -- **constructor**(): void -- **BrushType**: `BrushType` -- **EndX**: `double` -- **EndY**: `double` -- **GradientStops**: `List` -- **IsAbsolute**: `bool` -- **StartX**: `double` -- **StartY**: `double` -- **UseCustomDirection**: `bool` -- **Serialize**(ct: SerializationContext, propertyName: string): void - -### [LocalJson](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/LocalJson) - -- **constructor**(json: string): void -- **Json**: `string` -- **From**(json: string): LocalJson - -### [MarshalByValueFactory](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/MarshalByValueFactory) - -- **constructor**(): void - -### [ModuleLoader](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/ModuleLoader) - -- **constructor**(): void -- **IsLoadRequested**(runtime: IIgniteUIBlazor, moduleName: string): bool -- **Load**(runtime: IIgniteUIBlazor, moduleName: string): void -- **MarkIsLoadRequested**(runtime: IIgniteUIBlazor, moduleName: string): void - -### [OthersLabelFormatSpecifiers](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/OthersLabelFormatSpecifiers) - -- **constructor**(): void -- **ParentTypeName**: `string` -- **PieChartBaseParent**: `BaseRendererControl` -- **RingSeriesBaseParent**: `BaseRendererElement` -- **Dispose**(): void -- **OnInitializedAsync**(): Task - -### [Point](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/Point) - -- **constructor**(): void -- **constructor**(x: double, y: double): void -- **X**: `double` -- **Y**: `double` -- **Serialize**(c: SerializationContext, propertyName: string): void - -### [RadioGroupAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/RadioGroupAlignment) - -- **Horizontal**: `ContentOrientation` -- **Vertical**: `ContentOrientation` - -### [RadioLabelPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/RadioLabelPosition) - -- **After**: `ToggleLabelPosition` -- **Before**: `ToggleLabelPosition` - -### [Rect](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/Rect) - -- **constructor**(): void -- **constructor**(point1: Point, point2: Point): void -- **constructor**(point1: Point, size: Size): void -- **constructor**(left: double, top: double, size: Size): void -- **constructor**(left: double, top: double, width: double, height: double): void -- **Bottom**: `double` -- **Empty**: `Rect` -- **Height**: `double` -- **IsEmpty**: `bool` -- **Left**: `double` -- **Right**: `double` -- **Top**: `double` -- **Width**: `double` -- **X**: `double` -- **Y**: `double` -- **Equals**(value: object): bool -- **Serialize**(c: SerializationContext, propertyName: string): void - -### [RemoteJson](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/RemoteJson) - -- **constructor**(uri: string): void -- **Uri**: `string` -- **From**(uri: string): RemoteJson -- **WithUri**(uri: string): RemoteJson - -### [SelectScrollStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/SelectScrollStrategy) - -- **Block**: `PopoverScrollStrategy` -- **Close**: `PopoverScrollStrategy` -- **Scroll**: `PopoverScrollStrategy` - -### [SequenceInfo](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/SequenceInfo) - -- **AttributeKeys**: `ReadOnlyCollection` -- **MaxSequence**: `int` -- **GetSequence**(key: string): int - -### [SerializationContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/SerializationContext) - -- **constructor**(writer: Utf8JsonWriter, filter: SerializationFilter): void -- **Filter**: `SerializationFilter` -- **Writer**: `Utf8JsonWriter` - -### [Size](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/Size) - -- **constructor**(): void -- **constructor**(width: double, height: double): void -- **Height**: `double` -- **Width**: `double` -- **Serialize**(c: SerializationContext, propertyName: string): void - -### [SliderBaseTickOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/SliderBaseTickOrientation) - -- **End**: `SliderTickOrientation` -- **Mirror**: `SliderTickOrientation` -- **Start**: `SliderTickOrientation` - -### [SolidColorBrush](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/SolidColorBrush) - -- **constructor**(): void -- **constructor**(color: Color): void -- **BrushType**: `BrushType` -- **Color**: `Color` -- **Serialize**(ct: SerializationContext, propertyName: string): void - -### [StepperHorizontalAnimation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/StepperHorizontalAnimation) - -- **Fade**: `HorizontalTransitionAnimation` -- **None**: `HorizontalTransitionAnimation` -- **Slide**: `HorizontalTransitionAnimation` - -### [TickLabelRotation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/TickLabelRotation) - -- **NegativeNinety**: `SliderTickLabelRotation` -- **Ninety**: `SliderTickLabelRotation` -- **Zero**: `SliderTickLabelRotation` - -### [TypedDynamicContent](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/TypedDynamicContent) - -- **constructor**(t: Type): void -- **GetInstanceAsync**(): Task -- **OnComponentChanged**(oldValue: object, component: object): void - -### [VerticalLabelFormatSpecifiers](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/VerticalLabelFormatSpecifiers) - -- **constructor**(): void -- **ParentTypeName**: `string` -- **SparklineParent**: `BaseRendererControl` -- **Dispose**(): void -- **OnInitializedAsync**(): Task - -### [WCAttributeNameAttribute](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/WCAttributeNameAttribute) - -- **constructor**(alternateName: string): void -- **Name**: `string` - -### [WCEnumNameAttribute](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/WCEnumNameAttribute) - -- **constructor**(alternateName: string): void -- **Name**: `string` - -### [WCWidgetMemberNameAttribute](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/WCWidgetMemberNameAttribute) - -- **constructor**(alternateName: string): void -- **Name**: `string` - -### [WebCallback](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/WebCallback) - -- **constructor**(): void -- **IsReady**: `bool` -- **AdjustDynamicContent**(containerId: string, contentType: string, templateId: string, contentId: string, actionType: string, args: string): void -- **AdjustDynamicContentBatch**(containerId: string, batch: string): void -- **OnInvokeReturn**(containerId: string, invokeId: long, returnValue: object): void -- **OnRaiseEvent**(containerId: string, name: string, propertyName: string, args: string): void -- **OnReady**(): void -- **Register**(control: BaseRendererControl): void - -### [XAxisLabelFormatSpecifiers](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/XAxisLabelFormatSpecifiers) - -- **constructor**(): void -- **ParentTypeName**: `string` -- **XYChartParent**: `BaseRendererControl` -- **Dispose**(): void -- **OnInitializedAsync**(): Task - -### [YAxisLabelFormatSpecifiers](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/YAxisLabelFormatSpecifiers) - -- **constructor**(): void -- **ParentTypeName**: `string` -- **XYChartParent**: `BaseRendererControl` -- **Dispose**(): void -- **OnInitializedAsync**(): Task - -### [ColorUtil](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/ColorUtil) -Utility class for color-based operations. - -- **ColorToInt**(color: Color): int — Converts a color to its integer representation for use in bitmaps. -- **ColorToString**(c: Color, useRgba: bool): string -- **FromAHSL**(alpha: double, hue: double, saturation: double, lightness: double): Color — Gets a color from the specified ahsl components -- **FromAHSV**(alpha: double, hue: double, saturation: double, value: double): Color — Gets a color from the specified ahsv components -- **FromArgb**(argb: int): Color — Converts ARGB integer to a Color, e.g. -65536 (red pixel) -- **FromArgb**(hex: string): Color — Converts ARGB string to a Color, e.g. '#AARRGGBB' -- **FromHex**(colorHex: string): Color — Converts color hex string to a Color, e.g. '#AARRGGBB', '#RRGGBB', or '#RGB' -- **FromRGB**(rgb: string): Color — Converts RGB string a Color, e.g. 'RGB, R,G,B' -- **FromRGBA**(rgba: string): Color — Converts RGBA string a Color, e.g. 'RGBA, R,G,B,A', -- **FromString**(colorFormat: string): Color — Converts string format to a Color, e.g. 'DodgerBlue', '#AARRGGBB', '#RRGGBB', 'RGBA, R,G,B,A', or 'RGB, R,G,B' -- **GetAHSL**(color: Color): double[] — Gets the ahsl components of this color -- **GetAHSV**(color: Color): double[] — Gets the ahsv components of this color -- **GetAHSVInterpolation**(minimum: double[], interpolation: double, maximum: double[]): Color — Get an interpolated color between two colors. -- **GetColor**(brush: Brush): Color — Returns the main color of the given brush. -- **GetInterpolation**(minimum: Color, interpolation_: double, maximum_: Color, interpolationMode: InterpolationMode): Color — Get an interpolation from the current color to the specified color -- **GetL**(color: Color): double -- **GetRandomColor**(index: int): Color — Get a random color from generated array of colors. -- **GetsRGB**(color: Color): double[] -- **RGBAToRGB**(color: Color, background: Color): Color -- **RandomColor**(alpha: byte): Color — Returns a random color. -- **RandomHue**(color: Color): Color — Get a random color -- **ToGrayscale**(color: Color): Color - -### [InfragisticsBlazorExtensions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/classes/InfragisticsBlazorExtensions) - -- **AddIgniteUIBlazor**(collection: IServiceCollection, settings: IIgniteUIBlazorSettings, modulesToLoad: Type[]): IServiceCollection -- **AddIgniteUIBlazor**(collection: IServiceCollection, modulesToLoad: Type[]): IServiceCollection - -## Interfaces - -### [CellActionManager](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/CellActionManager) -Allows you to route cell actions to the grid for processing. - -- **ApplyCustomFilter(string, int, object)**: `any` -- **ApplyCustomFilterAsync(string, int, object)**: `Task` -- **ApplyFilter(ColumnComparisonConditionOperatorType, object)**: `any` -- **ApplyFilterAsync(ColumnComparisonConditionOperatorType, object)**: `Task` -- **CancelEditMode(bool)**: `any` -- **CancelEditModeAsync(bool)**: `Task` — Notify the grid to cancel edit mode. -- **ClearFilter()**: `any` -- **ClearFilterAsync()**: `Task` — Clear the filter on the column associated with the cell. -- **ClickCell(MouseButton)**: `any` -- **ClickCellAsync(MouseButton)**: `Task` — Notifies the grid that a cell has been clicked. -- **ClickExpansionIndicator()**: `any` -- **ClickExpansionIndicatorAsync()**: `Task` — Notifies the grid that an expansion indicator has been clicked. -- **ColumnFilterChanged(IgbColumnFilterCondition)**: `any` -- **ColumnFilterChangedAsync(IgbColumnFilterCondition)**: `Task` — Provides a new column filter condition to associate with the cell's column. -- **ColumnFilterChanging(IgbColumnFilterCondition)**: `any` -- **ColumnFilterChangingAsync(IgbColumnFilterCondition)**: `Task` — Provides a new intermediate column filter condition to associate with the cell's column. -- **DisableKeyInput()**: `any` -- **DisableKeyInputAsync()**: `Task` — Disables key input to the grid. -- **DoubleClicked(MouseButton)**: `any` -- **DoubleClickedAsync(MouseButton)**: `Task` — Notifies the grid that the cell was double clicked -- **DragStarted()**: `any` -- **DragStartedAsync()**: `Task` — Notifies the grid that a cell has started a drag. -- **EditorCellLostFocus()**: `any` -- **EditorCellLostFocusAsync()**: `Task` — Notify the grid that a cell has lost focus. -- **EnableKeyInput()**: `any` -- **EnableKeyInputAsync()**: `Task` — Enable key input to the grid. -- **GetColumnFilterCondition()**: `IgbColumnFilterCondition` -- **GetColumnFilterConditionAsync()**: `Task` — Get's the column filter condition associated with the cell's column. -- **GetColumnPropertyType()**: `DataSourceSchemaPropertyType` -- **GetColumnPropertyTypeAsync()**: `Task` — Get's the property type associated the cell's column. -- **IsCellDown()**: `bool` -- **IsCellDownAsync()**: `Task` — Gets if the mouse is down on the current cell. -- **IsControlPressed**: `bool` -- **IsShiftPressed**: `bool` -- **MouseDownCell(double, double)**: `any` -- **MouseDownCellAsync(double, double)**: `Task` -- **MouseEnterCell(double, double)**: `any` -- **MouseEnterCellAsync(double, double)**: `Task` -- **MouseIsOver(double, double)**: `any` -- **MouseIsOverAsync(double, double)**: `Task` -- **MouseLeaveCell(double, double)**: `any` -- **MouseLeaveCellAsync(double, double)**: `Task` -- **MouseUpCell(double, double)**: `any` -- **MouseUpCellAsync(double, double)**: `Task` -- **PassCellClone(object)**: `any` -- **PassCellCloneAsync(object)**: `Task` — Pass Cell Clone to Dragger -- **PointerDownCell()**: `any` -- **PointerDownCellAsync()**: `Task` — Notifies the grid that a pointer is down on a cell. -- **PointerUpCell()**: `any` -- **PointerUpCellAsync()**: `Task` — Notifies the grid that a pointer is up on a cell. -- **PreviewMouseDownCell(bool, bool, MouseButton)**: `any` -- **PreviewMouseDownCellAsync(bool, bool, MouseButton)**: `Task` -- **PreviewMouseUpCell(bool, bool, MouseButton)**: `any` -- **PreviewMouseUpCellAsync(bool, bool, MouseButton)**: `Task` -- **PreviewPointerDownCell()**: `any` -- **PreviewPointerDownCellAsync()**: `Task` — Notifies the grid that a pointer is pressing on the cell. -- **PreviewPointerUpCell()**: `any` -- **PreviewPointerUpCellAsync()**: `Task` — Notifies the grid that a pointer is releasing on a cell. -- **ShouldSkipFocusRetain()**: `bool` -- **ShouldSkipFocusRetainAsync()**: `Task` -- **StartEditMode()**: `any` -- **StartEditModeAsync()**: `Task` — Start edit mode. -- **UpdateCellEditValue(object)**: `any` -- **UpdateCellEditValueAsync(object)**: `Task` — Provides a way for cells to update the EditorCellModel's EditValue property. - -### [DataSource](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/DataSource) -AddOnSchemaChangedListener Represents a data source for use in components which need advanced access to data. - -- **ClearPinnedRows()**: `any` -- **ClearPinnedRowsAsync()**: `Task` — Called to clear all pinned rows. -- **Clone()**: `DataSource` -- **CloneAsync()**: `Task` — Clones this data source instance, copying the summary, grouping, filter and sorting settings into the new instance. -- **DeferAutoRefresh**: `bool` -- **FilterExpressions**: `IgbFilterExpressionCollection` -- **FirstVisibleIndexRequested**: `int` -- **FlushAutoRefresh()**: `any` -- **FlushAutoRefreshAsync()**: `Task` — Called to make sure a queued refresh of the data source has been applied before continuing. Should only be needed if you are trying to synchronously examine the results of changing settings on the data source. Note, for a virtual data source, the data source itself may be waiting for other synchronous requests to actualize data. This call will not wait for those, but will only make sure the appropriate requests are in flight from the settings changes -- **GetIsRowExpandedAtIndex(int)**: `bool` -- **GetIsRowExpandedAtIndexAsync(int)**: `Task` — Gets the expansion state for a row. -- **GetItemProperty(object, string)**: `object` -- **GetItemPropertyAsync(object, string)**: `Task` -- **GetItemPropertyAtIndex(int, string)**: `object` -- **GetItemPropertyAtIndexAsync(int, string)**: `Task` -- **GetMainValuePath(DataSourceRowType)**: `string` -- **GetMainValuePathAsync(DataSourceRowType)**: `Task` — Gets the type of row at the specified index. -- **GetRootSummaryResults()**: `IgbDataGridSummaryResult[]` -- **GetRootSummaryResultsAsync()**: `Task` — Gets the summary results for the root level. -- **GetRootSummaryRowCount()**: `int` -- **GetRootSummaryRowCountAsync()**: `Task` — Gets the number of summary rows at the root level. -- **GetRowLevel(int)**: `int` -- **GetRowLevelAsync(int)**: `Task` — Gets the hierarchy level of the row. -- **GetRowType(int)**: `DataSourceRowType` -- **GetRowTypeAsync(int)**: `Task` — Gets the type of row at the specified index. -- **GetSectionSummaryResults(int)**: `IgbDataGridSummaryResult[][]` -- **GetSectionSummaryResultsAsync(int)**: `Task` — Gets the summary results for a specific section. -- **GetStickyRowPriority(int)**: `int` -- **GetStickyRowPriorityAsync(int)**: `Task` — Gets the priority of a pinned row, which defines how it interacts with other pinned rows. -- **IncludeSummaryRowsInSection**: `bool` -- **IndexOfItem(object)**: `int` -- **IndexOfItemAsync(object)**: `Task` — Called to return the index for an item contained in the data source, or -1, if the item can't be found, or this action isn't currently supported. -- **IndexOfKey(object[])**: `int` -- **IndexOfKeyAsync(object[])**: `Task` -- **IsExclusivelySticky(int)**: `bool` -- **IsExclusivelyStickyAsync(int)**: `Task` — Gets whether the row is allowed to push other sticky rows with the same priority. -- **IsPlaceholderItem(int)**: `bool` -- **IsPlaceholderItemAsync(int)**: `Task` — Returns true if the item at the requested index is a placeholder item and has not been actualized. -- **IsRowPinned(int)**: `bool` -- **IsRowPinnedAsync(int)**: `Task` — Returns whether the row is pinned. -- **IsRowSpanning(DataSourceRowType)**: `bool` -- **IsRowSpanningAsync(DataSourceRowType)**: `Task` — Returns whether the requested row type is considered a spanning element for the data source. Spanning elements have a single complex value rather than the current schema of the data source. -- **IsSectionCollapsable**: `bool` -- **IsSectionContentVisible**: `bool` -- **IsSectionExpandedDefault**: `bool` -- **IsSectionHeaderNormalRow**: `bool` -- **IsSectionSummaryRowsAtBottom**: `bool` -- **LastVisibleIndexRequested**: `int` -- **PinRow(object[])**: `any` -- **PinRowAsync(object[])**: `Task` -- **PrimaryKey**: `string[]` -- **PropertiesRequested**: `string[]` -- **QueueAutoRefresh()**: `any` -- **QueueAutoRefreshAsync()**: `Task` — Called to manually queue a refresh of the data source. -- **Refresh()**: `any` -- **RefreshAsync()**: `Task` — Called to synchronously refresh the data source. -- **ResolveSchemaPropertyType(string)**: `DataSourceSchemaPropertyType` -- **ResolveSchemaPropertyTypeAsync(string)**: `Task` — Resolve a property or property path to its value type. -- **SchemaIncludedProperties**: `string[]` -- **SectionHeaderDisplayMode**: `DataSourceSectionHeaderDisplayMode` -- **SetIsRowExpandedAtIndex(int, bool)**: `any` -- **SetIsRowExpandedAtIndexAsync(int, bool)**: `Task` -- **ShouldEmitSectionFooters**: `bool` -- **ShouldEmitSectionHeaders**: `bool` -- **ShouldEmitShiftedRows**: `bool` -- **ShouldEmitSummaryRows**: `bool` -- **SummaryScope**: `DataSourceSummaryScope` -- **UnpinRow(object[])**: `any` -- **UnpinRowAsync(object[])**: `Task` -- **UpdateNotifier**: `DataSourceUpdateNotifier` - -### [DataSourceClonableDataProvider](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/DataSourceClonableDataProvider) -Represents an interface that a data provider can implement to be clonable. - -- **Clone()**: `DataSourceDataProvider` -- **CloneAsync()**: `Task` - -### [DataSourceDataProvider](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/DataSourceDataProvider) -Represents an interface that can be implemented to create a data provider for a data source. - -- **AddItem(object)**: `any` -- **AddItemAsync(object)**: `Task` — Adds the item to the data. -- **DeferAutoRefresh**: `bool` -- **ExecutionContext**: `DataSourceExecutionContext` -- **FilterExpressions**: `IgbFilterExpressionCollection` -- **FlushAutoRefresh()**: `any` -- **FlushAutoRefreshAsync()**: `Task` — Called to make sure a queued refresh of the data provider has been applied before continuing. Should only be needed if you are trying to synchronously examine the results of changing settings on the data provider. Note, for a virtual data provider, the data provider itself may be waiting for other synchronous requests to actualize data. This call will not wait for those, but will only make sure the appropriate requests are in flight from the settings changes -- **GetItemValue(object, string)**: `object` -- **GetItemValueAsync(object, string)**: `Task` -- **IndexOfItem(object)**: `int` -- **IndexOfItemAsync(object)**: `Task` — Called to return the index for an item contained in the data source, or -1, if the item can't be found, or this action isn't currently supported. -- **IndexOfKey(object[])**: `int` -- **IndexOfKeyAsync(object[])**: `Task` -- **PropertiesRequested**: `string[]` -- **QueueAutoRefresh()**: `any` -- **QueueAutoRefreshAsync()**: `Task` — Called to manually queue a refresh of the data provider. -- **Refresh()**: `any` -- **RefreshAsync()**: `Task` — Called to synchronously refresh the data provider. -- **RemoveItem(object)**: `any` -- **RemoveItemAsync(object)**: `Task` — Removes the item from the data. -- **ResolveSchemaPropertyType(string)**: `DataSourceSchemaPropertyType` -- **ResolveSchemaPropertyTypeAsync(string)**: `Task` — Resolve a property or property path to its value type. -- **SchemaIncludedProperties**: `string[]` -- **SetItemValue(object, string, object)**: `any` -- **SetItemValueAsync(object, string, object)**: `Task` -- **SummaryScope**: `DataSourceSummaryScope` -- **UpdateNotifier**: `DataSourceDataProviderUpdateNotifier` - -### [DataSourceDataProviderUpdateNotifier](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/DataSourceDataProviderUpdateNotifier) -Can be implemented to serve as a target for data provider update events. - - -### [DataSourceExecutionContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/DataSourceExecutionContext) -Represents an execution context that DataSources and DataProviders can syncrhonize execution with, or use to delay execution of some logic. - - -### [DataSourceLocalDataProvider](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/DataSourceLocalDataProvider) -Represents a local data provider which has synchronous access to actual data items. - -- **DataSource**: `object` - -### [DataSourceSchema](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/DataSourceSchema) -Represents information about the properties available on items of a data source. - - -### [DataSourceSupportsCount](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/DataSourceSupportsCount) -A data source that supports indicating the actual count of its items. - - -### [DataSourceSupportsIndexedAccess](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/DataSourceSupportsIndexedAccess) -A data source that supports indexed access to its items. - -- **GetItemAtIndex(int)**: `object` -- **GetItemAtIndexAsync(int)**: `Task` — Returns the item at the specific index in the data source. This index is based on the data source's current view of the data, not the actual underlying indexes of the original source. - -### [DataSourceUpdateNotifier](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/DataSourceUpdateNotifier) -Represents the events that a data source can notify consumers about. - -- **NotifyClearItems()**: `any` -- **NotifyClearItemsAsync()**: `Task` — Called when a large change occurs in the data source, or the content of the data source has been cleared. -- **NotifyInsertItem(int, object)**: `any` -- **NotifyInsertItemAsync(int, object)**: `Task` -- **NotifyRemoveItem(int, object)**: `any` -- **NotifyRemoveItemAsync(int, object)**: `Task` -- **NotifySetItem(int, object, object)**: `any` -- **NotifySetItemAsync(int, object, object)**: `Task` -- **RangeActualized(int, int)**: `any` -- **RangeActualizedAsync(int, int)**: `Task` - -### [DataSourceVirtualDataProvider](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/DataSourceVirtualDataProvider) -Represents a virtual data provider for a data source. A virtual data provider is paged and will load requested pages asynchronously. - -- **AddPageRequest(int, DataSourcePageRequestPriority)**: `any` -- **AddPageRequestAsync(int, DataSourcePageRequestPriority)**: `Task` -- **BatchCompleted**: `string` -- **Close()**: `any` -- **CloseAsync()**: `Task` — Closes the data provider, destroying its pending work. -- **CreateBatchRequest(IgbTransactionState[])**: `any` -- **CreateBatchRequestAsync(IgbTransactionState[])**: `Task` -- **PageLoaded**: `string` -- **PageSizeRequested**: `int` -- **RemoveAllPageRequests()**: `any` -- **RemoveAllPageRequestsAsync()**: `Task` — Removes all page requests from the data provider. -- **RemovePageRequest(int)**: `any` -- **RemovePageRequestAsync(int)**: `Task` — Removes a page request for a given page index. - -### [EditableDataSource](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/EditableDataSource) -AddOnSchemaChangedListener Represents a data source for use in components which need advanced access to data. - -- **AcceptPendingCommit(int)**: `any` -- **AcceptPendingCommitAsync(int)**: `Task` — Accepts a pending commit. -- **AcceptPendingTransaction(int)**: `any` -- **AcceptPendingTransactionAsync(int)**: `Task` — Accept a specific pending transaction. -- **AddItem(object)**: `any` -- **AddItemAsync(object)**: `Task` — Adds the provided item to the data source. -- **CancelEdits()**: `any` -- **CancelEditsAsync()**: `Task` — Cancels all the current edits. -- **CommitEdits(bool)**: `int` -- **CommitEditsAsync(bool)**: `Task` — Commit the current edits to the datasource. -- **GetAggregatedChanges(int)**: `IgbDataSourceAggregatedResult[]` -- **GetAggregatedChangesAsync(int)**: `Task` — Returns a set of changes that have been made to the data however have not been committed yet. -- **GetTransactionErrorByID(int)**: `string` -- **GetTransactionErrorByIDAsync(int)**: `Task` — Returns an error, if any, associated with a specific transaction. -- **GetTransactionErrorByKey(object[], string)**: `string` -- **GetTransactionErrorByKeyAsync(object[], string)**: `Task` -- **GetTransactionID(object[], string)**: `int` -- **GetTransactionIDAsync(object[], string)**: `Task` -- **HasAdd(object)**: `bool` -- **HasAddAsync(object)**: `Task` — Returns whether the item is an uncommitted add. -- **HasDelete(object[])**: `bool` -- **HasDeleteAsync(object[])**: `Task` -- **HasEdit(object[], string)**: `bool` -- **HasEditAsync(object[], string)**: `Task` -- **IsBatchingEnabled**: `bool` -- **IsPendingCommit(int)**: `bool` -- **IsPendingCommitAsync(int)**: `Task` — Returns whether a commit is pending or not. -- **IsPendingTransaction(int)**: `bool` -- **IsPendingTransactionAsync(int)**: `Task` — Returns whether a transaction pending or not. -- **IsReadOnly**: `bool` -- **Redo()**: `any` -- **RedoAsync()**: `Task` — Redo the last undo. -- **RejectPendingCommit(int)**: `any` -- **RejectPendingCommitAsync(int)**: `Task` — Reject a pending commit. -- **RejectPendingTransaction(int)**: `any` -- **RejectPendingTransactionAsync(int)**: `Task` — Rejects a pending transaction. -- **RemoveItem(object)**: `any` -- **RemoveItemAsync(object)**: `Task` — Removes an item from the datasource. -- **RemoveItemByKey(object[])**: `any` -- **RemoveItemByKeyAsync(object[])**: `Task` -- **SetTransactionError(int, string)**: `any` -- **SetTransactionErrorAsync(int, string)**: `Task` -- **Undo()**: `any` -- **UndoAsync()**: `Task` — Undo the last edit. -- **UpdatePropertyAtKey(object[], string, object, bool)**: `int` -- **UpdatePropertyAtKeyAsync(object[], string, object, bool)**: `Task` - -### [IDataIntentAttribute](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/IDataIntentAttribute) - -- **Intent**: `string` - -### [IExecutionContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/IExecutionContext) -Represents an execution context upon which work can be synchronized. - -- **EnqueueAction(ExecutionContextExecuteCallback)**: `any` — Enqueues the requested callback on the context to be executed at earliest opportunity. -- **EnqueueAnimationAction(ExecutionContextExecuteCallback)**: `any` — Enqueues the requested callback on the context to be executed at earliest opportunity, to be used for animation. -- **Execute(ExecutionContextExecuteCallback)**: `any` — Executes the requested callback on the context. -- **ExecuteDelayed(ExecutionContextExecuteCallback, int)**: `any` — Enqueues the requested callback on the context to be executed after at least the specified delay. -- **GetCurrentRelativeTime()**: `long` — Gets the current relative time in milliseconds that has elapsed since the execution context was created. - -### [IIgniteUIBlazor](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/IIgniteUIBlazor) - -- **IsLoadRequested(string)**: `bool` -- **IsRuntimeValid(bool)**: `bool` -- **JsRuntime**: `IJSRuntime` -- **MarkIsLoadRequested(string)**: `any` -- **RequestLoad(string)**: `any` -- **Settings**: `IIgniteUIBlazorSettings` -- **WebCallback**: `WebCallback` - -### [IIgniteUIBlazorSettings](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/IIgniteUIBlazorSettings) - -- **ForceJsonDataMarshalling**: `bool` -- **JsonSerializerOptions**: `IgniteUIJsonSerializerOptions` -- **ModulesToLoad**: `ReadOnlyCollection` - -### [IgbTileGenerator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/IgbTileGenerator) - - -### [JsonSerializable](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/JsonSerializable) - -- **Serialize(SerializationContext, string)**: `any` - -### [LegendContext](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/LegendContext) - - -### [LegendOwner](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/LegendOwner) -An owner of a legend. - - -### [LegendSeries](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/LegendSeries) -A series that can display in a legend. - -- **ResolveLegendIndex()**: `int` -- **ResolveLegendIndexAsync()**: `Task` — Returns the index to use in the legend. - -### [SupportsDataChangeNotifications](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/SupportsDataChangeNotifications) -Implementors support being notified of changes to data collections. - -- **NotifyClearItems()**: `any` -- **NotifyClearItemsAsync()**: `Task` — Called when a large number or all items have changed, or the collection has been cleared. -- **NotifyInsertItem(int, object)**: `any` -- **NotifyInsertItemAsync(int, object)**: `Task` -- **NotifyRemoveItem(int, object)**: `any` -- **NotifyRemoveItemAsync(int, object)**: `Task` -- **NotifySetItem(int, object, object)**: `any` -- **NotifySetItemAsync(int, object, object)**: `Task` - -### [SupportsExpansionChangeNotifications](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/interfaces/SupportsExpansionChangeNotifications) -Implementors support being notified of expansion changes. - -- **NotifyRowExpansionChanged(int, bool, bool)**: `any` -- **NotifyRowExpansionChangedAsync(int, bool, bool)**: `Task` - -## Enumerations - -### [AbsolutePosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/AbsolutePosition) - -- **Bottom** -- **Middle** -- **Top** - -### [ActualLegendItemBadgeShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ActualLegendItemBadgeShape) - -- **BarShape** -- **CircleShape** -- **ColumnShape** -- **HiddenShape** -- **LineMarkerless** -- **LineWithMarker** -- **MarkerShape** -- **SquareFinancial** -- **SquareIndicator** -- **SquareShape** - -### [AngleAxisLabelLocation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/AngleAxisLabelLocation) - -- **Auto** -- **InsideBottom** -- **InsideTop** -- **OutsideBottom** -- **OutsideTop** - -### [AnnotationAppearanceMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/AnnotationAppearanceMode) - -- **Auto** -- **BrightnessShift** -- **DashPattern** -- **OpacityShift** -- **SaturationShift** - -### [AutoCalloutVisibilityMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/AutoCalloutVisibilityMode) - -- **Auto** -- **DedicatedLanes** -- **Normal** - -### [AutoMarginsAndAngleUpdateMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/AutoMarginsAndAngleUpdateMode) - -- **None** -- **SizeChanging** -- **SizeChangingAndZoom** - -### [AvatarShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/AvatarShape) - -- **Circle** -- **Rounded** -- **Square** - -### [AxisAngleLabelMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/AxisAngleLabelMode) - -- **Auto** -- **Center** -- **ClosestPoint** - -### [AxisExtentType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/AxisExtentType) - -- **Percent** -- **Pixel** - -### [AxisLabelsLocation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/AxisLabelsLocation) - -- **InsideBottom** -- **InsideLeft** -- **InsideRight** -- **InsideTop** -- **OutsideBottom** -- **OutsideLeft** -- **OutsideRight** -- **OutsideTop** - -### [AxisRangeBufferMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/AxisRangeBufferMode) - -- **Auto** -- **None** -- **Series** -- **SeriesMaximum** -- **SeriesMinimum** - -### [AxisTitlePosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/AxisTitlePosition) - -- **Auto** -- **Bottom** -- **Left** -- **Right** -- **Top** - -### [AzureMapsImageryStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/AzureMapsImageryStyle) - -- **DarkGrey** -- **HybridDarkGreyOverlay** -- **HybridRoadOverlay** -- **LabelsDarkGreyOverlay** -- **LabelsRoadOverlay** -- **Road** -- **Satellite** -- **TerraOverlay** -- **TrafficAbsoluteOverlay** -- **TrafficDelayOverlay** -- **TrafficReducedOverlay** -- **TrafficRelativeDarkOverlay** -- **TrafficRelativeOverlay** -- **WeatherInfraredOverlay** -- **WeatherRadarOverlay** - -### [BadgeShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/BadgeShape) - -- **Rounded** -- **Square** - -### [BaseControlTheme](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/BaseControlTheme) - -- **Default** -- **DenaliLight** -- **MaterialLight** -- **RevealDark** -- **RevealLight** -- **SlingshotDark** -- **SlingshotLight** - -### [BingMapsImageryStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/BingMapsImageryStyle) - -- **Aerial** -- **AerialWithLabels** -- **CanvasDark** -- **CanvasGray** -- **CanvasLight** -- **Road** - -### [BrushSelectionMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/BrushSelectionMode) - -- **Interpolate** -- **Select** - -### [BrushType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/BrushType) - -- **LinearGradient** -- **RadialGradient** -- **Solid** - -### [ButtonBaseTarget](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ButtonBaseTarget) - -- **_blank** -- **_parent** -- **_self** -- **_top** - -### [ButtonBaseType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ButtonBaseType) - -- **Button** -- **Reset** -- **Submit** - -### [ButtonDisplayStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ButtonDisplayStyle) - -- **Fab** -- **Flat** -- **Icon** -- **Outlined** -- **Raised** - -### [ButtonGroupSelection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ButtonGroupSelection) - -- **Multiple** -- **Single** -- **SingleRequired** - -### [ButtonVariant](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ButtonVariant) - -- **Contained** -- **Fab** -- **Flat** -- **Outlined** - -### [CalendarActiveView](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CalendarActiveView) - -- **Days** -- **Months** -- **Years** - -### [CalendarHeaderOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CalendarHeaderOrientation) - -- **Horizontal** -- **Vertical** - -### [CalendarSelection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CalendarSelection) - -- **Multiple** -- **Range** -- **Single** - -### [CalloutCollisionMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CalloutCollisionMode) - -- **Auto** -- **Greedy** -- **GreedyCenterOfMass** -- **RadialBestFit** -- **RadialCenter** -- **RadialInsideEnd** -- **RadialOutsideEnd** -- **SimulatedAnnealing** - -### [CalloutPlacementPositions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CalloutPlacementPositions) - -- **Bottom** -- **BottomLeft** -- **BottomRight** -- **Left** -- **Right** -- **Top** -- **TopLeft** -- **TopRight** - -### [CaptureImageFormat](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CaptureImageFormat) - -- **Jpeg** -- **Png** - -### [CarouselAnimationDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CarouselAnimationDirection) - -- **Next** -- **Prev** - -### [CarouselIndicatorsOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CarouselIndicatorsOrientation) - -- **End** -- **Start** - -### [CategoryChartType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CategoryChartType) - -- **Area** -- **Auto** -- **Column** -- **Line** -- **Point** -- **Spline** -- **SplineArea** -- **StepArea** -- **StepLine** -- **Waterfall** - -### [CategoryCollisionMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CategoryCollisionMode) - -- **MatchHeight** -- **WholeColumn** - -### [CategoryItemHighlightType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CategoryItemHighlightType) - -- **Auto** -- **Marker** -- **Shape** - -### [CategorySeriesMarkerCollisionAvoidance](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CategorySeriesMarkerCollisionAvoidance) - -- **None** -- **Omit** - -### [CategoryTooltipLayerPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CategoryTooltipLayerPosition) - -- **Auto** -- **InsideEnd** -- **InsideStart** -- **OutsideEnd** -- **OutsideStart** - -### [CategoryTransitionInMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CategoryTransitionInMode) - -- **AccordionFromBottom** -- **AccordionFromCategoryAxisMaximum** -- **AccordionFromCategoryAxisMinimum** -- **AccordionFromLeft** -- **AccordionFromRight** -- **AccordionFromTop** -- **AccordionFromValueAxisMaximum** -- **AccordionFromValueAxisMinimum** -- **Auto** -- **Expand** -- **FromParent** -- **FromZero** -- **SweepFromBottom** -- **SweepFromCategoryAxisMaximum** -- **SweepFromCategoryAxisMinimum** -- **SweepFromCenter** -- **SweepFromLeft** -- **SweepFromRight** -- **SweepFromTop** -- **SweepFromValueAxisMaximum** -- **SweepFromValueAxisMinimum** - -### [CellContentHorizontalAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CellContentHorizontalAlignment) - -- **Auto** -- **Center** -- **Left** -- **Right** -- **Stretch** - -### [CellContentVerticalAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CellContentVerticalAlignment) - -- **Auto** -- **Bottom** -- **Center** -- **Stretch** -- **Top** - -### [CellDataLoadedAnimationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CellDataLoadedAnimationMode) - -- **Auto** -- **CrossFade** -- **None** - -### [CellPropertyAnimationType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CellPropertyAnimationType) - -- **BoolValue** -- **BrushValue** -- **DateValue** -- **DoubleValue** -- **EnumValue** -- **FontValue** -- **IgnoredValue** -- **IntValue** -- **None** -- **NumberValue** -- **ObjectValue** -- **StringValue** - -### [CellSelectionAnimationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CellSelectionAnimationMode) - -- **Auto** -- **ColorBlend** -- **None** - -### [ChartHitTestMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ChartHitTestMode) - -- **Auto** -- **ColorEncoded** -- **Computational** -- **Mixed** -- **MixedFavoringComputational** - -### [CheckboxListIndexType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CheckboxListIndexType) - -- **DeSelected** -- **Selected** - -### [CloneDataSourceFilterOperation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CloneDataSourceFilterOperation) - -- **None** -- **TextToValue** -- **ValueToText** - -### [CollisionAvoidanceType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CollisionAvoidanceType) - -- **Fade** -- **FadeAndShift** -- **None** -- **Omit** -- **OmitAndShift** - -### [ColorScaleInterpolationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ColorScaleInterpolationMode) - -- **InterpolateHSV** -- **InterpolateRGB** -- **Select** - -### [ColumnComparisonConditionOperatorType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ColumnComparisonConditionOperatorType) - -- **Bottom** -- **BottomPercentile** -- **Contains** -- **Custom** -- **DoesNotContain** -- **DoesNotEndWith** -- **DoesNotStartWith** -- **Empty** -- **EndsWith** -- **Equals** -- **False** -- **GreaterThan** -- **GreaterThanOrEqualTo** -- **IsNotNull** -- **IsNull** -- **LastMonth** -- **LastQuarter** -- **LastWeek** -- **LastYear** -- **LessThan** -- **LessThanOrEqualTo** -- **Month** -- **NextMonth** -- **NextQuarter** -- **NextWeek** -- **NextYear** -- **NotEmpty** -- **NotEquals** -- **Q1** -- **Q2** -- **Q3** -- **Q4** -- **StartsWith** -- **ThisMonth** -- **ThisQuarter** -- **ThisWeek** -- **ThisYear** -- **Today** -- **Tomorrow** -- **Top** -- **TopPercentile** -- **True** -- **Year** -- **YearToDate** -- **Yesterday** - -### [ColumnExchangingAnimationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ColumnExchangingAnimationMode) - -- **Auto** -- **Crossfade** -- **None** -- **SlideToBottom** -- **SlideToBottomAndCrossfade** -- **SlideToLeft** -- **SlideToLeftAndCrossfade** -- **SlideToRight** -- **SlideToRightAndCrossfade** -- **SlideToTop** -- **SlideToTopAndCrossfade** - -### [ColumnHidingAnimationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ColumnHidingAnimationMode) - -- **Auto** -- **FadeOut** -- **None** -- **SlideToBottom** -- **SlideToBottomAndFadeOut** -- **SlideToLeft** -- **SlideToLeftAndFadeOut** -- **SlideToRight** -- **SlideToRightAndFadeOut** -- **SlideToTop** -- **SlideToTopAndFadeOut** - -### [ColumnMovingAnimationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ColumnMovingAnimationMode) - -- **Auto** -- **None** -- **SlideOver** - -### [ColumnMovingMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ColumnMovingMode) - -- **Deferred** -- **None** - -### [ColumnOptionsIconAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ColumnOptionsIconAlignment) - -- **None** -- **Opposite** -- **Unset** - -### [ColumnOptionsIconBehavior](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ColumnOptionsIconBehavior) - -- **AlwaysVisible** -- **AppearOnHover** -- **AppearOnHoverAnimate** -- **Unset** - -### [ColumnPinningPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ColumnPinningPosition) - -- **End** -- **Start** - -### [ColumnPropertyUpdatingAnimationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ColumnPropertyUpdatingAnimationMode) - -- **Auto** -- **Interpolate** -- **InterpolateDeep** -- **None** - -### [ColumnResizingAnimationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ColumnResizingAnimationMode) - -- **Auto** -- **Interpolate** -- **None** - -### [ColumnResizingMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ColumnResizingMode) - -- **Deferred** -- **Immediate** -- **None** - -### [ColumnShowingAnimationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ColumnShowingAnimationMode) - -- **Auto** -- **FadeIn** -- **None** -- **SlideFromBottom** -- **SlideFromBottomAndFadeIn** -- **SlideFromLeft** -- **SlideFromLeftAndFadeIn** -- **SlideFromRight** -- **SlideFromRightAndFadeIn** -- **SlideFromTop** -- **SlideFromTopAndFadeIn** - -### [ColumnSortDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ColumnSortDirection) - -- **Ascending** -- **Descending** -- **None** - -### [ComboChangeType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ComboChangeType) - -- **Addition** -- **Deselection** -- **Selection** - -### [ComboEditorCloneDataSourceFilterOperation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ComboEditorCloneDataSourceFilterOperation) - -- **None** -- **TextToValue** -- **ValueToText** - -### [ComboEditorSelectedItemChangeType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ComboEditorSelectedItemChangeType) - -- **Row** -- **Text** -- **Value** - -### [ComputedPlotAreaMarginMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ComputedPlotAreaMarginMode) - -- **Auto** -- **None** -- **Series** - -### [ConsolidatedItemHitTestBehavior](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ConsolidatedItemHitTestBehavior) - -- **Basic** -- **NearestY** - -### [ConsolidatedItemsPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ConsolidatedItemsPosition) - -- **Maximum** -- **Median** -- **Minimum** -- **RelativeMaximum** -- **RelativeMinimum** - -### [ContentOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ContentOrientation) - -- **Horizontal** -- **Vertical** - -### [ControlDisplayDensity](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ControlDisplayDensity) - -- **Auto** -- **Comfortable** -- **Compact** -- **Cosy** -- **Minimal** - -### [ControlEventBehavior](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ControlEventBehavior) -Determines the behavior of events as they are fired at the JavaScript level and bubbled up to the Blazor level. - -- **Auto** — The behavior is automatically determined by the component. -- **Immediate** — The behavior is to immediately fire event handlers. -- **Queued** — The behavior is to queue the event handlers to the next available cycle. - -### [CrosshairsDisplayMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/CrosshairsDisplayMode) - -- **Auto** -- **Both** -- **Horizontal** -- **None** -- **Vertical** - -### [DashboardTileVisualizationType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DashboardTileVisualizationType) - -- **AreaChart** -- **Auto** -- **BarChart** -- **BubbleChart** -- **BulletGraph** -- **CandlestickChart** -- **ChoroplethMap** -- **ColumnChart** -- **DoughnutChart** -- **FunnelChart** -- **Grid** -- **HeatmapMap** -- **HighDensityMap** -- **KPI** -- **LineChart** -- **LinearGauge** -- **Map** -- **OHLCChart** -- **PieChart** -- **PolarChart** -- **RadialGauge** -- **RadialLineChart** -- **ScatterChart** -- **ScatterMap** -- **SparklineChart** -- **SplineAreaChart** -- **SplineChart** -- **StackedAreaChart** -- **StackedBarChart** -- **StackedColumnChart** -- **StepAreaChart** -- **StepLineChart** -- **TextGauge** -- **TextView** -- **TimeSeriesChart** -- **Treemap** - -### [DataAbbreviationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataAbbreviationMode) - -- **Auto** -- **Billion** -- **Independent** -- **Kilo** -- **Million** -- **None** -- **Quadrillion** -- **Shared** -- **Trillion** -- **Unset** - -### [DataAnnotationDisplayMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataAnnotationDisplayMode) - -- **Auto** -- **AxisValue** -- **DataLabel** -- **DataValue** -- **Hidden** -- **PixelValue** -- **WindowValue** - -### [DataAnnotationTargetMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataAnnotationTargetMode) - -- **Auto** -- **CategoryXAxes** -- **CategoryYAxes** -- **CompanionXAxes** -- **CompanionYAxes** -- **DataSourceAxes** -- **HorizontalAxes** -- **None** -- **NumericXAxes** -- **NumericYAxes** -- **PrimaryXAxes** -- **PrimaryYAxes** -- **TimeAxes** -- **VerticalAxes** - -### [DataGridSelectionMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataGridSelectionMode) - -- **MultipleCell** -- **MultipleRow** -- **None** -- **RangeCell** -- **SingleCell** -- **SingleRow** - -### [DataLegendHeaderDateMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataLegendHeaderDateMode) - -- **Auto** -- **FullStyle** -- **LongStyle** -- **MediumStyle** -- **None** -- **ShortStyle** - -### [DataLegendHeaderTimeMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataLegendHeaderTimeMode) - -- **Auto** -- **FullStyle** -- **LongStyle** -- **MediumStyle** -- **None** -- **ShortStyle** - -### [DataLegendLabelMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataLegendLabelMode) - -- **Auto** -- **Hidden** -- **Visible** - -### [DataLegendLayoutMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataLegendLayoutMode) - -- **Table** -- **Vertical** - -### [DataLegendSeriesFamily](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataLegendSeriesFamily) - -- **Category** -- **Financial** -- **Geographic** -- **Highlight** -- **Indicator** -- **Polar** -- **Radial** -- **Range** -- **Scatter** -- **Shape** -- **Stacked** - -### [DataLegendSeriesValueType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataLegendSeriesValueType) - -- **Angle** -- **Average** -- **Change** -- **Close** -- **Fill** -- **High** -- **Low** -- **Open** -- **Radius** -- **Range** -- **Summary** -- **TypicalPrice** -- **Value** -- **Volume** -- **XValue** -- **YValue** - -### [DataLegendSummaryType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataLegendSummaryType) - -- **Auto** -- **Average** -- **Max** -- **Min** -- **None** -- **Total** - -### [DataLegendUnitsMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataLegendUnitsMode) - -- **Auto** -- **Hidden** -- **Visible** - -### [DataLegendValueMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataLegendValueMode) - -- **Auto** -- **Currency** -- **Decimal** - -### [DataPieChartType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataPieChartType) - -- **Auto** -- **PieSingleRing** - -### [DataSeriesAxisType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataSeriesAxisType) - -- **Category** -- **CategoryAngle** -- **ContinuousDateTime** -- **DiscreteDateTime** -- **Linear** -- **Logarithmic** -- **NotApplicable** -- **ProportionalCategoryAngle** -- **RadialLinear** -- **RadialLogarithmic** - -### [DataSeriesIntent](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataSeriesIntent) - -- **AxisDateValue** -- **AxisLabelValue** -- **CloseSeriesValue** -- **DontPlot** -- **GenerationInput** -- **HighSeriesValue** -- **LowSeriesValue** -- **OpenSeriesValue** -- **PrimarySeriesValue** -- **SalesFixedCost** -- **SalesMarginalProfit** -- **SalesRevenue** -- **SalesTotalCost** -- **SalesUnit** -- **SalesVariableCost** -- **SeriesAngle** -- **SeriesFill** -- **SeriesGroup** -- **SeriesLabel** -- **SeriesRadius** -- **SeriesShape** -- **SeriesTitle** -- **SeriesValue** -- **SeriesX** -- **SeriesY** -- **VolumeSeriesValue** - -### [DataSeriesMarker](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataSeriesMarker) - -- **Automatic** -- **Circle** -- **Diamond** -- **Hexagon** -- **Hexagram** -- **Hidden** -- **None** -- **Pentagon** -- **Pentagram** -- **Pyramid** -- **Smart** -- **Square** -- **Tetragram** -- **Triangle** - -### [DataSeriesPropertyType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataSeriesPropertyType) - -- **DateTime** -- **Numeric** -- **String1** - -### [DataSeriesType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataSeriesType) - -- **Area** -- **Bar** -- **CalloutLayer** -- **CategoryHighlightLayer** -- **CategoryItemHighlightLayer** -- **CategoryToolTipLayer** -- **Column** -- **CrosshairLayer** -- **DataToolTipLayer** -- **FinalValueLayer** -- **FinancialIndicator** -- **FinancialOverlay** -- **FinancialPrice** -- **GeographicBubble** -- **GeographicContour** -- **GeographicHeat** -- **GeographicHighDensity** -- **GeographicPolygon** -- **GeographicPolyline** -- **GeographicScatter** -- **GeographicScatterArea** -- **ItemToolTipLayer** -- **Line** -- **LinearGauge** -- **Pie** -- **Point** -- **RadialGauge** -- **RadialLine** -- **ScatterArea** -- **ScatterBubble** -- **ScatterContour** -- **ScatterHighDensity** -- **ScatterLine** -- **ScatterPoint** -- **ScatterPolygon** -- **ScatterPolyline** -- **ScatterSpline** -- **Spline** -- **SplineArea** -- **Stacked** -- **StepArea** -- **StepLine** -- **TrendLineLayer** -- **Unknown** -- **UserAnnotationToolTipLayer** -- **ValueLayer** -- **ValueOverlay** -- **Waterfall** - -### [DataSourcePageRequestPriority](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataSourcePageRequestPriority) - -- **High** -- **Low** -- **Normal** - -### [DataSourceRowType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataSourceRowType) - -- **Custom** -- **Normal** -- **SectionFooter** -- **SectionHeader** -- **ShiftedRow** -- **SummaryRowRoot** -- **SummaryRowSection** - -### [DataSourceSchemaPropertyType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataSourceSchemaPropertyType) - -- **BooleanValue** -- **ByteValue** -- **DateTimeOffsetValue** -- **DateTimeValue** -- **DecimalValue** -- **DoubleValue** -- **IntValue** -- **LongValue** -- **ObjectValue** -- **ShortValue** -- **SingleValue** -- **StringValue** - -### [DataSourceSectionHeaderDisplayMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataSourceSectionHeaderDisplayMode) - -- **Combined** -- **Split** - -### [DataSourceSummaryOperand](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataSourceSummaryOperand) - -- **Average** -- **Count** -- **Custom** -- **Max** -- **Min** -- **Sum** - -### [DataSourceSummaryScope](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataSourceSummaryScope) - -- **Both** -- **Groups** -- **None** -- **Root** - -### [DataToolTipLayerGroupingMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataToolTipLayerGroupingMode) - -- **Auto** -- **Grouped** -- **Individual** - -### [DataToolTipLayerPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataToolTipLayerPosition) - -- **Auto** -- **InsideEnd** -- **InsideStart** -- **OutsideEnd** -- **OutsideStart** - -### [DataTooltipConstraintMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataTooltipConstraintMode) - -- **Application** -- **Auto** -- **Chart** -- **None** -- **PlotArea** - -### [DataTooltipGroupedPositionX](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataTooltipGroupedPositionX) - -- **Auto** -- **LeftEdgeSnapLeft** -- **LeftEdgeSnapMiddle** -- **LeftEdgeSnapRight** -- **PinLeft** -- **PinMiddle** -- **PinRight** -- **RightEdgeSnapLeft** -- **RightEdgeSnapMiddle** -- **RightEdgeSnapRight** -- **SnapLeft** -- **SnapMiddle** -- **SnapRight** -- **TrackLeft** -- **TrackMiddle** -- **TrackRight** - -### [DataTooltipGroupedPositionY](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DataTooltipGroupedPositionY) - -- **Auto** -- **BottomEdgeSnapBottom** -- **BottomEdgeSnapMiddle** -- **BottomEdgeSnapTop** -- **PinBottom** -- **PinMiddle** -- **PinTop** -- **SnapBottom** -- **SnapMiddle** -- **SnapTop** -- **TopEdgeSnapBottom** -- **TopEdgeSnapMiddle** -- **TopEdgeSnapTop** -- **TrackBottom** -- **TrackMiddle** -- **TrackTop** - -### [DateFormats](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DateFormats) - -- **DateLong** -- **DateShort** - -### [DatePart](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DatePart) - -- **AmPm** -- **Date** -- **Hours** -- **Minutes** -- **Month** -- **Seconds** -- **Year** - -### [DatePartType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DatePartType) - -- **AmPm** -- **Date** -- **Hours** -- **Literal** -- **Minutes** -- **Month** -- **Seconds** -- **Year** - -### [DateRangeType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DateRangeType) - -- **After** -- **Before** -- **Between** -- **Specific** -- **Weekdays** -- **Weekends** - -### [DateTimeFormats](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DateTimeFormats) - -- **DateLong** -- **DateShort** -- **DateTimeLong** -- **DateTimeShort** -- **TimeLong** -- **TimeShort** - -### [DayOfWeek](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DayOfWeek) - -- **Friday** -- **Monday** -- **Saturday** -- **Sunday** -- **Thursday** -- **Tuesday** -- **Wednesday** - -### [DividerType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DividerType) - -- **Dashed** -- **Solid** - -### [DockManagerPaneType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DockManagerPaneType) - -- **ContentPane** -- **DocumentHost** -- **SplitPane** -- **TabGroupPane** - -### [DockManagerShowHeaderIconOnHover](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DockManagerShowHeaderIconOnHover) - -- **All** -- **CloseOnly** -- **MoreOptionsOnly** -- **None** - -### [DockManagerShowPaneHeaders](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DockManagerShowPaneHeaders) - -- **Always** -- **OnHoverOnly** - -### [DockingIndicatorPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DockingIndicatorPosition) - -- **Bottom** -- **Center** -- **Left** -- **OuterBottom** -- **OuterLeft** -- **OuterRight** -- **OuterTop** -- **Right** -- **SplitterHorizontal** -- **SplitterVertical** -- **Top** - -### [DomainType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DomainType) - -- **Category** -- **Financial** -- **Pie** -- **Scatter** -- **Shape** - -### [DropPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/DropPosition) - -- **AfterDropTarget** -- **BeforeDropTarget** - -### [EditModeClickAction](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/EditModeClickAction) - -- **DoubleClick** -- **None** -- **SingleClick** - -### [EditModeType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/EditModeType) - -- **Cell** -- **CellBatch** -- **None** -- **Row** - -### [EditorType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/EditorType) - -- **Combo** -- **Date** -- **Default** -- **Numeric** -- **Text** - -### [ElevationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ElevationMode) - -- **Auto** -- **HaloShadow** -- **MaterialShadow** - -### [EnterKeyBehaviorAfterEdit](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/EnterKeyBehaviorAfterEdit) - -- **MoveDown** -- **MoveLeft** -- **MoveRight** -- **MoveUp** -- **None** - -### [EnterKeyBehaviors](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/EnterKeyBehaviors) - -- **Edit** -- **MoveDown** -- **MoveLeft** -- **MoveRight** -- **MoveUp** -- **None** - -### [ExpansionPanelIndicatorPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ExpansionPanelIndicatorPosition) - -- **End** -- **None** -- **Start** - -### [FeatureState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FeatureState) - -- **Disabled** -- **Enabled** -- **Unset** - -### [FilterComparisonType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FilterComparisonType) - -- **CaseInsensitive** -- **CaseSensitive** -- **Default** - -### [FilterExpressionFunctionType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FilterExpressionFunctionType) - -- **Cast** -- **Ceiling** -- **Concat** -- **Contains** -- **Date** -- **Day** -- **EndsWith** -- **Env** -- **Floor** -- **Hour** -- **IndexOf** -- **IsOf** -- **Length** -- **Minute** -- **Month** -- **Now** -- **Replace** -- **Round** -- **Second** -- **StartsWith** -- **Substring** -- **Time** -- **ToLower** -- **ToUpper** -- **Trim** -- **Year** - -### [FilterExpressionOperatorType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FilterExpressionOperatorType) - -- **Add** -- **And** -- **Divide** -- **Equal** -- **GreaterThan** -- **GreaterThanOrEqual** -- **Grouping** -- **LessThan** -- **LessThanOrEqual** -- **Modulo** -- **Multiply** -- **None** -- **Not** -- **NotEqual** -- **Or** -- **Subtract** - -### [FilterExpressionWrapperType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FilterExpressionWrapperType) - -- **Last30** -- **Last365** -- **Last7** -- **LastMonth** -- **LastQuarter** -- **LastWeek** -- **LastYear** -- **MonthToDate** -- **NextMonth** -- **NextQuarter** -- **NextWeek** -- **NextYear** -- **Q1** -- **Q2** -- **Q3** -- **Q4** -- **QuarterToDate** -- **ThisMonth** -- **ThisQuarter** -- **ThisWeek** -- **ThisYear** -- **Today** -- **Tomorrow** -- **TrailingTwelveMonths** -- **YearToDate** -- **Yesterday** - -### [FilterLogicalOperator](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FilterLogicalOperator) - -- **And** -- **Or** - -### [FilterMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FilterMode) - -- **ExcelStyleFilter** -- **QuickFilter** - -### [FilterUIType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FilterUIType) - -- **ColumnOptions** -- **FilterRow** -- **None** - -### [FilteringExpressionsTreeType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FilteringExpressionsTreeType) - -- **Advanced** -- **Regular** - -### [FilteringLogic](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FilteringLogic) - -- **And** -- **Or** - -### [FinalValueSelectionMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FinalValueSelectionMode) - -- **Auto** -- **Final** -- **FinalVisible** -- **FinalVisibleInterpolated** - -### [FinancialChartRangeSelectorOption](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FinancialChartRangeSelectorOption) - -- **All** -- **OneMonth** -- **OneYear** -- **SixMonths** -- **ThreeMonths** -- **YearToDate** - -### [FinancialChartType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FinancialChartType) - -- **Auto** -- **Bar** -- **Candle** -- **Column** -- **Line** - -### [FinancialChartVolumeType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FinancialChartVolumeType) - -- **Area** -- **Column** -- **Line** -- **None** - -### [FinancialChartXAxisMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FinancialChartXAxisMode) - -- **Ordinal** -- **Time** - -### [FinancialChartYAxisMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FinancialChartYAxisMode) - -- **Numeric** -- **PercentChange** - -### [FinancialChartZoomSliderType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FinancialChartZoomSliderType) - -- **Area** -- **Auto** -- **Bar** -- **Candle** -- **Column** -- **Line** -- **None** - -### [FinancialIndicatorType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FinancialIndicatorType) - -- **AbsoluteVolumeOscillator** -- **AccumulationDistribution** -- **AverageDirectionalIndex** -- **AverageTrueRange** -- **BollingerBandWidth** -- **ChaikinOscillator** -- **ChaikinVolatility** -- **CommodityChannelIndex** -- **DetrendedPriceOscillator** -- **EaseOfMovement** -- **FastStochasticOscillator** -- **ForceIndex** -- **FullStochasticOscillator** -- **MarketFacilitationIndex** -- **MassIndex** -- **MedianPrice** -- **MoneyFlowIndex** -- **MovingAverageConvergenceDivergence** -- **NegativeVolumeIndex** -- **OnBalanceVolume** -- **PercentagePriceOscillator** -- **PercentageVolumeOscillator** -- **PositiveVolumeIndex** -- **PriceVolumeTrend** -- **RateOfChangeAndMomentum** -- **RelativeStrengthIndex** -- **SlowStochasticOscillator** -- **StandardDeviation** -- **StochRSI** -- **TRIX** -- **TypicalPrice** -- **UltimateOscillator** -- **WeightedClose** -- **WilliamsPercentR** - -### [FinancialOverlayType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FinancialOverlayType) - -- **BollingerBands** -- **PriceChannel** - -### [FirstWeek](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FirstWeek) - -- **FirstDay** -- **FirstFourDayWeek** -- **FirstFullWeek** - -### [FlatDataProviderJoinCollisionType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FlatDataProviderJoinCollisionType) - -- **Auto** -- **LeftOnly** -- **PreferLeft** -- **PreferRight** -- **RightOnly** - -### [FlatDataProviderJoinType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FlatDataProviderJoinType) - -- **Join** -- **Left** -- **Right** - -### [FunnelSliceDisplay](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/FunnelSliceDisplay) - -- **Uniform** -- **Weighted** - -### [GenericDataSourceSchemaPropertyType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GenericDataSourceSchemaPropertyType) - -- **BooleanValue** -- **DateTimeValue** -- **DoubleValue** -- **IntValue** -- **StringValue** - -### [GridActivationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridActivationMode) - -- **Cell** -- **None** - -### [GridCellMergeMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridCellMergeMode) - -- **Always** -- **OnSort** - -### [GridColumnDataType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridColumnDataType) - -- **Boolean** -- **Currency** -- **Date** -- **DateTime** -- **Image** -- **Number** -- **Percent** -- **String** -- **Time** - -### [GridConditionalStyleBoundType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridConditionalStyleBoundType) - -- **Percent** -- **Value** - -### [GridConditionalStylePropertyStylingType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridConditionalStylePropertyStylingType) - -- **DirectSet** -- **ScaledValue** -- **ValueColorGradient** -- **ValueSelector** - -### [GridEasingFunctionType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridEasingFunctionType) - -- **CircleInOut** -- **CubicInOut** -- **ExponentialInOut** -- **Linear** - -### [GridHorizontalAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridHorizontalAlignment) - -- **Center** -- **Left** -- **Right** - -### [GridKeydownTargetType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridKeydownTargetType) - -- **DataCell** -- **GroupRow** -- **HeaderCell** -- **HierarchicalRow** -- **MasterDetailRow** -- **SummaryCell** - -### [GridMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridMode) - -- **BeforeSeries** -- **BehindSeries** -- **None** - -### [GridPagingMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridPagingMode) - -- **Local** -- **Remote** - -### [GridSelectionBehavior](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridSelectionBehavior) - -- **ModifierBased** -- **Toggle** - -### [GridSelectionMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridSelectionMode) - -- **Multiple** -- **MultipleCascade** -- **None** -- **Single** - -### [GridSummaryCalculationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridSummaryCalculationMode) - -- **ChildLevelsOnly** -- **RootAndChildLevels** -- **RootLevelOnly** - -### [GridSummaryPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridSummaryPosition) - -- **Bottom** -- **Top** - -### [GridToolbarExporterType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridToolbarExporterType) - -- **Csv** -- **Excel** -- **Pdf** - -### [GridValidationTrigger](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridValidationTrigger) - -- **Blur** -- **Change** - -### [GridVerticalAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GridVerticalAlignment) - -- **Bottom** -- **Middle** -- **Top** - -### [GroupHeaderDisplayMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GroupHeaderDisplayMode) - -- **Combined** -- **Split** - -### [GroupSummaryDisplayMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GroupSummaryDisplayMode) - -- **Cells** -- **List** -- **None** -- **RowBottom** -- **RowTop** - -### [GroupingDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/GroupingDirection) - -- **Asc** -- **Desc** -- **None** - -### [HeaderClickAction](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/HeaderClickAction) - -- **None** -- **SortByMultipleColumns** -- **SortByMultipleColumnsTriState** -- **SortByOneColumnOnly** -- **SortByOneColumnOnlyTriState** - -### [HighlightedValueDisplayMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/HighlightedValueDisplayMode) - -- **Auto** -- **Hidden** -- **Overlay** - -### [HighlightedValueLabelMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/HighlightedValueLabelMode) - -- **Auto** -- **LabelBoth** -- **PreferHighlighted** -- **PreferOriginal** - -### [HighlightingState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/HighlightingState) - -- **Inward** -- **Outward** -- **Static** - -### [HorizontalAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/HorizontalAlignment) - -- **Center** -- **Left** -- **Right** -- **Stretch** - -### [HorizontalTransitionAnimation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/HorizontalTransitionAnimation) - -- **Fade** -- **None** -- **Slide** - -### [IconButtonVariant](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/IconButtonVariant) - -- **Contained** -- **Flat** -- **Outlined** - -### [ImageLoadStatus](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ImageLoadStatus) - -- **Canceled** -- **Completed** -- **Failed** -- **Loading** -- **Unknown** - -### [ImageResourceType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ImageResourceType) - -- **EmbeddedResource** -- **LocalAsset** -- **LocalResource** -- **RemoteResource** -- **Unspecified** - -### [ImageStretchOptions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ImageStretchOptions) - -- **Fill** -- **None** -- **Uniform** - -### [IndicatorDisplayType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/IndicatorDisplayType) - -- **Area** -- **Column** -- **Line** - -### [InputGroupDisplayType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/InputGroupDisplayType) - -- **Border** -- **Box** -- **Line** -- **Search** - -### [InputType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/InputType) - -- **Email** -- **Number** -- **Password** -- **Search** -- **Tel** -- **Text** -- **Url** - -### [InteractionState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/InteractionState) - -- **Auto** -- **DragPan** -- **DragSelect** -- **DragZoom** -- **None** - -### [InterpolationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/InterpolationMode) - -- **HSV** -- **RGB** - -### [Key](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/Key) - -- **A** -- **Add** -- **Alt** -- **B** -- **Back** -- **C** -- **CapsLock** -- **Ctrl** -- **D** -- **D0** -- **D1** -- **D2** -- **D3** -- **D4** -- **D5** -- **D6** -- **D7** -- **D8** -- **D9** -- **Decimal** -- **Del** -- **Divide** -- **Down** -- **E** -- **End** -- **Enter** -- **Escape** -- **F** -- **F1** -- **F10** -- **F11** -- **F12** -- **F2** -- **F3** -- **F4** -- **F5** -- **F6** -- **F7** -- **F8** -- **F9** -- **G** -- **H** -- **Home** -- **I** -- **Insert** -- **J** -- **K** -- **L** -- **Left** -- **M** -- **Multiply** -- **N** -- **None** -- **NumPad0** -- **NumPad1** -- **NumPad2** -- **NumPad3** -- **NumPad4** -- **NumPad5** -- **NumPad6** -- **NumPad7** -- **NumPad8** -- **NumPad9** -- **O** -- **OemMinus** -- **OemPipe** -- **OemPlus** -- **OemQuestion** -- **OemSemicolon** -- **OemTilde** -- **P** -- **PageDown** -- **PageUp** -- **Q** -- **R** -- **Right** -- **S** -- **Shift** -- **Space** -- **Subtract** -- **T** -- **Tab** -- **U** -- **Unknown** -- **Up** -- **V** -- **W** -- **X** -- **Y** -- **Z** - -### [KeyBindingTrigger](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/KeyBindingTrigger) - -- **Keydown** -- **KeydownRepeat** -- **Keyup** - -### [LabelsPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/LabelsPosition) - -- **BestFit** -- **Center** -- **InsideEnd** -- **None** -- **OutsideEnd** - -### [LayoutAction](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/LayoutAction) - -- **Filtered** -- **Grouped** -- **Hidden** -- **Moved** -- **Pinned** -- **Resized** -- **Sorted** -- **Summed** - -### [LeaderLineType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/LeaderLineType) - -- **Arc** -- **Spline** -- **Straight** - -### [LegendEmptyValuesMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/LegendEmptyValuesMode) - -- **AlwaysHidden** -- **AlwaysVisible** -- **ShowWhenNoOthersCategory** - -### [LegendHighlightingMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/LegendHighlightingMode) - -- **Auto** -- **MatchSeries** -- **None** - -### [LegendItemBadgeMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/LegendItemBadgeMode) - -- **MatchSeries** -- **Simplified** - -### [LegendItemBadgeShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/LegendItemBadgeShape) - -- **Automatic** -- **Bar** -- **Circle** -- **Column** -- **Hidden** -- **Line** -- **Marker** -- **Square** - -### [LegendOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/LegendOrientation) - -- **Horizontal** -- **Vertical** - -### [LinearGraphNeedleShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/LinearGraphNeedleShape) - -- **Custom** -- **Needle** -- **Rectangle** -- **Trapezoid** -- **Triangle** - -### [LinearProgressLabelAlign](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/LinearProgressLabelAlign) - -- **Bottom** -- **BottomEnd** -- **BottomStart** -- **Top** -- **TopEnd** -- **TopStart** - -### [LinearScaleOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/LinearScaleOrientation) - -- **Horizontal** -- **Vertical** - -### [ListPanelActivationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ListPanelActivationMode) - -- **Cell** -- **None** - -### [ListPanelOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ListPanelOrientation) - -- **Horizontal** -- **HorizontalWrapped** -- **Vertical** - -### [ListPanelSelectionBehavior](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ListPanelSelectionBehavior) - -- **ModifierBased** -- **Toggle** - -### [ListPanelSelectionMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ListPanelSelectionMode) - -- **MultipleRow** -- **None** -- **SingleRow** - -### [ListSortDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ListSortDirection) - -- **Ascending** -- **Descending** - -### [MapBackgroundTilingMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/MapBackgroundTilingMode) - -- **Auto** -- **NonWrapped** -- **Wrapped** - -### [MapResizeBehavior](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/MapResizeBehavior) - -- **Auto** -- **MaintainCenterPosition** -- **MaintainTopLeftPosition** - -### [MarkerAutomaticBehavior](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/MarkerAutomaticBehavior) - -- **Circle** -- **CircleSmart** -- **Diamond** -- **Hexagon** -- **Hexagram** -- **Indexed** -- **None** -- **Pentagon** -- **Pentagram** -- **Pyramid** -- **SmartIndexed** -- **Square** -- **Tetragram** -- **Triangle** - -### [MarkerFillMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/MarkerFillMode) - -- **Auto** -- **MatchMarkerOutline** -- **Normal** - -### [MarkerOutlineMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/MarkerOutlineMode) - -- **Auto** -- **MatchMarkerBrush** -- **Normal** - -### [MarkerType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/MarkerType) - -- **Automatic** -- **Circle** -- **Diamond** -- **Hexagon** -- **Hexagram** -- **Hidden** -- **None** -- **Pentagon** -- **Pentagram** -- **Pyramid** -- **Square** -- **Tetragram** -- **Triangle** -- **Unset** - -### [MaskInputValueMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/MaskInputValueMode) - -- **Raw** -- **WithFormatting** - -### [MergedCellEvaluationCriteria](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/MergedCellEvaluationCriteria) - -- **Default** -- **FormattedText** -- **RawValue** - -### [MergedCellMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/MergedCellMode) - -- **Always** -- **Default** -- **Never** -- **OnlyWhenSorted** - -### [ModifierKeys](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ModifierKeys) - -- **Alt** -- **Apple** -- **Control** -- **None** -- **Shift** -- **Windows** - -### [MouseButton](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/MouseButton) - -- **Left** -- **Middle** -- **Right** -- **Unkown** - -### [MultiColumnComboBoxSelectedItemChangeType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/MultiColumnComboBoxSelectedItemChangeType) - -- **Row** -- **Text** -- **Value** - -### [MultiSliderOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/MultiSliderOrientation) - -- **Horizontal** -- **TwoDimensional** -- **Vertical** - -### [MultiSliderThumbRangePosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/MultiSliderThumbRangePosition) - -- **PinnedHigher** -- **PinnedLower** - -### [NavDrawerPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/NavDrawerPosition) - -- **Bottom** -- **End** -- **Relative** -- **Start** -- **Top** - -### [NestedActionMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/NestedActionMode) - -- **Replace** - -### [NumericScaleMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/NumericScaleMode) - -- **Linear** -- **Logarithmic** - -### [OthersCategoryType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/OthersCategoryType) - -- **Number** -- **Percent** - -### [OuterLabelAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/OuterLabelAlignment) - -- **Left** -- **Right** - -### [OverlayTextLocation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/OverlayTextLocation) - -- **Auto** -- **Hidden** -- **InsideBottomCenter** -- **InsideBottomLeft** -- **InsideBottomRight** -- **InsideMiddleCenter** -- **InsideMiddleLeft** -- **InsideMiddleRight** -- **InsideTopCenter** -- **InsideTopLeft** -- **InsideTopRight** -- **OutsideBottomCenter** -- **OutsideBottomLeft** -- **OutsideBottomRight** -- **OutsideMiddleLeft** -- **OutsideMiddleRight** -- **OutsideTopCenter** -- **OutsideTopLeft** -- **OutsideTopRight** - -### [PaneActionBehavior](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PaneActionBehavior) - -- **AllPanes** -- **SelectedPane** - -### [PaneDragActionType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PaneDragActionType) - -- **DockPane** -- **FloatPane** -- **MoveFloatingPane** -- **MoveTab** - -### [PenLineCap](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PenLineCap) - -- **Flat** -- **Round** -- **Square** -- **Triangle** - -### [PenLineJoin](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PenLineJoin) - -- **Bevel** -- **Miter** -- **Round** - -### [PickerMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PickerMode) - -- **Dialog** -- **Dropdown** - -### [PieChartSweepDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PieChartSweepDirection) - -- **Auto** -- **Clockwise** -- **Counterclockwise** - -### [PinnedPositions](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PinnedPositions) - -- **Left** -- **None** -- **Right** - -### [PivotAggregationType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PivotAggregationType) - -- **AVG** -- **COUNT** -- **EARLIEST** -- **LATEST** -- **MAX** -- **MIN** -- **SUM** - -### [PivotDimensionType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PivotDimensionType) - -- **Column** -- **Filter** -- **Row** - -### [PivotRowLayoutType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PivotRowLayoutType) - -- **Horizontal** -- **Vertical** - -### [PivotSummaryPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PivotSummaryPosition) - -- **Bottom** -- **Top** - -### [PopoverPlacement](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PopoverPlacement) - -- **Bottom** -- **BottomEnd** -- **BottomStart** -- **Left** -- **LeftEnd** -- **LeftStart** -- **Right** -- **RightEnd** -- **RightStart** -- **Top** -- **TopEnd** -- **TopStart** - -### [PopoverScrollStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PopoverScrollStrategy) - -- **Block** -- **Close** -- **Scroll** - -### [PopupAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PopupAlignment) - -- **Auto** -- **Far** -- **Middle** -- **Near** - -### [PopupAnimationType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PopupAnimationType) - -- **FadeInOutSlide** -- **GrowShrink** - -### [PopupDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PopupDirection) - -- **Auto** -- **Down** -- **Left** -- **Right** -- **Up** - -### [PopupPointerPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PopupPointerPosition) - -- **Auto** -- **Bottom** -- **Left** -- **Right** -- **Top** - -### [PriceDisplayType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PriceDisplayType) - -- **Candlestick** -- **OHLC** - -### [PropertyEditorPanelUpdateMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PropertyEditorPanelUpdateMode) - -- **Auto** -- **ComponentRendererOverlay** -- **DataSeriesToDescriptionCustomizations** - -### [PropertyEditorValueType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/PropertyEditorValueType) - -- **Array** -- **Boolean1** -- **Brush** -- **BrushCollection** -- **Button** -- **Collection** -- **Color** -- **ColorCollection** -- **DataRef** -- **Date** -- **DoubleCollection** -- **EnumValue** -- **EventRef** -- **Header** -- **MethodRef** -- **Number** -- **Point** -- **Rect** -- **Separator** -- **Size** -- **Slider** -- **StringValue** -- **SubType** -- **TemplateRef** -- **TimeSpan** -- **Unhandled** - -### [RadialGaugeBackingShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/RadialGaugeBackingShape) - -- **Circular** -- **Fitted** - -### [RadialGaugeDuplicateLabelOmissionStrategy](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/RadialGaugeDuplicateLabelOmissionStrategy) - -- **OmitBoth** -- **OmitFirst** -- **OmitLast** -- **OmitNeither** - -### [RadialGaugeNeedleShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/RadialGaugeNeedleShape) - -- **Needle** -- **NeedleWithBulb** -- **None** -- **Rectangle** -- **RectangleWithBulb** -- **Trapezoid** -- **TrapezoidWithBulb** -- **Triangle** -- **TriangleWithBulb** - -### [RadialGaugePivotShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/RadialGaugePivotShape) - -- **Circle** -- **CircleOverlay** -- **CircleOverlayWithHole** -- **CircleUnderlay** -- **CircleUnderlayWithHole** -- **CircleWithHole** -- **None** - -### [RadialGaugeScaleOversweepShape](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/RadialGaugeScaleOversweepShape) - -- **Auto** -- **Circular** -- **Fitted** - -### [RadialLabelMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/RadialLabelMode) - -- **Auto** -- **Label** -- **LabelAndPercentage** -- **LabelAndValue** -- **LabelAndValueAndPercentage** -- **Normal** -- **Percentage** -- **Value** -- **ValueAndPercentage** - -### [RangeTextSelectMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/RangeTextSelectMode) - -- **End** -- **Preserve** -- **Select** -- **Start** - -### [ResizerLocation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ResizerLocation) - -- **Bottom** -- **BottomLeft** -- **BottomRight** -- **Left** -- **Right** -- **Top** -- **TopLeft** -- **TopRight** - -### [RoundTripDateConversion](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/RoundTripDateConversion) -Enum defining different round trip date conversions. - -- **Auto** — The component will decide how to convert round tripped dates. -- **Local** — The component will convert round tripped dates to local time. -- **UTC** — The component will convert round tripped dates to UTC. - -### [RowHoverAnimationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/RowHoverAnimationMode) - -- **Auto** -- **ColorBlend** -- **None** - -### [RowPinningPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/RowPinningPosition) - -- **Bottom** -- **Top** - -### [RowSelectionAnimationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/RowSelectionAnimationMode) - -- **Auto** -- **ColorBlend** -- **None** - -### [ScatterItemSearchMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ScatterItemSearchMode) - -- **Auto** -- **ClosestPoint** -- **ClosestPointOnClosestLine** -- **ClosestVisiblePoint** -- **ClosestVisiblePointOnClosestLine** -- **None** -- **TopVisiblePoint** - -### [ScrollbarStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ScrollbarStyle) - -- **Default** -- **Fading** -- **Hidden** -- **Thin** - -### [SelectionRangeDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SelectionRangeDirection) - -- **Backward** -- **Forward** -- **None** - -### [SeriesHighlightedValuesDisplayMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SeriesHighlightedValuesDisplayMode) - -- **Auto** -- **Hidden** -- **Overlay** - -### [SeriesHighlightingBehavior](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SeriesHighlightingBehavior) - -- **Auto** -- **DirectlyOver** -- **NearestItems** -- **NearestItemsAndSeries** -- **NearestItemsRetainMainShapes** - -### [SeriesHighlightingMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SeriesHighlightingMode) - -- **Auto** -- **Brighten** -- **BrightenSpecific** -- **FadeOthers** -- **FadeOthersSpecific** -- **None** - -### [SeriesHitTestMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SeriesHitTestMode) - -- **Auto** -- **ColorEncoded** -- **Computational** - -### [SeriesOutlineMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SeriesOutlineMode) - -- **Auto** -- **Collapsed** -- **Visible** - -### [SeriesPlotAreaMarginHorizontalMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SeriesPlotAreaMarginHorizontalMode) - -- **Auto** -- **LeftBufferRightBuffer** -- **LeftBufferRightMargin** -- **LeftMarginRightBuffer** -- **LeftMarginRightMargin** -- **None** - -### [SeriesPlotAreaMarginVerticalMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SeriesPlotAreaMarginVerticalMode) - -- **Auto** -- **BottomBufferTopBuffer** -- **BottomBufferTopMargin** -- **BottomMarginTopBuffer** -- **BottomMarginTopMargin** -- **None** - -### [SeriesSelectionBehavior](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SeriesSelectionBehavior) - -- **Auto** -- **PerDataItemMultiSelect** -- **PerDataItemSingleSelect** -- **PerSeriesAndDataItemGlobalSingleSelect** -- **PerSeriesAndDataItemMultiSelect** -- **PerSeriesAndDataItemSingleSelect** -- **PerSeriesMultiSelect** -- **PerSeriesSingleSelect** - -### [SeriesSelectionMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SeriesSelectionMode) - -- **Auto** -- **Brighten** -- **FadeOthers** -- **FocusColorFill** -- **FocusColorOutline** -- **FocusColorThickOutline** -- **GrayscaleOthers** -- **None** -- **SelectionColorFill** -- **SelectionColorOutline** -- **SelectionColorThickOutline** -- **ThickOutline** - -### [SeriesViewerHorizontalScrollbarPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SeriesViewerHorizontalScrollbarPosition) - -- **Auto** -- **InsideBottom** -- **InsideTop** - -### [SeriesViewerScrollbarMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SeriesViewerScrollbarMode) - -- **FadeToLine** -- **Fading** -- **None** -- **Persistent** - -### [SeriesViewerVerticalScrollbarPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SeriesViewerVerticalScrollbarPosition) - -- **Auto** -- **InsideLeft** -- **InsideRight** - -### [SeriesVisibleRangeMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SeriesVisibleRangeMode) - -- **Auto** -- **IncludeReferenceValue** -- **ValuesOnly** - -### [ShapeItemSearchMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ShapeItemSearchMode) - -- **Auto** -- **ClosestBoundingBox** -- **ClosestPointOnClosestShape** -- **ClosestShape** -- **None** - -### [SliceSelectionMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SliceSelectionMode) - -- **Manual** -- **Multiple** -- **Single** - -### [SliderTickLabelRotation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SliderTickLabelRotation) - -- **NegativeNinety** -- **Ninety** -- **Zero** - -### [SliderTickOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SliderTickOrientation) - -- **End** -- **Mirror** -- **Start** - -### [SortIndicatorStyle](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SortIndicatorStyle) - -- **Default** -- **FadingSimpleUpDownArrows** -- **FadingUpDownArrows** -- **None** -- **Unset** - -### [SortMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SortMode) - -- **None** -- **SortByMultipleColumns** -- **SortByMultipleColumnsTriState** -- **SortByOneColumnOnly** -- **SortByOneColumnOnlyTriState** - -### [SortingDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SortingDirection) - -- **Asc** -- **Desc** -- **None** - -### [SortingOptionsMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SortingOptionsMode) - -- **Multiple** -- **Single** - -### [SparklineDisplayType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SparklineDisplayType) - -- **Area** -- **Column** -- **Line** -- **WinLoss** - -### [SplineType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SplineType) - -- **Clamped** -- **Natural** - -### [SplitPaneOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SplitPaneOrientation) - -- **Horizontal** -- **Vertical** - -### [StepperOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/StepperOrientation) - -- **Horizontal** -- **Vertical** - -### [StepperStepType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/StepperStepType) - -- **Full** -- **Indicator** -- **Title** - -### [StepperTitlePosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/StepperTitlePosition) - -- **Auto** -- **Bottom** -- **End** -- **Start** -- **Top** - -### [StepperVerticalAnimation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/StepperVerticalAnimation) - -- **Fade** -- **Grow** -- **None** - -### [StyleVariant](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/StyleVariant) - -- **Danger** -- **Info** -- **Primary** -- **Success** -- **Warning** - -### [SummaryScope](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SummaryScope) - -- **Both** -- **Groups** -- **None** -- **Root** - -### [SweepDirection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/SweepDirection) - -- **Clockwise** -- **Counterclockwise** - -### [TabsActivation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TabsActivation) - -- **Auto** -- **Manual** - -### [TabsAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TabsAlignment) - -- **Center** -- **End** -- **Justify** -- **Start** - -### [TextCellDecoration](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TextCellDecoration) - -- **None** -- **Overline** -- **Strikethrough** -- **Underline** - -### [TextCellLineBreakMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TextCellLineBreakMode) - -- **CharacterWrap** -- **Ellipsis** -- **NoWrap** -- **WordWrap** - -### [TextIconSetBuiltInTypes](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TextIconSetBuiltInTypes) - -- **CheckOrDashOrX** -- **ThreeArrows** -- **ThreeBoxes** -- **ThreeFaces** - -### [TextareaResize](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TextareaResize) - -- **Auto** -- **None** -- **Vertical** - -### [TextareaWrap](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TextareaWrap) - -- **Hard** -- **Off** -- **Soft** - -### [Theme](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/Theme) - -- **Bootstrap** -- **Fluent** -- **Indigo** -- **Material** - -### [ThemeVariant](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ThemeVariant) - -- **Dark** -- **Light** - -### [TileManagerDragMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TileManagerDragMode) - -- **None** -- **Tile** -- **TileHeader** - -### [TileManagerResizeMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TileManagerResizeMode) - -- **Always** -- **Hover** -- **None** - -### [TimeAxisDisplayType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TimeAxisDisplayType) - -- **Continuous** -- **Discrete** - -### [TimeAxisIntervalType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TimeAxisIntervalType) - -- **Days** -- **Hours** -- **Milliseconds** -- **Minutes** -- **Months** -- **Seconds** -- **Ticks** -- **Weeks** -- **Years** - -### [TimeAxisLabellingMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TimeAxisLabellingMode) - -- **Auto** -- **Compressed** -- **Normal** - -### [TitlesPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TitlesPosition) - -- **ScaleEnd** -- **ScaleStart** - -### [ToggleLabelPosition](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToggleLabelPosition) - -- **After** -- **Before** - -### [ToolActionButtonDisplayType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolActionButtonDisplayType) - -- **Flat** -- **Outlined** -- **Raised** - -### [ToolActionButtonGroupDisplayType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolActionButtonGroupDisplayType) - -- **Flat** -- **Outlined** - -### [ToolActionButtonInfoDisplayType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolActionButtonInfoDisplayType) - -- **Flat** -- **Outlined** -- **Raised** - -### [ToolActionCheckboxListIndexType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolActionCheckboxListIndexType) - -- **DeSelected** -- **Selected** - -### [ToolActionFieldSelectorEventType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolActionFieldSelectorEventType) - -- **AggregationChange** -- **Change** - -### [ToolActionFieldSelectorInfoType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolActionFieldSelectorInfoType) - -- **Label** -- **Value** - -### [ToolActionFieldSelectorType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolActionFieldSelectorType) - -- **Label** -- **Value** - -### [ToolActionInfoDensity](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolActionInfoDensity) - -- **Auto** -- **Comfortable** -- **Compact** -- **Cosy** -- **Minimal** - -### [ToolActionType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolActionType) - -- **Button** -- **ButtonPair** -- **Checkbox** -- **CheckboxList** -- **ColorEditor** -- **Combo** -- **FieldSelector** -- **GroupHeader** -- **IconButton** -- **IconMenu** -- **Label** -- **NumberInput** -- **Radio** -- **Separator** -- **SubPanel** -- **TextInput** -- **Unknown** - -### [ToolCommandExecutionState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolCommandExecutionState) - -- **Completed** -- **Failed** -- **Pending** - -### [ToolCommandStateType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolCommandStateType) - -- **IsDisabledChanged** -- **ValueChanged** -- **VisibilityChanged** - -### [ToolContextBindingMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolContextBindingMode) - -- **OneWay** -- **TwoWay** - -### [ToolContextValueType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolContextValueType) - -- **BoolValue** -- **Brush** -- **BrushCollection** -- **Color** -- **Data** -- **DoubleValue** -- **IntValue** -- **StringValue** - -### [ToolPanelOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolPanelOrientation) - -- **Horizontal** -- **HorizontalWrapped** -- **Vertical** - -### [ToolTipType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolTipType) - -- **Category** -- **Data** -- **Default** -- **Item** -- **None** - -### [ToolbarOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ToolbarOrientation) - -- **Horizontal** -- **HorizontalWrapped** -- **Vertical** - -### [TransactionEvent](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TransactionEvent) - -- **Add** -- **Clear** -- **Commit** -- **End** -- **Redo** -- **Undo** - -### [TransactionPendingState](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TransactionPendingState) - -- **Accept** -- **Pending** -- **Reject** - -### [TransactionType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TransactionType) - -- **Add** -- **Delete** -- **Update** - -### [TransitionInSpeedType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TransitionInSpeedType) - -- **Auto** -- **IndexScaled** -- **Normal** -- **Random** -- **ValueScaled** - -### [TransitionOutSpeedType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TransitionOutSpeedType) - -- **Auto** -- **IndexScaled** -- **Normal** -- **Random** -- **ValueScaled** - -### [TreeSelection](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TreeSelection) - -- **Cascade** -- **Multiple** -- **None** - -### [TreemapFillScaleMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TreemapFillScaleMode) - -- **GlobalSum** -- **GlobalValue** -- **Sum** -- **Value** - -### [TreemapHeaderDisplayMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TreemapHeaderDisplayMode) - -- **Auto** -- **Header** -- **Overlay** - -### [TreemapHighlightedValueDisplayMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TreemapHighlightedValueDisplayMode) - -- **Auto** -- **Hidden** -- **Overlay** - -### [TreemapHighlightingMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TreemapHighlightingMode) - -- **Auto** -- **Brighten** -- **FadeOthers** -- **None** - -### [TreemapLabelHorizontalFitMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TreemapLabelHorizontalFitMode) - -- **Auto** -- **Ellipsis** -- **Hide** - -### [TreemapLabelVerticalFitMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TreemapLabelVerticalFitMode) - -- **Auto** -- **Hide** -- **Show** - -### [TreemapLayoutType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TreemapLayoutType) - -- **SliceAndDice** -- **Squarified** -- **Stripped** - -### [TreemapNodeStyleMappingTargetType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TreemapNodeStyleMappingTargetType) - -- **All** -- **Child** -- **Parent** - -### [TreemapOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TreemapOrientation) - -- **Horizontal** -- **Vertical** - -### [TreemapValueMappingMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TreemapValueMappingMode) - -- **CustomValue** -- **Sum** -- **Value** - -### [TrendLineType](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/TrendLineType) - -- **CubicFit** -- **CumulativeAverage** -- **ExponentialAverage** -- **ExponentialFit** -- **LinearFit** -- **LogarithmicFit** -- **ModifiedAverage** -- **None** -- **PowerLawFit** -- **QuadraticFit** -- **QuarticFit** -- **QuinticFit** -- **SimpleAverage** -- **WeightedAverage** - -### [UnknownValuePlotting](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/UnknownValuePlotting) - -- **DontPlot** -- **LinearInterpolate** - -### [UnpinnedLocation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/UnpinnedLocation) - -- **Bottom** -- **Left** -- **Right** -- **Top** - -### [UserAnnotationTarget](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/UserAnnotationTarget) - -- **Axis** -- **Point** -- **Slice** -- **Strip** - -### [ValidationStatus](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ValidationStatus) - -- **INVALID** -- **VALID** - -### [ValueAxisLabelLocation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ValueAxisLabelLocation) - -- **Auto** -- **InsideLeft** -- **InsideRight** -- **OutsideLeft** -- **OutsideRight** - -### [ValueLayerValueMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ValueLayerValueMode) - -- **Auto** -- **Average** -- **GlobalAverage** -- **GlobalMaximum** -- **GlobalMinimum** -- **Maximum** -- **Minimum** - -### [VerticalAlignment](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/VerticalAlignment) - -- **Bottom** -- **Center** -- **Stretch** -- **Top** - -### [ViewerSurfaceUsage](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ViewerSurfaceUsage) - -- **Minimal** -- **Normal** - -### [Visibility](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/Visibility) - -- **Collapsed** -- **Visible** - -### [WeekDays](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/WeekDays) - -- **Friday** -- **Monday** -- **Saturday** -- **Sunday** -- **Thursday** -- **Tuesday** -- **Wednesday** - -### [WindowResponse](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/WindowResponse) - -- **Deferred** -- **Immediate** - -### [XAxisLabelLocation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/XAxisLabelLocation) - -- **Auto** -- **InsideBottom** -- **InsideTop** -- **OutsideBottom** -- **OutsideTop** - -### [YAxisLabelLocation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/YAxisLabelLocation) - -- **Auto** -- **InsideLeft** -- **InsideRight** -- **OutsideLeft** -- **OutsideRight** - -### [ZoomCoercionMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ZoomCoercionMode) - -- **Auto** -- **AxisConstrained** -- **Unconstrained** - -### [ZoomSliderOrientation](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/ZoomSliderOrientation) - -- **Horizontal** -- **Vertical** - -### [InterpolationMode](https://www.infragistics.com/api/blazor/IgniteUI.Blazor/25.1.x/enums/InterpolationMode) -Describes available modes for color interpolation. - -- **HSV** — Interpolation in HSV space. -- **RGB** — Interpolation in RGB space. diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/react-api/igniteui-react-dockmanager/19.5.1/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/react-api/igniteui-react-dockmanager/19.5.1/llms-full.txt deleted file mode 100644 index 44b623ddd..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/react-api/igniteui-react-dockmanager/19.5.1/llms-full.txt +++ /dev/null @@ -1,454 +0,0 @@ -# Ignite UI Dock Manager for React v19.5.1 — Full API Reference - -> Complete API reference for the Ignite UI Dock Manager for React package (19.5.1). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: React -Package: igniteui-react-dockmanager -Version: 19.5.1 - -## Classes - -### [IgrDockManager](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/classes/IgrDockManager) -A powerful, flexible dock manager component for laying out, docking, -undocking, pinning, and floating panes of content. - -- **activePane**: `IgcContentPane` — Determines the active content pane. -- **allowFloatingPanesResize**: `boolean` — Whether floating panes can be resized. -- **allowInnerDock**: `boolean` — Whether docking inside a pane is allowed. -- **allowMaximize**: `boolean` — Whether maximize action button is displayed for the panes. -- **allowRootDock**: `boolean` — Determines whether docking into the root-level pane is allowed. - -When set to true (default), panes can be docked directly into the root container. -This is done by creating a new root pane and repositioning the existing root pane as a sibling to the newly docked content pane. -- **allowSplitterDock**: `boolean` — Whether docking over splitter is allowed -- **autoScrollConfig**: `any` — Configuration for edge auto-scrolling behavior during drag & resize operations. - -- edgeThreshold: Distance in pixels from the container's edge that triggers scrolling. -- scrollSpeed: Number of pixels to scroll per interval (affects scroll rate). -- **closeBehavior**: `IgcPaneActionBehavior` — Which panes get affected by close operations. -- **containedInBoundaries**: `boolean` — Whether pane dragging stops when any of the pane's sides goes outside the DockManager’s bounds. -- **contextMenuPosition**: `IgcContextMenuPosition` — Position to open the context menu. -- **disableKeyboardNavigation**: `boolean` — Disables all keyboard navigation within the dock manager. -- **documentOnlyDrag**: `boolean` -- **draggedPane**: `IgcContentPane | IgcSplitPane | IgcTabGroupPane` — Determines the pane that is currently dragged. -- **draggedPaneElement**: `HTMLElement` -- **dropPosition**: `IgcDockManagerPoint` — The drop position (pane) when docking. -- **enableDragCursor**: `boolean` — Enables changing the mouse cursor when hovering over a tab or pane header. - -When set to true, the cursor changes from the default to pointer, -indicating that the header can be dragged (e.g., to dock or float the pane). -- **isValidDrop**: `boolean` — Whether the last drop/drag target was valid. -- **layout**: `IgcDockManagerLayout` — The layout configuration of the Dock Manager. -- **maximizedPane**: `IgcContentPane | IgcSplitPane | IgcTabGroupPane` — Determines the pane that is currently maximized. -- **navigationPaneMeta**: `IgcPaneNavigatorMetadata` — Metadata for the pane-navigator overlay. -- **proximityDock**: `boolean` — Determines whether docking indicators are displayed while docking -- **resourceStrings**: `IgcDockManagerResourceStrings` — The resource strings of the dock manager. -- **showHeaderIconOnHover**: `"all" | "none" | "closeOnly" | "moreOptionsOnly"` — Which header icons are shown on hover. -- **showPaneHeaders**: `"always" | "onHoverOnly"` — Determines when to display the pane headers - always or on hover of the pane. -- **unpinBehavior**: `IgcPaneActionBehavior` — Determines which panes are affected by particular pane action such as closing or unpinning. -- **useFixedSizeOnDock**: `"both" | "none" | "vertical" | "horizontal"` — Specifies which docking orientations should apply the FixedSize sizing mode -when panes are dynamically created via docking. - -Possible values: -- "none": Do not apply FixedSize on docking (default behavior). -- "vertical": Apply FixedSize only when panes are docked vertically. -- "horizontal": Apply FixedSize only when panes are docked horizontally. -- "both": Apply FixedSize for both vertical and horizontal orientation. - -This setting affects only dynamically created panes via user docking actions. -It does not apply to programmatically created panes or layout restorations. -- **direction**: `any` — Gets the direction of the Dock Manager. -- **connectedCallback**(): void — Invoked when the component is added to the document's DOM. - -In connectedCallback() you should setup tasks that should only occur when -the element is connected to the document. The most common of these is -adding event listeners to nodes external to the element, like a keydown -event handler added to the window. - -connectedCallback() { - super.connectedCallback(); - addEventListener('keydown', this._handleKeydown); -} - - -Typically, anything done in connectedCallback() should be undone when the -element is disconnected, in disconnectedCallback(). -- **disconnectedCallback**(): void — Invoked when the component is removed from the document's DOM. - -This callback is the main signal to the element that it may no longer be -used. disconnectedCallback() should ensure that nothing is holding a -reference to the element (such as event listeners added to nodes external -to the element), so that it is free to be garbage collected. - -disconnectedCallback() { - super.disconnectedCallback(); - window.removeEventListener('keydown', this._handleKeydown); -} - - -An element may be re-connected after being disconnected. -- **dropPane**(): Promise -- **dropPositionChanged**(): void -- **firstUpdated**(): void — Invoked when the element is first updated. Implement to perform one time -work on the element after update. - -firstUpdated() { - this.renderRoot.getElementById('my-text-area').focus(); -} - - -Setting properties inside this method will trigger the element to update -again after this update cycle completes. -- **floatingPaneResizeEnd**(args: IgcFloatingPaneResizeEventArgs): CustomEvent -- **floatingPaneResizeMove**(eventArgs: IgcFloatingPaneResizeMoveEventArgs): CustomEvent -- **floatingPaneResizeStart**(args: IgcFloatingPaneResizeEventArgs): CustomEvent -- **focusElement**(): void -- **focusPane**(contentId: string): Promise -- **getDockedPanesContainerRect**(): DOMRect -- **layoutChange**(): CustomEvent -- **paneClose**(args: IgcPaneCloseEventArgs): CustomEvent -- **paneDragEnd**(args: IgcPaneDragEndEventArgs): CustomEvent -- **paneDragOver**(args: IgcPaneDragOverEventArgs): CustomEvent -- **paneDragStart**(args: IgcPaneDragStartEventArgs): CustomEvent -- **panePinnedToggle**(args: IgcPanePinnedEventArgs): CustomEvent -- **paneScroll**(args: IgcPaneScrollEventArgs): CustomEvent -- **removePane**(pane: IgcDockManagerPane): Promise -- **scrollPaneIntoView**(pane: IgcDockManagerPane): void -- **updated**(): void — Invoked whenever the element is updated. Implement to perform -post-updating tasks via DOM APIs, for example, focusing an element. - -Setting properties inside this method will trigger the element to update -again after this update cycle completes. -- **willUpdate**(): void — Invoked before update() to compute values needed during the update. - -Implement willUpdate to compute property values that depend on other -properties and are used in the rest of the update process. - -willUpdate(changedProperties) { - // only need to check changed properties for an expensive computation. - if (changedProperties.has('firstName') || changedProperties.has('lastName')) { - this.sha = computeSHA(${this.firstName} ${this.lastName}); - } -} - -render() { - return htmlSHA: ${this.sha}; -} - -## Interfaces - -### [CustomEvent](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/CustomEvent) -[MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent) - -- **detail**: `T` — Returns any custom data event was created with. Typically used for synthetic events. - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent/detail) - -### [IgrActivePaneEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrActivePaneEventArgsDetail) - -- **newPane**: `IgcContentPane` — Gets the new active pane. -- **oldPane**: `IgcContentPane` — Gets the old active pane. - -### [IgrContentPane](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrContentPane) - -- **acceptsInnerDock?**: `boolean` — Determines whether the end user can inner dock another pane in this one. Defaults to true. -- **allowClose?**: `boolean` — Determines whether the end user is allowed to close the pane. Defaults to true. -- **allowDocking?**: `boolean` — Determines whether the end user is allowed to dock the pane. Defaults to true. -- **allowFloating?**: `boolean` — Determines whether the end user is allowed to make the pane floating. Defaults to true. -- **allowMaximize?**: `boolean` — Determines whether the end user is allowed to maximize the pane. -- **allowPinning?**: `boolean` — Determines whether the end user is allowed to pin/unpin the pane. Defaults to true. -- **contentId**: `string` — The slot attribute's value of the content element. -- **disabled?**: `boolean` — Determines whether a pane is disabled. Defaults to false. -- **documentOnly?**: `boolean` — Marks that a content pane can be docked only inside a document host. -- **floatingHeaderId?**: `string` — The slot attribute's value of the floating header element. If not set, the headerId property value is used. -- **header**: `string` — The text header of the content pane. Even if header slot templates are used, the text header is used for aria label. -- **headerId?**: `string` — The slot attribute's value of the content pane header element. If not set, the header property value is used. -- **hidden?**: `boolean` — Determines whether a pane is hidden in the UI. Defaults to false. -- **id?**: `string` — The id of the pane. If not set the Dock Manager generates it automatically. -- **isMaximized?**: `boolean` — Determines whether a content pane is maximized or not. Defaults to false. -- **isPinned?**: `boolean` — Determines whether a content pane is pinned or not. Defaults to true. -- **size?**: `number` — The size of the pane relative to its sibling panes' sizes. Defaults to 100. -- **tabHeaderId?**: `string` — The slot attribute's value of the tab header element. If not set, the header property value is used. -- **type**: `"contentPane"` — The type of the pane. -- **unpinnedHeaderId?**: `string` — The slot attribute's value of the unpinned header element. If not set, the header property value is used. -- **unpinnedLocation?**: `IgcUnpinnedLocation` — The desired unpinned location of the content pane. - -If not set the Dock Manager automatically calculates it based on the location of the pane relatively to the document host. -If more than one document host is presented, the closest one in the pane hierarchy will be used for the calculation. -If there is no document host, the default location is left. -- **unpinnedSize?**: `number` — The absolute size of the pane in an unpinned state. Defaults to 200. - -### [IgrDockingIndicator](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrDockingIndicator) - -- **direction?**: `string` — Gets a value indicating the direction of the docking indicator. -- **isRoot**: `boolean` — Gets a value indicating whether the docking indicator is a root one. -- **position**: `IgcDockingIndicatorPosition` — Gets the position of the docking indicator. - -### [IgrDockManagerLayout](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrDockManagerLayout) -Describes a Dock Manager layout. - -- **floatingPanes?**: `IgcSplitPane[]` — The floating panes of the layout. -- **rootPane**: `IgcSplitPane` — The root split pane of the layout. - -### [IgrDockManagerPoint](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrDockManagerPoint) - -- **x**: `number` -- **y**: `number` - -### [IgrDockManagerResourceStrings](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrDockManagerResourceStrings) -Describes dock manager resource strings. - -- **close?**: `string` -- **documents?**: `string` -- **maximize?**: `string` -- **minimize?**: `string` -- **moreOptions?**: `string` -- **moreTabs?**: `string` -- **panes?**: `string` -- **pin?**: `string` -- **unpin?**: `string` - -### [IgrDockPaneAction](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrDockPaneAction) - -- **dockingIndicator**: `IgcDockingIndicator` -- **targetPane**: `IgcDockManagerPane` -- **type**: `"dockPane"` - -### [IgrDocumentHost](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrDocumentHost) - -- **id?**: `string` — The id of the pane. If not set the Dock Manager generates it automatically. -- **rootPane**: `IgcSplitPane` — The root split pane of the document host. -- **size?**: `number` — The size of the pane relative to its sibling panes' sizes. Defaults to 100. -- **type**: `"documentHost"` — The type of the pane. - -### [IgrFloatingPaneResizeEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrFloatingPaneResizeEventArgsDetail) - -- **resizerLocation**: `IgcResizerLocation` — Gets the edge/corner that is being dragged. -- **sourcePane**: `IgcSplitPane` — Gets the source pane that triggers the resize operation. - -### [IgrFloatingPaneResizeMoveEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrFloatingPaneResizeMoveEventArgsDetail) - -- **newHeight**: `number` — Gets the pane's height after the resizing operation. -- **newLocation**: `IgcDockManagerPoint` — Gets the pane's floating location after the resizing operation. -- **newWidth**: `number` — Gets the pane's width after the resizing operation. -- **oldHeight**: `number` — Gets the pane's height before the resizing operation. -- **oldLocation**: `IgcDockManagerPoint` — Gets the pane's floating location before the resizing operation. -- **oldWidth**: `number` — Gets the pane's width before the resizing operation. - -### [IgrFloatPaneAction](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrFloatPaneAction) - -- **height**: `number` -- **location**: `IgcDockManagerPoint` -- **type**: `"floatPane"` -- **width**: `number` - -### [IgrMoveFloatingPaneAction](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrMoveFloatingPaneAction) - -- **newLocation**: `IgcDockManagerPoint` -- **oldLocation**: `IgcDockManagerPoint` -- **type**: `"moveFloatingPane"` - -### [IgrMoveTabAction](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrMoveTabAction) - -- **newIndex**: `number` -- **oldIndex**: `number` -- **type**: `"moveTab"` - -### [IgrPaneCloseEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrPaneCloseEventArgsDetail) - -- **panes**: `IgcContentPane[]` — Gets/sets the panes that are about to close. -- **sourcePane**: `IgcDockManagerPane` — Get the source pane that triggers the close. - -### [IgrPaneDragEndEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrPaneDragEndEventArgsDetail) - -- **panes**: `IgcContentPane[]` — Gets the panes that end dragging. -- **sourcePane**: `IgcContentPane | IgcSplitPane | IgcTabGroupPane` — Gets the source pane that ends dragging. - -### [IgrPaneDragOverEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrPaneDragOverEventArgsDetail) - -- **action**: `IgcPaneDragAction` — Gets information about the action being performed. -- **isValid**: `boolean` — Gets/sets whether the action is valid. -- **panes**: `IgcContentPane[]` — Gets the panes that are dragged over. -- **sourcePane**: `IgcContentPane | IgcSplitPane | IgcTabGroupPane` — Gets the source pane that triggers the drag over. - -### [IgrPaneDragStartEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrPaneDragStartEventArgsDetail) - -- **panes**: `IgcContentPane[]` — Gets the panes that are about to get dragged. -- **sourcePane**: `IgcContentPane | IgcSplitPane` — Gets the source pane that triggers the drag start. - -### [IgrPaneHeaderConnectionEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrPaneHeaderConnectionEventArgsDetail) - -- **element**: `IgcPaneHeaderElement` — The header element that is being connected/disconnected. -- **pane**: `IgcContentPane` — The pane whose header is being connected/disconnected. - -### [IgrPaneHeaderElement](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrPaneHeaderElement) -Describes a pane header element. - -- **dragService**: `IgcDragService` — Gets/sets the drag service. - -### [IgrPanePinnedEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrPanePinnedEventArgsDetail) - -- **location**: `IgcUnpinnedLocation` — Gets the unpinned location. -- **newValue**: `boolean` — Gets the new pinned value. -- **panes**: `IgcContentPane[]` — Gets/sets the panes that are about to get pinned/unpinned. -- **sourcePane**: `IgcContentPane` — Gets the source pane that triggers the pinned state change. - -### [IgrPaneScrollEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrPaneScrollEventArgsDetail) - -- **contentElement**: `HTMLElement` — Gets the content element that is scrolled. -- **pane**: `IgcContentPane` — Gets the content pane that is scrolled. - -### [IgrSplitPane](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrSplitPane) - -- **allowEmpty?**: `boolean` — Determines whether the pane should present in the UI when empty. -- **floatingHeight?**: `number` — The absolute height of the pane. Applies only for floating panes. Defaults to 100. -- **floatingLocation?**: `IgcDockManagerPoint` — The absolute location point of the pane. Applies only for floating panes. -- **floatingResizable?**: `boolean` — Determines whether floating pane resizing is allowed. Applies only for floating panes. -- **floatingWidth?**: `number` — The absolute width of the pane. Applies only for floating panes. Defaults to 100. -- **id?**: `string` — The id of the pane. If not set the Dock Manager generates it automatically. -- **isMaximized?**: `boolean` — Determines whether a split pane is maximized or not. Defaults to false. -- **orientation**: `IgcSplitPaneOrientation` — The orientation of the split pane. -- **panes**: `IgcDockManagerPane[]` — The child panes of the split pane. -- **size?**: `number` — The size of the pane relative to its sibling panes' sizes. Defaults to 100. -- **type**: `"splitPane"` — The type of the pane. -- **useFixedSize?**: `boolean` — Determines whether child panes are sized in pixels (instead of relatively to their siblings) and can be resized beyond the viewport, allowing scrollable overflow within the container. -Defaults to false. - -### [IgrSplitterResizeEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrSplitterResizeEventArgsDetail) - -- **orientation**: `IgcSplitPaneOrientation` — Gets the pane's orientation. -- **pane**: `IgcDockManagerPane` — Gets the pane being resized with the splitter. -- **paneHeight**: `number` — Gets the pane's height. -- **paneWidth**: `number` — Gets the pane's width. - -### [IgrTabGroupPane](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrTabGroupPane) - -- **allowEmpty?**: `boolean` — Determines whether the pane should present in the UI when empty. -- **id?**: `string` — The id of the pane. If not set the Dock Manager generates it automatically. -- **isMaximized?**: `boolean` — Determines whether a tab group is maximized or not. Defaults to false. -- **panes**: `IgcContentPane[]` — The child content panes of the tab group. -- **selectedIndex?**: `number` — The index of the selected tab. -- **size?**: `number` — The size of the pane relative to its sibling panes' sizes. Defaults to 100. -- **type**: `"tabGroupPane"` — The type of the pane. - -### [IgrTabHeaderConnectionEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrTabHeaderConnectionEventArgsDetail) - -- **element**: `IgcTabHeaderElement` — The tab header element that is being connected/disconnected. -- **pane**: `IgcContentPane` — The pane whose tab header is being connected/disconnected. - -### [IgrTabHeaderElement](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/interfaces/IgrTabHeaderElement) -Describes a tab header element. - -- **dragService**: `IgcDragService` — Gets/sets the drag service. - -## Type Aliases - -### [IgrActivePaneEventArgs](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrActivePaneEventArgs) -`CustomEvent` - -### [IgrDockingIndicatorPosition](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrDockingIndicatorPosition) -`any` - -### [IgrDockManagerPane](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrDockManagerPane) -`IgcContentPane | IgcSplitPane | IgcTabGroupPane | IgcDocumentHost | undefined` - -### [IgrDockManagerPaneType](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrDockManagerPaneType) -`any` - -### [IgrFloatingPaneResizeEventArgs](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrFloatingPaneResizeEventArgs) -`CustomEvent` - -### [IgrFloatingPaneResizeMoveEventArgs](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrFloatingPaneResizeMoveEventArgs) -`CustomEvent` - -### [IgrPaneActionBehavior](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrPaneActionBehavior) -`any` -Enumeration used to determine which panes within a dockable TabGroupPane are affected by a particular pane action such as closing or unpinning a pane. - -### [IgrPaneCloseEventArgs](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrPaneCloseEventArgs) -`CustomEvent` - -### [IgrPaneDragAction](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrPaneDragAction) -`IgcFloatPaneAction | IgcMoveFloatingPaneAction | IgcDockPaneAction | IgcMoveTabAction` - -### [IgrPaneDragActionType](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrPaneDragActionType) -`any` - -### [IgrPaneDragEndEventArgs](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrPaneDragEndEventArgs) -`CustomEvent` - -### [IgrPaneDragOverEventArgs](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrPaneDragOverEventArgs) -`CustomEvent` - -### [IgrPaneDragStartEventArgs](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrPaneDragStartEventArgs) -`CustomEvent` - -### [IgrPaneHeaderConnectionEventArgs](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrPaneHeaderConnectionEventArgs) -`CustomEvent` - -### [IgrPanePinnedEventArgs](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrPanePinnedEventArgs) -`CustomEvent` - -### [IgrPaneScrollEventArgs](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrPaneScrollEventArgs) -`CustomEvent` - -### [IgrResizerLocation](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrResizerLocation) -`any` - -### [IgrSplitPaneOrientation](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrSplitPaneOrientation) -`any` - -### [IgrSplitterResizeEventArgs](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrSplitterResizeEventArgs) -`CustomEvent` - -### [IgrTabHeaderConnectionEventArgs](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrTabHeaderConnectionEventArgs) -`CustomEvent` - -### [IgrUnpinnedLocation](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/types/IgrUnpinnedLocation) -`any` - -## Functions - -### [defineAllComponents](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/functions/defineAllComponents) -`defineAllComponents(): void` - -### [defineComponents](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/functions/defineComponents) -`defineComponents(components: IgniteComponent[]): void` - -### [getCurrentI18n](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/functions/getCurrentI18n) -`getCurrentI18n(): string` - -### [getCurrentResourceStrings](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/functions/getCurrentResourceStrings) -`getCurrentResourceStrings(): IResourceStrings` - -### [registerI18n](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/functions/registerI18n) -`registerI18n(resourceStrings: IResourceStrings, locale: string): void` -Register resources for a specific locale. - -### [setCurrentI18n](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/functions/setCurrentI18n) -`setCurrentI18n(locale: string): void` -Set the current locale of all Ignite UI components. - -## Variables - -### [IgrDockingIndicatorPosition](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/variables/IgrDockingIndicatorPosition) -`any` - -### [IgrDockManagerPaneType](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/variables/IgrDockManagerPaneType) -`any` - -### [IgrPaneActionBehavior](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/variables/IgrPaneActionBehavior) -`any` -Enumeration used to determine which panes within a dockable TabGroupPane are affected by a particular pane action such as closing or unpinning a pane. - -### [IgrPaneDragActionType](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/variables/IgrPaneDragActionType) -`any` - -### [IgrResizerLocation](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/variables/IgrResizerLocation) -`any` - -### [IgrSplitPaneOrientation](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/variables/IgrSplitPaneOrientation) -`any` - -### [IgrUnpinnedLocation](https://www.infragistics.com/api/react/igniteui-react-dockmanager/19.5.1/variables/IgrUnpinnedLocation) -`any` diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/react-api/igniteui-react-grids/19.5.1/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/react-api/igniteui-react-grids/19.5.1/llms-full.txt deleted file mode 100644 index 44a67ca27..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/react-api/igniteui-react-grids/19.5.1/llms-full.txt +++ /dev/null @@ -1,4514 +0,0 @@ -# Ignite UI Grids for React v19.5.1 — Full API Reference - -> Complete API reference for the Ignite UI Grids for React package (19.5.1). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: React -Package: igniteui-react-grids -Version: 19.5.1 - -## Classes - -### [IgrActionStrip](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrActionStrip) -Action Strip provides templatable area for one or more actions. - -- **actionButtons**: `IgcGridActionsBaseDirective[]` — ActionButton as ContentChildren inside the Action Strip -- **hidden**: `boolean` — Gets/Sets the visibility of the Action Strip. -Could be used to set if the Action Strip will be initially hidden. -- **resourceStrings**: `IgcActionStripResourceStrings` — Gets/Sets the resource strings. -- **hide**(): void — Hiding the Action Strip and removing it from its current context element. -- **show**(context?: any): void — Showing the Action Strip and appending it the specified context element. - -### [IgrBooleanFilteringOperand](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrBooleanFilteringOperand) -Provides filtering operations for booleans - -- **constructor**(): IgcBooleanFilteringOperand - -### [IgrByLevelTreeGridMergeStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrByLevelTreeGridMergeStrategy) - -- **constructor**(): IgcByLevelTreeGridMergeStrategy -- **comparer**(prevRecord: any, record: any, field: string, isDate?: boolean, isTime?: boolean): boolean - -### [IgrColumn](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrColumn) -**Ignite UI for Angular Column** - [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/grid#columns-configuration) The Ignite UI Column is used within an igx-grid element to define what data the column will show. Features such as sorting, filtering & editing are enabled at the column level. You can also provide a template containing custom content inside the column using ng-template which will be used for all cells within the column. - -- **additionalTemplateContext**: `any` — Sets/gets custom properties provided in additional template context. - -```html - - - {{ props }} - - -``` -- **autosizeHeader**: `boolean` — Sets/gets whether the column header is included in autosize logic. -Useful when template for a column header is sized based on parent, for example a default `div`. -Default value is `false`. -```typescript -let isResizable = this.column.resizable; -``` -```html - -``` -- **bodyTemplate**: `IgcRenderFunction` — Returns a reference to the `bodyTemplate`. -```typescript -let bodyTemplate = this.column.bodyTemplate; -``` -- **cellClasses**: `any` — Sets a conditional class selector of the column cells. -Accepts an object literal, containing key-value pairs, -where the key is the name of the CSS class, while the -value is either a callback function that returns a boolean, -or boolean, like so: -```typescript -callback = (rowData, columnKey, cellValue, rowIndex) => { return rowData[columnKey] > 6; } -cellClasses = { 'className' : this.callback }; -``` -```html - - -``` -- **cellStyles**: `any` — Sets conditional style properties on the column cells. -Similar to `ngStyle` it accepts an object literal where the keys are -the style properties and the value is the expression to be evaluated. -As with `cellClasses` it accepts a callback function. -```typescript -styles = { - background: 'royalblue', - color: (rowData, columnKey, cellValue, rowIndex) => value.startsWith('Important') ? 'red': 'inherit' -} -``` -```html - -``` -- **colEnd**: `number` — Column index where the current field should end. -The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field -```html - - - -``` -- **colStart**: `number` — Column index from which the field is starting. -```html - - - -``` -- **dataType**: `GridColumnDataType` — Sets/gets the data type of the column values. -Default value is `string`. -```typescript -let columnDataType = this.column.dataType; -``` -```html - -``` -- **disabledSummaries**: `string[]` — Sets/gets the summary operands to exclude from display. -Accepts an array of string keys representing the summary types to disable, such as 'Min', 'Max', 'Count' etc. -```typescript -let disabledSummaries = this.column.disabledSummaries; -``` -```html - -``` -- **disableHiding**: `boolean` — Gets whether the hiding is disabled. -```typescript -let isHidingDisabled = this.column.disableHiding; -``` -- **disablePinning**: `boolean` — Gets whether the pinning is disabled. -```typescript -let isPinningDisabled = this.column.disablePinning; -``` -- **editable**: `boolean` — Gets whether the column is editable. -Default value is `false`. -```typescript -let isEditable = this.column.editable; -``` -- **editorOptions**: `IgcColumnEditorOptions` — Pass optional properties for the default column editors. -- **errorTemplate**: `IgcRenderFunction` — Returns a reference to the validation error template. -```typescript -let errorTemplate = this.column.errorTemplate; -``` -- **field**: `string` — Sets/gets the `field` value. -```typescript -let columnField = this.column.field; -``` -```html - -``` -- **filterable**: `boolean` — Sets/gets whether the column is filterable. -Default value is `true`. -```typescript -let isFilterable = this.column.filterable; -``` -```html - -``` -- **filterCellTemplate**: `IgcRenderFunction` — Returns a reference to the `filterCellTemplate`. -```typescript -let filterCellTemplate = this.column.filterCellTemplate; -``` -- **filteringIgnoreCase**: `boolean` — Sets/gets whether the column filtering should be case sensitive. -Default value is `true`. -```typescript -let filteringIgnoreCase = this.column.filteringIgnoreCase; -``` -```html - -``` -- **filters**: `IgcFilteringOperand` — Gets the column `filters`. -```typescript -let columnFilters = this.column.filters' -``` -- **formatter**: `any` — Applies display format to cell values in the column. Does not modify the underlying data. -- **groupable**: `boolean` — Sets/gets whether the column is groupable. -Default value is `false`. -```typescript -let isGroupable = this.column.groupable; -``` -```html - -``` -- **hasSummary**: `boolean` — Gets a value indicating whether the summary for the column is enabled. -```typescript -let hasSummary = this.column.hasSummary; -``` -- **header**: `string` — Sets/gets the `header` value. -```typescript -let columnHeader = this.column.header; -``` -```html - -``` -- **headerClasses**: `string` — Sets/gets the class selector of the column header. -```typescript -let columnHeaderClass = this.column.headerClasses; -``` -```html - -``` -- **headerGroupClasses**: `string` — Sets/gets the class selector of the column group header. -```typescript -let columnHeaderClass = this.column.headerGroupClasses; -``` -```html - -``` -- **headerGroupStyles**: `any` — Sets conditional style properties on the column header group wrapper. -Similar to `ngStyle` it accepts an object literal where the keys are -the style properties and the value is the expression to be evaluated. -```typescript -styles = { - background: 'royalblue', - color: (column) => column.pinned ? 'red': 'inherit' -} -``` -```html - -``` -- **headerStyles**: `any` — Sets conditional style properties on the column header. -Similar to `ngStyle` it accepts an object literal where the keys are -the style properties and the value is the expression to be evaluated. -```typescript -styles = { - background: 'royalblue', - color: (column) => column.pinned ? 'red': 'inherit' -} -``` -```html - -``` -- **headerTemplate**: `IgcRenderFunction` — Returns a reference to the header template. -```typescript -let headerTemplate = this.column.headerTemplate; -``` -- **hidden**: `boolean` — Gets whether the column is hidden. -```typescript -let isHidden = this.column.hidden; -``` -- **inlineEditorTemplate**: `IgcRenderFunction` — Returns a reference to the inline editor template. -```typescript -let inlineEditorTemplate = this.column.inlineEditorTemplate; -``` -- **maxWidth**: `string` — Sets/gets the maximum `width` of the column. -```typescript -let columnMaxWidth = this.column.width; -``` -```html - -``` -- **merge**: `boolean` — Sets/gets whether to merge cells in this column. -```html - -``` -- **minWidth**: `string` — Sets/gets the minimum `width` of the column. -Default value is `88`; -```typescript -let columnMinWidth = this.column.minWidth; -``` -```html - -``` -- **parent**: `IgcColumnComponent` — Sets/gets the parent column. -```typescript -let parentColumn = this.column.parent; -``` -```typescript -this.column.parent = higherLevelColumn; -``` -- **pinned**: `boolean` — Gets whether the column is `pinned`. -```typescript -let isPinned = this.column.pinned; -``` -- **pinningPosition**: `ColumnPinningPosition` — Gets the pinning position of the column. -```typescript -let pinningPosition = this.column.pinningPosition; -- **pipeArgs**: `IgcColumnPipeArgs` -- **resizable**: `boolean` — Sets/gets whether the column is resizable. -Default value is `false`. -```typescript -let isResizable = this.column.resizable; -``` -```html - -``` -- **rowEnd**: `number` — Row index where the current field should end. -The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field -```html - - - -``` -- **rowStart**: `number` — Row index from which the field is starting. -```html - - - -``` -- **searchable**: `boolean` — Sets/gets whether the column is `searchable`. -Default value is `true`. -```typescript -let isSearchable = this.column.searchable'; -``` -```html - -``` -- **selectable**: `boolean` — Returns if the column is selectable. -```typescript -let columnSelectable = this.column.selectable; -``` -- **selected**: `boolean` — Returns if the column is selected. -```typescript -let isSelected = this.column.selected; -``` -- **sortable**: `boolean` — Sets/gets whether the column is sortable. -Default value is `false`. -```typescript -let isSortable = this.column.sortable; -``` -```html - -``` -- **sortingIgnoreCase**: `boolean` — Sets/gets whether the column sorting should be case sensitive. -Default value is `true`. -```typescript -let sortingIgnoreCase = this.column.sortingIgnoreCase; -``` -```html - -``` -- **sortStrategy**: `IgcSortingStrategy` — Gets the column `sortStrategy`. -```typescript -let sortStrategy = this.column.sortStrategy -``` -- **summaries**: `any` — Gets the column `summaries`. -```typescript -let columnSummaries = this.column.summaries; -``` -- **summaryFormatter**: `any` — The summaryFormatter is used to format the display of the column summaries. - -In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter -to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers. - -```typescript -columnInit(column: IgxColumnComponent) { - if (column.field == "OrderDate") { - column.summaryFormatter = this.summaryFormat; - } -} - -summaryFormat(summary: IgxSummaryResult, summaryOperand: IgxSummaryOperand): string { - const result = summary.summaryResult; - if(summaryResult.key !== 'count' && result !== null && result !== undefined) { - const pipe = new DatePipe('fr-FR'); - return pipe.transform(result,'mediumDate'); - } - return result; -} -``` -- **summaryTemplate**: `IgcRenderFunction` — Returns a reference to the `summaryTemplate`. -```typescript -let summaryTemplate = this.column.summaryTemplate; -``` -- **title**: `string` — Sets/gets the `title` value. -```typescript -let title = this.column.title; -``` -```html - -``` -- **visibleWhenCollapsed**: `boolean` — Indicates whether the column will be visible when its parent is collapsed. -```html - - - -``` -- **width**: `string` — Gets the `width` of the column. -```typescript -let columnWidth = this.column.width; -``` -- **childColumns**: `any` — A list containing all the child columns under this column (if any). -Empty without children or if this column is not Group or Layout. -- **columnGroup**: `any` — Returns a boolean indicating if the column is a `ColumnGroup`. -```typescript -let columnGroup = this.column.columnGroup; -``` -- **columnLayout**: `any` — Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout. -```typescript -let columnGroup = this.column.columnGroup; -``` -- **columnLayoutChild**: `any` — Returns a boolean indicating if the column is a child of a `ColumnLayout` for multi-row layout. -```typescript -let columnLayoutChild = this.column.columnLayoutChild; -``` -- **filteringExpressionsTree**: `any` — Returns the filteringExpressionsTree of the column. -```typescript -let tree = this.column.filteringExpressionsTree; -``` -- **index**: `any` — Gets the column index. -```typescript -let columnIndex = this.column.index; -``` -- **level**: `any` — Returns the level of the column in a column group. -Returns `0` if the column doesn't have a `parent`. -```typescript -let columnLevel = this.column.level; -``` -- **topLevelParent**: `any` — Returns a reference to the top level parent column. -```typescript -let topLevelParent = this.column.topLevelParent; -``` -- **visibleIndex**: `any` — Gets the column visible index. -If the column is not visible, returns `-1`. -```typescript -let visibleColumnIndex = this.column.visibleIndex; -``` -- **autosize**(byHeaderOnly?: boolean): void — Autosize the column to the longest currently visible cell value, including the header cell. -@ViewChild('grid') grid: IgxGridComponent; -let column = this.grid.columnList.filter(c => c.field === 'ID')[0]; -column.autosize(); -- **move**(index: number): void — Moves a column to the specified visible index. -If passed index is invalid, or if column would receive a different visible index after moving, moving is not performed. -If passed index would move the column to a different column group. moving is not performed. -- **pin**(index?: number, pinningPosition?: ColumnPinningPosition): boolean — Pins the column in the specified position at the provided index in that pinned area. -Defaults to index 0 if not provided, or to the initial index in the pinned area. -Returns true if the column is successfully pinned. Returns false if the column cannot be pinned. -Column cannot be pinned if: -- Is already pinned -- index argument is out of range -let success = this.column.pin(); -- **unpin**(index?: number): boolean — Unpins the column and place it at the provided index in the unpinned area. -Defaults to index 0 if not provided, or to the initial index in the unpinned area. -Returns true if the column is successfully unpinned. Returns false if the column cannot be unpinned. -Column cannot be unpinned if: -- Is already unpinned -- index argument is out of range -let success = this.column.unpin(); - -### [IgrColumnGroup](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrColumnGroup) -**Ignite UI for Angular Column Group** - -- **additionalTemplateContext**: `any` — Sets/gets custom properties provided in additional template context. - -```html - - - {{ props }} - - -``` -- **autosizeHeader**: `boolean` — Sets/gets whether the column header is included in autosize logic. -Useful when template for a column header is sized based on parent, for example a default `div`. -Default value is `false`. -```typescript -let isResizable = this.column.resizable; -``` -```html - -``` -- **bodyTemplate**: `IgcRenderFunction` — Returns a reference to the `bodyTemplate`. -```typescript -let bodyTemplate = this.column.bodyTemplate; -``` -- **cellClasses**: `any` — Sets a conditional class selector of the column cells. -Accepts an object literal, containing key-value pairs, -where the key is the name of the CSS class, while the -value is either a callback function that returns a boolean, -or boolean, like so: -```typescript -callback = (rowData, columnKey, cellValue, rowIndex) => { return rowData[columnKey] > 6; } -cellClasses = { 'className' : this.callback }; -``` -```html - - -``` -- **cellStyles**: `any` — Sets conditional style properties on the column cells. -Similar to `ngStyle` it accepts an object literal where the keys are -the style properties and the value is the expression to be evaluated. -As with `cellClasses` it accepts a callback function. -```typescript -styles = { - background: 'royalblue', - color: (rowData, columnKey, cellValue, rowIndex) => value.startsWith('Important') ? 'red': 'inherit' -} -``` -```html - -``` -- **children**: `HTMLCollection` -- **colEnd**: `number` — Column index where the current field should end. -The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field -```html - - - -``` -- **collapsible**: `boolean` — Set if the column group is collapsible. -Default value is `false` -```html - -``` -- **collapsibleIndicatorTemplate**: `IgcRenderFunction` — Allows you to define a custom template for expand/collapse indicator -- **colStart**: `number` — Column index from which the field is starting. -```html - - - -``` -- **dataType**: `GridColumnDataType` — Sets/gets the data type of the column values. -Default value is `string`. -```typescript -let columnDataType = this.column.dataType; -``` -```html - -``` -- **disabledSummaries**: `string[]` — Sets/gets the summary operands to exclude from display. -Accepts an array of string keys representing the summary types to disable, such as 'Min', 'Max', 'Count' etc. -```typescript -let disabledSummaries = this.column.disabledSummaries; -``` -```html - -``` -- **disableHiding**: `boolean` — Gets whether the hiding is disabled. -```typescript -let isHidingDisabled = this.column.disableHiding; -``` -- **disablePinning**: `boolean` — Gets whether the pinning is disabled. -```typescript -let isPinningDisabled = this.column.disablePinning; -``` -- **editable**: `boolean` — Gets whether the column is editable. -Default value is `false`. -```typescript -let isEditable = this.column.editable; -``` -- **editorOptions**: `IgcColumnEditorOptions` — Pass optional properties for the default column editors. -- **errorTemplate**: `IgcRenderFunction` — Returns a reference to the validation error template. -```typescript -let errorTemplate = this.column.errorTemplate; -``` -- **expanded**: `boolean` — Set whether the group is expanded or collapsed initially. -Applied only if the collapsible property is set to `true` -Default value is `true` -```html - const state = false - -``` -- **field**: `string` — Sets/gets the `field` value. -```typescript -let columnField = this.column.field; -``` -```html - -``` -- **filterable**: `boolean` — Sets/gets whether the column is filterable. -Default value is `true`. -```typescript -let isFilterable = this.column.filterable; -``` -```html - -``` -- **filterCellTemplate**: `IgcRenderFunction` — Returns a reference to the `filterCellTemplate`. -```typescript -let filterCellTemplate = this.column.filterCellTemplate; -``` -- **filteringIgnoreCase**: `boolean` — Sets/gets whether the column filtering should be case sensitive. -Default value is `true`. -```typescript -let filteringIgnoreCase = this.column.filteringIgnoreCase; -``` -```html - -``` -- **filters**: `IgcFilteringOperand` — Gets the column `filters`. -```typescript -let columnFilters = this.column.filters' -``` -- **formatter**: `any` — Applies display format to cell values in the column. Does not modify the underlying data. -- **groupable**: `boolean` — Sets/gets whether the column is groupable. -Default value is `false`. -```typescript -let isGroupable = this.column.groupable; -``` -```html - -``` -- **hasSummary**: `boolean` — Gets a value indicating whether the summary for the column is enabled. -```typescript -let hasSummary = this.column.hasSummary; -``` -- **header**: `string` — Sets/gets the `header` value. -```typescript -let columnHeader = this.column.header; -``` -```html - -``` -- **headerClasses**: `string` — Sets/gets the class selector of the column header. -```typescript -let columnHeaderClass = this.column.headerClasses; -``` -```html - -``` -- **headerGroupClasses**: `string` — Sets/gets the class selector of the column group header. -```typescript -let columnHeaderClass = this.column.headerGroupClasses; -``` -```html - -``` -- **headerGroupStyles**: `any` — Sets conditional style properties on the column header group wrapper. -Similar to `ngStyle` it accepts an object literal where the keys are -the style properties and the value is the expression to be evaluated. -```typescript -styles = { - background: 'royalblue', - color: (column) => column.pinned ? 'red': 'inherit' -} -``` -```html - -``` -- **headerStyles**: `any` — Sets conditional style properties on the column header. -Similar to `ngStyle` it accepts an object literal where the keys are -the style properties and the value is the expression to be evaluated. -```typescript -styles = { - background: 'royalblue', - color: (column) => column.pinned ? 'red': 'inherit' -} -``` -```html - -``` -- **headerTemplate**: `IgcRenderFunction` — Returns a reference to the header template. -```typescript -let headerTemplate = this.column.headerTemplate; -``` -- **hidden**: `boolean` — Gets whether the column is hidden. -```typescript -let isHidden = this.column.hidden; -``` -- **inlineEditorTemplate**: `IgcRenderFunction` — Returns a reference to the inline editor template. -```typescript -let inlineEditorTemplate = this.column.inlineEditorTemplate; -``` -- **maxWidth**: `string` — Sets/gets the maximum `width` of the column. -```typescript -let columnMaxWidth = this.column.width; -``` -```html - -``` -- **merge**: `boolean` — Sets/gets whether to merge cells in this column. -```html - -``` -- **minWidth**: `string` — Sets/gets the minimum `width` of the column. -Default value is `88`; -```typescript -let columnMinWidth = this.column.minWidth; -``` -```html - -``` -- **parent**: `IgcColumnComponent` — Sets/gets the parent column. -```typescript -let parentColumn = this.column.parent; -``` -```typescript -this.column.parent = higherLevelColumn; -``` -- **pinned**: `boolean` — Gets whether the column is `pinned`. -```typescript -let isPinned = this.column.pinned; -``` -- **pinningPosition**: `ColumnPinningPosition` — Gets the pinning position of the column. -```typescript -let pinningPosition = this.column.pinningPosition; -- **pipeArgs**: `IgcColumnPipeArgs` -- **resizable**: `boolean` — Sets/gets whether the column is resizable. -Default value is `false`. -```typescript -let isResizable = this.column.resizable; -``` -```html - -``` -- **rowEnd**: `number` — Row index where the current field should end. -The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field -```html - - - -``` -- **rowStart**: `number` — Row index from which the field is starting. -```html - - - -``` -- **searchable**: `boolean` — Sets/gets whether the column is `searchable`. -Default value is `true`. -```typescript -let isSearchable = this.column.searchable'; -``` -```html - -``` -- **selectable**: `boolean` — Returns if the column is selectable. -```typescript -let columnSelectable = this.column.selectable; -``` -- **selected**: `boolean` — Returns if the column is selected. -```typescript -let isSelected = this.column.selected; -``` -- **sortable**: `boolean` — Sets/gets whether the column is sortable. -Default value is `false`. -```typescript -let isSortable = this.column.sortable; -``` -```html - -``` -- **sortingIgnoreCase**: `boolean` — Sets/gets whether the column sorting should be case sensitive. -Default value is `true`. -```typescript -let sortingIgnoreCase = this.column.sortingIgnoreCase; -``` -```html - -``` -- **sortStrategy**: `IgcSortingStrategy` — Gets the column `sortStrategy`. -```typescript -let sortStrategy = this.column.sortStrategy -``` -- **summaries**: `any` — Gets the column `summaries`. -```typescript -let columnSummaries = this.column.summaries; -``` -- **summaryFormatter**: `any` — The summaryFormatter is used to format the display of the column summaries. - -In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter -to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers. - -```typescript -columnInit(column: IgxColumnComponent) { - if (column.field == "OrderDate") { - column.summaryFormatter = this.summaryFormat; - } -} - -summaryFormat(summary: IgxSummaryResult, summaryOperand: IgxSummaryOperand): string { - const result = summary.summaryResult; - if(summaryResult.key !== 'count' && result !== null && result !== undefined) { - const pipe = new DatePipe('fr-FR'); - return pipe.transform(result,'mediumDate'); - } - return result; -} -``` -- **summaryTemplate**: `IgcRenderFunction` — Returns a reference to the `summaryTemplate`. -```typescript -let summaryTemplate = this.column.summaryTemplate; -``` -- **title**: `string` — Sets/gets the `title` value. -```typescript -let title = this.column.title; -``` -```html - -``` -- **visibleWhenCollapsed**: `boolean` — Indicates whether the column will be visible when its parent is collapsed. -```html - - - -``` -- **width**: `string` — Gets the `width` of the column. -```typescript -let columnWidth = this.column.width; -``` -- **childColumns**: `any` — A list containing all the child columns under this column (if any). -Empty without children or if this column is not Group or Layout. -- **childColumns**: `any` — A list containing all the child columns under this column (if any). -Empty without children or if this column is not Group or Layout. -- **columnGroup**: `any` — Returns a boolean indicating if the column is a `ColumnGroup`. -```typescript -let isColumnGroup = this.columnGroup.columnGroup -``` -- **columnGroup**: `any` — Returns a boolean indicating if the column is a `ColumnGroup`. -```typescript -let columnGroup = this.column.columnGroup; -``` -- **columnLayout**: `any` — Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout. -```typescript -let columnGroup = this.column.columnGroup; -``` -- **columnLayout**: `any` — Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout. -```typescript -let columnGroup = this.column.columnGroup; -``` -- **columnLayoutChild**: `any` — Returns a boolean indicating if the column is a child of a `ColumnLayout` for multi-row layout. -```typescript -let columnLayoutChild = this.column.columnLayoutChild; -``` -- **filteringExpressionsTree**: `any` — Returns the filteringExpressionsTree of the column. -```typescript -let tree = this.column.filteringExpressionsTree; -``` -- **filters**: `any` — Gets the column group `filters`. -```typescript -let columnGroupFilters = this.columnGroup.filters; -``` -- **hidden**: `any` — Gets whether the column group is hidden. -```typescript -let isHidden = this.columnGroup.hidden; -``` -- **index**: `any` — Gets the column index. -```typescript -let columnIndex = this.column.index; -``` -- **level**: `any` — Returns the level of the column in a column group. -Returns `0` if the column doesn't have a `parent`. -```typescript -let columnLevel = this.column.level; -``` -- **selectable**: `any` — Returns if the column group is selectable -```typescript -let columnGroupSelectable = this.columnGroup.selectable; -``` -- **selected**: `any` — Returns if the column group is selected. -```typescript -let isSelected = this.columnGroup.selected; -``` -- **summaries**: `any` — Gets the column group `summaries`. -```typescript -let columnGroupSummaries = this.columnGroup.summaries; -``` -- **topLevelParent**: `any` — Returns a reference to the top level parent column. -```typescript -let topLevelParent = this.column.topLevelParent; -``` -- **visibleIndex**: `any` — Gets the column visible index. -If the column is not visible, returns `-1`. -```typescript -let visibleColumnIndex = this.column.visibleIndex; -``` -- **width**: `any` — Gets the width of the column group. -```typescript -let columnGroupWidth = this.columnGroup.width; -``` -- **autosize**(byHeaderOnly?: boolean): void — Autosize the column to the longest currently visible cell value, including the header cell. -@ViewChild('grid') grid: IgxGridComponent; -let column = this.grid.columnList.filter(c => c.field === 'ID')[0]; -column.autosize(); -- **move**(index: number): void — Moves a column to the specified visible index. -If passed index is invalid, or if column would receive a different visible index after moving, moving is not performed. -If passed index would move the column to a different column group. moving is not performed. -- **pin**(index?: number, pinningPosition?: ColumnPinningPosition): boolean — Pins the column in the specified position at the provided index in that pinned area. -Defaults to index 0 if not provided, or to the initial index in the pinned area. -Returns true if the column is successfully pinned. Returns false if the column cannot be pinned. -Column cannot be pinned if: -- Is already pinned -- index argument is out of range -let success = this.column.pin(); -- **unpin**(index?: number): boolean — Unpins the column and place it at the provided index in the unpinned area. -Defaults to index 0 if not provided, or to the initial index in the unpinned area. -Returns true if the column is successfully unpinned. Returns false if the column cannot be unpinned. -Column cannot be unpinned if: -- Is already unpinned -- index argument is out of range -let success = this.column.unpin(); - -### [IgrColumnLayout](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrColumnLayout) -Column layout for declaration of Multi-row Layout - -- **additionalTemplateContext**: `any` — Sets/gets custom properties provided in additional template context. - -```html - - - {{ props }} - - -``` -- **autosizeHeader**: `boolean` — Sets/gets whether the column header is included in autosize logic. -Useful when template for a column header is sized based on parent, for example a default `div`. -Default value is `false`. -```typescript -let isResizable = this.column.resizable; -``` -```html - -``` -- **bodyTemplate**: `IgcRenderFunction` — Returns a reference to the `bodyTemplate`. -```typescript -let bodyTemplate = this.column.bodyTemplate; -``` -- **cellClasses**: `any` — Sets a conditional class selector of the column cells. -Accepts an object literal, containing key-value pairs, -where the key is the name of the CSS class, while the -value is either a callback function that returns a boolean, -or boolean, like so: -```typescript -callback = (rowData, columnKey, cellValue, rowIndex) => { return rowData[columnKey] > 6; } -cellClasses = { 'className' : this.callback }; -``` -```html - - -``` -- **cellStyles**: `any` — Sets conditional style properties on the column cells. -Similar to `ngStyle` it accepts an object literal where the keys are -the style properties and the value is the expression to be evaluated. -As with `cellClasses` it accepts a callback function. -```typescript -styles = { - background: 'royalblue', - color: (rowData, columnKey, cellValue, rowIndex) => value.startsWith('Important') ? 'red': 'inherit' -} -``` -```html - -``` -- **children**: `HTMLCollection` -- **colEnd**: `number` — Column index where the current field should end. -The amount of columns between colStart and colEnd will determine the amount of spanning columns to that field -```html - - - -``` -- **collapsible**: `boolean` — Set if the column group is collapsible. -Default value is `false` -```html - -``` -- **collapsibleIndicatorTemplate**: `IgcRenderFunction` — Allows you to define a custom template for expand/collapse indicator -- **colStart**: `number` — Column index from which the field is starting. -```html - - - -``` -- **dataType**: `GridColumnDataType` — Sets/gets the data type of the column values. -Default value is `string`. -```typescript -let columnDataType = this.column.dataType; -``` -```html - -``` -- **disabledSummaries**: `string[]` — Sets/gets the summary operands to exclude from display. -Accepts an array of string keys representing the summary types to disable, such as 'Min', 'Max', 'Count' etc. -```typescript -let disabledSummaries = this.column.disabledSummaries; -``` -```html - -``` -- **disableHiding**: `boolean` — Gets whether the hiding is disabled. -```typescript -let isHidingDisabled = this.column.disableHiding; -``` -- **disablePinning**: `boolean` — Gets whether the pinning is disabled. -```typescript -let isPinningDisabled = this.column.disablePinning; -``` -- **editable**: `boolean` — Gets whether the column is editable. -Default value is `false`. -```typescript -let isEditable = this.column.editable; -``` -- **editorOptions**: `IgcColumnEditorOptions` — Pass optional properties for the default column editors. -- **errorTemplate**: `IgcRenderFunction` — Returns a reference to the validation error template. -```typescript -let errorTemplate = this.column.errorTemplate; -``` -- **expanded**: `boolean` — Set whether the group is expanded or collapsed initially. -Applied only if the collapsible property is set to `true` -Default value is `true` -```html - const state = false - -``` -- **field**: `string` — Sets/gets the `field` value. -```typescript -let columnField = this.column.field; -``` -```html - -``` -- **filterable**: `boolean` — Sets/gets whether the column is filterable. -Default value is `true`. -```typescript -let isFilterable = this.column.filterable; -``` -```html - -``` -- **filterCellTemplate**: `IgcRenderFunction` — Returns a reference to the `filterCellTemplate`. -```typescript -let filterCellTemplate = this.column.filterCellTemplate; -``` -- **filteringIgnoreCase**: `boolean` — Sets/gets whether the column filtering should be case sensitive. -Default value is `true`. -```typescript -let filteringIgnoreCase = this.column.filteringIgnoreCase; -``` -```html - -``` -- **filters**: `IgcFilteringOperand` — Gets the column `filters`. -```typescript -let columnFilters = this.column.filters' -``` -- **formatter**: `any` — Applies display format to cell values in the column. Does not modify the underlying data. -- **groupable**: `boolean` — Sets/gets whether the column is groupable. -Default value is `false`. -```typescript -let isGroupable = this.column.groupable; -``` -```html - -``` -- **hasSummary**: `boolean` — Gets a value indicating whether the summary for the column is enabled. -```typescript -let hasSummary = this.column.hasSummary; -``` -- **header**: `string` — Sets/gets the `header` value. -```typescript -let columnHeader = this.column.header; -``` -```html - -``` -- **headerClasses**: `string` — Sets/gets the class selector of the column header. -```typescript -let columnHeaderClass = this.column.headerClasses; -``` -```html - -``` -- **headerGroupClasses**: `string` — Sets/gets the class selector of the column group header. -```typescript -let columnHeaderClass = this.column.headerGroupClasses; -``` -```html - -``` -- **headerGroupStyles**: `any` — Sets conditional style properties on the column header group wrapper. -Similar to `ngStyle` it accepts an object literal where the keys are -the style properties and the value is the expression to be evaluated. -```typescript -styles = { - background: 'royalblue', - color: (column) => column.pinned ? 'red': 'inherit' -} -``` -```html - -``` -- **headerStyles**: `any` — Sets conditional style properties on the column header. -Similar to `ngStyle` it accepts an object literal where the keys are -the style properties and the value is the expression to be evaluated. -```typescript -styles = { - background: 'royalblue', - color: (column) => column.pinned ? 'red': 'inherit' -} -``` -```html - -``` -- **headerTemplate**: `IgcRenderFunction` — Returns a reference to the header template. -```typescript -let headerTemplate = this.column.headerTemplate; -``` -- **hidden**: `boolean` — Gets whether the column is hidden. -```typescript -let isHidden = this.column.hidden; -``` -- **inlineEditorTemplate**: `IgcRenderFunction` — Returns a reference to the inline editor template. -```typescript -let inlineEditorTemplate = this.column.inlineEditorTemplate; -``` -- **maxWidth**: `string` — Sets/gets the maximum `width` of the column. -```typescript -let columnMaxWidth = this.column.width; -``` -```html - -``` -- **merge**: `boolean` — Sets/gets whether to merge cells in this column. -```html - -``` -- **minWidth**: `string` — Sets/gets the minimum `width` of the column. -Default value is `88`; -```typescript -let columnMinWidth = this.column.minWidth; -``` -```html - -``` -- **parent**: `IgcColumnComponent` — Sets/gets the parent column. -```typescript -let parentColumn = this.column.parent; -``` -```typescript -this.column.parent = higherLevelColumn; -``` -- **pinned**: `boolean` — Gets whether the column is `pinned`. -```typescript -let isPinned = this.column.pinned; -``` -- **pinningPosition**: `ColumnPinningPosition` — Gets the pinning position of the column. -```typescript -let pinningPosition = this.column.pinningPosition; -- **pipeArgs**: `IgcColumnPipeArgs` -- **resizable**: `boolean` — Sets/gets whether the column is resizable. -Default value is `false`. -```typescript -let isResizable = this.column.resizable; -``` -```html - -``` -- **rowEnd**: `number` — Row index where the current field should end. -The amount of rows between rowStart and rowEnd will determine the amount of spanning rows to that field -```html - - - -``` -- **rowStart**: `number` — Row index from which the field is starting. -```html - - - -``` -- **searchable**: `boolean` — Sets/gets whether the column is `searchable`. -Default value is `true`. -```typescript -let isSearchable = this.column.searchable'; -``` -```html - -``` -- **selectable**: `boolean` — Returns if the column is selectable. -```typescript -let columnSelectable = this.column.selectable; -``` -- **selected**: `boolean` — Returns if the column is selected. -```typescript -let isSelected = this.column.selected; -``` -- **sortable**: `boolean` — Sets/gets whether the column is sortable. -Default value is `false`. -```typescript -let isSortable = this.column.sortable; -``` -```html - -``` -- **sortingIgnoreCase**: `boolean` — Sets/gets whether the column sorting should be case sensitive. -Default value is `true`. -```typescript -let sortingIgnoreCase = this.column.sortingIgnoreCase; -``` -```html - -``` -- **sortStrategy**: `IgcSortingStrategy` — Gets the column `sortStrategy`. -```typescript -let sortStrategy = this.column.sortStrategy -``` -- **summaries**: `any` — Gets the column `summaries`. -```typescript -let columnSummaries = this.column.summaries; -``` -- **summaryFormatter**: `any` — The summaryFormatter is used to format the display of the column summaries. - -In this example, we check to see if the column name is OrderDate, and then provide a method as the summaryFormatter -to change the locale for the dates to 'fr-FR'. The summaries with the count key are skipped so they are displayed as numbers. - -```typescript -columnInit(column: IgxColumnComponent) { - if (column.field == "OrderDate") { - column.summaryFormatter = this.summaryFormat; - } -} - -summaryFormat(summary: IgxSummaryResult, summaryOperand: IgxSummaryOperand): string { - const result = summary.summaryResult; - if(summaryResult.key !== 'count' && result !== null && result !== undefined) { - const pipe = new DatePipe('fr-FR'); - return pipe.transform(result,'mediumDate'); - } - return result; -} -``` -- **summaryTemplate**: `IgcRenderFunction` — Returns a reference to the `summaryTemplate`. -```typescript -let summaryTemplate = this.column.summaryTemplate; -``` -- **title**: `string` — Sets/gets the `title` value. -```typescript -let title = this.column.title; -``` -```html - -``` -- **visibleWhenCollapsed**: `boolean` — Indicates whether the column will be visible when its parent is collapsed. -```html - - - -``` -- **width**: `string` — Gets the `width` of the column. -```typescript -let columnWidth = this.column.width; -``` -- **childColumns**: `any` — A list containing all the child columns under this column (if any). -Empty without children or if this column is not Group or Layout. -- **childColumns**: `any` — A list containing all the child columns under this column (if any). -Empty without children or if this column is not Group or Layout. -- **columnGroup**: `any` — Returns a boolean indicating if the column is a `ColumnGroup`. -```typescript -let isColumnGroup = this.columnGroup.columnGroup -``` -- **columnGroup**: `any` — Returns a boolean indicating if the column is a `ColumnGroup`. -```typescript -let columnGroup = this.column.columnGroup; -``` -- **columnLayout**: `any` — Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout. -```typescript -let columnGroup = this.column.columnGroup; -``` -- **columnLayout**: `any` — Returns a boolean indicating if the column is a `ColumnLayout` for multi-row layout. -```typescript -let columnGroup = this.column.columnGroup; -``` -- **columnLayoutChild**: `any` — Returns a boolean indicating if the column is a child of a `ColumnLayout` for multi-row layout. -```typescript -let columnLayoutChild = this.column.columnLayoutChild; -``` -- **filteringExpressionsTree**: `any` — Returns the filteringExpressionsTree of the column. -```typescript -let tree = this.column.filteringExpressionsTree; -``` -- **filters**: `any` — Gets the column group `filters`. -```typescript -let columnGroupFilters = this.columnGroup.filters; -``` -- **hidden**: `any` — Gets whether the column group is hidden. -```typescript -let isHidden = this.columnGroup.hidden; -``` -- **index**: `any` — Gets the column index. -```typescript -let columnIndex = this.column.index; -``` -- **level**: `any` — Returns the level of the column in a column group. -Returns `0` if the column doesn't have a `parent`. -```typescript -let columnLevel = this.column.level; -``` -- **selectable**: `any` — Returns if the column group is selectable -```typescript -let columnGroupSelectable = this.columnGroup.selectable; -``` -- **selected**: `any` — Returns if the column group is selected. -```typescript -let isSelected = this.columnGroup.selected; -``` -- **summaries**: `any` — Gets the column group `summaries`. -```typescript -let columnGroupSummaries = this.columnGroup.summaries; -``` -- **topLevelParent**: `any` — Returns a reference to the top level parent column. -```typescript -let topLevelParent = this.column.topLevelParent; -``` -- **visibleIndex**: `any` — Gets the column visible index. -If the column is not visible, returns `-1`. -```typescript -let visibleColumnIndex = this.column.visibleIndex; -``` -- **visibleIndex**: `any` — Gets the column visible index. -If the column is not visible, returns `-1`. -```typescript -let visibleColumnIndex = this.column.visibleIndex; -``` -- **width**: `any` — Gets the width of the column layout. -```typescript -let columnGroupWidth = this.columnGroup.width; -``` -- **width**: `any` — Gets the width of the column group. -```typescript -let columnGroupWidth = this.columnGroup.width; -``` -- **autosize**(byHeaderOnly?: boolean): void — Autosize the column to the longest currently visible cell value, including the header cell. -@ViewChild('grid') grid: IgxGridComponent; -let column = this.grid.columnList.filter(c => c.field === 'ID')[0]; -column.autosize(); -- **move**(index: number): void — Moves a column to the specified visible index. -If passed index is invalid, or if column would receive a different visible index after moving, moving is not performed. -If passed index would move the column to a different column group. moving is not performed. -- **pin**(index?: number, pinningPosition?: ColumnPinningPosition): boolean — Pins the column in the specified position at the provided index in that pinned area. -Defaults to index 0 if not provided, or to the initial index in the pinned area. -Returns true if the column is successfully pinned. Returns false if the column cannot be pinned. -Column cannot be pinned if: -- Is already pinned -- index argument is out of range -let success = this.column.pin(); -- **unpin**(index?: number): boolean — Unpins the column and place it at the provided index in the unpinned area. -Defaults to index 0 if not provided, or to the initial index in the unpinned area. -Returns true if the column is successfully unpinned. Returns false if the column cannot be unpinned. -Column cannot be unpinned if: -- Is already unpinned -- index argument is out of range -let success = this.column.unpin(); - -### [IgrDateFilteringOperand](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrDateFilteringOperand) -Provides filtering operations for Dates - -- **constructor**(): IgcDateFilteringOperand - -### [IgrDateSummaryOperand](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrDateSummaryOperand) - -- **constructor**(): IgcDateSummaryOperand -- **operate**(data?: any[], allData?: any[], fieldName?: string, groupRecord?: IgcGroupByRecord): IgcSummaryResult[] — Executes the static methods and returns IgxSummaryResult[]. -interface IgxSummaryResult { - key: string; - label: string; - summaryResult: any; -} - -Can be overridden in the inherited classes to provide customization for the summary. -class CustomDateSummary extends IgxDateSummaryOperand { - constructor() { - super(); - } - public operate(data: any[], allData: any[], fieldName: string, groupRecord: IGroupByRecord): IgxSummaryResult[] { - const result = super.operate(data, allData, fieldName, groupRecord); - result.push({ - key: "deadline", - label: "Deadline Date", - summaryResult: this.calculateDeadline(data); - }); - return result; - } -} -this.grid.getColumnByName('ColumnName').summaries = CustomDateSummary; -- static **earliest**(data: any[]): void — Returns the earliest date value in the data records. -If filtering is applied, returns the latest date value in the filtered data records. -IgxDateSummaryOperand.earliest(data); -- static **latest**(data: any[]): void — Returns the latest date value in the data records. -If filtering is applied, returns the latest date value in the filtered data records. -IgxDateSummaryOperand.latest(data); - -### [IgrDateTimeFilteringOperand](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrDateTimeFilteringOperand) - -- **constructor**(): IgcDateTimeFilteringOperand - -### [IgrDefaultMergeStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrDefaultMergeStrategy) - -- **constructor**(): IgcDefaultMergeStrategy -- **comparer**(prevRecord: any, record: any, field: string, isDate?: boolean, isTime?: boolean): boolean -- **merge**(data: any[], field: string, comparer: any, result: any[], activeRowIndexes: number[], isDate?: boolean, isTime?: boolean, grid?: IgcGridBaseDirective): any[] -- static **instance**(): IgcDefaultMergeStrategy - -### [IgrDefaultTreeGridMergeStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrDefaultTreeGridMergeStrategy) - -- **constructor**(): IgcDefaultTreeGridMergeStrategy -- **comparer**(prevRecord: any, record: any, field: string, isDate?: boolean, isTime?: boolean): boolean - -### [IgrFilteringExpressionsTree](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrFilteringExpressionsTree) - -- **constructor**(): IgcFilteringExpressionsTree -- **entity**: `string` -- **fieldName**: `string` -- **owner**: `any` — Provides reference to the owner component. -- **returnFields**: `string[]` -- **type**: `FilteringExpressionsTreeType` -- **filteringOperands**: `IgcFilteringExpressionsTree | IgcFilteringExpression[]` -- **operator**: `FilteringLogic` - -### [IgrFilteringOperand](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrFilteringOperand) -Provides base filtering operations -Implementations should be Singleton - -- **constructor**(): IgcFilteringOperand -- **operations**: `IgcFilteringOperation[]` -- **append**(operation: IgcFilteringOperation): void — Adds a new condition to the filtering operations. -- **condition**(name: string): IgcFilteringOperation — Returns an instance of the condition with the specified name. -- **conditionList**(): string[] — Returns an array of names of the conditions which are visible in the filtering UI -- static **instance**(): IgcFilteringOperand - -### [IgrGrid](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrGrid) -Grid provides a way to present and manipulate tabular data. - -- **data**: `any[]` — Gets/Sets the array of data that populates the component. -- **detailTemplate**: `IgcRenderFunction` — Returns a reference to the master-detail template. -```typescript -let detailTemplate = this.grid.detailTemplate; -``` -- **dropAreaMessage**: `string` — Gets/Sets the message displayed inside the GroupBy drop area where columns can be dragged on. -- **dropAreaTemplate**: `IgcRenderFunction` — Gets/Sets the template that will be rendered as a GroupBy drop area. -- **groupByRowSelectorTemplate**: `IgcRenderFunction` — Gets the group by row selector template. -- **groupingExpansionState**: `IgcGroupByExpandState[]` — Gets/Sets a list of expansion states for group rows. -- **groupingExpressions**: `IgcGroupingExpression[]` — Gets/Sets the group by state. -- **groupRowTemplate**: `IgcRenderFunction` — Gets/Sets the template reference for the group row. -- **groupsExpanded**: `boolean` — Gets/Sets whether created groups are rendered expanded or collapsed. -- **groupStrategy**: `IgcGridGroupingStrategy` — Gets/Sets the grouping strategy of the grid. -- **hideGroupedColumns**: `boolean` — Gets/Sets whether the grouped columns should be hidden. -- **id**: `string` — Gets/Sets the value of the `id` attribute. -- **showGroupArea**: `boolean` — Returns whether the `IgxGridComponent` has group area. -- **totalItemCount**: `number` — Gets/Sets the total number of records in the data source. -- **groupsRecords**: `any` — Gets the hierarchical representation of the group by records. -- **selectedCells**: `any` — Returns an array of the selected `IgxGridCell`s. -- **clearGrouping**(name?: string): void — Clears grouping for particular column, array of columns or all columns. -- **deselectRowsInGroup**(groupRow: IgcGroupByRecord): void — Deselect all rows within a group. -- **fullyExpandGroup**(groupRow: IgcGroupByRecord): void — Expands the specified group and all of its parent groups. -- **getCellByColumn**(rowIndex: number, columnField: string): IgcCellType — Returns a CellType object that matches the conditions. -- **getCellByKey**(rowSelector: any, columnField: string): IgcCellType — Returns a CellType object that matches the conditions. -- **getRowByIndex**(index: number): IgcRowType — Returns the IgxGridRow by index. -- **getRowByKey**(key: any): IgcRowType — Returns IgxGridRow object by the specified primary key. -- **getSelectedData**(formatters?: boolean, headers?: boolean): any[] — Returns an array of the current cell selection in the form of [{ column.field: cell.value }, ...]. -- **groupBy**(expression: IgcGroupingExpression[]): void — Groups by a new IgxColumnComponent based on the provided expression, or modifies an existing one. -- **isExpandedGroup**(group: IgcGroupByRecord): boolean — Returns if a group is expanded or not. -- **pinRow**(rowID: any, index?: number): boolean — Pin the row by its id. -- **selectRowsInGroup**(groupRow: IgcGroupByRecord, clearPrevSelection?: boolean): void — Select all rows within a group. -- **toggleAllGroupRows**(): void — Toggles the expansion state of all group rows recursively. -- **toggleGroup**(groupRow: IgcGroupByRecord): void — Toggles the expansion state of a group. -- **unpinRow**(rowID: any): boolean — Unpin the row by its id. - -### [IgrGridEditingActions](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrGridEditingActions) -Grid Editing Actions for the Action Strip - -- **addChild**: `boolean` — An input to enable/disable action strip child row adding button -- **addRow**: `boolean` — An input to enable/disable action strip row adding button -- **asMenuItems**: `boolean` — Gets/Sets if the action buttons will be rendered as menu items. When in menu, items will be rendered with text label. -- **deleteRow**: `boolean` — An input to enable/disable action strip row deleting button -- **editRow**: `boolean` — An input to enable/disable action strip row editing button -- **hasChildren**: `any` -- **startEdit**(evt?: any): void — Enter row or cell edit mode depending the grid rowEditable option - -### [IgrGridPinningActions](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrGridPinningActions) -Grid Pinning Actions for the Action Strip - -- **asMenuItems**: `boolean` — Gets/Sets if the action buttons will be rendered as menu items. When in menu, items will be rendered with text label. -- **pin**(evt?: any): void — Pin the row according to the context. -- **scrollToRow**(evt: any): void -- **unpin**(evt?: any): void — Unpin the row according to the context. - -### [IgrGridState](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrGridState) -State component allows saving and restoring the state of the grid features. - -- **applyState**(state: IgcGridStateInfo, features?: string[]): void — Restores grid features' state based on the IGridStateInfo object passed as an argument. -- **applyStateFromString**(state: string, features?: string[]): void — Restores grid features' state based on the serialized IGridState object passed as an argument. -- **getState**(features?: string[]): IgcGridStateInfo — Gets the state of a feature or states of all grid features, unless a certain feature is disabled through the options property. -- **getStateAsString**(features?: string[]): string — Gets the state of a feature or states of all grid features, unless a certain feature is disabled through the options property. - -### [IgrGridToolbar](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrGridToolbar) -Provides a context-aware container component for UI operations for the grid components. - -- **grid**: `IgcGridBaseDirective` — Gets/sets the grid component for the toolbar component. -- **showProgress**: `boolean` — When enabled, shows the indeterminate progress bar. - -### [IgrGridToolbarActions](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrGridToolbarActions) -Provides a way to template the action portion of the toolbar in the grid. - - -### [IgrGridToolbarAdvancedFiltering](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrGridToolbarAdvancedFiltering) -Provides a pre-configured button to open the advanced filtering dialog of the grid. - -- **overlaySettings**: `IgcOverlaySettings` - -### [IgrGridToolbarExporter](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrGridToolbarExporter) -Provides a pre-configured exporter component for the grid. - -- **exportCSV**: `boolean` — Show entry for CSV export. -- **exportExcel**: `boolean` — Show entry for Excel export. -- **exportPDF**: `boolean` — Show entry for PDF export. -- **filename**: `string` — The name for the exported file. -- **export**(type: GridToolbarExporterType): void — Export the grid's data - -### [IgrGridToolbarHiding](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrGridToolbarHiding) -Provides a pre-configured column hiding component for the grid. - -- **columnListHeight**: `string` — Sets the height of the column list in the dropdown. -- **overlaySettings**: `IgcOverlaySettings` — Sets overlay settings -- **prompt**: `string` — The placeholder text for the search input. -- **title**: `string` — Title text for the column action component - -### [IgrGridToolbarPinning](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrGridToolbarPinning) -Provides a pre-configured column pinning component for the grid. - -- **columnListHeight**: `string` — Sets the height of the column list in the dropdown. -- **overlaySettings**: `IgcOverlaySettings` — Sets overlay settings -- **prompt**: `string` — The placeholder text for the search input. -- **title**: `string` — Title text for the column action component - -### [IgrGridToolbarTitle](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrGridToolbarTitle) -Provides a way to template the title portion of the toolbar in the grid. - - -### [IgrHierarchicalGrid](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrHierarchicalGrid) -Hierarchical grid - -- **advancedFilteringExpressionsTree**: `IgcFilteringExpressionsTree` -- **childLayoutList**: `IgcRowIslandComponent[]` -- **data**: `any[]` — Gets/Sets the array of data that populates the component. -```html - -``` -- **expandChildren**: `boolean` — Sets if all immediate children of the `IgxHierarchicalGridComponent` should be expanded/collapsed. -Default value is false. -```html - -``` -- **hasChildrenKey**: `string` — Gets/Sets the key indicating whether a row has children. If row has no children it does not render an expand indicator. -- **id**: `string` — Gets/Sets the value of the `id` attribute. -- **resourceStrings**: `IgcGridResourceStrings` — Gets/Sets the resource strings. -- **rootGrid**: `IgcGridBaseDirective` -- **showExpandAll**: `boolean` — Gets/Sets whether the expand/collapse all button in the header should be rendered. -- **totalItemCount**: `number` — Gets/Sets the total number of records in the data source. -- **foreignKey**: `any` — Gets the unique identifier of the parent row. It may be a `string` or `number` if `primaryKey` of the -parent grid is set or an object reference of the parent record otherwise. -```typescript -const foreignKey = this.grid.foreignKey; -``` -- **selectedCells**: `any` — Returns an array of the selected `IgxGridCell`s. -- **getCellByColumn**(rowIndex: number, columnField: string): IgcCellType — Returns a CellType object that matches the conditions. -- **getCellByKey**(rowSelector: any, columnField: string): IgcCellType — Returns a CellType object that matches the conditions. -- **getDefaultExpandState**(record: any): void -- **getRowByIndex**(index: number): IgcRowType — Returns the RowType by index. -- **getRowByKey**(key: any): IgcRowType — Returns the RowType by key. -- **pinRow**(rowID: any, index?: number): boolean — Pin the row by its id. -- **unpinRow**(rowID: any): boolean — Unpin the row by its id. - -### [IgrNoopFilteringStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrNoopFilteringStrategy) - -- **constructor**(): IgcNoopFilteringStrategy -- **filter**(data: any[], _: IgcFilteringExpressionsTree, __?: IgcFilteringExpressionsTree): any[] -- static **instance**(): void - -### [IgrNoopPivotDimensionsStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrNoopPivotDimensionsStrategy) - -- **constructor**(): IgcNoopPivotDimensionsStrategy -- **process**(collection: any[], _: IgcPivotDimension[], __: IgcPivotValue[]): any[] -- static **instance**(): IgcNoopPivotDimensionsStrategy - -### [IgrNoopSortingStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrNoopSortingStrategy) -Represents a class implementing the IGridSortingStrategy interface with a no-operation sorting strategy. -It performs no sorting and returns the data as it is. - -- **constructor**(): IgcNoopSortingStrategy -- **sort**(data: any[]): any[] -- static **instance**(): IgcNoopSortingStrategy - -### [IgrNumberFilteringOperand](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrNumberFilteringOperand) -Provides filtering operations for numbers - -- **constructor**(): IgcNumberFilteringOperand - -### [IgrNumberSummaryOperand](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrNumberSummaryOperand) - -- **constructor**(): IgcNumberSummaryOperand -- **operate**(data?: any[], allData?: any[], fieldName?: string, groupRecord?: IgcGroupByRecord): IgcSummaryResult[] — Executes the static methods and returns IgxSummaryResult[]. -interface IgxSummaryResult { - key: string; - label: string; - summaryResult: any; -} - -Can be overridden in the inherited classes to provide customization for the summary. -class CustomNumberSummary extends IgxNumberSummaryOperand { - constructor() { - super(); - } - public operate(data: any[], allData: any[], fieldName: string, groupRecord: IGroupByRecord): IgxSummaryResult[] { - const result = super.operate(data, allData, fieldName, groupRecord); - result.push({ - key: "avg", - label: "Avg", - summaryResult: IgxNumberSummaryOperand.average(data) - }); - result.push({ - key: 'mdn', - label: 'Median', - summaryResult: this.findMedian(data) - }); - return result; - } -} -this.grid.getColumnByName('ColumnName').summaries = CustomNumberSummary; -- static **average**(data: any[]): number — Returns the average numeric value in the data provided data records. -If filtering is applied, returns the average numeric value in the filtered data records. -IgxSummaryOperand.average(data); -- static **max**(data: any[]): number — Returns the maximum numeric value in the provided data records. -If filtering is applied, returns the maximum value in the filtered data records. -IgxNumberSummaryOperand.max(data); -- static **min**(data: any[]): number — Returns the minimum numeric value in the provided data records. -If filtering is applied, returns the minimum value in the filtered data records. -IgxNumberSummaryOperand.min(data); -- static **sum**(data: any[]): number — Returns the sum of the numeric values in the provided data records. -If filtering is applied, returns the sum of the numeric values in the data records. -IgxNumberSummaryOperand.sum(data); - -### [IgrPaginator](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrPaginator) -Paginator component description - -- **overlaySettings**: `IgcOverlaySettings` — Sets custom OverlaySettings. -```html - -``` -- **page**: `number` — Gets/Sets the current page of the paginator. -The default is 0. -```typescript -let page = this.paginator.page; -``` -- **perPage**: `number` — Gets/Sets the number of visible items per page in the paginator. -The default is 15. -```typescript -let itemsPerPage = this.paginator.perPage; -``` -- **resourceStrings**: `IgcPaginatorResourceStrings` — An accessor that sets the resource strings. -By default it uses EN resources. -- **selectOptions**: `number[]` — Sets custom options in the select of the paginator -```typescript -let options = this.paginator.selectOptions; -``` -- **totalPages**: `number` — Total pages calculated from totalRecords and perPage -- **totalRecords**: `number` — Sets the total records. -```typescript -let totalRecords = this.paginator.totalRecords; -``` -- **isFirstPage**: `any` — Returns if the current page is the first page. -```typescript -const lastPage = this.paginator.isFirstPage; -``` -- **isLastPage**: `any` — Returns if the current page is the last page. -```typescript -const lastPage = this.paginator.isLastPage; -``` -- **nextPage**(): void — Goes to the next page of the IgxPaginatorComponent, if the paginator is not already at the last page. -this.paginator.nextPage(); -- **paginate**(val: number): void — Goes to the desired page index. -this.paginator.paginate(1); -- **previousPage**(): void — Goes to the previous page of the IgxPaginatorComponent, if the paginator is not already at the first page. -this.paginator.previousPage(); - -### [IgrPivotDataSelector](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrPivotDataSelector) -Pivot Data Selector provides means to configure the pivot state of the Pivot Grid via a vertical panel UI - -- **columnsExpanded**: `boolean` — Gets/sets whether the columns panel is expanded -Get -```typescript - const columnsPanelState: boolean = this.dataSelector.columnsExpanded; -``` -Set -```html - -``` - -Two-way data binding: -```html - -``` -- **filtersExpanded**: `boolean` — Gets/sets whether the filters panel is expanded -Get -```typescript - const filtersPanelState: boolean = this.dataSelector.filtersExpanded; -``` -Set -```html - -``` - -Two-way data binding: -```html - -``` -- **grid**: `IgcPivotGridComponent` — Sets the grid. -- **rowsExpanded**: `boolean` — Gets/sets whether the rows panel is expanded -Get -```typescript - const rowsPanelState: boolean = this.dataSelector.rowsExpanded; -``` -Set -```html - -``` - -Two-way data binding: -```html - -``` -- **valuesExpanded**: `boolean` — Gets/sets whether the values panel is expanded -Get -```typescript - const valuesPanelState: boolean = this.dataSelector.valuesExpanded; -``` -Set -```html - -``` - -Two-way data binding: -```html - -``` - -### [IgrPivotDateDimension](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrPivotDateDimension) -Configuration of a pivot dimension. - -- **constructor**(inBaseDimension?: IgcPivotDimension, inOptions?: IgcPivotDateDimensionOptions): IgcPivotDateDimension -- **dataType**: `GridColumnDataType` — Gets/Sets data type -- **displayName**: `string` — Display name to show instead of the field name of this value. * -- **baseDimension**: `IgcPivotDimension` -- **enabled**: `boolean` — Enables/Disables a particular dimension from pivot structure. -- **options**: `IgcPivotDateDimensionOptions` -- **resourceStrings**: `IgcGridResourceStrings` - -### [IgrPivotGrid](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrPivotGrid) -Pivot Grid provides a way to present and manipulate data in a pivot table view. - -- **autoGenerateConfig**: `boolean` — Gets/Sets whether to auto-generate the pivot configuration based on the provided data. -- **data**: `any[]` — Gets/Sets the array of data that populates the component. -```html - -``` -- **defaultExpandState**: `boolean` — Gets/Sets the default expand state for all rows. -- **emptyPivotGridTemplate**: `IgcRenderFunction` — Gets/Sets a custom template when pivot grid is empty. -- **pivotConfiguration**: `IgcPivotConfiguration` — Gets/Sets the pivot configuration with all related dimensions and values. -- **pivotUI**: `IgcPivotUISettings` -- **rowDimensionHeaderTemplate**: `IgcRenderFunction` -- **superCompactMode**: `boolean` — Enables a super compact theme for the component. -- **valueChipTemplate**: `IgcRenderFunction` — Gets/Sets a custom template for the value chips. -- **allDimensions**: `any` — Gets the full list of dimensions. -- **dimensionsSortingExpressions**: `any` — Gets the sorting expressions generated for the dimensions. -- **selectedRows**: `any` -- **autoSizeRowDimension**(dimension: IgcPivotDimension): void — Auto-sizes row dimension cells. -- **filterDimension**(dimension: IgcPivotDimension, value: any, conditionOrExpressionTree?: IgcFilteringExpressionsTree | IgcFilteringOperation): void — Filters a single IPivotDimension. -- **getColumnGroupExpandState**(col: IgcColumnComponent): void -- **insertDimensionAt**(dimension: IgcPivotDimension, targetCollectionType: PivotDimensionType, index?: number): void — Inserts dimension in target collection by type at specified index or at the collection's end. -- **insertValueAt**(value: IgcPivotValue, index?: number): void — Inserts value at specified index or at the end. -- **moveDimension**(dimension: IgcPivotDimension, targetCollectionType: PivotDimensionType, index?: number): void — Move dimension from its currently collection to the specified target collection by type at specified index or at the collection's end. -- **moveValue**(value: IgcPivotValue, index?: number): void — Move value from its currently at specified index or at the end. -- **notifyDimensionChange**(regenerateColumns?: boolean): void — Notifies for dimension change. -- **removeDimension**(dimension: IgcPivotDimension): void — Removes dimension from its currently collection. -- **removeValue**(value: IgcPivotValue): void — Removes value from collection. -- **sortDimension**(dimension: IgcPivotDimension, sortDirection: SortingDirection): void — Sort the dimension and its children in the provided direction. -- **toggleColumn**(col: IgcColumnComponent): void -- **toggleDimension**(dimension: IgcPivotDimension): void — Toggles the dimension's enabled state on or off. -- **toggleRowGroup**(col: IgcColumnComponent, newState: boolean): void -- **toggleValue**(value: IgcPivotValue): void — Toggles the value's enabled state on or off. - -### [IgrQueryBuilder](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrQueryBuilder) -A component used for operating with complex filters by creating or editing conditions and grouping them using AND/OR logic. It is used internally in the Advanced Filtering of the Grid. - -- **disableEntityChange**: `boolean` — Disables subsequent entity changes at the root level after the initial selection. -- **disableReturnFieldsChange**: `boolean` — Disables return fields changes at the root level. -- **entities**: `IgcEntityType[]` — Gets the list of entities available for the IgxQueryBuilderComponent. - -Each entity describes a logical group of fields that can be used in queries. -An entity can optionally have child entities, allowing nested sub-queries. -- **expressionTree**: `IgcExpressionTree` — Returns the expression tree. -- **locale**: `string` — Gets the `locale` of the query builder. -If not set, defaults to application's locale. -- **queryBuilderHeaderCollection**: `IgcQueryBuilderHeaderComponent[]` -- **resourceStrings**: `IgcQueryBuilderResourceStrings` — Sets the resource strings. -By default it uses EN resources. -- **searchValueTemplate**: `IgcRenderFunction` — Sets/gets the search value template. -- **showEntityChangeDialog**: `boolean` — Gets/sets whether the confirmation dialog should be shown when changing entity. -Default value is `true`. -- **canCommit**(): boolean — Returns whether the expression tree can be committed in the current state. -- **commit**(): void — Commits the expression tree in the current state if it is valid. If not throws an exception. -- **discard**(): void — Discards all unsaved changes to the expression tree. - -### [IgrQueryBuilderHeader](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrQueryBuilderHeader) - -- **resourceStrings**: `IgcQueryBuilderResourceStrings` — Sets the resource strings. -By default it uses EN resources. -- **showLegend**: `boolean` — Show/hide the legend. -- **title**: `string` — Sets the title of the `IgxQueryBuilderHeaderComponent`. - -### [IgrRowIsland](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrRowIsland) -Row island - -- **actionStripComponents**: `IgcActionStripToken[]` -- **addRowEmptyTemplate**: `IgcRenderFunction` — Gets/Sets a custom template for adding row UI when grid is empty. -- **advancedFilteringExpressionsTree**: `IgcFilteringExpressionsTree` — Gets/Sets the advanced filtering state. -- **allowAdvancedFiltering**: `boolean` — Gets/Sets a value indicating whether the advanced filtering is enabled. -- **allowFiltering**: `boolean` — Gets/Sets if the filtering is enabled. -- **autoGenerate**: `boolean` — Gets/Sets whether to auto-generate the columns. -- **autoGenerateExclude**: `string[]` — Gets/Sets a list of property keys to be excluded from the generated column collection -- **batchEditing**: `boolean` -- **cellMergeMode**: `GridCellMergeMode` — Gets/Sets cell merge mode. -- **cellSelection**: `GridSelectionMode` — Gets/Sets cell selection mode. -- **childDataKey**: `string` — Sets the key of the row island by which child data would be taken from the row data if such is provided. -- **childLayoutList**: `IgcRowIslandComponent[]` -- **clipboardOptions**: `IgcClipboardOptions` — Controls the copy behavior of the grid. -- **columnList**: `IgcColumnComponent[]` -- **columnSelection**: `GridSelectionMode` — Gets/Sets column selection mode -- **columnWidth**: `string` — Gets/Sets the default width of the columns. -- **dataCloneStrategy**: `IgcDataCloneStrategy` — Gets/Sets the data clone strategy of the grid when in edit mode. -- **dragGhostCustomTemplate**: `IgcRenderFunction` — Gets the custom template, if any, used for row drag ghost. -- **dragIndicatorIconTemplate**: `IgcRenderFunction` — The custom template, if any, that should be used when rendering the row drag indicator icon -- **emptyFilteredGridMessage**: `string` — Gets/Sets the message displayed when there are no records and the grid is filtered. -- **emptyGridMessage**: `string` — Get/Sets the message displayed when there are no records. -- **emptyGridTemplate**: `IgcRenderFunction` — Gets/Sets a custom template when empty. -- **excelStyleHeaderIconTemplate**: `IgcRenderFunction` — Gets the excel style header icon. -- **expandChildren**: `boolean` — Sets if all immediate children of the grids for this `IgxRowIslandComponent` should be expanded/collapsed. -```html - - - - - -``` -- **expansionStates**: `Map` — Gets/Sets a list of key-value pairs [row ID, expansion state]. -- **filteringExpressionsTree**: `IgcFilteringExpressionsTree` — Gets/Sets the filtering state. -- **filteringLogic**: `FilteringLogic` — Gets/Sets the filtering logic of the `IgxGridComponent`. -- **filterMode**: `FilterMode` — Gets/Sets the filter mode. -- **filterStrategy**: `IgcFilteringStrategy` — Gets/Sets the filtering strategy of the grid. -- **hasChildrenKey**: `string` — Gets/Sets the key indicating whether a row has children. If row has no children it does not render an expand indicator. -- **headerCollapsedIndicatorTemplate**: `IgcRenderFunction` — Gets the row collapse indicator template. -- **headerExpandedIndicatorTemplate**: `IgcRenderFunction` — Gets the header expand indicator template. -- **headSelectorTemplate**: `IgcRenderFunction` — Gets the header row selector template. -- **height**: `string` — Gets/Sets the height. -- **hideRowSelectors**: `boolean` — Gets/Sets if the row selectors are hidden. -- **isLoading**: `boolean` — Gets/Sets whether the grid is going to show a loading indicator. -- **loadingGridTemplate**: `IgcRenderFunction` — Gets/Sets a custom template when loading. -- **locale**: `string` — Gets/Sets the locale. -- **mergeStrategy**: `IgcGridMergeStrategy` — Gets/Sets the merge strategy of the grid. -- **moving**: `boolean` — Controls whether columns moving is enabled in the grid. -- **paginationComponents**: `IgcPaginatorComponent[]` -- **paginatorTemplate**: `IgcRenderFunction` — Sets/Gets the paginator template for each child grid created from this row island. -- **pagingMode**: `GridPagingMode` -- **pinning**: `IgcPinningConfig` — Gets/Sets the initial pinning configuration. -- **primaryKey**: `string` — Gets/Sets the primary key. -- **resourceStrings**: `IgcGridResourceStrings` — Gets/Sets the resource strings. -- **rowAddTextTemplate**: `IgcRenderFunction` — Gets the row add text template. -- **rowClasses**: `any` — Sets a conditional class selector to the grid's row element. -Accepts an object literal, containing key-value pairs, -where the key is the name of the CSS class and the value is -either a callback function that returns a boolean, or boolean, like so: -```typescript -callback = (row: RowType) => { return row.selected > 6; } -rowClasses = { 'className' : this.callback }; -``` -```html - -``` -- **rowCollapsedIndicatorTemplate**: `IgcRenderFunction` — Gets the row collapse indicator template. -- **rowDraggable**: `boolean` — Gets/Sets whether rows can be moved. -- **rowEditable**: `boolean` — Gets/Sets whether the rows are editable. -- **rowEditActionsTemplate**: `IgcRenderFunction` — Gets the row edit actions template. -- **rowEditTextTemplate**: `IgcRenderFunction` — Gets the row edit text template. -- **rowExpandedIndicatorTemplate**: `IgcRenderFunction` — Gets the row expand indicator template. -- **rowHeight**: `number` — Gets/Sets the row height. -- **rowSelection**: `GridSelectionMode` — Gets/Sets row selection mode -- **rowSelectorTemplate**: `IgcRenderFunction` — Gets the row selector template. -- **rowStyles**: `any` — Sets conditional style properties on the grid row element. -It accepts an object literal where the keys are -the style properties and the value is an expression to be evaluated. -```typescript -styles = { - background: 'yellow', - color: (row: RowType) => row.selected : 'red': 'white' -} -``` -```html - -``` -- **selectedRows**: `any[]` — Gets/Sets the current selection state. -- **selectRowOnClick**: `boolean` — Gets/Sets whether clicking over a row should select/deselect it -- **shouldGenerate**: `boolean` — Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid -- **showExpandAll**: `boolean` — Gets/Sets whether the expand/collapse all button in the header should be rendered. -- **showSummaryOnCollapse**: `boolean` — Controls whether the summary row is visible when groupBy/parent row is collapsed. -- **snackbarDisplayTime**: `number` — Gets/Sets the display time for the row adding snackbar notification. -- **sortAscendingHeaderIconTemplate**: `IgcRenderFunction` — The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in asc order. -- **sortDescendingHeaderIconTemplate**: `IgcRenderFunction` — The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in desc order. -- **sortHeaderIconTemplate**: `IgcRenderFunction` — Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted. -- **sortingExpressions**: `IgcSortingExpression[]` — Gets/Sets the sorting state. -- **sortingOptions**: `IgcSortingOptions` — Gets/Sets the sorting options - single or multiple sorting. -Accepts an `ISortingOptions` object with any of the `mode` properties. -- **sortStrategy**: `IgcGridSortingStrategy` — Gets/Sets the sorting strategy of the grid. -- **summaryCalculationMode**: `GridSummaryCalculationMode` — Gets/Sets the summary calculation mode. -- **summaryPosition**: `GridSummaryPosition` — Gets/Sets the summary position. -- **summaryRowHeight**: `number` — Get/Set IgxSummaryRow height -- **toolbar**: `IgcGridToolbarComponent[]` -- **toolbarTemplate**: `IgcRenderFunction` — Sets/Gets the toolbar template for each child grid created from this row island. -- **totalRecords**: `number` — Returns the total number of records. -- **validationTrigger**: `GridValidationTrigger` — Gets/Sets the trigger for validators used when editing the grid. -- **width**: `string` — Gets/Sets the width of the grid. -- **columns**: `any` — Gets an array of `IgxColumnComponent`s. -- **dataRowList**: `any` — A list of currently rendered `IgxGridRowComponent`'s. -- **defaultRowHeight**: `any` — Gets the default row height. -- **pinnedRows**: `any` — Gets an array of the pinned `IgxRowComponent`s. -- **rowList**: `any` — A list of `IgxGridRowComponent`. -- **addRow**(data: any): void — Creates a new IgxGridRowComponent and adds the data record to the end of the data source. -- **beginAddRowById**(rowID: any, asChild?: boolean): void — Enters add mode by spawning the UI under the specified row by rowID. -- **beginAddRowByIndex**(index: number): void — Enters add mode by spawning the UI at the specified index. -- **clearCellSelection**(): void — Deselect selected cells. -- **clearFilter**(name?: string): void — If name is provided, clears the filtering state of the corresponding IgxColumnComponent. -- **clearSearch**(): void — Removes all the highlights in the cell. -- **clearSort**(name?: string): void — If name is provided, clears the sorting state of the corresponding IgxColumnComponent. -- **closeAdvancedFilteringDialog**(applyChanges: boolean): void — Closes the advanced filtering dialog. -- **collapseAll**(): void — Collapses all rows. -- **collapseRow**(rowID: any): void — Collapses the row by its id. -- **deleteRow**(rowSelector: any): any — Removes the IgxGridRowComponent and the corresponding data record by primary key. -- **deselectAllColumns**(): void — Deselects all columns -- **deselectAllRows**(onlyFilterData?: boolean): void — Deselects all rows -- **deselectColumns**(columns: string[] | IgcColumnComponent[]): void — Deselect specified columns by field. -- **deselectRows**(rowIDs: any[]): void — Deselect specified rows by ID. -- **disableSummaries**(rest: any[]): void — Disable summaries for the specified column. -- **enableSummaries**(rest: any[]): void — Enables summaries for the specified column and applies your customSummary. -- **endEdit**(commit?: boolean, evt?: any): boolean — Finishes the row transactions on the current row and returns whether the grid editing was canceled. -- **expandAll**(): void — Expands all rows. -- **expandRow**(rowID: any): void — Expands the row by its id. -- **filter**(name: string, value: any, conditionOrExpressionTree?: IgcFilteringExpressionsTree | IgcFilteringOperation, ignoreCase?: boolean): void — Filters a single IgxColumnComponent. -- **filterGlobal**(value: any, condition: any, ignoreCase?: any): void — Filters all the IgxColumnComponent in the IgxGridComponent with the same condition. -- **findNext**(text: string, caseSensitive?: boolean, exactMatch?: boolean): number — Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible. -- **findPrev**(text: string, caseSensitive?: boolean, exactMatch?: boolean): number — Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible. -- **getColumnByName**(name: string): IgcColumnComponent — Returns the IgxColumnComponent by field name. -- **getColumnByVisibleIndex**(index: number): IgcColumnComponent -- **getHeaderGroupWidth**(column: IgcColumnComponent): string — Gets the width to be set on IgxGridHeaderGroupComponent. -- **getNextCell**(currRowIndex: number, curVisibleColIndex: number, callback?: any): IgcCellPosition — Returns ICellPosition which defines the next cell, -according to the current position, that match specific criteria. -- **getPinnedEndWidth**(takeHidden?: boolean): void — Gets calculated width of the pinned areas. -- **getPinnedStartWidth**(takeHidden?: boolean): void — Gets calculated width of the pinned areas. -- **getPreviousCell**(currRowIndex: number, curVisibleColIndex: number, callback?: any): IgcCellPosition — Returns ICellPosition which defines the previous cell, -according to the current position, that match specific criteria. -- **getRowData**(rowSelector: any): any — Returns the data that is contained in the row component. -- **getSelectedColumnsData**(formatters?: boolean, headers?: boolean): void — Returns an array of the current columns selection in the form of [{ column.field: cell.value }, ...]. -- **getSelectedData**(formatters?: boolean, headers?: boolean): void — Returns an array of the current cell selection in the form of [{ column.field: cell.value }, ...]. -- **getSelectedRanges**(): IgcGridSelectionRange[] — Get the currently selected ranges in the grid. -- **isRecordPinnedByIndex**(rowIndex: number): void — Returns whether the record is pinned or not. -- **markForCheck**(): void — Triggers change detection for the IgxGridComponent. -Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed. -May degrade performance if used when not needed, or if misused: -// DON'Ts: -// don't call markForCheck from inside a loop -// don't call markForCheck when a primitive has changed -grid.data.forEach(rec => { - rec = newValue; - grid.markForCheck(); -}); - -// DOs -// call markForCheck after updating a nested property -grid.data.forEach(rec => { - rec.nestedProp1.nestedProp2 = newValue; -}); -grid.markForCheck(); -- **moveColumn**(column: IgcColumnComponent, target: IgcColumnComponent, pos?: DropPosition): void — Places a column before or after the specified target column. -- **navigateTo**(rowIndex: number, visibleColIndex?: number, cb?: any): void — Navigates to a position in the grid based on provided rowindex and visibleColumnIndex. -- **openAdvancedFilteringDialog**(overlaySettings?: IgcOverlaySettings): void — Opens the advanced filtering dialog. -- **pinColumn**(columnName: string, index?: number, pinningPosition?: ColumnPinningPosition): boolean — Pins a column by field name. -- **pinRow**(rowID: any, index?: number, row?: IgcRowType): boolean — Pin the row by its id. -- **recalculateAutoSizes**(): void — Recalculates all widths of columns that have size set to auto. -- **refreshSearch**(updateActiveInfo?: boolean, endEdit?: boolean): number — Reapplies the existing search. -- **selectAllColumns**(): void — Selects all columns -- **selectAllRows**(onlyFilterData?: boolean): void — Selects all rows -- **selectColumns**(columns: string[] | IgcColumnComponent[], clearCurrentSelection?: boolean): void — Select specified columns. -- **selectedColumns**(): IgcColumnComponent[] — Get current selected columns. -- **selectRange**(arg: IgcGridSelectionRange[]): void — Select range(s) of cells between certain rows and columns of the grid. -- **selectRows**(rowIDs: any[], clearCurrentSelection?: boolean): void — Select specified rows by ID. -- **sort**(expression: IgcSortingExpression[]): void — Sort a single IgxColumnComponent. -- **toggleColumnVisibility**(args: IgcColumnVisibilityChangedEventArgs): void — Toggles the specified column's visibility. -- **toggleRow**(rowID: any): void — Toggles the row by its id. -- **unpinColumn**(columnName: string, index?: number): boolean — Unpins a column by field name. Returns whether the operation is successful. -- **unpinRow**(rowID: any, row?: IgcRowType): boolean — Unpin the row by its id. -- **updateCell**(value: any, rowSelector: any, column: string): void — Updates the IgxGridRowComponent and the corresponding data record by primary key. -- **updateRow**(value: any, rowSelector: any): void — Updates the IgxGridRowComponent - -### [IgrStringFilteringOperand](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrStringFilteringOperand) -Provides filtering operations for strings - -- **constructor**(): IgcStringFilteringOperand -- static **applyIgnoreCase**(a: string, ignoreCase: boolean): string — Applies case sensitivity on strings if provided - -### [IgrSummaryOperand](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrSummaryOperand) - -- **constructor**(): IgcSummaryOperand -- **operate**(data?: any[], _allData?: any[], _fieldName?: string, _groupRecord?: IgcGroupByRecord): IgcSummaryResult[] — Executes the static count method and returns IgxSummaryResult[]. -interface IgxSummaryResult { - key: string; - label: string; - summaryResult: any; -} - -Can be overridden in the inherited classes to provide customization for the summary. -class CustomSummary extends IgxSummaryOperand { - constructor() { - super(); - } - public operate(data: any[], allData: any[], fieldName: string, groupRecord: IGroupByRecord): IgxSummaryResult[] { - const result = []; - result.push({ - key: "test", - label: "Test", - summaryResult: IgxSummaryOperand.count(data) - }); - return result; - } -} -this.grid.getColumnByName('ColumnName').summaries = CustomSummary; -- static **count**(data: any[]): number — Counts all the records in the data source. -If filtering is applied, counts only the filtered records. -IgxSummaryOperand.count(dataSource); - -### [IgrTimeFilteringOperand](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrTimeFilteringOperand) - -- **constructor**(): IgcTimeFilteringOperand - -### [IgrTimeSummaryOperand](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrTimeSummaryOperand) - -- **constructor**(): IgcTimeSummaryOperand -- **operate**(data?: any[], allData?: any[], fieldName?: string, groupRecord?: IgcGroupByRecord): IgcSummaryResult[] -- static **earliestTime**(data: any[]): void — Returns the earliest time value in the data records. Compare only the time part of the date. -If filtering is applied, returns the earliest time value in the filtered data records. -IgxTimeSummaryOperand.earliestTime(data); -- static **latestTime**(data: any[]): void — Returns the latest time value in the data records. Compare only the time part of the date. -If filtering is applied, returns the latest time value in the filtered data records. -IgxTimeSummaryOperand.latestTime(data); - -### [IgrTreeGrid](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/classes/IgrTreeGrid) -**Ignite UI for Angular Tree Grid** - [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/grid) The Ignite UI Tree Grid displays and manipulates hierarchical data with consistent schema formatted as a table and provides features such as sorting, filtering, editing, column pinning, paging, column moving and hiding. Example: - -- **actionStripComponents**: `IgcActionStripToken[]` -- **addRowEmptyTemplate**: `IgcRenderFunction` — Gets/Sets a custom template for adding row UI when grid is empty. -- **advancedFilteringExpressionsTree**: `IgcFilteringExpressionsTree` — Gets/Sets the advanced filtering state. -- **allowAdvancedFiltering**: `boolean` — Gets/Sets a value indicating whether the advanced filtering is enabled. -- **allowFiltering**: `boolean` — Gets/Sets if the filtering is enabled. -- **autoGenerate**: `boolean` — Gets/Sets whether to auto-generate the columns. -- **autoGenerateExclude**: `string[]` — Gets/Sets a list of property keys to be excluded from the generated column collection -- **batchEditing**: `boolean` — Gets/Sets whether the grid has batch editing enabled. -When batch editing is enabled, changes are not made directly to the underlying data. -Instead, they are stored as transactions, which can later be committed w/ the `commit` method. -- **cascadeOnDelete**: `boolean` — Sets whether child records should be deleted when their parent gets deleted. -By default it is set to true and deletes all children along with the parent. -```html - - -``` -- **cellMergeMode**: `GridCellMergeMode` — Gets/Sets cell merge mode. -- **cellSelection**: `GridSelectionMode` — Gets/Sets cell selection mode. -- **childDataKey**: `string` — Sets the child data key of the `IgxTreeGridComponent`. -```html - -``` -- **clipboardOptions**: `IgcClipboardOptions` — Controls the copy behavior of the grid. -- **columnList**: `IgcColumnComponent[]` -- **columnSelection**: `GridSelectionMode` — Gets/Sets column selection mode -- **columnWidth**: `string` — Gets/Sets the default width of the columns. -- **data**: `any[]` — Gets/Sets the array of data that populates the component. -```html - -``` -- **dataCloneStrategy**: `IgcDataCloneStrategy` — Gets/Sets the data clone strategy of the grid when in edit mode. -- **dragGhostCustomTemplate**: `IgcRenderFunction` — Gets the custom template, if any, used for row drag ghost. -- **dragIndicatorIconTemplate**: `IgcRenderFunction` — The custom template, if any, that should be used when rendering the row drag indicator icon -- **emptyFilteredGridMessage**: `string` — Gets/Sets the message displayed when there are no records and the grid is filtered. -- **emptyGridMessage**: `string` — Get/Sets the message displayed when there are no records. -- **emptyGridTemplate**: `IgcRenderFunction` — Gets/Sets a custom template when empty. -- **excelStyleHeaderIconTemplate**: `IgcRenderFunction` — Gets the excel style header icon. -- **expansionDepth**: `number` — Sets the count of levels to be expanded in the `IgxTreeGridComponent`. By default it is -set to `Infinity` which means all levels would be expanded. -```html - -``` -- **expansionStates**: `Map` — Gets/Sets a list of key-value pairs [row ID, expansion state]. -- **filteringExpressionsTree**: `IgcFilteringExpressionsTree` — Gets/Sets the filtering state. -- **filteringLogic**: `FilteringLogic` — Gets/Sets the filtering logic of the `IgxGridComponent`. -- **filterMode**: `FilterMode` — Gets/Sets the filter mode. -- **filterStrategy**: `IgcFilteringStrategy` — Gets/Sets the filtering strategy of the grid. -- **foreignKey**: `string` — Sets the foreign key of the `IgxTreeGridComponent`. -```html - - -``` -- **hasChildrenKey**: `string` — Sets the key indicating whether a row has children. -This property is only used for load on demand scenarios. -```html - - -``` -- **headerCollapsedIndicatorTemplate**: `IgcRenderFunction` — Gets the row collapse indicator template. -- **headerExpandedIndicatorTemplate**: `IgcRenderFunction` — Gets the header expand indicator template. -- **headSelectorTemplate**: `IgcRenderFunction` — Gets the header row selector template. -- **height**: `string` — Gets/Sets the height. -- **hideRowSelectors**: `boolean` — Gets/Sets if the row selectors are hidden. -- **id**: `string` — Sets the value of the `id` attribute. If not provided it will be automatically generated. -```html - -``` -- **isLoading**: `boolean` — Gets/Sets whether the grid is going to show a loading indicator. -- **loadChildrenOnDemand**: `any` — Sets a callback for loading child rows on demand. -```html - - -``` -```typescript -public loadChildren = (parentID: any, done: (children: any[]) => void) => { - this.dataService.getData(parentID, children => done(children)); -} -``` -- **loadingGridTemplate**: `IgcRenderFunction` — Gets/Sets a custom template when loading. -- **locale**: `string` — Gets/Sets the locale. -- **mergeStrategy**: `IgcGridMergeStrategy` — Gets/Sets the merge strategy of the grid. -- **moving**: `boolean` — Controls whether columns moving is enabled in the grid. -- **outlet**: `IgcOverlayOutletDirective` — Gets/Sets the outlet used to attach the grid's overlays to. -- **paginationComponents**: `IgcPaginatorComponent[]` -- **pagingMode**: `GridPagingMode` -- **pinning**: `IgcPinningConfig` — Gets/Sets the initial pinning configuration. -- **primaryKey**: `string` — Gets/Sets the primary key. -- **processedRootRecords**: `IgcTreeGridRecord[]` — Returns an array of processed (filtered and sorted) root `ITreeGridRecord`s. -```typescript -// gets the processed root record with index=2 -const states = this.grid.processedRootRecords[2]; -``` -- **resourceStrings**: `IgcGridResourceStrings` — Gets/Sets the resource strings. -- **rootRecords**: `IgcTreeGridRecord[]` — Returns an array of the root level `ITreeGridRecord`s. -```typescript -// gets the root record with index=2 -const states = this.grid.rootRecords[2]; -``` -- **rowAddTextTemplate**: `IgcRenderFunction` — Gets the row add text template. -- **rowClasses**: `any` — Sets a conditional class selector to the grid's row element. -Accepts an object literal, containing key-value pairs, -where the key is the name of the CSS class and the value is -either a callback function that returns a boolean, or boolean, like so: -```typescript -callback = (row: RowType) => { return row.selected > 6; } -rowClasses = { 'className' : this.callback }; -``` -```html - -``` -- **rowCollapsedIndicatorTemplate**: `IgcRenderFunction` — Gets the row collapse indicator template. -- **rowDraggable**: `boolean` — Gets/Sets whether rows can be moved. -- **rowEditable**: `boolean` — Gets/Sets whether the rows are editable. -- **rowEditActionsTemplate**: `IgcRenderFunction` — Gets the row edit actions template. -- **rowEditTextTemplate**: `IgcRenderFunction` — Gets the row edit text template. -- **rowExpandedIndicatorTemplate**: `IgcRenderFunction` — Gets the row expand indicator template. -- **rowHeight**: `number` — Gets/Sets the row height. -- **rowLoadingIndicatorTemplate**: `IgcRenderFunction` — Template for the row loading indicator when load on demand is enabled. -```html - - loop - - - - -``` -- **rowSelection**: `GridSelectionMode` — Gets/Sets row selection mode -- **rowSelectorTemplate**: `IgcRenderFunction` — Gets the row selector template. -- **rowStyles**: `any` — Sets conditional style properties on the grid row element. -It accepts an object literal where the keys are -the style properties and the value is an expression to be evaluated. -```typescript -styles = { - background: 'yellow', - color: (row: RowType) => row.selected : 'red': 'white' -} -``` -```html - -``` -- **selectedRows**: `any[]` — Gets/Sets the current selection state. -- **selectRowOnClick**: `boolean` — Gets/Sets whether clicking over a row should select/deselect it -- **shouldGenerate**: `boolean` — Gets/Sets whether the columns should be auto-generated once again after the initialization of the grid -- **showSummaryOnCollapse**: `boolean` — Controls whether the summary row is visible when groupBy/parent row is collapsed. -- **snackbarDisplayTime**: `number` — Gets/Sets the display time for the row adding snackbar notification. -- **sortAscendingHeaderIconTemplate**: `IgcRenderFunction` — The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in asc order. -- **sortDescendingHeaderIconTemplate**: `IgcRenderFunction` — The custom template, if any, that should be used when rendering a header sorting indicator when columns are sorted in desc order. -- **sortHeaderIconTemplate**: `IgcRenderFunction` — Gets custom template, if any, that should be used when rendering a header sorting indicator when columns are not sorted. -- **sortingExpressions**: `IgcSortingExpression[]` — Gets/Sets the sorting state. -- **sortingOptions**: `IgcSortingOptions` — Gets/Sets the sorting options - single or multiple sorting. -Accepts an `ISortingOptions` object with any of the `mode` properties. -- **sortStrategy**: `IgcGridSortingStrategy` — Gets/Sets the sorting strategy of the grid. -- **summaryCalculationMode**: `GridSummaryCalculationMode` — Gets/Sets the summary calculation mode. -- **summaryPosition**: `GridSummaryPosition` — Gets/Sets the summary position. -- **summaryRowHeight**: `number` — Get/Set IgxSummaryRow height -- **toolbar**: `IgcGridToolbarComponent[]` -- **totalRecords**: `number` — Returns the total number of records. -- **validationTrigger**: `GridValidationTrigger` — Gets/Sets the trigger for validators used when editing the grid. -- **width**: `string` — Gets/Sets the width of the grid. -- **columns**: `any` — Gets an array of `IgxColumnComponent`s. -- **dataRowList**: `any` — A list of currently rendered `IgxGridRowComponent`'s. -- **dataView**: `any` — Returns the currently transformed paged/filtered/sorted/grouped/pinned/unpinned row data, displayed in the grid. -- **defaultRowHeight**: `any` — Gets the default row height. -- **filteredData**: `any` — Returns an array of objects containing the filtered data. -- **filteredSortedData**: `any` — Returns an array containing the filtered sorted data. -- **hiddenColumnsCount**: `any` — Gets the number of hidden columns. -- **lastSearchInfo**: `any` — Represents the last search information. -- **pinnedColumns**: `any` — Gets an array of the pinned `IgxColumnComponent`s. -- **pinnedColumnsCount**: `any` — Gets the number of pinned columns. -- **pinnedEndColumns**: `any` — Gets an array of the pinned to the right `IgxColumnComponent`s. -- **pinnedRows**: `any` — Gets an array of the pinned `IgxRowComponent`s. -- **pinnedStartColumns**: `any` — Gets an array of the pinned to the left `IgxColumnComponent`s. -- **rowList**: `any` — A list of `IgxGridRowComponent`. -- **selectedCells**: `any` — Returns an array of the selected `IgxGridCell`s. -- **unpinnedColumns**: `any` — Gets an array of unpinned `IgxColumnComponent`s. -- **virtualizationState**: `any` — Returns the state of the grid virtualization. -- **visibleColumns**: `any` — Returns an array of visible `IgxColumnComponent`s. -- **addRow**(data: any, parentRowID?: any): void — Creates a new IgxTreeGridRowComponent with the given data. If a parentRowID is not specified, the newly created -row would be added at the root level. Otherwise, it would be added as a child of the row whose primaryKey matches -the specified parentRowID. If the parentRowID does not exist, an error would be thrown. -const record = { - ID: this.grid.data[this.grid1.data.length - 1].ID + 1, - Name: this.newRecord -}; -this.grid.addRow(record, 1); // Adds a new child row to the row with ID=1. -- **addRow**(data: any): void — Creates a new IgxGridRowComponent and adds the data record to the end of the data source. -- **beginAddRowById**(rowID: any, asChild?: boolean): void — Enters add mode by spawning the UI under the specified row by rowID. -- **beginAddRowByIndex**(index: number, asChild?: boolean): void — Enters add mode by spawning the UI with the context of the specified row by index. -- **beginAddRowByIndex**(index: number): void — Enters add mode by spawning the UI at the specified index. -- **clearCellSelection**(): void — Deselect selected cells. -- **clearFilter**(name?: string): void — If name is provided, clears the filtering state of the corresponding IgxColumnComponent. -- **clearSearch**(): void — Removes all the highlights in the cell. -- **clearSort**(name?: string): void — If name is provided, clears the sorting state of the corresponding IgxColumnComponent. -- **closeAdvancedFilteringDialog**(applyChanges: boolean): void — Closes the advanced filtering dialog. -- **collapseAll**(): void — Collapses all rows. - -this.grid.collapseAll(); -- **collapseAll**(): void — Collapses all rows. -- **collapseRow**(rowID: any): void — Collapses the row by its id. -- **deleteRow**(rowSelector: any): any — Removes the IgxGridRowComponent and the corresponding data record by primary key. -- **deselectAllColumns**(): void — Deselects all columns -- **deselectAllRows**(onlyFilterData?: boolean): void — Deselects all rows -- **deselectColumns**(columns: string[] | IgcColumnComponent[]): void — Deselect specified columns by field. -- **deselectRows**(rowIDs: any[]): void — Deselect specified rows by ID. -- **disableSummaries**(rest: any[]): void — Disable summaries for the specified column. -- **enableSummaries**(rest: any[]): void — Enables summaries for the specified column and applies your customSummary. -- **endEdit**(commit?: boolean, evt?: any): boolean — Finishes the row transactions on the current row and returns whether the grid editing was canceled. -- **expandAll**(): void — Expands all rows. -this.grid.expandAll(); -- **expandAll**(): void — Expands all rows. -- **expandRow**(rowID: any): void — Expands the row by its id. -- **filter**(name: string, value: any, conditionOrExpressionTree?: IgcFilteringExpressionsTree | IgcFilteringOperation, ignoreCase?: boolean): void — Filters a single IgxColumnComponent. -- **filterGlobal**(value: any, condition: any, ignoreCase?: any): void — Filters all the IgxColumnComponent in the IgxGridComponent with the same condition. -- **findNext**(text: string, caseSensitive?: boolean, exactMatch?: boolean): number — Finds the next occurrence of a given string in the grid and scrolls to the cell if it isn't visible. -- **findPrev**(text: string, caseSensitive?: boolean, exactMatch?: boolean): number — Finds the previous occurrence of a given string in the grid and scrolls to the cell if it isn't visible. -- **getCellByColumn**(rowIndex: number, columnField: string): IgcCellType — Returns a CellType object that matches the conditions. -- **getCellByKey**(rowSelector: any, columnField: string): IgcCellType — Returns a CellType object that matches the conditions. -- **getColumnByName**(name: string): IgcColumnComponent — Returns the IgxColumnComponent by field name. -- **getColumnByVisibleIndex**(index: number): IgcColumnComponent -- **getDefaultExpandState**(record: IgcTreeGridRecord): boolean -- **getHeaderGroupWidth**(column: IgcColumnComponent): string — Gets the width to be set on IgxGridHeaderGroupComponent. -- **getNextCell**(currRowIndex: number, curVisibleColIndex: number, callback?: any): IgcCellPosition — Returns ICellPosition which defines the next cell, -according to the current position, that match specific criteria. -- **getPinnedEndWidth**(takeHidden?: boolean): void — Gets calculated width of the pinned areas. -- **getPinnedStartWidth**(takeHidden?: boolean): void — Gets calculated width of the pinned areas. -- **getPreviousCell**(currRowIndex: number, curVisibleColIndex: number, callback?: any): IgcCellPosition — Returns ICellPosition which defines the previous cell, -according to the current position, that match specific criteria. -- **getRowByIndex**(index: number): IgcRowType — Returns the IgxTreeGridRow by index. -- **getRowByKey**(key: any): IgcRowType — Returns the RowType object by the specified primary key. -- **getRowData**(rowSelector: any): any — Returns the data that is contained in the row component. -- **getSelectedColumnsData**(formatters?: boolean, headers?: boolean): void — Returns an array of the current columns selection in the form of [{ column.field: cell.value }, ...]. -- **getSelectedData**(formatters?: boolean, headers?: boolean): any[] — Returns an array of the current cell selection in the form of [{ column.field: cell.value }, ...]. -- **getSelectedData**(formatters?: boolean, headers?: boolean): void — Returns an array of the current cell selection in the form of [{ column.field: cell.value }, ...]. -- **getSelectedRanges**(): IgcGridSelectionRange[] — Get the currently selected ranges in the grid. -- **isRecordPinnedByIndex**(rowIndex: number): void — Returns whether the record is pinned or not. -- **markForCheck**(): void — Triggers change detection for the IgxGridComponent. -Calling markForCheck also triggers the grid pipes explicitly, resulting in all updates being processed. -May degrade performance if used when not needed, or if misused: -// DON'Ts: -// don't call markForCheck from inside a loop -// don't call markForCheck when a primitive has changed -grid.data.forEach(rec => { - rec = newValue; - grid.markForCheck(); -}); - -// DOs -// call markForCheck after updating a nested property -grid.data.forEach(rec => { - rec.nestedProp1.nestedProp2 = newValue; -}); -grid.markForCheck(); -- **moveColumn**(column: IgcColumnComponent, target: IgcColumnComponent, pos?: DropPosition): void — Places a column before or after the specified target column. -- **navigateTo**(rowIndex: number, visibleColIndex?: number, cb?: any): void — Navigates to a position in the grid based on provided rowindex and visibleColumnIndex. -- **openAdvancedFilteringDialog**(overlaySettings?: IgcOverlaySettings): void — Opens the advanced filtering dialog. -- **pinColumn**(columnName: string, index?: number, pinningPosition?: ColumnPinningPosition): boolean — Pins a column by field name. -- **pinRow**(rowID: any, index?: number): boolean — Pin the row by its id. -- **pinRow**(rowID: any, index?: number, row?: IgcRowType): boolean — Pin the row by its id. -- **recalculateAutoSizes**(): void — Recalculates all widths of columns that have size set to auto. -- **reflow**(): void — Recalculates grid width/height dimensions. -- **refreshSearch**(updateActiveInfo?: boolean, endEdit?: boolean): number — Reapplies the existing search. -- **selectAllColumns**(): void — Selects all columns -- **selectAllRows**(onlyFilterData?: boolean): void — Selects all rows -- **selectColumns**(columns: string[] | IgcColumnComponent[], clearCurrentSelection?: boolean): void — Select specified columns. -- **selectedColumns**(): IgcColumnComponent[] — Get current selected columns. -- **selectRange**(arg: IgcGridSelectionRange[]): void — Select range(s) of cells between certain rows and columns of the grid. -- **selectRows**(rowIDs: any[], clearCurrentSelection?: boolean): void — Select specified rows by ID. -- **sort**(expression: IgcSortingExpression[]): void — Sort a single IgxColumnComponent. -- **toggleColumnVisibility**(args: IgcColumnVisibilityChangedEventArgs): void — Toggles the specified column's visibility. -- **toggleRow**(rowID: any): void — Toggles the row by its id. -- **unpinColumn**(columnName: string, index?: number): boolean — Unpins a column by field name. Returns whether the operation is successful. -- **unpinRow**(rowID: any): boolean — Unpin the row by its id. -- **unpinRow**(rowID: any, row?: IgcRowType): boolean — Unpin the row by its id. -- **updateCell**(value: any, rowSelector: any, column: string): void — Updates the IgxGridRowComponent and the corresponding data record by primary key. -- **updateRow**(value: any, rowSelector: any): void — Updates the IgxGridRowComponent - -## Interfaces - -### [CustomEvent](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/CustomEvent) -[MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent) - -- **detail**: `T` — Returns any custom data event was created with. Typically used for synthetic events. - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent/detail) - -### [IActionStripResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IActionStripResourceStrings) - -- **action_strip_button_more_title?**: `string` - -### [IBannerResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IBannerResourceStrings) - -- **banner_button_dismiss?**: `string` - -### [ICalendarResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/ICalendarResourceStrings) - -- **calendar_first_picker_of?**: `string` -- **calendar_multi_selection?**: `string` -- **calendar_next_month?**: `string` -- **calendar_next_year?**: `string` -- **calendar_next_years?**: `string` -- **calendar_previous_month?**: `string` -- **calendar_previous_year?**: `string` -- **calendar_previous_years?**: `string` -- **calendar_range_end?**: `string` -- **calendar_range_label_end?**: `string` -- **calendar_range_label_start?**: `string` -- **calendar_range_placeholder?**: `string` -- **calendar_range_selection?**: `string` -- **calendar_range_start?**: `string` -- **calendar_select_date?**: `string` -- **calendar_select_month?**: `string` -- **calendar_select_year?**: `string` -- **calendar_selected_month_is?**: `string` -- **calendar_single_selection?**: `string` -- **calendar_singular_multi_selection?**: `string` -- **calendar_singular_range_selection?**: `string` -- **calendar_singular_single_selection?**: `string` - -### [ICarouselResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/ICarouselResourceStrings) - -- **carousel_next_slide?**: `string` -- **carousel_of?**: `string` -- **carousel_previous_slide?**: `string` -- **carousel_slide?**: `string` - -### [IChipResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IChipResourceStrings) - -- **chip_remove?**: `string` -- **chip_select?**: `string` - -### [IComboResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IComboResourceStrings) - -- **combo_addCustomValues_placeholder?**: `string` -- **combo_aria_label_no_options?**: `string` -- **combo_aria_label_options?**: `string` -- **combo_clearItems_placeholder?**: `string` -- **combo_empty_message?**: `string` -- **combo_filter_search_placeholder?**: `string` - -### [IDatePickerResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IDatePickerResourceStrings) - -- **date_picker_change_date?**: `string` -- **date_picker_choose_date?**: `string` - -### [IDateRangePickerResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IDateRangePickerResourceStrings) - -- **date_range_picker_cancel_button?**: `string` -- **date_range_picker_currentMonth?**: `string` -- **date_range_picker_date_separator?**: `string` -- **date_range_picker_done_button?**: `string` -- **date_range_picker_last30Days?**: `string` -- **date_range_picker_last7Days?**: `string` -- **date_range_picker_yearToDate?**: `string` - -### [IFileInputResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IFileInputResourceStrings) - -- **file_input_placeholder?**: `string` -- **file_input_upload_button?**: `string` - -### [IgrActionStripResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrActionStripResourceStrings) - -- **igx_action_strip_button_more_title?**: `string` - -### [IgrActiveNodeChangeEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrActiveNodeChangeEventArgsDetail) -Emitted when the active node is changed - -- **column**: `number` — Represents the column index of the active node -- **level?**: `number` — Optional -Represents the hierarchical level of the active node -- **row**: `number` — Represents the row index of the active node -- **tag**: `GridKeydownTargetType` — Represents the type of the active node. -The GridKeydownTargetType is an enum or that specifies the possible target types - -### [IgrBaseEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrBaseEventArgsDetail) - -- **owner?**: `any` — Provides reference to the owner component. - -### [IgrBaseExporter](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrBaseExporter) - -- **export**: `any` -- **exportData**: `any` - -### [IgrBaseFilteringStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrBaseFilteringStrategy) - -- **filter**: `any` -- **findMatchByExpression**: `any` -- **getFilterItems**: `any` -- **matchRecord**: `any` - -### [IgrBaseSearchInfo](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrBaseSearchInfo) - -- **caseSensitive**: `any` -- **content**: `any` -- **exactMatch**: `any` -- **matchCount**: `any` -- **searchText**: `any` - -### [IgrCancelableBrowserEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrCancelableBrowserEventArgsDetail) - - -### [IgrCancelableEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrCancelableEventArgsDetail) - -- **cancel**: `boolean` — Provides the ability to cancel the event. - -### [IgrCellPosition](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrCellPosition) -The event is triggered when getting the current position of a certain cell - -- **rowIndex**: `any` -- **visibleColumnIndex**: `any` - -### [IgrCellTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrCellTemplateContext) - -- **additionalTemplateContext**: `any` -- **cell**: `any` -- **implicit**: `any` - -### [IgrCellType](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrCellType) -Interface representing a cell in the grid. It is essentially the blueprint to a cell object. -Contains definitions of properties and methods, relevant to a cell - -- **cellID?**: `any` — Optional; The cellID is the unique key, used to identify the cell -- **id?**: `any` — Optional; An object identifying the cell. It contains rowID, columnID, and rowIndex of the cell. -- **readonly?**: `boolean` -- **title?**: `any` — An optional title to display for the cell -- **validation?**: `IgcGridValidationState` — Optional; An object representing the validation state of the cell. -Whether it's valid or invalid, and if it has errors -- **visibleColumnIndex?**: `number` — The index of the column that the cell belongs to. It counts only the visible (not hidden) columns -- **active**: `any` -- **column**: `any` -- **editable**: `any` -- **editMode**: `any` -- **editValue**: `any` -- **grid**: `any` -- **row**: `any` -- **selected**: `any` -- **value**: `any` -- **width**: `any` -- **calculateSizeToFit?**: `any` -- **setEditMode?**: `any` -- **update**: `any` - -### [IgrClipboardOptions](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrClipboardOptions) -An interface describing settings for clipboard options - -- **copyFormatters**: `any` -- **copyHeaders**: `any` -- **enabled**: `any` -- **separator**: `any` - -### [IgrColumnEditorOptions](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrColumnEditorOptions) - - -### [IgrColumnExportingEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrColumnExportingEventArgsDetail) -columnExporting event arguments -this.exporterService.columnExporting.subscribe((args: IColumnExportingEventArgs) => { -// set args properties here -}); - -- **cancel**: `boolean` — Skip the exporting column when set to true -- **columnIndex**: `number` — Contains the exporting column index -- **field**: `string` — Contains the exporting column field name -- **grid?**: `IgcGridBaseDirective` — A reference to the grid owner. -- **header**: `string` — Contains the exporting column header -- **skipFormatter**: `boolean` — Export the column's data without applying its formatter, when set to true - -### [IgrColumnMovingEndEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrColumnMovingEndEventArgsDetail) -Represents event arguments related to the end of a column moving operation in a grid - -- **cancel**: `boolean` — cancel returns whether the event has been intercepted and stopped -If the value becomes "true", it returns/exits from the method, instantiating the interface -- **source**: `IgcColumnComponent` — The source of the event represents the column that is being moved. -The ColumnType contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties -- **target**: `IgcColumnComponent` — The target of the event represents the column, the source is being moved to. -The ColumnType contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties - -### [IgrColumnMovingEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrColumnMovingEventArgsDetail) -Represents event arguments related to a column moving operation in a grid - -- **cancel**: `boolean` — cancel returns whether the event has been intercepted and stopped -If the value becomes "true", it returns/exits from the method, instantiating the interface -- **source**: `IgcColumnComponent` — Represents the column that is being moved. -The ColumnType contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties - -### [IgrColumnMovingStartEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrColumnMovingStartEventArgsDetail) -Represents event arguments related to the start of a column moving operation in a grid. - -- **source**: `IgcColumnComponent` — Represents the column that is being moved. -The ColumnType contains the information (the grid it belongs to, css data, settings, etc.) of the column in its properties - -### [IgrColumnPipeArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrColumnPipeArgs) - - -### [IgrColumnResizeEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrColumnResizeEventArgsDetail) -The event arguments when a column is being resized - -- **column**: `IgcColumnComponent` — Represents the information of the column that is being resized -- **newWidth**: `string` — Represents the new width, the column is being resized to -- **prevWidth**: `string` — Represents the old width of the column before the resizing - -### [IgrColumnSelectionEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrColumnSelectionEventArgsDetail) -The event arguments when the selection state of a column is being changed -The event is cancelable - -- **added**: `string[]` — Represents an array of all added columns -Whenever a column has been selected, the array is "refreshed" with the selected columns -- **cancel**: `boolean` — Provides the ability to cancel the event. -- **newSelection**: `string[]` — Represents the newly selected columns -- **oldSelection**: `string[]` — Represents an array of columns, that have already been selected -- **owner?**: `any` — Provides reference to the owner component. -- **removed**: `string[]` — Represents an array of all columns, removed from the selection -Whenever a column has been deselected, the array is "refreshed" with the columns, that have been previously selected, but are no longer - -### [IgrColumnState](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrColumnState) - -- **colEnd?**: `number` -- **collapsible?**: `boolean` -- **colStart?**: `number` -- **columnLayout?**: `boolean` -- **expanded?**: `boolean` -- **parent?**: `any` -- **rowEnd?**: `number` -- **rowStart?**: `number` -- **visibleWhenCollapsed?**: `boolean` -- **columnGroup**: `any` -- **dataType**: `any` -- **disableHiding**: `any` -- **disablePinning**: `any` -- **editable**: `any` -- **field**: `any` -- **filterable**: `any` -- **filteringIgnoreCase**: `any` -- **groupable**: `any` -- **hasSummary**: `any` -- **header**: `any` -- **headerClasses**: `any` -- **headerGroupClasses**: `any` -- **hidden**: `any` -- **key**: `any` -- **maxWidth**: `any` -- **parentKey**: `any` -- **pinned**: `any` -- **resizable**: `any` -- **searchable**: `any` -- **sortable**: `any` -- **sortingIgnoreCase**: `any` -- **width**: `any` - -### [IgrColumnTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrColumnTemplateContext) - -- **column**: `any` -- **implicit**: `any` - -### [IgrColumnToggledEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrColumnToggledEventArgsDetail) -Event emitted when a checkbox in the checkbox -list of an IgxColumnActions component is clicked. - -- **checked**: `boolean` — The checked state after the action. -- **column**: `IgcColumnComponent` — The column that is toggled. - -### [IgrColumnVisibilityChangedEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrColumnVisibilityChangedEventArgsDetail) -The event arguments after a column's visibility is changed. - -- **column**: `any` — Represents the column the event originated from -- **newValue**: `boolean` — The new hidden state that the column will have, if operation is successful. -Will be true when hiding and false when showing. - -### [IgrColumnVisibilityChangingEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrColumnVisibilityChangingEventArgsDetail) -The event arguments when a column's visibility is changed. -The event is cancelable -It contains information about the column and the it's visibility after the operation (will be true when hiding and false when showing) - -- **cancel**: `boolean` — Provides the ability to cancel the event. -- **column**: `any` — Represents the column the event originated from -- **newValue**: `boolean` — The new hidden state that the column will have, if operation is successful. -Will be true when hiding and false when showing. - -### [IgrDataCloneStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrDataCloneStrategy) - -- **clone**: `any` - -### [IgrDimensionsChange](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrDimensionsChange) -Event emitted when dimension collection for rows, columns of filters is changed. - -- **dimensionCollectionType**: `any` -- **dimensions**: `any` - -### [IgrEntityType](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrEntityType) -Describes an entity in the QueryBuilder. -An entity represents a logical grouping of fields and can have nested child entities. - -- **childEntities?**: `IgcEntityType[]` — Optional child entities. -This allows building hierarchical or nested query structures. -- **fields**: `any` -- **name**: `any` - -### [IgrExporterEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrExporterEventArgsDetail) - -- **cancel**: `any` -- **exporter**: `any` -- **grid**: `any` -- **options**: `any` - -### [IgrExporterOptions](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrExporterOptions) - - -### [IgrExporterOptionsBase](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrExporterOptionsBase) - -- **alwaysExportHeaders**: `any` -- **exportSummaries**: `any` -- **fileName**: `any` -- **freezeHeaders**: `any` -- **ignoreColumnsOrder**: `any` -- **ignoreColumnsVisibility**: `any` -- **ignoreFiltering**: `any` -- **ignoreGrouping**: `any` -- **ignoreMultiColumnHeaders**: `any` -- **ignoreSorting**: `any` - -### [IgrExpressionTree](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrExpressionTree) - -- **entity?**: `string` -- **fieldName?**: `string` -- **returnFields?**: `string[]` -- **filteringOperands**: `any` -- **operator**: `any` - -### [IgrFieldEditorOptions](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrFieldEditorOptions) - -- **dateTimeFormat?**: `string` — A custom input format string used for the built-in editors of date/time columns. -See the Editing section under https://www.infragistics.com/products/ignite-ui-angular/angular/components/grid/column-types#datetime-date-and-time - -### [IgrFieldPipeArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrFieldPipeArgs) - -- **currencyCode?**: `string` — The currency code of type string, default value undefined -- **digitsInfo?**: `string` — Decimal representation options, specified by a string in the following format: -{minIntegerDigits}.{minFractionDigits}-{maxFractionDigits}. -minIntegerDigits: The minimum number of integer digits before the decimal point. Default is 1. -minFractionDigits: The minimum number of digits after the decimal point. Default is 0. -maxFractionDigits: The maximum number of digits after the decimal point. Default is 3. -- **display?**: `string` — Allow us to display currency 'symbol' or 'code' or 'symbol-narrow' or our own string. -The value is of type string. By default is set to 'symbol' -- **format?**: `string` — The date/time components that a date column will display, using predefined options or a custom format string. -- **timezone?**: `string` — A timezone offset (such as '+0430'), or a standard UTC/GMT or continental US timezone abbreviation. -- **weekStart?**: `number` — The first week day to be displayed in calendar when filtering or editing a date column - -### [IgrFieldType](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrFieldType) -Describes a field that can be used in the Grid and QueryBuilder components. - -- **defaultDateTimeFormat?**: `string` — Default date/time format for Date/Time fields. -- **defaultTimeFormat?**: `string` — Default time format for Date/Time fields. -- **editorOptions?**: `IgcFieldEditorOptions` — Options for the editor associated with this field. -- **filters?**: `IgcFilteringOperand` — Optional filtering operands that apply to this field. -- **header?**: `string` — Optional column header for UI display purposes. -- **label?**: `string` — Display label for the field. -- **pipeArgs?**: `IgcFieldPipeArgs` — Optional arguments for any pipe applied to the field. -- **dataType**: `any` -- **field**: `any` -- **formatter?**: `any` - -### [IgrFilteringEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrFilteringEventArgsDetail) -Represents event arguments related to filtering operations -The event is cancelable - -- **cancel**: `boolean` — Provides the ability to cancel the event. -- **filteringExpressions**: `IgcFilteringExpressionsTree` — Represents the filtering expressions applied to the grid. -The expression contains information like filtering operands and operator, an expression or condition, etc. -- **owner?**: `any` — Provides reference to the owner component. - -### [IgrFilteringExpression](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrFilteringExpression) -Represents filtering expressions. - -- **condition?**: `IgcFilteringOperation` -- **conditionName?**: `string` -- **ignoreCase?**: `boolean` -- **searchTree?**: `IgcExpressionTree` -- **searchVal?**: `any` -- **fieldName**: `any` - -### [IgrFilteringOperation](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrFilteringOperation) -Interface describing filtering operations - -- **hidden?**: `boolean` -- **isNestedQuery?**: `boolean` -- **logic?**: `any` -- **iconName**: `any` -- **isUnary**: `any` -- **name**: `any` - -### [IgrFilteringStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrFilteringStrategy) - -- **filter**: `any` -- **getFilterItems**: `any` - -### [IgrFilterItem](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrFilterItem) - -- **children?**: `IgcFilterItem[]` -- **label?**: `string` -- **value**: `any` - -### [IgrForOfDataChangeEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrForOfDataChangeEventArgsDetail) - - -### [IgrForOfDataChangingEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrForOfDataChangingEventArgsDetail) - -- **containerSize**: `number` -- **state**: `IgcForOfState` - -### [IgrForOfState](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrForOfState) - -- **chunkSize?**: `number` -- **startIndex?**: `number` - -### [IgrGridActionsBaseDirective](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridActionsBaseDirective) -Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it. - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement) - -- **asMenuItems**: `any` - -### [IgrGridBaseDirective](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridBaseDirective) - -- **actionStripComponents**: `any` -- **addRowEmptyTemplate**: `any` -- **advancedFilteringExpressionsTree**: `any` -- **allowAdvancedFiltering**: `any` -- **allowFiltering**: `any` -- **autoGenerate**: `any` -- **autoGenerateExclude**: `any` -- **batchEditing**: `any` -- **cellMergeMode**: `any` -- **cellSelection**: `any` -- **clipboardOptions**: `any` -- **columnList**: `any` -- **columns**: `any` -- **columnSelection**: `any` -- **columnWidth**: `any` -- **dataCloneStrategy**: `any` -- **dataRowList**: `any` -- **dataView**: `any` -- **defaultRowHeight**: `any` -- **dragGhostCustomTemplate**: `any` -- **dragIndicatorIconTemplate**: `any` -- **emptyFilteredGridMessage**: `any` -- **emptyGridMessage**: `any` -- **emptyGridTemplate**: `any` -- **excelStyleHeaderIconTemplate**: `any` -- **expansionStates**: `any` -- **filteredData**: `any` -- **filteredSortedData**: `any` -- **filteringExpressionsTree**: `any` -- **filteringLogic**: `any` -- **filterMode**: `any` -- **filterStrategy**: `any` -- **headerCollapsedIndicatorTemplate**: `any` -- **headerExpandedIndicatorTemplate**: `any` -- **headSelectorTemplate**: `any` -- **height**: `any` -- **hiddenColumnsCount**: `any` -- **hideRowSelectors**: `any` -- **isLoading**: `any` -- **lastSearchInfo**: `any` -- **loadingGridTemplate**: `any` -- **locale**: `any` -- **mergeStrategy**: `any` -- **moving**: `any` -- **outlet**: `any` -- **paginationComponents**: `any` -- **pagingMode**: `any` -- **pinnedColumns**: `any` -- **pinnedColumnsCount**: `any` -- **pinnedEndColumns**: `any` -- **pinnedRows**: `any` -- **pinnedStartColumns**: `any` -- **pinning**: `any` -- **primaryKey**: `any` -- **resourceStrings**: `any` -- **rowAddTextTemplate**: `any` -- **rowClasses**: `any` -- **rowCollapsedIndicatorTemplate**: `any` -- **rowDraggable**: `any` -- **rowEditable**: `any` -- **rowEditActionsTemplate**: `any` -- **rowEditTextTemplate**: `any` -- **rowExpandedIndicatorTemplate**: `any` -- **rowHeight**: `any` -- **rowList**: `any` -- **rowSelection**: `any` -- **rowSelectorTemplate**: `any` -- **rowStyles**: `any` -- **selectedRows**: `any` -- **selectRowOnClick**: `any` -- **shouldGenerate**: `any` -- **showSummaryOnCollapse**: `any` -- **snackbarDisplayTime**: `any` -- **sortAscendingHeaderIconTemplate**: `any` -- **sortDescendingHeaderIconTemplate**: `any` -- **sortHeaderIconTemplate**: `any` -- **sortingExpressions**: `any` -- **sortingOptions**: `any` -- **sortStrategy**: `any` -- **summaryCalculationMode**: `any` -- **summaryPosition**: `any` -- **summaryRowHeight**: `any` -- **toolbar**: `any` -- **totalRecords**: `any` -- **unpinnedColumns**: `any` -- **validationTrigger**: `any` -- **virtualizationState**: `any` -- **visibleColumns**: `any` -- **width**: `any` -- **addRow**: `any` -- **beginAddRowById**: `any` -- **beginAddRowByIndex**: `any` -- **clearCellSelection**: `any` -- **clearFilter**: `any` -- **clearSearch**: `any` -- **clearSort**: `any` -- **closeAdvancedFilteringDialog**: `any` -- **collapseAll**: `any` -- **collapseRow**: `any` -- **deleteRow**: `any` -- **deselectAllColumns**: `any` -- **deselectAllRows**: `any` -- **deselectColumns**: `any` -- **deselectRows**: `any` -- **disableSummaries**: `any` -- **enableSummaries**: `any` -- **endEdit**: `any` -- **expandAll**: `any` -- **expandRow**: `any` -- **filter**: `any` -- **filterGlobal**: `any` -- **findNext**: `any` -- **findPrev**: `any` -- **getColumnByName**: `any` -- **getColumnByVisibleIndex**: `any` -- **getHeaderGroupWidth**: `any` -- **getNextCell**: `any` -- **getPinnedEndWidth**: `any` -- **getPinnedStartWidth**: `any` -- **getPreviousCell**: `any` -- **getRowData**: `any` -- **getSelectedColumnsData**: `any` -- **getSelectedData**: `any` -- **getSelectedRanges**: `any` -- **isRecordPinnedByIndex**: `any` -- **markForCheck**: `any` -- **moveColumn**: `any` -- **navigateTo**: `any` -- **openAdvancedFilteringDialog**: `any` -- **pinColumn**: `any` -- **pinRow**: `any` -- **recalculateAutoSizes**: `any` -- **reflow**: `any` -- **refreshSearch**: `any` -- **selectAllColumns**: `any` -- **selectAllRows**: `any` -- **selectColumns**: `any` -- **selectedColumns**: `any` -- **selectRange**: `any` -- **selectRows**: `any` -- **sort**: `any` -- **toggleColumnVisibility**: `any` -- **toggleRow**: `any` -- **unpinColumn**: `any` -- **unpinRow**: `any` -- **updateCell**: `any` -- **updateRow**: `any` - -### [IgrGridCellEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridCellEventArgsDetail) -Represents an event argument related to grid cell interactions. - -- **cell**: `IgcCellType` — Represents the grid cell that triggered the event. -- **event**: `any` — Represents the original event that occurred -Examples of such events include: selecting, clicking, double clicking, etc. - -### [IgrGridClipboardEvent](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridClipboardEvent) -The event arguments when data from a grid is being copied. - -- **cancel**: `any` -- **data**: `any` - -### [IgrGridContextMenuEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridContextMenuEventArgsDetail) -Represents an event argument for the grid contextMenu output - -- **cell**: `IgcCellType` — Represents the grid cell that triggered the event. -- **event**: `any` — Represents the original event that occurred -Examples of such events include: selecting, clicking, double clicking, etc. -- **row**: `IgcRowType` — Represents the grid row that triggered the event. - -### [IgrGridCreatedEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridCreatedEventArgsDetail) - -- **grid**: `IgcHierarchicalGridComponent` -- **owner**: `IgcRowIslandComponent` — Provides reference to the owner component. -- **parentID**: `any` -- **parentRowData?**: `any` - -### [IgrGridEditDoneEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridEditDoneEventArgsDetail) -Represents event arguments related to grid editing completion. - -- **cellID?**: `any` -- **column?**: `IgcColumnComponent` — Optional -Represents the column information of the edited cell -- **isAddRow?**: `boolean` — Optional -Indicates if the editing consists of adding a new row -- **newValue?**: `any` — Optional -Represents the value, that is being entered in the edited cell -When there is no newValue and the event has ended, the value of the cell returns to the oldValue -- **oldValue**: `any` — Represents the previous (before editing) value of the edited cell. -It's used when the event has been stopped/exited. -- **owner?**: `IgcGridBaseDirective` — Optional -Represents the grid instance that owns the edit event. -- **primaryKey**: `any` -- **rowData**: `any` — rowData represents the updated/committed data of the row after the edit (newValue) -The only case rowData (of the current object) is used directly, is when there is no rowEditing or transactions enabled -- **rowID**: `any` -- **rowKey**: `any` -- **valid?**: `boolean` — Optional -Indicates if the new value would be valid. -It can be set to return the result of the methods for validation of the grid - -### [IgrGridEditEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridEditEventArgsDetail) -Represents event arguments related to grid editing. -The event is cancelable -It contains information about the row and the column, as well as the old and nwe value of the element/cell - -- **cancel**: `boolean` — Provides the ability to cancel the event. -- **cellID?**: `any` -- **column?**: `IgcColumnComponent` — Optional -Represents the column information of the edited cell -- **isAddRow?**: `boolean` — Optional -Indicates if the editing consists of adding a new row -- **newValue?**: `any` — Optional -Represents the value, that is being entered in the edited cell -When there is no newValue and the event has ended, the value of the cell returns to the oldValue -- **oldValue**: `any` — Represents the previous (before editing) value of the edited cell. -It's used when the event has been stopped/exited. -- **owner?**: `IgcGridBaseDirective` — Optional -Represents the grid instance that owns the edit event. -- **primaryKey**: `any` -- **rowData**: `any` — rowData represents the updated/committed data of the row after the edit (newValue) -The only case rowData (of the current object) is used directly, is when there is no rowEditing or transactions enabled -- **rowID**: `any` -- **rowKey**: `any` -- **valid?**: `boolean` — Optional -Indicates if the new value would be valid. -It can be set to return the result of the methods for validation of the grid - -### [IgrGridEmptyTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridEmptyTemplateContext) - - -### [IgrGridFormGroupCreatedEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridFormGroupCreatedEventArgsDetail) -Interface representing the event arguments when a form group is created in the grid. -- formGroup: The form group that is created. -- owner: The grid instance that owns the form group. - -- **owner**: `IgcGridBaseDirective` - -### [IgrGridGroupingStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridGroupingStrategy) -Represents a grouping strategy for the grid data, extending the Sorting Strategy interface (contains a sorting method). - -- **groupBy**: `any` - -### [IgrGridHeaderTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridHeaderTemplateContext) - -- **implicit**: `any` - -### [IgrGridKeydownEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridKeydownEventArgsDetail) -Represents an event, emitted when keydown is triggered over element inside grid's body -This event is fired only if the key combination is supported in the grid. - -- **cancel**: `boolean` — The event is cancelable -cancel returns whether the event has been intercepted and stopped -If the value becomes "true", it returns/exits from the method, instantiating the interface -- **event**: `any` — Represents the original event, that occurred. -- **target**: `any` — Represents the information and details of the object itself -- **targetType**: `GridKeydownTargetType` — The targetType represents the type of the targeted object. For example a cell or a row - -### [IgrGridMasterDetailContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridMasterDetailContext) - -- **implicit**: `any` -- **index**: `any` - -### [IgrGridMergeStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridMergeStrategy) -Merge strategy interface. - -- **comparer**: `any` -- **merge**: `any` - -### [IgrGridPaginatorTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridPaginatorTemplateContext) - -- **implicit**: `any` - -### [IgrGridResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridResourceStrings) - -- **igx_grid_actions_add_child_label?**: `string` -- **igx_grid_actions_add_label?**: `string` -- **igx_grid_actions_delete_label?**: `string` -- **igx_grid_actions_edit_label?**: `string` -- **igx_grid_actions_jumpDown_label?**: `string` -- **igx_grid_actions_jumpUp_label?**: `string` -- **igx_grid_actions_pin_label?**: `string` -- **igx_grid_actions_unpin_label?**: `string` -- **igx_grid_add_row_label?**: `string` -- **igx_grid_advanced_filter_add_condition?**: `string` -- **igx_grid_advanced_filter_add_condition_root?**: `string` -- **igx_grid_advanced_filter_add_group?**: `string` -- **igx_grid_advanced_filter_add_group_root?**: `string` -- **igx_grid_advanced_filter_and_group?**: `string` -- **igx_grid_advanced_filter_and_label?**: `string` -- **igx_grid_advanced_filter_column_placeholder?**: `string` -- **igx_grid_advanced_filter_create_and_group?**: `string` -- **igx_grid_advanced_filter_create_or_group?**: `string` -- **igx_grid_advanced_filter_delete?**: `string` -- **igx_grid_advanced_filter_delete_filters?**: `string` -- **igx_grid_advanced_filter_dialog_checkbox_text?**: `string` -- **igx_grid_advanced_filter_dialog_message?**: `string` -- **igx_grid_advanced_filter_dialog_title?**: `string` -- **igx_grid_advanced_filter_drop_ghost_text?**: `string` -- **igx_grid_advanced_filter_end_group?**: `string` -- **igx_grid_advanced_filter_from_label?**: `string` -- **igx_grid_advanced_filter_initial_text?**: `string` -- **igx_grid_advanced_filter_or_group?**: `string` -- **igx_grid_advanced_filter_or_label?**: `string` -- **igx_grid_advanced_filter_query_value_placeholder?**: `string` -- **igx_grid_advanced_filter_select_entity?**: `string` -- **igx_grid_advanced_filter_select_return_field_single?**: `string` -- **igx_grid_advanced_filter_switch_group?**: `string` -- **igx_grid_advanced_filter_title?**: `string` -- **igx_grid_advanced_filter_ungroup?**: `string` -- **igx_grid_advanced_filter_value_placeholder?**: `string` -- **igx_grid_complex_filter?**: `string` -- **igx_grid_emptyFilteredGrid_message?**: `string` -- **igx_grid_emptyGrid_message?**: `string` -- **igx_grid_excel_add_to_filter?**: `string` -- **igx_grid_excel_apply?**: `string` -- **igx_grid_excel_blanks?**: `string` -- **igx_grid_excel_boolean_filter?**: `string` -- **igx_grid_excel_cancel?**: `string` -- **igx_grid_excel_currency_filter?**: `string` -- **igx_grid_excel_custom_dialog_add?**: `string` -- **igx_grid_excel_custom_dialog_clear?**: `string` -- **igx_grid_excel_custom_dialog_header?**: `string` -- **igx_grid_excel_custom_filter?**: `string` -- **igx_grid_excel_date_filter?**: `string` -- **igx_grid_excel_deselect?**: `string` -- **igx_grid_excel_filter_clear?**: `string` -- **igx_grid_excel_filter_moving_header?**: `string` -- **igx_grid_excel_filter_moving_left?**: `string` -- **igx_grid_excel_filter_moving_left_short?**: `string` -- **igx_grid_excel_filter_moving_right?**: `string` -- **igx_grid_excel_filter_moving_right_short?**: `string` -- **igx_grid_excel_filter_sorting_asc?**: `string` -- **igx_grid_excel_filter_sorting_asc_short?**: `string` -- **igx_grid_excel_filter_sorting_desc?**: `string` -- **igx_grid_excel_filter_sorting_desc_short?**: `string` -- **igx_grid_excel_filter_sorting_header?**: `string` -- **igx_grid_excel_hide?**: `string` -- **igx_grid_excel_matches_count?**: `string` -- **igx_grid_excel_no_matches?**: `string` -- **igx_grid_excel_number_filter?**: `string` -- **igx_grid_excel_pin?**: `string` -- **igx_grid_excel_search_placeholder?**: `string` -- **igx_grid_excel_select?**: `string` -- **igx_grid_excel_select_all?**: `string` -- **igx_grid_excel_select_all_search_results?**: `string` -- **igx_grid_excel_show?**: `string` -- **igx_grid_excel_text_filter?**: `string` -- **igx_grid_excel_unpin?**: `string` -- **igx_grid_filter?**: `string` -- **igx_grid_filter_after?**: `string` -- **igx_grid_filter_all?**: `string` -- **igx_grid_filter_at?**: `string` -- **igx_grid_filter_at_after?**: `string` -- **igx_grid_filter_at_before?**: `string` -- **igx_grid_filter_before?**: `string` -- **igx_grid_filter_condition_placeholder?**: `string` -- **igx_grid_filter_contains?**: `string` -- **igx_grid_filter_doesNotContain?**: `string` -- **igx_grid_filter_doesNotEqual?**: `string` -- **igx_grid_filter_empty?**: `string` -- **igx_grid_filter_endsWith?**: `string` -- **igx_grid_filter_equals?**: `string` -- **igx_grid_filter_false?**: `string` -- **igx_grid_filter_greaterThan?**: `string` -- **igx_grid_filter_greaterThanOrEqualTo?**: `string` -- **igx_grid_filter_in?**: `string` -- **igx_grid_filter_lastMonth?**: `string` -- **igx_grid_filter_lastYear?**: `string` -- **igx_grid_filter_lessThan?**: `string` -- **igx_grid_filter_lessThanOrEqualTo?**: `string` -- **igx_grid_filter_nextMonth?**: `string` -- **igx_grid_filter_nextYear?**: `string` -- **igx_grid_filter_not_at?**: `string` -- **igx_grid_filter_notEmpty?**: `string` -- **igx_grid_filter_notIn?**: `string` -- **igx_grid_filter_notNull?**: `string` -- **igx_grid_filter_null?**: `string` -- **igx_grid_filter_operator_and?**: `string` -- **igx_grid_filter_operator_or?**: `string` -- **igx_grid_filter_row_boolean_placeholder?**: `string` -- **igx_grid_filter_row_close?**: `string` -- **igx_grid_filter_row_date_placeholder?**: `string` -- **igx_grid_filter_row_placeholder?**: `string` -- **igx_grid_filter_row_reset?**: `string` -- **igx_grid_filter_row_time_placeholder?**: `string` -- **igx_grid_filter_startsWith?**: `string` -- **igx_grid_filter_thisMonth?**: `string` -- **igx_grid_filter_thisYear?**: `string` -- **igx_grid_filter_today?**: `string` -- **igx_grid_filter_true?**: `string` -- **igx_grid_filter_yesterday?**: `string` -- **igx_grid_groupByArea_deselect_message?**: `string` -- **igx_grid_groupByArea_message?**: `string` -- **igx_grid_groupByArea_select_message?**: `string` -- **igx_grid_hiding_check_all_label?**: `string` -- **igx_grid_hiding_uncheck_all_label?**: `string` -- **igx_grid_pinned_row_indicator?**: `string` -- **igx_grid_pinning_check_all_label?**: `string` -- **igx_grid_pinning_uncheck_all_label?**: `string` -- **igx_grid_pivot_aggregate_avg?**: `string` -- **igx_grid_pivot_aggregate_count?**: `string` -- **igx_grid_pivot_aggregate_date_earliest?**: `string` -- **igx_grid_pivot_aggregate_date_latest?**: `string` -- **igx_grid_pivot_aggregate_max?**: `string` -- **igx_grid_pivot_aggregate_min?**: `string` -- **igx_grid_pivot_aggregate_sum?**: `string` -- **igx_grid_pivot_aggregate_time_earliest?**: `string` -- **igx_grid_pivot_aggregate_time_latest?**: `string` -- **igx_grid_pivot_column_drop_chip?**: `string` -- **igx_grid_pivot_date_dimension_total?**: `string` -- **igx_grid_pivot_empty_column_drop_area?**: `string` -- **igx_grid_pivot_empty_filter_drop_area?**: `string` -- **igx_grid_pivot_empty_message?**: `string` -- **igx_grid_pivot_empty_row_drop_area?**: `string` -- **igx_grid_pivot_empty_value_drop_area?**: `string` -- **igx_grid_pivot_filter_drop_chip?**: `string` -- **igx_grid_pivot_row_drop_chip?**: `string` -- **igx_grid_pivot_selector_columns?**: `string` -- **igx_grid_pivot_selector_filters?**: `string` -- **igx_grid_pivot_selector_panel_empty?**: `string` -- **igx_grid_pivot_selector_rows?**: `string` -- **igx_grid_pivot_selector_values?**: `string` -- **igx_grid_pivot_value_drop_chip?**: `string` -- **igx_grid_row_edit_btn_cancel?**: `string` -- **igx_grid_row_edit_btn_done?**: `string` -- **igx_grid_row_edit_text?**: `string` -- **igx_grid_snackbar_addrow_actiontext?**: `string` -- **igx_grid_snackbar_addrow_label?**: `string` -- **igx_grid_summary_average?**: `string` -- **igx_grid_summary_count?**: `string` -- **igx_grid_summary_earliest?**: `string` -- **igx_grid_summary_latest?**: `string` -- **igx_grid_summary_max?**: `string` -- **igx_grid_summary_min?**: `string` -- **igx_grid_summary_sum?**: `string` -- **igx_grid_toolbar_actions_filter_prompt?**: `string` -- **igx_grid_toolbar_advanced_filtering_button_label?**: `string` -- **igx_grid_toolbar_advanced_filtering_button_tooltip?**: `string` -- **igx_grid_toolbar_exporter_button_label?**: `string` -- **igx_grid_toolbar_exporter_button_tooltip?**: `string` -- **igx_grid_toolbar_exporter_csv_entry_text?**: `string` -- **igx_grid_toolbar_exporter_excel_entry_text?**: `string` -- **igx_grid_toolbar_exporter_pdf_entry_text?**: `string` -- **igx_grid_toolbar_hiding_button_tooltip?**: `string` -- **igx_grid_toolbar_hiding_title?**: `string` -- **igx_grid_toolbar_pinning_button_tooltip?**: `string` -- **igx_grid_toolbar_pinning_title?**: `string` - -### [IgrGridRowComponent](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridRowComponent) - -- **getContext**: `any` -- **getContextMRL**: `any` - -### [IgrGridRowDragGhostContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridRowDragGhostContext) - -- **data**: `any` -- **grid**: `any` -- **implicit**: `any` - -### [IgrGridRowEditActionsTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridRowEditActionsTemplateContext) - -- **implicit**: `any` - -### [IgrGridRowEditTextTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridRowEditTextTemplateContext) - -- **implicit**: `any` - -### [IgrGridRowEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridRowEventArgsDetail) -Represents an event argument related to grid row interactions. - -- **event**: `any` — Represents the original event that occurred -Examples of such events include: selecting, clicking, double clicking, etc. -- **row**: `IgcRowType` — Represents the grid row that triggered the event. - -### [IgrGridRowTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridRowTemplateContext) - -- **implicit**: `any` - -### [IgrGridScrollEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridScrollEventArgsDetail) -Event emitted when a grid is scrolled. - -- **direction**: `string` — The scroll direction - vertical or horizontal. -- **event**: `any` — The original browser scroll event. -- **scrollPosition**: `number` — The new scroll position - -### [IgrGridSelectionRange](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridSelectionRange) -Represents a range selection between certain rows and columns of the grid. -Range selection can be made either through drag selection or through keyboard selection. - -- **columnEnd**: `any` -- **columnStart**: `any` -- **rowEnd**: `any` -- **rowStart**: `any` - -### [IgrGridSortingStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridSortingStrategy) -Represents a sorting strategy for the grid data -Contains a single method sort that sorts the provided data based on the given sorting expressions - -- **sort**: `any` - -### [IgrGridStateBaseDirective](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridStateBaseDirective) -Any HTML element. Some elements directly implement this interface, while others implement it via an interface that inherits it. - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/HTMLElement) - -- **options**: `any` - -### [IgrGridStateCollection](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridStateCollection) - -- **id**: `any` -- **parentRowID**: `any` -- **state**: `any` - -### [IgrGridStateInfo](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridStateInfo) - -- **advancedFiltering?**: `IgcFilteringExpressionsTree` -- **cellSelection?**: `IgcGridSelectionRange[]` -- **columns?**: `IgcColumnState[]` -- **columnSelection?**: `string[]` -- **expansion?**: `any[]` -- **filtering?**: `IgcFilteringExpressionsTree` -- **groupBy?**: `IgcGroupingState` -- **id?**: `string` -- **moving?**: `boolean` -- **paging?**: `IgcPagingState` -- **pinningConfig?**: `IgcPinningConfig` -- **pivotConfiguration?**: `IgcPivotConfiguration` -- **rowIslands?**: `IgcGridStateCollection[]` -- **rowPinning?**: `any[]` -- **rowSelection?**: `any[]` -- **sorting?**: `IgcSortingExpression[]` - -### [IgrGridStateOptions](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridStateOptions) - -- **advancedFiltering?**: `boolean` -- **cellSelection?**: `boolean` -- **columns?**: `boolean` -- **columnSelection?**: `boolean` -- **expansion?**: `boolean` -- **filtering?**: `boolean` -- **groupBy?**: `boolean` -- **moving?**: `boolean` -- **paging?**: `boolean` -- **pinningConfig?**: `boolean` -- **pivotConfiguration?**: `boolean` -- **rowIslands?**: `boolean` -- **rowPinning?**: `boolean` -- **rowSelection?**: `boolean` -- **sorting?**: `boolean` - -### [IgrGridTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridTemplateContext) - -- **implicit**: `any` - -### [IgrGridToolbarExportEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridToolbarExportEventArgsDetail) -Represents the arguments for the grid toolbar export event. -It provides information about the grid instance, exporter service, export options, -and allows the event to be canceled. - -- **cancel**: `boolean` — cancel returns whether the event has been intercepted and stopped -If the value becomes "true", it returns/exits from the method, instantiating the interface -- **exporter**: `IgcBaseExporter` — The exporter is a base service. -The type (an abstract class IgxBaseExporter) has it's own properties and methods -It is used to define the format and options of the export, the exported element -and methods for preparing the data from the elements for exporting -- **grid**: `IgcGridBaseDirective` — grid represents a reference to the instance of the grid te event originated from -- **options**: `IgcExporterOptionsBase` — Represents the different settings, that can be given to an export -The type (an abstract class IgxExporterOptionsBase) has properties for column settings -(whether they should be ignored) as well as method for generating a file name - -### [IgrGridToolbarTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridToolbarTemplateContext) - -- **implicit**: `any` - -### [IgrGridValidationState](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridValidationState) -Interface representing the validation state of a grid. -- status: The validation status ('VALID' or 'INVALID'). -- errors: The validation errors if any. - -- **errors?**: `IgcValidationErrors` -- **status**: `any` - -### [IgrGridValidationStatusEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGridValidationStatusEventArgsDetail) -Interface representing the event arguments for the grid validation status change event. -- status: The validation status ('VALID' or 'INVALID'). -- owner: The grid instance that owns the validation state. - -- **owner**: `IgcGridBaseDirective` -- **status**: `ValidationStatus` - -### [IgrGroupByExpandState](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGroupByExpandState) - -- **expanded**: `any` -- **hierarchy**: `any` - -### [IgrGroupByKey](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGroupByKey) - -- **fieldName**: `any` -- **value**: `any` - -### [IgrGroupByRecord](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGroupByRecord) - -- **column?**: `IgcColumnComponent` -- **groups?**: `IgcGroupByRecord[]` -- **expression**: `any` -- **groupParent**: `any` -- **height**: `any` -- **level**: `any` -- **records**: `any` -- **value**: `any` - -### [IgrGroupByResult](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGroupByResult) - -- **data**: `any` -- **metadata**: `any` - -### [IgrGroupByRowSelectorTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGroupByRowSelectorTemplateContext) - -- **implicit**: `any` - -### [IgrGroupByRowSelectorTemplateDetails](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGroupByRowSelectorTemplateDetails) - -- **groupRow**: `any` -- **selectedCount**: `any` -- **totalCount**: `any` - -### [IgrGroupByRowTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGroupByRowTemplateContext) - -- **implicit**: `any` - -### [IgrGroupingDoneEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGroupingDoneEventArgsDetail) - -- **expressions**: `IgcSortingExpression[]` -- **groupedColumns**: `IgcColumnComponent[]` -- **ungroupedColumns**: `IgcColumnComponent[]` - -### [IgrGroupingExpression](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGroupingExpression) - -- **groupingComparer?**: `any` - -### [IgrGroupingState](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrGroupingState) - -- **defaultExpanded**: `any` -- **expansion**: `any` -- **expressions**: `any` - -### [IgrHeaderType](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrHeaderType) -Interface representing a header cell in the grid. It is essentially the blueprint to a header cell object. -Contains definitions of properties, relevant to the header - -- **column**: `any` -- **selectable**: `any` -- **selected**: `any` -- **sortDirection**: `any` -- **sorted**: `any` -- **title**: `any` - -### [IgrHeadSelectorTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrHeadSelectorTemplateContext) - -- **implicit**: `any` - -### [IgrHeadSelectorTemplateDetails](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrHeadSelectorTemplateDetails) - -- **selectedCount**: `any` -- **totalCount**: `any` -- **deselectAll?**: `any` -- **selectAll?**: `any` - -### [IgrHierarchicalGridBaseDirective](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrHierarchicalGridBaseDirective) - -- **hasChildrenKey**: `any` -- **rootGrid**: `any` -- **showExpandAll**: `any` - -### [IGridResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IGridResourceStrings) - -- **grid_actions_add_child_label?**: `string` -- **grid_actions_add_label?**: `string` -- **grid_actions_delete_label?**: `string` -- **grid_actions_edit_label?**: `string` -- **grid_actions_jumpDown_label?**: `string` -- **grid_actions_jumpUp_label?**: `string` -- **grid_actions_pin_label?**: `string` -- **grid_actions_unpin_label?**: `string` -- **grid_add_row_label?**: `string` -- **grid_advanced_filter_add_condition?**: `string` -- **grid_advanced_filter_add_condition_root?**: `string` -- **grid_advanced_filter_add_group?**: `string` -- **grid_advanced_filter_add_group_root?**: `string` -- **grid_advanced_filter_and_group?**: `string` -- **grid_advanced_filter_and_label?**: `string` -- **grid_advanced_filter_column_placeholder?**: `string` -- **grid_advanced_filter_create_and_group?**: `string` -- **grid_advanced_filter_create_or_group?**: `string` -- **grid_advanced_filter_delete?**: `string` -- **grid_advanced_filter_delete_filters?**: `string` -- **grid_advanced_filter_dialog_checkbox_text?**: `string` -- **grid_advanced_filter_dialog_message?**: `string` -- **grid_advanced_filter_dialog_title?**: `string` -- **grid_advanced_filter_drop_ghost_text?**: `string` -- **grid_advanced_filter_end_group?**: `string` -- **grid_advanced_filter_from_label?**: `string` -- **grid_advanced_filter_initial_text?**: `string` -- **grid_advanced_filter_or_group?**: `string` -- **grid_advanced_filter_or_label?**: `string` -- **grid_advanced_filter_query_value_placeholder?**: `string` -- **grid_advanced_filter_select_entity?**: `string` -- **grid_advanced_filter_select_return_field_single?**: `string` -- **grid_advanced_filter_switch_group?**: `string` -- **grid_advanced_filter_title?**: `string` -- **grid_advanced_filter_ungroup?**: `string` -- **grid_advanced_filter_value_placeholder?**: `string` -- **grid_complex_filter?**: `string` -- **grid_emptyFilteredGrid_message?**: `string` -- **grid_emptyGrid_message?**: `string` -- **grid_excel_add_to_filter?**: `string` -- **grid_excel_apply?**: `string` -- **grid_excel_blanks?**: `string` -- **grid_excel_boolean_filter?**: `string` -- **grid_excel_cancel?**: `string` -- **grid_excel_currency_filter?**: `string` -- **grid_excel_custom_dialog_add?**: `string` -- **grid_excel_custom_dialog_clear?**: `string` -- **grid_excel_custom_dialog_header?**: `string` -- **grid_excel_custom_filter?**: `string` -- **grid_excel_date_filter?**: `string` -- **grid_excel_deselect?**: `string` -- **grid_excel_filter_clear?**: `string` -- **grid_excel_filter_moving_header?**: `string` -- **grid_excel_filter_moving_left?**: `string` -- **grid_excel_filter_moving_left_short?**: `string` -- **grid_excel_filter_moving_right?**: `string` -- **grid_excel_filter_moving_right_short?**: `string` -- **grid_excel_filter_sorting_asc?**: `string` -- **grid_excel_filter_sorting_asc_short?**: `string` -- **grid_excel_filter_sorting_desc?**: `string` -- **grid_excel_filter_sorting_desc_short?**: `string` -- **grid_excel_filter_sorting_header?**: `string` -- **grid_excel_hide?**: `string` -- **grid_excel_matches_count?**: `string` -- **grid_excel_no_matches?**: `string` -- **grid_excel_number_filter?**: `string` -- **grid_excel_pin?**: `string` -- **grid_excel_search_placeholder?**: `string` -- **grid_excel_select?**: `string` -- **grid_excel_select_all?**: `string` -- **grid_excel_select_all_search_results?**: `string` -- **grid_excel_show?**: `string` -- **grid_excel_text_filter?**: `string` -- **grid_excel_unpin?**: `string` -- **grid_filter?**: `string` -- **grid_filter_after?**: `string` -- **grid_filter_all?**: `string` -- **grid_filter_at?**: `string` -- **grid_filter_at_after?**: `string` -- **grid_filter_at_before?**: `string` -- **grid_filter_before?**: `string` -- **grid_filter_condition_placeholder?**: `string` -- **grid_filter_contains?**: `string` -- **grid_filter_doesNotContain?**: `string` -- **grid_filter_doesNotEqual?**: `string` -- **grid_filter_empty?**: `string` -- **grid_filter_endsWith?**: `string` -- **grid_filter_equals?**: `string` -- **grid_filter_false?**: `string` -- **grid_filter_greaterThan?**: `string` -- **grid_filter_greaterThanOrEqualTo?**: `string` -- **grid_filter_in?**: `string` -- **grid_filter_lastMonth?**: `string` -- **grid_filter_lastYear?**: `string` -- **grid_filter_lessThan?**: `string` -- **grid_filter_lessThanOrEqualTo?**: `string` -- **grid_filter_nextMonth?**: `string` -- **grid_filter_nextYear?**: `string` -- **grid_filter_not_at?**: `string` -- **grid_filter_notEmpty?**: `string` -- **grid_filter_notIn?**: `string` -- **grid_filter_notNull?**: `string` -- **grid_filter_null?**: `string` -- **grid_filter_operator_and?**: `string` -- **grid_filter_operator_or?**: `string` -- **grid_filter_row_boolean_placeholder?**: `string` -- **grid_filter_row_close?**: `string` -- **grid_filter_row_date_placeholder?**: `string` -- **grid_filter_row_placeholder?**: `string` -- **grid_filter_row_reset?**: `string` -- **grid_filter_row_time_placeholder?**: `string` -- **grid_filter_startsWith?**: `string` -- **grid_filter_thisMonth?**: `string` -- **grid_filter_thisYear?**: `string` -- **grid_filter_today?**: `string` -- **grid_filter_true?**: `string` -- **grid_filter_yesterday?**: `string` -- **grid_groupByArea_deselect_message?**: `string` -- **grid_groupByArea_message?**: `string` -- **grid_groupByArea_select_message?**: `string` -- **grid_hiding_check_all_label?**: `string` -- **grid_hiding_uncheck_all_label?**: `string` -- **grid_pinned_row_indicator?**: `string` -- **grid_pinning_check_all_label?**: `string` -- **grid_pinning_uncheck_all_label?**: `string` -- **grid_pivot_aggregate_avg?**: `string` -- **grid_pivot_aggregate_count?**: `string` -- **grid_pivot_aggregate_date_earliest?**: `string` -- **grid_pivot_aggregate_date_latest?**: `string` -- **grid_pivot_aggregate_max?**: `string` -- **grid_pivot_aggregate_min?**: `string` -- **grid_pivot_aggregate_sum?**: `string` -- **grid_pivot_aggregate_time_earliest?**: `string` -- **grid_pivot_aggregate_time_latest?**: `string` -- **grid_pivot_column_drop_chip?**: `string` -- **grid_pivot_date_dimension_total?**: `string` -- **grid_pivot_empty_column_drop_area?**: `string` -- **grid_pivot_empty_filter_drop_area?**: `string` -- **grid_pivot_empty_message?**: `string` -- **grid_pivot_empty_row_drop_area?**: `string` -- **grid_pivot_empty_value_drop_area?**: `string` -- **grid_pivot_filter_drop_chip?**: `string` -- **grid_pivot_row_drop_chip?**: `string` -- **grid_pivot_selector_columns?**: `string` -- **grid_pivot_selector_filters?**: `string` -- **grid_pivot_selector_panel_empty?**: `string` -- **grid_pivot_selector_rows?**: `string` -- **grid_pivot_selector_values?**: `string` -- **grid_pivot_value_drop_chip?**: `string` -- **grid_row_edit_btn_cancel?**: `string` -- **grid_row_edit_btn_done?**: `string` -- **grid_row_edit_text?**: `string` -- **grid_snackbar_addrow_actiontext?**: `string` -- **grid_snackbar_addrow_label?**: `string` -- **grid_summary_average?**: `string` -- **grid_summary_count?**: `string` -- **grid_summary_earliest?**: `string` -- **grid_summary_latest?**: `string` -- **grid_summary_max?**: `string` -- **grid_summary_min?**: `string` -- **grid_summary_sum?**: `string` -- **grid_toolbar_actions_filter_prompt?**: `string` -- **grid_toolbar_advanced_filtering_button_label?**: `string` -- **grid_toolbar_advanced_filtering_button_tooltip?**: `string` -- **grid_toolbar_exporter_button_label?**: `string` -- **grid_toolbar_exporter_button_tooltip?**: `string` -- **grid_toolbar_exporter_csv_entry_text?**: `string` -- **grid_toolbar_exporter_excel_entry_text?**: `string` -- **grid_toolbar_exporter_pdf_entry_text?**: `string` -- **grid_toolbar_hiding_button_tooltip?**: `string` -- **grid_toolbar_hiding_title?**: `string` -- **grid_toolbar_pinning_button_tooltip?**: `string` -- **grid_toolbar_pinning_title?**: `string` - -### [IgrOverlayOutletDirective](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrOverlayOutletDirective) -Mark an element as an igxOverlay outlet container. -Directive instance is exported as overlay-outlet to be assigned to templates variables: -
- - -### [IgrOverlaySettings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrOverlaySettings) - -- **closeOnEscape?**: `boolean` — Set if the overlay should close when Esc key is pressed -- **closeOnOutsideClick?**: `boolean` — Set if the overlay should close on outside click -- **modal?**: `boolean` — Set if the overlay should be in modal mode -- **positionStrategy?**: `IgcPositionStrategy` — Position strategy to use with these settings -- **scrollStrategy?**: `IgcScrollStrategy` — Scroll strategy to use with these settings -- **target?**: `HTMLElement | Point` — Attaching target for the component to show - -### [IgrPageCancellableEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPageCancellableEventArgsDetail) - -- **current**: `number` -- **next**: `number` - -### [IgrPageEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPageEventArgsDetail) - -- **current**: `number` -- **previous**: `number` - -### [IgrPaginatorResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPaginatorResourceStrings) - -- **igx_paginator_first_page_button_text?**: `string` -- **igx_paginator_label?**: `string` -- **igx_paginator_last_page_button_text?**: `string` -- **igx_paginator_next_page_button_text?**: `string` -- **igx_paginator_pager_text?**: `string` -- **igx_paginator_previous_page_button_text?**: `string` - -### [IgrPagingState](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPagingState) - -- **index**: `any` -- **recordsPerPage**: `any` - -### [IgrPinColumnCancellableEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPinColumnCancellableEventArgsDetail) -The event arguments before a column's pin state is changed. -insertAtIndexspecifies at which index in the pinned/unpinned area the column is inserted. -Can be changed in the columnPin event. -isPinned returns the actual pin state of the column. When pinning/unpinning is successful, -the value of isPinned will change accordingly when read in the "-ing" and "-ed" event. - -- **cancel**: `boolean` — Provides the ability to cancel the event. -- **column**: `IgcColumnComponent` -- **insertAtIndex**: `number` — If pinned, specifies at which index in the pinned area the column is inserted. -If unpinned, specifies at which index in the unpinned area the column is inserted. -- **isPinned**: `boolean` — Returns the actual pin state of the column. -If pinning/unpinning is successful, value of isPinned will change accordingly when read in the "-ing" and "-ed" event. - -### [IgrPinColumnEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPinColumnEventArgsDetail) -The event arguments after a column's pin state is changed. -insertAtIndexspecifies at which index in the pinned/unpinned area the column was inserted. -isPinned returns the actual pin state of the column after the operation completed. - -- **column**: `IgcColumnComponent` -- **insertAtIndex**: `number` — If pinned, specifies at which index in the pinned area the column is inserted. -If unpinned, specifies at which index in the unpinned area the column is inserted. -- **isPinned**: `boolean` — Returns the actual pin state of the column. -If pinning/unpinning is successful, value of isPinned will change accordingly when read in the "-ing" and "-ed" event. - -### [IgrPinningConfig](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPinningConfig) -An interface describing settings for row/column pinning position. - -- **columns?**: `ColumnPinningPosition` -- **rows?**: `RowPinningPosition` - -### [IgrPinRowEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPinRowEventArgsDetail) -Event emitted when a row's pin state changes. -The event is cancelable - -- **cancel**: `boolean` — Provides the ability to cancel the event. -- **insertAtIndex?**: `number` — The index at which to pin the row in the pinned rows collection. -- **isPinned**: `boolean` — Whether or not the row is pinned or unpinned. -- **owner?**: `any` — Provides reference to the owner component. -- **row?**: `IgcRowType` -- **rowID**: `any` — The ID of the row, that was pinned/unpinned. -ID is either the primaryKey value or the data record instance. -- **rowKey**: `any` - -### [IgrPivotAggregator](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPivotAggregator) -Interface describing a IPivotAggregator class. -Used for specifying custom aggregator lists. - -- **aggregator?**: `any` — Aggregator function can be a custom implementation of PivotAggregation, or -use predefined ones from IgxPivotAggregate and its variants. -- **aggregatorName?**: `PivotAggregationType` — Aggregation name that will be used from a list of predefined aggregations. -If not set will use the specified aggregator function. -- **key**: `any` -- **label**: `any` - -### [IgrPivotConfiguration](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPivotConfiguration) -Configuration of the pivot grid. - -- **columnStrategy?**: `IgcPivotDimensionStrategy` — A strategy to transform the columns. -- **filters?**: `IgcPivotDimension[]` — Dimensions to be displayed in the filter area. -- **pivotKeys?**: `IgcPivotKeys` — Pivot data keys used for data generation. Can be used for custom remote scenarios where the data is pre-populated. -- **rowStrategy?**: `IgcPivotDimensionStrategy` — A strategy to transform the rows. -- **columns**: `any` -- **rows**: `any` -- **values**: `any` - -### [IgrPivotConfigurationChangedEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPivotConfigurationChangedEventArgsDetail) -Event emitted when pivot configuration is changed. - -- **pivotConfiguration**: `IgcPivotConfiguration` — The new configuration. - -### [IgrPivotDateDimensionOptions](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPivotDateDimensionOptions) - -- **fullDate?**: `boolean` — Enabled/Disables dimensions for the full date provided -- **months?**: `boolean` — Enables/Disables dimensions per month from provided periods. -- **quarters?**: `boolean` -- **total?**: `boolean` — Enables/Disables total value of all periods. -- **years?**: `boolean` — Enables/Disables dimensions per year from provided periods. - -### [IgrPivotDimension](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPivotDimension) -Configuration of a pivot dimension. - -- **childLevel?**: `IgcPivotDimension` — Allows defining a hierarchy when multiple sub groups need to be extracted from single member. -- **dataType?**: `GridColumnDataType` — The dataType of the related data field. -- **displayName?**: `string` — Display name to show instead of the field name of this value. * -- **filter?**: `IgcFilteringExpressionsTree` — A predefined or defined via the igxPivotSelector filter expression tree for the current dimension to be applied in the filter pipe. -- **horizontalSummary?**: `boolean` -- **level?**: `number` — Level of the dimension. -- **memberFunction?**: `any` — Function that extracts the value -- **sortable?**: `boolean` — Enable/disable sorting for a particular dimension. True by default. -- **sortDirection?**: `SortingDirection` — The sorting direction of the current dimension. Determines the order in which the values will appear in the related dimension. -- **width?**: `string` — The width of the dimension cells to be rendered.Can be pixel, % or "auto". -- **enabled**: `any` -- **memberName**: `any` - -### [IgrPivotDimensionStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPivotDimensionStrategy) -Interface describing Pivot data processing for dimensions. -Should contain a process method and return records hierarchy based on the provided dimensions. - -- **process**: `any` - -### [IgrPivotGridColumn](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPivotGridColumn) -Interface describing the Pivot column data. - Contains information on the related column dimensions and their values. - -- **dimensions**: `any` -- **field**: `any` -- **value**: `any` - -### [IgrPivotGridRecord](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPivotGridRecord) - -- **dataIndex?**: `number` — The index of the record in the total view -- **level?**: `number` — Record level* -- **records?**: `any[]` — List of original data records associated with the current pivoted data. * -- **totalRecordDimensionName?**: `string` — If set, it specifies the name of the dimension, that has total record enabled. -- **dimensions**: `any` - -### [IgrPivotGridValueTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPivotGridValueTemplateContext) - -- **implicit**: `any` - -### [IgrPivotKeys](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPivotKeys) -Interface describing the Pivot data keys used for data generation. - Can be used for custom remote scenarios where the data is pre-populated. - -- **aggregations**: `any` -- **children**: `any` -- **columnDimensionSeparator**: `any` -- **level**: `any` -- **records**: `any` -- **rowDimensionSeparator**: `any` - -### [IgrPivotUISettings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPivotUISettings) - -- **horizontalSummariesPosition?**: `PivotSummaryPosition` -- **rowLayout?**: `PivotRowLayoutType` -- **showConfiguration?**: `boolean` -- **showRowHeaders?**: `boolean` - -### [IgrPivotValue](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPivotValue) -Configuration of a pivot value aggregation. - -- **aggregateList?**: `IgcPivotAggregator[]` — List of aggregates to show in aggregate drop-down. -- **dataType?**: `GridColumnDataType` — Enables a data type specific template of the cells -- **displayName?**: `string` — Display name to show instead of member for the column header of this value. * -- **formatter?**: `any` — Applies display format to cell values. -- **styles?**: `any` — Allow conditionally styling of the IgxPivotGrid cells. -- **aggregate**: `any` -- **enabled**: `any` -- **member**: `any` - -### [IgrPositionSettings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPositionSettings) - -- **horizontalDirection?**: `HorizontalAlignment` — Direction in which the component should show -- **horizontalStartPoint?**: `HorizontalAlignment` — Target's starting point -- **minSize?**: `IgcSize` — The size up to which element may shrink when shown in elastic position strategy -- **offset?**: `number` — The offset of the element from the target in pixels -- **verticalDirection?**: `VerticalAlignment` — Direction in which the component should show -- **verticalStartPoint?**: `VerticalAlignment` — Target's starting point - -### [IgrPositionStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrPositionStrategy) -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-position) -Position strategies determine where to display the component in the provided IgxOverlayService. - -- **settings**: `any` -- **clone**: `any` - -### [IgrQueryBuilderResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrQueryBuilderResourceStrings) - -- **igx_query_builder_add_condition?**: `string` -- **igx_query_builder_add_condition_root?**: `string` -- **igx_query_builder_add_group?**: `string` -- **igx_query_builder_add_group_root?**: `string` -- **igx_query_builder_all_fields?**: `string` -- **igx_query_builder_and_group?**: `string` -- **igx_query_builder_and_label?**: `string` -- **igx_query_builder_column_placeholder?**: `string` -- **igx_query_builder_condition_placeholder?**: `string` -- **igx_query_builder_date_placeholder?**: `string` -- **igx_query_builder_datetime_placeholder?**: `string` -- **igx_query_builder_delete?**: `string` -- **igx_query_builder_delete_filters?**: `string` -- **igx_query_builder_details?**: `string` -- **igx_query_builder_dialog_cancel?**: `string` -- **igx_query_builder_dialog_checkbox_text?**: `string` -- **igx_query_builder_dialog_confirm?**: `string` -- **igx_query_builder_dialog_message?**: `string` -- **igx_query_builder_dialog_title?**: `string` -- **igx_query_builder_drop_ghost_text?**: `string` -- **igx_query_builder_end_group?**: `string` -- **igx_query_builder_filter_after?**: `string` -- **igx_query_builder_filter_all?**: `string` -- **igx_query_builder_filter_at?**: `string` -- **igx_query_builder_filter_at_after?**: `string` -- **igx_query_builder_filter_at_before?**: `string` -- **igx_query_builder_filter_before?**: `string` -- **igx_query_builder_filter_contains?**: `string` -- **igx_query_builder_filter_doesNotContain?**: `string` -- **igx_query_builder_filter_doesNotEqual?**: `string` -- **igx_query_builder_filter_empty?**: `string` -- **igx_query_builder_filter_endsWith?**: `string` -- **igx_query_builder_filter_equals?**: `string` -- **igx_query_builder_filter_false?**: `string` -- **igx_query_builder_filter_greaterThan?**: `string` -- **igx_query_builder_filter_greaterThanOrEqualTo?**: `string` -- **igx_query_builder_filter_in?**: `string` -- **igx_query_builder_filter_lastMonth?**: `string` -- **igx_query_builder_filter_lastYear?**: `string` -- **igx_query_builder_filter_lessThan?**: `string` -- **igx_query_builder_filter_lessThanOrEqualTo?**: `string` -- **igx_query_builder_filter_nextMonth?**: `string` -- **igx_query_builder_filter_nextYear?**: `string` -- **igx_query_builder_filter_not_at?**: `string` -- **igx_query_builder_filter_notEmpty?**: `string` -- **igx_query_builder_filter_notIn?**: `string` -- **igx_query_builder_filter_notNull?**: `string` -- **igx_query_builder_filter_null?**: `string` -- **igx_query_builder_filter_operator_and?**: `string` -- **igx_query_builder_filter_operator_or?**: `string` -- **igx_query_builder_filter_startsWith?**: `string` -- **igx_query_builder_filter_thisMonth?**: `string` -- **igx_query_builder_filter_thisYear?**: `string` -- **igx_query_builder_filter_today?**: `string` -- **igx_query_builder_filter_true?**: `string` -- **igx_query_builder_filter_yesterday?**: `string` -- **igx_query_builder_from_label?**: `string` -- **igx_query_builder_initial_text?**: `string` -- **igx_query_builder_or_group?**: `string` -- **igx_query_builder_or_label?**: `string` -- **igx_query_builder_query_value_placeholder?**: `string` -- **igx_query_builder_search?**: `string` -- **igx_query_builder_select_all?**: `string` -- **igx_query_builder_select_entity?**: `string` -- **igx_query_builder_select_label?**: `string` -- **igx_query_builder_select_return_field_single?**: `string` -- **igx_query_builder_select_return_fields?**: `string` -- **igx_query_builder_switch_group?**: `string` -- **igx_query_builder_time_placeholder?**: `string` -- **igx_query_builder_ungroup?**: `string` -- **igx_query_builder_value_placeholder?**: `string` -- **igx_query_builder_where_label?**: `string` - -### [IgrQueryBuilderSearchValueContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrQueryBuilderSearchValueContext) - -- **implicit**: `any` -- **selectedCondition**: `any` -- **selectedField**: `any` - -### [IgrRowDataCancelableEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrRowDataCancelableEventArgsDetail) - -- **cellID?**: `any` -- **data**: `any` -- **isAddRow?**: `boolean` -- **newValue?**: `any` -- **oldValue**: `any` -- **owner**: `IgcGridBaseDirective` -- **primaryKey**: `any` — Represents the unique key, the row can be associated with. -Available if primaryKey exists -- **rowData**: `any` -- **rowKey**: `any` - -### [IgrRowDataEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrRowDataEventArgsDetail) -Represents event arguments related to events, that can occur for rows in a grid -Example for events: adding, deleting, selection, transaction, etc. - -- **data**: `any` -- **primaryKey**: `any` — Represents the unique key, the row can be associated with. -Available if primaryKey exists -- **rowData**: `any` -- **rowKey**: `any` - -### [IgrRowDirective](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrRowDirective) - -- **addRowUI**: `any` -- **cells**: `any` -- **data**: `any` -- **dataRowIndex**: `any` -- **disabled**: `any` -- **expanded**: `any` -- **hasMergedCells**: `any` -- **index**: `any` -- **inEditMode**: `any` -- **key**: `any` -- **pinned**: `any` -- **rowHeight**: `any` -- **beginAddRow**: `any` -- **delete**: `any` -- **isCellActive**: `any` -- **pin**: `any` -- **unpin**: `any` -- **update**: `any` - -### [IgrRowDragEndEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrRowDragEndEventArgsDetail) -Emitted when a dragging operation is finished (when the row is dropped) - -- **animation**: `boolean` — animation returns whether the event is animated -- **dragData**: `IgcRowType` — Represents the information of the row that is being dragged. -- **dragDirective**: `any` — Represents the drag directive or information associated with the drag operation - -### [IgrRowDragStartEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrRowDragStartEventArgsDetail) -Emitted when a dragging operation is starting (when the row is "picked") -The event is cancelable - -- **cancel**: `boolean` — Provides the ability to cancel the event. -- **dragData**: `IgcRowType` — Represents the information of the row that is being dragged. -- **dragDirective**: `any` — Represents the drag directive or information associated with the drag operation -- **owner?**: `any` — Provides reference to the owner component. - -### [IgrRowExportingEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrRowExportingEventArgsDetail) -rowExporting event arguments -this.exporterService.rowExporting.subscribe((args: IRowExportingEventArgs) => { -// set args properties here -}) - -- **cancel**: `boolean` — Skip the exporting row when set to true -- **rowData**: `any` — Contains the exporting row data -- **rowIndex**: `number` — Contains the exporting row index - -### [IgrRowSelectionEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrRowSelectionEventArgsDetail) -The event arguments when the selection state of a row is being changed -The event is cancelable - -- **added**: `any[]` — Represents an array of all added rows -Whenever a row has been selected, the array is "refreshed" with the selected rows -- **allRowsSelected?**: `boolean` — Indicates whether or not all rows of the grid have been selected -- **cancel**: `boolean` — Provides the ability to cancel the event. -- **newSelection**: `any[]` — Represents the newly selected rows -- **oldSelection**: `any[]` — Represents an array of rows, that have already been selected -- **owner?**: `any` — Provides reference to the owner component. -- **removed**: `any[]` — Represents an array of all rows, removed from the selection -Whenever a row has been deselected, the array is "refreshed" with the rows, -that have been previously selected, but are no longer - -### [IgrRowSelectorTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrRowSelectorTemplateContext) - -- **implicit**: `any` - -### [IgrRowSelectorTemplateDetails](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrRowSelectorTemplateDetails) - -- **index**: `any` -- **key**: `any` -- **rowID**: `any` -- **selected**: `any` -- **deselect?**: `any` -- **select?**: `any` - -### [IgrRowToggleEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrRowToggleEventArgsDetail) -Represents event arguments related to the row's expansion state being changed in a grid - -- **cancel**: `boolean` — The event is cancelable -cancel returns whether the event has been intercepted and stopped -If the value becomes "true", it returns/exits from the method, instantiating the interface -- **expanded**: `boolean` — Returns the state of the row after the operation has ended -Indicating whether the row is being expanded (true) or collapsed (false) -- **rowID**: `any` — Represents the ID of the row that emitted the event (which state is changed) -- **rowKey**: `any` - -### [IgrRowType](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrRowType) -Interface representing a row in the grid. It is essentially the blueprint to a row object. -Contains definitions of properties and methods, relevant to a row - -- **addRowUI?**: `boolean` -- **cells?**: `IgcCellType[]` — Optional -A list or an array of cells, that belong to the row -- **children?**: `IgcRowType[]` — Optional -Contains the child rows of the current row, if there are any. -- **data?**: `any` -- **deleted?**: `boolean` — Optional -Indicates whether the row is marked for deletion. -- **disabled?**: `boolean` — Optional -Indicates whether the current row is disabled -- **expanded?**: `boolean` — Optional -Indicates whether the current row is expanded. -The value is true, if the row is expanded and false, if it is collapsed -- **focused?**: `boolean` — Optional -Indicates whether the row is currently focused. -- **groupRow?**: `IgcGroupByRecord` -- **hasChildren?**: `boolean` — Optional -Indicates whether the current row has any child rows -- **inEditMode?**: `boolean` — Optional -Indicates whether the row is currently being edited. -- **isGroupByRow?**: `boolean` — Indicates whether the row is grouped. -- **isSummaryRow?**: `boolean` -- **key?**: `any` -- **parent?**: `IgcRowType` — Optional -Contains the parent row of the current row, if it has one. -If the parent row exist, it means that the current row is a child row -- **pinned?**: `boolean` — Optional -Indicates whether the current row is pinned. -- **selected?**: `boolean` — Optional -Indicates whether the current row is selected -- **treeRow?**: `IgcTreeGridRecord` — Optional -Represents the hierarchical record associated with the row (for tree grids). -It is of type ITreeGridRecord, which contains the data, children, the hierarchical level, etc. -- **validation?**: `IgcGridValidationState` -- **grid**: `any` -- **index**: `any` -- **viewIndex**: `any` -- **delete?**: `any` -- **pin?**: `any` -- **unpin?**: `any` -- **update?**: `any` - -### [IgrScrollStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrScrollStrategy) -[Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/overlay-scroll). -Scroll strategies determines how the scrolling will be handled in the provided IgxOverlayService. - -- **attach**: `any` -- **detach**: `any` - -### [IgrSearchInfo](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrSearchInfo) - -- **activeMatchIndex**: `any` -- **matchInfoCache**: `any` - -### [IgrSize](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrSize) - -- **height**: `any` -- **width**: `any` - -### [IgrSortingEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrSortingEventArgsDetail) -Represents event arguments related to sorting and grouping operations -The event is cancelable - -- **cancel**: `boolean` — Provides the ability to cancel the event. -- **groupingExpressions?**: `IgcGroupingExpression[]` — Optional -Represents the grouping expressions applied to the grid. -It can be a single grouping expression or an array of them -The expression contains information like the sorting expression and criteria by which the elements will be grouped -- **owner?**: `any` — Provides reference to the owner component. -- **sortingExpressions?**: `IgcSortingExpression[]` — Optional -Represents the sorting expressions applied to the grid. -It can be a single sorting expression or an array of them -The expression contains information like file name, whether the letter case should be taken into account, etc. - -### [IgrSortingExpression](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrSortingExpression) - -- **ignoreCase?**: `boolean` -- **strategy?**: `IgcSortingStrategy` -- **dir**: `any` -- **fieldName**: `any` - -### [IgrSortingOptions](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrSortingOptions) - -- **mode**: `any` - -### [IgrSortingStrategy](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrSortingStrategy) - - -### [IgrSummaryExpression](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrSummaryExpression) - -- **customSummary?**: `any` -- **fieldName**: `any` - -### [IgrSummaryResult](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrSummaryResult) - -- **defaultFormatting?**: `boolean` — Apply default formatting based on the grid column type. -const result: IgxSummaryResult = { - key: 'key', - label: 'label', - defaultFormatting: true -} -- **key**: `any` -- **label**: `any` -- **summaryResult**: `any` - -### [IgrSummaryTemplateContext](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrSummaryTemplateContext) - -- **implicit**: `any` - -### [IgrToggleViewCancelableEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrToggleViewCancelableEventArgsDetail) - -- **id**: `string` — Id of the toggle view - -### [IgrToggleViewEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrToggleViewEventArgsDetail) - -- **id**: `string` — Id of the toggle view - -### [IgrTreeGridRecord](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrTreeGridRecord) - -- **children?**: `IgcTreeGridRecord[]` -- **expanded?**: `boolean` -- **isFilteredOutParent?**: `boolean` -- **level?**: `number` -- **parent?**: `IgcTreeGridRecord` -- **data**: `any` -- **key**: `any` - -### [IgrValidationErrors](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrValidationErrors) - - -### [IgrValidationResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrValidationResourceStrings) - -- **igx_grid_disabled_date_validation_error?**: `string` -- **igx_grid_email_validation_error?**: `string` -- **igx_grid_mask_validation_error?**: `string` -- **igx_grid_max_length_validation_error?**: `string` -- **igx_grid_max_validation_error?**: `string` -- **igx_grid_min_length_validation_error?**: `string` -- **igx_grid_min_validation_error?**: `string` -- **igx_grid_pattern_validation_error?**: `string` -- **igx_grid_required_validation_error?**: `string` -- **igx_grid_url_validation_error?**: `string` - -### [IgrValuesChange](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IgrValuesChange) -Event emitted when values list is changed. - -- **values**: `any` - -### [IListResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IListResourceStrings) - -- **list_loading?**: `string` -- **list_no_items?**: `string` - -### [IPaginatorResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IPaginatorResourceStrings) - -- **paginator_first_page_button_text?**: `string` -- **paginator_label?**: `string` -- **paginator_last_page_button_text?**: `string` -- **paginator_next_page_button_text?**: `string` -- **paginator_pager_text?**: `string` -- **paginator_previous_page_button_text?**: `string` - -### [IQueryBuilderResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IQueryBuilderResourceStrings) - -- **query_builder_add_condition?**: `string` -- **query_builder_add_condition_root?**: `string` -- **query_builder_add_group?**: `string` -- **query_builder_add_group_root?**: `string` -- **query_builder_all_fields?**: `string` -- **query_builder_and_group?**: `string` -- **query_builder_and_label?**: `string` -- **query_builder_column_placeholder?**: `string` -- **query_builder_condition_placeholder?**: `string` -- **query_builder_date_placeholder?**: `string` -- **query_builder_datetime_placeholder?**: `string` -- **query_builder_delete?**: `string` -- **query_builder_delete_filters?**: `string` -- **query_builder_details?**: `string` -- **query_builder_dialog_cancel?**: `string` -- **query_builder_dialog_checkbox_text?**: `string` -- **query_builder_dialog_confirm?**: `string` -- **query_builder_dialog_message?**: `string` -- **query_builder_dialog_title?**: `string` -- **query_builder_drop_ghost_text?**: `string` -- **query_builder_end_group?**: `string` -- **query_builder_filter_after?**: `string` -- **query_builder_filter_all?**: `string` -- **query_builder_filter_at?**: `string` -- **query_builder_filter_at_after?**: `string` -- **query_builder_filter_at_before?**: `string` -- **query_builder_filter_before?**: `string` -- **query_builder_filter_contains?**: `string` -- **query_builder_filter_doesNotContain?**: `string` -- **query_builder_filter_doesNotEqual?**: `string` -- **query_builder_filter_empty?**: `string` -- **query_builder_filter_endsWith?**: `string` -- **query_builder_filter_equals?**: `string` -- **query_builder_filter_false?**: `string` -- **query_builder_filter_greaterThan?**: `string` -- **query_builder_filter_greaterThanOrEqualTo?**: `string` -- **query_builder_filter_in?**: `string` -- **query_builder_filter_lastMonth?**: `string` -- **query_builder_filter_lastYear?**: `string` -- **query_builder_filter_lessThan?**: `string` -- **query_builder_filter_lessThanOrEqualTo?**: `string` -- **query_builder_filter_nextMonth?**: `string` -- **query_builder_filter_nextYear?**: `string` -- **query_builder_filter_not_at?**: `string` -- **query_builder_filter_notEmpty?**: `string` -- **query_builder_filter_notIn?**: `string` -- **query_builder_filter_notNull?**: `string` -- **query_builder_filter_null?**: `string` -- **query_builder_filter_operator_and?**: `string` -- **query_builder_filter_operator_or?**: `string` -- **query_builder_filter_startsWith?**: `string` -- **query_builder_filter_thisMonth?**: `string` -- **query_builder_filter_thisYear?**: `string` -- **query_builder_filter_today?**: `string` -- **query_builder_filter_true?**: `string` -- **query_builder_filter_yesterday?**: `string` -- **query_builder_from_label?**: `string` -- **query_builder_initial_text?**: `string` -- **query_builder_or_group?**: `string` -- **query_builder_or_label?**: `string` -- **query_builder_query_value_placeholder?**: `string` -- **query_builder_search?**: `string` -- **query_builder_select_all?**: `string` -- **query_builder_select_entity?**: `string` -- **query_builder_select_label?**: `string` -- **query_builder_select_return_field_single?**: `string` -- **query_builder_select_return_fields?**: `string` -- **query_builder_switch_group?**: `string` -- **query_builder_time_placeholder?**: `string` -- **query_builder_ungroup?**: `string` -- **query_builder_value_placeholder?**: `string` -- **query_builder_where_label?**: `string` - -### [IResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/IResourceStrings) - - -### [ITimePickerResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/ITimePickerResourceStrings) - -- **time_picker_cancel?**: `string` -- **time_picker_change_time?**: `string` -- **time_picker_choose_time?**: `string` -- **time_picker_ok?**: `string` - -### [ITreeResourceStrings](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/ITreeResourceStrings) - -- **collapse?**: `string` -- **expand?**: `string` - -### [Point](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/interfaces/Point) - -- **x**: `number` -- **y**: `number` - -## Enumerations - -### [ColumnPinningPosition](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/enums/ColumnPinningPosition) -Enumeration representing the possible positions for pinning columns. -- Start: Columns are pinned to the start of the grid. -- End: Columns are pinned to the end of the grid. - -- **End** -- **Start** - -### [DropPosition](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/enums/DropPosition) -This enumeration is used to configure whether the drop position is set before or after -the target. - -- **AfterDropTarget** -- **BeforeDropTarget** - -### [FilteringExpressionsTreeType](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/enums/FilteringExpressionsTreeType) - -- **Advanced** -- **Regular** - -### [FilteringLogic](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/enums/FilteringLogic) - -- **And** -- **Or** - -### [HorizontalAlignment](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/enums/HorizontalAlignment) - -- **Center** = -0.5 -- **Left** = -1 -- **Right** = 0 - -### [PivotDimensionType](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/enums/PivotDimensionType) -The dimension types - Row, Column or Filter. - -- **Column** -- **Filter** -- **Row** - -### [RowPinningPosition](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/enums/RowPinningPosition) -Enumeration representing the possible positions for pinning rows. -- Top: Rows are pinned to the top of the grid. -- Bottom: Rows are pinned to the bottom of the grid. - -- **Bottom** -- **Top** - -### [SortingDirection](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/enums/SortingDirection) - -- **Asc** = 1 -- **Desc** = 2 -- **None** = 0 - -### [VerticalAlignment](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/enums/VerticalAlignment) - -- **Bottom** = 0 -- **Middle** = -0.5 -- **Top** = -1 - -## Type Aliases - -### [FilterMode](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/FilterMode) -`"quickFilter" | "excelStyleFilter"` - -### [GridCellMergeMode](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/GridCellMergeMode) -`"onSort" | "always"` - -### [GridColumnDataType](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/GridColumnDataType) -`"string" | "number" | "boolean" | "date" | "dateTime" | "time" | "currency" | "percent" | "image"` - -### [GridKeydownTargetType](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/GridKeydownTargetType) -`"dataCell" | "summaryCell" | "groupRow" | "hierarchicalRow" | "headerCell" | "masterDetailRow"` - -### [GridPagingMode](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/GridPagingMode) -`"local" | "remote"` - -### [GridSelectionMode](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/GridSelectionMode) -`"none" | "single" | "multiple" | "multipleCascade"` - -### [GridSummaryCalculationMode](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/GridSummaryCalculationMode) -`"rootLevelOnly" | "childLevelsOnly" | "rootAndChildLevels"` - -### [GridSummaryPosition](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/GridSummaryPosition) -`"top" | "bottom"` - -### [GridToolbarExporterType](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/GridToolbarExporterType) -`"excel" | "csv" | "pdf"` - -### [GridValidationTrigger](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/GridValidationTrigger) -`"change" | "blur"` - -### [IgrActiveNodeChangeEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrActiveNodeChangeEventArgs) -`CustomEvent` - -### [IgrBaseEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrBaseEventArgs) -`CustomEvent` - -### [IgrCancelableBrowserEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrCancelableBrowserEventArgs) -`CustomEvent` - -### [IgrCancelableEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrCancelableEventArgs) -`CustomEvent` - -### [IgrColumnExportingEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrColumnExportingEventArgs) -`CustomEvent` - -### [IgrColumnMovingEndEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrColumnMovingEndEventArgs) -`CustomEvent` - -### [IgrColumnMovingEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrColumnMovingEventArgs) -`CustomEvent` - -### [IgrColumnMovingStartEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrColumnMovingStartEventArgs) -`CustomEvent` - -### [IgrColumnResizeEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrColumnResizeEventArgs) -`CustomEvent` - -### [IgrColumnsAutoGeneratedEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrColumnsAutoGeneratedEventArgs) -`CustomEvent` - -### [IgrColumnSelectionEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrColumnSelectionEventArgs) -`CustomEvent` - -### [IgrColumnToggledEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrColumnToggledEventArgs) -`CustomEvent` - -### [IgrColumnVisibilityChangedEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrColumnVisibilityChangedEventArgs) -`CustomEvent` - -### [IgrColumnVisibilityChangingEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrColumnVisibilityChangingEventArgs) -`CustomEvent` - -### [IgrExporterEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrExporterEventArgs) -`CustomEvent` - -### [IgrFilteringEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrFilteringEventArgs) -`CustomEvent` - -### [IgrForOfDataChangeEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrForOfDataChangeEventArgs) -`CustomEvent` - -### [IgrForOfDataChangingEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrForOfDataChangingEventArgs) -`CustomEvent` - -### [IgrGridCellEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrGridCellEventArgs) -`CustomEvent` - -### [IgrGridContextMenuEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrGridContextMenuEventArgs) -`CustomEvent` - -### [IgrGridCreatedEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrGridCreatedEventArgs) -`CustomEvent` - -### [IgrGridEditDoneEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrGridEditDoneEventArgs) -`CustomEvent` - -### [IgrGridEditEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrGridEditEventArgs) -`CustomEvent` - -### [IgrGridFormGroupCreatedEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrGridFormGroupCreatedEventArgs) -`CustomEvent` - -### [IgrGridKeydownEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrGridKeydownEventArgs) -`CustomEvent` - -### [IgrGridRowEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrGridRowEventArgs) -`CustomEvent` - -### [IgrGridScrollEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrGridScrollEventArgs) -`CustomEvent` - -### [IgrGridToolbarExportEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrGridToolbarExportEventArgs) -`CustomEvent` - -### [IgrGridValidationStatusEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrGridValidationStatusEventArgs) -`CustomEvent` - -### [IgrGroupingDoneEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrGroupingDoneEventArgs) -`CustomEvent` - -### [IgrPageCancellableEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrPageCancellableEventArgs) -`CustomEvent` - -### [IgrPageEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrPageEventArgs) -`CustomEvent` - -### [IgrPinColumnCancellableEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrPinColumnCancellableEventArgs) -`CustomEvent` - -### [IgrPinColumnEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrPinColumnEventArgs) -`CustomEvent` - -### [IgrPinRowEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrPinRowEventArgs) -`CustomEvent` - -### [IgrPivotConfigurationChangedEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrPivotConfigurationChangedEventArgs) -`CustomEvent` - -### [IgrRowDataCancelableEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrRowDataCancelableEventArgs) -`CustomEvent` - -### [IgrRowDataEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrRowDataEventArgs) -`CustomEvent` - -### [IgrRowDragEndEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrRowDragEndEventArgs) -`CustomEvent` - -### [IgrRowDragStartEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrRowDragStartEventArgs) -`CustomEvent` - -### [IgrRowExportingEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrRowExportingEventArgs) -`CustomEvent` - -### [IgrRowSelectionEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrRowSelectionEventArgs) -`CustomEvent` - -### [IgrRowToggleEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrRowToggleEventArgs) -`CustomEvent` - -### [IgrSortingEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrSortingEventArgs) -`CustomEvent` - -### [IgrToggleViewCancelableEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrToggleViewCancelableEventArgs) -`CustomEvent` - -### [IgrToggleViewEventArgs](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/IgrToggleViewEventArgs) -`CustomEvent` - -### [PivotAggregationType](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/PivotAggregationType) -`"SUM" | "AVG" | "MIN" | "MAX" | "COUNT" | "LATEST" | "EARLIEST"` - -### [PivotRowLayoutType](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/PivotRowLayoutType) -`"Vertical" | "Horizontal"` - -### [PivotSummaryPosition](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/PivotSummaryPosition) -`"Top" | "Bottom"` - -### [SortingOptionsMode](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/SortingOptionsMode) -`"single" | "multiple"` - -### [ValidationStatus](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/types/ValidationStatus) -`"VALID" | "INVALID"` - -## Functions - -### [registerI18n](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/functions/registerI18n) -`registerI18n(resourceStrings: IResourceStrings, locale: string): void` -Register resources for a specific locale. - -### [setCurrentI18n](https://www.infragistics.com/api/react/igniteui-react-grids/19.5.1/functions/setCurrentI18n) -`setCurrentI18n(locale: string): void` -Set the current locale of all Ignite UI components. diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/react-api/igniteui-react/19.5.1/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/react-api/igniteui-react/19.5.1/llms-full.txt deleted file mode 100644 index a38379609..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/react-api/igniteui-react/19.5.1/llms-full.txt +++ /dev/null @@ -1,1772 +0,0 @@ -# Ignite UI for React v19.5.1 — Full API Reference - -> Complete API reference for the Ignite UI for React package (19.5.1). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: React -Package: igniteui-react -Version: 19.5.1 - -## Classes - -### [IgrAccordion](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrAccordion) -The Accordion is a container-based component that can house multiple expansion panels -and offers keyboard navigation. - -- **singleExpand**: `boolean` — Allows only one panel to be expanded at a time. -- **panels**: `any` — Returns all of the accordions's direct igc-expansion-panel children. -- **hideAll**(): Promise — Hides all of the child expansion panels' contents. -- **showAll**(): Promise — Shows all of the child expansion panels' contents. - -### [IgrAvatar](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrAvatar) -An avatar component is used as a representation of a user identity -typically in a user profile. - -- **alt**: `string` — Alternative text for the image. -- **initials**: `string` — Initials to use as a fallback when no image is available. -- **shape**: `AvatarShape` — The shape of the avatar. -- **src**: `string` — The image source to use. - -### [IgrBadge](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrBadge) -The badge is a component indicating a status on a related item or an area -where some active indication is required. - -- **dot**: `boolean` — Sets whether to render a dot type badge. -When enabled, the badge appears as a small dot without any content. -- **outlined**: `boolean` — Sets whether to draw an outlined version of the badge. -- **shape**: `BadgeShape` — The shape of the badge. -- **variant**: `StyleVariant` — The type (style variant) of the badge. - -### [IgrBanner](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrBanner) -The igc-banner component displays important and concise message(s) for a user to address, that is specific to a page or feature. - -- **open**: `boolean` — Determines whether the banner is being shown/hidden. -- **hide**(): Promise — Hides the banner if not already hidden. Returns true when the animation has completed. -- **show**(): Promise — Shows the banner if not already shown. Returns true when the animation has completed. -- **toggle**(): Promise — Toggles between shown/hidden state. Returns true when the animation has completed. - -### [IgrButton](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrButton) -Represents a clickable button, used to submit forms or anywhere in a -document for accessible, standard button functionality. - -- **disabled**: `boolean` — The disabled state of the component -- **download**: `string` — Prompts to save the linked URL instead of navigating to it. -- **href**: `string` — The URL the button points to. -- **rel**: `string` — The relationship of the linked URL. -See https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types -- **target**: `"_blank" | "_parent" | "_self" | "_top"` — Where to display the linked URL, as the name for a browsing context. -- **type**: `"reset" | "submit" | "button"` — The type of the button. Defaults to button. -- **variant**: `ButtonVariant` — Sets the variant of the button. -- **form**: `any` — Returns the HTMLFormElement associated with this element. -- **blur**(): void — Removes focus from the button. -- **click**(): void — Simulates a mouse click on the element -- **focus**(options?: FocusOptions): void — Sets focus in the button. - -### [IgrButtonGroup](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrButtonGroup) -The igc-button-group groups a series of igc-toggle-buttons together, exposing features such as layout and selection. - -- **alignment**: `ContentOrientation` — Sets the orientation of the buttons in the group. -- **disabled**: `boolean` — Disables all buttons inside the group. -- **selectedItems**: `string[]` — Gets/Sets the currently selected buttons (their values). -- **selection**: `ButtonGroupSelection` — Controls the mode of selection for the button group. - -### [IgrCalendar](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrCalendar) -Represents a calendar that lets users -to select a date value in a variety of different ways. - -- **activeView**: `CalendarActiveView` — The current active view of the component. -- **formatOptions**: `Pick` — The options used to format the months and the weekdays in the calendar views. -- **headerOrientation**: `CalendarHeaderOrientation` — The orientation of the calendar header. -- **hideHeader**: `boolean` — Whether to render the calendar header part. -When the calendar selection is set to multiple the header is always hidden. -- **hideOutsideDays**: `boolean` — Whether to show the dates that do not belong to the current active month. -- **orientation**: `ContentOrientation` — The orientation of the calendar months when more than one month -is being shown. -- **visibleMonths**: `number` — The number of months displayed in the days view. - -### [IgrCard](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrCard) -A container component that wraps different elements related to a single subject. -The card component provides a flexible container for organizing content such as headers, -media, text content, and actions. - -- **elevated**: `boolean` — Sets the card to have an elevated appearance with shadow. -When false, the card uses an outlined style with a border. - -### [IgrCardActions](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrCardActions) -A container component for card action items such as buttons or icon buttons. -Actions can be positioned at the start, center, or end of the container. - -- **orientation**: `ContentOrientation` — The orientation of the actions layout. - -### [IgrCardContent](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrCardContent) -A container component for the card's main text content. -This component should be used within an igc-card element to display the primary content. - - -### [IgrCardHeader](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrCardHeader) -A container component for the card's header section. -Displays header content including an optional thumbnail, title, subtitle, and additional content. - - -### [IgrCardMedia](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrCardMedia) -A container component for card media content such as images, GIFs, or videos. -This component should be used within an igc-card element to display visual content. - - -### [IgrCarousel](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrCarousel) -The igc-carousel presents a set of igc-carousel-slides by sequentially displaying a subset of one or more slides. - -- **animationType**: `HorizontalTransitionAnimation` — The animation type. -- **disableLoop**: `boolean` — Whether the carousel should skip rotating to the first slide after it reaches the last. -- **disablePauseOnInteraction**: `boolean` — Whether the carousel should ignore use interactions and not pause on them. -- **hideIndicators**: `boolean` — Whether the carousel should render the indicator controls (dots). -- **hideNavigation**: `boolean` — Whether the carousel should skip rendering of the default navigation buttons. -- **indicatorsLabelFormat**: `string` — The format used to set the aria-label on the carousel indicators. -Instances of '{0}' will be replaced with the index of the corresponding slide. -- **indicatorsOrientation**: `CarouselIndicatorsOrientation` — Sets the orientation of the indicator controls (dots). -- **interval**: `number` — The duration in milliseconds between changing the active slide. -- **locale**: `string` — Gets/Sets the locale used for getting language, affecting resource strings. -- **maximumIndicatorsCount**: `number` — Controls the maximum indicator controls (dots) that can be shown. Default value is 10. -- **resourceStrings**: `ICarouselResourceStrings` — The resource strings for localization. -Currently only aria-label attributes are localized for the carousel. -- **slidesLabelFormat**: `string` — The format used to set the aria-label on the carousel slides and the text displayed -when the number of indicators is greater than tha maximum indicator count. -Instances of '{0}' will be replaced with the index of the corresponding slide. -Instances of '{1}' will be replaced with the total amount of slides. -- **vertical**: `boolean` — Whether the carousel has vertical alignment. -- **current**: `any` — The index of the current active slide. -- **isPaused**: `any` — Whether the carousel in in paused state. -- **isPlaying**: `any` — Whether the carousel is in playing state. -- **slides**: `any` — The slides of the carousel. -- **total**: `any` — The total number of slides. -- **next**(): Promise — Switches to the next slide, runs any animations, and returns if the operation was successful. -- **pause**(): void — Pauses the carousel rotation of slides. -- **play**(): void — Resumes playing of the carousel slides. -- **prev**(): Promise — Switches to the previous slide, runs any animations, and returns if the operation was successful. -- **select**(slide: IgcCarouselSlideComponent, animationDirection?: "next" | "prev"): Promise — Switches to the passed-in slide, runs any animations, and returns if the operation was successful. -- **select**(index: number, animationDirection?: "next" | "prev"): Promise — Switches to slide by index, runs any animations, and returns if the operation was successful. - -### [IgrCarouselIndicator](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrCarouselIndicator) -Used when a custom indicator needs to be passed to the igc-carousel component. - -- **active**: `boolean` -- **index**: `number` - -### [IgrCarouselSlide](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrCarouselSlide) -A single content container within a set of containers used in the context of an igc-carousel. - -- **active**: `boolean` — The current active slide for the carousel component. -- **previous**: `boolean` - -### [IgrChat](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrChat) -A chat UI component for displaying messages, attachments, and input interaction. - -- **draftMessage**: `any` — The chat message currently being composed but not yet sent. -Includes the draft text and any attachments. -- **messages**: `IgcChatMessage[]` — The list of chat messages currently displayed. -Use this property to set or update the message history. -- **options**: `IgcChatOptions` — Controls the chat behavior and appearance through a configuration object. -Use this to toggle UI options, provide suggestions, templates, etc. -- **resourceStrings**: `IgcChatResourceStrings` — The resource strings of the chat. -- **scrollToMessage**(messageId: string): void — Scrolls the view to a specific message by id. - -### [IgrCheckbox](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrCheckbox) -A check box allowing single values to be selected/deselected. - -- **checked**: `boolean` — The checked state of the control. -- **indeterminate**: `boolean` — Draws the checkbox in indeterminate state. -- **labelPosition**: `ToggleLabelPosition` — The label position of the control. -- **value**: `string` — The value attribute of the control. -- **blur**(): void — Removes focus from the control. -- **click**(): void — Simulates a click on the control. -- **focus**(options?: FocusOptions): void — Sets focus on the control. - -### [IgrChip](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrChip) -Chips help people enter information, make selections, filter content, or trigger actions. - -- **disabled**: `boolean` — Sets the disabled state for the chip. -- **locale**: `string` — Gets/Sets the locale used for getting language, affecting resource strings. -- **removable**: `boolean` — Defines if the chip is removable or not. -- **resourceStrings**: `IChipResourceStrings` — The resource strings for localization. -Currently only aria-labels for the default select/remove icons are localized. -- **selectable**: `boolean` — Defines if the chip is selectable or not. -- **selected**: `boolean` — Defines if the chip is selected or not. -- **variant**: `StyleVariant` — A property that sets the color variant of the chip component. - -### [IgrCircularGradient](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrCircularGradient) -Used for defining gradient stops in the igc-circular-progress. -For each igc-circular-gradient defined as gradient slot of igc-circular-progress element would be created a SVG stop element. -The values passed as color, offset and opacity would be set as -stop-color, offset and stop-opacity of the SVG element without further validations. - -- **color**: `string` — Defines the color of the gradient stop -- **offset**: `string` — Defines where the gradient stop is placed along the gradient vector -- **opacity**: `number` — Defines the opacity of the gradient stop - -### [IgrCircularProgress](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrCircularProgress) -A circular progress indicator used to express unspecified wait time or display -the length of a process. - -- **animationDuration**: `number` — Animation duration in milliseconds. -- **hideLabel**: `boolean` — Shows/hides the label of the control. -- **indeterminate**: `boolean` — The indeterminate state of the control. -- **labelFormat**: `string` — Format string for the default label of the control. -Placeholders: - {0} - current value of the control. - {1} - max value of the control. -- **max**: `number` — Maximum value of the control. -- **value**: `number` — The value of the control. -- **variant**: `StyleVariant` — The variant of the control. - -### [IgrCombo](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrCombo) -The Combo component is similar to the Select component in that it provides a list of options from which the user can make a selection. -In contrast to the Select component, the Combo component displays all options in a virtualized list of items, -meaning the combo box can simultaneously show thousands of options, where one or more options can be selected. -Additionally, users can create custom item templates, allowing for robust data visualization. -The Combo component features case-sensitive filtering, grouping, complex data binding, dynamic addition of values and more. - -- **autofocus**: `boolean` — The autofocus attribute of the control. -- **autofocusList**: `boolean` — Focuses the list of options when the menu opens. -- **caseSensitiveIcon**: `boolean` — Enables the case sensitive search icon in the filtering input. -- **data**: `T[]` — The data source used to generate the list of options. -- **disableClear**: `boolean` — Hides the clear button. -- **disableFiltering**: `boolean` — Disables the filtering of the list of options. -- **displayKey**: `any` — The key in the data source used to display items in the list. -- **filteringOptions**: `FilteringOptions` — An object that configures the filtering of the combo. -- **groupHeaderTemplate**: `ComboItemTemplate` — The template used for the content of each combo group header. -- **groupKey**: `any` — The key in the data source used to group items in the list. -- **groupSorting**: `GroupingDirection` — Sorts the items in each group by ascending or descending order. -- **itemTemplate**: `ComboItemTemplate` — The template used for the content of each combo item. -- **label**: `string` — The label attribute of the control. -- **locale**: `string` — Gets/Sets the locale used for getting language, affecting resource strings. -- **open**: `boolean` — Sets the open state of the component. -- **outlined**: `boolean` — The outlined attribute of the control. -- **placeholder**: `string` — The placeholder attribute of the control. -- **placeholderSearch**: `string` — The placeholder attribute of the search input. -- **resourceStrings**: `IComboResourceStrings` — The resource strings for localization. -- **singleSelect**: `boolean` — Enables single selection mode and moves item filtering to the main input. -- **value**: `ComboValue[]` — Sets the value (selected items). The passed value must be a valid JSON array. -If the data source is an array of complex objects, the `valueKey` attribute must be set. -Note that when `displayKey` is not explicitly set, it will fall back to the value of `valueKey`. -- **valueKey**: `any` — The key in the data source used when selecting items. -- **selection**: `any` — Returns the current selection as an array of objects as provided in the `data` source. -- **blur**(): void — Removes focus from the component. -- **deselect**(items?: Item | Item[]): void — Deselects option(s) in the list by either reference or valueKey. -If not argument is provided all items will be deselected. -- **focus**(options?: FocusOptions): void — Sets focus on the component. -- **hide**(): Promise — Hides the list of options. -- **select**(items?: Item | Item[]): void — Selects option(s) in the list by either reference or valueKey. -If not argument is provided all items will be selected. -- **show**(): Promise — Shows the list of options. -- **toggle**(): Promise — Toggles the list of options. - -### [IgrDatePicker](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrDatePicker) -igc-date-picker is a feature rich component used for entering a date through manual text input or -choosing date values from a calendar dialog that pops up. - -- **activeDate**: `Date` — Gets/Sets the date which is shown in the calendar picker and is highlighted. -By default it is the current date. -- **disabledDates**: `DateRangeDescriptor[]` — Gets/sets disabled dates. -- **displayFormat**: `string` — Format to display the value in when not editing. -Defaults to the locale format if not set. -- **headerOrientation**: `CalendarHeaderOrientation` — The orientation of the calendar header. -- **hideHeader**: `boolean` — Determines whether the calendar hides its header. -- **hideOutsideDays**: `boolean` — Controls the visibility of the dates that do not belong to the current month. -- **inputFormat**: `string` — The date format to apply on the input. -Defaults to the current locale Intl.DateTimeFormat -- **label**: `string` — The label of the datepicker. -- **locale**: `string` — Gets/Sets the locale used for formatting the display value. -- **max**: `Date` — The maximum value required for the date picker to remain valid. -- **min**: `Date` — The minimum value required for the date picker to remain valid. -- **mode**: `PickerMode` — Determines whether the calendar is opened in a dropdown or a modal dialog -- **nonEditable**: `boolean` — Whether to allow typing in the input. -- **open**: `boolean` — Sets the state of the datepicker dropdown. -- **orientation**: `ContentOrientation` — The orientation of the multiple months displayed in the calendar's days view. -- **outlined**: `boolean` — Whether the control will have outlined appearance. -- **placeholder**: `string` — The placeholder attribute of the control. -- **prompt**: `string` — The prompt symbol to use for unfilled parts of the mask. -- **readOnly**: `boolean` — Makes the control a readonly field. -- **resourceStrings**: `IgcCalendarResourceStrings` — The resource strings for localization. -- **showWeekNumbers**: `boolean` — Whether to show the number of the week in the calendar. -- **specialDates**: `DateRangeDescriptor[]` — Gets/sets special dates. -- **value**: `Date` — The value of the picker -- **visibleMonths**: `number` — The number of months displayed in the calendar. -- **weekStart**: `WeekDays` — Sets the start day of the week for the calendar. -- **clear**(): void — Clears the input part of the component of any user input -- **select**(): void — Selects the text in the input of the component -- **setRangeText**(replacement: string, start: number, end: number, mode?: RangeTextSelectMode): void -- **setSelectionRange**(start: number, end: number, direction?: SelectionRangeDirection): void — Sets the text selection range in the input of the component -- **stepDown**(datePart?: DatePart, delta?: number): void — Decrements the passed in date part -- **stepUp**(datePart?: DatePart, delta?: number): void — Increments the passed in date part - -### [IgrDateRangePicker](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrDateRangePicker) -The igc-date-range-picker allows the user to select a range of dates. - -- **activeDate**: `Date` — Gets/Sets the date which is shown in the calendar picker and is highlighted. -By default it is the current date. -- **customRanges**: `CustomDateRange[]` — Renders chips with custom ranges based on the elements of the array. -- **disabledDates**: `DateRangeDescriptor[]` — Gets/sets disabled dates. -- **displayFormat**: `string` — Format to display the value in when not editing. -Defaults to the locale format if not set. -- **headerOrientation**: `ContentOrientation` — The orientation of the calendar header. -- **hideHeader**: `boolean` — Determines whether the calendar hides its header. -- **hideOutsideDays**: `boolean` — Controls the visibility of the dates that do not belong to the current month. -- **inputFormat**: `string` — The date format to apply on the inputs. -Defaults to the current locale Intl.DateTimeFormat -- **label**: `string` — The label of the control (single input). -- **labelEnd**: `string` — The label attribute of the end input. -- **labelStart**: `string` — The label attribute of the start input. -- **locale**: `string` — The locale settings used to display the value. -- **max**: `Date` — The maximum value required for the date range picker to remain valid. -- **min**: `Date` — The minimum value required for the date range picker to remain valid. -- **mode**: `PickerMode` — Determines whether the calendar is opened in a dropdown or a modal dialog -- **nonEditable**: `boolean` — Whether to allow typing in the input. -- **orientation**: `ContentOrientation` — The orientation of the multiple months displayed in the calendar's days view. -- **outlined**: `boolean` — Whether the control will have outlined appearance. -- **placeholder**: `string` — The placeholder attribute of the control (single input). -- **placeholderEnd**: `string` — The placeholder attribute of the end input. -- **placeholderStart**: `string` — The placeholder attribute of the start input. -- **prompt**: `string` — The prompt symbol to use for unfilled parts of the mask. -- **readOnly**: `boolean` — Makes the control a readonly field. -- **resourceStrings**: `IgcDateRangePickerResourceStrings` — The resource strings of the date range picker. -- **showWeekNumbers**: `boolean` — Whether to show the number of the week in the calendar. -- **specialDates**: `DateRangeDescriptor[]` — Gets/sets special dates. -- **usePredefinedRanges**: `boolean` — Whether the control will show chips with predefined ranges. -- **useTwoInputs**: `boolean` — Use two inputs to display the date range values. Makes the input editable in dropdown mode. -- **value**: `DateRangeValue` — The value of the picker -- **visibleMonths**: `number` — The number of months displayed in the calendar. -- **weekStart**: `WeekDays` — Sets the start day of the week for the calendar. -- **clear**(): void — Clears the input parts of the component of any user input -- **select**(value: DateRangeValue): void — Selects a date range value in the picker - -### [IgrDateTimeInput](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrDateTimeInput) -A date time input is an input field that lets you set and edit the date and time in a chosen input element -using customizable display and input formats. - -- **displayFormat**: `string` — Format to display the value in when not editing. -Defaults to the locale format if not set. -- **inputFormat**: `string` — The date format to apply on the input. -- **locale**: `string` — Gets/Sets the locale used for formatting the display value. -- **max**: `Date` — The maximum value required for the input to remain valid. -- **min**: `Date` — The minimum value required for the input to remain valid. -- **spinDelta**: `DatePartDeltas` — Delta values used to increment or decrement each date part on step actions. -All values default to 1. -- **spinLoop**: `boolean` — Sets whether to loop over the currently spun segment. -- **value**: `Date` — The value of the input. -- **clear**(): void — Clears the input element of user input. -- **stepDown**(datePart?: DatePart, delta?: number): void — Decrements a date/time portion. -- **stepUp**(datePart?: DatePart, delta?: number): void — Increments a date/time portion. - -### [IgrDialog](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrDialog) -Represents a Dialog component. - -- **closeOnOutsideClick**: `boolean` — Whether the dialog should be closed when clicking outside of it. -- **hideDefaultAction**: `boolean` — Whether to hide the default action button for the dialog. - -When there is projected content in the footer slot this property -has no effect. -- **keepOpenOnEscape**: `boolean` — Whether the dialog should be kept open when pressing the 'Escape' button. -- **open**: `boolean` — Whether the dialog is opened. -- **returnValue**: `string` — Sets the return value for the dialog. -- **title**: `string` — Sets the title of the dialog. -- **hide**(): Promise — Closes the dialog. -- **show**(): Promise — Opens the dialog. -- **toggle**(): Promise — Toggles the open state of the dialog. - -### [IgrDivider](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrDivider) -The igc-divider allows the content author to easily create a horizontal/vertical rule as a break between content to better organize information on a page. - -- **middle**: `boolean` — When set and inset is provided, it will shrink the divider line from both sides. -- **type**: `DividerType` — Whether to render a solid or a dashed divider line. -- **vertical**: `boolean` — Whether to render a vertical divider line. - -### [IgrDropdown](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrDropdown) -Represents a DropDown component. - -- **distance**: `number` — The distance from the target element. -- **flip**: `boolean` — Whether the component should be flipped to the opposite side of the target once it's about to overflow the visible area. -When true, once enough space is detected on its preferred side, it will flip back. -- **placement**: `PopoverPlacement` — The preferred placement of the component around the target element. -- **sameWidth**: `boolean` — Whether the dropdown's width should be the same as the target's one. -- **scrollStrategy**: `PopoverScrollStrategy` — Determines the behavior of the component during scrolling of the parent container. -- **groups**: `any` — Returns the group items of the dropdown. -- **items**: `any` — Returns the items of the dropdown. -- **selectedItem**: `any` — Returns the selected item from the dropdown or null. -- **clearSelection**(): void — Clears the current selection of the dropdown. -- **disconnectedCallback**(): void — Invoked when the component is removed from the document's DOM. - -This callback is the main signal to the element that it may no longer be -used. disconnectedCallback() should ensure that nothing is holding a -reference to the element (such as event listeners added to nodes external -to the element), so that it is free to be garbage collected. - -disconnectedCallback() { - super.disconnectedCallback(); - window.removeEventListener('keydown', this._handleKeydown); -} - - -An element may be re-connected after being disconnected. -- **navigateTo**(value: string): IgcDropdownItemComponent — Navigates to the item with the specified value. If it exists, returns the found item, otherwise - null. -- **navigateTo**(index: number): IgcDropdownItemComponent — Navigates to the item at the specified index. If it exists, returns the found item, otherwise - null. -- **select**(value: string): IgcDropdownItemComponent — Selects the item with the specified value. If it exists, returns the found item, otherwise - null. -- **select**(index: number): IgcDropdownItemComponent — Selects the item at the specified index. If it exists, returns the found item, otherwise - null. -- **show**(target?: string | HTMLElement): Promise — Shows the component. -- **toggle**(target?: string | HTMLElement): Promise — Toggles the open state of the component. - -### [IgrDropdownGroup](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrDropdownGroup) -A container for a group of igc-dropdown-item components. - -- **items**: `IgcDropdownItemComponent[]` — All child igc-dropdown-items. - -### [IgrDropdownHeader](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrDropdownHeader) -Represents a header item in a igc-dropdown list. - - -### [IgrDropdownItem](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrDropdownItem) -Represents an item in a dropdown list. - -- **active**: `boolean` — Whether the item is active. -- **disabled**: `boolean` — Whether the item is disabled. -- **selected**: `boolean` — Whether the item is selected. -- **value**: `string` — The current value of the item. -If not specified, the element's text content is used. - -### [IgrExpansionPanel](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrExpansionPanel) -The Expansion Panel Component provides a way to display information in a toggleable way - -compact summary view containing title and description and expanded detail view containing -additional content to the summary header. - -- **disabled**: `boolean` — Get/Set whether the expansion panel is disabled. Disabled panels are ignored for user interactions. -- **indicatorPosition**: `ExpansionPanelIndicatorPosition` — The indicator position of the expansion panel. -- **open**: `boolean` — Indicates whether the contents of the control should be visible. -- **hide**(): Promise — Hides the panel content. -- **show**(): Promise — Shows the panel content. -- **toggle**(): Promise — Toggles the panel open/close state. - -### [IgrFileInput](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrFileInput) - -- **accept**: `string` — The accept attribute of the control. -Defines the file types as a list of comma-separated values that the file input should accept. -- **autofocus**: `boolean` — The autofocus attribute of the control. -- **locale**: `string` — Gets/Sets the locale used for getting language, affecting resource strings. -- **multiple**: `boolean` — The multiple attribute of the control. -Used to indicate that a file input allows the user to select more than one file. -- **resourceStrings**: `IFileInputResourceStrings` — The resource strings for localization. -- **value**: `string` — The value of the control. -Similar to native file input, this property is read-only and cannot be set programmatically. -- **files**: `any` — Returns the list of selected files. - -### [IgrGridLite](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrGridLite) -IgcGridLite is a web component for displaying data in a tabular format quick and easy. - -Out of the box it provides row virtualization, sort and filter operations (client and server side), -the ability to template cells and headers and column hiding. - -- **adoptRootStyles**: `boolean` -- **autoGenerate**: `boolean` — Whether the grid will try to "resolve" its column configuration based on the passed -data source. -- **data**: `T[]` — The data source for the grid. -- **dataPipelineConfiguration**: `DataPipelineConfiguration` — Configuration object which controls remote data operations for the grid. -- **filterExpressions**: `FilterExpression[]` — Set the filter state for the grid. -- **sortingExpressions**: `SortingExpression[]` — Set the sort state for the grid. -- **sortingOptions**: `GridLiteSortingOptions` — Sort configuration property for the grid. -- **columns**: `any` -- **dataView**: `any` — Returns the state of the data source after sort/filter operations -have been applied. -- **rows**: `any` — Returns the collection of rendered row elements in the grid. -- **totalItems**: `any` — [object Object],[object Object],[object Object] -- **clearFilter**(key?: Keys): void — Resets the current filter state of the control. -- **clearSort**(key?: Keys): void — Resets the current sort state of the control. -- **filter**(config: FilterExpression | FilterExpression[]): void — Performs a filter operation in the grid based on the passed expression(s). -- **getColumn**(id: number | Keys): ColumnConfiguration — Returns a ColumnConfiguration for a given column. -- **navigateTo**(row: number, column?: Keys, activate?: boolean): Promise — Navigates to a position in the grid based on provided row index and column field. -- **sort**(expressions: SortingExpression | SortingExpression[]): void — Performs a sort operation in the grid based on the passed expression(s). - -### [IgrGridLiteColumn](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrGridLiteColumn) - -- **cellTemplate**: `any` — Custom cell template for the column. -- **dataType**: `"string" | "number" | "boolean"` — The data type of the column's values. -- **field**: `Keys` — The field from the data for this column. -- **filterable**: `boolean` — Indicates whether the column is filterable. -- **filteringCaseSensitive**: `boolean` — Whether filter operations will be case sensitive. -- **header**: `string` — The header text of the column. -- **headerTemplate**: `any` — Custom header template for the column. -- **hidden**: `boolean` — Indicates whether the column is hidden. -- **resizable**: `boolean` — Indicates whether the column is resizable. -- **sortable**: `boolean` — Indicates whether the column is sortable. -- **sortConfiguration**: `ColumnSortConfiguration` — Sort configuration for the column (e.g., custom comparer). -- **sortingCaseSensitive**: `boolean` — Whether sort operations will be case sensitive. -- **width**: `string` — The width of the column. - -### [IgrIcon](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrIcon) -The icon component allows visualizing collections of pre-registered SVG icons. - -- **collection**: `string` — The name of the registered collection for look up of icons. -- **mirrored**: `boolean` — Whether to flip the icon horizontally. Useful for RTL (right-to-left) layouts. -- **name**: `string` — The name of the icon glyph to draw. - -### [IgrIconButton](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrIconButton) - -- **collection**: `string` — The name of the icon collection. -- **disabled**: `boolean` — The disabled state of the component -- **download**: `string` — Prompts to save the linked URL instead of navigating to it. -- **href**: `string` — The URL the button points to. -- **mirrored**: `boolean` — Whether to flip the icon button. Useful for RTL layouts. -- **name**: `string` — The name of the icon. -- **rel**: `string` — The relationship of the linked URL. -See https://developer.mozilla.org/en-US/docs/Web/HTML/Link_types -- **target**: `"_blank" | "_parent" | "_self" | "_top"` — Where to display the linked URL, as the name for a browsing context. -- **type**: `"reset" | "submit" | "button"` — The type of the button. Defaults to button. -- **variant**: `IconButtonVariant` — The visual variant of the icon button. -- **form**: `any` — Returns the HTMLFormElement associated with this element. -- **blur**(): void — Removes focus from the button. -- **click**(): void — Simulates a mouse click on the element -- **focus**(options?: FocusOptions): void — Sets focus in the button. - -### [IgrInput](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrInput) - -- **autocomplete**: `string` — The autocomplete attribute of the control. -- **autofocus**: `boolean` — The autofocus attribute of the control. -- **inputMode**: `string` — The input mode attribute of the control. -See [relevant MDN article](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode) -- **label**: `string` — The label for the control. -- **max**: `number` — The max attribute of the control. -- **maxLength**: `number` — The maximum string length of the control. -- **min**: `number` — The min attribute of the control. -- **minLength**: `number` — The minimum string length required by the control. -- **outlined**: `boolean` — Whether the control will have outlined appearance. -- **pattern**: `string` — The pattern attribute of the control. -- **placeholder**: `string` — The placeholder attribute of the control. -- **readOnly**: `boolean` — Makes the control a readonly field. -- **step**: `number` — The step attribute of the control. -- **type**: `InputType` — The type attribute of the control. -- **validateOnly**: `boolean` — Enables validation rules to be evaluated without restricting user input. This applies to the maxLength property for -string-type inputs or allows spin buttons to exceed the predefined min/max limits for number-type inputs. -- **value**: `string` — The value of the control. -- **blur**(): void — Removes focus from the control. -- **focus**(options?: FocusOptions): void — Sets focus on the control. -- **select**(): void — Selects all the text inside the input. -- **setRangeText**(replacement: string, start?: number, end?: number, selectMode?: RangeTextSelectMode): void — Replaces the selected text in the input. -- **setSelectionRange**(start?: number, end?: number, direction?: SelectionRangeDirection): void — Sets the text selection range of the control -- **stepDown**(n?: number): void — Decrements the numeric value of the input by one or more steps. -- **stepUp**(n?: number): void — Increments the numeric value of the input by one or more steps. - -### [IgrLinearProgress](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrLinearProgress) -A linear progress indicator used to express unspecified wait time or display -the length of a process. - -- **animationDuration**: `number` — Animation duration in milliseconds. -- **hideLabel**: `boolean` — Shows/hides the label of the control. -- **indeterminate**: `boolean` — The indeterminate state of the control. -- **labelAlign**: `LinearProgressLabelAlign` — The position for the default label of the control. -- **labelFormat**: `string` — Format string for the default label of the control. -Placeholders: - {0} - current value of the control. - {1} - max value of the control. -- **max**: `number` — Maximum value of the control. -- **striped**: `boolean` — Sets the striped look of the control. -- **value**: `number` — The value of the control. -- **variant**: `StyleVariant` — The variant of the control. - -### [IgrList](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrList) -Displays a collection of data items in a templatable list format. - - -### [IgrListHeader](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrListHeader) -Header list item. - - -### [IgrListItem](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrListItem) -The list-item component is a container -intended for row items in the list component. - -- **selected**: `boolean` — Defines if the list item is selected or not. - -### [IgrMaskInput](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrMaskInput) -A masked input is an input field where a developer can control user input and format the visible value, -based on configurable rules - -- **label**: `string` — The label for the control. -- **mask**: `string` — The masked pattern of the component. -- **mask**: `string` — The masked pattern of the component. -- **outlined**: `boolean` — Whether the control will have outlined appearance. -- **placeholder**: `string` — The placeholder attribute of the control. -- **prompt**: `string` — The prompt symbol to use for unfilled parts of the mask pattern. -- **prompt**: `string` — The prompt symbol to use for unfilled parts of the mask pattern. -- **readOnly**: `boolean` — Makes the control a readonly field. -- **value**: `string` — The value of the input. - -Regardless of the currently set `value-mode`, an empty value will return an empty string. -- **valueMode**: `MaskInputValueMode` — Dictates the behavior when retrieving the value of the control: - -- raw: Returns clean input (e.g. "5551234567") -- withFormatting: Returns with mask formatting (e.g. "(555) 123-4567") - -Empty values always return an empty string, regardless of the value mode. -- **blur**(): void — Removes focus from the control. -- **focus**(options?: FocusOptions): void — Sets focus on the control. -- **isValidMaskPattern**(): boolean — Returns whether the current masked input is valid according to the mask pattern. -- **select**(): void — Selects all the text inside the input. -- **setRangeText**(replacement: string, start?: number, end?: number, selectMode?: RangeTextSelectMode): void — Replaces the selected text in the control and re-applies the mask -- **setSelectionRange**(start?: number, end?: number, direction?: SelectionRangeDirection): void — Sets the text selection range of the control - -### [IgrNavbar](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrNavbar) -A navigation bar component is used to facilitate navigation through -a series of hierarchical screens within an app. - - -### [IgrNavDrawer](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrNavDrawer) -Represents a side navigation container that provides -quick access between views. - -- **open**: `boolean` — Determines whether the drawer is opened. -- **position**: `NavDrawerPosition` — The position of the drawer. -- **hide**(): Promise — Closes the drawer. -- **show**(): Promise — Opens the drawer. -- **toggle**(): Promise — Toggles the open state of the drawer. - -### [IgrNavDrawerHeaderItem](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrNavDrawerHeaderItem) -A wrapper for navigation drawer's header. - - -### [IgrNavDrawerItem](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrNavDrawerItem) -Represents a navigation drawer item. - -- **active**: `boolean` — Determines whether the drawer is active. -- **disabled**: `boolean` — Determines whether the drawer is disabled. - -### [IgrRadio](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrRadio) - -- **checked**: `boolean` — The checked state of the control. -- **labelPosition**: `ToggleLabelPosition` — The label position of the radio control. -- **required**: `boolean` -- **value**: `string` — The value attribute of the control. -- **blur**(): void — Removes focus from the radio control. -- **checkValidity**(): boolean — Checks for validity of the control and emits the invalid event if it invalid. -- **click**(): void — Simulates a click on the radio control. -- **focus**(options?: FocusOptions): void — Sets focus on the radio control. -- **reportValidity**(): boolean — Checks for validity of the control and shows the browser message if it invalid. -- **setCustomValidity**(message: string): void — Sets a custom validation message for the control. -As long as message is not empty, the control is considered invalid. - -### [IgrRadioGroup](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrRadioGroup) -The igc-radio-group component unifies one or more igc-radio buttons. - -- **alignment**: `ContentOrientation` — Alignment of the radio controls inside this group. -- **defaultValue**: `string` -- **name**: `string` — Gets/Sets the name for all child igc-radio components. -- **value**: `string` — Gets/Sets the checked igc-radio element that matches `value` - -### [IgrRangeSlider](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrRangeSlider) -A range slider component used to select two numeric values within a range. - -- **lower**: `number` — The current value of the lower thumb. -- **thumbLabelLower**: `string` — The aria label for the lower thumb. -- **thumbLabelUpper**: `string` — The aria label for the upper thumb. -- **upper**: `number` — The current value of the upper thumb. - -### [IgrRating](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrRating) -Rating provides insight regarding others' opinions and experiences, -and can allow the user to submit a rating of their own - -- **allowReset**: `boolean` — Whether to reset the rating when the user selects the same value. -- **hoverPreview**: `boolean` — Sets hover preview behavior for the component -- **label**: `string` — The label of the control. -- **max**: `number` — The maximum value for the rating. - -If there are projected symbols, the maximum value will be resolved -based on the number of symbols. -- **readOnly**: `boolean` — Makes the control a readonly field. -- **single**: `boolean` — Toggles single selection visual mode. -- **step**: `number` — The minimum value change allowed. - -Valid values are in the interval between 0 and 1 inclusive. -- **value**: `number` — The current value of the component -- **valueFormat**: `string` — A format string which sets aria-valuetext. Instances of '{0}' will be replaced -with the current value of the control and instances of '{1}' with the maximum value for the control. - -Important for screen-readers and useful for localization. -- **stepDown**(n?: number): void — Decrements the value of the control by n steps multiplied by -the step factor. -- **stepUp**(n?: number): void — Increments the value of the control by n steps multiplied by the -step factor. - -### [IgrRatingSymbol](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrRatingSymbol) -Used when a custom icon/symbol/element needs to be passed to the igc-rating component. - -- **connectedCallback**(): void — Invoked when the component is added to the document's DOM. - -In connectedCallback() you should setup tasks that should only occur when -the element is connected to the document. The most common of these is -adding event listeners to nodes external to the element, like a keydown -event handler added to the window. - -connectedCallback() { - super.connectedCallback(); - addEventListener('keydown', this._handleKeydown); -} - - -Typically, anything done in connectedCallback() should be undone when the -element is disconnected, in disconnectedCallback(). - -### [IgrRipple](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrRipple) -A ripple can be applied to an element to represent -interactive surface. - - -### [IgrSelect](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrSelect) -Represents a control that provides a menu of options. - -- **autofocus**: `boolean` — The autofocus attribute of the control. -- **distance**: `number` — The distance of the select dropdown from its input. -- **label**: `string` — The label attribute of the control. -- **outlined**: `boolean` — The outlined attribute of the control. -- **placeholder**: `string` — The placeholder attribute of the control. -- **placement**: `PopoverPlacement` — The preferred placement of the select dropdown around its input. -- **scrollStrategy**: `PopoverScrollStrategy` — Determines the behavior of the component during scrolling of the parent container. -- **value**: `string` — The value attribute of the control. -- **groups**: `any` — Returns the groups of the igc-select component. -- **items**: `any` — Returns the items of the igc-select component. -- **selectedItem**: `any` — Returns the selected item from the dropdown or null. -- **blur**(): void — Removes focus from the component. -- **clearSelection**(): void — Resets the current value and selection of the component. -- **focus**(options?: FocusOptions): void — Sets focus on the component. -- **navigateTo**(value: string): IgcSelectItemComponent — Navigates to the item with the specified value. If it exists, returns the found item, otherwise - null. -- **navigateTo**(index: number): IgcSelectItemComponent — Navigates to the item at the specified index. If it exists, returns the found item, otherwise - null. -- **reportValidity**(): boolean — Checks the validity of the control and moves the focus to it if it is not valid. -- **select**(value: string): IgcSelectItemComponent — Selects the item with the specified value. If it exists, returns the found item, otherwise - null. -- **select**(index: number): IgcSelectItemComponent — Selects the item at the specified index. If it exists, returns the found item, otherwise - null. - -### [IgrSelectGroup](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrSelectGroup) - -- **disabled**: `boolean` — Whether the group item and all its children are disabled. -- **items**: `IgcSelectItemComponent[]` — All child igc-select-items. - -### [IgrSelectHeader](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrSelectHeader) -Represents a header item in an igc-select component. - - -### [IgrSelectItem](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrSelectItem) -Represents an item in a select list. - -- **active**: `boolean` — Whether the item is disabled. -- **active**: `boolean` — Whether the item is active. -- **disabled**: `boolean` — Whether the item is disabled. -- **selected**: `boolean` — Whether the item is selected. -- **value**: `string` — The current value of the item. -If not specified, the element's text content is used. - -### [IgrSlider](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrSlider) -A slider component used to select numeric value within a range. - -- **value**: `number` — The current value of the component. -- **stepDown**(stepDecrement?: number): void — Decrements the value of the slider by stepDecrement * step, where stepDecrement defaults to 1. -- **stepUp**(stepIncrement?: number): void — Increments the value of the slider by stepIncrement * step, where stepIncrement defaults to 1. - -### [IgrSliderLabel](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrSliderLabel) -Allows formatting the values of the slider as string values. -The text content of the slider labels is used for thumb and tick labels. - - -### [IgrSnackbar](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrSnackbar) -A snackbar component is used to provide feedback about an operation -by showing a brief message at the bottom of the screen. - -- **actionText**: `string` — The snackbar action button. - -### [IgrStep](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrStep) -The step component is used within the igc-stepper element and it holds the content of each step. -It also supports custom indicators, title and subtitle. - -- **active**: `boolean` — Gets/sets whether the step is activе. -- **complete**: `boolean` — Gets/sets whether the step is completed. -- **contentBody**: `HTMLElement` -- **disabled**: `boolean` — Gets/sets whether the step is interactable. -- **header**: `HTMLElement` -- **invalid**: `boolean` — Gets/sets whether the step is invalid. -- **optional**: `boolean` — Gets/sets whether the step is optional. -- **isAccessible**: `any` - -### [IgrStepper](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrStepper) -IgxStepper provides a wizard-like workflow by dividing content into logical steps. - -- **animationDuration**: `number` — The animation duration in either vertical or horizontal mode. -- **contentTop**: `boolean` — Get/Set whether the content is displayed above the steps. -- **horizontalAnimation**: `HorizontalTransitionAnimation` — The animation type when in horizontal mode. -- **linear**: `boolean` — Get/Set whether the stepper is linear. -- **orientation**: `StepperOrientation` — Gets/Sets the orientation of the stepper. -- **steps**: `IgcStepComponent[]` — Returns all of the stepper's steps. -- **stepType**: `StepperStepType` — Get/Set the type of the steps. -- **titlePosition**: `StepperTitlePosition` — Get/Set the position of the steps title. -- **verticalAnimation**: `StepperVerticalAnimation` — The animation type when in vertical mode. -- **connectedCallback**(): void — Invoked when the component is added to the document's DOM. - -In connectedCallback() you should setup tasks that should only occur when -the element is connected to the document. The most common of these is -adding event listeners to nodes external to the element, like a keydown -event handler added to the window. - -connectedCallback() { - super.connectedCallback(); - addEventListener('keydown', this._handleKeydown); -} - - -Typically, anything done in connectedCallback() should be undone when the -element is disconnected, in disconnectedCallback(). -- **navigateTo**(index: number): void — Activates the step at a given index. -- **next**(): void — Activates the next enabled step. -- **prev**(): void — Activates the previous enabled step. -- **reset**(): void — Resets the stepper to its initial state i.e. activates the first step. - -### [IgrSwitch](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrSwitch) -Similar to a checkbox, a switch controls the state of a single setting on or off. - -- **checked**: `boolean` — The checked state of the control. -- **labelPosition**: `ToggleLabelPosition` — The label position of the control. -- **value**: `string` — The value attribute of the control. -- **blur**(): void — Removes focus from the control. -- **click**(): void — Simulates a click on the control. -- **focus**(options?: FocusOptions): void — Sets focus on the control. - -### [IgrTab](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrTab) -A tab element slotted into an igc-tabs container. - -- **disabled**: `boolean` — Determines whether the tab is disabled. -- **label**: `string` — The tab item label. -- **selected**: `boolean` — Determines whether the tab is selected. - -### [IgrTabs](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrTabs) -Tabs organize and allow navigation between groups of content that are related and at the same level of hierarchy. - -The component allows the user to navigate between multiple elements. -It supports keyboard navigation and provides API methods to control the selected tab. - -- **activation**: `TabsActivation` — Determines the tab activation. When set to auto, -the tab is instantly selected while navigating with the Left/Right Arrows, Home or End keys -and the corresponding panel is displayed. -When set to manual, the tab is only focused. The selection happens after pressing Space or Enter. -- **alignment**: `TabsAlignment` — Sets the alignment for the tab headers -- **selected**: `any` — Returns the currently selected tab label or IDREF if no label property is set. -- **tabs**: `any` — Returns the direct `igc-tab` elements that are children of this element. -- **select**(id: string): void — Selects the specified tab and displays the corresponding panel. -- **select**(ref: IgcTabComponent): void — Selects the specified tab and displays the corresponding panel. - -### [IgrTextarea](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrTextarea) -This element represents a multi-line plain-text editing control, -useful when you want to allow users to enter a sizeable amount of free-form text, -for example a comment on a review or feedback form. - -- **autocapitalize**: `string` — Controls whether and how text input is automatically capitalized as it is entered/edited by the user. - -[MDN documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autocapitalize). -- **autocomplete**: `string` — Specifies what if any permission the browser has to provide for automated assistance in filling out form field values, -as well as guidance to the browser as to the type of information expected in the field. -Refer to [this page](https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/autocomplete) for additional information. -- **inputMode**: `string` — Hints at the type of data that might be entered by the user while editing the element or its contents. -This allows a browser to display an appropriate virtual keyboard. - -[MDN documentation](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/inputmode) -- **label**: `string` — The label for the control. -- **maxLength**: `number` — The maximum number of characters (UTF-16 code units) that the user can enter. -If this value isn't specified, the user can enter an unlimited number of characters. -- **minLength**: `number` — The minimum number of characters (UTF-16 code units) required that the user should enter. -- **outlined**: `boolean` — Whether the control will have outlined appearance. -- **placeholder**: `string` — The placeholder attribute of the control. -- **readOnly**: `boolean` — Makes the control a readonly field. -- **resize**: `TextareaResize` — Controls whether the control can be resized. -When auto is set, the control will try to expand and fit its content. -- **rows**: `number` — The number of visible text lines for the control. If it is specified, it must be a positive integer. -If it is not specified, the default value is 3. -- **spellcheck**: `boolean` — Controls whether the element may be checked for spelling errors. -- **validateOnly**: `boolean` — Enables validation rules to be evaluated without restricting user input. This applies to the maxLength property -when it is defined. -- **value**: `string` — The value of the component -- **wrap**: `"off" | "hard" | "soft"` — Indicates how the control should wrap the value for form submission. -Refer to [this page on MDN](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/textarea#attributes) -for explanation of the available values. -- **scrollTo**(options?: ScrollToOptions): void — [MDN Reference](https://developer.mozilla.org/docs/Web/API/Element/scrollTo) -- **scrollTo**(x: number, y: number): void -- **select**(): void — Selects all text within the control. -- **setRangeText**(replacement: string, start: number, end: number, selectMode?: RangeTextSelectMode): void — Replaces the selected text in the control. -- **setSelectionRange**(start: number, end: number, direction?: SelectionRangeDirection): void — Sets the text selection range of the control - -### [IgrThemeProvider](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrThemeProvider) -A theme provider component that uses Lit context to provide theme information -to descendant components. - -This component allows you to scope a theme to a specific part of the page. -All library components within this provider will use the specified theme -instead of the global theme. - -- **theme**: `Theme` — The theme to provide to descendant components. -- **variant**: `ThemeVariant` — The theme variant to provide to descendant components. - -### [IgrTile](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrTile) -The tile component is used within the igc-tile-manager as a container -for displaying various types of information. - -- **_tileContent**: `HTMLElement` -- **colSpan**: `number` — The number of columns the tile will span. -- **colStart**: `number` — The starting column for the tile. -- **disableFullscreen**: `boolean` — Whether to disable the rendering of the tile fullscreen-action slot and its -default fullscreen action button. -- **disableMaximize**: `boolean` — Whether to disable the rendering of the tile maximize-action slot and its -default maximize action button. -- **disableResize**: `boolean` — Indicates whether to disable tile resize behavior regardless -ot its tile manager parent settings. -- **maximized**: `boolean` — Indicates whether the tile occupies all available space within the layout. -- **position**: `number` — Gets/sets the tile's visual position in the layout. -Corresponds to the CSS `order` property. -- **rowSpan**: `number` — The number of rows the tile will span. -- **rowStart**: `number` — The starting row for the tile. -- **fullscreen**: `any` — Indicates whether the tile occupies the whole screen. - -### [IgrTileManager](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrTileManager) -The tile manager component enables the dynamic arrangement, resizing, and interaction of tiles. - -- **columnCount**: `number` — Sets the number of columns for the tile manager. -Setting value <= than zero will trigger a responsive layout. -- **dragMode**: `TileManagerDragMode` — Whether drag and drop operations are enabled. -- **gap**: `string` — Sets the gap size between tiles in the tile manager. -- **minColumnWidth**: `string` — Sets the minimum width for a column unit in the tile manager. -- **minRowHeight**: `string` — Sets the minimum height for a row unit in the tile manager. -- **resizeMode**: `TileManagerResizeMode` — Whether resize operations are enabled. -- **tiles**: `any` — Gets the tiles sorted by their position in the layout. -- **loadLayout**(data: string): void — Restores a previously serialized state produced by saveLayout. -- **saveLayout**(): string — Returns the properties of the current tile collections as a JSON payload. - -### [IgrToast](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrToast) -A toast component is used to show a notification - -- **displayTime**: `number` — Determines the duration in ms in which the component will be visible. -- **keepOpen**: `boolean` — Determines whether the component should close after the displayTime is over. -- **open**: `boolean` — Whether the component is in shown state. -- **position**: `AbsolutePosition` — Sets the position of the component in the viewport. -- **hide**(): Promise — Closes the component. -- **show**(): Promise — Opens the component. -- **toggle**(): Promise — Toggles the open state of the component. - -### [IgrToggleButton](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrToggleButton) -The igc-toggle-button wraps a native button element and exposes additional value and selected properties. -It is used in the context of an igc-button-group to facilitate the creation of group/toolbar like UX behaviors. - -- **disabled**: `boolean` — Determines whether the button is disabled. -- **selected**: `boolean` — Determines whether the button is selected. -- **value**: `string` — The value attribute of the control. -- **blur**(): void — Removes focus from the button. -- **click**(): void — Simulates a mouse click on the element. -- **focus**(options?: FocusOptions): void — Sets focus on the button. - -### [IgrTooltip](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrTooltip) -Provides a way to display supplementary information related to an element when a user interacts with it (e.g., hover, focus). -It offers features such as placement customization, delays, sticky mode, and animations. - -- **anchor**: `string | Element` — An element instance or an IDREF to use as the anchor for the tooltip. -- **hideDelay**: `number` — Specifies the number of milliseconds that should pass before hiding the tooltip. -- **hideTriggers**: `string` — Which event triggers will hide the tooltip. -Expects a comma separate string of different event triggers. -- **message**: `string` — Specifies a plain text as tooltip content. -- **offset**: `number` — The offset of the tooltip from the anchor in pixels. -- **open**: `boolean` — Whether the tooltip is showing. -- **placement**: `PopoverPlacement` — Where to place the floating element relative to the parent anchor element. -- **showDelay**: `number` — Specifies the number of milliseconds that should pass before showing the tooltip. -- **showTriggers**: `string` — Which event triggers will show the tooltip. -Expects a comma separate string of different event triggers. -- **sticky**: `boolean` — Specifies if the tooltip remains visible until the user closes it via the close button or Esc key. -- **withArrow**: `boolean` — Whether to render an arrow indicator for the tooltip. -- **hide**(): Promise — Hides the tooltip if not already hidden. -- **show**(target?: string | Element): Promise — Shows the tooltip if not already showing. - If a target is provided, sets it as a transient anchor. -- **toggle**(): Promise — Toggles the tooltip between shown/hidden state - -### [IgrTree](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrTree) -The tree allows users to represent hierarchical data in a tree-view structure, -maintaining parent-child relationships, as well as to define static tree-view structure without a corresponding data model. - -- **locale**: `string` — Gets/Sets the locale used for getting language, affecting resource strings. -- **resourceStrings**: `ITreeResourceStrings` — The resource strings for localization. -Currently only aria-labels of the default expand/collapse icons are localized for the tree item. -- **selection**: `TreeSelection` — The selection state of the tree. -- **singleBranchExpand**: `boolean` — Whether a single or multiple of a parent's child items can be expanded. -- **toggleNodeOnClick**: `boolean` — Whether clicking over nodes will change their expanded state or not. -- **items**: `any` — Returns all of the tree's items. -- **collapse**(items?: IgcTreeItemComponent[]): void — Collapses all of the passed items. -If no items are passed, collapses ALL items. -- **connectedCallback**(): void — Invoked when the component is added to the document's DOM. - -In connectedCallback() you should setup tasks that should only occur when -the element is connected to the document. The most common of these is -adding event listeners to nodes external to the element, like a keydown -event handler added to the window. - -connectedCallback() { - super.connectedCallback(); - addEventListener('keydown', this._handleKeydown); -} - - -Typically, anything done in connectedCallback() should be undone when the -element is disconnected, in disconnectedCallback(). -- **deselect**(items?: IgcTreeItemComponent[]): void — Deselect all items if the items collection is empty. Otherwise, deselect the items in the items collection. -- **expand**(items?: IgcTreeItemComponent[]): void — Expands all of the passed items. -If no items are passed, expands ALL items. -- **expandToItem**(item: IgcTreeItemComponent): void -- **select**(items?: IgcTreeItemComponent[]): void — Select all items if the items collection is empty. Otherwise, select the items in the items collection. - -### [IgrTreeItem](https://www.infragistics.com/api/react/igniteui-react/19.5.1/classes/IgrTreeItem) -The tree-item component represents a child item of the tree component or another tree item. - -- **active**: `boolean` — Marks the item as the tree's active item. -- **disabled**: `boolean` — Get/Set whether the tree item is disabled. Disabled items are ignored for user interactions. -- **expanded**: `boolean` — The tree item expansion state. -- **label**: `string` — The tree item label. -- **level**: `number` — The depth of the item, relative to the root. -- **loading**: `boolean` — To be used for load-on-demand scenarios in order to specify whether the item is loading data. -- **parent**: `IgcTreeItemComponent` — The parent item of the current tree item (if any) -- **selected**: `boolean` — The tree item selection state. -- **tree**: `IgcTreeComponent` — A reference to the tree the item is a part of. -- **value**: `any` — The value entry that the tree item is visualizing. Required for searching through items. -- **path**: `any` — The full path to the tree item, starting from the top-most ancestor. -- **collapse**(): void — Collapses the tree item. -- **collapseWithEvent**(): Promise — Collapses the tree item. -- **connectedCallback**(): void — Invoked when the component is added to the document's DOM. - -In connectedCallback() you should setup tasks that should only occur when -the element is connected to the document. The most common of these is -adding event listeners to nodes external to the element, like a keydown -event handler added to the window. - -connectedCallback() { - super.connectedCallback(); - addEventListener('keydown', this._handleKeydown); -} - - -Typically, anything done in connectedCallback() should be undone when the -element is disconnected, in disconnectedCallback(). -- **disconnectedCallback**(): void — Invoked when the component is removed from the document's DOM. - -This callback is the main signal to the element that it may no longer be -used. disconnectedCallback() should ensure that nothing is holding a -reference to the element (such as event listeners added to nodes external -to the element), so that it is free to be garbage collected. - -disconnectedCallback() { - super.disconnectedCallback(); - window.removeEventListener('keydown', this._handleKeydown); -} - - -An element may be re-connected after being disconnected. -- **expand**(): void — Expands the tree item. -- **expandWithEvent**(): Promise — Expands the tree item. -- **getChildren**(options?: any): IgcTreeItemComponent[] — Returns a collection of child items. -If the parameter value is true returns all tree item's direct children, -otherwise - only the direct children. -- **toggle**(): void — Toggles tree item expansion state. - -## Interfaces - -### [BaseColumnConfiguration](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/BaseColumnConfiguration) -Configuration object for grid columns. - -- **cellTemplate?**: `any` — Cell template callback. -- **dataType?**: `DataType` — The type of data this column will reference. - -Affects the default filter operands if the column is with filtering enabled. -- **field**: `K` — The field from the data for this column. -- **filterable?**: `boolean` — Whether the column can be filtered. -- **filteringCaseSensitive?**: `boolean` — Whether the filter operations will be case sensitive. -- **header?**: `string` — Optional text to display in the column header. By default, the column field is used -to render the header text. -- **headerTemplate?**: `any` — Header template callback. -- **hidden?**: `boolean` — Whether the column is hidden or not. -- **resizable?**: `boolean` — Whether the the column can be resized or not. -- **sortable?**: `boolean` — Whether the column can be sorted. -- **sortConfiguration?**: `ColumnSortConfiguration` — Sort configuration options for the column (e.g., custom comparer). -- **sortingCaseSensitive?**: `boolean` — Whether the sort operations will be case sensitive. -- **width?**: `string` — Width for the current column. - -Accepts most CSS units for controlling width. - -### [BaseColumnSortConfiguration](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/BaseColumnSortConfiguration) -Extended sort configuration for a column. - -- **comparer?**: `SortComparer` — Custom comparer function for sort operations for this column. - -### [BaseFilterExpression](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/BaseFilterExpression) -Represents a filter operation for a given column. - -- **caseSensitive?**: `boolean` — Whether the sort operation should be case sensitive. -- **condition**: `FilterOperation> | OperandKeys>` — The filter function which will be executed against the data records. -- **criteria?**: `FilterCriteria` — Dictates how this expression should resolve in the filter operation in relation to -other expressions. -- **key**: `K` — The target column for the filter operation. -- **searchTerm?**: `PropertyType` — The filtering value used in the filter condition function. - -### [BaseIgcCellContext](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/BaseIgcCellContext) -Context object for the row cell template callback. - -- **column**: `ColumnConfiguration` — The current configuration for the column. -- **parent**: `IgcGridLiteCell` — The cell element parent of the template. -- **row**: `IgcGridLiteRow` — The row element containing the cell. -- **value**: `PropertyType` — The value from the data source for this cell. - -### [BaseSortingExpression](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/BaseSortingExpression) -Represents a sort operation for a given column. - -- **caseSensitive?**: `boolean` — Whether the sort operation should be case sensitive. -- **comparer?**: `SortComparer` — Custom comparer function for this operation. -- **direction**: `SortingDirection` — Sort direction for this operation. -- **key**: `K` — The target column. - -### [ChatAttachmentRenderContext](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/ChatAttachmentRenderContext) -The context object for renderers that deal with a specific attachment within a message. -It extends the message context with the attachment data. - -- **attachment**: `IgcChatMessageAttachment` — The specific attachment being rendered. - -### [ChatInputRenderContext](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/ChatInputRenderContext) -The context object for renderers that deal with the chat input area. -It extends the base context with input-specific properties. - -- **attachments**: `IgcChatMessageAttachment[]` — The list of attachments currently in the input area. -- **value**: `string` — The current value of the input field. - -### [ChatMessageRenderContext](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/ChatMessageRenderContext) -The context object for renderers that deal with a specific chat message. -It extends the base context with the message data. - -- **message**: `IgcChatMessage` — The specific chat message being rendered. - -### [ChatRenderContext](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/ChatRenderContext) -The base context object passed to custom renderer functions, containing the chat component instance. - -- **instance**: `IgcChatComponent` — The instance of the IgcChatComponent. - -### [ChatRenderers](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/ChatRenderers) -A collection of optional rendering functions that allow for custom UI rendering. -Each property is a function that takes a context object and returns a template result. - -- **attachment?**: `ChatTemplateRenderer` — Custom renderer for a single chat message attachment. -- **attachmentContent?**: `ChatTemplateRenderer` — Custom renderer for the content of an attachment. -- **attachmentHeader?**: `ChatTemplateRenderer` — Custom renderer for the header of an attachment. -- **fileUploadButton?**: `ChatTemplateRenderer` — Custom renderer for the file upload button in the input area. -- **input?**: `ChatTemplateRenderer` — Custom renderer for the main chat input field. -- **inputActions?**: `ChatTemplateRenderer` — Custom renderer for the actions container within the input area. -- **inputActionsEnd?**: `ChatTemplateRenderer` — Custom renderer for the actions at the end of the input area. -- **inputActionsStart?**: `ChatTemplateRenderer` — Custom renderer for the actions at the start of the input area. -- **inputAttachments?**: `ChatTemplateRenderer` — Custom renderer for the attachment previews within the input field. -- **message?**: `ChatTemplateRenderer` — Custom renderer for an entire chat message bubble. -- **messageActions?**: `ChatTemplateRenderer` — Custom renderer for message-specific actions (e.g., reply or delete buttons). -- **messageAttachments?**: `ChatTemplateRenderer` — Custom renderer for the attachments associated with a message. -- **messageContent?**: `ChatTemplateRenderer` — Custom renderer for the main text and content of a message. -- **messageHeader?**: `ChatTemplateRenderer` — Custom renderer for the header of a message, including sender and timestamp. -- **sendButton?**: `ChatTemplateRenderer` — Custom renderer for the message send button. -- **suggestionPrefix?**: `ChatTemplateRenderer` — Custom renderer for the prefix text shown before suggestions. - -### [ComboTemplateProps](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/ComboTemplateProps) - -- **item**: `T` - -### [CustomDateRange](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/CustomDateRange) - -- **dateRange**: `DateRangeValue` -- **label**: `string` - -### [CustomEvent](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/CustomEvent) -[MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent) - -- **detail**: `T` — Returns any custom data event was created with. Typically used for synthetic events. - -[MDN Reference](https://developer.mozilla.org/docs/Web/API/CustomEvent/detail) - -### [DataPipelineConfiguration](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/DataPipelineConfiguration) -Configuration for customizing the various data operations of the grid. - -- **filter?**: `DataPipelineHook` — Hook for customizing filter operations. -- **sort?**: `DataPipelineHook` — Hook for customizing sort operations. - -### [DatePartDeltas](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/DatePartDeltas) - -- **date?**: `number` -- **hours?**: `number` -- **minutes?**: `number` -- **month?**: `number` -- **seconds?**: `number` -- **year?**: `number` - -### [DateRangeDescriptor](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/DateRangeDescriptor) - -- **dateRange?**: `Date[]` -- **type**: `DateRangeType` - -### [DateRangeValue](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/DateRangeValue) - -- **end**: `Date` -- **start**: `Date` - -### [FilteringOptions](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/FilteringOptions) - -- **caseSensitive?**: `boolean` -- **filterKey**: `any` -- **matchDiacritics?**: `boolean` - -### [FilterOperation](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/FilterOperation) - -- **label?**: `string` -- **logic**: `FilterOperationLogic` -- **name**: `string` -- **unary**: `boolean` - -### [GridLiteSortingOptions](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/GridLiteSortingOptions) -Configures the sort behavior for the grid. - -- **mode**: `"multiple" | "single"` — The sorting mode - either 'single' or 'multiple' column sorting. - -### [ICalendarResourceStrings](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/ICalendarResourceStrings) - -- **calendar_first_picker_of?**: `string` -- **calendar_multi_selection?**: `string` -- **calendar_next_month?**: `string` -- **calendar_next_year?**: `string` -- **calendar_next_years?**: `string` -- **calendar_previous_month?**: `string` -- **calendar_previous_year?**: `string` -- **calendar_previous_years?**: `string` -- **calendar_range_end?**: `string` -- **calendar_range_label_end?**: `string` -- **calendar_range_label_start?**: `string` -- **calendar_range_placeholder?**: `string` -- **calendar_range_selection?**: `string` -- **calendar_range_start?**: `string` -- **calendar_select_date?**: `string` -- **calendar_select_month?**: `string` -- **calendar_select_year?**: `string` -- **calendar_selected_month_is?**: `string` -- **calendar_single_selection?**: `string` -- **calendar_singular_multi_selection?**: `string` -- **calendar_singular_range_selection?**: `string` -- **calendar_singular_single_selection?**: `string` - -### [ICarouselResourceStrings](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/ICarouselResourceStrings) - -- **carousel_next_slide?**: `string` -- **carousel_of?**: `string` -- **carousel_previous_slide?**: `string` -- **carousel_slide?**: `string` - -### [IChipResourceStrings](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IChipResourceStrings) - -- **chip_remove?**: `string` -- **chip_select?**: `string` - -### [IComboResourceStrings](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IComboResourceStrings) - -- **combo_addCustomValues_placeholder?**: `string` -- **combo_aria_label_no_options?**: `string` -- **combo_aria_label_options?**: `string` -- **combo_clearItems_placeholder?**: `string` -- **combo_empty_message?**: `string` -- **combo_filter_search_placeholder?**: `string` - -### [IconMeta](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IconMeta) - -- **collection**: `string` -- **external?**: `boolean` -- **name**: `string` - -### [IDateRangePickerResourceStrings](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IDateRangePickerResourceStrings) - -- **date_range_picker_cancel_button?**: `string` -- **date_range_picker_currentMonth?**: `string` -- **date_range_picker_date_separator?**: `string` -- **date_range_picker_done_button?**: `string` -- **date_range_picker_last30Days?**: `string` -- **date_range_picker_last7Days?**: `string` -- **date_range_picker_yearToDate?**: `string` - -### [IFileInputResourceStrings](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IFileInputResourceStrings) - -- **file_input_placeholder?**: `string` -- **file_input_upload_button?**: `string` - -### [IgrActiveStepChangedEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrActiveStepChangedEventArgsDetail) - -- **index**: `number` - -### [IgrActiveStepChangingEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrActiveStepChangingEventArgsDetail) - -- **newIndex**: `number` -- **oldIndex**: `number` - -### [IgrCalendarResourceStrings](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrCalendarResourceStrings) - -- **endDate**: `string` -- **nextMonth**: `string` -- **nextYear**: `string` -- **nextYears**: `string` -- **previousMonth**: `string` -- **previousYear**: `string` -- **previousYears**: `string` -- **selectDate**: `string` -- **selectedDate**: `string` -- **selectMonth**: `string` -- **selectRange**: `string` -- **selectYear**: `string` -- **startDate**: `string` -- **weekLabel**: `string` - -### [IgrChatMessage](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrChatMessage) -Represents a single chat message in the conversation. - -- **attachments?**: `IgcChatMessageAttachment[]` — Optional list of attachments associated with the message, -such as images, files, or links. -- **id**: `string` — A unique identifier for the message. -- **reactions?**: `string[]` — Optional list of reactions associated with the message. -- **sender**: `string` — The identifier or name of the sender of the message. -- **text**: `string` — The textual content of the message. -- **timestamp?**: `string` — The timestamp indicating when the message was sent. - -### [IgrChatMessageAttachment](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrChatMessageAttachment) -Represents an attachment associated with a chat message. - -- **file?**: `File` — The actual File object, if the attachment was provided locally (e.g. via upload). -- **id**: `string` — A unique identifier for the attachment. -- **name**: `string` — The display name of the attachment (e.g. file name). -- **thumbnail?**: `string` — Optional URL to a thumbnail preview of the attachment (e.g. for images or videos). -- **type?**: `string` — The MIME type or a custom type identifier for the attachment (e.g. "image/png", "pdf", "audio"). -- **url?**: `string` — The URL from which the attachment can be downloaded or viewed. -Typically used for attachments stored on a server or CDN. - -### [IgrChatMessageReaction](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrChatMessageReaction) -Represents a user's reaction to a specific chat message. - -- **message**: `IgcChatMessage` — The chat message that the reaction is associated with. -- **reaction**: `string` — The string representation of the reaction, such as an emoji or a string; - -### [IgrChatResourceStrings](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrChatResourceStrings) - -- **attachmentLabel**: `string` -- **attachmentsListLabel**: `string` -- **messageCopied**: `string` -- **reactionCopy**: `string` -- **reactionDislike**: `string` -- **reactionLike**: `string` -- **reactionRegenerate**: `string` -- **suggestionsHeader**: `string` - -### [IgrCheckboxChangeEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrCheckboxChangeEventArgsDetail) - -- **checked**: `boolean` -- **value?**: `string` - -### [IgrComboChangeEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrComboChangeEventArgsDetail) - -- **items**: `T[]` -- **newValue**: `ComboValue[]` -- **type**: `ComboChangeType` - -### [IgrDateRangePickerResourceStrings](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrDateRangePickerResourceStrings) - -- **cancel**: `string` -- **currentMonth**: `string` -- **done**: `string` -- **last30Days**: `string` -- **last7Days**: `string` -- **separator**: `string` -- **yearToDate**: `string` - -### [IgrFilteredEvent](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrFilteredEvent) -Event object for the filtered event of the grid. - -- **key**: `Keys` — The target column for the filter operation. -- **state**: `FilterExpression[]` — The filter state of the column after the operation. - -### [IgrFilteringEvent](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrFilteringEvent) -Event object for the filtering event of the grid. - -- **expressions**: `FilterExpression[]` — The filter expression(s) to apply. -- **key**: `Keys` — The target column for the filter operation. -- **type**: `"remove" | "add" | "modify"` — The type of modification which will be applied to the filter -state of the column. - -### [IgrHeaderContext](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrHeaderContext) -Context object for the column header template callback. - -- **column**: `ColumnConfiguration | ColumnConfiguration> | ColumnConfiguration>` — The current configuration for the column. -- **parent**: `IgcGridLiteHeader` — The header element parent of the template. - -### [IgrRadioChangeEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrRadioChangeEventArgsDetail) - -- **checked**: `boolean` -- **value?**: `string` - -### [IgrRangeSliderValueEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrRangeSliderValueEventArgsDetail) - -- **lower**: `number` -- **upper**: `number` - -### [IgrTileChangeStateEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrTileChangeStateEventArgsDetail) - -- **state**: `boolean` -- **tile**: `IgcTileComponent` - -### [IgrTreeSelectionEventArgsDetail](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/IgrTreeSelectionEventArgsDetail) - -- **newSelection**: `IgcTreeItemComponent[]` - -### [ITreeResourceStrings](https://www.infragistics.com/api/react/igniteui-react/19.5.1/interfaces/ITreeResourceStrings) - -- **collapse?**: `string` -- **expand?**: `string` - -## Enumerations - -### [DatePart](https://www.infragistics.com/api/react/igniteui-react/19.5.1/enums/DatePart) -Date Part Classes Module - -This module provides structured classes for date/time parts used in date-time input. -Each part type has its own class with specific validation and spin behavior. - -Classes are private to this module - only types and factory function are exported. - -- **AmPm** = "amPm" -- **Date** = "date" -- **Hours** = "hours" -- **Minutes** = "minutes" -- **Month** = "month" -- **Seconds** = "seconds" -- **Year** = "year" - -### [DateRangeType](https://www.infragistics.com/api/react/igniteui-react/19.5.1/enums/DateRangeType) - -- **After** = 0 -- **Before** = 1 -- **Between** = 2 -- **Specific** = 3 -- **Weekdays** = 4 -- **Weekends** = 5 - -## Type Aliases - -### [AbsolutePosition](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/AbsolutePosition) -`"bottom" | "middle" | "top"` - -### [AvatarShape](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/AvatarShape) -`"square" | "circle" | "rounded"` - -### [BadgeShape](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/BadgeShape) -`"rounded" | "square"` - -### [BaseSortComparer](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/BaseSortComparer) -`any` -Custom comparer function for a given column used when sorting is performed. - -### [ButtonGroupSelection](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/ButtonGroupSelection) -`"single" | "single-required" | "multiple"` - -### [ButtonVariant](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/ButtonVariant) -`"contained" | "flat" | "outlined" | "fab"` - -### [CalendarActiveView](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/CalendarActiveView) -`"days" | "months" | "years"` - -### [CalendarHeaderOrientation](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/CalendarHeaderOrientation) -`"horizontal" | "vertical"` - -### [CalendarSelection](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/CalendarSelection) -`"single" | "multiple" | "range"` - -### [CarouselIndicatorsOrientation](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/CarouselIndicatorsOrientation) -`"end" | "start"` - -### [ChatSuggestionsPosition](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/ChatSuggestionsPosition) -`"below-input" | "below-messages"` -A string literal type defining the two possible positions for chat suggestions. - -### [ChatTemplateRenderer](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/ChatTemplateRenderer) -`any` -A generic type for a function that serves as a custom renderer. -It takes a context object of type T and returns a template result. - -### [ColumnConfiguration](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/ColumnConfiguration) -`any` -See BaseColumnConfiguration for the full documentation. - -### [ColumnSortConfiguration](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/ColumnSortConfiguration) -`any` -See BaseColumnSortConfiguration for the full documentation. - -### [ComboItemTemplate](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/ComboItemTemplate) -`any` - -### [ContentOrientation](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/ContentOrientation) -`"horizontal" | "vertical"` - -### [DataPipelineHook](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/DataPipelineHook) -`any` -Callback function for customizing data operations in the grid. - -### [DataPipelineParams](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/DataPipelineParams) -`any` -The parameters passed to a DataPipelineHook callback. - -### [DataType](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/DataType) -`"number" | "string" | "boolean"` -The data for the current column. - -### [DividerType](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/DividerType) -`"solid" | "dashed"` - -### [ExpansionPanelIndicatorPosition](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/ExpansionPanelIndicatorPosition) -`"start" | "end" | "none"` - -### [FilterCriteria](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/FilterCriteria) -`"and" | "or"` -Controls how a data record should resolve in a filter operation: - - 'and' - the record must pass all the conditions. - - 'or' - the record must pass at least one condition. - -### [FilterExpression](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/FilterExpression) -`any` -See BaseFilterExpression for the full documentation. - -### [FilterOperationLogic](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/FilterOperationLogic) -`any` - -### [GroupingDirection](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/GroupingDirection) -`"asc" | "desc" | "none"` - -### [HorizontalTransitionAnimation](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/HorizontalTransitionAnimation) -`"slide" | "fade" | "none"` - -### [IconButtonVariant](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/IconButtonVariant) -`"contained" | "flat" | "outlined"` - -### [IgrActiveStepChangedEventArgs](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/IgrActiveStepChangedEventArgs) -`CustomEvent` - -### [IgrActiveStepChangingEventArgs](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/IgrActiveStepChangingEventArgs) -`CustomEvent` - -### [IgrCellContext](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/IgrCellContext) -`any` -See BaseIgcCellContext for the full documentation. - -### [IgrChatOptions](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/IgrChatOptions) -`any` -Configuration options for customizing the behavior and appearance of the chat component. - -### [IgrCheckboxChangeEventArgs](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/IgrCheckboxChangeEventArgs) -`CustomEvent` - -### [IgrComboChangeEventArgs](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/IgrComboChangeEventArgs) -`CustomEvent` - -### [IgrRadioChangeEventArgs](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/IgrRadioChangeEventArgs) -`CustomEvent` - -### [IgrRangeSliderValueEventArgs](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/IgrRangeSliderValueEventArgs) -`CustomEvent` - -### [IgrTileChangeStateEventArgs](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/IgrTileChangeStateEventArgs) -`CustomEvent` - -### [IgrTreeSelectionEventArgs](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/IgrTreeSelectionEventArgs) -`CustomEvent` - -### [InputType](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/InputType) -`"text" | "email" | "number" | "password" | "search" | "tel" | "url"` - -### [Keys](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/Keys) -`FlatKeys | NestedKeys` -Helper type for resolving keys of type T. - -### [LinearProgressLabelAlign](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/LinearProgressLabelAlign) -`"top-start" | "top" | "top-end" | "bottom-start" | "bottom" | "bottom-end"` - -### [MaskInputValueMode](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/MaskInputValueMode) -`"raw" | "withFormatting"` - -### [NavDrawerPosition](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/NavDrawerPosition) -`"start" | "end" | "top" | "bottom" | "relative"` - -### [OperandKeys](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/OperandKeys) -`any` - -### [PickerMode](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/PickerMode) -`"dropdown" | "dialog"` - -### [PopoverPlacement](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/PopoverPlacement) -`"top" | "top-start" | "top-end" | "bottom" | "bottom-start" | "bottom-end" | "right" | "right-start" | "right-end" | "left" | "left-start" | "left-end"` -Describes the preferred placement of a toggle component. - -### [PopoverScrollStrategy](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/PopoverScrollStrategy) -`"scroll" | "block" | "close"` - -### [PropertyType](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/PropertyType) -`any` -Helper type for resolving types of type T. - -### [RangeTextSelectMode](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/RangeTextSelectMode) -`"preserve" | "select" | "start" | "end"` - -### [SelectionRangeDirection](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/SelectionRangeDirection) -`"none" | "backward" | "forward"` - -### [SliderTickLabelRotation](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/SliderTickLabelRotation) -`0 | 90 | -90` - -### [SliderTickOrientation](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/SliderTickOrientation) -`"end" | "mirror" | "start"` - -### [SortComparer](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/SortComparer) -`any` -See BaseSortComparer for the full documentation. - -### [SortingDirection](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/SortingDirection) -`"ascending" | "descending" | "none"` -Sort direction for a given sort expression. - -### [SortingExpression](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/SortingExpression) -`any` -See BaseSortingExpression for the full documentation. - -### [SortState](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/SortState) -`Map, SortingExpression>` -Represents the sort state of the grid. - -### [StepperOrientation](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/StepperOrientation) -`"horizontal" | "vertical"` - -### [StepperStepType](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/StepperStepType) -`"full" | "indicator" | "title"` - -### [StepperTitlePosition](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/StepperTitlePosition) -`"auto" | "bottom" | "top" | "end" | "start"` - -### [StepperVerticalAnimation](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/StepperVerticalAnimation) -`"grow" | "fade" | "none"` - -### [StyleVariant](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/StyleVariant) -`"primary" | "info" | "success" | "warning" | "danger"` - -### [TabsActivation](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/TabsActivation) -`"auto" | "manual"` - -### [TabsAlignment](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/TabsAlignment) -`"start" | "end" | "center" | "justify"` - -### [TextareaResize](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/TextareaResize) -`"vertical" | "auto" | "none"` - -### [Theme](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/Theme) -`"material" | "bootstrap" | "indigo" | "fluent"` - -### [ThemeVariant](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/ThemeVariant) -`"light" | "dark"` - -### [TileManagerDragMode](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/TileManagerDragMode) -`"none" | "tile-header" | "tile"` - -### [TileManagerResizeMode](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/TileManagerResizeMode) -`"none" | "hover" | "always"` - -### [ToggleLabelPosition](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/ToggleLabelPosition) -`"after" | "before"` - -### [TreeSelection](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/TreeSelection) -`"none" | "multiple" | "cascade"` - -### [WeekDays](https://www.infragistics.com/api/react/igniteui-react/19.5.1/types/WeekDays) -`"sunday" | "monday" | "tuesday" | "wednesday" | "thursday" | "friday" | "saturday"` - -## Functions - -### [configureTheme](https://www.infragistics.com/api/react/igniteui-react/19.5.1/functions/configureTheme) -`configureTheme(t: Theme, v?: ThemeVariant): void` -Allows the global configuration of the active theme. - -Usage: - import { configureTheme } from 'igniteui-webcomponents'; - - configureTheme('material', 'light'); - -### [registerI18n](https://www.infragistics.com/api/react/igniteui-react/19.5.1/functions/registerI18n) -`registerI18n(resourceStrings: IResourceStrings, locale: string): void` -Register resources for a specific locale. - -### [registerIcon](https://www.infragistics.com/api/react/igniteui-react/19.5.1/functions/registerIcon) -`registerIcon(name: string, url: string, collection?: string): Promise` -Registers an icon by fetching it from a URL. - -### [registerIconFromText](https://www.infragistics.com/api/react/igniteui-react/19.5.1/functions/registerIconFromText) -`registerIconFromText(name: string, iconText: string, collection?: string): void` -Registers an icon from SVG text content. - -### [setCurrentI18n](https://www.infragistics.com/api/react/igniteui-react/19.5.1/functions/setCurrentI18n) -`setCurrentI18n(locale: string): void` -Set the current locale of all Ignite UI components. - -### [setIconRef](https://www.infragistics.com/api/react/igniteui-react/19.5.1/functions/setIconRef) -`setIconRef(name: string, collection: string, icon: IconMeta): void` -Sets an icon reference/alias that points to another icon. - -### [θaddAdoptedStylesController](https://www.infragistics.com/api/react/igniteui-react/19.5.1/functions/θaddAdoptedStylesController) -`θaddAdoptedStylesController(host: ReactiveControllerHost & LitElement): AdoptedStylesController` -Creates and attaches an AdoptedStylesController to a Lit component. - -### [θaddThemingController](https://www.infragistics.com/api/react/igniteui-react/19.5.1/functions/θaddThemingController) -`θaddThemingController(host: ReactiveControllerHost & ReactiveElement, themes: Themes, config?: ThemingControllerConfig): ThemingController` -Adds theming controller to the host component. - -## Variables - -### [BooleanOperands](https://www.infragistics.com/api/react/igniteui-react/19.5.1/variables/BooleanOperands) -`Readonly>` - -### [CalendarResourceStringsEN](https://www.infragistics.com/api/react/igniteui-react/19.5.1/variables/CalendarResourceStringsEN) -`ICalendarResourceStrings` -English resource strings for Ignite UI Calendar - -### [CarouselResourceStringsEN](https://www.infragistics.com/api/react/igniteui-react/19.5.1/variables/CarouselResourceStringsEN) -`ICarouselResourceStrings` -English resource strings for Ignite UI Carousel - -### [ChipResourceStringsEN](https://www.infragistics.com/api/react/igniteui-react/19.5.1/variables/ChipResourceStringsEN) -`IChipResourceStrings` -English resource strings for Ignite UI Chip - -### [ComboResourceStringsEN](https://www.infragistics.com/api/react/igniteui-react/19.5.1/variables/ComboResourceStringsEN) -`IComboResourceStrings` -English resource strings for Ignite UI Combo - -### [DateRangePickerResourceStringsEN](https://www.infragistics.com/api/react/igniteui-react/19.5.1/variables/DateRangePickerResourceStringsEN) -`IDateRangePickerResourceStrings` -English resource strings for Ignite UI Date Range Picker - -### [FileInputResourceStringsEN](https://www.infragistics.com/api/react/igniteui-react/19.5.1/variables/FileInputResourceStringsEN) -`IFileInputResourceStrings` -English resource strings for Ignite UI File Input - -### [IgrCalendarResourceStringEN](https://www.infragistics.com/api/react/igniteui-react/19.5.1/variables/IgrCalendarResourceStringEN) -`IgcCalendarResourceStrings` - -### [IgrChatResourceStringEN](https://www.infragistics.com/api/react/igniteui-react/19.5.1/variables/IgrChatResourceStringEN) -`IgcChatResourceStrings` - -### [IgrDateRangePickerResourceStringsEN](https://www.infragistics.com/api/react/igniteui-react/19.5.1/variables/IgrDateRangePickerResourceStringsEN) -`IgcDateRangePickerResourceStrings` - -### [NumberOperands](https://www.infragistics.com/api/react/igniteui-react/19.5.1/variables/NumberOperands) -`Readonly>` - -### [StringOperands](https://www.infragistics.com/api/react/igniteui-react/19.5.1/variables/StringOperands) -`Readonly>` - -### [TreeResourceStringsEN](https://www.infragistics.com/api/react/igniteui-react/19.5.1/variables/TreeResourceStringsEN) -`ITreeResourceStrings` -English resource strings for Ignite UI Tree diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/webcomponents-api/igniteui-dockmanager/latest/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/webcomponents-api/igniteui-dockmanager/latest/llms-full.txt deleted file mode 100644 index cc7a24d47..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/webcomponents-api/igniteui-dockmanager/latest/llms-full.txt +++ /dev/null @@ -1,382 +0,0 @@ -# Ignite UI for Web Components Dock Manager latest — Full API Reference - -> Complete API reference for the Ignite UI for Web Components Dock Manager package (latest). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: Web Components -Package: igniteui-dockmanager -Version: latest - -## Classes - -### [IgcDockManagerComponent](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/classes/IgcDockManagerComponent) -A powerful, flexible dock manager component for laying out, docking, -undocking, pinning, and floating panes of content. - -- **constructor**(): IgcDockManagerComponent -- **activePane**: `IgcContentPane` — Determines the active content pane. -- **allowFloatingPanesResize**: `boolean` — Whether floating panes can be resized. -- **allowInnerDock**: `boolean` — Whether docking inside a pane is allowed. -- **allowMaximize**: `boolean` — Whether maximize action button is displayed for the panes. -- **allowRootDock**: `boolean` — Determines whether docking into the root-level pane is allowed. - -When set to true (default), panes can be docked directly into the root container. -This is done by creating a new root pane and repositioning the existing root pane as a sibling to the newly docked content pane. -- **allowSplitterDock**: `boolean` — Whether docking over splitter is allowed -- **autoScrollConfig**: `IgcScrollConfig` — Configuration for edge auto-scrolling behavior during drag & resize operations. - -- edgeThreshold: Distance in pixels from the container's edge that triggers scrolling. -- scrollSpeed: Number of pixels to scroll per interval (affects scroll rate). -- **closeBehavior**: `IgcPaneActionBehavior` — Which panes get affected by close operations. -- **containedInBoundaries**: `boolean` — Whether pane dragging stops when any of the pane's sides goes outside the DockManager’s bounds. -- **contextMenuMeta**: `IgcContextMenuMetadata` — Metadata for rendering the context menu associated with a pane. -- **contextMenuPosition**: `IgcContextMenuPosition` — Position to open the context menu. -- **disableKeyboardNavigation**: `boolean` — Disables all keyboard navigation within the dock manager. -- **draggedPane**: `IgcContentPane | IgcSplitPane | IgcTabGroupPane` — Determines the pane that is currently dragged. -- **draggedPaneElement**: `HTMLElement` -- **dropPosition**: `IgcDockManagerPoint` — The drop position (pane) when docking. -- **dropShadowRect**: `DOMRect` — The bounding rectangle of the drop shadow shown during docking. -- **dropTargetPaneInfo**: `IgcDropTargetPaneInfo` — Contains metadata about the currently targeted drop pane during drag. -- **enableDragCursor**: `boolean` — Enables changing the mouse cursor when hovering over a tab or pane header. - -When set to true, the cursor changes from the default to pointer, -indicating that the header can be dragged (e.g., to dock or float the pane). -- **floatingPaneZIndicesMap**: `Map` — Tracks z-index values for floating panes to manage stacking order. -- **flyoutPane**: `IgcContentPane` — Contains metadata about the currently targeted drop pane during drag. -- **hasCustomMaximizeButton**: `boolean` — Indicates whether a custom maximize button is defined via a slot. -- **hasCustomMinimizeButton**: `boolean` — Indicates whether a custom minimize button is defined via a slot. -- **hoveredPane**: `IgcContentPane` — The pane that is currently being hovered during a drag operation. -- **layout**: `IgcDockManagerLayout` — The layout configuration of the Dock Manager. -- **maximizedPane**: `IgcContentPane | IgcSplitPane | IgcTabGroupPane` — Determines the pane that is currently maximized. -- **navigationPaneMeta**: `IgcPaneNavigatorMetadata` — Metadata for the pane-navigator overlay. -- **proximityDock**: `boolean` — Determines whether docking indicators are displayed while docking -- **resourceStrings**: `IgcDockManagerResourceStrings` — The resource strings of the dock manager. -- **showHeaderIconOnHover**: `"none" | "closeOnly" | "moreOptionsOnly" | "all"` — Which header icons are shown on hover. -- **showPaneHeaders**: `"always" | "onHoverOnly"` — Determines when to display the pane headers - always or on hover of the pane. -- **templates**: `Map` — A map of content template references by ID, used for slotting custom pane content. -- **unpinBehavior**: `IgcPaneActionBehavior` — Determines which panes are affected by particular pane action such as closing or unpinning. -- **useFixedSizeOnDock**: `"horizontal" | "vertical" | "none" | "both"` — Specifies which docking orientations should apply the FixedSize sizing mode -when panes are dynamically created via docking. - -Possible values: -- "none": Do not apply FixedSize on docking (default behavior). -- "vertical": Apply FixedSize only when panes are docked vertically. -- "horizontal": Apply FixedSize only when panes are docked horizontally. -- "both": Apply FixedSize for both vertical and horizontal orientation. - -This setting affects only dynamically created panes via user docking actions. -It does not apply to programmatically created panes or layout restorations. -- static **styles**: `any[]` -- static readonly **tagName**: `"igc-dockmanager"` -- **direction**: `string` — Gets the direction of the Dock Manager. -- **isValidDrop**: `boolean` — Whether the last drop/drag target was valid. -- **dropPane**(): Promise -- **focusPane**(contentId: string): Promise -- **paneFlyoutToggle**(args: IgcPaneFlyoutEventArgs): CustomEvent — Emitted when an unpinned pane's flyout state changes (opens or closes). - -This event fires when: -- An unpinned pane is clicked and its flyout opens to display content -- An unpinned pane's flyout closes (user clicks elsewhere, switches to another unpinned pane, etc.) -- Switching between unpinned panes (fires twice: close event for old pane, open event for new pane) - -This event does NOT fire when: -- A pane is pinned or unpinned using the pin button (use panePinnedToggle for that) -- A pane is initially unpinned (only subsequent flyout open/close actions) - -Use this event to show/hide auxiliary UI, update summary views, or respond to unpinned pane visibility changes. -- **removePane**(pane: IgcDockManagerPane): Promise -- static **register**(): void - -## Interfaces - -### [IgcActivePaneEventArgs](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcActivePaneEventArgs) - -- **newPane**: `IgcContentPane` — Gets the new active pane. -- **oldPane**: `IgcContentPane` — Gets the old active pane. - -### [IgcContentPane](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcContentPane) - -- **acceptsInnerDock?**: `boolean` — Determines whether the end user can inner dock another pane in this one. Defaults to true. -- **allowClose?**: `boolean` — Determines whether the end user is allowed to close the pane. Defaults to true. -- **allowDocking?**: `boolean` — Determines whether the end user is allowed to dock the pane. Defaults to true. -- **allowFloating?**: `boolean` — Determines whether the end user is allowed to make the pane floating. Defaults to true. -- **allowMaximize?**: `boolean` — Determines whether the end user is allowed to maximize the pane. -- **allowPinning?**: `boolean` — Determines whether the end user is allowed to pin/unpin the pane. Defaults to true. -- **contentId**: `string` — The slot attribute's value of the content element. -- **disabled?**: `boolean` — Determines whether a pane is disabled. Defaults to false. -- **documentOnly?**: `boolean` — Marks that a content pane can be docked only inside a document host. -- **floatingHeaderId?**: `string` — The slot attribute's value of the floating header element. If not set, the headerId property value is used. -- **header**: `string` — The text header of the content pane. Even if header slot templates are used, the text header is used for aria label. -- **headerId?**: `string` — The slot attribute's value of the content pane header element. If not set, the header property value is used. -- **hidden?**: `boolean` — Determines whether a pane is hidden in the UI. Defaults to false. -- **id?**: `string` — The id of the pane. If not set the Dock Manager generates it automatically. -- **isMaximized?**: `boolean` — Determines whether a content pane is maximized or not. Defaults to false. -- **isPinned?**: `boolean` — Determines whether a content pane is pinned or not. Defaults to true. -- **minResizeHeight?**: `number` — The minimum height of the pane in pixels during resizing. Defaults to 42. -- **minResizeWidth?**: `number` — The minimum width of the pane in pixels during resizing. Defaults to 42. -- **size?**: `number` — The size of the pane relative to its sibling panes' sizes. Defaults to 100. -- **tabHeaderId?**: `string` — The slot attribute's value of the tab header element. If not set, the header property value is used. -- **type**: `"contentPane"` — The type of the pane. -- **unpinnedHeaderId?**: `string` — The slot attribute's value of the unpinned header element. If not set, the header property value is used. -- **unpinnedLocation?**: `IgcUnpinnedLocation` — The desired unpinned location of the content pane. - -If not set the Dock Manager automatically calculates it based on the location of the pane relatively to the document host. -If more than one document host is presented, the closest one in the pane hierarchy will be used for the calculation. -If there is no document host, the default location is left. -- **unpinnedSize?**: `number` — The absolute size of the pane in an unpinned state. Defaults to 200. - -### [IgcDockingIndicator](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcDockingIndicator) - -- **direction?**: `string` — Gets a value indicating the direction of the docking indicator. -- **isRoot**: `boolean` — Gets a value indicating whether the docking indicator is a root one. -- **position**: `IgcDockingIndicatorPosition` — Gets the position of the docking indicator. - -### [IgcDockManagerEventMap](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcDockManagerEventMap) - -- **activePaneChanged**: `CustomEvent` -- **floatingPaneResizeEnd**: `CustomEvent` -- **floatingPaneResizeMove**: `CustomEvent` -- **floatingPaneResizeStart**: `CustomEvent` -- **layoutChange**: `CustomEvent` -- **paneClose**: `CustomEvent` -- **paneDragEnd**: `CustomEvent` -- **paneDragOver**: `CustomEvent` -- **paneDragStart**: `CustomEvent` -- **paneFlyoutToggle**: `CustomEvent` -- **paneHeaderConnected**: `CustomEvent` -- **paneHeaderDisconnected**: `CustomEvent` -- **panePinnedToggle**: `CustomEvent` -- **paneScroll**: `CustomEvent` -- **splitterResizeEnd**: `CustomEvent` -- **splitterResizeStart**: `CustomEvent` -- **tabHeaderConnected**: `CustomEvent` -- **tabHeaderDisconnected**: `CustomEvent` - -### [IgcDockManagerLayout](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcDockManagerLayout) -Describes a Dock Manager layout. - -- **floatingPanes?**: `IgcSplitPane[]` — The floating panes of the layout. -- **rootPane**: `IgcSplitPane` — The root split pane of the layout. - -### [IgcDockManagerPoint](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcDockManagerPoint) - -- **x**: `number` -- **y**: `number` - -### [IgcDockManagerResourceStrings](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcDockManagerResourceStrings) -Describes dock manager resource strings. - -- **close?**: `string` -- **documents?**: `string` -- **maximize?**: `string` -- **minimize?**: `string` -- **moreOptions?**: `string` -- **moreTabs?**: `string` -- **panes?**: `string` -- **pin?**: `string` -- **unpin?**: `string` - -### [IgcDockPaneAction](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcDockPaneAction) - -- **dockingIndicator**: `IgcDockingIndicator` -- **targetPane**: `IgcDockManagerPane` -- **type**: `"dockPane"` - -### [IgcDocumentHost](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcDocumentHost) - -- **id?**: `string` — The id of the pane. If not set the Dock Manager generates it automatically. -- **rootPane**: `IgcSplitPane` — The root split pane of the document host. -- **size?**: `number` — The size of the pane relative to its sibling panes' sizes. Defaults to 100. -- **type**: `"documentHost"` — The type of the pane. - -### [IgcFloatingPaneResizeEventArgs](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcFloatingPaneResizeEventArgs) - -- **resizerLocation**: `IgcResizerLocation` — Gets the edge/corner that is being dragged. -- **sourcePane**: `IgcSplitPane` — Gets the source pane that triggers the resize operation. - -### [IgcFloatingPaneResizeMoveEventArgs](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcFloatingPaneResizeMoveEventArgs) - -- **newHeight**: `number` — Gets the pane's height after the resizing operation. -- **newLocation**: `IgcDockManagerPoint` — Gets the pane's floating location after the resizing operation. -- **newWidth**: `number` — Gets the pane's width after the resizing operation. -- **oldHeight**: `number` — Gets the pane's height before the resizing operation. -- **oldLocation**: `IgcDockManagerPoint` — Gets the pane's floating location before the resizing operation. -- **oldWidth**: `number` — Gets the pane's width before the resizing operation. - -### [IgcFloatPaneAction](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcFloatPaneAction) - -- **height**: `number` -- **location**: `IgcDockManagerPoint` -- **type**: `"floatPane"` -- **width**: `number` - -### [IgcMoveFloatingPaneAction](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcMoveFloatingPaneAction) - -- **newLocation**: `IgcDockManagerPoint` -- **oldLocation**: `IgcDockManagerPoint` -- **type**: `"moveFloatingPane"` - -### [IgcMoveTabAction](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcMoveTabAction) - -- **newIndex**: `number` -- **oldIndex**: `number` -- **type**: `"moveTab"` - -### [IgcPaneCloseEventArgs](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcPaneCloseEventArgs) - -- **panes**: `IgcContentPane[]` — Gets/sets the panes that are about to close. -- **sourcePane**: `IgcDockManagerPane` — Get the source pane that triggers the close. - -### [IgcPaneDragEndEventArgs](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcPaneDragEndEventArgs) - -- **panes**: `IgcContentPane[]` — Gets the panes that end dragging. -- **sourcePane**: `IgcContentPane | IgcSplitPane | IgcTabGroupPane` — Gets the source pane that ends dragging. - -### [IgcPaneDragOverEventArgs](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcPaneDragOverEventArgs) - -- **action**: `IgcPaneDragAction` — Gets information about the action being performed. -- **isValid**: `boolean` — Gets/sets whether the action is valid. -- **panes**: `IgcContentPane[]` — Gets the panes that are dragged over. -- **sourcePane**: `IgcContentPane | IgcSplitPane | IgcTabGroupPane` — Gets the source pane that triggers the drag over. - -### [IgcPaneDragStartEventArgs](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcPaneDragStartEventArgs) - -- **panes**: `IgcContentPane[]` — Gets the panes that are about to get dragged. -- **sourcePane**: `IgcContentPane | IgcSplitPane` — Gets the source pane that triggers the drag start. - -### [IgcPaneHeaderConnectionEventArgs](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcPaneHeaderConnectionEventArgs) - -- **element**: `IgcPaneHeaderElement` — The header element that is being connected/disconnected. -- **pane**: `IgcContentPane` — The pane whose header is being connected/disconnected. - -### [IgcPaneHeaderElement](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcPaneHeaderElement) -Describes a pane header element. - -- **dragService**: `IgcDragService` — Gets/sets the drag service. - -### [IgcPanePinnedEventArgs](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcPanePinnedEventArgs) - -- **location**: `IgcUnpinnedLocation` — Gets the unpinned location. -- **newValue**: `boolean` — Gets the new pinned value. -- **panes**: `IgcContentPane[]` — Gets/sets the panes that are about to get pinned/unpinned. -- **sourcePane**: `IgcContentPane` — Gets the source pane that triggers the pinned state change. - -### [IgcPaneScrollEventArgs](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcPaneScrollEventArgs) - -- **contentElement**: `HTMLElement` — Gets the content element that is scrolled. -- **pane**: `IgcContentPane` — Gets the content pane that is scrolled. - -### [IgcSplitPane](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcSplitPane) - -- **allowEmpty?**: `boolean` — Determines whether the pane should present in the UI when empty. -- **floatingHeight?**: `number` — The absolute height of the pane. Applies only for floating panes. Defaults to 100. -- **floatingLocation?**: `IgcDockManagerPoint` — The absolute location point of the pane. Applies only for floating panes. -- **floatingResizable?**: `boolean` — Determines whether floating pane resizing is allowed. Applies only for floating panes. -- **floatingWidth?**: `number` — The absolute width of the pane. Applies only for floating panes. Defaults to 100. -- **id?**: `string` — The id of the pane. If not set the Dock Manager generates it automatically. -- **isMaximized?**: `boolean` — Determines whether a split pane is maximized or not. Defaults to false. -- **minResizeHeight?**: `number` — The minimum height of child panes in pixels during resizing. Defaults to 42. -- **minResizeWidth?**: `number` — The minimum width of child panes in pixels during resizing. Defaults to 42. -- **orientation**: `IgcSplitPaneOrientation` — The orientation of the split pane. -- **panes**: `IgcDockManagerPane[]` — The child panes of the split pane. -- **size?**: `number` — The size of the pane relative to its sibling panes' sizes. Defaults to 100. -- **type**: `"splitPane"` — The type of the pane. -- **useFixedSize?**: `boolean` — Determines whether child panes are sized in pixels (instead of relatively to their siblings) and can be resized beyond the viewport, allowing scrollable overflow within the container. -Defaults to false. - -### [IgcSplitterResizeEventArgs](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcSplitterResizeEventArgs) - -- **orientation**: `IgcSplitPaneOrientation` — Gets the pane's orientation. -- **pane**: `IgcDockManagerPane` — Gets the pane being resized with the splitter. -- **paneHeight**: `number` — Gets the pane's height. -- **paneWidth**: `number` — Gets the pane's width. - -### [IgcTabGroupPane](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcTabGroupPane) - -- **allowEmpty?**: `boolean` — Determines whether the pane should present in the UI when empty. -- **id?**: `string` — The id of the pane. If not set the Dock Manager generates it automatically. -- **isMaximized?**: `boolean` — Determines whether a tab group is maximized or not. Defaults to false. -- **minResizeHeight?**: `number` — The minimum height of the tab group pane in pixels during resizing. Defaults to 42. -- **minResizeWidth?**: `number` — The minimum width of the tab group pane in pixels during resizing. Defaults to 42. -- **panes**: `IgcContentPane[]` — The child content panes of the tab group. -- **selectedIndex?**: `number` — The index of the selected tab. -- **size?**: `number` — The size of the pane relative to its sibling panes' sizes. Defaults to 100. -- **type**: `"tabGroupPane"` — The type of the pane. - -### [IgcTabHeaderConnectionEventArgs](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcTabHeaderConnectionEventArgs) - -- **element**: `IgcTabHeaderElement` — The tab header element that is being connected/disconnected. -- **pane**: `IgcContentPane` — The pane whose tab header is being connected/disconnected. - -### [IgcTabHeaderElement](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/interfaces/IgcTabHeaderElement) -Describes a tab header element. - -- **dragService**: `IgcDragService` — Gets/sets the drag service. - -## Type Aliases - -### [DockingIndicatorPosition](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/types/DockingIndicatorPosition) -`any` - -### [DockManagerPaneType](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/types/DockManagerPaneType) -`any` - -### [IgcDockManagerPane](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/types/IgcDockManagerPane) -`IgcContentPane | IgcSplitPane | IgcTabGroupPane | IgcDocumentHost | undefined` - -### [IgcPaneDragAction](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/types/IgcPaneDragAction) -`IgcFloatPaneAction | IgcMoveFloatingPaneAction | IgcDockPaneAction | IgcMoveTabAction` - -### [PaneActionBehavior](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/types/PaneActionBehavior) -`any` -Enumeration used to determine which panes within a dockable TabGroupPane are affected by a particular pane action such as closing or unpinning a pane. - -### [PaneDragActionType](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/types/PaneDragActionType) -`any` - -### [ResizerLocation](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/types/ResizerLocation) -`any` - -### [SplitPaneOrientation](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/types/SplitPaneOrientation) -`any` - -### [UnpinnedLocation](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/types/UnpinnedLocation) -`any` - -## Functions - -### [addResourceStrings](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/functions/addResourceStrings) -`addResourceStrings(language: string, resourceStrings: IgcDockManagerResourceStrings): void` -Adds custom resource strings for a specified language. - -### [defineAllComponents](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/functions/defineAllComponents) -`defineAllComponents(): void` - -### [defineComponents](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/functions/defineComponents) -`defineComponents(components: IgniteComponent[]): void` - -## Variables - -### [DockingIndicatorPosition](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/variables/DockingIndicatorPosition) -`any` - -### [DockManagerPaneType](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/variables/DockManagerPaneType) -`any` - -### [getCurrentI18n](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/variables/getCurrentI18n) -`any` - -### [PaneActionBehavior](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/variables/PaneActionBehavior) -`any` -Enumeration used to determine which panes within a dockable TabGroupPane are affected by a particular pane action such as closing or unpinning a pane. - -### [PaneDragActionType](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/variables/PaneDragActionType) -`any` - -### [ResizerLocation](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/variables/ResizerLocation) -`any` - -### [SplitPaneOrientation](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/variables/SplitPaneOrientation) -`any` - -### [UnpinnedLocation](https://www.infragistics.com/api/webcomponents/igniteui-dockmanager/latest/variables/UnpinnedLocation) -`any` diff --git a/packages/igniteui-mcp/igniteui-doc-mcp/docs/webcomponents-api/igniteui-grid-lite/latest/llms-full.txt b/packages/igniteui-mcp/igniteui-doc-mcp/docs/webcomponents-api/igniteui-grid-lite/latest/llms-full.txt deleted file mode 100644 index 6409a7c66..000000000 --- a/packages/igniteui-mcp/igniteui-doc-mcp/docs/webcomponents-api/igniteui-grid-lite/latest/llms-full.txt +++ /dev/null @@ -1,250 +0,0 @@ -# Ignite UI Grid Lite latest — Full API Reference - -> Complete API reference for the Ignite UI Grid Lite package (latest). This file lists all public classes, interfaces, enumerations, type aliases, functions, and variables with their signatures, parameters, and descriptions. - -Platform: Web Components -Package: igniteui-grid-lite -Version: latest - -## Classes - -### [IgcGridLite](https://www.infragistics.com/api/webcomponents/igniteui-grid-lite/latest/classes/IgcGridLite) -IgcGridLite is a web component for displaying data in a tabular format quick and easy. - -Out of the box it provides row virtualization, sort and filter operations (client and server side), -the ability to template cells and headers and column hiding. - -- **autoGenerate**: `boolean` — Whether the grid will try to "resolve" its column configuration based on the passed -data source. -- **data**: `T[]` — The data source for the grid. -- **dataPipelineConfiguration**: `DataPipelineConfiguration` — Configuration object which controls remote data operations for the grid. -- **sortingOptions**: `GridLiteSortingOptions` — Sort configuration property for the grid. -- static **styles**: `CSSResult[]` — Array of styles to apply to the element. The styles should be defined -using the css tag function, via constructible stylesheets, or -imported from native CSS module scripts. - -Note on Content Security Policy: - -Element styles are implemented with