Action
    Preparing search index...

    Class Page

    A page contains visuals and panels.

    The visuals are displayed in the visualization area at the center of the page. The panels are docked to the sides around the visualization area.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    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 ForEachNodeInSubTree GetVisualBounds GetVisualizationAreaSize

    Methods

    • 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

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

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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

    • 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

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get CustomNodes(): CustomNodes

      Gets the collection of custom nodes associated with this page.

      Returns CustomNodes

      2.0

    • get HasMinimumHeight(): boolean

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

      Returns boolean

      2.0

    • set HasMinimumHeight(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get HasMinimumWidth(): boolean

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

      Returns boolean

      2.0

    • set HasMinimumWidth(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Id(): Guid

      Gets the unique id for this instance.

      Returns Guid

      2.0

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • 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

      2.0

    • set MinimumHeight(value: number): void

      Parameters

      • value: number

      Returns void

    • 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

      2.0

    • set MinimumWidth(value: number): void

      Parameters

      • value: number

      Returns void

    • get ShowActiveVisualMaximized(): boolean

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

      Returns boolean

      2.0

    • set ShowActiveVisualMaximized(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • 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

      2.0

    • set Title(value: string): void

      Parameters

      • value: string

      Returns void

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get Visible(): boolean

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

      Returns boolean

      Only pages that are visible are shown when a Spotfire analysis is used in "Viewing" mode and only the visible pages are included by default when exporting to PDF. An IronPython script or action can still be used to navigate to a hidden (the Visible property set to false) page in "Viewing" mode.

      When a Spotfire analysis is used in "Editing" mode all pages are shown in the page navigation, but pages with the Visible property set to false are indicated.

      2.0

    • set Visible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • Configures this page in a default way.

      Returns void

      2.0

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

      Parameters

      • source: Page

        Source page. Can be null.

      Returns void

      2.0

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

      Parameters

      Returns Rectangle

      Current bounds.

      This methods gets the current bounds of a visual in the user interface. In order to get a reliable and up to date result from this method, the user interface must be allowed to run its layout code. This can be forced by setting the ActivePageReference property on the document.

      If no user interface is present, or if the user interface has not displayed this visual yet, the method returns Rectangle.Empty.

      The rectangle is relative to the visualization area of a page. It is not adjusted for margins.

      2.0

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

      This method can be used together with the Spotfire.Dxp.Application.Visual.RenderAsync|Visual.Render method to render the visuals on a page using the current page layout, but with a different visualization area size.

      The returned rectangle is not adjusted for margins.

      2.0

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

      Returns Size

      The size of the visualization area in pixels.

      All the visuals are displayed in the visualization area at the center of the page. The panels are docked to the sides around the visualization area.

      The size of the visualization area is controlled by the user interface. In order to get a reliable and up to date result from this method, the user interface must be allowed to run its layout code. This can be forced by setting the ActivePageReference property on the document.

      If the application has no running user interface, this method returns Size.Empty.

      2.0

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability