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 Summary)

DocumentNode
- DataPropertyRegistry

Implements

Index

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

Context IsAttached Transactions AddProperty ContainsProperty ForEachNodeInSubTree GetProperties GetProperty RemoveProperty TryGetProperty

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 DocumentNode.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 DocumentNode.Equals

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from DocumentNode.GetHashCode

ToString

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

Returns string
A string that represents the current object.

Inherited from DocumentNode.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 DocumentNode.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 DocumentNode.Equals

Default capability

Context

get Context(): INodeContext
Gets the context of this node.

Returns INodeContext
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Context

IsAttached

get IsAttached(): boolean
Gets a value indicating whether this node is attached.

Returns boolean
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.IsAttached

Transactions

get Transactions(): ITransactions
Gets a collection of methods for executing transactions on the document.

Returns ITransactions
Since
2.0

Inherited from Framework.DocumentModel.DocumentNode.Transactions

AddProperty

AddProperty(propertyClass: DataPropertyClass, dataProperty: DataProperty): void
Adds a new Spotfire.Dxp.Data.DataProperty.
Parameters
- propertyClass: DataPropertyClass
  The property class that this property is part of.
- dataProperty: DataProperty
  The property to add.
Returns void
Since
2.0

ContainsProperty

ContainsProperty(
propertyClass: DataPropertyClass,
propertyName: string | String,
): 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

ForEachNodeInSubTree

ForEachNodeInSubTree<TNode>(
typeTNode: TypeRefParam<TNode>,
action: Action<TNode>,
): void
Applies the specified action to all nodes of the specified type in the subtree spanned from this node, including this node.
Type Parameters
- TNode
Parameters
- typeTNode: TypeRefParam<TNode>
  Generic type argument
- action: Action<TNode>
  The action to apply.
Returns void
Since
2.1

Inherited from DocumentNode.ForEachNodeInSubTree

GetProperties

GetProperties(
propertyClass: DataPropertyClass,
): System.Collections.Generic.IEnumerable<DataProperty>
Gets all the properties for a Spotfire.Dxp.Data.DataPropertyClass.
Parameters
- propertyClass: DataPropertyClass
  The property class.
Returns System.Collections.Generic.IEnumerable<DataProperty>
An enumeration of all the properties of the specified class.

Since
2.0

GetProperty

GetProperty(
propertyClass: DataPropertyClass,
propertyName: string | String,
): 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: DataPropertyClass,
dataProperty: DataProperty,
): void
Removes a custom property from the registry.
Parameters
- propertyClass: DataPropertyClass
  The property class that this property is part of.
- dataProperty: DataProperty
  The property to remove.
Returns void
Since
2.0
RemoveProperty(
propertyClass: DataPropertyClass,
dataPropertyName: string | String,
): 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: DataPropertyClass,
    propertyName: string | String,
    property: OutParam<DataProperty>,
): 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

Class DataPropertyRegistry

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

Cast

Type Parameters

Parameters

Returns T1

Equals

Parameters

Returns boolean

GetHashCode

Returns number

ToString

Returns string

TryCast

Type Parameters

Parameters

Returns null | T1

StaticEquals

Parameters

Returns boolean

Default capability

Context

Returns INodeContext

Since

IsAttached

Returns boolean

Since

Transactions

Returns ITransactions

Since

AddProperty

Parameters

Returns void

Since

ContainsProperty

Parameters

Returns boolean

Since

ForEachNodeInSubTree

Type Parameters

Parameters

Returns void

Since

GetProperties

Parameters

Returns System.Collections.Generic.IEnumerable<DataProperty>

Since

GetProperty

Parameters

Returns DataProperty

Since

RemoveProperty

Parameters

Returns void

Since

Parameters

Returns void

Since

TryGetProperty

Parameters

Returns boolean

Since

Settings

On This Page

`Static`Equals