IVisualizer Interface

interface IVisualizer {
    // Properties
    readonly ${name}: string;

    // Methods
    ${equals}(object: ${IVisualizer}): boolean;
    ${remove}(): void;
}

// This interface is not available in managed environment

// This interface is not available in native environment

IVisualizer Properties

name

readonly name: string;

// This property is not available in managed environment

// This property is not available in native environment

Holds the data visualizer name.

IVisualizer Methods

equals

equals(object: ${IVisualizer}): boolean;

// This method is not available in managed environment

// This method is not available in native environment

object: Reference to a data visualizer object.

Checks whether two references to data visualizer objects point to the same data visualizer. Since ISession.visualizers property always creates new objects each time the user queries it, it is required to use this method to test if two references actually reference the same object.

var session = ...;

var vis1 = session.visualizers[0];
var vis2 = session.visualizers[0];

alert(vis1 === vis2);  // displays false
alert(vis1.equals(vis2)); // displays true

remove

remove(): void;

// This method is not available in managed environment

// This method is not available in native environment

Removes this data visualizer from the session.