Class: Table
January 18, 2022 · View on GitHub
Kui API Documentation - v11.0.0 / @kui-shell/core / Table
Class: Table<RowType>
@kui-shell/core.Table
Type parameters
| Name | Type |
|---|---|
RowType | extends Row = Row |
Table of contents
Constructors
Properties
- allowedPresentations
- body
- breadcrumbs
- coldStartColumnIdx
- colorBy
- completeColumnIdx
- defaultPresentation
- drilldownTo
- durationColumnIdx
- flexWrap
- fontawesome
- fontawesomeBalloon
- fontawesomeCSS
- footer
- header
- markdown
- nFooterMessages
- noSort
- queueingDelayColumnIdx
- resourceVersion
- startColumnIdx
- statusColumnIdx
- style
- tableCSS
- title
Constructors
constructor
• new Table<RowType>(table)
Type parameters
| Name | Type |
|---|---|
RowType | extends Row<RowType> = Row |
Parameters
| Name | Type |
|---|---|
table | Table<Row> |
Defined in
packages/core/src/webapp/models/table.ts:216
Properties
allowedPresentations
• Optional allowedPresentations: PresentationStyle[]
Allowed presentations?
Defined in
packages/core/src/webapp/models/table.ts:165
body
• body: RowType[]
Defined in
packages/core/src/webapp/models/table.ts:146
breadcrumbs
• Optional breadcrumbs: Breadcrumb[] | () => Breadcrumb[]
Defined in
packages/core/src/webapp/models/table.ts:204
coldStartColumnIdx
• Optional coldStartColumnIdx: number
Column index to be interpreted as a time to initialize the computation
Defined in
packages/core/src/webapp/models/table.ts:174
colorBy
• Optional colorBy: "default" | "status" | "duration"
Coloring strategy for e.g. 'grid' and 'sequence-diagram' and 'histogram'
Defined in
packages/core/src/webapp/models/table.ts:186
completeColumnIdx
• Optional completeColumnIdx: number
Column index to be interpreted as a complete timestamp column
Defined in
packages/core/src/webapp/models/table.ts:183
defaultPresentation
• Optional defaultPresentation: PresentationStyle
Default presentation?
Defined in
packages/core/src/webapp/models/table.ts:162
drilldownTo
• Optional drilldownTo: "side-split" | "this-split" | "new-window"
Should drilldowns go to a side split, or to this split? Default:
side-split, unless the user chords the click with the Meta key
(which is Command on macOS, and Option on Linux/Windows
Defined in
packages/core/src/webapp/models/table.ts:159
durationColumnIdx
• Optional durationColumnIdx: number
Column index to be interpreted as a duration column
Defined in
packages/core/src/webapp/models/table.ts:171
flexWrap
• Optional flexWrap: number | boolean
Defined in
packages/core/src/webapp/models/table.ts:206
fontawesome
• Optional fontawesome: string
Defined in
packages/core/src/webapp/models/table.ts:210
fontawesomeBalloon
• Optional fontawesomeBalloon: string
Defined in
packages/core/src/webapp/models/table.ts:214
fontawesomeCSS
• Optional fontawesomeCSS: string
Defined in
packages/core/src/webapp/models/table.ts:212
footer
• Optional footer: string[]
Defined in
packages/core/src/webapp/models/table.ts:192
header
• Optional header: RowType & { isSortable?: boolean }
Defined in
packages/core/src/webapp/models/table.ts:190
markdown
• Optional markdown: boolean
Markdown cells?
Defined in
packages/core/src/webapp/models/table.ts:149
nFooterMessages
• Optional nFooterMessages: number
E.g. when displaying events for a Kubernetes table, how many events to show in the viewport. Use -1 to show them all. [Default: 6]
Defined in
packages/core/src/webapp/models/table.ts:199
noSort
• Optional noSort: boolean
Defined in
packages/core/src/webapp/models/table.ts:201
queueingDelayColumnIdx
• Optional queueingDelayColumnIdx: number
Column index to be interpreted as a time spent in a run queue
Defined in
packages/core/src/webapp/models/table.ts:177
resourceVersion
• Optional resourceVersion: string | number
This field helps with watching/paginating
Defined in
packages/core/src/webapp/models/table.ts:152
startColumnIdx
• Optional startColumnIdx: number
Column index to be interpreted as a start timestamp column
Defined in
packages/core/src/webapp/models/table.ts:180
statusColumnIdx
• Optional statusColumnIdx: number
Column index to be interpreted as a status column
Defined in
packages/core/src/webapp/models/table.ts:168
style
• Optional style: TableStyle
Defined in
packages/core/src/webapp/models/table.ts:188
tableCSS
• Optional tableCSS: string
Defined in
packages/core/src/webapp/models/table.ts:208
title
• Optional title: string