Class Table<DataType>

Type Parameters

DataType = unknown

Hierarchy

Resource<Signature<DataType>>
- Table

Constructors

constructor

new Table<DataType>(owner: unknown): Table<DataType>
Type Parameters
- DataType = unknown
Parameters
- owner: unknown
Returns Table<DataType>
Inherited from Resource<Signature<DataType>>.constructor
- Defined in node_modules/.pnpm/ember-resources@5.4.0_gv6j52yonbqt3c433e2sdxgmyu/node_modules/ember-resources/dist/core/class-based/resource.d.ts:248

Properties

`Private` `Optional` #page

#page?: number

Deprecated

this should be moved to a "pagination" plugin

`Private` [TABLE_KEY]

[TABLE_KEY]: string = ...

`Private` args

args: {
named: TableConfig<DataType>;
}

Type declaration

named: TableConfig<DataType>

columns

columns: MappedArray<Column<DataType>> = ...

`Private` defaultColumnConfig

defaultColumnConfig: {
isVisible: boolean;
minWidth: number;
} = DEFAULT_COLUMN_CONFIG

Type declaration

isVisible: boolean
minWidth: number

modifiers

modifiers: {
columnHeader: FunctionBasedModifier<{}>;
container: FunctionBasedModifier<{}>;
} = ...

Collection of utility modifiers that are the result of composing modifiers from plugins.

Using this is optional, and you can "just" use modifiers from specific plugins in specific places if you wish -- but these exists as a "convenience".

These are all no-use, no-cost utilities

Type declaration

columnHeader: FunctionBasedModifier<{}>
container: FunctionBasedModifier<{}>

preferences

preferences: TablePreferences

Interact with, save, modify, etc the preferences for the table, plugins, columns, etc

rows

rows: MappedArray<Row<DataType>> = ...

`Optional` `Private` scrollContainerElement

scrollContainerElement?: HTMLElement

`Optional` `Private` scrollContainerHeight

scrollContainerHeight?: number

`Optional` `Private` scrollContainerWidth

scrollContainerWidth?: number

Accessors

bulkSelection

get bulkSelection(): undefined | Selection<object>
Deprecated
This will soon be extracted to a plugin

Returns undefined | Selection<object>
- Defined in ember-headless-table/src/-private/table.ts:204

config

get config(): TableConfig<DataType>
Private
Returns TableConfig<DataType>
- Defined in ember-headless-table/src/-private/table.ts:195

hasActiveRow

get hasActiveRow(): boolean
Deprecated
This will soon be extracted to a plugin

Returns boolean
- Defined in ember-headless-table/src/-private/table.ts:213

hasCheckboxSelection

get hasCheckboxSelection(): boolean
Deprecated
This will soon be extracted to a plugin

Returns boolean
- Defined in ember-headless-table/src/-private/table.ts:222

isAtDefaultSettings

get isAtDefaultSettings(): boolean
Will return true if the default is at its default state. false otherwise.

Returns boolean
- Defined in ember-headless-table/src/-private/table.ts:230

isCheckboxSelectable

get isCheckboxSelectable(): boolean
Deprecated
This will soon be extracted to a plugin

Returns boolean
- Defined in ember-headless-table/src/-private/table.ts:239

isPaginated

get isPaginated(): boolean
Deprecated
This will soon be extracted to a plugin

Returns boolean
- Defined in ember-headless-table/src/-private/table.ts:257

isRowSelectable

get isRowSelectable(): boolean
Deprecated
This will soon be extracted to a plugin

Returns boolean
- Defined in ember-headless-table/src/-private/table.ts:248

pagination

get pagination(): undefined | Pagination
Deprecated
This will soon be extracted to a plugin

Returns undefined | Pagination
- Defined in ember-headless-table/src/-private/table.ts:266

plugins

get plugins(): Plugin<unknown, unknown>[]
Private
For all configured plugins, instantiates each one. If the plugins argument changes to the Table (either directly or through headlessTable, all state is lost and re-created)

Returns Plugin<unknown, unknown>[]
- Defined in ember-headless-table/src/-private/table.ts:158

rowSelection

get rowSelection(): Set<unknown>
Deprecated
This will soon be extracted to a plugin

Returns Set<unknown>
- Defined in ember-headless-table/src/-private/table.ts:275

totalRowCount

get totalRowCount(): number
Deprecated
This will soon be extracted to a plugin

Returns number
- Defined in ember-headless-table/src/-private/table.ts:310

totalRowsSelectedCount

get totalRowsSelectedCount(): undefined | number
Deprecated
This will soon be extracted to a plugin

Returns undefined | number
- Defined in ember-headless-table/src/-private/table.ts:319

value

get value(): this
Private
TODO: what's this for?

Returns this
- Defined in ember-headless-table/src/-private/table.ts:328

Methods

`Private` #maybeResetScrollContainer

#maybeResetScrollContainer(): void
Internal
Resets the scroll position of the scroll container if the page has changed.

Returns void
- Defined in ember-headless-table/src/-private/table.ts:337

`Private` modify

modify(_: undefined | [], named: TableConfig<DataType>): void
Private
Parameters
- _: undefined | []
- named: TableConfig<DataType>
Returns void
Overrides Resource.modify
- Defined in ember-headless-table/src/-private/table.ts:94

pluginOf

pluginOf(klass: Class<Plugin<unknown, unknown>>): undefined | Plugin<unknown, unknown>
Get the active plugin instance for the given plugin class
Parameters
- klass: Class<Plugin<unknown, unknown>>
Returns undefined | Plugin<unknown, unknown>
- Defined in ember-headless-table/src/-private/table.ts:188

`Private` resetScrollContainer

resetScrollContainer(): void
Private
Returns void
- Defined in ember-headless-table/src/-private/table.ts:348

resetToDefaults

resetToDefaults(): void
Returns void
- Defined in ember-headless-table/src/-private/table.ts:355

selectRow

selectRow(row: Row<DataType>): void
Deprecated
This will soon be extracted to a plugin
Parameters
- row: Row<DataType>
Returns void
- Defined in ember-headless-table/src/-private/table.ts:365

unselectRow

unselectRow(_row: Row<DataType>): void
Deprecated
This will soon be extracted to a plugin
Parameters
- _row: Row<DataType>
Returns void
- Defined in ember-headless-table/src/-private/table.ts:375

Class Table<DataType>

Type Parameters

DataType = unknown

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

DataType = unknown

Parameters

owner: unknown

Returns Table<DataType>

Properties

Private Optional #page

Deprecated

Private [TABLE_KEY]

Private args

Type declaration

named: TableConfig<DataType>

columns

Private defaultColumnConfig

Type declaration

isVisible: boolean

minWidth: number

modifiers

Type declaration

columnHeader: FunctionBasedModifier<{}>

container: FunctionBasedModifier<{}>

preferences

rows

Optional Private scrollContainerElement

Optional Private scrollContainerHeight

Optional Private scrollContainerWidth

Accessors

bulkSelection

Deprecated

Returns undefined | Selection<object>

config

Returns TableConfig<DataType>

hasActiveRow

Deprecated

Returns boolean

hasCheckboxSelection

Deprecated

Returns boolean

isAtDefaultSettings

Returns boolean

isCheckboxSelectable

Deprecated

Returns boolean

isPaginated

Deprecated

Returns boolean

isRowSelectable

Deprecated

Returns boolean

pagination

Deprecated

Returns undefined | Pagination

plugins

Returns Plugin<unknown, unknown>[]

rowSelection

Deprecated

Returns Set<unknown>

totalRowCount

Deprecated

Returns number

totalRowsSelectedCount

Deprecated

Returns undefined | number

value

Returns this

Methods

Private #maybeResetScrollContainer

Returns void

Private modify

`Private` `Optional` #page

`Private` [TABLE_KEY]

`Private` args

`Private` defaultColumnConfig

`Optional` `Private` scrollContainerElement

`Optional` `Private` scrollContainerHeight

`Optional` `Private` scrollContainerWidth

`Private` #maybeResetScrollContainer

`Private` modify

`Private` resetScrollContainer