Class LayoutDefinition

Defines the layout structure and content to be applied within a Spotfire.Dxp.Application.Page.

Since

2.0

Hierarchy (view full)

Spotfire.Object
- LayoutDefinition

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

constructor Add BeginSideBySideSection BeginStackedSection EndSection

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 LayoutDefinition(): LayoutDefinition
Initializes a new instance of the Spotfire.Dxp.Application.Layout.LayoutDefinition class.

Returns LayoutDefinition
Since
2.0

Overrides Object.constructor

Add

Add(visual): void
Adds the specified Spotfire.Dxp.Application.Visual to the current section. Spotfire.Dxp.Application.Layout.LayoutDefinition.BeginStackedSection or Spotfire.Dxp.Application.Layout.LayoutDefinition.BeginSideBySideSection should be called prior to this.
Parameters
- visual: Visual
  The Spotfire.Dxp.Application.Visual to be added.
Returns void
Since
2.0
Add(visual, proportion): void
Adds the specified Spotfire.Dxp.Application.Visual to the current section. Spotfire.Dxp.Application.Layout.LayoutDefinition.BeginStackedSection or Spotfire.Dxp.Application.Layout.LayoutDefinition.BeginSideBySideSection should be called prior to this.
Parameters
- visual: Visual
  The Spotfire.Dxp.Application.Visual to be added.
- proportion: number | Single
  The proportion of this element relative to its siblings. Must be greater than 0.
Returns void
Since
2.0

BeginSideBySideSection

BeginSideBySideSection(): void
Creates a side-by-side (vertical) section that will be used for subsequent calls to to Add(visual) or Add(visual, proportion). The section should be ended by calling Spotfire.Dxp.Application.Layout.LayoutDefinition.EndSection.

Returns void
Since
2.0
BeginSideBySideSection(proportion): void
Creates a side-by-side (vertical) section that will be used for subsequent calls to to Add(visual) or Add(visual, proportion). The section should be ended by calling Spotfire.Dxp.Application.Layout.LayoutDefinition.EndSection.
Parameters
- proportion: number | Single
  The proportion of this element relative to its siblings. Must be greater than 0.
Returns void
Since
2.0

BeginStackedSection

BeginStackedSection(): void
Creates a stacked (horizontal) section that will be used for subsequent calls to Add(visual) or Add(visual, proportion). The section should be closed by calling Spotfire.Dxp.Application.Layout.LayoutDefinition.EndSection.

Returns void
Since
2.0
BeginStackedSection(proportion): void
Creates a stacked (horizontal) section that will be used for subsequent calls to to Add(visual) or Add(visual, proportion). The section should be closed by calling Spotfire.Dxp.Application.Layout.LayoutDefinition.EndSection.
Parameters
- proportion: number | Single
  The proportion of this element relative to its siblings. Must be greater than 0.
Returns void
Since
2.0

EndSection

EndSection(): void
Ends the current section. All sections must be ended.

Returns void
Since
2.0

Class LayoutDefinition

Since

Hierarchy (view full)

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

constructor

Returns LayoutDefinition

Since

Add

Parameters

Returns void

Since

Parameters

Returns void

Since

BeginSideBySideSection

Returns void

Since

Parameters

Returns void

Since

BeginStackedSection

Returns void

Since

Parameters

Returns void

Since

EndSection

Returns void

Since

Settings

On This Page

`Static`Equals