Action
    Preparing search index...

    Class ResultProperties

    Represents the metadata about the result from a data source, transformation or calculation. These properties are used to set properties on the resulting data table.

    Also used to propagate metadata within a Spotfire.Dxp.Data.DataFlow or between table operations, like AddColumns(dataSource, settings) or AddRows(dataSource, settings) This collection is almost always read-only except in custom implementations (like in a Spotfire.Dxp.Data.DataRowReader) where the implementor is creating the result properties.

    2.0

    Hierarchy (View Summary)

    Index

    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

    • Gets the value of a named property.

      Parameters

      • name: string | String

        The property name.

      Returns unknown

      The value of the property.

      2.0

    • Checks a value exists for a named property.

      Parameters

      • name: string | String

        The property name.

      Returns boolean

      True if there is a value for the property; otherwise, false.

      2.0

    • Create a new collection of result properties where all the correct properties are forwarded.

      Parameters

      Returns ResultProperties

      A copy of the properties that should be propagated.

      2.0

    • Checks if a property with a given name exists.

      Parameters

      • name: string | String

        The name of the property.

      Returns boolean

      True if the property exists; otherwise, false.

      2.0

    • Sets the value of a named property.

      Parameters

      • name: string | String

        The property name.

      • value: any

        The property value.

      Returns void

      2.0