Class: Data

Qv.Document.Object.Data

The object's underlying data

Classes

PageObject

Members

CellBorderStyles :Qv.Document.Object.Style

HTML style-properties regarding the cell border. Not applicable for all type of objects.
Type:

CellStyles :Qv.Document.Object.Style

HTML style-properties regarding the cell. Not applicable for all type of objects.
Type:

HeaderRows :Array.<Array.<Qv.Document.Object.HeaderCell>>

Header rows. Not applicable for all types of objects (e.g. line arrows, text objects).
Type:

Name :String

Internal QlikView name for the object
Type:
  • String

NewOffset :Qv.Document.Object.DataPage

New offset for paging. Not applicable for all types of objects.
Type:

PageOffset :Qv.Document.Object.DataPage

PageOffset. Not applicable for all types of objects.
Type:

PageSize :Qv.Document.Object.DataPage

Pagesize-object. Determines the size of the x and y-chunks. Not applicable for all types of objects.
Type:

Rows :Array.<Array.<Qv.Document.Object.DataCell>>

Rows as two-dimensional array [RowItem][Column]. Not applicable for all types of objects (e.g. line arrows, text objects).
Type:

Styles :Qv.Document.Object.Style

General styling.
Type:

TotalSize :Qv.Document.Object.DataPage

Total number of rows and columns. Not applicable for all types of objects.
Type:

Type :String

The type of Qlikview object.
Type:
  • String

Methods

ClearAllButThis()

Note! Only available for Listboxes
Example
lb.Data.ClearAllButThis();

ClearSelections()

Note! Only available for Listboxes, Tableboxes, MultiBoxes, Charts and Extensions.
Example
lb.Data.ClearSelections();

Cycle(steps, colNo)

Note! Only available for Extensions.
Parameters:
Name Type Description
steps Integer
colNo Integer

DrillUp(steps, colNo)

Note! Only available for Extensions.
Parameters:
Name Type Description
steps Integer
colNo Integer

GetEnabled()

Note! Only available for Listboxes
Example
var enabled = lb.Data.GetEnabled();

GetSelected()

Note! Only available for Listboxes
Example
var selected = lb.Data.GetSelected();

Lock()

Note! Only available for Listboxes
Example
lb.Data.Lock();

PageObject(owner, size, startopt)

Note! Only available for Listboxes, Tableboxes, Charts and Extensions.
Parameters:
Name Type Attributes Description
owner Object Data-object.
size Integer Number of items visible per page.
start Integer <optional>
 Starting page.
Example
this.Data.Page = new this.Data.PageObject(this.Data, 10, 1);
Note! Only available for Listboxes.
Parameters:
Name Type Attributes Description
searchString. String
toggle Boolean <optional>
 If true, existing selections will be kept.
Example
lb.Data.Search("Steven", false);

SearchColumn(colNo, searchString, toggle)

Note! Only available for Extensions.
Parameters:
Name Type Description
colNo Integer Column number.
searchString String Text to search for. You have to add "*" in order to do a wildcard search otherwise you will only get exact matches.
toggle Boolean If true, existing selections will be kept (or deselected if selected again)
Example
ch.Data.SearchColumn(1, "Democrat", false);

SelectAll()

Note! Only available for Listboxes
Example
lb.Data.SelectAll();

SelectExcluded()

Note! Only available for Listboxes
Example
lb.Data.SelectExcluded();

SelectPossible()

Note! Only available for Listboxes
Example
lb.Data.SelectPossible();

SelectRow(rowNo)

Selects a row. Note! Only available for Extensions.
Parameters:
Name Type Description
rowNo Integer
Example
extension.Data.SelectRow(2);

SelectTexts(recordsToSelect)

Note! Only available for Listboxes.
Selects the visible textrecords in a listbox. Each record you want to select is sent as a parameter to the function - infinite number of parameters are accepted - OR include the records in an array and pass in the array. The parameters must match the textrecord exactly. Use search-function if you instead want to select all possible records for a string.
Parameters:
Name Type Description
recordsToSelect Array.<String> | String Either an array or multiple parameters for each record
Example
// Multiple parameters
lb.Data.SelectTexts("George Washington", "Thomas Jefferson");

// Array
var arrRecords = ["George Washington", "Thomas Jefferson"];
lb.Data.SelectTexts(arrRecords);

SelectTextsInColumn(ColNo, toggleopt, recordsToSelect)

Note! Only available for Extensions.
Selects the visible textrecords in an Extension. Each record you want to select is sent as a parameter to the function - infinite number of parameters are accepted - OR include the records in an array and pass in the array. The parameters must match the textrecord exactly. Use search-function if you instead want to select all possible records for a string.
Parameters:
Name Type Attributes Description
ColNo Integer Column to select in.
toggle Boolean <optional>
 If true, existing selections will be kept (or deselected if selected again).
recordsToSelect Array.<String> | String Either an array or multiple parameters for each record.
Example
// Multiple parameters
this.Data.SelectTextsInColumn(0, false, "George Washington", "Thomas Jefferson");
// Array
var arrRecords = ["George Washington", "Thomas Jefferson"];
this.Data.SelectTextsInColumn(0, false, arrRecords);

SelectValues(values, toggleopt)

Note! Only available for Listboxes.
Selects the record corresponding to the value.
Parameters:
Name Type Attributes Description
values Integer | Array.<Integer> Multiple values can be passed as an array of int.
toggle Boolean <optional>
 If true, existing selections will be kept.

SelectValuesInColumn(colNo, values, toggleopt) → {void}

Note! Only available for Extensions.
Parameters:
Name Type Attributes Description
colNo Integer
values Array.<String> | String Either an array or a comma separated list of values.
toggle Boolean <optional>
 If true, existing selections will be kept.
Returns:
Type
void

SetOffset(pageOffset)

Note! Only available for Listboxes, Tableboxes, Charts and Extensions.
Get data from server starting at row (pageOffset.y) and col (pageOffset.x).
Parameters:
Name Type Description
pageOffset Object
Example
this.Data.SetOffset({x:0,y:200});

SetPagesize(pageSize) → {void}

Note! Only available for Listboxes, Tableboxes, Charts and Extensions.
Sets the number of data rows (pagesize.y) and cols (pagesize.x) to fetch from the server per request.
Parameters:
Name Type Description
pageSize Qv.Document.Object.DataPage Size.
Returns:
Type
void
Example
var pagesize = {};
pagesize.x = 10;
pagesize.y = 20;
this.Data.SetPagesize(pagesize);

SetPagesizeX(val) → {void}

Note! Only available for Listboxes, Tableboxes, Charts and Extensions.
Sets the number of data cols to fetch from the server per request.
Parameters:
Name Type Description
val Integer Size to set to.
Returns:
Type
void
Example
this.Data.SetPagesizeX(10);

SetPagesizeY(val) → {void}

Note! Only available for Listboxes, Tableboxes, Charts and Extensions.
Sets the number of data rows to fetch from the server per request.
Parameters:
Name Type Description
val Integer Size to set to.
Returns:
Type
void
Example
this.Data.SetPagesizeY(20);

Unlock()

Note! Only available for Listboxes
Example
lb.Data.Unlock();