Action
    Preparing search index...

    Class CombinationChartBarProperties

    Class that controls properties for bars in a Spotfire.Dxp.Application.Visuals.CombinationChart.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Context IsAttached LabelCompleteBar LabelOrientation ReverseSegmentOrder StackMode Transactions Width ForEachNodeInSubTree

    Methods

    • 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

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

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • 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

    • 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

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get LabelCompleteBar(): boolean

      Gets or sets a value indicating whether the complete bar shall be labeled or not.

      Returns boolean

      2.0

    • set LabelCompleteBar(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get ReverseSegmentOrder(): boolean

      Gets or sets a value indicating whether segments in stacked bars should be shown in reversed order.

      Returns boolean

      2.0

    • set ReverseSegmentOrder(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get StackMode(): StackMode

      Gets or sets the stack mode. Only StackMode.None, and StackMode.Stack are supported.

      Returns StackMode

      2.0

    • set StackMode(value: StackMode): void

      Parameters

      Returns void

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get Width(): number

      Gets or sets the relative width of the bars. Allowed values are in the range [0, 100].

      Returns number

      This property is only used when the x axis is categorical. A value of 100 means the bar will occupy the full width of a category. A value of 0 will cause the bars will have a minimum width.

      If the x axis is continuous, this property is ignored. If binning is used on the x axis, the bars will occupy the full width of the bins. If binning is not used, bars will have a minimum width.

      2.0

    • set Width(value: number): void

      Parameters

      • value: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability