Class VisualizationPreferences

General user preferences for visualizations.

Since

2.0

Hierarchy (view full)

Accessors

Category SubCategory

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

AxisTitleFontMetadata IsEmpty LegendFontMetadata LimitingMarkingsEmptyBehavior LimitingMarkingsEmptyMessage LinesAndCurvesFontMetadata OtherLabelFontMetadata PreferredAggregationMethodForNumericColumns ScaleLabelFontMetadata TrellisLabelFontMetadata Reset Save UndoChanges

Accessors

Category

  • get Category(): string

  • Category for the preference.

    Returns string

SubCategory

  • get SubCategory(): string

  • Sub category for the preference.

    Returns string

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

AxisTitleFontMetadata

IsEmpty

  • get IsEmpty(): boolean

  • Gets a value indicating whether this preference object only contains default property values or not.

    Returns boolean

    Since

    2.0

LegendFontMetadata

LimitingMarkingsEmptyBehavior

LimitingMarkingsEmptyMessage

LinesAndCurvesFontMetadata

  • get LinesAndCurvesFontMetadata(): FontMetadata

  • Gets the metadata for the Lines and Curves font.

    Returns FontMetadata

    Since

    2.0

OtherLabelFontMetadata

PreferredAggregationMethodForNumericColumns

  • get PreferredAggregationMethodForNumericColumns(): string

  • Gets or sets the preferred aggregation method for numeric columns. When a visualization is configured by heuristics, this method will be used to aggregate numeric columns unless overridden by other settings, such as Spotfire.Dxp.Data.DataColumnProperties.PreferredAggregationMethod.

    Returns string

    Since

    2.0

  • set PreferredAggregationMethodForNumericColumns(value): void

  • Parameters

    • value: string

    Returns void

ScaleLabelFontMetadata

TrellisLabelFontMetadata

Reset

  • Reset(): void

  • Resets all values that may explicitly have been given to the properties of this preference on a user level basis through a calls to Spotfire.Dxp.Framework.Preferences.PreferenceProperty.Value. The effect of resetting a property is that when the Value of it is queried, either the group value or the default value will be returned.

    Returns void

    Since

    2.0

Save

  • Save(): void

  • Persists all changes to the properties of this preference object.

    Returns void

    Since

    2.0

UndoChanges

  • UndoChanges(): void

  • Undoes any changes that may have been to all of the properties of this preference, since it was last saved.

    Returns void

    Since

    2.0

Settings

Member Visibility

On This Page

Accessors
Methods
Default capability