Class Trellis

Trellis class.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

ActivePageIndex ActivePageIndexRuntime ColumnAxis Context HeaderFontMetadata IsAttached IsTrellising LegendItem ManualColumnCount ManualLayout ManualRowCount PageAxis PageCount PanelAxis RowAxis Transactions TrellisMode

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

    Returns T1

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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

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

    Returns null | T1

StaticEquals

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

Default capability

ActivePageIndex

  • get ActivePageIndex(): number

  • Gets or sets the active page index, expressed as a zero-based index.

    Returns number

    Since

    2.0

  • set ActivePageIndex(value): void

  • Parameters

    • value: number

    Returns void

ActivePageIndexRuntime

  • get ActivePageIndexRuntime(): number

  • Gets the active page index.

    Returns number

    Since

    2.0

ColumnAxis

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

HeaderFontMetadata

  • get HeaderFontMetadata(): FontMetadata

  • Gets or sets the font used for the headers.

    Returns FontMetadata

    Since

    2.0

  • set HeaderFontMetadata(value): void

  • Parameters

    Returns void

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

IsTrellising

  • get IsTrellising(): boolean

  • Gets a value indicating whether trellising is active.

    Returns boolean

    Since

    2.0

LegendItem

ManualColumnCount

ManualLayout

  • get ManualLayout(): boolean

  • Gets or sets a value indicating whether the number of rows and columns are set manually or automatically.

    Returns boolean

    Since

    2.0

  • set ManualLayout(value): void

  • Parameters

    • value: boolean

    Returns void

ManualRowCount

PageAxis

PageCount

  • get PageCount(): number

  • Gets the current number of trellis pages.

    Returns number

    Since

    2.0

PanelAxis

RowAxis

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

TrellisMode

Settings

Member Visibility

On This Page

Methods
Default capability