Row

Represents a single rendered row in the grid. Consists of one row element for each SubGrid in use. The grid only creates as many rows as needed to fill the current viewport (and a buffer). As the grid scrolls the rows are repositioned and reused, there is not a one-to-one relation between rows and records.

For normal use cases you should not have to use this class directly. Rely on using renderers instead.

Configs

1
cls: String | DomClassList | Object<String, (Boolean|Number)>Also a property

The class name to initially add to all row elements

Properties

18

Class hierarchy

isRow: Boolean= truereadonly
Identifies an object as an instance of Row class, or subclass thereof.
isRow: Boolean= truereadonlystatic
Identifies an object as an instance of Row class, or subclass thereof.

Other

bottom: Numberreadonly

Row bottom coordinate

cells: HTMLElement[]readonly

Row cell elements

cls: DomClassListAlso a config

When read, this a DomClassList of class names to be applied to this Row's elements.

It can be set using Object notation where each property name with a truthy value is added as a class, or as a regular space-separated string.

dataIndex: Number

Get/set this rows current index in grids store

element: HTMLElementreadonly

The row element, only applicable when not using multiple grid sections (see elements)

elements: Object<String, HTMLElement>readonly

An object, keyed by region name (for example locked and normal) containing the elements which comprise the full row.

height: Number

Get/set row height

id: String | Number

Get/set id for currently rendered record

index: Numberreadonly

Get index in RowManagers rows array

isFirst: Booleanreadonly

Is this the very first row?

offsetHeight: Number

Get row height including border

top: Numberreadonly

Row top coordinate

Lifecycle

configBase
isConstructingBase
isDestroyedBase
isDestroyingBase

Functions

23

Other

addCls

Add CSS classes to each element.

ParameterTypeDescription
classesString | Object<String, (Boolean|Number)> | DomClassList
assignCls

Adds/removes class names according to the passed object's properties.

Properties with truthy values are added. Properties with false values are removed.

ParameterTypeDescription
classesObject<String, (Boolean|Number)>

Object containing properties to set/clear

eachCell

Execute supplied function for each cell.

ParameterTypeDescription
fnfunction
eachElement

Execute supplied function for each regions element.

ParameterTypeDescription
fnfunction
getCell

Get the cell element for the specified column.

ParameterTypeDescription
columnIdString | Number

Column id

Returns: HTMLElement -

Cell element

getCells

Get cell elements for specified region.

ParameterTypeDescription
regionString

Region to get elements for

Returns: HTMLElement[] -

Array of cell elements

getElement

Get the element for the specified region.

ParameterTypeDescription
regionString
Returns: HTMLElement
getRectangle

Get the element bounds for the specified region of this Row.

ParameterTypeDescription
regionString
Returns: Rectangle
removeCls

Remove CSS classes from each element.

ParameterTypeDescription
classesString | Object<String, (Boolean|Number)> | DomClassList
toggleCls

Toggle CSS classes for each element.

ParameterTypeDescription
classesObject<String, (Boolean|Number)> | DomClassList | String
addBoolean

Configuration

applyDefaultsstaticBase

Events

detachListenersBase

Lifecycle

constructBase
destroystaticBase
doDestroyBase
setConfigBase

Misc

animatePropertyBase
callbackBase
downloadTestCaseBase
initClassstaticBase
isOfTypeNamestaticBase
mixinstaticBase
resolveCallbackBase