Getting Started | Class Index

Classes


Class Qv.Config

Configuration object for a connection to a QlikView document, for example in Qv.InitWorkBench.

Class Summary
Constructor Attributes Constructor Name and Description
 
Configuration object for a connection to a QlikView document, for example in Qv.InitWorkBench.
Field Summary
Field Attributes Field Name and Description
 
Make an anonymous connection
 
Functions that should run after workbench is loaded.
 
Set this to load the page with a selected bookmark.
 
CSS
Stylesheets that should be loaded after the standard stylesheets.
 
Customize icons for objects.
 
Name of the QlikView Server Cluster.
 
Make an automatic search when the page loads.
 
Make an automatic selection when the page loads.
 
True by default.
 
Section access password in clear text
 
Defaults to the path of QvAjax.js referenced in the page
 
Connect using a ticket
 
Section access userID in clear text
 
Mandatory, the name of document without the file extension.
 
Scrambled section access password
 
Scrambled section access userID
Class Detail
Qv.Config
Configuration object for a connection to a QlikView document, for example in Qv.InitWorkBench.
Example:
Qv.InitWorkBench(
    {
        View: 'FilmsWebView',
        BodyOnLoadFunctionNames: ['Init']
    });
Field Detail
{Boolean} Anonymous
Make an anonymous connection

{String/Array} BodyOnLoadFunctionNames
Functions that should run after workbench is loaded. Enter the name of the function or an array if you want to call more than one function. No parameters are allowed.
Example:
BodyOnLoadFunctionNames:"MyInit"
    or
BodyOnLoadFunctionNames:["MyInit1", "MyInit2"]

{String} Bookmark
Set this to load the page with a selected bookmark. Enter the ID of the bookmark
Example:
Bookmark: "Document\\BM02"

{String/Array} CSS
Stylesheets that should be loaded after the standard stylesheets. Typically you do that to override some of the styles. Enter the path of the stylesheet or an array if you want to supply more than one.
Example:
Qv.InitWorkBench(
    {
        View: 'FilmsWebView',
        Host: 'Local',
        BodyOnLoadFunctionNames: ['Init'],
        CSS: ["Initialisation_CSS.css", "Content/Initialisation_CSS2.css"]
    });

{Qv.CustomIcons} CustomIcons
Customize icons for objects. Enter substitute images for icons in the form icon code:icon url and separate them with a comma
Example:
CustomIcons:{CA:"NewClearAll.bmp", CD:"NewClear.bmp"}

{String} Host
Name of the QlikView Server Cluster. Defaults to Local

{Array} InitialSearch
Make an automatic search when the page loads. Enter object id and one or more texts to search for, separate them with commas.
Example:
Qv.InitWorkBench(
    {
        View: 'FilmsWebView',
        BodyOnLoadFunctionNames: ['Init'],
        InitialSearch: ["LB1460,*Al*"]
    });

{Array} InitialSelections
Make an automatic selection when the page loads. Enter object id and one or more texts to select, separate them with commas.
Example 1:
Qv.InitWorkBench(
{
    View: 'FilmsWebView',
    BodyOnLoadFunctionNames: ['Init'],
    //
    // NOTE: You should avoid spaces between the comma separated items.
    //
    InitialSelections: ["LB1460,Alan Arkin,Alan Alda"]
});

Example 2:
To make selections in multiple listboxes, use the following syntax.
Qv.InitWorkBench(
{
    View: 'FilmsWebView',
    BodyOnLoadFunctionNames: ['Init'],
    //
    // NOTE: You should avoid spaces between the comma separated items.
    //
    InitialSelections: ["LB1460,Alan Arkin,Alan Alda", "LB1466,1980's"]
});

{Boolean} InlineStyle
True by default. Serve as a default value for all objects on a page. Can be overridden by setting InlineStyle on individual objects (avqstyle='false').
Qv.InitWorkBench(
    {
        View: 'FilmsWebView',
        InlineStyle: false
    });
    
To effect this on an individual object, either set the InlineStyle property to 
false on the server side ASP.NET control:
<qww:QvObject ID="QvObject1" Anonymous="true" runat="server" ObjectID="CH03" 
ObjectType="Combo Chart" QlikViewDocument="FilmsWebView (Local)" />

Or the avqstyle property to false on the object's html:
<div class="QvFrame" avqview="FilmsWebView" avq="object:.Document\CH03" 
id="Document\CH03" avqstyle="false" style="display:none;width:400px;height:250px;">

{String} Password
Section access password in clear text

{String} QvAjaxZfcPath
Defaults to the path of QvAjax.js referenced in the page

{String} Ticket
Connect using a ticket

{String} Userid
Section access userID in clear text

{String} View
Mandatory, the name of document without the file extension.

{String} Xpassword
Scrambled section access password

{String} Xuserid
Scrambled section access userID