diff --git a/.github/skills/xplat-docs-api-links/SKILL.md b/.github/skills/xplat-docs-api-links/SKILL.md
index 3f8bb7f03b..346fcb8dd3 100644
--- a/.github/skills/xplat-docs-api-links/SKILL.md
+++ b/.github/skills/xplat-docs-api-links/SKILL.md
@@ -74,8 +74,13 @@ Each JSON file is a TypeDoc reflection tree. Top-level `children` contains all e
| `member` | no | Property or method name for the anchor. |
| `prefixed` | no | Default `true` — adds `Igr`/`Igx`/`Igc`/`Igb` automatically. Set `false` when `type` contains `{ComponentName}` or the name is already fully-qualified. **Always `false` for excel types.** |
| `suffix` | no | Default `true` — appends `Component` suffix for Angular DV packages. Set `false` for utility classes (FilteringOperand, SortingStrategy, SummaryOperand, all excel types). |
+| `exclude` | no | Comma-separated platform list (`"Angular"`, `"Blazor"`, etc.). On listed platforms the symbol renders as inline code (backticks) instead of a link. Use when the type/member genuinely **does not exist** on those platforms. **Preferred over wrapping a single `` in a ``** for the sole purpose of platform-omission. |
+| `excludeSuffixFor` | no | Comma-separated platform list. On listed platforms the package `classSuffix` (e.g. `Component`) is **not** appended, overriding the per-package default. Use when the same type is a plain class on some platforms (e.g. `IgxChartSelection`) but a `Component`-suffixed class on others. **Generates a real link — combine with `exclude` if the type is also absent on other platforms.** |
+| `excludePrefixFor` | no | Comma-separated platform list. On listed platforms the platform prefix (`Igr`/`Igx`/`Igc`/`Igb`) is **not** prepended. Use when a type has no prefix on certain platforms. **Generates a real link — combine with `exclude` if needed.** |
| `label` | no | Override display text. |
+> **Critical rule:** NEVER replace an existing `` with backtick text. If a URL is broken on certain platforms, add `exclude="Platform"` to the tag. Only backtick text is acceptable when the type has no TypeDoc page on *any* platform AND has never been an ApiLink in the content history. When in doubt, keep the ApiLink — the broken link will be caught by `check-api-links.mjs` and fixed via `apply-excludes.mjs`.
+
### Platform prefix mapping
| Platform | Prefix | Example (type="Column") |
@@ -253,6 +258,29 @@ Angular's `grids` package appends `Component` to all **UI component** class name
```
+### Use `excludeSuffixFor=` when only some platforms use the suffix
+
+When the suffix causes a 404 on **specific platforms only** (not globally), use `excludeSuffixFor` to remove it just for those platforms while keeping the link alive:
+
+```mdx
+
+
+```
+
+The `check-mdx-links.mjs` script automatically suggests this fix when it detects a broken link that resolves correctly after stripping the suffix — look for `→ FIX: excludeSuffixFor="..."` in the output.
+
+Similarly, `excludePrefixFor` removes the platform prefix (`Igr`/`Igx`/`Igc`/`Igb`) for the listed platforms only:
+
+```mdx
+
+```
+
+> **Decision guide**:
+> - Symbol **doesn't exist** on a platform → `exclude="Platform"`
+> - Symbol exists but URL has wrong suffix on those platforms → `excludeSuffixFor="Platform"`
+> - Symbol exists but URL has wrong prefix on those platforms → `excludePrefixFor="Platform"`
+> - `suffix={false}` / `prefixed={false}` → removes suffix/prefix globally (all platforms)
+
### Classes that NEED `suffix={false}`
- All `*FilteringOperand` classes: `BooleanFilteringOperand`, `NumberFilteringOperand`, `StringFilteringOperand`, `DateFilteringOperand`, `DateTimeFilteringOperand`, `TimeFilteringOperand`
diff --git a/.github/skills/xplat-docs-api-map-sync/SKILL.md b/.github/skills/xplat-docs-api-map-sync/SKILL.md
new file mode 100644
index 0000000000..f1855f2d2b
--- /dev/null
+++ b/.github/skills/xplat-docs-api-map-sync/SKILL.md
@@ -0,0 +1,223 @@
+---
+name: xplat-docs-api-map-sync
+description: "Reference guide for synchronizing the xplat docs ApiLink references with the upstream igniteui-xplat-docs apiMap data. Covers running scripts/resolve-api-links.mjs to inject ApiLink tags from `IgxFoo.bar`-style backtick references in MDX, syncing docConfig.json with the sibling igniteui-xplat-docs repo, generating per-platform broken-link reports via scripts/check-api-links.mjs, and applying exclude= props to broken ApiLink tags via scripts/apply-excludes.mjs. Use when bumping API package versions, after merging vNext content, or when ApiLink coverage drifts from upstream."
+user-invocable: true
+---
+
+# AI Agent Guide — Syncing xplat-docs ApiLink Coverage
+
+## Context
+
+This Astro xplat docs project mirrors the legacy gulp-based `igniteui-xplat-docs` pipeline. The legacy pipeline used **apiMap JSON** files (one per platform) and **docConfig.json** to:
+
+1. Convert backtick-prefixed type/member references (`` `IgxGrid.sort` ``) into resolved API URLs.
+2. Resolve the right per-platform package version, prefix, suffix, and base URL.
+
+Here those responsibilities are split across:
+
+| Responsibility | Implementation |
+|---|---|
+| `apiMap` lookup of valid types / members | Per-platform JSON files in sibling `igniteui-xplat-docs/apiMap/{Angular,React,Blazor,WebComponents}/*.apiMap.json` |
+| `docConfig` (package versions, prefixes, base URLs) | `docs/xplat/docConfig.json` |
+| Backtick → `` conversion | `docs/xplat/scripts/resolve-api-links.mjs` (or workspace-level equivalent) |
+| Verifying generated URLs against staging | `scripts/check-api-links.mjs` |
+| Auto-applying `exclude=` for broken URLs | `scripts/apply-excludes.mjs` |
+| Migrating `` to `exclude=` | `scripts/migrate-platformblock-to-exclude.mjs` |
+
+---
+
+## Sibling Repository Layout
+
+The `igniteui-xplat-docs` repo is at .
+
+```
+igniteui-xplat-docs/
+ apiMap/
+ Angular/*.apiMap.json
+ React/*.apiMap.json
+ Blazor/*.apiMap.json
+ WebComponents/*.apiMap.json
+ docConfig.json
+ gulpfile.js ← legacy reference; do not run
+```
+
+The `astro-components` repo is also a sibling (checked out next to `docs-template`) and is symlinked into `node_modules/igniteui-astro-components` via the workspace config in `docs-template/package.json`. The `` Astro component lives there at `src/components/mdx/ApiLink/ApiLink.astro`.
+
+---
+
+## Workflow 0 — Applying Fixes from an Existing mdx-link-report
+
+When `mdx-link-report-{angular,react,wc,blazor}.md` files already exist at the repo root (generated by a previous `check-mdx-links` run), apply all suggested fixes in one step:
+
+```bash
+# Preview what will change (no writes)
+node scripts/apply-mdx-report-fixes.mjs --dry-run
+
+# Apply all fixes across all four platform reports
+node scripts/apply-mdx-report-fixes.mjs
+```
+
+The script reads every `mdx-link-report-*.md` it finds, parses each broken-URL entry's **FIX** line, and merges the appropriate prop (`excludeSuffixFor`, `excludePrefixFor`, or `exclude`) onto the matching `` tag in the xplat source file. Angular report paths are automatically remapped to their canonical `docs/xplat/src/content/` source (except `grids/` and `changelog/` which Angular owns directly).
+
+After applying, re-run the check to confirm the broken count drops to 0:
+
+```bash
+npm run check-mdx-links:report:angular
+npm run check-mdx-links:report:react
+npm run check-mdx-links:report:wc
+npm run check-mdx-links:report:blazor
+```
+
+---
+
+## Workflow 1 — After Bumping a Platform Version
+
+When a platform's API package version changes (e.g. Angular 21.1 → 21.2) some symbols may be renamed, removed, or relocated. Walk through:
+
+```bash
+# 1. Sync docConfig.json with upstream (manual diff)
+# Compare docs/xplat/docConfig.json with sibling igniteui-xplat-docs/docConfig.json.
+# Apply any version, base-URL, or package-key changes; preserve local-only fields
+# (e.g. codeSandboxButtonInject).
+
+# 2. Generate per-platform broken-link reports against staging
+node scripts/check-api-links.mjs --platform=angular
+node scripts/check-api-links.mjs --platform=react
+node scripts/check-api-links.mjs --platform=wc
+node scripts/check-api-links.mjs --platform=blazor
+# → produces api-link-report-{angular,react,wc,blazor}.md at repo root.
+
+# 3. Auto-apply exclude= to ApiLink tags whose URLs are broken
+node scripts/apply-excludes.mjs --dry-run # preview
+node scripts/apply-excludes.mjs # apply
+
+# 4. Re-run reports — broken count should now be near 0
+node scripts/check-api-links.mjs --platform=angular
+# (and the other three)
+```
+
+## Workflow 2 — After Importing New Content from vNext
+
+**Critical rule: never demote an existing `` to backtick text.** If a URL is broken on some platforms, add `exclude="Platform"` — never remove the link. Backtick text is only acceptable when the type has no TypeDoc page on *any* platform and was never an ApiLink in the upstream content.
+
+**Correct pipeline order** — must run in this sequence:
+
+```bash
+# 1. Strip Igr/Igx/Igc/Igb prefixes from backtick-wrapped prose refs.
+# (Xplat content is platform-agnostic. `IgrToolbar` → `Toolbar`)
+# Script skips code fences, JSX tags, and PlatformBlock-wrapped content
+# (e.g. `IgrFoo` is intentional).
+node scripts/fix-igr-backtick-prefix.mjs
+
+# 2. Convert bare backtick refs (`Toolbar`, `DataChart`, etc.) into
+# using the sibling igniteui-xplat-docs/apiMap JSON files.
+# Reads mentionedTypes: frontmatter to scope the lookup per file.
+cd docs/xplat && node scripts/resolve-api-links.mjs
+
+# 3. Fix attributes: strip CLR arity suffixes, add prefixed={false}
+# for enums, reclassify class → interface for known mis-classified types.
+# Does NOT demote ApiLinks to backtick text.
+node scripts/fix-api-link-attrs.mjs
+
+# 4. Migrate any wrappers
+# that exist purely for platform-omission into exclude= props.
+cd /c/Repos/docs/docs-template && node scripts/migrate-platformblock-to-exclude.mjs
+
+# 5. Run Workflow 1 (steps 2-4) to verify and auto-fix broken URLs.
+```
+
+**Angular content syncs automatically** — after fixing xplat, run:
+```bash
+cd docs/xplat && node scripts/generate.mjs --platform=Angular --lang=en
+cd /c/Repos/docs/docs-template && node docs/angular/scripts/sync-generated.mjs --lang=en
+# repeat for --lang=jp, --lang=kr if needed
+```
+
+---
+
+## Script Reference
+
+### `scripts/check-api-links.mjs`
+
+Walks `docs/xplat/src/content/**/*.mdx`, extracts every `` tag, computes the staging URL per platform, and HEAD-checks each URL.
+
+- Honors enclosing `` (stack-based intersection) so a tag wrapped for one platform is checked only on that platform.
+- Honors `exclude="..."` on the tag itself — listed platforms are dropped from the check set.
+- Output:
+ - Console summary (OK / Not found / HTTP / Total broken).
+ - `api-link-report-.md` with details on every broken URL and the MDX files it appears in.
+
+CLI:
+```
+node scripts/check-api-links.mjs --platform=angular|react|wc|blazor
+```
+
+### `scripts/apply-excludes.mjs`
+
+Reads all four `api-link-report-*.md` files, builds a per-file map of broken URLs → platforms, then walks each file's `` tags and merges `exclude="..."` for any matching tag. Idempotent.
+
+Matching algorithm:
+- Strip platform prefix (`Igr/Igx/Igc/Igb`) from URL type names.
+- Generate two key variants per URL — with and without `Component/Module/Directive/Element` suffix — to match Angular tags written either with or without the suffix.
+- Lowercase member fragments so Blazor's PascalCased `#Condition` matches a tag's `member="condition"`.
+- On tag side, key is `(stripPrefix(type) | lowercased member | kind || 'class')`.
+
+CLI:
+```
+node scripts/apply-excludes.mjs --dry-run
+node scripts/apply-excludes.mjs
+```
+
+### `scripts/migrate-platformblock-to-exclude.mjs`
+
+Finds the anti-pattern:
+
+```mdx
+
+
+
+```
+
+When `for=` lists exactly N-1 of the 4 platforms, rewrites to:
+
+```mdx
+
+```
+
+Skips tags that already have an `exclude=` attribute.
+
+### `scripts/resolve-api-links.mjs` (or workspace equivalent)
+
+Walks MDX content and converts backtick-only API references like `` `IgxGrid.sort` `` into `` tags by looking up the type and member in the sibling `igniteui-xplat-docs/apiMap/*.json` files.
+
+---
+
+## docConfig.json Sync Checklist
+
+When syncing `docs/xplat/docConfig.json` with the upstream `igniteui-xplat-docs/docConfig.json`:
+
+- Pull in any new platform version numbers (`apiPackages[platform][packageId].version`).
+- Pull in any new packageId entries (e.g. new component packages added upstream).
+- Preserve **local-only** fields the Astro project uses but the legacy pipeline does not — e.g. `codeSandboxButtonInject`.
+- Leave `prefix`, `classSuffix`, and `apiUrl` alone unless explicitly changed upstream — only Angular has a non-empty `classSuffix` ("Component") for chart/gauge/map/excel/spreadsheet packages.
+
+---
+
+## Common Pitfalls
+
+| Pitfall | Symptom | Fix |
+|---|---|---|
+| Forgot to re-run `check-api-links` after `apply-excludes` | Same broken count reported | Re-run check after apply; report is regenerated. |
+| Member casing mismatch (Blazor PascalCase vs MDX lowercase) | Blazor 0 tags updated even though report shows breaks | `apply-excludes.mjs` already handles this via lowercase key. If you customize, preserve the lowercase logic. |
+| Angular `Component` suffix only on certain packages | Some Angular URLs still broken after apply | Verify `apply-excludes.mjs` `baseVariants()` adds both with-suffix and without-suffix variants. |
+| `replace_string_in_file` silently failing on `apply-excludes.mjs` | Edits report success but file unchanged | Use a Node-based file patcher: `readFileSync` + `.replace()` + `writeFileSync`. Always grep to verify. |
+| Running resolve-api-links BEFORE fix-igr-backtick-prefix | Backtick refs with `Igr` prefix can't be resolved; new backtick `Toolbar` refs created after fix-igr go unconverted | Always run fix-igr **first**, then resolve-api-links, then fix-api-link-attrs. |
+| Adding types to a NONEXISTENT_TYPES demotion list in fix-api-link-attrs | ApiLinks removed from content; replaced with `IgrFoo` backtick text | **Never demote ApiLinks.** `fix-api-link-attrs.mjs` has NO demotion logic. Handle broken URLs with `exclude=` via `apply-excludes.mjs`. |
+| fix-igr-backtick-prefix stripping Igr prefix inside PlatformBlock | ``IgrFoo`` → `Foo` (wrong) | The script already skips lines containing `` whose only purpose is to **omit** an `` for a subset of platforms. Use the `exclude="..."` prop on `` instead.
+
+The `exclude` prop accepts a comma-separated list of platform names (same casing as `for`). On the listed platforms, the link renders as **inline code (backticks)** instead of a hyperlink — preserving the symbol name in prose without producing a broken URL.
+
+### Anti-pattern (DO NOT DO THIS)
+
+```mdx
+
+
+
+
+```
+
+### Correct pattern
+
+```mdx
+
+```
+
+This renders a normal link on Angular/React/WebComponents and renders `MyType.someMember` in backticks on Blazor. No PlatformBlock needed.
+
+### When to use which
+
+| Situation | Use |
+|---|---|
+| The same `` references something missing on N platforms (broken URL) | `exclude="P1,P2"` on the ApiLink |
+| Different platforms need genuinely **different** ApiLinks (different `type`, `kind`, `member`, etc.) | One `` per variant (each containing its own ``) |
+| Surrounding **prose or code** also differs per platform | `` (regular usage) |
+
+### Migration script
+
+`scripts/migrate-platformblock-to-exclude.mjs` automatically rewrites the anti-pattern (a `` containing only a single `` whose `for=` covers exactly N-1 of the 4 platforms) into ``.
+
+### Report-driven exclusion
+
+`scripts/apply-excludes.mjs` reads `api-link-report-{angular,react,wc,blazor}.md` (produced by `scripts/check-api-links.mjs`) and adds `exclude="..."` to every ApiLink whose generated URL is broken on a given platform. Run after every API package version bump:
+
+```bash
+# 1. Generate per-platform reports
+node scripts/check-api-links.mjs --platform=angular
+node scripts/check-api-links.mjs --platform=react
+node scripts/check-api-links.mjs --platform=wc
+node scripts/check-api-links.mjs --platform=blazor
+
+# 2. Auto-apply exclude= to broken-link tags (idempotent)
+node scripts/apply-excludes.mjs --dry-run # preview
+node scripts/apply-excludes.mjs # apply
+
+# 3. Re-run reports to verify near-zero broken count
+```
+
+The script:
+- Strips `Igx/Igr/Igc/Igb` prefix from URL type names.
+- Strips `Component/Module/Directive/Element` suffix (Angular adds these to certain class names).
+- Lowercases member fragments (Blazor PascalCases members in URLs).
+- Merges with any existing `exclude=` attribute (preserves manually-added platforms).
+
+---
+
## Related Skills
- [`xplat-docs-api-links`](../xplat-docs-api-links/SKILL.md) — ApiLink usage guide
diff --git a/api-link-report-angular.md b/api-link-report-angular.md
index a22fba1e16..4b09c3ecef 100644
--- a/api-link-report-angular.md
+++ b/api-link-report-angular.md
@@ -1,12 +1,12 @@
# API Link Check Report
-_Generated: 2026-05-19 18:51:16 UTC_
+_Generated: 2026-05-22 09:54:39 UTC_
## Summary
| | |
|---|---|
-| ✅ OK | 1483 |
+| ✅ OK | 2084 |
| ❌ Not found (type/member missing) | 0 |
| ❌ HTTP error | 0 |
| ❌ **Total broken** | **0** |
diff --git a/api-link-report-blazor.md b/api-link-report-blazor.md
index ae317e20ce..56f8b7d460 100644
--- a/api-link-report-blazor.md
+++ b/api-link-report-blazor.md
@@ -1,12 +1,12 @@
# API Link Check Report
-_Generated: 2026-05-19 17:55:20 UTC_
+_Generated: 2026-05-22 09:58:46 UTC_
## Summary
| | |
|---|---|
-| ✅ OK | 1054 |
+| ✅ OK | 1785 |
| ❌ Not found (type/member missing) | 0 |
| ❌ HTTP error | 0 |
| ❌ **Total broken** | **0** |
diff --git a/api-link-report-react.md b/api-link-report-react.md
index f2a9b21a77..f5bb39467a 100644
--- a/api-link-report-react.md
+++ b/api-link-report-react.md
@@ -1,12 +1,12 @@
# API Link Check Report
-_Generated: 2026-05-19 17:53:29 UTC_
+_Generated: 2026-05-22 09:55:43 UTC_
## Summary
| | |
|---|---|
-| ✅ OK | 1106 |
+| ✅ OK | 1812 |
| ❌ Not found (type/member missing) | 0 |
| ❌ HTTP error | 0 |
| ❌ **Total broken** | **0** |
diff --git a/api-link-report-wc.md b/api-link-report-wc.md
index 0abf1c8fac..f2381eb7fb 100644
--- a/api-link-report-wc.md
+++ b/api-link-report-wc.md
@@ -1,12 +1,12 @@
# API Link Check Report
-_Generated: 2026-05-19 17:54:07 UTC_
+_Generated: 2026-05-22 09:56:43 UTC_
## Summary
| | |
|---|---|
-| ✅ OK | 1128 |
+| ✅ OK | 1752 |
| ❌ Not found (type/member missing) | 0 |
| ❌ HTTP error | 0 |
| ❌ **Total broken** | **0** |
diff --git a/docs/angular/src/content/en/components/action-strip.mdx b/docs/angular/src/content/en/components/action-strip.mdx
index 8dcaa3dc8b..796a120f96 100644
--- a/docs/angular/src/content/en/components/action-strip.mdx
+++ b/docs/angular/src/content/en/components/action-strip.mdx
@@ -80,7 +80,7 @@ export class HomeComponent {}
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
@@ -156,7 +156,7 @@ This can be utilized via grid action components and we are providing two default
These components inherit and when creating a custom grid action component, it should also inherit `IgxGridActionsBaseDirective`.
-
+
When `IgxActionStripComponent` is a child component of the grid, hovering a row will automatically show the UI.
diff --git a/docs/angular/src/content/en/components/ai/ai-assisted-development-overview.mdx b/docs/angular/src/content/en/components/ai/ai-assisted-development-overview.mdx
index 0aebf5c910..8df750ab8a 100644
--- a/docs/angular/src/content/en/components/ai/ai-assisted-development-overview.mdx
+++ b/docs/angular/src/content/en/components/ai/ai-assisted-development-overview.mdx
@@ -34,7 +34,7 @@ Run this command from the root of your existing Angular, React, Blazor, or Web C
npx igniteui-cli ai-config
```
-
+
Without a version pin, `npx` may pull an older CLI version that does not recognize the `ai-config` subcommand and will instead launch an interactive project-creation prompt, scaffolding a new project inside your existing one. Make sure that you have installed CLI version 16.x.
@@ -49,7 +49,7 @@ After the command finishes, start the MCP servers in your AI client. The servers
If Ignite UI is **not** installed in the project:
-
+
Ignite UI MCP servers configured for your selected clients
No AI skill files found. Make sure packages are installed (`npm install`) and your Ignite UI packages are up-to-date.
@@ -58,7 +58,7 @@ The MCP servers are ready to use. Skills will be added automatically the next ti
If Ignite UI **is** installed in the project:
-
+
Ignite UI MCP servers configured for your selected clients
Agent Skills copied to your selected agents' skills directories
@@ -185,14 +185,14 @@ If you have the Ignite UI CLI installed globally, use the shorter form:
ig ai-config
```
-
+
The `npx igniteui-cli` and `ig` forms do not register the `@angular/cli` MCP server. Use the Angular Schematics command above if you want all three servers configured in a single step.
-
+
The command requires Ignite UI packages to be installed in your project (`npm install`). If no skill files are found, make sure your packages are up-to-date.
diff --git a/docs/angular/src/content/en/components/ai/cli-mcp.mdx b/docs/angular/src/content/en/components/ai/cli-mcp.mdx
index ffbaf143bf..23b777b860 100644
--- a/docs/angular/src/content/en/components/ai/cli-mcp.mdx
+++ b/docs/angular/src/content/en/components/ai/cli-mcp.mdx
@@ -60,7 +60,7 @@ The canonical launch command is:
npx -y igniteui-cli mcp
```
-
+
The `-y` flag tells `npx` to auto-confirm the package download prompt so the server can start without manual intervention.
@@ -157,7 +157,7 @@ If you created the project with Ignite UI CLI first, review the generated `.vsco
Once saved, open the GitHub Copilot chat panel, switch to **Agent** mode, and the Ignite UI CLI MCP tools will be available.
-
+
MCP support in VS Code requires GitHub Copilot and VS Code 1.99 or later.
@@ -185,7 +185,7 @@ Cursor supports project-scoped MCP configuration. Create or edit `.cursor/mcp.js
The servers will be picked up automatically when you open a new Cursor chat session.
-
+
You can also configure MCP servers globally via **Settings → MCP** in Cursor.
@@ -273,7 +273,7 @@ JetBrains AI Assistant supports MCP servers through the IDE settings:
5. Click **OK** and restart the AI Assistant.
-
+
MCP support requires the AI Assistant plugin to be installed and enabled in your JetBrains IDE.
@@ -349,7 +349,7 @@ At a high level, the CLI MCP tools help with:
- updating project structure and configuration
- answering documentation and API questions
-
+
Framework detection uses component prefixes: `for Angular`, `for React`, `for Web Components`, `for Blazor`. The assistant picks up the right framework automatically from your open files or prompt context.
diff --git a/docs/angular/src/content/en/components/ai/skills.mdx b/docs/angular/src/content/en/components/ai/skills.mdx
index 60a9ae3398..3a95886d6c 100644
--- a/docs/angular/src/content/en/components/ai/skills.mdx
+++ b/docs/angular/src/content/en/components/ai/skills.mdx
@@ -11,7 +11,7 @@ import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro'
Ignite UI for Angular ships with **[Agent Skills](https://agentskills.io/)** - structured knowledge files that teach AI coding assistants (GitHub Copilot, Cursor, Windsurf, Claude, Gemini CLI, JetBrains Junie, etc.) how to work with Ignite UI for Angular. These skill files provide context-aware guidance on components, grids, data operations, and theming, enabling your AI assistant to generate accurate, idiomatic code that follows best practices.
-
+
The AI tooling landscape is evolving rapidly. Skill discovery locations and distribution options may change as tools and IDEs are updated. Always consult the official documentation for your specific tool or agent for the latest information.
@@ -26,7 +26,7 @@ The skill files live in the [`skills/`](https://github.com/IgniteUI/igniteui-ang
| Theming & Styling | [`skills/igniteui-angular-theming/SKILL.md`](https://github.com/IgniteUI/igniteui-angular/blob/master/skills/igniteui-angular-theming/SKILL.md) | Palettes, typography, elevations, component themes, MCP server |
| Generate From Image Design | [`skills/igniteui-angular-generate-from-image-design/SKILL.md`](https://github.com/IgniteUI/igniteui-angular/blob/master/skills/igniteui-angular-generate-from-image-design/SKILL.md) | Build Angular apps from screenshots, mockups, and wireframes using Ignite UI components |
-
+
Starting with Ignite UI for Angular **21.1.0**, these skills are automatically discovered when placed in your agent's skills path (e.g., `.claude/skills`, `.agents/skills`, `.cursor/rules/`). This release ships with an optional migration to add these skills to your project automatically.
@@ -144,7 +144,7 @@ ng generate @igniteui/angular-schematics:ai-config --assistants cursor --agents
This also registers the `@angular/cli` MCP server alongside the Ignite UI servers.
-
+
If you installed Ignite UI for Angular manually and want to copy skills without running `ai-config`, the skill files are also available under `node_modules`. To copy them into your project (e.g. into `.agents/skills/`), run:
diff --git a/docs/angular/src/content/en/components/avatar.mdx b/docs/angular/src/content/en/components/avatar.mdx
index de1b2ae090..efbfc82e0d 100644
--- a/docs/angular/src/content/en/components/avatar.mdx
+++ b/docs/angular/src/content/en/components/avatar.mdx
@@ -143,7 +143,7 @@ Analogically, the avatar can display an icon via the
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/banner.mdx b/docs/angular/src/content/en/components/banner.mdx
index 9afe9b9ea9..88f2367c82 100644
--- a/docs/angular/src/content/en/components/banner.mdx
+++ b/docs/angular/src/content/en/components/banner.mdx
@@ -73,7 +73,7 @@ export class HomeComponent {}
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/bullet-graph.mdx b/docs/angular/src/content/en/components/bullet-graph.mdx
index 0907f7b66b..2332333174 100644
--- a/docs/angular/src/content/en/components/bullet-graph.mdx
+++ b/docs/angular/src/content/en/components/bullet-graph.mdx
@@ -155,7 +155,7 @@ Performance value is the primary measure displayed by the component and it is vi
## Highlight Value
-The bullet graph's performance value can be further modified to show progress represented as a highlighted value. This will make the `Value` appear with a lower opacity. A good example is if `Value` is 50 and `HighlightValue` is set to 25. This would represent a performance of 50% regardless of what the value of `TargetValue` is set to. To enable this first set `HighlightValueDisplayMode` to Overlay and then apply a `HighlightValue` to something lower than `Value`.
+The bullet graph's performance value can be further modified to show progress represented as a highlighted value. This will make the appear with a lower opacity. A good example is if is 50 and is set to 25. This would represent a performance of 50% regardless of what the value of is set to. To enable this first set to Overlay and then apply a to something lower than .
@@ -336,7 +336,7 @@ The backing element represents background and border of the bullet graph compone
## Scale
-The scale is visual element that highlights the full range of values in the gauge. You can customize appearance and shape of the scale. The scale can also be inverted (using `IsScaleInverted` property) and all labels will be rendered from right-to-left instead of left-to-right.
+The scale is visual element that highlights the full range of values in the gauge. You can customize appearance and shape of the scale. The scale can also be inverted (using property) and all labels will be rendered from right-to-left instead of left-to-right.
diff --git a/docs/angular/src/content/en/components/button-group.mdx b/docs/angular/src/content/en/components/button-group.mdx
index 9bf5f10f31..75b2c78f77 100644
--- a/docs/angular/src/content/en/components/button-group.mdx
+++ b/docs/angular/src/content/en/components/button-group.mdx
@@ -85,7 +85,7 @@ export class HomeComponent {}
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/button.mdx b/docs/angular/src/content/en/components/button.mdx
index a205f92de7..353ac105d2 100644
--- a/docs/angular/src/content/en/components/button.mdx
+++ b/docs/angular/src/content/en/components/button.mdx
@@ -115,7 +115,7 @@ As of version `17.1.0` the IgniteUI for Angular exposes a new `igxIconButton` di
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/card.mdx b/docs/angular/src/content/en/components/card.mdx
index f9e9f5bb7a..5ac7ff5f96 100644
--- a/docs/angular/src/content/en/components/card.mdx
+++ b/docs/angular/src/content/en/components/card.mdx
@@ -108,7 +108,7 @@ export class HomeComponent {}
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/charts/chart-api.mdx b/docs/angular/src/content/en/components/charts/chart-api.mdx
index a3af6586d1..0880c9e439 100644
--- a/docs/angular/src/content/en/components/charts/chart-api.mdx
+++ b/docs/angular/src/content/en/components/charts/chart-api.mdx
@@ -6,85 +6,87 @@ _license: commercial
namespace: Infragistics.Controls.Charts
---
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# Angular Charts API
-The Ignite UI for Angular charts provide simple and easy to use APIs to plot your data in `CategoryChart`, `FinancialChart`, `DataChart`, `DataPieChart`, `DoughnutChart`, `PieChart`, and `Sparkline` UI elements.
+The Ignite UI for Angular charts provide simple and easy to use APIs to plot your data in , , , , , , and UI elements.
## Angular Category Chart API
-The Angular `CategoryChart` has the following API members:
+The Angular has the following API members:
| Chart Properties | Axis Properties | Series Properties |
|------------------|-----------------|-------------------|
-| - `CategoryChart.ChartType` - `ExcludedProperties` - `IncludedProperties` - `IsHorizontalZoomEnabled` - `IsVerticalZoomEnabled` - `CrosshairsDisplayMode` - `TransitionInMode` - `HighlightingBehavior` - `HighlightingMode` - `TrendLineType` | - `XAxisInterval` - `XAxisLabelLocation` - `XAxisGap` - `XAxisOverlap` - `XAxisTitle` - `YAxisInterval` - `YAxisLabelLocation` - `YAxisTitle` - `YAxisMinimumValue` - `YAxisMaximumValue` | - `Brushes` - `Outlines` - `MarkerBrushes` - `MarkerOutlines` - `MarkerTypes` - `ToolTipType`
|
## Angular Data Chart API
-The Angular `DataChart` has the following API members:
+The Angular has the following API members:
| Chart Properties | Axis Classes |
|------------------|--------------|
-| - `SeriesViewer.Title` - `SeriesViewer.Subtitle` - `IsHorizontalZoomEnabled` - `IsVerticalZoomEnabled` - `Brushes` - `Outlines` - `MarkerBrushes` - `MarkerOutlines` - `DataChart.Axes` - `SeriesViewer.Series` | - `Axis` is base class for all axis types - `CategoryXAxis` used with [Category Series](types/column-chart.md), [Stacked Series](types/stacked-chart.md), and [Financial Series](types/stock-chart.md) - `CategoryYAxis` used with [Category Series](types/column-chart.md), [Stacked Series](types/stacked-chart.md) - `CategoryAngleAxis` used with [Radial Series](types/radial-chart.md) - `NumericXAxis` used with [Scatter Series](types/scatter-chart.md) and [Bar Series](types/bar-chart.md) - `NumericYAxis` used with [Scatter Series](types/scatter-chart.md), [Category Series](types/column-chart.md), [Stacked Series](types/stacked-chart.md), and [Financial Series](types/stock-chart.md) - `NumericAngleAxis` used with [Polar Series](types/polar-chart.md) - `NumericRadiusAxis` used with [Polar Series](types/polar-chart.md) and [Radial Series](types/radial-chart.md) - `TimeXAxis` used with [Category Series](types/column-chart.md) and [Financial Series](types/stock-chart.md)
|
+| - `SeriesViewer.Title` - `SeriesViewer.Subtitle` - - - - - - - `DataChart.Axes` - `SeriesViewer.Series` | - is base class for all axis types - used with [Category Series](types/column-chart.md), [Stacked Series](types/stacked-chart.md), and [Financial Series](types/stock-chart.md) - used with [Category Series](types/column-chart.md), [Stacked Series](types/stacked-chart.md) - used with [Radial Series](types/radial-chart.md) - used with [Scatter Series](types/scatter-chart.md) and [Bar Series](types/bar-chart.md) - used with [Scatter Series](types/scatter-chart.md), [Category Series](types/column-chart.md), [Stacked Series](types/stacked-chart.md), and [Financial Series](types/stock-chart.md) - used with [Polar Series](types/polar-chart.md) - used with [Polar Series](types/polar-chart.md) and [Radial Series](types/radial-chart.md) - used with [Category Series](types/column-chart.md) and [Financial Series](types/stock-chart.md)
|
-The Angular `DataChart` can use the following type of series that inherit from `Series`:
+The Angular can use the following type of series that inherit from :
| Category Series | Stacked Series |
|------------------|----------------|
-| - `AreaSeries` - `BarSeries` - `ColumnSeries` - `LineSeries` - `PointSeries` - `SplineSeries` - `SplineAreaSeries` - `StepLineSeries` - `StepAreaSeries` - `RangeAreaSeries` - `RangeColumnSeries` - `WaterfallSeries` | - `StackedAreaSeries` - `StackedBarSeries` - `StackedColumnSeries` - `StackedLineSeries` - `StackedSplineSeries` - `Stacked100AreaSeries` - `Stacked100BarSeries` - `Stacked100ColumnSeries` - `Stacked100LineSeries` - `Stacked100SplineSeries`
| - - - - - |
## Angular Data Legend API
-The Angular `DataLegend` has the following API members:
-
-- `IncludedColumns`
-- `ExcludedColumns`
-- `IncludedSeries`
-- `ExcludedSeries`
-- `ValueFormatAbbreviation`
-- `ValueFormatMode`
-- `ValueFormatCulture`
-- `ValueFormatMinFractions`
-- `ValueFormatMaxFractions`
-- `ValueTextColor`
-- `TitleTextColor`
-- `LabelTextColor`
-- `UnitsTextColor`
-- `SummaryType`
-- `HeaderTextColor`
-- `BadgeShape`
+The Angular has the following API members:
+
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
## Angular Donut Chart API
-The Angular `DoughnutChart` has the following API members:
+The Angular has the following API members:
-- `AllowSliceExplosion`
-- `AllowSliceSelection`
-- `InnerExtent`
+-
+-
+-
## Angular Data Pie Chart API
-The Angular `DataPieChart` has the following API members:
+The Angular has the following API members:
- `DataPieChart.ChartType`
- `DataPieChart.HighlightingBehavior`
@@ -95,7 +97,7 @@ The Angular `DataPieChart` has the following API members:
## Angular Pie Chart API
-The Angular `PieChart` has the following API members:
+The Angular has the following API members:
- `PieChart.LegendItemBadgeTemplate`
- `PieChart.LegendItemTemplate`
@@ -106,15 +108,15 @@ The Angular `PieChart` has the following API members:
## Angular Sparkline Chart API
-The Angular `Sparkline` has the following API members:
+The Angular has the following API members:
-- `DisplayNormalRangeInFront`
+-
- `Sparkline.DisplayType`
-- `LowMarkerBrush`
-- `LowMarkerSize`
-- `LowMarkerVisibility`
-- `NormalRangeFill`
-- `UnknownValuePlotting`
+-
+-
+-
+-
+-
## Additional Resources
diff --git a/docs/angular/src/content/en/components/charts/features/chart-axis-gridlines.mdx b/docs/angular/src/content/en/components/charts/features/chart-axis-gridlines.mdx
index 90ed3fc81a..2b239d52c2 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-axis-gridlines.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-axis-gridlines.mdx
@@ -10,12 +10,14 @@ import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro'
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# Angular Axis Gridlines
All Ignite UI for Angular charts include built-in capability to modify appearance of axis lines as well as frequency of major/minor gridlines and tickmarks that are rendered on the X-Axis and Y-Axis.
-the following examples can be applied to `CategoryChart` as well as `FinancialChart` controls.
+the following examples can be applied to as well as controls.
Axis major gridlines are long lines that extend horizontally along the Y-Axis or vertically along the X-Axis from locations of axis labels, and they render through the plot area of the chart. Axis minor gridlines are lines that render between axis major gridlines.
@@ -37,20 +39,20 @@ This example shows how configure the axis gridline to display major and minor gr
Setting the axis interval property specifies how often major gridlines and axis labels are rendered on an axis. Similarly, the axis minor interval property specifies how frequent minor gridlines are rendered on an axis.
-In order to display minor gridlines that correspond to minor interval, you need to set `XAxisMinorStroke` and `XAxisMinorStrokeThickness` properties on the axis. This is because minor gridlines do not have a default color or thickness and they will not be displayed without first assigning them.
+In order to display minor gridlines that correspond to minor interval, you need to set and properties on the axis. This is because minor gridlines do not have a default color or thickness and they will not be displayed without first assigning them.
You can customize how the gridlines are displayed in your Angular chart by setting the following properties:
| Axis Visuals | Type | Property Names | Description |
| -----------------------|---------|--------------------------------------------------------------|---------------- |
-| Major Stroke Color | string | `XAxisMajorStroke` `YAxisMajorStroke` | These properties set the color of axis major gridlines. |
-| Minor Stroke Color | string | `XAxisMinorStroke` `YAxisMinorStroke` | These properties set the color of axis minor gridlines. |
-| Major Stroke Thickness | number | `XAxisMajorStrokeThickness` `YAxisMajorStrokeThickness` | These properties set the thickness in pixels of the axis major gridlines. |
-| Minor Stroke Thickness | number | `XAxisMinorStrokeThickness` `YAxisMinorStrokeThickness` | These properties set the thickness in pixels of the axis minor gridlines. |
-| Major Interval | number | `XAxisInterval` `YAxisInterval` | These properties set interval between axis major gridlines and labels. |
-| Minor Interval | number | `XAxisMinorInterval` `YAxisMinorInterval` | These properties set interval between axis minor gridlines, if used. |
-| Axis Line Stroke Color | string | `XAxisStroke` `YAxisStroke` | These properties set the color of an axis line. |
-| Axis Stroke Thickness | number | `XAxisStrokeThickness` `YAxisStrokeThickness` | These properties set the thickness in pixels of an axis line. |
+| Major Stroke Color | string | | These properties set the color of axis major gridlines. |
+| Minor Stroke Color | string | | These properties set the color of axis minor gridlines. |
+| Major Stroke Thickness | number | | These properties set the thickness in pixels of the axis major gridlines. |
+| Minor Stroke Thickness | number | | These properties set the thickness in pixels of the axis minor gridlines. |
+| Major Interval | number | | These properties set interval between axis major gridlines and labels. |
+| Minor Interval | number | | These properties set interval between axis minor gridlines, if used. |
+| Axis Line Stroke Color | string | | These properties set the color of an axis line. |
+| Axis Stroke Thickness | number | | These properties set the thickness in pixels of an axis line. |
Regarding the Major and Minor Interval in the table above, it is important to note that the major interval for axis labels will also be set by this value, displaying one label at the point on the axis associated with the interval. The minor interval gridlines are always rendered between the major gridlines, and as such, the minor interval properties should always be set to something much smaller (usually 2-5 times smaller) than the value of the major Interval properties.
@@ -65,9 +67,9 @@ The following example demonstrates how to customize the gridlines by setting the
-The axes of the `DataChart` also have the ability to place a dash array on the major and minor gridlines by utilizing the `MajorStrokeDashArray` and `MinorStrokeDashArray` properties, respectively. The actual axis line can be dashed as well by setting the `StrokeDashArray` property of the corresponding axis. These properties take an array of numbers that will describe the length of the dashes for the corresponding grid lines.
+The axes of the also have the ability to place a dash array on the major and minor gridlines by utilizing the and properties, respectively. The actual axis line can be dashed as well by setting the property of the corresponding axis. These properties take an array of numbers that will describe the length of the dashes for the corresponding grid lines.
-The following example demonstrates a `DataChart` with the above dash array properties set:
+The following example demonstrates a with the above dash array properties set:
@@ -76,9 +78,9 @@ The following example demonstrates a `DataChart` with the above dash array prope
## Angular Axis Tickmarks Example
-Axis tick marks are enabled by setting the `XAxisTickLength` and `YAxisTickLength` properties to a value greater than 0. These properties specifies the length of the line segments forming the tick marks.
+Axis tick marks are enabled by setting the and properties to a value greater than 0. These properties specifies the length of the line segments forming the tick marks.
-Tick marks are always extend from the axis line and point to the direction of the labels. Labels are offset by the value of the length of tickmarks to avoid overlapping. For example, with the `YAxisTickLength` property is set to 5, axis labels will be shifted left by that amount.
+Tick marks are always extend from the axis line and point to the direction of the labels. Labels are offset by the value of the length of tickmarks to avoid overlapping. For example, with the property is set to 5, axis labels will be shifted left by that amount.
The following example demonstrates how to customize the tickmarks by setting the properties above:
@@ -95,9 +97,9 @@ You can customize how the axis tickmarks are displayed in our Angular chats by s
| Axis Visuals | Type | Property Names | Description |
| -----------------------|---------|------------------------------------------------------------|------------------------- |
-| Tick Stroke Color | string | `XAxisTickStroke` `YAxisTickStroke` | These properties set the color of the tickmarks. |
-| Tick Stroke Thickness | number | `XAxisTickStrokeThickness` `YAxisTickStrokeThickness` | These properties set the thickness of the axis tick marks. |
-| Tick Stroke Length | number | `XAxisTickLength` `YAxisTickLength` | These properties set the length of the axis tick marks. |
+| Tick Stroke Color | string | | These properties set the color of the tickmarks. |
+| Tick Stroke Thickness | number | | These properties set the thickness of the axis tick marks. |
+| Tick Stroke Length | number | | These properties set the length of the axis tick marks. |
## Additional Resources
@@ -111,25 +113,25 @@ You can find more information about related chart features in these topics:
The following is a list of API members mentioned in the above sections:
-| `DataChart` | `CategoryChart` or `FinancialChart` |
+| | or |
| -------------------------------------------------- | ----------------------------------- |
-| `Axes` -> `NumericXAxis` -> `Interval` | `XAxisInterval` (Major Interval) |
-| `Axes` -> `NumericYAxis` -> `Interval` | `YAxisInterval` (Major Interval) |
-| `Axes` -> `NumericXAxis` -> `MinorInterval` | `XAxisMinorInterval` |
-| `Axes` -> `NumericYAxis` -> `MinorInterval` | `YAxisMinorInterval` |
-| `Axes` -> `NumericXAxis` -> `MajorStroke` | `XAxisMajorStroke` |
-| `Axes` -> `NumericYAxis` -> `MajorStroke` | `YAxisMajorStroke` |
-| `Axes` -> `NumericXAxis` -> `MajorStrokeThickness` | `XAxisMajorStrokeThickness` |
-| `Axes` -> `NumericYAxis` -> `MajorStrokeThickness` | `YAxisMajorStrokeThickness` |
-| `Axes` -> `NumericXAxis` -> `MinorStrokeThickness` | `XAxisMinorStrokeThickness` |
-| `Axes` -> `NumericYAxis` -> `MinorStrokeThickness` | `YAxisMinorStrokeThickness` |
-| `Axes` -> `NumericXAxis` -> `StrokeThickness` | `XAxisStrokeThickness` |
-| `Axes` -> `NumericYAxis` -> `StrokeThickness` | `YAxisStrokeThickness` |
-| `Axes` -> `NumericXAxis` -> `Stroke` | `XAxisStroke` (Axis Line Color) |
-| `Axes` -> `NumericYAxis` -> `Stroke` | `YAxisStroke` (Axis Line Color) |
-| `Axes` -> `NumericXAxis` -> `TickLength` | `XAxisTickLength` |
-| `Axes` -> `NumericYAxis` -> `TickLength` | `YAxisTickLength` |
-| `Axes` -> `NumericXAxis` -> `TickStroke` | `XAxisTickStroke` |
-| `Axes` -> `NumericYAxis` -> `TickStroke` | `YAxisTickStroke` |
-| `Axes` -> `NumericXAxis` -> `Strip` | `XAxisStrip` (Space between Major Gridlines) |
-| `Axes` -> `NumericYAxis` -> `Strip` | `YAxisStrip` (Space between Major Gridlines) |
+| -> -> | (Major Interval) |
+| -> -> | (Major Interval) |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | (Axis Line Color) |
+| -> -> | (Axis Line Color) |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | (Space between Major Gridlines) |
+| -> -> | (Space between Major Gridlines) |
diff --git a/docs/angular/src/content/en/components/charts/features/chart-axis-layouts.mdx b/docs/angular/src/content/en/components/charts/features/chart-axis-layouts.mdx
index 9356484f6f..c0f90fa9af 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-axis-layouts.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-axis-layouts.mdx
@@ -9,19 +9,21 @@ import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro'
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# Angular Axis Layouts
All Ignite UI for Angular charts include options to configure many axis layout options such as location as well as having the ability to share axis between series or have multiple axes in the same chart. These features are demonstrated in the examples given below.
-the following examples can be applied to `CategoryChart` as well as `FinancialChart` controls.
+the following examples can be applied to as well as controls.
## Axis Locations Example
-For all axes, you can specify axis location in relationship to chart plot area. The `XAxisLabelLocation` property of the Angular charts, allows you to position x-axis line and its labels on above or below plot area. Similarly, you can use the `YAxisLabelLocation` property to position y-axis on left side or right side of plot area.
+For all axes, you can specify axis location in relationship to chart plot area. The property of the Angular charts, allows you to position x-axis line and its labels on above or below plot area. Similarly, you can use the property to position y-axis on left side or right side of plot area.
-The following example depicts the amount of renewable electricity produced since 2009, represented by a [Line Chart](../types/line-chart.md). There is a drop-down that lets you configure the `YAxisLabelLocation` so that you can visualize what the axes look like when the labels are placed on the left or right side on the inside or outside of the chart's plot area.
+The following example depicts the amount of renewable electricity produced since 2009, represented by a [Line Chart](../types/line-chart.md). There is a drop-down that lets you configure the so that you can visualize what the axes look like when the labels are placed on the left or right side on the inside or outside of the chart's plot area.
@@ -36,11 +38,11 @@ e.g. https://www.infragistics.com/help/wpf/datachart-axis-orientation
## Axis Advanced Scenarios
-For more advanced axis layout scenarios, you can use Angular Data Chart to share axis, add multiple y-axis and/or x-axis in the same plot area, or even cross axes at specific values. The following examples show how to use these features of the `DataChart`.
+For more advanced axis layout scenarios, you can use Angular Data Chart to share axis, add multiple y-axis and/or x-axis in the same plot area, or even cross axes at specific values. The following examples show how to use these features of the .
### Axis Sharing Example
-You can share and add multiple axes in the same plot area of the Angular `DataChart`. It a common scenario to use share `TimeXAxis` and add multiple `NumericYAxis` to plot many data sources that have wide range of values (e.g. stock prices and stock trade volumes).
+You can share and add multiple axes in the same plot area of the Angular . It a common scenario to use share and add multiple to plot many data sources that have wide range of values (e.g. stock prices and stock trade volumes).
The following example depicts a stock price and trade volume chart with a [Stock Chart](../types/stock-chart.md) and a [Column Chart](../types/column-chart.md) plotted. In this case, the Y-Axis on the left is used by the [Column Chart](../types/column-chart.md) and the Y-Axis on the right is used by the [Stock Chart](../types/stock-chart.md), while the X-Axis is shared between the two.
@@ -53,7 +55,7 @@ The following example depicts a stock price and trade volume chart with a [Stock
### Axis Crossing Example
-In addition to placing axes outside plot area, the Angular `DataChart` also provides options to position axes inside of plot area and make them cross at specific values. For example, you can create trigonometric chart by setting `CrossingAxis` and `CrossingValue` properties on both x-axis and y-axis to render axis lines and axis labels such that they are crossing at (0, 0) origin point.
+In addition to placing axes outside plot area, the Angular also provides options to position axes inside of plot area and make them cross at specific values. For example, you can create trigonometric chart by setting and properties on both x-axis and y-axis to render axis lines and axis labels such that they are crossing at (0, 0) origin point.
The following example shows a Sin and Cos wave represented by a [Scatter Spline Chart](../types/scatter-chart.md) with the X and Y axes crossing each other at the (0, 0) origin point.
@@ -82,25 +84,25 @@ The following is a list of API members mentioned in the above sections:
d in the above sections:
-| `DataChart` | `CategoryChart` |
+| | |
| ------------------------------------------------------ | ------------------------------- |
-| `Axes` -> `NumericYAxis` -> `CrossingAxis` | None |
-| `Axes` -> `NumericYAxis` -> `CrossingValue` | None |
-| `Axes` -> `NumericXAxis` -> `IsInverted` | `XAxisInverted` |
-| `Axes` -> `NumericYAxis` -> `IsInverted` | `YAxisInverted` |
-| `Axes` -> `NumericYAxis` -> `LabelLocation` | `YAxisLabelLocation` |
-| `Axes` -> `NumericXAxis` -> `LabelLocation` | `XAxisLabelLocation` |
-| `Axes` -> `NumericYAxis` -> `LabelHorizontalAlignment` | `YAxisLabelHorizontalAlignment` |
-| `Axes` -> `NumericXAxis` -> `LabelVerticalAlignment` | `XAxisLabelVerticalAlignment` |
-| `Axes` -> `NumericYAxis` -> `LabelVisibility` | `YAxisLabelVisibility` |
-| `Axes` -> `NumericXAxis` -> `LabelVisibility` | `XAxisLabelVisibility` |
+| -> -> | None |
+| -> -> | None |
+| -> -> | |
+| -> -> | |
+| -> -> `LabelLocation` | |
+| -> -> `LabelLocation` | |
+| -> -> `LabelHorizontalAlignment` | |
+| -> -> `LabelVerticalAlignment` | |
+| -> -> `LabelVisibility` | |
+| -> -> `LabelVisibility` | |
{/* TODO correct links in Transformer */}
{/*
-| `Axes` -> `NumericYAxis` -> `labelSettings.location` | `YAxisLabelLocation` |
-| `Axes` -> `NumericXAxis` -> `labelSettings.location` | `XAxisLabelLocation` |
-| `Axes` -> `NumericYAxis` -> `labelSettings.horizontalAlignment` | `YAxisLabelHorizontalAlignment` |
-| `Axes` -> `NumericXAxis` -> `labelSettings.verticalAlignment` | `XAxisLabelVerticalAlignment` |
-| `Axes` -> `NumericYAxis` -> `labelSettings.visibility` | `YAxisLabelVisibility` |
-| `Axes` -> `NumericXAxis` -> `labelSettings.visibility` | `XAxisLabelVisibility` | */}
+| -> -> `labelSettings.location` | |
+| -> -> `labelSettings.location` | |
+| -> -> `labelSettings.horizontalAlignment` | |
+| -> -> `labelSettings.verticalAlignment` | |
+| -> -> `labelSettings.visibility` | |
+| -> -> `labelSettings.visibility` | | */}
diff --git a/docs/angular/src/content/en/components/charts/features/chart-axis-options.mdx b/docs/angular/src/content/en/components/charts/features/chart-axis-options.mdx
index d8830f4a0e..36e62eab3b 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-axis-options.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-axis-options.mdx
@@ -72,9 +72,9 @@ By default, charts will calculate the minimum and maximum values for the numeric
In the and controls, you can choose if your data is plotted on logarithmic scale along the y-axis when the property is set to true or on linear scale when this property is set to false (default value). With the property, you can change base of logarithmic scale from default value of 10 to other integer value.
-The and control allows you to choose how your data is represented along the y-axis using property that provides `Numeric` and `PercentChange` modes. The `Numeric` mode will plot data with the exact values while the `PercentChange` mode will display the data as percentage change relative to the first data point provided. The default value is `Numeric` mode.
+The and control allows you to choose how your data is represented along the y-axis using property that provides and modes. The mode will plot data with the exact values while the mode will display the data as percentage change relative to the first data point provided. The default value is mode.
-In addition to property, the control has property that provides `Time` and `Ordinal` modes for the x-axis. The `Time` mode will render space along the x-axis for gaps in data (e.g. no stock trading on weekends or holidays). The `Ordinal` mode will collapse date areas where data does not exist. The default value is `Ordinal` mode.
+In addition to property, the control has property that provides and modes for the x-axis. The mode will render space along the x-axis for gaps in data (e.g. no stock trading on weekends or holidays). The mode will collapse date areas where data does not exist. The default value is mode.
@@ -124,20 +124,20 @@ You can find more information about related chart features in these topics:
The following is a list of API members mentioned in the above sections:
-| `DataChart` | `FinancialChart` | `CategoryChart` |
+| | | |
| ------------------------------------------------------ | ---------------------- | ---------------------- |
-| `Axes` -> `NumericYAxis` -> `MaximumValue` | `YAxisMaximumValue` | `YAxisMaximumValue` |
-| `Axes` -> `NumericYAxis` -> `MinimumValue` | `YAxisMinimumValue` | `YAxisMinimumValue` |
-| `Axes` -> `NumericYAxis` -> `IsLogarithmic` | `YAxisIsLogarithmic` | `YAxisIsLogarithmic` |
-| `Axes` -> `NumericYAxis` -> `LogarithmBase` | `YAxisLogarithmBase` | `YAxisLogarithmBase` |
-| `Axes` -> `CategoryXAxis` -> `Gap` | None | `XAxisGap` |
-| `Axes` -> `CategoryXAxis` -> `Overlap` | None | `XAxisOverlap` |
-| `Axes` -> `TimeXAxis` | `XAxisMode` | None |
-| `Axes` -> `PercentChangeYAxis` | `YAxisMode` | None |
-| `Axes` -> `NumericYAxis` -> `labelSettings.angle` | `YAxisLabelAngle` | `YAxisLabelAngle` |
-| `Axes` -> `NumericXAxis` -> `labelSettings.angle` | `XAxisLabelAngle` | `XAxisLabelAngle` |
-| `Axes` -> `NumericYAxis` -> `labelSettings.textColor` | `YAxisLabelForeground` | `YAxisLabelForeground` |
-| `Axes` -> `NumericXAxis` -> `labelSettings.textColor` | `XAxisLabelForeground` | `XAxisLabelForeground` |
-| `Axes` -> `NumericYAxis` -> `labelSettings.visibility` | `YAxisLabelVisibility` | `YAxisLabelVisibility` |
-| `Axes` -> `NumericXAxis` -> `labelSettings.visibility` | `XAxisLabelVisibility` | `XAxisLabelVisibility` |
+| -> -> | | |
+| -> -> | | |
+| -> -> | | |
+| -> -> | | |
+| -> -> | None | |
+| -> -> | None | |
+| -> | | None |
+| -> | | None |
+| -> -> `labelSettings.angle` | | |
+| -> -> `labelSettings.angle` | | |
+| -> -> `labelSettings.textColor` | `YAxisLabelForeground` | `YAxisLabelForeground` |
+| -> -> `labelSettings.textColor` | `XAxisLabelForeground` | `XAxisLabelForeground` |
+| -> -> `labelSettings.visibility` | | |
+| -> -> `labelSettings.visibility` | | |
diff --git a/docs/angular/src/content/en/components/charts/features/chart-axis-types.mdx b/docs/angular/src/content/en/components/charts/features/chart-axis-types.mdx
index fd53503b34..f95427e76c 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-axis-types.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-axis-types.mdx
@@ -9,150 +9,154 @@ namespace: Infragistics.Controls.Charts
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# Angular Axis Types
-The Ignite UI for Angular Category Chart uses only one `CategoryXAxis` and one `NumericYAxis` type. Similarly, Ignite UI for Angular Financial Chart uses only one `TimeXAxis` and one `NumericYAxis` types. However, the Ignite UI for Angular Data Chart provides support for multiple axis types that you can position on any side of the chart by setting [axis location](chart-axis-layouts.md#axis-locations-example) or even inside of the chart by using [axis crossing](chart-axis-layouts.md#axis-crossing-example) properties. This topic goes over each one, which axes and series are compatible with each other, and some specific properties to the unique axes.
+The Ignite UI for Angular Category Chart uses only one and one type. Similarly, Ignite UI for Angular Financial Chart uses only one and one types. However, the Ignite UI for Angular Data Chart provides support for multiple axis types that you can position on any side of the chart by setting [axis location](chart-axis-layouts.md#axis-locations-example) or even inside of the chart by using [axis crossing](chart-axis-layouts.md#axis-crossing-example) properties. This topic goes over each one, which axes and series are compatible with each other, and some specific properties to the unique axes.
## Cartesian Axes
-The `DataChart` with Cartesian Axes, allows you to plot data in horizontal (X-axis) and vertical (X-axis) direction with 3 types of X-Axis
-(`CategoryXAxis`, `NumericXAxis`, and `TimeXAxis`) and 2 types of Y-Axis (`CategoryYAxis` and `NumericYAxis`).
+The with Cartesian Axes, allows you to plot data in horizontal (X-axis) and vertical (X-axis) direction with 3 types of X-Axis
+(, , and ) and 2 types of Y-Axis ( and ).
### Category X-Axis
-The `CategoryXAxis` treats its data as a sequence of categorical data items. It can display almost any type of data including strings and numbers. If you are plotting numbers on this axis, it is important to keep in mind that this axis is a discrete axis and not continuous. This means that each categorical data item will be placed equidistant from the one before it. The items will also be plotted in the order that they appear in the axis' data source.
+The treats its data as a sequence of categorical data items. It can display almost any type of data including strings and numbers. If you are plotting numbers on this axis, it is important to keep in mind that this axis is a discrete axis and not continuous. This means that each categorical data item will be placed equidistant from the one before it. The items will also be plotted in the order that they appear in the axis' data source.
-The `CategoryXAxis` requires you to provide a `DataSource` and a `Label` in order to plot data with it. It is generally used with the `NumericYAxis` to plot the following type of series:
+The requires you to provide a `DataSource` and a in order to plot data with it. It is generally used with the to plot the following type of series:
| Category Series | Stacked Series | Financial Series |
|------------------|----------------|--------------------|
-| - `AreaSeries` - `ColumnSeries` - `LineSeries` - `PointSeries` - `SplineSeries` - `SplineAreaSeries` - `StepLineSeries` - `StepAreaSeries` - `RangeAreaSeries` - `RangeColumnSeries` - `WaterfallSeries` | - `StackedAreaSeries` - `StackedColumnSeries` - `StackedLineSeries` - `StackedSplineSeries` - `Stacked100AreaSeries` - `Stacked100ColumnSeries` - `Stacked100LineSeries` - `Stacked100SplineSeries`
|
- The following example demonstrates usage of the `CategoryXAxis` type:
+ The following example demonstrates usage of the type:
### Category Y-Axis
-The `CategoryYAxis` works very similarly to the `CategoryXAxis` described above, but it is placed vertically rather than horizontally. Also, this axis requires you to provide a `DataSource` and a `Label` in order to plot data with it. The `CategoryYAxis` is generally used with the `NumericXAxis` to plot the following type of series:
+The works very similarly to the described above, but it is placed vertically rather than horizontally. Also, this axis requires you to provide a `DataSource` and a in order to plot data with it. The is generally used with the to plot the following type of series:
-- `BarSeries`
-- `StackedBarSeries`
-- `Stacked100BarSeries`
+-
+- `RangeBarSeries`
+-
+-
- The following example demonstrates usage of the `CategoryYAxis` type:
+ The following example demonstrates usage of the type:
### Numeric X-Axis
-The `NumericXAxis` treats its data as continuously varying numerical data items. Labels on this axis are placed horizontally along the X-Axis. The location of the `NumericXAxis` labels depends on the `XMemberPath` property of the various [Scatter Series](../types/scatter-chart.md) that it supports if combined with a `NumericYAxis`. Alternatively, if combined with the `CategoryXAxis`, these labels will be placed corresponding to the `ValueMemberPath` of the `BarSeries`, `StackedBarSeries`, and `Stacked100BarSeries`.
+The treats its data as continuously varying numerical data items. Labels on this axis are placed horizontally along the X-Axis. The location of the labels depends on the property of the various [Scatter Series](../types/scatter-chart.md) that it supports if combined with a . Alternatively, if combined with the , these labels will be placed corresponding to the of the , `RangeBarSeries`, , and .
-The `NumericXAxis` is compatible with the following type of series:
+The is compatible with the following type of series:
-- `BarSeries`
-- `BubbleSeries`
-- `HighDensityScatterSeries`
-- `ScatterSeries`
-- `ScatterLineSeries`
-- `ScatterSplineSeries`
-- `ScatterAreaSeries`
-- `ScatterContourSeries`
-- `ScatterPolylineSeries`
-- `ScatterPolygonSeries`
-- `StackedBarSeries`
-- `Stacked100BarSeries`
+-
+- `RangeBarSeries`
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
- The following example demonstrates usage of the `NumericXAxis`:
+ The following example demonstrates usage of the :
### Numeric Y-Axis
-The `NumericYAxis` treats its data as continuously varying numerical data items. Labels on this axis are placed vertically along the Y-Axis. The location of the `NumericYAxis` labels depends on the `YMemberPath` property of the various [ScatterSeries](../types/scatter-chart.md) that is supports if combined with a `NumericXAxis`. Alternatively, if combined with the `CategoryYAxis`, these labels will be placed corresponding to the `ValueMemberPath` of the category or stacked series mentioned in the table above. If you are using one of the financial series, they will be placed corresponding to the Open/High/Low/Close paths and the series type that you are using.
+The treats its data as continuously varying numerical data items. Labels on this axis are placed vertically along the Y-Axis. The location of the labels depends on the property of the various [ScatterSeries](../types/scatter-chart.md) that is supports if combined with a . Alternatively, if combined with the , these labels will be placed corresponding to the of the category or stacked series mentioned in the table above. If you are using one of the financial series, they will be placed corresponding to the Open/High/Low/Close paths and the series type that you are using.
-The `NumericYAxis` is compatible with the following type of series:
+The is compatible with the following type of series:
| Category Series | Stacked Series | Financial Series | Scatter Series |
|------------------|----------------|------------------|----------------|
-| - `AreaSeries` - `ColumnSeries` - `LineSeries` - `PointSeries` - `SplineSeries` - `SplineAreaSeries` - `StepLineSeries` - `StepAreaSeries` - `RangeAreaSeries` - `RangeColumnSeries` - `WaterfallSeries` | - `StackedAreaSeries` - `StackedColumnSeries` - `StackedLineSeries` - `StackedSplineSeries` - `Stacked100AreaSeries` - `Stacked100ColumnSeries` - `Stacked100LineSeries` - `Stacked100SplineSeries` | - `FinancialPriceSeries` - `BollingerBandsOverlay` - `ForceIndexIndicator` - `MedianPriceIndicator` - `MassIndexIndicator` - `RelativeStrengthIndexIndicator` - `StandardDeviationIndicator` - `TypicalPriceIndicator` | - `BubbleSeries` - `HighDensityScatterSeries` - `ScatterSeries` - `ScatterLineSeries` - `ScatterSplineSeries` - `ScatterAreaSeries` - `ScatterContourSeries` - `ScatterPolylineSeries` - `ScatterPolygonSeries` |
+| - - - - - - - - - - - | - - - - - - - - | - - - - - - - - | - - - - - - - - - |
- The following example demonstrates usage of the `NumericYAxis`:
+ The following example demonstrates usage of the :
### Time X Axis
-The `TimeXAxis` treats its data as a sequence of data items, sorted by date. Labels on this axis type are dates and can be formatted and arranged according to date intervals. The date range of this axis is determined by the date values in a data column that is mapped using its `DateTimeMemberPath`. This, along with a `DataSource` is required to plot data with this axis type.
+The treats its data as a sequence of data items, sorted by date. Labels on this axis type are dates and can be formatted and arranged according to date intervals. The date range of this axis is determined by the date values in a data column that is mapped using its . This, along with a `DataSource` is required to plot data with this axis type.
-The `TimeXAxis` is the X-Axis type in the `FinancialChart` component.
+The is the X-Axis type in the component.
#### Breaks in Time X Axis
-The `TimeXAxis` has the option to exclude intervals of data by using `Breaks`. As a result, the labels and plotted data will not appear at the excluded interval. For example, working/non-working days, holidays, and/or weekends. An instance of `TimeAxisBreak` can be added to the `Breaks` collection of the axis and configured by using a unique `Start`, `End` and `Interval`.
+The has the option to exclude intervals of data by using . As a result, the labels and plotted data will not appear at the excluded interval. For example, working/non-working days, holidays, and/or weekends. An instance of can be added to the collection of the axis and configured by using a unique , and .
#### Formatting in Time X Axis
-The `TimeXAxis` has the `LabelFormats` property, which represents a collection of `TimeAxisLabelFormat` objects. Each `TimeAxisLabelFormat` added to the collection is responsible for assigning a unique `Format` and `Range`. This can be especially useful for drilling down data from years to milliseconds and adjusting the labels depending on the range of time shown by the chart.
+The has the property, which represents a collection of objects. Each added to the collection is responsible for assigning a unique and . This can be especially useful for drilling down data from years to milliseconds and adjusting the labels depending on the range of time shown by the chart.
-The `Format` property of the `TimeAxisLabelFormat` specifies what format to use for a particular visible range. The `Range` property of the `TimeAxisLabelFormat` specifies the visible range at which the axis label formats will switch to a different format. For example, if you have two `TimeAxisLabelFormat` elements with a range set to 10 days and another set to 5 hours, then as soon as the visible range of the axis becomes less than 10 days, it will switch to 5-hour format.
+The property of the specifies what format to use for a particular visible range. The property of the specifies the visible range at which the axis label formats will switch to a different format. For example, if you have two elements with a range set to 10 days and another set to 5 hours, then as soon as the visible range of the axis becomes less than 10 days, it will switch to 5-hour format.
#### Intervals in Time X Axis
-The `TimeXAxis` replaces the conventional `Interval` property of the category and numeric axes with an `Intervals` collection of type `TimeAxisInterval`. Each `TimeAxisInterval` added to the collection is responsible for assigning a unique `Interval`, `Range` and `IntervalType`. This can be especially useful for drilling down data from years to milliseconds to provide unique spacing between labels depending on the range of time shown by the chart. A description of these properties is below:
+The replaces the conventional property of the category and numeric axes with an collection of type . Each added to the collection is responsible for assigning a unique , and . This can be especially useful for drilling down data from years to milliseconds to provide unique spacing between labels depending on the range of time shown by the chart. A description of these properties is below:
-- `Interval`: This specifies the interval to use. This is tied to the `IntervalType` property. For example, if the `IntervalType` is set to `Days`, then the numeric value specified in `Interval` will be in days.
-- `Range`: This specifies the visible range at which the axis interval will switch to a different interval. For example, if you have two TimeAxisInterval with a range set to 10 days and another set to 5 hours, as soon as the visible range in the axis becomes less than 10 days it will switch to the interval whose range is 5 hours.
-- `IntervalType`: This specifies the unit of time for the `Interval` property.
+- : This specifies the interval to use. This is tied to the property. For example, if the is set to `Days`, then the numeric value specified in will be in days.
+- : This specifies the visible range at which the axis interval will switch to a different interval. For example, if you have two TimeAxisInterval with a range set to 10 days and another set to 5 hours, as soon as the visible range in the axis becomes less than 10 days it will switch to the interval whose range is 5 hours.
+- : This specifies the unit of time for the property.
## Polar Axes
-The `DataChart` with Polar Axes, allows you to plot data outwards (radius axis) from center of the chart and around (angle axis) of center of the chart.
+The with Polar Axes, allows you to plot data outwards (radius axis) from center of the chart and around (angle axis) of center of the chart.
### Category Angle Axis
-The `CategoryAngleAxis` treats its data as a sequence of category data items. The labels on this axis are placed along the edge of a circle according to their position in that sequence. This type of axis can display almost any type of data including strings and numbers.
+The treats its data as a sequence of category data items. The labels on this axis are placed along the edge of a circle according to their position in that sequence. This type of axis can display almost any type of data including strings and numbers.
-The `CategoryAngleAxis` is generally used with the `NumericRadiusAxis` to plot [Radial Series](../types/radial-chart.md).
+The is generally used with the to plot [Radial Series](../types/radial-chart.md).
-The following example demonstrates usage of the `CategoryAngleAxis` type:
+The following example demonstrates usage of the type:
### Proportional Category Angle Axis
-The `ProportionalCategoryAngleAxis` treats its data as a sequence of category data items. The labels on this axis are placed along the edge of a circle according to their position in that sequence. This type of axis can display almost any type of data including strings and numbers.
+The treats its data as a sequence of category data items. The labels on this axis are placed along the edge of a circle according to their position in that sequence. This type of axis can display almost any type of data including strings and numbers.
-The `ProportionalCategoryAngleAxis` is generally used with the `NumericRadiusAxis` to plot a pie chart eg. [Radial Series](../types/radial-chart.md).
+The is generally used with the to plot a pie chart eg. [Radial Series](../types/radial-chart.md).
-The following example demonstrates usage of the `ProportionalCategoryAngleAxis` type:
+The following example demonstrates usage of the type:
### Numeric Angle Axis
-The `NumericAngleAxis` treats its data as continuously varying numerical data items. The labels on this axis area placed along a radius line starting from the center of the circular plot. The location of the labels on the `NumericAngleAxis` varies according to the value in the data column mapped using the `RadiusMemberPath` property of the [Polar Series](../types/polar-chart.md) object or the `ValueMemberPath` property of the [Radial Series](../types/radial-chart.md) object.
+The treats its data as continuously varying numerical data items. The labels on this axis area placed along a radius line starting from the center of the circular plot. The location of the labels on the varies according to the value in the data column mapped using the property of the [Polar Series](../types/polar-chart.md) object or the property of the [Radial Series](../types/radial-chart.md) object.
-The The `NumericAngleAxis` can be used with either the `CategoryAngleAxis` to plot [Radial Series](../types/radial-chart.md) or with the `NumericRadiusAxis` to plot [Polar Series](../types/polar-chart.md) respectively.
+The The can be used with either the to plot [Radial Series](../types/radial-chart.md) or with the to plot [Polar Series](../types/polar-chart.md) respectively.
-The following example demonstrates usage of the `NumericAngleAxis` type:
+The following example demonstrates usage of the type:
### Numeric Radius Axis
-The `NumericRadiusAxis` treats the data as continuously varying numerical data items. The labels on this axis are placed around the circular plot. The location of the labels varies according to the value in a data column mapped using the `AngleMemberPath` property of the corresponding polar series.
+The treats the data as continuously varying numerical data items. The labels on this axis are placed around the circular plot. The location of the labels varies according to the value in a data column mapped using the `AngleMemberPath` property of the corresponding polar series.
-The `NumericRadiusAxis` can be used with the `NumericRadiusAxis` to plot [Polar Series](../types/polar-chart.md).
+The can be used with the to plot [Polar Series](../types/polar-chart.md).
-The following example demonstrates usage of the `NumericRadiusAxis` type:
+The following example demonstrates usage of the type:
diff --git a/docs/angular/src/content/en/components/charts/features/chart-data-annotations.mdx b/docs/angular/src/content/en/components/charts/features/chart-data-annotations.mdx
index 972158fd58..500430f681 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-data-annotations.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-data-annotations.mdx
@@ -11,6 +11,8 @@ import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# Angular Chart Data Annotations
In the Angular chart, the data annotation layers allow you to annotate data plotted in Data Chart with sloped lines, vertical/horizontal lines (aka axis slices), vertical/horizontal strips (targeting specific axis), rectangles, and even parallelograms (aka bands). With data-binding supported, you can create as many annotations as you want to customize your charts. Also, you can combine different annotation layers and you can overlay text inside of plot area to annotated important events, patterns, and regions in your data.
@@ -28,7 +30,7 @@ Like this sample? Get access to our complete Angular toolkit and start building
## Angular Data Annotation Slice Layer Example
-In Angular, the `DataAnnotationSliceLayer` renders multiple vertical or horizontal lines that slice the chart at multiple values of an axis in the `DataChart` component. This data annotation layer is often used to annotate important events (e.g. company quarter reports) on x-axis or important values on y-axis. Setting the TargetAxis property to y-axis will render data annotation layer as horizontal slices or setting TargetAxis property to x-axis will render data annotation layer as vertical slices. Similarly to all series, the DataAnnotationSliceLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 1 numeric data column mapped to the `AnnotationValueMemberPath` property.
+In Angular, the renders multiple vertical or horizontal lines that slice the chart at multiple values of an axis in the component. This data annotation layer is often used to annotate important events (e.g. company quarter reports) on x-axis or important values on y-axis. Setting the TargetAxis property to y-axis will render data annotation layer as horizontal slices or setting TargetAxis property to x-axis will render data annotation layer as vertical slices. Similarly to all series, the DataAnnotationSliceLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 1 numeric data column mapped to the property.
For example, you can use DataAnnotationSliceLayer to annotate stock prices with important events such as stock split and outcome of earning reports.
@@ -39,9 +41,9 @@ For example, you can use DataAnnotationSliceLayer to annotate stock prices with
## Angular Data Annotation Strip Layer Example
-In Angular, the `DataAnnotationStripLayer` renders multiple vertical or horizontal strips between 2 values on an axis in the `DataChart` component. This data annotation layer can be used to annotate duration of events (e.g. stock market crash) on x-axis or important range of values on y-axis. Setting the TargetAxis property to y-axis will render data annotation layer as horizontal strips or setting TargetAxis property to x-axis will render data annotation layer as vertical strips. Similarly to all series, the `DataAnnotationStripLayer` also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 1 numeric data column mapped to the AnnotationValueMemberPath property.
+In Angular, the renders multiple vertical or horizontal strips between 2 values on an axis in the component. This data annotation layer can be used to annotate duration of events (e.g. stock market crash) on x-axis or important range of values on y-axis. Setting the TargetAxis property to y-axis will render data annotation layer as horizontal strips or setting TargetAxis property to x-axis will render data annotation layer as vertical strips. Similarly to all series, the also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 1 numeric data column mapped to the AnnotationValueMemberPath property.
-For example, you can use `DataAnnotationStripLayer` to annotate chart with stock market crashes and changes in federal interest rates.
+For example, you can use to annotate chart with stock market crashes and changes in federal interest rates.
@@ -50,7 +52,7 @@ For example, you can use `DataAnnotationStripLayer` to annotate chart with stock
## Angular Data Annotation Line Layer Example
-In Angular, `DataAnnotationLineLayer` renders multiple lines between 2 points in plot area of the `DataChart` component. This data annotation layer can be used to annotate stock chart with growth and decline in stock prices. Similarly to all series, the DataAnnotationLineLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 4 numeric data columns representing x/y coordinates of starting point and ending point of the lines. The starting points should be mapped using using `StartValueXMemberPath` and `StartValueYMemberPath` properties and the ending points should be mapped using `EndValueXMemberPath` and `EndValueYMemberPath` properties.
+In Angular, renders multiple lines between 2 points in plot area of the component. This data annotation layer can be used to annotate stock chart with growth and decline in stock prices. Similarly to all series, the DataAnnotationLineLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 4 numeric data columns representing x/y coordinates of starting point and ending point of the lines. The starting points should be mapped using using and properties and the ending points should be mapped using and properties.
For example, you can use DataAnnotationLineLayer to annotate growth and decline patterns in stock prices and 52-week high and low of stock prices on y-axis.
@@ -61,7 +63,7 @@ For example, you can use DataAnnotationLineLayer to annotate growth and decline
## Angular Data Annotation Rect Layer Example
-In Angular, the `DataAnnotationRectLayer` renders multiple rectangles defined by starting and ending points in plot area of the `DataChart` component. This data annotation layer can be used to annotate region of plot area such as bearish patterns in stock prices. Similarly to all series, the DataAnnotationRectLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 4 numeric data columns representing x/y coordinates of starting point and ending point of the rectangles. The starting points should be mapped using using `StartValueXMemberPath` and `StartValueYMemberPath` properties and the ending points should be mapped using `EndValueXMemberPath` and `EndValueYMemberPath` properties.
+In Angular, the renders multiple rectangles defined by starting and ending points in plot area of the component. This data annotation layer can be used to annotate region of plot area such as bearish patterns in stock prices. Similarly to all series, the DataAnnotationRectLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 4 numeric data columns representing x/y coordinates of starting point and ending point of the rectangles. The starting points should be mapped using using and properties and the ending points should be mapped using and properties.
For example, you can use DataAnnotationRectLayer to annotate bearish patterns and gaps in stock prices on y-axis.
@@ -72,7 +74,7 @@ For example, you can use DataAnnotationRectLayer to annotate bearish patterns an
## Angular Data Annotation Band Layer Example
-In Angular, the `DataAnnotationBandLayer` renders multiple skewed rectangles (free-form parallelogram) between 2 points in plot area of the `DataChart` component. This data annotation layer can be used to annotate range of growth and decline in stock prices. Similarly to all series, the DataAnnotationBandLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 4 numeric data columns representing x/y coordinates of starting point and ending point of the lines. The starting points should be mapped using `StartValueXMemberPath` and `StartValueYMemberPath` properties and the ending points should be mapped using `EndValueXMemberPath` and `EndValueYMemberPath` properties. In addition, you can specify thickness/size of the skewed rectangle by binding numeric data column to the AnnotationBreadthMemberPath property.
+In Angular, the renders multiple skewed rectangles (free-form parallelogram) between 2 points in plot area of the component. This data annotation layer can be used to annotate range of growth and decline in stock prices. Similarly to all series, the DataAnnotationBandLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 4 numeric data columns representing x/y coordinates of starting point and ending point of the lines. The starting points should be mapped using and properties and the ending points should be mapped using and properties. In addition, you can specify thickness/size of the skewed rectangle by binding numeric data column to the AnnotationBreadthMemberPath property.
For example, you can use DataAnnotationBandLayer to annotate range of growth in stock prices.
@@ -85,14 +87,14 @@ For example, you can use DataAnnotationBandLayer to annotate range of growth in
The following is a list of API members mentioned in the above sections:
-- `TargetAxis`: This property specifies which axis should have an enabled DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
+- : This property specifies which axis should have an enabled DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
- `DataSource`: This property binds data to the annotation layer to provide the precise shape.
-- `StartValueXMemberPath`: This property is a mapping to the name of the data column with x-positions for the start of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
-- `StartValueYMemberPath`: This property is a mapping to the name of data column with y-positions for the start of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
-- `EndValueXMemberPath`: This property is a mapping to the data column with x-positions for the end of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
-- `EndValueYMemberPath`: This property is a mapping to the data column with y-positions for end of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
-- `StartLabelXMemberPath`: This property is a mapping to the data column representing the overlay label for the starting position of the xAxis along the axis.
-- `StartLabelXDisplayMode` | `StartLabelYDisplayMode` | `EndLabelXDisplayMode` | `EndLabelYDisplayMode` | `CenterLabelXDisplayMode`: These properties specify what should annotation labels display on starting, ending, or center of the annotation shape, e.g. mapped data value, mapped data label, axis value, or hide a given annotation label.
-- `StartLabelYMemberPath`: This property is a mapping to the data column representing the axis label for the starting position of `DataAnnotationBandLayer`, `DataAnnotationLineLayer`, `DataAnnotationRectLayer` on the y-axis.
-- `EndLabelYMemberPath`: This property is a mapping to the data column representing the axis label for the ending position of `DataAnnotationBandLayer`, `DataAnnotationLineLayer`, `DataAnnotationRectLayer` on the y-axis.
+- : This property is a mapping to the name of the data column with x-positions for the start of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
+- : This property is a mapping to the name of data column with y-positions for the start of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
+- : This property is a mapping to the data column with x-positions for the end of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
+- : This property is a mapping to the data column with y-positions for end of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
+- : This property is a mapping to the data column representing the overlay label for the starting position of the xAxis along the axis.
+- | | | | : These properties specify what should annotation labels display on starting, ending, or center of the annotation shape, e.g. mapped data value, mapped data label, axis value, or hide a given annotation label.
+- : This property is a mapping to the data column representing the axis label for the starting position of , , on the y-axis.
+- : This property is a mapping to the data column representing the axis label for the ending position of , , on the y-axis.
diff --git a/docs/angular/src/content/en/components/charts/features/chart-data-legend.mdx b/docs/angular/src/content/en/components/charts/features/chart-data-legend.mdx
index 53285acb0e..ba7adf0c1e 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-data-legend.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-data-legend.mdx
@@ -15,37 +15,37 @@ import layoutMode from '@xplat-images/general/layout_mode.png';
# Angular Data Legend
-In Ignite UI for Angular, the `DataLegend` is highly-customizable version of the `Legend`, that shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values. This legend updates when moving the mouse inside of the plot area of the `CategoryChart`, `FinancialChart`, and `DataChart`. Also, it has a persistent state that remembers the last hovered point when the user's mouse pointer exits the plot area. It displays this content using a set of three type of rows (header, series, summary) and four types of columns (title, label, value, unit).
+In Ignite UI for Angular, the is highly-customizable version of the , that shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values. This legend updates when moving the mouse inside of the plot area of the , , and . Also, it has a persistent state that remembers the last hovered point when the user's mouse pointer exits the plot area. It displays this content using a set of three type of rows (header, series, summary) and four types of columns (title, label, value, unit).
## Angular Data Legend Rows
-The rows of the `DataLegend` include the header row, series row(s), and the summary row. The header row displays the axis label of the point that is hovered, and can be changed using the `HeaderText` property.
+The rows of the include the header row, series row(s), and the summary row. The header row displays the axis label of the point that is hovered, and can be changed using the property.
### Header Row
-The header row displays the current label of x-axis when hovering mouse over category series and financial series. You can use `HeaderFormatDate` and `HeaderFormatTime` properties to format date and time in the `DataLegend` if the x-axis shows dates. For other types of series, the `DataLegend` does not render the header row.
+The header row displays the current label of x-axis when hovering mouse over category series and financial series. You can use and properties to format date and time in the if the x-axis shows dates. For other types of series, the does not render the header row.
### Series Row
-The series row represents each series plotted in the chart. These rows will display the legend badge, series title, actual/abbreviated value of the the series, and abbreviation symbol or unit of measurement, if specified. You can filter series rows by setting `IncludedSeries` or `ExcludedSeries` properties to a collection of series' indexes (1, 2, 3) or series' titles (Tesla, Microsoft).
+The series row represents each series plotted in the chart. These rows will display the legend badge, series title, actual/abbreviated value of the the series, and abbreviation symbol or unit of measurement, if specified. You can filter series rows by setting or properties to a collection of series' indexes (1, 2, 3) or series' titles (Tesla, Microsoft).
### Summary Row
-Finally, there is a summary row that displays the total of all series values. The default summary title can be changed using the `SummaryTitleText` property of the legend. Also, you can use the `SummaryType` property to customize whether you display the `Total`, `Min`, `Max`, or `Average` of series values in the summary row.
+Finally, there is a summary row that displays the total of all series values. The default summary title can be changed using the property of the legend. Also, you can use the property to customize whether you display the , , , or of series values in the summary row.
## Angular Data Legend Columns
-The columns of the `DataLegend` include the series title, label, value of data column, and optional unit associated with the value. Some series in the chart can have multiple columns for label, value, and units. For example, financial price series has **High**, **Low**, **Open**, and **Close** data columns which can be filtered in the `DataLegend` using the `IncludedColumns` or `ExcludedColumns` properties.
+The columns of the include the series title, label, value of data column, and optional unit associated with the value. Some series in the chart can have multiple columns for label, value, and units. For example, financial price series has **High**, **Low**, **Open**, and **Close** data columns which can be filtered in the using the or properties.
-Setting values on the `IncludedColumns` and `ExcludedColumns` properties, depends on type of series and how many data columns they support. For example, you can set `IncludedColumns` property to a collection of **Open** and **Close** strings and the legend will show only open and close values for stock prices when the chart is plotting financial series. The following table lists all column names that can be use to filter columns in data legend.
+Setting values on the and properties, depends on type of series and how many data columns they support. For example, you can set property to a collection of **Open** and **Close** strings and the legend will show only open and close values for stock prices when the chart is plotting financial series. The following table lists all column names that can be use to filter columns in data legend.
| Type of Series | Column Names |
| -----------------|-------------- |
@@ -61,20 +61,20 @@ Where the **TypicalPrice** and percentage **Change** of OHLC prices are automati
### Title Column
-The title column displays legend badges and series titles, which come from the `Title` property of the different `Series` plotted in the chart.
+The title column displays legend badges and series titles, which come from the property of the different plotted in the chart.
### Label Column
-The label column displays short name on the left side of value column, e.g. "O" for **Open** stock price. You can toggle visibility of this column using the `LabelDisplayMode` property.
+The label column displays short name on the left side of value column, e.g. "O" for **Open** stock price. You can toggle visibility of this column using the property.
### Value Column
-The value column displays values of series as abbreviated text which can be formatted using the `ValueFormatAbbreviation` property to apply the same abbreviation for all numbers by setting this property to `Shared`. Alternatively, a user can select other abbreviations such as `Independent`, `Kilo`, `Million`, etc. Precision of abbreviated values is controlled using the `ValueFormatMinFractions` and `ValueFormatMaxFractions` for minimum and maximum digits, respectively.
+The value column displays values of series as abbreviated text which can be formatted using the property to apply the same abbreviation for all numbers by setting this property to . Alternatively, a user can select other abbreviations such as , , , etc. Precision of abbreviated values is controlled using the and for minimum and maximum digits, respectively.
### Unit Column
-The unit column displays an abbreviation symbol on the right side of value column. The unit symbol depends on the `ValueFormatAbbreviation` property, e.g. "M" for the `Million` abbreviation.
+The unit column displays an abbreviation symbol on the right side of value column. The unit symbol depends on the property, e.g. "M" for the abbreviation.
### Customizing Columns
@@ -88,11 +88,11 @@ You can customize text displayed in the **Label** and **Unit** columns using pr
| Range Series | HighMemberAsLegendLabel="H:" HighMemberAsLegendUnit="K" LowMemberAsLegendLabel="L:" LowMemberAsLegendUnit="K" |
| Financial Series | OpenMemberAsLegendLabel="O:" OpenMemberAsLegendUnit="K" HighMemberAsLegendLabel="H:" HighMemberAsLegendUnit="K" LowMemberAsLegendLabel="L:" LowMemberAsLegendUnit="K" CloseMemberAsLegendLabel="C:" CloseMemberAsLegendUnit="K" |
-Also, you can use the `UnitText` property on the `DataLegend` to change text displayed in all Unit columns.
+Also, you can use the `UnitText` property on the to change text displayed in all Unit columns.
## Layout Mode
-Legend items can be positioned in a vertical or table structure via the `LayoutMode` property. The default value is `Table`, which retains the same look and feel as seen in previous releases.
+Legend items can be positioned in a vertical or table structure via the property. The default value is `Table`, which retains the same look and feel as seen in previous releases.
eg.
@@ -100,7 +100,7 @@ eg.
## Angular Data Legend Styling
-The `DataLegend` provides properties for styling each type of column. Each of these properties begins with **Title**, **Label**, **Value**, or **Units**. You can style the text's color, font, and margin. For example, if you wanted to set the text color of all columns, you would set the `TitleTextColor`, `LabelTextColor`, `ValueTextColor`, and `UnitsTextColor` properties. The following example demonstrates a utilization of the styling properties mentioned above:
+The provides properties for styling each type of column. Each of these properties begins with **Title**, **Label**, **Value**, or **Units**. You can style the text's color, font, and margin. For example, if you wanted to set the text color of all columns, you would set the , , , and properties. The following example demonstrates a utilization of the styling properties mentioned above:
@@ -109,7 +109,7 @@ The `DataLegend` provides properties for styling each type of column. Each of th
## Angular Data Legend Value Formatting
-The `DataLegend` provides automatic abbreviation of large numbers using its `ValueFormatAbbreviation` property. This adds a multiplier in the units column such as kilo, million, billion, etc. You can customize the number of fractional digits that are displayed by setting the `ValueFormatMinFractions` and `ValueFormatMaxFractions`. This will allow you to determine the minimum and maximum number of digits that appear after the decimal point, respectively.
+The provides automatic abbreviation of large numbers using its property. This adds a multiplier in the units column such as kilo, million, billion, etc. You can customize the number of fractional digits that are displayed by setting the and . This will allow you to determine the minimum and maximum number of digits that appear after the decimal point, respectively.
The following example demonstrates how to use those properties:
@@ -119,7 +119,7 @@ The following example demonstrates how to use those properties:
## Angular Data Legend Value Mode
-You have the ability to change the default decimal display of values within the `DataLegend` to a currency by changing the `ValueFormatMode` property. Also, you can change the culture of the displayed currency symbol by setting the `ValueFormatCulture` property a culture tag. For example, the following example data legend with the `ValueFormatCulture` set to "en-GB" to display British Pounds (£) symbol:
+You have the ability to change the default decimal display of values within the to a currency by changing the property. Also, you can change the culture of the displayed currency symbol by setting the property a culture tag. For example, the following example data legend with the set to "en-GB" to display British Pounds (£) symbol:
@@ -127,8 +127,8 @@ You have the ability to change the default decimal display of values within the
## Angular Data Legend Grouping
-`DataLegendGroup` can be set, on all types of series, to a string that will categorize a group of series in Data Legend. Each group will have its own summary row displayed before another group of series is displayed:
-By default, DataLegend will hide names of groups, but you can display group names by setting the `GroupRowVisible` property to true.
+ can be set, on all types of series, to a string that will categorize a group of series in Data Legend. Each group will have its own summary row displayed before another group of series is displayed:
+By default, DataLegend will hide names of groups, but you can display group names by setting the property to true.
@@ -140,21 +140,21 @@ Several properties are exposed including grouping portions of the legend.
- `GroupRowMargin`
- `GroupTextMargin`
-- `GroupTextColor`
+-
- `GroupTextFontSize`
- `GroupTextFontFamily`
- `GroupTextFontStyle`
- `GroupTextFontStretch`
- `GroupTextFontWeight`
- `HeaderTextMargin`
-- `HeaderTextColor`
+-
- `HeaderTextFontSize`
- `HeaderTextFontFamily`
- `HeaderTextFontStyle`
- `HeaderTextFontStretch`
- `HeaderTextFontWeight`
-The `DataLegend` has several events that fire when rendering their corresponding row, even during mouse interactions where the values are updating. These events are listed below with a description of what they are designed to be used for:
+The has several events that fire when rendering their corresponding row, even during mouse interactions where the values are updating. These events are listed below with a description of what they are designed to be used for:
- `StyleGroupRow`: This event fires for each group to style text displayed in group rows.
- `StyleHeaderRow`: This event fires when rendering the header row.
@@ -163,9 +163,9 @@ The `DataLegend` has several events that fire when rendering their corresponding
- `StyleSummaryRow`: This event fires once when rendering the summary row.
- `StyleSummaryColumn`: This event fires once when rendering the summary column.
-Some of the events exposes a `DataLegendStylingRowEventArgs` parameter as its arguments, which lets you customize each item's text, text color, and the overall visibility of the row. The event arguments also expose event-specific properties. For example, since the `StyleSeriesRow` event fires for each series, the event arguments will return the series index and series title for the row that represents the series.
+Some of the events exposes a parameter as its arguments, which lets you customize each item's text, text color, and the overall visibility of the row. The event arguments also expose event-specific properties. For example, since the `StyleSeriesRow` event fires for each series, the event arguments will return the series index and series title for the row that represents the series.
-`StyleSummaryColumn` and `SeriesStyleColumn` events expose a `DataLegendStylingColumnEventArgs` parameter as its arguments, for customizing each field in the series. The event arguments also expose event-specific properties such as column index and value member related properties about the columns.
+`StyleSummaryColumn` and `SeriesStyleColumn` events expose a parameter as its arguments, for customizing each field in the series. The event arguments also expose event-specific properties such as column index and value member related properties about the columns.
diff --git a/docs/angular/src/content/en/components/charts/features/chart-data-selection.mdx b/docs/angular/src/content/en/components/charts/features/chart-data-selection.mdx
index f8c370692e..60f331ceb4 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-data-selection.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-data-selection.mdx
@@ -10,13 +10,15 @@ namespace: Infragistics.Controls.Charts
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# Angular Chart Selection
The Ignite UI for Angular selection feature in Angular Data Chart allows users to interactively select, highlight, outline and vice-versa deselect single or multiple series within a chart. This provides many different possibilities with how users interact with the data presented in more meaningful ways.
## Configuring Selection
-The default behavior `SelectionMode` turned off and requires opting into one of the following options. There are several selection modes available in the `DataChart`:
+The default behavior turned off and requires opting into one of the following options. There are several selection modes available in the :
- **Auto**
- **None**
@@ -32,10 +34,10 @@ The default behavior `SelectionMode` turned off and requires opting into one of
- **ThickOutline**
`Brighten` will fade the selected item while `FadeOthers` will cause the opposite effect occur.
-`GrayscaleOthers` will behave similarly to `FadeOthers` but instead show a gray color to the rest of the series. Note this will override any `SelectionBrush` setting.
+`GrayscaleOthers` will behave similarly to `FadeOthers` but instead show a gray color to the rest of the series. Note this will override any setting.
`SelectionColorOutline` and `SelectionColorThickOutline` will draw a border around the series.
-In conjunction, a `SelectionBehavior` is available to provide greater control on which items get selected. The default behavior for Auto is `PerSeriesAndDataItemMultiSelect`.
+In conjunction, a is available to provide greater control on which items get selected. The default behavior for Auto is `PerSeriesAndDataItemMultiSelect`.
- **Auto**
- **PerDataItemMultiSelect**
@@ -56,7 +58,7 @@ The following example shows the combination of both `SelectionColorFill` and `Au
## Configuring Multiple Selection
-Other selection modes offer various methods of selection. For example using `SelectionBehavior` with `PerDataItemMultiSelect` will affect all series in entire category when multiple series are present while allowing selection across categories. Compared to `PerDataItemSingleSelect`, only a single category of items can be selected at a time. This is useful if multiple series are bound to different datasources and provides greater control of selection between categories.
+Other selection modes offer various methods of selection. For example using with `PerDataItemMultiSelect` will affect all series in entire category when multiple series are present while allowing selection across categories. Compared to `PerDataItemSingleSelect`, only a single category of items can be selected at a time. This is useful if multiple series are bound to different datasources and provides greater control of selection between categories.
`PerSeriesAndDataItemGlobalSingleSelect` allows single series selection across all categories at a time.
@@ -64,19 +66,19 @@ Other selection modes offer various methods of selection. For example using `Sel
## Configuring Outline Selection
-When `FocusBrush` is applied, selected series will appear with a border when the `SelectionMode` property is set to one of the focus options.
+When is applied, selected series will appear with a border when the property is set to one of the focus options.
## Radial Series Selection
-This example demonstrates another series type via the `DataChart` where each radial series can be selected with different colors.
+This example demonstrates another series type via the where each radial series can be selected with different colors.
## Programmatic Selection
-Chart Selection can also be configured in code where selected items in the chart can be seen on startup or runtime. This can be achieved by adding items to the `SelectedSeriesCollection` of the `CategoryChart`. The `Matcher` property of the `ChartSelection` object allows for selecting a series based on a "matcher", ideal when you do not have access to the actual series from the chart. If you know the properties that your datasource contains, you can use the `ValueMemberPath` that the series would be.
+Chart Selection can also be configured in code where selected items in the chart can be seen on startup or runtime. This can be achieved by adding items to the `SelectedSeriesCollection` of the . The property of the object allows for selecting a series based on a "matcher", ideal when you do not have access to the actual series from the chart. If you know the properties that your datasource contains, you can use the `ValueMemberPath` that the series would be.
-The matcher is ideal for using in charts, such as the `CategoryChart` when you do not have access to the actual series, like the `DataChart`. In this case you if you know the properties that your datasource contained you can surmise the ValueMemberPaths that the series would have. For example, if you datasource has numeric properties Nuclear, Coal, Oil, Solar then you know there are series created for each of these properties. If you want to highlight the series bound to Solar values, you can add a ChartSelection object to the `SelectedSeriesItems` collection using a matcher with the following properties set
+The matcher is ideal for using in charts, such as the when you do not have access to the actual series, like the . In this case you if you know the properties that your datasource contained you can surmise the ValueMemberPaths that the series would have. For example, if you datasource has numeric properties Nuclear, Coal, Oil, Solar then you know there are series created for each of these properties. If you want to highlight the series bound to Solar values, you can add a ChartSelection object to the collection using a matcher with the following properties set
For example, if you datasource has numeric properties Nuclear, Coal, Oil, Solar then you know there are series created for each of these properties. If you want to select the series bound to Solar values, you can add a ChartSelection object to the SelectedSeriesItems collection using a matcher with the following properties set.
@@ -87,6 +89,6 @@ For example, if you datasource has numeric properties Nuclear, Coal, Oil, Solar
The following is a list of API members mentioned in the above sections:
-| `CategoryChart` Properties | `DataChart` Properties |
+| Properties | Properties |
| ----------------------------------------------|---------------------------|
| | |
diff --git a/docs/angular/src/content/en/components/charts/features/chart-data-tooltip.mdx b/docs/angular/src/content/en/components/charts/features/chart-data-tooltip.mdx
index 11cb111f34..7694cfd55e 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-data-tooltip.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-data-tooltip.mdx
@@ -46,7 +46,7 @@ The following example demonstrates the data tooltip with a summary applied:
The columns of the include the title, label, value, and units columns. Each series in the chart can have multiple columns for label, value, and units depending on the or collections of the chart.
-The title column displays legend badges and series titles, which come from the `Title` property of the different `Series` plotted in the chart.
+The title column displays legend badges and series titles, which come from the property of the different plotted in the chart.
The label column displays the name or abbreviation of the different property paths in the or collections of the tooltip.
@@ -83,8 +83,8 @@ The following example demonstrates a data tooltip with the added columns of Open
## Angular Data Tooltip Grouping for Data Chart
-`DataLegendGroup` can be set, on all types of series, to a string that will categorize a group of series in Data Legend. Each group will have its own summary row displayed before another group of series is displayed:
-By default, DataLegend will hide names of groups, but you can display group names by setting the `GroupRowVisible` property to true. `GroupingMode` should be set to "Grouped" and `LabelDisplayMode` should be set to "Visible" on the Data Tooltip Layer.
+ can be set, on all types of series, to a string that will categorize a group of series in Data Legend. Each group will have its own summary row displayed before another group of series is displayed:
+By default, DataLegend will hide names of groups, but you can display group names by setting the property to true. should be set to "Grouped" and should be set to "Visible" on the Data Tooltip Layer.
@@ -119,7 +119,7 @@ You can change the default decimal display of values within the **DataToolTip**
## Layout Mode
-Legend items can be positioned in a vertical or table structure via the `LayoutMode` property. The default value is `Table`, which retains the same look and feel as seen in previous releases.
+Legend items can be positioned in a vertical or table structure via the property. The default value is `Table`, which retains the same look and feel as seen in previous releases.
eg.
@@ -138,14 +138,14 @@ The following example demonstrates usage of the styling properties mentioned abo
Several properties are exposed including grouping portions of the tooltip.
- `GroupTextMargin`
-- `GroupTextColor`
+-
- `GroupTextFontSize`
- `GroupTextFontFamily`
- `GroupTextFontStyle`
- `GroupTextFontStretch`
- `GroupTextFontWeight`
- `HeaderTextMargin`
-- `HeaderTextColor`
+-
- `HeaderTextFontSize`
- `HeaderTextFontFamily`
- `HeaderTextFontStyle`
diff --git a/docs/angular/src/content/en/components/charts/features/chart-highlight-filter.mdx b/docs/angular/src/content/en/components/charts/features/chart-highlight-filter.mdx
index 45508b55c5..fd065636f6 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-highlight-filter.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-highlight-filter.mdx
@@ -9,6 +9,8 @@ namespace: Infragistics.Controls.Charts
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# Angular Chart Highlight Filter
The Ignite UI for Angular Chart components support a data highlighting overlay that can enhance the visualization of the series plotted in those charts by allowing you to view a subset of the data plotted. When enabled, this will highlight a subset of data while showing the total set with a reduced opacity in the case of column and area series types, and a dashed line in the case of line series types. This can help you to visualize things like target values versus actual values with your data set. This feature is demonstrated in the following example:
@@ -16,45 +18,45 @@ The Ignite UI for Angular Chart components support a data highlighting overlay t
-Note that data highlighting feature is supported by the `DataChart` and `CategoryChart`, but it is configured in different ways in those controls due to the nature of how those controls work. One thing remains constant with this feature though, in that you need to set the `HighlightedValuesDisplayMode` property to `Overlay` if you want to see the highlight. The following will explain the different configurations for the highlight filter feature.
+Note that data highlighting feature is supported by the and , but it is configured in different ways in those controls due to the nature of how those controls work. One thing remains constant with this feature though, in that you need to set the property to `Overlay` if you want to see the highlight. The following will explain the different configurations for the highlight filter feature.
## Using Highlight Filter with DataChart
-In the `DataChart`, much of the highlight filter API happens on the series themselves, mainly by setting the `HighlightedItemsSource` property to a collection representing a subset of the data you want to highlight. The count of the items in the `HighlightedItemsSource` needs to match the count of the data bound to the `ItemsSource` of the series that you are looking to highlight, and in the case of category series, it will use the `ValueMemberPath` that you have defined as the highlight path by default. The sample at the top of this page uses the `HighlightedItemsSource` in the `DataChart` to show the overlay.
+In the , much of the highlight filter API happens on the series themselves, mainly by setting the property to a collection representing a subset of the data you want to highlight. The count of the items in the needs to match the count of the data bound to the of the series that you are looking to highlight, and in the case of category series, it will use the `ValueMemberPath` that you have defined as the highlight path by default. The sample at the top of this page uses the in the to show the overlay.
-In the case that the schema does not match between the `HighlightedItemsSource` and the `ItemsSource` of the series, you can configure this using the `HighlightedValueMemberPath` property on the series. Additionally, if you would like to use the `ItemsSource` of the series itself as the highlight source and have a path on your data item that represents the subset, you can do this. This is done by simply setting the `HighlightedValueMemberPath` property to that path and not providing a `HighlightedItemsSource`.
+In the case that the schema does not match between the and the of the series, you can configure this using the `HighlightedValueMemberPath` property on the series. Additionally, if you would like to use the of the series itself as the highlight source and have a path on your data item that represents the subset, you can do this. This is done by simply setting the `HighlightedValueMemberPath` property to that path and not providing a .
-The reduced opacity of the column and area series types is configurable by setting the `HighlightedValuesFadeOpacity` property on the series. You can also set the `HighlightedValuesDisplayMode` property to `Hidden` if you do not wish to see the overlay at all.
+The reduced opacity of the column and area series types is configurable by setting the property on the series. You can also set the property to `Hidden` if you do not wish to see the overlay at all.
-The part of the series shown by the highlight filter will be represented in the legend and tooltip layers of the chart separately. You can configure the title that this is given in the tooltip and legend by setting the `HighlightedTitleSuffix`. This will append the value that you provide to the end of the `Title` of the series.
+The part of the series shown by the highlight filter will be represented in the legend and tooltip layers of the chart separately. You can configure the title that this is given in the tooltip and legend by setting the . This will append the value that you provide to the end of the of the series.
-If the `DataLegend` or `DataToolTipLayer` is used then the highlighted series will appear grouped. This can be managed by setting the `HighlightedValuesDataLegendGroup` property on the series to categorize them appropriately.
+If the or is used then the highlighted series will appear grouped. This can be managed by setting the property on the series to categorize them appropriately.
-The following example demonstrates the usage of the data legend grouping and highlighting overlay feature within the `DataChart` control using the `HighlightedValuesDataLegendGroup`:
+The following example demonstrates the usage of the data legend grouping and highlighting overlay feature within the control using the :
-The following example demonstrates the usage of the data legend grouping and highlighting overlay feature within the `DataChart` control using the `HighlightedValuesDataLegendGroup`:
+The following example demonstrates the usage of the data legend grouping and highlighting overlay feature within the control using the :
-The following example demonstrates the usage of the data highlighting overlay feature within the `DataChart` control using the `HighlightedValueMemberPath`:
+The following example demonstrates the usage of the data highlighting overlay feature within the control using the `HighlightedValueMemberPath`:
## Using Highlight Filter in CategoryChart
-The `CategoryChart` highlight filter happens on the chart by setting the `InitialHighlightFilter` property. Since the `CategoryChart` takes all of the properties on your underlying data item into account by default, you will need to define the `InitialGroups` on the chart as well so that the data can be grouped and aggregated in a way that you can have a subset of the data to filter on. You can set the `InitialGroups` to a value path in your underlying data item to group by a path that has duplicate values.
+The highlight filter happens on the chart by setting the property. Since the takes all of the properties on your underlying data item into account by default, you will need to define the on the chart as well so that the data can be grouped and aggregated in a way that you can have a subset of the data to filter on. You can set the to a value path in your underlying data item to group by a path that has duplicate values.
{/* Unsure of this part. Need to review */}
-{/* ????? The `InitialHighlightFilter` is done using OData filter query syntax. The syntax for this is an abbreviation of the filter operator. For example, if you wanted to have an InitialHighlightFilter of "Month not equals January" it would be represented as "Month ne 'January'"*/}
+{/* ????? The is done using OData filter query syntax. The syntax for this is an abbreviation of the filter operator. For example, if you wanted to have an InitialHighlightFilter of "Month not equals January" it would be represented as "Month ne 'January'"*/}
-Similar to the `DataChart`, the `HighlightedValuesDisplayMode` property is also exposed on the `CategoryChart`. In the case that you do not want to see the overlay, you can set this property to `Hidden`.
+Similar to the , the property is also exposed on the . In the case that you do not want to see the overlay, you can set this property to `Hidden`.
-The following example demonstrates the usage of the data highlighting overlay feature within the `CategoryChart` control:
+The following example demonstrates the usage of the data highlighting overlay feature within the control:
@@ -76,7 +78,7 @@ You can find more information about related chart features in these topics:
The following is a list of API members mentioned in the above sections:
-| `CategoryChart` Properties | `DataChart` Properties |
+| Properties | Properties |
| ----------------------------------------------|---------------------------|
| `CategoryChart.HighlightedItemsSource` | `Series.HighlightedItemsSource` |
| `CategoryChart.HighlightedTitleSuffix` | `Series.HighlightedTitleSuffix` |
diff --git a/docs/angular/src/content/en/components/charts/features/chart-markers.mdx b/docs/angular/src/content/en/components/charts/features/chart-markers.mdx
index ceed02b757..22f2bced86 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-markers.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-markers.mdx
@@ -17,7 +17,7 @@ In Ignite UI for Angular, markers are visual elements that display the values of
## Angular Chart Marker Example
-In the following example, the [Line Chart](../types/line-chart.md) is comparing the generation of renewable electricity for the countries Europe, China, and USA over the years of 2009 to 2019 with markers enabled by setting the property to `Circle` enum value.
+In the following example, the [Line Chart](../types/line-chart.md) is comparing the generation of renewable electricity for the countries Europe, China, and USA over the years of 2009 to 2019 with markers enabled by setting the property to enum value.
The colors of the markers are also managed by setting the and properties in the sample below. The markers and is configurable in this sample by using the drop-downs as well.
diff --git a/docs/angular/src/content/en/components/charts/features/chart-overlays.mdx b/docs/angular/src/content/en/components/charts/features/chart-overlays.mdx
index fdec0580f2..50aceb6538 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-overlays.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-overlays.mdx
@@ -27,13 +27,13 @@ The following example depicts a [Column Chart](../types/column-chart.md) with a
## Angular Value Overlay Properties
-Unlike other series types that use a `ItemsSource` for data binding, the value overlay uses a property to bind a single numeric value. In addition, the value overlay requires you to define a single to use. If you use an X-axis, the value overlay will be a vertical line, and if you use a Y-axis, it will be a horizontal line.
+Unlike other series types that use a for data binding, the value overlay uses a property to bind a single numeric value. In addition, the value overlay requires you to define a single to use. If you use an X-axis, the value overlay will be a vertical line, and if you use a Y-axis, it will be a horizontal line.
When using a numeric X or Y axis, the property should reflect the actual numeric value on the axis where you want the value overlay to be drawn. When using a category X or Y axis, the should reflect the index of the category at which you want the value overlay to appear.
When using the value overlay with a numeric angle axis, it will appear as a line from the center of the chart and when using a numeric radius axis, it will appear as a circle.
- appearance properties are inherited from `Series` and so and for example are available and work the same way they do with other types of series.
+ appearance properties are inherited from and so and for example are available and work the same way they do with other types of series.
It is also possible to show an axis annotation on a to show the value of the overlay on the owning axis. In order to show this, you can set the property to true.
@@ -43,15 +43,15 @@ The Angular charting components also expose the ability to use value lines to ca
Applying the in the and components is done by setting the property on the chart. This property takes a collection of the enumeration. You can mix and match multiple value layers in the same chart by adding multiple enumerations to the collection of the chart.
-In the , this is done by adding a to the `Series` collection of the chart and then setting the property to one of the enumerations. Each of these enumerations and what they mean is listed below:
+In the , this is done by adding a to the collection of the chart and then setting the property to one of the enumerations. Each of these enumerations and what they mean is listed below:
-- `Auto`: The default value mode of the enumeration.
-- `Average`: Applies potentially multiple value lines to call out the average value of each series plotted in the chart.
-- `GlobalAverage`: Applies a single value line to call out the average of all of the series values in the chart.
-- `GlobalMaximum`: Applies a single value line to call out the absolute maximum value of all of the series values in the chart.
-- `GlobalMinimum`: Applies a single value line to call out the absolute minimum value of all of the series values in the chart.
-- `Maximum`: Applies potentially multiple value lines to call out the maximum value of each series plotted in the chart.
-- `Minimum`: Applies potentially multiple value lines to call out the minimum value of each series plotted in the chart.
+- : The default value mode of the enumeration.
+- : Applies potentially multiple value lines to call out the average value of each series plotted in the chart.
+- : Applies a single value line to call out the average of all of the series values in the chart.
+- : Applies a single value line to call out the absolute maximum value of all of the series values in the chart.
+- : Applies a single value line to call out the absolute minimum value of all of the series values in the chart.
+- : Applies potentially multiple value lines to call out the maximum value of each series plotted in the chart.
+- : Applies potentially multiple value lines to call out the minimum value of each series plotted in the chart.
If you want to prevent any particular series from being taken into account when using the element, you can set the property on the layer. This will force the layer to target the series that you define. You can have as many elements within a single as you want.
@@ -70,7 +70,7 @@ You can also plot built-in financial overlays and indicators in Angular [Stock C
The Angular , , and all Data Annotation Layers can render custom overlay text inside plot area of the DataChart component. You can use this overlay text to annotate important events (e.g. company quarter reports) on x-axis or important values on y-axis in relationship to the layers.
-For example, you can use `DataAnnotationSliceLayer`, , and to show overlay text.
+For example, you can use , , and to show overlay text.
@@ -78,7 +78,7 @@ For example, you can use `DataAnnotationSliceLayer`, , and .
+the , , and .
diff --git a/docs/angular/src/content/en/components/charts/features/chart-performance.mdx b/docs/angular/src/content/en/components/charts/features/chart-performance.mdx
index 056c7aeaa2..96e8328738 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-performance.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-performance.mdx
@@ -21,7 +21,7 @@ The following examples demonstrates two high performance scenarios of Angular ch
## Angular Chart with High-Frequency
-In High-Frequency scenario, the Angular Charts can render data items that are updating in real time or at specified milliseconds intervals. You will experience no lag, no screen-flicker, and no visual delays, even as you interact with the chart on a touch-device. The following sample demonstrates the `CategoryChart` in High-Frequency scenario.
+In High-Frequency scenario, the Angular Charts can render data items that are updating in real time or at specified milliseconds intervals. You will experience no lag, no screen-flicker, and no visual delays, even as you interact with the chart on a touch-device. The following sample demonstrates the in High-Frequency scenario.
@@ -32,7 +32,7 @@ In High-Frequency scenario, the Angular Charts can render data items that are up
## Angular Chart with High-Volume
-In High-Volume scenario, the Angular Charts can render 1 million of data points while the chart keeps providing smooth performance when end-users tries zooming in/out or navigating chart content. The following sample demonstrates the `CategoryChart` in High-Volume scenario.
+In High-Volume scenario, the Angular Charts can render 1 million of data points while the chart keeps providing smooth performance when end-users tries zooming in/out or navigating chart content. The following sample demonstrates the in High-Volume scenario.
@@ -45,7 +45,7 @@ This section lists guidelines and chart features that add to the overhead and pr
### Data Size
-If you need to plot data sources with large number of data points (e.g. 10,000+), we recommend using Angular `DataChart` with one of the following type of series which where designed for specially for that purpose.
+If you need to plot data sources with large number of data points (e.g. 10,000+), we recommend using Angular with one of the following type of series which where designed for specially for that purpose.
- [Scatter HD Chart](../types/scatter-chart.md#angular-scatter-high-density-chart) instead of [Category Point Chart](../types/point-chart.md) or [Scatter Marker Chart](../types/scatter-chart.md#angular-scatter-marker-chart)
- [Scatter Polyline Chart](../types/shape-chart.md#angular-scatter-polyline-chart) instead of [Category Line Chart](../types/line-chart.md#angular-line-chart-example) or [Scatter Line Chart](../types/scatter-chart.md#angular-scatter-line-chart)
@@ -53,7 +53,7 @@ If you need to plot data sources with large number of data points (e.g. 10,000+)
### Data Structure
-Although Angular charts support rendering of multiple data sources by binding array of arrays of data points to `ItemsSource` property. It is much faster for charts if multiple data sources are flatten into single data source where each data item contains multiple data columns rather just one data column. For example:
+Although Angular charts support rendering of multiple data sources by binding array of arrays of data points to property. It is much faster for charts if multiple data sources are flatten into single data source where each data item contains multiple data columns rather just one data column. For example:
@@ -90,7 +90,7 @@ export class MultiDataSources {
### Data Filtering
-Angular `CategoryChart` and the `FinancialChart` controls have built-in data adapter that analyzes your data and generates chart series for you. However, it works faster if you use `IncludedProperties` and `ExcludedProperties` to filter only those data columns that you actually want to render. For example,
+Angular and the controls have built-in data adapter that analyzes your data and generates chart series for you. However, it works faster if you use and to filter only those data columns that you actually want to render. For example,
@@ -107,7 +107,7 @@ this.Chart.excludedProperties = [ "CHN", "FRN", "GER" ];
### Chart Types
-Simpler chart types such as [Line Chart](../types/line-chart.md) have faster performance than using [Spline Chart](../types/spline-chart.md) because of the complex interpolation of spline lines between data points. Therefore, you should use `CategoryChart.ChartType` property of Angular `CategoryChart` or the `FinancialChart` control to select type of chart that renders faster. Alternatively, you can change a type of series to a faster series in Angular `DataChart` control.
+Simpler chart types such as [Line Chart](../types/line-chart.md) have faster performance than using [Spline Chart](../types/spline-chart.md) because of the complex interpolation of spline lines between data points. Therefore, you should use `CategoryChart.ChartType` property of Angular or the control to select type of chart that renders faster. Alternatively, you can change a type of series to a faster series in Angular control.
The following table lists chart types in order from the fastest performance to slower performance in each group of charts:
@@ -166,7 +166,7 @@ this.LineSeries.markerType = MarkerType.None;
### Chart Resolution
-Setting the `Resolution` property to a higher value will improve performance, but it will lower the graphical fidelity of lines of plotted series. As such, it can be increased up until the fidelity is unacceptable.
+Setting the property to a higher value will improve performance, but it will lower the graphical fidelity of lines of plotted series. As such, it can be increased up until the fidelity is unacceptable.
This code snippet shows how to decrease resolution in the Angular charts.
@@ -196,10 +196,10 @@ Enabling [Chart Trendlines](chart-trendlines.md) will slightly decrease performa
Usage of x-axis with DateTime support is not recommended if spaces between data points, based on the amount of time span between them, are not important. Instead, ordinal/category axis should be used because it is more efficient in the way it coalesces data. Also, ordinal/category axis doesn’t perform any sorting on the data like the time-based x-axis does.
-The `CategoryChart` already uses ordinal/category axis so there is no need to change its properties.
+The already uses ordinal/category axis so there is no need to change its properties.
-This code snippet shows how to ordinal/category x-axis in the `FinancialChart` and `DataChart` controls.
+This code snippet shows how to ordinal/category x-axis in the and controls.
@@ -221,7 +221,7 @@ This code snippet shows how to ordinal/category x-axis in the `FinancialChart` a
### Axis Intervals
-By default, Angular charts will automatically calculate `YAxisInterval` based on range of your data. Therefore, you should avoid setting axis interval especially to a small value to prevent rendering of too many of axis gridlines and axis labels. Also, you might want to consider increasing `YAxisInterval` property to a larger value than the automatically calculated axis interval if you do not need many axis gridlines or axis labels.
+By default, Angular charts will automatically calculate based on range of your data. Therefore, you should avoid setting axis interval especially to a small value to prevent rendering of too many of axis gridlines and axis labels. Also, you might want to consider increasing property to a larger value than the automatically calculated axis interval if you do not need many axis gridlines or axis labels.
We do not recommend setting axis minor interval as it will decrease chart performance.
@@ -252,7 +252,7 @@ This code snippet shows how to set axis major interval in the Angular charts.
### Axis Scale
-Setting the `YAxisIsLogarithmic` property to false is recommended for higher performance, as fewer operations are needed than calculating axis range and values of axis labels in logarithmic scale.
+Setting the property to false is recommended for higher performance, as fewer operations are needed than calculating axis range and values of axis labels in logarithmic scale.
### Axis Labels Visibility
@@ -285,7 +285,7 @@ This code snippet shows how to hide axis labels in the Angular charts.
### Axis Labels Abbreviation
-Although, the Angular charts support abbreviation of large numbers (e.g. 10,000+) displayed in axis labels when `YAxisAbbreviateLargeNumbers` is set to true. We recommend, instead pre-processing large values in your data items by dividing them a common factor and then setting `YAxisTitle` to a string that represents factor used used to abbreviate your data values.
+Although, the Angular charts support abbreviation of large numbers (e.g. 10,000+) displayed in axis labels when is set to true. We recommend, instead pre-processing large values in your data items by dividing them a common factor and then setting to a string that represents factor used used to abbreviate your data values.
This code snippet shows how to set axis title in the Angular charts.
@@ -340,78 +340,78 @@ The following code snippet shows how to set a fixed extent for labels on y-axis
Enabling additional axis visuals (e.g. axis titles) or changing their default values might decrease performance in the Angular charts.
-For example, changing these properties on the `CategoryChart` or `FinancialChart` control:
+For example, changing these properties on the or control:
| Axis Visual | X-Axis Properties | Y-Axis Properties |
| ---------------------|-------------------|------------------- |
-| All Axis Visual | `XAxisInterval` `XAxisMinorInterval` | `YAxisInterval` `YAxisMinorInterval` |
-| Axis Tickmarks | `XAxisTickStroke` `XAxisTickStrokeThickness` `XAxisTickLength` | `YAxisTickStroke` `YAxisTickStrokeThickness` `YAxisTickLength` |
-| Axis Major Gridlines | `XAxisMajorStroke` `XAxisMajorStrokeThickness` | `YAxisMajorStroke` `YAxisMajorStrokeThickness` |
-| Axis Minor Gridlines | `XAxisMinorStroke` `XAxisMinorStrokeThickness` | `YAxisMinorStroke` `YAxisMinorStrokeThickness` |
-| Axis Main Line | `XAxisStroke` `XAxisStrokeThickness` | `YAxisStroke` `YAxisStrokeThickness` |
-| Axis Titles | `XAxisTitle` `XAxisTitleAngle` | `YAxisTitle` `YAxisTitleAngle` |
-| Axis Strips | `XAxisStrip` | `YAxisStrip` |
+| All Axis Visual | | |
+| Axis Tickmarks | | |
+| Axis Major Gridlines | | |
+| Axis Minor Gridlines | | |
+| Axis Main Line | | |
+| Axis Titles | | |
+| Axis Strips | | |
-Or changing properties of an `Axis` in the `DataChart` control:
+Or changing properties of an in the control:
| Axis Visual | Axis Properties |
| ---------------------|------------------- |
| All Axis Visuals | `Interval`, `MinorInterval` |
-| Axis Tickmarks | `TickStroke` , `TickStrokeThickness`, `TickLength` |
-| Axis Major Gridlines | `MajorStroke`, `MajorStrokeThickness` |
-| Axis Minor Gridlines | `MinorStroke`, `MinorStrokeThickness` |
-| Axis Main Line | `Stroke`, `StrokeThickness` |
-| Axis Titles | `Title`, `TitleAngle` |
-| Axis Strips | `Strip` |
+| Axis Tickmarks | , , |
+| Axis Major Gridlines | , |
+| Axis Minor Gridlines | , |
+| Axis Main Line | , |
+| Axis Titles | , `TitleAngle` |
+| Axis Strips | |
## Performance in Financial Chart
-In addition to above performance guidelines, the Angular `FinancialChart` control has the following unique features that affect performance.
+In addition to above performance guidelines, the Angular control has the following unique features that affect performance.
### Y-Axis Mode
-Setting the `YAxisMode` option to `Numeric` is recommended for higher performance, as fewer operations are needed than using `PercentChange` mode.
+Setting the option to `Numeric` is recommended for higher performance, as fewer operations are needed than using mode.
### Chart Panes
-Setting a lot of panes using `IndicatorTypes` and `OverlayTypes` options, might decrease performance and it is recommended to use a few financial indicators and one financial overlay.
+Setting a lot of panes using and options, might decrease performance and it is recommended to use a few financial indicators and one financial overlay.
### Zoom Slider
-Setting the `ZoomSliderType` option to `None` will improve chart performance and enable more vertical space for other indicators and the volume pane.
+Setting the option to will improve chart performance and enable more vertical space for other indicators and the volume pane.
### Volume Type
-Setting the `VolumeType` property can have the following impact on chart performance:
+Setting the property can have the following impact on chart performance:
-- `None` - is the least expensive since it does not display the volume pane.
-- `Line` - is more expensive volume type to render and it is recommended when rendering a lot of data points or when plotting a lot of data sources.
-- `Area` - is more expensive to render than the `Line` volume type.
-- `Column` - is more expensive to render than the `Area` volume type and it is recommended when rendering volume data of 1-3 stocks.
+- - is the least expensive since it does not display the volume pane.
+- - is more expensive volume type to render and it is recommended when rendering a lot of data points or when plotting a lot of data sources.
+- - is more expensive to render than the volume type.
+- - is more expensive to render than the volume type and it is recommended when rendering volume data of 1-3 stocks.
## Performance in Data Chart
-In addition to the general performance guidelines, the Angular `DataChart` control has the following unique features that affect performance.
+In addition to the general performance guidelines, the Angular control has the following unique features that affect performance.
### Axes Collection
-Adding too many axis to the `Axes` collection of the `DataChart` control will decrease chart performance and we recommend [Sharing Axes](chart-axis-layouts.md#axis-sharing-example) between series.
+Adding too many axis to the collection of the control will decrease chart performance and we recommend [Sharing Axes](chart-axis-layouts.md#axis-sharing-example) between series.
### Series Collection
-Also, adding a lot of series to the `Series` collection of the Angular `DataChart` control will add overhead to rendering because each series has its own rendering canvas. This is especially important if you have more than 10 series in the Data Chart. We recommend combining multiple data sources into flatten data source (see [Data Structure](#data-structure) section) and then using conditional styling feature of the following series:
+Also, adding a lot of series to the collection of the Angular control will add overhead to rendering because each series has its own rendering canvas. This is especially important if you have more than 10 series in the Data Chart. We recommend combining multiple data sources into flatten data source (see [Data Structure](#data-structure) section) and then using conditional styling feature of the following series:
| Slower Performance Scenario | Faster Scenario with Conditional Styling |
| ----------------------------|---------------------------------------- |
-| 10+ of `LineSeries` | Single `ScatterLineSeries` |
-| 20+ of `LineSeries` | Single `ScatterPolylineSeries` |
-| 10+ of `ScatterLineSeries` | Single `ScatterPolylineSeries` |
-| 10+ of `PointSeries` | Single `ScatterSeries` |
-| 20+ of `PointSeries` | Single `HighDensityScatterSeries` |
-| 20+ of `ScatterSeries` | Single `HighDensityScatterSeries` |
-| 10+ of `AreaSeries` | Single `ScatterPolygonSeries` |
-| 10+ of `ColumnSeries` | Single `ScatterPolygonSeries` |
+| 10+ of | Single |
+| 20+ of | Single |
+| 10+ of | Single |
+| 10+ of | Single |
+| 20+ of | Single |
+| 20+ of | Single |
+| 10+ of | Single |
+| 10+ of | Single |
## Additional Resources
diff --git a/docs/angular/src/content/en/components/charts/features/chart-titles.mdx b/docs/angular/src/content/en/components/charts/features/chart-titles.mdx
index 63b5f945be..981501e897 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-titles.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-titles.mdx
@@ -28,20 +28,20 @@ When adding a title or subtitle to the chart control, the content of the chart a
| Property Name | Property Type | Description |
| ----------------------|------------------|------------|
| `ChartTitle` | string | Title's text content. |
-| `TitleTextColor` | string | Title's text. color |
-| `TitleAlignment` | HorizontalAlignment | Title's horizontal alignment. |
-| `TitleTextStyle` | string | Title's font style, e.g. Italic Bold 8pt Times New Roman |
-| `TitleTopMargin` | number | Title's top margin. |
-| `TitleLeftMargin` | number | Title's left margin. |
-| `TitleRightMargin` | number | Title's right margin. |
-| `TitleBottomMargin` | number | Title's bottom margin. |
-| `Subtitle` | string | Title's text content. |
-| `SubtitleTextColor` | string | Title's text. color |
-| `SubtitleAlignment` | HorizontalAlignment | Title's horizontal alignment. |
-| `SubtitleTextStyle` | string | Title's font style, e.g. Italic Bold 8pt Times New Roman |
-| `SubtitleTopMargin` | number | Title's top margin. |
-| `SubtitleLeftMargin` | number | Title's left margin. |
-| `SubtitleRightMargin` | number | Title's right margin. |
-| `SubtitleBottomMargin`| number | Title's bottom margin. |
+| | string | Title's text. color |
+| | HorizontalAlignment | Title's horizontal alignment. |
+| | string | Title's font style, e.g. Italic Bold 8pt Times New Roman |
+| | number | Title's top margin. |
+| | number | Title's left margin. |
+| | number | Title's right margin. |
+| | number | Title's bottom margin. |
+| | string | Title's text content. |
+| | string | Title's text. color |
+| | HorizontalAlignment | Title's horizontal alignment. |
+| | string | Title's font style, e.g. Italic Bold 8pt Times New Roman |
+| | number | Title's top margin. |
+| | number | Title's left margin. |
+| | number | Title's right margin. |
+| | number | Title's bottom margin. |
diff --git a/docs/angular/src/content/en/components/charts/features/chart-tooltips.mdx b/docs/angular/src/content/en/components/charts/features/chart-tooltips.mdx
index 4e465cd57e..9d1c395cbd 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-tooltips.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-tooltips.mdx
@@ -29,10 +29,10 @@ The Tooltip | Display a tooltip for a single item when the pointer is positioned over it. |
+| Tooltip | Display the data tooltips for all series in the chart. |
+| Tooltip | Display a tooltip for each data item in the category that the pointer is positioned over. |
+| Tooltip | Display a grouped tooltip for all data points in the category that the pointer is positioned over. |
diff --git a/docs/angular/src/content/en/components/charts/features/chart-trendlines.mdx b/docs/angular/src/content/en/components/charts/features/chart-trendlines.mdx
index aaf9ee8304..3026745b3a 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-trendlines.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-trendlines.mdx
@@ -30,7 +30,7 @@ The following sample depicts a sh
## Angular Chart Trendlines Dash Array Example
-The following sample depicts a showing a `FinancialPriceSeries` with a **QuarticFit** dashed trendline applied via the property:
+The following sample depicts a showing a with a **QuarticFit** dashed trendline applied via the property:
@@ -40,7 +40,7 @@ The following sample depicts a showing
## Angular Chart Trendline Layer
-The is a series type that is designed to display a single trendline type for a target series. The difference between this and the existing trendline features on the existing series types is that since the is a series type, you can add more than one of them to the `Series` collection of the chart to have multiple trendlines attached to the same series. You can also have the trendline appear in the legend, which was not possible previously.
+The is a series type that is designed to display a single trendline type for a target series. The difference between this and the existing trendline features on the existing series types is that since the is a series type, you can add more than one of them to the collection of the chart to have multiple trendlines attached to the same series. You can also have the trendline appear in the legend, which was not possible previously.
## Trendline Layer Usage
@@ -52,7 +52,7 @@ If you would like to show the in
By default, the renders with the same color as its in a dashed line. This can be configured by using the various styling properties on the .
-To change the color of the trendline that is drawn, you can set its property. Alternatively, you can also set the property to `true`, which will pull from the chart's `Brushes` palette based on the index in which the is placed in the chart's `Series` collection.
+To change the color of the trendline that is drawn, you can set its property. Alternatively, you can also set the property to `true`, which will pull from the chart's palette based on the index in which the is placed in the chart's collection.
You can also modify the way that the appears by using its and properties. The takes a value between -1.0 and 1.0 to determine how much of a "shift" to apply to the options that end in "Shift".
diff --git a/docs/angular/src/content/en/components/charts/features/chart-user-annotations.mdx b/docs/angular/src/content/en/components/charts/features/chart-user-annotations.mdx
index fca702f12a..ce81b915c6 100644
--- a/docs/angular/src/content/en/components/charts/features/chart-user-annotations.mdx
+++ b/docs/angular/src/content/en/components/charts/features/chart-user-annotations.mdx
@@ -19,7 +19,7 @@ import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
In Ignite UI for Angular, you can annotate the with slice, strip, and point annotations at runtime using the user annotations feature. This allows the end user to add more details to the plot such as calling out single important events such as company quarter reports by using the slice annotation or events that have a duration by using the strip annotation. You can also call out individual points on the plotted series by using the point annotation or any combination of these three.
-This is directly integrated with the available tools of the `Toolbar`. The following topic explains, with examples, how you can utilize the `Toolbar` to add user annotations to the plot area of the chart, as well as how to do add these user annotations programmatically.
+This is directly integrated with the available tools of the . The following topic explains, with examples, how you can utilize the to add user annotations to the plot area of the chart, as well as how to do add these user annotations programmatically.
@@ -30,7 +30,7 @@ This feature is designed to support X and Y axes and does not currently support
## Using the User Annotations with the Toolbar
-The `Toolbar` exposes an Annotations menu item with two tools with the labels of "Annotate Chart" and "Delete Note." In order for this menu item to appear, you first need to set the property on the corresponding chart to `true`.
+The exposes an Annotations menu item with two tools with the labels of "Annotate Chart" and "Delete Note." In order for this menu item to appear, you first need to set the property on the corresponding chart to `true`.
The "Annotate Chart" option that appears after opening allows you to annotate the plot area of the . This can be done by adding slice, strip, or point annotations. You can add a slice annotation by clicking on a label on the X or Y axis. You can add a strip annotation by clicking and dragging in the plot area. Also, you can add a point annotation by clicking on a point in a series plotted in the chart.
@@ -40,34 +40,34 @@ You can delete the annotations that you have previously added by selecting the "
-When adding one of these user annotations via the `Toolbar`, the will raise an event named `UserAnnotationInformationRequested` where you can provide more information for the user annotations. This event's arguments have a property named `AnnotationInfo` that will return a object that allows the configuration of multiple different aspects of the annotation to be added.
+When adding one of these user annotations via the , the will raise an event named `UserAnnotationInformationRequested` where you can provide more information for the user annotations. This event's arguments have a property named `AnnotationInfo` that will return a object that allows the configuration of multiple different aspects of the annotation to be added.
The table below details the different configurable properties on :
| Property | Type | Description |
|------------|---------|-------------|
-|`AnnotationData`|`string`|This property allows additional information for the user annotation. This property is designed to be utilized with the `UserAnnotationToolTipContentUpdating` event to show additional information in the annotation's tooltip.|
-|`AnnotationId`|`string`|This read-only property returns the unique string ID of the user annotation.|
-|`BadgeColor`|`string`|This property gets or sets the color to use for the badge in the user annotation.|
-|`BadgeImageUri`|`string`|This property gets or sets a path to an image to use for the badge in the user annotation.|
-|`DialogSuggestedXLocation`|`double`|This property gets a recommended X location to show a dialog based on the location that the user annotation was added.|
-|`DialogSuggestedYLocation`|`double`|This property gets a recommended Y location to show a dialog based on the location that the user annotation was added.|
-|`Label`|`string`|This property gets or sets the label to be shown in the user annotation.|
-|`MainColor`|`string`|This property gets or sets the color to be used to fill the background of the user annotation.|
+||`string`|This property allows additional information for the user annotation. This property is designed to be utilized with the `UserAnnotationToolTipContentUpdating` event to show additional information in the annotation's tooltip.|
+||`string`|This read-only property returns the unique string ID of the user annotation.|
+||`string`|This property gets or sets the color to use for the badge in the user annotation.|
+||`string`|This property gets or sets a path to an image to use for the badge in the user annotation.|
+||`double`|This property gets a recommended X location to show a dialog based on the location that the user annotation was added.|
+||`double`|This property gets a recommended Y location to show a dialog based on the location that the user annotation was added.|
+||`string`|This property gets or sets the label to be shown in the user annotation.|
+||`string`|This property gets or sets the color to be used to fill the background of the user annotation.|
-After you have made the changes to the annotation through the `UserAnnotationInformationRequested` event, you should invoke the `FinishAnnotationFlow` method on the to finish creating the annotation and commit the changes to it. Alternatively, you can also cancel the annotation's creation by calling `CancelAnnotationFlow` and passing the `AnnotationId` of the annotation, which can be obtained from the `AnnotationInfo` parameter of the `UserAnnotationInformationRequested` event's arguments, as mentioned above. This will remove the annotation from the plot area.
+After you have made the changes to the annotation through the `UserAnnotationInformationRequested` event, you should invoke the method on the to finish creating the annotation and commit the changes to it. Alternatively, you can also cancel the annotation's creation by calling and passing the of the annotation, which can be obtained from the `AnnotationInfo` parameter of the `UserAnnotationInformationRequested` event's arguments, as mentioned above. This will remove the annotation from the plot area.
## Using the User Annotations Programmatically
-When using the programmatically, you can invoke two different methods on the to put the chart into a mode where you can add or remove a user annotation. These methods are named `StartCreatingAnnotation` and `StartDeletingAnnotation`, respectively.
+When using the programmatically, you can invoke two different methods on the to put the chart into a mode where you can add or remove a user annotation. These methods are named and , respectively.
-After invoking `StartCreatingAnnotation`, you can add a slice annotation by clicking on a label on the X or Y axis, add a strip annotation by clicking and dragging in the plot area and releasing the mouse button, or add a point annotation by clicking on a data point on a series plotted in the chart.
+After invoking , you can add a slice annotation by clicking on a label on the X or Y axis, add a strip annotation by clicking and dragging in the plot area and releasing the mouse button, or add a point annotation by clicking on a data point on a series plotted in the chart.
Adding one of these user annotations will raise an event named `UserAnnotationInformationRequested`, where you can provide more information for the user annotation. This event's arguments have a property named `AnnotationInfo` that will return a object that allows the configuration of multiple different aspects of the annotation to be added.
-After you have made the changes to the annotation through the `UserAnnotationInformationRequested` event, you should invoke the `FinishAnnotationFlow` method on the to finish creating the annotation and commit the changes to it. Alternatively, you can also cancel the annotation's creation by calling `CancelAnnotationFlow` and passing the `AnnotationId` of the annotation, which can be obtained from the `AnnotationInfo` parameter of the `UserAnnotationInformationRequested` event's arguments, as mentioned above. This will remove the annotation from the plot area.
+After you have made the changes to the annotation through the `UserAnnotationInformationRequested` event, you should invoke the method on the to finish creating the annotation and commit the changes to it. Alternatively, you can also cancel the annotation's creation by calling and passing the of the annotation, which can be obtained from the `AnnotationInfo` parameter of the `UserAnnotationInformationRequested` event's arguments, as mentioned above. This will remove the annotation from the plot area.
-Once the user annotation has been added to the chart, it will appear in the `Series` collection as a . The has an `Annotations` collection that can store , and elements depending on the type of annotations added to the plot area.
+Once the user annotation has been added to the chart, it will appear in the collection as a . The has an collection that can store , and elements depending on the type of annotations added to the plot area.
## User Annotation ToolTip
diff --git a/docs/angular/src/content/en/components/charts/types/area-chart.mdx b/docs/angular/src/content/en/components/charts/types/area-chart.mdx
index ae18f82bcb..e32c7efbf3 100644
--- a/docs/angular/src/content/en/components/charts/types/area-chart.mdx
+++ b/docs/angular/src/content/en/components/charts/types/area-chart.mdx
@@ -58,7 +58,7 @@ There are several common use cases for choosing an Area Chart:
## Angular Area Chart with Single Series
-Angular Area Chart is often used to show the change of value over time such as the amount of renewable electricity produced. You can create this type of chart in control by binding your data and setting property to `Area` value, as shown in the example below.
+Angular Area Chart is often used to show the change of value over time such as the amount of renewable electricity produced. You can create this type of chart in control by binding your data and setting property to value, as shown in the example below.
@@ -93,7 +93,7 @@ The following sections explain more advanced types of Angular Area Charts that c
## Angular Step Area Chart
-The Angular Step Area Chart belongs to a group of category charts and it is rendered using a collection of points connected by continuous vertical and horizontal lines with the area below lines filled in. Values are represented on the y-axis and categories are displayed on the x-axis. The step area chart emphasizes the amount of change over a period of time or compares multiple items. You can create this type of chart in control by binding your data and setting property to `StepArea` value, as shown in the example below.
+The Angular Step Area Chart belongs to a group of category charts and it is rendered using a collection of points connected by continuous vertical and horizontal lines with the area below lines filled in. Values are represented on the y-axis and categories are displayed on the x-axis. The step area chart emphasizes the amount of change over a period of time or compares multiple items. You can create this type of chart in control by binding your data and setting property to value, as shown in the example below.
@@ -212,16 +212,16 @@ The following table lists API members mentioned in above sections:
| Chart Type | Control Name | API Members |
| -------------------------|-----------------|-----------------------|
-| Area | `CategoryChart` | `CategoryChart.ChartType` = `Area` |
-| Step Area | `CategoryChart` | `CategoryChart.ChartType` = `StepArea` |
-| Range Area | `DataChart` | `RangeAreaSeries` |
-| Radial Area | `DataChart` | `RadialAreaSeries` |
-| Polar Area | `DataChart` | `PolarAreaSeries` |
-| Polar Spline Area | `DataChart` | `PolarSplineAreaSeries` |
-| Stacked Area | `DataChart` | `StackedAreaSeries` |
-| Stacked Spline Area | `DataChart` | `StackedSplineAreaSeries` |
-| Stacked 100% Area | `DataChart` | `Stacked100AreaSeries` |
-| Stacked 100% Spline Area | `DataChart` | `Stacked100SplineAreaSeries` |
+| Area | | `CategoryChart.ChartType` = |
+| Step Area | | `CategoryChart.ChartType` = |
+| Range Area | | |
+| Radial Area | | |
+| Polar Area | | |
+| Polar Spline Area | | |
+| Stacked Area | | |
+| Stacked Spline Area | | |
+| Stacked 100% Area | | |
+| Stacked 100% Spline Area | | |
## API References
diff --git a/docs/angular/src/content/en/components/charts/types/column-chart.mdx b/docs/angular/src/content/en/components/charts/types/column-chart.mdx
index 28833a143a..91dbe37c22 100644
--- a/docs/angular/src/content/en/components/charts/types/column-chart.mdx
+++ b/docs/angular/src/content/en/components/charts/types/column-chart.mdx
@@ -178,12 +178,12 @@ The following table lists API members mentioned in the above sections:
| Chart Type | Control Name | API Members |
| --------------------|--------------------|------------------------|
-| Column | `CategoryChart` | `CategoryChart.ChartType` = **Column** |
-| Radial Column | `DataChart` | `RadialColumnSeries` |
-| Range Column | `DataChart` | `RangeColumnSeries` |
-| Stacked Column | `DataChart` | `StackedColumnSeries` |
-| Stacked 100% Column | `DataChart` | `Stacked100ColumnSeries` |
-| Waterfall | `DataChart` | `WaterfallSeries` |
+| Column | | `CategoryChart.ChartType` = **Column** |
+| Radial Column | | |
+| Range Column | | |
+| Stacked Column | | |
+| Stacked 100% Column | | |
+| Waterfall | | |
diff --git a/docs/angular/src/content/en/components/charts/types/composite-chart.mdx b/docs/angular/src/content/en/components/charts/types/composite-chart.mdx
index f4d8e56631..4bbc17fa6a 100644
--- a/docs/angular/src/content/en/components/charts/types/composite-chart.mdx
+++ b/docs/angular/src/content/en/components/charts/types/composite-chart.mdx
@@ -15,7 +15,7 @@ The Ignite UI for Angular Composite Chart, also called a Combo Chart, is visuali
## Angular Composite / Combo Example
-The following example demonstrates how to create Composite Chart using `ColumnSeries` and `LineSeries` in the control.
+The following example demonstrates how to create Composite Chart using and in the control.
diff --git a/docs/angular/src/content/en/components/charts/types/data-pie-chart.mdx b/docs/angular/src/content/en/components/charts/types/data-pie-chart.mdx
index 89de21ac7d..d0bdab3920 100644
--- a/docs/angular/src/content/en/components/charts/types/data-pie-chart.mdx
+++ b/docs/angular/src/content/en/components/charts/types/data-pie-chart.mdx
@@ -79,7 +79,7 @@ The Others category in the has thre
The property works in tandem with the property of the . For the , you can define whether you want the to be evaluated as a number or a percentage. For example, if you decide on number and set the to 5, any slices that have a value less than 5 will become part of the Others category. Using the same value of 5 with a percent type, any values that are less than 5 percent of the total values of the will become part of the Others category.
-To get the underlying data items that are contained within the Others slice in the chart, you can utilize the `GetOthersContext` method on the chart. This return type of this method is an `OthersCategoryContext` which exposes an `Items` property. The `Items` property returns an array that will contain the items in the Others slice. Additionally, when clicking the Others slice, the `Item` property of the event arguments for the `SeriesClick` event will be will also return this `OthersCategoryContext`.
+To get the underlying data items that are contained within the Others slice in the chart, you can utilize the method on the chart. This return type of this method is an which exposes an property. The property returns an array that will contain the items in the Others slice. Additionally, when clicking the Others slice, the `Item` property of the event arguments for the `SeriesClick` event will be will also return this .
By default, the Others slice will be represented by a label of "Others." You can change this by modifying the property of the chart.
@@ -112,21 +112,21 @@ The following sample demonstrates usage of the Others slice in the supports slice selection by mouse click on the slices plotted in the chart. This can be configured by utilizing the and properties of the chart, described below:
-The main two options of the are `PerDataItemSingleSelect` and `PerDataItemMultiSelect`, which will enable single and multiple selection, respectively.
+The main two options of the are and , which will enable single and multiple selection, respectively.
The property exposes an enumeration that determines how the pie chart slices respond to being selected. The following are the options of that enumeration and what they do:
-- `Brighten`: The selected slices will be highlighted.
-- `FadeOthers`: The selected slices will remain their same color and others will fade.
-- `FocusColorFill`: The selected slices will change their background to the FocusBrush of the chart.
-- `FocusColorOutline`: The selected slices will have an outline with the color defined by the FocusBrush of the chart.
-- `FocusColorThickOutline`: The selected slices will have an outline with the color defined by the FocusBrush of the chart. The thickness of this outline can be configured via the Thickness property of the control as well.
-- `GrayscaleOthers`: The unselected slices will have a gray color filter applied to them.
-- `None`: There is no effect on the selected slices.
-- `SelectionColorFill`: The selected slices will change their background to the SelectionBrush of the chart.
-- `SelectionColorOutline`: The selected slices will have an outline with the color defined by the SelectionBrush of the chart.
-- `SelectionColorThickOutline`: The selected slices will have an outline with the color defined by the FocusBrush of the chart. The thickness of this outline can be configured via the Thickness property of the control as well.
-- `ThickOutline`: The selected slices will apply an outline with the thickness dependent on the Thickness property of the chart.
+- : The selected slices will be highlighted.
+- : The selected slices will remain their same color and others will fade.
+- : The selected slices will change their background to the FocusBrush of the chart.
+- : The selected slices will have an outline with the color defined by the FocusBrush of the chart.
+- : The selected slices will have an outline with the color defined by the FocusBrush of the chart. The thickness of this outline can be configured via the Thickness property of the control as well.
+- : The unselected slices will have a gray color filter applied to them.
+- : There is no effect on the selected slices.
+- : The selected slices will change their background to the SelectionBrush of the chart.
+- : The selected slices will have an outline with the color defined by the SelectionBrush of the chart.
+- : The selected slices will have an outline with the color defined by the FocusBrush of the chart. The thickness of this outline can be configured via the Thickness property of the control as well.
+- : The selected slices will apply an outline with the thickness dependent on the Thickness property of the chart.
When a slice is selected, its underlying data item will be added to the SelectedSeriesItems collection of the chart. As such, the DataPieChart exposes the SelectedSeriesItemsChanged event to detect when a slice has been selected and this collection is changed.
@@ -143,18 +143,18 @@ The supports mouse over highlightin
First, the enumerated property determines how a slice will be highlighted. The following are the options of that property and what they do:
-- `DirectlyOver`: The slices are only highlighted when the mouse is directly over them.
-- `NearestItems`: The nearest slice to the mouse position will be highlighted.
-- `NearestItemsAndSeries`: The nearest slice and series to the mouse position will be highlighted.
-- `NearestItemsRetainMainShapes`: The nearest items to the mouse position will be highlighted and the main shapes of the series will not be de-emphasized.
+- : The slices are only highlighted when the mouse is directly over them.
+- : The nearest slice to the mouse position will be highlighted.
+- : The nearest slice and series to the mouse position will be highlighted.
+- : The nearest items to the mouse position will be highlighted and the main shapes of the series will not be de-emphasized.
The enumerated property determines how the data pie chart slices respond to being highlighted. The following are the options of that property and what they do:
-- `Brighten`: The series will have its color brightened when the mouse position is over or near it.
+- : The series will have its color brightened when the mouse position is over or near it.
- `BrightenSpecific`: The specific slice will have its color brightened when the mouse position is over or near it.
-- `FadeOthers`: The series will retain its color when the mouse position is over or near it, while the others will appear faded.
+- : The series will retain its color when the mouse position is over or near it, while the others will appear faded.
- `FadeOthersSpecific`: The specific slice will retain its color when the mouse position is over or near it, while the others will appear faded.
-- `None`: The series and slices will not be highlighted.
+- : The series and slices will not be highlighted.
The following example demonstrates the mouse highlighting behaviors of the component:
diff --git a/docs/angular/src/content/en/components/charts/types/line-chart.mdx b/docs/angular/src/content/en/components/charts/types/line-chart.mdx
index 32d878accf..655f445d2c 100644
--- a/docs/angular/src/content/en/components/charts/types/line-chart.mdx
+++ b/docs/angular/src/content/en/components/charts/types/line-chart.mdx
@@ -15,7 +15,7 @@ The Ignite UI for Angular Line Chart or Line Graph is a type of category charts
## Angular Line Chart Example
-You can create the Angular Line Chart in the control by binding your data to property and setting property to `Line` enum, as shown in the example below.
+You can create the Angular Line Chart in the control by binding your data to property and setting property to enum, as shown in the example below.
@@ -73,7 +73,7 @@ There are several common use cases for choosing a Line Chart:
The Angular Line Chart is often used to show the change of value over time such as the amount of renewable electricity produced since 2009 over a ten-year period, as we have shown in the example below.
-You can create this type of chart in the control by binding your data and setting the property to `Line`, as shown in the example below:
+You can create this type of chart in the control by binding your data and setting the property to , as shown in the example below:
@@ -86,7 +86,7 @@ You can create this type of chart in the control by binding your data and setting the property to `Line`, as shown in the example below:
+You can create this type of chart in the control by binding your data and setting the property to , as shown in the example below:
@@ -101,7 +101,7 @@ The Angular Line chart is capable of handling high volumes of data, ranging into
In this example, we are streaming live data into the Angular Line Chart at an interval of your choosing. You can set the data points from 5,000 to 1 million and update the chart to optimize the scale based on the device you are rendering the chart on.
-You can create this type of chart in the control by binding your data and setting the property to `Line`, as shown in the example below:
+You can create this type of chart in the control by binding your data and setting the property to , as shown in the example below:
@@ -114,7 +114,7 @@ You can create this type of chart in the control by binding your data and setting the property to `Line`, as shown in the example below:
+You can create this type of chart in the control by binding your data and setting the property to , as shown in the example below:
@@ -200,11 +200,11 @@ The following table lists API members mentioned in the above sections:
| Chart Type | Control Name | API Members |
| ------------------|--------------------|----------------------- |
-| Line | `CategoryChart` | `CategoryChart.ChartType` = `Line` |
-| Polar Line | `DataChart` | `PolarLineSeries` |
-| Radial Line | `DataChart` | `RadialLineSeries` |
-| Stacked Line | `DataChart` | `StackedLineSeries` |
-| Stacked 100% Line | `DataChart` | `Stacked100LineSeries` |
+| Line | | `CategoryChart.ChartType` = |
+| Polar Line | | |
+| Radial Line | | |
+| Stacked Line | | |
+| Stacked 100% Line | | |
diff --git a/docs/angular/src/content/en/components/charts/types/pie-chart.mdx b/docs/angular/src/content/en/components/charts/types/pie-chart.mdx
index a04ba1c331..9c85b5d0d3 100644
--- a/docs/angular/src/content/en/components/charts/types/pie-chart.mdx
+++ b/docs/angular/src/content/en/components/charts/types/pie-chart.mdx
@@ -107,7 +107,7 @@ The pie chart supports explosion of individual pie slices as well as a `SliceCli
## Angular Pie Chart Selection
-The pie chart supports slice selection by mouse click as the default behavior. You can determine the selected slices by using the `SelectedItems` property. The selected slices are then highlighted.
+The pie chart supports slice selection by mouse click as the default behavior. You can determine the selected slices by using the property. The selected slices are then highlighted.
There is a property called which is how you set what mode you want the pie chart to use. The default value is `Single`. In order to disable selection, set the property to `Manual`.
@@ -125,7 +125,7 @@ The pie chart has 4 events associated with selection:
The events that end in "Changing" are cancelable events which means you can stop the selection of a slice by setting the event argument property `Cancel` to true. When set to true the associated property will not update and the slice will not become selected. This is useful for scenarios where you want to keep users from being able to select certain slices based on the data inside it.
-For scenarios where you click on the Others slice, the pie chart will return an object called `PieSliceOthersContext`. This object contains a list of the data items contained within the Others slice.
+For scenarios where you click on the Others slice, the pie chart will return an object called . This object contains a list of the data items contained within the Others slice.
diff --git a/docs/angular/src/content/en/components/charts/types/radial-chart.mdx b/docs/angular/src/content/en/components/charts/types/radial-chart.mdx
index 64a177e3b5..0287e26e41 100644
--- a/docs/angular/src/content/en/components/charts/types/radial-chart.mdx
+++ b/docs/angular/src/content/en/components/charts/types/radial-chart.mdx
@@ -68,7 +68,7 @@ Once our radial chart is created, we may want to make some further styling custo
## Angular Radial Chart Settings
-In addition, the labels can be configured to appear near or wide from the chart. This can be configured with the `LabelMode` property for the .
+In addition, the labels can be configured to appear near or wide from the chart. This can be configured with the property for the .
diff --git a/docs/angular/src/content/en/components/charts/types/scatter-chart.mdx b/docs/angular/src/content/en/components/charts/types/scatter-chart.mdx
index 29eff70020..cb5d2a8ce4 100644
--- a/docs/angular/src/content/en/components/charts/types/scatter-chart.mdx
+++ b/docs/angular/src/content/en/components/charts/types/scatter-chart.mdx
@@ -95,12 +95,12 @@ The following table lists API members mentioned in the above sections:
|Chart Type | Control Name | API Members |
|----------------------------|----------------|------------------------ |
- |Scatter Marker | `DataChart` | `ScatterSeries` |
- |Scatter Line | `DataChart` | `ScatterLineSeries` |
- |Scatter Spline | `DataChart` | `ScatterSplineSeries` |
- |High Density Scatter | `DataChart` | `HighDensityScatterSeries` |
- |Scatter Area | `DataChart` | `ScatterAreaSeries` |
- |Scatter Contour | `DataChart` | `ScatterContourSeries` |
+ |Scatter Marker | | |
+ |Scatter Line | | |
+ |Scatter Spline | | |
+ |High Density Scatter | | |
+ |Scatter Area | | |
+ |Scatter Contour | | |
## API References
diff --git a/docs/angular/src/content/en/components/charts/types/sparkline-chart.mdx b/docs/angular/src/content/en/components/charts/types/sparkline-chart.mdx
index 8061b6546f..894600f8bc 100644
--- a/docs/angular/src/content/en/components/charts/types/sparkline-chart.mdx
+++ b/docs/angular/src/content/en/components/charts/types/sparkline-chart.mdx
@@ -16,7 +16,7 @@ The Ignite UI for Angular Sparkline is a lightweight charting control. It is int
## Angular Sparkline Example
-The following example shows all the different types of available. The type is defined by setting the property. If the property is not specified, then by default, the `Line` type is displayed.
+The following example shows all the different types of available. The type is defined by setting the property. If the property is not specified, then by default, the type is displayed.
@@ -61,10 +61,10 @@ The Angular Sparkline has the ability to mark the data points with elliptical ic
The Angular Sparkline supports the following types of sparklines by setting the property accordingly:
-- `Line`: Displays the line chart type of Sparkline with numeric data, connecting the data points with line segments. At least two data points must be supplied to visualize the data in Sparkline.
-- `Area`: Displays the Area chart type of Sparkline with numeric data. This is like line type with additional steps of closing the area after each line is drawn. At least two data points must be supplied to visualize the data in Sparkline.
-- `Column`: Displays the Column chart type of Sparkline with numeric data. Some may refer to it as vertical bars. This type can render a single data point, but it would require specifying the minimum value range property (minimum) in Sparkline so the supplied single data point can be visible, otherwise the value will be treated as the minimum value and will not be visible.
-- `WinLoss`: This type is similar in its visual appearance to Column chart type, in which the value of each column is equal to either the positive maximum (for positive values) or the negative minimum (for negative value) of the data set. The idea is to indicate a win or loss scenario. For the Win/Loss chart to display properly, the data set must have both positive and negative values. If the WinLoss sparkline is bound to the same data as the other types such as the Line type, which can be bound to a collection of numeric values, then the Angular Sparkline will select two values from the collection - the highest and the lowest - and will render the sparkline based upon those values.
+- : Displays the line chart type of Sparkline with numeric data, connecting the data points with line segments. At least two data points must be supplied to visualize the data in Sparkline.
+- : Displays the Area chart type of Sparkline with numeric data. This is like line type with additional steps of closing the area after each line is drawn. At least two data points must be supplied to visualize the data in Sparkline.
+- : Displays the Column chart type of Sparkline with numeric data. Some may refer to it as vertical bars. This type can render a single data point, but it would require specifying the minimum value range property (minimum) in Sparkline so the supplied single data point can be visible, otherwise the value will be treated as the minimum value and will not be visible.
+- : This type is similar in its visual appearance to Column chart type, in which the value of each column is equal to either the positive maximum (for positive values) or the negative minimum (for negative value) of the data set. The idea is to indicate a win or loss scenario. For the Win/Loss chart to display properly, the data set must have both positive and negative values. If the WinLoss sparkline is bound to the same data as the other types such as the Line type, which can be bound to a collection of numeric values, then the Angular Sparkline will select two values from the collection - the highest and the lowest - and will render the sparkline based upon those values.
@@ -75,7 +75,7 @@ The Angular Sparkline supports the following types of sparklines by setting the
## Markers
-The Angular Sparkline allows you to show markers as circular-colored icons on your series to indicate the individual data points based on X/Y coordinates. Markers can be set on sparklines of display types of `Line`, `Area`, and `Column`. The `WinLoss` type of sparkline does not currently accept markers. By default, markers are not displayed, but they can be enabled by setting the corresponding marker visibility property.
+The Angular Sparkline allows you to show markers as circular-colored icons on your series to indicate the individual data points based on X/Y coordinates. Markers can be set on sparklines of display types of , , and . The type of sparkline does not currently accept markers. By default, markers are not displayed, but they can be enabled by setting the corresponding marker visibility property.
Markers in the sparkline can be placed in any combination of the following locations:
@@ -98,7 +98,7 @@ All of the markers mentioned above can be customized using the related marker ty
The normal range feature of the Angular Sparkline is a horizontal stripe representing some pre-defined meaningful range when the data is being visualized. The normal range can be set as a shaded area outlined with the desired color.
-The normal range can be wider than the maximum data point or beyond, and it can also be as thin as the sparkline's `Line` display type, to serve as a threshold indicator, for instance. The width of the normal range is determined by the following three properties, which serve as the minimum settings required for displaying the normal range:
+The normal range can be wider than the maximum data point or beyond, and it can also be as thin as the sparkline's display type, to serve as a threshold indicator, for instance. The width of the normal range is determined by the following three properties, which serve as the minimum settings required for displaying the normal range:
- `NormalRangeVisibility`: Whether the normal range is visible.
- `NormalRangeMaximum`: The bottom border of the range.
@@ -116,9 +116,9 @@ You can also configure whether to show the normal range in front of or behind th
## Trendlines
-The Angular Sparkline has support for a range of trendlines that display as another layer on top of the actual sparkline layer. To display a sparkline, you can use the `TrendLineType` property.
+The Angular Sparkline has support for a range of trendlines that display as another layer on top of the actual sparkline layer. To display a sparkline, you can use the property.
-The trendlines are calculated according to the algorithm specified by the `TrendLineType` property using the values of the data the the chart is bound to.
+The trendlines are calculated according to the algorithm specified by the property using the values of the data the the chart is bound to.
Trendlines can only be displayed one at a time and by default, the trendline is not displayed.
diff --git a/docs/angular/src/content/en/components/charts/types/spline-chart.mdx b/docs/angular/src/content/en/components/charts/types/spline-chart.mdx
index cda6451b25..8c80c2e098 100644
--- a/docs/angular/src/content/en/components/charts/types/spline-chart.mdx
+++ b/docs/angular/src/content/en/components/charts/types/spline-chart.mdx
@@ -14,7 +14,7 @@ The Ignite UI for Angular Spline Chart belongs to a group of Category Charts tha
## Angular Spline Chart Example
-The following example shows how to create Angular Spline Chart in the control by binding your data and setting the property to `Spline` enum.
+The following example shows how to create Angular Spline Chart in the control by binding your data and setting the property to enum.
@@ -27,7 +27,7 @@ The following example shows how to create Angular Spline Chart in the control by binding your data and setting the property to `Spline`, as shown in the example below:
+You can create this type of chart in the control by binding your data and setting the property to , as shown in the example below:
@@ -40,7 +40,7 @@ You can create this type of chart in the control by binding your data and setting the property to `Spline`, as shown in the example below:
+You can create this type of chart in the control by binding your data and setting the property to , as shown in the example below:
@@ -53,7 +53,7 @@ You can create this type of chart in the control by binding your data and setting the property to `Spline`, as shown in the example below:
+You can create this type of chart in the control by binding your data and setting the property to , as shown in the example below:
@@ -108,9 +108,9 @@ The following table lists API members mentioned in the above sections:
| Chart Type | Control Name | API Members |
| --------------------|--------------------|-------------------------- |
-| Spline | `CategoryChart` | `CategoryChart.ChartType` = `Spline` |
-| Stacked Spline | `DataChart` | `StackedSplineSeries` |
-| Stacked 100% Spline | `DataChart` | `Stacked100SplineSeries` |
+| Spline | | `CategoryChart.ChartType` = |
+| Stacked Spline | | |
+| Stacked 100% Spline | | |
diff --git a/docs/angular/src/content/en/components/charts/types/stacked-chart.mdx b/docs/angular/src/content/en/components/charts/types/stacked-chart.mdx
index a4a90d8e40..0e7422bd4b 100644
--- a/docs/angular/src/content/en/components/charts/types/stacked-chart.mdx
+++ b/docs/angular/src/content/en/components/charts/types/stacked-chart.mdx
@@ -30,7 +30,7 @@ The following sections demonstrate individual types of Ignite UI for Angular Sta
Stacked Area Charts are rendered using a collection of points connected by line segments, with the area below the line filled in and stacked on top of each other. Stacked Area Charts follow all the same requirements as [Area Chart](area-chart.md), with the only difference being that visually, the shaded areas are stacked on top of each other.
-You can create this type of chart in the `DataChart` control by binding your data to a `StackedAreaSeries`, as shown in the example below.
+You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -43,7 +43,7 @@ You can create this type of chart in the `DataChart` control by binding your dat
## Angular Stacked 100 Area Chart
Sometimes the series represent part of a whole being changed over time e.g. a country's energy consumption related to the sources from which it is produced. In such cases representing all stacked elements equally may be a better idea.
-You can create this type of chart in the `DataChart` control by binding your data to a `Stacked100AreaSeries`, as shown in the example below.
+You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -59,7 +59,7 @@ A Stacked Bar Chart, or Stacked Bar Graph, is a type of category chart that is u
The Stacked Bar Chart differs from the [Bar Chart](bar-chart.md) in that the data points representing your data are stacked next to each other horizontally to visually group your data. Each stack can contain both positive and negative values. All positive values are grouped on the positive side of the X-Axis, and all negative values are grouped on the negative side of the X-Axis.
-In this example of an Stacked Bar Chart, we have a Numeric X Axis (bottom labels of the chart) and a Category Y Axis (left labels of the chart). You can create this type of chart in the `DataChart` control by binding your data to a `StackedBarSeries`, as shown in the example below.
+In this example of an Stacked Bar Chart, we have a Numeric X Axis (bottom labels of the chart) and a Category Y Axis (left labels of the chart). You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -73,7 +73,7 @@ In this example of an Stacked Bar Chart, we have a Numeric X Axis (bottom labels
The Angular Stacked 100% Bar Chart is identical to the Angular stacked bar chart in all aspects except in their treatment of the values on X-Axis (bottom labels of the chart). Instead of presenting a direct representation of the data, the stacked 100% bar chart presents the data in terms of percent of the sum of all values in a data point.
-In this example of a Stacked 100% Bar Chart, the Energy Product values are shown as a 100% value of all of the data in the fragments of the horizontal bars. You can create this type of chart in the `DataChart` control by binding your data to a `Stacked100BarSeries`, as shown in the example below.
+In this example of a Stacked 100% Bar Chart, the Energy Product values are shown as a 100% value of all of the data in the fragments of the horizontal bars. You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -87,7 +87,7 @@ In this example of a Stacked 100% Bar Chart, the Energy Product values are shown
The Stacked Column Chart is identical to the [Column Chart](column-chart.md) in all aspects, except the series are represented on top of one another rather than to the side. The Stacked Column Chart is used to show comparing results between series. Each stacked fragment in the collection represents one visual element in each stack. Each stack can contain both positive and negative values. All positive values are grouped on the positive side of the Y-Axis, and all negative values are grouped on the negative side of the Y-Axis. The Stacked Column Chart uses the same concepts of data plotting as the Stacked Bar Chart but data points are stacked along vertical line (Y-Axis) rather than along horizontal line (X-Axis).
-You can create this type of chart in the `DataChart` control by binding your data to a `StackedColumnSeries`, as shown in the example below.
+You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -101,7 +101,7 @@ You can create this type of chart in the `DataChart` control by binding your dat
The Stacked 100% Column Chart is identical to the Stacked Column Chart in all aspects except in their treatment of the values on Y-Axis. Instead of presenting a direct representation of the data, the Stacked 100% Column Chart presents the data in terms of percent of the sum of all values in a data point.
-The example below shows a study made for online shopping traffic by departments via tablet, phone and personal computers. You can create this type of chart in the `DataChart` control by binding your data to a `Stacked100ColumnSeries`, as shown in the example below.
+The example below shows a study made for online shopping traffic by departments via tablet, phone and personal computers. You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -113,7 +113,7 @@ The example below shows a study made for online shopping traffic by departments
## Angular Stacked Line Chart
-The Stacked Line Chart is often used to show the change of value over time such as the amount of renewable electricity produced for several years between regions. You can create this type of chart in the `DataChart` control by binding your data to a `StackedLineSeries`, as shown in the example below:
+The Stacked Line Chart is often used to show the change of value over time such as the amount of renewable electricity produced for several years between regions. You can create this type of chart in the control by binding your data to a , as shown in the example below:
@@ -127,7 +127,7 @@ The Stacked Line Chart is often used to show the change of value over time such
The Stacked 100% Line Chart is identical to the Stacked Line Chart in all aspects except in their treatment of the values on y-axis. Instead of presenting a direct representation of the data, the Stacked 100% Line Chart presents the data in terms of percent of the sum of all values in a data point. The example below shows a study made for online shopping traffic by departments via tablet, phone and personal computers.
-You can create this type of chart in the `DataChart` control by binding your data to a `Stacked100LineSeries`, as shown in the example below:
+You can create this type of chart in the control by binding your data to a , as shown in the example below:
@@ -141,7 +141,7 @@ You can create this type of chart in the `DataChart` control by binding your dat
Stacked Spline Area Charts are rendered using a collection of points connected by curved spline segments, with the area below the curved spline fill in and stacked on top of each other. Stacked Spline Area Charts follow all of the same requirements as [Area Chart](area-chart.md), with the only difference being that the visually shaded areas are stacked on top of each other.
-You can create this type of chart in the `DataChart` control by binding your data to a `StackedSplineAreaSeries`, as shown in the example below.
+You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -155,7 +155,7 @@ You can create this type of chart in the `DataChart` control by binding your dat
The Stacked 100% Spline Area Chart is identical to the Stacked Spline Area Chart in all aspects except for the treatment of the values on the y-axis. Instead of presenting a direct representation of the data, the Stacked 100% Spline Area Chart presents the data in terms of a percent of the sum of all values in a particular data point. Sometimes the chart represents part of a whole being changed over time. For example, a country's energy consumption related to the sources from which it is produced. In such cases, representing all stacked elements equally may be a better idea.
-You can create this type of chart in the `DataChart` control by binding your data to a `Stacked100SplineAreaSeries`, as shown in the example below.
+You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -167,7 +167,7 @@ You can create this type of chart in the `DataChart` control by binding your dat
## Angular Stacked Spline Chart
-The Stacked Spline Chart is often used to show the change of value over time such as the amount of renewable electricity produced for several years between regions. You can create this type of chart in the `DataChart` control by binding your data to a `StackedSplineSeries`, as shown in the example below.
+The Stacked Spline Chart is often used to show the change of value over time such as the amount of renewable electricity produced for several years between regions. You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -181,7 +181,7 @@ The Stacked Spline Chart is often used to show the change of value over time suc
The Stacked 100% Spline Chart is identical to the Stacked Spline Chart in all aspects except in their treatment of the values on y-axis. Instead of presenting a direct representation of the data, the Stacked 100% Spline Chart presents the data in terms of percent of the sum of all values in a data point. The example below shows a study made for online shopping traffic by departments via tablet, phone and personal computers.
-You can create this type of chart in the `DataChart` control by binding your data to a `Stacked100SplineSeries`.
+You can create this type of chart in the control by binding your data to a .
@@ -207,15 +207,15 @@ The following table lists API members mentioned in the above sections:
| Chart Type | Control Name | API Members |
| -------------------------|----------------|-------------------------------- |
-| Stacked Area | `DataChart` | `StackedAreaSeries` |
-| Stacked Bar | `DataChart` | `StackedBarSeries` |
-| Stacked Column | `DataChart` | `StackedColumnSeries` |
-| Stacked Line | `DataChart` | `StackedLineSeries` |
-| Stacked Spline | `DataChart` | `StackedSplineSeries` |
-| Stacked Spline Area | `DataChart` | `StackedSplineAreaSeries` |
-| Stacked 100% Area | `DataChart` | `Stacked100AreaSeries` |
-| Stacked 100% Bar | `DataChart` | `Stacked100BarSeries` |
-| Stacked 100% Column | `DataChart` | `Stacked100ColumnSeries` |
-| Stacked 100% Line | `DataChart` | `Stacked100LineSeries` |
-| Stacked 100% Spline | `DataChart` | `Stacked100SplineSeries` |
-| Stacked 100% Spline Area | `DataChart` | `Stacked100SplineAreaSeries` |
+| Stacked Area | | |
+| Stacked Bar | | |
+| Stacked Column | | |
+| Stacked Line | | |
+| Stacked Spline | | |
+| Stacked Spline Area | | |
+| Stacked 100% Area | | |
+| Stacked 100% Bar | | |
+| Stacked 100% Column | | |
+| Stacked 100% Line | | |
+| Stacked 100% Spline | | |
+| Stacked 100% Spline Area | | |
diff --git a/docs/angular/src/content/en/components/charts/types/step-chart.mdx b/docs/angular/src/content/en/components/charts/types/step-chart.mdx
index 7008d9df21..cb06134f0a 100644
--- a/docs/angular/src/content/en/components/charts/types/step-chart.mdx
+++ b/docs/angular/src/content/en/components/charts/types/step-chart.mdx
@@ -15,7 +15,7 @@ The Ignite UI for Angular Step Chart belongs to a group of category charts that
## Angular Step Area Chart
-You can create Angular Step Area Chart in the control by setting property to `StepArea` enum, as shown in the example below.
+You can create Angular Step Area Chart in the control by setting property to enum, as shown in the example below.
@@ -28,7 +28,7 @@ You can create Angular Step Area Chart in the control by binding your data and setting property to `StepLine` value, as shown in the example below.
+You can create Step Line Chart in the control by binding your data and setting property to value, as shown in the example below.
@@ -39,7 +39,7 @@ You can create Step Line Chart in the control as demonstrated below.
+If you need Step Charts with more features such as composite other series, you can configure the , , , lines' , and lines' properties on the control as demonstrated below.
diff --git a/docs/angular/src/content/en/components/charts/types/stock-chart.mdx b/docs/angular/src/content/en/components/charts/types/stock-chart.mdx
index ca52b73b8c..28cf935d8d 100644
--- a/docs/angular/src/content/en/components/charts/types/stock-chart.mdx
+++ b/docs/angular/src/content/en/components/charts/types/stock-chart.mdx
@@ -15,7 +15,7 @@ The Ignite UI for Angular Stock Chart, sometimes referred to as Angular Financia
## Angular Stock Chart Example
-You can create Stock Chart using the control by binding your data and optionally setting property to `Line` value, as shown in the example below.
+You can create Stock Chart using the control by binding your data and optionally setting property to value, as shown in the example below.
@@ -96,7 +96,7 @@ If you need a Stock Chart with more features such as composite other series, you
## Angular Chart Annotations
-The Crosshair Annotation Layer provides crossing lines that meet at the actual value of every targeted series. Crosshair types include: Horizontal, Vertical, and Both. The Crosshairs can also be configured to snap to data points by setting the `CrosshairsSnapToData` property to true, otherwise the crosshairs will be interpolated between data points. Annotations can also be enabled to display the crosshair's value along the axis.
+The Crosshair Annotation Layer provides crossing lines that meet at the actual value of every targeted series. Crosshair types include: Horizontal, Vertical, and Both. The Crosshairs can also be configured to snap to data points by setting the property to true, otherwise the crosshairs will be interpolated between data points. Annotations can also be enabled to display the crosshair's value along the axis.
The Final Value Layer provides a quick view along the axis of the ending value displayed in a series.
@@ -124,20 +124,20 @@ The following panes are available:
Financial Indicators are often used by traders to measure changes and to show trends in stock prices. These indicators are usually displayed below the price pane because they do not share the same Y-Axis scale.
By default the indicator panes are not displayed. The toolbar allows the end user to select which indicator to display at run time.
-In order to display an indicator pane initially, the `IndicatorTypes` property must be set to a least one type of indicator, as demonstrated in the following code:
+In order to display an indicator pane initially, the property must be set to a least one type of indicator, as demonstrated in the following code:
### Volume Pane
The volume pane represents the number of shares traded during a given period. Low volume would indicate little interest, while high volume would indicate high interest with a lot of trades. This can be displayed using column, line or area chart types. The toolbar allows the end user to display the volume pane by selecting a chart type to render the data at runtime. In order the display the pane, a volume type must be set, as demonstrated in the following code:
### Price Pane
-This pane displays stock prices and shows the stock's high, low, open and close prices over time. In addition it can display trend lines and overlays. Your end user can choose different chart types from the toolbar. By default, the chart type is set to `Auto`. You can override the default setting, as demonstrated in the following code:
+This pane displays stock prices and shows the stock's high, low, open and close prices over time. In addition it can display trend lines and overlays. Your end user can choose different chart types from the toolbar. By default, the chart type is set to . You can override the default setting, as demonstrated in the following code:
Note that is recommended to use line chart type if plotting multiple data sources or if plotting data source with a lot of data points.
### Zoom Pane
-This pane controls the zoom of all the displayed panes. This pane is displayed by default. It can be turned off by setting the `ZoomSliderType` to `none` as demonstrated in the following code:
+This pane controls the zoom of all the displayed panes. This pane is displayed by default. It can be turned off by setting the to `none` as demonstrated in the following code:
-Note that you should set the `ZoomSliderType` option to the same value as the `ChartType` option is set to. This way, the zoom slider will show correct preview of the price pane. The following code demonstrates how to do this:
+Note that you should set the option to the same value as the option is set to. This way, the zoom slider will show correct preview of the price pane. The following code demonstrates how to do this:
In this example, the stock chart is plotting revenue for United States.
diff --git a/docs/angular/src/content/en/components/charts/types/treemap-chart.mdx b/docs/angular/src/content/en/components/charts/types/treemap-chart.mdx
index ebadc66ceb..2ce557e3b5 100644
--- a/docs/angular/src/content/en/components/charts/types/treemap-chart.mdx
+++ b/docs/angular/src/content/en/components/charts/types/treemap-chart.mdx
@@ -57,13 +57,13 @@ There are several common use cases for choosing a Treemap. When you:
- The data source must be an array or a list of data items
- The data source must contain at least one data item otherwise the map will not render any nodes.
-- All data items must contain at least one data column (e.g. string) which should be mapped to the `LabelMemberPath` property.
-- All data items must contain at least one numeric data column which should be mapped using the `ValueMemberPath` property.
-- To categorize data into organized tiles you can optionally use `ParentIdMemberPath` and `IdMemberPath`.
+- All data items must contain at least one data column (e.g. string) which should be mapped to the property.
+- All data items must contain at least one numeric data column which should be mapped using the property.
+- To categorize data into organized tiles you can optionally use and .
## Angular Treemap Configuration
-In the following example, the treemap demonstrates the ability of changing it's algorithmic structure by modifying the `LayoutType` and `LayoutOrientation` properties.
+In the following example, the treemap demonstrates the ability of changing it's algorithmic structure by modifying the and properties.
@@ -87,9 +87,9 @@ The Treemap allows you to choose the algorithm that is best for your requirement
### Layout Orientation
-`LayoutOrientation` property enables the user to set the direction in which the nodes of the hierarchy will be expanded.
+ property enables the user to set the direction in which the nodes of the hierarchy will be expanded.
-Note that the `LayoutOrientation` property works with the layout types SliceAndDice and Strip.
+Note that the property works with the layout types SliceAndDice and Strip.
- `Horizontal` – the child nodes are going to be stacked horizontally(SliceAndDice).
- `Vertical` – the child nodes are going to be stacked vertically (SliceAndDice).
@@ -103,17 +103,17 @@ In the following example, the treemap demonstrates the ability of changing the l
### Angular Treemap Highlighting
-In the following example, the treemap demonstrates the ability of node highlighting. There are two options for this feature. Each node can individually brighten, by decreasing its opacity, or cause all other nodes to trigger the same effect. To enable this feature, set `HighlightingMode`to Brighten or FadeOthers.
+In the following example, the treemap demonstrates the ability of node highlighting. There are two options for this feature. Each node can individually brighten, by decreasing its opacity, or cause all other nodes to trigger the same effect. To enable this feature, set to Brighten or FadeOthers.
## Angular Treemap Percent based highlighting
-- `HighlightedItemsSource`: Specifies the datasource to read highlighted values from. If null, then highlighted values are read from the ItemsSource property.
-- `HighlightedValueMemberPath`: Specifies the name of the property in the datasource where the highlighted values are read.
-- `HighlightedValueOpacity`: Controls the opacity of the normal value behind the highlighted value.
-- `HighlightedValuesDisplayMode`: Enables or disables highlighted values.
+- : Specifies the datasource to read highlighted values from. If null, then highlighted values are read from the ItemsSource property.
+- : Specifies the name of the property in the datasource where the highlighted values are read.
+- : Controls the opacity of the normal value behind the highlighted value.
+- : Enables or disables highlighted values.
- Auto: The treemap decides what mode to use.
- Overlay: The treemap displays highlighted values over top the normal value with a slight opacity applied to the normal value.
- Hidden: The treemap does not show highlighted values.
diff --git a/docs/angular/src/content/en/components/chip.mdx b/docs/angular/src/content/en/components/chip.mdx
index d27be47ecc..79b7cf8a23 100644
--- a/docs/angular/src/content/en/components/chip.mdx
+++ b/docs/angular/src/content/en/components/chip.mdx
@@ -112,7 +112,7 @@ Selection can be enabled by setting the
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/circular-progress.mdx b/docs/angular/src/content/en/components/circular-progress.mdx
index d7a94f976e..e77b6dfa89 100644
--- a/docs/angular/src/content/en/components/circular-progress.mdx
+++ b/docs/angular/src/content/en/components/circular-progress.mdx
@@ -88,7 +88,7 @@ After that, we should have the demo sample in your browser.
The **igx-circular-bar** emits event that outputs an object like this `{currentValue: 65, previousValue: 64}` on each step.
-
+
The default progress increments by **1% of the value** per update cycle, this happens if the value is not defined. To change the update rate, the value should be defined.```
@@ -136,7 +136,7 @@ You can dynamically change the value of the progress by using external controls
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/combo-templates.mdx b/docs/angular/src/content/en/components/combo-templates.mdx
index bded3f6f2d..7377b1d393 100644
--- a/docs/angular/src/content/en/components/combo-templates.mdx
+++ b/docs/angular/src/content/en/components/combo-templates.mdx
@@ -140,7 +140,7 @@ Use selector `[igxComboToggleIcon]`:
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/dashboard-tile.mdx b/docs/angular/src/content/en/components/dashboard-tile.mdx
index 81c720e89d..60669f2bd3 100644
--- a/docs/angular/src/content/en/components/dashboard-tile.mdx
+++ b/docs/angular/src/content/en/components/dashboard-tile.mdx
@@ -15,7 +15,7 @@ import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
# Angular Dashboard Tile
-The Angular Dashboard Tile is a automatic data visualization component which determines via analysis of a DataSource collection/array or single data point what would be the most appropriate visualization to display. It then also provides a further suite of tools in its embedded that let you alter the visualization that is presented in a variety of ways.
+The Angular Dashboard Tile is a automatic data visualization component which determines via analysis of a DataSource collection/array or single data point what would be the most appropriate visualization to display. It then also provides a further suite of tools in its embedded that let you alter the visualization that is presented in a variety of ways.
A wide variety of visualizations may be selected for display depending on the shape of the provided data including, but not limited to: Category Charts, Radial and Polar Charts, Scatter Charts, Geographic Maps, Radial and Linear Gauges, Financial Charts and Stacked Charts.
@@ -96,7 +96,7 @@ You are not locked into a single visualization when you bind the `DataSource`, a
-The visualization or properties of the visualization are also configurable using the at the top of the control. This has the default tools for the current visualization with the addition of four Dashboard Tile specific ones, highlighted below:
+The visualization or properties of the visualization are also configurable using the at the top of the control. This has the default tools for the current visualization with the addition of four Dashboard Tile specific ones, highlighted below:
@@ -105,7 +105,7 @@ From left to right:
- The first tool will show a data grid with the `DataSource` provided to the control. This is a toggle tool, so if you click it again after showing the grid, it will revert to the visualization.
- The second tool allows you to configure the settings of the current data visualization.
- The third tool allows you to change the current visualization, allowing you to plot a different series type or show a different type of visualization altogether. This can be set on the control by setting the `VisualizationType` property, mentioned above.
-- The last tool allows you to configure which properties on your underlying data item are included for the control. You can configure this by setting the `IncludedProperties` or `ExcludedProperties` collection on the control.
+- The last tool allows you to configure which properties on your underlying data item are included for the control. You can configure this by setting the or collection on the control.
This demo demonstrates dashboard tile integration with the Angular Pie Chart. The toolbar options at the top right provides access to styling and changing the data visualization.
@@ -121,7 +121,7 @@ This demo demonstrates dashboard tile integration with the Angular Geographic Ma
-
+
diff --git a/docs/angular/src/content/en/components/date-picker.mdx b/docs/angular/src/content/en/components/date-picker.mdx
index be1c06189f..4aefcdc2a3 100644
--- a/docs/angular/src/content/en/components/date-picker.mdx
+++ b/docs/angular/src/content/en/components/date-picker.mdx
@@ -160,7 +160,7 @@ The allows the projection of child components that
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/date-range-picker.mdx b/docs/angular/src/content/en/components/date-range-picker.mdx
index 2734e36405..7b412c6032 100644
--- a/docs/angular/src/content/en/components/date-range-picker.mdx
+++ b/docs/angular/src/content/en/components/date-range-picker.mdx
@@ -133,7 +133,7 @@ The Angular Date Range Picker component also allows configuring two separate inp
```
-
+
In the two-input configuration, place the `input` directly inside `igx-date-range-start` and `igx-date-range-end`.
To open the calendar from an icon, use `igx-picker-toggle` with `igxPrefix` applied directly to it:
@@ -273,13 +273,13 @@ In the default configuration, with a single read-only input, a default calendar
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
When a Date Range Picker has two separate inputs for start and end dates, it doesn't expose these icons by default. The and should be manually added as children of the or like so:
-
+
In the two-input configuration:
- use `igx-picker-toggle igxPrefix` for the calendar action
diff --git a/docs/angular/src/content/en/components/dialog.mdx b/docs/angular/src/content/en/components/dialog.mdx
index fe83d88505..5cbc76980d 100644
--- a/docs/angular/src/content/en/components/dialog.mdx
+++ b/docs/angular/src/content/en/components/dialog.mdx
@@ -79,7 +79,7 @@ export class HomeComponent {}
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/drop-down.mdx b/docs/angular/src/content/en/components/drop-down.mdx
index 3d1f39018c..42dd8e424f 100644
--- a/docs/angular/src/content/en/components/drop-down.mdx
+++ b/docs/angular/src/content/en/components/drop-down.mdx
@@ -176,7 +176,7 @@ To provide a more useful visual information, use the
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/excel-library-using-cells.mdx b/docs/angular/src/content/en/components/excel-library-using-cells.mdx
index b6a4380e2a..4b4ebbf94d 100644
--- a/docs/angular/src/content/en/components/excel-library-using-cells.mdx
+++ b/docs/angular/src/content/en/components/excel-library-using-cells.mdx
@@ -45,7 +45,7 @@ import { FormattedString } from "igniteui-angular-excel";
## Referencing Cells and Regions
-You can access a object or a object by calling the object’s `GetCell` or `GetRegion` methods, respectively. Both methods accept a string parameter that references a cell. Getting a reference to a cell is useful when applying formats or working with formulas and cell contents.
+You can access a object or a object by calling the object’s or methods, respectively. Both methods accept a string parameter that references a cell. Getting a reference to a cell is useful when applying formats or working with formulas and cell contents.
The following example code demonstrates how to reference cells and regions:
@@ -65,7 +65,7 @@ var region = worksheet.getRegion("G1:G10");
In Microsoft Excel, individual cells, as well as cell regions can have names assigned to them. The name of a cell or region can be used to reference that cell or region instead of their address.
-The Infragistics Angular Excel Library supports the referencing of cells and regions by name through the `GetCell` and `GetRegion` methods of the object. You refer to the cell or region using the `NamedReference` instance that refers to that cell or region.
+The Infragistics Angular Excel Library supports the referencing of cells and regions by name through the and methods of the object. You refer to the cell or region using the instance that refers to that cell or region.
You can use the following code snippet as an example for naming a cell or region:
@@ -109,7 +109,7 @@ worksheet.rows(0).cells(0).comment = cellComment;
## Adding a Formula to a Cell
-The Infragistics Angular Excel Library allows you to add Microsoft Excel formulas to a cell or group of cells in a worksheet. You can do this using the object’s `ApplyFormula` method or by instantiating a object and applying it to a cell. Regardless of the manner in which you apply a formula to a cell, you can access the object using the object’s property. If you need the value, use the cell’s `Value` property.
+The Infragistics Angular Excel Library allows you to add Microsoft Excel formulas to a cell or group of cells in a worksheet. You can do this using the object’s method or by instantiating a object and applying it to a cell. Regardless of the manner in which you apply a formula to a cell, you can access the object using the object’s property. If you need the value, use the cell’s property.
The following code shows you how to add a formula to a cell.
@@ -126,7 +126,7 @@ The following code shows you how to add a formula to a cell.
## Copying a Cell’s Format
-Cells can have different formatting, including background color, format string, and font style. If you need a cell to have the same format as a previously formatted cell, instead of individually setting each option exposed by the object’s property, you can call the object’s `SetFormatting` method and pass it a object to copy. This will copy every format setting from the first cell to the second cell. You can also do this for a row, merged cell region, or column.
+Cells can have different formatting, including background color, format string, and font style. If you need a cell to have the same format as a previously formatted cell, instead of individually setting each option exposed by the object’s property, you can call the object’s method and pass it a object to copy. This will copy every format setting from the first cell to the second cell. You can also do this for a row, merged cell region, or column.
The following code shows you how to copy the format of the 2nd column to the 4th column:
@@ -146,7 +146,7 @@ worksheet.columns(3).cellFormat.setFormatting(worksheet.columns(1).cellFormat);
## Formatting a Cell
-The Infragistics Angular Excel Library allows you to customize the look and behavior of a cell. You can customize a cell by setting properties exposed by the property of the , , , or `WorksheetMergedCellsRegion` objects.
+The Infragistics Angular Excel Library allows you to customize the look and behavior of a cell. You can customize a cell by setting properties exposed by the property of the , , , or objects.
You can customize every aspect of a cell’s appearance. You can set a cell’s font, background, and borders, as well as text alignment and rotation. You can even apply a different format on a character-by-character basis for a cell’s text.
@@ -171,9 +171,9 @@ You can create all possible fill types using static properties and methods on th
- `NoColor` - A property that represents a fill with no color, which allows a background image of the worksheet, if any, to show through.
-- `CreateSolidFill` - Returns a instance which has a pattern style of `Solid` and a background color set to the `Color` or specified in the method.
+- `CreateSolidFill` - Returns a instance which has a pattern style of `Solid` and a background color set to the or specified in the method.
-- `CreatePatternFill` - Returns a instance which has the specified pattern style and the `Color` or values, specified for the background and pattern colors.
+- `CreatePatternFill` - Returns a instance which has the specified pattern style and the or values, specified for the background and pattern colors.
- `CreateLinearGradientFill` - Returns a instance with the specified angle and gradient stops.
@@ -241,7 +241,7 @@ Each workbook has 12 associated theme colors. They are the following:
Colors are defined by the class, which is a sealed immutable class. The class has a static `Automatic` property, which returns the automatic color, and there are various constructors which allow you to create a instance with a color or a theme value and an optional tint.
-The `GetResolvedColor` method on allows you to determine what color will actually be seen by the user when they open the file in Excel.
+The method on allows you to determine what color will actually be seen by the user when they open the file in Excel.
If the represents a theme color, you must pass in a Workbook instance to the method so it can get the theme color’s RGB value from the workbook.
@@ -253,35 +253,35 @@ When the older formats are opened in Microsoft Excel 2003 and earlier versions,
You can set a host of different formats on a by using the object returned by the property of that cell. This object enables you to style many different aspects of the cell such as borders, font, fill, alignments, and whether or not the cell should shrink to fit or be locked.
-You can also access the built-in styles to Microsoft Excel 2007 using the `Styles` collection of the object. The full list of styles in Excel can be found in the Cell Styles gallery of the Home tab of Microsoft Excel 2007.
+You can also access the built-in styles to Microsoft Excel 2007 using the collection of the object. The full list of styles in Excel can be found in the Cell Styles gallery of the Home tab of Microsoft Excel 2007.
-There is a special type of style on the workbook’s `Styles` collection known as the "normal" style, which can be accessed using that collection’s `NormalStyle` property, or by indexing into the collection with the name "Normal".
+There is a special type of style on the workbook’s collection known as the "normal" style, which can be accessed using that collection’s property, or by indexing into the collection with the name "Normal".
-The `NormalStyle` contains the default properties for all cells in the workbook, unless otherwise specified on a row, column, or cell. Changing the properties on the `NormalStyle` will change all of the default cell format properties on the workbook. This is useful, for example, if you want to change the default font for your workbook.
+The contains the default properties for all cells in the workbook, unless otherwise specified on a row, column, or cell. Changing the properties on the will change all of the default cell format properties on the workbook. This is useful, for example, if you want to change the default font for your workbook.
-You can clear the `Styles` collection or reset it to its predefined state by using the `Clear` and `Reset` methods, respectively. Both of these will remove all user-defined styles, but `Clear` will clear the `Styles` collection entirely.
+You can clear the collection or reset it to its predefined state by using the and methods, respectively. Both of these will remove all user-defined styles, but will clear the collection entirely.
-With this feature, a `Style` property has been added to the object. This is a reference to a instance, representing the parent style of the format. For formats of a style, this property will always be null, because styles cannot have a parent style. For row, column, and cell formats, the `Style` property always returns the `NormalStyle` by default.
+With this feature, a property has been added to the object. This is a reference to a instance, representing the parent style of the format. For formats of a style, this property will always be null, because styles cannot have a parent style. For row, column, and cell formats, the property always returns the by default.
-If the `Style` property is set to null, it will revert back to the `NormalStyle`. If it is set to another style in the styles collection, that style will now hold the defaults for all unset properties on the cell format.
+If the property is set to null, it will revert back to the . If it is set to another style in the styles collection, that style will now hold the defaults for all unset properties on the cell format.
-When the `Style` property is set on a cell format, the format options included on the `Style` are removed from the cell format. All other properties are left intact. For example, if a cell style including border formatting was created and that style was set as the cell’s `Style`, the border format option on the cell format would be removed and the cell format only includes fill formatting.
+When the property is set on a cell format, the format options included on the are removed from the cell format. All other properties are left intact. For example, if a cell style including border formatting was created and that style was set as the cell’s , the border format option on the cell format would be removed and the cell format only includes fill formatting.
When a format option flag is removed from a format, all associated properties are reset to their unset values, so the cell format’s border properties are implicitly reset to default/unset values.
-You can determine what would really be seen in cells by using the `GetResolvedCellFormat` method on classes which represent a row, column, cell, and merged cell.
+You can determine what would really be seen in cells by using the method on classes which represent a row, column, cell, and merged cell.
-This method returns a instance which refers back to the associated on which it is based. So subsequent changes to the property will be reflected in the instance returned from a `GetResolvedCellFormat` call.
+This method returns a instance which refers back to the associated on which it is based. So subsequent changes to the property will be reflected in the instance returned from a call.
## Merging Cells
Aside from setting the value or format of cells, you can also merge cells to make two or more cells appear as one. If you merge cells, they must be in a rectangular region.
-When you merge cells, each cell in the region will have the same value and cell format. The merged cells will also be associated with the same `WorksheetMergedCellsRegion` object, accessible from their `AssociatedMergedCellsRegion` property. The resultant `WorksheetMergedCellsRegion` object will also have the same value and cell format as the cells.
+When you merge cells, each cell in the region will have the same value and cell format. The merged cells will also be associated with the same object, accessible from their property. The resultant object will also have the same value and cell format as the cells.
Setting the value (or cell format) of the region or any cell in the region will change the value of all cells and the region. If you un-merge cells, all of the previously merged cells will retain the shared cell format they had before they were unmerged. However, only the top-left cell of the region will retain the shared value.
-In order to create a merged cell region, you must add a range of cells to the object’s `MergedCellsRegions` collection. This collection exposes an `Add` method that takes four integer parameters. The four parameters determine the index of the starting row and column (top-left most cell) and the index of the ending row and column (bottom-right most cell).
+In order to create a merged cell region, you must add a range of cells to the object’s collection. This collection exposes an `Add` method that takes four integer parameters. The four parameters determine the index of the starting row and column (top-left most cell) and the index of the ending row and column (bottom-right most cell).
```ts
var workbook = new Workbook();
@@ -345,11 +345,11 @@ If a text is used in the cell, the cell displayed text will always be full value
The only time when this is not the case is when padding characters are used in format string. Then the value will be displayed as all hash marks when there is not enough room for the text.
-You can set the worksheet's `DisplayOptions`' `ShowFormulasInCells` property to have formulas be displayed in cells instead of their results, and format strings and cell widths are ignored. Text values display as if their format string were @ , non-integral numeric values display as if their format string were 0.0 and integral numeric values display as if their format string were 0 .
+You can set the worksheet's ' property to have formulas be displayed in cells instead of their results, and format strings and cell widths are ignored. Text values display as if their format string were @ , non-integral numeric values display as if their format string were 0.0 and integral numeric values display as if their format string were 0 .
Additionally, if the value cannot fit, it will not display as all hashes. Display text will still return its full text as the cell text, even though it may not be fully seen.
-The following code snippet demonstrates the usage of the `GetText` method to get the text as it would be displayed in Excel:
+The following code snippet demonstrates the usage of the method to get the text as it would be displayed in Excel:
```ts
var workbook = new Workbook();
diff --git a/docs/angular/src/content/en/components/excel-library-using-tables.mdx b/docs/angular/src/content/en/components/excel-library-using-tables.mdx
index a4090c61c3..e078aa9511 100644
--- a/docs/angular/src/content/en/components/excel-library-using-tables.mdx
+++ b/docs/angular/src/content/en/components/excel-library-using-tables.mdx
@@ -24,7 +24,7 @@ The Infragistics Angular Excel Engine's
## Adding a Table to a Worksheet
-Worksheet tables in the Infragistics Angular Excel Engine are represented by the object and are added in the worksheet's `Tables` collection. In order to add a table, you need to invoke the `Add` method on this collection. In this method, you can specify the region in which you would like to add a table, whether or not the table should contain headers, and optionally, specify the table's style as a `WorksheetTableStyle` object.
+Worksheet tables in the Infragistics Angular Excel Engine are represented by the object and are added in the worksheet's collection. In order to add a table, you need to invoke the `Add` method on this collection. In this method, you can specify the region in which you would like to add a table, whether or not the table should contain headers, and optionally, specify the table's style as a object.
The following code demonstrates how you can add a table with headers to a spanning a region of A1 to G10, where A1 to G1 will be the column headers:
@@ -37,7 +37,7 @@ worksheet.tables().add("A1:G10", true);
-Once you have added a table, you can modify it by adding or deleting rows and columns by calling the `InsertColumns`, `InsertDataRows`, `DeleteColumns`, or `DeleteDataRows` methods on the . You can also set a new table range by using the `Resize` method of the table.
+Once you have added a table, you can modify it by adding or deleting rows and columns by calling the , , , or methods on the . You can also set a new table range by using the method of the table.
The following code snippet shows the usage of these methods:
@@ -67,19 +67,19 @@ table.resize("A1:G15");
## Filtering Tables
Filtering is done by applying a filter on a column in the . When the filter is applied on a column, all filters in the table will be reevaluated to determine which rows meet the criteria of all filters applied.
-If the data in the table is subsequently changed or you change the `Hidden` property of the rows, the filter conditions will not automatically reevaluate. The filter conditions in a table are only reapplied when table column filters are added, removed, modified, or when the `ReapplyFilters` method is called on the table.
+If the data in the table is subsequently changed or you change the `Hidden` property of the rows, the filter conditions will not automatically reevaluate. The filter conditions in a table are only reapplied when table column filters are added, removed, modified, or when the method is called on the table.
The following are the filter types available to the columns of your :
-- `AverageFilter` - Cells can be filtered based on whether they are above or below the average value of all cells in the column.
-- `CustomFilter` - Cells can be filtered based on one or more custom conditions.
-- `DatePeriodFilter` - Only cells with dates in a specific month or quarter of any year will be displayed.
-- `FillFilter` - Only cells with a specific fill will be displayed.
-- `FixedValuesFilter` - Cells which only match specific display values or which fall within a specific group of dates/times will be displayed.
-- `FontColorFilter` - Only cells with a specific font color will be displayed.
-- `RelativeDateRangeFilter` - Cells with date values can be filtered based on whether they occur within a relative time range of the date when the filter was applied, such as the next day or previous quarter.
-- `TopOrBottomFilter` - This filter allows for filtering the top or bottom N values. It also allows filtering the top or bottom N% values.
-- `YearToDateFilter` - Cells with date values can be filtered if they occur between the start of the year and the date on which the filter was applied.
+- - Cells can be filtered based on whether they are above or below the average value of all cells in the column.
+- - Cells can be filtered based on one or more custom conditions.
+- - Only cells with dates in a specific month or quarter of any year will be displayed.
+- - Only cells with a specific fill will be displayed.
+- - Cells which only match specific display values or which fall within a specific group of dates/times will be displayed.
+- - Only cells with a specific font color will be displayed.
+- - Cells with date values can be filtered based on whether they occur within a relative time range of the date when the filter was applied, such as the next day or previous quarter.
+- - This filter allows for filtering the top or bottom N values. It also allows filtering the top or bottom N% values.
+- - Cells with date values can be filtered if they occur between the start of the year and the date on which the filter was applied.
The following code snippet demonstrates how to apply an "above average" filter to a 's first column:
@@ -96,20 +96,20 @@ table.columns(0).applyAverageFilter(AverageFilterType.AboveAverage);
## Sorting Tables
Sorting is done by setting a sorting condition on a table column. When a sorting condition is set on a column, all sorting conditions in the table will be reevaluated to determine the order of the cells in the table. When cells need to be moved to meet their sort criteria, the entire row of cells in the table is moved as a unit.
-If the data in the table is subsequently changed, the sort conditions do not automatically reevaluate. The sort conditions in a table are only reapplied when sort conditions are added, removed, modified, or when the `ReapplySortConditions` method is called on the table. When sorting conditions are reevaluated, only the visible cells are sorted. All cells in hidden rows are kept in place.
+If the data in the table is subsequently changed, the sort conditions do not automatically reevaluate. The sort conditions in a table are only reapplied when sort conditions are added, removed, modified, or when the method is called on the table. When sorting conditions are reevaluated, only the visible cells are sorted. All cells in hidden rows are kept in place.
-In addition to accessing sort conditions from the table columns, they are also exposed off the 's SortSettings property's `SortConditions` collection. This is an ordered collection of columns/sort condition pairs. The order of this collection is the precedence of the sorting.
+In addition to accessing sort conditions from the table columns, they are also exposed off the 's SortSettings property's collection. This is an ordered collection of columns/sort condition pairs. The order of this collection is the precedence of the sorting.
The following sort condition types are available to set on columns:
-- `OrderedSortCondition` - Sort cells in an ascending or descending order based on their value.
-- `CustomListSortCondition` - Sort cells in a defined order based on their text or display value. For example, this might be useful for sorting days as they appear on a calendar, rather than alphabetically.
-- `FillSortCondition` - Sort cells based on whether their fill is a specific pattern or gradient.
-- `FontColorSortCondition` - Sort cells based on whether their font is a specific color.
+- - Sort cells in an ascending or descending order based on their value.
+- - Sort cells in a defined order based on their text or display value. For example, this might be useful for sorting days as they appear on a calendar, rather than alphabetically.
+- - Sort cells based on whether their fill is a specific pattern or gradient.
+- - Sort cells based on whether their font is a specific color.
-There is also a `CaseSensitive` property on the SortSettings of the to determine whether strings should be sorted case sensitively or not.
+There is also a property on the SortSettings of the to determine whether strings should be sorted case sensitively or not.
-The following code snippet demonstrates how to apply an `OrderedSortCondition` to a :
+The following code snippet demonstrates how to apply an to a :
```ts
var workbook = new Workbook(WorkbookFormat.Excel2007);
diff --git a/docs/angular/src/content/en/components/excel-library-using-workbooks.mdx b/docs/angular/src/content/en/components/excel-library-using-workbooks.mdx
index 8b8b10d39d..a7bc09b831 100644
--- a/docs/angular/src/content/en/components/excel-library-using-workbooks.mdx
+++ b/docs/angular/src/content/en/components/excel-library-using-workbooks.mdx
@@ -24,7 +24,7 @@ The Infragistics Angular Excel Engine enables you to save data to and load data
## Change Default Font
-First create a new instance of . Next, add the new font to the `Styles` collection of the . This style contains the default properties for all cells in the workbook, unless otherwise specified on a row, column, or cell. Changing properties of the style will change the default cell format properties in the workbook.
+First create a new instance of . Next, add the new font to the collection of the . This style contains the default properties for all cells in the workbook, unless otherwise specified on a row, column, or cell. Changing properties of the style will change the default cell format properties in the workbook.
```ts
var workbook = new Workbook();
@@ -40,23 +40,23 @@ font.height = 16 * 20;
Microsoft Excel® document properties provide information to help organize and keep track of your documents. You can use the Infragistics Angular Excel Library to set these properties using the object’s property. The available properties are:
-- `Author`
+-
-- `Title`
+-
-- `Subject`
+-
-- `Keywords`
+-
-- `Category`
+-
-- `Status`
+-
-- `Comments`
+-
-- `Company`
+-
-- `Manager`
+-
The following code demonstrates how to create a workbook and set its `title` and `status` document properties.
diff --git a/docs/angular/src/content/en/components/excel-library-using-worksheets.mdx b/docs/angular/src/content/en/components/excel-library-using-worksheets.mdx
index f7e8a39e52..2c750a25c0 100644
--- a/docs/angular/src/content/en/components/excel-library-using-worksheets.mdx
+++ b/docs/angular/src/content/en/components/excel-library-using-worksheets.mdx
@@ -87,7 +87,7 @@ worksheet.displayOptions.showRowAndColumnHeaders = false;
## Configuring Editing of the Worksheet
-By default, the objects that you save will be editable. You can disable editing of a worksheet by protecting it using the object's `Protect` method. This method has a lot of nullable `bool` arguments that determine which pieces are protected, and one of these options is to allow editing of objects, which if set to **false** will prevent editing of the worksheet.
+By default, the objects that you save will be editable. You can disable editing of a worksheet by protecting it using the object's method. This method has a lot of nullable `bool` arguments that determine which pieces are protected, and one of these options is to allow editing of objects, which if set to **false** will prevent editing of the worksheet.
The following code demonstrates how to disable editing in your worksheet:
@@ -100,9 +100,9 @@ worksheet.protect();
-You can also use the object's `Protect` method to protect a worksheet against structural changes.
+You can also use the object's method to protect a worksheet against structural changes.
-When protection is set, you can set the object's `Locked` property on individual cells, rows, merged cell regions, or columns to override the worksheet object's protection on those objects. For example, if you need all cells of a worksheet to be read-only except for the cells of one column, you can protect the worksheet and then set the object's `Locked` property to **false** on a specific object. This will allow your users to edit cells within the column while disabling editing of the other cells in the worksheet.
+When protection is set, you can set the object's property on individual cells, rows, merged cell regions, or columns to override the worksheet object's protection on those objects. For example, if you need all cells of a worksheet to be read-only except for the cells of one column, you can protect the worksheet and then set the object's property to **false** on a specific object. This will allow your users to edit cells within the column while disabling editing of the other cells in the worksheet.
The following code demonstrates how you can do this:
@@ -117,24 +117,24 @@ worksheet.columns(0).cellFormat.locked = false;
## Filtering Worksheet Regions
-Filtering is done by setting a filter condition on a worksheet's which can be retrieved from the object's property. Filter conditions are only reapplied when they're added, removed, modified, or when the `ReapplyFilters` method is called on the worksheet. They are not constantly evaluated as data within the region changes.
+Filtering is done by setting a filter condition on a worksheet's which can be retrieved from the object's property. Filter conditions are only reapplied when they're added, removed, modified, or when the method is called on the worksheet. They are not constantly evaluated as data within the region changes.
-You can specify the region to apply the filter by using the `SetRegion` method on the object.
+You can specify the region to apply the filter by using the method on the object.
Below is a list of methods and their descriptions that you can use to add a filter to a worksheet:
| Method | Description |
| --------------|-------------|
-|`ApplyAverageFilter`|Represents a filter which can filter data based on whether the data is below or above the average of the entire data range.|
-|`ApplyDatePeriodFilter`|Represents a filter which can filter dates in a Month, or quarter of any year.|
-|`ApplyFillFilter`|Represents a filter which will filter cells based on their background fills. This filter specifies a single CellFill. Cells of with this fill will be visible in the data range. All other cells will be hidden.|
+||Represents a filter which can filter data based on whether the data is below or above the average of the entire data range.|
+||Represents a filter which can filter dates in a Month, or quarter of any year.|
+||Represents a filter which will filter cells based on their background fills. This filter specifies a single CellFill. Cells of with this fill will be visible in the data range. All other cells will be hidden.|
|`ApplyFixedValuesFilter`|Represents a filter which can filter cells based on specific, fixed values, which are allowed to display.|
-|`ApplyFontColorFilter`|Represents a filter which will filter cells based on their font colors. This filter specifies a single color. Cells with this color font will be visible in the data range. All other cells will be hidden.|
-|`ApplyIconFilter`|Represents a filter which can filter cells based on their conditional formatting icon.|
-|`ApplyRelativeDateRangeFilter`|Represents a filter which can filter date cells based on dates relative to the when the filter was applied.|
-|`ApplyTopOrBottomFilter`|Represents a filter which can filter in cells in the upper or lower portion of the sorted values.|
-|`ApplyYearToDateFilter`|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.|
-|`ApplyCustomFilter`|Represents a filter which can filter data based on one or two custom conditions. These two filter conditions can be combined with a logical "and" or a logical "or" operation.|
+||Represents a filter which will filter cells based on their font colors. This filter specifies a single color. Cells with this color font will be visible in the data range. All other cells will be hidden.|
+||Represents a filter which can filter cells based on their conditional formatting icon.|
+||Represents a filter which can filter date cells based on dates relative to the when the filter was applied.|
+||Represents a filter which can filter in cells in the upper or lower portion of the sorted values.|
+||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.|
+||Represents a filter which can filter data based on one or two custom conditions. These two filter conditions can be combined with a logical "and" or a logical "or" operation.|
You can use the following code snippet as an example to add a filter to a worksheet region:
@@ -151,7 +151,7 @@ worksheet.filterSettings.applyAverageFilter(0, AverageFilterType.AboveAverage);
## Freezing and Splitting Panes
You can freeze rows at the top of your worksheet or columns at the left using the freezing panes features. Frozen rows and columns remain visible at all times while the user is scrolling. The frozen rows and columns are separated from the rest of the worksheet by a single, solid line, which cannot be removed.
-In order to enable pane freezing, you need to set the property of the object's to **true**. You can then specify the rows or columns to freeze by using the `FrozenRows` and `FrozenColumns` properties of the display options `FrozenPaneSettings`, respectively.
+In order to enable pane freezing, you need to set the property of the object's to **true**. You can then specify the rows or columns to freeze by using the `FrozenRows` and `FrozenColumns` properties of the display options , respectively.
You can also specify the first row in the bottom pane or first column in the right pane using the `FirstRowInBottomPane` and `FirstColumnInRightPane` properties, respectively.
@@ -192,7 +192,7 @@ Sorting is done by setting a sorting condition on a worksheet level object on ei
This is done by specifying a region and sort type to the object's that can be retrieved using the property of the sheet.
-The sort conditions in a sheet are only reapplied when sort conditions are added, removed, modified, or when the `ReapplySortConditions` method is called on the worksheet. Columns or rows will be sorted within the region. "Rows" is the default sort type.
+The sort conditions in a sheet are only reapplied when sort conditions are added, removed, modified, or when the method is called on the worksheet. Columns or rows will be sorted within the region. "Rows" is the default sort type.
The following code snippet demonstrates how to apply a sort to a region of cells in a worksheet:
@@ -206,7 +206,7 @@ worksheet.sortSettings.sortConditions().addItem(new RelativeIndex(0), new Ordere
## Worksheet Protection
-You can protect a worksheet by calling the `Protect` method on the object. This method exposes many nullable `bool` parameters that allow you to restrict or allow the following user operations:
+You can protect a worksheet by calling the method on the object. This method exposes many nullable `bool` parameters that allow you to restrict or allow the following user operations:
- Editing of cells.
- Editing of objects such as shapes, comments, charts, or other controls.
@@ -219,7 +219,7 @@ You can protect a worksheet by calling the `Protect` method on the object.
+You can remove worksheet protection by calling the method on the object.
The following code snippet shows how to enable protection of all of the above-listed user operations:
@@ -234,11 +234,11 @@ worksheet.protect();
## Worksheet Conditional Formatting
-You can configure the conditional formatting of a object by using the many "Add" methods exposed on the `ConditionalFormats` collection of that worksheet. The first parameter of these "Add" methods is the `string` region of the worksheet that you would like to apply the conditional format to.
+You can configure the conditional formatting of a object by using the many "Add" methods exposed on the collection of that worksheet. The first parameter of these "Add" methods is the `string` region of the worksheet that you would like to apply the conditional format to.
-Many of the conditional formats that you can add to your worksheet have a property that determines the way that the elements should look when the condition in that conditional format holds true. For example, you can use the properties attached to this property such as `Fill` and `Font` to determine the background and font settings of your cells under a particular conditional format, respectively.
+Many of the conditional formats that you can add to your worksheet have a property that determines the way that the elements should look when the condition in that conditional format holds true. For example, you can use the properties attached to this property such as and to determine the background and font settings of your cells under a particular conditional format, respectively.
-There are a few conditional formats that do not have a property, as their visualization on the worksheet cell behaves differently. These conditional formats are the , , and `IconSetConditionalFormat`.
+There are a few conditional formats that do not have a property, as their visualization on the worksheet cell behaves differently. These conditional formats are the , , and .
When loading a pre-existing from Excel, the formats will be preserved when that is loaded. The same is true for when you save the out to an Excel file.
diff --git a/docs/angular/src/content/en/components/general-changelog-dv.mdx b/docs/angular/src/content/en/components/general-changelog-dv.mdx
index 9e15069d08..e31584c1a9 100644
--- a/docs/angular/src/content/en/components/general-changelog-dv.mdx
+++ b/docs/angular/src/content/en/components/general-changelog-dv.mdx
@@ -15,6 +15,8 @@ import chartdefaults3 from '@xplat-images/chartDefaults3.png';
import chartdefaults4 from '@xplat-images/chartDefaults4.png';
import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# Ignite UI for Angular Changelog
All notable changes for each version of Ignite UI for Angular are documented on this page.
@@ -76,9 +78,9 @@ Added OthersCategoryBrush and OthersCategoryOutline to DataPieChart and Proporti
#### User Annotations
-In Ignite UI for Angular, you can now annotate the `DataChart` with slice, strip, and point annotations at runtime using the new user annotations feature. This allows the end user to add more details to the plot such as calling out single important events such as company quarter reports by using the slice annotation or events that have a duration by using the strip annotation. You can also call out individual points on the plotted series by using the point annotation or any combination of these three.
+In Ignite UI for Angular, you can now annotate the with slice, strip, and point annotations at runtime using the new user annotations feature. This allows the end user to add more details to the plot such as calling out single important events such as company quarter reports by using the slice annotation or events that have a duration by using the strip annotation. You can also call out individual points on the plotted series by using the point annotation or any combination of these three.
-This is directly integrated with the available tools of the `Toolbar`.
+This is directly integrated with the available tools of the .
@@ -86,8 +88,8 @@ This is directly integrated with the available tools of the `Toolbar`.
Ability for axis annotations to automatically detect collisions and truncate to fit better. To enable this feature you must set the following properties:
-- `ShouldAvoidAnnotationCollisions`
-- `ShouldAutoTruncateAnnotations`
+-
+-
### igniteui-angular-maps (Geographic Map)
@@ -129,37 +131,37 @@ The following events have been added to the `IgxDataChart` to allow you to detec
#### Companion Axis
-Added `CompanionAxis` properties to the X and Y axis that allow you to quickly create a clone of an existing axis. When enabled using the `CompanionAxisEnabled` property, this will default the cloned axis to the opposite position of the chart and you can then configure that axes' properties.
+Added `CompanionAxis` properties to the X and Y axis that allow you to quickly create a clone of an existing axis. When enabled using the property, this will default the cloned axis to the opposite position of the chart and you can then configure that axes' properties.
#### RadialPieSeries Inset Outlines
-There is a new property called `UseInsetOutlines` to control how outlines on the `RadialPieSeries` are rendered. Setting this value to **true** will inset the outlines within the slice shape, whereas a **false** (default) value will place the outlines half-in half-out along the edge of the slice shape.
+There is a new property called to control how outlines on the are rendered. Setting this value to **true** will inset the outlines within the slice shape, whereas a **false** (default) value will place the outlines half-in half-out along the edge of the slice shape.
**Breaking Changes**
-- A fix was made due to an issue where the `PlotAreaPosition` and `ChartPosition` properties on `ChartMouseEventArgs` class were reversed. This will change the values that `PlotAreaPosition` and `ChartPosition` return.
+- A fix was made due to an issue where the and properties on class were reversed. This will change the values that and return.
### Enhancements
#### IgxBulletGraph
-- Added new `LabelsVisible` property
+- Added new property
#### Charts
- New properties added to the DataToolTipLayer, ItemToolTipLayer, and CategoryToolTipLayer to aid in styling: `ToolTipBackground`, `ToolTipBorderBrush`, and `ToolTipBorderThickness`
-- New properties added to the DataLegend to aid in styling: `ContentBackground`, `ContentBorderBrush`, and `ContentBorderThickness`. The `ContentBorderBrush` and `ContentBorderThickness` default to transparent and 0 respectively, so in order to see these borders, you will need to set these properties.
+- New properties added to the DataLegend to aid in styling: , , and . The and default to transparent and 0 respectively, so in order to see these borders, you will need to set these properties.
-- Added a new property to `ChartMouseEventArgs` called `WorldPosition` that provides the world relative position of the mouse. This position will be a value between 0 and 1 for both the X and Y axis within the axis space.
+- Added a new property to called that provides the world relative position of the mouse. This position will be a value between 0 and 1 for both the X and Y axis within the axis space.
-- Added `HighlightingFadeOpacity` to `SeriesViewer` and `DomainChart`. This allows you to configure the opacity applied to highlighted series.
+- Added to and . This allows you to configure the opacity applied to highlighted series.
- Expose `CalloutLabelUpdating` event for domain charts.
#### IgxLinearGauge
-- Added new `LabelsVisible` property
+- Added new property
### Bug Fixes
@@ -209,11 +211,11 @@ For more details please visit:
- Data Annotation Slice Layer
- Data Annotation Strip Layer
-- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose `LayoutMode` property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
+- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
-- The `DefaultInteraction` property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
+- The property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
-- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an `OverlayText` property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
+- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
- [Trendline Layer](charts/features/chart-trendlines.md) series type that allows you to apply a single trend line per trend line layer to a particular series. This allows the usage of multiple trend lines on a single series since you can have multiple [TrendlineLayer](charts/features/chart-overlays.md) series types in the chart.
@@ -250,9 +252,9 @@ For more details please visit:
#### Toolbar
-- Added new `GroupHeaderTextStyle` property to `Toolbar` and `ToolPanel`. If set, it will apply to all `ToolActionGroupHeader` actions.
-- Added new property on `ToolAction` called `TitleHorizontalAlignment` which controls the horizontal alignment of the title text.
-- Added new property on `ToolActionSubPanel` called `ItemSpacing` which controls the spacing between items inside the panel.
+- Added new `GroupHeaderTextStyle` property to and . If set, it will apply to all actions.
+- Added new property on called which controls the horizontal alignment of the title text.
+- Added new property on called which controls the spacing between items inside the panel.
### Bug Fixes
@@ -290,11 +292,11 @@ The following table lists the bug fixes made for the Ignite UI for Angular tools
## **18.1.0 (September 2024)**
-- [Data Pie Chart](charts/types/data-pie-chart.md) - The `DataPieChart` is a new component that renders a pie chart. This component works similarly to the `CategoryChart`, in that it will automatically detect the properties on your underlying data model while allowing selection, highlighting, animation and legend support via the ItemLegend component.
+- [Data Pie Chart](charts/types/data-pie-chart.md) - The is a new component that renders a pie chart. This component works similarly to the , in that it will automatically detect the properties on your underlying data model while allowing selection, highlighting, animation and legend support via the ItemLegend component.
-- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `DataChart`, to plot slices similar to a pie chart, a type of data visualization where data points are represented as segments within a circular graph.
+- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the , to plot slices similar to a pie chart, a type of data visualization where data points are represented as segments within a circular graph.
-- `Toolbar`
+-
- New ToolActionCheckboxList
A new CheckboxList ToolAction that displays a collection of items with checkboxes for selecting. A grid inside ToolAction CheckboxList grows in height up to 5 items, then a scrollbar is displayed.
@@ -313,67 +315,67 @@ The following table lists the bug fixes made for the Ignite UI for Angular tools
### igniteui-angular-charts (Charts)
-- [Data Legend Grouping](charts/features/chart-data-legend.md#angular-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#angular-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property `GroupRowVisible` toggles grouping with each series opting in can assign group text via the `DataLegendGroup` property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users.
+- [Data Legend Grouping](charts/features/chart-data-legend.md#angular-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#angular-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property toggles grouping with each series opting in can assign group text via the property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users.
-- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for `CategoryChart` and `DataChart`. Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and `SelectedSeriesItems` are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
+- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for and . Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
-- [Treemap Highlighting](charts/types/treemap-chart.md#angular-treemap-highlighting) - Now exposes a `HighlightingMode` property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the `HighlightingTransitionDuration` property.
+- [Treemap Highlighting](charts/types/treemap-chart.md#angular-treemap-highlighting) - Now exposes a property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the property.
-- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#angular-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new `HighlightedItemsSource`. Can be toggled via `HighlightedValuesDisplayMode` and styled via `FillBrushes`.
+- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#angular-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new . Can be toggled via and styled via `FillBrushes`.
-- `Toolbar` - New `IsHighlighted` option for ToolAction for outlining a border around specific tools of choice.
+- - New option for ToolAction for outlining a border around specific tools of choice.
### igniteui-angular-gauges (Gauges)
-- `RadialGauge`
- - New label for the highlight needle. `HighlightLabelText` and `HighlightLabelSnapsToNeedlePivot` and many other styling related properties for the HighlightLabel were added.
+-
+ - New label for the highlight needle. and and many other styling related properties for the HighlightLabel were added.
## **17.3.0 (March 2024)**
### igniteui-angular-charts
-- New Data Filtering via the `InitialFilter` property. Apply filter expressions to filter the chart data to a subset of records. Can be used for drill down large data.
+- New Data Filtering via the property. Apply filter expressions to filter the chart data to a subset of records. Can be used for drill down large data.
- `RadialChart`
- New Label Mode
- The `CategoryAngleAxis` for the now exposes a `LabelMode` property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
+ The for the now exposes a property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
### igniteui-angular-gauges
-- `RadialGauge`
- - New title/subtitle properties. `TitleText`, `SubtitleText` will appear near the bottom the gauge. In addition, the various title/subtitle font properties were added such as `TitleFontSize`, `TitleFontFamily`, `TitleFontStyle`, `TitleFontWeight` and `TitleExtent`. Finally, the new `TitleDisplaysValue` will allow the value to correspond with the needle's position.
- - New `OpticalScalingEnabled` and `OpticalScalingSize` properties for the `RadialGauge`. This new feature will manage the size at which labels, titles, and subtitles of the gauge have 100% optical scaling. You can read more about this new feature in this [topic](radial-gauge.md#optical-scaling)
- - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
-- `LinearGauge`
- - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
-- `BulletGraph`
- - The Performance bar will now reflect a difference between the value and new `HighlightValue` when the `HighlightValueDisplayMode` is applied to the 'Overlay' setting. The highlight value will show a filtered/subset completed measured percentage as a filled in color while the remaining bar's appearance will appear faded to the assigned value, illustrating the performance in real-time.
+-
+ - New title/subtitle properties. , will appear near the bottom the gauge. In addition, the various title/subtitle font properties were added such as `TitleFontSize`, `TitleFontFamily`, `TitleFontStyle`, `TitleFontWeight` and . Finally, the new will allow the value to correspond with the needle's position.
+ - New and properties for the . This new feature will manage the size at which labels, titles, and subtitles of the gauge have 100% optical scaling. You can read more about this new feature in this [topic](radial-gauge.md#optical-scaling)
+ - New highlight needle was added. and when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
+-
+ - New highlight needle was added. and when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
+-
+ - The Performance bar will now reflect a difference between the value and new when the is applied to the 'Overlay' setting. The highlight value will show a filtered/subset completed measured percentage as a filled in color while the remaining bar's appearance will appear faded to the assigned value, illustrating the performance in real-time.
## **17.2.0 (January 2024)**
### igniteui-angular-charts (Charts)
-- [Chart Highlight Filter](charts/features/chart-highlight-filter.md) - The `CategoryChart` and `DataChart` now expose a way to highlight and animate in and out of a subset of data. The display of this highlight depends on the series type. For column and area series, the subset will be shown on top of the total set of data where the subset will be colored by the actual brush of the series, and the total set will have a reduced opacity. For line series, the subset will be shown as a dotted line.
+- [Chart Highlight Filter](charts/features/chart-highlight-filter.md) - The and now expose a way to highlight and animate in and out of a subset of data. The display of this highlight depends on the series type. For column and area series, the subset will be shown on top of the total set of data where the subset will be colored by the actual brush of the series, and the total set will have a reduced opacity. For line series, the subset will be shown as a dotted line.
## **17.0.0 (November 2023)**
### igniteui-angular - Toolbar -
- Save tool action has been added to save the chart to an image via the clipboard.
-- Vertical orientation has been added via the toolbar's `Orientation` property. By default the toolbar is horizontal, now the toolbar can be shown in vertical orientation where the tools will popup to the left/right respectfully.
+- Vertical orientation has been added via the toolbar's property. By default the toolbar is horizontal, now the toolbar can be shown in vertical orientation where the tools will popup to the left/right respectfully.
- Custom SVG icons support was added via the toolbar's `renderImageFromText` method, further enhancing custom tool creation.
## **16.1.0 (June 2023)**
### New Components
-- [Toolbar](menus/toolbar.md) - This component is a companion container for UI operations to be used primarily with our charting components. The toolbar will dynamically update with a preset of properties and tool items when linked to our `DataChart` or `CategoryChart` components. You'll be able to create custom tools for your project allowing end users to provide changes, offering an endless amount of customization.
+- [Toolbar](menus/toolbar.md) - This component is a companion container for UI operations to be used primarily with our charting components. The toolbar will dynamically update with a preset of properties and tool items when linked to our or components. You'll be able to create custom tools for your project allowing end users to provide changes, offering an endless amount of customization.
### igniteui-angular-charts (Charts)
-- [ValueLayer](charts/features/chart-overlays.md#angular-value-layer) - A new series type named the `ValueLayer` is now exposed which can allow you to render an overlay for different focal points of the plotted data such as Maximum, Minimum, and Average. This is applied to the `CategoryChart` and `FinancialChart` by adding to the new `ValueLines` collection.
+- [ValueLayer](charts/features/chart-overlays.md#angular-value-layer) - A new series type named the is now exposed which can allow you to render an overlay for different focal points of the plotted data such as Maximum, Minimum, and Average. This is applied to the and by adding to the new collection.
-- It is now possible to apply a **dash array** to the different parts of the series of the `DataChart`. You can apply this to the [series](charts/types/line-chart.md#angular-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#angular-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#angular-chart-trendlines-dash-array-example) of the series plotted in the chart.
+- It is now possible to apply a **dash array** to the different parts of the series of the . You can apply this to the [series](charts/types/line-chart.md#angular-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#angular-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#angular-chart-trendlines-dash-array-example) of the series plotted in the chart.
## **16.0.0 (May 2023)**
- Angular 16 support.
@@ -388,7 +390,7 @@ Added significant improvements to default behaviors, and refined the Category Ch
- Responsive layouts for horizontal label rotation based on browser / screen size.
- Enhanced rendering for rounded labels on all platforms.
- Added marker properties to StackedFragmentSeries.
-- Added `ShouldPanOnMaximumZoom` property.
+- Added property.
- New Category Axis Properties:
- ZoomMaximumCategoryRange
- ZoomMaximumItemSpan
@@ -409,25 +411,25 @@ Added significant improvements to default behaviors, and refined the Category Ch
- GroupSortDescriptions
-The Chart's [Aggregation](charts/features/chart-data-aggregations.md) will not work when using `IncludedProperties` | `ExcludedProperties` because these properties are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
+The Chart's [Aggregation](charts/features/chart-data-aggregations.md) will not work when using | because these properties are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
## **13.2.0 (June 2022)**
### igniteui-angular-charts (Charts)
-- Added the highly-configurable [DataLegend](charts/features/chart-data-legend.md) component, which works much like the `Legend`, but it shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values.
+- Added the highly-configurable [DataLegend](charts/features/chart-data-legend.md) component, which works much like the , but it shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values.
- Added the highly-configurable [DataToolTip](charts/features/chart-data-tooltip.md) which displays values and titles of series as well as legend badges of series in a tooltip. This is now the default tooltip for all chart types.
-- Added animation and transition-in support for Stacked Series. Animations can be enabled by setting the `IsTransitionInEnabled` property to true. From there, you can set the `TransitionInDuration` property to determine how long your animation should take to complete and the `TransitionInMode` to determine the type of animation that takes place.
-- Added `AssigningCategoryStyle` event, is now available to all series in `DataChart`. This event is handled when you want to conditionally configure aspects of the series items such as `Fill` background-color and highlighting.
-- New `AllowedPositions` enumeration for CalloutLayer. Used to limit where the callouts are to be placed within the chart. By default, the callouts are intelligently placed in the best place but this used to force for example `TopLeft`, `TopRight`, `BottomLeft` or `BottomRight`.
+- Added animation and transition-in support for Stacked Series. Animations can be enabled by setting the property to true. From there, you can set the property to determine how long your animation should take to complete and the to determine the type of animation that takes place.
+- Added `AssigningCategoryStyle` event, is now available to all series in . This event is handled when you want to conditionally configure aspects of the series items such as background-color and highlighting.
+- New enumeration for CalloutLayer. Used to limit where the callouts are to be placed within the chart. By default, the callouts are intelligently placed in the best place but this used to force for example `TopLeft`, `TopRight`, `BottomLeft` or `BottomRight`.
- New corner radius properties added for Annotation Layers; used to round-out the corners of each of the callouts. Note, a corner radius has now been added by default.
- - `CalloutCornerRadius` for CalloutLayer
- - `AxisAnnotationBackgroundCornerRadius` for FinalValueLayer
- - `XAxisAnnotationBackgroundCornerRadius` and `YAxisAnnotationBackgroundCornerRadius` for CrosshairLayer
-- New `HorizontalViewScrollbarMode` and `VerticalViewScrollbarMode` enumeration to enable scrollbars in various ways. When paired with `IsVerticalZoomEnabled` or `IsHorizontalZoomEnabled`, you'll be able to persist or fade-in and out the scrollbars along the axes to navigate the chart.
-- New `FavorLabellingScaleEnd`, determines whether the axis should favor emitting a label at the end of the scale. Only compatible with numeric axes (e.g. `NumericXAxis`, `NumericYAxis`, `PercentChangeAxis`).
-- New `IsSplineShapePartOfRange` determines whether to include the spline shape in the axis range requested of the axis.
-- New `XAxisMaximumGap`, determines the maximum allowed value for the plotted series when using `XAxisGap`. The gap determines the amount of space between columns or bars of plotted series.
-- New `XAxisMinimumGapSize`, determines the minimum allowed pixel-based value for the plotted series when using `XAxisGap` to ensure there is always some spacing between each category.
+ - for CalloutLayer
+ - for FinalValueLayer
+ - and for CrosshairLayer
+- New and enumeration to enable scrollbars in various ways. When paired with or , you'll be able to persist or fade-in and out the scrollbars along the axes to navigate the chart.
+- New , determines whether the axis should favor emitting a label at the end of the scale. Only compatible with numeric axes (e.g. , , `PercentChangeAxis`).
+- New determines whether to include the spline shape in the axis range requested of the axis.
+- New , determines the maximum allowed value for the plotted series when using . The gap determines the amount of space between columns or bars of plotted series.
+- New , determines the minimum allowed pixel-based value for the plotted series when using to ensure there is always some spacing between each category.
@@ -441,29 +443,29 @@ Please ensure package "lit-html": "^2.0.0" or newer is added to your project for
This release introduces a few improvements and simplifications to visual design and configuration options for the geographic map and all chart components.
-- Changed `YAxisLabelLocation` property's type to **YAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart` and `CategoryChart`
-- Changed `XAxisLabelLocation` property's type to **XAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart`
-- Added `XAxisLabelLocation` property to `CategoryChart`
-- Added support for representing geographic series of `GeographicMap` in a legend
-- Added crosshair lines by default in `FinancialChart` and `CategoryChart`
-- Added crosshair annotations by default in `FinancialChart` and `CategoryChart`
-- Added final value annotation by default in `FinancialChart`
+- Changed property's type to **YAxisLabelLocation** from **AxisLabelLocation** in and
+- Changed property's type to **XAxisLabelLocation** from **AxisLabelLocation** in
+- Added property to
+- Added support for representing geographic series of in a legend
+- Added crosshair lines by default in and
+- Added crosshair annotations by default in and
+- Added final value annotation by default in
- Added new properties in Category Chart and Financial Chart:
- - `CrosshairsLineThickness` and other properties for customizing crosshairs lines
- - `CrosshairsAnnotationXAxisBackground` and other properties for customizing crosshairs annotations
- - `FinalValueAnnotationsBackground` and other properties for customizing final value annotations
- - `AreaFillOpacity` that allow changing opacity of series fill (e.g. Area chart)
- - `MarkerThickness` that allows changing thickness of markers
+ - and other properties for customizing crosshairs lines
+ - and other properties for customizing crosshairs annotations
+ - and other properties for customizing final value annotations
+ - that allow changing opacity of series fill (e.g. Area chart)
+ - that allows changing thickness of markers
- Added new properties in Category Chart, Financial Chart, Data Chart, and Geographic Map:
- - `MarkerAutomaticBehavior` that allows which marker type is assigned to multiple series in the same chart
- - `LegendItemBadgeShape` for setting badge shape of all series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on all series in a legend
+ - that allows which marker type is assigned to multiple series in the same chart
+ - for setting badge shape of all series represented in a legend
+ - for setting badge complexity on all series in a legend
- Added new properties in Series in Data Chart and Geographic Map:
- - `LegendItemBadgeShape` for setting badge shape on specific series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on specific series in a legend
+ - for setting badge shape on specific series represented in a legend
+ - for setting badge complexity on specific series in a legend
- Changed default vertical crosshair line stroke from #000000 to #BBBBBB in category chart and series
-- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's `MarkerAutomaticBehavior` property to `SmartIndexed` enum value
-- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's `LegendItemBadgeMode` property to `MatchSeries` enum value
+- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's property to `SmartIndexed` enum value
+- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's property to `MatchSeries` enum value
- Changed color palette of series and markers displayed in all charts to improve accessibility
| Old brushes/outlines | New outline/brushes |
@@ -475,30 +477,30 @@ This release introduces a few improvements and simplifications to visual design
## **11.2.0 (April 2021)**
### igniteui-angular-charts (Charts)
-This release introduces several new and improved visual design and configuration options for all of the chart components, e.g. `DataChart`, `CategoryChart`, and `FinancialChart`.
+This release introduces several new and improved visual design and configuration options for all of the chart components, e.g. , , and .
- Changed Bar/Column/Waterfall series to have square corners instead of rounded corners
- Changed Scatter High Density series’ colors for heat min property from #8a5bb1 to #000000
- Changed Scatter High Density series’ colors for heat max property from #ee5879 to #ee5879
- Changed Financial/Waterfall series’ `NegativeBrush` and `NegativeOutline` properties from #C62828 to #ee5879
- Changed marker's thickness to 2px from 1px
-- Changed marker's fill to match the marker's outline for `PointSeries`, `BubbleSeries`, `ScatterSeries`, `PolarScatterSeries`. You can use set `MarkerFillMode` property to Normal to undo this change
-- Compressed labelling for the `TimeXAxis` and `OrdinalTimeXAxis`
+- Changed marker's fill to match the marker's outline for , , , . You can use set property to Normal to undo this change
+- Compressed labelling for the and
- New Marker Properties:
- - series.`MarkerFillMode` - Can be set to `MatchMarkerOutline` so the marker depends on the outline
- - series.`MarkerFillOpacity` - Can be set to a value 0 to 1
- - series.`MarkerOutlineMode` - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
+ - series. - Can be set to `MatchMarkerOutline` so the marker depends on the outline
+ - series. - Can be set to a value 0 to 1
+ - series. - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
- New Series Property:
- - series.`OutlineMode` - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
-- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the `ComputedPlotAreaMarginMode`, listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
- - chart.`PlotAreaMarginLeft`
- - chart.`PlotAreaMarginTop`
- - chart.`PlotAreaMarginRight`
- - chart.`PlotAreaMarginBottom`
- - chart.`ComputedPlotAreaMarginMode`
+ - series. - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
+- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the , listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
+ - chart.
+ - chart.
+ - chart.
+ - chart.
+ - chart.
- New Highlighting Properties
- - chart.`HighlightingMode` - Sets whether hovered or non-hovered series to fade, brighten
- - chart.`HighlightingBehavior` - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
+ - chart. - Sets whether hovered or non-hovered series to fade, brighten
+ - chart. - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
- Note, in previous releases the highlighting was limited to fade on hover.
- Added Highlighting Stacked, Scatter, Polar, Radial, and Shape series:
- Added Annotation layers to Stacked, Scatter, Polar, Radial, and Shape series:
@@ -521,8 +523,8 @@ for example:
#### Chart Legend
-- Added horizontal `Orientation` property to ItemLegend that can be used with Bubble, Donut, and Pie Chart
-- Added `LegendHighlightingMode` property - Enables series highlighting when hovering over legend items
+- Added horizontal property to ItemLegend that can be used with Bubble, Donut, and Pie Chart
+- Added property - Enables series highlighting when hovering over legend items
### igniteui-angular-maps (GeoMap)
diff --git a/docs/angular/src/content/en/components/general/cli/getting-started-with-angular-schematics.mdx b/docs/angular/src/content/en/components/general/cli/getting-started-with-angular-schematics.mdx
index d28f4884ca..43e88ff780 100644
--- a/docs/angular/src/content/en/components/general/cli/getting-started-with-angular-schematics.mdx
+++ b/docs/angular/src/content/en/components/general/cli/getting-started-with-angular-schematics.mdx
@@ -301,7 +301,7 @@ The schematic writes (or merges into) the config file for your chosen coding ass
Skill files are Angular-specific guides copied into each agent's skills directory. They are sourced from your installed Ignite UI package and kept in sync each time you run the schematic - existing files are only updated if their content has changed.
-
+
If you run `ai-config` before installing packages (e.g. with `--skip-install`), the schematic falls back to built-in templates. Re-run the command after installing to pick up the skill files from your installed version.
@@ -313,7 +313,7 @@ If you have the Ignite UI CLI installed globally, the equivalent command is:
ig ai-config
```
-
+
The `ig ai-config` command configures only the two Ignite UI entries, `igniteui-cli` and `igniteui-theming`, and does not register `angular-cli`. Use `ng generate @igniteui/angular-schematics:ai-config` to get all three servers configured in a single step.
diff --git a/docs/angular/src/content/en/components/general/cli/step-by-step-guide-using-angular-schematics.mdx b/docs/angular/src/content/en/components/general/cli/step-by-step-guide-using-angular-schematics.mdx
index d50467c870..7781e2ad9d 100644
--- a/docs/angular/src/content/en/components/general/cli/step-by-step-guide-using-angular-schematics.mdx
+++ b/docs/angular/src/content/en/components/general/cli/step-by-step-guide-using-angular-schematics.mdx
@@ -149,7 +149,7 @@ The default selections are **Generic** and **Claude**. Selecting **None** skips
When run via the Angular schematic, an additional `angular-cli` MCP server entry is included automatically alongside the Ignite UI servers.
-
+
To skip AI configuration prompts entirely during non-interactive project creation, pass `--assistants none --agents none` to `ng new`. To re-run AI configuration later, use `ng generate @igniteui/angular-schematics:ai-config` from the project root.
diff --git a/docs/angular/src/content/en/components/general/cli/step-by-step-guide-using-cli.mdx b/docs/angular/src/content/en/components/general/cli/step-by-step-guide-using-cli.mdx
index 777abf2b4e..29b3da7f85 100644
--- a/docs/angular/src/content/en/components/general/cli/step-by-step-guide-using-cli.mdx
+++ b/docs/angular/src/content/en/components/general/cli/step-by-step-guide-using-cli.mdx
@@ -133,6 +133,6 @@ Next, you will be prompted to select which AI agents to configure skill files an
The default selections are **Generic** and **Claude**. Selecting **None** skips agent configuration entirely.
-
+
To skip AI configuration prompts entirely during non-interactive project creation, pass `--assistants none --agents none` to `ig new`. To re-run AI configuration later, use `ig ai-config` from the project root.
diff --git a/docs/angular/src/content/en/components/general/localization.mdx b/docs/angular/src/content/en/components/general/localization.mdx
index a756d04581..116e50b186 100644
--- a/docs/angular/src/content/en/components/general/localization.mdx
+++ b/docs/angular/src/content/en/components/general/localization.mdx
@@ -11,7 +11,7 @@ import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro'
## Localization (i18n)
-
+
As of 21.1.0 this is the recommended way of applying localization to the Ignite UI for Angular components.
@@ -23,7 +23,7 @@ Currently, Ignite UI for Angular ships with resource strings for the following l
-
+
Hindi (HI) included in the sample is only for illustrational purposes and to emphasize on the possibility to pass a custom localization object. In this sample, it contains only several localized strings for the summary. More details at [Custom localized resource strings](#custom-localized-resource-strings) section below.
@@ -51,7 +51,7 @@ In general you should register your resources under the languages, regions and s
With this approach we have the ability to set localization through the `lang` global attribute of the `HTML` tag. This attribute is being watched and if it is changed, all rendered components will update their resource strings to the currently set language. All rules regarding the tag used apply as described above.
-
+
This works only on root level and will not work for inner elements on the page.
@@ -243,7 +243,7 @@ public resourcesDE = GridResourceStringsDE;
If you would like to localize your app, but we do not provide resource strings for the language you use and would like to provide your own translation, you can always provide custom resource string. You can do that globally or per component(using the `resourceStrings` property).
-
+
Feel free to contribute to the [`igniteui-i18n-resources`](https://github.com/IgniteUI/igniteui-i18n/tree/master/projects/igniteui-i18n-resources) package with more languages. The `igniteui-angular-i18n` are based on them.
@@ -293,7 +293,7 @@ registerI18n(customResources, 'en');
```
-
+
The last examples set only specific resource strings. This means that the rest will default to English, if they are not available for the components in use to get.
@@ -322,7 +322,7 @@ The last examples set only specific resource strings. This means that the rest w
## Legacy Localization (i18n)
-
+
This is an old way of handling localization that was recommended until 21.0.x. We suggest using the new available way above if you are using newer versions. This will still work until further notice.
@@ -334,7 +334,7 @@ With only a few lines of code, users can easily change the localization strings
-
+
Hindi (HI) included in the sample is only for illustrational purposes and to emphasize on the possibility to pass a custom localization object. In this sample, it contains only several localized strings for the summary. More details at [Utilize own localized resources](#utilize-own-localized-resources) section below.
@@ -410,7 +410,7 @@ export class AppComponent implements OnInit {
}
```
-
+
Feel free to contribute to the [`igniteui-angular-i18n`](https://github.com/IgniteUI/igniteui-angular/tree/master/projects/igniteui-angular-i18n) package with more languages!
diff --git a/docs/angular/src/content/en/components/geo-map-binding-data-model.mdx b/docs/angular/src/content/en/components/geo-map-binding-data-model.mdx
index 18be1b6724..ed3cf2101c 100644
--- a/docs/angular/src/content/en/components/geo-map-binding-data-model.mdx
+++ b/docs/angular/src/content/en/components/geo-map-binding-data-model.mdx
@@ -27,13 +27,13 @@ The following table summarized data structures required for each type of geograp
| Geographic Series | Properties | Description |
|--------------|---------------| ---------------|
-| | `LongitudeMemberPath`, `LatitudeMemberPath` | Specifies names of 2 numeric longitude and latitude coordinates |
-| | `LongitudeMemberPath`, `LatitudeMemberPath` | Specifies names of 2 numeric longitude and latitude coordinates |
-| | `LongitudeMemberPath`, `LatitudeMemberPath`, `RadiusMemberPath` | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for size/radius of symbols |
-| | `LongitudeMemberPath`, `LatitudeMemberPath`, `ColorMemberPath` | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for triangulation of values |
-| | `LongitudeMemberPath`, `LatitudeMemberPath`, `ValueMemberPath` | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for triangulation of values |
-||`ShapeMemberPath`|Specifies the name of data column of items that contains the geographic points of shapes. This property must be mapped to an array of arrays of objects with x and y properties. |
-||`ShapeMemberPath`|Specifies the name of data column of items that contains the geographic coordinates of lines. This property must be mapped to an array of arrays of objects with x and y properties. |
+| | , | Specifies names of 2 numeric longitude and latitude coordinates |
+| | , | Specifies names of 2 numeric longitude and latitude coordinates |
+| | , , | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for size/radius of symbols |
+| | , , | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for triangulation of values |
+| | , , | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for triangulation of values |
+|||Specifies the name of data column of items that contains the geographic points of shapes. This property must be mapped to an array of arrays of objects with x and y properties. |
+|||Specifies the name of data column of items that contains the geographic coordinates of lines. This property must be mapped to an array of arrays of objects with x and y properties. |
## Code Snippet
The following code shows how to bind the to a custom data model that contains geographic locations of some cities of the world stored using longitude and latitude coordinates. Also, we use the to plot shortest geographic path between these locations using the [WorldUtility](geo-map-resources-world-util.md)
diff --git a/docs/angular/src/content/en/components/geo-map-display-imagery-types.mdx b/docs/angular/src/content/en/components/geo-map-display-imagery-types.mdx
index 1b3a70a1ab..2aafd2019d 100644
--- a/docs/angular/src/content/en/components/geo-map-display-imagery-types.mdx
+++ b/docs/angular/src/content/en/components/geo-map-display-imagery-types.mdx
@@ -33,7 +33,7 @@ The following table summarizes imagery classes provided by the map component.
||Represents the base control for all imagery classes that display all types of supported geographic imagery tiles. This class can be extended for the purpose of implementing support for geographic imagery tiles from other geographic imagery sources such as Map Quest mapping service.|
||Represents the multi-scale imagery control for displaying geographic imagery tiles from the Open Street Maps service.|
-{/* |`BingMapsMapImagery`|Represents the multi-scale imagery control for displaying geographic imagery tiles from the Bing Maps service.| */}
+{/* ||Represents the multi-scale imagery control for displaying geographic imagery tiles from the Bing Maps service.| */}
By default, the property is set to object and the map component displays geographic imagery tiles from the Open Street Maps service. In order to display different types of geographic imagery tiles, the map component must be re-configured.
@@ -52,6 +52,6 @@ This code example explicitly sets
+
diff --git a/docs/angular/src/content/en/components/geo-map-type-scatter-bubble-series.mdx b/docs/angular/src/content/en/components/geo-map-type-scatter-bubble-series.mdx
index 2a7fd096cc..925c5f5557 100644
--- a/docs/angular/src/content/en/components/geo-map-type-scatter-bubble-series.mdx
+++ b/docs/angular/src/content/en/components/geo-map-type-scatter-bubble-series.mdx
@@ -25,19 +25,19 @@ In Angular map component, you can use the series and how to specify data binding options of the series. Automatic marker selection is configured along with marker collision avoidance logic, and marker outline and fill colors are specified too.
## Configuration Summary
-Similar to other types of scatter series in the map control, the series has the `ItemsSource` property which can be bound to an array of objects. In addition, each data item in the items source must have two data columns that store geographic longitude and latitude coordinates and uses the `LongitudeMemberPath` and `LatitudeMemberPath` properties to map these data columns. The `RadiusScale` and `RadiusMemberPath` will settings configures the radius for the bubbles.
+Similar to other types of scatter series in the map control, the series has the property which can be bound to an array of objects. In addition, each data item in the items source must have two data columns that store geographic longitude and latitude coordinates and uses the and properties to map these data columns. The and will settings configures the radius for the bubbles.
The following table summarizes the GeographicHighDensityScatterSeries series properties used for data binding.
| Property|Type|Description |
| ---|---|--- |
-| `ItemsSource`|any|Gets or sets the items source |
-| `LongitudeMemberPath`|string|Uses the ItemsSource property to determine the location of the longitude values on the assigned items |
-| `LatitudeMemberPath`|string|Uses the ItemsSource property to determine the location of the latitude values on the assigned items |
-| `RadiusMemberPath`|string|Sets the path to use to get the radius values for the series. |
-| `RadiusScale`|`SizeScale`|Gets or sets the radius scale property for the current bubble series. |
-| `MinimumValue`|any|Configure the minimum value for calculating value sub ranges. |
-| `MaximumValue`|any|Configure the maximum value for calculating value sub ranges. |
+| |any|Gets or sets the items source |
+| |string|Uses the ItemsSource property to determine the location of the longitude values on the assigned items |
+| |string|Uses the ItemsSource property to determine the location of the latitude values on the assigned items |
+| |string|Sets the path to use to get the radius values for the series. |
+| ||Gets or sets the radius scale property for the current bubble series. |
+| |any|Configure the minimum value for calculating value sub ranges. |
+| |any|Configure the maximum value for calculating value sub ranges. |
## Code Snippet
@@ -179,4 +179,4 @@ export class MapTypeScatterBubbleSeriesComponent implements AfterViewInit {
## API References
-`RadiusScale`
+
diff --git a/docs/angular/src/content/en/components/geo-map-type-scatter-contour-series.mdx b/docs/angular/src/content/en/components/geo-map-type-scatter-contour-series.mdx
index 6d1b4b1fdf..8163bf42a6 100644
--- a/docs/angular/src/content/en/components/geo-map-type-scatter-contour-series.mdx
+++ b/docs/angular/src/content/en/components/geo-map-type-scatter-contour-series.mdx
@@ -25,33 +25,33 @@ In Angular map component, you can use the works a lot like the except that it represents data as contour lines, colored using a fill scale and the geographic scatter area series, represents data as a surface interpolated using a color scale.
## Data Requirements
-Similar to other types of geographic series in the map component, the has the `ItemsSource` property which can be bound to an array of objects. In addition, each item in the items source must have three data columns, two that store geographic location (longitude and latitude coordinates) and one data column that stores a value associated with the geographic location. These data column, are identified by `LongitudeMemberPath`, `LatitudeMemberPath`, and `ValueMemberPath` properties of the geographic series.
-The `GeographicContourLineSeries` automatically performs built-in data triangulation on items in the ItemsSource if no triangulation is set to the `TrianglesSource` property. However, computing triangulation can be a very time-consuming process, so the runtime performance will be better when specifying a `TriangulationSource` for this property, especially when a large number of data items are present.
+Similar to other types of geographic series in the map component, the has the property which can be bound to an array of objects. In addition, each item in the items source must have three data columns, two that store geographic location (longitude and latitude coordinates) and one data column that stores a value associated with the geographic location. These data column, are identified by , , and properties of the geographic series.
+The automatically performs built-in data triangulation on items in the ItemsSource if no triangulation is set to the property. However, computing triangulation can be a very time-consuming process, so the runtime performance will be better when specifying a `TriangulationSource` for this property, especially when a large number of data items are present.
## Data Binding
-The following table summarizes properties of `GeographicContourLineSeries` used for data binding.
+The following table summarizes properties of used for data binding.
| Property Name | Property Type | Description |
|--------------|---------------| ---------------|
-|`ItemsSource`|any|The source of data items to perform triangulation on if the `TrianglesSource` property provides no triangulation data.|
-|`LongitudeMemberPath`|string|The name of the property containing the Longitude for all items bound to the `ItemsSource`.|
-|`LatitudeMemberPath`|string|The name of the property containing the Latitude for all items bound to to the `ItemsSource`.|
-|`ValueMemberPath`|string|The name of the property containing a value at Latitude and Longitude coordinates of each data item. This numeric value will be be converted to a color when the `FillScale` property is set.|
-|`TrianglesSource`|any|Gets or sets the source of triangulation data. Setting Triangles of the TriangulationSource object to this property improves both runtime performance and geographic series rendering.|
-|`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. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
-|`TriangleVertexMemberPath2`|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. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
-|`TriangleVertexMemberPath3`|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. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
+||any|The source of data items to perform triangulation on if the property provides no triangulation data.|
+||string|The name of the property containing the Longitude for all items bound to the .|
+||string|The name of the property containing the Latitude for all items bound to to the .|
+||string|The name of the property containing a value at Latitude and Longitude coordinates of each data item. This numeric value will be be converted to a color when the property is set.|
+||any|Gets or sets the source of triangulation data. Setting Triangles of the TriangulationSource object to this property improves both runtime performance and geographic series rendering.|
+||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. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
+||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. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
+||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. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
## Contour Fill Scale
-Use the `FillScale` property of the to resolve fill brushes of the contour lines of the geographic series.
+Use the property of the to resolve fill brushes of the contour lines of the geographic series.
The provided `ValueBrushScale class should satisfy most of your coloring needs, but the application for custom coloring logic can inherit the ValueBrushScale class.
The following table list properties of the CustomPaletteColorScale affecting the surface coloring of the GeographicContourLineSeries.
| Property Name | Property Type | Description |
|--------------|---------------| ---------------|
-|`Brushes`|BrushCollection|Gets or sets the collection of brushes for filling contours of the `GeographicContourLineSeries`|
-|`MaximumValue`|double|The highest value to assign a brush in a fill scale.|
-|`MinimumValue`|double|The lowest value to assign a brush in a fill scale.|
+||BrushCollection|Gets or sets the collection of brushes for filling contours of the |
+||double|The highest value to assign a brush in a fill scale.|
+||double|The lowest value to assign a brush in a fill scale.|
## Code Snippet
@@ -180,7 +180,7 @@ export class MapTypeScatterContourSeriesComponent implements AfterViewInit {
## API References
-`FillScale`
+
diff --git a/docs/angular/src/content/en/components/geo-map-type-scatter-density-series.mdx b/docs/angular/src/content/en/components/geo-map-type-scatter-density-series.mdx
index e25a7044a4..763bef0874 100644
--- a/docs/angular/src/content/en/components/geo-map-type-scatter-density-series.mdx
+++ b/docs/angular/src/content/en/components/geo-map-type-scatter-density-series.mdx
@@ -27,30 +27,30 @@ The demo above shows the series has the `ItemsSource` property which can be bound to an array of objects. In addition, each data item in the items source must have two data columns that store geographic longitude and latitude coordinates and uses the `LongitudeMemberPath` and `LatitudeMemberPath` properties to map these data columns.
+Similar to other types of scatter series in the map control, the series has the property which can be bound to an array of objects. In addition, each data item in the items source must have two data columns that store geographic longitude and latitude coordinates and uses the and properties to map these data columns.
### Data Binding
The following table summarizes the GeographicHighDensityScatterSeries series properties used for data binding.
| Property|Type|Description |
| ---|---|--- |
-| `ItemsSource`|any|Gets or sets the items source |
-| `LongitudeMemberPath`|string|Uses the ItemsSource property to determine the location of the longitude values on the assigned items |
-| `LatitudeMemberPath`|string|Uses the ItemsSource property to determine the location of the latitude values on the assigned items |
+| |any|Gets or sets the items source |
+| |string|Uses the ItemsSource property to determine the location of the longitude values on the assigned items |
+| |string|Uses the ItemsSource property to determine the location of the latitude values on the assigned items |
## Heat Color Scale
The Heat Color Scale, an optional feature, determines the color pattern within the series. The following table summarizes the properties used for determining the color scale.
| Property |Type|Description |
| ---|---|--- |
-| `HeatMinimum`|Double|Defines the double value representing the minimum end of the color scale |
-| `HeatMaximum`|Double|Defines the double value representing the maximum end of the color scale |
-| `HeatMinimumColor`|Color|Defines the point density color used at the bottom end of the color scale |
-| `HeatMaximumColor`|Color|Defines the point density color used at the top end of the color scale |
+| |Double|Defines the double value representing the minimum end of the color scale |
+| |Double|Defines the double value representing the maximum end of the color scale |
+| |Color|Defines the point density color used at the bottom end of the color scale |
+| |Color|Defines the point density color used at the top end of the color scale |
## Code Example
-The following code demonstrates how set the `HeatMinimumColor` and `HeatMaximumColor` properties of the
+The following code demonstrates how set the and properties of the
diff --git a/docs/angular/src/content/en/components/grid/grid.mdx b/docs/angular/src/content/en/components/grid/grid.mdx
index eafe4f9b25..8bbfe4278b 100644
--- a/docs/angular/src/content/en/components/grid/grid.mdx
+++ b/docs/angular/src/content/en/components/grid/grid.mdx
@@ -231,7 +231,7 @@ Whenever a header template is used along with grouping/moving functionality the
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/icon-button.mdx b/docs/angular/src/content/en/components/icon-button.mdx
index b8987dc80c..f7760f9334 100644
--- a/docs/angular/src/content/en/components/icon-button.mdx
+++ b/docs/angular/src/content/en/components/icon-button.mdx
@@ -52,7 +52,7 @@ export class HomeComponent {}
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/icon-service.mdx b/docs/angular/src/content/en/components/icon-service.mdx
index bbf8e5162d..79b2fdbdce 100644
--- a/docs/angular/src/content/en/components/icon-service.mdx
+++ b/docs/angular/src/content/en/components/icon-service.mdx
@@ -66,7 +66,7 @@ Having registered the two font families above, we can now consume their icons in
```
-
+
To render icons from the default `material` family with `igx-icon`, add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/inputs/color-editor.mdx b/docs/angular/src/content/en/components/inputs/color-editor.mdx
index 694935776f..c5b1a0c220 100644
--- a/docs/angular/src/content/en/components/inputs/color-editor.mdx
+++ b/docs/angular/src/content/en/components/inputs/color-editor.mdx
@@ -31,7 +31,7 @@ npm install igniteui-angular-core
npm install igniteui-angular-inputs
```
-Before using the , you need to register the following modules as follows:
+Before using the `ColorEditor`, you need to register the following modules as follows:
@@ -47,7 +47,7 @@ Before using the , you need to regist
## Usage
-The simplest way to start using the is as follows:
+The simplest way to start using the `ColorEditor` is as follows:
@@ -107,7 +107,7 @@ public onValueChanged = (e: any) => {
## API References
-
+`ColorEditor`
## Additional Resources
diff --git a/docs/angular/src/content/en/components/linear-gauge.mdx b/docs/angular/src/content/en/components/linear-gauge.mdx
index 03d8d50a3d..43df820ef3 100644
--- a/docs/angular/src/content/en/components/linear-gauge.mdx
+++ b/docs/angular/src/content/en/components/linear-gauge.mdx
@@ -152,7 +152,7 @@ This is the primary measure displayed by the linear gauge component and is visua
## Highlight Needle
-The linear gauge can be modified to show a second needle. This will make the main needle's `Value` appear with a lower opacity. To enable this first set `HighlightValueDisplayMode` to Overlay and then apply a `HighlightValue`.
+The linear gauge can be modified to show a second needle. This will make the main needle's appear with a lower opacity. To enable this first set to Overlay and then apply a .
@@ -335,7 +335,7 @@ The backing element represents background and border of the linear gauge compone
## Scale
-The scale is a visual element that highlights the full range of values in the linear gauge. You can customize the appearance and the shape of the scale. It can also be inverted (using `IsScaleInverted` property) and all labels will be rendered from right-to-left instead of left-to-right.
+The scale is a visual element that highlights the full range of values in the linear gauge. You can customize the appearance and the shape of the scale. It can also be inverted (using property) and all labels will be rendered from right-to-left instead of left-to-right.
diff --git a/docs/angular/src/content/en/components/linear-progress.mdx b/docs/angular/src/content/en/components/linear-progress.mdx
index dd94eac12f..01f9bacbcd 100644
--- a/docs/angular/src/content/en/components/linear-progress.mdx
+++ b/docs/angular/src/content/en/components/linear-progress.mdx
@@ -187,7 +187,7 @@ Let's take a look at how this turned out:
If the input value is not defined, the progress update is **1% of the value**. In case you want the progress to be faster, the value should be greater than (** * 1%**), respectfully for slower progress the should be less than the default progress update.
-
+
If the value is defined greater than the input, there is only one update, which gets **the value that is passed for progress update**.
@@ -215,7 +215,7 @@ You can dynamically change the value of the progress bar by using external contr
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/maps/map-api.mdx b/docs/angular/src/content/en/components/maps/map-api.mdx
index ac82ea229f..f85febb1f1 100644
--- a/docs/angular/src/content/en/components/maps/map-api.mdx
+++ b/docs/angular/src/content/en/components/maps/map-api.mdx
@@ -6,89 +6,91 @@ license: commercial
mentionedTypes: ["GeographicMap", "Series", "SeriesViewer", "GeographicSymbolSeries", "GeographicProportionalSymbolSeries", "GeographicShapeSeries", "GeographicHighDensityScatterSeries", "GeographicScatterAreaSeries", "GeographicContourLineSeries", "GeographicShapeSeriesBase"]
namespace: Infragistics.Controls.Maps
---
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# Angular Geographic Map API
-The Angular `GeographicMap` has the following API members:
+The Angular has the following API members:
-- `Zoomable`
-- `ZoomToGeographic`
-- `WorldRect`
-- `WindowRect`
-- `WindowScale`
-- `GetGeographicFromZoom`
-- `GetGeographicPoint`
-- `GetPixelPoint`
+-
+-
+-
+-
+-
+-
+-
+-
## Angular Geographic Series Types
-The Angular `GeographicMap` has 7 types of series and they have the `ItemsSource` property for data binding.
+The Angular has 7 types of series and they have the property for data binding.
-- `GeographicHighDensityScatterSeries`
-- `GeographicSymbolSeries`
-- `GeographicProportionalSymbolSeries`
-- `GeographicPolylineSeries`
-- `GeographicShapeSeries`
-- `GeographicScatterAreaSeries`
-- `GeographicContourLineSeries`
+-
+-
+-
+-
+-
+-
+-
In addition, each type of series has specific properties for mapping data items and styling their appearance:
## Angular Geographic Symbol Series API
-The Angular `GeographicSymbolSeries` (Geographic Marker Series) has the following API members:
+The Angular (Geographic Marker Series) has the following API members:
-- `LatitudeMemberPath`
-- `LongitudeMemberPath`
-- `MarkerType`
-- `MarkerBrush`
-- `MarkerOutline`
+-
+-
+-
+-
+-
## Angular Geographic Bubble Series API
-The Angular `GeographicProportionalSymbolSeries` (Geographic Bubble Series) has the following API members:
+The Angular (Geographic Bubble Series) has the following API members:
-- `LatitudeMemberPath`
-- `LongitudeMemberPath`
-- `RadiusMemberPath`
-- `RadiusScale`
-- `FillScale`
-- `FillMemberPath`
+-
+-
+-
+-
+-
+-
## Angular Geographic Shape Series API
-The Angular `GeographicShapeSeries` and `GeographicPolylineSeries` have the same API members:
+The Angular and have the same API members:
-- `ShapeMemberPath`
-- `Thickness`
-- `Brush`
-- `Outline`
+-
+-
+-
+-
## Angular Geographic Area Series API
-The Angular `GeographicScatterAreaSeries` has the following API members:
+The Angular has the following API members:
-- `LatitudeMemberPath`
-- `LongitudeMemberPath`
-- `ColorMemberPath`
-- `ColorScale`
+-
+-
+-
+-
## Angular Geographic Contour Series API
-The Angular `GeographicContourLineSeries` has the following API members:
+The Angular has the following API members:
-- `LatitudeMemberPath`
-- `LongitudeMemberPath`
-- `ValueMemberPath`
-- `FillScale`
+-
+-
+-
+-
## Angular Geographic HD Series API
-The Angular `GeographicHighDensityScatterSeries` has the following API members:
+The Angular has the following API members:
-- `LatitudeMemberPath`
-- `LongitudeMemberPath`
-- `HeatMaximumColor`
-- `HeatMinimumColor`
\ No newline at end of file
+-
+-
+-
+-
\ No newline at end of file
diff --git a/docs/angular/src/content/en/components/mask.mdx b/docs/angular/src/content/en/components/mask.mdx
index 6d21187236..5fd8fc6d6a 100644
--- a/docs/angular/src/content/en/components/mask.mdx
+++ b/docs/angular/src/content/en/components/mask.mdx
@@ -78,7 +78,7 @@ export class HomeComponent {}
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/menus/toolbar.mdx b/docs/angular/src/content/en/components/menus/toolbar.mdx
index 9175bfc5bd..eccb663c94 100644
--- a/docs/angular/src/content/en/components/menus/toolbar.mdx
+++ b/docs/angular/src/content/en/components/menus/toolbar.mdx
@@ -30,7 +30,7 @@ npm install igniteui-angular-charts
npm install igniteui-angular-core
```
-The following modules are required when using the with the component and it's features.
+The following modules are required when using the with the component and it's features.
@@ -58,21 +58,6 @@ export class AppModule {}
-```ts
-import { IgxToolbarModule } from 'igniteui-react-layouts';
-import { IgrDataChartToolbarModule, IgrDataChartCoreModule, IgrDataChartCategoryModule, IgrDataChartAnnotationModule, IgrDataChartInteractivityModule, IgrDataChartCategoryTrendLineModule } from 'igniteui-react-charts';
-
-IgxToolbarModule.register();
-IgrDataChartToolbarModule.register();
-IgrDataChartCoreModule.register();
-IgrDataChartCategoryModule.register();
-IgrDataChartAnnotationModule.register();
-IgrDataChartInteractivityModule.register();
-IgrDataChartCategoryTrendLineModule.register();
-```
-
-
-
@@ -85,29 +70,29 @@ IgrDataChartCategoryTrendLineModule.register();
### Tool Actions
-The following is a list of the different items that you can add to the Toolbar.
+The following is a list of the different items that you can add to the Toolbar.
--
--
--
--
--
--
--
--
+-
+-
+-
+-
+-
+-
+-
+-
-Each of these tools exposes an event that is triggered by mouse click. Note, the is a wrapper for other tools that can also be wrapped inside a .
+Each of these tools exposes an `OnCommand` event that is triggered by mouse click. Note, the is a wrapper for other tools that can also be wrapped inside a .
-New and existing tools can be repositioned and marked hidden using the , and properties on the object. ToolActions also expose a property.
+New and existing tools can be repositioned and marked hidden using the , and properties on the object. ToolActions also expose a property.
-The following example demonstrates a couple of features. First you can group tools together in the `ToolActionSubPanel` including hiding built in tools such as the **ZoomReset** and **AnalyzeMenu** menu tool actions. In this example a new instance of the **ZoomReset** tool action within the **ZoomMenu** by using the the `AfterId` property and assigning that to **ZoomOut** to be precise with it's placement. It is also highlighted via the property on the tool.
+The following example demonstrates a couple of features. First you can group tools together in the including hiding built in tools such as the **ZoomReset** and **AnalyzeMenu** menu tool actions. In this example a new instance of the **ZoomReset** tool action within the **ZoomMenu** by using the the property and assigning that to **ZoomOut** to be precise with it's placement. It is also highlighted via the property on the tool.
### Angular Data Chart Integration
-The Angular Toolbar contains a property. This is used to link a component, such as the as shown in the code below:
+The Angular Toolbar contains a property. This is used to link a component, such as the as shown in the code below:
@@ -136,47 +121,47 @@ The Angular Toolbar contains a items and menus become available when the is linked with the Toolbar. Here is a list of the built-in Angular `DataChart` Tool Actions and their associated `OverlayId`:
+Several pre-existing items and menus become available when the is linked with the Toolbar. Here is a list of the built-in Angular Tool Actions and their associated :
Zooming Actions
-- `ZoomMenu`: A `ToolActionIconMenu` that exposes three `ToolActionLabel` items to invoke the `ZoomIn` and `ZoomOut` methods on the chart for increasing/decreasing the chart's zoom level including `ZoomReset`, a `ToolActionLabel` that invokes the `ResetZoom` method on the chart to reset the zoom level to it's default position.
+- `ZoomMenu`: A that exposes three items to invoke the and methods on the chart for increasing/decreasing the chart's zoom level including `ZoomReset`, a that invokes the method on the chart to reset the zoom level to it's default position.
Trend Actions
-- `AnalyzeMenu`: A `ToolActionIconMenu` that contains several options for configuring different options of the chart.
+- `AnalyzeMenu`: A that contains several options for configuring different options of the chart.
- `AnalyzeHeader`: A sub section header.
- `LinesMenu`: A sub menu containing various tools for showing different dashed horizontal lines on the chart.
- `LinesHeader`: A sub menu section header for the following three tools:
- - `MaxValue`: A `ToolActionCheckbox` that displays a dashed horizontal line along the yAxis at the maximum value of the series.
- - `MinValue`: A `ToolActionCheckbox` that displays a dashed horizontal line along the yAxis at the minimum value of the series.
- - `Average`: A `ToolActionCheckbox` that displays a dashed horizontal line along the yAxis at the average value of the series.
- - `TrendsMenu`: A sub menu containing tools for applying various trendlines to the `DataChart` plot area.
+ - `MaxValue`: A that displays a dashed horizontal line along the yAxis at the maximum value of the series.
+ - `MinValue`: A that displays a dashed horizontal line along the yAxis at the minimum value of the series.
+ - : A that displays a dashed horizontal line along the yAxis at the average value of the series.
+ - `TrendsMenu`: A sub menu containing tools for applying various trendlines to the plot area.
- `TrendsHeader`: A sub menu section header for the following three tools:
- - **Exponential**: A `ToolActionRadio` that sets the `TrendLineType` on each series in the chart to **ExponentialFit**.
- - **Linear**: A `ToolActionRadio` that sets the `TrendLineType` on each series in the chart to **LinearFit**.
- - **Logarithmic**: A `ToolActionRadio` that sets the `TrendLineType` on each series in the the chart to **LogarithmicFit**.
+ - **Exponential**: A that sets the on each series in the chart to **ExponentialFit**.
+ - **Linear**: A that sets the on each series in the chart to **LinearFit**.
+ - **Logarithmic**: A that sets the on each series in the the chart to **LogarithmicFit**.
- `HelpersHeader`: A sub section header.
- - `SeriesAvg`: A `ToolActionCheckbox` that adds or removes a `ValueLayer` to the chart's series collection using the `ValueLayerValueMode` of type `Average`.
- - `ValueLabelsMenu`: A sub menu containing various tools for showing different annotations on the `DataChart`'s plot area.
+ - `SeriesAvg`: A that adds or removes a to the chart's series collection using the of type .
+ - `ValueLabelsMenu`: A sub menu containing various tools for showing different annotations on the 's plot area.
- `ValueLabelsHeader`: A sub menu section header for the following tools:
- - `ShowValueLabels`: A `ToolActionCheckbox` that toggles data point values by using a `CalloutLayer`.
- - `ShowLastValueLabel`: A `ToolActionCheckbox` that toggles final value axis annotations by using a `FinalValueLayer`.
-- `ShowCrosshairs`: A `ToolActionCheckbox` that toggles mouse-over crosshair annotations via the chart's `CrosshairsDisplayMode` property.
-- `ShowGridlines`: A `ToolActionCheckbox` that toggles extra gridlines by applying a `MajorStroke` to the X-Axis.
+ - `ShowValueLabels`: A that toggles data point values by using a .
+ - `ShowLastValueLabel`: A that toggles final value axis annotations by using a .
+- `ShowCrosshairs`: A that toggles mouse-over crosshair annotations via the chart's property.
+- `ShowGridlines`: A that toggles extra gridlines by applying a `MajorStroke` to the X-Axis.
Save to Image Action
-- `CopyAsImage`: A `ToolActionLabel` that exposes an option to copy the chart to the clipboard.
+- `CopyAsImage`: A that exposes an option to copy the chart to the clipboard.
- `CopyHeader`: A sub section header.
### SVG Icons
-When adding tools manually, icons can be assigned using the method. There are three parameters to pass in this method. The first is the icon collection name defined on the tool eg. `IconCollectionName`. The second is the name of the icon defined on the tool eg. `IconName`, followed by adding the SVG string.
+When adding tools manually, icons can be assigned using the `RenderIconFromText` method. There are three parameters to pass in this method. The first is the icon collection name defined on the tool eg. . The second is the name of the icon defined on the tool eg. , followed by adding the SVG string.
### Data URL Icons
-Similarly to adding svg, you can also add an Icon image from a URL via the . The method's third parameter would be used to enter a string URL.
+Similarly to adding svg, you can also add an Icon image from a URL via the . The method's third parameter would be used to enter a string URL.
The following snippet shows both methods of adding an Icon.
@@ -235,7 +220,7 @@ public toolbarCustomIconOnViewInit(): void {
### Vertical Orientation
-By default the Angular Toolbar is shown horizontally, but it also has the ability to shown vertically by setting the property.
+By default the Angular Toolbar is shown horizontally, but it also has the ability to shown vertically by setting the property.
@@ -289,7 +274,7 @@ The following example demonstrates styling the Angular Data Chart series brush w
{/* ## Styling/Theming
-The icon component can be styled by using it's `BaseTheme` property directly to the `Toolbar`.
+The icon component can be styled by using it's property directly to the .
@@ -312,7 +297,7 @@ The icon component can be styled by using it's `BaseTheme` property directly to
## API References
-
+
## Additional Resources
diff --git a/docs/angular/src/content/en/components/navbar.mdx b/docs/angular/src/content/en/components/navbar.mdx
index 96c77a667d..677019567d 100644
--- a/docs/angular/src/content/en/components/navbar.mdx
+++ b/docs/angular/src/content/en/components/navbar.mdx
@@ -128,7 +128,7 @@ Next, we need to update our template with an icon button for each of the options
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/radial-gauge.mdx b/docs/angular/src/content/en/components/radial-gauge.mdx
index f28bf1365a..36032d833e 100644
--- a/docs/angular/src/content/en/components/radial-gauge.mdx
+++ b/docs/angular/src/content/en/components/radial-gauge.mdx
@@ -121,7 +121,7 @@ The radial gauge component comes with a backing shape drawn behind the scale tha
The backing element represents background and border of the radial gauge component. It is always the first element rendered and all the rest of elements such as needle, labels, and tick marks are overlay on top of it.
-The backing can be circular or fitted. A circular shape creates a 360 degree circle gauge while a fitted shape creates a filled arc segment encompassing the `ScaleStartAngle` and `ScaleEndAngle` properties. This can be set by setting the `BackingShape` property.
+The backing can be circular or fitted. A circular shape creates a 360 degree circle gauge while a fitted shape creates a filled arc segment encompassing the and properties. This can be set by setting the property.
@@ -157,7 +157,7 @@ The backing can be circular or fitted. A circular shape creates a 360 degree cir
## Scale
-The scale is visual element that highlights full range of values in the gauge which can be created by supplying `MinimumValue` and `MaximumValue` values. Together with backing, it defines overall shape of gauge. The `ScaleStartAngle` and `ScaleEndAngle` properties define bounds of arc of the scale. While, the `ScaleSweepDirection` property specifies whether the scale sweeps in clockwise or counter-clockwise direction. You can customize appearance of the scale by setting `ScaleBrush`, `ScaleStartExtent`, and `ScaleEndExtent` properties.
+The scale is visual element that highlights full range of values in the gauge which can be created by supplying and values. Together with backing, it defines overall shape of gauge. The and properties define bounds of arc of the scale. While, the property specifies whether the scale sweeps in clockwise or counter-clockwise direction. You can customize appearance of the scale by setting , , and properties.
@@ -192,9 +192,9 @@ The scale is visual element that highlights full range of values in the gauge wh
## Labels and Titles
-The radial gauge labels are visual elements displaying numeric values at a specified interval between values of the `MinimumValue` and `MaximumValue` properties. You can position labels by setting the `LabelExtent` property to a fraction, where 0 represents center of gauge and 1 represents outer extent of the gauge backing. Also, you can customize labels setting various styling properties such as `FontBrush` and `Font`.
+The radial gauge labels are visual elements displaying numeric values at a specified interval between values of the and properties. You can position labels by setting the property to a fraction, where 0 represents center of gauge and 1 represents outer extent of the gauge backing. Also, you can customize labels setting various styling properties such as and .
-Each of these labels for the needle have various styling attributes you can apply to change the font, angle, brush and distance from the center of the gauge such as `TitleExtent`, `TitleAngle`, `SubtitleFontSize`, `HighlightLabelBrush`.
+Each of these labels for the needle have various styling attributes you can apply to change the font, angle, brush and distance from the center of the gauge such as , , `SubtitleFontSize`, .
@@ -224,9 +224,9 @@ Each of these labels for the needle have various styling attributes you can appl
## Title & Subtitle
-`TitleText` and `SubtitleText` properties are available and can both be used to display custom text for the needle. Alternatively, `TitleDisplaysValue` and `SubtitleDisplaysValue`, when set to true, will let display the needle's value and override `TitleText` and `SubtitleText`. So you can occupy custom text for the title but show the value via the subtitle and vice versa.
+ and properties are available and can both be used to display custom text for the needle. Alternatively, and , when set to true, will let display the needle's value and override and . So you can occupy custom text for the title but show the value via the subtitle and vice versa.
-If the highlight needle is shown, as explained below, then custom text can be shown via `HighlightLabelText`, otherwise `HighlightLabelDisplaysValue` can be enabled and display it's value.
+If the highlight needle is shown, as explained below, then custom text can be shown via , otherwise can be enabled and display it's value.
@@ -247,14 +247,14 @@ If the highlight needle is shown, as explained below, then custom text can be sh
## Optical Scaling
-The radial gauge's labels and titles can change it's scaling. To enable this, first set `OpticalScalingEnabled` to true. Then you can set `OpticalScalingSize` which manages the size at which labels have 100% optical scaling. Labels will have larger fonts when gauge's size is larger. For example, labels will have a 200% larger font size when this property is set to 500 and the gauge px size is doubled to eg. 1000.
+The radial gauge's labels and titles can change it's scaling. To enable this, first set to true. Then you can set which manages the size at which labels have 100% optical scaling. Labels will have larger fonts when gauge's size is larger. For example, labels will have a 200% larger font size when this property is set to 500 and the gauge px size is doubled to eg. 1000.
## Tick Marks
-Tick marks are thin lines radiating from the center of the radial gauge. There are two types of tick marks: major and minor. Major tick marks are displayed at the `Interval` between the `MinimumValue` and `MaximumValue` properties. Use the `MinorTickCount` property to specify the number of minor tick marks displayed between each major tick mark. You can control the length of tick marks by setting a fraction (between 0 and 1) to `TickStartExtent`, `TickEndExtent`, `MinorTickStartExtent`, and `MinorTickEndExtent` properties.
+Tick marks are thin lines radiating from the center of the radial gauge. There are two types of tick marks: major and minor. Major tick marks are displayed at the between the and properties. Use the property to specify the number of minor tick marks displayed between each major tick mark. You can control the length of tick marks by setting a fraction (between 0 and 1) to , , , and properties.
@@ -290,7 +290,7 @@ Tick marks are thin lines radiating from the center of the radial gauge. There a
## Ranges
-A range highlights a set of continuous values bound by a specified `MinimumValue` and `MaximumValue` properties. You can add multiple ranges to the radial gauge by specifying their starting and ending values. Each range has a few customization properties such as `Brush` and `Outline`. Alternatively, you can set `RangeBrushes` and `RangeOutlines` properties to a list of colors for the ranges.
+A range highlights a set of continuous values bound by a specified and properties. You can add multiple ranges to the radial gauge by specifying their starting and ending values. Each range has a few customization properties such as and . Alternatively, you can set and properties to a list of colors for the ranges.
@@ -330,9 +330,9 @@ A range highlights a set of continuous values bound by a specified `MinimumValue
Radial gauge needles are visual elements used to signify a gauge set value. Needles are available in one of the several predefined shapes. The needle can have a pivot shape, which is placed in the center of the gauge. The pivot shape also takes one of the predefined shapes. Pivot shapes that include an overlay or an underlay can have a separate pivot brush applied to the shape.
-The supported needle shapes and caps are set using the `NeedleShape` and `NeedlePivotShape` properties.
+The supported needle shapes and caps are set using the and properties.
-You can enable an interactive mode of the gauge (using `IsNeedleDraggingEnabled` property) and the end-user will be able to change value by dragging the needle between values of `MinimumValue` and `MaximumValue` properties.
+You can enable an interactive mode of the gauge (using property) and the end-user will be able to change value by dragging the needle between values of and properties.
@@ -370,7 +370,7 @@ You can enable an interactive mode of the gauge (using `IsNeedleDraggingEnabled`
## Highlight Needle
-The radial gauge can be modified to show a second needle. This will make the main needle's `Value` appear with a lower opacity. To enable this first set `HighlightValueDisplayMode` to Overlay and then apply a `HighlightValue`.
+The radial gauge can be modified to show a second needle. This will make the main needle's appear with a lower opacity. To enable this first set to Overlay and then apply a .
diff --git a/docs/angular/src/content/en/components/select.mdx b/docs/angular/src/content/en/components/select.mdx
index acd462de58..4f008e3414 100644
--- a/docs/angular/src/content/en/components/select.mdx
+++ b/docs/angular/src/content/en/components/select.mdx
@@ -91,7 +91,7 @@ Add the `igx-select` along with a list of items to choose from. We use
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/snackbar.mdx b/docs/angular/src/content/en/components/snackbar.mdx
index 0bb32716c1..3aee474c21 100644
--- a/docs/angular/src/content/en/components/snackbar.mdx
+++ b/docs/angular/src/content/en/components/snackbar.mdx
@@ -224,7 +224,7 @@ Let’s create a list with contacts that can be deleted. When an item is deleted
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/spreadsheet-activation.mdx b/docs/angular/src/content/en/components/spreadsheet-activation.mdx
index e38d651f68..61ec86b12c 100644
--- a/docs/angular/src/content/en/components/spreadsheet-activation.mdx
+++ b/docs/angular/src/content/en/components/spreadsheet-activation.mdx
@@ -25,15 +25,15 @@ The Angular Spreadsheet component exposes properties that allow you to determine
## Activation Overview
-The activation of the Angular control is split up between the cells, panes, and worksheets of the current of the spreadsheet. The three "active" properties are described below:
+The activation of the Angular control is split up between the cells, panes, and worksheets of the current of the spreadsheet. The three "active" properties are described below:
-- : Returns or sets the active cell in the spreadsheet. To set it, you must create a new instance of and pass in information about that cell, such as the column and row or the string address of the cell.
-- : Returns the active pane in the currently active worksheet of the spreadsheet control.
-- : Returns or sets the active worksheet in the of the spreadsheet control. This can be set by setting it to an existing worksheet in the attached to the spreadsheet.
+- : Returns or sets the active cell in the spreadsheet. To set it, you must create a new instance of and pass in information about that cell, such as the column and row or the string address of the cell.
+- : Returns the active pane in the currently active worksheet of the spreadsheet control.
+- : Returns or sets the active worksheet in the of the spreadsheet control. This can be set by setting it to an existing worksheet in the attached to the spreadsheet.
## Code Snippet
-The following code snippet shows setting activation of the cell and worksheet in the control:
+The following code snippet shows setting activation of the cell and worksheet in the control:
```ts
this.spreadsheet.activeWorksheet = this.spreadsheet.workbook.worksheets(1);
@@ -44,6 +44,6 @@ this.spreadsheet.activeCell = new SpreadsheetCell("C5");
## API References
-
-
+
+
diff --git a/docs/angular/src/content/en/components/spreadsheet-chart-adapter.mdx b/docs/angular/src/content/en/components/spreadsheet-chart-adapter.mdx
index 18098c24a4..1464b4b735 100644
--- a/docs/angular/src/content/en/components/spreadsheet-chart-adapter.mdx
+++ b/docs/angular/src/content/en/components/spreadsheet-chart-adapter.mdx
@@ -11,7 +11,7 @@ import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
# Angular Spreadsheet Chart Adapter
-The Angular Spreadsheet component allows displaying charts in your .
+The Angular Spreadsheet component allows displaying charts in your .
## Angular Spreadsheet Chart Adapter Example
@@ -22,9 +22,9 @@ The Angular Spreadsheet component allows displaying charts in your you can display the charts in the spreadsheet. The spreadsheet chart adapters creates and initializes chart elements for the spreadsheet based on a Infragistics.Documents.Excel.WorksheetChart instance.
+Using you can display the charts in the spreadsheet. The spreadsheet chart adapters creates and initializes chart elements for the spreadsheet based on a Infragistics.Documents.Excel.WorksheetChart instance.
-In order to add a WorksheetChart to a worksheet, you must use the `AddChart` method of the worksheet’s Shapes collection. You can find more detail of adding charts in Excel below.
+In order to add a WorksheetChart to a worksheet, you must use the method of the worksheet’s Shapes collection. You can find more detail of adding charts in Excel below.
Here are the steps by step description :
@@ -84,10 +84,10 @@ There are over 35 chart types supported by the Spreadsheet ChartAdapters includi
-In the following code snippet, an external [ExcelUtility](excel-utility.md) class is used to save and load a `Workbook`.
+In the following code snippet, an external [ExcelUtility](excel-utility.md) class is used to save and load a .
-When setting up your Angular spreadsheet control to add charts, you will need to import the `SpreadsheetChartAdapter` class like so:
+When setting up your Angular spreadsheet control to add charts, you will need to import the class like so:
@@ -109,7 +109,7 @@ import { WorksheetCell } from 'igniteui-angular-excel';
## Code Snippet
-The following code snippet demonstrates how to add charts to the currently viewed worksheet in the control:
+The following code snippet demonstrates how to add charts to the currently viewed worksheet in the control:
```typescript
this.spreadsheet.chartAdapter = new SpreadsheetChartAdapter();
@@ -166,6 +166,6 @@ ExcelUtility.loadFromUrl(process.env.PUBLIC_URL + "/ExcelFiles/ChartData.xlsx").
## API References
-
-
+
+
diff --git a/docs/angular/src/content/en/components/spreadsheet-clipboard.mdx b/docs/angular/src/content/en/components/spreadsheet-clipboard.mdx
index 9d85866270..ef73e010c9 100644
--- a/docs/angular/src/content/en/components/spreadsheet-clipboard.mdx
+++ b/docs/angular/src/content/en/components/spreadsheet-clipboard.mdx
@@ -24,7 +24,7 @@ This topic explains how to perform clipboard operations on the Ignite UI for Ang
## Dependencies
-Before making use of the clipboard you will want to import the enumeration:
+Before making use of the clipboard you will want to import the `SpreadsheetAction` enumeration:
@@ -44,7 +44,7 @@ import { SpreadsheetAction } from 'igniteui-angular-spreadsheet';
## Usage
-The following code snippet shows how you can execute commands related to the clipboard in the Angular control:
+The following code snippet shows how you can execute commands related to the clipboard in the Angular control:
```ts
public cut(): void {
@@ -63,5 +63,5 @@ public paste(): void {
## API References
-
-
+`SpreadsheetAction`
+
diff --git a/docs/angular/src/content/en/components/spreadsheet-commands.mdx b/docs/angular/src/content/en/components/spreadsheet-commands.mdx
index 40f94546b2..ebb1bdb32f 100644
--- a/docs/angular/src/content/en/components/spreadsheet-commands.mdx
+++ b/docs/angular/src/content/en/components/spreadsheet-commands.mdx
@@ -10,7 +10,7 @@ import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
# Angular Working with Commands
-The Angular Spreadsheet component allows you to perform commands for activating different features of the spreadsheet. This topic explains how to perform different operations with the control using commands. Many of the commands will perform their action based on the active cells, rows, or worksheets. For example two such commands are ZoomIn and ZoomOut. See the enum for a full list.
+The Angular Spreadsheet component allows you to perform commands for activating different features of the spreadsheet. This topic explains how to perform different operations with the control using commands. Many of the commands will perform their action based on the active cells, rows, or worksheets. For example two such commands are ZoomIn and ZoomOut. See the `SpreadsheetAction` enum for a full list.
## Angular Working with Commands Example
@@ -24,7 +24,7 @@ The Angular Spreadsheet component allows you to perform commands for activating
## Dependencies
-Before making use of the commands you will want to import the
+Before making use of the commands you will want to import the `SpreadsheetAction`
@@ -72,4 +72,4 @@ public zoomOut(): void {
## API References
-
+`SpreadsheetAction`
diff --git a/docs/angular/src/content/en/components/spreadsheet-conditional-formatting.mdx b/docs/angular/src/content/en/components/spreadsheet-conditional-formatting.mdx
index 9f7194811b..d8e1be1540 100644
--- a/docs/angular/src/content/en/components/spreadsheet-conditional-formatting.mdx
+++ b/docs/angular/src/content/en/components/spreadsheet-conditional-formatting.mdx
@@ -1,4 +1,4 @@
----
+---
title: "Angular Spreadsheet | Conditional Formatting | Infragistics"
description: Use Infragistics' Angular spreadsheet control to conditionally format the cells of a worksheet. Check out Ignite UI for Angular spreadsheet demos!
keywords: Spreadsheet, conditional formatting, Ignite UI for Angular, Infragistics, Worksheet
@@ -10,7 +10,7 @@ import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
# Angular Spreadsheet Conditional Formatting
-The Angular component allows you to conditionally format the cells of a worksheet. This allows you to highlight different pieces of your data based on a condition.
+The Angular component allows you to conditionally format the cells of a worksheet. This allows you to highlight different pieces of your data based on a condition.
## Angular Spreadsheet Conditional Formatting Example
@@ -24,37 +24,37 @@ The Angular component allows yo
## Conditional Formatting Overview
-You can configure the conditional formatting of a particular worksheet by using the many `Add` methods exposed on the `ConditionalFormats` collection of that worksheet. The first parameter of these `Add` methods is the string region of the worksheet that you would like to apply the conditional format to.
+You can configure the conditional formatting of a particular worksheet by using the many `Add` methods exposed on the collection of that worksheet. The first parameter of these `Add` methods is the string region of the worksheet that you would like to apply the conditional format to.
-Many of the conditional formats that you can add to your worksheet have a `CellFormat` property that determines the way that the cells should look when the condition in that conditional format holds true. For example, you can use the properties attached to this `CellFormat` property such as `Fill` and `Font` to determine the background and font settings of your cells, respectively.
+Many of the conditional formats that you can add to your worksheet have a property that determines the way that the cells should look when the condition in that conditional format holds true. For example, you can use the properties attached to this property such as and to determine the background and font settings of your cells, respectively.
-When a conditional format is created and a `CellFormat` applied, there is a subset of properties that are currently supported by the worksheet cell. The properties that are currently honored off of the `CellFormat` are `Fill`, `Border` properties, `FormatString`, and some `Font` properties such as strikethrough, underline, italic, bold, and color. Many of these can be seen from the code snippet below.
+When a conditional format is created and a applied, there is a subset of properties that are currently supported by the worksheet cell. The properties that are currently honored off of the are , `Border` properties, , and some properties such as strikethrough, underline, italic, bold, and color. Many of these can be seen from the code snippet below.
-There are a few conditional formats that do not have a `CellFormat` property, as their visualization on the cells behaves differently. These conditional formats are the `DataBarConditionalFormat`, `ColorScaleConditionalFormat`, and `IconSetConditionalFormat`.
+There are a few conditional formats that do not have a property, as their visualization on the cells behaves differently. These conditional formats are the , , and .
When loading a pre-existing workbook from Excel, the formats will be preserved when that workbook is loaded. The same is true for when you save the workbook out to an Excel file.
-The following lists the supported conditional formats in the Angular control:
-
-- `AverageConditionalFormat`: Added using the `AddAverageCondition` method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether a cell’s value is above or below the average or standard deviation for the associated range.
-- `BlanksConditionalFormat`: Added using the `AddBlanksCondition` method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether the cell’s value is not set.
-- `ColorScaleConditionalFormat`: Added using the `AddColorScaleCondition` method, this conditional format exposes properties which control the coloring of a worksheet cell based on the cell’s value as relative to minimum, midpoint, and maximum threshold values.
-- `DataBarConditionalFormat`: Added using the `AddDataBarCondition` method, this conditional format exposes properties which display data bars in a worksheet cell based on the cell’s value as relative to the associated range of values.
-- `DateTimeConditionalFormat`: Added using the `AddDateTimeCondition` method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether a cell’s date value falls within a given range of time.
-- `DuplicateConditionalFormat`: Added using the `AddDuplicateCondition` method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether a cell’s value is unique or duplicated across the associated range.
-- `ErrorsConditionalFormat`: Added using the `AddErrorsCondition` method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether the cell’s value is valid.
-- `FormulaConditionalFormat`: Added using the `AddFormulaCondition` method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether the cell’s value meets the criteria defined by a formula.
-- `IconSetConditionalFormat`: Added using the `AddIconSetCondition` method, this conditional format exposes properties which display icons in a worksheet cell based on the cell’s value as relative to threshold values.
-- `NoBlanksConditionalFormat`: Added using the `AddNoBlanksCondition` method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether the cell’s value is set.
-- `NoErrorsConditionalFormat`: Added using the `AddNoErrorsCondition` method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether the cell’s value is valid.
-- `OperatorConditionalFormat`: Added using the `AddOperatorCondition` method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether the cell’s value meets the criteria defined by a logical operator.
-- `RankConditionalFormat`: Added using the `AddRankCondition` method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether a cell’s value is within the top of bottom rank of values across the associated range.
-- `TextOperatorConditionalFormat`: Added using the `AddTextCondition` method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether a cell’s text value meets the criteria defined by a string and a `FormatConditionTextOperator` value as placed in the `AddTextCondition` method’s parameters.
-- `UniqueConditionalFormat`: Added using the `AddUniqueCondition` method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether a cell’s value is unique across the associated range.
+The following lists the supported conditional formats in the Angular control:
+
+- : Added using the method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether a cell’s value is above or below the average or standard deviation for the associated range.
+- : Added using the method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether the cell’s value is not set.
+- : Added using the method, this conditional format exposes properties which control the coloring of a worksheet cell based on the cell’s value as relative to minimum, midpoint, and maximum threshold values.
+- : Added using the method, this conditional format exposes properties which display data bars in a worksheet cell based on the cell’s value as relative to the associated range of values.
+- : Added using the method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether a cell’s date value falls within a given range of time.
+- : Added using the method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether a cell’s value is unique or duplicated across the associated range.
+- : Added using the method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether the cell’s value is valid.
+- : Added using the method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether the cell’s value meets the criteria defined by a formula.
+- : Added using the method, this conditional format exposes properties which display icons in a worksheet cell based on the cell’s value as relative to threshold values.
+- : Added using the method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether the cell’s value is set.
+- : Added using the method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether the cell’s value is valid.
+- : Added using the method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether the cell’s value meets the criteria defined by a logical operator.
+- : Added using the method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether a cell’s value is within the top of bottom rank of values across the associated range.
+- : Added using the method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether a cell’s text value meets the criteria defined by a string and a value as placed in the method’s parameters.
+- : Added using the method, this conditional format exposes properties which control the visual attributes of a worksheet cell based on whether a cell’s value is unique across the associated range.
## Dependencies
-In order to add conditional formatting to the `Spreadsheet` control, you will need to import the following dependencies:
+In order to add conditional formatting to the control, you will need to import the following dependencies:
```ts
diff --git a/docs/angular/src/content/en/components/spreadsheet-configuring.mdx b/docs/angular/src/content/en/components/spreadsheet-configuring.mdx
index d7a77a69d2..ea7848c211 100644
--- a/docs/angular/src/content/en/components/spreadsheet-configuring.mdx
+++ b/docs/angular/src/content/en/components/spreadsheet-configuring.mdx
@@ -24,11 +24,11 @@ The Angular Spreadsheet component allows the user to configure many different as
## Configuring Cell Editing
-When a user edits a cell value and confirms the new input, the `Spreadsheet` control has the ability to navigate to cells adjacent to the currently active cell on press of the ENTER key, depending on the configuration of the spreadsheet.
+When a user edits a cell value and confirms the new input, the control has the ability to navigate to cells adjacent to the currently active cell on press of the ENTER key, depending on the configuration of the spreadsheet.
-In order to enable this ENTER key navigation, you can set the `IsEnterKeyNavigationEnabled` property to **true**. If set to false, the active cell will stay the same when pressing the ENTER key.
+In order to enable this ENTER key navigation, you can set the property to **true**. If set to false, the active cell will stay the same when pressing the ENTER key.
-You can also configure the direction of the adjacent cell navigated to on press of the ENTER key by setting the `EnterKeyNavigationDirection` property to `Down`, `Up`, `Left` or `Right`.
+You can also configure the direction of the adjacent cell navigated to on press of the ENTER key by setting the property to `Down`, `Up`, `Left` or `Right`.
The following code snippets demonstrate the above:
@@ -57,7 +57,7 @@ this.spreadsheet.enterKeyNavigationDirection = SpreadsheetEnterKeyNavigationDire
## Configuring Formula Bar
-The Angular `Spreadsheet` allows you to configure the visibility of the formula bar by setting the `IsFormulaBarVisible` property of the control.
+The Angular allows you to configure the visibility of the formula bar by setting the property of the control.
The following code snippets demonstrate the above:
@@ -79,7 +79,7 @@ this.spreadsheet.isFormulaBarVisible = true;
## Configuring Gridlines
-The `Spreadsheet` allows you to configure the visibility of its gridlines by setting the `AreGridlinesVisible` property of the control.
+The allows you to configure the visibility of its gridlines by setting the property of the control.
The following code snippets demonstrate the above:
@@ -101,7 +101,7 @@ this.spreadsheet.areGridlinesVisible = true;
## Configuring Headers
-The `Spreadsheet` allows you to configure the visibility of its headers by setting the `AreHeadersVisible` property of the control.
+The allows you to configure the visibility of its headers by setting the property of the control.
The following code snippets demonstrate the above:
@@ -123,13 +123,13 @@ this.spreadsheet.areHeadersVisible = false;
## Configuring Navigation
-The `Spreadsheet` control allows you to configure navigation between a worksheet's cells by configuring whether or not the control is in "end mode." End mode is the functionality where, on press of an arrow key, the active cell will be moved from the current cell to the end of the row or column where data exists in the adjacent cells, depending on the direction of the arrow key pressed. This functionality is good for navigating to the end of large blocks of data very quickly.
+The control allows you to configure navigation between a worksheet's cells by configuring whether or not the control is in "end mode." End mode is the functionality where, on press of an arrow key, the active cell will be moved from the current cell to the end of the row or column where data exists in the adjacent cells, depending on the direction of the arrow key pressed. This functionality is good for navigating to the end of large blocks of data very quickly.
-For example, if you are in end mode, and you click in a large 100x100 block of data, and press the → arrow key, this will navigate to the right end of the row that you are in to the furthest right column with data. After this operation, the `Spreadsheet` will pop out of end mode.
+For example, if you are in end mode, and you click in a large 100x100 block of data, and press the → arrow key, this will navigate to the right end of the row that you are in to the furthest right column with data. After this operation, the will pop out of end mode.
-End mode goes into effect at runtime when the user presses the END key, but it can be configured programmatically by setting the `IsInEndMode` property of the spreadsheet control.
+End mode goes into effect at runtime when the user presses the END key, but it can be configured programmatically by setting the property of the spreadsheet control.
-The following code snippets demonstrate the above, in that the `Spreadsheet` will begin in end mode:
+The following code snippets demonstrate the above, in that the will begin in end mode:
@@ -149,9 +149,9 @@ this.spreadsheet.isInEndMode = true;
## Configuring Protection
-The `Spreadsheet` will respect the protection of a workbook on a worksheet-by-worksheet basis. Configuration for a worksheet's protection can be configured by calling the `Protect()` method on the worksheet to protect it, and the `Unprotect()` method to unprotect it.
+The will respect the protection of a workbook on a worksheet-by-worksheet basis. Configuration for a worksheet's protection can be configured by calling the `Protect()` method on the worksheet to protect it, and the `Unprotect()` method to unprotect it.
-You can activate or deactivate protection on the `Spreadsheet` control's currently active worksheet by using the code below:
+You can activate or deactivate protection on the control's currently active worksheet by using the code below:
```ts
this.spreadsheet.activeWorksheet.protect();
@@ -160,13 +160,13 @@ this.spreadsheet.activeWorksheet.unprotect();
## Configuring Selection
-The `Spreadsheet` control allows you to configure the type of selection allowed in the control then modifier keys (SHIFT or CTRL) are pressed by the user. This is done by setting the `SelectionMode` property of the spreadsheet to one of the following values:
+The control allows you to configure the type of selection allowed in the control then modifier keys (SHIFT or CTRL) are pressed by the user. This is done by setting the property of the spreadsheet to one of the following values:
-- `AddToSelection`: New cell ranges are added to the `SpreadsheetSelection` object's `CellRanges` collection without needing to hold down the CTRL key when dragging via the mouse and a range is added with the first arrow key navigation after entering the mode. One can enter the mode by pressing SHIFT + F8.
-- `ExtendSelection`: The selection range in the `SpreadsheetSelection` object's `CellRanges` collection representing the active cell is updated as one uses the mouse to select a cell or navigating via the keyboard.
+- `AddToSelection`: New cell ranges are added to the object's collection without needing to hold down the CTRL key when dragging via the mouse and a range is added with the first arrow key navigation after entering the mode. One can enter the mode by pressing SHIFT + F8.
+- `ExtendSelection`: The selection range in the object's collection representing the active cell is updated as one uses the mouse to select a cell or navigating via the keyboard.
- `Normal`: The selection is replaced when dragging the mouse to select a cell or range of cells. Similarly when navigating via the keyboard a new selection is created. One may add a new range by holding the CTRL key and using the mouse and one may alter the selection range containing the active cell by holding the SHIFT key down while clicking with the mouse or navigating with the keyboard such as with the arrow keys.
-The `SpreadsheetSelection` object mentioned in the descriptions above can be obtained by using the `ActiveSelection` property of the `Spreadsheet` control.
+The object mentioned in the descriptions above can be obtained by using the property of the control.
The following code snippets demonstrate configuration of the selection mode:
@@ -190,9 +190,9 @@ The following code snippets demonstrate configuration of the selection mode:
this.spreadsheet.selectionMode = SpreadsheetCellSelectionMode.ExtendSelection;
```
-The selection of the `Spreadsheet` control can also be set or obtained programmatically. For single selection, you can set the `ActiveCell` property Multiple selection is done through the `SpreadsheetSelection` object that is returned by the `Spreadsheet` control's `ActiveSelection` property.
+The selection of the control can also be set or obtained programmatically. For single selection, you can set the property Multiple selection is done through the object that is returned by the control's property.
-The `SpreadsheetSelection` object has an `AddCellRange()` method that allows you to programmatically add a range of cells to the selection of the spreadsheet in the form of a new `SpreadsheetCellRange` object.
+The object has an `AddCellRange()` method that allows you to programmatically add a range of cells to the selection of the spreadsheet in the form of a new object.
The following code snippet demonstrates adding a cell range to the spreadsheet's selection:
@@ -202,7 +202,7 @@ this.spreadsheet.activeSelection.addCellRange(new SpreadsheetCellRange(2, 2, 5,
## Configuring Tab Bar Area
-The `Spreadsheet` control respects the configuration of the visibility and width of the tab bar area from the `WindowOptions` of the currently active `Workbook` via the `TabBarWidth` and `TabBarVisibility` properties, respectively.
+The control respects the configuration of the visibility and width of the tab bar area from the of the currently active via the `TabBarWidth` and `TabBarVisibility` properties, respectively.
The tab bar area is the area that visualizes the worksheet names as tabs in the control.
@@ -216,9 +216,9 @@ this.spreadsheet.workbook.windowOptions.tabBarWidth = 200;
## Configuring Zoom Level
-The Angular Spreadsheet component supports zooming in and out by configuring its `ZoomLevel` property. The zoom level can be a maximum of 400% and a minimum of 10%.
+The Angular Spreadsheet component supports zooming in and out by configuring its property. The zoom level can be a maximum of 400% and a minimum of 10%.
-Setting this property to a number represents the percentage as a whole number, so setting the `ZoomLevel` to 100 is equivalent to setting it to 100%.
+Setting this property to a number represents the percentage as a whole number, so setting the to 100 is equivalent to setting it to 100%.
The following code snippets show how to configure the spreadsheet's zoom level:
@@ -241,7 +241,7 @@ this.spreadsheet.zoomLevel = 200;
## API References
-
-
-
+
+
+
diff --git a/docs/angular/src/content/en/components/spreadsheet-hyperlinks.mdx b/docs/angular/src/content/en/components/spreadsheet-hyperlinks.mdx
index eca27a3499..4785820430 100644
--- a/docs/angular/src/content/en/components/spreadsheet-hyperlinks.mdx
+++ b/docs/angular/src/content/en/components/spreadsheet-hyperlinks.mdx
@@ -24,11 +24,11 @@ The Angular Spreadsheet component allows display of pre-existing hyperlinks in y
## Hyperlinks Overview
-Hyperlinks are added to the `Spreadsheet` control by accessing the `Hyperlinks` collection on the worksheet that you want to place the hyperlink on. This collection has an `Add` method that takes a `WorksheetHyperlink` object, where you can define the cell address, the hyperlink URL to be navigated to, the display text, and a tooltip to optionally be displayed on hover.
+Hyperlinks are added to the control by accessing the `Hyperlinks` collection on the worksheet that you want to place the hyperlink on. This collection has an `Add` method that takes a object, where you can define the cell address, the hyperlink URL to be navigated to, the display text, and a tooltip to optionally be displayed on hover.
## Dependencies
-When setting up your Angular spreadsheet control to use hyperlinks, you will need to import the `WorksheetHyperlink` class like so:
+When setting up your Angular spreadsheet control to use hyperlinks, you will need to import the class like so:
```ts
diff --git a/docs/angular/src/content/en/components/spreadsheet-overview.mdx b/docs/angular/src/content/en/components/spreadsheet-overview.mdx
index 2652e48903..e8b12b6e59 100644
--- a/docs/angular/src/content/en/components/spreadsheet-overview.mdx
+++ b/docs/angular/src/content/en/components/spreadsheet-overview.mdx
@@ -11,7 +11,7 @@ import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
# Angular Spreadsheet Overview
-The Angular Spreadsheet (Excel viewer) component is lightweight, feature-rich and supplied with all the necessary options for operating, visualizing, and editing all types of spreadsheet data – scientific, business, financial, and more. All the information can be presented in a tabular format that feels intuitive and easy to navigate across cells, panes, and worksheets. The `Spreadsheet` is complemented by flexible Excel-like interface, detailed charts, and features such as activation, cell editing, conditional formatting, styling, selection, clipboard.
+The Angular Spreadsheet (Excel viewer) component is lightweight, feature-rich and supplied with all the necessary options for operating, visualizing, and editing all types of spreadsheet data – scientific, business, financial, and more. All the information can be presented in a tabular format that feels intuitive and easy to navigate across cells, panes, and worksheets. The is complemented by flexible Excel-like interface, detailed charts, and features such as activation, cell editing, conditional formatting, styling, selection, clipboard.
## Angular Spreadsheet Example
@@ -67,7 +67,7 @@ npm install --save igniteui-angular-spreadsheet
## Component Modules
-The `Spreadsheet` requires the following modules:
+The requires the following modules:
@@ -114,7 +114,7 @@ Now that the Angular spreadsheet module is imported, next is the basic configura
-In the following code snippet, an external [ExcelUtility](excel-utility.md) class is used to save and load a `Workbook`.
+In the following code snippet, an external [ExcelUtility](excel-utility.md) class is used to save and load a .
The following demonstrates how to load a workbook into the Angular spreadsheet
@@ -147,5 +147,5 @@ ngOnInit() {
## API References
-
+
diff --git a/docs/angular/src/content/en/components/stepper.mdx b/docs/angular/src/content/en/components/stepper.mdx
index abb8cdb7f1..9eb839811b 100644
--- a/docs/angular/src/content/en/components/stepper.mdx
+++ b/docs/angular/src/content/en/components/stepper.mdx
@@ -119,7 +119,7 @@ Steps can be declared using one of the following approaches.
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/texthighlight.mdx b/docs/angular/src/content/en/components/texthighlight.mdx
index b65faa8a38..b9219ba779 100644
--- a/docs/angular/src/content/en/components/texthighlight.mdx
+++ b/docs/angular/src/content/en/components/texthighlight.mdx
@@ -149,7 +149,7 @@ Let's create a search box that we can use to highlight different parts of the te
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/time-picker.mdx b/docs/angular/src/content/en/components/time-picker.mdx
index dd2f463c77..f2c90f2e02 100644
--- a/docs/angular/src/content/en/components/time-picker.mdx
+++ b/docs/angular/src/content/en/components/time-picker.mdx
@@ -159,7 +159,7 @@ In the following example we have added a custom label and hint and changed the d
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
@@ -357,7 +357,7 @@ public onValidationFailed() {
The dropdown displays values within the min/max range (09:15:30 AM~06:15:30 PM) based on the items delta. A toast is added to show a message when an invalid time has been typed in.
-
+
The displayed values for each time portion in the dropdown/dialog are calculated based on the items delta always starting from zero. If the and does not match the items delta, the displayed values will start/end from the next/last possible value that matches the threshold.
diff --git a/docs/angular/src/content/en/components/tooltip.mdx b/docs/angular/src/content/en/components/tooltip.mdx
index eb450b3c2e..2b0bdab8be 100644
--- a/docs/angular/src/content/en/components/tooltip.mdx
+++ b/docs/angular/src/content/en/components/tooltip.mdx
@@ -235,7 +235,7 @@ Let's start by creating our map. We need a simple div that has for a background
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/transaction-how-to-use.mdx b/docs/angular/src/content/en/components/transaction-how-to-use.mdx
index e744474d1e..354c5551f2 100644
--- a/docs/angular/src/content/en/components/transaction-how-to-use.mdx
+++ b/docs/angular/src/content/en/components/transaction-how-to-use.mdx
@@ -86,7 +86,7 @@ In our html template, we define an compo
```
-
+
This example uses `igx-icon` with the default Material Icons family. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/tree.mdx b/docs/angular/src/content/en/components/tree.mdx
index 191abc25e9..0ab2b187a0 100644
--- a/docs/angular/src/content/en/components/tree.mdx
+++ b/docs/angular/src/content/en/components/tree.mdx
@@ -91,7 +91,7 @@ export class HomeComponent {}
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/treegrid/load-on-demand.mdx b/docs/angular/src/content/en/components/treegrid/load-on-demand.mdx
index 706be652a2..1a0b92f411 100644
--- a/docs/angular/src/content/en/components/treegrid/load-on-demand.mdx
+++ b/docs/angular/src/content/en/components/treegrid/load-on-demand.mdx
@@ -70,7 +70,7 @@ If you want to provide your own custom loading indicator, you may create an ng-t
```
-
+
This component uses Material Icons. Add the following link to your `index.html`: ``
diff --git a/docs/angular/src/content/en/components/treegrid/tree-grid.mdx b/docs/angular/src/content/en/components/treegrid/tree-grid.mdx
index c08effc974..0a7a91507b 100644
--- a/docs/angular/src/content/en/components/treegrid/tree-grid.mdx
+++ b/docs/angular/src/content/en/components/treegrid/tree-grid.mdx
@@ -301,7 +301,7 @@ To get started with styling the Tree Grid, we need to import the `index` file, w
Following the simplest approach, we create a new theme that extends the and accepts the parameters, required to customize the tree grid as desired.
-
+
There is no specific `sass` tree grid function.
@@ -320,8 +320,8 @@ $custom-theme: grid-theme(
);
```
-
-Instead of hardcoding the color values like we just did, we can achieve greater flexibility in terms of colors by using the and functions. Please refer to [`Palettes`](/themes/sass/palettes) topic for detailed guidance on how to use them.
+
+Instead of hardcoding the color values like we just did, we can achieve greater flexibility in terms of colors by using the [`palette`]({environment:sassApiUrl}/palettes#function-palette) and [`color`]({environment:sassApiUrl}/palettes#function-color) functions. Please refer to [`Palettes`](/themes/sass/palettes) topic for detailed guidance on how to use them.
The last step is to **include** the component theme in our application.
diff --git a/docs/angular/src/content/en/components/zoomslider-overview.mdx b/docs/angular/src/content/en/components/zoomslider-overview.mdx
index a413207e1f..9a98402f11 100644
--- a/docs/angular/src/content/en/components/zoomslider-overview.mdx
+++ b/docs/angular/src/content/en/components/zoomslider-overview.mdx
@@ -15,7 +15,7 @@ The Angular ZoomSlider control provides zooming functionality to range-enabled c
## Angular Zoom Slider Example
-The following sample demonstrates how to use `ZoomSlider` to navigate content in `DataChart`.
+The following sample demonstrates how to use to navigate content in .
@@ -53,7 +53,7 @@ npm install --save igniteui-angular-charts
## Component Modules
-The `ZoomSlider` requires the following modules:
+The requires the following modules:
diff --git a/docs/angular/src/content/en/grids_templates/column-types.mdx b/docs/angular/src/content/en/grids_templates/column-types.mdx
index 554735cee6..27372bd36f 100644
--- a/docs/angular/src/content/en/grids_templates/column-types.mdx
+++ b/docs/angular/src/content/en/grids_templates/column-types.mdx
@@ -79,7 +79,7 @@ The appearance of the date portions will be set (e.g. day, month, year) based on
- **format** - The default value for formatting the date is 'mediumDate'. Other available options are 'short', 'long', 'shortDate', 'fullDate', 'longTime', 'fullTime' and etc. This is a full list of all available [pre-defined Angular format options](https://angular.io/api/common/DatePipe#pre-defined-format-options) (legacy).
- **timezone** - The user's local system timezone is the default value. The timezone offset or standard GMT/UTC or continental US timezone abbreviation can also be passed. Different timezone examples which will display the corresponding time of the location anywhere in the world:
-
+
Since 20.2.x, if you have the Angular localization disabled, the list of available format options can be found in our new [localization topic](../general/localization#formatting).
diff --git a/docs/angular/src/content/en/grids_templates/export-excel.mdx b/docs/angular/src/content/en/grids_templates/export-excel.mdx
index c73b00deec..8a5424ec45 100644
--- a/docs/angular/src/content/en/grids_templates/export-excel.mdx
+++ b/docs/angular/src/content/en/grids_templates/export-excel.mdx
@@ -173,7 +173,7 @@ Once wired up, pressing the respective buttons downloads files named `ExportedDa
Expand/collapse indicators in Excel are shown based on the hierarchy of the last dimension of the Pivot Grid.
-
+
The exported {ComponentTitle} will not be formatted as a table, since Excel tables do not support multiple row headers.
diff --git a/docs/angular/src/content/en/grids_templates/keyboard-navigation.mdx b/docs/angular/src/content/en/grids_templates/keyboard-navigation.mdx
index 846a87d503..7c804a70df 100644
--- a/docs/angular/src/content/en/grids_templates/keyboard-navigation.mdx
+++ b/docs/angular/src/content/en/grids_templates/keyboard-navigation.mdx
@@ -318,7 +318,7 @@ Use the demo below to try out the custom scenarios that we just implemented:
(obj) => { obj.target.nativeElement.focus(); });
```
-
+
Please refer to the sample code for full implementation details.
@@ -347,7 +347,7 @@ Use the demo below to try out the custom scenarios that we just implemented:
(obj) => { obj.target.nativeElement.focus(); });
```
-
+
Please refer to the sample code for full implementation details.
diff --git a/docs/angular/src/content/en/grids_templates/multi-column-headers.mdx b/docs/angular/src/content/en/grids_templates/multi-column-headers.mdx
index e896f8e2d2..d4927552fb 100644
--- a/docs/angular/src/content/en/grids_templates/multi-column-headers.mdx
+++ b/docs/angular/src/content/en/grids_templates/multi-column-headers.mdx
@@ -159,7 +159,7 @@ For achieving `n-th` level of nested headers, the declaration above should be fo
Every supports [`moving`](column-moving), [`pinning`](column-pinning) and [`hiding`](column-hiding).
-
+
When there is a set of columns and column groups, pinning works only for top level column parents. More specifically pinning per nested `column groups` or `columns` is not allowed.
Please note that when using Pinning with Multi-Column Headers, the entire Group gets pinned.
Moving between `columns` and `column groups` is allowed only when they are at the same level in the hierarchy and both are in the same `group`.
diff --git a/docs/angular/src/content/en/grids_templates/row-editing.mdx b/docs/angular/src/content/en/grids_templates/row-editing.mdx
index a335f718d5..75ff282076 100644
--- a/docs/angular/src/content/en/grids_templates/row-editing.mdx
+++ b/docs/angular/src/content/en/grids_templates/row-editing.mdx
@@ -151,7 +151,7 @@ Then define a {ComponentTitle} with bound data source and
+
It's not needed to enable editing for individual columns. Using the property in the {ComponentTitle}, will mean that all rows, with defined `field` property, excluding primary one, will be editable. If you want to disable editing for specific column, then you set the column's input to `false`.
diff --git a/docs/angular/src/content/en/grids_templates/row-selection.mdx b/docs/angular/src/content/en/grids_templates/row-selection.mdx
index dd34b9fa67..92203a112c 100644
--- a/docs/angular/src/content/en/grids_templates/row-selection.mdx
+++ b/docs/angular/src/content/en/grids_templates/row-selection.mdx
@@ -322,7 +322,7 @@ public handleRowSelectionChange(args) {
### Select all rows
Another useful API method that provides is `selectAll(onlyFilteredData)`. By default this method will select all data rows, but if filtering is applied, it will select only the rows that match the filter criteria. But if you call the method with _false_ parameter, `selectAll(false)` will always select all data in the grid, even if filtering is applied.
-
+
Keep in mind that `selectAll()` will not select the rows that are deleted.
diff --git a/docs/angular/src/content/en/grids_templates/sorting.mdx b/docs/angular/src/content/en/grids_templates/sorting.mdx
index 8a81124d50..7b372e2ac6 100644
--- a/docs/angular/src/content/en/grids_templates/sorting.mdx
+++ b/docs/angular/src/content/en/grids_templates/sorting.mdx
@@ -168,7 +168,7 @@ this.{ComponentObjectRef}.clearSort();
The of the **{ComponentTitle}** is of different type compared to the of the **column**, since they work in different scopes and expose different parameters.
-
+
The sorting operation **DOES NOT** change the underlying data source of the {ComponentTitle}.
diff --git a/docs/angular/src/content/en/grids_templates/toolbar.mdx b/docs/angular/src/content/en/grids_templates/toolbar.mdx
index 047a751318..cf382cbbf2 100644
--- a/docs/angular/src/content/en/grids_templates/toolbar.mdx
+++ b/docs/angular/src/content/en/grids_templates/toolbar.mdx
@@ -108,7 +108,7 @@ The predefined `actions` and `title` UI components are added inside the `
-
+
As seen in the code snippet above, the predefined `actions` UI components are wrapped in the . This way, the toolbar title is aligned to the left of the toolbar and the actions are aligned to the right of the toolbar.
diff --git a/docs/angular/src/content/en/grids_templates/validation.mdx b/docs/angular/src/content/en/grids_templates/validation.mdx
index 5d1522d5fa..dbde2ab69b 100644
--- a/docs/angular/src/content/en/grids_templates/validation.mdx
+++ b/docs/angular/src/content/en/grids_templates/validation.mdx
@@ -137,7 +137,7 @@ Validation will be triggered in the following scenarios:
- When updating cells/rows via the API - , etc..
- When using batch editing and the / API of the transaction service.
-
+
Validation will not trigger for records that have not been edited via user input or via the editing API. Visual indicators on the cell will only shown if the related input is considered touched - either via user interaction or via the `markAsTouched` API of the validation service.
diff --git a/docs/angular/src/content/jp/components/action-strip.mdx b/docs/angular/src/content/jp/components/action-strip.mdx
index edc4a777ab..ec176da5c8 100644
--- a/docs/angular/src/content/jp/components/action-strip.mdx
+++ b/docs/angular/src/content/jp/components/action-strip.mdx
@@ -80,7 +80,7 @@ import { IgxIconComponent } from 'igniteui-angular/icon';
export class HomeComponent {}
```
-
+
このコンポーネントはマテリアル アイコンを使用します。`index.html` に次のリンクを追加してください: ``
diff --git a/docs/angular/src/content/jp/components/ai/ai-assisted-development-overview.mdx b/docs/angular/src/content/jp/components/ai/ai-assisted-development-overview.mdx
index 153d746d8d..0436d97480 100644
--- a/docs/angular/src/content/jp/components/ai/ai-assisted-development-overview.mdx
+++ b/docs/angular/src/content/jp/components/ai/ai-assisted-development-overview.mdx
@@ -1,136 +1,95 @@
---
-title: Ignite UI を使用した AI 支援開発 - Ignite UI for Angular
-description: Ignite UI は、エージェント スキル、Ignite UI CLI MCP サーバー、Theming MCP サーバーを提供し、Angular、React、Web Components 向けに AI コーディング アシスタントを正確なコンポーネント API、インポート パス、デザイン トークンで補完します。
-keywords: Angular, Ignite UI for Angular, Infragistics, MCP, Model Context Protocol, Ignite UI CLI MCP, Ignite UI Theming MCP, エージェント スキル, AI, エージェント, Copilot, Cursor
-_language: ja
+title: "Ignite UI を使った AI 支援開発 - Ignite UI for Angular"
+description: "Ignite UI は、Angular、React、Web Components 全体で正しいコンポーネント API、インポート パス、デザイン トークンを AI コーディング アシスタントに提供するために、エージェント スキル、Ignite UI CLI MCP サーバー、Theming MCP サーバーを提供します。"
+keywords: "Angular, Ignite UI for Angular, Infragistics, MCP, Model Context Protocol, Ignite UI CLI MCP, Ignite UI Theming MCP, エージェント スキル, AI, エージェント, Copilot, Cursor"
license: MIT
-canonicalLink: "/components/ai-assisted-development-overview"
+_canonicalLink: "{environment:dvUrl}/components/ai-assisted-development-overview"
mentionedTypes: []
last_updated: "2026-04-21"
---
-import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro';
+# Ignite UI を使った AI 支援開発
-# Ignite UI を使用した AI 支援開発
+Ignite UI for Angular、React、Web Components は、3 つのパーツで構成される AI ツールチェーン (エージェント スキル、Ignite UI CLI MCP サーバー、Ignite UI Theming MCP サーバー) を提供します。これにより、AI コーディング アシスタントに正しいコンポーネント API、インポート パス、デザイン トークンを提供します。エージェント スキルは、AI エージェントが特定のプロジェクトで Ignite UI を使用する方法を定義する、開発者が管理する命令パッケージです。CLI MCP サーバーは、Model Context Protocol を介してアクティブな AI エージェント セッションに Ignite UI CLI スキャフォールディング、コンポーネント管理、ドキュメント ツールを公開します。Theming MCP サーバーは、Ignite UI テーマ エンジンをクエリ可能なエージェント コンテキストとして公開します。3 つのコンポーネントはすべて、GitHub Copilot、Cursor、Claude Desktop、Claude Code、JetBrains AI Assistant と連携します。
-Ignite UI for Angular、React、Web Components は、エージェント スキル、Ignite UI CLI MCP サーバー、Ignite UI Theming MCP サーバーの 3 部構成の AI ツールチェーンを提供します。これにより、AI コーディング アシスタントが正確なコンポーネント API、インポート パス、デザイン トークンを使用できます。エージェント スキルは、開発者が所有するインストラクション パッケージで、特定のプロジェクトで AI エージェントが Ignite UI を使用する方法を定義します。CLI MCP サーバーは、Model Context Protocol を通じてアクティブな AI エージェント セッションに Ignite UI CLI スキャフォールディング、コンポーネント管理、ドキュメント ツールを公開します。Theming MCP サーバーは、Ignite UI Theming Engine をクエリ可能なエージェント コンテキストとして公開します。3 つのコンポーネントはすべて、GitHub Copilot、Cursor、Claude Desktop、Claude Code、JetBrains AI Assistant と連携します。
-
-AI ツールチェーンは、現在、CLI MCP とエージェント スキル レイヤーでの Blazor をサポートしていません。Blazor のカバレッジは Theming MCP のみで提供されます。CLI MCP サーバーは STDIO トランスポートを必要とします。HTTP ベースの MCP クライアントはサポートされていません。エージェント スキルと CLI MCP サーバーは、プロジェクト ファイルを自律的に変更しません。開発者のプロンプトに応じてアクティブな AI エージェントにツールとインストラクションを公開します。
+AI ツールチェーンは、現在、CLI MCP およびエージェント スキル レイヤーで Blazor をサポートしていません。Blazor の対応は Theming MCP のみで提供されます。CLI MCP サーバーには STDIO トランスポートが必要であり、HTTP ベースの MCP クライアントはサポートされていません。エージェント スキルと CLI MCP サーバーは、プロジェクト ファイルを自律的に変更することはなく、アクティブな AI エージェントにツールと命令を公開し、開発者のプロンプトに応じてエージェントが動作します。
## AI ツールチェーンの概要
-Ignite UI の AI ツールチェーンは、独立して使用可能な 3 つのレイヤーで構成されています。各レイヤーは単独で有効化でき、連携して動作するように設計されています。
+Ignite UI の AI ツールチェーンは、独立して使用可能な 3 つのレイヤーで構成されています。各レイヤーは単独で有効にすることができ、連携して動作するように設計されています。
-| レイヤー | 提供内容 | オーナー | フレームワーク |
-| --------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------------ | -------------------------------------- |
-| エージェント スキル | 開発者所有のインストラクション パッケージ: インポート パス、コンポーネント パターン、デシジョン フロー、プロジェクト規約 | 開発者 | Angular、React、Web Components、Blazor |
-| CLI MCP サーバー (`igniteui-cli`) | MCP 経由のプロジェクト スキャフォールディング、コンポーネント管理、ドキュメントと API クエリ | Infragistics | Angular、React、Web Components |
-| Theming MCP サーバー (`igniteui-theming`) | デザイン トークン、パレット定義、CSS カスタム プロパティ生成、WCAG AA コントラスト検証 | Infragistics | Angular、React、Web Components、Blazor |
+| レイヤー | 提供するもの | 所有者 | フレームワーク |
+| --- | --- | --- | --- |
+| エージェント スキル | 開発者が管理する命令パッケージ: インポート パス、コンポーネント パターン、デシジョン フロー、プロジェクト規約 | 開発者 | Angular、React、Web Components、Blazor |
+| CLI MCP サーバー (`igniteui-cli`) | MCP を介したプロジェクト スキャフォールディング、コンポーネント管理、ドキュメントと API クエリ | Infragistics | Angular、React、Web Components |
+| Theming MCP サーバー (`igniteui-theming`) | デザイン トークン、パレット定義、CSS 変数生成、MCP を介したテーマ クエリ | Infragistics | Angular、React、Web Components、Blazor |
-CLI MCP サーバーと Theming MCP サーバーはいずれも `npx` 経由で起動し、STDIO トランスポートを通じて任意の MCP 互換クライアントに接続します。エージェント スキルは、AI クライアントがディスクから読み取るプロジェクトに配置されたローカル ファイルです。
+CLI MCP サーバーと Theming MCP サーバーはどちらも `npx` を通じて起動され、STDIO トランスポートを介して任意の MCP 互換クライアントに接続します。エージェント スキルは、AI クライアントがディスクから読み取る、プロジェクトに配置されたローカル ファイルです。
## エージェント スキル
-エージェント スキルは、特定のフレームワークで Ignite UI を使用する方法を AI コーディング アシスタントに正確に伝える、構造化された開発者所有のパッケージです。スキル パッケージには、コンポーネント パターン、インポート パス、デシジョン フローを含む `SKILL.md` インストラクション ファイル、公式の Ignite UI ドキュメントへの参照、スキーマ ファイルやダイアグラムなどのアセットを含めることができます。スキルが AI クライアントでアクティブな場合、エージェントは一般的なトレーニング データではなくスキルに従います。一般的なトレーニング データは古い API シグネチャやインポート パスを参照している可能性があります。
+エージェント スキルは、特定のフレームワークにおける Ignite UI の使用方法を、AI コーディング アシスタントに正確に伝えるための、開発者が管理する構造化されたパッケージです。スキル パッケージには、コンポーネント パターン、インポート パス、デシジョン フローを含む `SKILL.md` 命令ファイル、Ignite UI 公式ドキュメントへの参照、スキーマ ファイルや図などのアセットを含めることができます。スキルが AI クライアントでアクティブになると、エージェントは、古い API シグネチャやインポート パスを引用する恐れのある一般的な学習データに依存する代わりに、スキルに従います。
-Ignite UI は Angular、React、Web Components、Blazor 向けの専用スキル パッケージを同梱しています。スキル パッケージは開発者が所有します: `SKILL.md` を編集してチームの規約に合わせ、プロジェクト固有のパターンを追加し、内部デザイン システムを参照し、コードベースと共にパッケージをバージョン管理してください。
+Ignite UI は、Angular、React、Web Components、Blazor 向けの専用スキル パッケージを提供しています。スキル パッケージは開発者が管理するものであり、チームの規約に合わせて `SKILL.md` を編集したり、プロジェクト固有のパターンの追加や内部デザイン システムを参照するなどして、コードベースとともにパッケージをバージョン管理できます。
完全なセットアップ手順と IDE の設定については、[エージェント スキル](skills.md)を参照してください。
## CLI MCP サーバー
-Ignite UI CLI MCP サーバー (`igniteui-cli`) は、Infragistics が管理する MCP サーバーで、アクティブな AI エージェント セッションに Ignite UI CLI スキャフォールディングとドキュメント ツールを公開します。接続すると、AI アシスタントはチャット セッション内の自然言語プロンプトを通じて、Angular、React、Web Components プロジェクトの作成、Ignite UI コンポーネントの追加と変更、ドキュメントと API の質問に回答できます。
+Ignite UI CLI MCP サーバー (`igniteui-cli`) は、Infragistics が管理する MCP サーバーで、Ignite UI CLI スキャフォールディングとドキュメント ツールをアクティブな AI エージェント セッションに公開します。接続すると、AI アシスタントはチャット セッションの自然言語プロンプトを通じて、Angular、React、または Web Components プロジェクトの作成、Ignite UI コンポーネントの追加と変更、ドキュメントと API の質問への回答を行うことができます。
-CLI MCP サーバーはグローバル インストールなしに `npx` 経由で起動します:
+CLI MCP サーバーはグローバル インストールなしで `npx` 経由で起動します。
```bash
npx -y igniteui-cli mcp
```
-このサーバーは、VS Code with GitHub Copilot、GitHub Copilot クラウド エージェント、Cursor、Claude Desktop、Claude Code、JetBrains AI Assistant、および STDIO トランスポートをサポートする他の MCP 互換クライアントに接続します。設定形式はクライアントによって異なります。以下の CLI MCP セットアップ ガイドを参照してください。
+サーバーは、GitHub Copilot を使用した VS Code、Cursor、Claude Desktop、Claude Code、JetBrains AI Assistant、および STDIO トランスポートをサポートするその他の MCP 互換クライアントに接続します。クライアントによって構成形式が異なります。以下の CLI MCP セットアップ ガイドを参照してください。
-CLI MCP サーバーは Blazor をサポートしていません。コードを自律的に生成しません。開発者のプロンプトに応じて AI エージェントにツールを公開します。
+CLI MCP サーバーは Blazor をサポートしていません。また、CLI MCP サーバーはコードを自律的に生成することはなく、AI エージェントにツールを公開するのみです。開発者のプロンプトに応じてエージェントがツールを呼び出します。
## Theming MCP サーバー
-Ignite UI Theming MCP サーバー (`igniteui-theming`) は、Ignite UI Theming Engine をクエリ可能なエージェント コンテキストとして公開する別の MCP サーバーです。デザイン トークン アクセス、パレット定義、CSS カスタム プロパティ生成、WCAG AA コントラスト検証をカバーします。CLI MCP サーバーとはアーキテクチャ的に分離されており、プロジェクト スキャフォールディング ツールを公開せずに AI エージェントにテーマ ツールへのアクセスを提供するために独立して接続できます。
+Ignite UI Theming MCP サーバー (`igniteui-theming`) は、Ignite UI テーマ エンジンをクエリ可能なエージェント コンテキストとして公開する別の MCP サーバーです。デザイン トークン アクセス、パレット定義、CSS カスタム プロパティ生成、WCAG AA コントラスト検証をカバーします。CLI MCP サーバーとはアーキテクチャ的に分離されており、プロジェクト スキャフォールディング ツールを公開せずに AI エージェントにテーマ ツールへのアクセスを提供するために、独立して接続できます。
-Theming MCP サーバーは `npx` 経由で起動します:
+Theming MCP サーバーは `npx` 経由で起動します。
```bash
npx -y igniteui-theming igniteui-theming-mcp
```
-Theming MCP サーバーは Angular、React、Web Components、Blazor をサポートしています。Ignite UI のリリースごとに更新されるため、エージェントは常に現在のトークン サーフェスに対して動作します。
+Theming MCP サーバーは Angular、React、Web Components、Blazor をサポートしています。Ignite UI のリリースごとに更新されるため、エージェントは常に最新のトークン サーフェスに対して動作します。
-設定の詳細については、[Theming MCP](theming-mcp.md) を参照してください。
+構成の詳細については、[Theming MCP](theming-mcp.md)を参照してください。
## サポートされている AI クライアント
-CLI MCP サーバーと Theming MCP サーバーは、STDIO トランスポートで MCP をサポートする任意のエディターまたは AI クライアントで動作します。
+CLI MCP サーバーと Theming MCP サーバーは、STDIO トランスポートで MCP をサポートする任意のエディターまたは AI クライアントと連携します。
-| クライアント | 設定方法 |
-| --------------------------- | ----------------------------------------------------------------- |
-| VS Code with GitHub Copilot | `.vscode/mcp.json` |
-| Cursor | `.cursor/mcp.json` |
-| Claude Desktop (macOS) | `~/Library/Application Support/Claude/claude_desktop_config.json` |
-| Claude Desktop (Windows) | `%APPDATA%\Claude\claude_desktop_config.json` |
-| Claude Code | `.mcp.json` または Claude Code MCP CLI コマンド |
-| JetBrains AI Assistant | **ツール → AI Assistant → Model Context Protocol (MCP)** |
+| クライアント | 構成方法 |
+| --- | --- |
+| GitHub Copilot を使用した VS Code | `.vscode/mcp.json` |
+| Cursor | `.cursor/mcp.json` |
+| Claude Desktop (macOS) | `~/Library/Application Support/Claude/claude_desktop_config.json` |
+| Claude Desktop (Windows) | `%APPDATA%\Claude\claude_desktop_config.json` |
+| Claude Code | `.mcp.json` または Claude Code MCP CLI コマンド |
+| JetBrains AI Assistant | **Tools → AI Assistant → Model Context Protocol (MCP)** |
-エージェント スキルは、GitHub Copilot では `.github/copilot-instructions.md`、Cursor では `.cursorrules` または `.cursor/rules/`、Windsurf では `.windsurfrules`、JetBrains AI Assistant ではプロジェクト レベルのプロンプト設定と互換性があります。
+エージェント スキルは、`.github/copilot-instructions.md` を介した GitHub Copilot、`.cursorrules` または `.cursor/rules/` を介した Cursor、`.windsurfrules` を介した Windsurf、プロジェクト レベルのプロンプト設定を介した JetBrains AI Assistant と互換性があります。
## AI ツールチェーンのセットアップ
-`ig ai-config` を使用して、1 つのコマンドでエージェント スキルと両方の MCP サーバーを設定します。各レイヤーを個別に制御する場合、または既存のプロジェクトでツールチェーンの一部のみを設定する場合は、以下の手順に従ってください。`ig ai-config` を実行すると、1 回の操作でステップ 1、2、3 が完了します。
-
-### クイック セットアップ
-
-`ai-config` コマンドは、Ignite UI エージェント スキルを `.claude/skills/` にコピーし、Ignite UI MCP サーバー設定を `.vscode/mcp.json` に書き込みます。ファイルが既に存在し、最新の状態であれば、このコマンドは何もしません。
-
-**Angular Schematics を使用する場合:**
-
-```bash
-ng generate @igniteui/angular-schematics:ai-config
-```
+Ignite UI AI ツールチェーンのセットアップには 3 つのステップがあります。フレームワークのエージェント スキルをロードし、CLI MCP サーバーを接続し、オプションで Theming MCP サーバーを接続します。3 つのステップはすべて独立しており、任意の順序で実行できます。
-これにより、Ignite UI サーバーと共に `@angular/cli` MCP サーバーも `.vscode/mcp.json` に登録されます。
+### ステップ 1 - エージェント スキルをロードする
-**Ignite UI CLI を使用する場合:**
+フレームワークの Ignite UI スキル パッケージをプロジェクトのエージェント検出パスにコピーします。スキル パッケージは `node_modules/igniteui-{framework}/skills/` のライブラリに付属しています。IDE との連携設定はクライアントに応じてその構成ファイルに保存してください。
-```bash
-npx igniteui-cli ai-config
-```
-
-Ignite UI CLI がグローバルにインストールされている場合は、短縮形を使用します:
-
-```bash
-ig ai-config
-```
+完全なセットアップについては、[エージェント スキル](skills.md)を参照してください。
-
+### ステップ 2 - CLI MCP サーバーを接続する
-`npx igniteui-cli` と `ig` 形式は `@angular/cli` MCP サーバーを登録しません。1 回の操作で 3 つのサーバーをすべて設定する場合は、上記の Angular Schematics コマンドを使用してください。
-
-
-
-
-
-
-このコマンドには、プロジェクトに Ignite UI パッケージがインストールされている必要があります (`npm install`)。スキル ファイルが見つからない場合は、パッケージが最新の状態であることを確認してください。
-
-
-
-
-### ステップ 1 — エージェント スキルのロード
-
-フレームワーク用の Ignite UI スキル パッケージをプロジェクトのエージェント検出パスにコピーします。スキル パッケージは `node_modules/igniteui-{framework}/skills/` のライブラリと共に同梱されています。使用しているクライアントの永続的なセットアップを使用して IDE に接続します。
-
-完全なセットアップについては、[エージェント スキル](skills.md) を参照してください。
-
-### ステップ 2 — CLI MCP サーバーへの接続
-
-AI クライアントの設定ファイルに `igniteui-cli` MCP サーバー エントリを追加します。クライアントに合った JSON 構造を使用します:
+AI クライアントの構成ファイルに `igniteui-cli` MCP サーバー エントリを追加します。クライアントに合った JSON 構造を使用してください。
**VS Code (`.vscode/mcp.json`):**
@@ -158,11 +117,11 @@ AI クライアントの設定ファイルに `igniteui-cli` MCP サーバー
}
```
-VS Code、GitHub、Cursor、Claude Desktop、Claude Code、JetBrains、その他の MCP 互換クライアントを含む完全なセットアップ ガイドについては、[CLI MCP](cli-mcp.md) を参照してください。
+VS Code、GitHub、Cursor、Claude Desktop、Claude Code、JetBrains、その他の MCP 互換クライアントを含む完全なセットアップ ガイドについては、[CLI MCP](cli-mcp.md)を参照してください。
-### ステップ 3 — Theming MCP サーバーへの接続 (オプション)
+### ステップ 3 - Theming MCP サーバーを接続する (オプション)
-`igniteui-cli` と並べて同じ MCP 設定ファイルに `igniteui-theming` エントリを追加します:
+`igniteui-cli` と並んで、同じ MCP 構成ファイルに `igniteui-theming` エントリを追加します。
```json
{
@@ -175,17 +134,18 @@ VS Code、GitHub、Cursor、Claude Desktop、Claude Code、JetBrains、その他
}
```
-設定の詳細とテーマ ワークフローについては、[Theming MCP](theming-mcp.md) を参照してください。
+構成の詳細とテーマ ワークフローについては、[Theming MCP](theming-mcp.md)を参照してください。
## その他のリソース
+
- [エージェント スキル](./skills.md)
- [Ignite UI CLI MCP](./cli-mcp.md)
- [Ignite UI Theming MCP](./theming-mcp.md)
-コミュニティは常に活気があり、新しいアイデアを歓迎しています。
+コミュニティに参加して新しいアイデアをご提案ください。
- [Ignite UI for Angular **フォーラム** (英語)](https://www.infragistics.com/community/forums/f/ignite-ui-for-angular)
- [Ignite UI for Angular **GitHub** (英語)](https://github.com/IgniteUI/igniteui-angular)
diff --git a/docs/angular/src/content/jp/components/ai/cli-mcp.mdx b/docs/angular/src/content/jp/components/ai/cli-mcp.mdx
index 211b1256b0..186f5cc49c 100644
--- a/docs/angular/src/content/jp/components/ai/cli-mcp.mdx
+++ b/docs/angular/src/content/jp/components/ai/cli-mcp.mdx
@@ -1,145 +1,151 @@
---
-title: Angular Ignite UI CLI MCP | Infragistics
-description: Ignite UI CLI MCP を AI クライアントに接続して、Ignite UI for Angular のプロジェクト スキャフォールディング、既存アプリの変更、コンポーネントの作成と更新、ドキュメントの質問に対応します。VS Code、GitHub、Cursor、Claude Desktop、Claude Code、JetBrains、その他の MCP クライアントのセットアップ オプションをご覧ください。
-keywords: Angular, Ignite UI for Angular, Infragistics, Ignite UI CLI MCP, Ignite UI Theming MCP, MCP, Model Context Protocol, AI, エージェント, GitHub Copilot, Cursor, Claude, JetBrains
-_language: ja
+title: "Angular Ignite UI CLI MCP | Infragistics"
+description: "Ignite UI CLI MCP を AI クライアントに接続して、Ignite UI for Angular のプロジェクトのスキャフォールディング、既存アプリの変更、コンポーネントの作成と更新、ドキュメントの質問に回答します。VS Code、GitHub、Cursor、Claude Desktop、Claude Code、JetBrains、その他の MCP クライアントのセットアップ オプションについて説明します。"
+keywords: "Angular, Ignite UI for Angular, Infragistics, Ignite UI CLI MCP, Ignite UI Theming MCP, MCP, Model Context Protocol, AI, エージェント, GitHub Copilot, Cursor, Claude, JetBrains"
license: MIT
-canonicalLink: "/components/ai/cli-mcp"
+_canonicalLink: "{environment:dvUrl}/components/ai/cli-mcp"
mentionedTypes: []
last_updated: "2026-04-21"
---
-
import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro';
# Ignite UI CLI MCP
-
Ignite UI CLI MCP は Model Context Protocol (MCP) サーバーで、AI アシスタントが Ignite UI for Angular アプリケーションのプロジェクト スキャフォールディング、既存アプリの変更、コンポーネントの作成と更新、ドキュメントへの質問に対応できるようにします。Ignite UI CLI MCP をエディター、GitHub リポジトリ、またはデスクトップ AI クライアントに接続して、行いたいことを説明すると、アシスタントが CLI ツールを代わりに操作します。
+
Ignite UI CLI MCP は、AI アシスタントが Ignite UI for Angular アプリケーションのプロジェクトのスキャフォールディング、既存アプリの変更、コンポーネントの作成と更新、ドキュメントの質問に回答できるようにする Model Context Protocol (MCP) サーバーです。Ignite UI CLI MCP をエディター、GitHub リポジトリ、またはデスクトップ AI クライアントに接続し、やりたいことを伝えると、アシスタントが CLI ツールを使用します。
-The Ignite UI Theming MCP is a Model Context Protocol (MCP) server that enables AI assistants to generate production-ready theming code for Ignite UI applications. MCP is an open standard that lets AI assistants call specialized tools provided by external servers. Connect the Ignite UI Theming MCP to your editor or desktop AI client and describe what you want — the assistant does the rest.
-
|
## {Platform} Data Chart API
-The {Platform} `DataChart` has the following API members:
+The {Platform} has the following API members:
| Chart Properties | Axis Classes |
|------------------|--------------|
-| - `SeriesViewer.Title` - `SeriesViewer.Subtitle` - `IsHorizontalZoomEnabled` - `IsVerticalZoomEnabled` - `Brushes` - `Outlines` - `MarkerBrushes` - `MarkerOutlines` - `DataChart.Axes` - `SeriesViewer.Series` | - `Axis` is base class for all axis types - `CategoryXAxis` used with [Category Series](types/column-chart.md), [Stacked Series](types/stacked-chart.md), and [Financial Series](types/stock-chart.md) - `CategoryYAxis` used with [Category Series](types/column-chart.md), [Stacked Series](types/stacked-chart.md) - `CategoryAngleAxis` used with [Radial Series](types/radial-chart.md) - `NumericXAxis` used with [Scatter Series](types/scatter-chart.md) and [Bar Series](types/bar-chart.md) - `NumericYAxis` used with [Scatter Series](types/scatter-chart.md), [Category Series](types/column-chart.md), [Stacked Series](types/stacked-chart.md), and [Financial Series](types/stock-chart.md) - `NumericAngleAxis` used with [Polar Series](types/polar-chart.md) - `NumericRadiusAxis` used with [Polar Series](types/polar-chart.md) and [Radial Series](types/radial-chart.md) - `TimeXAxis` used with [Category Series](types/column-chart.md) and [Financial Series](types/stock-chart.md)
|
+| - `SeriesViewer.Title` - `SeriesViewer.Subtitle` - - - - - - - `DataChart.Axes` - `SeriesViewer.Series` | - is base class for all axis types - used with [Category Series](types/column-chart.md), [Stacked Series](types/stacked-chart.md), and [Financial Series](types/stock-chart.md) - used with [Category Series](types/column-chart.md), [Stacked Series](types/stacked-chart.md) - used with [Radial Series](types/radial-chart.md) - used with [Scatter Series](types/scatter-chart.md) and [Bar Series](types/bar-chart.md) - used with [Scatter Series](types/scatter-chart.md), [Category Series](types/column-chart.md), [Stacked Series](types/stacked-chart.md), and [Financial Series](types/stock-chart.md) - used with [Polar Series](types/polar-chart.md) - used with [Polar Series](types/polar-chart.md) and [Radial Series](types/radial-chart.md) - used with [Category Series](types/column-chart.md) and [Financial Series](types/stock-chart.md)
|
-The {Platform} `DataChart` can use the following type of series that inherit from `Series`:
+The {Platform} can use the following type of series that inherit from :
| Category Series | Stacked Series |
|------------------|----------------|
-| - `AreaSeries` - `BarSeries` - `ColumnSeries` - `LineSeries` - `PointSeries` - `SplineSeries` - `SplineAreaSeries` - `StepLineSeries` - `StepAreaSeries` - `RangeAreaSeries` - `RangeColumnSeries` - `WaterfallSeries` | - `StackedAreaSeries` - `StackedBarSeries` - `StackedColumnSeries` - `StackedLineSeries` - `StackedSplineSeries` - `Stacked100AreaSeries` - `Stacked100BarSeries` - `Stacked100ColumnSeries` - `Stacked100LineSeries` - `Stacked100SplineSeries`
| - - - - - |
## {Platform} Data Legend API
-The {Platform} `DataLegend` has the following API members:
-
-- `IncludedColumns`
-- `ExcludedColumns`
-- `IncludedSeries`
-- `ExcludedSeries`
-- `ValueFormatAbbreviation`
-- `ValueFormatMode`
-- `ValueFormatCulture`
-- `ValueFormatMinFractions`
-- `ValueFormatMaxFractions`
-- `ValueTextColor`
-- `TitleTextColor`
-- `LabelTextColor`
-- `UnitsTextColor`
-- `SummaryType`
-- `HeaderTextColor`
-- `BadgeShape`
+The {Platform} has the following API members:
+
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
## {Platform} Donut Chart API
-The {Platform} `DoughnutChart` has the following API members:
+The {Platform} has the following API members:
-- `AllowSliceExplosion`
-- `AllowSliceSelection`
-- `InnerExtent`
+-
+-
+-
## {Platform} Data Pie Chart API
-The {Platform} `DataPieChart` has the following API members:
+The {Platform} has the following API members:
- `DataPieChart.ChartType`
- `DataPieChart.HighlightingBehavior`
@@ -95,7 +97,7 @@ The {Platform} `DataPieChart` has the following API members:
## {Platform} Pie Chart API
-The {Platform} `PieChart` has the following API members:
+The {Platform} has the following API members:
- `PieChart.LegendItemBadgeTemplate`
- `PieChart.LegendItemTemplate`
@@ -106,15 +108,15 @@ The {Platform} `PieChart` has the following API members:
## {Platform} Sparkline Chart API
-The {Platform} `Sparkline` has the following API members:
+The {Platform} has the following API members:
-- `DisplayNormalRangeInFront`
+-
- `Sparkline.DisplayType`
-- `LowMarkerBrush`
-- `LowMarkerSize`
-- `LowMarkerVisibility`
-- `NormalRangeFill`
-- `UnknownValuePlotting`
+-
+-
+-
+-
+-
## Additional Resources
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-annotations.mdx b/docs/xplat/src/content/en/components/charts/features/chart-annotations.mdx
index 7de9ed17d0..0d79eaa0c7 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-annotations.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-annotations.mdx
@@ -194,7 +194,7 @@ chart.calloutsLabelMemberPath = "info";
### Timeline Styling
-The following example demonstrates how to style the data chart as a timeline with annotations by setting the `AllowedPositions` properties listed above:
+The following example demonstrates how to style the data chart as a timeline with annotations by setting the properties listed above:
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-axis-gridlines.mdx b/docs/xplat/src/content/en/components/charts/features/chart-axis-gridlines.mdx
index e9a760dc7f..e7082aea3d 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-axis-gridlines.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-axis-gridlines.mdx
@@ -10,12 +10,14 @@ import DocsAside from 'igniteui-astro-components/components/mdx/DocsAside.astro'
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# {Platform} Axis Gridlines
All {ProductName} charts include built-in capability to modify appearance of axis lines as well as frequency of major/minor gridlines and tickmarks that are rendered on the X-Axis and Y-Axis.
-the following examples can be applied to `CategoryChart` as well as `FinancialChart` controls.
+the following examples can be applied to as well as controls.
Axis major gridlines are long lines that extend horizontally along the Y-Axis or vertically along the X-Axis from locations of axis labels, and they render through the plot area of the chart. Axis minor gridlines are lines that render between axis major gridlines.
@@ -37,20 +39,20 @@ This example shows how configure the axis gridline to display major and minor gr
Setting the axis interval property specifies how often major gridlines and axis labels are rendered on an axis. Similarly, the axis minor interval property specifies how frequent minor gridlines are rendered on an axis.
-In order to display minor gridlines that correspond to minor interval, you need to set `XAxisMinorStroke` and `XAxisMinorStrokeThickness` properties on the axis. This is because minor gridlines do not have a default color or thickness and they will not be displayed without first assigning them.
+In order to display minor gridlines that correspond to minor interval, you need to set and properties on the axis. This is because minor gridlines do not have a default color or thickness and they will not be displayed without first assigning them.
You can customize how the gridlines are displayed in your {Platform} chart by setting the following properties:
| Axis Visuals | Type | Property Names | Description |
| -----------------------|---------|--------------------------------------------------------------|---------------- |
-| Major Stroke Color | string | `XAxisMajorStroke` `YAxisMajorStroke` | These properties set the color of axis major gridlines. |
-| Minor Stroke Color | string | `XAxisMinorStroke` `YAxisMinorStroke` | These properties set the color of axis minor gridlines. |
-| Major Stroke Thickness | number | `XAxisMajorStrokeThickness` `YAxisMajorStrokeThickness` | These properties set the thickness in pixels of the axis major gridlines. |
-| Minor Stroke Thickness | number | `XAxisMinorStrokeThickness` `YAxisMinorStrokeThickness` | These properties set the thickness in pixels of the axis minor gridlines. |
-| Major Interval | number | `XAxisInterval` `YAxisInterval` | These properties set interval between axis major gridlines and labels. |
-| Minor Interval | number | `XAxisMinorInterval` `YAxisMinorInterval` | These properties set interval between axis minor gridlines, if used. |
-| Axis Line Stroke Color | string | `XAxisStroke` `YAxisStroke` | These properties set the color of an axis line. |
-| Axis Stroke Thickness | number | `XAxisStrokeThickness` `YAxisStrokeThickness` | These properties set the thickness in pixels of an axis line. |
+| Major Stroke Color | string | | These properties set the color of axis major gridlines. |
+| Minor Stroke Color | string | | These properties set the color of axis minor gridlines. |
+| Major Stroke Thickness | number | | These properties set the thickness in pixels of the axis major gridlines. |
+| Minor Stroke Thickness | number | | These properties set the thickness in pixels of the axis minor gridlines. |
+| Major Interval | number | | These properties set interval between axis major gridlines and labels. |
+| Minor Interval | number | | These properties set interval between axis minor gridlines, if used. |
+| Axis Line Stroke Color | string | | These properties set the color of an axis line. |
+| Axis Stroke Thickness | number | | These properties set the thickness in pixels of an axis line. |
Regarding the Major and Minor Interval in the table above, it is important to note that the major interval for axis labels will also be set by this value, displaying one label at the point on the axis associated with the interval. The minor interval gridlines are always rendered between the major gridlines, and as such, the minor interval properties should always be set to something much smaller (usually 2-5 times smaller) than the value of the major Interval properties.
@@ -65,9 +67,9 @@ The following example demonstrates how to customize the gridlines by setting the
-The axes of the `DataChart` also have the ability to place a dash array on the major and minor gridlines by utilizing the `MajorStrokeDashArray` and `MinorStrokeDashArray` properties, respectively. The actual axis line can be dashed as well by setting the `StrokeDashArray` property of the corresponding axis. These properties take an array of numbers that will describe the length of the dashes for the corresponding grid lines.
+The axes of the also have the ability to place a dash array on the major and minor gridlines by utilizing the and properties, respectively. The actual axis line can be dashed as well by setting the property of the corresponding axis. These properties take an array of numbers that will describe the length of the dashes for the corresponding grid lines.
-The following example demonstrates a `DataChart` with the above dash array properties set:
+The following example demonstrates a with the above dash array properties set:
@@ -76,9 +78,9 @@ The following example demonstrates a `DataChart` with the above dash array prope
## {Platform} Axis Tickmarks Example
-Axis tick marks are enabled by setting the `XAxisTickLength` and `YAxisTickLength` properties to a value greater than 0. These properties specifies the length of the line segments forming the tick marks.
+Axis tick marks are enabled by setting the and properties to a value greater than 0. These properties specifies the length of the line segments forming the tick marks.
-Tick marks are always extend from the axis line and point to the direction of the labels. Labels are offset by the value of the length of tickmarks to avoid overlapping. For example, with the `YAxisTickLength` property is set to 5, axis labels will be shifted left by that amount.
+Tick marks are always extend from the axis line and point to the direction of the labels. Labels are offset by the value of the length of tickmarks to avoid overlapping. For example, with the property is set to 5, axis labels will be shifted left by that amount.
The following example demonstrates how to customize the tickmarks by setting the properties above:
@@ -95,9 +97,9 @@ You can customize how the axis tickmarks are displayed in our {Platform} chats b
| Axis Visuals | Type | Property Names | Description |
| -----------------------|---------|------------------------------------------------------------|------------------------- |
-| Tick Stroke Color | string | `XAxisTickStroke` `YAxisTickStroke` | These properties set the color of the tickmarks. |
-| Tick Stroke Thickness | number | `XAxisTickStrokeThickness` `YAxisTickStrokeThickness` | These properties set the thickness of the axis tick marks. |
-| Tick Stroke Length | number | `XAxisTickLength` `YAxisTickLength` | These properties set the length of the axis tick marks. |
+| Tick Stroke Color | string | | These properties set the color of the tickmarks. |
+| Tick Stroke Thickness | number | | These properties set the thickness of the axis tick marks. |
+| Tick Stroke Length | number | | These properties set the length of the axis tick marks. |
## Additional Resources
@@ -111,25 +113,25 @@ You can find more information about related chart features in these topics:
The following is a list of API members mentioned in the above sections:
-| `DataChart` | `CategoryChart` or `FinancialChart` |
+| | or |
| -------------------------------------------------- | ----------------------------------- |
-| `Axes` -> `NumericXAxis` -> `Interval` | `XAxisInterval` (Major Interval) |
-| `Axes` -> `NumericYAxis` -> `Interval` | `YAxisInterval` (Major Interval) |
-| `Axes` -> `NumericXAxis` -> `MinorInterval` | `XAxisMinorInterval` |
-| `Axes` -> `NumericYAxis` -> `MinorInterval` | `YAxisMinorInterval` |
-| `Axes` -> `NumericXAxis` -> `MajorStroke` | `XAxisMajorStroke` |
-| `Axes` -> `NumericYAxis` -> `MajorStroke` | `YAxisMajorStroke` |
-| `Axes` -> `NumericXAxis` -> `MajorStrokeThickness` | `XAxisMajorStrokeThickness` |
-| `Axes` -> `NumericYAxis` -> `MajorStrokeThickness` | `YAxisMajorStrokeThickness` |
-| `Axes` -> `NumericXAxis` -> `MinorStrokeThickness` | `XAxisMinorStrokeThickness` |
-| `Axes` -> `NumericYAxis` -> `MinorStrokeThickness` | `YAxisMinorStrokeThickness` |
-| `Axes` -> `NumericXAxis` -> `StrokeThickness` | `XAxisStrokeThickness` |
-| `Axes` -> `NumericYAxis` -> `StrokeThickness` | `YAxisStrokeThickness` |
-| `Axes` -> `NumericXAxis` -> `Stroke` | `XAxisStroke` (Axis Line Color) |
-| `Axes` -> `NumericYAxis` -> `Stroke` | `YAxisStroke` (Axis Line Color) |
-| `Axes` -> `NumericXAxis` -> `TickLength` | `XAxisTickLength` |
-| `Axes` -> `NumericYAxis` -> `TickLength` | `YAxisTickLength` |
-| `Axes` -> `NumericXAxis` -> `TickStroke` | `XAxisTickStroke` |
-| `Axes` -> `NumericYAxis` -> `TickStroke` | `YAxisTickStroke` |
-| `Axes` -> `NumericXAxis` -> `Strip` | `XAxisStrip` (Space between Major Gridlines) |
-| `Axes` -> `NumericYAxis` -> `Strip` | `YAxisStrip` (Space between Major Gridlines) |
+| -> -> | (Major Interval) |
+| -> -> | (Major Interval) |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | (Axis Line Color) |
+| -> -> | (Axis Line Color) |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | |
+| -> -> | (Space between Major Gridlines) |
+| -> -> | (Space between Major Gridlines) |
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-axis-layouts.mdx b/docs/xplat/src/content/en/components/charts/features/chart-axis-layouts.mdx
index 81f1b76d42..ca7723a0b6 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-axis-layouts.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-axis-layouts.mdx
@@ -10,19 +10,21 @@ import PlatformBlock from 'igniteui-astro-components/components/mdx/PlatformBloc
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# {Platform} Axis Layouts
All {ProductName} charts include options to configure many axis layout options such as location as well as having the ability to share axis between series or have multiple axes in the same chart. These features are demonstrated in the examples given below.
-the following examples can be applied to `CategoryChart` as well as `FinancialChart` controls.
+the following examples can be applied to as well as controls.
## Axis Locations Example
-For all axes, you can specify axis location in relationship to chart plot area. The `XAxisLabelLocation` property of the {Platform} charts, allows you to position x-axis line and its labels on above or below plot area. Similarly, you can use the `YAxisLabelLocation` property to position y-axis on left side or right side of plot area.
+For all axes, you can specify axis location in relationship to chart plot area. The property of the {Platform} charts, allows you to position x-axis line and its labels on above or below plot area. Similarly, you can use the property to position y-axis on left side or right side of plot area.
-The following example depicts the amount of renewable electricity produced since 2009, represented by a [Line Chart](../types/line-chart.md). There is a drop-down that lets you configure the `YAxisLabelLocation` so that you can visualize what the axes look like when the labels are placed on the left or right side on the inside or outside of the chart's plot area.
+The following example depicts the amount of renewable electricity produced since 2009, represented by a [Line Chart](../types/line-chart.md). There is a drop-down that lets you configure the so that you can visualize what the axes look like when the labels are placed on the left or right side on the inside or outside of the chart's plot area.
@@ -37,11 +39,11 @@ e.g. https://www.infragistics.com/help/wpf/datachart-axis-orientation
## Axis Advanced Scenarios
-For more advanced axis layout scenarios, you can use {Platform} Data Chart to share axis, add multiple y-axis and/or x-axis in the same plot area, or even cross axes at specific values. The following examples show how to use these features of the `DataChart`.
+For more advanced axis layout scenarios, you can use {Platform} Data Chart to share axis, add multiple y-axis and/or x-axis in the same plot area, or even cross axes at specific values. The following examples show how to use these features of the .
### Axis Sharing Example
-You can share and add multiple axes in the same plot area of the {Platform} `DataChart`. It a common scenario to use share `TimeXAxis` and add multiple `NumericYAxis` to plot many data sources that have wide range of values (e.g. stock prices and stock trade volumes).
+You can share and add multiple axes in the same plot area of the {Platform} . It a common scenario to use share and add multiple to plot many data sources that have wide range of values (e.g. stock prices and stock trade volumes).
The following example depicts a stock price and trade volume chart with a [Stock Chart](../types/stock-chart.md) and a [Column Chart](../types/column-chart.md) plotted. In this case, the Y-Axis on the left is used by the [Column Chart](../types/column-chart.md) and the Y-Axis on the right is used by the [Stock Chart](../types/stock-chart.md), while the X-Axis is shared between the two.
@@ -54,7 +56,7 @@ The following example depicts a stock price and trade volume chart with a [Stock
### Axis Crossing Example
-In addition to placing axes outside plot area, the {Platform} `DataChart` also provides options to position axes inside of plot area and make them cross at specific values. For example, you can create trigonometric chart by setting `CrossingAxis` and `CrossingValue` properties on both x-axis and y-axis to render axis lines and axis labels such that they are crossing at (0, 0) origin point.
+In addition to placing axes outside plot area, the {Platform} also provides options to position axes inside of plot area and make them cross at specific values. For example, you can create trigonometric chart by setting and properties on both x-axis and y-axis to render axis lines and axis labels such that they are crossing at (0, 0) origin point.
The following example shows a Sin and Cos wave represented by a [Scatter Spline Chart](../types/scatter-chart.md) with the X and Y axes crossing each other at the (0, 0) origin point.
@@ -71,7 +73,7 @@ The following example shows a Sin and Cos wave represented by a [Scatter Spline
### Axis Timeline Example
-The following example demonstrates how to style the data chart using the `TimeXAxis` as a timeline:
+The following example demonstrates how to style the data chart using the as a timeline:
@@ -97,25 +99,25 @@ The following is a list of API members mentioned in the above sections:
d in the above sections:
-| `DataChart` | `CategoryChart` |
+| | |
| ------------------------------------------------------ | ------------------------------- |
-| `Axes` -> `NumericYAxis` -> `CrossingAxis` | None |
-| `Axes` -> `NumericYAxis` -> `CrossingValue` | None |
-| `Axes` -> `NumericXAxis` -> `IsInverted` | `XAxisInverted` |
-| `Axes` -> `NumericYAxis` -> `IsInverted` | `YAxisInverted` |
-| `Axes` -> `NumericYAxis` -> `LabelLocation` | `YAxisLabelLocation` |
-| `Axes` -> `NumericXAxis` -> `LabelLocation` | `XAxisLabelLocation` |
-| `Axes` -> `NumericYAxis` -> `LabelHorizontalAlignment` | `YAxisLabelHorizontalAlignment` |
-| `Axes` -> `NumericXAxis` -> `LabelVerticalAlignment` | `XAxisLabelVerticalAlignment` |
-| `Axes` -> `NumericYAxis` -> `LabelVisibility` | `YAxisLabelVisibility` |
-| `Axes` -> `NumericXAxis` -> `LabelVisibility` | `XAxisLabelVisibility` |
+| -> -> | None |
+| -> -> | None |
+| -> -> | |
+| -> -> | |
+| -> -> `LabelLocation` | |
+| -> -> `LabelLocation` | |
+| -> -> `LabelHorizontalAlignment` | |
+| -> -> `LabelVerticalAlignment` | |
+| -> -> `LabelVisibility` | |
+| -> -> `LabelVisibility` | |
{/* TODO correct links in Transformer */}
{/*
-| `Axes` -> `NumericYAxis` -> `labelSettings.location` | `YAxisLabelLocation` |
-| `Axes` -> `NumericXAxis` -> `labelSettings.location` | `XAxisLabelLocation` |
-| `Axes` -> `NumericYAxis` -> `labelSettings.horizontalAlignment` | `YAxisLabelHorizontalAlignment` |
-| `Axes` -> `NumericXAxis` -> `labelSettings.verticalAlignment` | `XAxisLabelVerticalAlignment` |
-| `Axes` -> `NumericYAxis` -> `labelSettings.visibility` | `YAxisLabelVisibility` |
-| `Axes` -> `NumericXAxis` -> `labelSettings.visibility` | `XAxisLabelVisibility` | */}
+| -> -> `labelSettings.location` | |
+| -> -> `labelSettings.location` | |
+| -> -> `labelSettings.horizontalAlignment` | |
+| -> -> `labelSettings.verticalAlignment` | |
+| -> -> `labelSettings.visibility` | |
+| -> -> `labelSettings.visibility` | | */}
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-axis-options.mdx b/docs/xplat/src/content/en/components/charts/features/chart-axis-options.mdx
index 7d0491b3c1..1794f79635 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-axis-options.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-axis-options.mdx
@@ -72,9 +72,9 @@ By default, charts will calculate the minimum and maximum values for the numeric
In the and controls, you can choose if your data is plotted on logarithmic scale along the y-axis when the property is set to true or on linear scale when this property is set to false (default value). With the property, you can change base of logarithmic scale from default value of 10 to other integer value.
-The and control allows you to choose how your data is represented along the y-axis using property that provides `Numeric` and `PercentChange` modes. The `Numeric` mode will plot data with the exact values while the `PercentChange` mode will display the data as percentage change relative to the first data point provided. The default value is `Numeric` mode.
+The and control allows you to choose how your data is represented along the y-axis using property that provides and modes. The mode will plot data with the exact values while the mode will display the data as percentage change relative to the first data point provided. The default value is mode.
-In addition to property, the control has property that provides `Time` and `Ordinal` modes for the x-axis. The `Time` mode will render space along the x-axis for gaps in data (e.g. no stock trading on weekends or holidays). The `Ordinal` mode will collapse date areas where data does not exist. The default value is `Ordinal` mode.
+In addition to property, the control has property that provides and modes for the x-axis. The mode will render space along the x-axis for gaps in data (e.g. no stock trading on weekends or holidays). The mode will collapse date areas where data does not exist. The default value is mode.
@@ -124,20 +124,20 @@ You can find more information about related chart features in these topics:
The following is a list of API members mentioned in the above sections:
-| `DataChart` | `FinancialChart` | `CategoryChart` |
+| | | |
| ------------------------------------------------------ | ---------------------- | ---------------------- |
-| `Axes` -> `NumericYAxis` -> `MaximumValue` | `YAxisMaximumValue` | `YAxisMaximumValue` |
-| `Axes` -> `NumericYAxis` -> `MinimumValue` | `YAxisMinimumValue` | `YAxisMinimumValue` |
-| `Axes` -> `NumericYAxis` -> `IsLogarithmic` | `YAxisIsLogarithmic` | `YAxisIsLogarithmic` |
-| `Axes` -> `NumericYAxis` -> `LogarithmBase` | `YAxisLogarithmBase` | `YAxisLogarithmBase` |
-| `Axes` -> `CategoryXAxis` -> `Gap` | None | `XAxisGap` |
-| `Axes` -> `CategoryXAxis` -> `Overlap` | None | `XAxisOverlap` |
-| `Axes` -> `TimeXAxis` | `XAxisMode` | None |
-| `Axes` -> `PercentChangeYAxis` | `YAxisMode` | None |
-| `Axes` -> `NumericYAxis` -> `labelSettings.angle` | `YAxisLabelAngle` | `YAxisLabelAngle` |
-| `Axes` -> `NumericXAxis` -> `labelSettings.angle` | `XAxisLabelAngle` | `XAxisLabelAngle` |
-| `Axes` -> `NumericYAxis` -> `labelSettings.textColor` | `YAxisLabelForeground` | `YAxisLabelForeground` |
-| `Axes` -> `NumericXAxis` -> `labelSettings.textColor` | `XAxisLabelForeground` | `XAxisLabelForeground` |
-| `Axes` -> `NumericYAxis` -> `labelSettings.visibility` | `YAxisLabelVisibility` | `YAxisLabelVisibility` |
-| `Axes` -> `NumericXAxis` -> `labelSettings.visibility` | `XAxisLabelVisibility` | `XAxisLabelVisibility` |
+| -> -> | | |
+| -> -> | | |
+| -> -> | | |
+| -> -> | | |
+| -> -> | None | |
+| -> -> | None | |
+| -> | | None |
+| -> | | None |
+| -> -> `labelSettings.angle` | | |
+| -> -> `labelSettings.angle` | | |
+| -> -> `labelSettings.textColor` | `YAxisLabelForeground` | `YAxisLabelForeground` |
+| -> -> `labelSettings.textColor` | `XAxisLabelForeground` | `XAxisLabelForeground` |
+| -> -> `labelSettings.visibility` | | |
+| -> -> `labelSettings.visibility` | | |
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-axis-types.mdx b/docs/xplat/src/content/en/components/charts/features/chart-axis-types.mdx
index 6feed3edc7..3987b4564d 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-axis-types.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-axis-types.mdx
@@ -9,150 +9,154 @@ namespace: Infragistics.Controls.Charts
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# {Platform} Axis Types
-The {ProductName} Category Chart uses only one `CategoryXAxis` and one `NumericYAxis` type. Similarly, {ProductName} Financial Chart uses only one `TimeXAxis` and one `NumericYAxis` types. However, the {ProductName} Data Chart provides support for multiple axis types that you can position on any side of the chart by setting [axis location](chart-axis-layouts.md#axis-locations-example) or even inside of the chart by using [axis crossing](chart-axis-layouts.md#axis-crossing-example) properties. This topic goes over each one, which axes and series are compatible with each other, and some specific properties to the unique axes.
+The {ProductName} Category Chart uses only one and one type. Similarly, {ProductName} Financial Chart uses only one and one types. However, the {ProductName} Data Chart provides support for multiple axis types that you can position on any side of the chart by setting [axis location](chart-axis-layouts.md#axis-locations-example) or even inside of the chart by using [axis crossing](chart-axis-layouts.md#axis-crossing-example) properties. This topic goes over each one, which axes and series are compatible with each other, and some specific properties to the unique axes.
## Cartesian Axes
-The `DataChart` with Cartesian Axes, allows you to plot data in horizontal (X-axis) and vertical (X-axis) direction with 3 types of X-Axis
-(`CategoryXAxis`, `NumericXAxis`, and `TimeXAxis`) and 2 types of Y-Axis (`CategoryYAxis` and `NumericYAxis`).
+The with Cartesian Axes, allows you to plot data in horizontal (X-axis) and vertical (X-axis) direction with 3 types of X-Axis
+(, , and ) and 2 types of Y-Axis ( and ).
### Category X-Axis
-The `CategoryXAxis` treats its data as a sequence of categorical data items. It can display almost any type of data including strings and numbers. If you are plotting numbers on this axis, it is important to keep in mind that this axis is a discrete axis and not continuous. This means that each categorical data item will be placed equidistant from the one before it. The items will also be plotted in the order that they appear in the axis' data source.
+The treats its data as a sequence of categorical data items. It can display almost any type of data including strings and numbers. If you are plotting numbers on this axis, it is important to keep in mind that this axis is a discrete axis and not continuous. This means that each categorical data item will be placed equidistant from the one before it. The items will also be plotted in the order that they appear in the axis' data source.
-The `CategoryXAxis` requires you to provide a `DataSource` and a `Label` in order to plot data with it. It is generally used with the `NumericYAxis` to plot the following type of series:
+The requires you to provide a `DataSource` and a in order to plot data with it. It is generally used with the to plot the following type of series:
| Category Series | Stacked Series | Financial Series |
|------------------|----------------|--------------------|
-| - `AreaSeries` - `ColumnSeries` - `LineSeries` - `PointSeries` - `SplineSeries` - `SplineAreaSeries` - `StepLineSeries` - `StepAreaSeries` - `RangeAreaSeries` - `RangeColumnSeries` - `WaterfallSeries` | - `StackedAreaSeries` - `StackedColumnSeries` - `StackedLineSeries` - `StackedSplineSeries` - `Stacked100AreaSeries` - `Stacked100ColumnSeries` - `Stacked100LineSeries` - `Stacked100SplineSeries`
|
- The following example demonstrates usage of the `CategoryXAxis` type:
+ The following example demonstrates usage of the type:
### Category Y-Axis
-The `CategoryYAxis` works very similarly to the `CategoryXAxis` described above, but it is placed vertically rather than horizontally. Also, this axis requires you to provide a `DataSource` and a `Label` in order to plot data with it. The `CategoryYAxis` is generally used with the `NumericXAxis` to plot the following type of series:
+The works very similarly to the described above, but it is placed vertically rather than horizontally. Also, this axis requires you to provide a `DataSource` and a in order to plot data with it. The is generally used with the to plot the following type of series:
-- `BarSeries`
-- `StackedBarSeries`
-- `Stacked100BarSeries`
+-
+- `RangeBarSeries`
+-
+-
- The following example demonstrates usage of the `CategoryYAxis` type:
+ The following example demonstrates usage of the type:
### Numeric X-Axis
-The `NumericXAxis` treats its data as continuously varying numerical data items. Labels on this axis are placed horizontally along the X-Axis. The location of the `NumericXAxis` labels depends on the `XMemberPath` property of the various [Scatter Series](../types/scatter-chart.md) that it supports if combined with a `NumericYAxis`. Alternatively, if combined with the `CategoryXAxis`, these labels will be placed corresponding to the `ValueMemberPath` of the `BarSeries`, `StackedBarSeries`, and `Stacked100BarSeries`.
+The treats its data as continuously varying numerical data items. Labels on this axis are placed horizontally along the X-Axis. The location of the labels depends on the property of the various [Scatter Series](../types/scatter-chart.md) that it supports if combined with a . Alternatively, if combined with the , these labels will be placed corresponding to the of the , `RangeBarSeries`, , and .
-The `NumericXAxis` is compatible with the following type of series:
+The is compatible with the following type of series:
-- `BarSeries`
-- `BubbleSeries`
-- `HighDensityScatterSeries`
-- `ScatterSeries`
-- `ScatterLineSeries`
-- `ScatterSplineSeries`
-- `ScatterAreaSeries`
-- `ScatterContourSeries`
-- `ScatterPolylineSeries`
-- `ScatterPolygonSeries`
-- `StackedBarSeries`
-- `Stacked100BarSeries`
+-
+- `RangeBarSeries`
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
+-
- The following example demonstrates usage of the `NumericXAxis`:
+ The following example demonstrates usage of the :
### Numeric Y-Axis
-The `NumericYAxis` treats its data as continuously varying numerical data items. Labels on this axis are placed vertically along the Y-Axis. The location of the `NumericYAxis` labels depends on the `YMemberPath` property of the various [ScatterSeries](../types/scatter-chart.md) that is supports if combined with a `NumericXAxis`. Alternatively, if combined with the `CategoryYAxis`, these labels will be placed corresponding to the `ValueMemberPath` of the category or stacked series mentioned in the table above. If you are using one of the financial series, they will be placed corresponding to the Open/High/Low/Close paths and the series type that you are using.
+The treats its data as continuously varying numerical data items. Labels on this axis are placed vertically along the Y-Axis. The location of the labels depends on the property of the various [ScatterSeries](../types/scatter-chart.md) that is supports if combined with a . Alternatively, if combined with the , these labels will be placed corresponding to the of the category or stacked series mentioned in the table above. If you are using one of the financial series, they will be placed corresponding to the Open/High/Low/Close paths and the series type that you are using.
-The `NumericYAxis` is compatible with the following type of series:
+The is compatible with the following type of series:
| Category Series | Stacked Series | Financial Series | Scatter Series |
|------------------|----------------|------------------|----------------|
-| - `AreaSeries` - `ColumnSeries` - `LineSeries` - `PointSeries` - `SplineSeries` - `SplineAreaSeries` - `StepLineSeries` - `StepAreaSeries` - `RangeAreaSeries` - `RangeColumnSeries` - `WaterfallSeries` | - `StackedAreaSeries` - `StackedColumnSeries` - `StackedLineSeries` - `StackedSplineSeries` - `Stacked100AreaSeries` - `Stacked100ColumnSeries` - `Stacked100LineSeries` - `Stacked100SplineSeries` | - `FinancialPriceSeries` - `BollingerBandsOverlay` - `ForceIndexIndicator` - `MedianPriceIndicator` - `MassIndexIndicator` - `RelativeStrengthIndexIndicator` - `StandardDeviationIndicator` - `TypicalPriceIndicator` | - `BubbleSeries` - `HighDensityScatterSeries` - `ScatterSeries` - `ScatterLineSeries` - `ScatterSplineSeries` - `ScatterAreaSeries` - `ScatterContourSeries` - `ScatterPolylineSeries` - `ScatterPolygonSeries` |
+| - - - - - - - - - - - | - - - - - - - - | - - - - - - - - | - - - - - - - - - |
- The following example demonstrates usage of the `NumericYAxis`:
+ The following example demonstrates usage of the :
### Time X Axis
-The `TimeXAxis` treats its data as a sequence of data items, sorted by date. Labels on this axis type are dates and can be formatted and arranged according to date intervals. The date range of this axis is determined by the date values in a data column that is mapped using its `DateTimeMemberPath`. This, along with a `DataSource` is required to plot data with this axis type.
+The treats its data as a sequence of data items, sorted by date. Labels on this axis type are dates and can be formatted and arranged according to date intervals. The date range of this axis is determined by the date values in a data column that is mapped using its . This, along with a `DataSource` is required to plot data with this axis type.
-The `TimeXAxis` is the X-Axis type in the `FinancialChart` component.
+The is the X-Axis type in the component.
#### Breaks in Time X Axis
-The `TimeXAxis` has the option to exclude intervals of data by using `Breaks`. As a result, the labels and plotted data will not appear at the excluded interval. For example, working/non-working days, holidays, and/or weekends. An instance of `TimeAxisBreak` can be added to the `Breaks` collection of the axis and configured by using a unique `Start`, `End` and `Interval`.
+The has the option to exclude intervals of data by using . As a result, the labels and plotted data will not appear at the excluded interval. For example, working/non-working days, holidays, and/or weekends. An instance of can be added to the collection of the axis and configured by using a unique , and .
#### Formatting in Time X Axis
-The `TimeXAxis` has the `LabelFormats` property, which represents a collection of `TimeAxisLabelFormat` objects. Each `TimeAxisLabelFormat` added to the collection is responsible for assigning a unique `Format` and `Range`. This can be especially useful for drilling down data from years to milliseconds and adjusting the labels depending on the range of time shown by the chart.
+The has the property, which represents a collection of objects. Each added to the collection is responsible for assigning a unique and . This can be especially useful for drilling down data from years to milliseconds and adjusting the labels depending on the range of time shown by the chart.
-The `Format` property of the `TimeAxisLabelFormat` specifies what format to use for a particular visible range. The `Range` property of the `TimeAxisLabelFormat` specifies the visible range at which the axis label formats will switch to a different format. For example, if you have two `TimeAxisLabelFormat` elements with a range set to 10 days and another set to 5 hours, then as soon as the visible range of the axis becomes less than 10 days, it will switch to 5-hour format.
+The property of the specifies what format to use for a particular visible range. The property of the specifies the visible range at which the axis label formats will switch to a different format. For example, if you have two elements with a range set to 10 days and another set to 5 hours, then as soon as the visible range of the axis becomes less than 10 days, it will switch to 5-hour format.
#### Intervals in Time X Axis
-The `TimeXAxis` replaces the conventional `Interval` property of the category and numeric axes with an `Intervals` collection of type `TimeAxisInterval`. Each `TimeAxisInterval` added to the collection is responsible for assigning a unique `Interval`, `Range` and `IntervalType`. This can be especially useful for drilling down data from years to milliseconds to provide unique spacing between labels depending on the range of time shown by the chart. A description of these properties is below:
+The replaces the conventional property of the category and numeric axes with an collection of type . Each added to the collection is responsible for assigning a unique , and . This can be especially useful for drilling down data from years to milliseconds to provide unique spacing between labels depending on the range of time shown by the chart. A description of these properties is below:
-- `Interval`: This specifies the interval to use. This is tied to the `IntervalType` property. For example, if the `IntervalType` is set to `Days`, then the numeric value specified in `Interval` will be in days.
-- `Range`: This specifies the visible range at which the axis interval will switch to a different interval. For example, if you have two TimeAxisInterval with a range set to 10 days and another set to 5 hours, as soon as the visible range in the axis becomes less than 10 days it will switch to the interval whose range is 5 hours.
-- `IntervalType`: This specifies the unit of time for the `Interval` property.
+- : This specifies the interval to use. This is tied to the property. For example, if the is set to `Days`, then the numeric value specified in will be in days.
+- : This specifies the visible range at which the axis interval will switch to a different interval. For example, if you have two TimeAxisInterval with a range set to 10 days and another set to 5 hours, as soon as the visible range in the axis becomes less than 10 days it will switch to the interval whose range is 5 hours.
+- : This specifies the unit of time for the property.
## Polar Axes
-The `DataChart` with Polar Axes, allows you to plot data outwards (radius axis) from center of the chart and around (angle axis) of center of the chart.
+The with Polar Axes, allows you to plot data outwards (radius axis) from center of the chart and around (angle axis) of center of the chart.
### Category Angle Axis
-The `CategoryAngleAxis` treats its data as a sequence of category data items. The labels on this axis are placed along the edge of a circle according to their position in that sequence. This type of axis can display almost any type of data including strings and numbers.
+The treats its data as a sequence of category data items. The labels on this axis are placed along the edge of a circle according to their position in that sequence. This type of axis can display almost any type of data including strings and numbers.
-The `CategoryAngleAxis` is generally used with the `NumericRadiusAxis` to plot [Radial Series](../types/radial-chart.md).
+The is generally used with the to plot [Radial Series](../types/radial-chart.md).
-The following example demonstrates usage of the `CategoryAngleAxis` type:
+The following example demonstrates usage of the type:
### Proportional Category Angle Axis
-The `ProportionalCategoryAngleAxis` treats its data as a sequence of category data items. The labels on this axis are placed along the edge of a circle according to their position in that sequence. This type of axis can display almost any type of data including strings and numbers.
+The treats its data as a sequence of category data items. The labels on this axis are placed along the edge of a circle according to their position in that sequence. This type of axis can display almost any type of data including strings and numbers.
-The `ProportionalCategoryAngleAxis` is generally used with the `NumericRadiusAxis` to plot a pie chart eg. [Radial Series](../types/radial-chart.md).
+The is generally used with the to plot a pie chart eg. [Radial Series](../types/radial-chart.md).
-The following example demonstrates usage of the `ProportionalCategoryAngleAxis` type:
+The following example demonstrates usage of the type:
### Numeric Angle Axis
-The `NumericAngleAxis` treats its data as continuously varying numerical data items. The labels on this axis area placed along a radius line starting from the center of the circular plot. The location of the labels on the `NumericAngleAxis` varies according to the value in the data column mapped using the `RadiusMemberPath` property of the [Polar Series](../types/polar-chart.md) object or the `ValueMemberPath` property of the [Radial Series](../types/radial-chart.md) object.
+The treats its data as continuously varying numerical data items. The labels on this axis area placed along a radius line starting from the center of the circular plot. The location of the labels on the varies according to the value in the data column mapped using the property of the [Polar Series](../types/polar-chart.md) object or the property of the [Radial Series](../types/radial-chart.md) object.
-The The `NumericAngleAxis` can be used with either the `CategoryAngleAxis` to plot [Radial Series](../types/radial-chart.md) or with the `NumericRadiusAxis` to plot [Polar Series](../types/polar-chart.md) respectively.
+The The can be used with either the to plot [Radial Series](../types/radial-chart.md) or with the to plot [Polar Series](../types/polar-chart.md) respectively.
-The following example demonstrates usage of the `NumericAngleAxis` type:
+The following example demonstrates usage of the type:
### Numeric Radius Axis
-The `NumericRadiusAxis` treats the data as continuously varying numerical data items. The labels on this axis are placed around the circular plot. The location of the labels varies according to the value in a data column mapped using the `AngleMemberPath` property of the corresponding polar series.
+The treats the data as continuously varying numerical data items. The labels on this axis are placed around the circular plot. The location of the labels varies according to the value in a data column mapped using the `AngleMemberPath` property of the corresponding polar series.
-The `NumericRadiusAxis` can be used with the `NumericRadiusAxis` to plot [Polar Series](../types/polar-chart.md).
+The can be used with the to plot [Polar Series](../types/polar-chart.md).
-The following example demonstrates usage of the `NumericRadiusAxis` type:
+The following example demonstrates usage of the type:
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-data-annotations.mdx b/docs/xplat/src/content/en/components/charts/features/chart-data-annotations.mdx
index 3793bd717b..e558fa365d 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-data-annotations.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-data-annotations.mdx
@@ -11,6 +11,8 @@ import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# {Platform} Chart Data Annotations
In the {Platform} chart, the data annotation layers allow you to annotate data plotted in Data Chart with sloped lines, vertical/horizontal lines (aka axis slices), vertical/horizontal strips (targeting specific axis), rectangles, and even parallelograms (aka bands). With data-binding supported, you can create as many annotations as you want to customize your charts. Also, you can combine different annotation layers and you can overlay text inside of plot area to annotated important events, patterns, and regions in your data.
@@ -28,7 +30,7 @@ Like this sample? Get access to our complete {Platform} toolkit and start buildi
## {Platform} Data Annotation Slice Layer Example
-In {Platform}, the `DataAnnotationSliceLayer` renders multiple vertical or horizontal lines that slice the chart at multiple values of an axis in the `DataChart` component. This data annotation layer is often used to annotate important events (e.g. company quarter reports) on x-axis or important values on y-axis. Setting the TargetAxis property to y-axis will render data annotation layer as horizontal slices or setting TargetAxis property to x-axis will render data annotation layer as vertical slices. Similarly to all series, the DataAnnotationSliceLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 1 numeric data column mapped to the `AnnotationValueMemberPath` property.
+In {Platform}, the renders multiple vertical or horizontal lines that slice the chart at multiple values of an axis in the component. This data annotation layer is often used to annotate important events (e.g. company quarter reports) on x-axis or important values on y-axis. Setting the TargetAxis property to y-axis will render data annotation layer as horizontal slices or setting TargetAxis property to x-axis will render data annotation layer as vertical slices. Similarly to all series, the DataAnnotationSliceLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 1 numeric data column mapped to the property.
For example, you can use DataAnnotationSliceLayer to annotate stock prices with important events such as stock split and outcome of earning reports.
@@ -39,9 +41,9 @@ For example, you can use DataAnnotationSliceLayer to annotate stock prices with
## {Platform} Data Annotation Strip Layer Example
-In {Platform}, the `DataAnnotationStripLayer` renders multiple vertical or horizontal strips between 2 values on an axis in the `DataChart` component. This data annotation layer can be used to annotate duration of events (e.g. stock market crash) on x-axis or important range of values on y-axis. Setting the TargetAxis property to y-axis will render data annotation layer as horizontal strips or setting TargetAxis property to x-axis will render data annotation layer as vertical strips. Similarly to all series, the `DataAnnotationStripLayer` also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 1 numeric data column mapped to the AnnotationValueMemberPath property.
+In {Platform}, the renders multiple vertical or horizontal strips between 2 values on an axis in the component. This data annotation layer can be used to annotate duration of events (e.g. stock market crash) on x-axis or important range of values on y-axis. Setting the TargetAxis property to y-axis will render data annotation layer as horizontal strips or setting TargetAxis property to x-axis will render data annotation layer as vertical strips. Similarly to all series, the also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 1 numeric data column mapped to the AnnotationValueMemberPath property.
-For example, you can use `DataAnnotationStripLayer` to annotate chart with stock market crashes and changes in federal interest rates.
+For example, you can use to annotate chart with stock market crashes and changes in federal interest rates.
@@ -50,7 +52,7 @@ For example, you can use `DataAnnotationStripLayer` to annotate chart with stock
## {Platform} Data Annotation Line Layer Example
-In {Platform}, `DataAnnotationLineLayer` renders multiple lines between 2 points in plot area of the `DataChart` component. This data annotation layer can be used to annotate stock chart with growth and decline in stock prices. Similarly to all series, the DataAnnotationLineLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 4 numeric data columns representing x/y coordinates of starting point and ending point of the lines. The starting points should be mapped using using `StartValueXMemberPath` and `StartValueYMemberPath` properties and the ending points should be mapped using `EndValueXMemberPath` and `EndValueYMemberPath` properties.
+In {Platform}, renders multiple lines between 2 points in plot area of the component. This data annotation layer can be used to annotate stock chart with growth and decline in stock prices. Similarly to all series, the DataAnnotationLineLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 4 numeric data columns representing x/y coordinates of starting point and ending point of the lines. The starting points should be mapped using using and properties and the ending points should be mapped using and properties.
For example, you can use DataAnnotationLineLayer to annotate growth and decline patterns in stock prices and 52-week high and low of stock prices on y-axis.
@@ -61,7 +63,7 @@ For example, you can use DataAnnotationLineLayer to annotate growth and decline
## {Platform} Data Annotation Rect Layer Example
-In {Platform}, the `DataAnnotationRectLayer` renders multiple rectangles defined by starting and ending points in plot area of the `DataChart` component. This data annotation layer can be used to annotate region of plot area such as bearish patterns in stock prices. Similarly to all series, the DataAnnotationRectLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 4 numeric data columns representing x/y coordinates of starting point and ending point of the rectangles. The starting points should be mapped using using `StartValueXMemberPath` and `StartValueYMemberPath` properties and the ending points should be mapped using `EndValueXMemberPath` and `EndValueYMemberPath` properties.
+In {Platform}, the renders multiple rectangles defined by starting and ending points in plot area of the component. This data annotation layer can be used to annotate region of plot area such as bearish patterns in stock prices. Similarly to all series, the DataAnnotationRectLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 4 numeric data columns representing x/y coordinates of starting point and ending point of the rectangles. The starting points should be mapped using using and properties and the ending points should be mapped using and properties.
For example, you can use DataAnnotationRectLayer to annotate bearish patterns and gaps in stock prices on y-axis.
@@ -72,7 +74,7 @@ For example, you can use DataAnnotationRectLayer to annotate bearish patterns an
## {Platform} Data Annotation Band Layer Example
-In {Platform}, the `DataAnnotationBandLayer` renders multiple skewed rectangles (free-form parallelogram) between 2 points in plot area of the `DataChart` component. This data annotation layer can be used to annotate range of growth and decline in stock prices. Similarly to all series, the DataAnnotationBandLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 4 numeric data columns representing x/y coordinates of starting point and ending point of the lines. The starting points should be mapped using `StartValueXMemberPath` and `StartValueYMemberPath` properties and the ending points should be mapped using `EndValueXMemberPath` and `EndValueYMemberPath` properties. In addition, you can specify thickness/size of the skewed rectangle by binding numeric data column to the AnnotationBreadthMemberPath property.
+In {Platform}, the renders multiple skewed rectangles (free-form parallelogram) between 2 points in plot area of the component. This data annotation layer can be used to annotate range of growth and decline in stock prices. Similarly to all series, the DataAnnotationBandLayer also supports data binding via the `DataSource` property that can be set to a collection of data items which should have at least 4 numeric data columns representing x/y coordinates of starting point and ending point of the lines. The starting points should be mapped using and properties and the ending points should be mapped using and properties. In addition, you can specify thickness/size of the skewed rectangle by binding numeric data column to the AnnotationBreadthMemberPath property.
For example, you can use DataAnnotationBandLayer to annotate range of growth in stock prices.
@@ -85,14 +87,14 @@ For example, you can use DataAnnotationBandLayer to annotate range of growth in
The following is a list of API members mentioned in the above sections:
-- `TargetAxis`: This property specifies which axis should have an enabled DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
+- : This property specifies which axis should have an enabled DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
- `DataSource`: This property binds data to the annotation layer to provide the precise shape.
-- `StartValueXMemberPath`: This property is a mapping to the name of the data column with x-positions for the start of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
-- `StartValueYMemberPath`: This property is a mapping to the name of data column with y-positions for the start of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
-- `EndValueXMemberPath`: This property is a mapping to the data column with x-positions for the end of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
-- `EndValueYMemberPath`: This property is a mapping to the data column with y-positions for end of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
-- `StartLabelXMemberPath`: This property is a mapping to the data column representing the overlay label for the starting position of the xAxis along the axis.
-- `StartLabelXDisplayMode` | `StartLabelYDisplayMode` | `EndLabelXDisplayMode` | `EndLabelYDisplayMode` | `CenterLabelXDisplayMode`: These properties specify what should annotation labels display on starting, ending, or center of the annotation shape, e.g. mapped data value, mapped data label, axis value, or hide a given annotation label.
-- `StartLabelYMemberPath`: This property is a mapping to the data column representing the axis label for the starting position of `DataAnnotationBandLayer`, `DataAnnotationLineLayer`, `DataAnnotationRectLayer` on the y-axis.
-- `EndLabelYMemberPath`: This property is a mapping to the data column representing the axis label for the ending position of `DataAnnotationBandLayer`, `DataAnnotationLineLayer`, `DataAnnotationRectLayer` on the y-axis.
+- : This property is a mapping to the name of the data column with x-positions for the start of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
+- : This property is a mapping to the name of data column with y-positions for the start of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
+- : This property is a mapping to the data column with x-positions for the end of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
+- : This property is a mapping to the data column with y-positions for end of the DataAnnotationBandLayer, DataAnnotationLineLayer, DataAnnotationRectLayer.
+- : This property is a mapping to the data column representing the overlay label for the starting position of the xAxis along the axis.
+- | | | | : These properties specify what should annotation labels display on starting, ending, or center of the annotation shape, e.g. mapped data value, mapped data label, axis value, or hide a given annotation label.
+- : This property is a mapping to the data column representing the axis label for the starting position of , , on the y-axis.
+- : This property is a mapping to the data column representing the axis label for the ending position of , , on the y-axis.
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-data-legend.mdx b/docs/xplat/src/content/en/components/charts/features/chart-data-legend.mdx
index 168ae02cf5..15b3577f4e 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-data-legend.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-data-legend.mdx
@@ -15,37 +15,37 @@ import layoutMode from '@xplat-images/general/layout_mode.png';
# {Platform} Data Legend
-In {ProductName}, the `DataLegend` is highly-customizable version of the `Legend`, that shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values. This legend updates when moving the mouse inside of the plot area of the `CategoryChart`, `FinancialChart`, and `DataChart`. Also, it has a persistent state that remembers the last hovered point when the user's mouse pointer exits the plot area. It displays this content using a set of three type of rows (header, series, summary) and four types of columns (title, label, value, unit).
+In {ProductName}, the is highly-customizable version of the , that shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values. This legend updates when moving the mouse inside of the plot area of the , , and . Also, it has a persistent state that remembers the last hovered point when the user's mouse pointer exits the plot area. It displays this content using a set of three type of rows (header, series, summary) and four types of columns (title, label, value, unit).
## {Platform} Data Legend Rows
-The rows of the `DataLegend` include the header row, series row(s), and the summary row. The header row displays the axis label of the point that is hovered, and can be changed using the `HeaderText` property.
+The rows of the include the header row, series row(s), and the summary row. The header row displays the axis label of the point that is hovered, and can be changed using the property.
### Header Row
-The header row displays the current label of x-axis when hovering mouse over category series and financial series. You can use `HeaderFormatDate` and `HeaderFormatTime` properties to format date and time in the `DataLegend` if the x-axis shows dates. For other types of series, the `DataLegend` does not render the header row.
+The header row displays the current label of x-axis when hovering mouse over category series and financial series. You can use and properties to format date and time in the if the x-axis shows dates. For other types of series, the does not render the header row.
### Series Row
-The series row represents each series plotted in the chart. These rows will display the legend badge, series title, actual/abbreviated value of the the series, and abbreviation symbol or unit of measurement, if specified. You can filter series rows by setting `IncludedSeries` or `ExcludedSeries` properties to a collection of series' indexes (1, 2, 3) or series' titles (Tesla, Microsoft).
+The series row represents each series plotted in the chart. These rows will display the legend badge, series title, actual/abbreviated value of the the series, and abbreviation symbol or unit of measurement, if specified. You can filter series rows by setting or properties to a collection of series' indexes (1, 2, 3) or series' titles (Tesla, Microsoft).
### Summary Row
-Finally, there is a summary row that displays the total of all series values. The default summary title can be changed using the `SummaryTitleText` property of the legend. Also, you can use the `SummaryType` property to customize whether you display the `Total`, `Min`, `Max`, or `Average` of series values in the summary row.
+Finally, there is a summary row that displays the total of all series values. The default summary title can be changed using the property of the legend. Also, you can use the property to customize whether you display the , , , or of series values in the summary row.
## {Platform} Data Legend Columns
-The columns of the `DataLegend` include the series title, label, value of data column, and optional unit associated with the value. Some series in the chart can have multiple columns for label, value, and units. For example, financial price series has **High**, **Low**, **Open**, and **Close** data columns which can be filtered in the `DataLegend` using the `IncludedColumns` or `ExcludedColumns` properties.
+The columns of the include the series title, label, value of data column, and optional unit associated with the value. Some series in the chart can have multiple columns for label, value, and units. For example, financial price series has **High**, **Low**, **Open**, and **Close** data columns which can be filtered in the using the or properties.
-Setting values on the `IncludedColumns` and `ExcludedColumns` properties, depends on type of series and how many data columns they support. For example, you can set `IncludedColumns` property to a collection of **Open** and **Close** strings and the legend will show only open and close values for stock prices when the chart is plotting financial series. The following table lists all column names that can be use to filter columns in data legend.
+Setting values on the and properties, depends on type of series and how many data columns they support. For example, you can set property to a collection of **Open** and **Close** strings and the legend will show only open and close values for stock prices when the chart is plotting financial series. The following table lists all column names that can be use to filter columns in data legend.
| Type of Series | Column Names |
| -----------------|-------------- |
@@ -61,20 +61,20 @@ Where the **TypicalPrice** and percentage **Change** of OHLC prices are automati
### Title Column
-The title column displays legend badges and series titles, which come from the `Title` property of the different `Series` plotted in the chart.
+The title column displays legend badges and series titles, which come from the property of the different plotted in the chart.
### Label Column
-The label column displays short name on the left side of value column, e.g. "O" for **Open** stock price. You can toggle visibility of this column using the `LabelDisplayMode` property.
+The label column displays short name on the left side of value column, e.g. "O" for **Open** stock price. You can toggle visibility of this column using the property.
### Value Column
-The value column displays values of series as abbreviated text which can be formatted using the `ValueFormatAbbreviation` property to apply the same abbreviation for all numbers by setting this property to `Shared`. Alternatively, a user can select other abbreviations such as `Independent`, `Kilo`, `Million`, etc. Precision of abbreviated values is controlled using the `ValueFormatMinFractions` and `ValueFormatMaxFractions` for minimum and maximum digits, respectively.
+The value column displays values of series as abbreviated text which can be formatted using the property to apply the same abbreviation for all numbers by setting this property to . Alternatively, a user can select other abbreviations such as , , , etc. Precision of abbreviated values is controlled using the and for minimum and maximum digits, respectively.
### Unit Column
-The unit column displays an abbreviation symbol on the right side of value column. The unit symbol depends on the `ValueFormatAbbreviation` property, e.g. "M" for the `Million` abbreviation.
+The unit column displays an abbreviation symbol on the right side of value column. The unit symbol depends on the property, e.g. "M" for the abbreviation.
### Customizing Columns
@@ -88,11 +88,11 @@ You can customize text displayed in the **Label** and **Unit** columns using pr
| Range Series | HighMemberAsLegendLabel="H:" HighMemberAsLegendUnit="K" LowMemberAsLegendLabel="L:" LowMemberAsLegendUnit="K" |
| Financial Series | OpenMemberAsLegendLabel="O:" OpenMemberAsLegendUnit="K" HighMemberAsLegendLabel="H:" HighMemberAsLegendUnit="K" LowMemberAsLegendLabel="L:" LowMemberAsLegendUnit="K" CloseMemberAsLegendLabel="C:" CloseMemberAsLegendUnit="K" |
-Also, you can use the `UnitText` property on the `DataLegend` to change text displayed in all Unit columns.
+Also, you can use the `UnitText` property on the to change text displayed in all Unit columns.
## Layout Mode
-Legend items can be positioned in a vertical or table structure via the `LayoutMode` property. The default value is `Table`, which retains the same look and feel as seen in previous releases.
+Legend items can be positioned in a vertical or table structure via the property. The default value is `Table`, which retains the same look and feel as seen in previous releases.
eg.
@@ -100,7 +100,7 @@ eg.
## {Platform} Data Legend Styling
-The `DataLegend` provides properties for styling each type of column. Each of these properties begins with **Title**, **Label**, **Value**, or **Units**. You can style the text's color, font, and margin. For example, if you wanted to set the text color of all columns, you would set the `TitleTextColor`, `LabelTextColor`, `ValueTextColor`, and `UnitsTextColor` properties. The following example demonstrates a utilization of the styling properties mentioned above:
+The provides properties for styling each type of column. Each of these properties begins with **Title**, **Label**, **Value**, or **Units**. You can style the text's color, font, and margin. For example, if you wanted to set the text color of all columns, you would set the , , , and properties. The following example demonstrates a utilization of the styling properties mentioned above:
@@ -109,7 +109,7 @@ The `DataLegend` provides properties for styling each type of column. Each of th
## {Platform} Data Legend Value Formatting
-The `DataLegend` provides automatic abbreviation of large numbers using its `ValueFormatAbbreviation` property. This adds a multiplier in the units column such as kilo, million, billion, etc. You can customize the number of fractional digits that are displayed by setting the `ValueFormatMinFractions` and `ValueFormatMaxFractions`. This will allow you to determine the minimum and maximum number of digits that appear after the decimal point, respectively.
+The provides automatic abbreviation of large numbers using its property. This adds a multiplier in the units column such as kilo, million, billion, etc. You can customize the number of fractional digits that are displayed by setting the and . This will allow you to determine the minimum and maximum number of digits that appear after the decimal point, respectively.
The following example demonstrates how to use those properties:
@@ -119,7 +119,7 @@ The following example demonstrates how to use those properties:
## {Platform} Data Legend Value Mode
-You have the ability to change the default decimal display of values within the `DataLegend` to a currency by changing the `ValueFormatMode` property. Also, you can change the culture of the displayed currency symbol by setting the `ValueFormatCulture` property a culture tag. For example, the following example data legend with the `ValueFormatCulture` set to "en-GB" to display British Pounds (£) symbol:
+You have the ability to change the default decimal display of values within the to a currency by changing the property. Also, you can change the culture of the displayed currency symbol by setting the property a culture tag. For example, the following example data legend with the set to "en-GB" to display British Pounds (£) symbol:
@@ -127,8 +127,8 @@ You have the ability to change the default decimal display of values within the
## {Platform} Data Legend Grouping
-`DataLegendGroup` can be set, on all types of series, to a string that will categorize a group of series in Data Legend. Each group will have its own summary row displayed before another group of series is displayed:
-By default, DataLegend will hide names of groups, but you can display group names by setting the `GroupRowVisible` property to true.
+ can be set, on all types of series, to a string that will categorize a group of series in Data Legend. Each group will have its own summary row displayed before another group of series is displayed:
+By default, DataLegend will hide names of groups, but you can display group names by setting the property to true.
@@ -140,21 +140,21 @@ Several properties are exposed including grouping portions of the legend.
- `GroupRowMargin`
- `GroupTextMargin`
-- `GroupTextColor`
+-
- `GroupTextFontSize`
- `GroupTextFontFamily`
- `GroupTextFontStyle`
- `GroupTextFontStretch`
- `GroupTextFontWeight`
- `HeaderTextMargin`
-- `HeaderTextColor`
+-
- `HeaderTextFontSize`
- `HeaderTextFontFamily`
- `HeaderTextFontStyle`
- `HeaderTextFontStretch`
- `HeaderTextFontWeight`
-The `DataLegend` has several events that fire when rendering their corresponding row, even during mouse interactions where the values are updating. These events are listed below with a description of what they are designed to be used for:
+The has several events that fire when rendering their corresponding row, even during mouse interactions where the values are updating. These events are listed below with a description of what they are designed to be used for:
- `StyleGroupRow`: This event fires for each group to style text displayed in group rows.
- `StyleHeaderRow`: This event fires when rendering the header row.
@@ -163,9 +163,9 @@ The `DataLegend` has several events that fire when rendering their corresponding
- `StyleSummaryRow`: This event fires once when rendering the summary row.
- `StyleSummaryColumn`: This event fires once when rendering the summary column.
-Some of the events exposes a `DataLegendStylingRowEventArgs` parameter as its arguments, which lets you customize each item's text, text color, and the overall visibility of the row. The event arguments also expose event-specific properties. For example, since the `StyleSeriesRow` event fires for each series, the event arguments will return the series index and series title for the row that represents the series.
+Some of the events exposes a parameter as its arguments, which lets you customize each item's text, text color, and the overall visibility of the row. The event arguments also expose event-specific properties. For example, since the `StyleSeriesRow` event fires for each series, the event arguments will return the series index and series title for the row that represents the series.
-`StyleSummaryColumn` and `SeriesStyleColumn` events expose a `DataLegendStylingColumnEventArgs` parameter as its arguments, for customizing each field in the series. The event arguments also expose event-specific properties such as column index and value member related properties about the columns.
+`StyleSummaryColumn` and `SeriesStyleColumn` events expose a parameter as its arguments, for customizing each field in the series. The event arguments also expose event-specific properties such as column index and value member related properties about the columns.
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-data-selection.mdx b/docs/xplat/src/content/en/components/charts/features/chart-data-selection.mdx
index 981bbc44ca..1d26c02395 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-data-selection.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-data-selection.mdx
@@ -10,13 +10,15 @@ namespace: Infragistics.Controls.Charts
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# {Platform} Chart Selection
The {ProductName} selection feature in {Platform} Data Chart allows users to interactively select, highlight, outline and vice-versa deselect single or multiple series within a chart. This provides many different possibilities with how users interact with the data presented in more meaningful ways.
## Configuring Selection
-The default behavior `SelectionMode` turned off and requires opting into one of the following options. There are several selection modes available in the `DataChart`:
+The default behavior turned off and requires opting into one of the following options. There are several selection modes available in the :
- **Auto**
- **None**
@@ -32,10 +34,10 @@ The default behavior `SelectionMode` turned off and requires opting into one of
- **ThickOutline**
`Brighten` will fade the selected item while `FadeOthers` will cause the opposite effect occur.
-`GrayscaleOthers` will behave similarly to `FadeOthers` but instead show a gray color to the rest of the series. Note this will override any `SelectionBrush` setting.
+`GrayscaleOthers` will behave similarly to `FadeOthers` but instead show a gray color to the rest of the series. Note this will override any setting.
`SelectionColorOutline` and `SelectionColorThickOutline` will draw a border around the series.
-In conjunction, a `SelectionBehavior` is available to provide greater control on which items get selected. The default behavior for Auto is `PerSeriesAndDataItemMultiSelect`.
+In conjunction, a is available to provide greater control on which items get selected. The default behavior for Auto is `PerSeriesAndDataItemMultiSelect`.
- **Auto**
- **PerDataItemMultiSelect**
@@ -56,7 +58,7 @@ The following example shows the combination of both `SelectionColorFill` and `Au
## Configuring Multiple Selection
-Other selection modes offer various methods of selection. For example using `SelectionBehavior` with `PerDataItemMultiSelect` will affect all series in entire category when multiple series are present while allowing selection across categories. Compared to `PerDataItemSingleSelect`, only a single category of items can be selected at a time. This is useful if multiple series are bound to different datasources and provides greater control of selection between categories.
+Other selection modes offer various methods of selection. For example using with `PerDataItemMultiSelect` will affect all series in entire category when multiple series are present while allowing selection across categories. Compared to `PerDataItemSingleSelect`, only a single category of items can be selected at a time. This is useful if multiple series are bound to different datasources and provides greater control of selection between categories.
`PerSeriesAndDataItemGlobalSingleSelect` allows single series selection across all categories at a time.
@@ -64,19 +66,19 @@ Other selection modes offer various methods of selection. For example using `Sel
## Configuring Outline Selection
-When `FocusBrush` is applied, selected series will appear with a border when the `SelectionMode` property is set to one of the focus options.
+When is applied, selected series will appear with a border when the property is set to one of the focus options.
## Radial Series Selection
-This example demonstrates another series type via the `DataChart` where each radial series can be selected with different colors.
+This example demonstrates another series type via the where each radial series can be selected with different colors.
## Programmatic Selection
-Chart Selection can also be configured in code where selected items in the chart can be seen on startup or runtime. This can be achieved by adding items to the `SelectedSeriesCollection` of the `CategoryChart`. The `Matcher` property of the `ChartSelection` object allows for selecting a series based on a "matcher", ideal when you do not have access to the actual series from the chart. If you know the properties that your datasource contains, you can use the `ValueMemberPath` that the series would be.
+Chart Selection can also be configured in code where selected items in the chart can be seen on startup or runtime. This can be achieved by adding items to the `SelectedSeriesCollection` of the . The property of the object allows for selecting a series based on a "matcher", ideal when you do not have access to the actual series from the chart. If you know the properties that your datasource contains, you can use the `ValueMemberPath` that the series would be.
-The matcher is ideal for using in charts, such as the `CategoryChart` when you do not have access to the actual series, like the `DataChart`. In this case you if you know the properties that your datasource contained you can surmise the ValueMemberPaths that the series would have. For example, if you datasource has numeric properties Nuclear, Coal, Oil, Solar then you know there are series created for each of these properties. If you want to highlight the series bound to Solar values, you can add a ChartSelection object to the `SelectedSeriesItems` collection using a matcher with the following properties set
+The matcher is ideal for using in charts, such as the when you do not have access to the actual series, like the . In this case you if you know the properties that your datasource contained you can surmise the ValueMemberPaths that the series would have. For example, if you datasource has numeric properties Nuclear, Coal, Oil, Solar then you know there are series created for each of these properties. If you want to highlight the series bound to Solar values, you can add a ChartSelection object to the collection using a matcher with the following properties set
For example, if you datasource has numeric properties Nuclear, Coal, Oil, Solar then you know there are series created for each of these properties. If you want to select the series bound to Solar values, you can add a ChartSelection object to the SelectedSeriesItems collection using a matcher with the following properties set.
@@ -87,6 +89,6 @@ For example, if you datasource has numeric properties Nuclear, Coal, Oil, Solar
The following is a list of API members mentioned in the above sections:
-| `CategoryChart` Properties | `DataChart` Properties |
+| Properties | Properties |
| ----------------------------------------------|---------------------------|
| | |
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-data-tooltip.mdx b/docs/xplat/src/content/en/components/charts/features/chart-data-tooltip.mdx
index cc6ea3b8b0..4ae0ccfda9 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-data-tooltip.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-data-tooltip.mdx
@@ -46,7 +46,7 @@ The following example demonstrates the data tooltip with a summary applied:
The columns of the include the title, label, value, and units columns. Each series in the chart can have multiple columns for label, value, and units depending on the or collections of the chart.
-The title column displays legend badges and series titles, which come from the `Title` property of the different `Series` plotted in the chart.
+The title column displays legend badges and series titles, which come from the property of the different plotted in the chart.
The label column displays the name or abbreviation of the different property paths in the or collections of the tooltip.
@@ -83,8 +83,8 @@ The following example demonstrates a data tooltip with the added columns of Open
## {Platform} Data Tooltip Grouping for Data Chart
-`DataLegendGroup` can be set, on all types of series, to a string that will categorize a group of series in Data Legend. Each group will have its own summary row displayed before another group of series is displayed:
-By default, DataLegend will hide names of groups, but you can display group names by setting the `GroupRowVisible` property to true. `GroupingMode` should be set to "Grouped" and `LabelDisplayMode` should be set to "Visible" on the Data Tooltip Layer.
+ can be set, on all types of series, to a string that will categorize a group of series in Data Legend. Each group will have its own summary row displayed before another group of series is displayed:
+By default, DataLegend will hide names of groups, but you can display group names by setting the property to true. should be set to "Grouped" and should be set to "Visible" on the Data Tooltip Layer.
@@ -119,7 +119,7 @@ You can change the default decimal display of values within the **DataToolTip**
## Layout Mode
-Legend items can be positioned in a vertical or table structure via the `LayoutMode` property. The default value is `Table`, which retains the same look and feel as seen in previous releases.
+Legend items can be positioned in a vertical or table structure via the property. The default value is `Table`, which retains the same look and feel as seen in previous releases.
eg.
@@ -138,14 +138,14 @@ The following example demonstrates usage of the styling properties mentioned abo
Several properties are exposed including grouping portions of the tooltip.
- `GroupTextMargin`
-- `GroupTextColor`
+-
- `GroupTextFontSize`
- `GroupTextFontFamily`
- `GroupTextFontStyle`
- `GroupTextFontStretch`
- `GroupTextFontWeight`
- `HeaderTextMargin`
-- `HeaderTextColor`
+-
- `HeaderTextFontSize`
- `HeaderTextFontFamily`
- `HeaderTextFontStyle`
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-highlight-filter.mdx b/docs/xplat/src/content/en/components/charts/features/chart-highlight-filter.mdx
index b0cea8d76a..fa32ce31e2 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-highlight-filter.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-highlight-filter.mdx
@@ -9,6 +9,8 @@ namespace: Infragistics.Controls.Charts
import Sample from 'igniteui-astro-components/components/mdx/Sample.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# {Platform} Chart Highlight Filter
The {ProductName} Chart components support a data highlighting overlay that can enhance the visualization of the series plotted in those charts by allowing you to view a subset of the data plotted. When enabled, this will highlight a subset of data while showing the total set with a reduced opacity in the case of column and area series types, and a dashed line in the case of line series types. This can help you to visualize things like target values versus actual values with your data set. This feature is demonstrated in the following example:
@@ -16,45 +18,45 @@ The {ProductName} Chart components support a data highlighting overlay that can
-Note that data highlighting feature is supported by the `DataChart` and `CategoryChart`, but it is configured in different ways in those controls due to the nature of how those controls work. One thing remains constant with this feature though, in that you need to set the `HighlightedValuesDisplayMode` property to `Overlay` if you want to see the highlight. The following will explain the different configurations for the highlight filter feature.
+Note that data highlighting feature is supported by the and , but it is configured in different ways in those controls due to the nature of how those controls work. One thing remains constant with this feature though, in that you need to set the property to `Overlay` if you want to see the highlight. The following will explain the different configurations for the highlight filter feature.
## Using Highlight Filter with DataChart
-In the `DataChart`, much of the highlight filter API happens on the series themselves, mainly by setting the `HighlightedItemsSource` property to a collection representing a subset of the data you want to highlight. The count of the items in the `HighlightedItemsSource` needs to match the count of the data bound to the `ItemsSource` of the series that you are looking to highlight, and in the case of category series, it will use the `ValueMemberPath` that you have defined as the highlight path by default. The sample at the top of this page uses the `HighlightedItemsSource` in the `DataChart` to show the overlay.
+In the , much of the highlight filter API happens on the series themselves, mainly by setting the property to a collection representing a subset of the data you want to highlight. The count of the items in the needs to match the count of the data bound to the of the series that you are looking to highlight, and in the case of category series, it will use the `ValueMemberPath` that you have defined as the highlight path by default. The sample at the top of this page uses the in the to show the overlay.
-In the case that the schema does not match between the `HighlightedItemsSource` and the `ItemsSource` of the series, you can configure this using the `HighlightedValueMemberPath` property on the series. Additionally, if you would like to use the `ItemsSource` of the series itself as the highlight source and have a path on your data item that represents the subset, you can do this. This is done by simply setting the `HighlightedValueMemberPath` property to that path and not providing a `HighlightedItemsSource`.
+In the case that the schema does not match between the and the of the series, you can configure this using the `HighlightedValueMemberPath` property on the series. Additionally, if you would like to use the of the series itself as the highlight source and have a path on your data item that represents the subset, you can do this. This is done by simply setting the `HighlightedValueMemberPath` property to that path and not providing a .
-The reduced opacity of the column and area series types is configurable by setting the `HighlightedValuesFadeOpacity` property on the series. You can also set the `HighlightedValuesDisplayMode` property to `Hidden` if you do not wish to see the overlay at all.
+The reduced opacity of the column and area series types is configurable by setting the property on the series. You can also set the property to `Hidden` if you do not wish to see the overlay at all.
-The part of the series shown by the highlight filter will be represented in the legend and tooltip layers of the chart separately. You can configure the title that this is given in the tooltip and legend by setting the `HighlightedTitleSuffix`. This will append the value that you provide to the end of the `Title` of the series.
+The part of the series shown by the highlight filter will be represented in the legend and tooltip layers of the chart separately. You can configure the title that this is given in the tooltip and legend by setting the . This will append the value that you provide to the end of the of the series.
-If the `DataLegend` or `DataToolTipLayer` is used then the highlighted series will appear grouped. This can be managed by setting the `HighlightedValuesDataLegendGroup` property on the series to categorize them appropriately.
+If the or is used then the highlighted series will appear grouped. This can be managed by setting the property on the series to categorize them appropriately.
-The following example demonstrates the usage of the data legend grouping and highlighting overlay feature within the `DataChart` control using the `HighlightedValuesDataLegendGroup`:
+The following example demonstrates the usage of the data legend grouping and highlighting overlay feature within the control using the :
-The following example demonstrates the usage of the data legend grouping and highlighting overlay feature within the `DataChart` control using the `HighlightedValuesDataLegendGroup`:
+The following example demonstrates the usage of the data legend grouping and highlighting overlay feature within the control using the :
-The following example demonstrates the usage of the data highlighting overlay feature within the `DataChart` control using the `HighlightedValueMemberPath`:
+The following example demonstrates the usage of the data highlighting overlay feature within the control using the `HighlightedValueMemberPath`:
## Using Highlight Filter in CategoryChart
-The `CategoryChart` highlight filter happens on the chart by setting the `InitialHighlightFilter` property. Since the `CategoryChart` takes all of the properties on your underlying data item into account by default, you will need to define the `InitialGroups` on the chart as well so that the data can be grouped and aggregated in a way that you can have a subset of the data to filter on. You can set the `InitialGroups` to a value path in your underlying data item to group by a path that has duplicate values.
+The highlight filter happens on the chart by setting the property. Since the takes all of the properties on your underlying data item into account by default, you will need to define the on the chart as well so that the data can be grouped and aggregated in a way that you can have a subset of the data to filter on. You can set the to a value path in your underlying data item to group by a path that has duplicate values.
{/* Unsure of this part. Need to review */}
-{/* ????? The `InitialHighlightFilter` is done using OData filter query syntax. The syntax for this is an abbreviation of the filter operator. For example, if you wanted to have an InitialHighlightFilter of "Month not equals January" it would be represented as "Month ne 'January'"*/}
+{/* ????? The is done using OData filter query syntax. The syntax for this is an abbreviation of the filter operator. For example, if you wanted to have an InitialHighlightFilter of "Month not equals January" it would be represented as "Month ne 'January'"*/}
-Similar to the `DataChart`, the `HighlightedValuesDisplayMode` property is also exposed on the `CategoryChart`. In the case that you do not want to see the overlay, you can set this property to `Hidden`.
+Similar to the , the property is also exposed on the . In the case that you do not want to see the overlay, you can set this property to `Hidden`.
-The following example demonstrates the usage of the data highlighting overlay feature within the `CategoryChart` control:
+The following example demonstrates the usage of the data highlighting overlay feature within the control:
@@ -76,7 +78,7 @@ You can find more information about related chart features in these topics:
The following is a list of API members mentioned in the above sections:
-| `CategoryChart` Properties | `DataChart` Properties |
+| Properties | Properties |
| ----------------------------------------------|---------------------------|
| `CategoryChart.HighlightedItemsSource` | `Series.HighlightedItemsSource` |
| `CategoryChart.HighlightedTitleSuffix` | `Series.HighlightedTitleSuffix` |
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-markers.mdx b/docs/xplat/src/content/en/components/charts/features/chart-markers.mdx
index 813b6b0d2f..a6e82c5d6a 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-markers.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-markers.mdx
@@ -18,7 +18,7 @@ In {ProductName}, markers are visual elements that display the values of data po
## {Platform} Chart Marker Example
-In the following example, the [Line Chart](../types/line-chart.md) is comparing the generation of renewable electricity for the countries Europe, China, and USA over the years of 2009 to 2019 with markers enabled by setting the property to `Circle` enum value.
+In the following example, the [Line Chart](../types/line-chart.md) is comparing the generation of renewable electricity for the countries Europe, China, and USA over the years of 2009 to 2019 with markers enabled by setting the property to enum value.
The colors of the markers are also managed by setting the and properties in the sample below. The markers and is configurable in this sample by using the drop-downs as well.
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-overlays.mdx b/docs/xplat/src/content/en/components/charts/features/chart-overlays.mdx
index 91c83052a5..5a09e9a411 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-overlays.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-overlays.mdx
@@ -28,13 +28,13 @@ The following example depicts a [Column Chart](../types/column-chart.md) with a
## {Platform} Value Overlay Properties
-Unlike other series types that use a `ItemsSource` for data binding, the value overlay uses a property to bind a single numeric value. In addition, the value overlay requires you to define a single to use. If you use an X-axis, the value overlay will be a vertical line, and if you use a Y-axis, it will be a horizontal line.
+Unlike other series types that use a for data binding, the value overlay uses a property to bind a single numeric value. In addition, the value overlay requires you to define a single to use. If you use an X-axis, the value overlay will be a vertical line, and if you use a Y-axis, it will be a horizontal line.
When using a numeric X or Y axis, the property should reflect the actual numeric value on the axis where you want the value overlay to be drawn. When using a category X or Y axis, the should reflect the index of the category at which you want the value overlay to appear.
When using the value overlay with a numeric angle axis, it will appear as a line from the center of the chart and when using a numeric radius axis, it will appear as a circle.
- appearance properties are inherited from `Series` and so and for example are available and work the same way they do with other types of series.
+ appearance properties are inherited from and so and for example are available and work the same way they do with other types of series.
It is also possible to show an axis annotation on a to show the value of the overlay on the owning axis. In order to show this, you can set the property to true.
@@ -44,15 +44,15 @@ The {Platform} charting components also expose the ability to use value lines to
Applying the in the and components is done by setting the property on the chart. This property takes a collection of the enumeration. You can mix and match multiple value layers in the same chart by adding multiple enumerations to the collection of the chart.
-In the , this is done by adding a to the `Series` collection of the chart and then setting the property to one of the enumerations. Each of these enumerations and what they mean is listed below:
+In the , this is done by adding a to the collection of the chart and then setting the property to one of the enumerations. Each of these enumerations and what they mean is listed below:
-- `Auto`: The default value mode of the enumeration.
-- `Average`: Applies potentially multiple value lines to call out the average value of each series plotted in the chart.
-- `GlobalAverage`: Applies a single value line to call out the average of all of the series values in the chart.
-- `GlobalMaximum`: Applies a single value line to call out the absolute maximum value of all of the series values in the chart.
-- `GlobalMinimum`: Applies a single value line to call out the absolute minimum value of all of the series values in the chart.
-- `Maximum`: Applies potentially multiple value lines to call out the maximum value of each series plotted in the chart.
-- `Minimum`: Applies potentially multiple value lines to call out the minimum value of each series plotted in the chart.
+- : The default value mode of the enumeration.
+- : Applies potentially multiple value lines to call out the average value of each series plotted in the chart.
+- : Applies a single value line to call out the average of all of the series values in the chart.
+- : Applies a single value line to call out the absolute maximum value of all of the series values in the chart.
+- : Applies a single value line to call out the absolute minimum value of all of the series values in the chart.
+- : Applies potentially multiple value lines to call out the maximum value of each series plotted in the chart.
+- : Applies potentially multiple value lines to call out the minimum value of each series plotted in the chart.
If you want to prevent any particular series from being taken into account when using the element, you can set the property on the layer. This will force the layer to target the series that you define. You can have as many elements within a single as you want.
@@ -71,7 +71,7 @@ You can also plot built-in financial overlays and indicators in {Platform} [Stoc
The {Platform} , , and all Data Annotation Layers can render custom overlay text inside plot area of the DataChart component. You can use this overlay text to annotate important events (e.g. company quarter reports) on x-axis or important values on y-axis in relationship to the layers.
-For example, you can use `DataAnnotationSliceLayer`, , and to show overlay text.
+For example, you can use , , and to show overlay text.
@@ -79,7 +79,7 @@ For example, you can use `DataAnnotationSliceLayer`, , and .
+the , , and .
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-performance.mdx b/docs/xplat/src/content/en/components/charts/features/chart-performance.mdx
index 3583dcbea9..4d8eca0266 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-performance.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-performance.mdx
@@ -22,7 +22,7 @@ The following examples demonstrates two high performance scenarios of {Platform}
## {Platform} Chart with High-Frequency
-In High-Frequency scenario, the {Platform} Charts can render data items that are updating in real time or at specified milliseconds intervals. You will experience no lag, no screen-flicker, and no visual delays, even as you interact with the chart on a touch-device. The following sample demonstrates the `CategoryChart` in High-Frequency scenario.
+In High-Frequency scenario, the {Platform} Charts can render data items that are updating in real time or at specified milliseconds intervals. You will experience no lag, no screen-flicker, and no visual delays, even as you interact with the chart on a touch-device. The following sample demonstrates the in High-Frequency scenario.
@@ -33,7 +33,7 @@ In High-Frequency scenario, the {Platform} Charts can render data items that are
## {Platform} Chart with High-Volume
-In High-Volume scenario, the {Platform} Charts can render 1 million of data points while the chart keeps providing smooth performance when end-users tries zooming in/out or navigating chart content. The following sample demonstrates the `CategoryChart` in High-Volume scenario.
+In High-Volume scenario, the {Platform} Charts can render 1 million of data points while the chart keeps providing smooth performance when end-users tries zooming in/out or navigating chart content. The following sample demonstrates the in High-Volume scenario.
@@ -46,7 +46,7 @@ This section lists guidelines and chart features that add to the overhead and pr
### Data Size
-If you need to plot data sources with large number of data points (e.g. 10,000+), we recommend using {Platform} `DataChart` with one of the following type of series which where designed for specially for that purpose.
+If you need to plot data sources with large number of data points (e.g. 10,000+), we recommend using {Platform} with one of the following type of series which where designed for specially for that purpose.
- [Scatter HD Chart](../types/scatter-chart.md#{PlatformLower}-scatter-high-density-chart) instead of [Category Point Chart](../types/point-chart.md) or [Scatter Marker Chart](../types/scatter-chart.md#{PlatformLower}-scatter-marker-chart)
- [Scatter Polyline Chart](../types/shape-chart.md#{PlatformLower}-scatter-polyline-chart) instead of [Category Line Chart](../types/line-chart.md#{PlatformLower}-line-chart-example) or [Scatter Line Chart](../types/scatter-chart.md#{PlatformLower}-scatter-line-chart)
@@ -54,7 +54,7 @@ If you need to plot data sources with large number of data points (e.g. 10,000+)
### Data Structure
-Although {Platform} charts support rendering of multiple data sources by binding array of arrays of data points to `ItemsSource` property. It is much faster for charts if multiple data sources are flatten into single data source where each data item contains multiple data columns rather just one data column. For example:
+Although {Platform} charts support rendering of multiple data sources by binding array of arrays of data points to property. It is much faster for charts if multiple data sources are flatten into single data source where each data item contains multiple data columns rather just one data column. For example:
@@ -138,7 +138,7 @@ export class MultiDataSources {
### Data Filtering
-{Platform} `CategoryChart` and the `FinancialChart` controls have built-in data adapter that analyzes your data and generates chart series for you. However, it works faster if you use `IncludedProperties` and `ExcludedProperties` to filter only those data columns that you actually want to render. For example,
+{Platform} and the controls have built-in data adapter that analyzes your data and generates chart series for you. However, it works faster if you use and to filter only those data columns that you actually want to render. For example,
@@ -162,7 +162,7 @@ this.Chart.excludedProperties = [ "CHN", "FRN", "GER" ];
### Chart Types
-Simpler chart types such as [Line Chart](../types/line-chart.md) have faster performance than using [Spline Chart](../types/spline-chart.md) because of the complex interpolation of spline lines between data points. Therefore, you should use `CategoryChart.ChartType` property of {Platform} `CategoryChart` or the `FinancialChart` control to select type of chart that renders faster. Alternatively, you can change a type of series to a faster series in {Platform} `DataChart` control.
+Simpler chart types such as [Line Chart](../types/line-chart.md) have faster performance than using [Spline Chart](../types/spline-chart.md) because of the complex interpolation of spline lines between data points. Therefore, you should use `CategoryChart.ChartType` property of {Platform} or the control to select type of chart that renders faster. Alternatively, you can change a type of series to a faster series in {Platform} control.
The following table lists chart types in order from the fastest performance to slower performance in each group of charts:
@@ -232,7 +232,7 @@ this.LineSeries.markerType = MarkerType.None;
### Chart Resolution
-Setting the `Resolution` property to a higher value will improve performance, but it will lower the graphical fidelity of lines of plotted series. As such, it can be increased up until the fidelity is unacceptable.
+Setting the property to a higher value will improve performance, but it will lower the graphical fidelity of lines of plotted series. As such, it can be increased up until the fidelity is unacceptable.
This code snippet shows how to decrease resolution in the {Platform} charts.
@@ -273,10 +273,10 @@ Enabling [Chart Trendlines](chart-trendlines.md) will slightly decrease performa
Usage of x-axis with DateTime support is not recommended if spaces between data points, based on the amount of time span between them, are not important. Instead, ordinal/category axis should be used because it is more efficient in the way it coalesces data. Also, ordinal/category axis doesn’t perform any sorting on the data like the time-based x-axis does.
-The `CategoryChart` already uses ordinal/category axis so there is no need to change its properties.
+The already uses ordinal/category axis so there is no need to change its properties.
-This code snippet shows how to ordinal/category x-axis in the `FinancialChart` and `DataChart` controls.
+This code snippet shows how to ordinal/category x-axis in the and controls.
@@ -328,7 +328,7 @@ This code snippet shows how to ordinal/category x-axis in the `FinancialChart` a
### Axis Intervals
-By default, {Platform} charts will automatically calculate `YAxisInterval` based on range of your data. Therefore, you should avoid setting axis interval especially to a small value to prevent rendering of too many of axis gridlines and axis labels. Also, you might want to consider increasing `YAxisInterval` property to a larger value than the automatically calculated axis interval if you do not need many axis gridlines or axis labels.
+By default, {Platform} charts will automatically calculate based on range of your data. Therefore, you should avoid setting axis interval especially to a small value to prevent rendering of too many of axis gridlines and axis labels. Also, you might want to consider increasing property to a larger value than the automatically calculated axis interval if you do not need many axis gridlines or axis labels.
We do not recommend setting axis minor interval as it will decrease chart performance.
@@ -398,7 +398,7 @@ This code snippet shows how to set axis major interval in the {Platform} charts.
### Axis Scale
-Setting the `YAxisIsLogarithmic` property to false is recommended for higher performance, as fewer operations are needed than calculating axis range and values of axis labels in logarithmic scale.
+Setting the property to false is recommended for higher performance, as fewer operations are needed than calculating axis range and values of axis labels in logarithmic scale.
### Axis Labels Visibility
@@ -478,7 +478,7 @@ This code snippet shows how to hide axis labels in the {Platform} charts.
### Axis Labels Abbreviation
-Although, the {Platform} charts support abbreviation of large numbers (e.g. 10,000+) displayed in axis labels when `YAxisAbbreviateLargeNumbers` is set to true. We recommend, instead pre-processing large values in your data items by dividing them a common factor and then setting `YAxisTitle` to a string that represents factor used used to abbreviate your data values.
+Although, the {Platform} charts support abbreviation of large numbers (e.g. 10,000+) displayed in axis labels when is set to true. We recommend, instead pre-processing large values in your data items by dividing them a common factor and then setting to a string that represents factor used used to abbreviate your data values.
This code snippet shows how to set axis title in the {Platform} charts.
@@ -608,78 +608,78 @@ The following code snippet shows how to set a fixed extent for labels on y-axis
Enabling additional axis visuals (e.g. axis titles) or changing their default values might decrease performance in the {Platform} charts.
-For example, changing these properties on the `CategoryChart` or `FinancialChart` control:
+For example, changing these properties on the or control:
| Axis Visual | X-Axis Properties | Y-Axis Properties |
| ---------------------|-------------------|------------------- |
-| All Axis Visual | `XAxisInterval` `XAxisMinorInterval` | `YAxisInterval` `YAxisMinorInterval` |
-| Axis Tickmarks | `XAxisTickStroke` `XAxisTickStrokeThickness` `XAxisTickLength` | `YAxisTickStroke` `YAxisTickStrokeThickness` `YAxisTickLength` |
-| Axis Major Gridlines | `XAxisMajorStroke` `XAxisMajorStrokeThickness` | `YAxisMajorStroke` `YAxisMajorStrokeThickness` |
-| Axis Minor Gridlines | `XAxisMinorStroke` `XAxisMinorStrokeThickness` | `YAxisMinorStroke` `YAxisMinorStrokeThickness` |
-| Axis Main Line | `XAxisStroke` `XAxisStrokeThickness` | `YAxisStroke` `YAxisStrokeThickness` |
-| Axis Titles | `XAxisTitle` `XAxisTitleAngle` | `YAxisTitle` `YAxisTitleAngle` |
-| Axis Strips | `XAxisStrip` | `YAxisStrip` |
+| All Axis Visual | | |
+| Axis Tickmarks | | |
+| Axis Major Gridlines | | |
+| Axis Minor Gridlines | | |
+| Axis Main Line | | |
+| Axis Titles | | |
+| Axis Strips | | |
-Or changing properties of an `Axis` in the `DataChart` control:
+Or changing properties of an in the control:
| Axis Visual | Axis Properties |
| ---------------------|------------------- |
| All Axis Visuals | `Interval`, `MinorInterval` |
-| Axis Tickmarks | `TickStroke` , `TickStrokeThickness`, `TickLength` |
-| Axis Major Gridlines | `MajorStroke`, `MajorStrokeThickness` |
-| Axis Minor Gridlines | `MinorStroke`, `MinorStrokeThickness` |
-| Axis Main Line | `Stroke`, `StrokeThickness` |
-| Axis Titles | `Title`, `TitleAngle` |
-| Axis Strips | `Strip` |
+| Axis Tickmarks | , , |
+| Axis Major Gridlines | , |
+| Axis Minor Gridlines | , |
+| Axis Main Line | , |
+| Axis Titles | , `TitleAngle` |
+| Axis Strips | |
## Performance in Financial Chart
-In addition to above performance guidelines, the {Platform} `FinancialChart` control has the following unique features that affect performance.
+In addition to above performance guidelines, the {Platform} control has the following unique features that affect performance.
### Y-Axis Mode
-Setting the `YAxisMode` option to `Numeric` is recommended for higher performance, as fewer operations are needed than using `PercentChange` mode.
+Setting the option to `Numeric` is recommended for higher performance, as fewer operations are needed than using mode.
### Chart Panes
-Setting a lot of panes using `IndicatorTypes` and `OverlayTypes` options, might decrease performance and it is recommended to use a few financial indicators and one financial overlay.
+Setting a lot of panes using and options, might decrease performance and it is recommended to use a few financial indicators and one financial overlay.
### Zoom Slider
-Setting the `ZoomSliderType` option to `None` will improve chart performance and enable more vertical space for other indicators and the volume pane.
+Setting the option to will improve chart performance and enable more vertical space for other indicators and the volume pane.
### Volume Type
-Setting the `VolumeType` property can have the following impact on chart performance:
+Setting the property can have the following impact on chart performance:
-- `None` - is the least expensive since it does not display the volume pane.
-- `Line` - is more expensive volume type to render and it is recommended when rendering a lot of data points or when plotting a lot of data sources.
-- `Area` - is more expensive to render than the `Line` volume type.
-- `Column` - is more expensive to render than the `Area` volume type and it is recommended when rendering volume data of 1-3 stocks.
+- - is the least expensive since it does not display the volume pane.
+- - is more expensive volume type to render and it is recommended when rendering a lot of data points or when plotting a lot of data sources.
+- - is more expensive to render than the volume type.
+- - is more expensive to render than the volume type and it is recommended when rendering volume data of 1-3 stocks.
## Performance in Data Chart
-In addition to the general performance guidelines, the {Platform} `DataChart` control has the following unique features that affect performance.
+In addition to the general performance guidelines, the {Platform} control has the following unique features that affect performance.
### Axes Collection
-Adding too many axis to the `Axes` collection of the `DataChart` control will decrease chart performance and we recommend [Sharing Axes](chart-axis-layouts.md#axis-sharing-example) between series.
+Adding too many axis to the collection of the control will decrease chart performance and we recommend [Sharing Axes](chart-axis-layouts.md#axis-sharing-example) between series.
### Series Collection
-Also, adding a lot of series to the `Series` collection of the {Platform} `DataChart` control will add overhead to rendering because each series has its own rendering canvas. This is especially important if you have more than 10 series in the Data Chart. We recommend combining multiple data sources into flatten data source (see [Data Structure](#data-structure) section) and then using conditional styling feature of the following series:
+Also, adding a lot of series to the collection of the {Platform} control will add overhead to rendering because each series has its own rendering canvas. This is especially important if you have more than 10 series in the Data Chart. We recommend combining multiple data sources into flatten data source (see [Data Structure](#data-structure) section) and then using conditional styling feature of the following series:
| Slower Performance Scenario | Faster Scenario with Conditional Styling |
| ----------------------------|---------------------------------------- |
-| 10+ of `LineSeries` | Single `ScatterLineSeries` |
-| 20+ of `LineSeries` | Single `ScatterPolylineSeries` |
-| 10+ of `ScatterLineSeries` | Single `ScatterPolylineSeries` |
-| 10+ of `PointSeries` | Single `ScatterSeries` |
-| 20+ of `PointSeries` | Single `HighDensityScatterSeries` |
-| 20+ of `ScatterSeries` | Single `HighDensityScatterSeries` |
-| 10+ of `AreaSeries` | Single `ScatterPolygonSeries` |
-| 10+ of `ColumnSeries` | Single `ScatterPolygonSeries` |
+| 10+ of | Single |
+| 20+ of | Single |
+| 10+ of | Single |
+| 10+ of | Single |
+| 20+ of | Single |
+| 20+ of | Single |
+| 10+ of | Single |
+| 10+ of | Single |
## Additional Resources
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-titles.mdx b/docs/xplat/src/content/en/components/charts/features/chart-titles.mdx
index 2b16796c56..d1b7f49490 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-titles.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-titles.mdx
@@ -28,20 +28,20 @@ When adding a title or subtitle to the chart control, the content of the chart a
| Property Name | Property Type | Description |
| ----------------------|------------------|------------|
| `ChartTitle` | string | Title's text content. |
-| `TitleTextColor` | string | Title's text. color |
-| `TitleAlignment` | HorizontalAlignment | Title's horizontal alignment. |
-| `TitleTextStyle` | string | Title's font style, e.g. Italic Bold 8pt Times New Roman |
-| `TitleTopMargin` | number | Title's top margin. |
-| `TitleLeftMargin` | number | Title's left margin. |
-| `TitleRightMargin` | number | Title's right margin. |
-| `TitleBottomMargin` | number | Title's bottom margin. |
-| `Subtitle` | string | Title's text content. |
-| `SubtitleTextColor` | string | Title's text. color |
-| `SubtitleAlignment` | HorizontalAlignment | Title's horizontal alignment. |
-| `SubtitleTextStyle` | string | Title's font style, e.g. Italic Bold 8pt Times New Roman |
-| `SubtitleTopMargin` | number | Title's top margin. |
-| `SubtitleLeftMargin` | number | Title's left margin. |
-| `SubtitleRightMargin` | number | Title's right margin. |
-| `SubtitleBottomMargin`| number | Title's bottom margin. |
+| | string | Title's text. color |
+| | HorizontalAlignment | Title's horizontal alignment. |
+| | string | Title's font style, e.g. Italic Bold 8pt Times New Roman |
+| | number | Title's top margin. |
+| | number | Title's left margin. |
+| | number | Title's right margin. |
+| | number | Title's bottom margin. |
+| | string | Title's text content. |
+| | string | Title's text. color |
+| | HorizontalAlignment | Title's horizontal alignment. |
+| | string | Title's font style, e.g. Italic Bold 8pt Times New Roman |
+| | number | Title's top margin. |
+| | number | Title's left margin. |
+| | number | Title's right margin. |
+| | number | Title's bottom margin. |
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-tooltips.mdx b/docs/xplat/src/content/en/components/charts/features/chart-tooltips.mdx
index df801d32e1..03755234ae 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-tooltips.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-tooltips.mdx
@@ -29,10 +29,10 @@ The Tooltip | Display a tooltip for a single item when the pointer is positioned over it. |
+| Tooltip | Display the data tooltips for all series in the chart. |
+| Tooltip | Display a tooltip for each data item in the category that the pointer is positioned over. |
+| Tooltip | Display a grouped tooltip for all data points in the category that the pointer is positioned over. |
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-trendlines.mdx b/docs/xplat/src/content/en/components/charts/features/chart-trendlines.mdx
index 8186b9e434..69d3aeb511 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-trendlines.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-trendlines.mdx
@@ -30,7 +30,7 @@ The following sample depicts a sh
## {Platform} Chart Trendlines Dash Array Example
-The following sample depicts a showing a `FinancialPriceSeries` with a **QuarticFit** dashed trendline applied via the property:
+The following sample depicts a showing a with a **QuarticFit** dashed trendline applied via the property:
@@ -40,7 +40,7 @@ The following sample depicts a showing
## {Platform} Chart Trendline Layer
-The is a series type that is designed to display a single trendline type for a target series. The difference between this and the existing trendline features on the existing series types is that since the is a series type, you can add more than one of them to the `Series` collection of the chart to have multiple trendlines attached to the same series. You can also have the trendline appear in the legend, which was not possible previously.
+The is a series type that is designed to display a single trendline type for a target series. The difference between this and the existing trendline features on the existing series types is that since the is a series type, you can add more than one of them to the collection of the chart to have multiple trendlines attached to the same series. You can also have the trendline appear in the legend, which was not possible previously.
## Trendline Layer Usage
@@ -52,7 +52,7 @@ If you would like to show the in
By default, the renders with the same color as its in a dashed line. This can be configured by using the various styling properties on the .
-To change the color of the trendline that is drawn, you can set its property. Alternatively, you can also set the property to `true`, which will pull from the chart's `Brushes` palette based on the index in which the is placed in the chart's `Series` collection.
+To change the color of the trendline that is drawn, you can set its property. Alternatively, you can also set the property to `true`, which will pull from the chart's palette based on the index in which the is placed in the chart's collection.
You can also modify the way that the appears by using its and properties. The takes a value between -1.0 and 1.0 to determine how much of a "shift" to apply to the options that end in "Shift".
diff --git a/docs/xplat/src/content/en/components/charts/features/chart-user-annotations.mdx b/docs/xplat/src/content/en/components/charts/features/chart-user-annotations.mdx
index d167278574..749e1cd877 100644
--- a/docs/xplat/src/content/en/components/charts/features/chart-user-annotations.mdx
+++ b/docs/xplat/src/content/en/components/charts/features/chart-user-annotations.mdx
@@ -19,7 +19,7 @@ import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
In {ProductName}, you can annotate the with slice, strip, and point annotations at runtime using the user annotations feature. This allows the end user to add more details to the plot such as calling out single important events such as company quarter reports by using the slice annotation or events that have a duration by using the strip annotation. You can also call out individual points on the plotted series by using the point annotation or any combination of these three.
-This is directly integrated with the available tools of the `Toolbar`. The following topic explains, with examples, how you can utilize the `Toolbar` to add user annotations to the plot area of the chart, as well as how to do add these user annotations programmatically.
+This is directly integrated with the available tools of the . The following topic explains, with examples, how you can utilize the to add user annotations to the plot area of the chart, as well as how to do add these user annotations programmatically.
@@ -30,7 +30,7 @@ This feature is designed to support X and Y axes and does not currently support
## Using the User Annotations with the Toolbar
-The `Toolbar` exposes an Annotations menu item with two tools with the labels of "Annotate Chart" and "Delete Note." In order for this menu item to appear, you first need to set the property on the corresponding chart to `true`.
+The exposes an Annotations menu item with two tools with the labels of "Annotate Chart" and "Delete Note." In order for this menu item to appear, you first need to set the property on the corresponding chart to `true`.
The "Annotate Chart" option that appears after opening allows you to annotate the plot area of the . This can be done by adding slice, strip, or point annotations. You can add a slice annotation by clicking on a label on the X or Y axis. You can add a strip annotation by clicking and dragging in the plot area. Also, you can add a point annotation by clicking on a point in a series plotted in the chart.
@@ -40,34 +40,34 @@ You can delete the annotations that you have previously added by selecting the "
-When adding one of these user annotations via the `Toolbar`, the will raise an event named `UserAnnotationInformationRequested` where you can provide more information for the user annotations. This event's arguments have a property named `AnnotationInfo` that will return a object that allows the configuration of multiple different aspects of the annotation to be added.
+When adding one of these user annotations via the , the will raise an event named `UserAnnotationInformationRequested` where you can provide more information for the user annotations. This event's arguments have a property named `AnnotationInfo` that will return a object that allows the configuration of multiple different aspects of the annotation to be added.
The table below details the different configurable properties on :
| Property | Type | Description |
|------------|---------|-------------|
-|`AnnotationData`|`string`|This property allows additional information for the user annotation. This property is designed to be utilized with the `UserAnnotationToolTipContentUpdating` event to show additional information in the annotation's tooltip.|
-|`AnnotationId`|`string`|This read-only property returns the unique string ID of the user annotation.|
-|`BadgeColor`|`string`|This property gets or sets the color to use for the badge in the user annotation.|
-|`BadgeImageUri`|`string`|This property gets or sets a path to an image to use for the badge in the user annotation.|
-|`DialogSuggestedXLocation`|`double`|This property gets a recommended X location to show a dialog based on the location that the user annotation was added.|
-|`DialogSuggestedYLocation`|`double`|This property gets a recommended Y location to show a dialog based on the location that the user annotation was added.|
-|`Label`|`string`|This property gets or sets the label to be shown in the user annotation.|
-|`MainColor`|`string`|This property gets or sets the color to be used to fill the background of the user annotation.|
+||`string`|This property allows additional information for the user annotation. This property is designed to be utilized with the `UserAnnotationToolTipContentUpdating` event to show additional information in the annotation's tooltip.|
+||`string`|This read-only property returns the unique string ID of the user annotation.|
+||`string`|This property gets or sets the color to use for the badge in the user annotation.|
+||`string`|This property gets or sets a path to an image to use for the badge in the user annotation.|
+||`double`|This property gets a recommended X location to show a dialog based on the location that the user annotation was added.|
+||`double`|This property gets a recommended Y location to show a dialog based on the location that the user annotation was added.|
+||`string`|This property gets or sets the label to be shown in the user annotation.|
+||`string`|This property gets or sets the color to be used to fill the background of the user annotation.|
-After you have made the changes to the annotation through the `UserAnnotationInformationRequested` event, you should invoke the `FinishAnnotationFlow` method on the to finish creating the annotation and commit the changes to it. Alternatively, you can also cancel the annotation's creation by calling `CancelAnnotationFlow` and passing the `AnnotationId` of the annotation, which can be obtained from the `AnnotationInfo` parameter of the `UserAnnotationInformationRequested` event's arguments, as mentioned above. This will remove the annotation from the plot area.
+After you have made the changes to the annotation through the `UserAnnotationInformationRequested` event, you should invoke the method on the to finish creating the annotation and commit the changes to it. Alternatively, you can also cancel the annotation's creation by calling and passing the of the annotation, which can be obtained from the `AnnotationInfo` parameter of the `UserAnnotationInformationRequested` event's arguments, as mentioned above. This will remove the annotation from the plot area.
## Using the User Annotations Programmatically
-When using the programmatically, you can invoke two different methods on the to put the chart into a mode where you can add or remove a user annotation. These methods are named `StartCreatingAnnotation` and `StartDeletingAnnotation`, respectively.
+When using the programmatically, you can invoke two different methods on the to put the chart into a mode where you can add or remove a user annotation. These methods are named and , respectively.
-After invoking `StartCreatingAnnotation`, you can add a slice annotation by clicking on a label on the X or Y axis, add a strip annotation by clicking and dragging in the plot area and releasing the mouse button, or add a point annotation by clicking on a data point on a series plotted in the chart.
+After invoking , you can add a slice annotation by clicking on a label on the X or Y axis, add a strip annotation by clicking and dragging in the plot area and releasing the mouse button, or add a point annotation by clicking on a data point on a series plotted in the chart.
Adding one of these user annotations will raise an event named `UserAnnotationInformationRequested`, where you can provide more information for the user annotation. This event's arguments have a property named `AnnotationInfo` that will return a object that allows the configuration of multiple different aspects of the annotation to be added.
-After you have made the changes to the annotation through the `UserAnnotationInformationRequested` event, you should invoke the `FinishAnnotationFlow` method on the to finish creating the annotation and commit the changes to it. Alternatively, you can also cancel the annotation's creation by calling `CancelAnnotationFlow` and passing the `AnnotationId` of the annotation, which can be obtained from the `AnnotationInfo` parameter of the `UserAnnotationInformationRequested` event's arguments, as mentioned above. This will remove the annotation from the plot area.
+After you have made the changes to the annotation through the `UserAnnotationInformationRequested` event, you should invoke the method on the to finish creating the annotation and commit the changes to it. Alternatively, you can also cancel the annotation's creation by calling and passing the of the annotation, which can be obtained from the `AnnotationInfo` parameter of the `UserAnnotationInformationRequested` event's arguments, as mentioned above. This will remove the annotation from the plot area.
-Once the user annotation has been added to the chart, it will appear in the `Series` collection as a . The has an `Annotations` collection that can store , and elements depending on the type of annotations added to the plot area.
+Once the user annotation has been added to the chart, it will appear in the collection as a . The has an collection that can store , and elements depending on the type of annotations added to the plot area.
## User Annotation ToolTip
diff --git a/docs/xplat/src/content/en/components/charts/types/area-chart.mdx b/docs/xplat/src/content/en/components/charts/types/area-chart.mdx
index aca28a70f1..d38b9b8530 100644
--- a/docs/xplat/src/content/en/components/charts/types/area-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/area-chart.mdx
@@ -58,7 +58,7 @@ There are several common use cases for choosing an Area Chart:
## {Platform} Area Chart with Single Series
-{Platform} Area Chart is often used to show the change of value over time such as the amount of renewable electricity produced. You can create this type of chart in control by binding your data and setting property to `Area` value, as shown in the example below.
+{Platform} Area Chart is often used to show the change of value over time such as the amount of renewable electricity produced. You can create this type of chart in control by binding your data and setting property to value, as shown in the example below.
@@ -93,7 +93,7 @@ The following sections explain more advanced types of {Platform} Area Charts tha
## {Platform} Step Area Chart
-The {Platform} Step Area Chart belongs to a group of category charts and it is rendered using a collection of points connected by continuous vertical and horizontal lines with the area below lines filled in. Values are represented on the y-axis and categories are displayed on the x-axis. The step area chart emphasizes the amount of change over a period of time or compares multiple items. You can create this type of chart in control by binding your data and setting property to `StepArea` value, as shown in the example below.
+The {Platform} Step Area Chart belongs to a group of category charts and it is rendered using a collection of points connected by continuous vertical and horizontal lines with the area below lines filled in. Values are represented on the y-axis and categories are displayed on the x-axis. The step area chart emphasizes the amount of change over a period of time or compares multiple items. You can create this type of chart in control by binding your data and setting property to value, as shown in the example below.
@@ -212,16 +212,16 @@ The following table lists API members mentioned in above sections:
| Chart Type | Control Name | API Members |
| -------------------------|-----------------|-----------------------|
-| Area | `CategoryChart` | `CategoryChart.ChartType` = `Area` |
-| Step Area | `CategoryChart` | `CategoryChart.ChartType` = `StepArea` |
-| Range Area | `DataChart` | `RangeAreaSeries` |
-| Radial Area | `DataChart` | `RadialAreaSeries` |
-| Polar Area | `DataChart` | `PolarAreaSeries` |
-| Polar Spline Area | `DataChart` | `PolarSplineAreaSeries` |
-| Stacked Area | `DataChart` | `StackedAreaSeries` |
-| Stacked Spline Area | `DataChart` | `StackedSplineAreaSeries` |
-| Stacked 100% Area | `DataChart` | `Stacked100AreaSeries` |
-| Stacked 100% Spline Area | `DataChart` | `Stacked100SplineAreaSeries` |
+| Area | | `CategoryChart.ChartType` = |
+| Step Area | | `CategoryChart.ChartType` = |
+| Range Area | | |
+| Radial Area | | |
+| Polar Area | | |
+| Polar Spline Area | | |
+| Stacked Area | | |
+| Stacked Spline Area | | |
+| Stacked 100% Area | | |
+| Stacked 100% Spline Area | | |
## API References
diff --git a/docs/xplat/src/content/en/components/charts/types/column-chart.mdx b/docs/xplat/src/content/en/components/charts/types/column-chart.mdx
index 10e750ae14..51a5278f05 100644
--- a/docs/xplat/src/content/en/components/charts/types/column-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/column-chart.mdx
@@ -178,12 +178,12 @@ The following table lists API members mentioned in the above sections:
| Chart Type | Control Name | API Members |
| --------------------|--------------------|------------------------|
-| Column | `CategoryChart` | `CategoryChart.ChartType` = **Column** |
-| Radial Column | `DataChart` | `RadialColumnSeries` |
-| Range Column | `DataChart` | `RangeColumnSeries` |
-| Stacked Column | `DataChart` | `StackedColumnSeries` |
-| Stacked 100% Column | `DataChart` | `Stacked100ColumnSeries` |
-| Waterfall | `DataChart` | `WaterfallSeries` |
+| Column | | `CategoryChart.ChartType` = **Column** |
+| Radial Column | | |
+| Range Column | | |
+| Stacked Column | | |
+| Stacked 100% Column | | |
+| Waterfall | | |
diff --git a/docs/xplat/src/content/en/components/charts/types/composite-chart.mdx b/docs/xplat/src/content/en/components/charts/types/composite-chart.mdx
index 5ec3132d71..fc0d017d1a 100644
--- a/docs/xplat/src/content/en/components/charts/types/composite-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/composite-chart.mdx
@@ -15,7 +15,7 @@ The {ProductName} Composite Chart, also called a Combo Chart, is visualization t
## {Platform} Composite / Combo Example
-The following example demonstrates how to create Composite Chart using `ColumnSeries` and `LineSeries` in the control.
+The following example demonstrates how to create Composite Chart using and in the control.
diff --git a/docs/xplat/src/content/en/components/charts/types/data-pie-chart.mdx b/docs/xplat/src/content/en/components/charts/types/data-pie-chart.mdx
index 14da58de2a..b29247210a 100644
--- a/docs/xplat/src/content/en/components/charts/types/data-pie-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/data-pie-chart.mdx
@@ -79,7 +79,7 @@ The Others category in the has thre
The property works in tandem with the property of the . For the , you can define whether you want the to be evaluated as a number or a percentage. For example, if you decide on number and set the to 5, any slices that have a value less than 5 will become part of the Others category. Using the same value of 5 with a percent type, any values that are less than 5 percent of the total values of the will become part of the Others category.
-To get the underlying data items that are contained within the Others slice in the chart, you can utilize the `GetOthersContext` method on the chart. This return type of this method is an `OthersCategoryContext` which exposes an `Items` property. The `Items` property returns an array that will contain the items in the Others slice. Additionally, when clicking the Others slice, the `Item` property of the event arguments for the `SeriesClick` event will be will also return this `OthersCategoryContext`.
+To get the underlying data items that are contained within the Others slice in the chart, you can utilize the method on the chart. This return type of this method is an which exposes an property. The property returns an array that will contain the items in the Others slice. Additionally, when clicking the Others slice, the `Item` property of the event arguments for the `SeriesClick` event will be will also return this .
By default, the Others slice will be represented by a label of "Others." You can change this by modifying the property of the chart.
@@ -112,21 +112,21 @@ The following sample demonstrates usage of the Others slice in the supports slice selection by mouse click on the slices plotted in the chart. This can be configured by utilizing the and properties of the chart, described below:
-The main two options of the are `PerDataItemSingleSelect` and `PerDataItemMultiSelect`, which will enable single and multiple selection, respectively.
+The main two options of the are and , which will enable single and multiple selection, respectively.
The property exposes an enumeration that determines how the pie chart slices respond to being selected. The following are the options of that enumeration and what they do:
-- `Brighten`: The selected slices will be highlighted.
-- `FadeOthers`: The selected slices will remain their same color and others will fade.
-- `FocusColorFill`: The selected slices will change their background to the FocusBrush of the chart.
-- `FocusColorOutline`: The selected slices will have an outline with the color defined by the FocusBrush of the chart.
-- `FocusColorThickOutline`: The selected slices will have an outline with the color defined by the FocusBrush of the chart. The thickness of this outline can be configured via the Thickness property of the control as well.
-- `GrayscaleOthers`: The unselected slices will have a gray color filter applied to them.
-- `None`: There is no effect on the selected slices.
-- `SelectionColorFill`: The selected slices will change their background to the SelectionBrush of the chart.
-- `SelectionColorOutline`: The selected slices will have an outline with the color defined by the SelectionBrush of the chart.
-- `SelectionColorThickOutline`: The selected slices will have an outline with the color defined by the FocusBrush of the chart. The thickness of this outline can be configured via the Thickness property of the control as well.
-- `ThickOutline`: The selected slices will apply an outline with the thickness dependent on the Thickness property of the chart.
+- : The selected slices will be highlighted.
+- : The selected slices will remain their same color and others will fade.
+- : The selected slices will change their background to the FocusBrush of the chart.
+- : The selected slices will have an outline with the color defined by the FocusBrush of the chart.
+- : The selected slices will have an outline with the color defined by the FocusBrush of the chart. The thickness of this outline can be configured via the Thickness property of the control as well.
+- : The unselected slices will have a gray color filter applied to them.
+- : There is no effect on the selected slices.
+- : The selected slices will change their background to the SelectionBrush of the chart.
+- : The selected slices will have an outline with the color defined by the SelectionBrush of the chart.
+- : The selected slices will have an outline with the color defined by the FocusBrush of the chart. The thickness of this outline can be configured via the Thickness property of the control as well.
+- : The selected slices will apply an outline with the thickness dependent on the Thickness property of the chart.
When a slice is selected, its underlying data item will be added to the SelectedSeriesItems collection of the chart. As such, the DataPieChart exposes the SelectedSeriesItemsChanged event to detect when a slice has been selected and this collection is changed.
@@ -143,18 +143,18 @@ The supports mouse over highlightin
First, the enumerated property determines how a slice will be highlighted. The following are the options of that property and what they do:
-- `DirectlyOver`: The slices are only highlighted when the mouse is directly over them.
-- `NearestItems`: The nearest slice to the mouse position will be highlighted.
-- `NearestItemsAndSeries`: The nearest slice and series to the mouse position will be highlighted.
-- `NearestItemsRetainMainShapes`: The nearest items to the mouse position will be highlighted and the main shapes of the series will not be de-emphasized.
+- : The slices are only highlighted when the mouse is directly over them.
+- : The nearest slice to the mouse position will be highlighted.
+- : The nearest slice and series to the mouse position will be highlighted.
+- : The nearest items to the mouse position will be highlighted and the main shapes of the series will not be de-emphasized.
The enumerated property determines how the data pie chart slices respond to being highlighted. The following are the options of that property and what they do:
-- `Brighten`: The series will have its color brightened when the mouse position is over or near it.
+- : The series will have its color brightened when the mouse position is over or near it.
- `BrightenSpecific`: The specific slice will have its color brightened when the mouse position is over or near it.
-- `FadeOthers`: The series will retain its color when the mouse position is over or near it, while the others will appear faded.
+- : The series will retain its color when the mouse position is over or near it, while the others will appear faded.
- `FadeOthersSpecific`: The specific slice will retain its color when the mouse position is over or near it, while the others will appear faded.
-- `None`: The series and slices will not be highlighted.
+- : The series and slices will not be highlighted.
The following example demonstrates the mouse highlighting behaviors of the component:
diff --git a/docs/xplat/src/content/en/components/charts/types/gantt-chart.mdx b/docs/xplat/src/content/en/components/charts/types/gantt-chart.mdx
index e3ea5c0545..622e41d906 100644
--- a/docs/xplat/src/content/en/components/charts/types/gantt-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/gantt-chart.mdx
@@ -16,7 +16,7 @@ The {ProductName} Gantt Chart is a type of bar chart, that visualizes various ca
## {Platform} Gantt Chart Example
-The following example demonstrates how to create Gantt Chart using `ScatterPolygonSeries` in the control.
+The following example demonstrates how to create Gantt Chart using in the control.
diff --git a/docs/xplat/src/content/en/components/charts/types/line-chart.mdx b/docs/xplat/src/content/en/components/charts/types/line-chart.mdx
index 30e044ff99..a727fd2b5d 100644
--- a/docs/xplat/src/content/en/components/charts/types/line-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/line-chart.mdx
@@ -15,7 +15,7 @@ The {ProductName} Line Chart or Line Graph is a type of category charts that sho
## {Platform} Line Chart Example
-You can create the {Platform} Line Chart in the control by binding your data to property and setting property to `Line` enum, as shown in the example below.
+You can create the {Platform} Line Chart in the control by binding your data to property and setting property to enum, as shown in the example below.
@@ -73,7 +73,7 @@ There are several common use cases for choosing a Line Chart:
The {Platform} Line Chart is often used to show the change of value over time such as the amount of renewable electricity produced since 2009 over a ten-year period, as we have shown in the example below.
-You can create this type of chart in the control by binding your data and setting the property to `Line`, as shown in the example below:
+You can create this type of chart in the control by binding your data and setting the property to , as shown in the example below:
@@ -86,7 +86,7 @@ You can create this type of chart in the control by binding your data and setting the property to `Line`, as shown in the example below:
+You can create this type of chart in the control by binding your data and setting the property to , as shown in the example below:
@@ -101,7 +101,7 @@ The {Platform} Line chart is capable of handling high volumes of data, ranging i
In this example, we are streaming live data into the {Platform} Line Chart at an interval of your choosing. You can set the data points from 5,000 to 1 million and update the chart to optimize the scale based on the device you are rendering the chart on.
-You can create this type of chart in the control by binding your data and setting the property to `Line`, as shown in the example below:
+You can create this type of chart in the control by binding your data and setting the property to , as shown in the example below:
@@ -114,7 +114,7 @@ You can create this type of chart in the control by binding your data and setting the property to `Line`, as shown in the example below:
+You can create this type of chart in the control by binding your data and setting the property to , as shown in the example below:
@@ -200,11 +200,11 @@ The following table lists API members mentioned in the above sections:
| Chart Type | Control Name | API Members |
| ------------------|--------------------|----------------------- |
-| Line | `CategoryChart` | `CategoryChart.ChartType` = `Line` |
-| Polar Line | `DataChart` | `PolarLineSeries` |
-| Radial Line | `DataChart` | `RadialLineSeries` |
-| Stacked Line | `DataChart` | `StackedLineSeries` |
-| Stacked 100% Line | `DataChart` | `Stacked100LineSeries` |
+| Line | | `CategoryChart.ChartType` = |
+| Polar Line | | |
+| Radial Line | | |
+| Stacked Line | | |
+| Stacked 100% Line | | |
diff --git a/docs/xplat/src/content/en/components/charts/types/pie-chart.mdx b/docs/xplat/src/content/en/components/charts/types/pie-chart.mdx
index d927364ea8..b193d319a7 100644
--- a/docs/xplat/src/content/en/components/charts/types/pie-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/pie-chart.mdx
@@ -107,7 +107,7 @@ The pie chart supports explosion of individual pie slices as well as a `SliceCli
## {Platform} Pie Chart Selection
-The pie chart supports slice selection by mouse click as the default behavior. You can determine the selected slices by using the `SelectedItems` property. The selected slices are then highlighted.
+The pie chart supports slice selection by mouse click as the default behavior. You can determine the selected slices by using the property. The selected slices are then highlighted.
There is a property called which is how you set what mode you want the pie chart to use. The default value is `Single`. In order to disable selection, set the property to `Manual`.
@@ -125,7 +125,7 @@ The pie chart has 4 events associated with selection:
The events that end in "Changing" are cancelable events which means you can stop the selection of a slice by setting the event argument property `Cancel` to true. When set to true the associated property will not update and the slice will not become selected. This is useful for scenarios where you want to keep users from being able to select certain slices based on the data inside it.
-For scenarios where you click on the Others slice, the pie chart will return an object called `PieSliceOthersContext`. This object contains a list of the data items contained within the Others slice.
+For scenarios where you click on the Others slice, the pie chart will return an object called . This object contains a list of the data items contained within the Others slice.
diff --git a/docs/xplat/src/content/en/components/charts/types/pyramid-chart.mdx b/docs/xplat/src/content/en/components/charts/types/pyramid-chart.mdx
index 854d37250b..9fc4dd1a83 100644
--- a/docs/xplat/src/content/en/components/charts/types/pyramid-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/pyramid-chart.mdx
@@ -15,7 +15,7 @@ The {ProductName} Pyramid Chart, also called an age pyramid or population pyrami
## {Platform} Pyramid Chart Example
-The following example demonstrates how to create Pyramid Chart using `BarSeries` in the control.
+The following example demonstrates how to create Pyramid Chart using in the control.
diff --git a/docs/xplat/src/content/en/components/charts/types/radial-chart.mdx b/docs/xplat/src/content/en/components/charts/types/radial-chart.mdx
index 694b6630ad..e3c2ec00ee 100644
--- a/docs/xplat/src/content/en/components/charts/types/radial-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/radial-chart.mdx
@@ -68,7 +68,7 @@ Once our radial chart is created, we may want to make some further styling custo
## {Platform} Radial Chart Settings
-In addition, the labels can be configured to appear near or wide from the chart. This can be configured with the `LabelMode` property for the .
+In addition, the labels can be configured to appear near or wide from the chart. This can be configured with the property for the .
diff --git a/docs/xplat/src/content/en/components/charts/types/scatter-chart.mdx b/docs/xplat/src/content/en/components/charts/types/scatter-chart.mdx
index 9dbfe715de..7dd921143c 100644
--- a/docs/xplat/src/content/en/components/charts/types/scatter-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/scatter-chart.mdx
@@ -95,12 +95,12 @@ The following table lists API members mentioned in the above sections:
|Chart Type | Control Name | API Members |
|----------------------------|----------------|------------------------ |
- |Scatter Marker | `DataChart` | `ScatterSeries` |
- |Scatter Line | `DataChart` | `ScatterLineSeries` |
- |Scatter Spline | `DataChart` | `ScatterSplineSeries` |
- |High Density Scatter | `DataChart` | `HighDensityScatterSeries` |
- |Scatter Area | `DataChart` | `ScatterAreaSeries` |
- |Scatter Contour | `DataChart` | `ScatterContourSeries` |
+ |Scatter Marker | | |
+ |Scatter Line | | |
+ |Scatter Spline | | |
+ |High Density Scatter | | |
+ |Scatter Area | | |
+ |Scatter Contour | | |
## API References
diff --git a/docs/xplat/src/content/en/components/charts/types/sparkline-chart.mdx b/docs/xplat/src/content/en/components/charts/types/sparkline-chart.mdx
index 770b21e781..fe6417634c 100644
--- a/docs/xplat/src/content/en/components/charts/types/sparkline-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/sparkline-chart.mdx
@@ -16,7 +16,7 @@ The {ProductName} Sparkline is a lightweight charting control. It is intended fo
## {Platform} Sparkline Example
-The following example shows all the different types of available. The type is defined by setting the property. If the property is not specified, then by default, the `Line` type is displayed.
+The following example shows all the different types of available. The type is defined by setting the property. If the property is not specified, then by default, the type is displayed.
@@ -61,10 +61,10 @@ The {Platform} Sparkline has the ability to mark the data points with elliptical
The {Platform} Sparkline supports the following types of sparklines by setting the property accordingly:
-- `Line`: Displays the line chart type of Sparkline with numeric data, connecting the data points with line segments. At least two data points must be supplied to visualize the data in Sparkline.
-- `Area`: Displays the Area chart type of Sparkline with numeric data. This is like line type with additional steps of closing the area after each line is drawn. At least two data points must be supplied to visualize the data in Sparkline.
-- `Column`: Displays the Column chart type of Sparkline with numeric data. Some may refer to it as vertical bars. This type can render a single data point, but it would require specifying the minimum value range property (minimum) in Sparkline so the supplied single data point can be visible, otherwise the value will be treated as the minimum value and will not be visible.
-- `WinLoss`: This type is similar in its visual appearance to Column chart type, in which the value of each column is equal to either the positive maximum (for positive values) or the negative minimum (for negative value) of the data set. The idea is to indicate a win or loss scenario. For the Win/Loss chart to display properly, the data set must have both positive and negative values. If the WinLoss sparkline is bound to the same data as the other types such as the Line type, which can be bound to a collection of numeric values, then the {Platform} Sparkline will select two values from the collection - the highest and the lowest - and will render the sparkline based upon those values.
+- : Displays the line chart type of Sparkline with numeric data, connecting the data points with line segments. At least two data points must be supplied to visualize the data in Sparkline.
+- : Displays the Area chart type of Sparkline with numeric data. This is like line type with additional steps of closing the area after each line is drawn. At least two data points must be supplied to visualize the data in Sparkline.
+- : Displays the Column chart type of Sparkline with numeric data. Some may refer to it as vertical bars. This type can render a single data point, but it would require specifying the minimum value range property (minimum) in Sparkline so the supplied single data point can be visible, otherwise the value will be treated as the minimum value and will not be visible.
+- : This type is similar in its visual appearance to Column chart type, in which the value of each column is equal to either the positive maximum (for positive values) or the negative minimum (for negative value) of the data set. The idea is to indicate a win or loss scenario. For the Win/Loss chart to display properly, the data set must have both positive and negative values. If the WinLoss sparkline is bound to the same data as the other types such as the Line type, which can be bound to a collection of numeric values, then the {Platform} Sparkline will select two values from the collection - the highest and the lowest - and will render the sparkline based upon those values.
@@ -75,7 +75,7 @@ The {Platform} Sparkline supports the following types of sparklines by setting t
## Markers
-The {Platform} Sparkline allows you to show markers as circular-colored icons on your series to indicate the individual data points based on X/Y coordinates. Markers can be set on sparklines of display types of `Line`, `Area`, and `Column`. The `WinLoss` type of sparkline does not currently accept markers. By default, markers are not displayed, but they can be enabled by setting the corresponding marker visibility property.
+The {Platform} Sparkline allows you to show markers as circular-colored icons on your series to indicate the individual data points based on X/Y coordinates. Markers can be set on sparklines of display types of , , and . The type of sparkline does not currently accept markers. By default, markers are not displayed, but they can be enabled by setting the corresponding marker visibility property.
Markers in the sparkline can be placed in any combination of the following locations:
@@ -98,7 +98,7 @@ All of the markers mentioned above can be customized using the related marker ty
The normal range feature of the {Platform} Sparkline is a horizontal stripe representing some pre-defined meaningful range when the data is being visualized. The normal range can be set as a shaded area outlined with the desired color.
-The normal range can be wider than the maximum data point or beyond, and it can also be as thin as the sparkline's `Line` display type, to serve as a threshold indicator, for instance. The width of the normal range is determined by the following three properties, which serve as the minimum settings required for displaying the normal range:
+The normal range can be wider than the maximum data point or beyond, and it can also be as thin as the sparkline's display type, to serve as a threshold indicator, for instance. The width of the normal range is determined by the following three properties, which serve as the minimum settings required for displaying the normal range:
- `NormalRangeVisibility`: Whether the normal range is visible.
- `NormalRangeMaximum`: The bottom border of the range.
@@ -116,9 +116,9 @@ You can also configure whether to show the normal range in front of or behind th
## Trendlines
-The {Platform} Sparkline has support for a range of trendlines that display as another layer on top of the actual sparkline layer. To display a sparkline, you can use the `TrendLineType` property.
+The {Platform} Sparkline has support for a range of trendlines that display as another layer on top of the actual sparkline layer. To display a sparkline, you can use the property.
-The trendlines are calculated according to the algorithm specified by the `TrendLineType` property using the values of the data the the chart is bound to.
+The trendlines are calculated according to the algorithm specified by the property using the values of the data the the chart is bound to.
Trendlines can only be displayed one at a time and by default, the trendline is not displayed.
diff --git a/docs/xplat/src/content/en/components/charts/types/spline-chart.mdx b/docs/xplat/src/content/en/components/charts/types/spline-chart.mdx
index f021977f9e..c2f75b05c6 100644
--- a/docs/xplat/src/content/en/components/charts/types/spline-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/spline-chart.mdx
@@ -14,7 +14,7 @@ The {ProductName} Spline Chart belongs to a group of Category Charts that render
## {Platform} Spline Chart Example
-The following example shows how to create {Platform} Spline Chart in the control by binding your data and setting the property to `Spline` enum.
+The following example shows how to create {Platform} Spline Chart in the control by binding your data and setting the property to enum.
@@ -27,7 +27,7 @@ The following example shows how to create {Platform} Spline Chart in the control by binding your data and setting the property to `Spline`, as shown in the example below:
+You can create this type of chart in the control by binding your data and setting the property to , as shown in the example below:
@@ -40,7 +40,7 @@ You can create this type of chart in the control by binding your data and setting the property to `Spline`, as shown in the example below:
+You can create this type of chart in the control by binding your data and setting the property to , as shown in the example below:
@@ -53,7 +53,7 @@ You can create this type of chart in the control by binding your data and setting the property to `Spline`, as shown in the example below:
+You can create this type of chart in the control by binding your data and setting the property to , as shown in the example below:
@@ -108,9 +108,9 @@ The following table lists API members mentioned in the above sections:
| Chart Type | Control Name | API Members |
| --------------------|--------------------|-------------------------- |
-| Spline | `CategoryChart` | `CategoryChart.ChartType` = `Spline` |
-| Stacked Spline | `DataChart` | `StackedSplineSeries` |
-| Stacked 100% Spline | `DataChart` | `Stacked100SplineSeries` |
+| Spline | | `CategoryChart.ChartType` = |
+| Stacked Spline | | |
+| Stacked 100% Spline | | |
diff --git a/docs/xplat/src/content/en/components/charts/types/stacked-chart.mdx b/docs/xplat/src/content/en/components/charts/types/stacked-chart.mdx
index 3ac303019f..81f6daa1ef 100644
--- a/docs/xplat/src/content/en/components/charts/types/stacked-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/stacked-chart.mdx
@@ -30,7 +30,7 @@ The following sections demonstrate individual types of {ProductName} Stacked Cha
Stacked Area Charts are rendered using a collection of points connected by line segments, with the area below the line filled in and stacked on top of each other. Stacked Area Charts follow all the same requirements as [Area Chart](area-chart.md), with the only difference being that visually, the shaded areas are stacked on top of each other.
-You can create this type of chart in the `DataChart` control by binding your data to a `StackedAreaSeries`, as shown in the example below.
+You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -43,7 +43,7 @@ You can create this type of chart in the `DataChart` control by binding your dat
## {Platform} Stacked 100 Area Chart
Sometimes the series represent part of a whole being changed over time e.g. a country's energy consumption related to the sources from which it is produced. In such cases representing all stacked elements equally may be a better idea.
-You can create this type of chart in the `DataChart` control by binding your data to a `Stacked100AreaSeries`, as shown in the example below.
+You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -59,7 +59,7 @@ A Stacked Bar Chart, or Stacked Bar Graph, is a type of category chart that is u
The Stacked Bar Chart differs from the [Bar Chart](bar-chart.md) in that the data points representing your data are stacked next to each other horizontally to visually group your data. Each stack can contain both positive and negative values. All positive values are grouped on the positive side of the X-Axis, and all negative values are grouped on the negative side of the X-Axis.
-In this example of an Stacked Bar Chart, we have a Numeric X Axis (bottom labels of the chart) and a Category Y Axis (left labels of the chart). You can create this type of chart in the `DataChart` control by binding your data to a `StackedBarSeries`, as shown in the example below.
+In this example of an Stacked Bar Chart, we have a Numeric X Axis (bottom labels of the chart) and a Category Y Axis (left labels of the chart). You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -73,7 +73,7 @@ In this example of an Stacked Bar Chart, we have a Numeric X Axis (bottom labels
The {Platform} Stacked 100% Bar Chart is identical to the {Platform} stacked bar chart in all aspects except in their treatment of the values on X-Axis (bottom labels of the chart). Instead of presenting a direct representation of the data, the stacked 100% bar chart presents the data in terms of percent of the sum of all values in a data point.
-In this example of a Stacked 100% Bar Chart, the Energy Product values are shown as a 100% value of all of the data in the fragments of the horizontal bars. You can create this type of chart in the `DataChart` control by binding your data to a `Stacked100BarSeries`, as shown in the example below.
+In this example of a Stacked 100% Bar Chart, the Energy Product values are shown as a 100% value of all of the data in the fragments of the horizontal bars. You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -87,7 +87,7 @@ In this example of a Stacked 100% Bar Chart, the Energy Product values are shown
The Stacked Column Chart is identical to the [Column Chart](column-chart.md) in all aspects, except the series are represented on top of one another rather than to the side. The Stacked Column Chart is used to show comparing results between series. Each stacked fragment in the collection represents one visual element in each stack. Each stack can contain both positive and negative values. All positive values are grouped on the positive side of the Y-Axis, and all negative values are grouped on the negative side of the Y-Axis. The Stacked Column Chart uses the same concepts of data plotting as the Stacked Bar Chart but data points are stacked along vertical line (Y-Axis) rather than along horizontal line (X-Axis).
-You can create this type of chart in the `DataChart` control by binding your data to a `StackedColumnSeries`, as shown in the example below.
+You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -101,7 +101,7 @@ You can create this type of chart in the `DataChart` control by binding your dat
The Stacked 100% Column Chart is identical to the Stacked Column Chart in all aspects except in their treatment of the values on Y-Axis. Instead of presenting a direct representation of the data, the Stacked 100% Column Chart presents the data in terms of percent of the sum of all values in a data point.
-The example below shows a study made for online shopping traffic by departments via tablet, phone and personal computers. You can create this type of chart in the `DataChart` control by binding your data to a `Stacked100ColumnSeries`, as shown in the example below.
+The example below shows a study made for online shopping traffic by departments via tablet, phone and personal computers. You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -113,7 +113,7 @@ The example below shows a study made for online shopping traffic by departments
## {Platform} Stacked Line Chart
-The Stacked Line Chart is often used to show the change of value over time such as the amount of renewable electricity produced for several years between regions. You can create this type of chart in the `DataChart` control by binding your data to a `StackedLineSeries`, as shown in the example below:
+The Stacked Line Chart is often used to show the change of value over time such as the amount of renewable electricity produced for several years between regions. You can create this type of chart in the control by binding your data to a , as shown in the example below:
@@ -127,7 +127,7 @@ The Stacked Line Chart is often used to show the change of value over time such
The Stacked 100% Line Chart is identical to the Stacked Line Chart in all aspects except in their treatment of the values on y-axis. Instead of presenting a direct representation of the data, the Stacked 100% Line Chart presents the data in terms of percent of the sum of all values in a data point. The example below shows a study made for online shopping traffic by departments via tablet, phone and personal computers.
-You can create this type of chart in the `DataChart` control by binding your data to a `Stacked100LineSeries`, as shown in the example below:
+You can create this type of chart in the control by binding your data to a , as shown in the example below:
@@ -141,7 +141,7 @@ You can create this type of chart in the `DataChart` control by binding your dat
Stacked Spline Area Charts are rendered using a collection of points connected by curved spline segments, with the area below the curved spline fill in and stacked on top of each other. Stacked Spline Area Charts follow all of the same requirements as [Area Chart](area-chart.md), with the only difference being that the visually shaded areas are stacked on top of each other.
-You can create this type of chart in the `DataChart` control by binding your data to a `StackedSplineAreaSeries`, as shown in the example below.
+You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -155,7 +155,7 @@ You can create this type of chart in the `DataChart` control by binding your dat
The Stacked 100% Spline Area Chart is identical to the Stacked Spline Area Chart in all aspects except for the treatment of the values on the y-axis. Instead of presenting a direct representation of the data, the Stacked 100% Spline Area Chart presents the data in terms of a percent of the sum of all values in a particular data point. Sometimes the chart represents part of a whole being changed over time. For example, a country's energy consumption related to the sources from which it is produced. In such cases, representing all stacked elements equally may be a better idea.
-You can create this type of chart in the `DataChart` control by binding your data to a `Stacked100SplineAreaSeries`, as shown in the example below.
+You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -167,7 +167,7 @@ You can create this type of chart in the `DataChart` control by binding your dat
## {Platform} Stacked Spline Chart
-The Stacked Spline Chart is often used to show the change of value over time such as the amount of renewable electricity produced for several years between regions. You can create this type of chart in the `DataChart` control by binding your data to a `StackedSplineSeries`, as shown in the example below.
+The Stacked Spline Chart is often used to show the change of value over time such as the amount of renewable electricity produced for several years between regions. You can create this type of chart in the control by binding your data to a , as shown in the example below.
@@ -181,7 +181,7 @@ The Stacked Spline Chart is often used to show the change of value over time suc
The Stacked 100% Spline Chart is identical to the Stacked Spline Chart in all aspects except in their treatment of the values on y-axis. Instead of presenting a direct representation of the data, the Stacked 100% Spline Chart presents the data in terms of percent of the sum of all values in a data point. The example below shows a study made for online shopping traffic by departments via tablet, phone and personal computers.
-You can create this type of chart in the `DataChart` control by binding your data to a `Stacked100SplineSeries`.
+You can create this type of chart in the control by binding your data to a .
@@ -207,15 +207,15 @@ The following table lists API members mentioned in the above sections:
| Chart Type | Control Name | API Members |
| -------------------------|----------------|-------------------------------- |
-| Stacked Area | `DataChart` | `StackedAreaSeries` |
-| Stacked Bar | `DataChart` | `StackedBarSeries` |
-| Stacked Column | `DataChart` | `StackedColumnSeries` |
-| Stacked Line | `DataChart` | `StackedLineSeries` |
-| Stacked Spline | `DataChart` | `StackedSplineSeries` |
-| Stacked Spline Area | `DataChart` | `StackedSplineAreaSeries` |
-| Stacked 100% Area | `DataChart` | `Stacked100AreaSeries` |
-| Stacked 100% Bar | `DataChart` | `Stacked100BarSeries` |
-| Stacked 100% Column | `DataChart` | `Stacked100ColumnSeries` |
-| Stacked 100% Line | `DataChart` | `Stacked100LineSeries` |
-| Stacked 100% Spline | `DataChart` | `Stacked100SplineSeries` |
-| Stacked 100% Spline Area | `DataChart` | `Stacked100SplineAreaSeries` |
+| Stacked Area | | |
+| Stacked Bar | | |
+| Stacked Column | | |
+| Stacked Line | | |
+| Stacked Spline | | |
+| Stacked Spline Area | | |
+| Stacked 100% Area | | |
+| Stacked 100% Bar | | |
+| Stacked 100% Column | | |
+| Stacked 100% Line | | |
+| Stacked 100% Spline | | |
+| Stacked 100% Spline Area | | |
diff --git a/docs/xplat/src/content/en/components/charts/types/step-chart.mdx b/docs/xplat/src/content/en/components/charts/types/step-chart.mdx
index 88995f328b..47e46e892d 100644
--- a/docs/xplat/src/content/en/components/charts/types/step-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/step-chart.mdx
@@ -15,7 +15,7 @@ The {ProductName} Step Chart belongs to a group of category charts that render a
## {Platform} Step Area Chart
-You can create {Platform} Step Area Chart in the control by setting property to `StepArea` enum, as shown in the example below.
+You can create {Platform} Step Area Chart in the control by setting property to enum, as shown in the example below.
@@ -28,7 +28,7 @@ You can create {Platform} Step Area Chart in the control by binding your data and setting property to `StepLine` value, as shown in the example below.
+You can create Step Line Chart in the control by binding your data and setting property to value, as shown in the example below.
@@ -39,7 +39,7 @@ You can create Step Line Chart in the control as demonstrated below.
+If you need Step Charts with more features such as composite other series, you can configure the , , , lines' , and lines' properties on the control as demonstrated below.
diff --git a/docs/xplat/src/content/en/components/charts/types/stock-chart.mdx b/docs/xplat/src/content/en/components/charts/types/stock-chart.mdx
index 9f3a0d72af..7df47a834e 100644
--- a/docs/xplat/src/content/en/components/charts/types/stock-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/stock-chart.mdx
@@ -15,7 +15,7 @@ The {ProductName} Stock Chart, sometimes referred to as {Platform} Financial Cha
## {Platform} Stock Chart Example
-You can create Stock Chart using the control by binding your data and optionally setting property to `Line` value, as shown in the example below.
+You can create Stock Chart using the control by binding your data and optionally setting property to value, as shown in the example below.
@@ -96,7 +96,7 @@ If you need a Stock Chart with more features such as composite other series, you
## {Platform} Chart Annotations
-The Crosshair Annotation Layer provides crossing lines that meet at the actual value of every targeted series. Crosshair types include: Horizontal, Vertical, and Both. The Crosshairs can also be configured to snap to data points by setting the `CrosshairsSnapToData` property to true, otherwise the crosshairs will be interpolated between data points. Annotations can also be enabled to display the crosshair's value along the axis.
+The Crosshair Annotation Layer provides crossing lines that meet at the actual value of every targeted series. Crosshair types include: Horizontal, Vertical, and Both. The Crosshairs can also be configured to snap to data points by setting the property to true, otherwise the crosshairs will be interpolated between data points. Annotations can also be enabled to display the crosshair's value along the axis.
The Final Value Layer provides a quick view along the axis of the ending value displayed in a series.
@@ -124,20 +124,20 @@ The following panes are available:
Financial Indicators are often used by traders to measure changes and to show trends in stock prices. These indicators are usually displayed below the price pane because they do not share the same Y-Axis scale.
By default the indicator panes are not displayed. The toolbar allows the end user to select which indicator to display at run time.
-In order to display an indicator pane initially, the `IndicatorTypes` property must be set to a least one type of indicator, as demonstrated in the following code:
+In order to display an indicator pane initially, the property must be set to a least one type of indicator, as demonstrated in the following code:
### Volume Pane
The volume pane represents the number of shares traded during a given period. Low volume would indicate little interest, while high volume would indicate high interest with a lot of trades. This can be displayed using column, line or area chart types. The toolbar allows the end user to display the volume pane by selecting a chart type to render the data at runtime. In order the display the pane, a volume type must be set, as demonstrated in the following code:
### Price Pane
-This pane displays stock prices and shows the stock's high, low, open and close prices over time. In addition it can display trend lines and overlays. Your end user can choose different chart types from the toolbar. By default, the chart type is set to `Auto`. You can override the default setting, as demonstrated in the following code:
+This pane displays stock prices and shows the stock's high, low, open and close prices over time. In addition it can display trend lines and overlays. Your end user can choose different chart types from the toolbar. By default, the chart type is set to . You can override the default setting, as demonstrated in the following code:
Note that is recommended to use line chart type if plotting multiple data sources or if plotting data source with a lot of data points.
### Zoom Pane
-This pane controls the zoom of all the displayed panes. This pane is displayed by default. It can be turned off by setting the `ZoomSliderType` to `none` as demonstrated in the following code:
+This pane controls the zoom of all the displayed panes. This pane is displayed by default. It can be turned off by setting the to `none` as demonstrated in the following code:
-Note that you should set the `ZoomSliderType` option to the same value as the `ChartType` option is set to. This way, the zoom slider will show correct preview of the price pane. The following code demonstrates how to do this:
+Note that you should set the option to the same value as the option is set to. This way, the zoom slider will show correct preview of the price pane. The following code demonstrates how to do this:
In this example, the stock chart is plotting revenue for United States.
diff --git a/docs/xplat/src/content/en/components/charts/types/treemap-chart.mdx b/docs/xplat/src/content/en/components/charts/types/treemap-chart.mdx
index 5b9d69103d..8592af2907 100644
--- a/docs/xplat/src/content/en/components/charts/types/treemap-chart.mdx
+++ b/docs/xplat/src/content/en/components/charts/types/treemap-chart.mdx
@@ -57,13 +57,13 @@ There are several common use cases for choosing a Treemap. When you:
- The data source must be an array or a list of data items
- The data source must contain at least one data item otherwise the map will not render any nodes.
-- All data items must contain at least one data column (e.g. string) which should be mapped to the `LabelMemberPath` property.
-- All data items must contain at least one numeric data column which should be mapped using the `ValueMemberPath` property.
-- To categorize data into organized tiles you can optionally use `ParentIdMemberPath` and `IdMemberPath`.
+- All data items must contain at least one data column (e.g. string) which should be mapped to the property.
+- All data items must contain at least one numeric data column which should be mapped using the property.
+- To categorize data into organized tiles you can optionally use and .
## {Platform} Treemap Configuration
-In the following example, the treemap demonstrates the ability of changing it's algorithmic structure by modifying the `LayoutType` and `LayoutOrientation` properties.
+In the following example, the treemap demonstrates the ability of changing it's algorithmic structure by modifying the and properties.
@@ -87,9 +87,9 @@ The Treemap allows you to choose the algorithm that is best for your requirement
### Layout Orientation
-`LayoutOrientation` property enables the user to set the direction in which the nodes of the hierarchy will be expanded.
+ property enables the user to set the direction in which the nodes of the hierarchy will be expanded.
-Note that the `LayoutOrientation` property works with the layout types SliceAndDice and Strip.
+Note that the property works with the layout types SliceAndDice and Strip.
- `Horizontal` – the child nodes are going to be stacked horizontally(SliceAndDice).
- `Vertical` – the child nodes are going to be stacked vertically (SliceAndDice).
@@ -103,17 +103,17 @@ In the following example, the treemap demonstrates the ability of changing the l
### {Platform} Treemap Highlighting
-In the following example, the treemap demonstrates the ability of node highlighting. There are two options for this feature. Each node can individually brighten, by decreasing its opacity, or cause all other nodes to trigger the same effect. To enable this feature, set `HighlightingMode`to Brighten or FadeOthers.
+In the following example, the treemap demonstrates the ability of node highlighting. There are two options for this feature. Each node can individually brighten, by decreasing its opacity, or cause all other nodes to trigger the same effect. To enable this feature, set to Brighten or FadeOthers.
## {Platform} Treemap Percent based highlighting
-- `HighlightedItemsSource`: Specifies the datasource to read highlighted values from. If null, then highlighted values are read from the ItemsSource property.
-- `HighlightedValueMemberPath`: Specifies the name of the property in the datasource where the highlighted values are read.
-- `HighlightedValueOpacity`: Controls the opacity of the normal value behind the highlighted value.
-- `HighlightedValuesDisplayMode`: Enables or disables highlighted values.
+- : Specifies the datasource to read highlighted values from. If null, then highlighted values are read from the ItemsSource property.
+- : Specifies the name of the property in the datasource where the highlighted values are read.
+- : Controls the opacity of the normal value behind the highlighted value.
+- : Enables or disables highlighted values.
- Auto: The treemap decides what mode to use.
- Overlay: The treemap displays highlighted values over top the normal value with a slight opacity applied to the normal value.
- Hidden: The treemap does not show highlighted values.
diff --git a/docs/xplat/src/content/en/components/dashboard-tile.mdx b/docs/xplat/src/content/en/components/dashboard-tile.mdx
index 5acbcc50ba..92577a0297 100644
--- a/docs/xplat/src/content/en/components/dashboard-tile.mdx
+++ b/docs/xplat/src/content/en/components/dashboard-tile.mdx
@@ -16,7 +16,7 @@ import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
# {Platform} Dashboard Tile
-The {Platform} Dashboard Tile is a automatic data visualization component which determines via analysis of a DataSource collection/array or single data point what would be the most appropriate visualization to display. It then also provides a further suite of tools in its embedded that let you alter the visualization that is presented in a variety of ways.
+The {Platform} Dashboard Tile is a automatic data visualization component which determines via analysis of a DataSource collection/array or single data point what would be the most appropriate visualization to display. It then also provides a further suite of tools in its embedded that let you alter the visualization that is presented in a variety of ways.
A wide variety of visualizations may be selected for display depending on the shape of the provided data including, but not limited to: Category Charts, Radial and Polar Charts, Scatter Charts, Geographic Maps, Radial and Linear Gauges, Financial Charts and Stacked Charts.
@@ -155,7 +155,7 @@ You are not locked into a single visualization when you bind the `DataSource`, a
-The visualization or properties of the visualization are also configurable using the at the top of the control. This has the default tools for the current visualization with the addition of four Dashboard Tile specific ones, highlighted below:
+The visualization or properties of the visualization are also configurable using the at the top of the control. This has the default tools for the current visualization with the addition of four Dashboard Tile specific ones, highlighted below:
@@ -164,7 +164,7 @@ From left to right:
- The first tool will show a data grid with the `DataSource` provided to the control. This is a toggle tool, so if you click it again after showing the grid, it will revert to the visualization.
- The second tool allows you to configure the settings of the current data visualization.
- The third tool allows you to change the current visualization, allowing you to plot a different series type or show a different type of visualization altogether. This can be set on the control by setting the `VisualizationType` property, mentioned above.
-- The last tool allows you to configure which properties on your underlying data item are included for the control. You can configure this by setting the `IncludedProperties` or `ExcludedProperties` collection on the control.
+- The last tool allows you to configure which properties on your underlying data item are included for the control. You can configure this by setting the or collection on the control.
This demo demonstrates dashboard tile integration with the {Platform} Pie Chart. The toolbar options at the top right provides access to styling and changing the data visualization.
@@ -180,7 +180,7 @@ This demo demonstrates dashboard tile integration with the {Platform} Geographic
-
+
diff --git a/docs/xplat/src/content/en/components/excel-library-using-cells.mdx b/docs/xplat/src/content/en/components/excel-library-using-cells.mdx
index 0073f5c484..3374709ce9 100644
--- a/docs/xplat/src/content/en/components/excel-library-using-cells.mdx
+++ b/docs/xplat/src/content/en/components/excel-library-using-cells.mdx
@@ -46,7 +46,7 @@ import { FormattedString } from "{PackageExcel}";
## Referencing Cells and Regions
-You can access a object or a object by calling the object’s `GetCell` or `GetRegion` methods, respectively. Both methods accept a string parameter that references a cell. Getting a reference to a cell is useful when applying formats or working with formulas and cell contents.
+You can access a object or a object by calling the object’s or methods, respectively. Both methods accept a string parameter that references a cell. Getting a reference to a cell is useful when applying formats or working with formulas and cell contents.
The following example code demonstrates how to reference cells and regions:
@@ -78,7 +78,7 @@ var region = worksheet.GetRegion("G1:G10");
In Microsoft Excel, individual cells, as well as cell regions can have names assigned to them. The name of a cell or region can be used to reference that cell or region instead of their address.
-The Infragistics {Platform} Excel Library supports the referencing of cells and regions by name through the `GetCell` and `GetRegion` methods of the object. You refer to the cell or region using the `NamedReference` instance that refers to that cell or region.
+The Infragistics {Platform} Excel Library supports the referencing of cells and regions by name through the and methods of the object. You refer to the cell or region using the instance that refers to that cell or region.
You can use the following code snippet as an example for naming a cell or region:
@@ -152,7 +152,7 @@ worksheet.Rows[0].Cells[0].Comment = cellComment;
## Adding a Formula to a Cell
-The Infragistics {Platform} Excel Library allows you to add Microsoft Excel formulas to a cell or group of cells in a worksheet. You can do this using the object’s `ApplyFormula` method or by instantiating a object and applying it to a cell. Regardless of the manner in which you apply a formula to a cell, you can access the object using the object’s property. If you need the value, use the cell’s `Value` property.
+The Infragistics {Platform} Excel Library allows you to add Microsoft Excel formulas to a cell or group of cells in a worksheet. You can do this using the object’s method or by instantiating a object and applying it to a cell. Regardless of the manner in which you apply a formula to a cell, you can access the object using the object’s property. If you need the value, use the cell’s property.
The following code shows you how to add a formula to a cell.
@@ -181,7 +181,7 @@ sumFormula.ApplyTo(worksheet.Rows[5].Cells[0]);
## Copying a Cell’s Format
-Cells can have different formatting, including background color, format string, and font style. If you need a cell to have the same format as a previously formatted cell, instead of individually setting each option exposed by the object’s property, you can call the object’s `SetFormatting` method and pass it a object to copy. This will copy every format setting from the first cell to the second cell. You can also do this for a row, merged cell region, or column.
+Cells can have different formatting, including background color, format string, and font style. If you need a cell to have the same format as a previously formatted cell, instead of individually setting each option exposed by the object’s property, you can call the object’s method and pass it a object to copy. This will copy every format setting from the first cell to the second cell. You can also do this for a row, merged cell region, or column.
The following code shows you how to copy the format of the 2nd column to the 4th column:
@@ -215,7 +215,7 @@ worksheet.Columns[3].CellFormat.SetFormatting(worksheet.Columns[1].CellFormat);
## Formatting a Cell
-The Infragistics {Platform} Excel Library allows you to customize the look and behavior of a cell. You can customize a cell by setting properties exposed by the property of the , , , or `WorksheetMergedCellsRegion` objects.
+The Infragistics {Platform} Excel Library allows you to customize the look and behavior of a cell. You can customize a cell by setting properties exposed by the property of the , , , or objects.
You can customize every aspect of a cell’s appearance. You can set a cell’s font, background, and borders, as well as text alignment and rotation. You can even apply a different format on a character-by-character basis for a cell’s text.
@@ -249,9 +249,9 @@ You can create all possible fill types using static properties and methods on th
- `NoColor` - A property that represents a fill with no color, which allows a background image of the worksheet, if any, to show through.
-- `CreateSolidFill` - Returns a instance which has a pattern style of `Solid` and a background color set to the `Color` or specified in the method.
+- `CreateSolidFill` - Returns a instance which has a pattern style of `Solid` and a background color set to the or specified in the method.
-- `CreatePatternFill` - Returns a instance which has the specified pattern style and the `Color` or values, specified for the background and pattern colors.
+- `CreatePatternFill` - Returns a instance which has the specified pattern style and the or values, specified for the background and pattern colors.
- `CreateLinearGradientFill` - Returns a instance with the specified angle and gradient stops.
@@ -329,7 +329,7 @@ Each workbook has 12 associated theme colors. They are the following:
Colors are defined by the class, which is a sealed immutable class. The class has a static `Automatic` property, which returns the automatic color, and there are various constructors which allow you to create a instance with a color or a theme value and an optional tint.
-The `GetResolvedColor` method on allows you to determine what color will actually be seen by the user when they open the file in Excel.
+The method on allows you to determine what color will actually be seen by the user when they open the file in Excel.
If the represents a theme color, you must pass in a Workbook instance to the method so it can get the theme color’s RGB value from the workbook.
@@ -341,35 +341,35 @@ When the older formats are opened in Microsoft Excel 2003 and earlier versions,
You can set a host of different formats on a by using the object returned by the property of that cell. This object enables you to style many different aspects of the cell such as borders, font, fill, alignments, and whether or not the cell should shrink to fit or be locked.
-You can also access the built-in styles to Microsoft Excel 2007 using the `Styles` collection of the object. The full list of styles in Excel can be found in the Cell Styles gallery of the Home tab of Microsoft Excel 2007.
+You can also access the built-in styles to Microsoft Excel 2007 using the collection of the object. The full list of styles in Excel can be found in the Cell Styles gallery of the Home tab of Microsoft Excel 2007.
-There is a special type of style on the workbook’s `Styles` collection known as the "normal" style, which can be accessed using that collection’s `NormalStyle` property, or by indexing into the collection with the name "Normal".
+There is a special type of style on the workbook’s collection known as the "normal" style, which can be accessed using that collection’s property, or by indexing into the collection with the name "Normal".
-The `NormalStyle` contains the default properties for all cells in the workbook, unless otherwise specified on a row, column, or cell. Changing the properties on the `NormalStyle` will change all of the default cell format properties on the workbook. This is useful, for example, if you want to change the default font for your workbook.
+The contains the default properties for all cells in the workbook, unless otherwise specified on a row, column, or cell. Changing the properties on the will change all of the default cell format properties on the workbook. This is useful, for example, if you want to change the default font for your workbook.
-You can clear the `Styles` collection or reset it to its predefined state by using the `Clear` and `Reset` methods, respectively. Both of these will remove all user-defined styles, but `Clear` will clear the `Styles` collection entirely.
+You can clear the collection or reset it to its predefined state by using the and methods, respectively. Both of these will remove all user-defined styles, but will clear the collection entirely.
-With this feature, a `Style` property has been added to the object. This is a reference to a instance, representing the parent style of the format. For formats of a style, this property will always be null, because styles cannot have a parent style. For row, column, and cell formats, the `Style` property always returns the `NormalStyle` by default.
+With this feature, a property has been added to the object. This is a reference to a instance, representing the parent style of the format. For formats of a style, this property will always be null, because styles cannot have a parent style. For row, column, and cell formats, the property always returns the by default.
-If the `Style` property is set to null, it will revert back to the `NormalStyle`. If it is set to another style in the styles collection, that style will now hold the defaults for all unset properties on the cell format.
+If the property is set to null, it will revert back to the . If it is set to another style in the styles collection, that style will now hold the defaults for all unset properties on the cell format.
-When the `Style` property is set on a cell format, the format options included on the `Style` are removed from the cell format. All other properties are left intact. For example, if a cell style including border formatting was created and that style was set as the cell’s `Style`, the border format option on the cell format would be removed and the cell format only includes fill formatting.
+When the property is set on a cell format, the format options included on the are removed from the cell format. All other properties are left intact. For example, if a cell style including border formatting was created and that style was set as the cell’s , the border format option on the cell format would be removed and the cell format only includes fill formatting.
When a format option flag is removed from a format, all associated properties are reset to their unset values, so the cell format’s border properties are implicitly reset to default/unset values.
-You can determine what would really be seen in cells by using the `GetResolvedCellFormat` method on classes which represent a row, column, cell, and merged cell.
+You can determine what would really be seen in cells by using the method on classes which represent a row, column, cell, and merged cell.
-This method returns a instance which refers back to the associated on which it is based. So subsequent changes to the property will be reflected in the instance returned from a `GetResolvedCellFormat` call.
+This method returns a instance which refers back to the associated on which it is based. So subsequent changes to the property will be reflected in the instance returned from a call.
## Merging Cells
Aside from setting the value or format of cells, you can also merge cells to make two or more cells appear as one. If you merge cells, they must be in a rectangular region.
-When you merge cells, each cell in the region will have the same value and cell format. The merged cells will also be associated with the same `WorksheetMergedCellsRegion` object, accessible from their `AssociatedMergedCellsRegion` property. The resultant `WorksheetMergedCellsRegion` object will also have the same value and cell format as the cells.
+When you merge cells, each cell in the region will have the same value and cell format. The merged cells will also be associated with the same object, accessible from their property. The resultant object will also have the same value and cell format as the cells.
Setting the value (or cell format) of the region or any cell in the region will change the value of all cells and the region. If you un-merge cells, all of the previously merged cells will retain the shared cell format they had before they were unmerged. However, only the top-left cell of the region will retain the shared value.
-In order to create a merged cell region, you must add a range of cells to the object’s `MergedCellsRegions` collection. This collection exposes an `Add` method that takes four integer parameters. The four parameters determine the index of the starting row and column (top-left most cell) and the index of the ending row and column (bottom-right most cell).
+In order to create a merged cell region, you must add a range of cells to the object’s collection. This collection exposes an `Add` method that takes four integer parameters. The four parameters determine the index of the starting row and column (top-left most cell) and the index of the ending row and column (bottom-right most cell).
```ts
var workbook = new Workbook();
@@ -455,11 +455,11 @@ If a text is used in the cell, the cell displayed text will always be full value
The only time when this is not the case is when padding characters are used in format string. Then the value will be displayed as all hash marks when there is not enough room for the text.
-You can set the worksheet's `DisplayOptions`' `ShowFormulasInCells` property to have formulas be displayed in cells instead of their results, and format strings and cell widths are ignored. Text values display as if their format string were @ , non-integral numeric values display as if their format string were 0.0 and integral numeric values display as if their format string were 0 .
+You can set the worksheet's ' property to have formulas be displayed in cells instead of their results, and format strings and cell widths are ignored. Text values display as if their format string were @ , non-integral numeric values display as if their format string were 0.0 and integral numeric values display as if their format string were 0 .
Additionally, if the value cannot fit, it will not display as all hashes. Display text will still return its full text as the cell text, even though it may not be fully seen.
-The following code snippet demonstrates the usage of the `GetText` method to get the text as it would be displayed in Excel:
+The following code snippet demonstrates the usage of the method to get the text as it would be displayed in Excel:
```ts
var workbook = new Workbook();
diff --git a/docs/xplat/src/content/en/components/excel-library-using-tables.mdx b/docs/xplat/src/content/en/components/excel-library-using-tables.mdx
index 07da899b24..9b43a189af 100644
--- a/docs/xplat/src/content/en/components/excel-library-using-tables.mdx
+++ b/docs/xplat/src/content/en/components/excel-library-using-tables.mdx
@@ -25,7 +25,7 @@ The Infragistics {Platform} Excel Engine's
## Adding a Table to a Worksheet
-Worksheet tables in the Infragistics {Platform} Excel Engine are represented by the object and are added in the worksheet's `Tables` collection. In order to add a table, you need to invoke the `Add` method on this collection. In this method, you can specify the region in which you would like to add a table, whether or not the table should contain headers, and optionally, specify the table's style as a `WorksheetTableStyle` object.
+Worksheet tables in the Infragistics {Platform} Excel Engine are represented by the object and are added in the worksheet's collection. In order to add a table, you need to invoke the `Add` method on this collection. In this method, you can specify the region in which you would like to add a table, whether or not the table should contain headers, and optionally, specify the table's style as a object.
The following code demonstrates how you can add a table with headers to a spanning a region of A1 to G10, where A1 to G1 will be the column headers:
@@ -47,7 +47,7 @@ worksheet.Tables.Add("A1:G10", true);
-Once you have added a table, you can modify it by adding or deleting rows and columns by calling the `InsertColumns`, `InsertDataRows`, `DeleteColumns`, or `DeleteDataRows` methods on the . You can also set a new table range by using the `Resize` method of the table.
+Once you have added a table, you can modify it by adding or deleting rows and columns by calling the , , , or methods on the . You can also set a new table range by using the method of the table.
The following code snippet shows the usage of these methods:
@@ -100,19 +100,19 @@ table.Resize("A1:G15");
## Filtering Tables
Filtering is done by applying a filter on a column in the . When the filter is applied on a column, all filters in the table will be reevaluated to determine which rows meet the criteria of all filters applied.
-If the data in the table is subsequently changed or you change the `Hidden` property of the rows, the filter conditions will not automatically reevaluate. The filter conditions in a table are only reapplied when table column filters are added, removed, modified, or when the `ReapplyFilters` method is called on the table.
+If the data in the table is subsequently changed or you change the `Hidden` property of the rows, the filter conditions will not automatically reevaluate. The filter conditions in a table are only reapplied when table column filters are added, removed, modified, or when the method is called on the table.
The following are the filter types available to the columns of your :
-- `AverageFilter` - Cells can be filtered based on whether they are above or below the average value of all cells in the column.
-- `CustomFilter` - Cells can be filtered based on one or more custom conditions.
-- `DatePeriodFilter` - Only cells with dates in a specific month or quarter of any year will be displayed.
-- `FillFilter` - Only cells with a specific fill will be displayed.
-- `FixedValuesFilter` - Cells which only match specific display values or which fall within a specific group of dates/times will be displayed.
-- `FontColorFilter` - Only cells with a specific font color will be displayed.
-- `RelativeDateRangeFilter` - Cells with date values can be filtered based on whether they occur within a relative time range of the date when the filter was applied, such as the next day or previous quarter.
-- `TopOrBottomFilter` - This filter allows for filtering the top or bottom N values. It also allows filtering the top or bottom N% values.
-- `YearToDateFilter` - Cells with date values can be filtered if they occur between the start of the year and the date on which the filter was applied.
+- - Cells can be filtered based on whether they are above or below the average value of all cells in the column.
+- - Cells can be filtered based on one or more custom conditions.
+- - Only cells with dates in a specific month or quarter of any year will be displayed.
+- - Only cells with a specific fill will be displayed.
+- - Cells which only match specific display values or which fall within a specific group of dates/times will be displayed.
+- - Only cells with a specific font color will be displayed.
+- - Cells with date values can be filtered based on whether they occur within a relative time range of the date when the filter was applied, such as the next day or previous quarter.
+- - This filter allows for filtering the top or bottom N values. It also allows filtering the top or bottom N% values.
+- - Cells with date values can be filtered if they occur between the start of the year and the date on which the filter was applied.
The following code snippet demonstrates how to apply an "above average" filter to a 's first column:
@@ -139,20 +139,20 @@ table.Columns[0].ApplyAverageFilter(Documents.Excel.Filtering.AverageFilterType.
## Sorting Tables
Sorting is done by setting a sorting condition on a table column. When a sorting condition is set on a column, all sorting conditions in the table will be reevaluated to determine the order of the cells in the table. When cells need to be moved to meet their sort criteria, the entire row of cells in the table is moved as a unit.
-If the data in the table is subsequently changed, the sort conditions do not automatically reevaluate. The sort conditions in a table are only reapplied when sort conditions are added, removed, modified, or when the `ReapplySortConditions` method is called on the table. When sorting conditions are reevaluated, only the visible cells are sorted. All cells in hidden rows are kept in place.
+If the data in the table is subsequently changed, the sort conditions do not automatically reevaluate. The sort conditions in a table are only reapplied when sort conditions are added, removed, modified, or when the method is called on the table. When sorting conditions are reevaluated, only the visible cells are sorted. All cells in hidden rows are kept in place.
-In addition to accessing sort conditions from the table columns, they are also exposed off the 's SortSettings property's `SortConditions` collection. This is an ordered collection of columns/sort condition pairs. The order of this collection is the precedence of the sorting.
+In addition to accessing sort conditions from the table columns, they are also exposed off the 's SortSettings property's collection. This is an ordered collection of columns/sort condition pairs. The order of this collection is the precedence of the sorting.
The following sort condition types are available to set on columns:
-- `OrderedSortCondition` - Sort cells in an ascending or descending order based on their value.
-- `CustomListSortCondition` - Sort cells in a defined order based on their text or display value. For example, this might be useful for sorting days as they appear on a calendar, rather than alphabetically.
-- `FillSortCondition` - Sort cells based on whether their fill is a specific pattern or gradient.
-- `FontColorSortCondition` - Sort cells based on whether their font is a specific color.
+- - Sort cells in an ascending or descending order based on their value.
+- - Sort cells in a defined order based on their text or display value. For example, this might be useful for sorting days as they appear on a calendar, rather than alphabetically.
+- - Sort cells based on whether their fill is a specific pattern or gradient.
+- - Sort cells based on whether their font is a specific color.
-There is also a `CaseSensitive` property on the SortSettings of the to determine whether strings should be sorted case sensitively or not.
+There is also a property on the SortSettings of the to determine whether strings should be sorted case sensitively or not.
-The following code snippet demonstrates how to apply an `OrderedSortCondition` to a :
+The following code snippet demonstrates how to apply an to a :
```ts
var workbook = new Workbook(WorkbookFormat.Excel2007);
diff --git a/docs/xplat/src/content/en/components/excel-library-using-workbooks.mdx b/docs/xplat/src/content/en/components/excel-library-using-workbooks.mdx
index 2f979a8fce..a0556e8338 100644
--- a/docs/xplat/src/content/en/components/excel-library-using-workbooks.mdx
+++ b/docs/xplat/src/content/en/components/excel-library-using-workbooks.mdx
@@ -25,7 +25,7 @@ The Infragistics {Platform} Excel Engine enables you to save data to and load da
## Change Default Font
-First create a new instance of . Next, add the new font to the `Styles` collection of the . This style contains the default properties for all cells in the workbook, unless otherwise specified on a row, column, or cell. Changing properties of the style will change the default cell format properties in the workbook.
+First create a new instance of . Next, add the new font to the collection of the . This style contains the default properties for all cells in the workbook, unless otherwise specified on a row, column, or cell. Changing properties of the style will change the default cell format properties in the workbook.
```ts
var workbook = new Workbook();
@@ -50,23 +50,23 @@ font.Height = 16 * 20;
Microsoft Excel® document properties provide information to help organize and keep track of your documents. You can use the Infragistics {Platform} Excel Library to set these properties using the object’s property. The available properties are:
-- `Author`
+-
-- `Title`
+-
-- `Subject`
+-
-- `Keywords`
+-
-- `Category`
+-
-- `Status`
+-
-- `Comments`
+-
-- `Company`
+-
-- `Manager`
+-
The following code demonstrates how to create a workbook and set its `title` and `status` document properties.
diff --git a/docs/xplat/src/content/en/components/excel-library-using-worksheets.mdx b/docs/xplat/src/content/en/components/excel-library-using-worksheets.mdx
index 45f8720f1d..2b85651069 100644
--- a/docs/xplat/src/content/en/components/excel-library-using-worksheets.mdx
+++ b/docs/xplat/src/content/en/components/excel-library-using-worksheets.mdx
@@ -115,7 +115,7 @@ worksheet.DisplayOptions.ShowRowAndColumnHeaders = false;
## Configuring Editing of the Worksheet
-By default, the objects that you save will be editable. You can disable editing of a worksheet by protecting it using the object's `Protect` method. This method has a lot of nullable `bool` arguments that determine which pieces are protected, and one of these options is to allow editing of objects, which if set to **false** will prevent editing of the worksheet.
+By default, the objects that you save will be editable. You can disable editing of a worksheet by protecting it using the object's method. This method has a lot of nullable `bool` arguments that determine which pieces are protected, and one of these options is to allow editing of objects, which if set to **false** will prevent editing of the worksheet.
The following code demonstrates how to disable editing in your worksheet:
@@ -137,9 +137,9 @@ worksheet.Protect();
-You can also use the object's `Protect` method to protect a worksheet against structural changes.
+You can also use the object's method to protect a worksheet against structural changes.
-When protection is set, you can set the object's `Locked` property on individual cells, rows, merged cell regions, or columns to override the worksheet object's protection on those objects. For example, if you need all cells of a worksheet to be read-only except for the cells of one column, you can protect the worksheet and then set the object's `Locked` property to **false** on a specific object. This will allow your users to edit cells within the column while disabling editing of the other cells in the worksheet.
+When protection is set, you can set the object's property on individual cells, rows, merged cell regions, or columns to override the worksheet object's protection on those objects. For example, if you need all cells of a worksheet to be read-only except for the cells of one column, you can protect the worksheet and then set the object's property to **false** on a specific object. This will allow your users to edit cells within the column while disabling editing of the other cells in the worksheet.
The following code demonstrates how you can do this:
@@ -164,24 +164,24 @@ worksheet.Columns[0].CellFormat.Locked = ExcelDefaultableBoolean.False;
## Filtering Worksheet Regions
-Filtering is done by setting a filter condition on a worksheet's which can be retrieved from the object's property. Filter conditions are only reapplied when they're added, removed, modified, or when the `ReapplyFilters` method is called on the worksheet. They are not constantly evaluated as data within the region changes.
+Filtering is done by setting a filter condition on a worksheet's which can be retrieved from the object's property. Filter conditions are only reapplied when they're added, removed, modified, or when the method is called on the worksheet. They are not constantly evaluated as data within the region changes.
-You can specify the region to apply the filter by using the `SetRegion` method on the object.
+You can specify the region to apply the filter by using the method on the object.
Below is a list of methods and their descriptions that you can use to add a filter to a worksheet:
| Method | Description |
| --------------|-------------|
-|`ApplyAverageFilter`|Represents a filter which can filter data based on whether the data is below or above the average of the entire data range.|
-|`ApplyDatePeriodFilter`|Represents a filter which can filter dates in a Month, or quarter of any year.|
-|`ApplyFillFilter`|Represents a filter which will filter cells based on their background fills. This filter specifies a single CellFill. Cells of with this fill will be visible in the data range. All other cells will be hidden.|
+||Represents a filter which can filter data based on whether the data is below or above the average of the entire data range.|
+||Represents a filter which can filter dates in a Month, or quarter of any year.|
+||Represents a filter which will filter cells based on their background fills. This filter specifies a single CellFill. Cells of with this fill will be visible in the data range. All other cells will be hidden.|
|`ApplyFixedValuesFilter`|Represents a filter which can filter cells based on specific, fixed values, which are allowed to display.|
-|`ApplyFontColorFilter`|Represents a filter which will filter cells based on their font colors. This filter specifies a single color. Cells with this color font will be visible in the data range. All other cells will be hidden.|
-|`ApplyIconFilter`|Represents a filter which can filter cells based on their conditional formatting icon.|
-|`ApplyRelativeDateRangeFilter`|Represents a filter which can filter date cells based on dates relative to the when the filter was applied.|
-|`ApplyTopOrBottomFilter`|Represents a filter which can filter in cells in the upper or lower portion of the sorted values.|
-|`ApplyYearToDateFilter`|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.|
-|`ApplyCustomFilter`|Represents a filter which can filter data based on one or two custom conditions. These two filter conditions can be combined with a logical "and" or a logical "or" operation.|
+||Represents a filter which will filter cells based on their font colors. This filter specifies a single color. Cells with this color font will be visible in the data range. All other cells will be hidden.|
+||Represents a filter which can filter cells based on their conditional formatting icon.|
+||Represents a filter which can filter date cells based on dates relative to the when the filter was applied.|
+||Represents a filter which can filter in cells in the upper or lower portion of the sorted values.|
+||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.|
+||Represents a filter which can filter data based on one or two custom conditions. These two filter conditions can be combined with a logical "and" or a logical "or" operation.|
You can use the following code snippet as an example to add a filter to a worksheet region:
@@ -208,7 +208,7 @@ worksheet.FilterSettings.ApplyAverageFilter(0, Documents.Excel.Filtering.Average
## Freezing and Splitting Panes
You can freeze rows at the top of your worksheet or columns at the left using the freezing panes features. Frozen rows and columns remain visible at all times while the user is scrolling. The frozen rows and columns are separated from the rest of the worksheet by a single, solid line, which cannot be removed.
-In order to enable pane freezing, you need to set the property of the object's to **true**. You can then specify the rows or columns to freeze by using the `FrozenRows` and `FrozenColumns` properties of the display options `FrozenPaneSettings`, respectively.
+In order to enable pane freezing, you need to set the property of the object's to **true**. You can then specify the rows or columns to freeze by using the `FrozenRows` and `FrozenColumns` properties of the display options , respectively.
You can also specify the first row in the bottom pane or first column in the right pane using the `FirstRowInBottomPane` and `FirstColumnInRightPane` properties, respectively.
@@ -273,7 +273,7 @@ Sorting is done by setting a sorting condition on a worksheet level object on ei
This is done by specifying a region and sort type to the object's that can be retrieved using the property of the sheet.
-The sort conditions in a sheet are only reapplied when sort conditions are added, removed, modified, or when the `ReapplySortConditions` method is called on the worksheet. Columns or rows will be sorted within the region. "Rows" is the default sort type.
+The sort conditions in a sheet are only reapplied when sort conditions are added, removed, modified, or when the method is called on the worksheet. Columns or rows will be sorted within the region. "Rows" is the default sort type.
The following code snippet demonstrates how to apply a sort to a region of cells in a worksheet:
@@ -296,7 +296,7 @@ worksheet.SortSettings.SortConditions.Add(new RelativeIndex(0), new Infragistics
## Worksheet Protection
-You can protect a worksheet by calling the `Protect` method on the object. This method exposes many nullable `bool` parameters that allow you to restrict or allow the following user operations:
+You can protect a worksheet by calling the method on the object. This method exposes many nullable `bool` parameters that allow you to restrict or allow the following user operations:
- Editing of cells.
- Editing of objects such as shapes, comments, charts, or other controls.
@@ -309,7 +309,7 @@ You can protect a worksheet by calling the `Protect` method on the object.
+You can remove worksheet protection by calling the method on the object.
The following code snippet shows how to enable protection of all of the above-listed user operations:
@@ -333,11 +333,11 @@ worksheet.Protect();
## Worksheet Conditional Formatting
-You can configure the conditional formatting of a object by using the many "Add" methods exposed on the `ConditionalFormats` collection of that worksheet. The first parameter of these "Add" methods is the `string` region of the worksheet that you would like to apply the conditional format to.
+You can configure the conditional formatting of a object by using the many "Add" methods exposed on the collection of that worksheet. The first parameter of these "Add" methods is the `string` region of the worksheet that you would like to apply the conditional format to.
-Many of the conditional formats that you can add to your worksheet have a property that determines the way that the elements should look when the condition in that conditional format holds true. For example, you can use the properties attached to this property such as `Fill` and `Font` to determine the background and font settings of your cells under a particular conditional format, respectively.
+Many of the conditional formats that you can add to your worksheet have a property that determines the way that the elements should look when the condition in that conditional format holds true. For example, you can use the properties attached to this property such as and to determine the background and font settings of your cells under a particular conditional format, respectively.
-There are a few conditional formats that do not have a property, as their visualization on the worksheet cell behaves differently. These conditional formats are the , , and `IconSetConditionalFormat`.
+There are a few conditional formats that do not have a property, as their visualization on the worksheet cell behaves differently. These conditional formats are the , , and .
When loading a pre-existing from Excel, the formats will be preserved when that is loaded. The same is true for when you save the out to an Excel file.
diff --git a/docs/xplat/src/content/en/components/general-changelog-dv-blazor.mdx b/docs/xplat/src/content/en/components/general-changelog-dv-blazor.mdx
index e01fdbde14..2a19874d75 100644
--- a/docs/xplat/src/content/en/components/general-changelog-dv-blazor.mdx
+++ b/docs/xplat/src/content/en/components/general-changelog-dv-blazor.mdx
@@ -17,6 +17,8 @@ import chartdefaults3 from '@xplat-images/chartDefaults3.png';
import chartdefaults4 from '@xplat-images/chartDefaults4.png';
import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# {ProductName} Changelog
@@ -162,9 +164,9 @@ As of the 2025.2 release, we no longer support .NET 6. This corresponds with the
#### User Annotations
-In {ProductName}, you can now annotate the `DataChart` with slice, strip, and point annotations at runtime using the new user annotations feature. This allows the end user to add more details to the plot such as calling out single important events such as company quarter reports by using the slice annotation or events that have a duration by using the strip annotation. You can also call out individual points on the plotted series by using the point annotation or any combination of these three.
+In {ProductName}, you can now annotate the with slice, strip, and point annotations at runtime using the new user annotations feature. This allows the end user to add more details to the plot such as calling out single important events such as company quarter reports by using the slice annotation or events that have a duration by using the strip annotation. You can also call out individual points on the plotted series by using the point annotation or any combination of these three.
-This is directly integrated with the available tools of the `Toolbar`.
+This is directly integrated with the available tools of the .
@@ -172,8 +174,8 @@ This is directly integrated with the available tools of the `Toolbar`.
Ability for axis annotations to automatically detect collisions and truncate to fit better. To enable this feature you must set the following properties:
-- `ShouldAvoidAnnotationCollisions`
-- `ShouldAutoTruncateAnnotations`
+-
+-
### {PackageMaps} (Geographic Map)
@@ -197,7 +199,7 @@ Ability for axis annotations to automatically detect collisions and truncate to
- The merging can be configured on the grid level to apply either:
- `OnSort` - only when the column is sorted.
- `Always` - always, regardless of data operations.
- The default `CellMergeMode` is `OnSort`.
+ The default is `OnSort`.
```razor
@@ -208,7 +210,7 @@ Ability for axis annotations to automatically detect collisions and truncate to
- **Column Pinning**
- - Added ability to pin individual columns to a specific side (start or end of the grid), so that you can now have pinning from both sides. This can be done either declaratively by setting the `PinningPosition` property on the column:
+ - Added ability to pin individual columns to a specific side (start or end of the grid), so that you can now have pinning from both sides. This can be done either declaratively by setting the property on the column:
```razor
@@ -229,7 +231,7 @@ col.Pinned = true;
```
- - If property `PinningPosition` is not set on a column, the column will default to the position specified on the grid's pinning options for columns.
+ - If property is not set on a column, the column will default to the position specified on the grid's pinning options for columns.
- **Sorting and Grouping Improvements**
- Improved sorting algorithm efficiency using Schwartzian transformation. This is a technique, also known as decorate-sort-undecorate, which avoids recomputing the sort keys by temporarily associating them with the original data records.
@@ -238,23 +240,23 @@ col.Pinned = true;
- Optimized grouping operations.
- **Other Improvements**
- - A column's `MinWidth` and `MaxWidth` constrain the user-specified width so that it cannot go outside their bounds.
- - The `PagingMode` property can now be set as simple strings "local" and "remote" and does not require importing the `GridPagingMode` enum.
+ - A column's and constrain the user-specified width so that it cannot go outside their bounds.
+ - The property can now be set as simple strings "local" and "remote" and does not require importing the `GridPagingMode` enum.
### General
#### Added
-- `DateRangePicker`
+-
#### Changed
- Updated the readonly styles of most form associated components across all themes to better signify when a component is in a readonly state.
-- `Tooltip`
- - Behavioral change: `Tooltip` default placement is "bottom" now.
- - Behavioral change: `Tooltip` will not render an arrow indicator by default unless with-arrow is set.
- - Breaking change: `Tooltip` events will no longer return its anchor target in its detail property. You can still access it at event.target.anchor.
+-
+ - Behavioral change: default placement is "bottom" now.
+ - Behavioral change: will not render an arrow indicator by default unless with-arrow is set.
+ - Breaking change: events will no longer return its anchor target in its detail property. You can still access it at event.target.anchor.
#### Deprecated
-- `Tooltip` - `DisableArrow` is deprecated. Use `WithArrow` to render an arrow indicator.
+- - is deprecated. Use to render an arrow indicator.
### Bug Fixes
@@ -270,21 +272,21 @@ col.Pinned = true;
**Breaking Changes**
-- `AzureMapsMapImagery` was renamed to `AzureMapsImagery`
+- `AzureMapsMapImagery` was renamed to
- `AzureMapsImageryStyle.Imagery` was renamed to `AzureMapsImageryStyle.Satellite`
-- The following `AzureMapsImageryStyle` enum values were renamed to include the Overlay suffix:
- - `TerraOverlay`,
- - `LabelsRoadOverlay`
- - `LabelsDarkGreyOverlay`
- - `HybridRoadOverlay`
- - `HybridDarkGreyOverlay`
- - `WeatherRadarOverlay`
- - `WeatherInfraredOverlay`
- - `TrafficAbsoluteOverlay`
- - `TrafficRelativeOverlay`
- - `TrafficRelativeDarkOverlay`
- - `TrafficDelayOverlay`
- - `TrafficReducedOverlay`
+- The following enum values were renamed to include the Overlay suffix:
+ - ,
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
### {PackageCharts} (Charts)
@@ -301,34 +303,34 @@ The following events have been added to the `IgbDataChart` to allow you to detec
#### Companion Axis
-Added `CompanionAxis` properties to the X and Y axis that allow you to quickly create a clone of an existing axis. When enabled using the `CompanionAxisEnabled` property, this will default the cloned axis to the opposite position of the chart and you can then configure that axes' properties.
+Added `CompanionAxis` properties to the X and Y axis that allow you to quickly create a clone of an existing axis. When enabled using the property, this will default the cloned axis to the opposite position of the chart and you can then configure that axes' properties.
#### RadialPieSeries Inset Outlines
-There is a new property called `UseInsetOutlines` to control how outlines on the `RadialPieSeries` are rendered. Setting this value to **true** will inset the outlines within the slice shape, whereas a **false** (default) value will place the outlines half-in half-out along the edge of the slice shape.
+There is a new property called to control how outlines on the are rendered. Setting this value to **true** will inset the outlines within the slice shape, whereas a **false** (default) value will place the outlines half-in half-out along the edge of the slice shape.
**Breaking Changes**
-- A fix was made due to an issue where the `PlotAreaPosition` and `ChartPosition` properties on `ChartMouseEventArgs` class were reversed. This will change the values that `PlotAreaPosition` and `ChartPosition` return.
+- A fix was made due to an issue where the and properties on class were reversed. This will change the values that and return.
### {PackageGrids} (Grids)
#### Cell Suffix Content
-Added support for suffix content within the cells that allows you to add additional text or icons to the end of the cell value and style it. The full list of added properties for the cell suffix content is listed below and is available on the `DataGridColumn` and `CellInfo` class:
+Added support for suffix content within the cells that allows you to add additional text or icons to the end of the cell value and style it. The full list of added properties for the cell suffix content is listed below and is available on the and class:
-- `SuffixText`
-- `SuffixTextColor`
+-
+-
- `SuffixTextFont`
-- `SuffixIconName`
-- `SuffixIconCollectionName`
-- `SuffixIconStroke`
-- `SuffixIconFill`
-- `SuffixIconViewBoxLeft`
-- `SuffixIconViewBoxTop`
-- `SuffixIconViewBoxWidth`
-- `SuffixIconViewBoxHeight`
-- `TextDecoration`
+-
+-
+-
+-
+-
+-
+-
+-
+-
Please note that the maximum size available for the icons is 24x24. You can provide an icon that is larger or smaller than this, but you will need to configure the viewbox settings in order to properly scale it to fit in the 24x24 space so it is fully visible.
@@ -348,17 +350,17 @@ Please note that the maximum size available for the icons is 24x24. You can prov
#### IgbBulletGraph
-- Added new `LabelsVisible` property
+- Added new property
#### Charts
- New properties added to the DataToolTipLayer, ItemToolTipLayer, and CategoryToolTipLayer to aid in styling: `ToolTipBackground`, `ToolTipBorderBrush`, and `ToolTipBorderThickness`
-- New properties added to the DataLegend to aid in styling: `ContentBackground`, `ContentBorderBrush`, and `ContentBorderThickness`. The `ContentBorderBrush` and `ContentBorderThickness` default to transparent and 0 respectively, so in order to see these borders, you will need to set these properties.
+- New properties added to the DataLegend to aid in styling: , , and . The and default to transparent and 0 respectively, so in order to see these borders, you will need to set these properties.
-- Added a new property to `ChartMouseEventArgs` called `WorldPosition` that provides the world relative position of the mouse. This position will be a value between 0 and 1 for both the X and Y axis within the axis space.
+- Added a new property to called that provides the world relative position of the mouse. This position will be a value between 0 and 1 for both the X and Y axis within the axis space.
-- Added `HighlightingFadeOpacity` to `SeriesViewer` and `DomainChart`. This allows you to configure the opacity applied to highlighted series.
+- Added to and . This allows you to configure the opacity applied to highlighted series.
#### IgbDataGrid
@@ -366,7 +368,7 @@ Please note that the maximum size available for the icons is 24x24. You can prov
#### IgbLinearGauge
-- Added new `LabelsVisible` property
+- Added new property
## **{PackageVerChanges-25-1-AUG}**
@@ -395,16 +397,16 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
### General
The following properties of these components are now nullable:
-- `Button`: `Form`
-- `Calendar`: `SpecialDates`, `DisabledDates`
-- `Combo`: `ValueKey`, `DisplayKey`, `GroupKey`
-- `DatePicker`: `Value`, `Min`, `Max`
-- `DateTimePicker`: `Value`, `Min`, `Max`
-- `Dropdown`: `SelectedItem`
-- `Input`: `Pattern`, `MinLength`, `MaxLength`, `Min`, `Max`, `Step`
-- `Select`: `Value`, `SelectedItem`
-- `Tile`: `ColStart`, `RowStart`
-- `TileManager`: `MinColumnWidth`, `MinRowHeight`, `Gap`
+- :
+- : ,
+- : , ,
+- : , ,
+- `DateTimePicker`: , ,
+- :
+- : , , , , ,
+- : ,
+- : ,
+- : , ,
## **{PackageVerChanges-25-1-JULY}**
@@ -440,16 +442,16 @@ For more details please visit:
- Data Annotation Slice Layer
- Data Annotation Strip Layer
-- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose `LayoutMode` property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
+- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
-- The `DefaultInteraction` property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
+- The property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
-- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an `OverlayText` property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
+- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
- [Trendline Layer](charts/features/chart-trendlines.md) series type that allows you to apply a single trend line per trend line layer to a particular series. This allows the usage of multiple trend lines on a single series since you can have multiple [TrendlineLayer](charts/features/chart-overlays.md) series types in the chart.
### General
-- `Tooltip` component provides a way to display a tooltip for a specific element. To use, set content as desired and link via the `Anchor` property to the target element's id:
+- component provides a way to display a tooltip for a specific element. To use, set content as desired and link via the property to the target element's id:
@@ -462,25 +464,25 @@ For more details please visit:
- The tooltip can be further customized with `Show/HideDelay`, `Placement` around the target and customizable `Show/HideTriggers` events.
+ The tooltip can be further customized with `Show/HideDelay`, around the target and customizable `Show/HideTriggers` events.
### Changes
- A number of enumerations have been renamed and/or merged with others. Renames (with affected components):
- - `BaseAlertLikePosition` (`Snackbar` and `Toast`) has been renamed to `AbsolutePosition`
- - `ButtonGroupAlignment` (`ButtonGroup`), `CalendarOrientation` (`Calendar`), `CardActionsOrientation` (`CardActions`), `DatePickerOrientation` (`DatePicker`), `RadioGroupAlignment` (`RadioGroup`) have been merged and renamed to `ContentOrientation`
- - `CalendarBaseSelection` (`Calendar`) has been renamed to `CalendarSelection`
- - `CarouselAnimationType` (`Carousel`) and `StepperHorizontalAnimation` (`Stepper`) have been merged and renamed to `HorizontalTransitionAnimation`
- - `CheckboxBaseLabelPosition` (`Checkbox` and `Switch`) and `RadioLabelPosition` (`Radio`) have been merged and renamed to `ToggleLabelPosition`
- - `DatePickerMode` (`DatePicker`) has been renamed to `PickerMode`
- - `DatePickerHeaderOrientation` (`DatePicker`) has been renamed to/merged with `CalendarHeaderOrientation`
- - `DropdownPlacement` (`Dropdown` and `Select`) has been renamed to `PopoverPlacement`
- - `DropdownScrollStrategy` (`Dropdown`) and `SelectScrollStrategy` (`Select`) have been merged and renamed to `PopoverScrollStrategy`
- - `SliderBaseTickOrientation` (`Slider` and `RangeSlider`) has been renamed to `SliderTickOrientation`
- - `TickLabelRotation` (`Slider` and `RangeSlider`) has been renamed to `SliderTickLabelRotation`
-- `Tabs`
-
- Simplified configuration by removing the need to define separate panel and linking the panel and tab header. The `Panel` property and the `IgbTabPanel` itself have been removed. Content can be now assigned directly to the `Tab` and header text can be set conveniently via the new `Label` property or by projecting an element to `slot="label"` for more involved customization.
+ - `BaseAlertLikePosition` ( and ) has been renamed to `AbsolutePosition`
+ - `ButtonGroupAlignment` (), `CalendarOrientation` (), `CardActionsOrientation` (), `DatePickerOrientation` (), `RadioGroupAlignment` () have been merged and renamed to `ContentOrientation`
+ - `CalendarBaseSelection` () has been renamed to `CalendarSelection`
+ - `CarouselAnimationType` () and `StepperHorizontalAnimation` () have been merged and renamed to `HorizontalTransitionAnimation`
+ - `CheckboxBaseLabelPosition` ( and ) and `RadioLabelPosition` () have been merged and renamed to `ToggleLabelPosition`
+ - `DatePickerMode` () has been renamed to `PickerMode`
+ - `DatePickerHeaderOrientation` () has been renamed to/merged with `CalendarHeaderOrientation`
+ - `DropdownPlacement` ( and ) has been renamed to `PopoverPlacement`
+ - `DropdownScrollStrategy` () and `SelectScrollStrategy` () have been merged and renamed to `PopoverScrollStrategy`
+ - `SliderBaseTickOrientation` ( and ) has been renamed to `SliderTickOrientation`
+ - ( and ) has been renamed to `SliderTickLabelRotation`
+-
+
+ Simplified configuration by removing the need to define separate panel and linking the panel and tab header. The `Panel` property and the `IgbTabPanel` itself have been removed. Content can be now assigned directly to the and header text can be set conveniently via the new property or by projecting an element to `slot="label"` for more involved customization.
Before:
@@ -525,32 +527,32 @@ For more details please visit:
```
-- `Input`
- - `Min` & `Max` are now `double` instead of `string`
-- `Stepper`
- - `ActiveStepChangingArgsEventArgs` has been renamed to `ActiveStepChangingEventArgs`
- - `ActiveStepChangedArgsEventArgs` has been renamed to `ActiveStepChangedEventArgs`
+-
+ - & are now `double` instead of `string`
+-
+ - `ActiveStepChangingArgsEventArgs` has been renamed to
+ - `ActiveStepChangedArgsEventArgs` has been renamed to
- `StepperTitlePosition` now defaults to `Auto` to correctly reflect the default behavior
-- `Tree`
- - `TreeSelectionChangeEventArgs` has been renamed to `TreeSelectionEventArgs`
-- `Textarea`
- - `Autocapitalize` & `InputMode` are now `string` properties instead of explicit enums
+-
+ - `TreeSelectionChangeEventArgs` has been renamed to
+-
+ - & are now `string` properties instead of explicit enums
### {PackageGrids} (Grids)
-- `Column`
+-
- Added events: `HiddenChange`, `ExpandedChange`, `WidthChange`, `PinnedChange`
-- `Grid`
+-
- Added events: `GroupingExpressionsChange`, `GroupingExpansionStateChange`
-- `RowIsland`
- - Added new parameter `ParentRowData` in `GridCreatedEventArgsDetail` args for `GridCreated` event
-- `Grid`, `HierarchicalGrid`, `TreeGrid`
- - Added property - `ExpansionStates` - represents a list of key-value pairs [row ID, expansion state].
+-
+ - Added new parameter in args for `GridCreated` event
+- , ,
+ - Added property - - represents a list of key-value pairs [row ID, expansion state].
- Added event: `ExpansionStatesChange`
- Type of `Rendered` event is changed from `VoidHandler` to `ComponentBoolValueChangedEventHandler`
- Type of DataChanging event is changed from `ForOfDataChangingEventHandler` to `ForOfDataChangeEventHandler`
- Type of DataChanged event is changed from `VoidHandler` to `ForOfDataChangeEventHandler`
-- `PivotDataSelector`
+-
- Added events: `ColumnsExpandedChange`, `RowsExpandedChange`, `FiltersExpandedChange`, `ValuesExpandedChange`
### {PackageDashboards} (Dashboards)
@@ -593,15 +595,15 @@ For more details please visit:
### Enhancements
#### List
-- Added new property on `ListItem` called `Selected`
+- Added new property on called
#### Accordion
-- Added new events `Open` and `Close`
+- Added new events and `Close`
### {PackageGrids}
- **All Grids**
- - Allow applying initial filtering through `FilteringExpressionsTree` property
+ - Allow applying initial filtering through property
### Bug Fixes
@@ -618,7 +620,7 @@ For more details please visit:
### {PackageGrids}
- **All Grids**
- - Added new `DisabledSummaries` for the columns of the grid, allowing the developers to skip some of the summaries
+ - Added new for the columns of the grid, allowing the developers to skip some of the summaries
- Encapsulate internal grid action button
### Bug Fixes
@@ -633,9 +635,9 @@ For more details please visit:
#### Toolbar
-- Added new `GroupHeaderTextStyle` property to `Toolbar` and `ToolPanel`. If set, it will apply to all `ToolActionGroupHeader` actions.
-- Added new property on `ToolAction` called `TitleHorizontalAlignment` which controls the horizontal alignment of the title text.
-- Added new property on `ToolActionSubPanel` called `ItemSpacing` which controls the spacing between items inside the panel.
+- Added new `GroupHeaderTextStyle` property to and . If set, it will apply to all actions.
+- Added new property on called which controls the horizontal alignment of the title text.
+- Added new property on called which controls the spacing between items inside the panel.
### Bug Fixes
@@ -689,18 +691,18 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
### General
- New [Carousel](layouts/carousel.md) component.
-- `Input`
- - Changed `change` event argument type from `ComponentDataValueChangedEventArgs` to `ComponentValueChangedEventArgs`
+-
+ - Changed `change` event argument type from to
## **{PackageVerChanges-24-1-SEP}**
### {PackageCharts} (Charts)
-- New [Data Pie Chart](charts/types/data-pie-chart.md) - The `DataPieChart` is a new component that renders a pie chart. This component works similarly to the `CategoryChart`, in that it will automatically detect the properties on your underlying data model while allowing selection, highlighting, animation and legend support via the ItemLegend component.
+- New [Data Pie Chart](charts/types/data-pie-chart.md) - The is a new component that renders a pie chart. This component works similarly to the , in that it will automatically detect the properties on your underlying data model while allowing selection, highlighting, animation and legend support via the ItemLegend component.
-- New [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `DataChart`, to plot slices similar to a pie chart, a type of data visualization where data points are represented as segments within a circular graph.
+- New [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the , to plot slices similar to a pie chart, a type of data visualization where data points are represented as segments within a circular graph.
-- `Toolbar`
+-
- New ToolActionCheckboxList
A new CheckboxList ToolAction that displays a collection of items with checkboxes for selecting. A grid inside ToolAction CheckboxList grows in height up to 5 items, then a scrollbar is displayed.
@@ -717,124 +719,124 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
- New [Banner](notifications/banner.md) component.
- New [DatePicker](scheduling/date-picker.md) component.
-- New `Divider` component.
-- `Icon`
- - Added `SetIconRef` method. This allows to register and replace icons by SVG files.
+- New component.
+-
+ - Added method. This allows to register and replace icons by SVG files.
- All components now use icons by reference internally so that it's easy to replace them without explicitly providing custom templates.
-- `Combo`, `DatePicker`, `Dialog`, `Dropdown`, `ExpansionPanel`, `NavDrawer`, `Toast`, `Snackbar`, **IgbSelectComponent**
- - Toggle methods `Show`, `Hide`, `Toggle` methods return **true** now on success. Otherwise **false**.
-- `RadioGroup`
- - Added `Name` and `Value` properties. `Value` also supports two-way binding.
+- , , , , , , , , **IgbSelectComponent**
+ - Toggle methods , , methods return **true** now on success. Otherwise **false**.
+-
+ - Added and properties. also supports two-way binding.
**Breaking Changes**
- Renamed old **IgbDatePicker** to **IgbXDatePicker**.
-- Removed `Form` component. Use native form instead.
+- Removed component. Use native form instead.
- Removed `size` property in favor of the `--ig-size` CSS custom property for the following components:
- - `Avatar`, `Button`,`IconButton`, `Calendar`, `Chip`, `Dropdown`, `Icon`, `Input`, `List`, `Rating`, `Snackbar`, `Tabs`, `Tree`
-- `Badge`, `Chip`, `LinearProgress`, `CircularProgress`
- - Renamed `Variant` property type to `StyleVariant`.
-- `Calendar`
- - Renamed `WeekStart` property type to `WeekDays`.
-- `Checkbox`, `Switch`
- - Changed `Change` event argument type from `ComponentBoolValueChangedEventArgs` to `CheckboxChangeEventArgs`.
-- `Combo`
- - The `IgbCombo` is now of generic type and the `Value` type is now of type `T[]`. This means that either you need to specify `T` or it will be inferred by the assigned `Value` type.
- - Removed `PositionStrategy`, `Flip`, `SameWidth` properties.
+ - , ,, , , , , , , , , ,
+- , , ,
+ - Renamed property type to `StyleVariant`.
+-
+ - Renamed property type to `WeekDays`.
+- ,
+ - Changed `Change` event argument type from to .
+-
+ - The `IgbCombo` is now of generic type and the type is now of type `T[]`. This means that either you need to specify `T` or it will be inferred by the assigned type.
+ - Removed , , properties.
- **IgbSelectComponent**
- - Removed `PositionStrategy`, `Flip`, `SameWidth` properties.
-- `DateTimeInput`
- - Removed `MaxValue` and `MinValue` properties. Use `Max` and `Min` instead.
-- `Dropdown`
- - Removed `PositionStrategy` property.
-- `Input`
- - Removed old named `Maxlength` and `Minlength` properties. Use `MaxLength` and `MinLength`.
- - Removed old named `Readonly` and `Inputmode` properties. Use `ReadOnly` and `InputMode`.
- - Changed `InputMode` type also to `string`.
-- `Radio`
- - Changed `Change` event argument type from `ComponentBoolValueChangedEventArgs` to `RadioChangeEventArgs`.
-- `RangeSlider`
- - Removed `AriaThumbLower` and `AriaThumbUpper` properties. Use `ThumbLabelLower` and `ThumbLabelUpper` instead.
-- `Rating`
- - Renamed `Readonly` property to `ReadOnly`.
+ - Removed , , properties.
+-
+ - Removed `MaxValue` and `MinValue` properties. Use and instead.
+-
+ - Removed property.
+-
+ - Removed old named `Maxlength` and `Minlength` properties. Use and .
+ - Removed old named `Readonly` and `Inputmode` properties. Use and .
+ - Changed type also to `string`.
+-
+ - Changed `Change` event argument type from to .
+-
+ - Removed `AriaThumbLower` and `AriaThumbUpper` properties. Use and instead.
+-
+ - Renamed `Readonly` property to .
### {PackageGrids}
- **All Grids**
- Added `GetColumns` / `GetColumnsAsync` methods, which return the grid columns collection.
- Added new `RowClick` event.
-- `PivotGrid`
- - Added `Sortable` property for a `PivotDimension`.
- - Added horizontal layout. Can be enabled inside the new `PivotUI` property as `RowLayout` `Horizontal`.
- - Added row dimension summaries for horizontal layout only. Can be enabled for each `PivotDimension` by setting `HorizontalSummary` to **true**.
- - Added `HorizontalSummariesPosition` property to the `PivotUI`, configuring horizontal summaries position.
- - Added row headers for the row dimensions. Can be enabled inside the new `PivotUI` property as `ShowHeaders` **true**.
+-
+ - Added property for a .
+ - Added horizontal layout. Can be enabled inside the new property as `RowLayout` `Horizontal`.
+ - Added row dimension summaries for horizontal layout only. Can be enabled for each by setting to **true**.
+ - Added `HorizontalSummariesPosition` property to the , configuring horizontal summaries position.
+ - Added row headers for the row dimensions. Can be enabled inside the new property as `ShowHeaders` **true**.
- Keyboard navigation now can move in to row headers back and forth from any row dimension headers or column headers.
- Added keyboard interactions for row dimension collapse using ALT + ↑↓←→ arrows and row headers sorting using CTRL + ↑↓ arrows.
**Breaking Changes**
- **All Grids**
- - `RowIsland`
+ -
- Removed `DisplayDensity` deprecated property.
- - Renamed `Columns`, `ActualColumns`, `ContentColumns` properties to `ColumnList`, `ActualColumnList` and `ContentColumnList`. Recommended to use the new `GetColumns` method instead.
- - Renamed `RowDelete` and `RowAdd` event argument type to `RowDataCancelableEventArgs`.
- - Renamed `ContextMenu` event argument type to `GridContextMenuEventArgs`.
- - Removed `GridEditEventArgs`, `GridEditDoneEventArgs`, `PinRowEventArgs` events `RowID` and `PrimaryKey` properties. Use `RowKey` instead.
-- `PivotGrid`
- - removed `ShowPivotConfigurationUI` property. Use `PivotUI` and set inside it the new `ShowConfiguration` option.
-- `Column`
- - Removed `Movable` property. Use Grid's `Moving` property now.
- - Removed `ColumnChildren` property. Use `ChildColumns` instead.
-- `ColumnGroup`
- - Removed `Children` property. Use `ChildColumns` instead.
-- `Paginator`
- - Removed `IsFirstPageDisabled` and `IsLastPageDisabled` properties. Use `IsFirstPage` and `IsLastPage` instead.
+ - Renamed , , `ContentColumns` properties to , and `ContentColumnList`. Recommended to use the new `GetColumns` method instead.
+ - Renamed `RowDelete` and `RowAdd` event argument type to .
+ - Renamed `ContextMenu` event argument type to .
+ - Removed , , events `RowID` and properties. Use `RowKey` instead.
+-
+ - removed `ShowPivotConfigurationUI` property. Use and set inside it the new `ShowConfiguration` option.
+-
+ - Removed `Movable` property. Use Grid's property now.
+ - Removed `ColumnChildren` property. Use instead.
+-
+ - Removed property. Use instead.
+-
+ - Removed `IsFirstPageDisabled` and `IsLastPageDisabled` properties. Use and instead.
## **{PackageVerChanges-24-1-JUN}**
### General
-- `Input`, `Textarea` - exposed `ValidateOnly` to enable validation rules being enforced without restricting user input.
-- `Dropdown` - `PositionStrategy` property is deprecated. The dropdown now uses the `Popover` API to render its container in the top layer of the browser viewport, making the property obsolete.
-- `DockManager` - `SplitPane` `IsMaximized` is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the `IsMaximized` property of `TabGroupPane` and/or `ContentPane` instead.
+- , - exposed to enable validation rules being enforced without restricting user input.
+- - property is deprecated. The dropdown now uses the `Popover` API to render its container in the top layer of the browser viewport, making the property obsolete.
+- - is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the property of and/or instead.
### {PackageGrids}
- `DisplayDensity` deprecated in favor of the `--ig-size` CSS custom property. Check out the [Grid Size](grids/grid/size.md) topic for more.
-- `PivotGrid` - The type of Columns, Rows, Filters from `PivotConfiguration` option is now array of IgbPivotDimension - `IgbPivotDimension[]`, it was `IgbPivotDimensionCollection` previously.
+- - The type of Columns, Rows, Filters from option is now array of IgbPivotDimension - `IgbPivotDimension[]`, it was `IgbPivotDimensionCollection` previously.
-The type of Values from `PivotConfiguration` option is now array of IgbPivotValue - `IgbPivotValue[]`, it was `IgbPivotValueCollection` previously.
+The type of Values from option is now array of IgbPivotValue - `IgbPivotValue[]`, it was `IgbPivotValueCollection` previously.
### {PackageCharts} (Charts)
-- [Data Legend Grouping](charts/features/chart-data-legend.md#{PlatformLower}-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#{PlatformLower}-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property `GroupRowVisible` toggles grouping with each series opting in can assign group text via the `DataLegendGroup` property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users.
+- [Data Legend Grouping](charts/features/chart-data-legend.md#{PlatformLower}-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#{PlatformLower}-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property toggles grouping with each series opting in can assign group text via the property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users.
-- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for `CategoryChart` and `DataChart`. Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and `SelectedSeriesItems` are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
+- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for and . Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
-- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `DataChart`, to enable creating pie charts in the allowing robust visualizations using all the added power of the data chart.
+- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the , to enable creating pie charts in the allowing robust visualizations using all the added power of the data chart.
-- [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a `HighlightingMode` property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the `HighlightingTransitionDuration` property.
+- [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the property.
-- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new `HighlightedItemsSource`. Can be toggled via `HighlightedValuesDisplayMode` and styled via `FillBrushes`.
+- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new . Can be toggled via and styled via .
-- `Toolbar` - New `IsHighlighted` option for ToolAction for outlining a border around specific tools of choice.
+- - New option for ToolAction for outlining a border around specific tools of choice.
### {PackageGauges} (Gauges)
-- `RadialGauge`
- - New label for the highlight needle. `HighlightLabelText` and `HighlightLabelSnapsToNeedlePivot` and many other styling related properties for the HighlightLabel were added.
+-
+ - New label for the highlight needle. and and many other styling related properties for the HighlightLabel were added.
## **{PackageVerChanges-23-2-APR2}**
### {PackageCharts} (Charts)
-Data Filtering via the `InitialFilter` property. Apply filter expressions to filter the chart data to a subset of records. Can be used for drill down large data.
+Data Filtering via the property. Apply filter expressions to filter the chart data to a subset of records. Can be used for drill down large data.
-- `BulletGraph`
- - The Performance bar will now reflect a difference between the value and new `HighlightValue` when the `HighlightValueDisplayMode` is applied to the 'Overlay' setting. The highlight value will show a filtered/subset measured percentage as a filled in color while the remaining bar's appearance will appear faded to the assigned value, illustrating the performance in real-time.
-- `LinearGauge`
- - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
-- `RadialGauge`
- - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
+-
+ - The Performance bar will now reflect a difference between the value and new when the is applied to the 'Overlay' setting. The highlight value will show a filtered/subset measured percentage as a filled in color while the remaining bar's appearance will appear faded to the assigned value, illustrating the performance in real-time.
+-
+ - New highlight needle was added. and when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
+-
+ - New highlight needle was added. and when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
## **{PackageVerChanges-23-2-APR}**
@@ -850,31 +852,31 @@ Data Filtering via the `InitialFilter` property. Apply filter expressions to fil
### New Features
-- `DockManager`
- - New `ProximityDock` property. If enabled, docking indicators are not visible and the end user can dock the dragged pane by dragging it close to the target pane edges.
- - New `ContainedInBoundaries` property. Determines whether the floating panes are kept inside the Dock Manager boundaries. Defaults to `false`.
- - New `ShowPaneHeaders` property. Determines whether pane headers are only shown on hover or always visible. Defaults to `always`.
-- `Tree`
+-
+ - New property. If enabled, docking indicators are not visible and the end user can dock the dragged pane by dragging it close to the target pane edges.
+ - New property. Determines whether the floating panes are kept inside the Dock Manager boundaries. Defaults to `false`.
+ - New property. Determines whether pane headers are only shown on hover or always visible. Defaults to `always`.
+-
- Added `toggleNodeOnClick` property that determines whether clicking over a node will change its expanded state or not. Defaults to `false`.
-- `Rating`
+-
- `allowReset` added. When enabled selecting the same value will reset the component. **Behavioral change** - In previous releases this was the default behavior of the rating component. Make sure to set `allowReset` if you need to keep this behavior in your application.
-- `Select`, `Dropdown`
+- ,
- exposed `selectedItem`, `items` and `groups` getters
-- `RadialGauge`
- - New title/subtitle properties. `TitleText`, `SubtitleText` will appear near the bottom the gauge. In addition, the various title/subtitle font properties were added such as `TitleFontSize`, `TitleFontFamily`, `TitleFontStyle`, `TitleFontWeight` and `TitleExtent`. Finally, the new `TitleDisplaysValue` will allow the value to correspond with the needle's position.
- - New `OpticalScalingEnabled` and `OpticalScalingSize` properties for the `RadialGauge`. This new feature will manage the size at which labels, titles, and subtitles of the gauge have 100% optical scaling. You can read more about this new feature in this [topic](radial-gauge.md#optical-scaling)
- - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
+-
+ - New title/subtitle properties. , will appear near the bottom the gauge. In addition, the various title/subtitle font properties were added such as `TitleFontSize`, `TitleFontFamily`, `TitleFontStyle`, `TitleFontWeight` and . Finally, the new will allow the value to correspond with the needle's position.
+ - New and properties for the . This new feature will manage the size at which labels, titles, and subtitles of the gauge have 100% optical scaling. You can read more about this new feature in this [topic](radial-gauge.md#optical-scaling)
+ - New highlight needle was added. and when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
- `RadialChart`
- New Label Mode
- The `CategoryAngleAxis` for the now exposes a `LabelMode` property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
+ The for the now exposes a property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
### General
-- `Input`, `MaskInput`, `DateTimeInput`, `Rating`
- - `Readonly` has been renamed to `ReadOnly`
-- `Input`
- - `Maxlength` has been renamed to `MaxLength`
- - `Minlength` has been renamed to `MinLength`
+- , , ,
+ - `Readonly` has been renamed to
+-
+ - `Maxlength` has been renamed to
+ - `Minlength` has been renamed to
### Deprecations
@@ -884,18 +886,18 @@ Data Filtering via the `InitialFilter` property. Apply filter expressions to fil
--ig-size: var(--ig-size-small);
}
```
-- `DateTimeInput`
- - `MinValue` and `MaxValue` properties have been deprecated. Please, use `Min` and `Max` instead.
-- `RangeSlider`
- - `AriaLabelLower` and `AriaLabelUpper` properties have been deprecated. Please, use `ThumbLabelLower` and `ThumbLabelUpper` instead.
+-
+ - `MinValue` and `MaxValue` properties have been deprecated. Please, use and instead.
+-
+ - `AriaLabelLower` and `AriaLabelUpper` properties have been deprecated. Please, use and instead.
### Removed
- Removed our own `dir` attribute which shadowed the default one. This is a non-breaking change.
-- `Slider` - `ariaLabel` shadowed property. This is a non-breaking change.
-- `Checkbox` - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
-- `Switch` - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
-- `Radio` - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
+- - `ariaLabel` shadowed property. This is a non-breaking change.
+- - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
+- - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
+- - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
## **{PackageVerChanges-23-2-JAN}**
@@ -905,14 +907,14 @@ Data Filtering via the `InitialFilter` property. Apply filter expressions to fil
### {PackageCharts} (Charts)
-- [Chart Highlight Filter](charts/features/chart-highlight-filter.md) - The `CategoryChart` and `DataChart` now expose a way to highlight and animate in and out of a subset of data. The display of this highlight depends on the series type. For column and area series, the subset will be shown on top of the total set of data where the subset will be colored by the actual brush of the series, and the total set will have a reduced opacity. For line series, the subset will be shown as a dotted line.
+- [Chart Highlight Filter](charts/features/chart-highlight-filter.md) - The and now expose a way to highlight and animate in and out of a subset of data. The display of this highlight depends on the series type. For column and area series, the subset will be shown on top of the total set of data where the subset will be colored by the actual brush of the series, and the total set will have a reduced opacity. For line series, the subset will be shown as a dotted line.
## **{PackageVerChanges-23-2}**
### {PackageGrids} - Toolbar -
- Save tool action has been added to save the chart to an image via the clipboard.
-- Vertical orientation has been added via the toolbar's `Orientation` property. By default the toolbar is horizontal, now the toolbar can be shown in vertical orientation where the tools will popup to the left/right respectfully.
+- Vertical orientation has been added via the toolbar's property. By default the toolbar is horizontal, now the toolbar can be shown in vertical orientation where the tools will popup to the left/right respectfully.
- Custom SVG icons support was added via the toolbar's `renderImageFromText` method, further enhancing custom tool creation.
### {PackageGrids} (Grid)
@@ -923,13 +925,13 @@ Data Filtering via the `InitialFilter` property. Apply filter expressions to fil
### New Components
-- [Toolbar](menus/toolbar.md) - component is a companion container for UI operations to be used primarily with our charting components. The toolbar will dynamically update with a preset of properties and tools when linked to our `DataChart` or `CategoryChart` components, but it also gives you the ability to create custom tools for your project.
+- [Toolbar](menus/toolbar.md) - component is a companion container for UI operations to be used primarily with our charting components. The toolbar will dynamically update with a preset of properties and tools when linked to our or components, but it also gives you the ability to create custom tools for your project.
### {PackageCharts} (Charts)
-- [ValueLayer](charts/features/chart-overlays.md#{PlatformLower}-value-layer) - A new series type named the `ValueLayer` is now exposed which can allow you to render an overlay for different focal points of the plotted data such as Maximum, Minimum, and Average. This is applied to the `CategoryChart` and `FinancialChart` by adding to the new `ValueLines` collection.
+- [ValueLayer](charts/features/chart-overlays.md#{PlatformLower}-value-layer) - A new series type named the is now exposed which can allow you to render an overlay for different focal points of the plotted data such as Maximum, Minimum, and Average. This is applied to the and by adding to the new collection.
-- It is now possible to apply a **dash array** to the different parts of the series of the `DataChart`. You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
+- It is now possible to apply a **dash array** to the different parts of the series of the . You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
## **{PackageVerChanges-22-2.65}**
### New Components
@@ -943,7 +945,7 @@ Data Filtering via the `InitialFilter` property. Apply filter expressions to fil
### {PackageGrids} (Data Grid)
-- A new argument `PrimaryKey` has been introduced to `IgbRowDataEventArgs` from `Detail`, and part of the event arguments that are emitted by the `RowAdded` and `RowDeleted` events. When the grid has a primary key attribute added, then the emitted primaryKey event argument represents the row ID, otherwise it defaults to null.
+- A new argument has been introduced to `IgbRowDataEventArgs` from , and part of the event arguments that are emitted by the `RowAdded` and `RowDeleted` events. When the grid has a primary key attribute added, then the emitted primaryKey event argument represents the row ID, otherwise it defaults to null.
- `RowSelectionChanging` event arguments are changed. Now, the `OldSelection`, `NewSelection`, `Added` and `Removed` collections no longer consist of the row keys of the selected elements when the grid has set a primaryKey, but now in any case the row data is emitted.
- When the grid is working with remote data and a primary key has been set, the selected rows that are not currently part of the grid view will be emitted for a partial row data object.
- When selected row is deleted from the grid component `RowSelectionChanging` event will no longer be emitted.
@@ -959,8 +961,8 @@ Data Filtering via the `InitialFilter` property. Apply filter expressions to fil
- `IgbDateTimeInput`, the StepDownAsync(DateTimeInputDatePart.Date, SpinDelta.Date) is now trimmed down to DatePart instead of DateTimeInputDatePart
- `IgbRadio` and `IgbRadioGroup`, added component validation along with styles for invalid state
- `IgbMask`, added the capability to escape mask pattern literals.
-- `IgbBadge` added a `Shape` property that controls the shape of the badge and can be either `Square` or `Rounded`. The default shape of the badge is rounded.
-- `IgbAvatar`, the `RoundShape` property has been deprecated and will be removed in a future version. Users can control the shape of the avatar by the newly added `Shape` attribute that can be `Square`, `Rounded` or `Circle`. The default shape of the avatar is `Square`.
+- `IgbBadge` added a property that controls the shape of the badge and can be either or `Rounded`. The default shape of the badge is rounded.
+- `IgbAvatar`, the `RoundShape` property has been deprecated and will be removed in a future version. Users can control the shape of the avatar by the newly added attribute that can be , `Rounded` or . The default shape of the avatar is .
### {PackageDockManager} (DockManager)
@@ -988,7 +990,7 @@ Added significant improvements to default behaviors, and refined the Category Ch
- Responsive layouts for horizontal label rotation based on browser / screen size.
- Enhanced rendering for rounded labels on all platforms.
- Added marker properties to StackedFragmentSeries.
-- Added `ShouldPanOnMaximumZoom` property.
+- Added property.
- New Category Axis Properties:
- ZoomMaximumCategoryRange
- ZoomMaximumItemSpan
@@ -1009,33 +1011,33 @@ Added significant improvements to default behaviors, and refined the Category Ch
- GroupSortDescriptions
-[Chart Aggregation](charts/features/chart-data-aggregations.md) will not work when using `IncludedProperties` | `ExcludedProperties`. These properties on the chart are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
+[Chart Aggregation](charts/features/chart-data-aggregations.md) will not work when using | . These properties on the chart are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
### {PackageGrids} (Data Grid)
-- Changed **{IgPrefix}Column** to `DataGridColumn`
-- Changed **GridCellEventArgs** to `DataGridCellEventArgs`
-- Changed **GridSelectionMode** to `DataGridSelectionMode`
+- Changed **{IgPrefix}Column** to
+- Changed **GridCellEventArgs** to
+- Changed **GridSelectionMode** to
- Changed **SummaryOperand** to `DataSourceSummaryOperand`
## **{PackageVerChanges-22-1}**
### {PackageCharts} (Charts)
-- Added the highly-configurable [DataLegend](charts/features/chart-data-legend.md) component, which works much like the `Legend`, but it shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values.
+- Added the highly-configurable [DataLegend](charts/features/chart-data-legend.md) component, which works much like the , but it shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values.
- Added the highly-configurable [DataToolTip](charts/features/chart-data-tooltip.md) which displays values and titles of series as well as legend badges of series in a tooltip. This is now the default tooltip for all chart types.
-- Added animation and transition-in support for Stacked Series. Animations can be enabled by setting the `IsTransitionInEnabled` property to true. From there, you can set the `TransitionInDuration` property to determine how long your animation should take to complete and the `TransitionInMode` to determine the type of animation that takes place.
-- Added `AssigningCategoryStyle` event, is now available to all series in `DataChart`. This event is handled when you want to conditionally configure aspects of the series items such as `Fill` background-color and highlighting.
-- New `AllowedPositions` enumeration for CalloutLayer. Used to limit where the callouts are to be placed within the chart. By default, the callouts are intelligently placed in the best place but this used to force for example `TopLeft`, `TopRight`, `BottomLeft` or `BottomRight`.
+- Added animation and transition-in support for Stacked Series. Animations can be enabled by setting the property to true. From there, you can set the property to determine how long your animation should take to complete and the to determine the type of animation that takes place.
+- Added `AssigningCategoryStyle` event, is now available to all series in . This event is handled when you want to conditionally configure aspects of the series items such as background-color and highlighting.
+- New enumeration for CalloutLayer. Used to limit where the callouts are to be placed within the chart. By default, the callouts are intelligently placed in the best place but this used to force for example `TopLeft`, `TopRight`, `BottomLeft` or `BottomRight`.
- New corner radius properties added for Annotation Layers; used to round-out the corners of each of the callouts. Note, a corner radius has now been added by default.
- - `CalloutCornerRadius` for CalloutLayer
- - `AxisAnnotationBackgroundCornerRadius` for FinalValueLayer
- - `XAxisAnnotationBackgroundCornerRadius` and `YAxisAnnotationBackgroundCornerRadius` for CrosshairLayer
-- New `HorizontalViewScrollbarMode` and `VerticalViewScrollbarMode` enumeration to enable scrollbars in various ways. When paired with `IsVerticalZoomEnabled` or `IsHorizontalZoomEnabled`, you'll be able to persist or fade-in and out the scrollbars along the axes to navigate the chart.
-- New `FavorLabellingScaleEnd`, determines whether the axis should favor emitting a label at the end of the scale. Only compatible with numeric axes (e.g. `NumericXAxis`, `NumericYAxis`, `PercentChangeAxis`).
-- New `IsSplineShapePartOfRange` determines whether to include the spline shape in the axis range requested of the axis.
-- New `XAxisMaximumGap`, determines the maximum allowed value for the plotted series when using `XAxisGap`. The gap determines the amount of space between columns or bars of plotted series.
-- New `XAxisMinimumGapSize`, determines the minimum allowed pixel-based value for the plotted series when using `XAxisGap` to ensure there is always some spacing between each category.
+ - for CalloutLayer
+ - for FinalValueLayer
+ - and for CrosshairLayer
+- New and enumeration to enable scrollbars in various ways. When paired with or , you'll be able to persist or fade-in and out the scrollbars along the axes to navigate the chart.
+- New , determines whether the axis should favor emitting a label at the end of the scale. Only compatible with numeric axes (e.g. , , `PercentChangeAxis`).
+- New determines whether to include the spline shape in the axis range requested of the axis.
+- New , determines the maximum allowed value for the plotted series when using . The gap determines the amount of space between columns or bars of plotted series.
+- New , determines the minimum allowed pixel-based value for the plotted series when using to ensure there is always some spacing between each category.
### {PackageGrids} (Data Grid)
@@ -1063,11 +1065,11 @@ The following breaking changes were introduced
### {PackageGrids} (Data Grid)
-- Changed `ValueField` property from type string[] to string.
+- Changed property from type string[] to string.
### {PackageInputs} (Inputs)
-- A new `ValueChanged` event supports 2-way binding and should only be handled if you have not bound the `Value` property. In order to read the Value field from the control without data binding the `ValueChanged` event should be handled, otherwise if your data is not bound you should use GetCurrentValueAsync to read the controls Value.
+- A new `ValueChanged` event supports 2-way binding and should only be handled if you have not bound the property. In order to read the Value field from the control without data binding the `ValueChanged` event should be handled, otherwise if your data is not bound you should use GetCurrentValueAsync to read the controls Value.
#### Date Picker
- Changed `ValueChanged` event to `SelectedValueChanged`.
@@ -1104,29 +1106,29 @@ For example, ``` ``` instead of ``` ```
This release introduces a few improvements and simplifications to visual design and configuration options for the geographic map and all chart components.
-- Changed `YAxisLabelLocation` property's type to **YAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart` and `CategoryChart`
-- Changed `XAxisLabelLocation` property's type to **XAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart`
-- Added `XAxisLabelLocation` property to `CategoryChart`
-- Added support for representing geographic series of `GeographicMap` in a legend
-- Added crosshair lines by default in `FinancialChart` and `CategoryChart`
-- Added crosshair annotations by default in `FinancialChart` and `CategoryChart`
-- Added final value annotation by default in `FinancialChart`
+- Changed property's type to **YAxisLabelLocation** from **AxisLabelLocation** in and
+- Changed property's type to **XAxisLabelLocation** from **AxisLabelLocation** in
+- Added property to
+- Added support for representing geographic series of in a legend
+- Added crosshair lines by default in and
+- Added crosshair annotations by default in and
+- Added final value annotation by default in
- Added new properties in Category Chart and Financial Chart:
- - `CrosshairsLineThickness` and other properties for customizing crosshairs lines
- - `CrosshairsAnnotationXAxisBackground` and other properties for customizing crosshairs annotations
- - `FinalValueAnnotationsBackground` and other properties for customizing final value annotations
- - `AreaFillOpacity` that allow changing opacity of series fill (e.g. Area chart)
- - `MarkerThickness` that allows changing thickness of markers
+ - and other properties for customizing crosshairs lines
+ - and other properties for customizing crosshairs annotations
+ - and other properties for customizing final value annotations
+ - that allow changing opacity of series fill (e.g. Area chart)
+ - that allows changing thickness of markers
- Added new properties in Category Chart, Financial Chart, Data Chart, and Geographic Map:
- - `MarkerAutomaticBehavior` that allows which marker type is assigned to multiple series in the same chart
- - `LegendItemBadgeShape` for setting badge shape of all series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on all series in a legend
+ - that allows which marker type is assigned to multiple series in the same chart
+ - for setting badge shape of all series represented in a legend
+ - for setting badge complexity on all series in a legend
- Added new properties in Series in Data Chart and Geographic Map:
- - `LegendItemBadgeShape` for setting badge shape on specific series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on specific series in a legend
+ - for setting badge shape on specific series represented in a legend
+ - for setting badge complexity on specific series in a legend
- Changed default vertical crosshair line stroke from #000000 to #BBBBBB in category chart and series
-- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's `MarkerAutomaticBehavior` property to `SmartIndexed` enum value
-- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's `LegendItemBadgeMode` property to `MatchSeries` enum value
+- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's property to `SmartIndexed` enum value
+- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's property to `MatchSeries` enum value
- Changed color palette of series and markers displayed in all charts to improve accessibility
| Old brushes/outlines | New outline/brushes |
@@ -1152,30 +1154,30 @@ This release introduces a few improvements and simplifications to visual design
#### Charts & Maps
-This release introduces several new and improved visual design and configuration options for all of the chart components, e.g. `DataChart`, `CategoryChart`, and `FinancialChart`.
+This release introduces several new and improved visual design and configuration options for all of the chart components, e.g. , , and .
- Changed Bar/Column/Waterfall series to have square corners instead of rounded corners
- Changed Scatter High Density series’ colors for heat min property from #8a5bb1 to #000000
- Changed Scatter High Density series’ colors for heat max property from #ee5879 to #ee5879
- Changed Financial/Waterfall series’ `NegativeBrush` and `NegativeOutline` properties from #C62828 to #ee5879
- Changed marker's thickness to 2px from 1px
-- Changed marker's fill to match the marker's outline for `PointSeries`, `BubbleSeries`, `ScatterSeries`, `PolarScatterSeries`. You can use set `MarkerFillMode` property to Normal to undo this change
-- Compressed labelling for the `TimeXAxis` and `OrdinalTimeXAxis`
+- Changed marker's fill to match the marker's outline for , , , . You can use set property to Normal to undo this change
+- Compressed labelling for the and
- New Marker Properties:
- - series.`MarkerFillMode` - Can be set to `MatchMarkerOutline` so the marker depends on the outline
- - series.`MarkerFillOpacity` - Can be set to a value 0 to 1
- - series.`MarkerOutlineMode` - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
+ - series. - Can be set to `MatchMarkerOutline` so the marker depends on the outline
+ - series. - Can be set to a value 0 to 1
+ - series. - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
- New Series Property:
- - series.`OutlineMode` - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
-- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the `ComputedPlotAreaMarginMode`, listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
- - chart.`PlotAreaMarginLeft`
- - chart.`PlotAreaMarginTop`
- - chart.`PlotAreaMarginRight`
- - chart.`PlotAreaMarginBottom`
- - chart.`ComputedPlotAreaMarginMode`
+ - series. - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
+- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the , listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
+ - chart.
+ - chart.
+ - chart.
+ - chart.
+ - chart.
- New Highlighting Properties
- - chart.`HighlightingMode` - Sets whether hovered or non-hovered series to fade, brighten
- - chart.`HighlightingBehavior` - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
+ - chart. - Sets whether hovered or non-hovered series to fade, brighten
+ - chart. - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
- Note, in previous releases the highlighting was limited to fade on hover.
- Added Highlighting Stacked, Scatter, Polar, Radial, and Shape series:
- Added Annotation layers to Stacked, Scatter, Polar, Radial, and Shape series:
@@ -1198,8 +1200,8 @@ for example:
#### Chart Legend
-- Added horizontal `Orientation` property to ItemLegend that can be used with Bubble, Donut, and Pie Chart
-- Added `LegendHighlightingMode` property - Enables series highlighting when hovering over legend items
+- Added horizontal property to ItemLegend that can be used with Bubble, Donut, and Pie Chart
+- Added property - Enables series highlighting when hovering over legend items
#### Geographic Map
@@ -1214,11 +1216,11 @@ These features are CTP
### {PackageGrids} (Data Grid)
-- Added `EditOnKeyPress` aka Excel-style Editing, instantly begin editing when typing.
-- Added `EditModeClickAction` property - By default double-clicking is required to enter edit mode. This can be set to `SingleClick` to allow for edit mode to occur when selecting a new cell.
-- Added `EnterKeyBehaviors` property - aka Excel-style Navigation (Enter Behavior) – controls the behavior of the enter key, e.g. Options are (none, edit, move up, down, left, right)
-- Added `EnterKeyBehaviorAfterEdit` property - While in edit-mode, this property controls when enter is pressed, e.g. Options are (moves to the cell below, above, right, left)
-- Added `SelectAllRows` - method.
+- Added aka Excel-style Editing, instantly begin editing when typing.
+- Added property - By default double-clicking is required to enter edit mode. This can be set to to allow for edit mode to occur when selecting a new cell.
+- Added property - aka Excel-style Navigation (Enter Behavior) – controls the behavior of the enter key, e.g. Options are (none, edit, move up, down, left, right)
+- Added property - While in edit-mode, this property controls when enter is pressed, e.g. Options are (moves to the cell below, above, right, left)
+- Added - method.
- Added Row Range Selection - With `GridSelectionMode` property set to MultipleRow the following new functionality is now included:
- Click and drag to select rows
- SHIFT and click to select multiple rows.
@@ -1230,13 +1232,13 @@ These features are CTP
#### Date Picker
-- `ShowTodayButton` - Toggles Today button visibility
-- `Label` - Adds a label above the date value
-- `Placeholder` property - adds custom text when no value is selected
-- `FormatString` - Customize input date string e.g. (`yyyy-MM-dd`)
-- `DateFormat` - Specifies whether to display selected dates as LongDate or ShortDate
-- `FirstDayOfWeek` - Specifies first day of week
-- `FirstWeekOfYear` - Specifies when to display first week of the year, e.g. (First Full Week, First Four day Week)
-- `ShowWeekNumbers` - Toggles Week number visibility
-- `MinDate` & `MaxDate` - Date limits, specifying a range of available selectable dates.
+- - Toggles Today button visibility
+- - Adds a label above the date value
+- property - adds custom text when no value is selected
+- - Customize input date string e.g. (`yyyy-MM-dd`)
+- - Specifies whether to display selected dates as LongDate or ShortDate
+- - Specifies first day of week
+- - Specifies when to display first week of the year, e.g. (First Full Week, First Four day Week)
+- - Toggles Week number visibility
+- & - Date limits, specifying a range of available selectable dates.
- Added Accessibility
diff --git a/docs/xplat/src/content/en/components/general-changelog-dv-react.mdx b/docs/xplat/src/content/en/components/general-changelog-dv-react.mdx
index e031ee86a5..88d181a77f 100644
--- a/docs/xplat/src/content/en/components/general-changelog-dv-react.mdx
+++ b/docs/xplat/src/content/en/components/general-changelog-dv-react.mdx
@@ -16,6 +16,8 @@ import chartdefaults3 from '@xplat-images/chartDefaults3.png';
import chartdefaults4 from '@xplat-images/chartDefaults4.png';
import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# {ProductName} Changelog
@@ -28,8 +30,8 @@ All notable changes for each version of {ProductName} are documented on this pag
#### Changed
-- `DockManager`: Updated to use the latest `igniteui-dockmanager@2.1.0` with new `minResizeWidth` and `minResizeHeight` properties, `paneFlyoutToggle` event; additional `layoutChange` event detail and fixes. See the [full changelog](https://github.com/IgniteUI/igniteui-dockmanager/blob/master/CHANGELOG.md#210).
-- Updated to use the latest `igniteui-webcomponents@7.1.0` including new `Splitter` and `Highlight` container components and fixes. See the [full changelog](https://github.com/IgniteUI/igniteui-webcomponents/blob/master/CHANGELOG.md#710---2026-03-19).
+- : Updated to use the latest `igniteui-dockmanager@2.1.0` with new `minResizeWidth` and `minResizeHeight` properties, `paneFlyoutToggle` event; additional `layoutChange` event detail and fixes. See the [full changelog](https://github.com/IgniteUI/igniteui-dockmanager/blob/master/CHANGELOG.md#210).
+- Updated to use the latest `igniteui-webcomponents@7.1.0` including new and `Highlight` container components and fixes. See the [full changelog](https://github.com/IgniteUI/igniteui-webcomponents/blob/master/CHANGELOG.md#710---2026-03-19).
#### New Features
@@ -92,18 +94,18 @@ All notable changes for each version of {ProductName} are documented on this pag
### {PackageGrids} (Grids)
-- `IgrGrid`, `IgrTreeGrid`, `IgrHierarchicalGrid`, `IgrPivotGrid`
+- , , ,
- Improved performance by dynamically adjusting the scroll throttle based on the data displayed in grid.
**Breaking Changes**
-- `IgrGrid`, `IgrTreeGrid`, `IgrHierarchicalGrid`, `IgrPivotGrid`
+- , , ,
- Original `data` array mutations (like adding/removing/moving records in the original array) are no longer detected automatically. Components need an array reference change for the change to be detected.
**Localization(i18n)**
-- `IgrGrid`, `IgrTreeGrid`, `IgrHierarchicalGrid`, `IgrPivotGrid`, `IgrCombo`, `IgrDatePicker`, `IgrDateRangePicker`, `IgrCalendar`, `IgrCarousel`, `IgrChip`, `IgrInput`, `IgrTree`
- - New `Intl` implementation for the grid components that format and render data like dates and numbers. Updated `Intl` implementation for `IgrCalendar`, `IgrDatePicker`, and `IgrDateRangePicker`.
+- , , , , , , , , , , ,
+ - New `Intl` implementation for the grid components that format and render data like dates and numbers. Updated `Intl` implementation for , , and .
- New localization implementation for the currently supported languages for all components that have resource strings in the currently supported languages.
- New public localization API and package named `igniteui-i18n-resources` containing the new resources that are used in conjunction.
@@ -159,9 +161,9 @@ Added OthersCategoryBrush and OthersCategoryOutline to DataPieChart and Proporti
#### User Annotations
-In {ProductName}, you can now annotate the `DataChart` with slice, strip, and point annotations at runtime using the new user annotations feature. This allows the end user to add more details to the plot such as calling out single important events such as company quarter reports by using the slice annotation or events that have a duration by using the strip annotation. You can also call out individual points on the plotted series by using the point annotation or any combination of these three.
+In {ProductName}, you can now annotate the with slice, strip, and point annotations at runtime using the new user annotations feature. This allows the end user to add more details to the plot such as calling out single important events such as company quarter reports by using the slice annotation or events that have a duration by using the strip annotation. You can also call out individual points on the plotted series by using the point annotation or any combination of these three.
-This is directly integrated with the available tools of the `Toolbar`.
+This is directly integrated with the available tools of the .
@@ -169,8 +171,8 @@ This is directly integrated with the available tools of the `Toolbar`.
Ability for axis annotations to automatically detect collisions and truncate to fit better. To enable this feature you must set the following properties:
-- `ShouldAvoidAnnotationCollisions`
-- `ShouldAutoTruncateAnnotations`
+-
+-
### {PackageMaps} (Geographic Map)
@@ -189,10 +191,10 @@ Ability for axis annotations to automatically detect collisions and truncate to
### New Components
-- Added `IgrChat` component
+- Added `Chat` component
### {PackageGrids} (Grids)
-- `IgrGrid`, `IgrTreeGrid`, `IgrHierarchicalGrid`
+- , ,
- Introduced a new cell merging feature that allows you to configure and merge cells in a column based on same data or other custom condition, into a single cell.
It can be enabled on the individual columns:
@@ -296,34 +298,34 @@ The following events have been added to the `IgbDataChart` to allow you to detec
#### Companion Axis
-Added `CompanionAxis` properties to the X and Y axis that allow you to quickly create a clone of an existing axis. When enabled using the `CompanionAxisEnabled` property, this will default the cloned axis to the opposite position of the chart and you can then configure that axes' properties.
+Added `CompanionAxis` properties to the X and Y axis that allow you to quickly create a clone of an existing axis. When enabled using the property, this will default the cloned axis to the opposite position of the chart and you can then configure that axes' properties.
#### RadialPieSeries Inset Outlines
-There is a new property called `UseInsetOutlines` to control how outlines on the `RadialPieSeries` are rendered. Setting this value to **true** will inset the outlines within the slice shape, whereas a **false** (default) value will place the outlines half-in half-out along the edge of the slice shape.
+There is a new property called to control how outlines on the are rendered. Setting this value to **true** will inset the outlines within the slice shape, whereas a **false** (default) value will place the outlines half-in half-out along the edge of the slice shape.
**Breaking Changes**
-- A fix was made due to an issue where the `PlotAreaPosition` and `ChartPosition` properties on `ChartMouseEventArgs` class were reversed. This will change the values that `PlotAreaPosition` and `ChartPosition` return.
+- A fix was made due to an issue where the and properties on class were reversed. This will change the values that and return.
### {PackageGrids} (Grids)
#### Cell Suffix Content
-Added support for suffix content within the cells that allows you to add additional text or icons to the end of the cell value and style it. The full list of added properties for the cell suffix content is listed below and is available on the `DataGridColumn` and `CellInfo` class:
+Added support for suffix content within the cells that allows you to add additional text or icons to the end of the cell value and style it. The full list of added properties for the cell suffix content is listed below and is available on the and class:
-- `SuffixText`
-- `SuffixTextColor`
+-
+-
- `SuffixTextFont`
-- `SuffixIconName`
-- `SuffixIconCollectionName`
-- `SuffixIconStroke`
-- `SuffixIconFill`
-- `SuffixIconViewBoxLeft`
-- `SuffixIconViewBoxTop`
-- `SuffixIconViewBoxWidth`
-- `SuffixIconViewBoxHeight`
-- `TextDecoration`
+-
+-
+-
+-
+-
+-
+-
+-
+-
Please note that the maximum size available for the icons is 24x24. You can provide an icon that is larger or smaller than this, but you will need to configure the viewbox settings in order to properly scale it to fit in the 24x24 space so it is fully visible.
@@ -331,28 +333,28 @@ Please note that the maximum size available for the icons is 24x24. You can prov
| Bug Number | Control | Description |
|------------|---------|-------------|
-|31624 | `IgrCategoryChart` | Resizing the containing window of the `IgrCategoryChart` causes the chart to fail to render the series|
-|27304 | `IgrDataChart` | Zoom rectangle is not positioned the same as the background rectangle|
-|37930 | `IgrDataChart` | Data Annotation Overlay Text Color not working|
-|30600 | `IgrDoughnutChart` | No textStyle property for either the chart or series (pie chart has this)|
-|38231 | `IgrGrid` | Unpinned column does not return to the original position if hidden columns exist|
+|31624 | | Resizing the containing window of the causes the chart to fail to render the series|
+|27304 | | Zoom rectangle is not positioned the same as the background rectangle|
+|37930 | | Data Annotation Overlay Text Color not working|
+|30600 | | No textStyle property for either the chart or series (pie chart has this)|
+|38231 | | Unpinned column does not return to the original position if hidden columns exist|
|33861 | Excel Library | Adding line chart corrupts excel File for German culture|
### Enhancements
#### IgrBulletGraph
-- Added new `LabelsVisible` property
+- Added new property
#### Charts
- New properties added to the DataToolTipLayer, ItemToolTipLayer, and CategoryToolTipLayer to aid in styling: `ToolTipBackground`, `ToolTipBorderBrush`, and `ToolTipBorderThickness`
-- New properties added to the DataLegend to aid in styling: `ContentBackground`, `ContentBorderBrush`, and `ContentBorderThickness`. The `ContentBorderBrush` and `ContentBorderThickness` default to transparent and 0 respectively, so in order to see these borders, you will need to set these properties.
+- New properties added to the DataLegend to aid in styling: , , and . The and default to transparent and 0 respectively, so in order to see these borders, you will need to set these properties.
-- Added a new property to `ChartMouseEventArgs` called `WorldPosition` that provides the world relative position of the mouse. This position will be a value between 0 and 1 for both the X and Y axis within the axis space.
+- Added a new property to called that provides the world relative position of the mouse. This position will be a value between 0 and 1 for both the X and Y axis within the axis space.
-- Added `HighlightingFadeOpacity` to `SeriesViewer` and `DomainChart`. This allows you to configure the opacity applied to highlighted series.
+- Added to and . This allows you to configure the opacity applied to highlighted series.
- Expose `CalloutLabelUpdating` event for domain charts.
@@ -362,7 +364,7 @@ Please note that the maximum size available for the icons is 24x24. You can prov
#### IgrLinearGauge
-- Added new `LabelsVisible` property
+- Added new property
## **{PackageVerChanges-25-1-SEP}**
@@ -455,7 +457,7 @@ Please note that the maximum size available for the icons is 24x24. You can prov
| Bug Number | Control | Description |
|------------|---------|------------------|
-|36448 | `IgrRadialGauge` | Radial label format properties do not work. (eg. Title, SubTitles)|
+|36448 | | Radial label format properties do not work. (eg. Title, SubTitles)|
### {PackageCharts} (Charts)
@@ -481,23 +483,23 @@ For more details please visit:
- Data Annotation Slice Layer
- Data Annotation Strip Layer
-- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose `LayoutMode` property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
+- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
-- The `DefaultInteraction` property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
+- The property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
-- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an `OverlayText` property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
+- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
- [Trendline Layer](charts/features/chart-trendlines.md) series type that allows you to apply a single trend line per trend line layer to a particular series. This allows the usage of multiple trend lines on a single series since you can have multiple [TrendlineLayer](charts/features/chart-overlays.md) series types in the chart.
### {PackageDashboards} (Dashboards)
-- The `IgrDashboardTile` now supports propagating the aggregations from its DataGrid view to the chart visualization such as sorting, grouping, filtering and selection. This is currently supported by binding the `DataSource` of the `IgrDashboardTile` to an instance of `IgrLocalDataSource`.
+- The now supports propagating the aggregations from its DataGrid view to the chart visualization such as sorting, grouping, filtering and selection. This is currently supported by binding the `DataSource` of the to an instance of .
### {PackageGrids}
**Breaking Changes**
-- The `IgrDataGrid` & `IgrMultiColumnComboBox` are now part of the igniteui-react-data-grids package.
+- The `DataGrid` & are now part of the igniteui-react-data-grids package.
### Enhancements
@@ -512,9 +514,9 @@ For more details please visit:
| Bug Number | Control | Description |
|------------|---------|------------------|
-|25997 | `IgrDataGrid` | Summaries are only showing for first grouped child row|
-|37023 | `IgrDataChart` | Tooltips are cut-off/offscreen if overflow hidden is set.|
-|37685 | `IgrSpreadsheet` | Poor rendering of numbers formatted with Arial font.|
+|25997 | `DataGrid` | Summaries are only showing for first grouped child row|
+|37023 | | Tooltips are cut-off/offscreen if overflow hidden is set.|
+|37685 | `Spreadsheet` | Poor rendering of numbers formatted with Arial font.|
|37244 | Excel Library | Custom Data Validation is not working.|
## **{PackageVerChanges-24-2-APR2}**
@@ -525,11 +527,11 @@ With 19.0.0 the React product introduces many breaking changes done to improve a
[Update Guide](update-guide.md)
### Removed
-- `CheckboxChangeEventArgs` removed, use `IgrCheckboxChangeEventArgs` instead.
-- `RadioChangeEventArgs` removed, use `IgrRadioChangeEventArgs` instead.
-- `IgrRangeSliderValue` removed, use `IgrRangeSliderValueEventArgs` instead.
-- `IgrActiveStepChangingArgs` removed, use `IgrActiveStepChangingEventArgs` instead.
-- `IgrActiveStepChangedArgs` removed, use `IgrActiveStepChangedEventArgs` instead.
+- removed, use instead.
+- removed, use instead.
+- removed, use instead.
+- `ActiveStepChangingArgs` removed, use instead.
+- `ActiveStepChangedArgs` removed, use instead.
### Enhancements
@@ -551,29 +553,29 @@ igr-tab-panel component is removed. The igr-tab now encompasses both the tab hea
### Enhancements
#### List
-- Added new property on `ListItem` called `Selected`
+- Added new property on called
#### Accordion
-- Added new events `Open` and `Close`
+- Added new events and `Close`
### {PackageGrids}
- **All Grids**
- - Allow applying initial filtering through `FilteringExpressionsTree` property
+ - Allow applying initial filtering through property
### Deprecations
-- The `clicked` event of the `Button` is deprecated. Use the native `onClick` handler.
+- The `clicked` event of the is deprecated. Use the native `onClick` handler.
### Bug Fixes
| Bug Number | Control | Description |
|------------|---------|------------------|
-|25602 | `IgrDataGrid` | Loading a layout with one of the date-specific filter operators results in a TypeError console error|
-|28480 | `IgrCombo` | Undefined reference error is thrown when a datasource is replaced|
-|30319 | `IgrDataGrid` | Records are sorted despite no value changed|
-|32598 | `IgrDataGrid` | Multi-selection is not working correctly
-|36374 | `IgrInput` | A previous value was bound when a form was submitted on any touch device|
+|25602 | `DataGrid` | Loading a layout with one of the date-specific filter operators results in a TypeError console error|
+|28480 | | Undefined reference error is thrown when a datasource is replaced|
+|30319 | `DataGrid` | Records are sorted despite no value changed|
+|32598 | `DataGrid` | Multi-selection is not working correctly
+|36374 | | A previous value was bound when a form was submitted on any touch device|
## **{PackageVerChanges-24-2-MAR}**
@@ -594,15 +596,15 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
### {PackageCommon}
- Added new `allowSplitterDock` property for `Dockmanager` that allows docking directly in a split.
-- Added new `useFixedSize` property for the `SplitPane` of `Dockmanager` that allows new resize behavior.
+- Added new `useFixedSize` property for the of `Dockmanager` that allows new resize behavior.
### Enhancements
#### Toolbar
-- Added new `groupHeaderTextStyle` property to `Toolbar` and `ToolPanel`. If set, it will apply to all `ToolActionGroupHeader` actions.
-- Added new property on `ToolAction` called `TitleHorizontalAlignment` which controls the horizontal alignment of the title text.
-- Added new property on `ToolActionSubPanel` called `itemSpacing` which controls the spacing between items inside the panel.
+- Added new `groupHeaderTextStyle` property to and . If set, it will apply to all actions.
+- Added new property on called which controls the horizontal alignment of the title text.
+- Added new property on called `itemSpacing` which controls the spacing between items inside the panel.
### Bug Fixes
@@ -610,16 +612,16 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
| Bug Number | Control | Description |
|------------|---------|------------------|
-|30286 | `IgrDataChart` | Bubble Series tooltip content is switched to that of nearby bubble data in clicking a bubble|
-|32906 | `IgrDataChart` | `IgrDataChart` is showing two xAxis on the top|
-|33605 | `IgrDataChart` | ScatterLineSeries is not showing the color of the line correctly in the legend|
-|34776 | `IgrDataChart` | Repeatedly showing and hiding the `IgrDataChart` causes memory leakage in JS Heap|
-|35498 | `IgrDataChart` | Tooltips for the series specified in IncludedSeries are not displayed|
-|34324 | `IgrGrid` | Column hiding through condition in the grid template is not working|
-|34678 | `IgrGrid` | Enum values coerced to strings, breaking expected numeric behavior in some grid properties|
-|32093 | `IgrPivotGrid` | PivotDateDimensionOptions are not applied to the PivotDateDimension|
-|34053 | `IgrRadialGauge` | The position of the scale label is shifted|
-|35496 | `IgrSpreadsheet` | Error when setting styles in Excel with images|
+|30286 | | Bubble Series tooltip content is switched to that of nearby bubble data in clicking a bubble|
+|32906 | | is showing two xAxis on the top|
+|33605 | | ScatterLineSeries is not showing the color of the line correctly in the legend|
+|34776 | | Repeatedly showing and hiding the causes memory leakage in JS Heap|
+|35498 | | Tooltips for the series specified in IncludedSeries are not displayed|
+|34324 | | Column hiding through condition in the grid template is not working|
+|34678 | | Enum values coerced to strings, breaking expected numeric behavior in some grid properties|
+|32093 | | PivotDateDimensionOptions are not applied to the PivotDateDimension|
+|34053 | | The position of the scale label is shifted|
+|35496 | `Spreadsheet` | Error when setting styles in Excel with images|
|36176 | Excel Library | Exception occurs when loading an Excel workbook that has a LET function|
|36379 | Excel Library | Colors with any alpha channel in an excel workbook fail to load|
|26218 | Excel Library | Chart's plot area right margin becomes narrower and fill pattern and fill foreground are gone just by loading an Excel file|
@@ -651,18 +653,18 @@ DashboardTile
### General
- New [Carousel](layouts/carousel.md) component.
-- `Input`
- - Changed `change` event argument type from `ComponentDataValueChangedEventArgs` to `ComponentValueChangedEventArgs`
+-
+ - Changed `change` event argument type from to
## **{PackageVerChanges-24-1-SEP}**
### {PackageCharts} (Charts)
-- New [Data Pie Chart](charts/types/data-pie-chart.md) - The `DataPieChart` is a new component that renders a pie chart. This component works similarly to the `CategoryChart`, in that it will automatically detect the properties on your underlying data model while allowing selection, highlighting, animation and legend support via the ItemLegend component.
+- New [Data Pie Chart](charts/types/data-pie-chart.md) - The is a new component that renders a pie chart. This component works similarly to the , in that it will automatically detect the properties on your underlying data model while allowing selection, highlighting, animation and legend support via the ItemLegend component.
-- New [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `DataChart`, to plot slices similar to a pie chart, a type of data visualization where data points are represented as segments within a circular graph.
+- New [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the , to plot slices similar to a pie chart, a type of data visualization where data points are represented as segments within a circular graph.
-- `Toolbar`
+-
- New ToolActionCheckboxList
A new CheckboxList ToolAction that displays a collection of items with checkboxes for selecting. A grid inside ToolAction CheckboxList grows in height up to 5 items, then a scrollbar is displayed.
@@ -679,55 +681,55 @@ DashboardTile
- New [Banner](notifications/banner.md) component.
- New [DatePicker](scheduling/date-picker.md) component.
-- New `Divider` component.
+- New component.
- Added support for native events to all components.
-- `Icon`
+-
- Added `setIconRef` method. This allows to register and replace icons by SVG files.
- All components now use icons by reference internally so that it's easy to replace them without explicitly providing custom templates.
-- `Combo`, `DatePicker`, `Dialog`, `Dropdown`, `ExpansionPanel`, `NavDrawer`, `Toast`, `Snackbar`, **IgrSelectComponent**
+- , , , , , , , , **IgrSelectComponent**
- Toggle methods `show`, `hide`, `toggle` methods return **true** now on success, otherwise **false**.
-- **IgrButtonComponent**, `IconButton`, `Checkbox`, `Switch`, `Combo`, `DateTimeInput`, `Input`, `MaskInput`, `Radio`, **IgrSelectComponent**, `Textarea`
+- **IgrButtonComponent**, , , , , , , , , **IgrSelectComponent**,
- Deprecated custom `focus` and `blur` events. Use the native `onFocus` and `onBlur` events instead
-- `RadioGroup`
- - Added `Name` and `Value` properties.
+-
+ - Added and properties.
**Breaking Changes**
- Renamed old **IgrDatePicker** to **IgrXDatePicker**.
-- Removed `Form` component. Use native form instead.
+- Removed component. Use native form instead.
- Removed `size` property in favor of the `--ig-size` CSS custom property for the following components:
- - `Avatar`, **IgrButtonComponent**, `IconButton`, `Calendar`, `Chip`, `Dropdown`, `Icon`, `Input`, `List`, `Rating`, `Snackbar`, `Tabs`, `Tree`
-- `Badge`, `Chip`, `LinearProgress`, `CircularProgress`
- - Renamed `Variant` property type to `StyleVariant`.
-- `Calendar`
- - Renamed `WeekStart` property type to `WeekDays`.
-- `Checkbox`, `Switch`
- - Changed `change` event argument type from `ComponentBoolValueChangedEventArgs` to `CheckboxChangeEventArgs`.
-- `Combo`, **IgrSelectComponent**
+ - , **IgrButtonComponent**, , , , , , , , , , ,
+- , , ,
+ - Renamed property type to `StyleVariant`.
+-
+ - Renamed property type to `WeekDays`.
+- ,
+ - Changed `change` event argument type from to .
+- , **IgrSelectComponent**
- Removed `positionStrategy`, `flip`, `sameWidth` properties.
-- `DateTimeInput`
+-
- Removed `maxValue` and `minValue` properties. Use `max` and `min` instead.
-- `Dropdown`
+-
- Removed `positionStrategy` property.
-- `Input`
+-
- Removed old named `maxlength` and `minlength` properties. Use `maxLength` and `minLength`.
- Removed old named `readonly` and `inputmode` properties. Use `readOnly` and `inputMode`.
- Changed `inputMode` type also to `string`.
-- `Radio`
- - Changed `change` event argument type from `ComponentBoolValueChangedEventArgs` to `RadioChangeEventArgs`.
-- `RangeSlider`
+-
+ - Changed `change` event argument type from to .
+-
- Removed `ariaThumbLower` and `ariaThumbUpper` properties. Use `thumbLabelLower` and `thumbLabelUpper` instead.
-- `Rating`
+-
- Renamed `readonly` property to `readOnly`.
### {PackageGrids}
- **All Grids**
- Added new `RowClick` event.
-- `PivotGrid`
- - Added `sortable` property for a `PivotDimension`.
+-
+ - Added `sortable` property for a .
- Added horizontal layout. Can be enabled inside the new `pivotUI` property as `rowLayout` `horizontal`.
- - Added row dimension summaries for horizontal layout only. Can be enabled for each `PivotDimension` by setting `horizontalSummary` to **true**.
+ - Added row dimension summaries for horizontal layout only. Can be enabled for each by setting `horizontalSummary` to **true**.
- Added `horizontalSummariesPosition` property to the `pivotUI`, configuring horizontal summaries position.
- Added row headers for the row dimensions. Can be enabled inside the new `pivotUI` property as `showHeaders` **true**.
- Keyboard navigation now can move in to row headers back and forth from any row dimension headers or column headers.
@@ -736,127 +738,127 @@ DashboardTile
**Breaking Changes**
- **All Grids**
- - `RowIsland`
+ -
- Removed `displayDensity` deprecated property.
- Renamed `actualColumns`, `contentColumns` properties to `actualColumnList` and `contentColumnList`. Use `columns` or `columnList` property to get all columns now.
- - Renamed `rowDelete` and `rowAdd` event argument type to `RowDataCancelableEventArgs`.
- - Renamed `contextMenu` event argument type to `GridContextMenuEventArgs`.
- - Removed `GridEditEventArgs`, `GridEditDoneEventArgs`, `PinRowEventArgs` events `rowID` and `primaryKey` properties. Use `rowKey` instead.
-- `PivotGrid`
+ - Renamed `rowDelete` and `rowAdd` event argument type to .
+ - Renamed `contextMenu` event argument type to .
+ - Removed , , events `rowID` and `primaryKey` properties. Use `rowKey` instead.
+-
- removed `showPivotConfigurationUI` property. Use `pivotUI` and set inside it the new `showConfiguration` option.
-- `Column`
+-
- Removed `movable` property. Use Grid's `moving` property now.
- Removed `columnChildren` property. Use `childColumns` instead.
-- `ColumnGroup`
+-
- Removed `children` property. Use `childColumns` instead.
-- `Paginator`
+-
- Removed `isFirstPageDisabled` and `isLastPageDisabled` properties. Use `isFirstPage` and `isLastPage` instead.
## **{PackageVerChanges-24-1-JUN}**
### {PackageCommon}
-- `Input`, `Textarea` - exposed `ValidateOnly` to enable validation rules being enforced without restricting user input.
-- `Dropdown` - `PositionStrategy` property is deprecated. The dropdown now uses the `Popover` API to render its container in the top layer of the browser viewport, making the property obsolete.
-- `DockManager` - `SplitPane` `IsMaximized` is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the `IsMaximized` property of `TabGroupPane` and/or `ContentPane` instead.
+- , - exposed to enable validation rules being enforced without restricting user input.
+- - property is deprecated. The dropdown now uses the `Popover` API to render its container in the top layer of the browser viewport, making the property obsolete.
+- - is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the property of and/or instead.
### {PackageGrids}
- `DisplayDensity` deprecated in favor of the `--ig-size` CSS custom property. Check out the [Grid Size](grids/grid/size.md) topic for more.
-- `PivotGrid` - Configuration of the component can now be applied correctly.
+- - Configuration of the component can now be applied correctly.
### {PackageCharts} (Charts)
-- [Data Legend Grouping](charts/features/chart-data-legend.md#{PlatformLower}-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#{PlatformLower}-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property `GroupRowVisible` toggles grouping with each series opting in can assign group text via the `DataLegendGroup` property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users.
+- [Data Legend Grouping](charts/features/chart-data-legend.md#{PlatformLower}-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#{PlatformLower}-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property toggles grouping with each series opting in can assign group text via the property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users.
-- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for `CategoryChart` and `DataChart`. Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and `SelectedSeriesItems` are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
+- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for and . Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
-- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `DataChart`, to enable creating pie charts in the allowing robust visualizations using all the added power of the data chart.
+- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the , to enable creating pie charts in the allowing robust visualizations using all the added power of the data chart.
-- [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a `HighlightingMode` property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the `HighlightingTransitionDuration` property.
+- [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the property.
-- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new `HighlightedItemsSource`. Can be toggled via `HighlightedValuesDisplayMode` and styled via `FillBrushes`.
+- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new . Can be toggled via and styled via `FillBrushes`.
-- `Toolbar` - New `IsHighlighted` option for ToolAction for outlining a border around specific tools of choice.
+- - New option for ToolAction for outlining a border around specific tools of choice.
### {PackageGauges} (Gauges)
-- `RadialGauge`
- - New label for the highlight needle. `HighlightLabelText` and `HighlightLabelSnapsToNeedlePivot` and many other styling related properties for the HighlightLabel were added.
+-
+ - New label for the highlight needle. and and many other styling related properties for the HighlightLabel were added.
## **{PackageVerChanges-23-2-MAR}**
### {PackageCharts}
-- New Data Filtering via the `InitialFilter` property. Apply filter expressions to filter the chart data to a subset of records. Can be used for drill down large data.
+- New Data Filtering via the property. Apply filter expressions to filter the chart data to a subset of records. Can be used for drill down large data.
- `RadialChart`
- New Label Mode
- The `CategoryAngleAxis` for the now exposes a `LabelMode` property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
+ The for the now exposes a property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
### {PackageGrids}
-- New [`HierarchicalGrid`](grids/hierarchical-grid/overview.md) component
+- New [](grids/hierarchical-grid/overview.md) component
### {PackageGauges}
-- `RadialGauge`
- - New title/subtitle properties. `TitleText`, `SubtitleText` will appear near the bottom the gauge. In addition, the various title/subtitle font properties were added such as `TitleFontSize`, `TitleFontFamily`, `TitleFontStyle`, `TitleFontWeight` and `TitleExtent`. Finally, the new `TitleDisplaysValue` will allow the value to correspond with the needle's position.
- - New `OpticalScalingEnabled` and `OpticalScalingSize` properties for the `RadialGauge`. This new feature will manage the size at which labels, titles, and subtitles of the gauge have 100% optical scaling. You can read more about this new feature in this [topic](radial-gauge.md#optical-scaling)
- - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
-- `LinearGauge`
- - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
-- `BulletGraph`
- - The Performance bar will now reflect a difference between the value and new `HighlightValue` when the `HighlightValueDisplayMode` is applied to the 'Overlay' setting. The highlight value will show a filtered/subset completed measured percentage as a filled in color while the remaining bar's appearance will appear faded to the assigned value, illustrating the performance in real-time.
+-
+ - New title/subtitle properties. , will appear near the bottom the gauge. In addition, the various title/subtitle font properties were added such as `TitleFontSize`, `TitleFontFamily`, `TitleFontStyle`, `TitleFontWeight` and . Finally, the new will allow the value to correspond with the needle's position.
+ - New and properties for the . This new feature will manage the size at which labels, titles, and subtitles of the gauge have 100% optical scaling. You can read more about this new feature in this [topic](radial-gauge.md#optical-scaling)
+ - New highlight needle was added. and when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
+-
+ - New highlight needle was added. and when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
+-
+ - The Performance bar will now reflect a difference between the value and new when the is applied to the 'Overlay' setting. The highlight value will show a filtered/subset completed measured percentage as a filled in color while the remaining bar's appearance will appear faded to the assigned value, illustrating the performance in real-time.
### {PackageCommon}
-- New `Textarea` component
-- New `ButtonGroup` component
-- `DockManager`
- - New `ProximityDock` property. If enabled, docking indicators are not visible and the end user can dock the dragged pane by dragging it close to the target pane edges.
- - New `ContainedInBoundaries` property. Determines whether the floating panes are kept inside the Dock Manager boundaries. Defaults to `false`.
- - New `ShowPaneHeaders` property. Determines whether pane headers are only shown on hover or always visible. Defaults to `always`.
-- `Input`, `MaskInput`, `DateTimeInput`, `Rating`
- - `Readonly` has been renamed to `ReadOnly`
-- `Input`
- - `Maxlength` has been renamed to `MaxLength`
- - `Minlength` has been renamed to `MinLength`
-- `Tree`
+- New component
+- New component
+-
+ - New property. If enabled, docking indicators are not visible and the end user can dock the dragged pane by dragging it close to the target pane edges.
+ - New property. Determines whether the floating panes are kept inside the Dock Manager boundaries. Defaults to `false`.
+ - New property. Determines whether pane headers are only shown on hover or always visible. Defaults to `always`.
+- , , ,
+ - `Readonly` has been renamed to
+-
+ - `Maxlength` has been renamed to
+ - `Minlength` has been renamed to
+-
- Added `toggleNodeOnClick` property that determines whether clicking over a node will change its expanded state or not. Defaults to `false`.
-- `Rating`
+-
- `allowReset` added. When enabled selecting the same value will reset the component. **Behavioral change** - In previous releases this was the default behavior of the rating component. Make sure to set `allowReset` if you need to keep this behavior in your application.
-- `Select`, `Dropdown`
+- ,
- exposed `selectedItem`, `items` and `groups` getters
#### Deprecations
-- The `Form` component has been deprecated. Please, use the native form element instead.
+- The component has been deprecated. Please, use the native form element instead.
- The `size` property and attribute have been deprecated for all components. Use the `--ig-size` CSS custom property instead. The following example sets the size of the avatar component to small:
```css
.avatar {
--ig-size: var(--ig-size-small);
}
```
-- `DateTimeInput`
- - `MinValue` and `MaxValue` properties have been deprecated. Please, use `Min` and `Max` instead.
-- `RangeSlider`
- - `AriaLabelLower` and `AriaLabelUpper` properties have been deprecated. Please, use `ThumbLabelLower` and `ThumbLabelUpper` instead.
+-
+ - `MinValue` and `MaxValue` properties have been deprecated. Please, use and instead.
+-
+ - `AriaLabelLower` and `AriaLabelUpper` properties have been deprecated. Please, use and instead.
#### Removed
- Removed our own `dir` attribute which shadowed the default one. This is a non-breaking change.
-- `Slider` - `ariaLabel` shadowed property. This is a non-breaking change.
-- `Checkbox` - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
-- `Switch` - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
-- `Radio` - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
+- - `ariaLabel` shadowed property. This is a non-breaking change.
+- - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
+- - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
+- - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
## **{PackageVerChanges-23-2-JAN}**
### {PackageCharts} (Charts)
-- [Chart Highlight Filter](charts/features/chart-highlight-filter.md) - The `CategoryChart` and `DataChart` now expose a way to highlight and animate in and out of a subset of data. The display of this highlight depends on the series type. For column and area series, the subset will be shown on top of the total set of data where the subset will be colored by the actual brush of the series, and the total set will have a reduced opacity. For line series, the subset will be shown as a dotted line.
+- [Chart Highlight Filter](charts/features/chart-highlight-filter.md) - The and now expose a way to highlight and animate in and out of a subset of data. The display of this highlight depends on the series type. For column and area series, the subset will be shown on top of the total set of data where the subset will be colored by the actual brush of the series, and the total set will have a reduced opacity. For line series, the subset will be shown as a dotted line.
## **{PackageVerChanges-23-2-DEC}**
@@ -869,7 +871,7 @@ DashboardTile
### {PackageGrids} - Toolbar -
- Save tool action has been added to save the chart to an image via the clipboard.
-- Vertical orientation has been added via the toolbar's `Orientation` property. By default the toolbar is horizontal, now the toolbar can be shown in vertical orientation where the tools will popup to the left/right respectfully.
+- Vertical orientation has been added via the toolbar's property. By default the toolbar is horizontal, now the toolbar can be shown in vertical orientation where the tools will popup to the left/right respectfully.
- Custom SVG icons support was added via the toolbar's `renderImageFromText` method, further enhancing custom tool creation.
- [Grid](grids/data-grid.md) - This is a new fully functional cross-platform grid and includes features like filtering, sorting, templates, row selection, row grouping, row pinning and movable columns.
@@ -882,13 +884,13 @@ DashboardTile
### New Components
-- [Toolbar](menus/toolbar.md) - This component is a companion container for UI operations to be used primarily with our charting components. The toolbar will dynamically update with a preset of properties and tool items when linked to our `DataChart` or `CategoryChart` components. You'll be able to create custom tools for your project allowing end users to provide changes, offering an endless amount of customization.
+- [Toolbar](menus/toolbar.md) - This component is a companion container for UI operations to be used primarily with our charting components. The toolbar will dynamically update with a preset of properties and tool items when linked to our or components. You'll be able to create custom tools for your project allowing end users to provide changes, offering an endless amount of customization.
### {PackageCharts} (Charts)
-- [ValueLayer](charts/features/chart-overlays.md#{PlatformLower}-value-layer) - A new series type named the `ValueLayer` is now exposed which can allow you to render an overlay for different focal points of the plotted data such as Maximum, Minimum, and Average. This is applied to the `CategoryChart` and `FinancialChart` by adding to the new `ValueLines` collection.
+- [ValueLayer](charts/features/chart-overlays.md#{PlatformLower}-value-layer) - A new series type named the is now exposed which can allow you to render an overlay for different focal points of the plotted data such as Maximum, Minimum, and Average. This is applied to the and by adding to the new collection.
-- It is now possible to apply a **dash array** to the different parts of the series of the `DataChart`. You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
+- It is now possible to apply a **dash array** to the different parts of the series of the . You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
## **{PackageVerChanges-22-2}**
@@ -897,7 +899,7 @@ Added significant improvements to default behaviors, and refined the Category Ch
- Responsive layouts for horizontal label rotation based on browser / screen size.
- Enhanced rendering for rounded labels on all platforms.
- Added marker properties to StackedFragmentSeries.
-- Added `ShouldPanOnMaximumZoom` property.
+- Added property.
- New Category Axis Properties:
- ZoomMaximumCategoryRange
- ZoomMaximumItemSpan
@@ -918,32 +920,32 @@ Added significant improvements to default behaviors, and refined the Category Ch
- GroupSortDescriptions
-[Chart Aggregation](charts/features/chart-data-aggregations.md) will not work when using `IncludedProperties` | `ExcludedProperties`. These properties on the chart are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
+[Chart Aggregation](charts/features/chart-data-aggregations.md) will not work when using | . These properties on the chart are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
### {PackageGrids} (Data Grid)
-- Changed **{IgPrefix}Column** to `DataGridColumn`
-- Changed **GridCellEventArgs** to `DataGridCellEventArgs`
-- Changed **GridSelectionMode** to `DataGridSelectionMode`
-- Changed **SummaryOperand** to `DataSourceSummaryOperand`
+- Changed **{IgPrefix}Column** to
+- Changed **GridCellEventArgs** to
+- Changed **GridSelectionMode** to
+- Changed **SummaryOperand** to
## **{PackageVerChanges-22-1}**
### {PackageCharts} (Charts)
-- Added the highly-configurable [DataLegend](charts/features/chart-data-legend.md) component, which works much like the `Legend`, but it shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values.
+- Added the highly-configurable [DataLegend](charts/features/chart-data-legend.md) component, which works much like the , but it shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values.
- Added the highly-configurable [DataToolTip](charts/features/chart-data-tooltip.md) which displays values and titles of series as well as legend badges of series in a tooltip. This is now the default tooltip for all chart types.
-- Added animation and transition-in support for Stacked Series. Animations can be enabled by setting the `IsTransitionInEnabled` property to true. From there, you can set the `TransitionInDuration` property to determine how long your animation should take to complete and the `TransitionInMode` to determine the type of animation that takes place.
-- Added `AssigningCategoryStyle` event, is now available to all series in `DataChart`. This event is handled when you want to conditionally configure aspects of the series items such as `Fill` background-color and highlighting.
-- New `AllowedPositions` enumeration for CalloutLayer. Used to limit where the callouts are to be placed within the chart. By default, the callouts are intelligently placed in the best place but this used to force for example `TopLeft`, `TopRight`, `BottomLeft` or `BottomRight`.
+- Added animation and transition-in support for Stacked Series. Animations can be enabled by setting the property to true. From there, you can set the property to determine how long your animation should take to complete and the to determine the type of animation that takes place.
+- Added `AssigningCategoryStyle` event, is now available to all series in . This event is handled when you want to conditionally configure aspects of the series items such as background-color and highlighting.
+- New enumeration for CalloutLayer. Used to limit where the callouts are to be placed within the chart. By default, the callouts are intelligently placed in the best place but this used to force for example `TopLeft`, `TopRight`, `BottomLeft` or `BottomRight`.
- New corner radius properties added for Annotation Layers; used to round-out the corners of each of the callouts. Note, a corner radius has now been added by default.
- - `CalloutCornerRadius` for CalloutLayer
- - `AxisAnnotationBackgroundCornerRadius` for FinalValueLayer
- - `XAxisAnnotationBackgroundCornerRadius` and `YAxisAnnotationBackgroundCornerRadius` for CrosshairLayer
-- New `HorizontalViewScrollbarMode` and `VerticalViewScrollbarMode` enumeration to enable scrollbars in various ways. When paired with `IsVerticalZoomEnabled` or `IsHorizontalZoomEnabled`, you'll be able to persist or fade-in and out the scrollbars along the axes to navigate the chart.
-- New `FavorLabellingScaleEnd`, determines whether the axis should favor emitting a label at the end of the scale. Only compatible with numeric axes (e.g. `NumericXAxis`, `NumericYAxis`, `PercentChangeAxis`).
-- New `IsSplineShapePartOfRange` determines whether to include the spline shape in the axis range requested of the axis.
-- New `XAxisMaximumGap`, determines the maximum allowed value for the plotted series when using `XAxisGap`. The gap determines the amount of space between columns or bars of plotted series.
-- New `XAxisMinimumGapSize`, determines the minimum allowed pixel-based value for the plotted series when using `XAxisGap` to ensure there is always some spacing between each category.
+ - for CalloutLayer
+ - for FinalValueLayer
+ - and for CrosshairLayer
+- New and enumeration to enable scrollbars in various ways. When paired with or , you'll be able to persist or fade-in and out the scrollbars along the axes to navigate the chart.
+- New , determines whether the axis should favor emitting a label at the end of the scale. Only compatible with numeric axes (e.g. , , `PercentChangeAxis`).
+- New determines whether to include the spline shape in the axis range requested of the axis.
+- New , determines the maximum allowed value for the plotted series when using . The gap determines the amount of space between columns or bars of plotted series.
+- New , determines the minimum allowed pixel-based value for the plotted series when using to ensure there is always some spacing between each category.
### {PackageGrids} (Data Grid)
@@ -954,13 +956,13 @@ Added New Feature - [Row Paging](grids/data-grid/row-paging.md) which is used to
### {PackageGrids} (Data Grid)
#### Data Grid
-- Added `ValueMultiField`, of type string[], in the `ComboBoxColumn` to be used when your items in the drop down contain a key that consists of multiple fields.
+- Added , of type string[], in the to be used when your items in the drop down contain a key that consists of multiple fields.
The following breaking changes were introduced
-- Changed `ValueField` property from type string[] to string.
+- Changed property from type string[] to string.
### {PackageInputs} (Inputs)
@@ -983,29 +985,29 @@ Please ensure package "lit-html": "^2.0.0" or newer is added to your project for
This release introduces a few improvements and simplifications to visual design and configuration options for the geographic map and all chart components.
-- Changed `YAxisLabelLocation` property's type to **YAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart` and `CategoryChart`
-- Changed `XAxisLabelLocation` property's type to **XAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart`
-- Added `XAxisLabelLocation` property to `CategoryChart`
-- Added support for representing geographic series of `GeographicMap` in a legend
-- Added crosshair lines by default in `FinancialChart` and `CategoryChart`
-- Added crosshair annotations by default in `FinancialChart` and `CategoryChart`
-- Added final value annotation by default in `FinancialChart`
+- Changed property's type to **YAxisLabelLocation** from **AxisLabelLocation** in and
+- Changed property's type to **XAxisLabelLocation** from **AxisLabelLocation** in
+- Added property to
+- Added support for representing geographic series of in a legend
+- Added crosshair lines by default in and
+- Added crosshair annotations by default in and
+- Added final value annotation by default in
- Added new properties in Category Chart and Financial Chart:
- - `CrosshairsLineThickness` and other properties for customizing crosshairs lines
- - `CrosshairsAnnotationXAxisBackground` and other properties for customizing crosshairs annotations
- - `FinalValueAnnotationsBackground` and other properties for customizing final value annotations
- - `AreaFillOpacity` that allow changing opacity of series fill (e.g. Area chart)
- - `MarkerThickness` that allows changing thickness of markers
+ - and other properties for customizing crosshairs lines
+ - and other properties for customizing crosshairs annotations
+ - and other properties for customizing final value annotations
+ - that allow changing opacity of series fill (e.g. Area chart)
+ - that allows changing thickness of markers
- Added new properties in Category Chart, Financial Chart, Data Chart, and Geographic Map:
- - `MarkerAutomaticBehavior` that allows which marker type is assigned to multiple series in the same chart
- - `LegendItemBadgeShape` for setting badge shape of all series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on all series in a legend
+ - that allows which marker type is assigned to multiple series in the same chart
+ - for setting badge shape of all series represented in a legend
+ - for setting badge complexity on all series in a legend
- Added new properties in Series in Data Chart and Geographic Map:
- - `LegendItemBadgeShape` for setting badge shape on specific series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on specific series in a legend
+ - for setting badge shape on specific series represented in a legend
+ - for setting badge complexity on specific series in a legend
- Changed default vertical crosshair line stroke from #000000 to #BBBBBB in category chart and series
-- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's `MarkerAutomaticBehavior` property to `SmartIndexed` enum value
-- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's `LegendItemBadgeMode` property to `MatchSeries` enum value
+- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's property to `SmartIndexed` enum value
+- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's property to `MatchSeries` enum value
- Changed color palette of series and markers displayed in all charts to improve accessibility
| Old brushes/outlines | New outline/brushes |
@@ -1025,38 +1027,38 @@ This release introduces a few improvements and simplifications to visual design
- Added `SelectionChanged` event. Used to detect changes on selection interactions
e.g. Multiple row selection.
- Breaking Changes:
- - Changed grid's SummaryScope property's type to SummaryScope from `DataSourceSummaryScope`
- - Changed GroupHeaderDisplayMode property's type to GroupHeaderDisplayMode from `DataSourceSectionHeaderDisplayMode`
+ - Changed grid's SummaryScope property's type to SummaryScope from
+ - Changed GroupHeaderDisplayMode property's type to GroupHeaderDisplayMode from
## **{PackageVerChanges-21-1}**
### {PackageCharts} (Charts)
-This release introduces several new and improved visual design and configuration options for all of the chart components, e.g. `DataChart`, `CategoryChart`, and `FinancialChart`.
+This release introduces several new and improved visual design and configuration options for all of the chart components, e.g. , , and .
- Changed Bar/Column/Waterfall series to have square corners instead of rounded corners
- Changed Scatter High Density series’ colors for heat min property from #8a5bb1 to #000000
- Changed Scatter High Density series’ colors for heat max property from #ee5879 to #ee5879
- Changed Financial/Waterfall series’ `NegativeBrush` and `NegativeOutline` properties from #C62828 to #ee5879
- Changed marker's thickness to 2px from 1px
-- Changed marker's fill to match the marker's outline for `PointSeries`, `BubbleSeries`, `ScatterSeries`, `PolarScatterSeries`. You can use set `MarkerFillMode` property to Normal to undo this change
-- Compressed labelling for the `TimeXAxis` and `OrdinalTimeXAxis`
+- Changed marker's fill to match the marker's outline for , , , . You can use set property to Normal to undo this change
+- Compressed labelling for the and
- New Marker Properties:
- - series.`MarkerFillMode` - Can be set to `MatchMarkerOutline` so the marker depends on the outline
- - series.`MarkerFillOpacity` - Can be set to a value 0 to 1
- - series.`MarkerOutlineMode` - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
+ - series. - Can be set to `MatchMarkerOutline` so the marker depends on the outline
+ - series. - Can be set to a value 0 to 1
+ - series. - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
- New Series Property:
- - series.`OutlineMode` - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
-- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the `ComputedPlotAreaMarginMode`, listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
- - chart.`PlotAreaMarginLeft`
- - chart.`PlotAreaMarginTop`
- - chart.`PlotAreaMarginRight`
- - chart.`PlotAreaMarginBottom`
- - chart.`ComputedPlotAreaMarginMode`
+ - series. - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
+- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the , listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
+ - chart.
+ - chart.
+ - chart.
+ - chart.
+ - chart.
- New Highlighting Properties
- - chart.`HighlightingMode` - Sets whether hovered or non-hovered series to fade, brighten
- - chart.`HighlightingBehavior` - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
+ - chart. - Sets whether hovered or non-hovered series to fade, brighten
+ - chart. - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
- Note, in previous releases the highlighting was limited to fade on hover.
- Added Highlighting Stacked, Scatter, Polar, Radial, and Shape series:
- Added Annotation layers to Stacked, Scatter, Polar, Radial, and Shape series:
@@ -1079,8 +1081,8 @@ for example:
#### Chart Legend
-- Added horizontal `Orientation` property to ItemLegend that can be used with Bubble, Donut, and Pie Chart
-- Added `LegendHighlightingMode` property - Enables series highlighting when hovering over legend items
+- Added horizontal property to ItemLegend that can be used with Bubble, Donut, and Pie Chart
+- Added property - Enables series highlighting when hovering over legend items
### {PackageMaps} (GeoMap)
@@ -1097,11 +1099,11 @@ These features are CTP
### {PackageGrids} (Data Grid)
-- Added `EditOnKeyPress` aka Excel-style Editing, instantly begin editing when typing.
-- Added `EditModeClickAction` property - By default double-clicking is required to enter edit mode. This can be set to `SingleClick` to allow for edit mode to occur when selecting a new cell.
-- Added `EnterKeyBehaviors` property - aka Excel-style Navigation (Enter Behavior) – controls the behavior of the enter key, e.g. Options are (none, edit, move up, down, left, right)
-- Added `EnterKeyBehaviorAfterEdit` property - While in edit-mode, this property controls when enter is pressed, e.g. Options are (moves to the cell below, above, right, left)
-- Added `SelectAllRows` - method.
+- Added aka Excel-style Editing, instantly begin editing when typing.
+- Added property - By default double-clicking is required to enter edit mode. This can be set to `SingleClick` to allow for edit mode to occur when selecting a new cell.
+- Added property - aka Excel-style Navigation (Enter Behavior) – controls the behavior of the enter key, e.g. Options are (none, edit, move up, down, left, right)
+- Added property - While in edit-mode, this property controls when enter is pressed, e.g. Options are (moves to the cell below, above, right, left)
+- Added - method.
- Added Row Range Selection - With `GridSelectionMode` property set to MultipleRow the following new functionality is now included:
- Click and drag to select rows
- SHIFT and click to select multiple rows.
@@ -1113,15 +1115,15 @@ These features are CTP
#### Date Picker
-- `ShowTodayButton` - Toggles Today button visibility
-- `Label` - Adds a label above the date value
-- `Placeholder` property - adds custom text when no value is selected
-- `FormatString` - Customize input date string e.g. (`yyyy-MM-dd`)
-- `DateFormat` - Specifies whether to display selected dates as LongDate or ShortDate
-- `FirstDayOfWeek` - Specifies first day of week
-- `FirstWeekOfYear` - Specifies when to display first week of the year, e.g. (First Full Week, First Four day Week)
-- `ShowWeekNumbers` - Toggles Week number visibility
-- `MinDate` & `MaxDate` - Date limits, specifying a range of available selectable dates.
+- - Toggles Today button visibility
+- - Adds a label above the date value
+- property - adds custom text when no value is selected
+- - Customize input date string e.g. (`yyyy-MM-dd`)
+- - Specifies whether to display selected dates as LongDate or ShortDate
+- - Specifies first day of week
+- - Specifies when to display first week of the year, e.g. (First Full Week, First Four day Week)
+- - Toggles Week number visibility
+- & - Date limits, specifying a range of available selectable dates.
- Added Accessibility
diff --git a/docs/xplat/src/content/en/components/general-changelog-dv-wc.mdx b/docs/xplat/src/content/en/components/general-changelog-dv-wc.mdx
index ad25eeb92c..1c6a835875 100644
--- a/docs/xplat/src/content/en/components/general-changelog-dv-wc.mdx
+++ b/docs/xplat/src/content/en/components/general-changelog-dv-wc.mdx
@@ -17,6 +17,8 @@ import chartdefaults4 from '@xplat-images/chartDefaults4.png';
import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# {ProductName} Changelog
@@ -126,9 +128,9 @@ Added OthersCategoryBrush and OthersCategoryOutline to DataPieChart and Proporti
#### User Annotations
-In {ProductName}, you can now annotate the `DataChart` with slice, strip, and point annotations at runtime using the new user annotations feature. This allows the end user to add more details to the plot such as calling out single important events such as company quarter reports by using the slice annotation or events that have a duration by using the strip annotation. You can also call out individual points on the plotted series by using the point annotation or any combination of these three.
+In {ProductName}, you can now annotate the with slice, strip, and point annotations at runtime using the new user annotations feature. This allows the end user to add more details to the plot such as calling out single important events such as company quarter reports by using the slice annotation or events that have a duration by using the strip annotation. You can also call out individual points on the plotted series by using the point annotation or any combination of these three.
-This is directly integrated with the available tools of the `Toolbar`.
+This is directly integrated with the available tools of the .
@@ -136,8 +138,8 @@ This is directly integrated with the available tools of the `Toolbar`.
Ability for axis annotations to automatically detect collisions and truncate to fit better. To enable this feature you must set the following properties:
-- `ShouldAvoidAnnotationCollisions`
-- `ShouldAutoTruncateAnnotations`
+-
+-
### {PackageMaps} (Geographic Map)
@@ -159,7 +161,7 @@ Ability for axis annotations to automatically detect collisions and truncate to
### New Components
-- Added `IgrChat` component
+- Added `Chat` component
### {PackageGrids} (Grids)
- `IgcGrid`, `IgcTreeGrid`, `IgcHierarchicalGrid`
@@ -269,34 +271,34 @@ The following events have been added to the `IgcDataChart` to allow you to detec
#### Companion Axis
-Added `CompanionAxis` properties to the X and Y axis that allow you to quickly create a clone of an existing axis. When enabled using the `CompanionAxisEnabled` property, this will default the cloned axis to the opposite position of the chart and you can then configure that axes' properties.
+Added `CompanionAxis` properties to the X and Y axis that allow you to quickly create a clone of an existing axis. When enabled using the property, this will default the cloned axis to the opposite position of the chart and you can then configure that axes' properties.
#### RadialPieSeries Inset Outlines
-There is a new property called `UseInsetOutlines` to control how outlines on the `RadialPieSeries` are rendered. Setting this value to **true** will inset the outlines within the slice shape, whereas a **false** (default) value will place the outlines half-in half-out along the edge of the slice shape.
+There is a new property called to control how outlines on the are rendered. Setting this value to **true** will inset the outlines within the slice shape, whereas a **false** (default) value will place the outlines half-in half-out along the edge of the slice shape.
**Breaking Changes**
-- A fix was made due to an issue where the `PlotAreaPosition` and `ChartPosition` properties on `ChartMouseEventArgs` class were reversed. This will change the values that `PlotAreaPosition` and `ChartPosition` return.
+- A fix was made due to an issue where the and properties on class were reversed. This will change the values that and return.
### {PackageGrids}
#### Cell Suffix Content
-Added support for suffix content within the cells that allows you to add additional text or icons to the end of the cell value and style it. The full list of added properties for the cell suffix content is listed below and is available on the `DataGridColumn` and `CellInfo` class:
+Added support for suffix content within the cells that allows you to add additional text or icons to the end of the cell value and style it. The full list of added properties for the cell suffix content is listed below and is available on the and class:
-- `SuffixText`
-- `SuffixTextColor`
+-
+-
- `SuffixTextFont`
-- `SuffixIconName`
-- `SuffixIconCollectionName`
-- `SuffixIconStroke`
-- `SuffixIconFill`
-- `SuffixIconViewBoxLeft`
-- `SuffixIconViewBoxTop`
-- `SuffixIconViewBoxWidth`
-- `SuffixIconViewBoxHeight`
-- `TextDecoration`
+-
+-
+-
+-
+-
+-
+-
+-
+-
Please note that the maximum size available for the icons is 24x24. You can provide an icon that is larger or smaller than this, but you will need to configure the viewbox settings in order to properly scale it to fit in the 24x24 space so it is fully visible.
@@ -314,19 +316,19 @@ Please note that the maximum size available for the icons is 24x24. You can prov
### Enhancements
-#### IgrBulletGraph
+#### BulletGraph
-- Added new `LabelsVisible` property
+- Added new property
#### Charts
- New properties added to the DataToolTipLayer, ItemToolTipLayer, and CategoryToolTipLayer to aid in styling: `ToolTipBackground`, `ToolTipBorderBrush`, and `ToolTipBorderThickness`
-- New properties added to the DataLegend to aid in styling: `ContentBackground`, `ContentBorderBrush`, and `ContentBorderThickness`. The `ContentBorderBrush` and `ContentBorderThickness` default to transparent and 0 respectively, so in order to see these borders, you will need to set these properties.
+- New properties added to the DataLegend to aid in styling: , , and . The and default to transparent and 0 respectively, so in order to see these borders, you will need to set these properties.
-- Added a new property to `ChartMouseEventArgs` called `WorldPosition` that provides the world relative position of the mouse. This position will be a value between 0 and 1 for both the X and Y axis within the axis space.
+- Added a new property to called that provides the world relative position of the mouse. This position will be a value between 0 and 1 for both the X and Y axis within the axis space.
-- Added `HighlightingFadeOpacity` to `SeriesViewer` and `DomainChart`. This allows you to configure the opacity applied to highlighted series.
+- Added to and . This allows you to configure the opacity applied to highlighted series.
- Expose `CalloutLabelUpdating` event for domain charts.
@@ -336,7 +338,7 @@ Please note that the maximum size available for the icons is 24x24. You can prov
#### IgcLinearGauge
-- Added new `LabelsVisible` property
+- Added new property
## **{PackageVerChanges-25-1-AUG}**
@@ -438,11 +440,11 @@ For more details please visit:
- Data Annotation Strip Layer
-- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose `LayoutMode` property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
+- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
-- The `DefaultInteraction` property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
+- The property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
-- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an `OverlayText` property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
+- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
- [Trendline Layer](charts/features/chart-trendlines.md) series type that allows you to apply a single trend line per trend line layer to a particular series. This allows the usage of multiple trend lines on a single series since you can have multiple [TrendlineLayer](charts/features/chart-overlays.md) series types in the chart.
@@ -479,7 +481,7 @@ For more details please visit:
### {PackageGrids}
- **All Grids**
- - Allow applying initial filtering through `FilteringExpressionsTree` property
+ - Allow applying initial filtering through property
### Bug Fixes
@@ -497,9 +499,9 @@ For more details please visit:
#### Toolbar
-- Added new `GroupHeaderTextStyle` property to `Toolbar` and `ToolPanel`. If set, it will apply to all `ToolActionGroupHeader` actions.
-- Added new property on `ToolAction` called `TitleHorizontalAlignment` which controls the horizontal alignment of the title text.
-- Added new property on `ToolActionSubPanel` called `ItemSpacing` which controls the spacing between items inside the panel.
+- Added new `GroupHeaderTextStyle` property to and . If set, it will apply to all actions.
+- Added new property on called which controls the horizontal alignment of the title text.
+- Added new property on called which controls the spacing between items inside the panel.
### Bug Fixes
@@ -543,11 +545,11 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
### {PackageCharts}
-- New [Data Pie Chart](charts/types/data-pie-chart.md) - The `DataPieChart` is a new component that renders a pie chart. This component works similarly to the `CategoryChart`, in that it will automatically detect the properties on your underlying data model while allowing selection, highlighting, animation and legend support via the ItemLegend component.
+- New [Data Pie Chart](charts/types/data-pie-chart.md) - The is a new component that renders a pie chart. This component works similarly to the , in that it will automatically detect the properties on your underlying data model while allowing selection, highlighting, animation and legend support via the ItemLegend component.
-- New [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `DataChart`, to plot slices similar to a pie chart, a type of data visualization where data points are represented as segments within a circular graph.
+- New [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the , to plot slices similar to a pie chart, a type of data visualization where data points are represented as segments within a circular graph.
-- `Toolbar`
+-
- New ToolActionCheckboxList
A new CheckboxList ToolAction that displays a collection of items with checkboxes for selecting. A grid inside ToolAction CheckboxList grows in height up to 5 items, then a scrollbar is displayed.
@@ -564,10 +566,10 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
- **All Grids**
- Added new `RowClick` event.
-- `PivotGrid`
- - Added `sortable` property for a `PivotDimension`.
+-
+ - Added `sortable` property for a .
- Added horizontal layout. Can be enabled inside the new `pivotUI` property as `rowLayout` `horizontal`.
- - Added row dimension summaries for horizontal layout only. Can be enabled for each `PivotDimension` by setting `horizontalSummary` to **true**.
+ - Added row dimension summaries for horizontal layout only. Can be enabled for each by setting `horizontalSummary` to **true**.
- Added `horizontalSummariesPosition` property to the `pivotUI`, configuring horizontal summaries position.
- Added row headers for the row dimensions. Can be enabled inside the new `pivotUI` property as `showHeaders` **true**.
- Keyboard navigation now can move in to row headers back and forth from any row dimension headers or column headers.
@@ -575,84 +577,84 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
**Breaking Changes**
- **All Grids**
- - `RowIsland`
+ -
- Removed `displayDensity` deprecated property.
- Renamed `actualColumns`, `contentColumns` properties to `actualColumnList` and `contentColumnList`. Use `column` or `columnList` property to get all columns now.
- - Renamed `rowDelete` and `rowAdd` event argument type to `RowDataCancelableEventArgs`.
- - Renamed `contextMenu` event argument type to `GridContextMenuEventArgs`.
- - Removed `GridEditEventArgs`, `GridEditDoneEventArgs`, `PinRowEventArgs` events `rowID` and `primaryKey` properties. Use `rowKey` instead.
-- `PivotGrid`
+ - Renamed `rowDelete` and `rowAdd` event argument type to .
+ - Renamed `contextMenu` event argument type to .
+ - Removed , , events `rowID` and `primaryKey` properties. Use `rowKey` instead.
+-
- removed `showPivotConfigurationUI` property. Use `pivotUI` and set inside it the new `showConfiguration` option.
-- `Column`
+-
- Removed `movable` property. Use Grid's `moving` property now.
- Removed `columnChildren` property. Use `childColumns` instead.
-- `ColumnGroup`
+-
- Removed `children` property. Use `childColumns` instead.
-- `Paginator`
+-
- Removed `isFirstPageDisabled` and `isLastPageDisabled` properties. Use `isFirstPage` and `isLastPage` instead.
## **{PackageVerChanges-24-1-JUN}**
### {PackageCommon}
-- `Input`, `Textarea` - exposed `ValidateOnly` to enable validation rules being enforced without restricting user input.
-- `Dropdown` - `PositionStrategy` property is deprecated. The dropdown now uses the `Popover` API to render its container in the top layer of the browser viewport, making the property obsolete.
-- `DockManager` - `SplitPane` `IsMaximized` is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the `IsMaximized` property of `TabGroupPane` and/or `ContentPane` instead.
+- , - exposed to enable validation rules being enforced without restricting user input.
+- - property is deprecated. The dropdown now uses the `Popover` API to render its container in the top layer of the browser viewport, making the property obsolete.
+- - is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the property of and/or instead.
### {PackageGrids}
- `DisplayDensity` deprecated in favor of the `--ig-size` CSS custom property. Check out the [Grid Size](grids/grid/size.md) topic for more regarding the Grid.
### {PackageCharts}
-- [Data Legend Grouping](charts/features/chart-data-legend.md#{PlatformLower}-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#{PlatformLower}-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property `GroupRowVisible` toggles grouping with each series opting in can assign group text via the `DataLegendGroup` property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users.
+- [Data Legend Grouping](charts/features/chart-data-legend.md#{PlatformLower}-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#{PlatformLower}-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property toggles grouping with each series opting in can assign group text via the property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users.
-- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for `CategoryChart` and `DataChart`. Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and `SelectedSeriesItems` are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
+- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for and . Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
-- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `DataChart`, to enable creating pie charts in the allowing robust visualizations using all the added power of the data chart.
+- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the , to enable creating pie charts in the allowing robust visualizations using all the added power of the data chart.
-- [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a `HighlightingMode` property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the `HighlightingTransitionDuration` property.
+- [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the property.
-- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new `HighlightedItemsSource`. Can be toggled via `HighlightedValuesDisplayMode` and styled via `FillBrushes`.
+- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new . Can be toggled via and styled via `FillBrushes`.
-- `Toolbar` - New `IsHighlighted` option for ToolAction for outlining a border around specific tools of choice.
+- - New option for ToolAction for outlining a border around specific tools of choice.
### {PackageGauges}
-- `RadialGauge`
- - New label for the highlight needle. `HighlightLabelText` and `HighlightLabelSnapsToNeedlePivot` and many other styling related properties for the HighlightLabel were added.
+-
+ - New label for the highlight needle. and and many other styling related properties for the HighlightLabel were added.
## **{PackageVerChanges-23-2-MAR}**
### {PackageGrids}
-- New [`HierarchicalGrid`](grids/hierarchical-grid/overview.md) component.
+- New [](grids/hierarchical-grid/overview.md) component.
### {PackageCharts}
-- New Data Filtering via the `InitialFilter` property. Apply filter expressions to filter the chart data to a subset of records. Can be used for drill down large data.
+- New Data Filtering via the property. Apply filter expressions to filter the chart data to a subset of records. Can be used for drill down large data.
- `RadialChart`
- New Label Mode
- The `CategoryAngleAxis` for the now exposes a `LabelMode` property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
+ The for the now exposes a property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
### {PackageGauges}
-- `RadialGauge`
- - New title/subtitle properties. `TitleText`, `SubtitleText` will appear near the bottom the gauge. In addition, the various title/subtitle font properties were added such as `TitleFontSize`, `TitleFontFamily`, `TitleFontStyle`, `TitleFontWeight` and `TitleExtent`. Finally, the new `TitleDisplaysValue` will allow the value to correspond with the needle's position.
- - New `OpticalScalingEnabled` and `OpticalScalingSize` properties for the `RadialGauge`. This new feature will manage the size at which labels, titles, and subtitles of the gauge have 100% optical scaling. You can read more about this new feature in this [topic](radial-gauge.md#optical-scaling)
- - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
-- `LinearGauge`
- - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
-- `BulletGraph`
- - The Performance bar will now reflect a difference between the value and new `HighlightValue` when the `HighlightValueDisplayMode` is applied to the 'Overlay' setting. The highlight value will show a filtered/subset completed measured percentage as a filled in color while the remaining bar's appearance will appear faded to the assigned value, illustrating the performance in real-time.
+-
+ - New title/subtitle properties. , will appear near the bottom the gauge. In addition, the various title/subtitle font properties were added such as `TitleFontSize`, `TitleFontFamily`, `TitleFontStyle`, `TitleFontWeight` and . Finally, the new will allow the value to correspond with the needle's position.
+ - New and properties for the . This new feature will manage the size at which labels, titles, and subtitles of the gauge have 100% optical scaling. You can read more about this new feature in this [topic](radial-gauge.md#optical-scaling)
+ - New highlight needle was added. and when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
+-
+ - New highlight needle was added. and when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
+-
+ - The Performance bar will now reflect a difference between the value and new when the is applied to the 'Overlay' setting. The highlight value will show a filtered/subset completed measured percentage as a filled in color while the remaining bar's appearance will appear faded to the assigned value, illustrating the performance in real-time.
## **{PackageVerChanges-23-2-JAN}**
### {PackageCharts}
-- [Chart Highlight Filter](charts/features/chart-highlight-filter.md) - The `CategoryChart` and `DataChart` now expose a way to highlight and animate in and out of a subset of data. The display of this highlight depends on the series type. For column and area series, the subset will be shown on top of the total set of data where the subset will be colored by the actual brush of the series, and the total set will have a reduced opacity. For line series, the subset will be shown as a dotted line.
+- [Chart Highlight Filter](charts/features/chart-highlight-filter.md) - The and now expose a way to highlight and animate in and out of a subset of data. The display of this highlight depends on the series type. For column and area series, the subset will be shown on top of the total set of data where the subset will be colored by the actual brush of the series, and the total set will have a reduced opacity. For line series, the subset will be shown as a dotted line.
## **{PackageVerChanges-23-2-DEC}**
@@ -667,7 +669,7 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
- [Toolbar](menus/toolbar.md)
- Save tool action has been added to save the chart to an image via the clipboard.
- - Vertical orientation has been added via the toolbar's `Orientation` property. By default the toolbar is horizontal, now the toolbar can be shown in vertical orientation where the tools will popup to the left/right respectfully.
+ - Vertical orientation has been added via the toolbar's property. By default the toolbar is horizontal, now the toolbar can be shown in vertical orientation where the tools will popup to the left/right respectfully.
- Custom SVG icons support was added via the toolbar's `renderImageFromText` method, further enhancing custom tool creation.
@@ -675,13 +677,13 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
### {PackageLayouts}
-- [Toolbar](menus/toolbar.md) - This component is a companion container for UI operations to be used primarily with our charting components. The toolbar will dynamically update with a preset of properties and tool items when linked to our `DataChart` or `CategoryChart` components. You'll be able to create custom tools for your project allowing end users to provide changes, offering an endless amount of customization.
+- [Toolbar](menus/toolbar.md) - This component is a companion container for UI operations to be used primarily with our charting components. The toolbar will dynamically update with a preset of properties and tool items when linked to our or components. You'll be able to create custom tools for your project allowing end users to provide changes, offering an endless amount of customization.
### {PackageCharts}
-- [ValueLayer](charts/features/chart-overlays.md#{PlatformLower}-value-layer) - A new series type named the `ValueLayer` is now exposed which can allow you to render an overlay for different focal points of the plotted data such as Maximum, Minimum, and Average. This is applied to the `CategoryChart` and `FinancialChart` by adding to the new `ValueLines` collection.
+- [ValueLayer](charts/features/chart-overlays.md#{PlatformLower}-value-layer) - A new series type named the is now exposed which can allow you to render an overlay for different focal points of the plotted data such as Maximum, Minimum, and Average. This is applied to the and by adding to the new collection.
-- It is now possible to apply a **dash array** to the different parts of the series of the `DataChart`. You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
+- It is now possible to apply a **dash array** to the different parts of the series of the . You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
## **{PackageVerChanges-22-2.2}**
@@ -689,14 +691,14 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
### {PackageGrids}
-- A new argument `PrimaryKey` has been introduced to `IgcRowDataEventArgs`, and part of the event arguments that are emitted by the `RowAdded` and `RowDeleted` events. When the grid has a primary key attribute added, then the emitted primaryKey event argument represents the row ID, otherwise it defaults to undefined.
+- A new argument has been introduced to `IgcRowDataEventArgs`, and part of the event arguments that are emitted by the `RowAdded` and `RowDeleted` events. When the grid has a primary key attribute added, then the emitted primaryKey event argument represents the row ID, otherwise it defaults to undefined.
- `RowSelectionChanging` event arguments are changed. Now, the `OldSelection`, `NewSelection`, `Added` and `Removed` collections no longer consist of the row keys of the selected elements when the grid has set a primaryKey, but now in any case the row data is emitted.
- When the grid is working with remote data and a primary key has been set, the selected rows that are not currently part of the grid view will be emitted for a partial row data object.
- When selected row is deleted from the grid component `RowSelectionChanging` event will no longer be emitted.
- The `OnGroupingDone` event has been renamed to `GroupingDone` to not violate the no on-prefixed outputs convention.
- The `OnDensityChanged` event has been renamed to `DensityChanged` to not violate the no on-prefixed outputs convention. All components exposing this event are affected.
-- `PivotGrid`: The `IgcPivotDateDimension` properties `InBaseDimension` and `InOption` have been deprecated and renamed to `BaseDimension` and `Options` respectively.
+- : The `IgcPivotDateDimension` properties `InBaseDimension` and `InOption` have been deprecated and renamed to `BaseDimension` and `Options` respectively.
### {PackageInputs}
@@ -704,8 +706,8 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
- `IgcDateTimeInput`, the StepDownAsync(DateTimeInputDatePart.Date, SpinDelta.Date) is now trimmed down to DatePart instead of DateTimeInputDatePart
- `IgcRadio` and `IgcRadioGroup`, added component validation along with styles for invalid state
- `IgcMask`, added the capability to escape mask pattern literals.
-- `IgcBadge` added a `Shape` property that controls the shape of the badge and can be either `Square` or `Rounded`. The default shape of the badge is rounded.
-- `IgcAvatar`, the `RoundShape` property has been deprecated and will be removed in a future version. Users can control the shape of the avatar by the newly added `Shape` attribute that can be `Square`, `Rounded` or `Circle`. The default shape of the avatar is `Square`.
+- `IgcBadge` added a property that controls the shape of the badge and can be either or `Rounded`. The default shape of the badge is rounded.
+- `IgcAvatar`, the `RoundShape` property has been deprecated and will be removed in a future version. Users can control the shape of the avatar by the newly added attribute that can be , `Rounded` or . The default shape of the avatar is .
## **{PackageVerChanges-22-2.1}**
@@ -721,9 +723,9 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
- New [Grid](grids/data-grid.md) component.
- New [Tree Grid](grids/tree-grid/overview.md) component.
- `DataGrid`:
- - Changed **{IgPrefix}Column** to `DataGridColumn`
- - Changed **GridCellEventArgs** to `DataGridCellEventArgs`
- - Changed **GridSelectionMode** to `DataGridSelectionMode`
+ - Changed **{IgPrefix}Column** to
+ - Changed **GridCellEventArgs** to
+ - Changed **GridSelectionMode** to
- Changed **SummaryOperand** to `DataSourceSummaryOperand`
### {PackageCharts}
@@ -733,7 +735,7 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
- Responsive layouts for horizontal label rotation based on browser / screen size.
- Enhanced rendering for rounded labels on all platforms.
- Added marker properties to StackedFragmentSeries.
-- Added `ShouldPanOnMaximumZoom` property.
+- Added property.
- New Category Axis Properties:
- ZoomMaximumCategoryRange
- ZoomMaximumItemSpan
@@ -753,7 +755,7 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
- GroupSorts
- GroupSortDescriptions
-[Chart Aggregation](charts/features/chart-data-aggregations.md) will not work when using `IncludedProperties` | `ExcludedProperties`. These properties on the chart are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
+[Chart Aggregation](charts/features/chart-data-aggregations.md) will not work when using | . These properties on the chart are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
## **{PackageVerChanges-22-1}**
@@ -765,27 +767,27 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
### {PackageCharts}
-- Added the highly-configurable [DataLegend](charts/features/chart-data-legend.md) component, which works much like the `Legend`, but it shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values.
+- Added the highly-configurable [DataLegend](charts/features/chart-data-legend.md) component, which works much like the , but it shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values.
- Added the highly-configurable [DataToolTip](charts/features/chart-data-tooltip.md) which displays values and titles of series as well as legend badges of series in a tooltip. This is now the default tooltip for all chart types.
-- Added animation and transition-in support for Stacked Series. Animations can be enabled by setting the `IsTransitionInEnabled` property to true. From there, you can set the `TransitionInDuration` property to determine how long your animation should take to complete and the `TransitionInMode` to determine the type of animation that takes place.
-- Added `AssigningCategoryStyle` event, is now available to all series in `DataChart`. This event is handled when you want to conditionally configure aspects of the series items such as `Fill` background-color and highlighting.
-- New `AllowedPositions` enumeration for CalloutLayer. Used to limit where the callouts are to be placed within the chart. By default, the callouts are intelligently placed in the best place but this used to force for example `TopLeft`, `TopRight`, `BottomLeft` or `BottomRight`.
+- Added animation and transition-in support for Stacked Series. Animations can be enabled by setting the property to true. From there, you can set the property to determine how long your animation should take to complete and the to determine the type of animation that takes place.
+- Added `AssigningCategoryStyle` event, is now available to all series in . This event is handled when you want to conditionally configure aspects of the series items such as background-color and highlighting.
+- New enumeration for CalloutLayer. Used to limit where the callouts are to be placed within the chart. By default, the callouts are intelligently placed in the best place but this used to force for example `TopLeft`, `TopRight`, `BottomLeft` or `BottomRight`.
- New corner radius properties added for Annotation Layers; used to round-out the corners of each of the callouts. Note, a corner radius has now been added by default.
- - `CalloutCornerRadius` for CalloutLayer
- - `AxisAnnotationBackgroundCornerRadius` for FinalValueLayer
- - `XAxisAnnotationBackgroundCornerRadius` and `YAxisAnnotationBackgroundCornerRadius` for CrosshairLayer
-- New `HorizontalViewScrollbarMode` and `VerticalViewScrollbarMode` enumeration to enable scrollbars in various ways. When paired with `IsVerticalZoomEnabled` or `IsHorizontalZoomEnabled`, you'll be able to persist or fade-in and out the scrollbars along the axes to navigate the chart.
-- New `FavorLabellingScaleEnd`, determines whether the axis should favor emitting a label at the end of the scale. Only compatible with numeric axes (e.g. `NumericXAxis`, `NumericYAxis`, `PercentChangeAxis`).
-- New `IsSplineShapePartOfRange` determines whether to include the spline shape in the axis range requested of the axis.
-- New `XAxisMaximumGap`, determines the maximum allowed value for the plotted series when using `XAxisGap`. The gap determines the amount of space between columns or bars of plotted series.
-- New `XAxisMinimumGapSize`, determines the minimum allowed pixel-based value for the plotted series when using `XAxisGap` to ensure there is always some spacing between each category.
+ - for CalloutLayer
+ - for FinalValueLayer
+ - and for CrosshairLayer
+- New and enumeration to enable scrollbars in various ways. When paired with or , you'll be able to persist or fade-in and out the scrollbars along the axes to navigate the chart.
+- New , determines whether the axis should favor emitting a label at the end of the scale. Only compatible with numeric axes (e.g. , , `PercentChangeAxis`).
+- New determines whether to include the spline shape in the axis range requested of the axis.
+- New , determines the maximum allowed value for the plotted series when using . The gap determines the amount of space between columns or bars of plotted series.
+- New , determines the minimum allowed pixel-based value for the plotted series when using to ensure there is always some spacing between each category.
## **{PackageVerChanges-21-2.1}**
### {PackageGrids}
- `DataGrid`:
- - Added `ValueMultiField`, of type string[], in the `ComboBoxColumn` to be used when your items in the drop down contain a key that consists of multiple fields.
+ - Added , of type string[], in the to be used when your items in the drop down contain a key that consists of multiple fields.
The following breaking changes were introduced: Changed `ValueField` property from type string[] to string.
@@ -824,29 +826,29 @@ Please ensure package "lit-html": "^2.0.0" or newer is added to your project for
This release introduces a few improvements and simplifications to visual design and configuration options for the geographic map and all chart components.
-- Changed `YAxisLabelLocation` property's type to **YAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart` and `CategoryChart`
-- Changed `XAxisLabelLocation` property's type to **XAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart`
-- Added `XAxisLabelLocation` property to `CategoryChart`
-- Added support for representing geographic series of `GeographicMap` in a legend
-- Added crosshair lines by default in `FinancialChart` and `CategoryChart`
-- Added crosshair annotations by default in `FinancialChart` and `CategoryChart`
-- Added final value annotation by default in `FinancialChart`
+- Changed property's type to **YAxisLabelLocation** from **AxisLabelLocation** in and
+- Changed property's type to **XAxisLabelLocation** from **AxisLabelLocation** in
+- Added property to
+- Added support for representing geographic series of in a legend
+- Added crosshair lines by default in and
+- Added crosshair annotations by default in and
+- Added final value annotation by default in
- Added new properties in Category Chart and Financial Chart:
- - `CrosshairsLineThickness` and other properties for customizing crosshairs lines
- - `CrosshairsAnnotationXAxisBackground` and other properties for customizing crosshairs annotations
- - `FinalValueAnnotationsBackground` and other properties for customizing final value annotations
- - `AreaFillOpacity` that allow changing opacity of series fill (e.g. Area chart)
- - `MarkerThickness` that allows changing thickness of markers
+ - and other properties for customizing crosshairs lines
+ - and other properties for customizing crosshairs annotations
+ - and other properties for customizing final value annotations
+ - that allow changing opacity of series fill (e.g. Area chart)
+ - that allows changing thickness of markers
- Added new properties in Category Chart, Financial Chart, Data Chart, and Geographic Map:
- - `MarkerAutomaticBehavior` that allows which marker type is assigned to multiple series in the same chart
- - `LegendItemBadgeShape` for setting badge shape of all series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on all series in a legend
+ - that allows which marker type is assigned to multiple series in the same chart
+ - for setting badge shape of all series represented in a legend
+ - for setting badge complexity on all series in a legend
- Added new properties in Series in Data Chart and Geographic Map:
- - `LegendItemBadgeShape` for setting badge shape on specific series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on specific series in a legend
+ - for setting badge shape on specific series represented in a legend
+ - for setting badge complexity on specific series in a legend
- Changed default vertical crosshair line stroke from #000000 to #BBBBBB in category chart and series
-- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's `MarkerAutomaticBehavior` property to `SmartIndexed` enum value
-- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's `LegendItemBadgeMode` property to `MatchSeries` enum value
+- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's property to `SmartIndexed` enum value
+- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's property to `MatchSeries` enum value
- Changed color palette of series and markers displayed in all charts to improve accessibility
| Old brushes/outlines | New outline/brushes |
@@ -860,10 +862,10 @@ This release introduces a few improvements and simplifications to visual design
- `DataGrid`:
- Added `EditOnKeyPress` aka Excel-style Editing, instantly begin editing when typing.
- - Added `EditModeClickAction` property - By default double-clicking is required to enter edit mode. This can be set to `SingleClick` to allow for edit mode to occur when selecting a new cell.
- - Added `EnterKeyBehaviors` property - aka Excel-style Navigation (Enter Behavior) – controls the behavior of the enter key, e.g. Options are (none, edit, move up, down, left, right)
- - Added `EnterKeyBehaviorAfterEdit` property - While in edit-mode, this property controls when enter is pressed, e.g. Options are (moves to the cell below, above, right, left)
- - Added `SelectAllRows` - method.
+ - Added property - By default double-clicking is required to enter edit mode. This can be set to to allow for edit mode to occur when selecting a new cell.
+ - Added property - aka Excel-style Navigation (Enter Behavior) – controls the behavior of the enter key, e.g. Options are (none, edit, move up, down, left, right)
+ - Added property - While in edit-mode, this property controls when enter is pressed, e.g. Options are (moves to the cell below, above, right, left)
+ - Added - method.
- Added Row Range Selection - With `GridSelectionMode` property set to MultipleRow the following new functionality is now included:
- Click and drag to select rows
- SHIFT and click to select multiple rows.
@@ -874,15 +876,15 @@ This release introduces a few improvements and simplifications to visual design
### {PackageCharts}
- Date Picker:
- - `ShowTodayButton` - Toggles Today button visibility
- - `Label` - Adds a label above the date value
- - `Placeholder` property - adds custom text when no value is selected
- - `FormatString` - Customize input date string e.g. (`yyyy-MM-dd`)
- - `DateFormat` - Specifies whether to display selected dates as LongDate or ShortDate
- - `FirstDayOfWeek` - Specifies first day of week
- - `FirstWeekOfYear` - Specifies when to display first week of the year, e.g. (First Full Week, First Four day Week)
- - `ShowWeekNumbers` - Toggles Week number visibility
- - `MinDate` & `MaxDate` - Date limits, specifying a range of available selectable dates.
+ - - Toggles Today button visibility
+ - - Adds a label above the date value
+ - property - adds custom text when no value is selected
+ - - Customize input date string e.g. (`yyyy-MM-dd`)
+ - - Specifies whether to display selected dates as LongDate or ShortDate
+ - - Specifies first day of week
+ - - Specifies when to display first week of the year, e.g. (First Full Week, First Four day Week)
+ - - Toggles Week number visibility
+ - & - Date limits, specifying a range of available selectable dates.
- Added Accessibility
@@ -900,30 +902,30 @@ These features are CTP
### {PackageCharts}
-This release introduces several new and improved visual design and configuration options for all of the chart components, e.g. `DataChart`, `CategoryChart`, and `FinancialChart`.
+This release introduces several new and improved visual design and configuration options for all of the chart components, e.g. , , and .
- Changed Bar/Column/Waterfall series to have square corners instead of rounded corners
- Changed Scatter High Density series’ colors for heat min property from #8a5bb1 to #000000
- Changed Scatter High Density series’ colors for heat max property from #ee5879 to #ee5879
- Changed Financial/Waterfall series’ `NegativeBrush` and `NegativeOutline` properties from #C62828 to #ee5879
- Changed marker's thickness to 2px from 1px
-- Changed marker's fill to match the marker's outline for `PointSeries`, `BubbleSeries`, `ScatterSeries`, `PolarScatterSeries`. You can use set `MarkerFillMode` property to Normal to undo this change
-- Compressed labelling for the `TimeXAxis` and `OrdinalTimeXAxis`
+- Changed marker's fill to match the marker's outline for , , , . You can use set property to Normal to undo this change
+- Compressed labelling for the and
- New Marker Properties:
- - series.`MarkerFillMode` - Can be set to `MatchMarkerOutline` so the marker depends on the outline
- - series.`MarkerFillOpacity` - Can be set to a value 0 to 1
- - series.`MarkerOutlineMode` - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
+ - series. - Can be set to `MatchMarkerOutline` so the marker depends on the outline
+ - series. - Can be set to a value 0 to 1
+ - series. - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
- New Series Property:
- - series.`OutlineMode` - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
-- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the `ComputedPlotAreaMarginMode`, listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
- - chart.`PlotAreaMarginLeft`
- - chart.`PlotAreaMarginTop`
- - chart.`PlotAreaMarginRight`
- - chart.`PlotAreaMarginBottom`
- - chart.`ComputedPlotAreaMarginMode`
+ - series. - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
+- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the , listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
+ - chart.
+ - chart.
+ - chart.
+ - chart.
+ - chart.
- New Highlighting Properties
- - chart.`HighlightingMode` - Sets whether hovered or non-hovered series to fade, brighten
- - chart.`HighlightingBehavior` - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
+ - chart. - Sets whether hovered or non-hovered series to fade, brighten
+ - chart. - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
- Note, in previous releases the highlighting was limited to fade on hover.
- Added Highlighting Stacked, Scatter, Polar, Radial, and Shape series:
- Added Annotation layers to Stacked, Scatter, Polar, Radial, and Shape series:
@@ -946,8 +948,8 @@ for example:
#### Chart Legend
-- Added horizontal `Orientation` property to ItemLegend that can be used with Bubble, Donut, and Pie Chart
-- Added `LegendHighlightingMode` property - Enables series highlighting when hovering over legend items
+- Added horizontal property to ItemLegend that can be used with Bubble, Donut, and Pie Chart
+- Added property - Enables series highlighting when hovering over legend items
## **{PackageVerChangedFields}**
@@ -1113,44 +1115,44 @@ import { IgcLiveGridComponent } from 'igniteui-webcomponents-data-grids/ES5/igc-
### **{PackageCommonVerChanges-5.0.0}**
-- `Icon`
+-
- Added `setIconRef` method. This allows to register and replace icons by SVG files.
- All components now use icons by reference internally so that it's easy to replace them without explicitly providing custom templates.
-- `RadioGroup`
+-
- Added `name` and `value` properties.
**Breaking Changes**
-- Removed `Form` component. Use native form instead.
+- Removed component. Use native form instead.
- Removed `size` property in favor of the `--ig-size` CSS custom property for the following components:
- - `Avatar`, `Button`,`IconButton`, `Calendar`, `Chip`, `Dropdown`, `Icon`, `Input`, `List`, `Rating`, `Snackbar`, `Tabs`, `Tree`
+ - , ,, , , , , , , , , ,
- Removed custom `igcFocus` and `igcBlur` events. Use the native `focus` and `blur` events instead for the following components:
- - `Button`, `IconButton`, `Checkbox`, `Switch`, `Combo`, `DateTimeInput`, `Input`, `MaskInput`, `Radio`, **IgcSelectComponent**, `Textarea`
-- `Checkbox`, `Switch` ,`Radio`
+ - , , , , , , , , , **IgcSelectComponent**,
+- , ,
- Changed `igcChange` event arguments from `CustomEvent` to `CustomEvent<{ checked: boolean; value: string | undefined }>`
-- `Combo`, **IgcSelectComponent**
+- , **IgcSelectComponent**
- Removed `positionStrategy`, `flip`, `sameWidth` properties.
-- `Dialog`
+-
- Renamed The `closeOnEscape` property to `keepOpenOnEscape`.
-- `Dropdown`
+-
- Removed `positionStrategy` property.
-- `Input`
+-
- Removed `maxlength` and `minlength` properties. Use the native `maxLength` and `minLength` properties or `max` and `min` instead.
- Renamed `readonly` and `inputmode` properties to `readOnly` and `inputMode`.
-- `RangeSlider`
+-
- Renamed `ariaThumbLower`/`ariaThumbUpper` properties to `thumbLabelLower`/`thumbLabelUpper`.
-- `Rating`
+-
- Renamed `readonly` property to `readOnly`.
### **{PackageCommonVerChanges-4.11.1}**
#### Changed
-- `Stepper` - Design changes in vertical mode.
+- - Design changes in vertical mode.
### **{PackageCommonVerChanges-4.11.0}**
#### Changed
-- `Toast`, `Rating`, `Stepper` - Styling changes in Indigo Theme.
+- , , - Styling changes in Indigo Theme.
### **{PackageCommonVerChanges-4.10.0}**
@@ -1158,117 +1160,117 @@ import { IgcLiveGridComponent } from 'igniteui-webcomponents-data-grids/ES5/igc-
- New [Banner](notifications/banner.md) component
- New [Divider](layouts/divider.md) component
- New [DatePicker](scheduling/date-picker.md) component
-- `RadioGroup` - Bind underlying radio components name and checked state through the radio group.
+- - Bind underlying radio components name and checked state through the radio group.
#### Deprecated
-- `Input` `Inputmode` property. Aligned with the native `inputMode` DOM property instead.
+- `Inputmode` property. Aligned with the native `inputMode` DOM property instead.
#### Fixed
-- `Input`, `Textarea` - passing `undefined` to value sets the underlying input value to undefined.
-- `MaskInput` - after a form `reset` call correctly update underlying input value and placeholder state.
-- `Tree` - setting `--ig-size` on the item `indicator` CSS Part will now change the size of the icon.
-- `DateTimeInput` - double emit of `igcChange` in certain scenarios.
-- `NavDrawer` - mini variant is not initially rendered when not in an open state.
-- `Combo`:
+- , - passing `undefined` to value sets the underlying input value to undefined.
+- - after a form `reset` call correctly update underlying input value and placeholder state.
+- - setting `--ig-size` on the item `indicator` CSS Part will now change the size of the icon.
+- - double emit of `igcChange` in certain scenarios.
+- - mini variant is not initially rendered when not in an open state.
+- :
- Selecting an entry using the ENTER key now correctly works in single selection mode.
- - Turning on the `DisableFiltering` option now clears any previously entered search term.
+ - Turning on the option now clears any previously entered search term.
- Entering a search term in single selection mode that already matches the selected item now works correctly.
### **{PackageCommonVerChanges-4.9.0}**
#### Added
-- `ButtonGroup` - now allows resetting the selection state via the `SelectedItems` property.
-- `Input`, `Textarea` - exposed `ValidateOnly` to enable validation rules being enforced without restricting user input.
+- - now allows resetting the selection state via the property.
+- , - exposed to enable validation rules being enforced without restricting user input.
#### Changed
-- `Combo`, `Select` and `Dropdown` - now use the native `Popover` API.
+- , and - now use the native `Popover` API.
#### Deprecated
-- `Dropdown` - `PositionStrategy` property is deprecated. The dropdown now uses the `Popover` API to render its container in the top layer of the browser viewport, making the property obsolete.
+- - property is deprecated. The dropdown now uses the `Popover` API to render its container in the top layer of the browser viewport, making the property obsolete.
#### Fixed
-- `DateTimeInput` - Label in Material theme is broken when component is in read-only mode.
+- - Label in Material theme is broken when component is in read-only mode.
### **{PackageCommonVerChanges-4.8.2}**
#### Fixed
-- `Textarea` - resize handle position for non-suffixed textarea.
-- `Tabs` - error when dynamically creating and adding a tab group and tabs in a single call stack.
-- `Checkbox`/`Switch` - participate in form submission when initially checked.
-- `Dialog` - `igcClosed` fired before the component was actually closed/hidden.
+- - resize handle position for non-suffixed textarea.
+- - error when dynamically creating and adding a tab group and tabs in a single call stack.
+- / - participate in form submission when initially checked.
+- - `igcClosed` fired before the component was actually closed/hidden.
### **{PackageCommonVerChanges-4.8.1}**
#### Fixed
-- `DateTimeInput` - `InputFormat` is not applied to an already set value.
-- `Checkbox`, `Radio`, `Switch` - apply form validation synchronously.
-- `Select`, `Dropdown` - Unable to select item when clicking on a wrapping element inside the dropdown/select item slot.
-- `Tree` - active state is correctly applied to the correct tree node on click.
+- - is not applied to an already set value.
+- , , - apply form validation synchronously.
+- , - Unable to select item when clicking on a wrapping element inside the dropdown/select item slot.
+- - active state is correctly applied to the correct tree node on click.
### **{PackageCommonVerChanges-4.8.0}**
#### Added
-- `Combo` can now set `GroupSorting` to none which shows the groups in the order of the provided data.
-- `Button`/`IconButton` - updated visual looks across themes, new states.
+- can now set to none which shows the groups in the order of the provided data.
+- / - updated visual looks across themes, new states.
- `NavBar` - added border in Bootstrap theme.
#### Changed
-- Grouping in `Combo` no longer sorts the data. `GroupSorting` property now affects the sorting direction only of the groups. **Behavioral change**: In previous release the sorting directions of the groups sorted the items as well. If you want to achieve this behavior you can pass already sorted data to the `Combo`.
+- Grouping in no longer sorts the data. property now affects the sorting direction only of the groups. **Behavioral change**: In previous release the sorting directions of the groups sorted the items as well. If you want to achieve this behavior you can pass already sorted data to the .
#### Deprecated
-- `Slider` - `aria-label-upper` and `aria-label-lower` are deprecated and will be removed in the next major release. Use `thumb-label-upper` and `thumb-label-lower` instead.
+- - `aria-label-upper` and `aria-label-lower` are deprecated and will be removed in the next major release. Use `thumb-label-upper` and `thumb-label-lower` instead.
#### Fixed
-- `Button` - Slotted icon size.
-- `ButtonGroup`
+- - Slotted icon size.
+-
- Updated Fluent theme look.
- Disabled state in Safari.
-- `Combo`/`Select` - Style issues.
-- `Slider`
+- / - Style issues.
+-
- Clicks on the slider track now use the track element width as a basis for the calculation.
- Input events are no longer emitted while continuously dragging the slider thumb and exceeding upper/lower bounds.
- When setting `upper-bound`/`lower-bound` before `min`/`max`, the slider will no longer overwrite the bound properties with the previous values of `min`/`max`.
- The `aria-label` bound to the slider thumb is no longer reset on consequent renders.
-- `Input`
+-
- Default validators are run synchronously.
- Style issues.
-- `DateTimeInput` - `setRangeText()` updates underlying value.
+- - `setRangeText()` updates underlying value.
### **{PackageCommonVerChanges-4.7.0}**
#### Added
-- `Tree` - Added `ToggleNodeOnClick` property that determines whether clicking over a node will change its expanded state or not. Defaults to `false`.
+- - Added property that determines whether clicking over a node will change its expanded state or not. Defaults to `false`.
-- `Rating` - `AllowReset` added. When enabled selecting the same value will reset the component. **Behavioral change**: In previous releases this was the default behavior of the rating component. Make sure to set `allowReset` if you need to keep this behavior in your application.
+- - added. When enabled selecting the same value will reset the component. **Behavioral change**: In previous releases this was the default behavior of the rating component. Make sure to set `allowReset` if you need to keep this behavior in your application.
#### Changed
-- Improved WAI-ARIA compliance for `Avatar`, `Badge` and `Combo`.
+- Improved WAI-ARIA compliance for , and .
#### Fixed
-- Active item visual styles for `Dropdown`, `Select` and `Combo`.
-- `NavDrawer` - mini variant broken visual style.
+- Active item visual styles for , and .
+- - mini variant broken visual style.
### **{PackageCommonVerChanges-4.6.0}**
#### Added
-- `action` slot added to `Snackbar`.
-- `indicator-expanded` slot added to `ExpansionPanel`.
-- `toggle-icon-expanded` slot added to `Select`.
-- `Select`, `Dropdown` - exposed `selectedItem`, `items` and `groups` getters.
+- `action` slot added to .
+- `indicator-expanded` slot added to .
+- `toggle-icon-expanded` slot added to .
+- , - exposed `selectedItem`, `items` and `groups` getters.
#### Changed
- Updated the package to Lit v3.
- Components dark variants are now bound to their shadow root.
- Components implement default sizes based on current theme.
-- `ButtonGroup` - changed events to non-cancellable.
+- - changed events to non-cancellable.
- Optimized components CSS and reduced bundle size.
-- WAI-ARIA improvements for `Icon`, `Select`, `Dropdown` and `List`.
+- WAI-ARIA improvements for , , and .
#### Fixed
-- `Textarea` missing styling parts.
-- `TreeItem` disabled styles.
-- `Snackbar` removed unnecessary styles.
-- `TreeItem` hover state visual design.
-- `Calendar` not keeping focus state when switching views.
+- missing styling parts.
+- disabled styles.
+- removed unnecessary styles.
+- hover state visual design.
+- not keeping focus state when switching views.
### **{PackageCommonVerChanges-4.5.0}**
@@ -1276,13 +1278,13 @@ import { IgcLiveGridComponent } from 'igniteui-webcomponents-data-grids/ES5/igc-
- New [Text Area](inputs/text-area.md) component.
- New [Button Group](inputs/button-group.md) component.
-- New `ToggleButton`.
-- `NavDrawer` now supports CSS transitions.
-- Position attribute for `Toast` and `Snackbar`.
+- New .
+- now supports CSS transitions.
+- Position attribute for and .
#### Deprecated
-The `size` property and attribute have been deprecated for all components. Use the `--ig-size` CSS custom property instead. The following example sets the size of the `Avatar` component to small:
+The `size` property and attribute have been deprecated for all components. Use the `--ig-size` CSS custom property instead. The following example sets the size of the component to small:
```css
igc-avatar {
@@ -1302,83 +1304,83 @@ igc-avatar {
#### Added
- The following components are now Form Associated Custom Elements. They are automatically associated with a parent `
#### Deprecated
-- `Select`: Deprecated `sameWidth`, `positionStrategy` and `flip`. They will be removed in the next major release.
+- : Deprecated `sameWidth`, `positionStrategy` and `flip`. They will be removed in the next major release.
#### Fixed
-- `Select`: `prefix`/`suffix`/`helper-text` slots not being rendered.
-- `Tabs`: Nested tabs selection.
-- `Dialog`: Backdrop doesn't overlay elements.
-- `Dropdown`: Listbox position on initial open state.
-- `Stepper`: Stretch vertically in parent container.
-- `Navbar`: Wrong colors in fluent theme.
+- : `prefix`/`suffix`/`helper-text` slots not being rendered.
+- : Nested tabs selection.
+- : Backdrop doesn't overlay elements.
+- : Listbox position on initial open state.
+- : Stretch vertically in parent container.
+- : Wrong colors in fluent theme.
- Animation player throws errors when height is unspecified.
-- `DateTimeInput`: Intl.DateTimeFormat issues in Chromium based browsers.
+- : Intl.DateTimeFormat issues in Chromium based browsers.
### **{PackageCommonVerChanges-4.2.3}**
#### Deprecated
-- `Dialog` - Property `closeOnEscape` is deprecated in favor of new property `keepOpenOnEscape`.
+- - Property `closeOnEscape` is deprecated in favor of new property `keepOpenOnEscape`.
#### Fixed
-- `Radio`- colors in selected focus state.
-- `IconButton` - set icon size to match other design system products.
-- `Chip` - removed outline styles for Fluent and Material themes.
-- `Calendar` - navigation to date on set value.
-- `Tabs` - not taking the full height of their parents.
+- - colors in selected focus state.
+- - set icon size to match other design system products.
+- - removed outline styles for Fluent and Material themes.
+- - navigation to date on set value.
+- - not taking the full height of their parents.
### **{PackageCommonVerChanges-4.2.2}**
#### Deprecated
-- `Button` - The `prefix`/`suffix` slots are no longer needed and will be removed in the next major release.
+- - The `prefix`/`suffix` slots are no longer needed and will be removed in the next major release.
#### Fixed
-- `Button` - UI inconsistencies.
-- `Calendar` - Fluent theme inconsistencies.
-- `Combo` - Selection via API doesn't work on a searched list.
-- `Dialog` - Fluent theme inconsistency.
-- `Input` - UI inconsistencies.
-- `Toast` - Fluent theme inconsistency.
+- - UI inconsistencies.
+- - Fluent theme inconsistencies.
+- - Selection via API doesn't work on a searched list.
+- - Fluent theme inconsistency.
+- - UI inconsistencies.
+- - Fluent theme inconsistency.
- Components missing in defineAllComponents.
-- Wrong host sizes for `Avatar`, `Badge`, `Button` and `IconButton`.
+- Wrong host sizes for , , and .
### **{PackageCommonVerChanges-4.2.1}**
#### Fixed
-- `Combo` - Matching item not activated on filtering in single selection mode.
+- - Matching item not activated on filtering in single selection mode.
### **{PackageCommonVerChanges-4.2.0}**
#### Added
-- `Combo` - Single Selection mode via the `single-select` attribute.
+- - Single Selection mode via the `single-select` attribute.
#### Fixed
-- `Input` - UI inconsistencies.
-- `Badge` - Doesn't correctly render `igc-icon` and font icons.
-- `Radio` - UI inconsistencies.
-- `NavDrawer` - Can't override item margin.
+- - UI inconsistencies.
+- - Doesn't correctly render `igc-icon` and font icons.
+- - UI inconsistencies.
+- - Can't override item margin.
### **{PackageCommonVerChanges-4.1.1}**
#### Fixed
-- `Input`
+-
- position label based on component size.
- material themes don't match design.
- do not cache the underlying input.
@@ -1471,10 +1473,10 @@ interface IgcComboChangeEventArgs {
#### Added
- New [Stepper](layouts/stepper.md) component.
- New [Combo](inputs/combo/overview.md) component.
-- `MaskInput` - Skip literal positions when deleting symbols in the component
+- - Skip literal positions when deleting symbols in the component
#### Fixed
-- `MaskInput` - Validation state on user input.
+- - Validation state on user input.
### **{PackageCommonVerChanges-4.0.0}**
@@ -1493,11 +1495,11 @@ interface IgcComboChangeEventArgs {
### **{PackageCommonVerChanges-3.4.1}**
#### Changed
-- `Slider` - updated theme with the latest fluent spec.
-- `Calendar` - updated weekend days color.
+- - updated theme with the latest fluent spec.
+- - updated weekend days color.
#### Fixed
-- `Tabs` `selected` attribute breaks content visibility on init.
+- `selected` attribute breaks content visibility on init.
### **{PackageCommonVerChanges-3.4.0}**
@@ -1506,22 +1508,22 @@ interface IgcComboChangeEventArgs {
- New [Select](inputs/select.md) component.
#### Fixed
-- `Calendar` - range selection a11y improvements.
-- `RangeSlider` - a11y improvements for choosing range values.
-- `Rating` - improved a11y with assistive software now reading the total number of items.
-- `Toast` - added `role="alert"` to the message container for assistive software to read it without the need of focusing.
-- `Chip` - made remove button accessible with the keyboard.
-- `Button` `prefix`/`suffix` does not align icons to the button text.
+- - range selection a11y improvements.
+- - a11y improvements for choosing range values.
+- - improved a11y with assistive software now reading the total number of items.
+- - added `role="alert"` to the message container for assistive software to read it without the need of focusing.
+- - made remove button accessible with the keyboard.
+- `prefix`/`suffix` does not align icons to the button text.
### **{PackageCommonVerChanges-3.3.1}**
#### Changed
-- `Tree` - Removed theme-specified height.
+- - Removed theme-specified height.
#### Fixed
-- `Dropdown` - Dispose of top-level event listeners.
-- `LinearProgress` - Indeterminate animation in Safari.
-- `RadioGroup` - Child radio components auto-registration.
+- - Dispose of top-level event listeners.
+- - Indeterminate animation in Safari.
+- - Child radio components auto-registration.
### **{PackageCommonVerChanges-3.3.0}**
@@ -1532,8 +1534,8 @@ interface IgcComboChangeEventArgs {
- Typography styles in themes.
#### Changed
-- `Rating` - Added support for single selection and empty symbols.
-- `Slider` - Improved slider steps rendering.
+- - Added support for single selection and empty symbols.
+- - Improved slider steps rendering.
- Components will now auto register their dependencies when they are registered in `defineComponents`
@@ -1551,11 +1553,11 @@ Check the official [documentation](https://www.infragistics.com/products/ignite-
#### Fixed
- Remove input helper text container when it is empty.
-- `Icon` not showing in Safari.
-- `Checkbox` not showing in Safari.
-- `Button` stretches correctly in flex containers.
+- not showing in Safari.
+- not showing in Safari.
+- stretches correctly in flex containers.
- Various theming issues.
-- `Dropdown` - bug fixes and improvements.
+- - bug fixes and improvements.
### **{PackageCommonVerChanges-3.2.0}**
@@ -1563,27 +1565,27 @@ Check the official [documentation](https://www.infragistics.com/products/ignite-
- New [MaskInput](inputs/mask-input.md) component.
- New [ExpansionPanel](layouts/expansion-panel.md) component.
- New [Tree](grids/tree.md) component.
-- `Rating` - Added `selected` CSS part and exposed CSS variable to control symbol sizes.
-- `IconButton` - Allow slotted content.
+- - Added `selected` CSS part and exposed CSS variable to control symbol sizes.
+- - Allow slotted content.
#### Fixed
-- `NavDrawer` - Various styles fixes.
+- - Various styles fixes.
- Buttons - Vertical align and focus management.
-- `Input` - Overflow for `suffix`/`prefix`.
-- `Switch` - Collapse with small sizes.
-- `List` - Overflow behavior.
+- - Overflow for `suffix`/`prefix`.
+- - Collapse with small sizes.
+- - Overflow behavior.
### **{PackageCommonVerChanges-3.1.0}**
#### Added
-- `Chip`: Added `prefix` and `suffix` slots.
-- `Snackbar`: Added `toggle` method.
+- : Added `prefix` and `suffix` slots.
+- : Added `toggle` method.
#### Deprecated
-- `Chip`: Previously exposed `start` and `end` slots are replaced by `prefix` and `suffix`. They remain active, but are now deprecated and will be removed in a future version.
+- : Previously exposed `start` and `end` slots are replaced by `prefix` and `suffix`. They remain active, but are now deprecated and will be removed in a future version.
#### Fixed
-- `Chip`:
+- :
- Auto load internal icons.
- Selected chip is misaligned.
- Package: ESM internal import paths.
@@ -1597,7 +1599,7 @@ Check the official [documentation](https://www.infragistics.com/products/ignite-
#### Added
- New [DropDown](inputs/dropdown.md) component.
-- `Calendar`: Active date can be set via an attribute.
+- : Active date can be set via an attribute.
### **{PackageCommonVerChanges-2.1.1}**
@@ -1631,16 +1633,16 @@ Example:
- Dark Themes
- New [Slider](inputs/slider.md) component.
- New [RangeSlider](inputs/slider.md) component.
-- Support `required` property in `Radio` component.
+- Support `required` property in component.
#### Changed
- Fix checkbox/switch validity status
-- Split `Calendar`'s `value: Date | Date[]` property into two properties - `value: Date` and `values: Date[]`
-- Replaced `Calendar`'s `hasHeader` property & `has-header` attribute with `hideHeader` & `hide-header` respectively.
-- Replaced `Card`'s `outlined` property with `elevated`.
+- Split 's `value: Date | Date[]` property into two properties - `value: Date` and `values: Date[]`
+- Replaced 's `hasHeader` property & `has-header` attribute with `hideHeader` & `hide-header` respectively.
+- Replaced 's `outlined` property with `elevated`.
#### Removed
-- Removed `igcOpening`, `igcOpened`, `igcClosing` and `igcClosed` events from `NavDrawer` component.
+- Removed `igcOpening`, `igcOpened`, `igcClosing` and `igcClosed` events from component.
### **{PackageCommonVerChanges-1.0.0}**
@@ -1673,7 +1675,7 @@ Initial release of Ignite UI Web Components
### **{PackageDockManagerVerChanges-1.14.4}**
#### Deprecated
-- `SplitPane` `IsMaximized` is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the `IsMaximized` property of `TabGroupPane` and/or `ContentPane` instead.
+- is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the property of and/or instead.
### **{PackageDockManagerVerChanges-1.14.3}**
@@ -1704,13 +1706,13 @@ Initial release of Ignite UI Web Components
#### Fixed
- Maximizing and unpinning panes leads to unclickable panes.
-- Center dock is possible in a pane that has `AcceptsInnerDock` set to **true** if the `AllowInnerDock` of `DockManager` is set to **false**.
+- Center dock is possible in a pane that has set to **true** if the of is set to **false**.
### **{PackageDockManagerVerChanges-1.13.0}**
#### New features
-- Add `FocusPane` method.
-- Add `AllowInnerDock` and `AcceptsInnerDock` properties.
+- Add method.
+- Add and properties.
#### Enhancements
- Save pane maximized state in layout.
@@ -1752,7 +1754,7 @@ Initial release of Ignite UI Web Components
#### Enhancements
- Include pane information in `splitterResizeStart` and `splitterResizeEnd` events.
-- `DockManager` is now exported as class.
+- is now exported as class.
#### Fixed
- Contents in slots with `unpinnedHeaderId` are not updated correctly.
@@ -1786,7 +1788,7 @@ Initial release of Ignite UI Web Components
### **{PackageDockManagerVerChanges-1.11.0}**
#### New features
-- Add options for `ShowHeaderIconOnHover` property for different buttons
+- Add options for property for different buttons
- Add `horizontal` and `vertical` options for `splitter-handle` CSS part
- Add `header-title` CSS part
- Add `hover` option for `tab-header-close-button` CSS part in active/inactive states
@@ -1795,7 +1797,7 @@ Initial release of Ignite UI Web Components
### **{PackageDockManagerVerChanges-1.10.0}**
#### New features
-- Add `ShowHeaderIconOnHover` property.
+- Add property.
#### Fixed
- Active pane is not retained on float/dock.
@@ -1819,10 +1821,10 @@ Initial release of Ignite UI Web Components
#### New features
- Customizable floating pane header.
-- `Disabled` property per pane.
-- `DocumentOnly` property which allows content pane to be docked only inside a document host.
-- `AllowEmpty` property for split and tab group panes which allows displaying empty areas.
-- `DisableKeyboardNavigation` property on the dock manager.
+- property per pane.
+- property which allows content pane to be docked only inside a document host.
+- property for split and tab group panes which allows displaying empty areas.
+- property on the dock manager.
#### Fixed
- Docking indicators appear over the currently dragged floating pane.
@@ -1838,7 +1840,7 @@ Initial release of Ignite UI Web Components
### **{PackageDockManagerVerChanges-1.5.0}**
#### New features
-- `AllowMaximize` property per pane.
+- property per pane.
#### Fixed
- Unpinned pane is closing automatically upon clicking on its content.
diff --git a/docs/xplat/src/content/en/components/general-changelog-dv.mdx b/docs/xplat/src/content/en/components/general-changelog-dv.mdx
index d337bbfa38..ebd5da3abc 100644
--- a/docs/xplat/src/content/en/components/general-changelog-dv.mdx
+++ b/docs/xplat/src/content/en/components/general-changelog-dv.mdx
@@ -16,6 +16,8 @@ import chartdefaults3 from '@xplat-images/chartDefaults3.png';
import chartdefaults4 from '@xplat-images/chartDefaults4.png';
import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# {ProductName} Changelog
All notable changes for each version of {ProductName} are documented on this page.
@@ -77,9 +79,9 @@ Added OthersCategoryBrush and OthersCategoryOutline to DataPieChart and Proporti
#### User Annotations
-In {ProductName}, you can now annotate the `DataChart` with slice, strip, and point annotations at runtime using the new user annotations feature. This allows the end user to add more details to the plot such as calling out single important events such as company quarter reports by using the slice annotation or events that have a duration by using the strip annotation. You can also call out individual points on the plotted series by using the point annotation or any combination of these three.
+In {ProductName}, you can now annotate the with slice, strip, and point annotations at runtime using the new user annotations feature. This allows the end user to add more details to the plot such as calling out single important events such as company quarter reports by using the slice annotation or events that have a duration by using the strip annotation. You can also call out individual points on the plotted series by using the point annotation or any combination of these three.
-This is directly integrated with the available tools of the `Toolbar`.
+This is directly integrated with the available tools of the .
@@ -87,8 +89,8 @@ This is directly integrated with the available tools of the `Toolbar`.
Ability for axis annotations to automatically detect collisions and truncate to fit better. To enable this feature you must set the following properties:
-- `ShouldAvoidAnnotationCollisions`
-- `ShouldAutoTruncateAnnotations`
+-
+-
### {PackageMaps} (Geographic Map)
@@ -130,37 +132,37 @@ The following events have been added to the `IgxDataChart` to allow you to detec
#### Companion Axis
-Added `CompanionAxis` properties to the X and Y axis that allow you to quickly create a clone of an existing axis. When enabled using the `CompanionAxisEnabled` property, this will default the cloned axis to the opposite position of the chart and you can then configure that axes' properties.
+Added `CompanionAxis` properties to the X and Y axis that allow you to quickly create a clone of an existing axis. When enabled using the property, this will default the cloned axis to the opposite position of the chart and you can then configure that axes' properties.
#### RadialPieSeries Inset Outlines
-There is a new property called `UseInsetOutlines` to control how outlines on the `RadialPieSeries` are rendered. Setting this value to **true** will inset the outlines within the slice shape, whereas a **false** (default) value will place the outlines half-in half-out along the edge of the slice shape.
+There is a new property called to control how outlines on the are rendered. Setting this value to **true** will inset the outlines within the slice shape, whereas a **false** (default) value will place the outlines half-in half-out along the edge of the slice shape.
**Breaking Changes**
-- A fix was made due to an issue where the `PlotAreaPosition` and `ChartPosition` properties on `ChartMouseEventArgs` class were reversed. This will change the values that `PlotAreaPosition` and `ChartPosition` return.
+- A fix was made due to an issue where the and properties on class were reversed. This will change the values that and return.
### Enhancements
#### IgxBulletGraph
-- Added new `LabelsVisible` property
+- Added new property
#### Charts
- New properties added to the DataToolTipLayer, ItemToolTipLayer, and CategoryToolTipLayer to aid in styling: `ToolTipBackground`, `ToolTipBorderBrush`, and `ToolTipBorderThickness`
-- New properties added to the DataLegend to aid in styling: `ContentBackground`, `ContentBorderBrush`, and `ContentBorderThickness`. The `ContentBorderBrush` and `ContentBorderThickness` default to transparent and 0 respectively, so in order to see these borders, you will need to set these properties.
+- New properties added to the DataLegend to aid in styling: , , and . The and default to transparent and 0 respectively, so in order to see these borders, you will need to set these properties.
-- Added a new property to `ChartMouseEventArgs` called `WorldPosition` that provides the world relative position of the mouse. This position will be a value between 0 and 1 for both the X and Y axis within the axis space.
+- Added a new property to called that provides the world relative position of the mouse. This position will be a value between 0 and 1 for both the X and Y axis within the axis space.
-- Added `HighlightingFadeOpacity` to `SeriesViewer` and `DomainChart`. This allows you to configure the opacity applied to highlighted series.
+- Added to and . This allows you to configure the opacity applied to highlighted series.
- Expose `CalloutLabelUpdating` event for domain charts.
#### IgxLinearGauge
-- Added new `LabelsVisible` property
+- Added new property
### Bug Fixes
@@ -210,11 +212,11 @@ For more details please visit:
- Data Annotation Slice Layer
- Data Annotation Strip Layer
-- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose `LayoutMode` property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
+- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
-- The `DefaultInteraction` property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
+- The property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
-- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an `OverlayText` property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
+- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
- [Trendline Layer](charts/features/chart-trendlines.md) series type that allows you to apply a single trend line per trend line layer to a particular series. This allows the usage of multiple trend lines on a single series since you can have multiple [TrendlineLayer](charts/features/chart-overlays.md) series types in the chart.
@@ -251,9 +253,9 @@ For more details please visit:
#### Toolbar
-- Added new `GroupHeaderTextStyle` property to `Toolbar` and `ToolPanel`. If set, it will apply to all `ToolActionGroupHeader` actions.
-- Added new property on `ToolAction` called `TitleHorizontalAlignment` which controls the horizontal alignment of the title text.
-- Added new property on `ToolActionSubPanel` called `ItemSpacing` which controls the spacing between items inside the panel.
+- Added new `GroupHeaderTextStyle` property to and . If set, it will apply to all actions.
+- Added new property on called which controls the horizontal alignment of the title text.
+- Added new property on called which controls the spacing between items inside the panel.
### Bug Fixes
@@ -291,11 +293,11 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
## **{PackageVerChanges-24-1-SEP}**
-- [Data Pie Chart](charts/types/data-pie-chart.md) - The `DataPieChart` is a new component that renders a pie chart. This component works similarly to the `CategoryChart`, in that it will automatically detect the properties on your underlying data model while allowing selection, highlighting, animation and legend support via the ItemLegend component.
+- [Data Pie Chart](charts/types/data-pie-chart.md) - The is a new component that renders a pie chart. This component works similarly to the , in that it will automatically detect the properties on your underlying data model while allowing selection, highlighting, animation and legend support via the ItemLegend component.
-- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `DataChart`, to plot slices similar to a pie chart, a type of data visualization where data points are represented as segments within a circular graph.
+- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the , to plot slices similar to a pie chart, a type of data visualization where data points are represented as segments within a circular graph.
-- `Toolbar`
+-
- New ToolActionCheckboxList
A new CheckboxList ToolAction that displays a collection of items with checkboxes for selecting. A grid inside ToolAction CheckboxList grows in height up to 5 items, then a scrollbar is displayed.
@@ -314,67 +316,67 @@ The following table lists the bug fixes made for the {ProductName} toolset for t
### {PackageCharts} (Charts)
-- [Data Legend Grouping](charts/features/chart-data-legend.md#{PlatformLower}-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#{PlatformLower}-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property `GroupRowVisible` toggles grouping with each series opting in can assign group text via the `DataLegendGroup` property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users.
+- [Data Legend Grouping](charts/features/chart-data-legend.md#{PlatformLower}-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#{PlatformLower}-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property toggles grouping with each series opting in can assign group text via the property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users.
-- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for `CategoryChart` and `DataChart`. Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and `SelectedSeriesItems` are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
+- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for and . Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
-- [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a `HighlightingMode` property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the `HighlightingTransitionDuration` property.
+- [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the property.
-- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new `HighlightedItemsSource`. Can be toggled via `HighlightedValuesDisplayMode` and styled via `FillBrushes`.
+- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new . Can be toggled via and styled via `FillBrushes`.
-- `Toolbar` - New `IsHighlighted` option for ToolAction for outlining a border around specific tools of choice.
+- - New option for ToolAction for outlining a border around specific tools of choice.
### {PackageGauges} (Gauges)
-- `RadialGauge`
- - New label for the highlight needle. `HighlightLabelText` and `HighlightLabelSnapsToNeedlePivot` and many other styling related properties for the HighlightLabel were added.
+-
+ - New label for the highlight needle. and and many other styling related properties for the HighlightLabel were added.
## **{PackageVerChanges-23-2-MAR}**
### {PackageCharts}
-- New Data Filtering via the `InitialFilter` property. Apply filter expressions to filter the chart data to a subset of records. Can be used for drill down large data.
+- New Data Filtering via the property. Apply filter expressions to filter the chart data to a subset of records. Can be used for drill down large data.
- `RadialChart`
- New Label Mode
- The `CategoryAngleAxis` for the now exposes a `LabelMode` property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
+ The for the now exposes a property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
### {PackageGauges}
-- `RadialGauge`
- - New title/subtitle properties. `TitleText`, `SubtitleText` will appear near the bottom the gauge. In addition, the various title/subtitle font properties were added such as `TitleFontSize`, `TitleFontFamily`, `TitleFontStyle`, `TitleFontWeight` and `TitleExtent`. Finally, the new `TitleDisplaysValue` will allow the value to correspond with the needle's position.
- - New `OpticalScalingEnabled` and `OpticalScalingSize` properties for the `RadialGauge`. This new feature will manage the size at which labels, titles, and subtitles of the gauge have 100% optical scaling. You can read more about this new feature in this [topic](radial-gauge.md#optical-scaling)
- - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
-- `LinearGauge`
- - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
-- `BulletGraph`
- - The Performance bar will now reflect a difference between the value and new `HighlightValue` when the `HighlightValueDisplayMode` is applied to the 'Overlay' setting. The highlight value will show a filtered/subset completed measured percentage as a filled in color while the remaining bar's appearance will appear faded to the assigned value, illustrating the performance in real-time.
+-
+ - New title/subtitle properties. , will appear near the bottom the gauge. In addition, the various title/subtitle font properties were added such as `TitleFontSize`, `TitleFontFamily`, `TitleFontStyle`, `TitleFontWeight` and . Finally, the new will allow the value to correspond with the needle's position.
+ - New and properties for the . This new feature will manage the size at which labels, titles, and subtitles of the gauge have 100% optical scaling. You can read more about this new feature in this [topic](radial-gauge.md#optical-scaling)
+ - New highlight needle was added. and when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
+-
+ - New highlight needle was added. and when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
+-
+ - The Performance bar will now reflect a difference between the value and new when the is applied to the 'Overlay' setting. The highlight value will show a filtered/subset completed measured percentage as a filled in color while the remaining bar's appearance will appear faded to the assigned value, illustrating the performance in real-time.
## **{PackageVerChanges-23-2-JAN}**
### {PackageCharts} (Charts)
-- [Chart Highlight Filter](charts/features/chart-highlight-filter.md) - The `CategoryChart` and `DataChart` now expose a way to highlight and animate in and out of a subset of data. The display of this highlight depends on the series type. For column and area series, the subset will be shown on top of the total set of data where the subset will be colored by the actual brush of the series, and the total set will have a reduced opacity. For line series, the subset will be shown as a dotted line.
+- [Chart Highlight Filter](charts/features/chart-highlight-filter.md) - The and now expose a way to highlight and animate in and out of a subset of data. The display of this highlight depends on the series type. For column and area series, the subset will be shown on top of the total set of data where the subset will be colored by the actual brush of the series, and the total set will have a reduced opacity. For line series, the subset will be shown as a dotted line.
## **{PackageVerChanges-23-2}**
### {PackageGrids} - Toolbar -
- Save tool action has been added to save the chart to an image via the clipboard.
-- Vertical orientation has been added via the toolbar's `Orientation` property. By default the toolbar is horizontal, now the toolbar can be shown in vertical orientation where the tools will popup to the left/right respectfully.
+- Vertical orientation has been added via the toolbar's property. By default the toolbar is horizontal, now the toolbar can be shown in vertical orientation where the tools will popup to the left/right respectfully.
- Custom SVG icons support was added via the toolbar's `renderImageFromText` method, further enhancing custom tool creation.
## **{PackageVerChanges-23-1}**
### New Components
-- [Toolbar](menus/toolbar.md) - This component is a companion container for UI operations to be used primarily with our charting components. The toolbar will dynamically update with a preset of properties and tool items when linked to our `DataChart` or `CategoryChart` components. You'll be able to create custom tools for your project allowing end users to provide changes, offering an endless amount of customization.
+- [Toolbar](menus/toolbar.md) - This component is a companion container for UI operations to be used primarily with our charting components. The toolbar will dynamically update with a preset of properties and tool items when linked to our or components. You'll be able to create custom tools for your project allowing end users to provide changes, offering an endless amount of customization.
### {PackageCharts} (Charts)
-- [ValueLayer](charts/features/chart-overlays.md#{PlatformLower}-value-layer) - A new series type named the `ValueLayer` is now exposed which can allow you to render an overlay for different focal points of the plotted data such as Maximum, Minimum, and Average. This is applied to the `CategoryChart` and `FinancialChart` by adding to the new `ValueLines` collection.
+- [ValueLayer](charts/features/chart-overlays.md#{PlatformLower}-value-layer) - A new series type named the is now exposed which can allow you to render an overlay for different focal points of the plotted data such as Maximum, Minimum, and Average. This is applied to the and by adding to the new collection.
-- It is now possible to apply a **dash array** to the different parts of the series of the `DataChart`. You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
+- It is now possible to apply a **dash array** to the different parts of the series of the . You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
## **{PackageVerChanges-22-2.2}**
- Angular 16 support.
@@ -389,7 +391,7 @@ Added significant improvements to default behaviors, and refined the Category Ch
- Responsive layouts for horizontal label rotation based on browser / screen size.
- Enhanced rendering for rounded labels on all platforms.
- Added marker properties to StackedFragmentSeries.
-- Added `ShouldPanOnMaximumZoom` property.
+- Added property.
- New Category Axis Properties:
- ZoomMaximumCategoryRange
- ZoomMaximumItemSpan
@@ -410,25 +412,25 @@ Added significant improvements to default behaviors, and refined the Category Ch
- GroupSortDescriptions
-The Chart's [Aggregation](charts/features/chart-data-aggregations.md) will not work when using `IncludedProperties` | `ExcludedProperties` because these properties are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
+The Chart's [Aggregation](charts/features/chart-data-aggregations.md) will not work when using | because these properties are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
## **{PackageVerChanges-22-1}**
### {PackageCharts} (Charts)
-- Added the highly-configurable [DataLegend](charts/features/chart-data-legend.md) component, which works much like the `Legend`, but it shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values.
+- Added the highly-configurable [DataLegend](charts/features/chart-data-legend.md) component, which works much like the , but it shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values.
- Added the highly-configurable [DataToolTip](charts/features/chart-data-tooltip.md) which displays values and titles of series as well as legend badges of series in a tooltip. This is now the default tooltip for all chart types.
-- Added animation and transition-in support for Stacked Series. Animations can be enabled by setting the `IsTransitionInEnabled` property to true. From there, you can set the `TransitionInDuration` property to determine how long your animation should take to complete and the `TransitionInMode` to determine the type of animation that takes place.
-- Added `AssigningCategoryStyle` event, is now available to all series in `DataChart`. This event is handled when you want to conditionally configure aspects of the series items such as `Fill` background-color and highlighting.
-- New `AllowedPositions` enumeration for CalloutLayer. Used to limit where the callouts are to be placed within the chart. By default, the callouts are intelligently placed in the best place but this used to force for example `TopLeft`, `TopRight`, `BottomLeft` or `BottomRight`.
+- Added animation and transition-in support for Stacked Series. Animations can be enabled by setting the property to true. From there, you can set the property to determine how long your animation should take to complete and the to determine the type of animation that takes place.
+- Added `AssigningCategoryStyle` event, is now available to all series in . This event is handled when you want to conditionally configure aspects of the series items such as background-color and highlighting.
+- New enumeration for CalloutLayer. Used to limit where the callouts are to be placed within the chart. By default, the callouts are intelligently placed in the best place but this used to force for example `TopLeft`, `TopRight`, `BottomLeft` or `BottomRight`.
- New corner radius properties added for Annotation Layers; used to round-out the corners of each of the callouts. Note, a corner radius has now been added by default.
- - `CalloutCornerRadius` for CalloutLayer
- - `AxisAnnotationBackgroundCornerRadius` for FinalValueLayer
- - `XAxisAnnotationBackgroundCornerRadius` and `YAxisAnnotationBackgroundCornerRadius` for CrosshairLayer
-- New `HorizontalViewScrollbarMode` and `VerticalViewScrollbarMode` enumeration to enable scrollbars in various ways. When paired with `IsVerticalZoomEnabled` or `IsHorizontalZoomEnabled`, you'll be able to persist or fade-in and out the scrollbars along the axes to navigate the chart.
-- New `FavorLabellingScaleEnd`, determines whether the axis should favor emitting a label at the end of the scale. Only compatible with numeric axes (e.g. `NumericXAxis`, `NumericYAxis`, `PercentChangeAxis`).
-- New `IsSplineShapePartOfRange` determines whether to include the spline shape in the axis range requested of the axis.
-- New `XAxisMaximumGap`, determines the maximum allowed value for the plotted series when using `XAxisGap`. The gap determines the amount of space between columns or bars of plotted series.
-- New `XAxisMinimumGapSize`, determines the minimum allowed pixel-based value for the plotted series when using `XAxisGap` to ensure there is always some spacing between each category.
+ - for CalloutLayer
+ - for FinalValueLayer
+ - and for CrosshairLayer
+- New and enumeration to enable scrollbars in various ways. When paired with or , you'll be able to persist or fade-in and out the scrollbars along the axes to navigate the chart.
+- New , determines whether the axis should favor emitting a label at the end of the scale. Only compatible with numeric axes (e.g. , , `PercentChangeAxis`).
+- New determines whether to include the spline shape in the axis range requested of the axis.
+- New , determines the maximum allowed value for the plotted series when using . The gap determines the amount of space between columns or bars of plotted series.
+- New , determines the minimum allowed pixel-based value for the plotted series when using to ensure there is always some spacing between each category.
@@ -442,29 +444,29 @@ Please ensure package "lit-html": "^2.0.0" or newer is added to your project for
This release introduces a few improvements and simplifications to visual design and configuration options for the geographic map and all chart components.
-- Changed `YAxisLabelLocation` property's type to **YAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart` and `CategoryChart`
-- Changed `XAxisLabelLocation` property's type to **XAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart`
-- Added `XAxisLabelLocation` property to `CategoryChart`
-- Added support for representing geographic series of `GeographicMap` in a legend
-- Added crosshair lines by default in `FinancialChart` and `CategoryChart`
-- Added crosshair annotations by default in `FinancialChart` and `CategoryChart`
-- Added final value annotation by default in `FinancialChart`
+- Changed property's type to **YAxisLabelLocation** from **AxisLabelLocation** in and
+- Changed property's type to **XAxisLabelLocation** from **AxisLabelLocation** in
+- Added property to
+- Added support for representing geographic series of in a legend
+- Added crosshair lines by default in and
+- Added crosshair annotations by default in and
+- Added final value annotation by default in
- Added new properties in Category Chart and Financial Chart:
- - `CrosshairsLineThickness` and other properties for customizing crosshairs lines
- - `CrosshairsAnnotationXAxisBackground` and other properties for customizing crosshairs annotations
- - `FinalValueAnnotationsBackground` and other properties for customizing final value annotations
- - `AreaFillOpacity` that allow changing opacity of series fill (e.g. Area chart)
- - `MarkerThickness` that allows changing thickness of markers
+ - and other properties for customizing crosshairs lines
+ - and other properties for customizing crosshairs annotations
+ - and other properties for customizing final value annotations
+ - that allow changing opacity of series fill (e.g. Area chart)
+ - that allows changing thickness of markers
- Added new properties in Category Chart, Financial Chart, Data Chart, and Geographic Map:
- - `MarkerAutomaticBehavior` that allows which marker type is assigned to multiple series in the same chart
- - `LegendItemBadgeShape` for setting badge shape of all series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on all series in a legend
+ - that allows which marker type is assigned to multiple series in the same chart
+ - for setting badge shape of all series represented in a legend
+ - for setting badge complexity on all series in a legend
- Added new properties in Series in Data Chart and Geographic Map:
- - `LegendItemBadgeShape` for setting badge shape on specific series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on specific series in a legend
+ - for setting badge shape on specific series represented in a legend
+ - for setting badge complexity on specific series in a legend
- Changed default vertical crosshair line stroke from #000000 to #BBBBBB in category chart and series
-- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's `MarkerAutomaticBehavior` property to `SmartIndexed` enum value
-- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's `LegendItemBadgeMode` property to `MatchSeries` enum value
+- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's property to `SmartIndexed` enum value
+- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's property to `MatchSeries` enum value
- Changed color palette of series and markers displayed in all charts to improve accessibility
| Old brushes/outlines | New outline/brushes |
@@ -476,30 +478,30 @@ This release introduces a few improvements and simplifications to visual design
## **{PackageVerChanges-21-1}**
### {PackageCharts} (Charts)
-This release introduces several new and improved visual design and configuration options for all of the chart components, e.g. `DataChart`, `CategoryChart`, and `FinancialChart`.
+This release introduces several new and improved visual design and configuration options for all of the chart components, e.g. , , and .
- Changed Bar/Column/Waterfall series to have square corners instead of rounded corners
- Changed Scatter High Density series’ colors for heat min property from #8a5bb1 to #000000
- Changed Scatter High Density series’ colors for heat max property from #ee5879 to #ee5879
- Changed Financial/Waterfall series’ `NegativeBrush` and `NegativeOutline` properties from #C62828 to #ee5879
- Changed marker's thickness to 2px from 1px
-- Changed marker's fill to match the marker's outline for `PointSeries`, `BubbleSeries`, `ScatterSeries`, `PolarScatterSeries`. You can use set `MarkerFillMode` property to Normal to undo this change
-- Compressed labelling for the `TimeXAxis` and `OrdinalTimeXAxis`
+- Changed marker's fill to match the marker's outline for , , , . You can use set property to Normal to undo this change
+- Compressed labelling for the and
- New Marker Properties:
- - series.`MarkerFillMode` - Can be set to `MatchMarkerOutline` so the marker depends on the outline
- - series.`MarkerFillOpacity` - Can be set to a value 0 to 1
- - series.`MarkerOutlineMode` - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
+ - series. - Can be set to `MatchMarkerOutline` so the marker depends on the outline
+ - series. - Can be set to a value 0 to 1
+ - series. - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
- New Series Property:
- - series.`OutlineMode` - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
-- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the `ComputedPlotAreaMarginMode`, listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
- - chart.`PlotAreaMarginLeft`
- - chart.`PlotAreaMarginTop`
- - chart.`PlotAreaMarginRight`
- - chart.`PlotAreaMarginBottom`
- - chart.`ComputedPlotAreaMarginMode`
+ - series. - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
+- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the , listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
+ - chart.
+ - chart.
+ - chart.
+ - chart.
+ - chart.
- New Highlighting Properties
- - chart.`HighlightingMode` - Sets whether hovered or non-hovered series to fade, brighten
- - chart.`HighlightingBehavior` - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
+ - chart. - Sets whether hovered or non-hovered series to fade, brighten
+ - chart. - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
- Note, in previous releases the highlighting was limited to fade on hover.
- Added Highlighting Stacked, Scatter, Polar, Radial, and Shape series:
- Added Annotation layers to Stacked, Scatter, Polar, Radial, and Shape series:
@@ -522,8 +524,8 @@ for example:
#### Chart Legend
-- Added horizontal `Orientation` property to ItemLegend that can be used with Bubble, Donut, and Pie Chart
-- Added `LegendHighlightingMode` property - Enables series highlighting when hovering over legend items
+- Added horizontal property to ItemLegend that can be used with Bubble, Donut, and Pie Chart
+- Added property - Enables series highlighting when hovering over legend items
### {PackageMaps} (GeoMap)
diff --git a/docs/xplat/src/content/en/components/general-cli-overview.mdx b/docs/xplat/src/content/en/components/general-cli-overview.mdx
index bafd0b86db..1f14544815 100644
--- a/docs/xplat/src/content/en/components/general-cli-overview.mdx
+++ b/docs/xplat/src/content/en/components/general-cli-overview.mdx
@@ -183,7 +183,7 @@ ig list
For a guided walkthrough of the component addition wizard, see [Step-by-Step Guide Using Ignite UI CLI](general-step-by-step-guide-using-cli.md#add-view).
-
+
Your routing file will be updated with the path to the newly generated page. For example, a component named `MyGrid` will be navigable at `/my-grid`.
@@ -290,7 +290,7 @@ If you have the CLI installed globally:
ig ai-config
```
-
+
Without a version pin, `npx` may pull an older CLI version that does not recognize the `ai-config` subcommand and will instead launch an interactive project-creation prompt, scaffolding a new project inside your existing one. Make sure that you have installed CLI version 16.x.
diff --git a/docs/xplat/src/content/en/components/general-step-by-step-guide-using-cli.mdx b/docs/xplat/src/content/en/components/general-step-by-step-guide-using-cli.mdx
index 0625f3d77c..e776dd304f 100644
--- a/docs/xplat/src/content/en/components/general-step-by-step-guide-using-cli.mdx
+++ b/docs/xplat/src/content/en/components/general-step-by-step-guide-using-cli.mdx
@@ -153,7 +153,7 @@ For example:
ig add grid MyGrid
```
-
+
Your routing file will be updated with the path to the newly generated page. For example, a component named `MyGrid` will be navigable at `/my-grid`.
diff --git a/docs/xplat/src/content/en/components/geo-map-binding-data-model.mdx b/docs/xplat/src/content/en/components/geo-map-binding-data-model.mdx
index 59539933bd..1ca006a241 100644
--- a/docs/xplat/src/content/en/components/geo-map-binding-data-model.mdx
+++ b/docs/xplat/src/content/en/components/geo-map-binding-data-model.mdx
@@ -28,13 +28,13 @@ The following table summarized data structures required for each type of geograp
| Geographic Series | Properties | Description |
|--------------|---------------| ---------------|
-| | `LongitudeMemberPath`, `LatitudeMemberPath` | Specifies names of 2 numeric longitude and latitude coordinates |
-| | `LongitudeMemberPath`, `LatitudeMemberPath` | Specifies names of 2 numeric longitude and latitude coordinates |
-| | `LongitudeMemberPath`, `LatitudeMemberPath`, `RadiusMemberPath` | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for size/radius of symbols |
-| | `LongitudeMemberPath`, `LatitudeMemberPath`, `ColorMemberPath` | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for triangulation of values |
-| | `LongitudeMemberPath`, `LatitudeMemberPath`, `ValueMemberPath` | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for triangulation of values |
-||`ShapeMemberPath`|Specifies the name of data column of items that contains the geographic points of shapes. This property must be mapped to an array of arrays of objects with x and y properties. |
-||`ShapeMemberPath`|Specifies the name of data column of items that contains the geographic coordinates of lines. This property must be mapped to an array of arrays of objects with x and y properties. |
+| | , | Specifies names of 2 numeric longitude and latitude coordinates |
+| | , | Specifies names of 2 numeric longitude and latitude coordinates |
+| | , , | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for size/radius of symbols |
+| | , , | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for triangulation of values |
+| | , , | Specifies names of 2 numeric longitude and latitude coordinates and 1 numeric column for triangulation of values |
+|||Specifies the name of data column of items that contains the geographic points of shapes. This property must be mapped to an array of arrays of objects with x and y properties. |
+|||Specifies the name of data column of items that contains the geographic coordinates of lines. This property must be mapped to an array of arrays of objects with x and y properties. |
## Code Snippet
The following code shows how to bind the to a custom data model that contains geographic locations of some cities of the world stored using longitude and latitude coordinates. Also, we use the to plot shortest geographic path between these locations using the [WorldUtility](geo-map-resources-world-util.md)
diff --git a/docs/xplat/src/content/en/components/geo-map-display-imagery-types.mdx b/docs/xplat/src/content/en/components/geo-map-display-imagery-types.mdx
index 0f7616b608..3659ec3d09 100644
--- a/docs/xplat/src/content/en/components/geo-map-display-imagery-types.mdx
+++ b/docs/xplat/src/content/en/components/geo-map-display-imagery-types.mdx
@@ -33,7 +33,7 @@ The following table summarizes imagery classes provided by the map component.
||Represents the base control for all imagery classes that display all types of supported geographic imagery tiles. This class can be extended for the purpose of implementing support for geographic imagery tiles from other geographic imagery sources such as Map Quest mapping service.|
||Represents the multi-scale imagery control for displaying geographic imagery tiles from the Open Street Maps service.|
-{/* |`BingMapsMapImagery`|Represents the multi-scale imagery control for displaying geographic imagery tiles from the Bing Maps service.| */}
+{/* ||Represents the multi-scale imagery control for displaying geographic imagery tiles from the Bing Maps service.| */}
By default, the property is set to object and the map component displays geographic imagery tiles from the Open Street Maps service. In order to display different types of geographic imagery tiles, the map component must be re-configured.
@@ -52,6 +52,6 @@ This code example explicitly sets
+
diff --git a/docs/xplat/src/content/en/components/geo-map-type-scatter-bubble-series.mdx b/docs/xplat/src/content/en/components/geo-map-type-scatter-bubble-series.mdx
index 2172a031cf..71c5315991 100644
--- a/docs/xplat/src/content/en/components/geo-map-type-scatter-bubble-series.mdx
+++ b/docs/xplat/src/content/en/components/geo-map-type-scatter-bubble-series.mdx
@@ -26,19 +26,19 @@ In {Platform} map component, you can use the series and how to specify data binding options of the series. Automatic marker selection is configured along with marker collision avoidance logic, and marker outline and fill colors are specified too.
## Configuration Summary
-Similar to other types of scatter series in the map control, the series has the `ItemsSource` property which can be bound to an array of objects. In addition, each data item in the items source must have two data columns that store geographic longitude and latitude coordinates and uses the `LongitudeMemberPath` and `LatitudeMemberPath` properties to map these data columns. The `RadiusScale` and `RadiusMemberPath` will settings configures the radius for the bubbles.
+Similar to other types of scatter series in the map control, the series has the property which can be bound to an array of objects. In addition, each data item in the items source must have two data columns that store geographic longitude and latitude coordinates and uses the and properties to map these data columns. The and will settings configures the radius for the bubbles.
The following table summarizes the GeographicHighDensityScatterSeries series properties used for data binding.
| Property|Type|Description |
| ---|---|--- |
-| `ItemsSource`|any|Gets or sets the items source |
-| `LongitudeMemberPath`|string|Uses the ItemsSource property to determine the location of the longitude values on the assigned items |
-| `LatitudeMemberPath`|string|Uses the ItemsSource property to determine the location of the latitude values on the assigned items |
-| `RadiusMemberPath`|string|Sets the path to use to get the radius values for the series. |
-| `RadiusScale`|`SizeScale`|Gets or sets the radius scale property for the current bubble series. |
-| `MinimumValue`|any|Configure the minimum value for calculating value sub ranges. |
-| `MaximumValue`|any|Configure the maximum value for calculating value sub ranges. |
+| |any|Gets or sets the items source |
+| |string|Uses the ItemsSource property to determine the location of the longitude values on the assigned items |
+| |string|Uses the ItemsSource property to determine the location of the latitude values on the assigned items |
+| |string|Sets the path to use to get the radius values for the series. |
+| ||Gets or sets the radius scale property for the current bubble series. |
+| |any|Configure the minimum value for calculating value sub ranges. |
+| |any|Configure the maximum value for calculating value sub ranges. |
## Code Snippet
@@ -341,4 +341,4 @@ addSeriesWith(locations: any[])
## API References
-`RadiusScale`
+
diff --git a/docs/xplat/src/content/en/components/geo-map-type-scatter-contour-series.mdx b/docs/xplat/src/content/en/components/geo-map-type-scatter-contour-series.mdx
index 7cdda26b7e..7a506b529b 100644
--- a/docs/xplat/src/content/en/components/geo-map-type-scatter-contour-series.mdx
+++ b/docs/xplat/src/content/en/components/geo-map-type-scatter-contour-series.mdx
@@ -26,33 +26,33 @@ In {Platform} map component, you can use the works a lot like the except that it represents data as contour lines, colored using a fill scale and the geographic scatter area series, represents data as a surface interpolated using a color scale.
## Data Requirements
-Similar to other types of geographic series in the map component, the has the `ItemsSource` property which can be bound to an array of objects. In addition, each item in the items source must have three data columns, two that store geographic location (longitude and latitude coordinates) and one data column that stores a value associated with the geographic location. These data column, are identified by `LongitudeMemberPath`, `LatitudeMemberPath`, and `ValueMemberPath` properties of the geographic series.
-The `GeographicContourLineSeries` automatically performs built-in data triangulation on items in the ItemsSource if no triangulation is set to the `TrianglesSource` property. However, computing triangulation can be a very time-consuming process, so the runtime performance will be better when specifying a `TriangulationSource` for this property, especially when a large number of data items are present.
+Similar to other types of geographic series in the map component, the has the property which can be bound to an array of objects. In addition, each item in the items source must have three data columns, two that store geographic location (longitude and latitude coordinates) and one data column that stores a value associated with the geographic location. These data column, are identified by , , and properties of the geographic series.
+The automatically performs built-in data triangulation on items in the ItemsSource if no triangulation is set to the property. However, computing triangulation can be a very time-consuming process, so the runtime performance will be better when specifying a `TriangulationSource` for this property, especially when a large number of data items are present.
## Data Binding
-The following table summarizes properties of `GeographicContourLineSeries` used for data binding.
+The following table summarizes properties of used for data binding.
| Property Name | Property Type | Description |
|--------------|---------------| ---------------|
-|`ItemsSource`|any|The source of data items to perform triangulation on if the `TrianglesSource` property provides no triangulation data.|
-|`LongitudeMemberPath`|string|The name of the property containing the Longitude for all items bound to the `ItemsSource`.|
-|`LatitudeMemberPath`|string|The name of the property containing the Latitude for all items bound to to the `ItemsSource`.|
-|`ValueMemberPath`|string|The name of the property containing a value at Latitude and Longitude coordinates of each data item. This numeric value will be be converted to a color when the `FillScale` property is set.|
-|`TrianglesSource`|any|Gets or sets the source of triangulation data. Setting Triangles of the TriangulationSource object to this property improves both runtime performance and geographic series rendering.|
-|`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. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
-|`TriangleVertexMemberPath2`|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. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
-|`TriangleVertexMemberPath3`|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. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
+||any|The source of data items to perform triangulation on if the property provides no triangulation data.|
+||string|The name of the property containing the Longitude for all items bound to the .|
+||string|The name of the property containing the Latitude for all items bound to to the .|
+||string|The name of the property containing a value at Latitude and Longitude coordinates of each data item. This numeric value will be be converted to a color when the property is set.|
+||any|Gets or sets the source of triangulation data. Setting Triangles of the TriangulationSource object to this property improves both runtime performance and geographic series rendering.|
+||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. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
+||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. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
+||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. It is not mandatory to set this property. It is taken by default unless custom triangulation logic is provided.|
## Contour Fill Scale
-Use the `FillScale` property of the to resolve fill brushes of the contour lines of the geographic series.
+Use the property of the to resolve fill brushes of the contour lines of the geographic series.
The provided `ValueBrushScale class should satisfy most of your coloring needs, but the application for custom coloring logic can inherit the ValueBrushScale class.
The following table list properties of the CustomPaletteColorScale affecting the surface coloring of the GeographicContourLineSeries.
| Property Name | Property Type | Description |
|--------------|---------------| ---------------|
-|`Brushes`|BrushCollection|Gets or sets the collection of brushes for filling contours of the `GeographicContourLineSeries`|
-|`MaximumValue`|double|The highest value to assign a brush in a fill scale.|
-|`MinimumValue`|double|The lowest value to assign a brush in a fill scale.|
+||BrushCollection|Gets or sets the collection of brushes for filling contours of the |
+||double|The highest value to assign a brush in a fill scale.|
+||double|The lowest value to assign a brush in a fill scale.|
## Code Snippet
@@ -376,7 +376,7 @@ createContourSeries(data: any[])
## API References
-`FillScale`
+
diff --git a/docs/xplat/src/content/en/components/geo-map-type-scatter-density-series.mdx b/docs/xplat/src/content/en/components/geo-map-type-scatter-density-series.mdx
index 48be9c23ae..3bbfcc1178 100644
--- a/docs/xplat/src/content/en/components/geo-map-type-scatter-density-series.mdx
+++ b/docs/xplat/src/content/en/components/geo-map-type-scatter-density-series.mdx
@@ -28,30 +28,30 @@ The demo above shows the series has the `ItemsSource` property which can be bound to an array of objects. In addition, each data item in the items source must have two data columns that store geographic longitude and latitude coordinates and uses the `LongitudeMemberPath` and `LatitudeMemberPath` properties to map these data columns.
+Similar to other types of scatter series in the map control, the series has the property which can be bound to an array of objects. In addition, each data item in the items source must have two data columns that store geographic longitude and latitude coordinates and uses the and properties to map these data columns.
### Data Binding
The following table summarizes the GeographicHighDensityScatterSeries series properties used for data binding.
| Property|Type|Description |
| ---|---|--- |
-| `ItemsSource`|any|Gets or sets the items source |
-| `LongitudeMemberPath`|string|Uses the ItemsSource property to determine the location of the longitude values on the assigned items |
-| `LatitudeMemberPath`|string|Uses the ItemsSource property to determine the location of the latitude values on the assigned items |
+| |any|Gets or sets the items source |
+| |string|Uses the ItemsSource property to determine the location of the longitude values on the assigned items |
+| |string|Uses the ItemsSource property to determine the location of the latitude values on the assigned items |
## Heat Color Scale
The Heat Color Scale, an optional feature, determines the color pattern within the series. The following table summarizes the properties used for determining the color scale.
| Property |Type|Description |
| ---|---|--- |
-| `HeatMinimum`|Double|Defines the double value representing the minimum end of the color scale |
-| `HeatMaximum`|Double|Defines the double value representing the maximum end of the color scale |
-| `HeatMinimumColor`|Color|Defines the point density color used at the bottom end of the color scale |
-| `HeatMaximumColor`|Color|Defines the point density color used at the top end of the color scale |
+| |Double|Defines the double value representing the minimum end of the color scale |
+| |Double|Defines the double value representing the maximum end of the color scale |
+| |Color|Defines the point density color used at the bottom end of the color scale |
+| |Color|Defines the point density color used at the top end of the color scale |
## Code Example
-The following code demonstrates how set the `HeatMinimumColor` and `HeatMaximumColor` properties of the
+The following code demonstrates how set the and properties of the
diff --git a/docs/xplat/src/content/en/components/grid-lite/column-configuration.mdx b/docs/xplat/src/content/en/components/grid-lite/column-configuration.mdx
index fc00704188..ad8100137a 100644
--- a/docs/xplat/src/content/en/components/grid-lite/column-configuration.mdx
+++ b/docs/xplat/src/content/en/components/grid-lite/column-configuration.mdx
@@ -64,7 +64,7 @@ return (
-Columns are defined declaratively using `` child elements within the grid. The `Field` property is the only required for a column, as it serves as the column identifier. It is also the property that is used to map and render the relevant data in the grid rows.
+Columns are defined declaratively using `` child elements within the grid. The property is the only required for a column, as it serves as the column identifier. It is also the property that is used to map and render the relevant data in the grid rows.
```razor
@@ -78,7 +78,7 @@ Columns are defined declaratively using `` child elements wit
## Configuration Based on the Data Source
-The grid supports inferring the column configuration based on the provided data source when `AutoGenerate` is set to true. It tries to infer the appropriate `Field` and `DataType` properties based on records in the data.
+The grid supports inferring the column configuration based on the provided data source when `AutoGenerate` is set to true. It tries to infer the appropriate and properties based on records in the data.
```razor
@@ -240,7 +240,7 @@ return (
-To change the width of column, use the `Width` parameter of the `IgbGridLiteColumn` component.
+To change the width of column, use the parameter of the `IgbGridLiteColumn` component.
```razor
@@ -290,7 +290,7 @@ return (
-Columns can be hidden/shown by setting the `Hidden` parameter on the `IgbGridLiteColumn` component.
+Columns can be hidden/shown by setting the parameter on the `IgbGridLiteColumn` component.
```razor
@@ -338,7 +338,7 @@ return (
-Each column of the {GridLiteTitle} can be configured to be resizable by setting the `Resizable` parameter on the `IgbGridLiteColumn` component.
+Each column of the {GridLiteTitle} can be configured to be resizable by setting the parameter on the `IgbGridLiteColumn` component.
```razor
diff --git a/docs/xplat/src/content/en/components/grid-lite/filtering.mdx b/docs/xplat/src/content/en/components/grid-lite/filtering.mdx
index 9e5fcedc4d..c19022d332 100644
--- a/docs/xplat/src/content/en/components/grid-lite/filtering.mdx
+++ b/docs/xplat/src/content/en/components/grid-lite/filtering.mdx
@@ -26,7 +26,7 @@ The {GridLiteTitle} supports filtering operations on its data source. Data filte
-The {GridLiteTitle} supports filtering operations on its data source. Data filtering is controlled on per-column level, allowing you to have filterable and non-filterable columns. By default, filtering on a column is disabled unless explicitly configured with the `Filterable` property of the column.
+The {GridLiteTitle} supports filtering operations on its data source. Data filtering is controlled on per-column level, allowing you to have filterable and non-filterable columns. By default, filtering on a column is disabled unless explicitly configured with the property of the column.
diff --git a/docs/xplat/src/content/en/components/grid-lite/header-template.mdx b/docs/xplat/src/content/en/components/grid-lite/header-template.mdx
index 54ad9e342f..d7a03f0b22 100644
--- a/docs/xplat/src/content/en/components/grid-lite/header-template.mdx
+++ b/docs/xplat/src/content/en/components/grid-lite/header-template.mdx
@@ -43,7 +43,7 @@ return (
-By default the column uses the `Field` property for label text. To customize the label, set the `Header` property to a more human readable format.
+By default the column uses the property for label text. To customize the label, set the property to a more human readable format.
```razor
diff --git a/docs/xplat/src/content/en/components/grid-lite/sorting.mdx b/docs/xplat/src/content/en/components/grid-lite/sorting.mdx
index 9eb542844f..12941f101c 100644
--- a/docs/xplat/src/content/en/components/grid-lite/sorting.mdx
+++ b/docs/xplat/src/content/en/components/grid-lite/sorting.mdx
@@ -25,7 +25,7 @@ The {GridLiteTitle} supports sorting operations on its data source. Data sorting
-The {GridLiteTitle} supports sorting operations on its data source. Data sorting is controlled on per-column level, allowing you to have sortable and non-sortable columns, while the grid itself controls certain sort behaviors. By default, sorting on a column is disabled unless explicitly configured with the `Sortable` property of the column.
+The {GridLiteTitle} supports sorting operations on its data source. Data sorting is controlled on per-column level, allowing you to have sortable and non-sortable columns, while the grid itself controls certain sort behaviors. By default, sorting on a column is disabled unless explicitly configured with the property of the column.
@@ -193,7 +193,7 @@ The {GridLiteTitle} supports both single and multi-column sorting. Multi-column
-The {GridLiteTitle} supports both single and multi-column sorting. Multi-column is enabled by default and can be configured through the `SortingOptions` property of the grid. The `Mode` property accepts `GridLiteSortingMode.Single` or `GridLiteSortingMode.Multiple` as values.
+The {GridLiteTitle} supports both single and multi-column sorting. Multi-column is enabled by default and can be configured through the property of the grid. The property accepts `GridLiteSortingMode.Single` or `GridLiteSortingMode.Multiple` as values.
@@ -282,7 +282,7 @@ The following sample shows the grid `sortingOptions` property and how it control
-The following sample shows the grid `SortingOptions` property and how it controls the grid sorting behavior.
+The following sample shows the grid property and how it controls the grid sorting behavior.
diff --git a/docs/xplat/src/content/en/components/grids/_shared/cell-editing.mdx b/docs/xplat/src/content/en/components/grids/_shared/cell-editing.mdx
index 222df628a5..8c7e340b6a 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/cell-editing.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/cell-editing.mdx
@@ -122,7 +122,7 @@ public updateCell() {
-Another way to update cell is directly through `Update` method of `Cell`:
+Another way to update cell is directly through method of `Cell`:
diff --git a/docs/xplat/src/content/en/components/grids/_shared/cell-merging.mdx b/docs/xplat/src/content/en/components/grids/_shared/cell-merging.mdx
index 4ed414463e..39258bccdd 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/cell-merging.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/cell-merging.mdx
@@ -42,7 +42,7 @@ Cell merging in the grid is controlled at two levels:
### Grid Merge Mode
-The grid exposes a property that accepts values from the enum:
+The grid exposes a property that accepts values from the enum:
- `always` - Merges any adjacent cells that meet the merging condition, regardless of sort state.
- `onSort` - Merges adjacent cells only when the column is sorted **(default value)**.
@@ -230,11 +230,11 @@ export class MyCustomStrategy extends IgcDefaultMergeStrategy {
-The `IgxTreeGrid` provides two built-in strategies that implement the `IGridMergeStrategy` interface: `DefaultTreeGridMergeStrategy` and `ByLevelTreeGridMergeStrategy`. `DefaultTreeGridMergeStrategy` merges all cells with the same value, regardless of their hierarchical level. In contrast, `ByLevelTreeGridMergeStrategy` only merges cells if they have the same value and are located at the same level, making level a required condition for merging.
+The `IgxTreeGrid` provides two built-in strategies that implement the `IGridMergeStrategy` interface: and . merges all cells with the same value, regardless of their hierarchical level. In contrast, only merges cells if they have the same value and are located at the same level, making level a required condition for merging.
### Extending the Default Strategy
-If you only want to customize part of the behavior (for example, the comparer logic), you can extend one of the built-in strategies, either `DefaultTreeGridMergeStrategy` or `ByLevelTreeGridMergeStrategy`, and override the relevant methods.
+If you only want to customize part of the behavior (for example, the comparer logic), you can extend one of the built-in strategies, either or , and override the relevant methods.
```ts
diff --git a/docs/xplat/src/content/en/components/grids/_shared/column-hiding.mdx b/docs/xplat/src/content/en/components/grids/_shared/column-hiding.mdx
index 1af4f17095..17da98cc03 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/column-hiding.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/column-hiding.mdx
@@ -686,7 +686,7 @@ Now let's create our . In o
### Add title and filter prompt
-A couple more things we can do in order to enrich the user experience of our column hiding component is to set the `Title` and the `FilterColumnsPrompt` properties. The `Title` is displayed on the top and the `FilterColumnsPrompt` is the prompt text that is displayed in the filter input of our column hiding UI.
+A couple more things we can do in order to enrich the user experience of our column hiding component is to set the and the `FilterColumnsPrompt` properties. The is displayed on the top and the `FilterColumnsPrompt` is the prompt text that is displayed in the filter input of our column hiding UI.
```html
diff --git a/docs/xplat/src/content/en/components/grids/_shared/column-moving.mdx b/docs/xplat/src/content/en/components/grids/_shared/column-moving.mdx
index 13ce9f49f1..b601128d71 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/column-moving.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/column-moving.mdx
@@ -152,7 +152,7 @@ const headerTemplate = (ctx: IgrCellTemplateContext) => {
In addition to the drag and drop functionality, the Column Moving feature also provides API methods to allow moving a column/reordering columns programmatically:
- - Moves a column before or after another column (a target). The first parameter is the column to be moved, and the second parameter is the target column. Also accepts an optional third parameter `Position` (representing a value), which determines whether to place the column before or after the target column.
+ - Moves a column before or after another column (a target). The first parameter is the column to be moved, and the second parameter is the target column. Also accepts an optional third parameter `Position` (representing a value), which determines whether to place the column before or after the target column.
@@ -177,7 +177,7 @@ grid.moveColumn(idColumn, nameColumn, DropPosition.AfterDropTarget);
-`Move` - Moves a column to a specified visible index. If the passed index parameter is invalid (is negative, or exceeds the number of columns), or if the column is not allowed to move to this index (if inside another group), no operation is performed.
+ - Moves a column to a specified visible index. If the passed index parameter is invalid (is negative, or exceeds the number of columns), or if the column is not allowed to move to this index (if inside another group), no operation is performed.
```typescript
@@ -197,7 +197,7 @@ idColumn.move(3);
```
-Note that when using the column moving feature, the event will be emitted if the operation was successful. Also note that in comparison to the drag and drop functionality, using the column moving feature does not require setting the property to true.
+Note that when using the column moving feature, the event will be emitted if the operation was successful. Also note that in comparison to the drag and drop functionality, using the column moving feature does not require setting the property to true.
## Events
diff --git a/docs/xplat/src/content/en/components/grids/_shared/column-pinning.mdx b/docs/xplat/src/content/en/components/grids/_shared/column-pinning.mdx
index 903ff92a89..be3a15bd9d 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/column-pinning.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/column-pinning.mdx
@@ -28,7 +28,7 @@ This example demonstrates how you can pin a column or multiple columns to the le
## Column Pinning API
-Column pinning is controlled through the property of the `Column`. Pinned columns are rendered on the left side of the by default and stay fixed through horizontal scrolling of the unpinned columns in the body.
+Column pinning is controlled through the property of the . Pinned columns are rendered on the left side of the by default and stay fixed through horizontal scrolling of the unpinned columns in the body.
diff --git a/docs/xplat/src/content/en/components/grids/_shared/column-resizing.mdx b/docs/xplat/src/content/en/components/grids/_shared/column-resizing.mdx
index 6615153f1e..c3a659e5a4 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/column-resizing.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/column-resizing.mdx
@@ -24,7 +24,7 @@ The {ProductName} Column Resizing feature in {Platform} {ComponentTitle} allows
-**Column resizing** is also enabled per-column level, meaning that the can have a mix of resizable and non-resizable columns. This is done via the input of the `Column`.
+**Column resizing** is also enabled per-column level, meaning that the can have a mix of resizable and non-resizable columns. This is done via the input of the .
@@ -80,7 +80,7 @@ The {ProductName} Column Resizing feature in {Platform} {ComponentTitle} allows
-You can subscribe to the event of the to implement some custom logic when a column is resized. Both, previous and new column widths, as well as the `Column` object, are exposed through the event arguments.
+You can subscribe to the event of the to implement some custom logic when a column is resized. Both, previous and new column widths, as well as the object, are exposed through the event arguments.
@@ -433,7 +433,7 @@ When resizing columns with width in percentages, the horizontal amount of the mo
## Restrict Column Resizing
-You can also configure the minimum and maximum allowable column widths. This is done via the and inputs of the `Column`. In this case the resize indicator drag operation is restricted to notify the user that the column cannot be resized outside the boundaries defined by and .
+You can also configure the minimum and maximum allowable column widths. This is done via the and inputs of the . In this case the resize indicator drag operation is restricted to notify the user that the column cannot be resized outside the boundaries defined by and .
diff --git a/docs/xplat/src/content/en/components/grids/_shared/column-selection.mdx b/docs/xplat/src/content/en/components/grids/_shared/column-selection.mdx
index f1af3a70e2..30e7fb75e7 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/column-selection.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/column-selection.mdx
@@ -43,7 +43,7 @@ The sample below demonstrates the three types of `{ComponentName}`'s **column se
## Basic Usage
-The column selection feature can be enabled through the input, which takes values.
+The column selection feature can be enabled through the input, which takes values.
## Interactions
diff --git a/docs/xplat/src/content/en/components/grids/_shared/column-types.mdx b/docs/xplat/src/content/en/components/grids/_shared/column-types.mdx
index bfcbd56d8f..e1cb873570 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/column-types.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/column-types.mdx
@@ -38,7 +38,7 @@ This column is not chang
### Number
-If the is set to **number**, the cell value will be formatted based on application or grid's `Locale` settings, as well as when property is specified. Then the number format will be changed based on them, for example it might change the:
+If the is set to **number**, the cell value will be formatted based on application or grid's settings, as well as when property is specified. Then the number format will be changed based on them, for example it might change the:
- Number of digits after the decimal point
- Decimal separator with `,` or `.`
@@ -104,7 +104,7 @@ const formatOptions : IgrColumnPipeArgs = {
### DateTime, Date and Time
-The appearance of the date portions will be set (e.g. day, month, year) based on `Locale` format or input. The pipe arguments can be used to specify a custom date format or timezone:
+The appearance of the date portions will be set (e.g. day, month, year) based on format or input. The pipe arguments can be used to specify a custom date format or timezone:
- **format** - The default value for formatting the date is `'mediumDate'`. Other available options are `'short'`, `'long'`, `'shortDate'`, `'fullDate'`, `'longTime'`, `'fullTime'` and etc.
- **timezone** - The user's local system timezone is the default value. The timezone offset or standard GMT/UTC or continental US timezone abbreviation can also be passed. Different timezone examples which will display the corresponding time of the location anywhere in the world:
@@ -329,7 +329,7 @@ When `AutoGenerate` is used for the columns, the grid analyses the values in the
#### Default template
-The default template will show a numeric value with currency symbol that would be either prefixed or suffixed. Both currency symbol location and number value formatting is based on the provided Application [LOCALE_ID](https://angular.io/api/core/LOCALE_ID) or {ComponentTitle} `Locale`.
+The default template will show a numeric value with currency symbol that would be either prefixed or suffixed. Both currency symbol location and number value formatting is based on the provided Application [LOCALE_ID](https://angular.io/api/core/LOCALE_ID) or {ComponentTitle} .
**By using LOCALE_ID**
diff --git a/docs/xplat/src/content/en/components/grids/_shared/conditional-cell-styling.mdx b/docs/xplat/src/content/en/components/grids/_shared/conditional-cell-styling.mdx
index ff8abddaf8..73732db890 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/conditional-cell-styling.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/conditional-cell-styling.mdx
@@ -454,10 +454,10 @@ constructor() {
The component in {ProductName} provides two ways to **conditional styling of cells** based on custom rules.
-- By setting the `Column` input to an object literal containing key-value pairs. The key is the name of the CSS class, while the value is either a callback function that returns a boolean, or boolean value. The result is a convenient material styling of the cell.
+- By setting the input to an object literal containing key-value pairs. The key is the name of the CSS class, while the value is either a callback function that returns a boolean, or boolean value. The result is a convenient material styling of the cell.
### Using Cell Classes
-You can conditionally style the cells by setting the `Column` input and define custom rules.
+You can conditionally style the cells by setting the input and define custom rules.
@@ -785,7 +785,7 @@ Use **::ng-deep** or **ViewEncapsulation.None** to force the custom styles down
### Using Cell Styles
-Columns expose the `CellStyles` property which allows conditional styling of the column cells. Similar to it accepts an object literal where the keys are style properties and the values are expressions for evaluation. Also, you can apply regular styling with ease (without any conditions).
+Columns expose the property which allows conditional styling of the column cells. Similar to it accepts an object literal where the keys are style properties and the values are expressions for evaluation. Also, you can apply regular styling with ease (without any conditions).
Let's define our styles:
@@ -863,7 +863,7 @@ const webGridCellStyles = {
-On `ngOnInit` we will add the `CellStyles` configuration for each column of the predefined `Columns` collection, which is used to create the columns dynamically.
+On `ngOnInit` we will add the configuration for each column of the predefined `Columns` collection, which is used to create the columns dynamically.
```ts
public ngOnInit() {
@@ -1079,7 +1079,7 @@ const cellStylesHandler = {
-On `ngOnInit` we will add the `CellStyles` configuration for each column of the predefined `Columns` collection, which is used to create the columns dynamically.
+On `ngOnInit` we will add the configuration for each column of the predefined `Columns` collection, which is used to create the columns dynamically.
```ts
public ngOnInit() {
diff --git a/docs/xplat/src/content/en/components/grids/_shared/editing.mdx b/docs/xplat/src/content/en/components/grids/_shared/editing.mdx
index 0a1840ccc3..696fb01936 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/editing.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/editing.mdx
@@ -76,14 +76,14 @@ The grid exposes a wide array of events that provide greater control over the ed
| Event | Description | Arguments | Cancellable |
| --------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | ----------- |
- | | If `RowEditing` is enabled, fires when a row enters edit mode | | **true** |
- | | Fires when a cell **enters edit mode** (after ) | | **true** |
- | | If value is changed, fires just **before** a cell's value is **committed** (e.g. by pressing ENTER) | | **true** |
- | | If value is changed, fires **after** a cell has been edited and cell's value is **committed** | | **false** |
- | | Fires when a cell **exits edit mode** | | **false** |
- | | If `RowEditing` is enabled, fires just before a row in edit mode's value is **committed** (e.g. by clicking the `Done` button on the Row Editing Overlay) | | **true** |
- | | If `RowEditing` is enabled, fires **after** a row has been edited and new row's value has been **committed**. | | **false** |
- | | If `RowEditing` is enabled, fires when a row **exits edit mode** | | **false** |
+ | | If `RowEditing` is enabled, fires when a row enters edit mode | | **true** |
+ | | Fires when a cell **enters edit mode** (after ) | | **true** |
+ | | If value is changed, fires just **before** a cell's value is **committed** (e.g. by pressing ENTER) | | **true** |
+ | | If value is changed, fires **after** a cell has been edited and cell's value is **committed** | | **false** |
+ | | Fires when a cell **exits edit mode** | | **false** |
+ | | If `RowEditing` is enabled, fires just before a row in edit mode's value is **committed** (e.g. by clicking the `Done` button on the Row Editing Overlay) | | **true** |
+ | | If `RowEditing` is enabled, fires **after** a row has been edited and new row's value has been **committed**. | | **false** |
+ | | If `RowEditing` is enabled, fires when a row **exits edit mode** | | **false** |
### Event Cancellation
diff --git a/docs/xplat/src/content/en/components/grids/_shared/excel-style-filtering.mdx b/docs/xplat/src/content/en/components/grids/_shared/excel-style-filtering.mdx
index d42151489c..f430473b41 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/excel-style-filtering.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/excel-style-filtering.mdx
@@ -642,7 +642,7 @@ As you see at the demos above the default appearance of the Excel Style filterin
### Usage
-In order to configure the Excel style filtering component, you should set its `Column` property to one of the {ComponentTitle}'s columns. In the sample above, we have bound the `Column` property to the value of an SelectComponent that displays the {ComponentTitle}'s columns.
+In order to configure the Excel style filtering component, you should set its property to one of the {ComponentTitle}'s columns. In the sample above, we have bound the property to the value of an SelectComponent that displays the {ComponentTitle}'s columns.
diff --git a/docs/xplat/src/content/en/components/grids/_shared/export-excel.mdx b/docs/xplat/src/content/en/components/grids/_shared/export-excel.mdx
index 3e132c20a5..c816fb3aec 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/export-excel.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/export-excel.mdx
@@ -138,14 +138,13 @@ The exported wil
is also configured to demonstrate how you can control which export formats are available to end users. Use the toolbar exporter options to toggle Excel, CSV, or PDF buttons:
- `export-excel`, `export-csv`, `export-pdf`
- `exportExcel`, `exportCsv`, `exportPdf`
-- `ExportExcel`, `ExportCsv`, `ExportPdf`
+- , `ExportCsv`, `ExportPdf`
## Export Grid with Frozen Column Headers
-
By default, the Excel Exporter service exports the grid with scrollable (unfrozen) column headers. In many scenarios you may want to freeze all headers at the top of the exported Excel file so they always stay in view as the user scrolls through the records. To achieve this, set the `ExporterOption` to `true`.
diff --git a/docs/xplat/src/content/en/components/grids/_shared/filtering.mdx b/docs/xplat/src/content/en/components/grids/_shared/filtering.mdx
index f4811cf7fe..2220122aba 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/filtering.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/filtering.mdx
@@ -129,7 +129,7 @@ While some filtering conditions have been applied to a column, and the filter ro
## Usage
-There's a default filtering strategy provided out of the box, as well as all the standard filtering conditions, which the developer can replace with their own implementation. In addition, we've provided a way to easily plug in your own custom filtering conditions. The currently provides not only a simplistic filtering UI, but also more complex filtering options. Depending on the set of the column, the correct set of **filtering operations** is loaded inside the filter UI dropdown. Additionally, you can set the `IgnoreCase` and the initial `Condition` properties.
+There's a default filtering strategy provided out of the box, as well as all the standard filtering conditions, which the developer can replace with their own implementation. In addition, we've provided a way to easily plug in your own custom filtering conditions. The currently provides not only a simplistic filtering UI, but also more complex filtering options. Depending on the set of the column, the correct set of **filtering operations** is loaded inside the filter UI dropdown. Additionally, you can set the and the initial properties.
The filtering feature is enabled for the component by setting the input to **true**. The default is `QuickFilter` and it **cannot** be changed run time. To disable this feature for a certain column – set the input to **false**.
@@ -206,11 +206,11 @@ You can filter any column or a combination of columns through the : this is a base filtering operand, which can be inherited when defining custom filtering conditions.
- defines all default filtering conditions for **boolean** type.
- defines all default filtering conditions for **numeric** type.
- defines all default filtering conditions for **string** type.
-- `DateFilteringOperand` defines all default filtering conditions for **date** type.
+- defines all default filtering conditions for **date** type.
```typescript
// Single column filtering
@@ -491,7 +491,7 @@ The supports rem
## Custom Filtering Operands
-You can customize the filtering menu by adding, removing or modifying the filtering operands. By default, the filtering menu contains certain operands based on the column’s data type (, `DateFilteringOperand`, and ). You can extend these classes or their base class `FilteringOperand` to change the filtering menu items’ behavior.
+You can customize the filtering menu by adding, removing or modifying the filtering operands. By default, the filtering menu contains certain operands based on the column’s data type (, , and ). You can extend these classes or their base class to change the filtering menu items’ behavior.
In the sample below, inspect the “Product Name” and “Discontinued” columns filters menus. For the “Discontinued” column filter, we have limited the number of operands to All, True and False. For the “Product Name” column filter – we have modified the Contains and Does Not Contain operands logic to perform case sensitive search and added also Empty and Not Empty operands.
@@ -708,7 +708,7 @@ constructor() {
## Re-templating Filter Cell
-You can add a template marked with `FilterCellTemplate` in order to retemplate the filter cell. In the sample below, an input is added for the string columns and `DatePicker` for the date column. When the user types or selects a value, a filter with contains operator for string columns and equals operator for date columns, is applied using grid's public API.
+You can add a template marked with in order to retemplate the filter cell. In the sample below, an input is added for the string columns and `DatePicker` for the date column. When the user types or selects a value, a filter with contains operator for string columns and equals operator for date columns, is applied using grid's public API.
@@ -1021,14 +1021,14 @@ Some browsers such as Firefox fail to parse regional specific decimal separators
- `filteringExpressions` property is removed. Use instead.
- `filter_multiple` method is removed. Use `Filter` method and property instead.
- The `Filter` method has new signature. It now accepts the following parameters:
- - `Name` - the name of the column to be filtered.
+ - - the name of the column to be filtered.
- `Value` - the value to be used for filtering.
- - `ConditionOrExpressionTree` (optional) - this parameter accepts object of type `FilteringOperation` or . If only simple filtering is needed, a filtering operation could be passed as an argument. In case of advanced filtering, an expressions tree containing complex filtering logic could be passed as an argument.
- - `IgnoreCase` (optional) - whether the filtering is case sensitive or not.
+ - `ConditionOrExpressionTree` (optional) - this parameter accepts object of type or . If only simple filtering is needed, a filtering operation could be passed as an argument. In case of advanced filtering, an expressions tree containing complex filtering logic could be passed as an argument.
+ - (optional) - whether the filtering is case sensitive or not.
- `FilteringDone` event now have only one parameter of type which contains the filtering state of the filtered column.
-- filtering operands: `FilteringExpression` condition property is no longer a direct reference to a filtering condition method, instead it's a reference to an `FilteringOperation`.
-- `ColumnComponent` now exposes a `Filters` property, which takes an `FilteringOperand` class reference.
-- Custom filters can be provided to the {ComponentTitle} columns by populating the `Operations` property of the `FilteringOperand` with operations of `FilteringOperation` type.
+- filtering operands: condition property is no longer a direct reference to a filtering condition method, instead it's a reference to an .
+- `ColumnComponent` now exposes a property, which takes an class reference.
+- Custom filters can be provided to the {ComponentTitle} columns by populating the property of the with operations of type.
diff --git a/docs/xplat/src/content/en/components/grids/_shared/keyboard-navigation.mdx b/docs/xplat/src/content/en/components/grids/_shared/keyboard-navigation.mdx
index f8fb5d6c22..1b41db06ee 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/keyboard-navigation.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/keyboard-navigation.mdx
@@ -152,15 +152,15 @@ Overriding the default behavior for a certain key or keys combination is one of
|---------|-------------|-----------|
| | An event that is emitted when any of key press/combinations described above is performed. Can be canceled. For any other key press/combination, use the default `onkeydown` event. | |
| | An event that is emitted when the active node is changed. You can use it to determine the Active focus position (header, tbody etc.), column index, row index or nested level. | |
-| `NavigateTo` | Navigates to a position in the grid, based on provided `Rowindex` and `VisibleColumnIndex`. It can also execute a custom logic over the target element, through a callback function that accepts param of type ```{ targetType: GridKeydownTargetType, target: Object }``` . Usage: ```grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });``` | ```RowIndex: number, VisibleColumnIndex: number, callback: ({ targetType: GridKeydownTargetType, target: Object }```) => {} |
-| `GetNextCell`| returns `ICellPosition` object, which defines the next cell by `RowIndex` and `VisibleColumnIndex`. A callback function can be passed as a third parameter of `GetNextCell` method. The callback function accepts `Column` as a param and returns a `boolean` value indication if a given criteria is met: ```const nextEditableCell = grid.getNextCell(0, 4, (col) => col.editable);``` | ```currentRowIndex: number, currentVisibleColumnIndex: number, callback: (Column) => boolean``` |
-| `GetPreviousCell` | returns `ICellPosition` object, which defines the previous cell by `RowIndex` and `VisibleColumnIndex`. A callback function can be passed as a third parameter of `GetPreviousCell` method. The callback function accepts `Column` as a param and returns a `boolean` value indication if a given criteria is met: ```const prevEditableCell = grid.getPreviousCell(0, 4, (col) => col.editable);``` | ``` CurrentRowIndex: number, CurrentVisibleColumnIndex: number, callback: (Column) => boolean ``` |
+| | Navigates to a position in the grid, based on provided `Rowindex` and `VisibleColumnIndex`. It can also execute a custom logic over the target element, through a callback function that accepts param of type ```{ targetType: GridKeydownTargetType, target: Object }``` . Usage: ```grid.navigateTo(10, 3, (args) => { args.target.nativeElement.focus(); });``` | ```RowIndex: number, VisibleColumnIndex: number, callback: ({ targetType: GridKeydownTargetType, target: Object }```) => {} |
+| | returns `ICellPosition` object, which defines the next cell by `RowIndex` and `VisibleColumnIndex`. A callback function can be passed as a third parameter of method. The callback function accepts as a param and returns a `boolean` value indication if a given criteria is met: ```const nextEditableCell = grid.getNextCell(0, 4, (col) => col.editable);``` | ```currentRowIndex: number, currentVisibleColumnIndex: number, callback: (Column) => boolean``` |
+| | returns `ICellPosition` object, which defines the previous cell by `RowIndex` and `VisibleColumnIndex`. A callback function can be passed as a third parameter of method. The callback function accepts as a param and returns a `boolean` value indication if a given criteria is met: ```const prevEditableCell = grid.getPreviousCell(0, 4, (col) => col.editable);``` | ``` CurrentRowIndex: number, CurrentVisibleColumnIndex: number, callback: (Column) => boolean ``` |
-Both `GetNextCell` and `GetPreviousCell` are
+Both and are
available for the current level and cannot access cells from upper or lower level.
diff --git a/docs/xplat/src/content/en/components/grids/_shared/multi-column-headers.mdx b/docs/xplat/src/content/en/components/grids/_shared/multi-column-headers.mdx
index b32917b315..b536e6d1d6 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/multi-column-headers.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/multi-column-headers.mdx
@@ -23,7 +23,7 @@ The {ProductName} Multi-Column Headers feature in {Platform} {ComponentTitle} al
-The declaration of multi-column headers is achieved by wrapping a set of columns into an component with `Header` title information passed.
+The declaration of multi-column headers is achieved by wrapping a set of columns into an component with title information passed.
@@ -601,7 +601,7 @@ If you want to re-use a single template for several column groups, you could set
-Each of the column groups of the grid can be templated separately. The column group expects `RenderFragment` for the `HeaderTemplate` property.
+Each of the column groups of the grid can be templated separately. The column group expects `RenderFragment` for the property.
The expression is provided with the column group object as a context.
```razor
diff --git a/docs/xplat/src/content/en/components/grids/_shared/multi-row-layout.mdx b/docs/xplat/src/content/en/components/grids/_shared/multi-row-layout.mdx
index c51102568e..38ff8a2fda 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/multi-row-layout.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/multi-row-layout.mdx
@@ -25,9 +25,9 @@ The Multi-row Layout in the {ProductName} extends the rendering capabilities of
-The declaration of Multi-row Layout is achieved through component. Each component should be considered as a block, containing one or multiple `Column` components. Some of the grid features work on block level (those are listed in the "Feature Integration" section below). For example the virtualization will use the block to determine the virtual chunks, so for better performance split the columns into more blocks if the layout allows it. There should be no columns outside of those blocks and no usage of when configuring a multi-row layout. Multi-row Layout is implemented on top of the [grid layout](https://www.w3.org/TR/css-grid-1/) specification and should conform to its requirements.
+The declaration of Multi-row Layout is achieved through component. Each component should be considered as a block, containing one or multiple components. Some of the grid features work on block level (those are listed in the "Feature Integration" section below). For example the virtualization will use the block to determine the virtual chunks, so for better performance split the columns into more blocks if the layout allows it. There should be no columns outside of those blocks and no usage of when configuring a multi-row layout. Multi-row Layout is implemented on top of the [grid layout](https://www.w3.org/TR/css-grid-1/) specification and should conform to its requirements.
-The `Column` component exposes four `Input` properties to determine the location and span of each cell:
+The component exposes four `Input` properties to determine the location and span of each cell:
- - column index from which the field is starting. This property is **mandatory**.
- - row index from which the field is starting. This property is **mandatory**.
- - 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. This property is **optional**. If not set defaults to **colStart + 1**.
@@ -135,12 +135,12 @@ The result of the above configuration can be seen on the screenshot below:
- and properties must be set for each `Column` into a . The component is not verifying if the layout is correct and not throwing errors or warnings about that. The developers must make sure that the declaration of their layout is correct and complete, otherwise they may end up in broken layout with misalignments, overlaps and browser inconsistencies.
+ and properties must be set for each into a . The component is not verifying if the layout is correct and not throwing errors or warnings about that. The developers must make sure that the declaration of their layout is correct and complete, otherwise they may end up in broken layout with misalignments, overlaps and browser inconsistencies.
## Feature Integration
-Due to the completely different rendering approach of Multi-row Layout, some of the column features will work only on component. Such features are Column Pinning and Column Hiding. Otherwise - Sorting and Grouping will work in the same way - on the `Column` component.
+Due to the completely different rendering approach of Multi-row Layout, some of the column features will work only on component. Such features are Column Pinning and Column Hiding. Otherwise - Sorting and Grouping will work in the same way - on the component.
- Filtering - only Excel Style Filtering is supported. Setting explicitly to `FilterMode.quickFilter` has no effect.
- Paging - works on records, not visual rows.
@@ -229,7 +229,7 @@ In the below steps, we are going through the steps of customizing the grid's Mul
### Importing Global Theme
-To begin the customization of the Multi-row Layout feature, you need to import the `Index` file, where all styling functions and mixins are located.
+To begin the customization of the Multi-row Layout feature, you need to import the file, where all styling functions and mixins are located.
```scss
@use "igniteui-angular/theming" as *;
diff --git a/docs/xplat/src/content/en/components/grids/_shared/paging.mdx b/docs/xplat/src/content/en/components/grids/_shared/paging.mdx
index e6a2a6d3db..a92d05734d 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/paging.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/paging.mdx
@@ -186,7 +186,7 @@ TO-DO H-GRID CODE SNIPPET
### Paginator Configuration within Child Grids
-Due to certain limitations in how the child grids of an are implemented and how DI scope works, when defining a paginator component inside the `RowIsland` tags, always make sure to use the directive on the paginator itself. This will make sure that the child grid have the correct paginator instance as a reference:
+Due to certain limitations in how the child grids of an are implemented and how DI scope works, when defining a paginator component inside the tags, always make sure to use the directive on the paginator itself. This will make sure that the child grid have the correct paginator instance as a reference:
diff --git a/docs/xplat/src/content/en/components/grids/_shared/remote-data-operations.mdx b/docs/xplat/src/content/en/components/grids/_shared/remote-data-operations.mdx
index 2f358a86c8..bd712812e0 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/remote-data-operations.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/remote-data-operations.mdx
@@ -73,7 +73,7 @@ BLAZOR CODE SNIPPET HERE
```
-When requesting data, you need to utilize the interface, which provides the and properties.
+When requesting data, you need to utilize the interface, which provides the and properties.
The first will always be 0 and should be determined by you based on the specific application scenario.
@@ -98,7 +98,7 @@ The first .
-To implement infinite scroll, you have to fetch the data in chunks. The data that is already fetched should be stored locally and you have to determine the length of a chunk and how many chunks there are. You also have to keep a track of the last visible data row index in the grid. In this way, using the and properties, you can determine if the user scrolls up and you have to show them already fetched data or scrolls down and you have to fetch more data from the end-point.
+To implement infinite scroll, you have to fetch the data in chunks. The data that is already fetched should be stored locally and you have to determine the length of a chunk and how many chunks there are. You also have to keep a track of the last visible data row index in the grid. In this way, using the and properties, you can determine if the user scrolls up and you have to show them already fetched data or scrolls down and you have to fetch more data from the end-point.
@@ -299,7 +299,7 @@ BLAZOR CODE SNIPPET HERE
```
-When remote sorting and filtering are provided, usually we do not need the built-in sorting and filtering of the grid. We can disable them by setting the and the inputs of the grid to the and the respective instances.
+When remote sorting and filtering are provided, usually we do not need the built-in sorting and filtering of the grid. We can disable them by setting the and the inputs of the grid to the and the respective instances.
```html
-When remote filtering is provided, usually we do not need the built-in filtering of the Tree Grid. We can disable it by setting the input of the Tree Grid to the instance.
+When remote filtering is provided, usually we do not need the built-in filtering of the Tree Grid. We can disable it by setting the input of the Tree Grid to the instance.
```html
@@ -407,11 +407,11 @@ You can see the result of the code from above at the beginning of this article i
The list items inside the Excel Style Filtering dialog represent the unique values for the respective column. The generates these values based on its data source by default. In case of remote filtering, the grid data does not contain all the data from the server. In order to provide the unique values manually and load them on demand, we can take advantage of the 's input. This input is actually a method that provides three arguments:
-- `Column` - The respective column instance.
+- - The respective column instance.
- - The filtering expressions tree, which is reduced based on the respective column.
- `Done` - Callback that should be called with the newly generated column values when they are retrieved from the server.
-The developer can manually generate the necessary unique column values based on the information, that is provided by the `Column` and the arguments and then invoke the `Done` callback.
+The developer can manually generate the necessary unique column values based on the information, that is provided by the and the arguments and then invoke the `Done` callback.
When the `UniqueColumnValuesStrategy` input is provided, the default unique values generating process in the excel style filtering will not be used.
@@ -1340,7 +1340,7 @@ For further reference please check the full sample bellow:
-In this sample we will demonstrate how to display a certain number of root records per page no matter how many child records they have. In order to cancel the built-in Tree Grid paging algorithm, which displays a certain number of records no matter their level (root or child), we have to set the `PerPage` property to `Number.MAX_SAFE_INTEGER`.
+In this sample we will demonstrate how to display a certain number of root records per page no matter how many child records they have. In order to cancel the built-in Tree Grid paging algorithm, which displays a certain number of records no matter their level (root or child), we have to set the property to `Number.MAX_SAFE_INTEGER`.
```html
@@ -1365,7 +1365,7 @@ Now we can choose between setting-up our own custom paging template or using the
### Remote paging with default template
-If you want to use the default paging template, you need to set the Paginator's `TotalRecords` property, only then the grid will be able to calculate the total page number based on total remote records. When performing a remote pagination the Paginator will pass to the Grid only the data for the current page, so the grid will not try to paginate the provided data source. That's why we should set Grid's `PagingMode` property to `GridPagingMode.Remote`. Also it is necessary to either subscribe to `PagingDone` or `PerPageChange` events in order to fetch the data from your remote service, it depends on the use case which event will be used.
+If you want to use the default paging template, you need to set the Paginator's property, only then the grid will be able to calculate the total page number based on total remote records. When performing a remote pagination the Paginator will pass to the Grid only the data for the current page, so the grid will not try to paginate the provided data source. That's why we should set Grid's property to `GridPagingMode.Remote`. Also it is necessary to either subscribe to `PagingDone` or `PerPageChange` events in order to fetch the data from your remote service, it depends on the use case which event will be used.
```html
@@ -1446,7 +1446,7 @@ BLAZOR CODE SNIPPET HERE
### Remote Paging with Custom Paginator Content
-When we define a custom paginator content we need to define the content in a way to get the data only for the requested page and to pass the correct **skip** and **top** parameters to the remote service according to the selected page and items `PerPage`. We are going to use the in order to ease our example configuration, along with the `PageSizeSelectorComponent` and `PageNavigationComponent` that were introduced - `PageSize` will add the per page dropdown and label and `PageNav` will add the navigation action buttons and labels.
+When we define a custom paginator content we need to define the content in a way to get the data only for the requested page and to pass the correct **skip** and **top** parameters to the remote service according to the selected page and items . We are going to use the in order to ease our example configuration, along with the `PageSizeSelectorComponent` and `PageNavigationComponent` that were introduced - `PageSize` will add the per page dropdown and label and `PageNav` will add the navigation action buttons and labels.
```html
-As you can see in the `Paginate` method, custom pagination logic is performed, based on the `TotalPagesOnServer` value.
+As you can see in the method, custom pagination logic is performed, based on the `TotalPagesOnServer` value.
#### Remote Paging with Batch Editing Demo
diff --git a/docs/xplat/src/content/en/components/grids/_shared/row-adding.mdx b/docs/xplat/src/content/en/components/grids/_shared/row-adding.mdx
index d2160f2364..30b10c83c3 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/row-adding.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/row-adding.mdx
@@ -382,13 +382,13 @@ Then define a wi
> **Note**:
-> The input controlling the visibility of the add row button may use the action strip context (which is of type to fine tune which records the button shows for.
+> The input controlling the visibility of the add row button may use the action strip context (which is of type to fine tune which records the button shows for.
> **Note**:
-> The inputs controlling the visibility of the add row and add child buttons may use the action strip context (which is of type to fine tune which records the buttons show for.
+> The inputs controlling the visibility of the add row and add child buttons may use the action strip context (which is of type to fine tune which records the buttons show for.
diff --git a/docs/xplat/src/content/en/components/grids/_shared/row-pinning.mdx b/docs/xplat/src/content/en/components/grids/_shared/row-pinning.mdx
index 15681c614b..1ddee87fac 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/row-pinning.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/row-pinning.mdx
@@ -96,7 +96,7 @@ The built-in row pinning UI is enabled by adding an input of the `Row`. Pinned rows are rendered at the top of the by default and stay fixed through vertical scrolling of the unpinned rows in the body.
+Row pinning is controlled through the input of the `Row`. Pinned rows are rendered at the top of the by default and stay fixed through vertical scrolling of the unpinned rows in the body.
```typescript
@@ -142,7 +142,7 @@ this.Grid.UnpinRowAsync("ALFKI");
Note that the row ID is the primary key value, defined by the of the grid, or the record instance itself. Both methods return a boolean value indicating whether their respective operation is successful or not. Usually the reason they fail is that the row is already in the desired state.
-A row is pinned below the last pinned row. Changing the order of the pinned rows can be done by subscribing to the event and changing the property of the event arguments to the desired position index.
+A row is pinned below the last pinned row. Changing the order of the pinned rows can be done by subscribing to the event and changing the property of the event arguments to the desired position index.
```html
@@ -700,8 +700,8 @@ The sample will not be affected by the selected global theme from **Change Theme
## API References
-
-
+
+
## Additional Resources
diff --git a/docs/xplat/src/content/en/components/grids/_shared/row-selection.mdx b/docs/xplat/src/content/en/components/grids/_shared/row-selection.mdx
index 7f222e7c16..c56994b8c8 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/row-selection.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/row-selection.mdx
@@ -37,9 +37,9 @@ The sample below demonstrates the three types of , you just need to set the property. This property accepts values.
+In order to setup row selection in the , you just need to set the property. This property accepts values.
- exposes the following modes:
+ exposes the following modes:
- **None**
- **Single**
@@ -226,7 +226,7 @@ In this mode a parent's selection state entirely depends on the selection state
- Row selection will trigger event. This event gives you information about the **new selection**, **old selection**, the rows that have been **added** and **removed** from the old selection. Also the event is **cancellable**, so this allows you to prevent selection.
-- When row selection is enabled row selectors are displayed, but if you don't want to show them, you can set `HideRowSelectors` to **true**.
+- When row selection is enabled row selectors are displayed, but if you don't want to show them, you can set to **true**.
- When you switch between row selection modes at runtime, this will clear the previous row selection state.
@@ -309,7 +309,7 @@ This will add the rows which correspond to the data entries with IDs 1, 2 and 5
### Deselect Rows
-If you need to deselect rows programmatically, you can use the `DeselectRows` method.
+If you need to deselect rows programmatically, you can use the method.
```html
@@ -457,7 +457,7 @@ const handleRowSelectionChange = (args: IgrRowSelectionEventArgs) => {
Another useful API method that provides is . By default this method will select all data rows, but if filtering is applied, it will select only the rows that match the filter criteria. If you call the method with **false** parameter, `SelectAllRows(false)` will always select all data in the grid, even if filtering is applied.
-> **Note** Keep in mind that `SelectAllRows` will not select the rows that are deleted.
+> **Note** Keep in mind that will not select the rows that are deleted.
### Deselect All Rows
@@ -565,14 +565,14 @@ const mySelectedRows = [1,2,3];
You can template header and row selectors in the and also access their contexts which provide useful functionality for different scenarios.
-By default, the **handles all row selection interactions** on the row selector's parent container or on the row itself, leaving just the state visualization for the template. Overriding the base functionality should generally be done using the [RowSelectionChanging event](#row-selection-event). In case you implement a custom template with a `Click` handler which overrides the base functionality, you should stop the event's propagation to preserve the correct row state.
+By default, the **handles all row selection interactions** on the row selector's parent container or on the row itself, leaving just the state visualization for the template. Overriding the base functionality should generally be done using the [RowSelectionChanging event](#row-selection-event). In case you implement a custom template with a handler which overrides the base functionality, you should stop the event's propagation to preserve the correct row state.
#### Row Template
-To create a custom row selector template, within the `{ComponentSelector}` you can use the `RowSelectorTemplate` property. From the template you can access the implicitly provided context variable, with properties that give you information about the row's state.
+To create a custom row selector template, within the `{ComponentSelector}` you can use the property. From the template you can access the implicitly provided context variable, with properties that give you information about the row's state.
-The property shows whether the current row is selected or not while the `Index` property can be used to access the row index.
+The property shows whether the current row is selected or not while the property can be used to access the row index.
```html
@@ -652,7 +652,7 @@ const rowSelectorTemplate = (ctx: IgrRowSelectorTemplateContext) => {
```
-The `RowID` property can be used to get a reference of an `{ComponentSelector}` row. This is useful when you implement a `click` handler on the row selector element.
+The property can be used to get a reference of an `{ComponentSelector}` row. This is useful when you implement a `click` handler on the row selector element.
```html
@@ -689,7 +689,7 @@ const rowSelectorTemplate = (ctx: IgrRowSelectorTemplateContext) => {
```
-In the above example we are using an `Checkbox` and we bind `rowContext.selected` to its `Checked` property. See this in action in our [Row Numbering Demo](#row-numbering-demo).
+In the above example we are using an and we bind `rowContext.selected` to its property. See this in action in our [Row Numbering Demo](#row-numbering-demo).
@@ -701,9 +701,9 @@ The `rowContext.select()` and `rowContext.deselect()` methods are exposed in the
### Header Template
-To create a custom header selector template, within the , you can use the `HeadSelectorTemplate` property. From the template you can access the implicitly provided context variable, with properties that give you information about the header's state.
+To create a custom header selector template, within the , you can use the property. From the template you can access the implicitly provided context variable, with properties that give you information about the header's state.
-The `SelectedCount` property shows you how many rows are currently selected while `TotalCount` shows you how many rows there are in the in total.
+The property shows you how many rows are currently selected while shows you how many rows there are in the in total.
```html
@@ -743,7 +743,7 @@ public RenderFragment Template = (context) =>
```
-The `SelectedCount` and `TotalCount` properties can be used to determine if the head selector should be checked or indeterminate (partially selected).
+The and properties can be used to determine if the head selector should be checked or indeterminate (partially selected).
@@ -830,7 +830,7 @@ The `headContext.selectAll()` and `headContext.deselectAll()` methods are expose
### Row Numbering Demo
-This demo shows the usage of custom header and row selectors. The latter uses `RowContext.Index` to display row numbers and an `Checkbox` bound to `RowContext.Selected`.
+This demo shows the usage of custom header and row selectors. The latter uses `RowContext.Index` to display row numbers and an bound to `RowContext.Selected`.
@@ -858,9 +858,9 @@ This demo prevents some rows from being selected using the
-
-
-
+
+
+
## Additional Resources
diff --git a/docs/xplat/src/content/en/components/grids/_shared/search.mdx b/docs/xplat/src/content/en/components/grids/_shared/search.mdx
index cf8d60c46b..a893576b1f 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/search.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/search.mdx
@@ -789,7 +789,7 @@ Now let's allow the user to choose whether the search should be case sensitive a
```
-Now let's allow the user to choose whether the search should be case sensitive and/or by an exact match. For this purpose we can use the `IgrChip` component along with a boolean state variable to indicate whether the IgrChip is selected.
+Now let's allow the user to choose whether the search should be case sensitive and/or by an exact match. For this purpose we can use the `Chip` component along with a boolean state variable to indicate whether the Chip is selected.
```tsx
@@ -1374,7 +1374,7 @@ useEffect(() => {
|Limitation|Description|
|--- |--- |
-|Searching in cells with a template|The search functionality highlights work only for the default cell templates. If you have a column with custom cell template, the highlights will not work so you should either use alternative approaches, such as a column formatter, or set the `Searchable` property on the column to false.|
+|Searching in cells with a template|The search functionality highlights work only for the default cell templates. If you have a column with custom cell template, the highlights will not work so you should either use alternative approaches, such as a column formatter, or set the property on the column to false.|
|Remote Virtualization| The search will not work properly when using remote virtualization|
|Cells with cut off text| When the text in the cell is too large to fit and the text we are looking for is cut off by the ellipsis, we will still scroll to the cell and include it in the match count, but nothing will be highlighted |
diff --git a/docs/xplat/src/content/en/components/grids/_shared/selection.mdx b/docs/xplat/src/content/en/components/grids/_shared/selection.mdx
index fc4b7a7898..ac1e3394fc 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/selection.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/selection.mdx
@@ -75,7 +75,7 @@ Property property enables you to specify the following options for each `Column`. The corresponding column selection will be enabled or disabled if this property is set to true or false, respectively.
+The property enables you to specify the following options for each . The corresponding column selection will be enabled or disabled if this property is set to true or false, respectively.
This leads to the following three variations:
diff --git a/docs/xplat/src/content/en/components/grids/_shared/sorting.mdx b/docs/xplat/src/content/en/components/grids/_shared/sorting.mdx
index 5be6ce3bc2..a73dac4ed5 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/sorting.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/sorting.mdx
@@ -284,7 +284,7 @@ hierarchicalGridRef.current.sort([
-Sorting is performed using our algorithm. Any `Column` or `ISortingExpression` can use a custom implementation of the as a substitute algorithm. This is useful when custom sorting needs to be defined for complex template columns, or image columns, for example.
+Sorting is performed using our algorithm. Any or `ISortingExpression` can use a custom implementation of the as a substitute algorithm. This is useful when custom sorting needs to be defined for complex template columns, or image columns, for example.
As with the filtering behavior, you can clear the sorting state by using the method:
@@ -392,7 +392,7 @@ hierarchicalGridRef.current.clearSort();
-The of the is of different type compared to the of the `Column`, since they work in different scopes and expose different parameters.
+The of the is of different type compared to the of the , since they work in different scopes and expose different parameters.
@@ -921,7 +921,7 @@ Then set the related CSS properties to this class:
## API References
-
+
## Additional Resources
diff --git a/docs/xplat/src/content/en/components/grids/_shared/state-persistence.mdx b/docs/xplat/src/content/en/components/grids/_shared/state-persistence.mdx
index 1454eddecc..c580a7eb58 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/state-persistence.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/state-persistence.mdx
@@ -45,7 +45,7 @@ The {ProductName} State Persistence in {Platform} {ComponentTitle} allows develo
- **Columns**
- Multi column headers
- Columns order
- - Column properties defined by the interface.
+ - Column properties defined by the interface.
@@ -64,31 +64,31 @@ The {ProductName} State Persistence in {Platform} {ComponentTitle} allows develo
- **Columns**
- Multi column headers
- Columns order
- - Column properties defined by the interface.
+ - Column properties defined by the interface.
-- `Sorting`
-- `Filtering`
+-
+-
-
-
-- `Expansion`
--
- - Pivot Configuration properties defined by the interface.
+-
+-
+ - Pivot Configuration properties defined by the interface.
- Pivot Dimension and Value functions are restored using application level code, see [Restoring Pivot Configuration](state-persistence.md#restoring-pivot-configuration) section.
- Pivot Row and Column strategies are also restored using application level code, see [Restoring Pivot Strategies](state-persistence.md#restoring-pivot-strategies) section.
-- `Sorting`
-- `Filtering`
+-
+-
-
-
-- `Expansion`
--
- - Pivot Configuration properties defined by the interface.
+-
+-
+ - Pivot Configuration properties defined by the interface.
- Pivot Dimension and Value functions are restored using application level code, see [Restoring Pivot Configuration](state-persistence.md#restoring-pivot-configuration) section.
@@ -175,7 +175,7 @@ const sortingFilteringStates: IgcGridStateInfo = gridState.getState(['sorting',
```tsx
-// get an `IgrGridStateInfo` object, containing all features original state objects, as returned by the grid public API
+// get an `GridStateInfo` object, containing all features original state objects, as returned by the grid public API
const state: IgrGridStateInfo = gridStateRef.current.getState([]);
// get all features` state in a serialized JSON string
@@ -250,15 +250,15 @@ gridState.ApplyStateFromStringAsync(sortingFilteringStates, new string[0])
-The `Options` object implements the `IGridStateOptions` interface, i.e. for every key, which is the name of a certain feature, there is the boolean value indicating if this feature state will be tracked. method will not put the state of these features in the returned value and method will not restore state for them.
+The object implements the `IGridStateOptions` interface, i.e. for every key, which is the name of a certain feature, there is the boolean value indicating if this feature state will be tracked. method will not put the state of these features in the returned value and method will not restore state for them.
-The `Options` object implements the interface, i.e. for every key, which is the name of a certain feature, there is the boolean value indicating if this feature state will be tracked. / methods will not put the state of these features in the returned value and / methods will not restore state for them.
+The object implements the interface, i.e. for every key, which is the name of a certain feature, there is the boolean value indicating if this feature state will be tracked. / methods will not put the state of these features in the returned value and / methods will not restore state for them.
-The `Options` object implements the `GridStateOptions` interface, i.e. for every key, which is the name of a certain feature, there is the boolean value indicating if this feature state will be tracked. `GetStateAsStringAsync` methods will not put the state of these features in the returned value and `ApplyStateFromStringAsync` methods will not restore state for them.
+The object implements the interface, i.e. for every key, which is the name of a certain feature, there is the boolean value indicating if this feature state will be tracked. `GetStateAsStringAsync` methods will not put the state of these features in the returned value and `ApplyStateFromStringAsync` methods will not restore state for them.
@@ -652,7 +652,7 @@ public activeTemplate = (ctx: IgcCellTemplateContext) => {
-2 - Query the template view in the component using @ViewChild or @ViewChildren decorator. In the `ColumnInit` event handler, assign the template to the column `BodyTemplate` property:
+2 - Query the template view in the component using @ViewChild or @ViewChildren decorator. In the `ColumnInit` event handler, assign the template to the column property:
```typescript
@ViewChild('activeTemplate', { static: true }) public activeTemplate: TemplateRef;
@@ -665,7 +665,7 @@ public onColumnInit(column: IgxColumnComponent) {
-2 - In the `ColumnInit` event handler, assign the template to the column `BodyTemplate` property:
+2 - In the `ColumnInit` event handler, assign the template to the column property:
@@ -957,7 +957,7 @@ public onDimensionInit(event: any) {
## Restoring Child Grids
-Saving / Restoring state for the child grids is controlled by the `RowIslands` property and is enabled by default. will use the same options for saving/restoring features both for the root grid and all child grids down the hierarchy. For example, if we pass the following options:
+Saving / Restoring state for the child grids is controlled by the property and is enabled by default. will use the same options for saving/restoring features both for the root grid and all child grids down the hierarchy. For example, if we pass the following options:
``` html
@@ -1005,7 +1005,7 @@ gridState.options = { cellSelection: false, sorting: false, rowIslands: true };
-Then the API will return the state for all grids (root grid and child grids) features excluding `Selection` and `Sorting`. If later on the developer wants to restore only the `Filtering` state for all grids, use:
+Then the API will return the state for all grids (root grid and child grids) features excluding `Selection` and . If later on the developer wants to restore only the state for all grids, use:
```typescript
@@ -1021,7 +1021,7 @@ state.applyState(state, ['filtering', 'rowIslands']);
-Then the API will return the state for all grids (root grid and child grids) features excluding `Selection` and `Sorting`. If later on the developer wants to restore only the `Filtering` state for all grids, use:
+Then the API will return the state for all grids (root grid and child grids) features excluding `Selection` and . If later on the developer wants to restore only the state for all grids, use:
```razor
gridState.ApplyStateFromStringAsync(gridStateString, new string[] { "filtering", "rowIslands" });
@@ -1169,21 +1169,21 @@ state.applyState(gridState.columnSelection);
-- method uses JSON.stringify() method to convert the original objects to a JSON string. JSON.stringify() does not support Functions, thats why the directive will ignore the columns `Formatter`, `Filters`, `Summaries`, , , `CellStyles`, `HeaderTemplate` and `BodyTemplate` properties.
+- method uses JSON.stringify() method to convert the original objects to a JSON string. JSON.stringify() does not support Functions, thats why the directive will ignore the columns , , , , , , and properties.
-- method uses JSON.stringify() method to convert the original objects to a JSON string. JSON.stringify() does not support Functions, thats why the component will ignore the columns `Formatter`, `Filters`, `Summaries`, , , `CellStyles`, `HeaderTemplate` and `BodyTemplate` properties.
+- method uses JSON.stringify() method to convert the original objects to a JSON string. JSON.stringify() does not support Functions, thats why the component will ignore the columns , , , , , , and properties.
-- method uses JSON.stringify() method to convert the original objects to a JSON string. JSON.stringify() does not support Functions, thats why the component will ignore the columns `Formatter`, `Filters`, `Summaries`, , , `CellStyles`, `HeaderTemplate` and `BodyTemplate` properties.
+- method uses JSON.stringify() method to convert the original objects to a JSON string. JSON.stringify() does not support Functions, thats why the component will ignore the columns , , , , , , and properties.
-- method uses JSON.stringify() method to convert the original objects to a JSON string. JSON.stringify() does not support Functions, thats why the directive will ignore the pivot dimension `MemberFunction`, pivot values `Member`, `Formatter`, custom `Aggregate` functions, `Styles` and pivot configuration strategies: `ColumnStrategy` and `RowStrategy`.
+- method uses JSON.stringify() method to convert the original objects to a JSON string. JSON.stringify() does not support Functions, thats why the directive will ignore the pivot dimension `MemberFunction`, pivot values , , custom functions, and pivot configuration strategies: and .
@@ -1194,9 +1194,9 @@ state.applyState(gridState.columnSelection);
-
-
-
+
+
+
## Additional Resources
diff --git a/docs/xplat/src/content/en/components/grids/_shared/summaries.mdx b/docs/xplat/src/content/en/components/grids/_shared/summaries.mdx
index 6906856a83..873a8f61d0 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/summaries.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/summaries.mdx
@@ -48,7 +48,7 @@ For `date` data type, the following functions are available:
All available column data types could be found in the official [Column types topic](column-types.md#default-template).
- summaries are enabled per-column by setting property to **true**. It is also important to keep in mind that the summaries for each column are resolved according to the column data type. In the the default column data type is `string`, so if you want `number` or `date` specific summaries you should specify the property as `number` or `date`. Note that the summary values will be displayed localized, according to the grid `Locale` and column .
+ summaries are enabled per-column by setting property to **true**. It is also important to keep in mind that the summaries for each column are resolved according to the column data type. In the the default column data type is `string`, so if you want `number` or `date` specific summaries you should specify the property as `number` or `date`. Note that the summary values will be displayed localized, according to the grid and column .
@@ -510,7 +510,7 @@ If these functions do not fulfill your requirements you can provide a custom sum
-In order to achieve this you have to override one of the base classes , or according to the column data type and your needs. This way you can redefine the existing function or you can add new functions. class provides the default implementation only for the `Count` method. extends and provides implementation for the `Min`, `Max`, `Sum` and `Average`. extends and additionally gives you `Earliest` and `Latest`.
+In order to achieve this you have to override one of the base classes , or according to the column data type and your needs. This way you can redefine the existing function or you can add new functions. class provides the default implementation only for the method. extends and provides implementation for the , , and . extends and additionally gives you and .
@@ -634,9 +634,9 @@ class PtoSummary {
-As seen in the examples, the base classes expose the `Operate` method, so you can choose to get all default summaries and modify the result, or calculate entirely new summary results.
+As seen in the examples, the base classes expose the method, so you can choose to get all default summaries and modify the result, or calculate entirely new summary results.
-The method returns a list of .
+The method returns a list of .
```typescript
@@ -662,12 +662,12 @@ and take optional parameters for calculating the summaries.
See [Custom summaries, which access all data](#custom-summaries-which-access-all-data) section below.
-In order to calculate the summary row height properly, the {ComponentTitle} needs the `Operate` method to always return an array of `SummaryResult` with the proper length even when the data is empty.
+In order to calculate the summary row height properly, the {ComponentTitle} needs the method to always return an array of with the proper length even when the data is empty.
-In order to calculate the summary row height properly, the {ComponentTitle} needs the method to always return an array of with the proper length even when the data is empty.
+In order to calculate the summary row height properly, the {ComponentTitle} needs the method to always return an array of with the proper length even when the data is empty.
@@ -807,7 +807,7 @@ igRegisterScript("WebHierarchicalGridCustomSummary", (event) => {
-And now let's add our custom summary to the column `Title`. We will achieve that by setting the Summaries` property to the class we create below.
+And now let's add our custom summary to the column . We will achieve that by setting the Summaries` property to the class we create below.
```html
<{ComponentSelector} #treeGrid [data]="data" [autoGenerate]="false" height="800px" width="800px">
@@ -867,7 +867,7 @@ igRegisterScript("WebTreeGridCustomSummary", (event) => {
### Custom summaries, which access all data
- Now you can access all {ComponentTitle} data inside the custom column summary. Two additional optional parameters are introduced in the `SummaryOperand` `Operate` method.
+ Now you can access all {ComponentTitle} data inside the custom column summary. Two additional optional parameters are introduced in the method.
As you can see in the code snippet below the operate method has the following three parameters:
- columnData - gives you an array that contains the values only for the current column
- allGridData - gives you the whole grid data source
@@ -1064,7 +1064,7 @@ When a default summary is defined, the height of the summary area is calculated
-Column summary template could be defined through API by setting the column `SummaryTemplate` property to the required TemplateRef.
+Column summary template could be defined through API by setting the column property to the required TemplateRef.
@@ -1199,7 +1199,7 @@ At runtime, summaries can also be dynamically disabled using the
## Formatting summaries
-By default, summary results, produced by the built-in summary operands, are localized and formatted according to the grid `Locale` and column . When using custom operands, the `Locale` and are not applied. If you want to change the default appearance of the summary results, you may format them using the property.
+By default, summary results, produced by the built-in summary operands, are localized and formatted according to the grid and column . When using custom operands, the and are not applied. If you want to change the default appearance of the summary results, you may format them using the property.
```typescript
public dateSummaryFormat(summary: IgxSummaryResult, summaryOperand: IgxSummaryOperand): string {
@@ -1284,14 +1284,14 @@ When you have grouped by columns, the property are:
-- - Summaries are calculated only for the root level.
-- - Summaries are calculated only for the child levels.
-- - Summaries are calculated for both root and child levels. This is the default value.
+- - Summaries are calculated only for the root level.
+- - Summaries are calculated only for the child levels.
+- - Summaries are calculated for both root and child levels. This is the default value.
The available values of the property are:
-- - The summary row appears before the group by row children.
-- - The summary row appears after the group by row children. This is the default value.
+- - The summary row appears before the group by row children.
+- - The summary row appears after the group by row children. This is the default value.
The property is boolean. Its default value is set to **false**, which means that the summary row would be hidden when the group row is collapsed. If the property is set to **true** the summary row stays visible when group row is collapsed.
@@ -1315,14 +1315,14 @@ The supports sep
The available values of the property are:
-- - Summaries are calculated only for the root level nodes.
-- - Summaries are calculated only for the child levels.
-- - Summaries are calculated for both root and child levels. This is the default value.
+- - Summaries are calculated only for the root level nodes.
+- - Summaries are calculated only for the child levels.
+- - Summaries are calculated for both root and child levels. This is the default value.
The available values of the property are:
-- - The summary row appears before the list of child rows.
-- - The summary row appears after the list of child rows. This is the default value.
+- - The summary row appears before the list of child rows.
+- - The summary row appears after the list of child rows. This is the default value.
The property is boolean. Its default value is set to **false**, which means that the summary row would be hidden when the parent row is collapsed. If the property is set to **true** the summary row stays visible when parent row is collapsed.
@@ -1560,7 +1560,7 @@ Don't forget to include the themes in the same way as it was demonstrated above.
-
+
diff --git a/docs/xplat/src/content/en/components/grids/_shared/toolbar.mdx b/docs/xplat/src/content/en/components/grids/_shared/toolbar.mdx
index b5d9c748f9..b5ff4506f1 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/toolbar.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/toolbar.mdx
@@ -264,7 +264,7 @@ The predefined and
-As seen in the code snippet above, the predefined `Actions` UI components are wrapped in the container. This way, the toolbar title is aligned to the left of the toolbar and the actions are aligned to the right of the toolbar.
+As seen in the code snippet above, the predefined UI components are wrapped in the container. This way, the toolbar title is aligned to the left of the toolbar and the actions are aligned to the right of the toolbar.
Of course, each of these UIs can be added independently of each other, or may not be added at all. This way the toolbar container will be rendered empty:
@@ -637,7 +637,7 @@ toolbar interaction components.
-Each action now exposes a way to change the overlay settings of the actions dialog by using the `OverlaySettings` input. For example:
+Each action now exposes a way to change the overlay settings of the actions dialog by using the input. For example:
```html
@@ -1217,7 +1217,7 @@ The following sample demonstrates how to customize the exported files:
When using the default toolbar exporter component, whenever an export operation takes place the toolbar will show a progress indicator while the operation is in progress.
-Moreover, users can set the toolbar `ShowProgress` property and use for their own long running operations or just as another way to signify an action taking place in the grid.
+Moreover, users can set the toolbar property and use for their own long running operations or just as another way to signify an action taking place in the grid.
The sample belows uses has significant amount of data, in order to increase the time needed for data export so the progressbar can be seen. Additionally it has another button that simulates a long running operation in the grid:
diff --git a/docs/xplat/src/content/en/components/grids/_shared/validation.mdx b/docs/xplat/src/content/en/components/grids/_shared/validation.mdx
index 63675c8d3d..c5dd25c8df 100644
--- a/docs/xplat/src/content/en/components/grids/_shared/validation.mdx
+++ b/docs/xplat/src/content/en/components/grids/_shared/validation.mdx
@@ -20,7 +20,7 @@ The {Platform} {ComponentName} provides editing that has a built-in Validation m
### Configure via Template-Driven Configuration
-We extend some of the {Platform} Forms validator to directly work with the `Column`. The same validators are available as attributes to be set declaratively in `Column`. The following validators are supported out-of-the-box:
+We extend some of the {Platform} Forms validator to directly work with the . The same validators are available as attributes to be set declaratively in . The following validators are supported out-of-the-box:
- Required
- Min
@@ -51,7 +51,7 @@ The following sample demonstrates how to use the prebuilt `Required`, `Email` an
### Configure via Reactive Forms
-We expose the that will be used for validation when editing starts on a row/cell via a event. You can modify it by adding your own validators for the related fields:
+We expose the that will be used for validation when editing starts on a row/cell via a event. You can modify it by adding your own validators for the related fields:
```html
@@ -117,7 +117,7 @@ Invalid states will persis until the validation errors in them are fixed accordi
Validation will be triggered in the following scenarios:
-- While editing via the cell editor based on the grid's . Either on `Change` while typing in the editor, or on `Blur` when the editor loses focus or closes.
+- While editing via the cell editor based on the grid's . Either on `Change` while typing in the editor, or on `Blur` when the editor loses focus or closes.
- When updating cells/rows via the API - , , etc.
- When using batch editing and the `Undo`/`Redo` API of the transaction service.
@@ -130,7 +130,7 @@ Validation will not trigger for records that have not been edited via user input
### Set a custom validator
-You can define your own validation directive to use on a `Column` in the template.
+You can define your own validation directive to use on a in the template.
```ts
@Directive({
@@ -202,7 +202,7 @@ The below example demonstrates the above-mentioned customization options.
In some scenarios validation of one field may depend on the value of another field in the record.
-In that case a custom validator can be used to compare the values in the record via their shared .
+In that case a custom validator can be used to compare the values in the record via their shared .
The below sample demonstrates a cross-field validation between different field of the same record. It checks the dates validity compared to the current date and between the active and created on date of the record as well as the deals won/lost ration for each employee. All errors are collected in a separate pinned column that shows that the record is invalid and displays the related errors.
@@ -257,7 +257,7 @@ public calculateDealsRatio(dealsWon, dealsLost) {
```
-The cross-field validator can be added to the of the row from `FormGroupCreated` event, which returns the new for each row when entering edit mode:
+The cross-field validator can be added to the of the row from `FormGroupCreated` event, which returns the new for each row when entering edit mode:
```html
@@ -457,7 +457,7 @@ private rowValidator(): ValidatorFn {
}
```
-The cross-field validator can be added to the of the row from `FormGroupCreated` event, which returns the new for each row when entering edit mode:
+The cross-field validator can be added to the of the row from `FormGroupCreated` event, which returns the new for each row when entering edit mode:
```html
supports rem
When needing to customize one of the existing templates in the grid, Blazor provides two possible ways to define a template:
-- via a server-side template, using the related component property (i.e. `BodyTemplate` property) or declaratively with the template name. For example:
+- via a server-side template, using the related component property (i.e. property) or declaratively with the template name. For example:
```razor
diff --git a/docs/xplat/src/content/en/components/grids/data-grid.mdx b/docs/xplat/src/content/en/components/grids/data-grid.mdx
index 87a156cc2a..ab0d42d860 100644
--- a/docs/xplat/src/content/en/components/grids/data-grid.mdx
+++ b/docs/xplat/src/content/en/components/grids/data-grid.mdx
@@ -381,7 +381,7 @@ constructor() {
Each of the columns of the grid can be templated separately. The column expects `ng-template` Angular grid module directives.
-It also expose `AdditionalTemplateContext` input that can be used for custom properties and any type of data context that you want to pass to the column itself:
+It also expose input that can be used for custom properties and any type of data context that you want to pass to the column itself:
```html
@@ -574,7 +574,7 @@ function nameCellTemplate(ctx: IgrCellTemplateContext) {
-In the snippet above we take a reference to the implicitly provided cell value. This is sufficient if you just want to present some data and maybe apply some custom styling or pipe transforms over the value of the cell. However even more useful is to take the `Cell` instance itself as shown below:
+In the snippet above we take a reference to the implicitly provided cell value. This is sufficient if you just want to present some data and maybe apply some custom styling or pipe transforms over the value of the cell. However even more useful is to take the instance itself as shown below:
@@ -753,7 +753,7 @@ If the data in a cell is bound with `[(ngModel)]` and the value change is not ha
-When properly implemented, the cell editing template also ensures that the cell's `EditValue` will correctly pass through the grid [editing event cycle](grid/editing.md#event-arguments-and-sequence).
+When properly implemented, the cell editing template also ensures that the cell's will correctly pass through the grid [editing event cycle](grid/editing.md#event-arguments-and-sequence).
### Cell Editing Template
@@ -854,7 +854,7 @@ function updateValue(event, value) {
-Make sure to check the API for the in order to get accustomed with the provided properties you can use in your templates.
+Make sure to check the API for the in order to get accustomed with the provided properties you can use in your templates.
### Column Template API
@@ -1074,11 +1074,11 @@ The code above will make the **ProductName** column sortable and editable and wi
There are optional parameters for formatting:
-- `Format` - determines what date/time parts are displayed, defaults to `'mediumDate'`, equivalent to **'MMM d, y'**
-- `Timezone` - the timezone offset for dates. By default uses the end-user's local system timezone
-- `DigitsInfo` - decimal representation objects. Default to **1.0-3**
+- - determines what date/time parts are displayed, defaults to `'mediumDate'`, equivalent to **'MMM d, y'**
+- - the timezone offset for dates. By default uses the end-user's local system timezone
+- - decimal representation objects. Default to **1.0-3**
-To allow customizing the display format by these parameters, the input is exposed. A column will respect only the corresponding properties for its data type, if `PipeArgs` is set. Example:
+To allow customizing the display format by these parameters, the input is exposed. A column will respect only the corresponding properties for its data type, if is set. Example:
@@ -1163,7 +1163,7 @@ const columnPipeArgs: IgrColumnPipeArgs = {
-The `OrderDate` column will respect only the `Format` and `Timezone` properties, while the `UnitPrice` will only respect the `DigitsInfo`.
+The `OrderDate` column will respect only the and properties, while the `UnitPrice` will only respect the .
All available column data types could be found in the official [Column types topic](grid/column-types.md#default-template).
@@ -1204,7 +1204,7 @@ const POJO = [{
>**WARNING**:
>**The key values must not contain arrays**.
->If you use `AutoGenerate` columns **the data keys must be identical.**
+>If you use columns **the data keys must be identical.**
@@ -1489,7 +1489,7 @@ That is all sorting and filtering operations work out of the box without any add
configuration. Same goes for grouping and editing operations with or without transactions as well as the ability to template the cells of the bound column.
>**WARNING**
->The grids **do not** support this kind of binding for `PrimaryKey`, `ForeignKey` and `ChildKey` properties where applicable.
+>The grids **do not** support this kind of binding for , `ForeignKey` and `ChildKey` properties where applicable.
{/* NOTE this sample is differed */}
@@ -1932,7 +1932,7 @@ And the result from this configuration is:
### Working with Flat Data Overview
-The flat data binding approach is similar to the one that we already described above, but instead of **cell value** we are going to use the property of the .
+The flat data binding approach is similar to the one that we already described above, but instead of **cell value** we are going to use the property of the .
Since the {Platform} grid is a component for **rendering**, **manipulating** and **preserving** data records, having access to **every data record** gives you the opportunity to customize the approach of handling it. The `data` property provides you this opportunity.
@@ -2339,7 +2339,7 @@ See the [Grid Sizing](sizing.md) topic. */}
## Performance (Experimental)
-Design of the `Grid` allows it to take advantage of the Event Coalescing feature that has Angular introduced. This feature allows for improved performance with roughly around **20%** in terms of interactions and responsiveness. This feature can be enabled on application level by simply setting the `ngZoneEventCoalescing` and `ngZoneRunCoalescing` properties to **true** in the `bootstrapModule` method:
+Design of the allows it to take advantage of the Event Coalescing feature that has Angular introduced. This feature allows for improved performance with roughly around **20%** in terms of interactions and responsiveness. This feature can be enabled on application level by simply setting the `ngZoneEventCoalescing` and `ngZoneRunCoalescing` properties to **true** in the `bootstrapModule` method:
```typescript
platformBrowserDynamic()
@@ -2437,14 +2437,14 @@ To facilitate your work, apply the comment in the `src/styles.scss` file.
-
+
-
-
-
-
+
+
+
+
## Theming Dependencies
@@ -2463,7 +2463,7 @@ To facilitate your work, apply the comment in the `src/styles.scss` file.
## Tutorial video
-Learn more about creating a {Platform} `Grid` in our short tutorial video:
+Learn more about creating a {Platform} in our short tutorial video:
diff --git a/docs/xplat/src/content/en/components/grids/grid/groupby.mdx b/docs/xplat/src/content/en/components/grids/grid/groupby.mdx
index 5a22b68206..635836066e 100644
--- a/docs/xplat/src/content/en/components/grids/grid/groupby.mdx
+++ b/docs/xplat/src/content/en/components/grids/grid/groupby.mdx
@@ -269,9 +269,9 @@ Up until now, grouping/sorting worked in conjunction with each other. In 13.2 ve
### Expand/Collapse API
-In addition to grouping expressions you can also control the expansion states for group rows. They are stored in a separate property of the component which is a collection of . Each expansion state is uniquely defined by the field name it is created for and the value it represents for each level of grouping, i.e. the identifier is a hierarchy array of .
+In addition to grouping expressions you can also control the expansion states for group rows. They are stored in a separate property of the component which is a collection of . Each expansion state is uniquely defined by the field name it is created for and the value it represents for each level of grouping, i.e. the identifier is a hierarchy array of .
-As with , setting a list of directly to the will change the expansion accordingly. Additionally exposes a method that toggles a group by the group record instance or via the property of the row.
+As with , setting a list of directly to the will change the expansion accordingly. Additionally exposes a method that toggles a group by the group record instance or via the property of the row.
@@ -409,7 +409,7 @@ this.grid.DeselectRowsInGroup(row.GroupRow);
### Group Row Templates
-The group row except for the expand/collapse UI is fully templatable. By default it renders a grouping icon and displays the field name and value it represents. The context to render the template against is of type .
+The group row except for the expand/collapse UI is fully templatable. By default it renders a grouping icon and displays the field name and value it represents. The context to render the template against is of type .
As an example, the following template would make the group rows summary more verbose:
@@ -464,9 +464,9 @@ igRegisterScript("WebGridGroupByRowTemplate", (ctx) => {
### Group Row Selector Templates
-As mentioned above the group row except for the expand/collapse UI is fully templatable. To create a custom Group By row selector template use `GroupByRowSelectorTemplate`. From the template, you can access the implicitly provided context variable, with properties that give you information about the Group By row's state.
+As mentioned above the group row except for the expand/collapse UI is fully templatable. To create a custom Group By row selector template use . From the template, you can access the implicitly provided context variable, with properties that give you information about the Group By row's state.
-The property shows how many of the group records are currently selected while shows how many records belong to the group.
+The property shows how many of the group records are currently selected while shows how many records belong to the group.
```html
@@ -513,7 +513,7 @@ igRegisterScript("GroupByRowSelectorTemplate", (ctx) => {
-The property returns a reference to the group row.
+The property returns a reference to the group row.
```html
@@ -561,7 +561,7 @@ igRegisterScript("GroupByRowSelectorTemplate", (ctx) => {
-The and properties can be used to determine if the Group By row selector should be checked or indeterminate (partially selected).
+The and properties can be used to determine if the Group By row selector should be checked or indeterminate (partially selected).
@@ -620,7 +620,7 @@ Grid allows defining custom grouping per column or per grouping expression, whic
-In order to implement custom grouping the data first needs to be sorted appropriately. Due to this you may also need to apply a custom sorting strategy that extends the base `DefaultSortingStrategy`. After the data is sorted the custom groups can be determined by specifying a `GroupingComparer` for the column or for the specific grouping expression.
+In order to implement custom grouping the data first needs to be sorted appropriately. Due to this you may also need to apply a custom sorting strategy that extends the base `DefaultSortingStrategy`. After the data is sorted the custom groups can be determined by specifying a for the column or for the specific grouping expression.
@@ -638,7 +638,7 @@ The sample below demonstrates custom grouping by `Date`, where the date values a
The sample defines custom sorting for the different date conditions.
-Each custom strategy defines the method, which is the custom compare function used when sorting the values. Additionally it extracts the values from the date needed for the comparison.
+Each custom strategy defines the method, which is the custom compare function used when sorting the values. Additionally it extracts the values from the date needed for the comparison.
@@ -676,7 +676,7 @@ function getParsedDate(date: any) {
-A function is defined for the grouping expressions, which determines the items belonging to the same group based on the selected grouping mode. Values in the sorted data for which this function returns 0 are marked as part of the same group.
+A function is defined for the grouping expressions, which determines the items belonging to the same group based on the selected grouping mode. Values in the sorted data for which this function returns 0 are marked as part of the same group.
```typescript
grid.groupingExpressions = [
diff --git a/docs/xplat/src/content/en/components/grids/grid/master-detail.mdx b/docs/xplat/src/content/en/components/grids/grid/master-detail.mdx
index a37e9c1a26..4d985077a6 100644
--- a/docs/xplat/src/content/en/components/grids/grid/master-detail.mdx
+++ b/docs/xplat/src/content/en/components/grids/grid/master-detail.mdx
@@ -185,4 +185,4 @@ Additional API methods for controlling the expansion states are also exposed:
-
+
diff --git a/docs/xplat/src/content/en/components/grids/grid/selection-based-aggregates.mdx b/docs/xplat/src/content/en/components/grids/grid/selection-based-aggregates.mdx
index e89474ceda..4f6ef45563 100644
--- a/docs/xplat/src/content/en/components/grids/grid/selection-based-aggregates.mdx
+++ b/docs/xplat/src/content/en/components/grids/grid/selection-based-aggregates.mdx
@@ -18,7 +18,7 @@ With the sample, illustrated beyond, you may see how multiple selection is being
## Topic Overview
To achieve the selection-based aggregates functionality, you can use our `Grid Selection` feature, together with the `Grid Summaries`.
-The Summaries are allowing for customization of the basic Summary feature functionality through extending one of the base classes, `SummaryOperand`, `NumberSummaryOperand`.html) or `DateSummaryOperand`, depending on the column data type and your needs.
+The Summaries are allowing for customization of the basic Summary feature functionality through extending one of the base classes, , .html) or , depending on the column data type and your needs.
## Selection
To start working with the data in the selected grid range, you will have to subscribe to events that are notifying of changes in the grid selection. That can be done by subscribing to the `selected` event and to the `rangeSelected` event. You need to bind to both of them because the Selection feature differentiates between selecting a single cell and selecting a range of cells.
@@ -28,7 +28,7 @@ In the events subscription logic, you can extract the selected data using the gr
## Summary
Within the custom summary class, you'd have to be differentiating the types of data in the grid. For instance, in the scenario below, there are four different columns, whose type of data is suitable for custom summaries. These are the Unit Price, the Units in Stock, Discontinued status and the Order Date.
-The `operate` method of the derived class of the `SummaryOperand`, is where you will process the data, starting by casing it in different categories based on the data types:
+The `operate` method of the derived class of the , is where you will process the data, starting by casing it in different categories based on the data types:
```typescript
const numberData = data.filter(rec => typeof rec === "number");
@@ -40,7 +40,7 @@ const dates = data.filter(rec => isDate(rec));
Bear in mind, that `isDate` is a custom function.
-After having the data types grouped accordingly, you can proceed to the aggregation itself. For that reason, you could use the already exposed methods of the `NumberSummaryOperand` and `DateSummaryOperand`.
+After having the data types grouped accordingly, you can proceed to the aggregation itself. For that reason, you could use the already exposed methods of the and .
After that, you'd have to put the aggregated data in the same array, which would be returned to the template.
For the visualization of the data, you might want to use the grid footer, which in a combination with the `custom-summaries` class will give the natural look of the Summary.
diff --git a/docs/xplat/src/content/en/components/grids/hierarchical-grid/load-on-demand.mdx b/docs/xplat/src/content/en/components/grids/hierarchical-grid/load-on-demand.mdx
index 4433935143..16394aca56 100644
--- a/docs/xplat/src/content/en/components/grids/hierarchical-grid/load-on-demand.mdx
+++ b/docs/xplat/src/content/en/components/grids/hierarchical-grid/load-on-demand.mdx
@@ -16,7 +16,7 @@ import hgridDatabase from '@xplat-images/hgrid-database.jpg';
# Hierarchical Grid Load On Demand
-The Ignite UI for {Platform} `HierarchicalGrid` allows fast rendering by requesting the minimum amount of data to be retrieved from the server so that the user can see the result in view and interact with the visible data as quickly as possible. Initially only the root grid’s data is retrieved and rendered, only after the user expands a row containing a child grid, he will receive the data for that particular child grid. This mechanism, also known as Load on Demand, can be easily configured to work with any remote data.
+The Ignite UI for {Platform} allows fast rendering by requesting the minimum amount of data to be retrieved from the server so that the user can see the result in view and interact with the visible data as quickly as possible. Initially only the root grid’s data is retrieved and rendered, only after the user expands a row containing a child grid, he will receive the data for that particular child grid. This mechanism, also known as Load on Demand, can be easily configured to work with any remote data.
This topic demonstrates how to configure Load on Demand by creating a Remote Service Provider that communicates with an already available remote service. Here's the working demo and later we will go through it step by step and describe the process of creating it.
@@ -308,7 +308,7 @@ Next we will setup our hierarchical grid and connect it to our remote service pr
### Template defining
-First we will define our hierarchical grid template with the levels of hierarchy that we expect to have. We know that our root grid `PrimaryKey` for the customers is their `customerId`, for their orders on the first level - `orderId` and respectively for order details - `productId`. Knowing each database table and their keys allows us to define our initial template:
+First we will define our hierarchical grid template with the levels of hierarchy that we expect to have. We know that our root grid for the customers is their `customerId`, for their orders on the first level - `orderId` and respectively for order details - `productId`. Knowing each database table and their keys allows us to define our initial template:
@@ -472,7 +472,7 @@ We will easily set the data of the root grid after getting its data from the ser
-Setting the data for any child that has been expanded is a bit different. When a row is expanded for the first time, a new child `HierarchicalGrid` is rendered for it and we need to get the reference for the newly created grid to set its data. That is why each `RowIsland` component provides the `GridCreated` event that is fired when a new child grid is created for that specific row island. We can use that to get the reference we need for the new grid, request its data from the service, and apply it.
+Setting the data for any child that has been expanded is a bit different. When a row is expanded for the first time, a new child is rendered for it and we need to get the reference for the newly created grid to set its data. That is why each component provides the `GridCreated` event that is fired when a new child grid is created for that specific row island. We can use that to get the reference we need for the new grid, request its data from the service, and apply it.
We can use one method for all row islands since we built our service so that it needs only information if it is the root level, the key of the row island, the primary key of the parent row, and its unique identifier. All this information can be accessed either directly from the event arguments, or from the row island responsible for triggering the event.
@@ -516,7 +516,7 @@ Since the `GridCreated` event provides a reference to the row island, the `paren
-Since the `GridCreated` event provides the `parentID` property, a reference to the row island as `owner` and the new child `grid` property, it will be passed as the first argument. We are only missing information about the parent row's `primaryKey`, but we can easily determine that based on the row island `ChildDataKey`.
+Since the `GridCreated` event provides the `parentID` property, a reference to the row island as `owner` and the new child `grid` property, it will be passed as the first argument. We are only missing information about the parent row's `primaryKey`, but we can easily determine that based on the row island .
@@ -886,11 +886,11 @@ igRegisterScript("OnGridCreated", (args) => {
-With this, the setup of our application is almost done. This last step aims to improve the user experience by informing the user that the data is still loading so he doesn't have to look at an empty grid in the meantime. That's why the `HierarchicalGrid` supports a loading indicator that can be displayed while the grid is empty. If new data is received, the loading indicator will hide and the data will be rendered.
+With this, the setup of our application is almost done. This last step aims to improve the user experience by informing the user that the data is still loading so he doesn't have to look at an empty grid in the meantime. That's why the supports a loading indicator that can be displayed while the grid is empty. If new data is received, the loading indicator will hide and the data will be rendered.
### Setup of loading indication
-The `HierarchicalGrid` can display a loading indicator by setting the `IsLoading` property to **true** while there is no data. We need to set it initially for the root grid and also when creating new child grids, until their data is loaded. We could always set it to **true** in our template, but we want to hide it and display that the grid has no data if the service returns an empty array by setting it to **false**.
+The can display a loading indicator by setting the property to **true** while there is no data. We need to set it initially for the root grid and also when creating new child grids, until their data is loaded. We could always set it to **true** in our template, but we want to hide it and display that the grid has no data if the service returns an empty array by setting it to **false**.
In this case the final version of our configuration would look like this:
diff --git a/docs/xplat/src/content/en/components/grids/hierarchical-grid/overview.mdx b/docs/xplat/src/content/en/components/grids/hierarchical-grid/overview.mdx
index cfab809aad..2f0dd3cc07 100644
--- a/docs/xplat/src/content/en/components/grids/hierarchical-grid/overview.mdx
+++ b/docs/xplat/src/content/en/components/grids/hierarchical-grid/overview.mdx
@@ -634,7 +634,7 @@ function buildUrl(dataState) {
## Hide/Show row expand indicators
-If you have a way to provide information whether a row has children prior to its expanding, you could use the `HasChildrenKey` input property. This way you could provide a boolean property from the data objects which indicates whether an expansion indicator should be displayed.
+If you have a way to provide information whether a row has children prior to its expanding, you could use the input property. This way you could provide a boolean property from the data objects which indicates whether an expansion indicator should be displayed.
@@ -672,9 +672,9 @@ If you have a way to provide information whether a row has children prior to its
-Note that setting the `HasChildrenKey` property is not required. In case you don't provide it, expansion indicators will be displayed for each row.
+Note that setting the property is not required. In case you don't provide it, expansion indicators will be displayed for each row.
-Additionally if you wish to show/hide the header expand/collapse all indicator you can use the `ShowExpandAll` property.
+Additionally if you wish to show/hide the header expand/collapse all indicator you can use the property.
This UI is disabled by default for performance reasons and it is not recommended to enable it in grids with large data or grids with load on demand.
## Features
@@ -1024,4 +1024,4 @@ Then set the `--header-background` and `--header-text-color` CSS properties for
-
+
diff --git a/docs/xplat/src/content/en/components/grids/list.mdx b/docs/xplat/src/content/en/components/grids/list.mdx
index 78254d0c70..4bb431418a 100644
--- a/docs/xplat/src/content/en/components/grids/list.mdx
+++ b/docs/xplat/src/content/en/components/grids/list.mdx
@@ -12,11 +12,11 @@ import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
# {Platform} List Overview
-The {ProductName} List element is extremely useful when presenting a group of items. You can create a simple list of textual items, or a more complex one, containing an array of different layout elements. The `List` component displays rows of items and supports one or more headers as well. Each list item is completely templatable and will support any valid HTML or other components.
+The {ProductName} List element is extremely useful when presenting a group of items. You can create a simple list of textual items, or a more complex one, containing an array of different layout elements. The component displays rows of items and supports one or more headers as well. Each list item is completely templatable and will support any valid HTML or other components.
## {Platform} List Example
-The following example represents a list populated with contacts with a name and a phone number properties. The `List` component demonstrated below uses the `Avatar` and `Button` elements to enrich the user experience and expose the capabilities of setting avatar picture and buttons for text and call actions.
+The following example represents a list populated with contacts with a name and a phone number properties. The component demonstrated below uses the and elements to enrich the user experience and expose the capabilities of setting avatar picture and buttons for text and call actions.
@@ -53,7 +53,7 @@ First, you need to the install the corresponding {ProductName} npm package by ru
npm install igniteui-react
```
-You will then need to import the `List` and its necessary CSS, like so:
+You will then need to import the and its necessary CSS, like so:
```tsx
import { IgrList, IgrListHeader, IgrListItem } from 'igniteui-react';
@@ -64,7 +64,7 @@ import 'igniteui-webcomponents/themes/light/bootstrap.css';
-Before using the `List`, you need to register it as follows:
+Before using the , you need to register it as follows:
@@ -81,7 +81,7 @@ builder.Services.AddIgniteUIBlazor(typeof(IgbListModule));
-You will also need to link an additional CSS file to apply the styling to the `List` component. The following needs to be placed in the **wwwroot/index.html** file in a **Blazor Web Assembly** project or the **Pages/_Host.cshtml** file in a **Blazor Server** project:
+You will also need to link an additional CSS file to apply the styling to the component. The following needs to be placed in the **wwwroot/index.html** file in a **Blazor Web Assembly** project or the **Pages/_Host.cshtml** file in a **Blazor Server** project:
```razor
@@ -256,7 +256,7 @@ After implementing the above code, our list component should now look like the f
### Adding Avatar and Buttons
-We can use some of our other components in conjunction with the `List` component to enrich the experience and add some functionality. We can have a nice picture avatar to the left of the name and phone values. Additionally, we can add some buttons to the right of them to allow the user to text and call contacts, so let's update our contacts list component to show the avatar and the buttons. We can do that by using some of the list item's slots.
+We can use some of our other components in conjunction with the component to enrich the experience and add some functionality. We can have a nice picture avatar to the left of the name and phone values. Additionally, we can add some buttons to the right of them to allow the user to text and call contacts, so let's update our contacts list component to show the avatar and the buttons. We can do that by using some of the list item's slots.
@@ -405,9 +405,9 @@ We can use some of our other components in conjunction with the `List` component
-The `start` slot is meant to be used for adding some kind of media before all other content of our list items. The target element, in our case the `Avatar` component, will also be provided with a default position and spacing.
+The `start` slot is meant to be used for adding some kind of media before all other content of our list items. The target element, in our case the component, will also be provided with a default position and spacing.
-The `end` slot is meant to be used for list items that have some kind of action or metadata, represented, for example, by a switch, a button, a checkbox, etc. We will use `Button` components.
+The `end` slot is meant to be used for list items that have some kind of action or metadata, represented, for example, by a switch, a button, a checkbox, etc. We will use components.
Let's also allow the user to change the size of the list using the `--ig-size` CSS variable. We will add some radio buttons to display all size values. This way whenever one gets selected, we will change the size of the list.
@@ -510,7 +510,7 @@ The result of implementing the above code should look like the following:
## Styling
-The `List` exposes several CSS parts, giving you full control over its style:
+The exposes several CSS parts, giving you full control over its style:
|Name|Description|
|--|--|
@@ -541,20 +541,20 @@ igc-list-item::part(subtitle) {
-In this article we covered a lot of ground with the `List` component. First, we created a simple list with text items. Then, we created a list of contact items and added functionality to them by using some additional {ProductName} components, like the `Avatar` and `Button`. Finally, we changed the component's appearance through the exposed CSS parts.
+In this article we covered a lot of ground with the component. First, we created a simple list with text items. Then, we created a list of contact items and added functionality to them by using some additional {ProductName} components, like the and . Finally, we changed the component's appearance through the exposed CSS parts.
## API References
-
-
+
+
-
+
## Additional Resources
diff --git a/docs/xplat/src/content/en/components/grids/pivot-grid/features.mdx b/docs/xplat/src/content/en/components/grids/pivot-grid/features.mdx
index ab365f8687..a1edd2e079 100644
--- a/docs/xplat/src/content/en/components/grids/pivot-grid/features.mdx
+++ b/docs/xplat/src/content/en/components/grids/pivot-grid/features.mdx
@@ -17,7 +17,7 @@ import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
The pivot and flat grid components inherit from a common base and thus share some functionality and features.
-Some features do not have meaningful behavior in the context of a pivot table and therefore cannot be enabled for `PivotGrid`. These include:
+Some features do not have meaningful behavior in the context of a pivot table and therefore cannot be enabled for . These include:
- CRUD operations
- Grouping
- Row/Column Pinning
@@ -50,8 +50,8 @@ The filtering UI can be opened via the dimension chips filter icon and allows ex
If there is not enough space for all of the filtering chips, the {PivotGridTitle} will show the ones that were cut off into a dropdown. End-users can access and manipulate them there.
-Dimensions can also be filtered initially via the dimension configuration in `PivotConfiguration` with the dimension's `filter` property.
-It can be set to a new `FilteringExpressionsTree` with the related filter condition, for example:
+Dimensions can also be filtered initially via the dimension configuration in with the dimension's `filter` property.
+It can be set to a new with the related filter condition, for example:
```typescript
public filterExpTree = new FilteringExpressionsTree(FilteringLogic.And);
@@ -137,9 +137,9 @@ const dimension: IgrPivotDimension = {
## Dimensions Resizing
Row dimensions can be resized similarly to column resizing - via a resizing indicator that can be found on the right edge of the cells.
-They can also be auto-sized by double clicking the resize indicator, or by using the related API - `AutoSizeRowDimension`.
+They can also be auto-sized by double clicking the resize indicator, or by using the related API - .
-A different size can also be set initially with the `Width` property available in the dimension definition:
+A different size can also be set initially with the property available in the dimension definition:
@@ -236,7 +236,7 @@ The {PivotGridTitle} supports single selection which is enabled just like in the
In case there are multiple row or column dimensions which would create groups that span multiple rows/columns, selection is applied to all cells that belong to the selected group.
## Super Compact Mode
-The `PivotGrid` component provides a `SuperCompactMode` input. It is suitable for cases that require a lot of cells to be present on the screen at once. If enabled the option ignores the `--ig-size` CSS variable for the {PivotGridTitle}. Enabling `SuperCompactMode` also sets the `--ig-size` to `small` for each child component(like `Chip`) that does not have the `SuperCompactMode` option.
+The component provides a input. It is suitable for cases that require a lot of cells to be present on the screen at once. If enabled the option ignores the `--ig-size` CSS variable for the {PivotGridTitle}. Enabling also sets the `--ig-size` to `small` for each child component(like `Chip`) that does not have the option.
diff --git a/docs/xplat/src/content/en/components/grids/pivot-grid/overview.mdx b/docs/xplat/src/content/en/components/grids/pivot-grid/overview.mdx
index 65d507d8af..ef03fddd18 100644
--- a/docs/xplat/src/content/en/components/grids/pivot-grid/overview.mdx
+++ b/docs/xplat/src/content/en/components/grids/pivot-grid/overview.mdx
@@ -18,8 +18,8 @@ The {Platform} Pivot Grid is used for summing up and representing voluminous mul
The {Platform} Pivot Grid presents data in a pivot table and helps users performing complex analysis on the supplied data set. This sophisticated Pivot Grid control is used for organizing, summarizing, and filtering large volumes of data which is later displayed in a cross-table format. Key features of an {Platform} Pivot Grid are row dimensions, column dimensions, aggregations, and filters.
-The `PivotGrid` gives the ability to users to configure and display their data in a multi-dimensional pivot table structure.
-The rows and columns represent distinct data groups, and the data cell values represent aggregations. This allows complex data analysis based on a simple flat data set. The `PivotGrid` is a feature-rich pivot table that provides easy configuration of the different dimensions and values as well as additional data operations on them like filtering and sorting.
+The gives the ability to users to configure and display their data in a multi-dimensional pivot table structure.
+The rows and columns represent distinct data groups, and the data cell values represent aggregations. This allows complex data analysis based on a simple flat data set. The is a feature-rich pivot table that provides easy configuration of the different dimensions and values as well as additional data operations on them like filtering and sorting.
## {Platform} Pivot Grid Example
@@ -32,7 +32,7 @@ The following is an {Platform} Pivot Grid example in combination with the {Platf
## Getting Started With {Platform} Pivot Grid
-The {Platform} {PivotGridName} can be configured via the `PivotConfiguration` property.
+The {Platform} {PivotGridName} can be configured via the property.
@@ -76,14 +76,14 @@ A filter can also be defined via the **filters** configuration property. It can
### Dimensions Configuration
-Each basic dimension configuration requires a `MemberName` that matches a field from the provided **data**.
+Each basic dimension configuration requires a that matches a field from the provided **data**.
Multiple sibling dimensions can be defined, which creates a more complex nested group in the related row or column dimension area.
The dimensions can be reordered or moved from one area to another via their corresponding chips using drag & drop.
-A dimension can also describe an expandable hierarchy via the `ChildLevel` property, for example:
+A dimension can also describe an expandable hierarchy via the property, for example:
@@ -146,12 +146,12 @@ const dimension: IgrPivotDimension = {
-In this case the dimension renders an expander in the related section of the grid (row or column) and allows the children to be expanded or collapsed as part of the hierarchy. By default the row dimensions are initially expanded. This behavior can be controlled with the `DefaultExpandState` property of the Pivot Grid.
+In this case the dimension renders an expander in the related section of the grid (row or column) and allows the children to be expanded or collapsed as part of the hierarchy. By default the row dimensions are initially expanded. This behavior can be controlled with the property of the Pivot Grid.
### Predefined Dimensions
As part of the Pivot Grid some additional predefined dimensions are exposed for easier configuration:
-- `PivotDateDimension`
+-
Can be used for date fields. Describes the following hierarchy by default:
- All Periods
- Years
@@ -320,7 +320,7 @@ A value configuration requires a **member** that matches a field from the provid
- `PivotAggregate` - for any other data types. This is the base aggregation.
Contains the following aggregation functions: `COUNT`.
-The current aggregation function can be changed at runtime using the value chip's drop-down. By default, it displays a list of available aggregations based on the field's data type. A custom list of aggregations can also be set via the `AggregateList` property, for example:
+The current aggregation function can be changed at runtime using the value chip's drop-down. By default, it displays a list of available aggregations based on the field's data type. A custom list of aggregations can also be set via the property, for example:
@@ -484,12 +484,12 @@ public static totalMax: PivotAggregation = (members, data: any) => {
-The pivot value also provides a `DisplayName` property. It can be used to display a custom name for this value in the column header.
+The pivot value also provides a property. It can be used to display a custom name for this value in the column header.
### Enable Property
-`PivotConfiguration` is the interface that describes the current state of the `PivotGrid` component. With it the developer can declare fields of the data as **rows**, **columns**, **filters** or **values**. The configuration allows enabling or disabling each of these elements separately. Only enabled elements are included in the current state of the Pivot Grid. The `PivotDataSelector` component utilizes the same configuration and shows a list of all elements - enabled and disabled. For each of them there is a checkbox in the appropriate state. End-users can easily tweak the pivot state by toggling the different elements using these checkboxes.
-The `Enable` property controls if a given `PivotDimension` or `PivotValue` is active and takes part in the pivot view rendered by the Pivot Grid.
+ is the interface that describes the current state of the component. With it the developer can declare fields of the data as **rows**, **columns**, **filters** or **values**. The configuration allows enabling or disabling each of these elements separately. Only enabled elements are included in the current state of the Pivot Grid. The component utilizes the same configuration and shows a list of all elements - enabled and disabled. For each of them there is a checkbox in the appropriate state. End-users can easily tweak the pivot state by toggling the different elements using these checkboxes.
+The `Enable` property controls if a given or is active and takes part in the pivot view rendered by the Pivot Grid.
### Full Configuration Code
@@ -713,19 +713,19 @@ Using above code will result in the following example which groups the Date uniq
### Auto generate configuration
-The `AutoGenerateConfig` property automatically generates dimensions and values based on the data source fields:
+The property automatically generates dimensions and values based on the data source fields:
- Numeric Fields:
- - Created as `PivotValue` using `PivotNumericAggregate.sum` aggregator.
+ - Created as using `PivotNumericAggregate.sum` aggregator.
- Added to the values collection and enabled by default.
- Non-Numeric Fields:
- - Created as `PivotDimension`.
+ - Created as .
- Disabled by default.
- Added to the columns collection.
- Date Fields(only the first `date` field is enabled, the other `date` fields apply non-numeric fields rule):
- - Created as `PivotDateDimension`
+ - Created as
- Enabled by default
- added to the rows collection.
@@ -750,7 +750,7 @@ A more detailed view of how they are used can be seen bellow in example data, wh
];
```
-All of these are stored in the **pivotKeys** property which is part of the `PivotConfiguration` and can be used to change the default pivot keys.
+All of these are stored in the **pivotKeys** property which is part of the and can be used to change the default pivot keys.
- **children** - Field that stores children for hierarchy building. It represents a map from grouped values and all the pivotGridRecords that are based on that value. It can be utilized in very specific scenarios, where there is a need to do something while creating the hierarchies. No need to change this for common usage.
- **records** - Field that stores reference to the original data records. Can be seen in the example from above - **AllProducts_records**. Avoid setting fields in the data with the same name as this property. If your data records has **records** property, you can specify different and unique value for it using the **pivotKeys**.
- **aggregations** - Field that stores aggregation values. It's applied while creating the hierarchies and also it should not be changed for common scenarios.
@@ -798,7 +798,7 @@ If you have data field values that contain the default keys, make sure to change
-When overriding the `PivotKeys` in Blazor, currently you will need to define all other keys, since assigning a new PivotKeys object, it replaces completely the default ones:
+When overriding the in Blazor, currently you will need to define all other keys, since assigning a new PivotKeys object, it replaces completely the default ones:
```razor
@code {
@@ -822,8 +822,8 @@ When overriding the `PivotKeys` in Blazor, currently you will need to define all
|Limitation|Description|
|--- |--- |
-| Setting columns declaratively is not supported. | The Pivot grid generates its columns based on the `Columns` configuration, so setting them declaratively, like in the base grid, is not supported. Such columns are disregarded. |
-| Setting duplicate `MemberName` or `Member` property values for dimensions/values. | These properties should be unique for each dimension/value. Duplication may result in loss of data from the final result. |
+| Setting columns declaratively is not supported. | The Pivot grid generates its columns based on the configuration, so setting them declaratively, like in the base grid, is not supported. Such columns are disregarded. |
+| Setting duplicate or property values for dimensions/values. | These properties should be unique for each dimension/value. Duplication may result in loss of data from the final result. |
| Row Selection is only supported in **Single** mode. | Multiple selection is currently not supported. |
| Merging the dimension members is case sensitive| The Pivot Grid creates groups and merges the same (case sensitive) values. But the dimensions provide `MemberFunction` and this can be changed there, the result of the `MemberFunction` are compared and used as display value.|
@@ -832,10 +832,10 @@ When overriding the `PivotKeys` in Blazor, currently you will need to define all
## API References
-
+
-
+
## Additional Resources
diff --git a/docs/xplat/src/content/en/components/grids/pivot-grid/remote-operations.mdx b/docs/xplat/src/content/en/components/grids/pivot-grid/remote-operations.mdx
index 7f8f3b5c16..bc21fc7945 100644
--- a/docs/xplat/src/content/en/components/grids/pivot-grid/remote-operations.mdx
+++ b/docs/xplat/src/content/en/components/grids/pivot-grid/remote-operations.mdx
@@ -83,14 +83,14 @@ public aggregatedData = [
```
The Pivot grid provides the object keys fields it uses to do its pivot calculations.
-- `Children` - Field that stores children for hierarchy building. It represents a map from grouped values and all the pivotGridRecords that are based on that value. It can be utilized in very specific scenarios, where there is a need to do something while creating the hierarchies. No need to change this for common usage.
-- `Records` - Field that stores reference to the original data records. Can be seen in the example from above - **AllProducts_records**. Avoid setting fields in the data with the same name as this property. If your data records has **records** property, you can specify different and unique value for it using the `PivotKeys`.
-- `Aggregations` - Field that stores aggregation values. It's applied while creating the hierarchies and also it should not be changed for common scenarios.
-- `Level` - Field that stores dimension level based on its hierarchy. Avoid setting fields in the data with the same name as this property. If your data records has **level** property, you can specify different and unique value for it using the `PivotKeys`.
-- `ColumnDimensionSeparator` - Separator used when generating the unique column field values. It is the dash(**-**) from the example from above - **All-Bulgaria**.
-- `RowDimensionSeparator` - Separator used when generating the unique row field values. It is the underscore(**_**) from the example from above - **AllProducts_records**. It's used when creating the `Records` and `Level` field.
-
-All of these are stored in the `PivotKeys` property which is part of the `PivotConfiguration` and can be used to change the default pivot keys.
+- - Field that stores children for hierarchy building. It represents a map from grouped values and all the pivotGridRecords that are based on that value. It can be utilized in very specific scenarios, where there is a need to do something while creating the hierarchies. No need to change this for common usage.
+- - Field that stores reference to the original data records. Can be seen in the example from above - **AllProducts_records**. Avoid setting fields in the data with the same name as this property. If your data records has **records** property, you can specify different and unique value for it using the .
+- - Field that stores aggregation values. It's applied while creating the hierarchies and also it should not be changed for common scenarios.
+- - Field that stores dimension level based on its hierarchy. Avoid setting fields in the data with the same name as this property. If your data records has **level** property, you can specify different and unique value for it using the .
+- - Separator used when generating the unique column field values. It is the dash(**-**) from the example from above - **All-Bulgaria**.
+- - Separator used when generating the unique row field values. It is the underscore(**_**) from the example from above - **AllProducts_records**. It's used when creating the and field.
+
+All of these are stored in the property which is part of the and can be used to change the default pivot keys.
These defaults are:
```typescript
@@ -100,7 +100,7 @@ export const = {
};
```
-Setting `NoopPivotDimensionsStrategy` for the `ColumnStrategy` and `RowStrategy` skips the data grouping and aggregation done by the data pipes, but the pivot grid still needs declarations for the rows, columns, values and filters in order to render the pivot view as expected:
+Setting `NoopPivotDimensionsStrategy` for the and skips the data grouping and aggregation done by the data pipes, but the pivot grid still needs declarations for the rows, columns, values and filters in order to render the pivot view as expected:
@@ -190,9 +190,9 @@ public pivotConfig: IgcPivotConfiguration = {
-It is important for the data to match the configuration. For the best results no additional fields should be included into the aggregated data and no fields from the provided data should be left undeclared as rows or columns. The `PivotGrid` component builds its data based on the `PivotConfiguration` and it is expected for the configuration and aggregated data to match accordingly.
+It is important for the data to match the configuration. For the best results no additional fields should be included into the aggregated data and no fields from the provided data should be left undeclared as rows or columns. The component builds its data based on the and it is expected for the configuration and aggregated data to match accordingly.
-Similarly for other remote data operations like sorting and filtering, data processing can be skipped by setting the related empty strategies - `FilterStrategy`, `SortStrategy`:
+Similarly for other remote data operations like sorting and filtering, data processing can be skipped by setting the related empty strategies - , :
diff --git a/docs/xplat/src/content/en/components/grids/tree-grid/load-on-demand.mdx b/docs/xplat/src/content/en/components/grids/tree-grid/load-on-demand.mdx
index 9df3b61cd3..2477d06cc4 100644
--- a/docs/xplat/src/content/en/components/grids/tree-grid/load-on-demand.mdx
+++ b/docs/xplat/src/content/en/components/grids/tree-grid/load-on-demand.mdx
@@ -77,7 +77,7 @@ After the user clicks the expand icon, it is replaced by a loading indicator. Wh
### Expanding Indicator Visibility
-If you have a way to provide an information whether a row has children prior to its expanding, you could use the `HasChildrenKey` input property. This way you could provide a boolean property from the data objects which indicates whether an expansion indicator should be displayed.
+If you have a way to provide an information whether a row has children prior to its expanding, you could use the input property. This way you could provide a boolean property from the data objects which indicates whether an expansion indicator should be displayed.
@@ -103,7 +103,7 @@ If you have a way to provide an information whether a row has children prior to
-Note that setting the `HasChildrenKey` property is not required. In case you don't provide it, expansion indicators will be displayed for each row. After expanding a row that has no children, you still need to call the done callback with undefined or empty array. In this case after the loading indicator disappears, the expansion indicator never shows up.
+Note that setting the property is not required. In case you don't provide it, expansion indicators will be displayed for each row. After expanding a row that has no children, you still need to call the done callback with undefined or empty array. In this case after the loading indicator disappears, the expansion indicator never shows up.
### Custom Loading Indicator
@@ -111,7 +111,7 @@ Note that setting the `HasChildrenKey` property is not required. In case you don
-If you want to provide your own custom loading indicator, you can use the `RowLoadingIndicatorTemplate` option to set a custom template.The following code snippet demonstrates how set to it:
+If you want to provide your own custom loading indicator, you can use the option to set a custom template.The following code snippet demonstrates how set to it:
```ts
constructor() {
diff --git a/docs/xplat/src/content/en/components/grids/tree-grid/overview.mdx b/docs/xplat/src/content/en/components/grids/tree-grid/overview.mdx
index 8ec8665f47..535e5e8350 100644
--- a/docs/xplat/src/content/en/components/grids/tree-grid/overview.mdx
+++ b/docs/xplat/src/content/en/components/grids/tree-grid/overview.mdx
@@ -178,7 +178,7 @@ Each row can have only one tree cell, but it can have multiple (or none) ordinar
### Initial Expansion Depth
-Initially the tree grid will expand all node levels and show them. This behavior can be configured using the `ExpansionDepth` property. By default its value is **Infinity** which means all node levels will be expanded. You may control the initial expansion depth by setting this property to a numeric value. For example **0** will show only root level nodes, **1** will show root level nodes and their child nodes and so on.
+Initially the tree grid will expand all node levels and show them. This behavior can be configured using the property. By default its value is **Infinity** which means all node levels will be expanded. You may control the initial expansion depth by setting this property to a numeric value. For example **0** will show only root level nodes, **1** will show root level nodes and their child nodes and so on.
### Child Collection
@@ -251,7 +251,7 @@ public class EmployeesItem
-Now let's start by importing our `Data` collection and binding it to our tree grid.
+Now let's start by importing our collection and binding it to our tree grid.
@@ -295,10 +295,10 @@ Now let's start by importing our `Data` collection and binding it to our tree gr
-In order for the tree grid to build the hierarchy, we will have to set its `ChildDataKey` property to the name of the child collection that is used in each of our data objects. In our case that will be the **Employees** collection.
+In order for the tree grid to build the hierarchy, we will have to set its property to the name of the child collection that is used in each of our data objects. In our case that will be the **Employees** collection.
In addition, we can disable the automatic column generation and define them manually by matching them to the actual properties of our data objects. (The **Employees** collection will be automatically used for the hierarchy, so there is no need to include it in the columns' definitions.)
-We can now enable the row selection and paging features of the tree grid by using the `RowSelection` and add the `Paginator` element.
+We can now enable the row selection and paging features of the tree grid by using the and add the element.
We can also enable the summaries, the filtering, sorting, editing, moving and resizing features for each of our columns.
@@ -334,7 +334,7 @@ We can also enable the summaries, the filtering, sorting, editing, moving and re
-Finally, we can enable the toolbar of our tree grid, along with the column hiding, column pinning and exporting features by using the `GridToolbar`, `GridToolbarHiding`, `GridToolbarPinning` and `GridToolbarExporter` respectively.
+Finally, we can enable the toolbar of our tree grid, along with the column hiding, column pinning and exporting features by using the , , and respectively.
@@ -426,9 +426,9 @@ const data = [
```
-In the sample data above, all records have an ID, a ParentID and some additional properties like Name, JobTitle and Age. As mentioned previously, the ID of the records must be unique as it will be our `PrimaryKey`. The ParentID contains the ID of the parent node and could be set as a `ForeignKey`. If a row has a ParentID that does not match any row in the tree grid, then that means this row is a root row.
+In the sample data above, all records have an ID, a ParentID and some additional properties like Name, JobTitle and Age. As mentioned previously, the ID of the records must be unique as it will be our . The ParentID contains the ID of the parent node and could be set as a . If a row has a ParentID that does not match any row in the tree grid, then that means this row is a root row.
-The parent-child relation is configured using the tree grid's `PrimaryKey` and `ForeignKey` properties.
+The parent-child relation is configured using the tree grid's and properties.
Here is the template of the component which demonstrates how to configure the tree grid to display the data defined in the above flat collection:
@@ -504,8 +504,8 @@ And here is the final result:
The indentation of the tree grid cell persists across other tree grid features like filtering, sorting and paging.
- When `Sorting` is applied on a column, the data rows get sorted by levels. This means that the root level rows will be sorted independently from their respective children. Their respective children collections will each be sorted independently as well and so on.
-- The first column (the one that has a `VisibleIndex` of 0) is always the tree column.
-- The column that ends up with a `VisibleIndex` of 0 after operations like column pinning, column hiding and column moving becomes the tree column.
+- The first column (the one that has a of 0) is always the tree column.
+- The column that ends up with a of 0 after operations like column pinning, column hiding and column moving becomes the tree column.
- Exported Excel worksheets reflect the hierarchy by grouping the records as they are grouped in the tree grid itself. All records expanded states would also be persisted and reflected.
- When exporting to CSV, levels and expanded states are ignored and all data is exported as flat.
@@ -557,7 +557,7 @@ Then set the related CSS properties for that class:
-
+
## Additional Resources
diff --git a/docs/xplat/src/content/en/components/grids/tree.mdx b/docs/xplat/src/content/en/components/grids/tree.mdx
index 4b7d598c52..169f957f63 100644
--- a/docs/xplat/src/content/en/components/grids/tree.mdx
+++ b/docs/xplat/src/content/en/components/grids/tree.mdx
@@ -17,7 +17,7 @@ import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
For end-users this means they can easily navigate across different app pages, use selection, checkboxes, add texts, icons, images and more.
-The {ProductName} Tree component 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. Its primary purpose is to allow end-users to visualize and navigate within hierarchical data structures. The `Tree` component also provides load on demand capabilities, item activation, multiple and cascade selection of items through built-in checkboxes, built-in keyboard navigation and more.
+The {ProductName} Tree component 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. Its primary purpose is to allow end-users to visualize and navigate within hierarchical data structures. The component also provides load on demand capabilities, item activation, multiple and cascade selection of items through built-in checkboxes, built-in keyboard navigation and more.
## {Platform} Tree Example
@@ -44,7 +44,7 @@ First, you need to install the {ProductName} by running the following command:
npm install {PackageWebComponents}
```
-Before using the `Tree`, you need to register it as follows:
+Before using the , you need to register it as follows:
```ts
import { defineComponents, IgcTreeComponent } from 'igniteui-webcomponents';
@@ -68,7 +68,7 @@ First, you need to the install the corresponding {ProductName} npm package by ru
npm install igniteui-react
```
-You will then need to import the `Tree`and its necessary CSS, like so:
+You will then need to import the and its necessary CSS, like so:
```tsx
import { IgrTree, IgrTreeItem } from 'igniteui-react';
@@ -84,7 +84,7 @@ import 'igniteui-webcomponents/themes/light/bootstrap.css';
-You will also need to link an additional CSS file to apply the styling to the `Tree` component. The following needs to be placed in the **wwwroot/index.html** file in a **Blazor Web Assembly** project or the **Pages/_Host.cshtml** file in a **Blazor Server** project:
+You will also need to link an additional CSS file to apply the styling to the component. The following needs to be placed in the **wwwroot/index.html** file in a **Blazor Web Assembly** project or the **Pages/_Host.cshtml** file in a **Blazor Server** project:
```razor
@@ -106,12 +106,12 @@ builder.Services.AddIgniteUIBlazor(
-The simplest way to start using the `Tree` is as follows:
+The simplest way to start using the is as follows:
### Declaring a tree
-`TreeItem` is the representation of every item that belongs to the `Tree`.
-Items provide `Disabled`, `Active`, `Selected` and `Expanded` properties, which give you opportunity to configure the states of the item as per your requirement.
-The `Value` property can be used to add a reference to the data entry the item represents.
+ is the representation of every item that belongs to the .
+Items provide , , and properties, which give you opportunity to configure the states of the item as per your requirement.
+The property can be used to add a reference to the data entry the item represents.
@@ -158,7 +158,7 @@ Items can be bound to a data model so that their expanded and selected states ar
- Declaring a tree by creating static unbound items
-In order to render a tree you do not necessarily need a data set - individual items can be created without an underlying data model using the exposed `Label` property or provide a custom slot content for the `TreeItem` label.
+In order to render a tree you do not necessarily need a data set - individual items can be created without an underlying data model using the exposed property or provide a custom slot content for the label.
@@ -238,9 +238,9 @@ You can provide a custom slot content for each `TreeItem`'s indentation, expansi
### Item Interactions
-`TreeItem` could be expanded or collapsed:
+ could be expanded or collapsed:
- by clicking on the item expand indicator (default behavior).
-- by clicking on the item if the `Tree` `ToggleNodeOnClick` property is set to `true`.
+- by clicking on the item if the property is set to `true`.
@@ -259,7 +259,7 @@ You can provide a custom slot content for each `TreeItem`'s indentation, expansi
-By default, multiple items could be expanded at the same time. In order to change this behavior and allow expanding only single branch at a time, the `SingleBranchExpand` property could be enabled. This way when an item is expanded, all of the others already expanded branches in the same level will be collapsed.
+By default, multiple items could be expanded at the same time. In order to change this behavior and allow expanding only single branch at a time, the property could be enabled. This way when an item is expanded, all of the others already expanded branches in the same level will be collapsed.
@@ -281,7 +281,7 @@ By default, multiple items could be expanded at the same time. In order to chang
-In addition, the `Tree` provides the following API methods for item interactions:
+In addition, the provides the following API methods for item interactions:
- `Tree.Expand` - expands all items. If an items array is passed, expands only the specified items.
- `Tree.Collapse` - collapses all items. If an items array is passed, collapses only the specified items.
@@ -293,15 +293,15 @@ In addition, the `Tree` provides the following API methods for item interactions
## {Platform} Tree Selection
-In order to setup item selection in the {ProductName} Tree component, you just need to set its `Selection` property. This property accepts the following three modes: **None**, **Multiple** and **Cascade**. Below we will take a look at each of them in more detail.
+In order to setup item selection in the {ProductName} Tree component, you just need to set its property. This property accepts the following three modes: **None**, **Multiple** and **Cascade**. Below we will take a look at each of them in more detail.
### None
-In the `Tree` by default item selection is disabled. Users cannot select or deselect an item through UI interaction, but these actions can still be completed through the provided API method.
+In the by default item selection is disabled. Users cannot select or deselect an item through UI interaction, but these actions can still be completed through the provided API method.
### Multiple
-To enable multiple item selection in the `Tree` just set the `Selection` property to **multiple**. This will render a checkbox for every item. Each item has two states - selected or not. This mode supports multiple selection.
+To enable multiple item selection in the just set the property to **multiple**. This will render a checkbox for every item. Each item has two states - selected or not. This mode supports multiple selection.
@@ -330,7 +330,7 @@ To enable multiple item selection in the `Tree` just set the `Selection` propert
### Cascade
-To enable cascade item selection in the `Tree`, just set the selection property to **cascade**. This will render a checkbox for every item.
+To enable cascade item selection in the , just set the selection property to **cascade**. This will render a checkbox for every item.
@@ -361,9 +361,9 @@ To enable cascade item selection in the `Tree`, just set the selection property
In this mode a parent's selection state entirely depends on the selection state of its children. When a parent has some selected and some deselected children, its checkbox is in an indeterminate state.
## Keyboard Navigation
-Keyboard navigation in `Tree` provides a rich variety of keyboard interactions for the user. This functionality is enabled by default and allows users to navigate through the items.
+Keyboard navigation in provides a rich variety of keyboard interactions for the user. This functionality is enabled by default and allows users to navigate through the items.
-The `Tree` navigation is compliant with W3C accessibility standards and convenient to use.
+The navigation is compliant with W3C accessibility standards and convenient to use.
**Key Combinations**
@@ -403,7 +403,7 @@ The {ProductName} Tree can be rendered in such way that it requires the minimal
After the user clicks the expand icon, it is replaced by a loading indicator. When the loading property resolves to false, the loading indicator disappears and the children are loaded.
-You can provide a custom slot content for the loading area using the `loadingIndicator` slot. If such slot is not defined, the `CircularProgress` is used.
+You can provide a custom slot content for the loading area using the `loadingIndicator` slot. If such slot is not defined, the is used.
### Load On Demand With Virtualization
@@ -417,7 +417,7 @@ Loading a greater number of children on demand in the {ProductName} Tree might n
## Styling
-You can change the appearance of the `TreeItem`, by using some of the exposed CSS parts listed below:
+You can change the appearance of the , by using some of the exposed CSS parts listed below:
| Part name | Description |
| ---------|------------ |
@@ -430,7 +430,7 @@ You can change the appearance of the `TreeItem`, by using some of the exposed CS
| `text` | The tree item displayed text. |
| `select` | The checkbox of the tree item when selection is enabled. |
-Using these CSS parts we can customize thе appearance of the `Tree` component like this:
+Using these CSS parts we can customize thе appearance of the component like this:
```css
igc-tree-item {
@@ -447,10 +447,10 @@ igc-tree-item {
## API References
-
-
+
+
-
+
## Additional Resources
diff --git a/docs/xplat/src/content/en/components/inputs/chip.mdx b/docs/xplat/src/content/en/components/inputs/chip.mdx
index a7d38d2d03..493d5b27a1 100644
--- a/docs/xplat/src/content/en/components/inputs/chip.mdx
+++ b/docs/xplat/src/content/en/components/inputs/chip.mdx
@@ -237,7 +237,7 @@ The {ProductName} chip can be disabled by using the component and their slots, we can add different content before and after the main content of the chip. We provide default select and remove icons but you can customize them using the `Select` and `Remove` slots. You can add additional content before or after the main content, using the `Start` and `End` slots.
+With the `Prefix` and `Suffix` parts of the component and their slots, we can add different content before and after the main content of the chip. We provide default select and remove icons but you can customize them using the and `Remove` slots. You can add additional content before or after the main content, using the `Start` and `End` slots.
diff --git a/docs/xplat/src/content/en/components/inputs/circular-progress.mdx b/docs/xplat/src/content/en/components/inputs/circular-progress.mdx
index e29aaacaf6..6854458627 100644
--- a/docs/xplat/src/content/en/components/inputs/circular-progress.mdx
+++ b/docs/xplat/src/content/en/components/inputs/circular-progress.mdx
@@ -84,7 +84,7 @@ Before using the , you need to register it as
builder.Services.AddIgniteUIBlazor(typeof(IgbCircularProgressModule));
```
-You will also need to link an additional CSS file to apply the styling to the `Calendar` component. The following needs to be placed in the **wwwroot/index.html** file in a **Blazor Web Assembly** project or the **Pages/_Host.cshtml** file in a **Blazor Server** project:
+You will also need to link an additional CSS file to apply the styling to the component. The following needs to be placed in the **wwwroot/index.html** file in a **Blazor Web Assembly** project or the **Pages/_Host.cshtml** file in a **Blazor Server** project:
```razor
@@ -149,7 +149,7 @@ You can set the type of your indicator, using the property. Also, you can hide the default label of the {ProductName} by setting the property and customize the progress indicator default label via the exposed `LabelFormat` property.
+If you want to track a process that is not determined precisely, you can set the property. Also, you can hide the default label of the {ProductName} by setting the property and customize the progress indicator default label via the exposed property.
diff --git a/docs/xplat/src/content/en/components/inputs/color-editor.mdx b/docs/xplat/src/content/en/components/inputs/color-editor.mdx
index 8d7b08bf7f..74d92b4ece 100644
--- a/docs/xplat/src/content/en/components/inputs/color-editor.mdx
+++ b/docs/xplat/src/content/en/components/inputs/color-editor.mdx
@@ -32,7 +32,7 @@ npm install {PackageCore}
npm install {PackageInputs}
```
-Before using the , you need to register the following modules as follows:
+Before using the `ColorEditor`, you need to register the following modules as follows:
@@ -100,7 +100,7 @@ builder.Services.AddIgniteUIBlazor(
## Usage
-The simplest way to start using the is as follows:
+The simplest way to start using the `ColorEditor` is as follows:
@@ -209,7 +209,7 @@ public onValueChanged(calendar: IgrColorEditor, e: IgrColorEditorPanelSelectedVa
## API References
-
+`ColorEditor`
## Additional Resources
diff --git a/docs/xplat/src/content/en/components/inputs/combo/features.mdx b/docs/xplat/src/content/en/components/inputs/combo/features.mdx
index a110092777..b05ef7df14 100644
--- a/docs/xplat/src/content/en/components/inputs/combo/features.mdx
+++ b/docs/xplat/src/content/en/components/inputs/combo/features.mdx
@@ -16,14 +16,14 @@ import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
The {ProductName} ComboBox component exposes several features such as filtering and grouping.
## Combobox Features Example
-The following demo shows some `Combo` features that are enabled/disabled at runtime:
+The following demo shows some features that are enabled/disabled at runtime:
-In our sample we are going to use the `Switch` component, so we have to import them together with the combo:
+In our sample we are going to use the component, so we have to import them together with the combo:
@@ -50,7 +50,7 @@ builder.Services.AddIgniteUIBlazor(typeof(IgbComboModule));
builder.Services.AddIgniteUIBlazor(typeof(IgbSwitchModule));
```
-You will also need to link an additional CSS file to apply the styling to the `Switch` component. The following needs to be placed in the **wwwroot/index.html** file in a **Blazor Web Assembly** project or the **Pages/_Host.cshtml** file in a **Blazor Server** project:
+You will also need to link an additional CSS file to apply the styling to the component. The following needs to be placed in the **wwwroot/index.html** file in a **Blazor Web Assembly** project or the **Pages/_Host.cshtml** file in a **Blazor Server** project:
```razor
@@ -182,7 +182,7 @@ switchDisable.addEventListener("igcChange", () => {
-Note that grouping is enabled/disabled by setting the `GroupKey` property to a corresponding data source field:
+Note that grouping is enabled/disabled by setting the property to a corresponding data source field:
@@ -253,7 +253,7 @@ Filtering options can be further enhanced by enabling the search case sensitivit
#### Filtering Options
-The {ProductName} exposes one more filtering property that allows passing configuration of both `FilterKey` and `CaseSensitive` options. The `FilterKey` indicates which data source field should be used for filtering the list of options. The `CaseSensitive` option indicates if the filtering should be case-sensitive or not.
+The {ProductName} exposes one more filtering property that allows passing configuration of both `FilterKey` and `CaseSensitive` options. The `FilterKey` indicates which data source field should be used for filtering the list of options. The `CaseSensitive` option indicates if the filtering should be case-sensitive or not.
The following code snippet shows how to filter the cities from our data source by country instead of name. We are also making the filtering case-sensitive by default:
@@ -291,7 +291,7 @@ const options = {
### Grouping
-Defining a option will group the items, according to the provided key:
+Defining a option will group the items, according to the provided key:
@@ -318,7 +318,7 @@ Defining a option wi
-The `GroupKey` property will only have effect if your data source consists of complex objects.
+The property will only have effect if your data source consists of complex objects.
#### Sorting Direction
@@ -351,7 +351,7 @@ The ComboBox component also exposes an option for setting whether groups should
### Label
-The label can be set easily using the property:
+The label can be set easily using the property:
@@ -521,7 +521,7 @@ You can disable the ComboBox using the
+
## Additional Resources
diff --git a/docs/xplat/src/content/en/components/inputs/combo/overview.mdx b/docs/xplat/src/content/en/components/inputs/combo/overview.mdx
index 8b2f8a80f5..f81e5db193 100644
--- a/docs/xplat/src/content/en/components/inputs/combo/overview.mdx
+++ b/docs/xplat/src/content/en/components/inputs/combo/overview.mdx
@@ -36,7 +36,7 @@ First, you need to install the {ProductName} by running the following command:
npm install {PackageWebComponents}
```
-Before using the `Combo` component, you need to register it together with its additional components and necessary CSS:
+Before using the component, you need to register it together with its additional components and necessary CSS:
```ts
import { defineComponents, IgcComboComponent }
@@ -57,7 +57,7 @@ For a complete introduction to the {ProductName}, read the [**Getting Started**]
-To get started with the `Combo` component, first we need to register its module as follows:
+To get started with the component, first we need to register its module as follows:
```razor
@@ -66,7 +66,7 @@ To get started with the `Combo` component, first we need to register its module
builder.Services.AddIgniteUIBlazor(typeof(IgbComboModule));
```
-You will also need to link an additional CSS file to apply the styling to the `Combo` component. The following needs to be placed in the **wwwroot/index.html** file in a **Blazor Web Assembly** project or the **Pages/_Host.cshtml** file in a **Blazor Server** project:
+You will also need to link an additional CSS file to apply the styling to the component. The following needs to be placed in the **wwwroot/index.html** file in a **Blazor Web Assembly** project or the **Pages/_Host.cshtml** file in a **Blazor Server** project:
```razor
@@ -86,7 +86,7 @@ First, you need to the install the corresponding {ProductName} npm package by ru
npm install igniteui-react
```
-You will then need to import the {Platform} `Combo` and its necessary CSS:
+You will then need to import the {Platform} and its necessary CSS:
```tsx
import { IgrCombo } from 'igniteui-react';
@@ -97,8 +97,8 @@ import 'igniteui-webcomponents/themes/light/bootstrap.css';
-
-The `Combo` component doesn't work with the standard `
-If the `ValueKey` property is omitted, you will have to list the items you wish to select/deselect as objects references:
+If the property is omitted, you will have to list the items you wish to select/deselect as objects references:
@@ -389,10 +389,10 @@ comboRef.current.deselect([cities[1], cities[5]]);
### Validation
-The {ProductName} component supports most of the properties, such as , , , , etc. The component also exposes two methods bound to its validation:
+The {ProductName} component supports most of the properties, such as , , , , etc. The component also exposes two methods bound to its validation:
-- `ReportValidity` - checks for validity and returns true if the component satisfies the validation constraints.
-- `CheckValidity` - a wrapper around reportValidity to comply with the native input API.
+- - checks for validity and returns true if the component satisfies the validation constraints.
+- - a wrapper around reportValidity to comply with the native input API.
## Keyboard Navigation
@@ -411,7 +411,7 @@ When the combo component is focused and the list of options is **visible**:
## Styling
-You can change the appearance of the component and its items, by using the exposed CSS parts listed below:
+You can change the appearance of the component and its items, by using the exposed CSS parts listed below:
| Part name | Description |
| -------------------- | ------------------------------------------------------------------------------- |
@@ -467,7 +467,7 @@ igc-combo::part(toggle-icon) {
## API References
-
+
## Additional Resources
diff --git a/docs/xplat/src/content/en/components/inputs/date-time-input.mdx b/docs/xplat/src/content/en/components/inputs/date-time-input.mdx
index f0e34d749f..fa70225a7e 100644
--- a/docs/xplat/src/content/en/components/inputs/date-time-input.mdx
+++ b/docs/xplat/src/content/en/components/inputs/date-time-input.mdx
@@ -132,7 +132,7 @@ The also accepts [ISO 8601](https://tc39.es/ecm
The string can be a full `ISO` string, in the format `YYYY-MM-DDTHH:mm:ss.sssZ` or it could be separated into date-only and time-only portions.
#### Date-only
-If a date-only string is bound to the property of the component, it needs to be in the format `YYYY-MM-DD`. The is still used when typing values in the input and it does not have to be in the same format. Additionally, when binding a date-only string, the directive will prevent time shifts by coercing the time to be `T00:00:00`.
+If a date-only string is bound to the property of the component, it needs to be in the format `YYYY-MM-DD`. The is still used when typing values in the input and it does not have to be in the same format. Additionally, when binding a date-only string, the directive will prevent time shifts by coercing the time to be `T00:00:00`.
#### Time-only
Time-only strings are normally not defined in the `ECMA` specification, however to allow the directive to be integrated in scenarios which require time-only solutions, it supports the 24 hour format - `HH:mm:ss`. The 12 hour format is not supported.
@@ -166,10 +166,10 @@ The has intuitive keyboard navigation that make
The supports different display and input formats.
-It uses [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat) which allows it to support predefined format options, such as `long` and `short`, `medium` and `full`. Additionally, it can also accept a custom string constructed from supported characters, such as `dd-MM-yy`. Also, if no is provided, the component will use the as such.
+It uses [Intl.DateTimeFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat) which allows it to support predefined format options, such as `long` and `short`, `medium` and `full`. Additionally, it can also accept a custom string constructed from supported characters, such as `dd-MM-yy`. Also, if no is provided, the component will use the as such.
### Input Format
-The table bellow shows formats that are supported by the component's :
+The table bellow shows formats that are supported by the component's :
|Format|Description|
|-------|----------|
@@ -187,7 +187,7 @@ The table bellow shows formats that are supported by the component's . This will set both the expected user input format and the `mask`. Additionally, the is locale based, so if none is provided, the editor will default to `dd/MM/yyyy`.
+To set a specific input format, pass it as a string to the . This will set both the expected user input format and the `mask`. Additionally, the is locale based, so if none is provided, the editor will default to `dd/MM/yyyy`.
@@ -323,7 +323,7 @@ If all went well, the component will be `invalid` if the value is greater or low
The exposes public and methods. They increment or decrement a specific `DatePart` of the currently set date and time and can be used in a couple of ways.
-In the first scenario, if no specific DatePart is passed to the method, a default DatePart will increment or decrement, based on the specified `InputFormat` and the internal component implementation. In the second scenario, you can explicitly specify what DatePart to manipulate as it may suite different requirements. Also, both methods accept an optional `delta` parameter of type number which can be used to set the stepUp/stepDown step.
+In the first scenario, if no specific DatePart is passed to the method, a default DatePart will increment or decrement, based on the specified and the internal component implementation. In the second scenario, you can explicitly specify what DatePart to manipulate as it may suite different requirements. Also, both methods accept an optional `delta` parameter of type number which can be used to set the stepUp/stepDown step.
diff --git a/docs/xplat/src/content/en/components/inputs/dropdown.mdx b/docs/xplat/src/content/en/components/inputs/dropdown.mdx
index 6d8661101b..f3cc4564b2 100644
--- a/docs/xplat/src/content/en/components/inputs/dropdown.mdx
+++ b/docs/xplat/src/content/en/components/inputs/dropdown.mdx
@@ -125,7 +125,7 @@ The simplest way to start using the is as follows:
### Target
-The {Platform} Dropdown list is positioned relatively to its target. The `target` slot allows you to provide a built-in component which toggles the `open` property on click. In some cases you would want to use an external target or use another event to toggle the opening of the Dropdown. You can achieve this using the `Show`, `Hide` and `Toggle` methods which allow you to provide the target as a parameter. By default, the Dropdown list uses `absolute` CSS position. You will need to set the of the {Platform} Dropdown to `fixed` when the target element is inside a fixed container, but the Dropdown is not. The Dropdown list is automatically sized based on its content, if you want the list to have the same width as the target, you should set the property to `true`.
+The {Platform} Dropdown list is positioned relatively to its target. The `target` slot allows you to provide a built-in component which toggles the `open` property on click. In some cases you would want to use an external target or use another event to toggle the opening of the Dropdown. You can achieve this using the , and methods which allow you to provide the target as a parameter. By default, the Dropdown list uses `absolute` CSS position. You will need to set the of the {Platform} Dropdown to `fixed` when the target element is inside a fixed container, but the Dropdown is not. The Dropdown list is automatically sized based on its content, if you want the list to have the same width as the target, you should set the property to `true`.
@@ -134,7 +134,7 @@ The {Platform} Dropdown list is positioned relatively to its target. The `target
### Position
-The preferred placement of the {Platform} Dropdown can be set using the property. The default placement of the Dropdown is `bottom-start`. The `Flip` property determines whether the placement should be flipped if there is not enough space to display the Dropdown at the specified placement. The distance from the {Platform} Dropdown list to its target can be specified using the property.
+The preferred placement of the {Platform} Dropdown can be set using the property. The default placement of the Dropdown is `bottom-start`. The property determines whether the placement should be flipped if there is not enough space to display the Dropdown at the specified placement. The distance from the {Platform} Dropdown list to its target can be specified using the property.
@@ -143,7 +143,7 @@ The preferred placement of the {Platform} Dropdown can be set using the emits the `Change` event when the user selects an item. The `Select` method of the Dropdown allows you to select an item by its index or value.
+The emits the `Change` event when the user selects an item. The method of the Dropdown allows you to select an item by its index or value.
### Item
@@ -174,7 +174,7 @@ The {Platform} Dropdown's items can also be grouped using the property determines the behavior of the component during scrolling the container of the target element. The default value is `scroll` which means that the Dropdown will be scrolled with its target. Setting the property to `block` will block the scrolling if the Dropdown is opened. You could also set the property to `close` which means that the Dropdown will be closed automatically on scroll.
### Keep Open
diff --git a/docs/xplat/src/content/en/components/inputs/file-input.mdx b/docs/xplat/src/content/en/components/inputs/file-input.mdx
index 531568694e..35ba9d864d 100644
--- a/docs/xplat/src/content/en/components/inputs/file-input.mdx
+++ b/docs/xplat/src/content/en/components/inputs/file-input.mdx
@@ -22,7 +22,7 @@ The {ProductName} File Input component provides an interactive way for users to
## Usage
-The component allows users to select files from their device and upload them to a web application. It displays the names of selected files and offers customization options for the browse button and the "No file chosen" text. The component also provides properties, methods, and slots that can be used to further configure its behavior to suit your needs.
+The component allows users to select files from their device and upload them to a web application. It displays the names of selected files and offers customization options for the browse button and the "No file chosen" text. The component also provides properties, methods, and slots that can be used to further configure its behavior to suit your needs.
### Getting Started
@@ -31,13 +31,13 @@ The component allows users to select files from the
-To start using the , first, you need to install the Ignite UI for Web Components by running the following command:
+To start using the , first, you need to install the Ignite UI for Web Components by running the following command:
```cmd
npm install {PackageWebComponents}
```
-After that, you need to import the as follows:
+After that, you need to import the as follows:
```ts
import { defineComponents, IgcFileInputComponent } from 'igniteui-webcomponents';
@@ -49,7 +49,7 @@ defineComponents(IgcFileInputComponent);
-Now you can start with a basic configuration of the {Platform} .
+Now you can start with a basic configuration of the {Platform} .
@@ -65,17 +65,17 @@ For a complete introduction to the {ProductName}, read the [**Getting Started**]
### Properties
-The component offers a variety of properties that allow you to configure its behavior based on specific requirements. These properties give you control over the input’s functionality, appearance, and validation.
+The component offers a variety of properties that allow you to configure its behavior based on specific requirements. These properties give you control over the input’s functionality, appearance, and validation.
-- `Value` - Sets the current value of the file input field.
-- `Disabled` - Disables the file input, preventing user interaction.
-- `Required` - Marks the input as mandatory. Form submission will be blocked unless a file is selected.
-- `Invalid` - Indicates that the input value is invalid, used to trigger visual error states.
+- - Sets the current value of the file input field.
+- - Disables the file input, preventing user interaction.
+- - Marks the input as mandatory. Form submission will be blocked unless a file is selected.
+- - Indicates that the input value is invalid, used to trigger visual error states.
- `Multiple` - Allows the selection of multiple files.
- `Accept` - Defines the types of files that can be selected. The value for this property needs to be a comma-separated list of file formats (e.g., .jpg, .png, .gif).
-- `Autofocus` - Automatically focuses the file input field when the page loads.
-- `Label` - Sets the label text associated with the file input element.
-- `Placeholder` - Provides placeholder text displayed when no file is selected.
+- - Automatically focuses the file input field when the page loads.
+- - Sets the label text associated with the file input element.
+- - Provides placeholder text displayed when no file is selected.
@@ -93,16 +93,16 @@ The component offers a variety of properties that a
### Methods
-In addition to its configurable properties, there are four useful methods inherited from the component that you can use in the component:
+In addition to its configurable properties, there are four useful methods inherited from the component that you can use in the component:
- `Focus` - Sets the focus on the file input element.
- `Blur` - Removes the focus from the file input element.
-- `ReportValidity` - Checks the validity of the input and displays a validation message if the input is invalid.
-- `SetCustomValidity` - Sets a custom validation message. If the provided message is not empty, the input will be marked as invalid.
+- - Checks the validity of the input and displays a validation message if the input is invalid.
+- - Sets a custom validation message. If the provided message is not empty, the input will be marked as invalid.
### Slots
-The component also exposes several slots that can be used to customize its appearance and behavior.
+The component also exposes several slots that can be used to customize its appearance and behavior.
- `prefix` & `suffix` - Allow you to insert content before or after the main input area.
- `helper-text` - Displays a hint or instructional message below the input. Useful for providing additional guidance, such as formatting tips or field requirements.
@@ -110,27 +110,27 @@ The component also exposes several slots that can b
- `file-missing-text` - Sets the text shown in the input field when no file has been selected.
- `value-missing` - Renders custom content when the required field validation fails. (i.e., when a file is required but not provided).
- `invalid` – Allows you to render custom content when the input is in an invalid state.
-- `custom-error` - Displays content when a custom validation message is set using the method.
+- `custom-error` - Displays content when a custom validation message is set using the method.
## Integration
-The component integrates seamlessly with the HTML Form element. Using the methods and properties described above, you can effectively manage its behavior and validation within the standard HTML Forms.
+The component integrates seamlessly with the HTML Form element. Using the methods and properties described above, you can effectively manage its behavior and validation within the standard HTML Forms.
## Limitations
-The component currently has the following limitations:
+The component currently has the following limitations:
- The default strings for the "Browse" button and the "No file chosen" message is not automatically localized. These strings remain the same across all locales but can be manually customized using the appropriate slots or placeholder binding.
- Files cannot be set manually through the `value` property. File selection can be done only via the file picker. You can however pass an empty string `''` to reset the field.
## Accessibility & ARIA Support
-The component is both focusable and interactive, ensuring full keyboard and screen reader accessibility. The component can be labeled using the attribute, which leverages the native `
## テーブルをワークシートに追加
-Infragistics {Platform} Excel Engine のワークシート テーブルは オブジェクトによって表され、ワークシートの `Tables` コレクションに追加されます。テーブルを追加するには、このコレクションの `Add` メソッドを呼び出す必要があります。このメソッドでは、テーブルを追加する領域、テーブルにヘッダーを含めるかどうか、およびオプションで `WorksheetTableStyle` オブジェクトとしてテーブルのスタイルを指定できます。
+Infragistics {Platform} Excel Engine のワークシート テーブルは オブジェクトによって表され、ワークシートの コレクションに追加されます。テーブルを追加するには、このコレクションの `Add` メソッドを呼び出す必要があります。このメソッドでは、テーブルを追加する領域、テーブルにヘッダーを含めるかどうか、およびオプションで オブジェクトとしてテーブルのスタイルを指定できます。
以下のコード サンプルは、ヘッダーを含むテーブルを の A1 to G10 (A1 to G1 が列ヘッダー) 領域に追加する方法を示します。
@@ -43,7 +43,7 @@ worksheet.Tables.Add("A1:G10", true);
-テーブルを追加後 で `InsertColumns`、`InsertDataRows`、`DeleteColumns`、または `DeleteDataRows` メソッドを呼び出して行列を追加または削除して変更できます。テーブルの `Resize` メソッドを使用して新しいテーブル範囲を設定できます。
+テーブルを追加後 で 、、、または メソッドを呼び出して行列を追加または削除して変更できます。テーブルの メソッドを使用して新しいテーブル範囲を設定できます。
以下のコード スニペットは、3 つのメソッドの使用方法を示します。
@@ -96,19 +96,19 @@ table.Resize("A1:G15");
## テーブルのフィルタリング
の列にフィルターを適用します。フィルターが列で適用されると、テーブルに適用したすべてのフィルター条件と一致する行を決定するために再評価されます。
-テーブルのデータを後で変更または行の `Hidden` プロパティを変更した場合、フィルター条件は自動的に再評価されません。テーブルのフィルター条件は、テーブルの列フィルターが追加、削除、変更されたときか、`ReapplyFilters` メソッドがテーブルに対して呼び出されたときに限り再適用されます。
+テーブルのデータを後で変更または行の `Hidden` プロパティを変更した場合、フィルター条件は自動的に再評価されません。テーブルのフィルター条件は、テーブルの列フィルターが追加、削除、変更されたときか、 メソッドがテーブルに対して呼び出されたときに限り再適用されます。
以下は、 の列で使用できるフィルター タイプです。
-- `AverageFilter` - このコードは、列のすべてのセルの平均値の上か下かに基づいてセルをフィルターする方法を示します。
-- `CustomFilter` - 1 つ以上のカスタム条件に基づいてセルをフィルターできます。
-- `DatePeriodFilter` - 年の特定の月または四半期の日付を含むセルのみが表示されます。
-- `FillFilter` - 特定の塗りつぶしを含むセルのみが表示されます。
-- `FixedValuesFilter` - 特定の表示値のみに一致するまたは日付/時間の特定のグループ内に分類されるセルが表示されます。
-- `FontColorFilter` - 特定のフォントの色を含むセルのみが表示されます。
-- `RelativeDateRangeFilter` - フィルターが適用されたときに、以下の日または前の四半期のように日付の相対的な時間の範囲内で発生するかどうかに基づいて、日付値ををフィルターできます。
-- `TopOrBottomFilter` - このフィルターはトップまたはボトム N 値をフィルターします。このフィルターはトップまたはボトム N %値をフィルターします。
-- `YearToDateFilter` - 年の始まりとフィルターが適用される日付の間に発生する場合、日付値を含むYearToDateFilter-をフィルターできます。
+- - このコードは、列のすべてのセルの平均値の上か下かに基づいてセルをフィルターする方法を示します。
+- - 1 つ以上のカスタム条件に基づいてセルをフィルターできます。
+- - 年の特定の月または四半期の日付を含むセルのみが表示されます。
+- - 特定の塗りつぶしを含むセルのみが表示されます。
+- - 特定の表示値のみに一致するまたは日付/時間の特定のグループ内に分類されるセルが表示されます。
+- - 特定のフォントの色を含むセルのみが表示されます。
+- - フィルターが適用されたときに、以下の日または前の四半期のように日付の相対的な時間の範囲内で発生するかどうかに基づいて、日付値ををフィルターできます。
+- - このフィルターはトップまたはボトム N 値をフィルターします。このフィルターはトップまたはボトム N %値をフィルターします。
+- - 年の始まりとフィルターが適用される日付の間に発生する場合、日付値を含むYearToDateFilter-をフィルターできます。
以下のコード スニペットは、 の最初の列に平均を超えるフィルターを適用する方法を示します。
@@ -135,20 +135,20 @@ table.Columns[0].ApplyAverageFilter(Documents.Excel.Filtering.AverageFilterType.
## テーブルのソート
テーブル列でソート条件を設定するとソートが実行されます。ソート条件が列で設定されると、テーブルのセルの順番を決定するためにテーブルのすべてのソート条件が再評価されます。ソートの基準を満たすためにセルを移動させる必要があるとき、テーブルのセルの行全体が 1 つの単位として移動されます。
-テーブルのデータが後で変更される場合、ソート条件は自動的に再評価されません。テーブルのソート条件は、ソート条件が追加、削除、変更される時に、または `ReapplySortConditions` メソッドがテーブルで呼び出されるときに限り再適用されます。ソート条件が再評価されると、表示されたセルのみがソートられます。非表示行のすべてのセルは適切に維持されます。
+テーブルのデータが後で変更される場合、ソート条件は自動的に再評価されません。テーブルのソート条件は、ソート条件が追加、削除、変更される時に、または メソッドがテーブルで呼び出されるときに限り再適用されます。ソート条件が再評価されると、表示されたセルのみがソートられます。非表示行のすべてのセルは適切に維持されます。
-テーブル列からソート条件へアクセスする以外に の `SortSettings` プロパティの `SortConditions` コレクションからも公開されます。これは、列/ソート条件のペアの順番に並べられたコレクションです。このコレクション内の順序はソートの優先順位です。
+テーブル列からソート条件へアクセスする以外に の プロパティの コレクションからも公開されます。これは、列/ソート条件のペアの順番に並べられたコレクションです。このコレクション内の順序はソートの優先順位です。
列に設定可能なソート条件タイプは以下のとおりです。
-- `OrderedSortCondition` - セル値に基づいてセルを昇順または降順にソートします。
-- `CustomListSortCondition` - テキストまたは表示値に基づいて定義された順序でセルをソートします。このソート方法は、日付がカレンダーに表示されるためアルファベット順よりも便利です。
-- `FillSortCondition` - 塗りつぶしが特定のパターン/グラデーションであるかどうかに基づいてセルをソートします。
-- `FontColorSortCondition` - フォントが特定の色であるかどうかによってセルをソートします。
+- - セル値に基づいてセルを昇順または降順にソートします。
+- - テキストまたは表示値に基づいて定義された順序でセルをソートします。このソート方法は、日付がカレンダーに表示されるためアルファベット順よりも便利です。
+- - 塗りつぶしが特定のパターン/グラデーションであるかどうかに基づいてセルをソートします。
+- - フォントが特定の色であるかどうかによってセルをソートします。
-また の `SortSettings` の `CaseSensitive` プロパティは、文字列が大文字と小文字を区別してソートできるかどうかを開発者が設定できます。
+また の の プロパティは、文字列が大文字と小文字を区別してソートできるかどうかを開発者が設定できます。
-以下のコード スニペットは、 に `OrderedSortCondition` を適用する方法です。
+以下のコード スニペットは、 に を適用する方法です。
```ts
var workbook = new Workbook(WorkbookFormat.Excel2007);
diff --git a/docs/xplat/src/content/jp/components/excel-library-using-workbooks.mdx b/docs/xplat/src/content/jp/components/excel-library-using-workbooks.mdx
index fb9e842b71..da66d8bbcb 100644
--- a/docs/xplat/src/content/jp/components/excel-library-using-workbooks.mdx
+++ b/docs/xplat/src/content/jp/components/excel-library-using-workbooks.mdx
@@ -27,7 +27,7 @@ Infragistics {Platform} Excel Engine は、データを Microsoft® Excel® に
## 既定のフォントを変更
- の新しいインスタンスを作成します。 の `Styles` コレクションに新しいフォントを追加します。このスタイルにはワークブックのすべてのセルのデフォルトのプロパティが含まれています。ただし、行、列またはセルで指定されている場合はその限りではありません。スタイルのプロパティを変更すると、ワークブックのデフォルトのセル書式プロパティが変更します。
+ の新しいインスタンスを作成します。 の コレクションに新しいフォントを追加します。このスタイルにはワークブックのすべてのセルのデフォルトのプロパティが含まれています。ただし、行、列またはセルで指定されている場合はその限りではありません。スタイルのプロパティを変更すると、ワークブックのデフォルトのセル書式プロパティが変更します。
```ts
var workbook = new Workbook();
@@ -52,23 +52,23 @@ font.Height = 16 * 20;
Microsoft Excel® ドキュメント プロパティは、ドキュメントの整理やトラッキングを改善するための情報を提供します。 オブジェクトの プロパティを使用してこれらのプロパティを設定するために、Infragistics {Platform} Excel Engine を使用できます。使用可能なプロパティは以下のとおりです。
-- `Author`
+-
-- `Title`
+-
-- `Subject`
+-
-- `Keywords`
+-
-- `Category`
+-
-- `Status`
+-
-- `Comments`
+-
-- `Company`
+-
-- `Manager`
+-
以下のコードは、ブックを作成し、`title` および `status` ドキュメント プロパティを設定する方法を示します。
diff --git a/docs/xplat/src/content/jp/components/excel-library-using-worksheets.mdx b/docs/xplat/src/content/jp/components/excel-library-using-worksheets.mdx
index 2037394aec..d758814836 100644
--- a/docs/xplat/src/content/jp/components/excel-library-using-worksheets.mdx
+++ b/docs/xplat/src/content/jp/components/excel-library-using-worksheets.mdx
@@ -117,7 +117,7 @@ worksheet.DisplayOptions.ShowRowAndColumnHeaders = false;
## ワークシートの編集を設定
-デフォルトで保存する オブジェクトが有効です。 オブジェクトの `Protect` メソッドを使用してワークシートを保護することにより、ワークシートの編集を禁止できます。このメソッドは、保護する部分を決定する null 許容型 `bool` 引数が多くあり、オプションの 1 つは編集オブジェクトを許容し、**false** に設定した場合はワークシートの編集を防止します。
+デフォルトで保存する オブジェクトが有効です。 オブジェクトの メソッドを使用してワークシートを保護することにより、ワークシートの編集を禁止できます。このメソッドは、保護する部分を決定する null 許容型 `bool` 引数が多くあり、オプションの 1 つは編集オブジェクトを許容し、**false** に設定した場合はワークシートの編集を防止します。
以下のコードは、ワークシートで編集を無効にする方法を示します。
@@ -139,9 +139,9 @@ worksheet.Protect();
- オブジェクトの `Protect` メソッドを使用して構造変更からワークシートを保護できます。
+ オブジェクトの メソッドを使用して構造変更からワークシートを保護できます。
-保護が設定されると、Worksheet オブジェクトの保護をこれらのオブジェクトでオーバーライドするために、 オブジェクトの `Locked` プロパティを各セル、行、マージされたセル領域、または列で設定することができます。たとえば、1 つの列のセルを除き、ワークシートのすべてのセルを読み取り専用にする必要がある場合、特定の オブジェクトで プロパティの `Locked` を **false** に設定します。これにより、その列内のセルの編集をユーザーに許可し、ワークシートの他のセルの編集は禁止できます。
+保護が設定されると、Worksheet オブジェクトの保護をこれらのオブジェクトでオーバーライドするために、 オブジェクトの プロパティを各セル、行、マージされたセル領域、または列で設定することができます。たとえば、1 つの列のセルを除き、ワークシートのすべてのセルを読み取り専用にする必要がある場合、特定の オブジェクトで プロパティの を **false** に設定します。これにより、その列内のセルの編集をユーザーに許可し、ワークシートの他のセルの編集は禁止できます。
以下のコードはその方法を示します。
@@ -166,24 +166,24 @@ worksheet.Columns[0].CellFormat.Locked = ExcelDefaultableBoolean.False;
## ワークシート領域のフィルタリング
-フィルタリングは、 オブジェクトの `filterSettings` プロパティから取得できるワークシートの でフィルター条件を設定できます。フィルター条件は、フィルター条件追加、削除、変更される時に、または `ReapplyFilters` メソッドがワークシートで呼び出されるときに限り再適用されます。フィルターは、領域内で常にデータを評価するわけではありません。
+フィルタリングは、 オブジェクトの `filterSettings` プロパティから取得できるワークシートの でフィルター条件を設定できます。フィルター条件は、フィルター条件追加、削除、変更される時に、または メソッドがワークシートで呼び出されるときに限り再適用されます。フィルターは、領域内で常にデータを評価するわけではありません。
- オブジェクトの `SetRegion` メソッドでフィルターを適用する領域を指定できます。
+ オブジェクトの メソッドでフィルターを適用する領域を指定できます。
以下は、フィルターをワークシートに追加するためのメソッド一覧と概要です。
| メソッド | 説明 |
| -------------|:-------------:|
-|`ApplyAverageFilter`|データ範囲全体の平均を下回るデータであるか上回るデータであるかという条件に基づいてデータを絞り込むことのできるフィルターです。|
-|`ApplyDatePeriodFilter`|月または四半期の日付をフィルターできるフィルターを表します。|
-|`ApplyFillFilter`|背景の塗りつぶしに基づいてセルを絞り込むフィルターを表します。このフィルターには CellFill を 1 つ指定します。この塗りつぶしのセルがデータ範囲に表示されることになります。他のセルはすべて非表示になります。|
+||データ範囲全体の平均を下回るデータであるか上回るデータであるかという条件に基づいてデータを絞り込むことのできるフィルターです。|
+||月または四半期の日付をフィルターできるフィルターを表します。|
+||背景の塗りつぶしに基づいてセルを絞り込むフィルターを表します。このフィルターには CellFill を 1 つ指定します。この塗りつぶしのセルがデータ範囲に表示されることになります。他のセルはすべて非表示になります。|
|`ApplyFixedValuesFilter`|具体的な指定値に基づいて表示セルを絞り込むことのできるフィルターです。|
-|`ApplyFontColorFilter`|フォントの色に基づいてセルを絞り込むフィルターを表します。このフィルターには 1 つの色を指定します。この色のフォントのセルがデータ範囲に表示されることになります。他のセルはすべて非表示になります。|
-|`ApplyIconFilter`|条件付き書式アイコンに基づいてセルを絞り込むフィルターを表します。|
-|`ApplyRelativeDateRangeFilter`|フィルターの適用日を基点とした相対日付によって日付セルの範囲を絞り込むことのできるフィルターです。|
-|`ApplyTopOrBottomFilter`|ソートされた値リストの上位または下位にあるセルを表示できるフィルターです。|
-|`ApplyYearToDateFilter`|日付セルの範囲を現在の年の開始日からフィルターの評価実施日までの期間に絞り込むことのできるフィルターです。|
-|`ApplyCustomFilter`|1 つ、ないし 2 つのカスタム条件に基づいてデータを絞り込むことのできるフィルターです。この 2 つの絞り込み条件は論理積 (and) または論理和 (or) 演算子と組み合わせて使用できます。|
+||フォントの色に基づいてセルを絞り込むフィルターを表します。このフィルターには 1 つの色を指定します。この色のフォントのセルがデータ範囲に表示されることになります。他のセルはすべて非表示になります。|
+||条件付き書式アイコンに基づいてセルを絞り込むフィルターを表します。|
+||フィルターの適用日を基点とした相対日付によって日付セルの範囲を絞り込むことのできるフィルターです。|
+||ソートされた値リストの上位または下位にあるセルを表示できるフィルターです。|
+||日付セルの範囲を現在の年の開始日からフィルターの評価実施日までの期間に絞り込むことのできるフィルターです。|
+||1 つ、ないし 2 つのカスタム条件に基づいてデータを絞り込むことのできるフィルターです。この 2 つの絞り込み条件は論理積 (and) または論理和 (or) 演算子と組み合わせて使用できます。|
以下のコード スニペットを使用してフィルターをワークシート領域に追加します。
@@ -210,7 +210,7 @@ worksheet.FilterSettings.ApplyAverageFilter(0, Documents.Excel.Filtering.Average
## ペインの固定と分割
ペイン固定機能は、行をワークシートの上または列を左にで固定できます。ユーザーがスクロールしている間、固定した行や列は表示されたままになります。固定された行列は、削除できない実線によってワークシートの残りの部分と区切られます。
-ペイン固定を有効にするために オブジェクトの の プロパティを **true** に設定する必要があります。表示オプション `FrozenPaneSettings` の `FrozenRows` と `FrozenColumns` プロパティを使用して固定する行列を指定できます。
+ペイン固定を有効にするために オブジェクトの の プロパティを **true** に設定する必要があります。表示オプション の `FrozenRows` と `FrozenColumns` プロパティを使用して固定する行列を指定できます。
また `FirstRowInBottomPane` と `FirstColumnInRightPane` を個々に使用して下ペインの最初の行または右ペインの最初の列を指定できます。
@@ -275,7 +275,7 @@ worksheet.DisplayOptions.MagnificationInNormalView = 300;
これには、シートの プロパティを使用して取得できる オブジェクトの に領域とソートタイプを指定します。
-シートのソート条件は、ソート条件が追加、削除、変更される時に、または `ReapplySortConditions` メソッドがワークシートで呼び出されるときに限り再適用されます。列または行を領域でソートします。'Rows' はデフォルトのソートタイプです。
+シートのソート条件は、ソート条件が追加、削除、変更される時に、または メソッドがワークシートで呼び出されるときに限り再適用されます。列または行を領域でソートします。'Rows' はデフォルトのソートタイプです。
以下のコード スニペットは、ワークシートのセル領域を適用する方法を示します。
@@ -298,7 +298,7 @@ worksheet.SortSettings.SortConditions.Add(new RelativeIndex(0), new Infragistics
## ワークシートの保護
- オブジェクトで `Protect` メソッドを呼び出してワークシートを保護できます。このメソッドは、以下のユーザー操作を制限または許容する null 許容型 `bool` パラメーターを公開します。
+ オブジェクトで メソッドを呼び出してワークシートを保護できます。このメソッドは、以下のユーザー操作を制限または許容する null 許容型 `bool` パラメーターを公開します。
- セルの編集
- 図形、コメント、チャートなどのオブジェクトやコントロールを編集します。
@@ -311,7 +311,7 @@ worksheet.SortSettings.SortConditions.Add(new RelativeIndex(0), new Infragistics
- データのソート。
- ピボット テーブルの使用
- オブジェクトで `Unprotect` メソッドを呼び出してワークシートの保護を削除できます。
+ オブジェクトで メソッドを呼び出してワークシートの保護を削除できます。
以下のコード スニペットは、上記にリストされたすべてのユーザー操作を保護を有効にします。
@@ -335,11 +335,11 @@ worksheet.Protect();
## ワークシートの条件付き書式設定
- の条件付き書式を設定するには、ワークシートの `ConditionalFormats` コレクションで公開される多数の Add メソッドを使用できます。この Add メソッドの最初のパラメーターは条件付き書式に適用する Worksheet の `string` 領域です。
+ の条件付き書式を設定するには、ワークシートの コレクションで公開される多数の Add メソッドを使用できます。この Add メソッドの最初のパラメーターは条件付き書式に適用する Worksheet の `string` 領域です。
-Worksheet に追加可能な条件付き書式にその条件が true の場合に 要素の外観を決定する プロパティがあります。たとえば、`Fill` や `Font` などのこの プロパティにアタッチされるプロパティを使用してセルの背景およびフォント設定を決定できます。
+Worksheet に追加可能な条件付き書式にその条件が true の場合に 要素の外観を決定する プロパティがあります。たとえば、 や などのこの プロパティにアタッチされるプロパティを使用してセルの背景およびフォント設定を決定できます。
-ワークシート セルの可視化の動作が異なるため、 プロパティがない条件付き書式もあります。この条件付き書式は 、、`IconSetConditionalFormat` です。
+ワークシート セルの可視化の動作が異なるため、 プロパティがない条件付き書式もあります。この条件付き書式は 、、 です。
既存の を Excel から読み込む際に、その が読み込まれた場合も書式設定は保持されます。 を Excel ファイルに保存する場合も保持されます。
diff --git a/docs/xplat/src/content/jp/components/excel-library.mdx b/docs/xplat/src/content/jp/components/excel-library.mdx
index b1a3a0eea9..a2b00caefc 100644
--- a/docs/xplat/src/content/jp/components/excel-library.mdx
+++ b/docs/xplat/src/content/jp/components/excel-library.mdx
@@ -158,11 +158,11 @@ Excel ライブラリ は Excel Binary Workbook (.xlsb) フォーマットを現
-次のコード スニペットでは、外部の [ExcelUtility](excel-utility.md) クラスを使用して `Workbook` を保存およびロードしています。
+次のコード スニペットでは、外部の [ExcelUtility](excel-utility.md) クラスを使用して を保存およびロードしています。
-`Workbook` オブジェクトを読み込んで保存するために、実際の `Workbook` の保存メソッドや static な `Load` メソッドを使用できます。
+ オブジェクトを読み込んで保存するために、実際の の保存メソッドや static な `Load` メソッドを使用できます。
```ts
diff --git a/docs/xplat/src/content/jp/components/general-changelog-dv-blazor.mdx b/docs/xplat/src/content/jp/components/general-changelog-dv-blazor.mdx
index 1cd6b377a6..06372fb1ab 100644
--- a/docs/xplat/src/content/jp/components/general-changelog-dv-blazor.mdx
+++ b/docs/xplat/src/content/jp/components/general-changelog-dv-blazor.mdx
@@ -19,6 +19,8 @@ import chartdefaults4 from '@xplat-images/chartDefaults4.png';
import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# {ProductName} 変更ログ
@@ -158,7 +160,7 @@ DataPieChart および ProportionalCategoryAngleAxis に OthersCategoryBrush と
- New dot type, improved outline implementation following WCAG AA accessibility standards and theme based sizing. [#1889](https://github.com/IgniteUI/igniteui-webcomponents/pull/1889)
#### ユーザー注釈
-{ProductName} では、ユーザー注釈機能により、実行時に `DataChart` にスライス注釈、ストリップ注釈、ポイント注釈を追加できるようになりました。これにより、エンドユーザーは、スライス注釈を使用して会社の四半期レポートなどの単一の重要イベントを強調したり、ストリップ注釈を使用して期間を持つイベントを示したりすることで、プロットに詳細を追加できます。ポイント注釈またはこれら 3 つの任意の組み合わせを使用して、プロットされたシリーズ上の個々のポイントを呼び出すこともできます。
+{ProductName} では、ユーザー注釈機能により、実行時に にスライス注釈、ストリップ注釈、ポイント注釈を追加できるようになりました。これにより、エンドユーザーは、スライス注釈を使用して会社の四半期レポートなどの単一の重要イベントを強調したり、ストリップ注釈を使用して期間を持つイベントを示したりすることで、プロットに詳細を追加できます。ポイント注釈またはこれら 3 つの任意の組み合わせを使用して、プロットされたシリーズ上の個々のポイントを呼び出すこともできます。
#### 軸注釈の衝突検出
軸注釈が自動で衝突を検出し、適切に収まるよう切り詰めます。この機能を有効にするには、次のプロパティを設定します:
#### {PackageMaps} (地理マップ)
@@ -184,14 +186,14 @@ DataPieChart および ProportionalCategoryAngleAxis に OthersCategoryBrush と
### 変更
- すべてのテーマにわたってフォームに関連付けられたほとんどのコンポーネントの読み取り専用スタイルを更新し、コンポーネントが読み取り専用状態にあることをより適切に示せるようになりました。
-- `Tooltip`
- - 動作変更: `Tooltip` のデフォルトの placement は 「bottom」 になりました。
- - 動作変更: with-arrow が設定されていない限り、`Tooltip` はデフォルトでは矢印インジケーターをレンダリングしません。
- - 重大な変更: `Tooltip` イベントは、detail プロパティに anchor ターゲットを返さなくなりました。引き続き event.target.anchor でアクセスできます。
+-
+ - 動作変更: のデフォルトの placement は 「bottom」 になりました。
+ - 動作変更: with-arrow が設定されていない限り、 はデフォルトでは矢印インジケーターをレンダリングしません。
+ - 重大な変更: イベントは、detail プロパティに anchor ターゲットを返さなくなりました。引き続き event.target.anchor でアクセスできます。
### 非推奨
-- `Tooltip` - `DisableArrow` は非推奨です。矢印インジケーターをレンダリングするには、`WithArrow` を使用してください。
+- - は非推奨です。矢印インジケーターをレンダリングするには、 を使用してください。
### バグ修正
@@ -205,21 +207,21 @@ DataPieChart および ProportionalCategoryAngleAxis に OthersCategoryBrush と
**重大な変更**
-- `AzureMapsMapImagery` は `AzureMapsImagery` に名前が変更されました。
-- `AzureMapsImagery` は `AzureMapsImageryStyle.Satellite` に名前が変更されました。
-- 次の `AzureMapsImageryStyle` 列挙値は、Overlay サフィックスを含むように名前が変更されました。
- - `TerraOverlay`
- - `LabelsRoadOverlay`
- - `LabelsDarkGreyOverlay`
- - `HybridRoadOverlay`
- - `HybridDarkGreyOverlay`
- - `WeatherRadarOverlay`
- - `WeatherInfraredOverlay`
- - `TrafficAbsoluteOverlay`
- - `TrafficRelativeOverlay`
- - `TrafficRelativeDarkOverlay`
- - `TrafficDelayOverlay`
- - `TrafficReducedOverlay`
+- `AzureMapsMapImagery` は に名前が変更されました。
+- は `AzureMapsImageryStyle.Satellite` に名前が変更されました。
+- 次の 列挙値は、Overlay サフィックスを含むように名前が変更されました。
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
### {PackageCharts} (チャート)
@@ -238,20 +240,20 @@ DataPieChart および ProportionalCategoryAngleAxis に OthersCategoryBrush と
#### 対応軸
-X 軸と Y 軸に `CompanionAxis` プロパティが追加され、既存の軸を簡単に複製できるようになりました。`CompanionAxisEnabled` プロパティを有効にすると、複製された軸はチャートの反対側に配置され、そこから各軸プロパティを設定できます。
+X 軸と Y 軸に `CompanionAxis` プロパティが追加され、既存の軸を簡単に複製できるようになりました。 プロパティを有効にすると、複製された軸はチャートの反対側に配置され、そこから各軸プロパティを設定できます。
-- `ShouldAvoidAnnotationCollisions`
-- `ShouldAutoTruncateAnnotations`
+-
+-
### RadialPieSeries インセット アウトライン
-`RadialPieSeries` のアウトライン レンダリング方法を制御するために `UseInsetOutlines` プロパティが追加されました。**true** に設定すると、アウトラインがスライス形状の内側に描画され、**false** (既定値) に設定すると、アウトラインはスライス形状の端に半分内側・半分外側で描画されます。
+ のアウトライン レンダリング方法を制御するために プロパティが追加されました。**true** に設定すると、アウトラインがスライス形状の内側に描画され、**false** (既定値) に設定すると、アウトラインはスライス形状の端に半分内側・半分外側で描画されます。
### {PackageGrids} (グリッド)
#### セル サフィックス コンテンツ
-セル内のサフィックス コンテンツのサポートが追加されました。これにより、セル値の末尾にテキストやアイコンを追加してスタイルを設定できるようになりました。セル サフィックス コンテンツに追加されたプロパティの完全なリストは以下に示されており、`DataGridColumn` および `CellInfo` クラスで使用できます。
+セル内のサフィックス コンテンツのサポートが追加されました。これにより、セル値の末尾にテキストやアイコンを追加してスタイルを設定できるようになりました。セル サフィックス コンテンツに追加されたプロパティの完全なリストは以下に示されており、 および クラスで使用できます。
@@ -261,18 +263,18 @@ X 軸と Y 軸に `CompanionAxis` プロパティが追加され、既存の軸
-- `SuffixText`
-- `SuffixTextColor`
+-
+-
- `SuffixTextFont`
-- `SuffixIconName`
-- `SuffixIconCollectionName`
-- `SuffixIconStroke`
-- `SuffixIconFill`
-- `SuffixIconViewBoxLeft`
-- `SuffixIconViewBoxTop`
-- `SuffixIconViewBoxWidth`
-- `SuffixIconViewBoxHeight`
-- `TextDecoration`
+-
+-
+-
+-
+-
+-
+-
+-
+-
```razor
@@ -312,16 +314,16 @@ col.Pinned = true;
- Optimized grouping operations.
- **Other Improvements**
- - A column's `MinWidth` and `MaxWidth` constrain the user-specified width so that it cannot go outside their bounds.
+ - A column's and `MaxWidth` constrain the user-specified width so that it cannot go outside their bounds.
- The `PagingMode` property can now be set as simple strings "local" and "remote" and does not require importing the `GridPagingMode` enum.
### バグ修正
#### 機能拡張
-- `DateRangePicker`
+-
#### IgbBulletGraph
-- 新しい `LabelsVisible` プロパティが追加されました。
+- 新しい プロパティが追加されました。
#### チャート
- DataToolTipLayer、ItemToolTipLayer、CategoryToolTipLayer にスタイル設定用の新しいプロパティが追加されました: `ToolTipBackground`、`ToolTipBorderBrush`、および `ToolTipBorderThickness`。
@@ -336,21 +338,21 @@ col.Pinned = true;
**Breaking Changes**
-- `AzureMapsMapImagery` was renamed to `AzureMapsImagery`
+- `AzureMapsMapImagery` was renamed to
- `AzureMapsImageryStyle.Imagery` was renamed to `AzureMapsImageryStyle.Satellite`
-- The following `AzureMapsImageryStyle` enum values were renamed to include the Overlay suffix:
- - `TerraOverlay`,
- - `LabelsRoadOverlay`
- - `LabelsDarkGreyOverlay`
- - `HybridRoadOverlay`
- - `HybridDarkGreyOverlay`
- - `WeatherRadarOverlay`
- - `WeatherInfraredOverlay`
- - `TrafficAbsoluteOverlay`
- - `TrafficRelativeOverlay`
- - `TrafficRelativeDarkOverlay`
- - `TrafficDelayOverlay`
- - `TrafficReducedOverlay`
+- The following enum values were renamed to include the Overlay suffix:
+ - ,
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ -
### {PackageMaps} 地理マップ
@@ -374,20 +376,20 @@ col.Pinned = true;
#### 一般
以下のコンポーネントのプロパティが null 許容になりました。
-- `Button`: `Form`
-- `Calendar`: `SpecialDates`、`DisabledDates`
-- `Combo`: `ValueKey`、`DisplayKey`、`GroupKey`
-- `DatePicker`: `Value`、`Min`、`Max`
-- `DateTimePicker`: `Value`、`Min`、`Max`
-- `Dropdown`: `SelectedItem`
-- `Input`: `Pattern`、`MinLength`、`MaxLength`、`Min`、`Max`、`Step`
-- `Select`: `Value`、`SelectedItem`
-- `Tile`: `ColStart`、`RowStart`
-- `TileManager`: `MinColumnWidth`、`MinRowHeight`、`Gap`
+- :
+- : 、
+- : 、、
+- : 、、
+- `DateTimePicker`: 、、
+- :
+- : 、、、、、
+- : 、
+- : 、
+- : 、、
**Breaking Changes**
-- A fix was made due to an issue where the `PlotAreaPosition` and `ChartPosition` properties on `ChartMouseEventArgs` class were reversed. This will change the values that `PlotAreaPosition` and `ChartPosition` return.
+- A fix was made due to an issue where the and properties on class were reversed. This will change the values that and return.
### **{PackageVerChanges-25-1-JULY}**
@@ -399,18 +401,18 @@ col.Pinned = true;
|37718 | `IgbTab` | タブ パネル内のグリッドに新しい行を追加した際に、予期しないスクロールが発生する。|
|37855 | `IgbGrid` | グリッドに HeaderTemplate が含まれており、ページが安全でない (http) プロトコルを使用してアクセスされた場合、Crypto.randomUID が見つからないというエラーがスローされる。|
-- `SuffixText`
-- `SuffixTextColor`
+-
+-
- `SuffixTextFont`
-- `SuffixIconName`
-- `SuffixIconCollectionName`
-- `SuffixIconStroke`
-- `SuffixIconFill`
-- `SuffixIconViewBoxLeft`
-- `SuffixIconViewBoxTop`
-- `SuffixIconViewBoxWidth`
-- `SuffixIconViewBoxHeight`
-- `TextDecoration`
+-
+-
+-
+-
+-
+-
+-
+-
+-
Please note that the maximum size available for the icons is 24x24. You can provide an icon that is larger or smaller than this, but you will need to configure the viewbox settings in order to properly scale it to fit in the 24x24 space so it is fully visible.
@@ -436,31 +438,31 @@ Please note that the maximum size available for the icons is 24x24. You can prov
- データ注釈スライス レイヤー
- データ注釈ストリップ レイヤー
-- [データ ツールチップ](charts/features/chart-data-tooltip.md)と[データ 凡例](charts/features/chart-data-legend.md)では、ツールチップまたは凡例のコンテンツをテーブルまたは垂直レイアウト構造でレイアウトするために使用できる `LayoutMode` プロパティが公開されています。
+- [データ ツールチップ](charts/features/chart-data-tooltip.md)と[データ 凡例](charts/features/chart-data-legend.md)では、ツールチップまたは凡例のコンテンツをテーブルまたは垂直レイアウト構造でレイアウトするために使用できる プロパティが公開されています。
-- チャートの `DefaultInteraction` プロパティが更新され、新しい列挙体 `DragSelect` が含まれるようになりました。これにより、ドラッグされたプレビュー Rect は、その中に含まれるポイントを選択します。 (ベータ版)
+- チャートの プロパティが更新され、新しい列挙体 `DragSelect` が含まれるようになりました。これにより、ドラッグされたプレビュー Rect は、その中に含まれるポイントを選択します。 (ベータ版)
-- [ValueOverlay と ValueLayer](charts/features/chart-overlays.md) は、上記にリストした [チャート データ注釈](charts/features/chart-data-annotations.md)に加えて、プロット領域に追加の注釈テキストをオーバーレイするために使用できる `OverlayText` プロパティを公開するようになりました。これらの注釈の外観は、OverlayText プレフィックスが付いた多くのプロパティを使用して構成できます。たとえば、`OverlayTextBrush` プロパティはオーバーレイ テキストの色を構成します。 (ベータ版)
+- [ValueOverlay と ValueLayer](charts/features/chart-overlays.md) は、上記にリストした [チャート データ注釈](charts/features/chart-data-annotations.md)に加えて、プロット領域に追加の注釈テキストをオーバーレイするために使用できる プロパティを公開するようになりました。これらの注釈の外観は、OverlayText プレフィックスが付いた多くのプロパティを使用して構成できます。たとえば、`OverlayTextBrush` プロパティはオーバーレイ テキストの色を構成します。 (ベータ版)
#### 一般
-- `Tooltip` は、特定の要素のツールチップを表示する方法を提供します。使用するには、必要に応じてコンテンツを設定し、`Anchor` プロパティを介してターゲット要素の ID にリンクします。
+- は、特定の要素のツールチップを表示する方法を提供します。使用するには、必要に応じてコンテンツを設定し、 プロパティを介してターゲット要素の ID にリンクします。
#### 変更内容
- いくつかの列挙は名前が変更され、他の列挙と統合されました。名前の変更 (影響を受けるコンポーネントを含む):
- - `BaseAlertLikePosition` (`Snackbar` と `Toast`) は `AbsolutePosition` に名前が変更されました。
- - `ButtonGroupAlignment` (`ButtonGroup`)、`CalendarOrientation` (`Calendar`)、`CardActionsOrientation` (`CardActions`)、`DatePickerOrientation` (`DatePicker`)、`RadioGroupAlignment` (`RadioGroup`) が統合され、`ContentOrientation` に名前が変更されました。
- - `CalendarBaseSelection` (`Calendar`) は `CalendarSelection` に名前が変更されました。
- - `CarouselAnimationType` (`Carousel`) と `StepperHorizontalAnimation` (`Stepper`) が統合され、`HorizontalTransitionAnimation` に名前が変更されました。
- - `CheckboxBaseLabelPosition` (`Checkbox` と `Switch`) と `RadioLabelPosition` (`Radio`) が統合され、`ToggleLabelPosition` に名前が変更されました。
- - `DatePickerMode` (`DatePicker`) は `PickerMode` に名前が変更されました。
- - `DatePickerHeaderOrientation` (`DatePicker`) は `CalendarHeaderOrientation` に名前変更/統合されました。
- - `DropdownPlacement` (`Dropdown` と `Select`) は `PopoverPlacement` に名前が変更されました。
- - `DropdownScrollStrategy` (`Dropdown`) と `SelectScrollStrategy` (`Select`) が統合され、`PopoverScrollStrategy` に名前が変更されました。
- - `SliderBaseTickOrientation` (`Slider` および `RangeSlider`) の名前が `SliderTickOrientation` に変更されました。
- - `TickLabelRotation` (`Slider` と `RangeSlider`) の名前が `SliderTickLabelRotation` に変更されました。
-- `Tabs`
+ - `BaseAlertLikePosition` ( と ) は `AbsolutePosition` に名前が変更されました。
+ - `ButtonGroupAlignment` ()、`CalendarOrientation` ()、`CardActionsOrientation` ()、`DatePickerOrientation` ()、`RadioGroupAlignment` () が統合され、`ContentOrientation` に名前が変更されました。
+ - `CalendarBaseSelection` () は `CalendarSelection` に名前が変更されました。
+ - `CarouselAnimationType` () と `StepperHorizontalAnimation` () が統合され、`HorizontalTransitionAnimation` に名前が変更されました。
+ - `CheckboxBaseLabelPosition` ( と ) と `RadioLabelPosition` () が統合され、`ToggleLabelPosition` に名前が変更されました。
+ - `DatePickerMode` () は `PickerMode` に名前が変更されました。
+ - `DatePickerHeaderOrientation` () は `CalendarHeaderOrientation` に名前変更/統合されました。
+ - `DropdownPlacement` ( と ) は `PopoverPlacement` に名前が変更されました。
+ - `DropdownScrollStrategy` () と `SelectScrollStrategy` () が統合され、`PopoverScrollStrategy` に名前が変更されました。
+ - `SliderBaseTickOrientation` ( および ) の名前が `SliderTickOrientation` に変更されました。
+ - ( と ) の名前が `SliderTickLabelRotation` に変更されました。
+-
## {PackageGrids} (グリッド)
@@ -519,16 +521,16 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
- Data Annotation Slice Layer
- Data Annotation Strip Layer
-- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose `LayoutMode` property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
+- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
-- The `DefaultInteraction` property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
+- The property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
-- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an `OverlayText` property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
+- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
- [Trendline Layer](charts/features/chart-trendlines.md) series type that allows you to apply a single trend line per trend line layer to a particular series. This allows the usage of multiple trend lines on a single series since you can have multiple [TrendlineLayer](charts/features/chart-overlays.md) series types in the chart.
### List
-- `ListItem` に新しいプロパティ `Selected` を追加しました。
+- に新しいプロパティ を追加しました。
@@ -541,13 +543,13 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
- The tooltip can be further customized with `Show/HideDelay`, `Placement` around the target and customizable `Show/HideTriggers` events.
+ The tooltip can be further customized with `Show/HideDelay`, around the target and customizable `Show/HideTriggers` events.
### Accordion
-- 新しいイベント `Open` および `Close` を追加しました。
+- 新しいイベント および `Close` を追加しました。
- Simplified configuration by removing the need to define separate panel and linking the panel and tab header. The `Panel` property and the `IgbTabPanel` itself have been removed. Content can be now assigned directly to the `Tab` and header text can be set conveniently via the new `Label` property or by projecting an element to `slot="label"` for more involved customization.
+ Simplified configuration by removing the need to define separate panel and linking the panel and tab header. The `Panel` property and the `IgbTabPanel` itself have been removed. Content can be now assigned directly to the and header text can be set conveniently via the new property or by projecting an element to `slot="label"` for more involved customization.
Before:
@@ -592,21 +594,21 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
```
-- `Input`
- - `Min` & `Max` are now `double` instead of `string`
-- `Stepper`
- - `ActiveStepChangingArgsEventArgs` has been renamed to `ActiveStepChangingEventArgs`
- - `ActiveStepChangedArgsEventArgs` has been renamed to `ActiveStepChangedEventArgs`
+-
+ - & are now `double` instead of `string`
+-
+ - `ActiveStepChangingArgsEventArgs` has been renamed to
+ - `ActiveStepChangedArgsEventArgs` has been renamed to
- `StepperTitlePosition` now defaults to `Auto` to correctly reflect the default behavior
-- `Tree`
- - `TreeSelectionChangeEventArgs` has been renamed to `TreeSelectionEventArgs`
-- `Textarea`
- - `Autocapitalize` & `InputMode` are now `string` properties instead of explicit enums
+-
+ - `TreeSelectionChangeEventArgs` has been renamed to
+-
+ - & are now `string` properties instead of explicit enums
### {PackageGrids}
- **すべてのグリッド**
- - `FilteringExpressionsTree` プロパティを使用して初期フィルタリングの適用が可能になりました。
+ - プロパティを使用して初期フィルタリングの適用が可能になりました。
### バグ修正
@@ -642,9 +644,9 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
### Toolbar
-- `Toolbar` と `ToolPanel` に新しい `GroupHeaderTextStyle` プロパティを追加しました。設定されている場合、すべての `ToolActionGroupHeader` アクションに適用されます。
-- タイトル テキストの水平方向の配置を制御する `TitleHorizontalAlignment` という新しいプロパティを `ToolAction` に追加しました。
-- `ToolActionSubPanel` に、パネル内の項目間の間隔を制御する `ItemSpacing` という新しいプロパティを追加しました。
+- と に新しい `GroupHeaderTextStyle` プロパティを追加しました。設定されている場合、すべての アクションに適用されます。
+- タイトル テキストの水平方向の配置を制御する という新しいプロパティを に追加しました。
+- に、パネル内の項目間の間隔を制御する という新しいプロパティを追加しました。
## バグ修正
@@ -655,7 +657,7 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
### {PackageGrids}
#### **{PackageVerChanges-24-2-DEC}**
-- Added new property on `ListItem` called `Selected`
+- Added new property on called
#### {PackageCharts} (チャート)
- [Dashboard Tile](dashboard-tile.md) コンポーネントは、バインドされた ItemsSource コレクションまたは単一のポイントを分析および視覚化し、データのスキーマとカウントに基づいて適切なデータ視覚化を返すコンテナー コントロールです。このコントロールは、組み込みの [Toolbar](menus/toolbar.md) コンポーネントを利用して、実行時に視覚化を変更できるようにし、最小限のコードでデータのさまざまな視覚化を表示できるようにします。
@@ -684,7 +686,7 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
### {PackageCharts} (チャート)
-- 新しい[データ円チャート](charts/types/data-pie-chart.md) - `DataPieChart` は円ャートを表示する新しいコンポーネントです。このコンポーネントは、`CategoryChart` と同様に動作し、基になるデータ モデルのプロパティを自動的に検出しながら、ItemLegend コンポーネントを介して選択、強調表示、アニメーション、凡例のサポートを可能にします。
+- 新しい[データ円チャート](charts/types/data-pie-chart.md) - は円ャートを表示する新しいコンポーネントです。このコンポーネントは、 と同様に動作し、基になるデータ モデルのプロパティを自動的に検出しながら、ItemLegend コンポーネントを介して選択、強調表示、アニメーション、凡例のサポートを可能にします。
## 一般
@@ -692,15 +694,15 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
#### **{PackageVerChanges-24-1-JUN}**
-- Added new `GroupHeaderTextStyle` property to `Toolbar` and `ToolPanel`. If set, it will apply to all `ToolActionGroupHeader` actions.
-- Added new property on `ToolAction` called `TitleHorizontalAlignment` which controls the horizontal alignment of the title text.
-- Added new property on `ToolActionSubPanel` called `ItemSpacing` which controls the spacing between items inside the panel.
+- Added new `GroupHeaderTextStyle` property to and . If set, it will apply to all actions.
+- Added new property on called which controls the horizontal alignment of the title text.
+- Added new property on called which controls the spacing between items inside the panel.
### 一般
-- `Input`、`Textarea` - ユーザー入力を制限することなく検証ルールを適用できるように `ValidateOnly` を公開しました。
-- `Dropdown` - `PositionStrategy` プロパティは非推奨です。ドロップダウンは、ブラウザー ビューポートの最上位レイヤーにコンテナーをレンダリングするために `Popover` API を使用するようになったため、このプロパティは廃止されました。
-- `DockManager` - `SplitPane` の `IsMaximized` は非推奨です。分割ペイン レベルで isMaximized を true に設定しても、分割ペインはコンテナーとしてのみ機能し、最大化されて表示される実際のコンテンツがないため、実際の効果はありません。代わりに、`TabGroupPane` および/または `ContentPane` の `IsMaximized` プロパティを使用してください。
+- 、 - ユーザー入力を制限することなく検証ルールを適用できるように を公開しました。
+- - プロパティは非推奨です。ドロップダウンは、ブラウザー ビューポートの最上位レイヤーにコンテナーをレンダリングするために `Popover` API を使用するようになったため、このプロパティは廃止されました。
+- - の は非推奨です。分割ペイン レベルで isMaximized を true に設定しても、分割ペインはコンテナーとしてのみ機能し、最大化されて表示される実際のコンテンツがないため、実際の効果はありません。代わりに、 および/または の プロパティを使用してください。
| Bug Number | Control | Description |
|------------|---------|------------------|
@@ -730,7 +732,7 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
### {PackageCharts} (チャート)
-- [データ凡例のグループ化](charts/features/chart-data-legend.md#{PlatformLower}-データ凡例のグループ化) と [データ ツールチップのグループ化](charts/features/chart-data-tooltip.md#{PlatformLower}-データ-チャートのデータ-ツールチップのグループ化) - 新しいグループ化機能が追加されました。`GroupRowVisible` プロパティは、各シリーズのグループ化を切り替え、オプトインすると `DataLegendGroup` プロパティを介してグループ テキストを割り当てることができます 同じ値が複数のシリーズに適用されている場合、それらはグループ化されて表示されます。すべてのユーザー向けに分類および整理する必要がある大規模なデータセットに役立ちます。
+- [データ凡例のグループ化](charts/features/chart-data-legend.md#{PlatformLower}-データ凡例のグループ化) と [データ ツールチップのグループ化](charts/features/chart-data-tooltip.md#{PlatformLower}-データ-チャートのデータ-ツールチップのグループ化) - 新しいグループ化機能が追加されました。 プロパティは、各シリーズのグループ化を切り替え、オプトインすると プロパティを介してグループ テキストを割り当てることができます 同じ値が複数のシリーズに適用されている場合、それらはグループ化されて表示されます。すべてのユーザー向けに分類および整理する必要がある大規模なデータセットに役立ちます。
## {PackageGauges} (ゲージ)
@@ -740,53 +742,53 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
### {PackageCharts} (チャート)
-`InitialFilter` プロパティによる新しいデータ フィルタリング。フィルター式を適用して、チャート データをレコードのサブセットにフィルターします。大規模なデータのドリルダウンに使用できます。
+ プロパティによる新しいデータ フィルタリング。フィルター式を適用して、チャート データをレコードのサブセットにフィルターします。大規模なデータのドリルダウンに使用できます。
-- `BulletGraph`
- - `HighlightValueDisplayMode` が 'Overlay' 設定に適用されたとき、パフォーマンス バーには値と新しい `HighlightValue` の差が反映されるようになりました。ハイライト値には、フィルタリング/サブセットの測定パーセンテージが塗りつぶされた色で表示され、残りのバーの外観は割り当てられた値に対して薄く表示され、リアルタイムでパフォーマンスを示します。
-- `LinearGauge`
- - 新しいハイライト針が追加されました。`HighlightValue` と `HighlightValueDisplayMode` の両方に値と 'Overlay' 設定が指定されたとき、メインの針が薄く表示され、新しい針が表示されます。
-- `RadialGauge`
- - 新しいハイライト針が追加されました。`HighlightValue` と `HighlightValueDisplayMode` の両方に値と 'Overlay' 設定が指定されたとき、メインの針が薄く表示され、新しい針が表示されます。
+-
+ - が 'Overlay' 設定に適用されたとき、パフォーマンス バーには値と新しい の差が反映されるようになりました。ハイライト値には、フィルタリング/サブセットの測定パーセンテージが塗りつぶされた色で表示され、残りのバーの外観は割り当てられた値に対して薄く表示され、リアルタイムでパフォーマンスを示します。
+-
+ - 新しいハイライト針が追加されました。 と の両方に値と 'Overlay' 設定が指定されたとき、メインの針が薄く表示され、新しい針が表示されます。
+-
+ - 新しいハイライト針が追加されました。 と の両方に値と 'Overlay' 設定が指定されたとき、メインの針が薄く表示され、新しい針が表示されます。
- With the release of version 2024.2 and per the [Microsoft .NET lifecycle](https://dotnet.microsoft.com/en-us/platform/support/policy/dotnet-core), we no longer support .NET 3.1, .NET 5, or .NET 7.
## **{PackageVerChanges-23-2-APR}**
### **{PackageVerChanges-23-2-MAR}**
- New [Carousel](layouts/carousel.md) component.
-- `Input`
- - Changed `change` event argument type from `ComponentDataValueChangedEventArgs` to `ComponentValueChangedEventArgs`
+-
+ - Changed `change` event argument type from to
## 新しいコンポーネント
### 新機能
-- `DockManager`
- - 新しい `ProximityDock` プロパティ。有効にすると、ドッキング インジケーターは表示されなくなり、エンド ユーザーは、ドラッグしたペインをターゲット ペインの端に近づけてドラッグすることでドッキングできます。
- - 新しい `ContainedInBoundaries` プロパティ。フローティング ペインを Dock Manager の境界内に保持するかどうかを決定します。デフォルトは **false** です。
- - 新しい `ShowPaneHeaders` プロパティ。ペインのヘッダーをホバー時にのみ表示するか、常に表示するかを決定します。デフォルトは `always` です。
-- `Tree`
+-
+ - 新しい プロパティ。有効にすると、ドッキング インジケーターは表示されなくなり、エンド ユーザーは、ドラッグしたペインをターゲット ペインの端に近づけてドラッグすることでドッキングできます。
+ - 新しい プロパティ。フローティング ペインを Dock Manager の境界内に保持するかどうかを決定します。デフォルトは **false** です。
+ - 新しい プロパティ。ペインのヘッダーをホバー時にのみ表示するか、常に表示するかを決定します。デフォルトは `always` です。
+-
- ノードをクリックすると展開状態が変更されるかどうかを決定する `toggleNodeOnClick` プロパティが追加されました。デフォルトは **false** です。
-- `Rating`
+-
- `allowReset` が追加されました。有効にすると、同じ値を選択するとコンポーネントがリセットされます。**動作の変更** - 以前のリリースでは、これが Rating コンポーネントのデフォルトの動作でした。アプリケーションでこの動作を維持する必要がある場合は、必ず `allowReset` を設定してください。
-- `Select`、`Dropdown`
+- 、
- `selectedItem`、`items`、および `groups` ゲッターが公開されました。
-- `RadialGauge`
- - 新しいタイトル/サブタイトルのプロパティ。`TitleText`、`SubtitleText` はゲージの下部近くに表示されます。さらに、`TitleFontSize`、`TitleFontFamily`、`TitleFontStyle`、`TitleFontWeight`、`TitleExtent` など、さまざまなタイトルとサブタイトルのフォント プロパティが追加されました。最後に、新しい `TitleDisplaysValue` により、値を針の位置に対応させることができます。
- - `RadialGauge` の新しい `OpticalScalingEnabled` プロパティと `OpticalScalingSize` プロパティ。この新機能は、ゲージのラベル、タイトル、サブタイトルが 100% のオプティカル スケーリングを持つサイズを管理します。この新機能の詳細については、[こちら](radial-gauge.md#オプティカル-スケーリング)を参照してください。
- - 新しいハイライト針が追加されました。`HighlightValue` と `HighlightValueDisplayMode` の両方に値と 'Overlay' 設定が指定されたとき、メインの針が薄く表示され、新しい針が表示されます。
+-
+ - 新しいタイトル/サブタイトルのプロパティ。、 はゲージの下部近くに表示されます。さらに、`TitleFontSize`、`TitleFontFamily`、`TitleFontStyle`、`TitleFontWeight`、 など、さまざまなタイトルとサブタイトルのフォント プロパティが追加されました。最後に、新しい により、値を針の位置に対応させることができます。
+ - の新しい プロパティと プロパティ。この新機能は、ゲージのラベル、タイトル、サブタイトルが 100% のオプティカル スケーリングを持つサイズを管理します。この新機能の詳細については、[こちら](radial-gauge.md#オプティカル-スケーリング)を参照してください。
+ - 新しいハイライト針が追加されました。 と の両方に値と 'Overlay' 設定が指定されたとき、メインの針が薄く表示され、新しい針が表示されます。
- `RadialChart`
- 新しいラベル モード
- - 新しいタイトル/サブタイトルのプロパティ。`TitleText`、`SubtitleText` はゲージの下部近くに表示されます。さらに、`TitleFontSize`、`TitleFontFamily`、`TitleFontStyle`、`TitleFontWeight`、`TitleExtent` など、さまざまなタイトルとサブタイトルのフォント プロパティが追加されました。最後に、新しい `TitleDisplaysValue` により、値を針の位置に対応させることができます。
- - `RadialGauge` の新しい `OpticalScalingEnabled` プロパティと `OpticalScalingSize` プロパティ。この新機能は、ゲージのラベル、タイトル、サブタイトルが 100% のオプティカル スケーリングを持つサイズを管理します。この新機能の詳細については、[このトピック](radial-gauge.md#オプティカル-スケーリング)を参照してください。
- - 新しいハイライト針が追加されました。`HighlightValue` と `HighlightValueDisplayMode` の両方に値と 'Overlay' 設定が指定されたとき、メインの針が薄く表示され、新しい針が表示されます。
+ - 新しいタイトル/サブタイトルのプロパティ。、 はゲージの下部近くに表示されます。さらに、`TitleFontSize`、`TitleFontFamily`、`TitleFontStyle`、`TitleFontWeight`、 など、さまざまなタイトルとサブタイトルのフォント プロパティが追加されました。最後に、新しい により、値を針の位置に対応させることができます。
+ - の新しい プロパティと プロパティ。この新機能は、ゲージのラベル、タイトル、サブタイトルが 100% のオプティカル スケーリングを持つサイズを管理します。この新機能の詳細については、[このトピック](radial-gauge.md#オプティカル-スケーリング)を参照してください。
+ - 新しいハイライト針が追加されました。 と の両方に値と 'Overlay' 設定が指定されたとき、メインの針が薄く表示され、新しい針が表示されます。
- `RadialChart`
- 新しいラベル モード
- `CategoryAngleAxis` は、ラベルの位置をさらに構成できる `LabelMode` プロパティを公開するようになりました。これにより、`Center` 列挙型を選択してデフォルト モードを切り替えることも、ラベルを円形のプロット領域に近づける新しいモード `ClosestPoint` を使用することもできます。
+ は、ラベルの位置をさらに構成できる プロパティを公開するようになりました。これにより、`Center` 列挙型を選択してデフォルト モードを切り替えることも、ラベルを円形のプロット領域に近づける新しいモード `ClosestPoint` を使用することもできます。
-- New [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `DataChart`, to plot slices similar to a pie chart, a type of data visualization where data points are represented as segments within a circular graph.
+- New [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the , to plot slices similar to a pie chart, a type of data visualization where data points are represented as segments within a circular graph.
-- `Toolbar`
+-
- New ToolActionCheckboxList
A new CheckboxList ToolAction that displays a collection of items with checkboxes for selecting. A grid inside ToolAction CheckboxList grows in height up to 5 items, then a scrollbar is displayed.
@@ -801,43 +803,43 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
### 一般
-- `Input`、`MaskInput`、`DateTimeInput`、`Rating`
- - `Readonly` は `ReadOnly` に名前が変更されました。
-- `Input`
- - `Maxlength` は `MaxLength` に名前が変更されました。
- - `Minlength` は `MinLength` に名前が変更されました。
+- 、、、
+ - `Readonly` は に名前が変更されました。
+-
+ - `Maxlength` は に名前が変更されました。
+ - `Minlength` は に名前が変更されました。
**Breaking Changes**
- Renamed old **IgbDatePicker** to **IgbXDatePicker**.
-- Removed `Form` component. Use native form instead.
+- Removed component. Use native form instead.
- Removed `size` property in favor of the `--ig-size` CSS custom property for the following components:
- - `Avatar`, `Button`,`IconButton`, `Calendar`, `Chip`, `Dropdown`, `Icon`, `Input`, `List`, `Rating`, `Snackbar`, `Tabs`, `Tree`
-- `Badge`, `Chip`, `LinearProgress`, `CircularProgress`
- - Renamed `Variant` property type to `StyleVariant`.
-- `Calendar`
- - Renamed `WeekStart` property type to `WeekDays`.
-- `Checkbox`, `Switch`
- - Changed `Change` event argument type from `ComponentBoolValueChangedEventArgs` to `CheckboxChangeEventArgs`.
-- `Combo`
- - The `IgbCombo` is now of generic type and the `Value` type is now of type `T[]`. This means that either you need to specify `T` or it will be inferred by the assigned `Value` type.
- - Removed `PositionStrategy`, `Flip`, `SameWidth` properties.
+ - , ,, , , , , , , , , ,
+- , , ,
+ - Renamed property type to `StyleVariant`.
+-
+ - Renamed property type to `WeekDays`.
+- ,
+ - Changed `Change` event argument type from to .
+-
+ - The `IgbCombo` is now of generic type and the type is now of type `T[]`. This means that either you need to specify `T` or it will be inferred by the assigned type.
+ - Removed , , properties.
- **IgbSelectComponent**
- - Removed `PositionStrategy`, `Flip`, `SameWidth` properties.
-- `DateTimeInput`
- - Removed `MaxValue` and `MinValue` properties. Use `Max` and `Min` instead.
-- `Dropdown`
- - Removed `PositionStrategy` property.
-- `Input`
- - Removed old named `Maxlength` and `Minlength` properties. Use `MaxLength` and `MinLength`.
- - Removed old named `Readonly` and `Inputmode` properties. Use `ReadOnly` and `InputMode`.
- - Changed `InputMode` type also to `string`.
-- `Radio`
- - Changed `Change` event argument type from `ComponentBoolValueChangedEventArgs` to `RadioChangeEventArgs`.
-- `RangeSlider`
- - Removed `AriaThumbLower` and `AriaThumbUpper` properties. Use `ThumbLabelLower` and `ThumbLabelUpper` instead.
-- `Rating`
- - Renamed `Readonly` property to `ReadOnly`.
+ - Removed , , properties.
+-
+ - Removed `MaxValue` and `MinValue` properties. Use and instead.
+-
+ - Removed property.
+-
+ - Removed old named `Maxlength` and `Minlength` properties. Use and .
+ - Removed old named `Readonly` and `Inputmode` properties. Use and .
+ - Changed type also to `string`.
+-
+ - Changed `Change` event argument type from to .
+-
+ - Removed `AriaThumbLower` and `AriaThumbUpper` properties. Use and instead.
+-
+ - Renamed `Readonly` property to .
### 非推奨
@@ -852,34 +854,34 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
## 削除済
### **{PackageVerChanges-23-2-JAN}**
-- `Input`, `Textarea` - exposed `ValidateOnly` to enable validation rules being enforced without restricting user input.
-- `Dropdown` - `PositionStrategy` property is deprecated. The dropdown now uses the `Popover` API to render its container in the top layer of the browser viewport, making the property obsolete.
-- `DockManager` - `SplitPane` `IsMaximized` is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the `IsMaximized` property of `TabGroupPane` and/or `ContentPane` instead.
+- , - exposed to enable validation rules being enforced without restricting user input.
+- - property is deprecated. The dropdown now uses the `Popover` API to render its container in the top layer of the browser viewport, making the property obsolete.
+- - is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the property of and/or instead.
### .NET 8.0 のサポート
- 2023.2 リリースでは .NET 8 がサポートされます。.NET 8 の詳細については、[Microsoft サイト](https://learn.microsoft.com/ja-jp/dotnet/core/whats-new/dotnet-8)をご確認ください。
-The type of Values from `PivotConfiguration` option is now array of IgbPivotValue - `IgbPivotValue[]`, it was `IgbPivotValueCollection` previously.
+The type of Values from option is now array of IgbPivotValue - `IgbPivotValue[]`, it was `IgbPivotValueCollection` previously.
### {PackageCharts} (チャート)
-- [チャートのハイライト表示フィルター](charts/features/chart-highlight-filter.md) - `CategoryChart` と `DataChart` は、データのサブセットの内外でハイライト表示およびアニメーション化する方法を公開するようになりました。このハイライト表示の表示はシリーズのタイプによって異なります。列およびエリア シリーズの場合、サブセットはデータの合計セットの上に表示され、サブセットはシリーズの実際のブラシによって色付けされ、合計セットは不透明度を下げます。折れ線シリーズの場合、サブセットは点線で表示されます。
+- [チャートのハイライト表示フィルター](charts/features/chart-highlight-filter.md) - と は、データのサブセットの内外でハイライト表示およびアニメーション化する方法を公開するようになりました。このハイライト表示の表示はシリーズのタイプによって異なります。列およびエリア シリーズの場合、サブセットはデータの合計セットの上に表示され、サブセットはシリーズの実際のブラシによって色付けされ、合計セットは不透明度を下げます。折れ線シリーズの場合、サブセットは点線で表示されます。
-- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for `CategoryChart` and `DataChart`. Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and `SelectedSeriesItems` are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
+- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for and . Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
-- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `DataChart`, to enable creating pie charts in the allowing robust visualizations using all the added power of the data chart.
+- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the , to enable creating pie charts in the allowing robust visualizations using all the added power of the data chart.
-- [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a `HighlightingMode` property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the `HighlightingTransitionDuration` property.
+- [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the property.
-- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new `HighlightedItemsSource`. Can be toggled via `HighlightedValuesDisplayMode` and styled via `FillBrushes`.
+- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new . Can be toggled via and styled via .
-- `Toolbar` - New `IsHighlighted` option for ToolAction for outlining a border around specific tools of choice.
+- - New option for ToolAction for outlining a border around specific tools of choice.
### **{PackageVerChanges-23-2}**
-- `RadialGauge`
- - New label for the highlight needle. `HighlightLabelText` and `HighlightLabelSnapsToNeedlePivot` and many other styling related properties for the HighlightLabel were added.
+-
+ - New label for the highlight needle. and and many other styling related properties for the HighlightLabel were added.
## {PackageGrids} - Toolbar -
@@ -888,12 +890,12 @@ The type of Values from `PivotConfiguration` option is now array of IgbPivotValu
- 新規機能:
- [状態保持](grids/grid/state-persistence.md)
-- `BulletGraph`
- - The Performance bar will now reflect a difference between the value and new `HighlightValue` when the `HighlightValueDisplayMode` is applied to the 'Overlay' setting. The highlight value will show a filtered/subset measured percentage as a filled in color while the remaining bar's appearance will appear faded to the assigned value, illustrating the performance in real-time.
-- `LinearGauge`
- - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
-- `RadialGauge`
- - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
+-
+ - The Performance bar will now reflect a difference between the value and new when the is applied to the 'Overlay' setting. The highlight value will show a filtered/subset measured percentage as a filled in color while the remaining bar's appearance will appear faded to the assigned value, illustrating the performance in real-time.
+-
+ - New highlight needle was added. and when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
+-
+ - New highlight needle was added. and when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
## **{PackageVerChanges-23-1}**
@@ -903,27 +905,27 @@ The type of Values from `PivotConfiguration` option is now array of IgbPivotValu
### {PackageCharts} (チャート)
-- [ValueLayer](charts/features/chart-overlays.md#{PlatformLower}-value-layer) - `ValueLayer` という名前の新しいシリーズ タイプが公開されました。これにより、Maximum、Minimum、Average など、プロットされたデータのさまざまな焦点のオーバーレイを描画できます。これは、新しい `ValueLines` コレクションに追加することで、`CategoryChart` と `FinancialChart` に適用されます。
+- [ValueLayer](charts/features/chart-overlays.md#{PlatformLower}-value-layer) - という名前の新しいシリーズ タイプが公開されました。これにより、Maximum、Minimum、Average など、プロットされたデータのさまざまな焦点のオーバーレイを描画できます。これは、新しい コレクションに追加することで、 と に適用されます。
### **{PackageVerChanges-22-2.65}**
-- `DockManager`
- - New `ProximityDock` property. If enabled, docking indicators are not visible and the end user can dock the dragged pane by dragging it close to the target pane edges.
- - New `ContainedInBoundaries` property. Determines whether the floating panes are kept inside the Dock Manager boundaries. Defaults to `false`.
- - New `ShowPaneHeaders` property. Determines whether pane headers are only shown on hover or always visible. Defaults to `always`.
-- `Tree`
+-
+ - New property. If enabled, docking indicators are not visible and the end user can dock the dragged pane by dragging it close to the target pane edges.
+ - New property. Determines whether the floating panes are kept inside the Dock Manager boundaries. Defaults to `false`.
+ - New property. Determines whether pane headers are only shown on hover or always visible. Defaults to `always`.
+-
- Added `toggleNodeOnClick` property that determines whether clicking over a node will change its expanded state or not. Defaults to `false`.
-- `Rating`
+-
- `allowReset` added. When enabled selecting the same value will reset the component. **Behavioral change** - In previous releases this was the default behavior of the rating component. Make sure to set `allowReset` if you need to keep this behavior in your application.
-- `Select`, `Dropdown`
+- ,
- exposed `selectedItem`, `items` and `groups` getters
-- `RadialGauge`
- - New title/subtitle properties. `TitleText`, `SubtitleText` will appear near the bottom the gauge. In addition, the various title/subtitle font properties were added such as `TitleFontSize`, `TitleFontFamily`, `TitleFontStyle`, `TitleFontWeight` and `TitleExtent`. Finally, the new `TitleDisplaysValue` will allow the value to correspond with the needle's position.
- - New `OpticalScalingEnabled` and `OpticalScalingSize` properties for the `RadialGauge`. This new feature will manage the size at which labels, titles, and subtitles of the gauge have 100% optical scaling. You can read more about this new feature in this [topic](radial-gauge.md#optical-scaling)
- - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
+-
+ - New title/subtitle properties. , will appear near the bottom the gauge. In addition, the various title/subtitle font properties were added such as `TitleFontSize`, `TitleFontFamily`, `TitleFontStyle`, `TitleFontWeight` and . Finally, the new will allow the value to correspond with the needle's position.
+ - New and properties for the . This new feature will manage the size at which labels, titles, and subtitles of the gauge have 100% optical scaling. You can read more about this new feature in this [topic](radial-gauge.md#optical-scaling)
+ - New highlight needle was added. and when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear.
- `RadialChart`
- New Label Mode
- The `CategoryAngleAxis` for the now exposes a `LabelMode` property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
+ The for the now exposes a property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
### 新しいコンポーネント
@@ -936,7 +938,7 @@ The type of Values from `PivotConfiguration` option is now array of IgbPivotValu
### {PackageGrids} (データ グリッド)
-- 新しい引数 `PrimaryKey` が `Detail` から `IgbRowDataEventArgs` に導入されました。これは、`RowAdded` および `RowDeleted` イベントによって発行されるイベント引数の一部です。グリッドに主キー属性が追加されている場合、発行された primaryKey イベント引数は行 ID を表し、それ以外の場合はデフォルトで null 値になります。
+- 新しい引数 `PrimaryKey` が から `IgbRowDataEventArgs` に導入されました。これは、`RowAdded` および `RowDeleted` イベントによって発行されるイベント引数の一部です。グリッドに主キー属性が追加されている場合、発行された primaryKey イベント引数は行 ID を表し、それ以外の場合はデフォルトで null 値になります。
- `RowSelectionChanging` イベント引数が変更されました。現在、グリッドが primaryKey を設定した場合、`OldSelection`、`NewSelection`、`Added` および `Removed` コレクションは、選択された要素の行キーで構成されなくなりましたが、いずれにしても行データが出力されるようになりました。
- グリッドがリモート データを操作していて、主キーが設定されている場合、現在グリッド ビューに含まれていない選択された行に対して、部分的な行データ オブジェクトが発行されます。
- 選択された行がグリッド コンポーネントから削除されると、`RowSelectionChanging` イベントは発生しなくなります。
@@ -950,8 +952,8 @@ The type of Values from `PivotConfiguration` option is now array of IgbPivotValu
- `IgbDateTimeInput`、StepDownAsync(DateTimeInputDatePart.Date, SpinDelta.Date) は、DateTimeInputDatePart ではなく DatePart に切り詰められるようになりました。
- `IgbRadio` および `IgbRadioGroup` は、無効な状態のスタイルとともにコンポーネントの検証が追加されました。
- `IgbMask` は、マスク パターン リテラルをエスケープする機能が追加されました。
-- `IgbBadge` は、バッジの形状を制御する `Shape` プロパティを追加し、`Square` または `Rounded` のいずれかになります。デフォルトでは、バッジの形状は rounded です。
-- `IgbAvatar`、`RoundShape` プロパティは廃止され、将来のバージョンで削除される予定です。ユーザーは、新しく追加された `Shape` 属性によってアバターの形状を制御できます。これは、`Square`、`Rounded`、または `Circle` にすることができます。アバターのデフォルトの形状は `Square`です。
+- `IgbBadge` は、バッジの形状を制御する プロパティを追加し、 または `Rounded` のいずれかになります。デフォルトでは、バッジの形状は rounded です。
+- `IgbAvatar`、`RoundShape` プロパティは廃止され、将来のバージョンで削除される予定です。ユーザーは、新しく追加された 属性によってアバターの形状を制御できます。これは、、`Rounded`、または にすることができます。アバターのデフォルトの形状は です。
### {PackageDockManager} (DockManager)
@@ -977,30 +979,30 @@ The type of Values from `PivotConfiguration` option is now array of IgbPivotValu
### {PackageGrids} (データ グリッド)
-- **{IgPrefix}Column** を `DataGridColumn` に変更しました。
-- **GridCellEventArgs** を `DataGridCellEventArgs` に変更しました。
-- **GridSelectionMode** を `DataGridSelectionMode` に変更しました。
+- **{IgPrefix}Column** を に変更しました。
+- **GridCellEventArgs** を に変更しました。
+- **GridSelectionMode** を に変更しました。
- **SummaryOperand** を `DataSourceSummaryOperand` に変更しました。
-- It is now possible to apply a **dash array** to the different parts of the series of the `DataChart`. You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
+- It is now possible to apply a **dash array** to the different parts of the series of the . You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
## **{PackageVerChanges-22-1}**
### {PackageCharts} (チャート)
-- 高度に構成可能な [DataLegend](charts/features/chart-data-legend.md) コンポーネントが追加されました。これは、`Legend` とよく似たコンポーネントですが、シリーズの値を表示し、シリーズの行と値の列をフィルタリングし、値のスタイルとフォーマットを行うための多くの構成プロパティを提供します。
+- 高度に構成可能な [DataLegend](charts/features/chart-data-legend.md) コンポーネントが追加されました。これは、 とよく似たコンポーネントですが、シリーズの値を表示し、シリーズの行と値の列をフィルタリングし、値のスタイルとフォーマットを行うための多くの構成プロパティを提供します。
- 高度に構成可能な [DataToolTip](charts/features/chart-data-tooltip.md) が追加されました。これは、シリーズの値とタイトル、およびシリーズの凡例バッジをツールチップに表示します。これは、すべてのチャート タイプのデフォルトのツールチップになりました。
-- 積層シリーズのアニメーションとトランジションインのサポートが追加されました。`IsTransitionInEnabled` プロパティを true に設定すると、アニメーションを有効にできます。そこから、`TransitionInDuration` プロパティを設定してアニメーションが完了するまでの時間を決定し、`TransitionInMode` でアニメーションのタイプを決定できます。
-- 追加された `AssigningCategoryStyle` イベントは、`DataChart` のすべてのシリーズで利用できるようになりました。このイベントは、背景色の `Fill` やハイライト表示など、シリーズ項目の外観を条件付きで構成する場合に処理されます。
-- CalloutLayer の新しい `AllowedPositions` 列挙体。チャート内のどこにコールアウトを配置するかを制限するために使用されます。デフォルトでは、コールアウトは最適な場所に配置されますが、これは `TopLeft`、`TopRight`、`BottomLeft`、または `BottomRight` を強制するために使用されます。
+- 積層シリーズのアニメーションとトランジションインのサポートが追加されました。 プロパティを true に設定すると、アニメーションを有効にできます。そこから、 プロパティを設定してアニメーションが完了するまでの時間を決定し、 でアニメーションのタイプを決定できます。
+- 追加された `AssigningCategoryStyle` イベントは、 のすべてのシリーズで利用できるようになりました。このイベントは、背景色の やハイライト表示など、シリーズ項目の外観を条件付きで構成する場合に処理されます。
+- CalloutLayer の新しい 列挙体。チャート内のどこにコールアウトを配置するかを制限するために使用されます。デフォルトでは、コールアウトは最適な場所に配置されますが、これは `TopLeft`、`TopRight`、`BottomLeft`、または `BottomRight` を強制するために使用されます。
- 注釈レイヤーに追加された新しいコーナー半径プロパティ。各コールアウトのコーナーを丸めるために使用されます。コーナー半径がデフォルトで追加されていることに注意してください。
- - CalloutLayer の `CalloutCornerRadius`
- - FinalValueLayer の `AxisAnnotationBackgroundCornerRadius`
- - CrosshairLayer の `XAxisAnnotationBackgroundCornerRadius` と `YAxisAnnotationBackgroundCornerRadius`
-- さまざまな方法でスクロールバーを有効にするための新しい `HorizontalViewScrollbarMode` および `VerticalViewScrollbarMode` 列挙体。`IsVerticalZoomEnabled` または `IsHorizontalZoomEnabled` と組み合わせると、チャートをナビゲートするための軸に沿ったスクロールバーを、常設またはフェードインおよびフェードアウトすることができます。
-- 新しい `FavorLabellingScaleEnd` は、軸がスケールの最後にラベルを表示することを優先するかどうかを決定します。数値軸 (`NumericXAxis`、`NumericYAxis`、`PercentChangeAxis` など) とのみ互換性があります。
-- 新しい `IsSplineShapePartOfRange` は、軸に要求された軸範囲にスプライン形状を含めるかどうかを決定します。
-- 新しい `XAxisMaximumGap` は、`XAxisGap` を使用するときにプロットされたシリーズの最大許容値を決定します。ギャップは、プロットされたシリーズの列またはバー間のスペースの量を決定します。
-- 新しい `XAxisMinimumGapSize` は、`XAxisGap` を使用するときに、プロットされたシリーズの最小許容ピクセルベース値を決定し、各カテゴリ間に常にある程度の間隔があることを保証します。
+ - CalloutLayer の
+ - FinalValueLayer の
+ - CrosshairLayer の と
+- さまざまな方法でスクロールバーを有効にするための新しい および 列挙体。 または と組み合わせると、チャートをナビゲートするための軸に沿ったスクロールバーを、常設またはフェードインおよびフェードアウトすることができます。
+- 新しい は、軸がスケールの最後にラベルを表示することを優先するかどうかを決定します。数値軸 (、、`PercentChangeAxis` など) とのみ互換性があります。
+- 新しい は、軸に要求された軸範囲にスプライン形状を含めるかどうかを決定します。
+- 新しい は、 を使用するときにプロットされたシリーズの最大許容値を決定します。ギャップは、プロットされたシリーズの列またはバー間のスペースの量を決定します。
+- 新しい は、 を使用するときに、プロットされたシリーズの最小許容ピクセルベース値を決定し、各カテゴリ間に常にある程度の間隔があることを保証します。
### {PackageGrids} (データ グリッド)
@@ -1028,7 +1030,7 @@ The type of Values from `PivotConfiguration` option is now array of IgbPivotValu
### {PackageGrids} (データ グリッド)
-- `ValueField` プロパティを string[] 型から string に変更しました。
+- プロパティを string[] 型から string に変更しました。
## {PackageInputs} (入力)
@@ -1062,7 +1064,7 @@ The type of Values from `PivotConfiguration` option is now array of IgbPivotValu
- Responsive layouts for horizontal label rotation based on browser / screen size.
- Enhanced rendering for rounded labels on all platforms.
- Added marker properties to StackedFragmentSeries.
-- Added `ShouldPanOnMaximumZoom` property.
+- Added property.
- New Category Axis Properties:
- ZoomMaximumCategoryRange
- ZoomMaximumItemSpan
@@ -1083,7 +1085,7 @@ The type of Values from `PivotConfiguration` option is now array of IgbPivotValu
- GroupSortDescriptions
-[Chart Aggregation](charts/features/chart-data-aggregations.md) will not work when using `IncludedProperties` | `ExcludedProperties`. These properties on the chart are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
+[Chart Aggregation](charts/features/chart-data-aggregations.md) will not work when using | . These properties on the chart are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
### チャートとマップの改善
@@ -1093,20 +1095,20 @@ The type of Values from `PivotConfiguration` option is now array of IgbPivotValu
### **{PackageVerChanges-21-1}**
-- Added the highly-configurable [DataLegend](charts/features/chart-data-legend.md) component, which works much like the `Legend`, but it shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values.
+- Added the highly-configurable [DataLegend](charts/features/chart-data-legend.md) component, which works much like the , but it shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values.
- Added the highly-configurable [DataToolTip](charts/features/chart-data-tooltip.md) which displays values and titles of series as well as legend badges of series in a tooltip. This is now the default tooltip for all chart types.
-- Added animation and transition-in support for Stacked Series. Animations can be enabled by setting the `IsTransitionInEnabled` property to true. From there, you can set the `TransitionInDuration` property to determine how long your animation should take to complete and the `TransitionInMode` to determine the type of animation that takes place.
-- Added `AssigningCategoryStyle` event, is now available to all series in `DataChart`. This event is handled when you want to conditionally configure aspects of the series items such as `Fill` background-color and highlighting.
-- New `AllowedPositions` enumeration for CalloutLayer. Used to limit where the callouts are to be placed within the chart. By default, the callouts are intelligently placed in the best place but this used to force for example `TopLeft`, `TopRight`, `BottomLeft` or `BottomRight`.
+- Added animation and transition-in support for Stacked Series. Animations can be enabled by setting the property to true. From there, you can set the property to determine how long your animation should take to complete and the to determine the type of animation that takes place.
+- Added `AssigningCategoryStyle` event, is now available to all series in . This event is handled when you want to conditionally configure aspects of the series items such as background-color and highlighting.
+- New enumeration for CalloutLayer. Used to limit where the callouts are to be placed within the chart. By default, the callouts are intelligently placed in the best place but this used to force for example `TopLeft`, `TopRight`, `BottomLeft` or `BottomRight`.
- New corner radius properties added for Annotation Layers; used to round-out the corners of each of the callouts. Note, a corner radius has now been added by default.
- - `CalloutCornerRadius` for CalloutLayer
- - `AxisAnnotationBackgroundCornerRadius` for FinalValueLayer
- - `XAxisAnnotationBackgroundCornerRadius` and `YAxisAnnotationBackgroundCornerRadius` for CrosshairLayer
-- New `HorizontalViewScrollbarMode` and `VerticalViewScrollbarMode` enumeration to enable scrollbars in various ways. When paired with `IsVerticalZoomEnabled` or `IsHorizontalZoomEnabled`, you'll be able to persist or fade-in and out the scrollbars along the axes to navigate the chart.
-- New `FavorLabellingScaleEnd`, determines whether the axis should favor emitting a label at the end of the scale. Only compatible with numeric axes (e.g. `NumericXAxis`, `NumericYAxis`, `PercentChangeAxis`).
-- New `IsSplineShapePartOfRange` determines whether to include the spline shape in the axis range requested of the axis.
-- New `XAxisMaximumGap`, determines the maximum allowed value for the plotted series when using `XAxisGap`. The gap determines the amount of space between columns or bars of plotted series.
-- New `XAxisMinimumGapSize`, determines the minimum allowed pixel-based value for the plotted series when using `XAxisGap` to ensure there is always some spacing between each category.
+ - for CalloutLayer
+ - for FinalValueLayer
+ - and for CrosshairLayer
+- New and enumeration to enable scrollbars in various ways. When paired with or , you'll be able to persist or fade-in and out the scrollbars along the axes to navigate the chart.
+- New , determines whether the axis should favor emitting a label at the end of the scale. Only compatible with numeric axes (e.g. , , `PercentChangeAxis`).
+- New determines whether to include the spline shape in the axis range requested of the axis.
+- New , determines the maximum allowed value for the plotted series when using . The gap determines the amount of space between columns or bars of plotted series.
+- New , determines the minimum allowed pixel-based value for the plotted series when using to ensure there is always some spacing between each category.
### 新しいビジュアル デザイン
@@ -1114,12 +1116,12 @@ Added New Feature - [Row Paging](grids/data-grid/row-paging.md) which is used to
### チャートとマップ
-このリリースでは、すべてのチャート コンポーネントに、いくつかの新しく改善されたビジュアル デザインと構成オプションが導入されています。例えば、`DataChart`、`CategoryChart`、および `FinancialChart`。
+このリリースでは、すべてのチャート コンポーネントに、いくつかの新しく改善されたビジュアル デザインと構成オプションが導入されています。例えば、、、および 。
### チャート凡例
-- バブル、ドーナツ、および円チャートで使用できる水平方向の `Orientation` プロパティを ItemLegend に追加しました。
-- `LegendHighlightingMode` プロパティの追加 - 凡例項目にホバーした時にシリーズのハイライト表示を有効にします。
+- バブル、ドーナツ、および円チャートで使用できる水平方向の プロパティを ItemLegend に追加しました。
+- プロパティの追加 - 凡例項目にホバーした時にシリーズのハイライト表示を有効にします。
## 地理マップ
@@ -1130,9 +1132,9 @@ Added New Feature - [Row Paging](grids/data-grid/row-paging.md) which is used to
### {PackageGrids} (データ グリッド)
- `EditOnKeyPress`、(別名: Excel スタイルの編集) を追加し、入力するとすぐに編集を開始します。
-- `EditModeClickAction` プロパティを追加しました - デフォルトでは、編集モードに入るにはダブル クリックが必要です。これを `SingleClick` に設定して、新しいセルを選択するときに編集モードを実行できるようにすることができます。
-- `EnterKeyBehaviors` プロパティの追加 - 別名 Excel スタイル ナビゲーション (Enter 動作) - Enter キーの動作を制御します。たとえば、オプションは none、edit、move up、down、left、right です。
-- `EnterKeyBehaviorAfterEdit` プロパティの追加 - 編集モードでは、このプロパティは Enter キーが押されたときを制御します。例えば、オプションは (下、上、右、左のセルに移動) です。
+- プロパティを追加しました - デフォルトでは、編集モードに入るにはダブル クリックが必要です。これを に設定して、新しいセルを選択するときに編集モードを実行できるようにすることができます。
+- プロパティの追加 - 別名 Excel スタイル ナビゲーション (Enter 動作) - Enter キーの動作を制御します。たとえば、オプションは none、edit、move up、down、left、right です。
+- プロパティの追加 - 編集モードでは、このプロパティは Enter キーが押されたときを制御します。例えば、オプションは (下、上、右、左のセルに移動) です。
- `SelectAllRows` メソッドを追加しました。
- 行範囲の選択を追加しました - `GridSelectionMode` プロパティを MultipleRow に設定すると、次の新しい機能が含まれるようになりました:
- クリックしてドラッグし、行を選択します。
@@ -1143,18 +1145,18 @@ Added New Feature - [Row Paging](grids/data-grid/row-paging.md) which is used to
### {PackageInputs} (入力)
-- A new `ValueChanged` event supports 2-way binding and should only be handled if you have not bound the `Value` property. In order to read the Value field from the control without data binding the `ValueChanged` event should be handled, otherwise if your data is not bound you should use GetCurrentValueAsync to read the controls Value.
+- A new `ValueChanged` event supports 2-way binding and should only be handled if you have not bound the property. In order to read the Value field from the control without data binding the `ValueChanged` event should be handled, otherwise if your data is not bound you should use GetCurrentValueAsync to read the controls Value.
#### 日付ピッカー
-- `ShowTodayButton` - 現在の日付のボタンの表示を切り替えます。
-- `Label` - 日付値の上にラベルを追加します。
-- `Placeholder` プロパティ - 値が選択されていない場合にカスタム テキストを追加します。
-- `FormatString` - 入力日付文字列をカスタマイズします。(例: `yyyy-MM-dd`)
-- `DateFormat` - 選択した日付を LongDate または ShortDate のどちらとして表示するかを指定します。
-- `FirstDayOfWeek` - 週の最初の曜日を指定します。
-- `FirstWeekOfYear` - 年の最初の週をいつ表示するかを指定します。例えば、最初の 1 週間、最初の 4 日間の週です。
-- `ShowWeekNumbers` - 週番号の表示を切り替えます。
-- `MinDate` & `MaxDate` - 使用可能の選択できる日付の範囲を指定する日付制限。
+- - 現在の日付のボタンの表示を切り替えます。
+- - 日付値の上にラベルを追加します。
+- プロパティ - 値が選択されていない場合にカスタム テキストを追加します。
+- - 入力日付文字列をカスタマイズします。(例: `yyyy-MM-dd`)
+- - 選択した日付を LongDate または ShortDate のどちらとして表示するかを指定します。
+- - 週の最初の曜日を指定します。
+- - 年の最初の週をいつ表示するかを指定します。例えば、最初の 1 週間、最初の 4 日間の週です。
+- - 週番号の表示を切り替えます。
+- & - 使用可能の選択できる日付の範囲を指定する日付制限。
- アクセシビリティの追加
#### Multi-Column ComboBox
@@ -1189,29 +1191,29 @@ For example, ``` ``` instead of ``` ```
This release introduces a few improvements and simplifications to visual design and configuration options for the geographic map and all chart components.
-- Changed `YAxisLabelLocation` property's type to **YAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart` and `CategoryChart`
-- Changed `XAxisLabelLocation` property's type to **XAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart`
-- Added `XAxisLabelLocation` property to `CategoryChart`
-- Added support for representing geographic series of `GeographicMap` in a legend
-- Added crosshair lines by default in `FinancialChart` and `CategoryChart`
-- Added crosshair annotations by default in `FinancialChart` and `CategoryChart`
-- Added final value annotation by default in `FinancialChart`
+- Changed property's type to **YAxisLabelLocation** from **AxisLabelLocation** in and
+- Changed property's type to **XAxisLabelLocation** from **AxisLabelLocation** in
+- Added property to
+- Added support for representing geographic series of in a legend
+- Added crosshair lines by default in and
+- Added crosshair annotations by default in and
+- Added final value annotation by default in
- Added new properties in Category Chart and Financial Chart:
- - `CrosshairsLineThickness` and other properties for customizing crosshairs lines
- - `CrosshairsAnnotationXAxisBackground` and other properties for customizing crosshairs annotations
- - `FinalValueAnnotationsBackground` and other properties for customizing final value annotations
- - `AreaFillOpacity` that allow changing opacity of series fill (e.g. Area chart)
- - `MarkerThickness` that allows changing thickness of markers
+ - and other properties for customizing crosshairs lines
+ - and other properties for customizing crosshairs annotations
+ - and other properties for customizing final value annotations
+ - that allow changing opacity of series fill (e.g. Area chart)
+ - that allows changing thickness of markers
- Added new properties in Category Chart, Financial Chart, Data Chart, and Geographic Map:
- - `MarkerAutomaticBehavior` that allows which marker type is assigned to multiple series in the same chart
- - `LegendItemBadgeShape` for setting badge shape of all series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on all series in a legend
+ - that allows which marker type is assigned to multiple series in the same chart
+ - for setting badge shape of all series represented in a legend
+ - for setting badge complexity on all series in a legend
- Added new properties in Series in Data Chart and Geographic Map:
- - `LegendItemBadgeShape` for setting badge shape on specific series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on specific series in a legend
+ - for setting badge shape on specific series represented in a legend
+ - for setting badge complexity on specific series in a legend
- Changed default vertical crosshair line stroke from #000000 to #BBBBBB in category chart and series
-- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's `MarkerAutomaticBehavior` property to `SmartIndexed` enum value
-- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's `LegendItemBadgeMode` property to `MatchSeries` enum value
+- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's property to `SmartIndexed` enum value
+- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's property to `MatchSeries` enum value
- Changed color palette of series and markers displayed in all charts to improve accessibility
| Old brushes/outlines | New outline/brushes |
@@ -1237,30 +1239,30 @@ This release introduces a few improvements and simplifications to visual design
#### Charts & Maps
-This release introduces several new and improved visual design and configuration options for all of the chart components, e.g. `DataChart`, `CategoryChart`, and `FinancialChart`.
+This release introduces several new and improved visual design and configuration options for all of the chart components, e.g. , , and .
- Changed Bar/Column/Waterfall series to have square corners instead of rounded corners
- Changed Scatter High Density series’ colors for heat min property from #8a5bb1 to #000000
- Changed Scatter High Density series’ colors for heat max property from #ee5879 to #ee5879
- Changed Financial/Waterfall series’ `NegativeBrush` and `NegativeOutline` properties from #C62828 to #ee5879
- Changed marker's thickness to 2px from 1px
-- Changed marker's fill to match the marker's outline for `PointSeries`, `BubbleSeries`, `ScatterSeries`, `PolarScatterSeries`. You can use set `MarkerFillMode` property to Normal to undo this change
-- Compressed labelling for the `TimeXAxis` and `OrdinalTimeXAxis`
+- Changed marker's fill to match the marker's outline for , , , . You can use set property to Normal to undo this change
+- Compressed labelling for the and
- New Marker Properties:
- - series.`MarkerFillMode` - Can be set to `MatchMarkerOutline` so the marker depends on the outline
- - series.`MarkerFillOpacity` - Can be set to a value 0 to 1
- - series.`MarkerOutlineMode` - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
+ - series. - Can be set to `MatchMarkerOutline` so the marker depends on the outline
+ - series. - Can be set to a value 0 to 1
+ - series. - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
- New Series Property:
- - series.`OutlineMode` - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
-- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the `ComputedPlotAreaMarginMode`, listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
- - chart.`PlotAreaMarginLeft`
- - chart.`PlotAreaMarginTop`
- - chart.`PlotAreaMarginRight`
- - chart.`PlotAreaMarginBottom`
- - chart.`ComputedPlotAreaMarginMode`
+ - series. - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
+- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the , listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
+ - chart.
+ - chart.
+ - chart.
+ - chart.
+ - chart.
- New Highlighting Properties
- - chart.`HighlightingMode` - Sets whether hovered or non-hovered series to fade, brighten
- - chart.`HighlightingBehavior` - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
+ - chart. - Sets whether hovered or non-hovered series to fade, brighten
+ - chart. - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
- Note, in previous releases the highlighting was limited to fade on hover.
- Added Highlighting Stacked, Scatter, Polar, Radial, and Shape series:
- Added Annotation layers to Stacked, Scatter, Polar, Radial, and Shape series:
@@ -1283,8 +1285,8 @@ for example:
#### Chart Legend
-- Added horizontal `Orientation` property to ItemLegend that can be used with Bubble, Donut, and Pie Chart
-- Added `LegendHighlightingMode` property - Enables series highlighting when hovering over legend items
+- Added horizontal property to ItemLegend that can be used with Bubble, Donut, and Pie Chart
+- Added property - Enables series highlighting when hovering over legend items
#### Geographic Map
@@ -1300,9 +1302,9 @@ These features are CTP
### {PackageGrids} (Data Grid)
- Added `EditOnKeyPress` aka Excel-style Editing, instantly begin editing when typing.
-- Added `EditModeClickAction` property - By default double-clicking is required to enter edit mode. This can be set to `SingleClick` to allow for edit mode to occur when selecting a new cell.
-- Added `EnterKeyBehaviors` property - aka Excel-style Navigation (Enter Behavior) – controls the behavior of the enter key, e.g. Options are (none, edit, move up, down, left, right)
-- Added `EnterKeyBehaviorAfterEdit` property - While in edit-mode, this property controls when enter is pressed, e.g. Options are (moves to the cell below, above, right, left)
+- Added property - By default double-clicking is required to enter edit mode. This can be set to to allow for edit mode to occur when selecting a new cell.
+- Added property - aka Excel-style Navigation (Enter Behavior) – controls the behavior of the enter key, e.g. Options are (none, edit, move up, down, left, right)
+- Added property - While in edit-mode, this property controls when enter is pressed, e.g. Options are (moves to the cell below, above, right, left)
- Added `SelectAllRows` - method.
- Added Row Range Selection - With `GridSelectionMode` property set to MultipleRow the following new functionality is now included:
- Click and drag to select rows
@@ -1315,13 +1317,13 @@ These features are CTP
#### Date Picker
-- `ShowTodayButton` - Toggles Today button visibility
-- `Label` - Adds a label above the date value
-- `Placeholder` property - adds custom text when no value is selected
-- `FormatString` - Customize input date string e.g. (`yyyy-MM-dd`)
-- `DateFormat` - Specifies whether to display selected dates as LongDate or ShortDate
-- `FirstDayOfWeek` - Specifies first day of week
-- `FirstWeekOfYear` - Specifies when to display first week of the year, e.g. (First Full Week, First Four day Week)
-- `ShowWeekNumbers` - Toggles Week number visibility
-- `MinDate` & `MaxDate` - Date limits, specifying a range of available selectable dates.
+- - Toggles Today button visibility
+- - Adds a label above the date value
+- property - adds custom text when no value is selected
+- - Customize input date string e.g. (`yyyy-MM-dd`)
+- - Specifies whether to display selected dates as LongDate or ShortDate
+- - Specifies first day of week
+- - Specifies when to display first week of the year, e.g. (First Full Week, First Four day Week)
+- - Toggles Week number visibility
+- & - Date limits, specifying a range of available selectable dates.
- Added Accessibility
diff --git a/docs/xplat/src/content/jp/components/general-changelog-dv-react.mdx b/docs/xplat/src/content/jp/components/general-changelog-dv-react.mdx
index 6159bde3c5..9fcdfce1c7 100644
--- a/docs/xplat/src/content/jp/components/general-changelog-dv-react.mdx
+++ b/docs/xplat/src/content/jp/components/general-changelog-dv-react.mdx
@@ -18,6 +18,8 @@ import chartdefaults4 from '@xplat-images/chartDefaults4.png';
import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# {ProductName} 変更ログ
@@ -75,18 +77,18 @@ import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
### {PackageGrids} (グリッド)
-- `IgrGrid`、`IgrTreeGrid`、`IgrHierarchicalGrid`、`IgrPivotGrid`
+- 、、、
- グリッドに表示されるデータに基づいてスクロール スロットルを動的に調整することでパフォーマンスを改善しました。
**重大な変更**
-- `IgrGrid`、`IgrTreeGrid`、`IgrHierarchicalGrid`、`IgrPivotGrid`
+- 、、、
- 元の `data` 配列の変更 (元の配列へのレコードの追加/削除/移動など) は自動的に検出されなくなりました。変更を検出するには、コンポーネントに配列参照の変更が必要です。
**ローカライゼーション (i18n)**
-- `IgrGrid`、`IgrTreeGrid`、`IgrHierarchicalGrid`、`IgrPivotGrid`、`IgrCombo`、`IgrDatePicker`、`IgrDateRangePicker`、`IgrCalendar`、`IgrCarousel`、`IgrChip`、`IgrInput`、`IgrTree`
- - グリッド コンポーネントで日付や数値などのデータをフォーマットおよびレンダリングするための新しい `Intl` 実装。`IgrCalendar`、`IgrDatePicker`、`IgrDateRangePicker` の `Intl` 実装を更新しました。
+- 、、、、、、、、、、、
+ - グリッド コンポーネントで日付や数値などのデータをフォーマットおよびレンダリングするための新しい `Intl` 実装。、、 の `Intl` 実装を更新しました。
- 現在サポートされているすべての言語のリソース文字列を持つすべてのコンポーネントに対する新しいローカライゼーション実装。
- 新しいパブリック ローカライゼーション API と、新しいリソースを含む `igniteui-i18n-resources` という名前のパッケージ。
@@ -138,18 +140,18 @@ DataPieChart および ProportionalCategoryAngleAxis に OthersCategoryBrush と
### **{PackageVerChanges-25-2-DEC}**
-- `IgrGrid`, `IgrTreeGrid`, `IgrHierarchicalGrid`, `IgrPivotGrid`
+- , , ,
- Improved performance by dynamically adjusting the scroll throttle based on the data displayed in grid.
**Breaking Changes**
-- `IgrGrid`, `IgrTreeGrid`, `IgrHierarchicalGrid`, `IgrPivotGrid`
+- , , ,
- Original `data` array mutations (like adding/removing/moving records in the original array) are no longer detected automatically. Components need an array reference change for the change to be detected.
**Localization(i18n)**
-- `IgrGrid`, `IgrTreeGrid`, `IgrHierarchicalGrid`, `IgrPivotGrid`, `IgrCombo`, `IgrDatePicker`, `IgrDateRangePicker`, `IgrCalendar`, `IgrCarousel`, `IgrChip`, `IgrInput`, `IgrTree`
- - New `Intl` implementation for the grid components that format and render data like dates and numbers. Updated `Intl` implementation for `IgrCalendar`, `IgrDatePicker`, and `IgrDateRangePicker`.
+- , , , , , , , , , , ,
+ - New `Intl` implementation for the grid components that format and render data like dates and numbers. Updated `Intl` implementation for , , and .
- New localization implementation for the currently supported languages for all components that have resource strings in the currently supported languages.
- New public localization API and package named `igniteui-i18n-resources` containing the new resources that are used in conjunction.
@@ -185,7 +187,7 @@ DataPieChart および ProportionalCategoryAngleAxis に OthersCategoryBrush と
### ユーザー注釈
-{ProductName} では、ユーザー注釈機能により、実行時に `DataChart` にスライス注釈、ストリップ注釈、ポイント注釈を追加できるようになりました。これにより、エンドユーザーは、スライス注釈を使用して会社の四半期レポートなどの単一の重要イベントを強調したり、ストリップ注釈を使用して期間を持つイベントを示したりすることで、プロットに詳細を追加できます。ポイント注釈またはこれら 3 つの任意の組み合わせを使用して、プロットされたシリーズ上の個々のポイントを呼び出すこともできます。
+{ProductName} では、ユーザー注釈機能により、実行時に にスライス注釈、ストリップ注釈、ポイント注釈を追加できるようになりました。これにより、エンドユーザーは、スライス注釈を使用して会社の四半期レポートなどの単一の重要イベントを強調したり、ストリップ注釈を使用して期間を持つイベントを示したりすることで、プロットに詳細を追加できます。ポイント注釈またはこれら 3 つの任意の組み合わせを使用して、プロットされたシリーズ上の個々のポイントを呼び出すこともできます。
### 軸注釈の衝突検出
@@ -201,15 +203,15 @@ DataPieChart および ProportionalCategoryAngleAxis に OthersCategoryBrush と
#### 新しいコンポーネント
-- `IgrChat` コンポーネントを追加しました。
+- `Chat` コンポーネントを追加しました。
-This is directly integrated with the available tools of the `Toolbar`.
+This is directly integrated with the available tools of the .
#### {PackageGrids} (グリッド)
-- `IgrGrid`、`IgrTreeGrid`、`IgrHierarchicalGrid`
+- 、、
- 同じデータまたはその他のカスタム条件に基づいて列内のセルを 1 つのセルに構成および結合できる新しいセル結合機能を追加しました。
個々の列で有効化できます:
@@ -238,10 +240,10 @@ This is directly integrated with the available tools of the `Toolbar`.
### Azure マップ画像のサポート
-`IgrGeographicMap` は、 Azure ベースのマップ画像をサポートし、開発者は複数のアプリケーション タイプにわたって詳細かつ動的なマップを表示できるようになりました。複数のマップ レイヤーを組み合わせて地理データを視覚化し、インタラクティブなマッピング エクスペリエンスを簡単に作成できます。
+ は、 Azure ベースのマップ画像をサポートし、開発者は複数のアプリケーション タイプにわたって詳細かつ動的なマップを表示できるようになりました。複数のマップ レイヤーを組み合わせて地理データを視覚化し、インタラクティブなマッピング エクスペリエンスを簡単に作成できます。
### {PackageCharts} (チャート)
-- `IgrGrid`, `IgrTreeGrid`, `IgrHierarchicalGrid`
+- , ,
- Introduced a new cell merging feature that allows you to configure and merge cells in a column based on same data or other custom condition, into a single cell.
It can be enabled on the individual columns:
@@ -308,7 +310,7 @@ This is directly integrated with the available tools of the `Toolbar`.
### 新しい軸ラベル イベント
-軸ラベルに対するさまざまな操作を検出できるように、次のイベントが `IgrDataChart` に追加されました。
+軸ラベルに対するさまざまな操作を検出できるように、次のイベントが に追加されました。
## 対応軸
@@ -329,11 +331,11 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
| バグ番号 | コントロール | 説明 |
|------------|---------|-------------|
-|31624 | `IgrCategoryChart` | `IgrCategoryChart` を含むウィンドウをリサイズすると、チャートがシリーズをレンダリングできなくなる。|
-|27304 | `IgrDataChart` | ズーム長方形が背景長方形と同じ位置に配置されない。|
-|38231 | `IgrGrid` | 非ピン固定列は、非表示が存在する場合に元の位置に戻らない。|
-|30600 | `IgrDoughnutChart` | チャートやシリーズに textStyle プロパティが存在しない (円チャートにはある)。|
-|37930 | `IgrDataChart` | Data Annotation Overlay のテキスト色が機能しない。|
+|31624 | | を含むウィンドウをリサイズすると、チャートがシリーズをレンダリングできなくなる。|
+|27304 | | ズーム長方形が背景長方形と同じ位置に配置されない。|
+|38231 | | 非ピン固定列は、非表示が存在する場合に元の位置に戻らない。|
+|30600 | | チャートやシリーズに textStyle プロパティが存在しない (円チャートにはある)。|
+|37930 | | Data Annotation Overlay のテキスト色が機能しない。|
|33861 | Excel Library | 折れ線チャートを追加すると、ドイツ語カルチャで Excel ファイルが破損する。|
- `LabelMouseDown`
@@ -345,15 +347,15 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
#### 機能拡張
-Added `CompanionAxis` properties to the X and Y axis that allow you to quickly create a clone of an existing axis. When enabled using the `CompanionAxisEnabled` property, this will default the cloned axis to the opposite position of the chart and you can then configure that axes' properties.
+Added `CompanionAxis` properties to the X and Y axis that allow you to quickly create a clone of an existing axis. When enabled using the property, this will default the cloned axis to the opposite position of the chart and you can then configure that axes' properties.
#### IgrBulletGraph
-- 新しい `LabelsVisible` プロパティが追加されました。
+- 新しい プロパティが追加されました。
**Breaking Changes**
-- A fix was made due to an issue where the `PlotAreaPosition` and `ChartPosition` properties on `ChartMouseEventArgs` class were reversed. This will change the values that `PlotAreaPosition` and `ChartPosition` return.
+- A fix was made due to an issue where the and properties on class were reversed. This will change the values that and return.
### チャート
@@ -361,24 +363,24 @@ Added `CompanionAxis` properties to the X and Y axis that allow you to quickly c
- DataGrid に新しいプロパティ `stopPropagation` が追加されました。これにより、マウス イベントが親要素へバブリングするのを防止できます。
-- `SuffixText`
-- `SuffixTextColor`
+-
+-
- `SuffixTextFont`
-- `SuffixIconName`
-- `SuffixIconCollectionName`
-- `SuffixIconStroke`
-- `SuffixIconFill`
-- `SuffixIconViewBoxLeft`
-- `SuffixIconViewBoxTop`
-- `SuffixIconViewBoxWidth`
-- `SuffixIconViewBoxHeight`
-- `TextDecoration`
+-
+-
+-
+-
+-
+-
+-
+-
+-
Please note that the maximum size available for the icons is 24x24. You can provide an icon that is larger or smaller than this, but you will need to configure the viewbox settings in order to properly scale it to fit in the 24x24 space so it is fully visible.
### IgrLinearGauge
-- 新しい `LabelsVisible` プロパティが追加されました。
+- 新しい プロパティが追加されました。
### **{PackageVerChanges-25-1-SEP}**
@@ -402,11 +404,11 @@ Please note that the maximum size available for the icons is 24x24. You can prov
|[1809](https://github.com/IgniteUI/igniteui-webcomponents/pull/1809)|Switch|新しい thumb hover プロパティを使用するよう修正。|
|[1837](https://github.com/IgniteUI/igniteui-webcomponents/pull/1837)|TileManager|内部正規表現のエスケープ不備を修正。|
-- New properties added to the DataLegend to aid in styling: `ContentBackground`, `ContentBorderBrush`, and `ContentBorderThickness`. The `ContentBorderBrush` and `ContentBorderThickness` default to transparent and 0 respectively, so in order to see these borders, you will need to set these properties.
+- New properties added to the DataLegend to aid in styling: , , and . The and default to transparent and 0 respectively, so in order to see these borders, you will need to set these properties.
-- Added a new property to `ChartMouseEventArgs` called `WorldPosition` that provides the world relative position of the mouse. This position will be a value between 0 and 1 for both the X and Y axis within the axis space.
+- Added a new property to called that provides the world relative position of the mouse. This position will be a value between 0 and 1 for both the X and Y axis within the axis space.
-- Added `HighlightingFadeOpacity` to `SeriesViewer` and `DomainChart`. This allows you to configure the opacity applied to highlighted series.
+- Added to and . This allows you to configure the opacity applied to highlighted series.
- Expose `CalloutLabelUpdating` event for domain charts.
@@ -519,7 +521,7 @@ Please note that the maximum size available for the icons is 24x24. You can prov
### {PackageDashboards} (ダッシュボード)
-- `IgrDashboardTile` では、ソート、グループ化、フィルタリング、選択などの集計を DataGrid ビューからチャート視覚化に伝播できるようになりました。これは現在、`IgrDashboardTile` の `DataSource` を `IgrLocalDataSource` のインスタンスにバインドすることによってサポートされています。
+- では、ソート、グループ化、フィルタリング、選択などの集計を DataGrid ビューからチャート視覚化に伝播できるようになりました。これは現在、 の `DataSource` を のインスタンスにバインドすることによってサポートされています。
### {PackageGrids}
@@ -538,9 +540,9 @@ Please note that the maximum size available for the icons is 24x24. You can prov
- チャートは `GetOthersContext()` メソッドを公開するようになりました。これにより、Others (その他) スライスのコンテンツが返されます。
-- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose `LayoutMode` property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
+- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
-- The `DefaultInteraction` property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
+- The property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an `OverlayText` property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
@@ -550,10 +552,10 @@ Please note that the maximum size available for the icons is 24x24. You can prov
| バグ番号 | コントロール | 説明 |
|------------|---------|------------------|
-|25997 | `IgrDataGrid` | 集計はグループ化された最初の子行にのみ表示される。|
-|37023 | `IgrDataChart` | overflow: hidden が設定されている場合にツールチップが切り取られたり画面外に表示されたりする。
+|25997 | `DataGrid` | 集計はグループ化された最初の子行にのみ表示される。|
+|37023 | | overflow: hidden が設定されている場合にツールチップが切り取られたり画面外に表示されたりする。
|37244 | Excel Library | カスタム データ検証が機能しない。.
-|37685 | `IgrSpreadsheet` | Arial フォントで書式設定された数値が正しく描画されない。
+|37685 | `Spreadsheet` | Arial フォントで書式設定された数値が正しく描画されない。
### **{PackageVerChanges-24-2-APR2}**
@@ -590,10 +592,10 @@ With 19.0.0 the React product introduces many breaking changes done to improve a
### 機能拡張
#### List
-- `ListItem` に新しいプロパティ `Selected` を追加しました。
+- に新しいプロパティ を追加しました。
#### Accordion
-- 新しいイベント `Open` および `Close` を追加しました。
+- 新しいイベント および `Close` を追加しました。
igr-tab-panel component is removed. The igr-tab now encompasses both the tab header and the tab content in a single component.
@@ -601,12 +603,12 @@ igr-tab-panel component is removed. The igr-tab now encompasses both the tab hea
### 非推奨
-- `Button` の `clicked` イベントは非推奨となりました。代わりにネイティブの `onClick` ハンドラーを使用してください。
+- の `clicked` イベントは非推奨となりました。代わりにネイティブの `onClick` ハンドラーを使用してください。
### バグ修正
#### **{PackageVerChanges-24-2-MAR1}**
-- Added new property on `ListItem` called `Selected`
+- Added new property on called
#### {PackageGrids}
次の表は、このリリースの {ProductName} ツールセットに対して行われたバグ修正を示しています。
@@ -614,7 +616,7 @@ igr-tab-panel component is removed. The igr-tab now encompasses both the tab hea
### **{PackageVerChanges-24-2-MAR}**
- **All Grids**
- - Allow applying initial filtering through `FilteringExpressionsTree` property
+ - Allow applying initial filtering through property
### {PackageGrids}
@@ -625,14 +627,14 @@ igr-tab-panel component is removed. The igr-tab now encompasses both the tab hea
### {PackageCommon}
- `Dockmanager` に、分割内で直接ドッキングできる新しい `allowSplitterDock` プロパティが追加されました。
-- `Dockmanager` の `SplitPane` に新しい `useFixedSize` プロパティが追加され、新しいサイズ変更動作が可能になりました。
+- `Dockmanager` の に新しい `useFixedSize` プロパティが追加され、新しいサイズ変更動作が可能になりました。
## 機能拡張
### Toolbar
-- `Toolbar` と `ToolPanel` に新しい `groupHeaderTextStyle` プロパティを追加しました。設定されている場合、すべての `ToolActionGroupHeader` アクションに適用されます。
-- タイトル テキストの水平方向の配置を制御する `TitleHorizontalAlignment` という新しいプロパティを `ToolAction` に追加しました。
-- `ToolActionSubPanel` に、パネル内の項目間の間隔を制御する `itemSpacing` という新しいプロパティを追加しました。
+- と に新しい `groupHeaderTextStyle` プロパティを追加しました。設定されている場合、すべての アクションに適用されます。
+- タイトル テキストの水平方向の配置を制御する という新しいプロパティを に追加しました。
+- に、パネル内の項目間の間隔を制御する `itemSpacing` という新しいプロパティを追加しました。
| Bug Number | Control | Description |
|------------|---------|------------------|
@@ -660,16 +662,16 @@ DashboardTile
| Bug Number | Control | Description |
|------------|---------|------------------|
-|30286 | `IgrDataChart` | Bubble Series tooltip content is switched to that of nearby bubble data in clicking a bubble|
-|32906 | `IgrDataChart` | `IgrDataChart` is showing two xAxis on the top|
-|33605 | `IgrDataChart` | ScatterLineSeries is not showing the color of the line correctly in the legend|
-|34776 | `IgrDataChart` | Repeatedly showing and hiding the `IgrDataChart` causes memory leakage in JS Heap|
-|35498 | `IgrDataChart` | Tooltips for the series specified in IncludedSeries are not displayed|
-|34324 | `IgrGrid` | Column hiding through condition in the grid template is not working|
-|34678 | `IgrGrid` | Enum values coerced to strings, breaking expected numeric behavior in some grid properties|
-|32093 | `IgrPivotGrid` | PivotDateDimensionOptions are not applied to the PivotDateDimension|
-|34053 | `IgrRadialGauge` | The position of the scale label is shifted|
-|35496 | `IgrSpreadsheet` | Error when setting styles in Excel with images|
+|30286 | | Bubble Series tooltip content is switched to that of nearby bubble data in clicking a bubble|
+|32906 | | is showing two xAxis on the top|
+|33605 | | ScatterLineSeries is not showing the color of the line correctly in the legend|
+|34776 | | Repeatedly showing and hiding the causes memory leakage in JS Heap|
+|35498 | | Tooltips for the series specified in IncludedSeries are not displayed|
+|34324 | | Column hiding through condition in the grid template is not working|
+|34678 | | Enum values coerced to strings, breaking expected numeric behavior in some grid properties|
+|32093 | | PivotDateDimensionOptions are not applied to the PivotDateDimension|
+|34053 | | The position of the scale label is shifted|
+|35496 | `Spreadsheet` | Error when setting styles in Excel with images|
|36176 | Excel Library | Exception occurs when loading an Excel workbook that has a LET function|
|36379 | Excel Library | Colors with any alpha channel in an excel workbook fail to load|
|26218 | Excel Library | Chart's plot area right margin becomes narrower and fill pattern and fill foreground are gone just by loading an Excel file|
@@ -683,39 +685,39 @@ DashboardTile
### 一般
- 新しい [Carousel](layouts/carousel.md) コンポーネント。
-- `Input`
- - `change` イベント引数タイプを `ComponentDataValueChangedEventArgs` から `ComponentValueChangedEventArgs` に変更しました。
+-
+ - `change` イベント引数タイプを から に変更しました。
## **{PackageVerChanges-24-1-SEP}**
### {PackageCharts} (チャート)
-- 新しい[データ円チャート](charts/types/data-pie-chart.md) - `DataPieChart` は円ャートを表示する新しいコンポーネントです。このコンポーネントは、`CategoryChart` と同様に動作し、基になるデータ モデルのプロパティを自動的に検出しながら、ItemLegend コンポーネントを介して選択、強調表示、アニメーション、凡例のサポートを可能にします。
+- 新しい[データ円チャート](charts/types/data-pie-chart.md) - は円ャートを表示する新しいコンポーネントです。このコンポーネントは、 と同様に動作し、基になるデータ モデルのプロパティを自動的に検出しながら、ItemLegend コンポーネントを介して選択、強調表示、アニメーション、凡例のサポートを可能にします。
-- 新しい [比例カテゴリ角度軸](charts/types/radial-chart.md) - スライスをプロットするための、`DataChart` のラジアル円シリーズの新しい軸。円チャートに似ており、データ ポイントが円グラフ内のセグメントとして表されます。
+- 新しい [比例カテゴリ角度軸](charts/types/radial-chart.md) - スライスをプロットするための、 のラジアル円シリーズの新しい軸。円チャートに似ており、データ ポイントが円グラフ内のセグメントとして表されます。
### {PackageCommon}
- 新しい [Banner](notifications/banner.md) コンポーネント。
- 新しい [DatePicker](scheduling/date-picker.md) コンポーネント。
-- 新しい `Divider` コンポーネント。
+- 新しい コンポーネント。
- すべてのコンポーネントにネイティブ イベントのサポートが追加されました。
-- `Icon`
+-
- `setIconRef` メソッドが追加されました。これにより、アイコンを SVG ファイルで登録および置き換えることができます。
- すべてのコンポーネントが内部的な参照によるアイコンを使用するようになり、カスタム テンプレートを明示的に提供しなくても簡単に置き換えられるようになりました。
-- `Combo`、`DatePicker`、`Dialog`、`Dropdown`、`ExpansionPanel`、`NavDrawer`、`Toast`、`Snackbar`、**IgrSelectComponent**
+- 、、、、、、、、**IgrSelectComponent**
- トグル メソッドの `show`、`hide`、`toggle` メソッドは、成功した場合に **true** を返すようになりました。そうでない場合は **false**。
-- **IgrButtonComponent**、`IconButton`、`Checkbox`、`Switch`、`Combo`、`DateTimeInput`、`Input`、`MaskInput`、`Radio`、**IgrSelectComponent**、`Textarea`
+- **IgrButtonComponent**、、、、、、、、、**IgrSelectComponent**、
- カスタムの `focus` および `blur` イベントは非推奨になりました。代わりにネイティブの `onFocus` および `onBlur` イベントを使用してください。
-- `RadioGroup`
- - `Name` および `Value` プロパティを追加しました。
+-
+ - および プロパティを追加しました。
## {PackageGrids}
### **{PackageVerChanges-24-1-JUN}**
- New [Carousel](layouts/carousel.md) component.
-- `Input`
- - Changed `change` event argument type from `ComponentDataValueChangedEventArgs` to `ComponentValueChangedEventArgs`
+-
+ - Changed `change` event argument type from to
## {PackageCommon}
@@ -723,9 +725,9 @@ DashboardTile
- `DisplayDensity` は非推奨となり、代わりに `--ig-size` CSS カスタム プロパティが使用されるようになりました。詳細については、[グリッド サイズ](grids/grid/size.md) トピックを参照してください。
-- `PivotGrid` - コンポーネントの構成が正しく適用できるようになりました。
+- - コンポーネントの構成が正しく適用できるようになりました。
-- `Toolbar`
+-
- New ToolActionCheckboxList
A new CheckboxList ToolAction that displays a collection of items with checkboxes for selecting. A grid inside ToolAction CheckboxList grows in height up to 5 items, then a scrollbar is displayed.
@@ -740,87 +742,87 @@ DashboardTile
### {PackageCharts} (チャート)
-- [データ凡例のグループ化](charts/features/chart-data-legend.md#{PlatformLower}-データ凡例のグループ化) と [データ ツールチップのグループ化](charts/features/chart-data-tooltip.md#{PlatformLower}-データ-チャートのデータ-ツールチップのグループ化) - 新しいグループ化機能が追加されました。`GroupRowVisible` プロパティは、各シリーズのグループ化を切り替え、オプトインすると `DataLegendGroup` プロパティを介してグループ テキストを割り当てることができます 同じ値が複数のシリーズに適用されている場合、それらはグループ化されて表示されます。すべてのユーザー向けに分類および整理する必要がある大規模なデータセットに役立ちます。
+- [データ凡例のグループ化](charts/features/chart-data-legend.md#{PlatformLower}-データ凡例のグループ化) と [データ ツールチップのグループ化](charts/features/chart-data-tooltip.md#{PlatformLower}-データ-チャートのデータ-ツールチップのグループ化) - 新しいグループ化機能が追加されました。 プロパティは、各シリーズのグループ化を切り替え、オプトインすると プロパティを介してグループ テキストを割り当てることができます 同じ値が複数のシリーズに適用されている場合、それらはグループ化されて表示されます。すべてのユーザー向けに分類および整理する必要がある大規模なデータセットに役立ちます。
-- [チャートの選択](charts/features/chart-data-selection.md) - 新しいシリーズ選択のスタイル設定。これは、`CategoryChart` および `DataChart` のすべてのカテゴリ、財務、およびラジアル シリーズに広く採用されています。シリーズはクリックして異なる色で表示したり、明るくしたり、薄くしたり、フォーカスのアウトラインを表示したりできます。個々のシリーズまたはデータ項目全体を通じて影響を受ける項目を管理します。
-複数のシリーズとマーカーがサポートされています。特定のデータ項目の値間のさまざまな相違点や類似点を示すのに役立ちます。また、`SelectedSeriesItemsChanged` イベントと `SelectedSeriesItems` は、選択内容に基づいたデータ分析を行うポップアップやその他の画面など、アプリケーション内で実行できるその他のアクションを取り巻く堅牢なビジネス要件を構築するための追加の支援として利用できます。
+- [チャートの選択](charts/features/chart-data-selection.md) - 新しいシリーズ選択のスタイル設定。これは、 および のすべてのカテゴリ、財務、およびラジアル シリーズに広く採用されています。シリーズはクリックして異なる色で表示したり、明るくしたり、薄くしたり、フォーカスのアウトラインを表示したりできます。個々のシリーズまたはデータ項目全体を通じて影響を受ける項目を管理します。
+複数のシリーズとマーカーがサポートされています。特定のデータ項目の値間のさまざまな相違点や類似点を示すのに役立ちます。また、`SelectedSeriesItemsChanged` イベントと は、選択内容に基づいたデータ分析を行うポップアップやその他の画面など、アプリケーション内で実行できるその他のアクションを取り巻く堅牢なビジネス要件を構築するための追加の支援として利用できます。
-- [比例カテゴリ角度軸](charts/types/radial-chart.md) - `DataChart` のラジアル円シリーズの新しい軸により、データ チャートのすべての追加機能を使用してロバスト可能な視覚化をする円チャートの作成が可能になります。
+- [比例カテゴリ角度軸](charts/types/radial-chart.md) - のラジアル円シリーズの新しい軸により、データ チャートのすべての追加機能を使用してロバスト可能な視覚化をする円チャートの作成が可能になります。
### {PackageGauges} (ゲージ)
-- `RadialGauge`
- - ハイライト針の新しいラベル。`HighlightLabelText` と `HighlightLabelSnapsToNeedlePivot` および、その他の HighlightLabel の多くのスタイル関連プロパティが追加されました。
+-
+ - ハイライト針の新しいラベル。 と および、その他の HighlightLabel の多くのスタイル関連プロパティが追加されました。
**Breaking Changes**
- **All Grids**
- - `RowIsland`
+ -
- Removed `displayDensity` deprecated property.
- Renamed `actualColumns`, `contentColumns` properties to `actualColumnList` and `contentColumnList`. Use `columns` or `columnList` property to get all columns now.
- - Renamed `rowDelete` and `rowAdd` event argument type to `RowDataCancelableEventArgs`.
- - Renamed `contextMenu` event argument type to `GridContextMenuEventArgs`.
- - Removed `GridEditEventArgs`, `GridEditDoneEventArgs`, `PinRowEventArgs` events `rowID` and `primaryKey` properties. Use `rowKey` instead.
-- `PivotGrid`
+ - Renamed `rowDelete` and `rowAdd` event argument type to .
+ - Renamed `contextMenu` event argument type to .
+ - Removed , , events `rowID` and `primaryKey` properties. Use `rowKey` instead.
+-
- removed `showPivotConfigurationUI` property. Use `pivotUI` and set inside it the new `showConfiguration` option.
-- `Column`
+-
- Removed `movable` property. Use Grid's `moving` property now.
- Removed `columnChildren` property. Use `childColumns` instead.
-- `ColumnGroup`
+-
- Removed `children` property. Use `childColumns` instead.
-- `Paginator`
+-
- Removed `isFirstPageDisabled` and `isLastPageDisabled` properties. Use `isFirstPage` and `isLastPage` instead.
## **{PackageVerChanges-23-2-MAR}**
### {PackageCharts}
-- `InitialFilter` プロパティによる新しいデータ フィルタリング。フィルター式を適用して、チャート データをレコードのサブセットにフィルターします。大規模なデータのドリルダウンに使用できます。
+- プロパティによる新しいデータ フィルタリング。フィルター式を適用して、チャート データをレコードのサブセットにフィルターします。大規模なデータのドリルダウンに使用できます。
### {PackageGrids}
-- 新しい [`HierarchicalGrid`](grids/hierarchical-grid/overview.md) コンポーネント
+- 新しい [](grids/hierarchical-grid/overview.md) コンポーネント
-- `PivotGrid` - Configuration of the component can now be applied correctly.
+- - Configuration of the component can now be applied correctly.
### {PackageGauges}
-- `RadialGauge`
- - 新しいタイトル/サブタイトルのプロパティ。`TitleText`、`SubtitleText` はゲージの下部近くに表示されます。さらに、`TitleFontSize`、`TitleFontFamily`、`TitleFontStyle`、`TitleFontWeight`、`TitleExtent` など、さまざまなタイトルとサブタイトルのフォント プロパティが追加されました。最後に、新しい `TitleDisplaysValue` により、値を針の位置に対応させることができます。
- - `RadialGauge` の新しい `OpticalScalingEnabled` プロパティと `OpticalScalingSize` プロパティ。この新機能は、ゲージのラベル、タイトル、サブタイトルが 100% のオプティカル スケーリングを持つサイズを管理します。この新機能の詳細については、[こちら](radial-gauge.md#オプティカル-スケーリング)を参照してください。
- - 新しいハイライト針が追加されました。`HighlightValue` と `HighlightValueDisplayMode` の両方に値と 'Overlay' 設定が指定されたとき、メインの針が薄く表示され、新しい針が表示されます。
-- `LinearGauge`
- - 新しいハイライト針が追加されました。`HighlightValue` と `HighlightValueDisplayMode` の両方に値と 'Overlay' 設定が指定されたとき、メインの針が薄く表示され、新しい針が表示されます。
-- `BulletGraph`
- - `HighlightValueDisplayMode` が 'Overlay' 設定に適用されたとき、パフォーマンス バーには値と新しい `HighlightValue` の差が反映されるようになりました。ハイライト値には、フィルタリング/サブセットが完了した測定パーセンテージが塗りつぶされた色で表示され、残りのバーの外観は割り当てられた値に対して薄く表示され、リアルタイムでパフォーマンスを示します。
+-
+ - 新しいタイトル/サブタイトルのプロパティ。、 はゲージの下部近くに表示されます。さらに、`TitleFontSize`、`TitleFontFamily`、`TitleFontStyle`、`TitleFontWeight`、 など、さまざまなタイトルとサブタイトルのフォント プロパティが追加されました。最後に、新しい により、値を針の位置に対応させることができます。
+ - の新しい プロパティと プロパティ。この新機能は、ゲージのラベル、タイトル、サブタイトルが 100% のオプティカル スケーリングを持つサイズを管理します。この新機能の詳細については、[こちら](radial-gauge.md#オプティカル-スケーリング)を参照してください。
+ - 新しいハイライト針が追加されました。 と の両方に値と 'Overlay' 設定が指定されたとき、メインの針が薄く表示され、新しい針が表示されます。
+-
+ - 新しいハイライト針が追加されました。 と の両方に値と 'Overlay' 設定が指定されたとき、メインの針が薄く表示され、新しい針が表示されます。
+-
+ - が 'Overlay' 設定に適用されたとき、パフォーマンス バーには値と新しい の差が反映されるようになりました。ハイライト値には、フィルタリング/サブセットが完了した測定パーセンテージが塗りつぶされた色で表示され、残りのバーの外観は割り当てられた値に対して薄く表示され、リアルタイムでパフォーマンスを示します。
-- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for `CategoryChart` and `DataChart`. Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and `SelectedSeriesItems` are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
+- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for and . Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
-- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `DataChart`, to enable creating pie charts in the allowing robust visualizations using all the added power of the data chart.
+- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the , to enable creating pie charts in the allowing robust visualizations using all the added power of the data chart.
-- [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a `HighlightingMode` property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the `HighlightingTransitionDuration` property.
+- [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the property.
-- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new `HighlightedItemsSource`. Can be toggled via `HighlightedValuesDisplayMode` and styled via `FillBrushes`.
+- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new . Can be toggled via and styled via `FillBrushes`.
-- `Toolbar` - New `IsHighlighted` option for ToolAction for outlining a border around specific tools of choice.
+- - New option for ToolAction for outlining a border around specific tools of choice.
### {PackageCommon}
-- 新しい `Textarea` コンポーネント
-- 新しい `ButtonGroup` コンポーネント
-- `DockManager`
- - 新しい `ProximityDock` プロパティ。有効にすると、ドッキング インジケーターは表示されなくなり、エンド ユーザーは、ドラッグしたペインをターゲット ペインの端に近づけてドラッグすることでドッキングできます
- - 新しい `ContainedInBoundaries` プロパティ。フローティング ペインを Dock Manager の境界内に保持するかどうかを決定します。デフォルトは **false** です。
- - 新しい `ShowPaneHeaders` プロパティ。ペインのヘッダーをホバー時にのみ表示するか、常に表示するかを決定します。デフォルトは `always` です。
-- `Input`、`MaskInput`、`DateTimeInput`、`Rating`
- - `Readonly` は `ReadOnly` に名前が変更されました。
-- `Input`
- - `Maxlength` は `MaxLength` に名前が変更されました。
- - `Minlength` は `MinLength` に名前が変更されました。
-- `Tree`
+- 新しい コンポーネント
+- 新しい コンポーネント
+-
+ - 新しい プロパティ。有効にすると、ドッキング インジケーターは表示されなくなり、エンド ユーザーは、ドラッグしたペインをターゲット ペインの端に近づけてドラッグすることでドッキングできます
+ - 新しい プロパティ。フローティング ペインを Dock Manager の境界内に保持するかどうかを決定します。デフォルトは **false** です。
+ - 新しい プロパティ。ペインのヘッダーをホバー時にのみ表示するか、常に表示するかを決定します。デフォルトは `always` です。
+- 、、、
+ - `Readonly` は に名前が変更されました。
+-
+ - `Maxlength` は に名前が変更されました。
+ - `Minlength` は に名前が変更されました。
+-
- ノードをクリックすると展開状態が変更されるかどうかを決定する `toggleNodeOnClick` プロパティが追加されました。デフォルトは **false** です。
-- `Rating`
+-
- `allowReset` が追加されました。有効にすると、同じ値を選択するとコンポーネントがリセットされます。**動作の変更** - 以前のリリースでは、これが Rating コンポーネントのデフォルトの動作でした。アプリケーションでこの動作を維持する必要がある場合は、必ず `allowReset` を設定してください。
-- `Select`、`Dropdown`
+- 、
- `selectedItem`、`items`、および `groups` ゲッターが公開されました。
## 非推奨
@@ -828,41 +830,41 @@ DashboardTile
### 削除済
- デフォルトの属性を隠していた独自の `dir` 属性が削除されました。これは互換性のある変更です。
-- `Slider` - `ariaLabel` シャドウ プロパティ。これは互換性のある変更です。
-- `Checkbox` - `ariaLabelledBy` シャドウ属性。これは互換性のある変更です。
-- `Switch` - `ariaLabelledBy` シャドウ属性。これは互換性のある変更です。
-- `Radio` - `ariaLabelledBy` シャドウ属性。これは互換性のある変更です。
+- - `ariaLabel` シャドウ プロパティ。これは互換性のある変更です。
+- - `ariaLabelledBy` シャドウ属性。これは互換性のある変更です。
+- - `ariaLabelledBy` シャドウ属性。これは互換性のある変更です。
+- - `ariaLabelledBy` シャドウ属性。これは互換性のある変更です。
- `RadialChart`
- New Label Mode
- The `CategoryAngleAxis` for the now exposes a `LabelMode` property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
+ The for the now exposes a property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
### **{PackageVerChanges-23-2-JAN}**
-- New [`HierarchicalGrid`](grids/hierarchical-grid/overview.md) component
+- New [](grids/hierarchical-grid/overview.md) component
### {PackageCharts} (チャート)
-- [チャートのハイライト表示フィルター](charts/features/chart-highlight-filter.md) - `CategoryChart` と `DataChart` は、データのサブセットの内外でハイライト表示およびアニメーション化する方法を公開するようになりました。このハイライト表示の表示はシリーズのタイプによって異なります。列およびエリア シリーズの場合、サブセットはデータの合計セットの上に表示され、サブセットはシリーズの実際のブラシによって色付けされ、合計セットは不透明度を下げます。折れ線シリーズの場合、サブセットは点線で表示されます。
+- [チャートのハイライト表示フィルター](charts/features/chart-highlight-filter.md) - と は、データのサブセットの内外でハイライト表示およびアニメーション化する方法を公開するようになりました。このハイライト表示の表示はシリーズのタイプによって異なります。列およびエリア シリーズの場合、サブセットはデータの合計セットの上に表示され、サブセットはシリーズの実際のブラシによって色付けされ、合計セットは不透明度を下げます。折れ線シリーズの場合、サブセットは点線で表示されます。
### **{PackageVerChanges-23-2-DEC}**
-- New `Textarea` component
-- New `ButtonGroup` component
-- `DockManager`
- - New `ProximityDock` property. If enabled, docking indicators are not visible and the end user can dock the dragged pane by dragging it close to the target pane edges.
- - New `ContainedInBoundaries` property. Determines whether the floating panes are kept inside the Dock Manager boundaries. Defaults to `false`.
- - New `ShowPaneHeaders` property. Determines whether pane headers are only shown on hover or always visible. Defaults to `always`.
-- `Input`, `MaskInput`, `DateTimeInput`, `Rating`
- - `Readonly` has been renamed to `ReadOnly`
-- `Input`
- - `Maxlength` has been renamed to `MaxLength`
- - `Minlength` has been renamed to `MinLength`
-- `Tree`
+- New component
+- New component
+-
+ - New property. If enabled, docking indicators are not visible and the end user can dock the dragged pane by dragging it close to the target pane edges.
+ - New property. Determines whether the floating panes are kept inside the Dock Manager boundaries. Defaults to `false`.
+ - New property. Determines whether pane headers are only shown on hover or always visible. Defaults to `always`.
+- , , ,
+ - `Readonly` has been renamed to
+-
+ - `Maxlength` has been renamed to
+ - `Minlength` has been renamed to
+-
- Added `toggleNodeOnClick` property that determines whether clicking over a node will change its expanded state or not. Defaults to `false`.
-- `Rating`
+-
- `allowReset` added. When enabled selecting the same value will reset the component. **Behavioral change** - In previous releases this was the default behavior of the rating component. Make sure to set `allowReset` if you need to keep this behavior in your application.
-- `Select`, `Dropdown`
+- ,
- exposed `selectedItem`, `items` and `groups` getters
@@ -874,10 +876,10 @@ DashboardTile
#### **{PackageVerChanges-23-2}**
- Removed our own `dir` attribute which shadowed the default one. This is a non-breaking change.
-- `Slider` - `ariaLabel` shadowed property. This is a non-breaking change.
-- `Checkbox` - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
-- `Switch` - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
-- `Radio` - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
+- - `ariaLabel` shadowed property. This is a non-breaking change.
+- - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
+- - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
+- - `ariaLabelledBy` shadowed attribute. This is a non-breaking change.
## {PackageGrids} - Toolbar -
@@ -889,7 +891,7 @@ DashboardTile
### 新しいコンポーネント
-- [Toolbar](menus/toolbar.md) コンポーネントは、主にチャート コンポーネントで使用される UI 操作のコンパニオン コンテナーです。ツールバーは、`DataChart` または `CategoryChart` コンポーネントにリンクされると、プロパティとツール項目のプリセットで動的に更新されます。プロジェクト用のカスタム ツールを作成して、エンド ユーザーが変更を提供できるようになり、無限のカスタマイズが可能になります。
+- [Toolbar](menus/toolbar.md) コンポーネントは、主にチャート コンポーネントで使用される UI 操作のコンパニオン コンテナーです。ツールバーは、 または コンポーネントにリンクされると、プロパティとツール項目のプリセットで動的に更新されます。プロジェクト用のカスタム ツールを作成して、エンド ユーザーが変更を提供できるようになり、無限のカスタマイズが可能になります。
## {PackageCharts} (チャート)
@@ -900,7 +902,7 @@ DashboardTile
- ブラウザー / 画面サイズに基づいた水平ラベル回転のレスポンシブ レイアウト。
- すべてのプラットフォームでの丸型ラベルの描画が強化されました。
- StackedFragmentSeries にマーカー プロパティを追加しました。
-- `ShouldPanOnMaximumZoom` プロパティを追加しました。
+- プロパティを追加しました。
- 新しいカテゴリ軸プロパティ:
- ZoomMaximumCategoryRange
- ZoomMaximumItemSpan
@@ -922,35 +924,35 @@ DashboardTile
### {PackageGrids} (データ グリッド)
-- **{IgPrefix}Column** を `DataGridColumn` に変更しました。
-- **GridCellEventArgs** を `DataGridCellEventArgs` に変更しました。
-- **GridSelectionMode** を `DataGridSelectionMode` に変更しました。
-- **SummaryOperand** を `DataSourceSummaryOperand` に変更しました。
+- **{IgPrefix}Column** を に変更しました。
+- **GridCellEventArgs** を に変更しました。
+- **GridSelectionMode** を に変更しました。
+- **SummaryOperand** を に変更しました。
## **{PackageVerChanges-22-1}**
### {PackageCharts} (チャート)
-- 高度に構成可能な [DataLegend](charts/features/chart-data-legend.md) コンポーネントが追加されました。これは、`Legend` とよく似たコンポーネントですが、シリーズの値を表示し、シリーズの行と値の列をフィルタリングし、値のスタイルとフォーマットを行うための多くの構成プロパティを提供します。
+- 高度に構成可能な [DataLegend](charts/features/chart-data-legend.md) コンポーネントが追加されました。これは、 とよく似たコンポーネントですが、シリーズの値を表示し、シリーズの行と値の列をフィルタリングし、値のスタイルとフォーマットを行うための多くの構成プロパティを提供します。
- 高度に構成可能な [DataToolTip](charts/features/chart-data-tooltip.md) が追加されました。これは、シリーズの値とタイトル、およびシリーズの凡例バッジをツールチップに表示します。これは、すべてのチャート タイプのデフォルトのツールチップになりました。
-- 積層シリーズのアニメーションとトランジションインのサポートが追加されました。`IsTransitionInEnabled` プロパティを true に設定すると、アニメーションを有効にできます。そこから、`TransitionInDuration` プロパティを設定してアニメーションが完了するまでの時間を決定し、`TransitionInMode` でアニメーションのタイプを決定できます。
-- 追加された `AssigningCategoryStyle` イベントは、`DataChart` のすべてのシリーズで利用できるようになりました。このイベントは、背景色の `Fill` やハイライト表示など、シリーズ項目の外観を条件付きで構成する場合に処理されます。
-- CalloutLayer の新しい `AllowedPositions` 列挙体。チャート内のどこにコールアウトを配置するかを制限するために使用されます。デフォルトでは、コールアウトは最適な場所に配置されますが、これは `TopLeft`、`TopRight`、`BottomLeft`、または `BottomRight` を強制するために使用されます。
+- 積層シリーズのアニメーションとトランジションインのサポートが追加されました。 プロパティを true に設定すると、アニメーションを有効にできます。そこから、 プロパティを設定してアニメーションが完了するまでの時間を決定し、 でアニメーションのタイプを決定できます。
+- 追加された `AssigningCategoryStyle` イベントは、 のすべてのシリーズで利用できるようになりました。このイベントは、背景色の やハイライト表示など、シリーズ項目の外観を条件付きで構成する場合に処理されます。
+- CalloutLayer の新しい 列挙体。チャート内のどこにコールアウトを配置するかを制限するために使用されます。デフォルトでは、コールアウトは最適な場所に配置されますが、これは `TopLeft`、`TopRight`、`BottomLeft`、または `BottomRight` を強制するために使用されます。
- 注釈レイヤーに追加された新しいコーナー半径プロパティ。各コールアウトのコーナーを丸めるために使用されます。コーナー半径がデフォルトで追加されていることに注意してください。
- - CalloutLayer の `CalloutCornerRadius`
- - FinalValueLayer の `AxisAnnotationBackgroundCornerRadius`
- - CrosshairLayer の `XAxisAnnotationBackgroundCornerRadius` と `YAxisAnnotationBackgroundCornerRadius`
-- さまざまな方法でスクロールバーを有効にするための新しい `HorizontalViewScrollbarMode` および `VerticalViewScrollbarMode` 列挙体。`IsVerticalZoomEnabled` または `IsHorizontalZoomEnabled` と組み合わせると、チャートをナビゲートするための軸に沿ったスクロールバーを、常設またはフェードインおよびフェードアウトすることができます。
-- 新しい `FavorLabellingScaleEnd` は、軸がスケールの最後にラベルを表示することを優先するかどうかを決定します。数値軸 (`NumericXAxis`、`NumericYAxis`、`PercentChangeAxis` など) とのみ互換性があります。
-- 新しい `IsSplineShapePartOfRange` は、軸に要求された軸範囲にスプライン形状を含めるかどうかを決定します。
-- 新しい `XAxisMaximumGap` は、`XAxisGap` を使用するときにプロットされたシリーズの最大許容値を決定します。ギャップは、プロットされたシリーズの列またはバー間のスペースの量を決定します。
-- 新しい `XAxisMinimumGapSize` は、`XAxisGap` を使用するときに、プロットされたシリーズの最小許容ピクセルベース値を決定し、各カテゴリ間に常にある程度の間隔があることを保証します。
+ - CalloutLayer の
+ - FinalValueLayer の
+ - CrosshairLayer の と
+- さまざまな方法でスクロールバーを有効にするための新しい および 列挙体。 または と組み合わせると、チャートをナビゲートするための軸に沿ったスクロールバーを、常設またはフェードインおよびフェードアウトすることができます。
+- 新しい は、軸がスケールの最後にラベルを表示することを優先するかどうかを決定します。数値軸 (、、`PercentChangeAxis` など) とのみ互換性があります。
+- 新しい は、軸に要求された軸範囲にスプライン形状を含めるかどうかを決定します。
+- 新しい は、 を使用するときにプロットされたシリーズの最大許容値を決定します。ギャップは、プロットされたシリーズの列またはバー間のスペースの量を決定します。
+- 新しい は、 を使用するときに、プロットされたシリーズの最小許容ピクセルベース値を決定し、各カテゴリ間に常にある程度の間隔があることを保証します。
### {PackageGrids} (データ グリッド)
新機能 - [行ページング](grids/data-grid/row-paging.md)を追加しました。これは、大量のデータセットを類似したコンテンツを持つ一連のページに分割するために使用されます。ページネーションを使用すると、データを設定された行数で表示することができ、ユーザーはスクロール バーを使用せずにデータを順次閲覧することができます。テーブル ページネーションの UI には通常、現在のページ、合計ページ、ユーザーがページをめくるためのクリック可能な [前へ] と [次へ] の矢印 / ボタンなどが含まれます。
-- It is now possible to apply a **dash array** to the different parts of the series of the `DataChart`. You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
+- It is now possible to apply a **dash array** to the different parts of the series of the . You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
## **{PackageVerChanges-21-2.1}**
@@ -959,7 +961,7 @@ Added significant improvements to default behaviors, and refined the Category Ch
- Responsive layouts for horizontal label rotation based on browser / screen size.
- Enhanced rendering for rounded labels on all platforms.
- Added marker properties to StackedFragmentSeries.
-- Added `ShouldPanOnMaximumZoom` property.
+- Added property.
- New Category Axis Properties:
- ZoomMaximumCategoryRange
- ZoomMaximumItemSpan
@@ -980,32 +982,32 @@ Added significant improvements to default behaviors, and refined the Category Ch
- GroupSortDescriptions
-[Chart Aggregation](charts/features/chart-data-aggregations.md) will not work when using `IncludedProperties` | `ExcludedProperties`. These properties on the chart are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
+[Chart Aggregation](charts/features/chart-data-aggregations.md) will not work when using | . These properties on the chart are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
### {PackageGrids} (データ グリッド)
-- Changed **{IgPrefix}Column** to `DataGridColumn`
-- Changed **GridCellEventArgs** to `DataGridCellEventArgs`
-- Changed **GridSelectionMode** to `DataGridSelectionMode`
-- Changed **SummaryOperand** to `DataSourceSummaryOperand`
+- Changed **{IgPrefix}Column** to
+- Changed **GridCellEventArgs** to
+- Changed **GridSelectionMode** to
+- Changed **SummaryOperand** to
## データ グリッド
### {PackageInputs} (入力)
-- Added the highly-configurable [DataLegend](charts/features/chart-data-legend.md) component, which works much like the `Legend`, but it shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values.
+- Added the highly-configurable [DataLegend](charts/features/chart-data-legend.md) component, which works much like the , but it shows values of series and provides many configuration properties for filtering series rows and values columns, styling and formatting values.
- Added the highly-configurable [DataToolTip](charts/features/chart-data-tooltip.md) which displays values and titles of series as well as legend badges of series in a tooltip. This is now the default tooltip for all chart types.
-- Added animation and transition-in support for Stacked Series. Animations can be enabled by setting the `IsTransitionInEnabled` property to true. From there, you can set the `TransitionInDuration` property to determine how long your animation should take to complete and the `TransitionInMode` to determine the type of animation that takes place.
-- Added `AssigningCategoryStyle` event, is now available to all series in `DataChart`. This event is handled when you want to conditionally configure aspects of the series items such as `Fill` background-color and highlighting.
-- New `AllowedPositions` enumeration for CalloutLayer. Used to limit where the callouts are to be placed within the chart. By default, the callouts are intelligently placed in the best place but this used to force for example `TopLeft`, `TopRight`, `BottomLeft` or `BottomRight`.
+- Added animation and transition-in support for Stacked Series. Animations can be enabled by setting the property to true. From there, you can set the property to determine how long your animation should take to complete and the to determine the type of animation that takes place.
+- Added `AssigningCategoryStyle` event, is now available to all series in . This event is handled when you want to conditionally configure aspects of the series items such as background-color and highlighting.
+- New enumeration for CalloutLayer. Used to limit where the callouts are to be placed within the chart. By default, the callouts are intelligently placed in the best place but this used to force for example `TopLeft`, `TopRight`, `BottomLeft` or `BottomRight`.
- New corner radius properties added for Annotation Layers; used to round-out the corners of each of the callouts. Note, a corner radius has now been added by default.
- - `CalloutCornerRadius` for CalloutLayer
- - `AxisAnnotationBackgroundCornerRadius` for FinalValueLayer
- - `XAxisAnnotationBackgroundCornerRadius` and `YAxisAnnotationBackgroundCornerRadius` for CrosshairLayer
-- New `HorizontalViewScrollbarMode` and `VerticalViewScrollbarMode` enumeration to enable scrollbars in various ways. When paired with `IsVerticalZoomEnabled` or `IsHorizontalZoomEnabled`, you'll be able to persist or fade-in and out the scrollbars along the axes to navigate the chart.
-- New `FavorLabellingScaleEnd`, determines whether the axis should favor emitting a label at the end of the scale. Only compatible with numeric axes (e.g. `NumericXAxis`, `NumericYAxis`, `PercentChangeAxis`).
-- New `IsSplineShapePartOfRange` determines whether to include the spline shape in the axis range requested of the axis.
-- New `XAxisMaximumGap`, determines the maximum allowed value for the plotted series when using `XAxisGap`. The gap determines the amount of space between columns or bars of plotted series.
-- New `XAxisMinimumGapSize`, determines the minimum allowed pixel-based value for the plotted series when using `XAxisGap` to ensure there is always some spacing between each category.
+ - for CalloutLayer
+ - for FinalValueLayer
+ - and for CrosshairLayer
+- New and enumeration to enable scrollbars in various ways. When paired with or , you'll be able to persist or fade-in and out the scrollbars along the axes to navigate the chart.
+- New , determines whether the axis should favor emitting a label at the end of the scale. Only compatible with numeric axes (e.g. , , `PercentChangeAxis`).
+- New determines whether to include the spline shape in the axis range requested of the axis.
+- New , determines the maximum allowed value for the plotted series when using . The gap determines the amount of space between columns or bars of plotted series.
+- New , determines the minimum allowed pixel-based value for the plotted series when using to ensure there is always some spacing between each category.
### 日付ピッカー
@@ -1018,29 +1020,29 @@ Added significant improvements to default behaviors, and refined the Category Ch
#### {PackageCharts} (チャート)
このリリースでは、地理マップとすべてのチャート コンポーネントのビジュアル デザインと構成オプションにいくつかの改善と簡素化が導入されています。
-- `FinancialChart` と `CategoryChart` の `YAxisLabelLocation` プロパティのタイプを **AxisLabelLocation** から **YAxisLabelLocation** に変更しました。
-- `FinancialChart` の **AxisLabelLocation** から **XAxisLabelLocation** に `XAxisLabelLocation` プロパティのタイプを変更しました。
-- `CategoryChart` に `XAxisLabelLocation` プロパティを追加しました。
-- 凡例で `GeographicMap` の地理的なシリーズを表すためのサポートが追加されました。
-- `FinancialChart` と`CategoryChart` にデフォルトの十字線を追加しました。
-- `FinancialChart` と`CategoryChart` にデフォルトの十字線の注釈を追加しました。
-- `FinancialChart` にデフォルトで最終値の注釈を追加しました。
+- と の プロパティのタイプを **AxisLabelLocation** から **YAxisLabelLocation** に変更しました。
+- の **AxisLabelLocation** から **XAxisLabelLocation** に プロパティのタイプを変更しました。
+- に プロパティを追加しました。
+- 凡例で の地理的なシリーズを表すためのサポートが追加されました。
+- と にデフォルトの十字線を追加しました。
+- と にデフォルトの十字線の注釈を追加しました。
+- にデフォルトで最終値の注釈を追加しました。
- カテゴリ チャートとファイナンシャル チャートに新しいプロパティを追加しました:
- - 十字線をカスタマイズするための `CrosshairsLineThickness` およびその他のプロパティ
- - 十字線の注釈をカスタマイズするための `CrosshairsAnnotationXAxisBackground` およびその他のプロパティ
- - 最終値の注釈をカスタマイズするための `FinalValueAnnotationsBackground` およびその他のプロパティ
- - シリーズ塗りつぶしの不透明度を変更できる `AreaFillOpacity` (エリア チャートなど)
- - マーカーの厚さを変更できる `MarkerThickness`
+ - 十字線をカスタマイズするための およびその他のプロパティ
+ - 十字線の注釈をカスタマイズするための およびその他のプロパティ
+ - 最終値の注釈をカスタマイズするための およびその他のプロパティ
+ - シリーズ塗りつぶしの不透明度を変更できる (エリア チャートなど)
+ - マーカーの厚さを変更できる
- カテゴリ チャート、ファイナンシャル チャート、データ チャート、および地理マップに新しいプロパティを追加しました。
- - 同じチャート内の複数のシリーズにどのマーカー タイプを割り当てることができる `MarkerAutomaticBehavior`
- - 凡例で表されるすべてのシリーズのバッジの形状を設定するための `LegendItemBadgeShape`
- - 凡例のすべてのシリーズにバッジの複雑さを設定するための `LegendItemBadgeMode`
+ - 同じチャート内の複数のシリーズにどのマーカー タイプを割り当てることができる
+ - 凡例で表されるすべてのシリーズのバッジの形状を設定するための
+ - 凡例のすべてのシリーズにバッジの複雑さを設定するための
- データ チャートと地理マップのシリーズに新しいプロパティを追加しました。
- - 凡例で表される特定のシリーズにバッジの形状を設定するための `LegendItemBadgeShape`
- - 凡例の特定のシリーズにバッジの複雑さを設定するための `LegendItemBadgeMode`
+ - 凡例で表される特定のシリーズにバッジの形状を設定するための
+ - 凡例の特定のシリーズにバッジの複雑さを設定するための
- カテゴリ チャートとシリーズで、デフォルトの垂直十字線ストロークを#000000 から #BBBBBB に変更しました。
-- 同じチャートにプロットされたすべてのシリーズのマーカーの図形を円に変更しました。これは、チャートの `MarkerAutomaticBehavior` プロパティを `SmartIndexed` 列挙値に設定することで元に戻すことができます。
-- チャートの凡例のシリーズの簡略化された図形で、円、線、または四角のみを表示します。これは、チャートの `LegendItemBadgeMode` プロパティを `MatchSeries` 列挙値に設定することで元に戻すことができます。
+- 同じチャートにプロットされたすべてのシリーズのマーカーの図形を円に変更しました。これは、チャートの プロパティを `SmartIndexed` 列挙値に設定することで元に戻すことができます。
+- チャートの凡例のシリーズの簡略化された図形で、円、線、または四角のみを表示します。これは、チャートの プロパティを `MatchSeries` 列挙値に設定することで元に戻すことができます。
- アクセシビリティを向上させるために、すべてのチャートに表示されるシリーズとマーカーのカラー パレットを変更しました
| 古いのブラシ/アウトライン | 新のアウトライン/ブラシ |
@@ -1053,14 +1055,14 @@ Added significant improvements to default behaviors, and refined the Category Ch
- Changed ValueChanged event to `SelectedValueChanged`.
#### {PackageCharts} (チャート)
-このリリースでは、すべてのチャート コンポーネントに、いくつかの新しく改善されたビジュアル デザインと構成オプションが導入されています。例えば、`DataChart`、`CategoryChart`、および `FinancialChart`。
+このリリースでは、すべてのチャート コンポーネントに、いくつかの新しく改善されたビジュアル デザインと構成オプションが導入されています。例えば、、、および 。
## チャート凡例
-- バブル、ドーナツ、および円チャートで使用できる水平方向の `Orientation` プロパティを ItemLegend に追加しました。
-- `LegendHighlightingMode` プロパティの追加 - 凡例項目にホバーした時にシリーズのハイライト表示を有効にします。
+- バブル、ドーナツ、および円チャートで使用できる水平方向の プロパティを ItemLegend に追加しました。
+- プロパティの追加 - 凡例項目にホバーした時にシリーズのハイライト表示を有効にします。
### {PackageMaps} (GeoMap)
@@ -1080,11 +1082,11 @@ Added significant improvements to default behaviors, and refined the Category Ch
### {PackageGrids} (データ グリッド)
-- `EditOnKeyPress`、(別名: Excel スタイルの編集) を追加し、入力するとすぐに編集を開始します。
-- `EditModeClickAction` プロパティを追加しました - デフォルトでは、編集モードに入るにはダブル クリックが必要です。これを `SingleClick` に設定して、新しいセルを選択するときに編集モードを実行できるようにすることができます。
-- `EnterKeyBehaviors` プロパティの追加 - 別名 Excel スタイル ナビゲーション (Enter 動作) - Enter キーの動作を制御します。たとえば、オプションは none、edit、move up、down、left、right です。
-- `EnterKeyBehaviorAfterEdit` プロパティの追加 - 編集モードでは、このプロパティは Enter キーが押されたときを制御します。例えば、オプションは (下、上、右、左のセルに移動) です。
-- `SelectAllRows` メソッドを追加しました。
+- 、(別名: Excel スタイルの編集) を追加し、入力するとすぐに編集を開始します。
+- プロパティを追加しました - デフォルトでは、編集モードに入るにはダブル クリックが必要です。これを `SingleClick` に設定して、新しいセルを選択するときに編集モードを実行できるようにすることができます。
+- プロパティの追加 - 別名 Excel スタイル ナビゲーション (Enter 動作) - Enter キーの動作を制御します。たとえば、オプションは none、edit、move up、down、left、right です。
+- プロパティの追加 - 編集モードでは、このプロパティは Enter キーが押されたときを制御します。例えば、オプションは (下、上、右、左のセルに移動) です。
+- メソッドを追加しました。
- 行範囲の選択を追加しました - `GridSelectionMode` プロパティを MultipleRow に設定すると、次の新しい機能が含まれるようになりました:
- クリックしてドラッグし、行を選択します。
- SHIFT キーを押しながらクリックして、複数の行を選択します。
@@ -1097,15 +1099,15 @@ Added significant improvements to default behaviors, and refined the Category Ch
## {PackageInputs} (入力)
### 日付ピッカー
-- `ShowTodayButton` - 現在の日付のボタンの表示を切り替えます。
-- `Label` - 日付値の上にラベルを追加します。
-- `Placeholder` プロパティ - 値が選択されていない場合にカスタム テキストを追加します。
-- `FormatString` - 入力日付文字列をカスタマイズします。(例: `yyyy-MM-dd`)
-- `DateFormat` - 選択した日付を LongDate または ShortDate のどちらとして表示するかを指定します。
-- `FirstDayOfWeek` - 週の最初の曜日を指定します。
-- `FirstWeekOfYear` - 年の最初の週をいつ表示するかを指定します。例えば、最初の 1 週間、最初の 4 日間の週です。
-- `ShowWeekNumbers` - 週番号の表示を切り替えます。
-- `MinDate` & `MaxDate` - 使用可能の選択できる日付の範囲を指定する日付制限。
+- - 現在の日付のボタンの表示を切り替えます。
+- - 日付値の上にラベルを追加します。
+- プロパティ - 値が選択されていない場合にカスタム テキストを追加します。
+- - 入力日付文字列をカスタマイズします。(例: `yyyy-MM-dd`)
+- - 選択した日付を LongDate または ShortDate のどちらとして表示するかを指定します。
+- - 週の最初の曜日を指定します。
+- - 年の最初の週をいつ表示するかを指定します。例えば、最初の 1 週間、最初の 4 日間の週です。
+- - 週番号の表示を切り替えます。
+- & - 使用可能の選択できる日付の範囲を指定する日付制限。
- アクセシビリティの追加
- Changed Bar/Column/Waterfall series to have square corners instead of rounded corners
@@ -1113,23 +1115,23 @@ Added significant improvements to default behaviors, and refined the Category Ch
- Changed Scatter High Density series’ colors for heat max property from #ee5879 to #ee5879
- Changed Financial/Waterfall series’ `NegativeBrush` and `NegativeOutline` properties from #C62828 to #ee5879
- Changed marker's thickness to 2px from 1px
-- Changed marker's fill to match the marker's outline for `PointSeries`, `BubbleSeries`, `ScatterSeries`, `PolarScatterSeries`. You can use set `MarkerFillMode` property to Normal to undo this change
-- Compressed labelling for the `TimeXAxis` and `OrdinalTimeXAxis`
+- Changed marker's fill to match the marker's outline for , , , . You can use set property to Normal to undo this change
+- Compressed labelling for the and
- New Marker Properties:
- - series.`MarkerFillMode` - Can be set to `MatchMarkerOutline` so the marker depends on the outline
- - series.`MarkerFillOpacity` - Can be set to a value 0 to 1
- - series.`MarkerOutlineMode` - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
+ - series. - Can be set to `MatchMarkerOutline` so the marker depends on the outline
+ - series. - Can be set to a value 0 to 1
+ - series. - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
- New Series Property:
- - series.`OutlineMode` - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
-- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the `ComputedPlotAreaMarginMode`, listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
- - chart.`PlotAreaMarginLeft`
- - chart.`PlotAreaMarginTop`
- - chart.`PlotAreaMarginRight`
- - chart.`PlotAreaMarginBottom`
- - chart.`ComputedPlotAreaMarginMode`
+ - series. - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
+- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the , listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
+ - chart.
+ - chart.
+ - chart.
+ - chart.
+ - chart.
- New Highlighting Properties
- - chart.`HighlightingMode` - Sets whether hovered or non-hovered series to fade, brighten
- - chart.`HighlightingBehavior` - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
+ - chart. - Sets whether hovered or non-hovered series to fade, brighten
+ - chart. - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
- Note, in previous releases the highlighting was limited to fade on hover.
- Added Highlighting Stacked, Scatter, Polar, Radial, and Shape series:
- Added Annotation layers to Stacked, Scatter, Polar, Radial, and Shape series:
@@ -1152,8 +1154,8 @@ for example:
#### **{PackageVerChangedFields}**
-- Added horizontal `Orientation` property to ItemLegend that can be used with Bubble, Donut, and Pie Chart
-- Added `LegendHighlightingMode` property - Enables series highlighting when hovering over legend items
+- Added horizontal property to ItemLegend that can be used with Bubble, Donut, and Pie Chart
+- Added property - Enables series highlighting when hovering over legend items
### {PackageGrids} (データ グリッド)
@@ -1167,11 +1169,11 @@ for example:
### **{PackageVerRenamedGrid}**
-- Added `EditOnKeyPress` aka Excel-style Editing, instantly begin editing when typing.
-- Added `EditModeClickAction` property - By default double-clicking is required to enter edit mode. This can be set to `SingleClick` to allow for edit mode to occur when selecting a new cell.
-- Added `EnterKeyBehaviors` property - aka Excel-style Navigation (Enter Behavior) – controls the behavior of the enter key, e.g. Options are (none, edit, move up, down, left, right)
-- Added `EnterKeyBehaviorAfterEdit` property - While in edit-mode, this property controls when enter is pressed, e.g. Options are (moves to the cell below, above, right, left)
-- Added `SelectAllRows` - method.
+- Added aka Excel-style Editing, instantly begin editing when typing.
+- Added property - By default double-clicking is required to enter edit mode. This can be set to `SingleClick` to allow for edit mode to occur when selecting a new cell.
+- Added property - aka Excel-style Navigation (Enter Behavior) – controls the behavior of the enter key, e.g. Options are (none, edit, move up, down, left, right)
+- Added property - While in edit-mode, this property controls when enter is pressed, e.g. Options are (moves to the cell below, above, right, left)
+- Added - method.
- Added Row Range Selection - With `GridSelectionMode` property set to MultipleRow the following new functionality is now included:
- Click and drag to select rows
- SHIFT and click to select multiple rows.
diff --git a/docs/xplat/src/content/jp/components/general-changelog-dv-wc.mdx b/docs/xplat/src/content/jp/components/general-changelog-dv-wc.mdx
index 215a09c306..e1899d4f10 100644
--- a/docs/xplat/src/content/jp/components/general-changelog-dv-wc.mdx
+++ b/docs/xplat/src/content/jp/components/general-changelog-dv-wc.mdx
@@ -19,6 +19,8 @@ import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# {ProductName} 変更ログ
@@ -195,7 +197,7 @@ Dropdown menus and dialogs are now using HTML Popover API to provide better posi
#### 新しいコンポーネント
-- `IgrChat` コンポーネントを追加しました。
+- `Chat` コンポーネントを追加しました。
- Adjusted the schema generation to account for more items to make it more likely to find valid values for properties.
@@ -205,9 +207,9 @@ Dropdown menus and dialogs are now using HTML Popover API to provide better posi
#### **{PackageVerChanges-25-1-SEP}**
-In {ProductName}, you can now annotate the `DataChart` with slice, strip, and point annotations at runtime using the new user annotations feature. This allows the end user to add more details to the plot such as calling out single important events such as company quarter reports by using the slice annotation or events that have a duration by using the strip annotation. You can also call out individual points on the plotted series by using the point annotation or any combination of these three.
+In {ProductName}, you can now annotate the with slice, strip, and point annotations at runtime using the new user annotations feature. This allows the end user to add more details to the plot such as calling out single important events such as company quarter reports by using the slice annotation or events that have a duration by using the strip annotation. You can also call out individual points on the plotted series by using the point annotation or any combination of these three.
-This is directly integrated with the available tools of the `Toolbar`.
+This is directly integrated with the available tools of the .
@@ -215,8 +217,8 @@ This is directly integrated with the available tools of the `Toolbar`.
Ability for axis annotations to automatically detect collisions and truncate to fit better. To enable this feature you must set the following properties:
-- `ShouldAvoidAnnotationCollisions`
-- `ShouldAutoTruncateAnnotations`
+-
+-
### Azure マップ画像のサポート
@@ -238,10 +240,10 @@ Ability for axis annotations to automatically detect collisions and truncate to
### 対応軸
-X 軸と Y 軸に `CompanionAxis` プロパティが追加され、既存の軸を簡単に複製できるようになりました。`CompanionAxisEnabled` プロパティを有効にすると、複製された軸はチャートの反対側に配置され、そこから各軸プロパティを設定できます。
+X 軸と Y 軸に `CompanionAxis` プロパティが追加され、既存の軸を簡単に複製できるようになりました。 プロパティを有効にすると、複製された軸はチャートの反対側に配置され、そこから各軸プロパティを設定できます。
### RadialPieSeries インセット アウトライン
-`RadialPieSeries` のアウトライン レンダリング方法を制御するために `UseInsetOutlines` プロパティが追加されました。**true** に設定すると、アウトラインがスライス形状の内側に描画され、**false** (既定値) に設定すると、アウトラインはスライス形状の端に半分内側・半分外側で描画されます。
+ のアウトライン レンダリング方法を制御するために プロパティが追加されました。**true** に設定すると、アウトラインがスライス形状の内側に描画され、**false** (既定値) に設定すると、アウトラインはスライス形状の端に半分内側・半分外側で描画されます。
**重大な変更**
@@ -252,7 +254,7 @@ X 軸と Y 軸に `CompanionAxis` プロパティが追加され、既存の軸
```
-- `ChartMouseEventArgs` クラスの `PlotAreaPosition` プロパティと `ChartPosition` プロパティが逆になっている問題が修正されました。これにより、`PlotAreaPosition` と `ChartPosition` が返す値が変更されます。
+- クラスの プロパティと プロパティが逆になっている問題が修正されました。これにより、 と が返す値が変更されます。
@@ -336,7 +338,7 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
- DataToolTipLayer、ItemToolTipLayer、CategoryToolTipLayer にスタイル設定用の新しいプロパティが追加されました: `ToolTipBackground`、`ToolTipBorderBrush`、および `ToolTipBorderThickness`。
-- DataLegend にスタイル設定用の新しいプロパティが追加されました: `ContentBackground`、`ContentBorderBrush`、および `ContentBorderThickness`。`ContentBorderBrush` と `ContentBorderThickness` はそれぞれ既定で transparent と 0 に設定されているため、境界線を表示するにはこれらのプロパティを設定する必要があります。
+- DataLegend にスタイル設定用の新しいプロパティが追加されました: 、、および 。 と はそれぞれ既定で transparent と 0 に設定されているため、境界線を表示するにはこれらのプロパティを設定する必要があります。
#### IgcDataGrid
@@ -348,7 +350,7 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
**Breaking Changes**
-- A fix was made due to an issue where the `PlotAreaPosition` and `ChartPosition` properties on `ChartMouseEventArgs` class were reversed. This will change the values that `PlotAreaPosition` and `ChartPosition` return.
+- A fix was made due to an issue where the and properties on class were reversed. This will change the values that and return.
### **{PackageVerChanges-25-1-AUG}**
@@ -358,18 +360,18 @@ Explore some of the publicly available [Azure maps here](https://azure.microsoft
[詳細はこちらをご参照ください](https://developer.mozilla.org/ja/docs/Web/CSS/:state)
- フォーム関連カスタム要素の有効性の動作: 要素は `:user-invalid` を模倣しようとし、UI またはフォームの `requestSubmit()/reset()` 呼び出しを介して操作されない限り、無効スタイルは適用されません。
-- `SuffixText`
-- `SuffixTextColor`
+-
+-
- `SuffixTextFont`
-- `SuffixIconName`
-- `SuffixIconCollectionName`
-- `SuffixIconStroke`
-- `SuffixIconFill`
-- `SuffixIconViewBoxLeft`
-- `SuffixIconViewBoxTop`
-- `SuffixIconViewBoxWidth`
-- `SuffixIconViewBoxHeight`
-- `TextDecoration`
+-
+-
+-
+-
+-
+-
+-
+-
+-
Please note that the maximum size available for the icons is 24x24. You can provide an icon that is larger or smaller than this, but you will need to configure the viewbox settings in order to properly scale it to fit in the 24x24 space so it is fully visible.
@@ -410,11 +412,11 @@ Please note that the maximum size available for the icons is 24x24. You can prov
- `igcChange` および `igcCancel` イベントの詳細では、基になるコンポーネントの `files` プロパティが返されるようになりました。
-- New properties added to the DataLegend to aid in styling: `ContentBackground`, `ContentBorderBrush`, and `ContentBorderThickness`. The `ContentBorderBrush` and `ContentBorderThickness` default to transparent and 0 respectively, so in order to see these borders, you will need to set these properties.
+- New properties added to the DataLegend to aid in styling: , , and . The and default to transparent and 0 respectively, so in order to see these borders, you will need to set these properties.
-- Added a new property to `ChartMouseEventArgs` called `WorldPosition` that provides the world relative position of the mouse. This position will be a value between 0 and 1 for both the X and Y axis within the axis space.
+- Added a new property to called that provides the world relative position of the mouse. This position will be a value between 0 and 1 for both the X and Y axis within the axis space.
-- Added `HighlightingFadeOpacity` to `SeriesViewer` and `DomainChart`. This allows you to configure the opacity applied to highlighted series.
+- Added to and . This allows you to configure the opacity applied to highlighted series.
- Expose `CalloutLabelUpdating` event for domain charts.
@@ -497,14 +499,14 @@ For more details please visit:
### {PackageGrids}
- **すべてのグリッド**
- - `FilteringExpressionsTree` プロパティを使用して初期フィルタリングの適用が可能になりました。
+ - プロパティを使用して初期フィルタリングの適用が可能になりました。
-- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose `LayoutMode` property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
+- The [Data Tooltip](charts/features/chart-data-tooltip.md) and [Data Legend](charts/features/chart-data-legend.md) expose property that you can use to layout the contents of the tooltip or legend in a table or vertical layout structure.
-- The `DefaultInteraction` property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
+- The property of the charts has been updated to include a new enumeration - `DragSelect` in which the dragged preview Rect will select the points contained within.
-- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an `OverlayText` property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
+- The [ValueOverlay and ValueLayer](charts/features/chart-overlays.md), in addition to the [Chart Data Annotations](charts/features/chart-data-annotations.md) listed above now expose an property that can be used to overlay additional annotation text in the plot area. These appearance of these annotations can be configured by using the many OverlayText-prefixed properties. For example, the `OverlayTextBrush` property will configure the color of the overlay text.
- [Trendline Layer](charts/features/chart-trendlines.md) series type that allows you to apply a single trend line per trend line layer to a particular series. This allows the usage of multiple trend lines on a single series since you can have multiple [TrendlineLayer](charts/features/chart-overlays.md) series types in the chart.
@@ -527,9 +529,9 @@ For more details please visit:
### 機能拡張
#### Toolbar
-- `Toolbar` と `ToolPanel` に新しい `GroupHeaderTextStyle` プロパティを追加しました。設定されている場合、すべての `ToolActionGroupHeader` アクションに適用されます。
-- タイトル テキストの水平方向の配置を制御する `TitleHorizontalAlignment` という新しいプロパティを `ToolAction` に追加しました。
-- `ToolActionSubPanel` に、パネル内の項目間の間隔を制御する `ItemSpacing` という新しいプロパティを追加しました。
+- と に新しい `GroupHeaderTextStyle` プロパティを追加しました。設定されている場合、すべての アクションに適用されます。
+- タイトル テキストの水平方向の配置を制御する という新しいプロパティを に追加しました。
+- に、パネル内の項目間の間隔を制御する という新しいプロパティを追加しました。
#### バグ修正
次の表は、このリリースの {ProductName} ツールセットに対して行われたバグ修正を示しています。
@@ -543,7 +545,7 @@ For more details please visit:
### **{PackageVerChanges-24-2-DEC}**
- **All Grids**
- - Allow applying initial filtering through `FilteringExpressionsTree` property
+ - Allow applying initial filtering through property
### {PackageCharts}
@@ -555,16 +557,16 @@ For more details please visit:
#### {PackageCharts}
-- 新しい[データ円チャート](charts/types/data-pie-chart.md) - `DataPieChart` は円ャートを表示する新しいコンポーネントです。このコンポーネントは、`CategoryChart` と同様に動作し、基になるデータ モデルのプロパティを自動的に検出しながら、ItemLegend コンポーネントを介して選択、強調表示、アニメーション、凡例のサポートを可能にします。
+- 新しい[データ円チャート](charts/types/data-pie-chart.md) - は円ャートを表示する新しいコンポーネントです。このコンポーネントは、 と同様に動作し、基になるデータ モデルのプロパティを自動的に検出しながら、ItemLegend コンポーネントを介して選択、強調表示、アニメーション、凡例のサポートを可能にします。
### {PackageGrids}
- **すべてのグリッド**
- 新しい `RowClick` イベントが追加されました。
-- `PivotGrid`
- - `PivotDimension` に `sortable` プロパティが追加されました。
+-
+ - に `sortable` プロパティが追加されました。
- 水平レイアウトが追加されました。新しい `pivotUI` プロパティ内で `rowLayout` `horizontal` として有効にできます。
- - 水平レイアウトのみの行ディメンション サマリーが追加されました。`horizontalSummary` を **true** に設定することで、各 `PivotDimension` に対して有効にできます。
+ - 水平レイアウトのみの行ディメンション サマリーが追加されました。`horizontalSummary` を **true** に設定することで、各 に対して有効にできます。
- 水平集計の位置を設定するための `horizontalSummariesPosition` プロパティを `pivotUI` に追加しました。
- 行ディメンションの行ヘッダーが追加されました。新しい `pivotUI` プロパティ内で `showHeaders` **true** として有効にできます。
- キーボード ナビゲーションで行ディメンションヘッダーや列ヘッダーから行ヘッダーへ移動できるようになりました。
@@ -572,20 +574,20 @@ For more details please visit:
**重大な変更**:
- **すべてのグリッド**
- - `RowIsland`
+ -
- `displayDensity` の非推奨のプロパティが削除されました。
- `actualColumns`、`contentColumns` プロパティの名前を、`actualColumnList` および `contentColumnList` に変更しました。すべての列を取得するには、`column` または `columnList` プロパティを使用してください。
- - `rowDelete` および `rowAdd` イベント引数タイプの名前を `RowDataCancelableEventArgs` に変更しました。
- - `contextMenu` イベント引数タイプの名前を `GridContextMenuEventArgs` に変更しました。
- - `GridEditEventArgs`、`GridEditDoneEventArgs`、`PinRowEventArgs` イベントの `rowID` および `primaryKey` プロパティが削除されました。代わりに `rowKey` を使用してください。
-- `PivotGrid`
+ - `rowDelete` および `rowAdd` イベント引数タイプの名前を に変更しました。
+ - `contextMenu` イベント引数タイプの名前を に変更しました。
+ - 、、 イベントの `rowID` および `primaryKey` プロパティが削除されました。代わりに `rowKey` を使用してください。
+-
- `showPivotConfigurationUI` プロパティが削除されました。`pivotUI` を使用して、その中に新しい `showConfiguration` オプションを設定してください。
-- `Column`
+-
- `movable` プロパティが削除されました。グリッドの `moving` プロパティを使用してください。
- `columnChildren` プロパティが削除されました。代わりに `childColumns` を使用してください。
-- `ColumnGroup`
+-
- `children` プロパティが削除されました。代わりに `childColumns` を使用してください。
-- `Paginator`
+-
- `isFirstPageDisabled` および `isLastPageDisabled` プロパティが削除されました。代わりに、`isFirstPage` および `isLastPage` を使用してください。
## **{PackageVerChanges-24-1-JUN}**
@@ -594,30 +596,30 @@ For more details please visit:
### {PackageCommon}
-- `Input`、`Textarea` - ユーザー入力を制限することなく検証ルールを適用できるように `ValidateOnly` を公開しました。
-- `Dropdown` - `PositionStrategy` プロパティは非推奨です。ドロップダウンは、ブラウザー ビューポートの最上位レイヤーにコンテナーをレンダリングするために `Popover` API を使用するようになったため、このプロパティは廃止されました。
-- `DockManager` - `SplitPane` の `IsMaximized` は非推奨です。分割ペイン レベルで isMaximized を true に設定しても、分割ペインはコンテナーとしてのみ機能し、最大化されて表示される実際のコンテンツがないため、実際の効果はありません。代わりに、`TabGroupPane` および/または `ContentPane` の `IsMaximized` プロパティを使用してください。
+- 、 - ユーザー入力を制限することなく検証ルールを適用できるように を公開しました。
+- - プロパティは非推奨です。ドロップダウンは、ブラウザー ビューポートの最上位レイヤーにコンテナーをレンダリングするために `Popover` API を使用するようになったため、このプロパティは廃止されました。
+- - の は非推奨です。分割ペイン レベルで isMaximized を true に設定しても、分割ペインはコンテナーとしてのみ機能し、最大化されて表示される実際のコンテンツがないため、実際の効果はありません。代わりに、 および/または の プロパティを使用してください。
## {PackageGrids}
### {PackageCharts}
-- [データ凡例のグループ化](charts/features/chart-data-legend.md#{PlatformLower}-データ凡例のグループ化) と [データ ツールチップのグループ化](charts/features/chart-data-tooltip.md#{PlatformLower}-データ-チャートのデータ-ツールチップのグループ化) - 新しいグループ化機能が追加されました。`GroupRowVisible` プロパティは、各シリーズのグループ化を切り替え、オプトインすると `DataLegendGroup` プロパティを介してグループ テキストを割り当てることができます 同じ値が複数のシリーズに適用されている場合、それらはグループ化されて表示されます。すべてのユーザー向けに分類および整理する必要がある大規模なデータセットに役立ちます。
+- [データ凡例のグループ化](charts/features/chart-data-legend.md#{PlatformLower}-データ凡例のグループ化) と [データ ツールチップのグループ化](charts/features/chart-data-tooltip.md#{PlatformLower}-データ-チャートのデータ-ツールチップのグループ化) - 新しいグループ化機能が追加されました。 プロパティは、各シリーズのグループ化を切り替え、オプトインすると プロパティを介してグループ テキストを割り当てることができます 同じ値が複数のシリーズに適用されている場合、それらはグループ化されて表示されます。すべてのユーザー向けに分類および整理する必要がある大規模なデータセットに役立ちます。
### {PackageGauges}
-- `RadialGauge`
- - ハイライト針の新しいラベル。`HighlightLabelText` と `HighlightLabelSnapsToNeedlePivot` および、その他の HighlightLabel の多くのスタイル関連プロパティが追加されました。
+-
+ - ハイライト針の新しいラベル。 と および、その他の HighlightLabel の多くのスタイル関連プロパティが追加されました。
## **{PackageVerChanges-23-2-MAR}**
### {PackageGrids}
-- 新しい [`HierarchicalGrid`](grids/hierarchical-grid/overview.md) ンポーネント
+- 新しい [](grids/hierarchical-grid/overview.md) ンポーネント
-- New [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `DataChart`, to plot slices similar to a pie chart, a type of data visualization where data points are represented as segments within a circular graph.
+- New [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the , to plot slices similar to a pie chart, a type of data visualization where data points are represented as segments within a circular graph.
-- `Toolbar`
+-
- New ToolActionCheckboxList
A new CheckboxList ToolAction that displays a collection of items with checkboxes for selecting. A grid inside ToolAction CheckboxList grows in height up to 5 items, then a scrollbar is displayed.
@@ -632,35 +634,35 @@ For more details please visit:
### {PackageCharts}
-- `InitialFilter` プロパティによる新しいデータ フィルタリング。フィルター式を適用して、チャート データをレコードのサブセットにフィルターします。大規模なデータのドリルダウンに使用できます。
+- プロパティによる新しいデータ フィルタリング。フィルター式を適用して、チャート データをレコードのサブセットにフィルターします。大規模なデータのドリルダウンに使用できます。
- `RadialChart`
- 新しいラベル モード
- `CategoryAngleAxis` は、ラベルの位置をさらに構成できる `LabelMode` プロパティを公開するようになりました。これにより、`Center` 列挙型を選択してデフォルト モードを切り替えることも、ラベルを円形のプロット領域に近づける新しいモード `ClosestPoint` を使用することもできます。
+ は、ラベルの位置をさらに構成できる プロパティを公開するようになりました。これにより、`Center` 列挙型を選択してデフォルト モードを切り替えることも、ラベルを円形のプロット領域に近づける新しいモード `ClosestPoint` を使用することもできます。
## {PackageGauges}
### **{PackageVerChanges-23-2-JAN}**
-- `Input`, `Textarea` - exposed `ValidateOnly` to enable validation rules being enforced without restricting user input.
-- `Dropdown` - `PositionStrategy` property is deprecated. The dropdown now uses the `Popover` API to render its container in the top layer of the browser viewport, making the property obsolete.
-- `DockManager` - `SplitPane` `IsMaximized` is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the `IsMaximized` property of `TabGroupPane` and/or `ContentPane` instead.
+- , - exposed to enable validation rules being enforced without restricting user input.
+- - property is deprecated. The dropdown now uses the `Popover` API to render its container in the top layer of the browser viewport, making the property obsolete.
+- - is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the property of and/or instead.
### {PackageCharts}
-- [チャートのハイライト表示フィルター](charts/features/chart-highlight-filter.md) - `CategoryChart` と `DataChart` は、データのサブセットの内外でハイライト表示およびアニメーション化する方法を公開するようになりました。このハイライトの表示はシリーズのタイプによって異なります。列およびエリア シリーズの場合、サブセットはデータの合計セットの上に表示され、サブセットはシリーズの実際のブラシによって色付けされ、合計セットは不透明度を下げます。折れ線シリーズの場合、サブセットは点線で表示されます。
+- [チャートのハイライト表示フィルター](charts/features/chart-highlight-filter.md) - と は、データのサブセットの内外でハイライト表示およびアニメーション化する方法を公開するようになりました。このハイライトの表示はシリーズのタイプによって異なります。列およびエリア シリーズの場合、サブセットはデータの合計セットの上に表示され、サブセットはシリーズの実際のブラシによって色付けされ、合計セットは不透明度を下げます。折れ線シリーズの場合、サブセットは点線で表示されます。
### **{PackageVerChanges-23-2-DEC}**
-- [Data Legend Grouping](charts/features/chart-data-legend.md#{PlatformLower}-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#{PlatformLower}-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property `GroupRowVisible` toggles grouping with each series opting in can assign group text via the `DataLegendGroup` property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users.
+- [Data Legend Grouping](charts/features/chart-data-legend.md#{PlatformLower}-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#{PlatformLower}-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property toggles grouping with each series opting in can assign group text via the property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users.
-- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for `CategoryChart` and `DataChart`. Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and `SelectedSeriesItems` are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
+- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for and . Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular data item. Also `SelectedSeriesItemsChanged` event and are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection.
-- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `DataChart`, to enable creating pie charts in the allowing robust visualizations using all the added power of the data chart.
+- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the , to enable creating pie charts in the allowing robust visualizations using all the added power of the data chart.
-- [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a `HighlightingMode` property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the `HighlightingTransitionDuration` property.
+- [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the property.
-- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new `HighlightedItemsSource`. Can be toggled via `HighlightedValuesDisplayMode` and styled via `FillBrushes`.
+- [Treemap Percent-based Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-percent-based-highlighting) - New percent-based highlighting, allowing nodes to represent progress or subset of a collection. The appearance is shown as a fill-in of its backcolor up to a specific value either by a member on your data item or by supplying a new . Can be toggled via and styled via `FillBrushes`.
-- `Toolbar` - New `IsHighlighted` option for ToolAction for outlining a border around specific tools of choice.
+- - New option for ToolAction for outlining a border around specific tools of choice.
### {PackageGrids}
@@ -673,28 +675,28 @@ For more details please visit:
- [Toolbar](menus/toolbar.md)
- クリップボードを介してチャートを画像に保存するための保存ツール アクションが追加されました。
- - ツールバーの `Orientation` プロパティを介して垂直方向が追加されました。デフォルトでは、ツールバーは水平方向ですが、ツールバーを垂直方向に表示できるようになり、ツールが左右にポップアップ表示されます。
+ - ツールバーの プロパティを介して垂直方向が追加されました。デフォルトでは、ツールバーは水平方向ですが、ツールバーを垂直方向に表示できるようになり、ツールが左右にポップアップ表示されます。
- ツールバーの `renderImageFromText` メソッドを介してカスタム SVG アイコンのサポートが追加され、カスタム ツールの作成がさらに強化されました。
### **{PackageVerChanges-23-1}**
-- New Data Filtering via the `InitialFilter` property. Apply filter expressions to filter the chart data to a subset of records. Can be used for drill down large data.
+- New Data Filtering via the property. Apply filter expressions to filter the chart data to a subset of records. Can be used for drill down large data.
- `RadialChart`
- New Label Mode
- The `CategoryAngleAxis` for the now exposes a `LabelMode` property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
+ The for the now exposes a property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area.
### {PackageLayouts}
-- [Toolbar](menus/toolbar.md) - このコンポーネントは、主にチャート コンポーネントで使用される UI 操作のコンパニオン コンテナーです。ツールバーは、`DataChart` または `CategoryChart` コンポーネントにリンクされると、プロパティとツール項目のプリセットで動的に更新されます。プロジェクト用のカスタム ツールを作成して、エンド ユーザーが変更を提供できるようになり、無限のカスタマイズが可能になります。
+- [Toolbar](menus/toolbar.md) - このコンポーネントは、主にチャート コンポーネントで使用される UI 操作のコンパニオン コンテナーです。ツールバーは、 または コンポーネントにリンクされると、プロパティとツール項目のプリセットで動的に更新されます。プロジェクト用のカスタム ツールを作成して、エンド ユーザーが変更を提供できるようになり、無限のカスタマイズが可能になります。
## {PackageCharts}
### **{PackageVerChanges-22-2.2}**
-- [Chart Highlight Filter](charts/features/chart-highlight-filter.md) - The `CategoryChart` and `DataChart` now expose a way to highlight and animate in and out of a subset of data. The display of this highlight depends on the series type. For column and area series, the subset will be shown on top of the total set of data where the subset will be colored by the actual brush of the series, and the total set will have a reduced opacity. For line series, the subset will be shown as a dotted line.
+- [Chart Highlight Filter](charts/features/chart-highlight-filter.md) - The and now expose a way to highlight and animate in and out of a subset of data. The display of this highlight depends on the series type. For column and area series, the subset will be shown on top of the total set of data where the subset will be colored by the actual brush of the series, and the total set will have a reduced opacity. For line series, the subset will be shown as a dotted line.
## {PackageGrids}
@@ -703,8 +705,8 @@ For more details please visit:
- `IgcDateTimeInput` で StepDownAsync(DateTimeInputDatePart.Date, SpinDelta.Date)、DateTimeInputDatePart ではなく DatePart に切り詰められるようになりました。
- `IgcRadio` および `IgcRadioGroup` で、無効な状態のスタイルとともにコンポーネントの検証が追加されました。
- `IgcMask` - マスク パターン リテラルをエスケープする機能が追加されました。
-- `IgcBadge` - バッジの形状を制御する `Shape` プロパティが追加され、`Square` または `Rounded` のいずれかになります。デフォルトでは、バッジの形状は Rounded です。
-- `IgcAvatar` - `RoundShape` プロパティは非推奨になり、将来のバージョンで削除される予定です。ユーザーは、新しく追加された `Shape` 属性によってアバターの形状を制御できます。形状属性は、`Square`、`Rounded`、または `Circle` です。アバターの図形はデフォルトで `Square` です。
+- `IgcBadge` - バッジの形状を制御する プロパティが追加され、 または `Rounded` のいずれかになります。デフォルトでは、バッジの形状は Rounded です。
+- `IgcAvatar` - `RoundShape` プロパティは非推奨になり、将来のバージョンで削除される予定です。ユーザーは、新しく追加された 属性によってアバターの形状を制御できます。形状属性は、、`Rounded`、または です。アバターの図形はデフォルトで です。
## **{PackageVerChanges-22-2.1}**
@@ -721,16 +723,16 @@ For more details please visit:
- 新しい [Grid](grids/data-grid.md) コンポーネント。
- 新しい [Tree Grid](grids/tree-grid/overview.md) コンポーネント。
- `DataGrid`:
- - **{IgPrefix}Column** を `DataGridColumn` に変更しました。
- - **GridCellEventArgs** を `DataGridCellEventArgs` に変更しました。
- - **GridSelectionMode** を `DataGridSelectionMode` に変更しました。
+ - **{IgPrefix}Column** を に変更しました。
+ - **GridCellEventArgs** を に変更しました。
+ - **GridSelectionMode** を に変更しました。
- **SummaryOperand** を `DataSourceSummaryOperand` に変更しました。
### **{PackageVerChanges-22-1}**
-- [ValueLayer](charts/features/chart-overlays.md#{PlatformLower}-value-layer) - A new series type named the `ValueLayer` is now exposed which can allow you to render an overlay for different focal points of the plotted data such as Maximum, Minimum, and Average. This is applied to the `CategoryChart` and `FinancialChart` by adding to the new `ValueLines` collection.
+- [ValueLayer](charts/features/chart-overlays.md#{PlatformLower}-value-layer) - A new series type named the is now exposed which can allow you to render an overlay for different focal points of the plotted data such as Maximum, Minimum, and Average. This is applied to the and by adding to the new collection.
-- It is now possible to apply a **dash array** to the different parts of the series of the `DataChart`. You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
+- It is now possible to apply a **dash array** to the different parts of the series of the . You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
## {PackageGrids}
@@ -738,22 +740,22 @@ For more details please visit:
### {PackageCharts}
-- 高度に構成可能な [DataLegend](charts/features/chart-data-legend.md) コンポーネントを追加しました。これは、`Legend` とよく似ていますが、シリーズの値を表示し、シリーズの行と値の列をフィルタリングし、値のスタイルとフォーマットを行うための多くの構成プロパティを提供します。
+- 高度に構成可能な [DataLegend](charts/features/chart-data-legend.md) コンポーネントを追加しました。これは、 とよく似ていますが、シリーズの値を表示し、シリーズの行と値の列をフィルタリングし、値のスタイルとフォーマットを行うための多くの構成プロパティを提供します。
- 高度に構成可能な [DataToolTip](charts/features/chart-data-tooltip.md) が追加されました。これは、シリーズの値とタイトル、およびシリーズの凡例バッジをツールチップに表示します。これは、すべてのチャート タイプのデフォルトのツールチップになりました。
-- 積層シリーズのアニメーションとトランジションインのサポートが追加されました。`IsTransitionInEnabled` プロパティを true に設定すると、アニメーションを有効にできます。そこから、`TransitionInDuration` プロパティを設定してアニメーションが完了するまでの時間を決定し、`TransitionInMode` でアニメーションのタイプを決定できます。
-- 追加された `AssigningCategoryStyle` イベントは、`DataChart` のすべてのシリーズで利用できるようになりました。このイベントは、背景色の `Fill` やハイライト表示など、シリーズ項目の外観を条件付きで構成する場合に処理されます。
-- CalloutLayer の新しい `AllowedPositions` 列挙体。チャート内のどこにコールアウトを配置するかを制限するために使用されます。デフォルトでは、コールアウトは最適な場所に配置されますが、これは `TopLeft`、`TopRight`、`BottomLeft`、または `BottomRight` を強制するために使用されます。
+- 積層シリーズのアニメーションとトランジションインのサポートが追加されました。 プロパティを true に設定すると、アニメーションを有効にできます。そこから、 プロパティを設定してアニメーションが完了するまでの時間を決定し、 でアニメーションのタイプを決定できます。
+- 追加された `AssigningCategoryStyle` イベントは、 のすべてのシリーズで利用できるようになりました。このイベントは、背景色の やハイライト表示など、シリーズ項目の外観を条件付きで構成する場合に処理されます。
+- CalloutLayer の新しい 列挙体。チャート内のどこにコールアウトを配置するかを制限するために使用されます。デフォルトでは、コールアウトは最適な場所に配置されますが、これは `TopLeft`、`TopRight`、`BottomLeft`、または `BottomRight` を強制するために使用されます。
- 注釈レイヤーに追加された新しいコーナー半径プロパティ。各コールアウトのコーナーを丸めるために使用されます。コーナー半径がデフォルトで追加されていることに注意してください。
- - CalloutLayer の `CalloutCornerRadius`
- - FinalValueLayer の `AxisAnnotationBackgroundCornerRadius`
- - CrosshairLayer の `XAxisAnnotationBackgroundCornerRadius` と `YAxisAnnotationBackgroundCornerRadius`
-- さまざまな方法でスクロールバーを有効にするための新しい `HorizontalViewScrollbarMode` および `VerticalViewScrollbarMode` 列挙体。`IsVerticalZoomEnabled` または `IsHorizontalZoomEnabled` と組み合わせると、チャートをナビゲートするための軸に沿ったスクロールバーを、常設またはフェードインおよびフェードアウトすることができます。
-- 新しい `FavorLabellingScaleEnd` は、軸がスケールの最後にラベルを表示することを優先するかどうかを決定します。数値軸 (`NumericXAxis`、`NumericYAxis`、`PercentChangeAxis` など) とのみ互換性があります。
-- 新しい `IsSplineShapePartOfRange` は、軸に要求された軸範囲にスプライン形状を含めるかどうかを決定します。
-- 新しい `XAxisMaximumGap` は、`XAxisGap` を使用するときにプロットされたシリーズの最大許容値を決定します。ギャップは、プロットされたシリーズの列またはバー間のスペースの量を決定します。
-- 新しい `XAxisMinimumGapSize` は、`XAxisGap` を使用するときに、プロットされたシリーズの最小許容ピクセルベース値を決定し、各カテゴリ間に常にある程度の間隔があることを保証します。
+ - CalloutLayer の
+ - FinalValueLayer の
+ - CrosshairLayer の と
+- さまざまな方法でスクロールバーを有効にするための新しい および 列挙体。 または と組み合わせると、チャートをナビゲートするための軸に沿ったスクロールバーを、常設またはフェードインおよびフェードアウトすることができます。
+- 新しい は、軸がスケールの最後にラベルを表示することを優先するかどうかを決定します。数値軸 (、、`PercentChangeAxis` など) とのみ互換性があります。
+- 新しい は、軸に要求された軸範囲にスプライン形状を含めるかどうかを決定します。
+- 新しい は、 を使用するときにプロットされたシリーズの最大許容値を決定します。ギャップは、プロットされたシリーズの列またはバー間のスペースの量を決定します。
+- 新しい は、 を使用するときに、プロットされたシリーズの最小許容ピクセルベース値を決定し、各カテゴリ間に常にある程度の間隔があることを保証します。
-- `PivotGrid`: The `IgcPivotDateDimension` properties `InBaseDimension` and `InOption` have been deprecated and renamed to `BaseDimension` and `Options` respectively.
+- : The `IgcPivotDateDimension` properties `InBaseDimension` and `InOption` have been deprecated and renamed to `BaseDimension` and `Options` respectively.
### **{PackageVerChanges-21-2.1}**
@@ -761,8 +763,8 @@ For more details please visit:
- `IgcDateTimeInput`, the StepDownAsync(DateTimeInputDatePart.Date, SpinDelta.Date) is now trimmed down to DatePart instead of DateTimeInputDatePart
- `IgcRadio` and `IgcRadioGroup`, added component validation along with styles for invalid state
- `IgcMask`, added the capability to escape mask pattern literals.
-- `IgcBadge` added a `Shape` property that controls the shape of the badge and can be either `Square` or `Rounded`. The default shape of the badge is rounded.
-- `IgcAvatar`, the `RoundShape` property has been deprecated and will be removed in a future version. Users can control the shape of the avatar by the newly added `Shape` attribute that can be `Square`, `Rounded` or `Circle`. The default shape of the avatar is `Square`.
+- `IgcBadge` added a property that controls the shape of the badge and can be either or `Rounded`. The default shape of the badge is rounded.
+- `IgcAvatar`, the `RoundShape` property has been deprecated and will be removed in a future version. Users can control the shape of the avatar by the newly added attribute that can be , `Rounded` or . The default shape of the avatar is .
## {PackageGrids}
@@ -795,29 +797,29 @@ For more details please visit:
このリリースでは、地理マップとすべてのチャート コンポーネントのビジュアル デザインと構成オプションにいくつかの改善と簡素化が導入されています。
-- `FinancialChart` と `CategoryChart` の `YAxisLabelLocation` プロパティのタイプを **AxisLabelLocation** から **YAxisLabelLocation** に変更しました。
-- `FinancialChart` の `XAxisLabelLocation` プロパティのタイプを **AxisLabelLocation** から **XAxisLabelLocation** に変更しました。
-- `CategoryChart` に `XAxisLabelLocation` プロパティを追加しました。
-- 凡例で `GeographicMap` の地理的なシリーズを表すためのサポートが追加されました。
-- `FinancialChart` と `CategoryChart` にデフォルトの十字線を追加しました。
-- `FinancialChart` と `CategoryChart` にデフォルトの十字線の注釈を追加しました。
-- `FinancialChart` にデフォルトで最終値の注釈を追加しました
+- と の プロパティのタイプを **AxisLabelLocation** から **YAxisLabelLocation** に変更しました。
+- の プロパティのタイプを **AxisLabelLocation** から **XAxisLabelLocation** に変更しました。
+- に プロパティを追加しました。
+- 凡例で の地理的なシリーズを表すためのサポートが追加されました。
+- と にデフォルトの十字線を追加しました。
+- と にデフォルトの十字線の注釈を追加しました。
+- にデフォルトで最終値の注釈を追加しました
- カテゴリ チャートとファイナンシャル チャートに新しいプロパティを追加しました:
- - 十字線をカスタマイズするための `CrosshairsLineThickness` およびその他のプロパティ。
- - 十字線の注釈をカスタマイズするための `CrosshairsAnnotationXAxisBackground` およびその他のプロパティ。
- - 最終値の注釈をカスタマイズするための `FinalValueAnnotationsBackground` およびその他のプロパティ。
- - シリーズ塗りつぶしの不透明度を変更できる `AreaFillOpacity` (エリア チャートなど)
- - マーカーの厚さを変更できる `MarkerThickness`
+ - 十字線をカスタマイズするための およびその他のプロパティ。
+ - 十字線の注釈をカスタマイズするための およびその他のプロパティ。
+ - 最終値の注釈をカスタマイズするための およびその他のプロパティ。
+ - シリーズ塗りつぶしの不透明度を変更できる (エリア チャートなど)
+ - マーカーの厚さを変更できる
- カテゴリ チャート、ファイナンシャル チャート、データ チャート、および地理マップに新しいプロパティを追加しました。
- - 同じチャート内の複数のシリーズにどのマーカー タイプを割り当てることができる `MarkerAutomaticBehavior`
- - 凡例で表されるすべてのシリーズのバッジの形状を設定するための `LegendItemBadgeShape`
- - 凡例のすべてのシリーズにバッジの複雑さを設定するための `LegendItemBadgeMode`
+ - 同じチャート内の複数のシリーズにどのマーカー タイプを割り当てることができる
+ - 凡例で表されるすべてのシリーズのバッジの形状を設定するための
+ - 凡例のすべてのシリーズにバッジの複雑さを設定するための
- データ チャートと地理マップのシリーズに新しいプロパティを追加しました。
- - 凡例で表される特定のシリーズにバッジの形状を設定するための `LegendItemBadgeShape`
- - 凡例の特定のシリーズにバッジの複雑さを設定するための `LegendItemBadgeMode`
+ - 凡例で表される特定のシリーズにバッジの形状を設定するための
+ - 凡例の特定のシリーズにバッジの複雑さを設定するための
- カテゴリ チャートとシリーズで、デフォルトの垂直十字線ストロークを #000000 から #BBBBBB に変更しました。
-- 同じチャートにプロットされたすべてのシリーズのマーカーの図形を円に変更しました。これは、チャートの `MarkerAutomaticBehavior` プロパティを `SmartIndexed` 列挙値に設定することで元に戻すことができます。
-- チャートの凡例のシリーズの簡略化された図形で、円、線、または四角のみを表示します。これは、チャートの `LegendItemBadgeMode` プロパティを `MatchSeries` 列挙値に設定することで元に戻すことができます。
+- 同じチャートにプロットされたすべてのシリーズのマーカーの図形を円に変更しました。これは、チャートの プロパティを `SmartIndexed` 列挙値に設定することで元に戻すことができます。
+- チャートの凡例のシリーズの簡略化された図形で、円、線、または四角のみを表示します。これは、チャートの プロパティを `MatchSeries` 列挙値に設定することで元に戻すことができます。
- アクセシビリティを向上させるために、すべてのチャートに表示されるシリーズとマーカーのカラー パレットを変更しました
| 古いのブラシ/アウトライン | 新のアウトライン/ブラシ |
@@ -831,10 +833,10 @@ For more details please visit:
- `DataGrid`:
- `EditOnKeyPress` を追加しました - 別名 Excel スタイルの編集。入力するとすぐに編集を開始します。
- - `EditModeClickAction` プロパティを追加しました - デフォルトでは、編集モードに入るにはダブル クリックが必要です。これを `SingleClick` に設定して、新しいセルを選択するときに編集モードを実行できるようにすることができます。
- - `EnterKeyBehaviors` プロパティ (別名 Excel スタイルのナビゲーション (Enter 動作)) を追加して、Enter キーの動作を制御します。例えば、オプションは (なし、編集、上、下、左、右に移動) です。
- - `EnterKeyBehaviorAfterEdit` プロパティを追加しました - 編集モードでは、このプロパティは Enter キーが押されたときを制御します。例えば、オプションは (下、上、右、左のセルに移動) です。
- - `SelectAllRows` メソッドを追加しました。
+ - プロパティを追加しました - デフォルトでは、編集モードに入るにはダブル クリックが必要です。これを に設定して、新しいセルを選択するときに編集モードを実行できるようにすることができます。
+ - プロパティ (別名 Excel スタイルのナビゲーション (Enter 動作)) を追加して、Enter キーの動作を制御します。例えば、オプションは (なし、編集、上、下、左、右に移動) です。
+ - プロパティを追加しました - 編集モードでは、このプロパティは Enter キーが押されたときを制御します。例えば、オプションは (下、上、右、左のセルに移動) です。
+ - メソッドを追加しました。
- 行範囲の選択を追加しました - `GridSelectionMode` プロパティを MultipleRow に設定すると、次の新しい機能が含まれるようになりました:
- クリックしてドラッグし、行を選択します。
- SHIFT キーを押しながらクリックして、複数の行を選択します。
@@ -845,45 +847,45 @@ For more details please visit:
### {PackageCharts}
- Date Picker:
- - `ShowTodayButton` - 現在の日付のボタンの表示を切り替えます。
- - `Label` - 日付値の上にラベルを追加します。
- - `Placeholder` プロパティ - 値が選択されていない場合にカスタム テキストを追加します。
- - `FormatString` - 入力日付文字列をカスタマイズします。(例: `yyyy-MM-dd`)
- - `DateFormat` - 選択した日付を LongDate または ShortDate のどちらとして表示するかを指定します。
- - `FirstDayOfWeek` - 週の最初の曜日を指定します。
- - `FirstWeekOfYear` - 年の最初の週をいつ表示するかを指定します。例えば、最初の 1 週間、最初の 4 日間の週です。
- - `ShowWeekNumbers` - 週番号の表示を切り替えます。
- - `MinDate` & `MaxDate` - 使用可能の選択できる日付の範囲を指定する日付制限。
+ - - 現在の日付のボタンの表示を切り替えます。
+ - - 日付値の上にラベルを追加します。
+ - プロパティ - 値が選択されていない場合にカスタム テキストを追加します。
+ - - 入力日付文字列をカスタマイズします。(例: `yyyy-MM-dd`)
+ - - 選択した日付を LongDate または ShortDate のどちらとして表示するかを指定します。
+ - - 週の最初の曜日を指定します。
+ - - 年の最初の週をいつ表示するかを指定します。例えば、最初の 1 週間、最初の 4 日間の週です。
+ - - 週番号の表示を切り替えます。
+ - & - 使用可能の選択できる日付の範囲を指定する日付制限。
- アクセシビリティの追加
## {PackageMaps}
### {PackageCharts}
-このリリースでは、すべてのチャート コンポーネントに、いくつかの新しく改善されたビジュアル デザインと構成オプションが導入されています。例えば、`DataChart`、`CategoryChart`、および `FinancialChart`。
+このリリースでは、すべてのチャート コンポーネントに、いくつかの新しく改善されたビジュアル デザインと構成オプションが導入されています。例えば、、、および 。
- 棒/縦棒/ウォーターフォール シリーズを、角丸ではなく角が四角になるように変更しました。
- heat min プロパティの 散布高密度シリーズの色を #8a5bb1 から #000000 に変更しました。
- heat max プロパティの 散布高密度シリーズの色を #ee5879 から #ee5879 に変更しました。
- ファイナンシャル/ウォーターフォール シリーズの `NegativeBrush` および `NegativeOutline` プロパティを #C62828 から #ee5879 に変更しました。
- マーカーの厚さを 1 pxから 2 pxに変更しました。
-- `PointSeries`、`BubbleSeries`、`ScatterSeries`、`PolarScatterSeries` のマーカーのアウトラインに一致するようにマーカーの塗りつぶしを変更しました。`MarkerFillMode` プロパティを Normal に設定すると、この変更を元に戻すことができます。
-- `TimeXAxis` および `OrdinalTimeXAxis` のラベリングを圧縮しました。
+- 、、、 のマーカーのアウトラインに一致するようにマーカーの塗りつぶしを変更しました。 プロパティを Normal に設定すると、この変更を元に戻すことができます。
+- および のラベリングを圧縮しました。
- 新しいマーカー プロパティ:
- - series.`MarkerFillMode` - マーカーがアウトラインに依存するように、`MatchMarkerOutline` に設定できます。
- - series.`MarkerFillOpacity` - 0〜1 の値に設定できます。
- - series.`MarkerOutlineMode` - マーカーのアウトラインが塗りブラシの色に依存するように、`MatchMarkerBrush` に設定できます。
+ - series. - マーカーがアウトラインに依存するように、`MatchMarkerOutline` に設定できます。
+ - series. - 0〜1 の値に設定できます。
+ - series. - マーカーのアウトラインが塗りブラシの色に依存するように、`MatchMarkerBrush` に設定できます。
- 新シリーズ プロパティ:
- - series.`OutlineMode` - シリーズ アウトラインの表示を切り替えるように設定できます。データ チャートの場合、プロパティはシリーズ上にあることに注意してください。
-- チャートがデフォルトのズーム レベルにあるときにビューポートに導入されるブリード オーバー領域を定義する新しいチャート プロパティを追加しました。一般的な使用例では、軸と最初/最後のデータ ポイントの間にスペースを提供します。以下にリストされている `ComputedPlotAreaMarginMode` は、マーカーが有効になっているときに自動的にマージンを設定することに注意してください。その他は、厚さを表す `Double` を指定するように設計されており、PlotAreaMarginLeft などがチャートの 4 辺すべてにスペースを調整します。
- - chart.`PlotAreaMarginLeft`
- - chart.`PlotAreaMarginTop`
- - chart.`PlotAreaMarginRight`
- - chart.`PlotAreaMarginBottom`
- - chart.`ComputedPlotAreaMarginMode`
+ - series. - シリーズ アウトラインの表示を切り替えるように設定できます。データ チャートの場合、プロパティはシリーズ上にあることに注意してください。
+- チャートがデフォルトのズーム レベルにあるときにビューポートに導入されるブリード オーバー領域を定義する新しいチャート プロパティを追加しました。一般的な使用例では、軸と最初/最後のデータ ポイントの間にスペースを提供します。以下にリストされている は、マーカーが有効になっているときに自動的にマージンを設定することに注意してください。その他は、厚さを表す `Double` を指定するように設計されており、PlotAreaMarginLeft などがチャートの 4 辺すべてにスペースを調整します。
+ - chart.
+ - chart.
+ - chart.
+ - chart.
+ - chart.
- 新しいハイライト表示プロパティ:
- - chart.`HighlightingMode` - ホバーされたシリーズとホバーされていないシリーズをフェードまたは明るくするかを設定します。
- - chart.`HighlightingBehavior` - 真上または最も近い項目など、マウスの位置に応じてシリーズをハイライト表示するかどうかを設定します。
+ - chart. - ホバーされたシリーズとホバーされていないシリーズをフェードまたは明るくするかを設定します。
+ - chart. - 真上または最も近い項目など、マウスの位置に応じてシリーズをハイライト表示するかどうかを設定します。
- 以前のリリースでは、ハイライト表示はホバー時にフェードするように制限されていたことに注意してください。
- 積層型、散布、極座標、ラジアル、およびシェイプ シリーズにハイライト表示を追加しました。
- 積層型、散布、極座標、ラジアル、およびシェイプ シリーズに注釈レイヤーを追加しました。
@@ -895,8 +897,8 @@ For more details please visit:
### チャート凡例
-- バブル、ドーナツ、および円チャートで使用できる水平方向の `Orientation` プロパティを ItemLegend に追加しました
-- `LegendHighlightingMode` プロパティの追加 - 凡例項目にホバーした時にシリーズのハイライト表示を有効にします
+- バブル、ドーナツ、および円チャートで使用できる水平方向の プロパティを ItemLegend に追加しました
+- プロパティの追加 - 凡例項目にホバーした時にシリーズのハイライト表示を有効にします
## **{PackageVerChangedFields}**
@@ -913,29 +915,29 @@ For more details please visit:
This release introduces a few improvements and simplifications to visual design and configuration options for the geographic map and all chart components.
-- Changed `YAxisLabelLocation` property's type to **YAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart` and `CategoryChart`
-- Changed `XAxisLabelLocation` property's type to **XAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart`
-- Added `XAxisLabelLocation` property to `CategoryChart`
-- Added support for representing geographic series of `GeographicMap` in a legend
-- Added crosshair lines by default in `FinancialChart` and `CategoryChart`
-- Added crosshair annotations by default in `FinancialChart` and `CategoryChart`
-- Added final value annotation by default in `FinancialChart`
+- Changed property's type to **YAxisLabelLocation** from **AxisLabelLocation** in and
+- Changed property's type to **XAxisLabelLocation** from **AxisLabelLocation** in
+- Added property to
+- Added support for representing geographic series of in a legend
+- Added crosshair lines by default in and
+- Added crosshair annotations by default in and
+- Added final value annotation by default in
- Added new properties in Category Chart and Financial Chart:
- - `CrosshairsLineThickness` and other properties for customizing crosshairs lines
- - `CrosshairsAnnotationXAxisBackground` and other properties for customizing crosshairs annotations
- - `FinalValueAnnotationsBackground` and other properties for customizing final value annotations
- - `AreaFillOpacity` that allow changing opacity of series fill (e.g. Area chart)
- - `MarkerThickness` that allows changing thickness of markers
+ - and other properties for customizing crosshairs lines
+ - and other properties for customizing crosshairs annotations
+ - and other properties for customizing final value annotations
+ - that allow changing opacity of series fill (e.g. Area chart)
+ - that allows changing thickness of markers
- Added new properties in Category Chart, Financial Chart, Data Chart, and Geographic Map:
- - `MarkerAutomaticBehavior` that allows which marker type is assigned to multiple series in the same chart
- - `LegendItemBadgeShape` for setting badge shape of all series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on all series in a legend
+ - that allows which marker type is assigned to multiple series in the same chart
+ - for setting badge shape of all series represented in a legend
+ - for setting badge complexity on all series in a legend
- Added new properties in Series in Data Chart and Geographic Map:
- - `LegendItemBadgeShape` for setting badge shape on specific series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on specific series in a legend
+ - for setting badge shape on specific series represented in a legend
+ - for setting badge complexity on specific series in a legend
- Changed default vertical crosshair line stroke from #000000 to #BBBBBB in category chart and series
-- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's `MarkerAutomaticBehavior` property to `SmartIndexed` enum value
-- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's `LegendItemBadgeMode` property to `MatchSeries` enum value
+- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's property to `SmartIndexed` enum value
+- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's property to `MatchSeries` enum value
- Changed color palette of series and markers displayed in all charts to improve accessibility
| Old brushes/outlines | New outline/brushes |
@@ -949,10 +951,10 @@ This release introduces a few improvements and simplifications to visual design
- `DataGrid`:
- Added `EditOnKeyPress` aka Excel-style Editing, instantly begin editing when typing.
- - Added `EditModeClickAction` property - By default double-clicking is required to enter edit mode. This can be set to `SingleClick` to allow for edit mode to occur when selecting a new cell.
- - Added `EnterKeyBehaviors` property - aka Excel-style Navigation (Enter Behavior) – controls the behavior of the enter key, e.g. Options are (none, edit, move up, down, left, right)
- - Added `EnterKeyBehaviorAfterEdit` property - While in edit-mode, this property controls when enter is pressed, e.g. Options are (moves to the cell below, above, right, left)
- - Added `SelectAllRows` - method.
+ - Added property - By default double-clicking is required to enter edit mode. This can be set to to allow for edit mode to occur when selecting a new cell.
+ - Added property - aka Excel-style Navigation (Enter Behavior) – controls the behavior of the enter key, e.g. Options are (none, edit, move up, down, left, right)
+ - Added property - While in edit-mode, this property controls when enter is pressed, e.g. Options are (moves to the cell below, above, right, left)
+ - Added - method.
- Added Row Range Selection - With `GridSelectionMode` property set to MultipleRow the following new functionality is now included:
- Click and drag to select rows
- SHIFT and click to select multiple rows.
@@ -979,30 +981,30 @@ These features are CTP
### **{PackageCommonVerChanges-5.1.0}**
-This release introduces several new and improved visual design and configuration options for all of the chart components, e.g. `DataChart`, `CategoryChart`, and `FinancialChart`.
+This release introduces several new and improved visual design and configuration options for all of the chart components, e.g. , , and .
- Changed Bar/Column/Waterfall series to have square corners instead of rounded corners
- Changed Scatter High Density series’ colors for heat min property from #8a5bb1 to #000000
- Changed Scatter High Density series’ colors for heat max property from #ee5879 to #ee5879
- Changed Financial/Waterfall series’ `NegativeBrush` and `NegativeOutline` properties from #C62828 to #ee5879
- Changed marker's thickness to 2px from 1px
-- Changed marker's fill to match the marker's outline for `PointSeries`, `BubbleSeries`, `ScatterSeries`, `PolarScatterSeries`. You can use set `MarkerFillMode` property to Normal to undo this change
-- Compressed labelling for the `TimeXAxis` and `OrdinalTimeXAxis`
+- Changed marker's fill to match the marker's outline for , , , . You can use set property to Normal to undo this change
+- Compressed labelling for the and
- New Marker Properties:
- - series.`MarkerFillMode` - Can be set to `MatchMarkerOutline` so the marker depends on the outline
- - series.`MarkerFillOpacity` - Can be set to a value 0 to 1
- - series.`MarkerOutlineMode` - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
+ - series. - Can be set to `MatchMarkerOutline` so the marker depends on the outline
+ - series. - Can be set to a value 0 to 1
+ - series. - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
- New Series Property:
- - series.`OutlineMode` - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
-- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the `ComputedPlotAreaMarginMode`, listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
- - chart.`PlotAreaMarginLeft`
- - chart.`PlotAreaMarginTop`
- - chart.`PlotAreaMarginRight`
- - chart.`PlotAreaMarginBottom`
- - chart.`ComputedPlotAreaMarginMode`
+ - series. - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
+- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the , listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
+ - chart.
+ - chart.
+ - chart.
+ - chart.
+ - chart.
- New Highlighting Properties
- - chart.`HighlightingMode` - Sets whether hovered or non-hovered series to fade, brighten
- - chart.`HighlightingBehavior` - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
+ - chart. - Sets whether hovered or non-hovered series to fade, brighten
+ - chart. - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
- Note, in previous releases the highlighting was limited to fade on hover.
- Added Highlighting Stacked, Scatter, Polar, Radial, and Shape series:
- Added Annotation layers to Stacked, Scatter, Polar, Radial, and Shape series:
@@ -1187,159 +1189,159 @@ import { IgcLiveGridComponent } from 'igniteui-webcomponents-data-grids/ES5/igc-
### 非推奨
#### 修正
-- `Input`、`Textarea`- 値に `undefined` を渡すと、基になる入力値が undefined に設定されます。
-- `MaskInput` - フォームの `reset` の呼び出し後、基になる入力値とプレースホルダーの状態が正しく更新されます。
-- `Tree` - 項目 `indicator` CSS パーツに `--ig-size` を設定すると、アイコンのサイズが変更されるようになりました。
-- `DateTimeInput` - 特定のシナリオで `igcChange` が二重に発行されます。
-- `NavDrawer` - ミニ バリアントは、開いた状態でない場合、最初は描画されません。
-- `Combo`:
+- 、- 値に `undefined` を渡すと、基になる入力値が undefined に設定されます。
+- - フォームの `reset` の呼び出し後、基になる入力値とプレースホルダーの状態が正しく更新されます。
+- - 項目 `indicator` CSS パーツに `--ig-size` を設定すると、アイコンのサイズが変更されるようになりました。
+- - 特定のシナリオで `igcChange` が二重に発行されます。
+- - ミニ バリアントは、開いた状態でない場合、最初は描画されません。
+- :
- ENTER キーを使用してエントリを選択すると、単一選択モードで正しく機能するようになりました。
- - `DisableFiltering` オプションをオンにすると、以前に入力した検索語句がクリアされるようになりました。
+ - オプションをオンにすると、以前に入力した検索語句がクリアされるようになりました。
- 単一選択モードで、選択した項目に既に一致する検索語を入力すると、正しく機能するようになりました。
### **{PackageCommonVerChanges-4.9.0}**
-- `Icon`
+-
- Added `setIconRef` method. This allows to register and replace icons by SVG files.
- All components now use icons by reference internally so that it's easy to replace them without explicitly providing custom templates.
-- `RadioGroup`
+-
- Added `name` and `value` properties.
**Breaking Changes**
-- Removed `Form` component. Use native form instead.
+- Removed component. Use native form instead.
- Removed `size` property in favor of the `--ig-size` CSS custom property for the following components:
- - `Avatar`, `Button`,`IconButton`, `Calendar`, `Chip`, `Dropdown`, `Icon`, `Input`, `List`, `Rating`, `Snackbar`, `Tabs`, `Tree`
+ - , ,, , , , , , , , , ,
- Removed custom `igcFocus` and `igcBlur` events. Use the native `focus` and `blur` events instead for the following components:
- - `Button`, `IconButton`, `Checkbox`, `Switch`, `Combo`, `DateTimeInput`, `Input`, `MaskInput`, `Radio`, **IgcSelectComponent**, `Textarea`
-- `Checkbox`, `Switch` ,`Radio`
+ - , , , , , , , , , **IgcSelectComponent**,
+- , ,
- Changed `igcChange` event arguments from `CustomEvent` to `CustomEvent<{ checked: boolean; value: string | undefined }>`
-- `Combo`, **IgcSelectComponent**
+- , **IgcSelectComponent**
- Removed `positionStrategy`, `flip`, `sameWidth` properties.
-- `Dialog`
+-
- Renamed The `closeOnEscape` property to `keepOpenOnEscape`.
-- `Dropdown`
+-
- Removed `positionStrategy` property.
-- `Input`
+-
- Removed `maxlength` and `minlength` properties. Use the native `maxLength` and `minLength` properties or `max` and `min` instead.
- Renamed `readonly` and `inputmode` properties to `readOnly` and `inputMode`.
-- `RangeSlider`
+-
- Renamed `ariaThumbLower`/`ariaThumbUpper` properties to `thumbLabelLower`/`thumbLabelUpper`.
-- `Rating`
+-
- Renamed `readonly` property to `readOnly`.
### 追加
#### 変更
-- `Combo`、`Select`、`Dropdown` - ネイティブの `Popover` API を使用するようになりました。
+- 、、 - ネイティブの `Popover` API を使用するようになりました。
### 非推奨
#### 修正
-- `DateTimeInput` - コンポーネントが読み取り専用モードの場合、Material テーマのラベルが壊れます。
+- - コンポーネントが読み取り専用モードの場合、Material テーマのラベルが壊れます。
### **{PackageCommonVerChanges-4.8.2}**
#### 修正
-- `Textarea` - サフィックスのないテキスト領域のサイズ変更ハンドルの位置。
-- `Tabs` - 単一の呼び出しスタックでタブ グループとタブを動的に作成および追加するときにエラーが発生します。
-- `Checkbox`/`Switch` - 最初にチェックしたときにフォームの送信に参加します。
-- `Dialog` - コンポーネントが実際に閉じられる/非表示になる前に `igcClosed` が発生します。
+- - サフィックスのないテキスト領域のサイズ変更ハンドルの位置。
+- - 単一の呼び出しスタックでタブ グループとタブを動的に作成および追加するときにエラーが発生します。
+- / - 最初にチェックしたときにフォームの送信に参加します。
+- - コンポーネントが実際に閉じられる/非表示になる前に `igcClosed` が発生します。
#### **{PackageCommonVerChanges-4.8.1}**
-- `Input` `Inputmode` property. Aligned with the native `inputMode` DOM property instead.
+- `Inputmode` property. Aligned with the native `inputMode` DOM property instead.
#### 修正
-- `DateTimeInput` - `InputFormat` は、既に設定されている値には適用されません。
-- `Checkbox`、`Radio`、`Switch` - フォーム検証を同期的に適用します。
-- `Select`、`Dropdown` - ドロップダウン/選択項目スロット内のラップ要素をクリックしても項目を選択できません。
-- `Tree` - アクティブ状態は、クリック時に正しいツリー ノードに正しく適用されます。
+- - は、既に設定されている値には適用されません。
+- 、、 - フォーム検証を同期的に適用します。
+- 、 - ドロップダウン/選択項目スロット内のラップ要素をクリックしても項目を選択できません。
+- - アクティブ状態は、クリック時に正しいツリー ノードに正しく適用されます。
### **{PackageCommonVerChanges-4.8.0}**
#### 追加
-- `Combo` では、`GroupSorting` を none に設定できるようになりました。これにより、提供されたデータの順序でグループが表示されます。
-- `Button`/`IconButton` - テーマ間でビジュアルの外観が更新され、新しい状態が追加されました。
+- では、 を none に設定できるようになりました。これにより、提供されたデータの順序でグループが表示されます。
+- / - テーマ間でビジュアルの外観が更新され、新しい状態が追加されました。
- `NavBar` - Bootstrap テーマに境界線が追加されました。
#### 変更
-- `Combo` でのグループ化ではデータがソートされなくなりました。`GroupSorting` プロパティは、グループのソート方向にのみ影響するようになりました。**動作変更**: 以前のリリースでは、グループのソート方向によって項目もソートされていました。この動作を実現したい場合は、既にソートされたデータを `Combo` に渡すことができます。
+- でのグループ化ではデータがソートされなくなりました。 プロパティは、グループのソート方向にのみ影響するようになりました。**動作変更**: 以前のリリースでは、グループのソート方向によって項目もソートされていました。この動作を実現したい場合は、既にソートされたデータを に渡すことができます。
#### 非推奨
-- `Slider` - `aria-label-upper` と `aria-label-lower` は非推奨であり、次のメジャー リリースで削除されます。代わりに、`thumb-label-upper` と `thumb-label-lower` を使用してください。
+- - `aria-label-upper` と `aria-label-lower` は非推奨であり、次のメジャー リリースで削除されます。代わりに、`thumb-label-upper` と `thumb-label-lower` を使用してください。
#### 修正
-- `Button` - スロットアイコンのサイズ。
-- `ButtonGroup`
+- - スロットアイコンのサイズ。
+-
- Fluent テーマの外観を更新しました。
- Safari での無効状態。
-- `Combo`/`Select` - スタイルの問題。
-- `Slider`
+- / - スタイルの問題。
+-
- スライダー トラックのクリックは、トラック要素の幅を計算の基準として使用します。
- スライダーのつまみを連続的にドラッグし、上限/下限を超えても、入力イベントは発生されません。
- `min`/`max` の前に `upper-bound`/`lower-bound` を設定する場合、スライダーはバインドされたプロパティを `min`/`max` の以前の値で上書きしません。
- スライダーのつまみにバインドされた `aria-label` は結果のレンダリングでリセットされなくなりました。
-- `Input`
+-
- デフォルトの検証は同期的に実行されます。
- スタイルの問題。
-- `DateTimeInput` - `setRangeText()` は基になる値を更新します。
+- - `setRangeText()` は基になる値を更新します。
### **{PackageCommonVerChanges-4.7.0}**
#### 追加
-- `Tree` - ノードをクリックすると展開状態が変更されるかどうかを決定する `ToggleNodeOnClick` プロパティが追加されました。デフォルトは **false** です。
+- - ノードをクリックすると展開状態が変更されるかどうかを決定する プロパティが追加されました。デフォルトは **false** です。
### 変更
#### 修正
-- `Dropdown`、`Select`、および `Combo` のアクティブ項目のビジュアル スタイル。
-- `NavDrawer` - ミニ バリアントの壊れたビジュアル スタイル。
+- 、、および のアクティブ項目のビジュアル スタイル。
+- - ミニ バリアントの壊れたビジュアル スタイル。
### **{PackageCommonVerChanges-4.6.0}**
#### 追加
-- `Snackbar` に `action` スロットが追加されました。
-- `indicator-expanded` スロットが `ExpansionPanel` に追加されました。
-- `toggle-icon-expanded` スロットが `Select` に追加されました。
-- `Select`、`Dropdown` - `selectedItem`、`items`、`groups` ゲッターを公開しました。
+- に `action` スロットが追加されました。
+- `indicator-expanded` スロットが に追加されました。
+- `toggle-icon-expanded` スロットが に追加されました。
+- 、 - `selectedItem`、`items`、`groups` ゲッターを公開しました。
#### 変更
- パッケージを Lit v3 に更新しました。
- コンポーネントのダーク バリアントはシャドウ ルートにバインドされるようになりました。
- コンポーネントは現在のテーマに基づいてデフォルトのサイズを実装します。
-- `ButtonGroup` - イベントをキャンセル不可に変更しました。
+- - イベントをキャンセル不可に変更しました。
- コンポーネント CSS を最適化し、バンドル サイズを縮小しました。
-- `Icon`、`Select`、`Dropdown`、`List` の WAI-ARIA が改善されました。
+- 、、、 の WAI-ARIA が改善されました。
#### 修正
-- `Textarea` にスタイル設定パーツがありません。
-- `TreeItem` の無効なスタイル。
-- `Snackbar` の不要なスタイルを削除しました。
-- `TreeItem` ホバー状態のビジュアル デザイン。
-- ビューを切り替えても `Calendar` のフォーカス状態が維持されません。
+- にスタイル設定パーツがありません。
+- の無効なスタイル。
+- の不要なスタイルを削除しました。
+- ホバー状態のビジュアル デザイン。
+- ビューを切り替えても のフォーカス状態が維持されません。
#### **{PackageCommonVerChanges-4.5.0}**
-- `Button` - Slotted icon size.
-- `ButtonGroup`
+- - Slotted icon size.
+-
- Updated Fluent theme look.
- Disabled state in Safari.
-- `Combo`/`Select` - Style issues.
-- `Slider`
+- / - Style issues.
+-
- Clicks on the slider track now use the track element width as a basis for the calculation.
- Input events are no longer emitted while continuously dragging the slider thumb and exceeding upper/lower bounds.
- When setting `upper-bound`/`lower-bound` before `min`/`max`, the slider will no longer overwrite the bound properties with the previous values of `min`/`max`.
- The `aria-label` bound to the slider thumb is no longer reset on consequent renders.
-- `Input`
+-
- Default validators are run synchronously.
- Style issues.
-- `DateTimeInput` - `setRangeText()` updates underlying value.
+- - `setRangeText()` updates underlying value.
### 追加
#### 非推奨
-`size` プロパティと属性は、すべてのコンポーネントで非推奨になりました。代わりに `--ig-size` CSS カスタム プロパティを使用してください。次の例では、`Avatar` コンポーネントのサイズを小さく設定します:
+`size` プロパティと属性は、すべてのコンポーネントで非推奨になりました。代わりに `--ig-size` CSS カスタム プロパティを使用してください。次の例では、 コンポーネントのサイズを小さく設定します:
-- `Rating` - `AllowReset` added. When enabled selecting the same value will reset the component. **Behavioral change**: In previous releases this was the default behavior of the rating component. Make sure to set `allowReset` if you need to keep this behavior in your application.
+- - added. When enabled selecting the same value will reset the component. **Behavioral change**: In previous releases this was the default behavior of the rating component. Make sure to set `allowReset` if you need to keep this behavior in your application.
#### 修正
- Safari でのコンボ項目の位置。
@@ -1348,36 +1350,36 @@ import { IgcLiveGridComponent } from 'igniteui-webcomponents-data-grids/ES5/igc-
- 遅延データ バインディングを使用したコンボ値と選択状態。
- さまざまなスタイルとテーマの修正と調整
#### **{PackageCommonVerChanges-4.4.0}**
-- Active item visual styles for `Dropdown`, `Select` and `Combo`.
-- `NavDrawer` - mini variant broken visual style.
+- Active item visual styles for , and .
+- - mini variant broken visual style.
### 追加
#### 変更
-- `Rating` - Fluent テーマのカラー。
-- `Stepper` - インジケーターのスタイルとカラー スキーマ。
+- - Fluent テーマのカラー。
+- - インジケーターのスタイルとカラー スキーマ。
#### 非推奨
- `IgcForm` コンポーネントは非推奨です。
-- `Input`:
+- :
- `minlength` プロパティは非推奨になり、次のメジャー バージョンで削除される予定です。代わりに `minLength` を使用してください。
- `maxlength` プロパティは非推奨になり、次のメジャー バージョンで削除される予定です。代わりに `maxLength` を使用してください。
- `readonly` プロパティは非推奨になり、次のメジャー バージョンで削除される予定です。代わりに `readOnly` を使用してください。
-- `MaskInput`:
+- :
- `readonly` プロパティは非推奨になり、次のメジャー バージョンで削除される予定です。代わりに `readOnly` を使用してください。
-- `DateTimeInput`:
+- :
- `readonly` プロパティは非推奨になり、次のメジャー バージョンで削除される予定です。代わりに `readOnly` を使用してください。
- `minValue` プロパティは非推奨になり、次のメジャー バージョンで削除される予定です。代わりに `min` を使用してください。
- `maxValue` プロパティは非推奨になり、次のメジャー バージョンで削除される予定です。代わりに `max` を使用してください。
-- `Rating`:
+- :
- `readonly` プロパティは非推奨になり、次のメジャー バージョンで削除される予定です。代わりに `readOnly` を使用してください。
#### 削除済
- デフォルトの属性を隠していた独自の `dir` 属性が削除されました。これは**互換性のある変更**です。
-- `Slider` - `ariaLabel` シャドウ プロパティ。これは**互換性のある変更**です。
-- `Checkbox` - `ariaLabelledBy` シャドウ属性。これは**互換性のある変更**です。
-- `Switch` - `ariaLabelledBy` シャドウ属性。これは**互換性のある変更**です。
-- `Radio` - `ariaLabelledBy` シャドウ属性。これは**互換性のある変更**です。
+- - `ariaLabel` シャドウ プロパティ。これは**互換性のある変更**です。
+- - `ariaLabelledBy` シャドウ属性。これは**互換性のある変更**です。
+- - `ariaLabelledBy` シャドウ属性。これは**互換性のある変更**です。
+- - `ariaLabelledBy` シャドウ属性。これは**互換性のある変更**です。
### 修正
@@ -1385,13 +1387,13 @@ import { IgcLiveGridComponent } from 'igniteui-webcomponents-data-grids/ES5/igc-
- New [Text Area](inputs/text-area.md) component.
- New [Button Group](inputs/button-group.md) component.
-- New `ToggleButton`.
-- `NavDrawer` now supports CSS transitions.
-- Position attribute for `Toast` and `Snackbar`.
+- New .
+- now supports CSS transitions.
+- Position attribute for and .
#### 追加
-- `Tree` - コンポーネントアニメーション。
+- - コンポーネントアニメーション。
- コンポーネントの境界半径は、そのスキーマから使用されます。
```css
@@ -1401,87 +1403,87 @@ igc-avatar {
```
#### 変更
-- `Combo`、`Input`、`Select` - スキーマのカラー。
-- `Dropdown` - スキーマのカラー。
-- `Icon` - テーマのスタイルとサイズが更新されました。
+- 、、 - スキーマのカラー。
+- - スキーマのカラー。
+- - テーマのスタイルとサイズが更新されました。
### 修正
#### **{PackageCommonVerChanges-4.3.0}**
- The following components are now Form Associated Custom Elements. They are automatically associated with a parent `
`
and behave like a browser-provided control:
- - `Button` & `IconButton`
- - `Checkbox`
- - `Combo`
- - `DateTimeInput`
- - `Input`
- - `MaskInput`
- - `Radio`
- - `Rating`
- - Single `Slider`
- - `Select`
- - `Switch`
-- `Stepper` now supports animations.
+ - &
+ -
+ -
+ -
+ -
+ -
+ -
+ -
+ - Single
+ -
+ -
+- now supports animations.
#### 追加
-- `Combo`:
+- :
- `matchDiacritics` をフィルタリング オプション プロパティに追加しました。デフォルトは **false** です。**true** に設定すると、フィルターはアクセント付き文字とその基本文字を区別します。それ以外の場合、文字列は正規化されてから照合されます。
- 現在の選択内容をデータ オブジェクトの配列として返す `selection` プロパティ。
-- `Card`: 明示的な高さのサポート
-- `Dialog`: アニメーションの追加
+- : 明示的な高さのサポート
+- : アニメーションの追加
#### 変更
-- `Combo`:
+- :
- `value` は読み取り専用ではなくなり、明示的に設定できるようになりました。value 属性は宣言型のバインディングもサポートしており、有効な JSON 文字列化配列を受け入れます。
#### 非推奨
-- `Select`: `sameWidth`、`positionStrategy`、`flip` は非推奨になりました。これらは次のメジャー リリースで削除される予定です。
+- : `sameWidth`、`positionStrategy`、`flip` は非推奨になりました。これらは次のメジャー リリースで削除される予定です。
#### 修正
-- `Select`: `prefix`/`suffix`/`helper-text` スロットが描画されません。
-- `Tabs`: ネストされたタブの選択。
-- `Dialog`: 背景は要素をオーバーレイしません。
-- `Dropdown`: 最初に開いた状態でのリストボックスの位置。
-- `Stepper`: 親コンテナ内で垂直方向に引き伸ばします。
-- `Navbar`: Fluent テーマの間違ったカラー。
+- : `prefix`/`suffix`/`helper-text` スロットが描画されません。
+- : ネストされたタブの選択。
+- : 背景は要素をオーバーレイしません。
+- : 最初に開いた状態でのリストボックスの位置。
+- : 親コンテナ内で垂直方向に引き伸ばします。
+- : Fluent テーマの間違ったカラー。
- 高さが指定されていない場合、アニメーション プレーヤーはエラーを発生します。
-- `DateTimeInput`: Chromium ベースのブラウザーでの Intl.DateTimeFormat の問題。
+- : Chromium ベースのブラウザーでの Intl.DateTimeFormat の問題。
### **{PackageCommonVerChanges-4.2.3}**
#### 非推奨
-- `Dialog` - `closeOnEscape` プロパティは非推奨となり、代わりに新しい `keepOpenOnEscape` プロパティが使用されます。
+- - `closeOnEscape` プロパティは非推奨となり、代わりに新しい `keepOpenOnEscape` プロパティが使用されます。
#### 修正
-- `Radio`- 選択されたフォーカス状態のカラー。
-- `IconButton` - 他のデザイン システム製品に合わせてアイコンのサイズを設定します。
-- `Chip` - Fluent および Material テーマのアウトライン スタイルが削除されました。
-- `Calendar` - 設定された値の日付へのナビゲーション。
-- `Tabs` - 親の高さを完全には取得しません。
+- - 選択されたフォーカス状態のカラー。
+- - 他のデザイン システム製品に合わせてアイコンのサイズを設定します。
+- - Fluent および Material テーマのアウトライン スタイルが削除されました。
+- - 設定された値の日付へのナビゲーション。
+- - 親の高さを完全には取得しません。
#### **{PackageCommonVerChanges-4.2.2}**
-- `Combo` - single selection not working in certain scenarios.
-- `Dropdown` - various styling fixes.
-- `IconButton` - border radius with ripple.
-- `IconButton` - fixed wrong color in Fluent theme.
-- `Input` - various styling fixes.
-- `TreeItem` - assign closest **igc-tree-item** ancestor as a parent.
-- `Tabs` - internal **hidden** styles and custom display property.
+- - single selection not working in certain scenarios.
+- - various styling fixes.
+- - border radius with ripple.
+- - fixed wrong color in Fluent theme.
+- - various styling fixes.
+- - assign closest **igc-tree-item** ancestor as a parent.
+- - internal **hidden** styles and custom display property.
### 非推奨
#### 修正
-- `Button` - UI の不一致。
-- `Calendar` - Fluent テーマの不一致。
-- `Combo` - API 経由の選択は検索リストでは機能しません。
-- `Dialog` - Fluent テーマの不一致。
-- `Input` - UI の不一致。
-- `Toast` - Fluent テーマの不一致。
+- - UI の不一致。
+- - Fluent テーマの不一致。
+- - API 経由の選択は検索リストでは機能しません。
+- - Fluent テーマの不一致。
+- - UI の不一致。
+- - Fluent テーマの不一致。
- defineAllComponents にコンポーネントがありません。
-- `Avatar`、`Badge`、`Button`、`IconButton` のホスト サイズが間違っています。
+- 、、、 のホスト サイズが間違っています。
#### **{PackageCommonVerChanges-4.2.1}**
-- `Combo`:
+- :
- `value` is no longer readonly and can be explicitly set. The value attribute also supports declarative binding,
accepting a valid JSON stringified array.
- `value` type changed from `string[]` to `ComboValue[]` where
@@ -1503,52 +1505,52 @@ interface IgcComboChangeEventArgs {
#### 修正
-- `Combo` - 単一選択モードでのフィルタリングでは一致する項目がアクティブ化されません。
+- - 単一選択モードでのフィルタリングでは一致する項目がアクティブ化されません。
#### **{PackageCommonVerChanges-4.2.0}**
-- `Select`: `prefix`/`suffix`/`helper-text` slots not being rendered.
-- `Tabs`: Nested tabs selection.
-- `Dialog`: Backdrop doesn't overlay elements.
-- `Dropdown`: Listbox position on initial open state.
-- `Stepper`: Stretch vertically in parent container.
-- `Navbar`: Wrong colors in fluent theme.
+- : `prefix`/`suffix`/`helper-text` slots not being rendered.
+- : Nested tabs selection.
+- : Backdrop doesn't overlay elements.
+- : Listbox position on initial open state.
+- : Stretch vertically in parent container.
+- : Wrong colors in fluent theme.
- Animation player throws errors when height is unspecified.
-- `DateTimeInput`: Intl.DateTimeFormat issues in Chromium based browsers.
+- : Intl.DateTimeFormat issues in Chromium based browsers.
### 追加
#### 修正
-- `Input` - UI の不一致。
-- `Badge` - `igc-icon` とフォント アイコンが正しく描画されません。
-- `Radio` - UI の不一致。
-- `NavDrawer` - 項目のマージンをオーバーライドできません。
+- - UI の不一致。
+- - `igc-icon` とフォント アイコンが正しく描画されません。
+- - UI の不一致。
+- - 項目のマージンをオーバーライドできません。
#### **{PackageCommonVerChanges-4.1.1}**
-- `Radio`- colors in selected focus state.
-- `IconButton` - set icon size to match other design system products.
-- `Chip` - removed outline styles for Fluent and Material themes.
-- `Calendar` - navigation to date on set value.
-- `Tabs` - not taking the full height of their parents.
+- - colors in selected focus state.
+- - set icon size to match other design system products.
+- - removed outline styles for Fluent and Material themes.
+- - navigation to date on set value.
+- - not taking the full height of their parents.
### 修正
#### **{PackageCommonVerChanges-4.1.0}**
-- `Button` - The `prefix`/`suffix` slots are no longer needed and will be removed in the next major release.
+- - The `prefix`/`suffix` slots are no longer needed and will be removed in the next major release.
#### 追加
- 新しい [Stepper](layouts/stepper.md) コンポーネント。
- 新しい [Combo](inputs/combo/overview.md) コンポーネント。
-- `MaskInput` - コンポーネント内のシンボルを削除するときにリテラル位置をスキップします。
+- - コンポーネント内のシンボルを削除するときにリテラル位置をスキップします。
### 修正
#### **{PackageCommonVerChanges-4.0.0}**
-- `Combo` - Matching item not activated on filtering in single selection mode.
+- - Matching item not activated on filtering in single selection mode.
### 変更
#### **{PackageCommonVerChanges-3.4.2}**
-- `Combo` - Single Selection mode via the `single-select` attribute.
+- - Single Selection mode via the `single-select` attribute.
#### 修正
- `DateRangeType` のインポート エラーを解決しました。
@@ -1556,15 +1558,15 @@ interface IgcComboChangeEventArgs {
### **{PackageCommonVerChanges-3.4.1}**
#### 変更
-- `Slider` - 最新の Fluent 仕様に合わせてテーマを更新しました。
-- `Calendar` - 週末の色を更新しました。
+- - 最新の Fluent 仕様に合わせてテーマを更新しました。
+- - 週末の色を更新しました。
### 修正
#### **{PackageCommonVerChanges-3.4.0}**
- New [Stepper](layouts/stepper.md) component.
- New [Combo](inputs/combo/overview.md) component.
-- `MaskInput` - Skip literal positions when deleting symbols in the component
+- - Skip literal positions when deleting symbols in the component
#### 追加
- 新しい [Dialog](notifications/dialog.md) コンポーネント。
@@ -1582,9 +1584,9 @@ interface IgcComboChangeEventArgs {
### 変更
#### 修正
-- `Dropdown` - トップレベルのイベント リスナーを破棄します。
-- `LinearProgress` - Safari での不確定なアニメーション。
-- `RadioGroup` - 子ラジオ コンポーネントの自動登録。
+- - トップレベルのイベント リスナーを破棄します。
+- - Safari での不確定なアニメーション。
+- - 子ラジオ コンポーネントの自動登録。
### **{PackageCommonVerChanges-3.3.0}**
@@ -1595,8 +1597,8 @@ interface IgcComboChangeEventArgs {
- テーマのタイポグラフィ スタイル。
#### 変更
-- `Rating` - 単一選択と空のシンボルのサポートが追加されました。
-- `Slider` - スライダー ステップの描画を改善しました。
+- - 単一選択と空のシンボルのサポートが追加されました。
+- - スライダー ステップの描画を改善しました。
- コンポーネントは、`defineComponents` で登録されると、その依存関係を自動登録するようになりました。
### 修正
@@ -1609,29 +1611,29 @@ interface IgcComboChangeEventArgs {
- 新しい [MaskInput](inputs/mask-input.md) コンポーネント。
- 新しい [ExpansionPanel](layouts/expansion-panel.md) コンポーネント。
- 新しい [Tree](grids/tree.md) コンポーネント。
-- `Rating` - シンボルのサイズを制御するために、`selected` CSS パーツと公開された CSS 変数を追加しました。
-- `IconButton` - スロット化されたコンテンツを許可します。
+- - シンボルのサイズを制御するために、`selected` CSS パーツと公開された CSS 変数を追加しました。
+- - スロット化されたコンテンツを許可します。
### 修正
#### **{PackageCommonVerChanges-3.1.0}**
-- `Tree` - Removed theme-specified height.
+- - Removed theme-specified height.
#### 追加
-- `Chip`: `prefix` と `suffix` のスロットを追加しました。
-- `Snackbar`: `toggle` メソッドを追加しました。
+- : `prefix` と `suffix` のスロットを追加しました。
+- : `toggle` メソッドを追加しました。
### 非推奨
#### 修正
-- `Chip`:
+- :
- 内部アイコンを自動読み込みます。
- 選択したチップの位置がずれています。
- パッケージ: ESM 内部インポート パス。
#### **{PackageCommonVerChanges-3.0.0}**
-- `Rating` - Added support for single selection and empty symbols.
-- `Slider` - Improved slider steps rendering.
+- - Added support for single selection and empty symbols.
+- - Improved slider steps rendering.
- Components will now auto register their dependencies when they are registered in `defineComponents`
@@ -1654,20 +1656,20 @@ Check the official [documentation](https://www.infragistics.com/products/ignite-
#### 追加
- 新しい [DropDown](inputs/dropdown.md) コンポーネント。
-- `Calendar`: アクティブ日付は属性を介して設定できます。
+- : アクティブ日付は属性を介して設定できます。
#### **{PackageCommonVerChanges-2.1.1}**
-- `NavDrawer` - Various styles fixes.
+- - Various styles fixes.
- Buttons - Vertical align and focus management.
-- `Input` - Overflow for `suffix`/`prefix`.
-- `Switch` - Collapse with small sizes.
-- `List` - Overflow behavior.
+- - Overflow for `suffix`/`prefix`.
+- - Collapse with small sizes.
+- - Overflow behavior.
### 追加
#### **{PackageCommonVerChanges-2.1.0}**
-- `Chip`: Added `prefix` and `suffix` slots.
-- `Snackbar`: Added `toggle` method.
+- : Added `prefix` and `suffix` slots.
+- : Added `toggle` method.
#### 追加
- 新しい [LinearProgress](inputs/linear-progress.md) コンポーネント。
@@ -1679,7 +1681,7 @@ Check the official [documentation](https://www.infragistics.com/products/ignite-
- コンポーネントテーマは、`configureTheme(theme: Theme)` 関数を呼び出すことで実行時に変更できます。
#### **{PackageCommonVerChanges-2.0.0}**
-- `Chip`:
+- :
- Auto load internal icons.
- Selected chip is misaligned.
- Package: ESM internal import paths.
@@ -1688,9 +1690,9 @@ Check the official [documentation](https://www.infragistics.com/products/ignite-
#### 変更
- チェックボックス/スイッチの検証状態を修正しました。
-- `Calendar` の `value: Date | Date[]` プロパティを 2 つのプロパティに分割しました: `value: Date` おとび `values: Date[]`。``
-- `Calendar` の `hasHeader` プロパティと `has-header` 属性をそれぞれ `hideHeader` と `hide-header` に置き換えました。
-- `Card` の `outlined` プロパティを `elevated` に置き換えました。
+- の `value: Date | Date[]` プロパティを 2 つのプロパティに分割しました: `value: Date` おとび `values: Date[]`。``
+- の `hasHeader` プロパティと `has-header` 属性をそれぞれ `hideHeader` と `hide-header` に置き換えました。
+- の `outlined` プロパティを `elevated` に置き換えました。
### 削除済
@@ -1715,7 +1717,7 @@ Example:
### **{PackageDockManagerVerChanges-1.14.4}**
#### 非推奨
-- `SplitPane` の `IsMaximized` は非推奨です。分割ペイン レベルで isMaximized を true に設定しても、分割ペインはコンテナーとしてのみ機能し、最大化されて表示される実際のコンテンツがないため、実際の効果はありません。代わりに、`TabGroupPane` および/または `ContentPane` の `IsMaximized` プロパティを使用してください。
+- の は非推奨です。分割ペイン レベルで isMaximized を true に設定しても、分割ペインはコンテナーとしてのみ機能し、最大化されて表示される実際のコンテンツがないため、実際の効果はありません。代わりに、 および/または の プロパティを使用してください。
### **{PackageDockManagerVerChanges-1.14.3}**
@@ -1725,9 +1727,9 @@ Example:
#### **{PackageDockManagerVerChanges-1.14.2}**
- Fix checkbox/switch validity status
-- Split `Calendar`'s `value: Date | Date[]` property into two properties - `value: Date` and `values: Date[]`
-- Replaced `Calendar`'s `hasHeader` property & `has-header` attribute with `hideHeader` & `hide-header` respectively.
-- Replaced `Card`'s `outlined` property with `elevated`.
+- Split 's `value: Date | Date[]` property into two properties - `value: Date` and `values: Date[]`
+- Replaced 's `hasHeader` property & `has-header` attribute with `hideHeader` & `hide-header` respectively.
+- Replaced 's `outlined` property with `elevated`.
#### 修正
- すばやくドラッグして、パネルをドック マネージャーの境界内に制限します。
@@ -1797,7 +1799,7 @@ Initial release of Ignite UI Web Components
#### 機能拡張
- `splitterResizeStart` イベントと `splitterResizeEnd` イベントにペイン情報を含めます。
-- `DockManager` がクラスとしてエクスポートされるようになりました。
+- がクラスとしてエクスポートされるようになりました。
### 修正
@@ -1859,15 +1861,15 @@ Initial release of Ignite UI Web Components
#### 新機能
- カスタマイズ可能なフローティング ペイン ヘッダー。
-- ペインごとの `Disabled` プロパティ。
-- `DocumentOnly` プロパティは、コンテンツ ペインをドキュメント ホスト内にのみドッキングできるようにします。
-- 分割ペインとタブ グループ ペインの空の領域を表示できるようにする `AllowEmpty` プロパティ。
-- ドック マネージャーの `DisableKeyboardNavigation` プロパティ。
+- ペインごとの プロパティ。
+- プロパティは、コンテンツ ペインをドキュメント ホスト内にのみドッキングできるようにします。
+- 分割ペインとタブ グループ ペインの空の領域を表示できるようにする プロパティ。
+- ドック マネージャーの プロパティ。
### 修正
#### **{PackageDockManagerVerChanges-1.6.0}**
-- Add `ShowHeaderIconOnHover` property.
+- Add property.
#### 新機能
- ドック マネージャーのペインとタブをカスタマイズします。
@@ -1909,7 +1911,7 @@ Initial release of Ignite UI Web Components
### 新機能
#### **{PackageDockManagerVerChanges-1.2.0}**
-- `AllowMaximize` property per pane.
+- property per pane.
#### 新機能
- アクティブ ペイン。
diff --git a/docs/xplat/src/content/jp/components/general-changelog-dv.mdx b/docs/xplat/src/content/jp/components/general-changelog-dv.mdx
index c56437cd3e..fa3ed64aee 100644
--- a/docs/xplat/src/content/jp/components/general-changelog-dv.mdx
+++ b/docs/xplat/src/content/jp/components/general-changelog-dv.mdx
@@ -18,6 +18,8 @@ import chartdefaults4 from '@xplat-images/chartDefaults4.png';
import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
+import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
+
# {ProductName} 変更ログ
{ProductName} の各バージョンのすべての重要な変更は、このページに記載されています。
@@ -79,9 +81,9 @@ DataPieChart および ProportionalCategoryAngleAxis に OthersCategoryBrush と
#### ユーザー注釈
-{ProductName} では、ユーザー注釈機能により、実行時に `DataChart` にスライス注釈、ストリップ注釈、ポイント注釈を追加できるようになりました。これにより、エンドユーザーは、スライス注釈を使用して会社の四半期レポートなどの単一の重要イベントを強調したり、ストリップ注釈を使用して期間を持つイベントを示したりすることで、プロットに詳細を追加できます。ポイント注釈またはこれら 3 つの任意の組み合わせを使用して、プロットされたシリーズ上の個々のポイントを呼び出すこともできます。
+{ProductName} では、ユーザー注釈機能により、実行時に にスライス注釈、ストリップ注釈、ポイント注釈を追加できるようになりました。これにより、エンドユーザーは、スライス注釈を使用して会社の四半期レポートなどの単一の重要イベントを強調したり、ストリップ注釈を使用して期間を持つイベントを示したりすることで、プロットに詳細を追加できます。ポイント注釈またはこれら 3 つの任意の組み合わせを使用して、プロットされたシリーズ上の個々のポイントを呼び出すこともできます。
-これは、`Toolbar` のデフォルトのツールと統合されています。
+これは、 のデフォルトのツールと統合されています。
@@ -89,8 +91,8 @@ DataPieChart および ProportionalCategoryAngleAxis に OthersCategoryBrush と
軸注釈が自動で衝突を検出し、適切に収まるよう切り詰めます。この機能を有効にするには、次のプロパティを設定します:
-- `ShouldAvoidAnnotationCollisions`
-- `ShouldAutoTruncateAnnotations`
+-
+-
### {PackageMaps} (地理マップ)
@@ -132,15 +134,15 @@ DataPieChart および ProportionalCategoryAngleAxis に OthersCategoryBrush と
#### 対応軸
-X 軸と Y 軸に `CompanionAxis` プロパティが追加され、既存の軸を簡単に複製できるようになりました。`CompanionAxisEnabled` プロパティを有効にすると、複製された軸はチャートの反対側に配置され、そこから各軸プロパティを設定できます。
+X 軸と Y 軸に `CompanionAxis` プロパティが追加され、既存の軸を簡単に複製できるようになりました。 プロパティを有効にすると、複製された軸はチャートの反対側に配置され、そこから各軸プロパティを設定できます。
#### RadialPieSeries インセット アウトライン
-`RadialPieSeries` のアウトライン レンダリング方法を制御するために `UseInsetOutlines` プロパティが追加されました。**true** に設定すると、アウトラインがスライス形状の内側に描画され、**false** (既定値) に設定すると、アウトラインはスライス形状の端に半分内側・半分外側で描画されます。
+ のアウトライン レンダリング方法を制御するために プロパティが追加されました。**true** に設定すると、アウトラインがスライス形状の内側に描画され、**false** (既定値) に設定すると、アウトラインはスライス形状の端に半分内側・半分外側で描画されます。
**重大な変更**
-- `ChartMouseEventArgs` クラスの `PlotAreaPosition` プロパティと `ChartPosition` プロパティが逆になっている問題が修正されました。これにより、`PlotAreaPosition` と `ChartPosition` が返す値が変更されます。
+- クラスの プロパティと プロパティが逆になっている問題が修正されました。これにより、 と が返す値が変更されます。
### 機能拡張
@@ -152,11 +154,11 @@ X 軸と Y 軸に `CompanionAxis` プロパティが追加され、既存の軸
- DataToolTipLayer、ItemToolTipLayer、CategoryToolTipLayer にスタイル設定用の新しいプロパティが追加されました: `ToolTipBackground`、`ToolTipBorderBrush`、および `ToolTipBorderThickness`。
-- DataLegend にスタイル設定用の新しいプロパティが追加されました: `ContentBackground`、`ContentBorderBrush`、および `ContentBorderThickness`。`ContentBorderBrush` と `ContentBorderThickness` はそれぞれ既定で transparent と 0 に設定されているため、境界線を表示するにはこれらのプロパティを設定する必要があります。
+- DataLegend にスタイル設定用の新しいプロパティが追加されました: 、、および 。 と はそれぞれ既定で transparent と 0 に設定されているため、境界線を表示するにはこれらのプロパティを設定する必要があります。
-- マウスのワールド相対位置を提供する `WorldPosition` という新しいプロパティが `ChartMouseEventArgs` に追加されました。この位置は、軸空間内の X 軸と Y 軸の両方に対して 0 から 1 の間の値になります。
+- マウスのワールド相対位置を提供する という新しいプロパティが に追加されました。この位置は、軸空間内の X 軸と Y 軸の両方に対して 0 から 1 の間の値になります。
-- `SeriesViewer` と `DomainChart` に `HighlightingFadeOpacity` が追加されました。ハイライト表示されたシリーズに適用される不透明度を設定できます。
+- と に が追加されました。ハイライト表示されたシリーズに適用される不透明度を設定できます。
- ドメイン チャートの `CalloutLabelUpdating` イベントを公開しました。
@@ -212,11 +214,11 @@ X 軸と Y 軸に `CompanionAxis` プロパティが追加され、既存の軸
- データ注釈スライス レイヤー
- データ注釈ストリップ レイヤー
-- [データ ツールチップ](charts/features/chart-data-tooltip.md)と[データ 凡例](charts/features/chart-data-legend.md)では、ツールチップまたは凡例のコンテンツをテーブルまたは垂直レイアウト構造でレイアウトするために使用できる `LayoutMode` プロパティが公開されています。
+- [データ ツールチップ](charts/features/chart-data-tooltip.md)と[データ 凡例](charts/features/chart-data-legend.md)では、ツールチップまたは凡例のコンテンツをテーブルまたは垂直レイアウト構造でレイアウトするために使用できる プロパティが公開されています。
-- チャートの `DefaultInteraction` プロパティが更新され、新しい列挙体 `DragSelect` が含まれるようになりました。これにより、ドラッグされたプレビュー Rect は、その中に含まれるポイントを選択します。 (ベータ版)
+- チャートの プロパティが更新され、新しい列挙体 `DragSelect` が含まれるようになりました。これにより、ドラッグされたプレビュー Rect は、その中に含まれるポイントを選択します。 (ベータ版)
-- [ValueOverlay と ValueLayer](charts/features/chart-overlays.md) は、上記にリストした [チャート データ注釈](charts/features/chart-data-annotations.md)に加えて、プロット領域に追加の注釈テキストをオーバーレイするために使用できる `OverlayText` プロパティを公開するようになりました。これらの注釈の外観は、OverlayText プレフィックスが付いた多くのプロパティを使用して構成できます。たとえば、`OverlayTextBrush` プロパティはオーバーレイ テキストの色を構成します。 (ベータ版)
+- [ValueOverlay と ValueLayer](charts/features/chart-overlays.md) は、上記にリストした [チャート データ注釈](charts/features/chart-data-annotations.md)に加えて、プロット領域に追加の注釈テキストをオーバーレイするために使用できる プロパティを公開するようになりました。これらの注釈の外観は、OverlayText プレフィックスが付いた多くのプロパティを使用して構成できます。たとえば、`OverlayTextBrush` プロパティはオーバーレイ テキストの色を構成します。 (ベータ版)
- [トレンドライン レイヤー](charts/features/chart-trendlines.md) シリーズ タイプを使用すると、トレンド ライン レイヤーごとに 1 つのトレンド ラインを特定のシリーズに適用できます。これにより、チャートに複数の [TrendlineLayer](charts/features/chart-overlays.md) シリーズ タイプを使用できるため、単一のシリーズで複数のトレンド ラインを使用できるようになります。
@@ -253,9 +255,9 @@ X 軸と Y 軸に `CompanionAxis` プロパティが追加され、既存の軸
#### Toolbar
-- `Toolbar` と `ToolPanel` に新しい `GroupHeaderTextStyle` プロパティを追加しました。設定されている場合、すべての `ToolActionGroupHeader` アクションに適用されます。
-- タイトル テキストの水平方向の配置を制御する `TitleHorizontalAlignment` という新しいプロパティを `ToolAction` に追加しました。
-- `ToolActionSubPanel` に、パネル内の項目間の間隔を制御する `ItemSpacing` という新しいプロパティを追加しました。
+- と に新しい `GroupHeaderTextStyle` プロパティを追加しました。設定されている場合、すべての アクションに適用されます。
+- タイトル テキストの水平方向の配置を制御する という新しいプロパティを に追加しました。
+- に、パネル内の項目間の間隔を制御する という新しいプロパティを追加しました。
### バグ修正
@@ -293,11 +295,11 @@ X 軸と Y 軸に `CompanionAxis` プロパティが追加され、既存の軸
## **{PackageVerChanges-24-1-SEP}**
-- [データ円チャート](charts/types/data-pie-chart.md) - `DataPieChart` は円ャートを表示する新しいコンポーネントです。このコンポーネントは、`CategoryChart` と同様に動作し、基になるデータ モデルのプロパティを自動的に検出しながら、ItemLegend コンポーネントを介して選択、ハイライト表示、アニメーション、凡例のサポートを可能にします。
+- [データ円チャート](charts/types/data-pie-chart.md) - は円ャートを表示する新しいコンポーネントです。このコンポーネントは、 と同様に動作し、基になるデータ モデルのプロパティを自動的に検出しながら、ItemLegend コンポーネントを介して選択、ハイライト表示、アニメーション、凡例のサポートを可能にします。
-- [比例カテゴリ角度軸](charts/types/radial-chart.md) - スライスをプロットするための、`DataChart` のラジアル円シリーズの新しい軸。円チャートに似ており、データ ポイントが円グラフ内のセグメントとして表されます。
+- [比例カテゴリ角度軸](charts/types/radial-chart.md) - スライスをプロットするための、 のラジアル円シリーズの新しい軸。円チャートに似ており、データ ポイントが円グラフ内のセグメントとして表されます。
-- `Toolbar`
+-
- 新しい ToolActionCheckboxList
選択用のチェックボックスを備えた項目のコレクションを表示する新しい CheckboxList ToolAction。ToolAction CheckboxList 内のグリッドの高さは 5 項目まで大きくなり、その後スクロールバーが表示されます。
@@ -316,78 +318,78 @@ X 軸と Y 軸に `CompanionAxis` プロパティが追加され、既存の軸
### {PackageCharts} (チャート)
-- [データ凡例のグループ化](charts/features/chart-data-legend.md#{PlatformLower}-データ凡例のグループ化) と [データ ツールチップのグループ化](charts/features/chart-data-tooltip.md#{PlatformLower}-データ-チャートのデータ-ツールチップのグループ化) - 新しいグループ化機能が追加されました。`GroupRowVisible` プロパティは、各シリーズのグループ化を切り替え、オプトインすると `DataLegendGroup` プロパティを介してグループ テキストを割り当てることができます 同じ値が複数のシリーズに適用されている場合、それらはグループ化されて表示されます。すべてのユーザー向けに分類および整理する必要がある大規模なデータセットに役立ちます。
+- [データ凡例のグループ化](charts/features/chart-data-legend.md#{PlatformLower}-データ凡例のグループ化) と [データ ツールチップのグループ化](charts/features/chart-data-tooltip.md#{PlatformLower}-データ-チャートのデータ-ツールチップのグループ化) - 新しいグループ化機能が追加されました。 プロパティは、各シリーズのグループ化を切り替え、オプトインすると プロパティを介してグループ テキストを割り当てることができます 同じ値が複数のシリーズに適用されている場合、それらはグループ化されて表示されます。すべてのユーザー向けに分類および整理する必要がある大規模なデータセットに役立ちます。
-- [チャートの選択](charts/features/chart-data-selection.md) - 新しいシリーズ選択のスタイル設定。これは、`CategoryChart` および `DataChart` のすべてのカテゴリ、財務、およびラジアル シリーズに広く採用されています。シリーズはクリックして異なる色で表示したり、明るくしたり、薄くしたり、フォーカスのアウトラインを表示したりできます。個々のシリーズまたはデータ項目全体を通じて影響を受ける項目を管理します。
-複数のシリーズとマーカーがサポートされています。特定のデータ項目の値間のさまざまな相違点や類似点を示すのに役立ちます。また、`SelectedSeriesItemsChanged` イベントと `SelectedSeriesItems` は、選択内容に基づいたデータ分析を行うポップアップやその他の画面など、アプリケーション内で実行できるその他のアクションを取り巻く堅牢なビジネス要件を構築するための追加の支援として利用できます。
+- [チャートの選択](charts/features/chart-data-selection.md) - 新しいシリーズ選択のスタイル設定。これは、 および のすべてのカテゴリ、財務、およびラジアル シリーズに広く採用されています。シリーズはクリックして異なる色で表示したり、明るくしたり、薄くしたり、フォーカスのアウトラインを表示したりできます。個々のシリーズまたはデータ項目全体を通じて影響を受ける項目を管理します。
+複数のシリーズとマーカーがサポートされています。特定のデータ項目の値間のさまざまな相違点や類似点を示すのに役立ちます。また、`SelectedSeriesItemsChanged` イベントと は、選択内容に基づいたデータ分析を行うポップアップやその他の画面など、アプリケーション内で実行できるその他のアクションを取り巻く堅牢なビジネス要件を構築するための追加の支援として利用できます。
-- [ツリーマップのハイライト表示](charts/types/treemap-chart.md#{PlatformLower}-リーマップのハイライト表示) - ツリー マップの項目のマウスオーバーによるハイライト表示を構成できる `HighlightingMode` プロパティが公開されました。このプロパティには 2 つのオプションがあります: `Brighten` では、マウスを置いた項目にのみハイライト表示が適用され、`FadeOthers` では、マウスホバーした項目のハイライト表示はそのままで、それ以外はすべてフェードアウトします。このハイライト表示はアニメーション化されており、`HighlightingTransitionDuration` プロパティを使用して制御できます。
+- [ツリーマップのハイライト表示](charts/types/treemap-chart.md#{PlatformLower}-リーマップのハイライト表示) - ツリー マップの項目のマウスオーバーによるハイライト表示を構成できる プロパティが公開されました。このプロパティには 2 つのオプションがあります: `Brighten` では、マウスを置いた項目にのみハイライト表示が適用され、`FadeOthers` では、マウスホバーした項目のハイライト表示はそのままで、それ以外はすべてフェードアウトします。このハイライト表示はアニメーション化されており、 プロパティを使用して制御できます。
-- [ツリーマップのパーセントベースのハイライト表示](charts/types/treemap-chart.md#{PlatformLower}-ツリーマップのパーセントベースのハイライト表示) - 新しいパーセントベースのハイライト表示により、ノードはコレクションの進行状況またはサブセットを表すことができます。外観は、データ項目のメンバーによって、または新しい `HighlightedItemsSource` を指定することによって、特定の値までの背景色の塗りつぶしとして表示されます。`HighlightedValuesDisplayMode` で切り替えることができ、`FillBrushes` でスタイルを設定できます。
+- [ツリーマップのパーセントベースのハイライト表示](charts/types/treemap-chart.md#{PlatformLower}-ツリーマップのパーセントベースのハイライト表示) - 新しいパーセントベースのハイライト表示により、ノードはコレクションの進行状況またはサブセットを表すことができます。外観は、データ項目のメンバーによって、または新しい を指定することによって、特定の値までの背景色の塗りつぶしとして表示されます。 で切り替えることができ、`FillBrushes` でスタイルを設定できます。
-- `Toolbar` - 選択した特定のツールの周囲に境界線を描くための ToolAction の新しい `IsHighlighted` オプション。
+- - 選択した特定のツールの周囲に境界線を描くための ToolAction の新しい オプション。
### {PackageGauges} (ゲージ)
-- `RadialGauge`
- - ハイライト針の新しいラベル。`HighlightLabelText` と `HighlightLabelSnapsToNeedlePivot` および、その他の HighlightLabel の多くのスタイル関連プロパティが追加されました。
+-
+ - ハイライト針の新しいラベル。 と および、その他の HighlightLabel の多くのスタイル関連プロパティが追加されました。
## **{PackageVerChanges-24-1-JUN}**
### {PackageCharts} (チャート)
-- [データ凡例のグループ化](charts/features/chart-data-legend.md#{PlatformLower}-データ凡例のグループ化) と [データ ツールチップのグループ化](charts/features/chart-data-tooltip.md#{PlatformLower}-データ-チャートのデータ-ツールチップのグループ化) - 新しいグループ化機能が追加されました。`GroupRowVisible` プロパティは、各シリーズのグループ化を切り替え、オプトインすると `DataLegendGroup` プロパティを介してグループ テキストを割り当てることができます 同じ値が複数のシリーズに適用されている場合、それらはグループ化されて表示されます。すべてのユーザー向けに分類および整理する必要がある大規模なデータセットに役立ちます。
+- [データ凡例のグループ化](charts/features/chart-data-legend.md#{PlatformLower}-データ凡例のグループ化) と [データ ツールチップのグループ化](charts/features/chart-data-tooltip.md#{PlatformLower}-データ-チャートのデータ-ツールチップのグループ化) - 新しいグループ化機能が追加されました。 プロパティは、各シリーズのグループ化を切り替え、オプトインすると プロパティを介してグループ テキストを割り当てることができます 同じ値が複数のシリーズに適用されている場合、それらはグループ化されて表示されます。すべてのユーザー向けに分類および整理する必要がある大規模なデータセットに役立ちます。
-- [チャートの選択](charts/features/chart-data-selection.md) - 新しいシリーズ選択のスタイル設定。これは、`CategoryChart` および `DataChart` のすべてのカテゴリ、財務、およびラジアル シリーズに広く採用されています。シリーズはクリックして異なる色で表示したり、明るくしたり、薄くしたり、フォーカスのアウトラインを表示したりできます。個々のシリーズまたはデータ項目全体を通じて影響を受ける項目を管理します。
-複数のシリーズとマーカーがサポートされています。特定のデータ項目の値間のさまざまな相違点や類似点を示すのに役立ちます。また、`SelectedSeriesItemsChanged` イベントと `SelectedSeriesItems` は、選択内容に基づいたデータ分析を行うポップアップやその他の画面など、アプリケーション内で実行できるその他のアクションを取り巻く堅牢なビジネス要件を構築するための追加の支援として利用できます。
+- [チャートの選択](charts/features/chart-data-selection.md) - 新しいシリーズ選択のスタイル設定。これは、 および のすべてのカテゴリ、財務、およびラジアル シリーズに広く採用されています。シリーズはクリックして異なる色で表示したり、明るくしたり、薄くしたり、フォーカスのアウトラインを表示したりできます。個々のシリーズまたはデータ項目全体を通じて影響を受ける項目を管理します。
+複数のシリーズとマーカーがサポートされています。特定のデータ項目の値間のさまざまな相違点や類似点を示すのに役立ちます。また、`SelectedSeriesItemsChanged` イベントと は、選択内容に基づいたデータ分析を行うポップアップやその他の画面など、アプリケーション内で実行できるその他のアクションを取り巻く堅牢なビジネス要件を構築するための追加の支援として利用できます。
### {PackageGauges} (ゲージ)
-- `RadialGauge`
- - ハイライト針の新しいラベル。`HighlightLabelText` と `HighlightLabelSnapsToNeedlePivot` および、その他の HighlightLabel の多くのスタイル関連プロパティが追加されました。
+-
+ - ハイライト針の新しいラベル。 と および、その他の HighlightLabel の多くのスタイル関連プロパティが追加されました。
## **{PackageVerChanges-23-2-MAR}**
### {PackageCharts}
-- `InitialFilter` プロパティによる新しいデータ フィルタリング。フィルター式を適用して、チャート データをレコードのサブセットにフィルターします。大規模なデータのドリルダウンに使用できます。
+- プロパティによる新しいデータ フィルタリング。フィルター式を適用して、チャート データをレコードのサブセットにフィルターします。大規模なデータのドリルダウンに使用できます。
## {PackageGauges}
### **{PackageVerChanges-23-2-JAN}**
- Save tool action has been added to save the chart to an image via the clipboard.
-- Vertical orientation has been added via the toolbar's `Orientation` property. By default the toolbar is horizontal, now the toolbar can be shown in vertical orientation where the tools will popup to the left/right respectfully.
+- Vertical orientation has been added via the toolbar's property. By default the toolbar is horizontal, now the toolbar can be shown in vertical orientation where the tools will popup to the left/right respectfully.
- Custom SVG icons support was added via the toolbar's `renderImageFromText` method, further enhancing custom tool creation.
## {PackageCharts} (チャート)
### **{PackageVerChanges-23-2}**
-- [Toolbar](menus/toolbar.md) - This component is a companion container for UI operations to be used primarily with our charting components. The toolbar will dynamically update with a preset of properties and tool items when linked to our `DataChart` or `CategoryChart` components. You'll be able to create custom tools for your project allowing end users to provide changes, offering an endless amount of customization.
+- [Toolbar](menus/toolbar.md) - This component is a companion container for UI operations to be used primarily with our charting components. The toolbar will dynamically update with a preset of properties and tool items when linked to our or components. You'll be able to create custom tools for your project allowing end users to provide changes, offering an endless amount of customization.
### {PackageGrids} - Toolbar -
- クリップボードを介してチャートを画像に保存するための保存ツール アクションが追加されました。
-- ツールバーの `Orientation` プロパティを介して垂直方向が追加されました。デフォルトでは、ツールバーは水平方向ですが、ツールバーを垂直方向に表示できるようになり、ツールが左右にポップアップ表示されます。
+- ツールバーの プロパティを介して垂直方向が追加されました。デフォルトでは、ツールバーは水平方向ですが、ツールバーを垂直方向に表示できるようになり、ツールが左右にポップアップ表示されます。
- ツールバーの `renderImageFromText` メソッドを介してカスタム SVG アイコンのサポートが追加され、カスタム ツールの作成がさらに強化されました。
-- It is now possible to apply a **dash array** to the different parts of the series of the `DataChart`. You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
+- It is now possible to apply a **dash array** to the different parts of the series of the . You can apply this to the [series](charts/types/line-chart.md#{PlatformLower}-styling-line-chart) plotted in the chart, the [gridlines](charts/features/chart-axis-gridlines.md#{PlatformLower}-axis-gridlines-properties) of the chart, and the [trendlines](charts/features/chart-trendlines.md#{PlatformLower}-chart-trendlines-dash-array-example) of the series plotted in the chart.
## **{PackageVerChanges-23-1}**
- Angular 16 support.
## 新しいコンポーネント
-- [Toolbar](menus/toolbar.md) - このコンポーネントは、主にチャート コンポーネントで使用される UI 操作のコンパニオン コンテナーです。ツールバーは、`DataChart` または `CategoryChart` コンポーネントにリンクされると、プロパティとツール項目のプリセットで動的に更新されます。プロジェクト用のカスタム ツールを作成して、エンド ユーザーが変更を提供できるようになり、無限のカスタマイズが可能になります。
+- [Toolbar](menus/toolbar.md) - このコンポーネントは、主にチャート コンポーネントで使用される UI 操作のコンパニオン コンテナーです。ツールバーは、 または コンポーネントにリンクされると、プロパティとツール項目のプリセットで動的に更新されます。プロジェクト用のカスタム ツールを作成して、エンド ユーザーが変更を提供できるようになり、無限のカスタマイズが可能になります。
## {PackageCharts} (チャート)
-- [ValueLayer](charts/features/chart-overlays.md#{PlatformLower}-value-layer) - `ValueLayer` という名前の新しいシリーズ タイプが公開されました。これにより、Maximum、Minimum、Average など、プロットされたデータのさまざまな焦点のオーバーレイを描画できます。これは、新しい `ValueLines` コレクションに追加することで、`CategoryChart` と `FinancialChart` に適用されます。
+- [ValueLayer](charts/features/chart-overlays.md#{PlatformLower}-value-layer) - という名前の新しいシリーズ タイプが公開されました。これにより、Maximum、Minimum、Average など、プロットされたデータのさまざまな焦点のオーバーレイを描画できます。これは、新しい コレクションに追加することで、 と に適用されます。
-- **ダッシュ配列**を `DataChart` のシリーズのさまざまな部分に適用できるようになりました。これは、チャートにプロットされた[シリーズ](charts/types/line-chart.md#{PlatformLower}-折れ線チャートのスタイル設定)、チャートの[グリッド線](charts/features/chart-axis-gridlines.md#{PlatformLower}-軸グリッド線のプロパティ)、およびチャートにプロットされたシリーズの[トレンドライン](charts/features/chart-trendlines.md#{PlatformLower}-チャート-トレンドラインのダッシュ配列の例)に適用できます。
+- **ダッシュ配列**を のシリーズのさまざまな部分に適用できるようになりました。これは、チャートにプロットされた[シリーズ](charts/types/line-chart.md#{PlatformLower}-折れ線チャートのスタイル設定)、チャートの[グリッド線](charts/features/chart-axis-gridlines.md#{PlatformLower}-軸グリッド線のプロパティ)、およびチャートにプロットされたシリーズの[トレンドライン](charts/features/chart-trendlines.md#{PlatformLower}-チャート-トレンドラインのダッシュ配列の例)に適用できます。
-The Chart's [Aggregation](charts/features/chart-data-aggregations.md) will not work when using `IncludedProperties` | `ExcludedProperties` because these properties are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
+The Chart's [Aggregation](charts/features/chart-data-aggregations.md) will not work when using | because these properties are meant for non-aggregated data. Once you attempt to aggregate data these properties should no longer be used. The reason it does not work is because aggregation replaces the collection that is passed to the chart for render. The include/exclude properties are designed to filter in/out properties of that data and those properties no longer exist in the new aggregated collection.
## **{PackageVerChanges-22-2.2}**
### **{PackageVerChanges-22-2.1}**
@@ -404,29 +406,29 @@ The Chart's [Aggregation](charts/features/chart-data-aggregations.md) will not w
This release introduces a few improvements and simplifications to visual design and configuration options for the geographic map and all chart components.
-- Changed `YAxisLabelLocation` property's type to **YAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart` and `CategoryChart`
-- Changed `XAxisLabelLocation` property's type to **XAxisLabelLocation** from **AxisLabelLocation** in `FinancialChart`
-- Added `XAxisLabelLocation` property to `CategoryChart`
-- Added support for representing geographic series of `GeographicMap` in a legend
-- Added crosshair lines by default in `FinancialChart` and `CategoryChart`
-- Added crosshair annotations by default in `FinancialChart` and `CategoryChart`
-- Added final value annotation by default in `FinancialChart`
+- Changed property's type to **YAxisLabelLocation** from **AxisLabelLocation** in and
+- Changed property's type to **XAxisLabelLocation** from **AxisLabelLocation** in
+- Added property to
+- Added support for representing geographic series of in a legend
+- Added crosshair lines by default in and
+- Added crosshair annotations by default in and
+- Added final value annotation by default in
- Added new properties in Category Chart and Financial Chart:
- - `CrosshairsLineThickness` and other properties for customizing crosshairs lines
- - `CrosshairsAnnotationXAxisBackground` and other properties for customizing crosshairs annotations
- - `FinalValueAnnotationsBackground` and other properties for customizing final value annotations
- - `AreaFillOpacity` that allow changing opacity of series fill (e.g. Area chart)
- - `MarkerThickness` that allows changing thickness of markers
+ - and other properties for customizing crosshairs lines
+ - and other properties for customizing crosshairs annotations
+ - and other properties for customizing final value annotations
+ - that allow changing opacity of series fill (e.g. Area chart)
+ - that allows changing thickness of markers
- Added new properties in Category Chart, Financial Chart, Data Chart, and Geographic Map:
- - `MarkerAutomaticBehavior` that allows which marker type is assigned to multiple series in the same chart
- - `LegendItemBadgeShape` for setting badge shape of all series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on all series in a legend
+ - that allows which marker type is assigned to multiple series in the same chart
+ - for setting badge shape of all series represented in a legend
+ - for setting badge complexity on all series in a legend
- Added new properties in Series in Data Chart and Geographic Map:
- - `LegendItemBadgeShape` for setting badge shape on specific series represented in a legend
- - `LegendItemBadgeMode` for setting badge complexity on specific series in a legend
+ - for setting badge shape on specific series represented in a legend
+ - for setting badge complexity on specific series in a legend
- Changed default vertical crosshair line stroke from #000000 to #BBBBBB in category chart and series
-- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's `MarkerAutomaticBehavior` property to `SmartIndexed` enum value
-- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's `LegendItemBadgeMode` property to `MatchSeries` enum value
+- Changed shape of markers to circle for all series plotted in the same chart. This can be reverted by setting chart's property to `SmartIndexed` enum value
+- Simplified shapes of series in chart's legend to display only circle, line, or square. This can be reverted by setting chart's property to `MatchSeries` enum value
- Changed color palette of series and markers displayed in all charts to improve accessibility
| Old brushes/outlines | New outline/brushes |
@@ -447,23 +449,23 @@ This release introduces a few improvements and simplifications to visual design
- Changed Scatter High Density series’ colors for heat max property from #ee5879 to #ee5879
- Changed Financial/Waterfall series’ `NegativeBrush` and `NegativeOutline` properties from #C62828 to #ee5879
- Changed marker's thickness to 2px from 1px
-- Changed marker's fill to match the marker's outline for `PointSeries`, `BubbleSeries`, `ScatterSeries`, `PolarScatterSeries`. You can use set `MarkerFillMode` property to Normal to undo this change
-- Compressed labelling for the `TimeXAxis` and `OrdinalTimeXAxis`
+- Changed marker's fill to match the marker's outline for , , , . You can use set property to Normal to undo this change
+- Compressed labelling for the and
- New Marker Properties:
- - series.`MarkerFillMode` - Can be set to `MatchMarkerOutline` so the marker depends on the outline
- - series.`MarkerFillOpacity` - Can be set to a value 0 to 1
- - series.`MarkerOutlineMode` - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
+ - series. - Can be set to `MatchMarkerOutline` so the marker depends on the outline
+ - series. - Can be set to a value 0 to 1
+ - series. - Can be set to `MatchMarkerBrush` so the marker's outline depends on the fill brush color
- New Series Property:
- - series.`OutlineMode` - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
-- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the `ComputedPlotAreaMarginMode`, listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
- - chart.`PlotAreaMarginLeft`
- - chart.`PlotAreaMarginTop`
- - chart.`PlotAreaMarginRight`
- - chart.`PlotAreaMarginBottom`
- - chart.`ComputedPlotAreaMarginMode`
+ - series. - Can be set to toggle the series outline visibility. Note, for Data Chart, the property is on the series
+- New chart properties that define bleed over area introduced into the viewport when the chart is at the default zoom level. A common use case is to provide space between the axes and first/last data points. Note, the , listed below, will automatically set the margin when markers are enabled. The others are designed to specify a `Double` to represent the thickness, where PlotAreaMarginLeft etc. adjusts the space to all four sides of the chart:
+ - chart.
+ - chart.
+ - chart.
+ - chart.
+ - chart.
- New Highlighting Properties
- - chart.`HighlightingMode` - Sets whether hovered or non-hovered series to fade, brighten
- - chart.`HighlightingBehavior` - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
+ - chart. - Sets whether hovered or non-hovered series to fade, brighten
+ - chart. - Sets whether the series highlights depending on mouse position e.g. directly over or nearest item
- Note, in previous releases the highlighting was limited to fade on hover.
- Added Highlighting Stacked, Scatter, Polar, Radial, and Shape series:
- Added Annotation layers to Stacked, Scatter, Polar, Radial, and Shape series:
@@ -503,30 +505,30 @@ These features are CTP
## {PackageCharts} (チャート)
-このリリースでは、すべてのチャート コンポーネントに、いくつかの新しく改善されたビジュアル デザインと構成オプションが導入されています。例えば、`DataChart`、`CategoryChart`、および `FinancialChart`。
+このリリースでは、すべてのチャート コンポーネントに、いくつかの新しく改善されたビジュアル デザインと構成オプションが導入されています。例えば、、、および 。
- 棒/縦棒/ウォーターフォール シリーズを、角丸ではなく角が四角になるように変更しました。
- heat min プロパティの 散布高密度シリーズの色を #8a5bb1 から #000000 に変更しました。
- heat max プロパティの 散布高密度シリーズの色を #ee5879 から #ee5879 に変更しました。
- ファイナンシャル/ウォーターフォール シリーズの `NegativeBrush` および `NegativeOutline` プロパティを #C62828 から #ee5879 に変更しました。
- マーカーの厚さを 1px から 2px に変更しました。
-- `PointSeries`、`BubbleSeries`、`ScatterSeries`、`PolarScatterSeries` のマーカーのアウトラインに一致するようにマーカーの塗りつぶしを変更しました。`MarkerFillMode` プロパティを Normal に設定すると、この変更を元に戻すことができます。
-- `TimeXAxis` および `OrdinalTimeXAxis` のラベリングを圧縮しました。
+- 、、、 のマーカーのアウトラインに一致するようにマーカーの塗りつぶしを変更しました。 プロパティを Normal に設定すると、この変更を元に戻すことができます。
+- および のラベリングを圧縮しました。
- 新しいマーカー プロパティ:
- - series.`MarkerFillMode` - マーカーがアウトラインに依存するように、`MatchMarkerOutline` に設定できます。
- - series.`MarkerFillOpacity` - 0〜1 の値に設定できます。
- - series.`MarkerOutlineMode` - マーカーのアウトラインが塗りブラシの色に依存するように、`MatchMarkerBrush` に設定できます。
+ - series. - マーカーがアウトラインに依存するように、`MatchMarkerOutline` に設定できます。
+ - series. - 0〜1 の値に設定できます。
+ - series. - マーカーのアウトラインが塗りブラシの色に依存するように、`MatchMarkerBrush` に設定できます。
- 新シリーズプロパティ:
- - series.`OutlineMode` - シリーズ アウトラインの表示を切り替えるように設定できます。データ チャートの場合、プロパティはシリーズ上にあることに注意してください。
- - チャートがデフォルトのズーム レベルにあるときにビューポートに導入されるブリード オーバー領域を定義する新しいチャート プロパティを追加しました。一般的な使用例では、軸と最初/最後のデータ ポイントの間にスペースを提供します。以下にリストされている `ComputedPlotAreaMarginMode` は、マーカーが有効になっているときに自動的にマージンを設定することに注意してください。その他は、厚さを表す `Double` を指定するように設計されており、PlotAreaMarginLeft などがチャートの 4 辺すべてにスペースを調整します:
- - chart.`PlotAreaMarginLeft`
- - chart.`PlotAreaMarginTop`
- - chart.`PlotAreaMarginRight`
- - chart.`PlotAreaMarginBottom`
- - chart.`ComputedPlotAreaMarginMode`
+ - series. - シリーズ アウトラインの表示を切り替えるように設定できます。データ チャートの場合、プロパティはシリーズ上にあることに注意してください。
+ - チャートがデフォルトのズーム レベルにあるときにビューポートに導入されるブリード オーバー領域を定義する新しいチャート プロパティを追加しました。一般的な使用例では、軸と最初/最後のデータ ポイントの間にスペースを提供します。以下にリストされている は、マーカーが有効になっているときに自動的にマージンを設定することに注意してください。その他は、厚さを表す `Double` を指定するように設計されており、PlotAreaMarginLeft などがチャートの 4 辺すべてにスペースを調整します:
+ - chart.
+ - chart.
+ - chart.
+ - chart.
+ - chart.
- 新しいハイライト表示プロパティ:
- - chart.`HighlightingMode` - ホバーされたシリーズとホバーされていないシリーズをフェードまたは明るくするかを設定します。
- - chart.`HighlightingBehavior` - 真上または最も近い項目など、マウスの位置に応じてシリーズをハイライト表示するかどうかを設定します。
+ - chart. - ホバーされたシリーズとホバーされていないシリーズをフェードまたは明るくするかを設定します。
+ - chart. - 真上または最も近い項目など、マウスの位置に応じてシリーズをハイライト表示するかどうかを設定します。
- 以前のリリースでは、ハイライト表示はホバー時にフェードするように制限されていたことに注意してください。
- 積層型、散布図、極座標、ラジアル、図形シリーズにハイライト表示を追加しました。
- 積層型、散布図、極座標、ラジアル、図形注釈レイヤーを追加しました。
diff --git a/docs/xplat/src/content/jp/components/general-cli-overview.mdx b/docs/xplat/src/content/jp/components/general-cli-overview.mdx
index ff43f6aa96..f36315be1c 100644
--- a/docs/xplat/src/content/jp/components/general-cli-overview.mdx
+++ b/docs/xplat/src/content/jp/components/general-cli-overview.mdx
@@ -97,7 +97,7 @@ ig add [component_template] [component_name]
ig add grid MyGridComponent
```
-
+
ルーティング ファイルは、新しいコンポーネントを含むページへのパス (この場合は `/my-grid-component`) で更新されます。これを使用して、新しく生成されたページに手動で移動できます。
diff --git a/docs/xplat/src/content/jp/components/geo-map-binding-data-model.mdx b/docs/xplat/src/content/jp/components/geo-map-binding-data-model.mdx
index ebb947a067..13a3296d84 100644
--- a/docs/xplat/src/content/jp/components/geo-map-binding-data-model.mdx
+++ b/docs/xplat/src/content/jp/components/geo-map-binding-data-model.mdx
@@ -30,13 +30,13 @@ import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
| Geographic シリーズ | プロパティ | 概要 |
|--------------|---------------| ---------------|
-| | `LongitudeMemberPath`、`LatitudeMemberPath` | 2 つの数値の経度と緯度座標の名前を指定します。 |
-| | `LongitudeMemberPath`、`LatitudeMemberPath` | 2 つの数値の経度と緯度座標の名前を指定します。 |
-| | `LongitudeMemberPath`、`LatitudeMemberPath`、`RadiusMemberPath` | 2 つの経度座標と緯度座標の名前と、シンボルのサイズ/半径の数字列を 1 列指定します。 |
-| | `LongitudeMemberPath`、`LatitudeMemberPath`、`ColorMemberPath` | 数値の三角測量のために、2 つの経度と緯度座標および数値列を 1 列指定します。 |
-| | `LongitudeMemberPath`、`LatitudeMemberPath`、`ValueMemberPath` | 数値の三角測量のために、2 つの経度と緯度座標および数値列を 1 列指定します。 |
-||`ShapeMemberPath`|図形の地理的ポイントを含む 項目のデータ列の名前を指定します。このプロパティは、x プロパティと y プロパティを持つオブジェクトの配列の配列にマップする必要があります。 |
-||`ShapeMemberPath`|線の地理的座標を含む 項目のデータ列の名前を指定します。このプロパティは、x プロパティと y プロパティを持つオブジェクトの配列の配列にマップする必要があります。 |
+| | 、 | 2 つの数値の経度と緯度座標の名前を指定します。 |
+| | 、 | 2 つの数値の経度と緯度座標の名前を指定します。 |
+| | 、、 | 2 つの経度座標と緯度座標の名前と、シンボルのサイズ/半径の数字列を 1 列指定します。 |
+| | 、、 | 数値の三角測量のために、2 つの経度と緯度座標および数値列を 1 列指定します。 |
+| | 、、 | 数値の三角測量のために、2 つの経度と緯度座標および数値列を 1 列指定します。 |
+|||図形の地理的ポイントを含む 項目のデータ列の名前を指定します。このプロパティは、x プロパティと y プロパティを持つオブジェクトの配列の配列にマップする必要があります。 |
+|||線の地理的座標を含む 項目のデータ列の名前を指定します。このプロパティは、x プロパティと y プロパティを持つオブジェクトの配列の配列にマップする必要があります。 |
## コード スニペット
以下のコードは、 を、経度と緯度の座標を使用して格納された世界の一部の都市の地理的位置を含むカスタム データ モデルにバインドする方法を示します。また、[WorldUtility](geo-map-resources-world-util.md) を使用してこれらの場所間の最短の地理的経路をプロットするために を使用します。
diff --git a/docs/xplat/src/content/jp/components/geo-map-binding-shp-file.mdx b/docs/xplat/src/content/jp/components/geo-map-binding-shp-file.mdx
index c75c7ad833..8669209454 100644
--- a/docs/xplat/src/content/jp/components/geo-map-binding-shp-file.mdx
+++ b/docs/xplat/src/content/jp/components/geo-map-binding-shp-file.mdx
@@ -12,7 +12,7 @@ import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
# {Platform} シェープ ファイルを地理的データにバインディング
-{ProductName} Map コンポーネントの クラスは、形状ファイルから地理空間データ (ポイント/位置、ポリライン、ポリゴン) を読み込み、それを オブジェクトのコレクションに変換します。
+{ProductName} Map コンポーネントの クラスは、形状ファイルから地理空間データ (ポイント/位置、ポリライン、ポリゴン) を読み込み、それを オブジェクトのコレクションに変換します。
## {Platform} シェープ ファイルを地理的データにバインディングの例
@@ -20,20 +20,20 @@ import ApiLink from 'igniteui-astro-components/components/mdx/ApiLink.astro';
-以下の表は、シェイプ ファイルを読み込むための クラスのプロパティを説明します。
+以下の表は、シェイプ ファイルを読み込むための クラスのプロパティを説明します。
| プロパティ | 型 | 概要 |
|----------|------|---------------|
-| `ShapefileSource` | string |シェイプ ファイル(.shp) から読み込まれた 1 つの地理空間シェープにすべてのポイントが含まれます。|
-|`DatabaseSource` | string |たとえば、シェープファイルで日本は、以下でポイント オブジェクト リストのリストとして表されます。|
+| | string |シェイプ ファイル(.shp) から読み込まれた 1 つの地理空間シェープにすべてのポイントが含まれます。|
+| | string |たとえば、シェープファイルで日本は、以下でポイント オブジェクト リストのリストとして表されます。|
-両方のソース プロパティが null 以外の値に設定されると、 オブジェクトの ImportAsync メソッドが起動し、シェイプ ファイルを取得して読み込み、最終的に変換を実行します。この操作が完了すると、 は オブジェクトで生成され、シェイプ ファイルから地理空間データを読み込んで変換するプロセスが完了したことを通知するために、`ImportCompleted` イベントが起動されます。
+両方のソース プロパティが null 以外の値に設定されると、 オブジェクトの ImportAsync メソッドが起動し、シェイプ ファイルを取得して読み込み、最終的に変換を実行します。この操作が完了すると、 は オブジェクトで生成され、シェイプ ファイルから地理空間データを読み込んで変換するプロセスが完了したことを通知するために、`ImportCompleted` イベントが起動されます。
## シェープファイルの読み込み
-以下のコードは、世界の主要都市の場所を含むシェイプ ファイルを読み込むための オブジェクトのインスタンスを作成します。また、xamGeographicMap コントロールにデータをバインドするための前提条件として `ImportCompleted` イベントを処理する方法も示します。
+以下のコードは、世界の主要都市の場所を含むシェイプ ファイルを読み込むための オブジェクトのインスタンスを作成します。また、xamGeographicMap コントロールにデータをバインドするための前提条件として `ImportCompleted` イベントを処理する方法も示します。
```html
@@ -57,9 +57,9 @@ sds.dataBind();
## シェープファイルをバインド
-Map コンポーネントでは、Geographic Series は、シェイプ ファイルから読み込まれる地理的データを表示するために使用されます。すべてのタイプの地理的シリーズには、オブジェクトの配列にバインドできる `ItemsSource` プロパティがあります。 は オブジェクトのリストを含むため、このような配列の例です。
+Map コンポーネントでは、Geographic Series は、シェイプ ファイルから読み込まれる地理的データを表示するために使用されます。すべてのタイプの地理的シリーズには、オブジェクトの配列にバインドできる プロパティがあります。 は オブジェクトのリストを含むため、このような配列の例です。
-`ShapefileRecord` クラスは、以下の表にリストする地理的データを保存するためのプロパティを提供します。
+ クラスは、以下の表にリストする地理的データを保存するためのプロパティを提供します。
| プロパティ | 概要 |
|--------------|---------------|
@@ -69,8 +69,8 @@ Map コンポーネントでは、Geographic Series は、シェイプ ファイ
このデータ構造は、適切なデータ列がマップされている限り、ほとんどの地理的シリーズでの使用に適しています。
## コード スニペット
-このコード例は、シェープ ファイルが を使用して読み込まれたことを前提としています。
-以下のコードは、マップ コンポーネント内の を にバインドし、すべての オブジェクトの `Points` プロパティをマップします。
+このコード例は、シェープ ファイルが を使用して読み込まれたことを前提としています。
+以下のコードは、マップ コンポーネント内の を にバインドし、すべての オブジェクトの `Points` プロパティをマップします。
@@ -286,4 +286,4 @@ onDataLoaded(sds: IgcShapeDataSource, e: any) {
## API リファレンス
-
+
diff --git a/docs/xplat/src/content/jp/components/geo-map-display-azure-imagery.mdx b/docs/xplat/src/content/jp/components/geo-map-display-azure-imagery.mdx
index 70c5361d9e..556a8b0648 100644
--- a/docs/xplat/src/content/jp/components/geo-map-display-azure-imagery.mdx
+++ b/docs/xplat/src/content/jp/components/geo-map-display-azure-imagery.mdx
@@ -29,7 +29,7 @@ import Badge from 'igniteui-astro-components/components/mdx/Badge.astro';
## {Platform} Azure Maps からの画像の表示 - コード例
-以下のコード スニペットは、 クラスを使用して {Platform} `GeographicMap` で Azure Maps からの地理的画像タイルを表示する方法を示します。
+以下のコード スニペットは、 クラスを使用して {Platform} で Azure Maps からの地理的画像タイルを表示する方法を示します。
@@ -130,8 +130,8 @@ map.backgroundContent = tileSource;
を使用する際には、**ベース マップ スタイル** (例: **Satellite**, **Road**, **DarkGrey**) の上に**オーバーレイ** (交通情報、天気、ラベル) を重ね合わせることができます。例えば **Satellite** と **TerraOverlay** を組み合わせることで、地形を視覚化できます。
- **ベース スタイル**: Satellite、Road、Terra、DarkGrey がコアとなる背景タイルを提供します。
-- **オーバーレイ スタイル**: 交通情報や天気の画像 (`TrafficRelativeOverlay`、`WeatherRadarOverlay` など) は、タイル シリーズに割り当てることでベース スタイル上に重ねられるよう設計されています。
-- **ハイブリッド スタイル**: `HybridRoadOverlay` や `HybridDarkGreyOverlay` などのバリエーションは、ベース スタイルにラベルや道路などのオーバーレイをあらかじめ組み合わせているため、複数のレイヤーを手動で管理する必要はありません。
+- **オーバーレイ スタイル**: 交通情報や天気の画像 (、 など) は、タイル シリーズに割り当てることでベース スタイル上に重ねられるよう設計されています。
+- **ハイブリッド スタイル**: や などのバリエーションは、ベース スタイルにラベルや道路などのオーバーレイをあらかじめ組み合わせているため、複数のレイヤーを手動で管理する必要はありません。
この設計により、より豊かなマップ表現が可能になります。例えば:
- **Satellite** 画像に **TrafficOverlay** を重ねて、実際の地図上に渋滞状況をハイライト表示。
@@ -143,7 +143,7 @@ map.backgroundContent = tileSource;
## Azure Maps からの画像オーバーレイ - コード例
-次のコード スニペットは、 クラスと クラスを使用して、{Platform} `GeographicMap` の交通情報と濃い灰色のマップを結合した背景画像の上に地理画像タイルを表示する方法を示しています。
+次のコード スニペットは、 クラスと クラスを使用して、{Platform} の交通情報と濃い灰色のマップを結合した背景画像の上に地理画像タイルを表示する方法を示しています。
@@ -337,7 +337,7 @@ window.addEventListener("load", () => {
| プロパティ名 | プロパティ タイプ | 説明 |
|----------------|-----------------|---------------|
||string|Azure Maps 画像サービスで必要となる API キーを設定するためのプロパティを表します。このキーは azure.microsoft.com ウェブサイトから取得してください。|
-||`AzureMapsImageryStyle`|Azure Maps 画像タイルのマップ スタイルを設定するプロパティを表します。このプロパティは、以下の `AzureMapsImageryStyle` 列挙値に設定できます。