Class DataPropertyRegistry

The Spotfire.Dxp.Data.DataProperty registry is part of the Spotfire.Dxp.Data.DataManager and contains the properties that can be defined in the analysis. All properties (metadata) that are set must be defined in this registry.

Since

2.0

Hierarchy (view full)

Implements

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context IsAttached Transactions AddProperty ContainsProperty GetProperties GetProperty RemoveProperty TryGetProperty

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

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

AddProperty

ContainsProperty

  • ContainsProperty(propertyClass, propertyName): boolean

  • Checks if the property named exists in the given Spotfire.Dxp.Data.DataPropertyClass.

    Parameters

    • propertyClass: DataPropertyClass

      The property class to find the property in.

    • propertyName: string | String

      The name of the property to find.

    Returns boolean

    True if the property exists in the property class, false otherwise.

    Since

    2.0

GetProperties

GetProperty

  • GetProperty(propertyClass, propertyName): DataProperty

  • Gets the property with the given name.

    Parameters

    • propertyClass: DataPropertyClass

      The property class to find the property in.

    • propertyName: string | String

      The property name to get.

    Returns DataProperty

    The property with the given name.

    Since

    2.0

RemoveProperty

  • RemoveProperty(propertyClass, dataProperty): void

  • Removes a custom property from the registry.

    Parameters

    Returns void

    Since

    2.0

  • RemoveProperty(propertyClass, dataPropertyName): void

  • Removes a custom property from the registry.

    Parameters

    • propertyClass: DataPropertyClass

      The property class that this property is part of.

    • dataPropertyName: string | String

      The name of the property to remove.

    Returns void

    Since

    2.0

TryGetProperty

  • TryGetProperty(propertyClass, propertyName, property): boolean

  • Tries to get a property with a given name.

    Parameters

    • propertyClass: DataPropertyClass

      The property class to search in.

    • propertyName: string | String

      The property name of the property to find.

    • property: OutParam<DataProperty>

      This argument will be set to the property if it was found, it will be set to null otherwise.

    Returns boolean

    True if the property was found, false otherwise.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability