Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 6 additions & 7 deletions grid-sdk/javascript/tree-grid/accessibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,21 @@ layout: post
title: JavaScript TreeGrid Accessibility | Syncfusion
description: Learn how JavaScript TreeGrid supports accessibility with WAI-ARIA roles, keyboard navigation, and ADA, Section 508, and WCAG compliance.
platform: grid-sdk
control: Accessibility
publishingplatform: grid-sdk
control: Accessibility
documentation: ug
domainurl: https://help.syncfusion.com/grid-sdk
---

# Accessibility in JavaScript TreeGrid

The Tree Grid component followed the accessibility guidelines and standards, including [ADA](https://www.ada.gov/), [Section 508](https://www.section508.gov/), [WCAG 2.2](https://www.w3.org/TR/WCAG22/) standards, and [WCAG roles](https://www.w3.org/TR/wai-aria/#roles) that are commonly used to evaluate accessibility.
The Tree Grid component followed the accessibility guidelines and standards, including [ADA](https://www.ada.gov), [Section 508](https://www.section508.gov), [WCAG 2.2](https://www.w3.org/TR/WCAG22) standards, and [WCAG roles](https://www.w3.org/TR/wai-aria#roles) that are commonly used to evaluate accessibility.

The accessibility compliance for the Tree Grid component is outlined below.

| Accessibility Criteria | Compatibility |
| -- | -- |
| [WCAG 2.2](https://www.w3.org/TR/WCAG22/) Support | <img src="https://cdn.syncfusion.com/content/images/documentation/partial.png" alt="intermediate"> |
| [Section 508](https://www.section508.gov/) Support | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
| [WCAG 2.2](https://www.w3.org/TR/WCAG22) Support | <img src="https://cdn.syncfusion.com/content/images/documentation/partial.png" alt="intermediate"> |
| [Section 508](https://www.section508.gov) Support | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
| Screen Reader Support | <img src="https://cdn.syncfusion.com/content/images/documentation/partial.png" alt="intermediate"> |
| Right-To-Left Support | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
| Color Contrast | <img src="https://cdn.syncfusion.com/content/images/documentation/full.png" alt="Yes"> |
Expand All @@ -41,7 +40,7 @@ The accessibility compliance for the Tree Grid component is outlined below.

## WAI-ARIA attributes

The Tree Grid component followed the [WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/treegrid/) patterns to meet the accessibility. The following ARIA attributes are used in the Tree Grid component:
The Tree Grid component followed the [WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/patterns/treegrid) patterns to meet the accessibility. The following ARIA attributes are used in the Tree Grid component:

| Attributes | Purpose |
| --- | --- |
Expand All @@ -57,7 +56,7 @@ The Tree Grid component followed the [WAI-ARIA](https://www.w3.org/WAI/ARIA/apg/

## Keyboard interaction

The Tree Grid component followed the [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/treegrid/) guideline, making it easy for people who use assistive technologies (AT) and those who completely rely on keyboard navigation. The following keyboard shortcuts are supported by the Tree Grid component.
The Tree Grid component followed the [keyboard interaction](https://www.w3.org/WAI/ARIA/apg/patterns/treegrid) guideline, making it easy for people who use assistive technologies (AT) and those who completely rely on keyboard navigation. The following keyboard shortcuts are supported by the Tree Grid component.

Interaction Keys |Description
-----|-----
Expand Down
5 changes: 2 additions & 3 deletions grid-sdk/javascript/tree-grid/adaptive.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ layout: post
title: JavaScript TreeGrid Adaptive UI | Syncfusion
description: Learn how to enable adaptive UI in JavaScript TreeGrid for optimized mobile, tablet, and small-screen user experiences.
platform: grid-sdk
control: Adaptive
publishingplatform: grid-sdk
control: Adaptive
documentation: ug
domainurl: https://help.syncfusion.com/grid-sdk
---
Expand All @@ -13,7 +12,7 @@ domainurl: https://help.syncfusion.com/grid-sdk

The Tree Grid user interface (UI) was redesigned to provide an optimal viewing experience and improve usability on small screens. This interface will render the filter, edit dialog and other features adaptively. For example, Filtering opens the UI for user in a pop-up occupying the entire screen.

To make the tree grid adaptive, set the [`enableAdaptiveUI`](../api/treegrid/#enableAdaptiveUI) to true.
To make the tree grid adaptive, set the [`enableAdaptiveUI`](../api/treegrid#enableAdaptiveUI) to true.

{% if page.publishingplatform == "typescript" %}

Expand Down
13 changes: 6 additions & 7 deletions grid-sdk/javascript/tree-grid/aggregates/aggregates.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,24 +3,23 @@ layout: post
title: JavaScript TreeGrid Aggregates | Syncfusion
description: Learn how to configure, display, and customize aggregate values in JavaScript TreeGrid, including built-in aggregate types and child aggregation.
platform: grid-sdk
control: Aggregates
publishingplatform: grid-sdk
control: Aggregates
documentation: ug
domainurl: https://help.syncfusion.com/grid-sdk
---

# Aggregates in JavaScript TreeGrid

Aggregate values are displayed in the TreeGrid footer and in parent row footer for child row aggregate values. It can be configured through `aggregates` property.
[`field`](../../api/treegrid/aggregateColumnModel/#field) and [`type`](../../api/treegrid/aggregateColumnModel/#type) are the minimum properties required to represent an aggregate column.
[`field`](../../api/treegrid/aggregateColumnModel#field) and [`type`](../../api/treegrid/aggregateColumnModel#type) are the minimum properties required to represent an aggregate column.

To use the aggregate feature, you have to inject the `Aggregate` module.

By default, the aggregate value can be displayed in the treegrid footer, and footer of child rows. To show the aggregate value in one of the cells, use the [`footerTemplate`](../../api/treegrid/aggregateColumnModel/#footertemplate).
By default, the aggregate value can be displayed in the treegrid footer, and footer of child rows. To show the aggregate value in one of the cells, use the [`footerTemplate`](../../api/treegrid/aggregateColumnModel#footertemplate).

## Built-in aggregate types

The aggregate type should be specified in the [`type`](../../api/treegrid/aggregateColumnModel/#type) property to configure an aggregate column.
The aggregate type should be specified in the [`type`](../../api/treegrid/aggregateColumnModel#type) property to configure an aggregate column.

The built-in aggregates are,

Expand All @@ -32,12 +31,12 @@ The built-in aggregates are,
* Truecount
* Falsecount

> * Multiple aggregates can be used for an aggregate column by setting the [`type`](../../api/treegrid/aggregateColumnModel/#type) property with an array of aggregate types.
> * Multiple aggregates can be used for an aggregate column by setting the [`type`](../../api/treegrid/aggregateColumnModel#type) property with an array of aggregate types.
> * Multiple types for a column is supported only when one of the aggregate templates is used.

## Child aggregate

Aggregate value is calculated for child rows, and it is displayed in the parent row footer. Use the [`childSummary`](../../api/treegrid/aggregateRowModel/#showchildsummary) property to render the child rows aggregate value.
Aggregate value is calculated for child rows, and it is displayed in the parent row footer. Use the [`childSummary`](../../api/treegrid/aggregateRowModel#showchildsummary) property to render the child rows aggregate value.

{% if page.publishingplatform == "typescript" %}

Expand Down
5 changes: 2 additions & 3 deletions grid-sdk/javascript/tree-grid/aggregates/custom-aggregate.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@ layout: post
title: JavaScript TreeGrid Custom Aggregate | Syncfusion
description: Learn about implementing custom aggregates in the JavaScript TreeGrid, including configuration and usage of custom aggregation functions.
platform: grid-sdk
control: Custom aggregate
publishingplatform: grid-sdk
control: Custom aggregate
documentation: ug
domainurl: https://help.syncfusion.com/grid-sdk
---

# Custom Aggregate in JavaScript TreeGrid

To calculate the aggregate value with your own aggregate functions, use the custom aggregate option. To use custom aggregation, specify the [`type`](../../api/treegrid/aggregateColumnModel/#type) as `Custom`, and provide the custom aggregate function in the [`customAggregate`](../../api/treegrid/aggregateColumnModel/#customaggregate) property.
To calculate the aggregate value with your own aggregate functions, use the custom aggregate option. To use custom aggregation, specify the [`type`](../../api/treegrid/aggregateColumnModel#type) as `Custom`, and provide the custom aggregate function in the [`customAggregate`](../../api/treegrid/aggregateColumnModel#customaggregate) property.

{% if page.publishingplatform == "typescript" %}

Expand Down
9 changes: 4 additions & 5 deletions grid-sdk/javascript/tree-grid/aggregates/footer-aggregate.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@ layout: post
title: JavaScript TreeGrid Footer Aggregate | Syncfusion
description: Learn how to configure and display footer aggregate values in JavaScript TreeGrid, including API usage, templates, and formatting options.
platform: grid-sdk
control: Footer aggregate
publishingplatform: grid-sdk
control: Footer aggregate
documentation: ug
domainurl: https://help.syncfusion.com/grid-sdk
---

# Footer Aggregate in JavaScript TreeGrid

Footer aggregate value is calculated for all the rows, and it is displayed in the footer cells. Use the [`footerTemplate`](../../api/treegrid/aggregateColumnModel/#footertemplate) property to render the aggregate value in footer cells.
Footer aggregate value is calculated for all the rows, and it is displayed in the footer cells. Use the [`footerTemplate`](../../api/treegrid/aggregateColumnModel#footertemplate) property to render the aggregate value in footer cells.

{% if page.publishingplatform == "typescript" %}

Expand Down Expand Up @@ -40,11 +39,11 @@ Footer aggregate value is calculated for all the rows, and it is displayed in th
{% previewsample "https://help.syncfusion.com/code-snippet/grid-sdk/javascript/treegrid/aggregates-cs3" %}
{% endif %}

> The aggregate values must be accessed inside the template using their corresponding [`type`](../../api/treegrid/aggregateColumnModel/#type) name.
> The aggregate values must be accessed inside the template using their corresponding [`type`](../../api/treegrid/aggregateColumnModel#type) name.

## How to format aggregate value

You can format the aggregate value result by using the [`format`](../../api/treegrid/aggregateColumnModel/#type) property.
You can format the aggregate value result by using the [`format`](../../api/treegrid/aggregateColumnModel#type) property.

{% if page.publishingplatform == "typescript" %}

Expand Down
7 changes: 3 additions & 4 deletions grid-sdk/javascript/tree-grid/cell/auto-wrap.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,16 @@ layout: post
title: JavaScript TreeGrid Auto Wrap | Syncfusion
description: Learn how to enable auto wrap in JavaScript TreeGrid to display header and cell content across multiple lines using flexible text wrapping modes.
platform: grid-sdk
control: Auto wrap
publishingplatform: grid-sdk
control: Auto wrap
documentation: ug
domainurl: https://help.syncfusion.com/grid-sdk
---

# Auto Wrap in JavaScript TreeGrid

The auto wrap allows the cell content of the treegrid to wrap to the next line when it exceeds the boundary of the cell width. The Cell Content wrapping works based on the position of white space between words.
To enable auto wrap, set the [`allowTextWrap`](../../api/treegrid/#allowtextwrap) property to `true`.
You can configure the auto wrap mode by setting the [`textWrapSettings.wrapMode`](../../api/treegrid/#textwrapsettings) property.
To enable auto wrap, set the [`allowTextWrap`](../../api/treegrid#allowtextwrap) property to `true`.
You can configure the auto wrap mode by setting the [`textWrapSettings.wrapMode`](../../api/treegrid#textwrapsettings) property.

There are three types of `wrapMode`. They are:

Expand Down
11 changes: 5 additions & 6 deletions grid-sdk/javascript/tree-grid/cell/cell.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ layout: post
title: JavaScript TreeGrid Cells | Syncfusion
description: Learn how to customize and format cells in JavaScript TreeGrid, including tooltips, styling, clip mode, autowrap, and cell templates.
platform: grid-sdk
control: Cell
publishingplatform: grid-sdk
control: Cell
documentation: ug
domainurl: https://help.syncfusion.com/grid-sdk
---
Expand All @@ -13,8 +12,8 @@ domainurl: https://help.syncfusion.com/grid-sdk

## Customize cell styles

The appearance of cells can be customized by using the [`queryCellInfo`](../../api/treegrid/#querycellinfo) event.
The [`queryCellInfo`](../../api/treegrid/#querycellinfo) event triggers for every cell. In that event handler, you can get `QueryCellInfoEventArgs` that contains the details of the cell.
The appearance of cells can be customized by using the [`queryCellInfo`](../../api/treegrid#querycellinfo) event.
The [`queryCellInfo`](../../api/treegrid#querycellinfo) event triggers for every cell. In that event handler, you can get `QueryCellInfoEventArgs` that contains the details of the cell.

{% if page.publishingplatform == "typescript" %}

Expand Down Expand Up @@ -45,7 +44,7 @@ The [`queryCellInfo`](../../api/treegrid/#querycellinfo) event triggers for ever

## Custom attributes

You can customize the treegrid cells by adding a CSS class to the [`customAttribute`](../../api/treegrid/column/#customattributes) property of the column.
You can customize the treegrid cells by adding a CSS class to the [`customAttribute`](../../api/treegrid/column#customattributes) property of the column.

```css
.e-attr {
Expand Down Expand Up @@ -90,7 +89,7 @@ In the below example, we have customized the cells of `TaskID` and `StartDate` c

## Grid lines

The [`gridLines`](../../api/treegrid/#gridlines) have option to display cell border and it can be defined by the [`gridLines`](../../api/treegrid/#gridlines) property.
The [`gridLines`](../../api/treegrid#gridlines) have option to display cell border and it can be defined by the [`gridLines`](../../api/treegrid#gridlines) property.

The available modes of grid lines are:

Expand Down
9 changes: 4 additions & 5 deletions grid-sdk/javascript/tree-grid/cell/clip-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,16 @@ layout: post
title: JavaScript TreeGrid Clip Mode | Syncfusion
description: Learn how to configure clip mode in JavaScript TreeGrid to manage overflowing cell content using clipping, ellipsis, or ellipsis with tooltip display.
platform: grid-sdk
control: Clip mode
publishingplatform: grid-sdk
control: Clip mode
documentation: ug
domainurl: https://help.syncfusion.com/grid-sdk
---

# Clip Mode in JavaScript TreeGrid

The clip mode provides options to display its overflow cell content and it can be defined by the [`columns.clipMode`](../../api/treegrid/column/#clipmode) property.
The clip mode provides options to display its overflow cell content and it can be defined by the [`columns.clipMode`](../../api/treegrid/column#clipmode) property.

There are three types of [`clipMode`](../../api/treegrid/column/#clipmode). They are:
There are three types of [`clipMode`](../../api/treegrid/column#clipmode). They are:

* **`Clip`**: Truncates the cell content when it overflows its area.
* **`Ellipsis`**: Displays ellipsis when the cell content overflows its area.
Expand Down Expand Up @@ -46,4 +45,4 @@ There are three types of [`clipMode`](../../api/treegrid/column/#clipmode). They
{% previewsample "https://help.syncfusion.com/code-snippet/grid-sdk/javascript/treegrid/cell-cs4" %}
{% endif %}

>By default, [`columns.clipMode`](../../api/treegrid/column/#clipmode) value is `Ellipsis`.
>By default, [`columns.clipMode`](../../api/treegrid/column#clipmode) value is `Ellipsis`.
5 changes: 2 additions & 3 deletions grid-sdk/javascript/tree-grid/cell/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@ layout: post
title: JavaScript TreeGrid Cell Content | Syncfusion
description: Learn how to display HTML content in JavaScript TreeGrid headers and cells using disableHtmlEncode to render formatted content and custom markup.
platform: grid-sdk
control: Content
publishingplatform: grid-sdk
control: Content
documentation: ug
domainurl: https://help.syncfusion.com/grid-sdk
---

# HTML Content in JavaScript TreeGrid

The HTML tags can be displayed in the TreeGrid header and content by enabling the [`disableHtmlEncode`](../../api/treegrid/column/#disablehtmlencode) property.
The HTML tags can be displayed in the TreeGrid header and content by enabling the [`disableHtmlEncode`](../../api/treegrid/column#disablehtmlencode) property.

{% if page.publishingplatform == "typescript" %}

Expand Down
7 changes: 3 additions & 4 deletions grid-sdk/javascript/tree-grid/clipboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ layout: post
title: JavaScript TreeGrid Clipboard | Syncfusion
description: Learn how to use clipboard operations in JavaScript TreeGrid, including copy, paste, hierarchy modes, and autofill for rows and cells.
platform: grid-sdk
control: Clipboard
publishingplatform: grid-sdk
control: Clipboard
documentation: ug
domainurl: https://help.syncfusion.com/grid-sdk
---
Expand Down Expand Up @@ -49,7 +48,7 @@ Interaction keys |Description

## Copy to clipboard by external buttons

To copy selected rows or cells data into the clipboard with help of external buttons, you need to invoke the [`copy`](../api/treegrid/#copy) method.
To copy selected rows or cells data into the clipboard with help of external buttons, you need to invoke the [`copy`](../api/treegrid#copy) method.

{% if page.publishingplatform == "typescript" %}

Expand Down Expand Up @@ -80,7 +79,7 @@ To copy selected rows or cells data into the clipboard with help of external but

## Copy Hierarchy Modes

Tree Grid provides support for a set of copy modes with [`copyHierarchyMode`](../api/treegrid/#copyhierarchymode) property.
Tree Grid provides support for a set of copy modes with [`copyHierarchyMode`](../api/treegrid#copyhierarchymode) property.
The below are the type of filter mode available in TreeGrid.

* **Parent** : This is the default copy hierarchy mode in Tree Grid. Clipboard value have the selected records with its parent records. If the selected records not have any parent record then the selected record will be in clipboard.
Expand Down
7 changes: 3 additions & 4 deletions grid-sdk/javascript/tree-grid/columns/auto-fit-columns.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@ layout: post
title: JavaScript TreeGrid Auto Fit Columns | Syncfusion
description: Learn how to automatically adjust column widths in JavaScript TreeGrid to fit content and improve data presentation.
platform: grid-sdk
control: Auto fit columns
publishingplatform: grid-sdk
control: Auto fit columns
documentation: ug
domainurl: https://help.syncfusion.com/grid-sdk
---

# Auto Fit Columns in JavaScript TreeGrid

The [`autoFitColumns`](../../api/treegrid/#autofitcolumns) method resizes the column to fit the widest cell's content without wrapping. You can autofit a specific column at initial rendering by invoking the [`autoFitColumns`](../../api/treegrid/#autofitcolumns) method in [`dataBound`](../../api/treegrid/#databound) event.
The [`autoFitColumns`](../../api/treegrid#autofitcolumns) method resizes the column to fit the widest cell's content without wrapping. You can autofit a specific column at initial rendering by invoking the [`autoFitColumns`](../../api/treegrid#autofitcolumns) method in [`dataBound`](../../api/treegrid#databound) event.

{% if page.publishingplatform == "typescript" %}

Expand Down Expand Up @@ -40,4 +39,4 @@ The [`autoFitColumns`](../../api/treegrid/#autofitcolumns) method resizes the co
{% previewsample "https://help.syncfusion.com/code-snippet/grid-sdk/javascript/treegrid/columns-cs1" %}
{% endif %}

> You can autofit all the columns by invoking the [`autoFitColumns`](../../api/treegrid/column/#autofitcolumns) method without column names.
> You can autofit all the columns by invoking the [`autoFitColumns`](../../api/treegrid/column#autofitcolumns) method without column names.
Loading