Class Qww.PivotTable.Mgr

Class to manage communication with a QlikView pivot table.

Defined in: <JavaScript\QWW\QwwJs_PivotTableMgr.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	Qww.PivotTable.Mgr(cfg) Constructs a new Qww.PivotTable.Mgr instance.

Field Summary
Field Attributes	Field Name and Description
	Caption Caption for text object.
	Cfg Reference to the configuration object which was used to create construct the object.
	CurrentPage Returns the current page number which the TableMgr holds data for.
	Enabled Whether the table is enabled (visible) within the QlikView application.
	NoPages Number of rows in the current page of data (note that it may be less than the PageSize if it's the last page of data).
	NoRows Number of rows in the current page of data (note that it may be less than the PageSize if it's the last page of data).
	PageOffset Page offset of the current page of data.
	PageSize Number of rows per page of data received for the table.
	Rows Collection of rows of data for the current page of data in the pivot table.
	TotalSize Total number of rows in the table.

Method Summary
Method Attributes	Method Name and Description
	PageDown() Moves to the next page of data in the table.
	PageUp() Moves to the previous page of data in the table.
	SelectMultipleCells(startRecordNumber, startColumn, numberOfRows, numberOfColumns) Selects a range of cells in the table.
	SelectSingleCell(recordNumber, selectColumn) Selects a cell in the table.
	SetPage(pageNumber) Moves to the page number specified.

Class Detail

Qww.PivotTable.Mgr(cfg)

Constructs a new Qww.PivotTable.Mgr instance.

tbl = new Qww.PivotTable.Mgr(
{
    // ObjectID of the underlying Table Box 
    // in QlikView
    ObjectID: "PIVOTTABLEID",
    // The number of results to download for 
    // each page.
    PageSize: 2000,
    // Function to call when data changes
    OnUpdate: showResults
});

Parameters:
{Object} cfg: JSON object to configure PivotTableMgr.
{String} cfg.ObjectID: Id of the pivot table in the QlikView application.
{String} cfg.ApplicationID Optional, Default: null: Id/Name of the QlikView application. Note this is only necessary when multiple QlikView documents are being used on the same web page and should otherwise be set to null.
{Int} cfg.PageSize Optional, Default: 50: Number of rows to return in a single page of data.
{Function} cfg.OnUpdate Optional: Function to call whenever the data is updated.

Returns:: {Qww.PivotTable.Mgr} Qww.PivotTable.Mgr

Field Detail

{Qww.ObjectCaption} Caption

Caption for text object.

{Object} Cfg

Reference to the configuration object which was used to create construct the object. This allows certain properties to be updated after initial instantiation.

{Int} CurrentPage

Returns the current page number which the TableMgr holds data for.

{Bool} Enabled

Whether the table is enabled (visible) within the QlikView application. This can be dependent, for example, upon show and hide conditions set for the object in QlikView.

{Int} NoPages

Number of rows in the current page of data (note that it may be less than the PageSize if it's the last page of data).

{Int} NoRows

Number of rows in the current page of data (note that it may be less than the PageSize if it's the last page of data).

{Int} PageOffset

Page offset of the current page of data.

{Int} PageSize

Number of rows per page of data received for the table.

{Qww.PivotTable.Row[]} Rows

Collection of rows of data for the current page of data in the pivot table.

{Int} TotalSize

Total number of rows in the table.

Method Detail

{Bool} PageDown()

Moves to the next page of data in the table.

Returns:: {Bool} Returns true if the page was changed (if the table was already set to the last page then false will be returned).

{Bool} PageUp()

Moves to the previous page of data in the table.

Returns:: {Bool} Returns true if the page was changed (if the table was already set to the first page then false will be returned).

SelectMultipleCells(startRecordNumber, startColumn, numberOfRows, numberOfColumns)

Selects a range of cells in the table.

Parameters:
{Int} startRecordNumber: Start record number to select.
{Int} startColumn: Start column number to select.
{Int} numberOfRows: Number of rows to select.
{Int} numberOfColumns: Number of columns to select.

SelectSingleCell(recordNumber, selectColumn)

Selects a cell in the table.

Parameters:
{Int} recordNumber: Record number to select.
{Int} selectColumn: Column number to select.

SetPage(pageNumber)

Moves to the page number specified. Note that the first page is 1.

Parameters:
{Int} pageNumber: Page number to move to.

Classes

Class Qww.PivotTable.Mgr