Class ReferencePoint

A reference point is used to visualize the results from a fitting model. There are expressions defining the X and Y position of the point. The expressions may reference the result variables defined by the fitting model.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AffectAxisRanges Color Context CustomDisplayName Details DisplayName IsAttached IsBackground MarkerShape Name Size Transactions Visible XExpression YExpression

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

AffectAxisRanges

  • get AffectAxisRanges(): boolean

  • Gets or sets a value indicating whether this reference point affects the axis ranges.

    Returns boolean

    Since

    2.0

  • set AffectAxisRanges(value): void

  • Parameters

    • value: boolean

    Returns void

Color

  • get Color(): Color

  • Gets or sets the color by which this reference point is rendered.

    Returns Color

    Since

    2.0

  • set Color(value): void

  • Parameters

    Returns void

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

CustomDisplayName

  • get CustomDisplayName(): string

  • Gets or sets the custom name of this reference point.

    Returns string

    Since

    2.0

  • set CustomDisplayName(value): void

  • Parameters

    • value: string

    Returns void

Details

DisplayName

  • get DisplayName(): string

  • Gets the display name of this reference point.

    Returns string

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

IsBackground

  • get IsBackground(): boolean

  • Gets or sets a value controlling whether this reference point is rendered behind other visual elements in the visualization.

    Returns boolean

    Since

    2.0

  • set IsBackground(value): void

  • Parameters

    • value: boolean

    Returns void

MarkerShape

  • get MarkerShape(): MarkerShape

  • Gets or sets the shape of this reference point.

    Returns MarkerShape

    Since

    2.0

  • set MarkerShape(value): void

  • Parameters

    Returns void

Name

  • get Name(): string

  • Gets the name of this reference point.

    Returns string

    Since

    2.0

Size

  • get Size(): number

  • Gets or sets the size of this reference point.

    Returns number

    Since

    2.0

  • set Size(value): void

  • Parameters

    • value: number

    Returns void

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

Visible

  • get Visible(): boolean

  • Gets or sets a value indicating whether this reference point is visible.

    Returns boolean

    Since

    2.0

  • set Visible(value): void

  • Parameters

    • value: boolean

    Returns void

XExpression

  • get XExpression(): string

  • Gets the expression defining the horizontal position of this point.

    Returns string

    Since

    2.0

YExpression

  • get YExpression(): string

  • Gets the expression defining the vertical position of this point.

    Returns string

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability