Class ColumnOrder`Private`

Used for keeping track of and updating column order

Hierarchy

ColumnOrder

Index

Constructors

constructor

new ColumnOrder(args: {
    columns: (() => Column<unknown>[]);
    existingOrder?: Map<string, number>;
    save: ((order: Map<string, number>) => void);
}): ColumnOrder
Parameters
- args: {
      columns: (() => Column<unknown>[]);
      existingOrder?: Map<string, number>;
      save: ((order: Map<string, number>) => void);
  }
  - columns: (() => Column<unknown>[])
    - (): Column<unknown>[]
      
      Returns Column<unknown>[]
  - Optional existingOrder?: Map<string, number>
  - save: ((order: Map<string, number>) => void)
    - (order: Map<string, number>): void
      
      Parameters
      
      order: Map<string, number>
      
      Returns void
Returns ColumnOrder
- Defined in ember-headless-table/src/plugins/column-reordering/plugin.ts:189

Properties

`Private` args

args: {
    columns: (() => Column<unknown>[]);
    existingOrder?: Map<string, number>;
    save: ((order: Map<string, number>) => void);
}

Type declaration

columns: (() => Column<unknown>[])
- - (): Column<unknown>[]
  - Returns Column<unknown>[]
Optional existingOrder?: Map<string, number>
save: ((order: Map<string, number>) => void)
- - (order: Map<string, number>): void
  - Parameters
    - order: Map<string, number>
    Returns void

map

map: TrackedMap<string, number> = ...

This map will be empty until we re-order something.

Accessors

adjustedColumns

get adjustedColumns(): Column<unknown>[]
When columns are removed or hidden, our positions don't change but when doing the math, we want to adjust things based on 0-indexed counting

TODO: figure out if we need this??

Returns Column<unknown>[]
- Defined in ember-headless-table/src/plugins/column-reordering/plugin.ts:367

orderedColumns

get orderedColumns(): Column<unknown>[]
Returns Column<unknown>[]
- Defined in ember-headless-table/src/plugins/column-reordering/plugin.ts:372

orderedMap

get orderedMap(): ReadonlyMap<string, number>
The same as this.map, but with all the columns' information

Returns ReadonlyMap<string, number>
- Defined in ember-headless-table/src/plugins/column-reordering/plugin.ts:356

Methods

get

get(key: string): number
Parameters
- key: string
Returns number
- Defined in ember-headless-table/src/plugins/column-reordering/plugin.ts:340

moveLeft

moveLeft(key: string): void
To account for columnVisibilty, we need to:
- get the list of visible columns
- get the column order (which preserves the order of hidden columns)
- skip over non-visible columns when determining the previous "index"
- set the position to whatever that is.
Parameters
- key: string
Returns void
- Defined in ember-headless-table/src/plugins/column-reordering/plugin.ts:208

moveRight

moveRight(key: string): void
To account for columnVisibilty, we need to:
- get the list of visible columns
- get the column order (which preserves the order of hidden columns)
- skip over non-visible columns when determining the next "index"
- set the position to whatever that is.
Parameters
- key: string
Returns void
- Defined in ember-headless-table/src/plugins/column-reordering/plugin.ts:241

swapWith

swapWith(key: string, position: number): undefined | false
Performs a swap of the column's position with the column at position
Parameters
- key: string
- position: number
Returns undefined | false
- Defined in ember-headless-table/src/plugins/column-reordering/plugin.ts:270

Class ColumnOrderPrivate

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

args: { columns: (() => Column<unknown>[]); existingOrder?: Map<string, number>; save: ((order: Map<string, number>) => void); }

columns: (() => Column<unknown>[])

Returns Column<unknown>[]

Optional existingOrder?: Map<string, number>

save: ((order: Map<string, number>) => void)

Parameters

order: Map<string, number>

Returns void

Returns ColumnOrder

Properties

Private args

Type declaration

columns: (() => Column<unknown>[])

Returns Column<unknown>[]

Optional existingOrder?: Map<string, number>

save: ((order: Map<string, number>) => void)

Parameters

order: Map<string, number>

Returns void

map

Accessors

adjustedColumns

Returns Column<unknown>[]

orderedColumns

Returns Column<unknown>[]

orderedMap

Returns ReadonlyMap<string, number>

Methods

get

Parameters

key: string

Returns number

moveLeft

Parameters

key: string

Returns void

moveRight

Parameters

key: string

Returns void

swapWith

Parameters

key: string

position: number

Returns undefined | false

Settings

Member Visibility

Theme

Class ColumnOrder`Private`

args: {
columns: (() => Column<unknown>[]);
existingOrder?: Map<string, number>;
save: ((order: Map<string, number>) => void);
}

`Optional` existingOrder?: Map<string, number>

`Private` args

`Optional` existingOrder?: Map<string, number>