Qv.Document.Object

Classes

Axis
Background
Data
DataCell
DataPage
HeaderCell
Layout
Style

Members

Data :Qv.Document.Object.Data

Data for the object
Type:

DocumentMgr :Object

Reference to the Qlikview document manager. This is the top level manager, from this manager you can find the sheet manager, the bookmark manager, all object managers etc.
Type:
  • Object

Element :Object

Reference to the html-element
Type:
  • Object

Layout :Qv.Document.Object.Layout

Layout of object
Type:

Name :String

The internal QV-name of the object
Type:
  • String

ObjectMgr :Object

Reference to the Qlikview manager for this object.
Type:
  • Object

PageBinder :Object

Reference to the Qlikview object binder.
Type:
  • Object

Type :String

The object's QV-type
Type:
  • String

Methods

Click()

Note! Only available for Buttons.
Trigger a click on the button.
Example
qvButton.Click();

GetHeight() → {Number}

Note! Only available for Extensions.
Returns the maximum height assigned for the object by its container.
Returns:
Type
Number

GetText() → {String}

Note! Only available for Text objects.
Returns the text.
Returns:
Type
String

GetVariable() → {Object}

Note! Only available for Inputboxes.
Returns an object where the property value is the unformated variable and text is formatted. If you omit the row parameter the first variable in the input box is returned.
Returns:
Type
Object
Example
var variable = qvInput.GetVariable();
    var variableText = variable.text;

GetWidth() → {Number}

Note! Only available for Extensions.
Returns the maximum width assigned for the object by its container.
Returns:
Type
Number

IsInvalid() → {Boolean}

Checks if your Extension is "valid", i.e. has been rendered and is ready for use. This can also be checked for the object you get returned by GetObject, e.g:
Returns:
Type
Boolean
Example
var myObj = this.GetObject("LB01");
    alert(myObj.IsInvalid());

SetOnUpdateComplete(onupdatecomplete)

Set a function to be called when the QlikView object is updated
Parameters:
NameTypeDescription
onupdatecompletefunctionThe function to be called
Example
var doc = Qv.GetCurrentDocument();
var lb = doc.GetObject("LB36");
lb.SetOnUpdateComplete(function() {alert("on update complete called");});

SetVariable()

Note! Only available for Inputboxes.
If you omit the row parameter the first variable in the input box is updated.
Example
qvInput.SetVariable("new value");