About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class VisualContent

This class is an implementation detail and should never be used directly. Instead, always use the concrete visualization classes, such as Spotfire.Dxp.Application.Visuals.BarChart, directly.

Since

2.0

Hierarchy (view full)

DocumentNode
- VisualContent
  - HtmlTextArea
  - Visualization

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context IsAttached Title Transactions TypeId Visual ApplyUserPreferences 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from DocumentNode.Cast

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.

Inherited from DocumentNode.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from DocumentNode.ToString

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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from DocumentNode.TryCast

`Static`Equals

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.

Inherited from DocumentNode.Equals

Default capability

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

Title

get Title(): string
Gets or sets the Visual's 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

Inherited from Framework.DocumentModel.DocumentNode.Transactions

TypeId

get TypeId(): TypeIdentifier
Gets the type identifier for the visual.

Returns TypeIdentifier
Since
2.0

Visual

get Visual(): null | Visual
Gets the visual instance, or null if this instance is not owned by a visual.

Returns null | Visual
Since
2.0

ApplyUserPreferences

ApplyUserPreferences(): void
Applies user preferences to a newly created visual.

Returns void
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