Action
    Preparing search index...

    Class VisualizationPreferences

    General user preferences for visualizations.

    2.0

    Hierarchy (View Summary)

    Index

    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

    • get Category(): string

      Category for the preference.

      Returns string

    • get SubCategory(): string

      Sub category for the preference.

      Returns string

    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 IsEmpty(): boolean

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

      Returns boolean

      2.0

    • get LinesAndCurvesFontMetadata(): FontMetadata

      Gets the metadata for the Lines and Curves font.

      Returns FontMetadata

      2.0

    • 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

      2.0

    • set PreferredAggregationMethodForNumericColumns(value: string): void

      Parameters

      • value: string

      Returns 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

      2.0

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

      Returns void

      If the value type of a property is mutable, internal changes made to the property must be manually reported through calls to Spotfire.Dxp.Framework.Preferences.PreferenceProperty for the property value to be persisted.

      2.0

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

      Returns void

      2.0

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods
    Default capability