Class PageCollection

A collection of visual pages in an analysis document. Note that new instances of this class cannot be created. The one and only instance is accessed through the Spotfire.Dxp.Application.Document.Pages property of the Spotfire.Dxp.Application.Document class.

The instance of this class can be used directly either to enumerate or to modify the visual pages in the document, that is, add new pages, remove pages, move pages, etc.

Since

2.0

Hierarchy (View Summary)

Spotfire.Dxp.Framework.DocumentModel.DocumentNodeListBase<
Spotfire.Dxp.Application.Page,
>
- PageCollection

Methods

[iterator]

"[iterator]"(): Iterator<Spotfire.Dxp.Application.Page>
Returns Iterator<Spotfire.Dxp.Application.Page>
Overrides DocumentNodeListBase.[iterator]

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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 DocumentNodeListBase.Cast

Equals

Equals(obj: any): 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 DocumentNodeListBase.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from DocumentNodeListBase.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from DocumentNodeListBase.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): T1 | null
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 T1 | null
Inherited from DocumentNodeListBase.TryCast

`Static`Equals

Equals(objA: any, objB: any): 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 DocumentNodeListBase.Equals

Default capability

`Readonly`Item

Item: PropertyGet<number | System.Int32, Spotfire.Dxp.Application.Page>

Gets the element at the specified index.

Param: index

The zero-based index of the element to get.

Returns

The element at the specified index.

Since

2.0

Context

get Context(): Spotfire.Dxp.Framework.DocumentModel.INodeContext
Gets the context of this node.

Returns Spotfire.Dxp.Framework.DocumentModel.INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNodeListBase.Context

Count

get Count(): number
Gets the number of elements contained in this instance.

Returns number
Since
2.0

Inherited from Framework.DocumentModel.DocumentNodeListBase.Count

IsAttached

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

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNodeListBase.IsAttached

NavigationMode

get NavigationMode(): Spotfire.Dxp.Application.PageNavigationMode
Gets or sets the page navigation mode (tabs or links) used to switch between the pages of the document.

Returns Spotfire.Dxp.Application.PageNavigationMode
Since
2.0
set NavigationMode(value: Spotfire.Dxp.Application.PageNavigationMode): void
Parameters
- value: Spotfire.Dxp.Application.PageNavigationMode
Returns void

Transactions

get Transactions(): Spotfire.Dxp.Framework.DocumentModel.ITransactions
Gets a collection of methods for executing transactions on the document.

Returns Spotfire.Dxp.Framework.DocumentModel.ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNodeListBase.Transactions

VisualizationAreaSize

get VisualizationAreaSize(): Spotfire.Dxp.Application.Layout.VisualizationAreaSize
Gets the settings that control the size of the visualization area.

Returns Spotfire.Dxp.Application.Layout.VisualizationAreaSize
Since
2.0

AddDuplicate

AddDuplicate(page: Spotfire.Dxp.Application.Page): Spotfire.Dxp.Application.Page
Creates a duplicate of the specified page and adds it to this collection. The duplicate page will become the active page.
Parameters
- page: Spotfire.Dxp.Application.Page
  The Spotfire.Dxp.Application.Page to duplicate. It must be attached to the document.
Returns Spotfire.Dxp.Application.Page
The duplicate Spotfire.Dxp.Application.Page.

Since
2.0

AddNew

AddNew(): Spotfire.Dxp.Application.Page
Creates and adds a Spotfire.Dxp.Application.Page with a localized default title to the document. The page will become the active page.

Returns Spotfire.Dxp.Application.Page
Since
2.0
AddNew(suggestedTitle: string | System.String): Spotfire.Dxp.Application.Page
Creates and adds a Spotfire.Dxp.Application.Page to the document. The page will become the active page.
Parameters
- suggestedTitle: string | System.String
  A suggested title. A suffix will be added to the suggested title if it is not unique, that is, another visual page with the name exists. Note that only the first 1000 characters of the suggested title are considered when naming the new page.
Returns Spotfire.Dxp.Application.Page
The object model representation of the page that was added.

Since
2.0

Clear

Clear(): void
Removes all pages from this collection.

Returns void
Since
2.0

Contains

Contains(value: Spotfire.Dxp.Application.Page): boolean
Determines whether the specified value is in this collection.
Parameters
- value: Spotfire.Dxp.Application.Page
  The object to locate in this collection. The value can be null.
Returns boolean
true if value is found in this collection; otherwise, false.

Since
2.0

Inherited from DocumentNodeListBase.Contains

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: System.Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: System.Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNodeListBase.ForEachNodeInSubTree

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<
Spotfire.Dxp.Application.Page,
>
Returns an enumerator that iterates through this collection.

Returns System.Collections.Generic.IEnumerator<Spotfire.Dxp.Application.Page>
An System.Collections.Generic.IEnumerator for this collection.

Since
2.0

Inherited from DocumentNodeListBase.GetEnumerator

IndexOf

IndexOf(value: Spotfire.Dxp.Application.Page): number
Searches for the specified value and returns the zero-based index of the first occurrence within this collection.
Parameters
- value: Spotfire.Dxp.Application.Page
  The object to locate. The value can be null.
Returns number
The zero-based index of the first occurrence of value within this collection, if found; otherwise, -1.

Since
2.0

Inherited from DocumentNodeListBase.IndexOf

Move

Move(fromIndex: number | System.Int32, toIndex: number | System.Int32): void
Moves the item at the specified index to a new location in the collection.
Parameters
- fromIndex: number | System.Int32
  The zero-based index specifying the location of the item to be moved.
- toIndex: number | System.Int32
  The zero-based index specifying the new location of the item.
Returns void
Since
2.0

MoveVisualTo

MoveVisualTo(
visualPanel: Spotfire.Dxp.Application.Visual,
page: Spotfire.Dxp.Application.Page,
): void
Moves a visual from its current Spotfire.Dxp.Application.Page to a new page.
Parameters
- visualPanel: Spotfire.Dxp.Application.Visual
  The visual to move.
- page: Spotfire.Dxp.Application.Page
  The page to move the visual to.
Returns void
Since
2.0

Remove

Remove(item: Spotfire.Dxp.Application.Page): boolean
Removes the specified Spotfire.Dxp.Application.Page from this page collection.
Parameters
- item: Spotfire.Dxp.Application.Page
  The page to remove.
Returns boolean
true if the page was successfully removed from this page collection, otherwise false. This method also returns false if the page is not found.

Since
2.0

RemoveAt

RemoveAt(index: number | System.Int32): void
Removes the page at the specified index from this page collection.
Parameters
- index: number | System.Int32
  The index of the page to remove.
Returns void
Since
2.0

ToArray

ToArray(): TypedArray<Spotfire.Dxp.Application.Page>
Copies the elements of the collection to a new array.

Returns TypedArray<Spotfire.Dxp.Application.Page>
An array containing the elements.

Since
2.0

Inherited from DocumentNodeListBase.ToArray

TryGetPage

TryGetPage(
id: System.Guid,
page: OutParam<Spotfire.Dxp.Application.Page>,
): boolean
Tries to get a page specified by its id.
Parameters
- id: System.Guid
  The id.
- page: OutParam<Spotfire.Dxp.Application.Page>
  The page.
Returns boolean
true if the page was found, otherwise false.

Since
2.0

Class PageCollection

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<Spotfire.Dxp.Application.Page>

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns T1 | null

StaticEquals

Parameters

Returns boolean

Default capability

ReadonlyItem

Param: index

Returns

Since

Context

Returns Spotfire.Dxp.Framework.DocumentModel.INodeContext

Since

Count

Returns number

Since

IsAttached

Returns boolean

Since

NavigationMode

Returns Spotfire.Dxp.Application.PageNavigationMode

Since

Parameters

Returns void

Transactions

Returns Spotfire.Dxp.Framework.DocumentModel.ITransactions

Since

VisualizationAreaSize

Returns Spotfire.Dxp.Application.Layout.VisualizationAreaSize

Since

AddDuplicate

Parameters

Returns Spotfire.Dxp.Application.Page

Since

AddNew

Returns Spotfire.Dxp.Application.Page

Since

Parameters

Returns Spotfire.Dxp.Application.Page

Since

Clear

Returns void

Since

Contains

Parameters

Returns boolean

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

GetEnumerator

Returns System.Collections.Generic.IEnumerator<Spotfire.Dxp.Application.Page>

Since

IndexOf

Parameters

`Static`Equals

`Readonly`Item