packages/components/eui-table/sortable-col/eui-table-sortable-col.component.ts
Component used internally by eui-table to make a column sortable.
OnInit
OnDestroy
| selector | th[sortable] |
| imports |
NgTemplateOutlet
FormsModule
ReactiveFormsModule
TranslateModule
EUI_ICON
EUI_BUTTON
EUI_BADGE
EUI_FEEDBACK_MESSAGE
EUI_SELECT
EUI_LABEL
EUI_DROPDOWN
|
| templateUrl | ./eui-table-sortable-col.component.html |
Properties |
Methods |
Inputs |
HostBindings |
Accessors |
| defaultMultiOrder |
Type : any
|
Default value : null
|
|
Whether the column is multi-sorted by default. |
| defaultOrder |
Type : boolean
|
Default value : false
|
|
Whether the column is sorted by default. |
| isMultiSortable |
Type : boolean
|
Default value : false
|
|
Whether the sorting of the column can be cumulated with the one of other column. |
| sortDisabled |
Type : boolean
|
Default value : false
|
|
Whether the sort is disabled on the column. |
| sortOn |
Type : string
|
| sortOrder |
Type : "asc" | "desc"
|
Default value : 'desc'
|
| class |
Type : string
|
| Public click |
click()
|
|
Handles the click event on the sortable column.
Returns :
void
|
| getOrderByIndex | ||||||
getOrderByIndex(index: number)
|
||||||
|
Parameters :
Returns :
string | null
|
| onCancelMultiSort |
onCancelMultiSort()
|
|
Returns :
void
|
| onClickMultisortOrder | |||||||||
onClickMultisortOrder(index: number, order: "asc" | "desc" | null)
|
|||||||||
|
Handles the click event on the multi-sortable column.
Parameters :
Returns :
void
|
| onOpenDropdown |
onOpenDropdown()
|
|
Returns :
void
|
| onSubmitMultiSort |
onSubmitMultiSort()
|
|
Returns :
void
|
| currentMultiSortPosition |
Type : number
|
Default value : 0
|
| dropdown |
Type : EuiDropdownComponent
|
Decorators :
@ViewChild(EuiDropdownComponent)
|
| error |
Default value : false
|
| form |
Type : FormGroup
|
| multisortParams |
Type : MultisortParam[]
|
Default value : []
|
| Public order |
Type : "asc" | "desc" | null
|
Default value : 'desc'
|
| cssClasses |
getcssClasses()
|
|
Computes and returns the CSS classes for the component based on its current state.
Returns :
string
|
| columns |
getcolumns()
|