GroupingFeature

Defined in: core/features/grouping.svelte.ts:31

A class that provides grouping functionality for the datagrid, allowing columns to be grouped and expanded/collapsed.

Implements

• GroupingFeatureState

Constructors

new GroupingFeature()

new GroupingFeature(datagrid, config?): GroupingFeature

Defined in: core/features/grouping.svelte.ts:57

Creates an instance of the GroupingFeature class, initializing it with the datagrid and optional configuration.

Parameters

datagrid

DatagridCore

The datagrid instance to associate with the grouping feature.

config?

Partial

Optional configuration for the grouping feature.

Returns

GroupingFeature

Properties

Property	Type	Description	Defined in
activeGroups	string[]	The list of columns currently used for grouping.	core/features/grouping.svelte.ts:38
expandedGroups	SvelteSet<string>	A set of currently expanded group identifiers.	core/features/grouping.svelte.ts:41
manual	boolean	Whether grouping is manually controlled.	core/features/grouping.svelte.ts:35
maxActiveGroups	number	The maximum number of groups that can be active at once.	core/features/grouping.svelte.ts:47
maxExpandedGroups	number	The maximum number of groups that can be expanded at any time.	core/features/grouping.svelte.ts:44
onGroupingChange	(expandedGroups: string[]) => void	Callback function triggered when the grouping state changes.	core/features/grouping.svelte.ts:50

Methods

collapseGroup()

collapseGroup(groupIdentifier): void

Defined in: core/features/grouping.svelte.ts:97

Collapses a specific group and notifies the datagrid.

Parameters

groupIdentifier

string

The identifier of the group to collapse.

Returns

void

---

expandGroup()

expandGroup(groupIdentifier): void

Defined in: core/features/grouping.svelte.ts:84

Expands a specific group, notifying the datagrid and ensuring the group limit is not exceeded.

Parameters

groupIdentifier

string

The identifier of the group to expand.

Returns

void

---

isColumnWithinGroup()

isColumnWithinGroup(columnId): boolean

Defined in: core/features/grouping.svelte.ts:67

Checks if a column is part of the active grouping.

Parameters

columnId

string

The column identifier to check.

Returns

boolean

True if the column is part of the active grouping, false otherwise.

---

isGroupExpanded()

isGroupExpanded(groupIdentifier): boolean

Defined in: core/features/grouping.svelte.ts:76

Checks if a group is expanded.

Parameters

groupIdentifier

string

The identifier for the group to check.

Returns

boolean

True if the group is expanded, false otherwise.

---

toggleGrouping()

toggleGrouping(columnId): void

Defined in: core/features/grouping.svelte.ts:107

Toggles the grouping state of a column. If the column is already in the group, it will be collapsed; if not, it will be expanded.

Parameters

columnId

string

The identifier of the column to toggle.

Returns

void

---

updateActiveGroups()

updateActiveGroups(activeGroups): void | Error

Defined in: core/features/grouping.svelte.ts:121

Updates the list of active groups, ensuring it does not exceed the maximum limit of active groups. Emits an event notifying the datagrid of the change.

Parameters

activeGroups

string[]

The new list of active groups.

Returns

void | Error

Throws

If the number of active groups exceeds the maximum allowed.