@serenity-is/sleekgrid / GroupItemMetadataProvider

Class: GroupItemMetadataProvider

Table of contents

Constructors

• constructor

Properties

• getGroupRowMetadata
• getTotalsRowMetadata
• grid
• options
• pluginName
• defaults

Methods

• destroy
• getOptions
• groupCellPosition
• handleGridClick
• handleGridKeyDown
• init
• setOptions
• defaultGroupFormat
• defaultTotalsFormat

Constructors

constructor

• new GroupItemMetadataProvider(opt?)

Parameters

Name	Type
opt?	GroupItemMetadataProviderOptions

Defined in

data/groupitemmetadataprovider.ts:29

Properties

getGroupRowMetadata

• getGroupRowMetadata: (item: Group<any>) => ItemMetadata<any>

Type declaration

▸ (item): ItemMetadata<any>

Parameters

Name	Type
item	Group<any>

Returns

ItemMetadata<any>

Defined in

data/groupitemmetadataprovider.ts:193

---

getTotalsRowMetadata

• getTotalsRowMetadata: (item: GroupTotals<any>) => ItemMetadata<any>

Type declaration

▸ (item): ItemMetadata<any>

Parameters

Name	Type
item	GroupTotals<any>

Returns

ItemMetadata<any>

Defined in

data/groupitemmetadataprovider.ts:217

---

grid

• Protected grid: Pick<Grid<any>, "groupTotalsFormatter" | "onClick" | "onKeyDown" | "getColumns" | "getData" | "getDataItem" | "getRenderedRange" | "getActiveCell">

Defined in

data/groupitemmetadataprovider.ts:26

---

options

• Private options: GroupItemMetadataProviderOptions

Defined in

data/groupitemmetadataprovider.ts:27

---

pluginName

• Readonly pluginName: "GroupItemMetadataProvider"

Defined in

data/groupitemmetadataprovider.ts:77

---

defaults

▪ Static Readonly defaults: GroupItemMetadataProviderOptions

Defined in

data/groupitemmetadataprovider.ts:37

Methods

destroy

▸ destroy(): void

Returns

void

Defined in

data/groupitemmetadataprovider.ts:79

---

getOptions

▸ getOptions(): GroupItemMetadataProviderOptions

Returns

GroupItemMetadataProviderOptions

Defined in

data/groupitemmetadataprovider.ts:86

---

groupCellPosition

▸ groupCellPosition(): Object

Returns

Object

Name	Type
cell	number
colspan	number | "*"

Defined in

data/groupitemmetadataprovider.ts:156

---

handleGridClick

▸ handleGridClick(e, args): void

Parameters

Name	Type
e	MouseEvent
args	ArgsCell

Returns

void

Defined in

data/groupitemmetadataprovider.ts:94

---

handleGridKeyDown

▸ handleGridKeyDown(e, args): void

Parameters

Name	Type
e	KeyboardEvent
args	ArgsCell

Returns

void

Defined in

data/groupitemmetadataprovider.ts:120

---

init

▸ init(grid): void

Parameters

Name	Type
grid	Pick<Grid<any>, "groupTotalsFormatter" | "onClick" | "onKeyDown" | "getColumns" | "getData" | "getDataItem" | "getRenderedRange" | "getActiveCell">

Returns

void

Defined in

data/groupitemmetadataprovider.ts:71

---

setOptions

▸ setOptions(value): void

Parameters

Name	Type
value	GroupItemMetadataProviderOptions

Returns

void

Defined in

data/groupitemmetadataprovider.ts:90

---

defaultGroupFormat

▸ Static defaultGroupFormat(ctx, opt?): string

Parameters

Name	Type
ctx	FormatterContext<any>
opt?	GroupItemMetadataProviderOptions

Returns

string

Defined in

data/groupitemmetadataprovider.ts:53

---

defaultTotalsFormat

▸ Static defaultTotalsFormat(ctx, grid?): string

Parameters

Name	Type
ctx	FormatterContext<any>
grid?	Pick<Grid<any>, "groupTotalsFormatter" | "onClick" | "onKeyDown" | "getColumns" | "getData" | "getDataItem" | "getRenderedRange" | "getActiveCell">

Returns

string

Defined in

data/groupitemmetadataprovider.ts:63