Interface Page

Represents a Page in a Spotfire document.

interface Page {
    id: string;
    index: number;
    name: string;
    visible: boolean;
    setAsActive(): void;
}

Hierarchy (view full)

Properties

id index name visible

Methods

setAsActive

Properties

id

id: string

Gets the unique id for this instance. The id is stable during the page life cycle, thus it can be used to store as a reference to this page in a ModProperty or AnalysisProperty.

Version

1.1

index

index: number

Gets the zero-based index in this instance in the page collection in the Spotfire document.

name

name: string

Gets the name of this instance.

visible

visible: boolean

Gets a value indicating whether this instance is visible.

Methods

setAsActive

  • setAsActive(): void

  • Sets this instance as the active page.

    Returns void

Settings

Member Visibility

On This Page

Properties
Methods