Global

Method summary

Members

members

insight - {

type

Insight }

Root level variable that provides access to the Xpress Insight JavaScript API.

details

Properties:

properties

Name	Type	Description
Formatter	type Formatter	The entity formatter

Example

examples

// Has a ready method that you should pass you view code into
insight.ready(function() {
    // You will usually need a reference to the view object, fetch this as follows
    var view = insight.getView();

    // You view code goes here
});

Methods

method

addAction ( actionName, actionConfig )

Register a custom VDL action. This global function is only available within VDL views, you will get an error if you try to call it within a custom HTML view.

Parameters:

params

Name	Type	Description
actionName	type string	Identifying name of the VDL action. This is used as the tag selector in the VDL view.
actionConfig	type VdlAction	VDL Action implementation

details

Back to Top

method

VDL ( name, extension )

Register a custom VDL extension. This global function is only available within VDL views, you will get an error if you try to call it within a custom HTML view.

Parameters:

params

Name	Type	Description
name	type string	Identifying name of the extension. This is used as the tag selector if a tag or attribute property is not specified in the extension object.
extension	type VdlExtension	Extension definition

details

Example

examples

VDL('my-title', {
  template: '<h4><vdl-content></vdl-content></h4>'
});

VDL('my-view-link', {
  transform: function (element, attributes, api) {
    var action = 'alert("no view specified")';
    if (attributes.view) {
      action = 'function () { insight.openView("' + attributes.view.rawValue + '") } ';
    }
    api.addBinding(element, 'click', action);
  }
});

Back to Top

Type Definitions

members

ActiveTableMarker - {

type

object }

Identifies a cell marker.

details

Properties:

properties

Name	Type	Description
rowKey	type string	A unique row identifier for the cell.
columnVisibleIndex	type number	Visible column index of the cell.

members

AttributeAvailableWhenRule - {

type

Object }

Attribute availability rule.

details

Properties:

properties

Name	Type	Argument	Description
attribute	type string	optional	Name of the attribute to to test against
rule	type string	optional	Name of the rule to apply (equals, isEmpty, ...)
value	type string | number | boolean	optional	Value to test for

members

AttributeValidation - {

type

Object }

Attribute validation rules.

details

Properties:

properties

Name	Type	Argument	Description
range	type Array.<number>	optional	Number within a range [0] min, [1] max
allowedValues	type Array.<string>	optional	List of allowed values

method

EntityValidatorCallback ( entityName, value, indices ) → {Result}

Parameters:

params

Name	Type	Description
entityName	type string	The name of the entity to validate
value	type *	The new value to validate
indices	type Array.<*>	Element index, if an array entity

details

Returns:

returns table

Type	Description
type Result	The validation result and a message, in in error

Back to Top

members

ExpressionVarDoc - {

type

Object }

Expression variable documentation.

details

Properties:

properties

Name	Type	Description
name	type string	Name of the variable
type	type string	Data type of the variable
description	type string	Description of the variable

members

ExtensionAttribute - {

type

Object }

VDL Extension attribute definition.

details

Properties:

properties

Name	Type	Argument	Default	Description
name	type string			The name of the attribute
description	type string	optional		The description of the attribute
acceptsExpression	type boolean	optional	false	Attribute accepts an expression
expression	type 'all' | 'static' | 'dynamic'	optional	'static'	Whether attribute accepts/requires expression or just a static value
required	type boolean	optional	false	Whether the attribute is required
defaultValue	type string	optional		Specify a default value for the attribute
valueType	type string | Array.<string>	optional	'string'	The data type(s) of the attribute value
docIgnore	type boolean	optional	false	Whether to include the attribute in VDLDoc
availableWhen	type Array.<AttributeAvailableWhenRule>	optional		List of rules to determine if the attribute is available
mutexGroup	type string	optional		Name of a group in which only one member attribute can be specified
expressionVars	type Array.<ExpressionVarDoc>			Documentation on available expression variables
validation	type AttributeValidation	optional		Validation rules

members

ExtensionAttributeMutex - {

type

Array.<string> }

VDL Extension attribute mutex. List of attribute names where only one can be specified per element.

details

members

ExtensionDoc - {

type

Object }

VDL Extension documentation.

details

Properties:

properties

Name	Type	Argument	Default	Description
ignore	type boolean	optional	false	Should the extension be ignored when generating the documentation
group	type string	optional		The group the vdl extension belongs to
description	type string	optional		Description of the VDL extension
descriptionAsHtml	type boolean	optional	false	Should the description be treated as HTML, defaults to false
elementContents	type Object	optional		Documents the element contents Properties properties Name Type Argument Default Description description type string optional  Describes what contents are allowed inside the element acceptsMarkup type boolean optional  false Whether markup is allowed within the element contents
example	type string	optional		Pre-formatted markup example of the extension

members

Folder - {

type

Object }

details

Properties:

properties

Name	Type	Description
displayName	type string	The name of the folder
id	type string	The ID representing the folder
objectType	type string	The type of this object
ownerId	type string	the owner username of the folder
parent	type string	The parent object reference of this folder
path	type string	The path to this folder
shareStatus	type string	the share status of this folder
url	type string	the url to this folder resource

members

NewAttachmentOptions - {

type

Object }

Optional information to create a new attachment.

details

Properties:

properties

Name	Type	Argument	Description
options.filename	type string	optional	The new attachment filename
options.fileExtension	type string	optional	The new attachment extension. If filename is also present the extension will be appended to it (separated by a dot), otherwise the extension will be appended to the default filename.
options.editorId	type string	optional	Editor to create the attachment with
options.tag	type string	optional	Tag to add to the new attachment

method

NotifyCallback ( scenario, viewProperties )

Called when scenario observer data changes. The callback gets passed either a single Scenario, if observing withFirstScenario, or an array of Scenario objects, in all other cases. The Scenario objects are special in that the only allow access to entities that are being declared by the ScenarioObserver. The second argument is an object that allows access to the view properties declared by the ScenarioObserver.

Parameters:

params

Name	Type	Description
scenario	type Scenario | Array.<Scenario>	A single scenario or ordered list of scenarios depending on what is declared by the scenario observer
viewProperties	type MaskedViewProperties	An accessor object to access the view properties declared by the scenario observer

details

Back to Top

members

PrimitiveType - {

type

number | boolean | string }

A primitive type. Number, Boolean or String

details

members

TableCellIndex - {

type

object }

A cell index. This is not the display position in the table but its internal index that can be used to lookup the cell object from the DataTable API.

details

Properties:

properties

Name	Type	Description
row	type number
column	type number
columnVisible	type number

members

VdlAction - {

type

Object }

VDL Action interface.

details

Properties:

properties

Name	Type	Argument	Description
name	type string	optional	Identifying name of the VDL action
displayName	type string	optional	Display name of the VDL action
isAction	type boolean	optional	is a VDL Action
attributes	type Array.<ExtensionAttribute>	optional	List of attributes for the VDL action
attributeMutex	type Array.<ExtensionAttributeMutex>	optional	List of mutually exclusive attributes
doc	type ExtensionDoc	optional	Documents the VDL action
run	type function	optional	main VDL Action callback

members

VdlAttribute - {

type

Object }

A parsed VDL attribute.

details

Properties:

properties

Name	Type	Argument	Description
entities	type VdlEntities	optional	entities discovered, indexed by name, a list of scenarios indices
rawValue	type string		The original, unprocessed attribute text
expression	type Object		Properties properties Name Type Description value type string The processed expression derived from the attribute text isString type boolean Whether the expression is a plain string value, i.e. wrapped in double-quotes

method

VdlErrorTargetSelector ( element ) → {Element|jQuery}

Given an element that has a transform error, select an alternative target element to apply the error message too.

Parameters:

params

Name	Type	Description
element	type Element	The element in error

details

Returns:

returns table

Type	Description
type Element | jQuery	The element to transfer the error to

Back to Top

members

VdlExtension - {

type

Object }

VDL Extension interface.

details

Properties:

properties

Name	Type	Argument	Default	Description
name	type string	optional		Identifying name of the extension
tag	type string	optional		Tag name matched when discovering instances
isContainer	type boolean	optional		can contain other elements
isAction	type boolean	optional		is a VDL Action
attributes	type string | Array.<string> | ExtensionAttribute | Array.<ExtensionAttribute>	optional		One or more attribute names to match when discovering instances
attributeMutex	type Array.<ExtensionAttributeMutex>	optional		List of mutually exclusive attributes
modifiesDescendants	type boolean	optional	true	Whether the extension modifies, and controls descendant nodes. When true it is not possible to reference other extensions in the descendant nodes that have this flag set to true.
requiredParent	type string | Array.<string>	optional		Name of the required parent tag, if an array then it should be one of the items from that array
transform	type VdlExtensionTransform			How to transform matched elements
template	type string	optional		Knockout component HTML template
errorTargetSelector	type VdlErrorTargetSelector	optional		Callback to select an alternative element to apply any transform errors too
doc	type ExtensionDoc	optional		Documents the VDL extension
createViewModel	type ViewModelFactory	optional		Knockout view model factory function

method

VdlExtensionTransform ( element, attributes, api )

Transform matched DOM elements before Knockout is applied to the DOM.

Parameters:

params

Name	Type	Description
element	type Element	Matched element
attributes	type Object.<string, VdlAttribute>	Map of the parsed attributes on the element
api	type ExtensionApi	The extension API for modifying the global view model and manipulating the DOM

details

Back to Top

members

VdlValidator - {

type

Object }

VDL Validator interface.

details

Properties:

properties

Name	Type	Argument	Description
name	type string	optional	Identifying name of the extension
validate	type function	optional	The function that will carry out the validation

method

ViewModelFactory ( params, componentInfo ) → {Object}

Factory function to create a view model.

Parameters:

params

Name	Type	Description
params	type Object.<string, *>	Map or parameters passed from the custom element
componentInfo	type Object	Properties params Name Type Description element type Element The element the component is being injected into. When createViewModel is called, the template has already been injected into this element, but isn't yet bound. templateNodes type Array.<Element> An array containing any DOM nodes that have been supplied to the component

details

Returns:

returns table

Type	Description
type Object	The generated view model

Back to Top