HeaderCell

Description

The header cell for each column.

props

column

column: {
  type: PropType<Column>;
  required: true;
};

Description

The Column being rendered.

Type declaration

Member	Type
`type`	`PropType`<`Column`>
`required`	`true`

sortable

sortable: {
  type: BooleanConstructor;
  required: false;
  default: boolean;
};

Description

Whether sorting is enabled at the grid-level.

Default Value

false

Type declaration

Member	Type
`type`	`BooleanConstructor`
`required`	`false`
`default`	`boolean`

sort

sort: {
  type: PropType<Sort[]>;
  required: true;
};

Description

The current sort for the entire data grid.

Type declaration

Member	Type
`type`	`PropType`<`Sort`[]>
`required`	`true`

allowColumnReorder

allowColumnReorder: {
  type: BooleanConstructor;
  required: true;
};

Description

Whether to allow columns to be reordered using drag-and-drop powered by drag-drop-vueopen in new window.

Type declaration

Member	Type
`type`	`BooleanConstructor`
`required`	`true`

columnIndex

columnIndex: {
  type: NumberConstructor;
  required: true;
};

Description

The zero-based index of the column that defines the current column order.

Type declaration

Member	Type
`type`	`NumberConstructor`
`required`	`true`

totalColumnCount

totalColumnCount: {
  type: NumberConstructor;
  required: true;
};

Description

The total number of columns in the grid.

Type declaration

Member	Type
`type`	`NumberConstructor`
`required`	`true`

emits

onClick()

onClick(columnIndex): boolean

Parameters

Parameter	Type	Description
`columnIndex`	`number`	The zero-based index of the column that defines the current column order.

Returns

boolean

Description

Event emitted when the header cell is clicked. This is also emitted when the space bar is pressed and the header cell is focused.

onLeft()

onLeft(columnIndex): boolean

Parameters

Parameter	Type	Description
`columnIndex`	`number`	The zero-based index of the column that defines the current column order.

Returns

boolean

Description

Event emitted when the left arrow key is pressed and the header cell is focused.

onRight()

onRight(columnIndex): boolean

Parameters

Parameter	Type	Description
`columnIndex`	`number`	The zero-based index of the column that defines the current column order.

Returns

boolean

Description

Event emitted when the right arrow key is pressed and the header cell is focused.