@serenity-is/sleekgrid / GroupItemMetadataProvider

Class: GroupItemMetadataProvider

Implements

• IPlugin

Constructors

new GroupItemMetadataProvider()

new GroupItemMetadataProvider(opt?): GroupItemMetadataProvider

Parameters

opt?

GroupItemMetadataProviderOptions

Returns

GroupItemMetadataProvider

Defined in

data/groupitemmetadataprovider.ts:29

Properties

getGroupRowMetadata()

getGroupRowMetadata: (item) => ItemMetadata<any>

Parameters

item

Group<any>

Returns

ItemMetadata<any>

Defined in

data/groupitemmetadataprovider.ts:193

---

getTotalsRowMetadata()

getTotalsRowMetadata: (item) => ItemMetadata<any>

Parameters

item

GroupTotals<any>

Returns

ItemMetadata<any>

Defined in

data/groupitemmetadataprovider.ts:217

---

grid

protected grid: Grid<any>

Defined in

data/groupitemmetadataprovider.ts:26

---

pluginName

readonly pluginName: "GroupItemMetadataProvider" = "GroupItemMetadataProvider"

Implementation of

IPlugin.pluginName

Defined in

data/groupitemmetadataprovider.ts:77

---

defaults

readonly static defaults: GroupItemMetadataProviderOptions

Defined in

data/groupitemmetadataprovider.ts:37

Methods

destroy()

destroy(): void

Returns

void

Implementation of

IPlugin.destroy

Defined in

data/groupitemmetadataprovider.ts:79

---

getOptions()

getOptions(): GroupItemMetadataProviderOptions

Returns

GroupItemMetadataProviderOptions

Defined in

data/groupitemmetadataprovider.ts:86

---

groupCellPosition()

groupCellPosition(): object

Returns

object

cell

cell: number = 0

colspan

colspan: number | "*"

Defined in

data/groupitemmetadataprovider.ts:156

---

handleGridClick()

handleGridClick(e, args): void

Parameters

e

MouseEvent

args

ArgsCell

Returns

void

Defined in

data/groupitemmetadataprovider.ts:94

---

handleGridKeyDown()

handleGridKeyDown(e, args): void

Parameters

e

KeyboardEvent

args

ArgsCell

Returns

void

Defined in

data/groupitemmetadataprovider.ts:120

---

init()

init(grid): void

Parameters

grid

Grid<any>

Returns

void

Implementation of

IPlugin.init

Defined in

data/groupitemmetadataprovider.ts:71

---

setOptions()

setOptions(value): void

Parameters

value

GroupItemMetadataProviderOptions

Returns

void

Defined in

data/groupitemmetadataprovider.ts:90

---

defaultGroupFormat()

static defaultGroupFormat(ctx, opt?): string

Parameters

ctx

FormatterContext<any>

opt?

GroupItemMetadataProviderOptions

Returns

string

Defined in

data/groupitemmetadataprovider.ts:53

---

defaultTotalsFormat()

static defaultTotalsFormat(ctx, grid?): string

Parameters

ctx

FormatterContext<any>

grid?

Grid<any>

Returns

string

Defined in

data/groupitemmetadataprovider.ts:63