Class Index | File Index

Classes


Namespace VIZIT_SETTINGS


Defined in: <pkg\Release\Vizit\Layouts\Vizit\vizit-all.js>.

Namespace Summary
Constructor Attributes Constructor Name and Description
 
Used for configuring Vizit with a simple JavaScript object placed on the page before including vizit-all.js.
Field Summary
Field Attributes Field Name and Description
<static>  
VIZIT_SETTINGS.apiVersion
REQUIRED.
<static>  
VIZIT_SETTINGS.buttons
An array of strings containing the names of the buttons that should be drawn.
<static>  
VIZIT_SETTINGS.expandProperties
Whether or not the Property Editor should be expanded automatically when a document is opened.
<static>  
VIZIT_SETTINGS.external
Whether or not Vizit Essential should open in an external window instead of on the page.
<static>  
VIZIT_SETTINGS.id
A unique string that will refer to the Vizit Essential Controller that is created from the VIZIT_SETTINGS object.
<static>  
VIZIT_SETTINGS.instantPreviewSize
The maximum width/height of the Instant Preview thumbnails.
<static>  
VIZIT_SETTINGS.isSearchPage
Whether or not this page should be treated as if it might have search results on it.
<static>  
VIZIT_SETTINGS.populateSearch
Whether or not to automatically take a "k" query string parameter's value and use it to populate the search term panel in Vizit Essential.
<static>  
VIZIT_SETTINGS.previewHoverSize
The maximum width/height of the preview that appears when mousing over an Instant Preview or button (if configured).
<static>  
VIZIT_SETTINGS.previewOnEssentialHover
Whether or not to show a 300 x 300 preview when hovering over the OpenInEssential button.
<static>  
Whether or not to show a 300 x 300 preview when hovering over the InstantPreview.
<static>  
VIZIT_SETTINGS.previewOnProHover
Whether or not to show a 300 x 300 preview when hovering over the OpenInPro button.
<static>  
VIZIT_SETTINGS.proInNewWindow
Whether or not a new window is opened every time a document is opened in Vizit Pro.
<static>  
VIZIT_SETTINGS.takeOverLinks
Whether or not clicking links to documents should open those documents in Vizit Essential or perform the default action (generally, downloading the file)
Namespace Detail
VIZIT_SETTINGS
Used for configuring Vizit with a simple JavaScript object placed on the page before including vizit-all.js. If you are using VIZIT_SETTINGS on a SharePoint 2010 page, you do not need to include the vizit-all.js file. You can simply add VIZIT_SETTINGS using the Vizit Web Part.

In addition to any of the configuration properties used to construct the Vizit.Essential.Controller#constructor, VIZIT_SETTINGS can also be used to configure the buttons that appear next to every list item on the page, indicate whether to open document links in Vizit Essential instead of the default behavior (such as downloading the document), and provide an ID for the Essential window which can be referenced later with Vizit.Essential.Manager.

    
        // VIZIT_SETTINGS with configuration properties from Vizit.Essential.Controller.
        var VIZIT_SETTINGS = {
            apiVersion: 2,
            width: 500,
            height: 800
        };

        // -- or --

        var VIZIT_SETTINGS = {
            apiVersion: 2,
            takeOverLinks: false
        };

        // -- or --

        // VIZIT_SETTINGS with a combination of properties from Vizit.Essential.Controller
        var VIZIT_SETTINGS = {
            apiVersion: 2,
            buttons: [
                'OpenInEssential'
            ],
            width: 400,
            height: 300,
            id: 'anEssentialId',
            mainbarActions: [
                'OpenInPro',
                '->',
                'FullScreen'
            ]
        };
    
Field Detail
<static> VIZIT_SETTINGS.apiVersion
REQUIRED. The current apiVersion for VIZIT_SETTINGS is 2. This indicates the version of the API your VIZIT_SETTINGS object is expecting. If apiVersion is left blank, version 1 will be assumed and any functionality added in version 2 may not function properly.

<static> VIZIT_SETTINGS.buttons
An array of strings containing the names of the buttons that should be drawn. If this is not provided, the global defaults or anything in VIZIT_SETTINGS.buttons will be used. Possible options are 'InstantPreview', 'OpenInEssential', and 'OpenInPro'

<static> VIZIT_SETTINGS.expandProperties
Whether or not the Property Editor should be expanded automatically when a document is opened. Defaults to false.

<static> VIZIT_SETTINGS.external
Whether or not Vizit Essential should open in an external window instead of on the page.

<static> VIZIT_SETTINGS.id
A unique string that will refer to the Vizit Essential Controller that is created from the VIZIT_SETTINGS object. It can be used to reference the Vizit Essential Controller when making calls to Vizit.Essential.Manager.Open

<static> VIZIT_SETTINGS.instantPreviewSize
The maximum width/height of the Instant Preview thumbnails. Defaults to 80.

<static> VIZIT_SETTINGS.isSearchPage
Whether or not this page should be treated as if it might have search results on it. Setting this to false will improve performance on the client when it is not necessary. Defaults to true.

<static> VIZIT_SETTINGS.populateSearch
Whether or not to automatically take a "k" query string parameter's value and use it to populate the search term panel in Vizit Essential. SharePoint's query string parameter for search is a "k".

<static> VIZIT_SETTINGS.previewHoverSize
The maximum width/height of the preview that appears when mousing over an Instant Preview or button (if configured).

<static> VIZIT_SETTINGS.previewOnEssentialHover
Whether or not to show a 300 x 300 preview when hovering over the OpenInEssential button. Defaults to false.

<static> VIZIT_SETTINGS.previewOnInstantPreviewHover
Whether or not to show a 300 x 300 preview when hovering over the InstantPreview. Defaults to true.

<static> VIZIT_SETTINGS.previewOnProHover
Whether or not to show a 300 x 300 preview when hovering over the OpenInPro button. Defaults to false.

<static> VIZIT_SETTINGS.proInNewWindow
Whether or not a new window is opened every time a document is opened in Vizit Pro. Defaults to false.

<static> VIZIT_SETTINGS.takeOverLinks
Whether or not clicking links to documents should open those documents in Vizit Essential or perform the default action (generally, downloading the file)

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Oct 28 2013 13:52:27 GMT-0000 (GMT)