Class Visual

This class represents either a visualization or a text area.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context CustomNodes Id IsAttached ShowTitle Title Transactions TypeId ApplyUserPreferences As AutoConfigure

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

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

CustomNodes

  • get CustomNodes(): CustomNodes

  • Gets the collection of custom nodes associated with this visual.

    Returns CustomNodes

    Since

    2.0

Id

  • get Id(): Guid

  • Gets the unique id for this instance.

    Returns Guid

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

ShowTitle

  • get ShowTitle(): boolean

  • Gets or sets a flag indicating whether to show the title or not.

    Returns boolean

    Since

    2.0

  • set ShowTitle(value): void

  • Parameters

    • value: boolean

    Returns void

Title

  • get Title(): string

  • Gets or sets the title.

    Returns string

    Since

    2.0

  • set Title(value): void

  • Parameters

    • value: string

    Returns void

Transactions

  • get Transactions(): ITransactions

  • Gets a collection of methods for executing transactions on the document.

    Returns ITransactions

    Since

    2.0

TypeId

  • get TypeId(): TypeIdentifier

  • Gets or sets the type identifier for the visual. By setting this property, the visual is converted to the specified type.

    Returns TypeIdentifier

    Since

    2.0

  • set TypeId(value): void

  • Parameters

    Returns void

ApplyUserPreferences

  • ApplyUserPreferences(): void

  • Applies user preferences to a newly created visual.

    Returns void

    Since

    2.0

As

  • As<T>(typeT): null | JsType<T>

  • Gets the visual as the specified type.

    Type Parameters

    • T

    Parameters

    Returns null | JsType<T>

    The visual; otherwise null.

    Since

    2.0

AutoConfigure

  • AutoConfigure(): void

  • Configures a newly created visual with reasonable default values given the current data set.

    Returns void

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability