Class: DataMap

Methods

dataMap.js#L685

clear()

Clears the data array.

dataMap.js#L696

clearLengthCache()

Clear cached data length.

dataMap.js#L144

colToProp(col){Number}

Returns property name that corresponds with the given column index.

Parameters:

Name	Type	Description
col	Number	Visual column index.

Returns: {Number} Physical column index.

dataMap.js#L261

createCol(index, amount, source){Number}

Creates col at the right of the data array.

Parameters:

Name	Type	Default	Description
index	Number		optional Visual index of the column before which the new column will be inserted
amount	Number	1	optional An amount of columns to add.
source	String		optional Source of method call.

Fires:

• Hooks#event:afterCreateCol

Returns: {Number} Returns number of created columns

dataMap.js#L197

createRow(index, amount, source){Number}

Creates row at the bottom of the data array.

Parameters:

Name	Type	Default	Description
index	Number		optional Physical index of the row before which the new row will be inserted.
amount	Number	1	optional An amount of rows to add.
source	String		optional Source of method call.

Fires:

• Hooks#event:afterCreateRow

Returns: {Number} Returns number of created rows.

dataMap.js#L851

destroy()

Destroy instance.

dataMap.js#L480

filterData(index, amount){Array}

Filter unwanted data elements from the data source.

Parameters:

Name	Type	Description
index	Number	Visual index of the element to remove.
amount	Number	Number of rows to add/remove.

Returns: {Array}

dataMap.js#L497

get(row, prop)

Returns single value from the data array.

Parameters:

Name	Type	Description
row	Number	Visual row index.
prop	Number

dataMap.js#L751

getAll(){Array}

Returns the data array.

Returns: {Array}

dataMap.js#L568

getCopyable(row, prop){String}

Returns single value from the data array (intended for clipboard copy to an external application).

Parameters:

Name	Type	Description
row	Number	Physical row index.
prop	Number

Returns: {String}

dataMap.js#L832

getCopyableText(start, end){String}

Return data as copyable text (tab separated columns intended for clipboard copy to an external application).

Parameters:

Name	Type	Description
start	Object	optional Start selection position. Visual indexes.
end	Object	optional End selection position. Visual indexes.

Returns: {String}

dataMap.js#L705

getLength(){Number}

Get data length.

Returns: {Number}

dataMap.js#L777

getRange(start, end, destination){Array}

Returns data range as array.

Parameters:

Name	Type	Description
start	Object	optional Start selection position. Visual indexes.
end	Object	optional End selection position. Visual indexes.
destination	Number	Destination of datamap.get

Returns: {Array}

dataMap.js#L175

getSchema(){Object}

Returns: {Object}

dataMap.js#L821

getText(start, end){String}

Return data as text (tab separated columns).

Parameters:

Name	Type	Description
start	Object	optional Start selection position. Visual indexes.
end	Object	optional End selection position. Visual indexes.

Returns: {String}

dataMap.js#L159

propToCol(prop){*}

Parameters:

Name	Type	Description
prop	Object

Fires:

• Hooks#event:modifyCol

Returns: {*}

dataMap.js#L68

recursiveDuckColumns(schema, lastCol, parent){Number}

Parameters:

Name	Type	Description
schema	Object
lastCol	Number
parent	Number

Returns: {Number}

dataMap.js#L58

recursiveDuckSchema(object){Object|Array}

Parameters:

Name	Type	Description
object	Object | Array

Returns: {Object|Array}

dataMap.js#L359

removeCol(index, amount, source)

Removes column from the data array.

Parameters:

Name	Type	Default	Description
index	Number		optional Visual index of the column to be removed. If not provided, the last column will be removed
amount	Number	1	optional Amount of the columns to be removed. If not provided, one column will be removed
source	String		optional Source of method call.

Fires:

• Hooks#event:beforeRemoveCol
• Hooks#event:afterRemoveCol

dataMap.js#L324

removeRow(index, amount, source)

Removes row from the data array.

Parameters:

Name	Type	Default	Description
index	Number		optional Visual index of the row to be removed. If not provided, the last row will be removed
amount	Number	1	optional Amount of the rows to be removed. If not provided, one row will be removed
source	String		optional Source of method call.

Fires:

• Hooks#event:beforeRemoveRow
• Hooks#event:afterRemoveRow

dataMap.js#L583

set(row, prop, value, source)

Saves single value to the data array.

Parameters:

Name	Type	Description
row	Number	Visual row index.
prop	Number
value	String
source	String	optional Source of hook runner.

dataMap.js#L416

spliceCol(col, index, amount, elements){Array}

Add/Removes data from the column.

Parameters:

Name	Type	Description
col	Number	Physical index of column in which do you want to do splice
index	Number	Index at which to start changing the array. If negative, will begin that many elements from the end
amount	Number	An integer indicating the number of old array elements to remove. If amount is 0, no elements are removed
elements	Array	optional

Returns: {Array} Returns removed portion of columns

dataMap.js#L465

spliceData(index, amount, element)

Add/remove row(s) to/from the data source.

Parameters:

Name	Type	Description
index	Number	Physical index of the element to remove.
amount	Number	Number of rows to add/remove.
element	Object	Row to add.

dataMap.js#L442

spliceRow(row, index, amount, elements){Array}

Add/Removes data from the row.

Parameters:

Name	Type	Description
row	Number	Physical index of row in which do you want to do splice
index	Number	Index at which to start changing the array. If negative, will begin that many elements from the end.
amount	Number	An integer indicating the number of old array elements to remove. If amount is 0, no elements are removed.
elements	Array	optional

Returns: {Array} Returns removed portion of rows

dataMap.js#L664

visualColumnsToPhysical(index, amount){Array}

Parameters:

Name	Type	Description
index		Visual column index.
amount

Returns: {Array}

dataMap.js#L640

visualRowsToPhysical(index, amount){Number}

This ridiculous piece of code maps rows Id that are present in table data to those displayed for user.
The trick is, the physical row id (stored in settings.data) is not necessary the same
as the visual (displayed) row id (e.g. when sorting is applied).

Parameters:

Name	Type	Description
index	Number	Visual row index.
amount	Number

Fires:

• Hooks#event:modifyRow

Returns: {Number}