@serenity-is/sleekgrid / GroupItemMetadataProvider

Class: GroupItemMetadataProvider

Defined in: src/data/groupitemmetadataprovider.tsx:26

Implements

• GridPlugin

Constructors

Constructor

new GroupItemMetadataProvider(opt?): GroupItemMetadataProvider

Defined in: src/data/groupitemmetadataprovider.tsx:30

Parameters

opt?

GroupItemMetadataProviderOptions

Returns

GroupItemMetadataProvider

Properties

getGroupRowMetadata()

getGroupRowMetadata: (item) => ItemMetadata

Defined in: src/data/groupitemmetadataprovider.tsx:223

Parameters

item

Group

Returns

ItemMetadata

---

getTotalsRowMetadata()

getTotalsRowMetadata: (item) => ItemMetadata

Defined in: src/data/groupitemmetadataprovider.tsx:247

Parameters

item

IGroupTotals

Returns

ItemMetadata

---

grid

protected grid: ISleekGrid

Defined in: src/data/groupitemmetadataprovider.tsx:27

---

pluginName

readonly pluginName: "GroupItemMetadataProvider" = "GroupItemMetadataProvider"

Defined in: src/data/groupitemmetadataprovider.tsx:107

Implementation of

GridPlugin.pluginName

---

defaults

readonly static defaults: GroupItemMetadataProviderOptions

Defined in: src/data/groupitemmetadataprovider.tsx:38

Methods

destroy()

destroy(): void

Defined in: src/data/groupitemmetadataprovider.tsx:109

Returns

void

Implementation of

GridPlugin.destroy

---

getOptions()

getOptions(): GroupItemMetadataProviderOptions

Defined in: src/data/groupitemmetadataprovider.tsx:116

Returns

GroupItemMetadataProviderOptions

---

groupCellPosition()

groupCellPosition(): object

Defined in: src/data/groupitemmetadataprovider.tsx:186

Returns

object

cell

cell: number = 0

colspan

colspan: number | "*"

---

handleGridClick()

handleGridClick(e): void

Defined in: src/data/groupitemmetadataprovider.tsx:124

Parameters

e

CellMouseEvent

Returns

void

---

handleGridKeyDown()

handleGridKeyDown(e): void

Defined in: src/data/groupitemmetadataprovider.tsx:150

Parameters

e

CellKeyboardEvent

Returns

void

---

init()

init(grid): void

Defined in: src/data/groupitemmetadataprovider.tsx:101

Parameters

grid

ISleekGrid

Returns

void

Implementation of

GridPlugin.init

---

setOptions()

setOptions(value): void

Defined in: src/data/groupitemmetadataprovider.tsx:120

Parameters

value

GroupItemMetadataProviderOptions

Returns

void

---

defaultGroupFormat()

static defaultGroupFormat(ctx, opt?): FormatterResult

Defined in: src/data/groupitemmetadataprovider.tsx:54

Parameters

ctx

FormatterContext

opt?

GroupItemMetadataProviderOptions

Returns

FormatterResult

---

defaultTotalsFormat()

static defaultTotalsFormat(ctx, grid?): FormatterResult

Defined in: src/data/groupitemmetadataprovider.tsx:85

Parameters

ctx

FormatterContext

grid?

ISleekGrid

Returns

FormatterResult