API Docs for: 3.0.1.91d25ad1
Show:

Utils.ModelsTableColumn Class

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

Column definition class for ModelsTable columns

Check its public properties

Methods

cleanFilterString

() protected

Defined in addon/utils/column.js:522

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

Properties

__mt

Components.ModelsTable private

Defined in addon/utils/column.js:408

className

String

Defined in addon/utils/column.js:344

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: ''

colspanForFilterCell

Number

Defined in addon/utils/column.js:209

Colspan for cell in the filters-row

Default: 1

colspanForSortCell

Number

Defined in addon/utils/column.js:192

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:97

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:134

Custom component used in the header cell with filter

It will receive several options:

Default: ''

componentForFooterCell

String

Defined in addon/utils/column.js:174

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:154

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

It will receive several options:

Default: ''

cssPropertyName

String protected

Defined in addon/utils/column.js:424

data

Object[] protected

Defined in addon/utils/column.js:415

Default: []

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:263

If filtering should be disabled for this column

Default: false

disableSorting

Boolean

Defined in addon/utils/column.js:254

If sorting should be disabled for this column

Default: false

editable

Boolean | Function

Defined in addon/utils/column.js:125

Is this column allowed to be editable

Default: true

filteredBy

String

Defined in addon/utils/column.js:281

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

Default: null

filterField

String protected

Defined in addon/utils/column.js:512

filterFunction

Function

Defined in addon/utils/column.js:353

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

Default: null

filterPlaceholder

String

Defined in addon/utils/column.js:371

Placeholder for filter-input

Default: ''

filterString

String

Defined in addon/utils/column.js:272

FilterString a default filtering for this column

Default: ''

filterUsed

Boolean protected

Defined in addon/utils/column.js:461

Default: false

filterWithSelect

Boolean

Defined in addon/utils/column.js:317

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:299

Is current column hidden by default

Default: false

isVisible

Boolean protected

Defined in addon/utils/column.js:434

Default: true

mayBeHidden

Boolean

Defined in addon/utils/column.js:308

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 protected

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:335

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 protected

Defined in addon/utils/column.js:218

Default: 1

realColspanForSortCell

Number protected

Defined in addon/utils/column.js:201

Default: 1

routeName

String

Defined in addon/utils/column.js:380

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:389

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 protected

Defined in addon/utils/column.js:443

Default: true

sortDesc

Boolean protected

Defined in addon/utils/column.js:452

Default: false

sortDirection

String

Defined in addon/utils/column.js:235

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:226

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

Default: null

sortField

String protected

Defined in addon/utils/column.js:483

sortFilterOptions

Boolean

Defined in addon/utils/column.js:326

Should options in the select-box be sorted

Default: false

sortFunction

Function

Defined in addon/utils/column.js:362

Optional custom function used to sort rows

Default: null

sorting

String

Defined in addon/utils/column.js:290

Sort direction for column

Default: ''

sortPrecedence

Number

Defined in addon/utils/column.js:245

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

Default: null

title

String

Defined in addon/utils/column.js:49

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

Default: ''

useFilter

Boolean protected

Defined in addon/utils/column.js:496

Allow filtering for column or not

Default: true

useSorting

Boolean protected

Defined in addon/utils/column.js:470

Allow sorting for column or not

Default: true