BlockSuite API Documentation / @blocksuite/data-view / GroupTrait

Class: GroupTrait

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:25

Constructors

new GroupTrait()

new GroupTrait(groupBy$, view, ops): GroupTrait

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:147

Parameters

groupBy$

ReadonlySignal<undefined | GroupBy>

view

SingleView

ops

changeGroupSort

(keys) => void

changeRowSort

(groupKeys, groupKey, keys) => void

groupBySet

(groupBy) => void

sortGroup

(keys) => string[]

sortRow

(groupKey, rowIds) => string[]

Returns

GroupTrait

Properties

config$

config$: ReadonlySignal<undefined | GroupByConfig>

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:28

---

groupDataMap$

groupDataMap$: ReadonlySignal<undefined | Record<string, GroupData>>

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:72

---

groupsDataList$

groupsDataList$: ReadonlySignal<undefined | GroupData[]>

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:120

---

property$

property$: ReadonlySignal<undefined | Property<unknown, unknown, Record<string, unknown>>>

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:40

---

staticGroupDataMap$

staticGroupDataMap$: ReadonlySignal<undefined | Record<string, Omit<GroupData, "rows">>>

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:48

---

view

view: SingleView

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:149

Accessors

addGroup

Get Signature

get addGroup(): undefined | (config) => object

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:135

Returns

undefined | (config) => object

---

propertyId

Get Signature

get propertyId(): undefined | string

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:143

Returns

undefined | string

Methods

addToGroup()

addToGroup(rowId, key): void

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:163

Parameters

rowId

string

key

string

Returns

void

---

changeCardSort()

changeCardSort(groupKey, cardIds): void

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:177

Parameters

groupKey

string

cardIds

string[]

Returns

void

---

changeGroup()

changeGroup(columnId): void

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:189

Parameters

columnId

undefined | string

Returns

void

---

changeGroupSort()

changeGroupSort(keys): void

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:208

Parameters

keys

string[]

Returns

void

---

defaultGroupProperty()

defaultGroupProperty(key): GroupProperty

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:212

Parameters

key

string

Returns

GroupProperty

---

moveCardTo()

moveCardTo(rowId, fromGroupKey, toGroupKey, position): void

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:220

Parameters

rowId

string

fromGroupKey

undefined | string

toGroupKey

string

position

InsertToPosition

Returns

void

---

moveGroupTo()

moveGroupTo(groupKey, position): void

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:254

Parameters

groupKey

string

position

InsertToPosition

Returns

void

---

removeFromGroup()

removeFromGroup(rowId, key): void

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:269

Parameters

rowId

string

key

string

Returns

void

---

updateData()

updateData(data): void

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:127

Parameters

data

Returns

void

---

updateValue()

updateValue(rows, value): void

Defined in: packages/affine/data-view/src/core/group-by/trait.ts:286

Parameters

rows

string[]

value

unknown

Returns

void