About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Class PreferenceBase

Base class for Preference implementations.

Since

2.0

Hierarchy (View Summary)

Spotfire.Object
- PreferenceBase
  - VisualizationPreferences

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Category IsEmpty SubCategory Reset Save UndoChanges

Methods

Cast

Cast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns T1
Inherited from Object.Cast

Equals

Equals(obj: any): 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.

Inherited from Object.Equals

GetHashCode

GetHashCode(): number
Serves as the default hash function.

Returns number
A hash code for the current object.

Inherited from Object.GetHashCode

ToString

ToString(): string
Returns a string that represents the current object.

Returns string
A string that represents the current object.

Inherited from Object.ToString

TryCast

TryCast<T1, T2>(this: T2, type: TypeRef<T1>): 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
- this: T2
- type: TypeRef<T1>
  The type to cast to.
Returns null | T1
Inherited from Object.TryCast

`Static`Equals

Equals(objA: any, objB: any): 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.

Inherited from Object.Equals

Default capability

Category

get Category(): string
Gets the name of the category. Implementations of this property are to return the name of the category to which the preference belongs. The category name must not be null or an empty string for the preference to be properly persisted.

Returns string
Since
2.0

IsEmpty

get IsEmpty(): boolean
Gets a value indicating whether this preference object only contains default property values or not.

Returns boolean
Since
2.0

SubCategory

get SubCategory(): string
Gets the name of the sub category. Implementations of this property are to return the name of the subcategory to which the preference belongs. The subcategory must not be null or an empty string for the preference to be properly persisted.

Returns string
Since
2.0

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
Remark
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.

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