Class KpiComparativeAxis

Represents an axis used to define a comparative value for a KPI.

Since

2.0

Hierarchy (view full)

  • Axis
    • KpiComparativeAxis

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AxisMode Binding CategoryMode Context EvaluationMode Expression Formatting IsAttached Name TitleFontMetadata Transactions

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

AxisMode

  • get AxisMode(): AxisMode

  • Gets the axis mode.

    Returns AxisMode

    Since

    2.0

Binding

  • get Binding(): AxisBinding

  • Gets or sets the axis binding.

    Returns AxisBinding

    Since

    2.0

  • set Binding(value): void

  • Parameters

    Returns void

CategoryMode

  • get CategoryMode(): CategoryMode

  • Gets or sets a value controlling how a categorical axis responds to filtering. This property only affects axes where the categories are laid out spatially.

    Returns CategoryMode

    Since

    2.0

  • set CategoryMode(value): void

  • Parameters

    Returns void

Context

EvaluationMode

  • get EvaluationMode(): AxisEvaluationMode

  • Gets or sets a value controlling whether the axis expression should be evaluated on all data or on filtered data.

    Returns AxisEvaluationMode

    Since

    2.0

  • set EvaluationMode(value): void

  • Parameters

    Returns void

Expression

  • get Expression(): string

  • Gets or sets the expression that defines how data is mapped to this axis.

    Returns string

    Since

    2.0

  • set Expression(value): void

  • Parameters

    • value: string

    Returns void

Formatting

  • get Formatting(): Formatting

  • Gets the formatting for this comparative axis.

    Returns Formatting

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

Name

  • get Name(): string

  • Gets the axis name.

    Returns string

    Since

    2.0

TitleFontMetadata

  • get TitleFontMetadata(): FontMetadata

  • Gets or sets the title font for this axis.

    Returns FontMetadata

    Since

    2.0

  • set TitleFontMetadata(value): void

  • Parameters

    Returns void

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability