Action
    Preparing search index...

    Class ReferenceLayer

    Represents a layer of reference elements.

    2.2

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Band BarSegmentHandling Box ColumnNameMatchTarget Context DisplayName Enabled EvaluationModes Expression IsAttached IsBackground Label LimitByMarking Line LineConnection Marker Name Relations SecondaryExpression Transactions Transparency ValueAxis Width ForEachNodeInSubTree MoveTo

    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 ColumnNameMatchTarget(): ColumnNameMatch

      Gets or sets a value that override the standard column name matching behavior to instead match on columns from this target axis.

      Returns ColumnNameMatch

      2.2

    • set ColumnNameMatchTarget(value: ColumnNameMatch): void

      Parameters

      Returns void

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get DisplayName(): string

      Gets the display name.

      Returns string

      2.2

    • get Enabled(): boolean

      Gets or sets a value indicating whether this layer is enabled.

      Returns boolean

      2.2

    • set Enabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Expression(): string

      Gets or sets the expression.

      Returns string

      2.2

    • set Expression(value: string): void

      Parameters

      • value: string

      Returns void

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get IsBackground(): boolean

      Gets or sets a value indicating whether to render this element in the background. That is, behind the data layer.

      Returns boolean

      2.2

    • set IsBackground(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Label(): Label

      Gets the label reference element settings.

      Returns Label

      2.2

    • get LimitByMarking(): boolean

      Gets or sets a value indicating whether to limit the reference layer to the marked data.

      Returns boolean

      2.2

    • set LimitByMarking(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get Line(): Line

      Gets the line reference element settings.

      Returns Line

      2.2

    • get Marker(): Marker

      Gets the marker reference element settings.

      Returns Marker

      2.2

    • get SecondaryExpression(): string

      Gets or sets the secondary expression.

      Returns string

      2.2

    • set SecondaryExpression(value: string): void

      Parameters

      • value: string

      Returns void

    • get Transactions(): ITransactions

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

      Returns ITransactions

      2.0

    • get Transparency(): number

      Gets or sets a value for the relative transparency. This value is always in the range [0, 1], where 0 is fully opaque and 1 is fully transparent.

      Returns number

      2.2

    • set Transparency(value: number): void

      Parameters

      • value: number

      Returns void

    • get ValueAxis(): ValueAxis

      Gets or sets a value indicating which axis in the parent visualization that is the value axis.

      Returns ValueAxis

      2.2

    • set ValueAxis(value: ValueAxis): void

      Parameters

      Returns void

    • get Width(): number

      Gets or sets a value for the relative width. This value is always in the range [0, 100], where 100 is the full width of the categorical element and 0 means that the element is not visible.

      Returns number

      2.2

    • set Width(value: number): void

      Parameters

      • value: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability