Insight

Method summary

Methods

method

addSetComparator ( setName, comparator, direction )

Define a comparator function to be used for sorting a set. Any previously defined comparator function for the set will be replaced with this one. If addSetSorter has also been applied to the same set it will be ignored and this comparator function will be used in preference.

Parameters:

params

Name	Type	Argument	Default	Description
setName	type string			The name of the set
comparator	type Insight~ComparatorFunction | Array.<*> | insight.enums.Comparators			The comparator function use to sort the set. Alternatively you can provide an array where the index of a value provides its ordinal number. Also you can provide the name of a built-in comparator from insight.enums.Comparators.
direction	type insight.enums.SortDirection	optional	insight.enums.SortDirection.ASC	If the direction is set to insight.enums.SortDirection.DESC then the sort function will be called with the arguments reversed, sorting the values in the opposite direction

details

• See:
• insight.enums.Comparators

Example

examples

insight.addSetComparator('INTEGER_SET', function(a, b) {
    // Simple number sort
    return a - b;
}, insight.enums.SortDirection.DESC);

// Sort days of the week in short form
insight.addSetComparator('STRING_SET', ['Mon', 'Tues', 'Wed', 'Thurs', 'Fri', 'Sat', 'Sun']);

// Use built-in STRING comparator. This will sort alpha-numeric strings
insight.addSetComparator('STRING_SET', insight.enums.Comparators.STRING);

Back to Top

method

addSetSorter ( setName, sorter, dimension ) → {boolean}

Use Insight#addSetComparator instead.

Parameters:

params

Name	Type	Argument	Default	Description
setName	type string			The name of the set
sorter	type Insight~SortingFunction			The sorting function
dimension	type insight.enums.EntityDataDimension	optional	insight.enums.EntityDataDimension.NORMAL_DATA	The dimension of the set

details

• Deprecated since Js Api 4.7

Returns:

returns table

Type	Description
type boolean	Whether the sorter was added or not

Back to Top

method

getClientType ( ) → {insight.enums.ClientType}

The type of the client that is hosting this view.

details

Returns:

returns table

Type	Description
type insight.enums.ClientType	the client type

Example

examples

insight.getClientType(); // returns "Insight Web Client" in web browser.

Back to Top

method

getDistribUrl ( ) → {string}

The URL to the Insight distribution folder.

details

Returns:

returns table

Type	Description
type string	The URL to the Insight distribution folder, including the trailing file separator

Example

examples

insight.getDistribUrl();

Back to Top

method

getSetComparator ( setName ) → {Object.<{comparator: (Insight~ComparatorFunction|Array.<*>), direction: insight.enums.SortDirection}>|undefined}

Get the set comparator function for a given set.

Parameters:

params

Name	Type	Description
setName	type string	The name of the set

details

Returns:

returns table

Type	Description
type Object.<{comparator: (Insight~ComparatorFunction|Array.<*>), direction: insight.enums.SortDirection}> | undefined	The comparator function/array and sort direction, if any assigned to the set.

Back to Top

method

getSetSorter ( setName, dimension ) → {function|undefined}

Use Insight#getSetComparator instead.

Parameters:

params

Name	Type	Argument	Default	Description
setName	type string			The name of the set
dimension	type insight.enums.EntityDataDimension	optional	insight.enums.EntityDataDimension.NORMAL_DATA	The dimension of the set

details

• Deprecated since Js Api 4.7

Returns:

returns table

Type	Description
type function | undefined	The set sorting function or undefined if one isn't defined

Back to Top

method

getView ( ) → {View}

The current Insight View, providing access to the scenarios, app as well as save and reload behaviour.

details

Returns:

returns table

Type	Description
type View	the current View

Example

examples

var view = insight.getView();

Back to Top

method

isDebugEnabled ( ) → {boolean}

Indicates whether log messages and HTML debugging is enabled.

details

Returns:

returns table

Type	Description
type boolean	True if debug is enabled, otherwise false

Example

examples

isDebugEnabled(); // true or false

Back to Top

method

isS3Enabled ( ) → {boolean}

Indicates if S3 has been configured for use

details

Returns:

returns table

Type	Description
type boolean	True if S3 has been configured, otherwise false

Back to Top

method

openView ( viewTitleOrId )

Opens the given custom view. In the Analyst Client, the view is opened in a new tab. In the web client, the new view is opened in the current window. The view to be opened can be identified in a variety of ways:

• Non-Tableau views
  • The title of the view, as specified using the title attribute in the companion file. If there are several views with the same title, the first will be chosen.
  • The id of the view, as specified using the optional id attribute in the companion file.
  • The title of the view group and title of the view, separated by two colons, e.g. 'My Group::My View'.
• Tableau views (which do not directly have have entries in the companion file)
  • The title of the Tableau view
  • The title of the view group and title of the Tableau view, separated by two colons, e.g. 'My Group::My View'.

Parameters:

params

Name	Type	Description
viewTitleOrId	type string	the title or id of the view, as defined in the companion file (or Tableau workbook, as appropriate)

details

Example

examples

insight.openView( 'Welcome' );

Back to Top

method

ready ( callback )

Define code to be run once the JS API is loaded and ready. You should wrap all your view code within a call to this method.

This function will execute the callback once the Model Schema and App entities have been cached. If not completed in 30 seconds then the script will terminate.

Parameters:

params

Name	Type	Description
callback	type Insight.readyCallback	A function to execute once the Insight API has initialized.

details

Example

examples

insight.ready(function () {
     // called when the JS API is ready.
     // Add your code here.
});

Back to Top

method

removeSetComparator ( setName )

Remove a previously added set comparator.

Parameters:

params

Name	Type	Description
setName	type string	The name of the set

details

Back to Top

method

removeSetSorter ( setName, dimension ) → {boolean}

Use Insight#removeSetComparator instead.

Parameters:

params

Name	Type	Argument	Default	Description
setName	type string			The name of the set
dimension	type insight.enums.EntityDataDimension	optional	insight.enums.EntityDataDimension.NORMAL_DATA	The dimension of the set

details

• Deprecated since Js Api 4.7

Returns:

returns table

Type	Description
type boolean	Whether a sorter was removed or not

Back to Top

method

setDebugEnabled ( enabled )

Controls whether log messages are enabled.

Parameters:

params

Name	Type	Argument	Default	Description
enabled	type boolean	optional	true	set to true to enable debug, false to disable

details

Example

examples

insight.setDebugEnabled(true); // enable debug logging.

Back to Top

method

setDefaultFormatters ( )

Sets default schema defined entity formatters

details

Back to Top

Type Definitions

method

readyCallback ( )

Invoked when the JS API is ready to be used. You should wrap your view code in a callback and pass it to insight.ready().

details

Back to Top

method

ComparatorFunction ( a, b ) → {number}

A comparator function applied to a set.

Parameters:

params

Name	Type	Description
a		Value to compare
b		Value to compare

details

Returns:

returns table

Type	Description
type number	Return less than 0 if 'a' should come before 'b' in ascending order, 0 if 'a' and 'b' are equal and greater than 0 if 'b' should come before 'a' in ascending order.

Example

examples

function setComparator(a, b) {
    // Simple number sort
    return a - b;
}

Back to Top

method

SortingFunction ( originalSet ) → {array}

Use Insight~ComparatorFunction instead.

Parameters:

params

Name	Type	Description
originalSet	type array	The original set

details

• Deprecated since Js Api 4.7

Returns:

returns table

Type	Description
type array	The sorted set

Back to Top