Class Page

A page contains visuals and panels.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

ActiveDataTableReference ActiveFilteringSelectionReference ActiveMarkingSelectionReference ActiveVisualReference Context CustomNodes DetailsOnDemandPanel FilterPanel HasMinimumHeight HasMinimumWidth Id IsAttached MinimumHeight MinimumWidth Panels ShowActiveVisualMaximized Title Transactions Visible Visuals ApplyLayout AutoConfigure GetVisualBounds GetVisualizationAreaSize

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

ActiveDataTableReference

ActiveFilteringSelectionReference

ActiveMarkingSelectionReference

ActiveVisualReference

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 page.

    Returns CustomNodes

    Since

    2.0

DetailsOnDemandPanel

FilterPanel

HasMinimumHeight

  • get HasMinimumHeight(): boolean

  • Gets or sets a value indicating whether a minimum height has been set for the page.

    Returns boolean

    Since

    2.0

  • set HasMinimumHeight(value): void

  • Parameters

    • value: boolean

    Returns void

HasMinimumWidth

  • get HasMinimumWidth(): boolean

  • Gets or sets a value indicating whether a minimum width has been set for the page.

    Returns boolean

    Since

    2.0

  • set HasMinimumWidth(value): void

  • Parameters

    • value: boolean

    Returns void

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

MinimumHeight

  • get MinimumHeight(): number

  • Gets or sets the minimum height of the page. This is used if Spotfire.Dxp.Application.Page.HasMinimumHeight is set to true.

    Returns number

    Since

    2.0

  • set MinimumHeight(value): void

  • Parameters

    • value: number

    Returns void

MinimumWidth

  • get MinimumWidth(): number

  • Gets or sets the minimum width of the page. This is used if Spotfire.Dxp.Application.Page.HasMinimumWidth is set to true.

    Returns number

    Since

    2.0

  • set MinimumWidth(value): void

  • Parameters

    • value: number

    Returns void

Panels

ShowActiveVisualMaximized

  • get ShowActiveVisualMaximized(): boolean

  • Gets or sets a value indicating whether to show the active visual maximized.

    Returns boolean

    Since

    2.0

  • set ShowActiveVisualMaximized(value): void

  • Parameters

    • value: boolean

    Returns void

Title

  • get Title(): string

  • Gets or sets the page title. If set to a title that is not unique, the provided title will be modified in such a way that it becomes unique.

    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

Visible

  • get Visible(): boolean

  • Gets or sets a value indicating whether this Spotfire.Dxp.Application.Page is visible.

    Returns boolean

    Since

    2.0

  • set Visible(value): void

  • Parameters

    • value: boolean

    Returns void

Visuals

ApplyLayout

AutoConfigure

  • AutoConfigure(): void

  • Configures this page in a default way.

    Returns void

    Since

    2.0

  • AutoConfigure(source): void

  • Configures this page using settings from the specified source page.

    Parameters

    • source: Page

      Source page. Can be null.

    Returns void

    Since

    2.0

GetVisualBounds

  • GetVisualBounds(visual): Rectangle

  • Gets the bounds of a visual in the user interface.

    Parameters

    Returns Rectangle

    Current bounds.

    Since

    2.0

  • GetVisualBounds(visual, visualizationAreaBounds): Rectangle

  • Gets the bounds of a visual given a rectangle defining a visualization area.

    Parameters

    • visual: Visual

      A visual.

    • visualizationAreaBounds: Rectangle

      A rectangle defining a visualization area.

    Returns Rectangle

    The bounds the visual would have, given the bounds of a visualization area.

    Since

    2.0

GetVisualizationAreaSize

  • GetVisualizationAreaSize(): Size

  • Gets the size of the visualization area in the user interface.

    Returns Size

    The size of the visualization area in pixels.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability