API Docs for: v2.7.0
Show:

Utils.ModelsTableColumn Class

Extends Ember.Object
Defined in: addon/utils/column.js:17

Column definition class for ModelsTable columns

Check its public properties

Methods

cleanFilterString

() private

Defined in addon/utils/column.js:493

If preselected option doesn't exist after filterOptions update, filterString is reverted to empty string (basically, filtering for this column is dropped)

Properties

className

String

Defined in addon/utils/column.js:348

Custom class-name for cells in the current column. This class-name will also be added to the header and filter of the column

Default: ''

colspanForSortCell

Number

Defined in addon/utils/column.js:213

Colspan for cell in the filters-row

Default: 1

colspanForSortCell

Number

Defined in addon/utils/column.js:196

Colspan for cell in the sorting-row

Default: 1

component

String

Defined in addon/utils/column.js:69

Custom component used in the column's cells.

It will receive several options:

Default: ''

componentForEdit

String

Defined in addon/utils/column.js:98

Custom component used in the column's cells when the row is in edit mode

It will receive several options:

Default: ''

componentForFilterCell

String

Defined in addon/utils/column.js:136

Custom component used in the header cell with filter

It will receive several options:

Default: ''

componentForFooterCell

String

Defined in addon/utils/column.js:178

Custom component used in the footer cell

It will receive several options:

  • selectedItems - bound from ModelsTable.selectedItems
  • expandedItems - bound from ModelsTable.expandedItems
  • data - whole dataset passed to the models-table
  • mappedSelectedItems - selectedItems mapped by propertyName
  • mappedExpandedItems - expandedItems mapped by propertyName
  • mappedData - data mapped by propertyName

Default: ''

componentForSortCell

String

Defined in addon/utils/column.js:157

Custom component used in the header cell with sorting and column title

It will receive several options:

Default: ''

cssPropertyName

String private

Defined in addon/utils/column.js:409

defaultVisible

Boolean private

Defined in addon/utils/column.js:29

Value inverted to the isHidden initial value

It set on column init and not changed any more

disableFiltering

Boolean

Defined in addon/utils/column.js:267

If filtering should be disabled for this column

Default: false

disableSorting

Boolean

Defined in addon/utils/column.js:258

If sorting should be disabled for this column

Default: false

editable

Boolean

Defined in addon/utils/column.js:127

Is this column allowed to be editable

Default: true

filteredBy

String

Defined in addon/utils/column.js:285

Custom data's property that is used to filter column. If it isn't provided, propertyName is used

Default: null

filterField

String

Defined in addon/utils/column.js:484

filterFunction

Function

Defined in addon/utils/column.js:357

Custom function used to filter rows (used if filterWithSelect is false)

filterPlaceholder

String

Defined in addon/utils/column.js:373

Placeholder for filter-input

Default: ''

filterString

String

Defined in addon/utils/column.js:276

FilterString a default filtering for this column

Default: ''

filterUsed

Boolean private

Defined in addon/utils/column.js:443

filterWithSelect

Boolean

Defined in addon/utils/column.js:321

If true select-dropdown will be used for filtering by current column. Options are unique values for data.@each.${propertyName}

Default: false

isHidden

Boolean

Defined in addon/utils/column.js:303

Is current column hidden by default

Default: false

isVisible

Boolean private

Defined in addon/utils/column.js:419

mayBeHidden

Boolean

Defined in addon/utils/column.js:312

Can current column be hidden. This field determines, if column appears in the columns-dropdown. If mayBeHidden is true and isHidden is also true for column, this column always be hidden

Default: true

originalDefinition

Object private

Defined in addon/utils/column.js:398

Object containing the definition of the column passed into the component

Default: null

predefinedFilterOptions

String[] | Number[] | Boolean[]

Defined in addon/utils/column.js:339

List of option to the filter-box (used if filterWithSelect is true)

Default: null

propertyName

String

Defined in addon/utils/column.js:40

Field-name of the data's object shown in the current column. If it isn't provided, sorting and filtering options for current column are ignored

Default: ''

realColspanForFilterCell

Number private

Defined in addon/utils/column.js:222

Default: 1

realColspanForSortCell

Number private

Defined in addon/utils/column.js:205

Default: 1

routeName

String

Defined in addon/utils/column.js:382

If this property is defined, link to the route will be rendered in the cell. propertyName is used as an anchor. If it's not declared, id will be used.
Main idea for routeName is to provide a simple way to generate links for each model in the data. It should not be used for any other purposes

Default: ''

routeProperty

String

Defined in addon/utils/column.js:390

If this property is defined, link to the route will be rendered in the cell. routeProperty is used as an anchor. If it's not declared, id will be used.
Main idea for routeName is to provide a simple way to generate links for each model in the data. It should not be used for any other purposes

Default: ''

simple

Boolean

Defined in addon/utils/column.js:58

If true only propertyName will be shown in the column's cells and no components etc. Edit-mode won't affect such column.

If false column's cells will be processed as usual (components will be used to display data and for edit-mode)

Default: false

sortAsc

Boolean private

Defined in addon/utils/column.js:427

sortDesc

Boolean private

Defined in addon/utils/column.js:435

sortDirection

String

Defined in addon/utils/column.js:239

The default sorting for this column. Can be either asc or desc. Needs to be set in conjunction with sortPrecedence, otherwise it will not have any effect

Default: ''

sortedBy

String

Defined in addon/utils/column.js:230

Field-name for sorting by current column. If it isn't provided, propertyName is used

Default: null

sortField

String

Defined in addon/utils/column.js:463

sortFilterOptions

Boolean

Defined in addon/utils/column.js:330

Should options in the select-box be sorted

Default: false

sortFunction

Function

Defined in addon/utils/column.js:365

Optional custom function used to sort rows

sorting

Boolean

Defined in addon/utils/column.js:294

Sorting is column sorted now

Default: false

sortPrecedence

Number

Defined in addon/utils/column.js:249

Sort precedence for this column - needs to be larger than -1 for sortDirection to take effect

Default: ''

title

String

Defined in addon/utils/column.js:49

Header for column. If it isn't provided, capitalized propertyName is used

Default: ''

useFilter

Boolean private

Defined in addon/utils/column.js:472

Allow filtering for column or not

useSorting

Boolean private

Defined in addon/utils/column.js:451

Allow sorting for column or not