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

Class DockingPlacement

The docking placement of a Spotfire.Dxp.Application.Panel.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- DockingPlacement

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor Index Region

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 Object.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 Object.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from Object.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 Object.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 Object.Equals

Default capability

constructor

new DockingPlacement(region, index): DockingPlacement
Initializes a new instance of the Spotfire.Dxp.Application.Layout.DockingPlacement class.
Parameters
- region: PanelRegion
  The docking region.
- index: number | Int32
  The docking index.
Returns DockingPlacement
Since
2.0

Overrides Object.constructor

Index

get Index(): number
Gets the index of the Spotfire.Dxp.Application.Panel instance in the Spotfire.Dxp.Application.Layout.PanelRegion.
An index of 0 indicates the topmost panel in Spotfire.Dxp.Application.Layout.PanelRegion.Left and Spotfire.Dxp.Application.Layout.PanelRegion.Right regions, and the leftmost panel in the Spotfire.Dxp.Application.Layout.PanelRegion.Bottom region.

Returns number
Since
2.0

Region

get Region(): PanelRegion
Gets the region.

Returns PanelRegion
Since
2.0