Class DocumentView

This class is used to control which view of the document that is used when getting and settings properties of the document model. A document has multiple views if the user has opened multiple browser tabs for the document in the web client, or if a javascript mashup uses multiple views.

Each view of the document can have different values for active page, active visualization, active data table, active marking, and active filtering selection. The value of these properties depends on the currently active view of the document. This class provides the API for getting and setting the current view of the document. We will refer to these properties as view properties.

The current document view is stored in a thread static variable and is thus associated with the current thread.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

ForEach

Methods

Cast

  • Cast<T1, T2>(this, type): T1

  • Casts this object to the specified type. Throws error on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns T1

Equals

  • Equals(obj): boolean

  • Determines whether the specified object is equal to the current object.

    Parameters

    • obj: any

      The object to compare with the current object.

    Returns boolean

    true if the specified object is equal to the current object; otherwise, false.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • Casts this object to the specified type. Returns null on failure.

    Type Parameters

    • T1

      The target type of the cast.

    • T2

      The type of the object to cast.

    Parameters

    Returns null | T1

StaticEquals

  • Equals(objA, objB): boolean

  • Determines whether the specified object instances are considered equal.

    Parameters

    • objA: any

      The first object to compare.

    • objB: any

      The second object to compare.

    Returns boolean

    true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

Default capability

StaticForEach

  • ForEach(documentNode, action): void

  • Executes the specified action for each view of the document.

    Parameters

    • documentNode: DocumentNode

      Any document node in the document.

    • action: Action

      The action that will be executed once in each view.

    Returns void

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability