Getting Started | Class Index

Classes


Class Qv.Document.Object.Data

The object's underlying data

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
 
HTML style-properties regarding the cell border.
 
HTML style-properties regarding the cell.
 
Header rows.
 
Internal QlikView name for the object
 
New offset for paging.
 
PageOffset.
 
Pagesize-object.
 
Rows as two-dimensional array [RowItem][Column].
 
General styling.
 
Total number of rows and columns.
 
The type of Qlikview object.
Method Summary
Method Attributes Method Name and Description
 
Note! Only available for Listboxes
 
Note! Only available for Listboxes, Tableboxes, MultiBoxes, Charts and Extensions.
 
Cycle(steps, colNo)
Note! Only available for Extensions.
 
DrillUp(steps, colNo)
Note! Only available for Extensions.
 
Note! Only available for Listboxes
 
Note! Only available for Listboxes
 
Lock()
Note! Only available for Listboxes
 
PageObject(owner, size, start)
Note! Only available for Listboxes, Tableboxes, Charts and Extensions.
 
Search(toggle)
Note! Only available for Listboxes.
 
SearchColumn(colNo, searchString, toggle)
Note! Only available for Extensions.
 
Note! Only available for Listboxes
 
Note! Only available for Listboxes
 
Note! Only available for Listboxes
 
SelectRow(rowNo)
Selects a row.
 
SelectTexts(recordsToSelect)
Note! Only available for Listboxes.
 
SelectTextsInColumn(Column, toggle, recordsToSelect)
Note! Only available for Extensions.
 
SelectValues(values, toggle)
Note! Only available for Listboxes.
 
SelectValuesInColumn(values, isFinal)
Note! Only available for Extensions.
 
SetOffset(pageOffset)
Note! Only available for Listboxes, Tableboxes, Charts and Extensions.
 
SetPagesize(pageSize)
Note! Only available for Listboxes, Tableboxes, Charts and Extensions.
 
Note! Only available for Listboxes, Tableboxes, Charts and Extensions.
 
Note! Only available for Listboxes, Tableboxes, Charts and Extensions.
 
Note! Only available for Listboxes
Class Detail
Qv.Document.Object.Data
Field Detail
{Qv.Document.Object.Style} CellBorderStyles
HTML style-properties regarding the cell border. Not applicable for all type of objects.

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

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

{String} Name
Internal QlikView name for the object

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

PageOffset. Not applicable for all types of objects.

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

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

General styling.

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

{String} Type
The type of Qlikview object.
Method Detail
{void} ClearAllButThis()
Note! Only available for Listboxes
Example:
lb.Data.ClearAllButThis();

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

{void} Cycle(steps, colNo)
Note! Only available for Extensions.
Parameters:
steps
colNo

{void} DrillUp(steps, colNo)
Note! Only available for Extensions.
Parameters:
steps
colNo

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

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

{void} Lock()
Note! Only available for Listboxes
Example:
lb.Data.Lock();

{void} PageObject(owner, size, start)
Note! Only available for Listboxes, Tableboxes, Charts and Extensions.
Example:
this.Data.Page = new this.Data.PageObject(this.Data, 10, 1);
Parameters:
{Object} owner
Data-object.
{Number} size
Number of items visible per page.
{Number} start Optional
Starting page.

{void} Search(toggle)
Note! Only available for Listboxes.
Example:
lb.Data.Search("Steven", false);
Parameters:
{String} text.
{Boolean} toggle Optional
If true, existing selections will be kept.

{void} SearchColumn(colNo, searchString, toggle)
Note! Only available for Extensions.
Example:
ch.Data.SearchColumn(1, "Democrat", false);
Parameters:
{Integer} colNo
Column number.
{String} searchString
Text to search for.
{Boolean} toggle
Whether to toggle selections.

{void} SelectAll()
Note! Only available for Listboxes
Example:
lb.Data.SelectAll();

{void} SelectExcluded()
Note! Only available for Listboxes
Example:
lb.Data.SelectExcluded();

{void} SelectPossible()
Note! Only available for Listboxes
Example:
lb.Data.SelectPossible();

{void} SelectRow(rowNo)
Selects a row. Note! Only available for Extensions.
Example:
extension.Data.SelectRow(2);
Parameters:
{Integer} rowNo

{void} 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.
Example:
// Multiple parameters
lb.Data.SelectTexts("George Washington", "Thomas Jefferson");

// Array
var arrRecords = ["George Washington", "Thomas Jefferson"];
lb.Data.SelectTexts(arrRecords);
Parameters:
{String[]|multiple strings} recordsToSelect
Either an array or multiple parameters for each record

{void} SelectTextsInColumn(Column, toggle, 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.
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);
Parameters:
{colNo} Column
to select in.
{Boolean} toggle Optional
If true, existing selections will be kept (or deselected if selected again).
{Array|String[]} recordsToSelect
Either an array or multiple parameters for each record.

{void} SelectValues(values, toggle)
Note! Only available for Listboxes.
Selects the record corresponding to the value.
Parameters:
{Integer|Integer[]} values
Multiple values can be passed as an array of int.
{Boolean} toggle Optional
If true, existing selections will be kept.

{void} SelectValuesInColumn(values, isFinal)
Note! Only available for Extensions.
Parameters:
{Number} colNo.
{String[]|multiple string parameters} values
Either an array or a comma separated list of values.
{Boolean} isFinal Optional
Whether to toggle the selection.

{void} SetOffset(pageOffset)
Note! Only available for Listboxes, Tableboxes, Charts and Extensions.
Parameters:
pageOffset

{void} SetPagesize(pageSize)
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.
Example:
var pagesize = {};
pagesize.x = 10;
pagesize.y = 20;
this.Data.SetPagesize(pagesize);
Parameters:
{Qv.Document.Object.DataPage} pageSize
Size.

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

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

{void} Unlock()
Note! Only available for Listboxes
Example:
lb.Data.Unlock();