Class DataColumnProperties

Represents a collection of the properties in a column.

Since

2.0

Hierarchy (view full)

Methods

Cast Equals GetHashCode ToString TryCast Equals

Default capability

CalculatedExpression ColumnType Comparer ContentType DataType Description Expression ExternalId ExternalName Formatter IsValid Name PreferredAggregationMethod PropertyNames Get PropertyExists Set SetCustomSortOrder TryGetCustomSortOrder

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

CalculatedExpression

  • get CalculatedExpression(): string

  • Gets the derived expression of the column. The calculated expression is the expression text after preprocessing the original expression (Spotfire.Dxp.Data.DataColumnProperties.Expression).

    Returns string

    Since

    2.0

ColumnType

Comparer

ContentType

  • get ContentType(): string

  • Gets or sets a more specific type of the data contained in a column of a certain DataType.

    Returns string

    Since

    2.0

  • set ContentType(value): void

  • Parameters

    • value: string

    Returns void

DataType

  • get DataType(): DataType

  • Gets or sets the data type of the column.

    Returns DataType

    Since

    2.0

  • set DataType(value): void

  • Parameters

    Returns void

Description

  • get Description(): string

  • Gets or sets a textual description of the column.

    Returns string

    Since

    2.0

  • set Description(value): void

  • Parameters

    • value: string

    Returns void

Expression

  • get Expression(): string

  • Gets the defining expression of the column.

    Returns string

    Since

    2.0

ExternalId

  • get ExternalId(): string

  • Gets or sets the external identifier of the column.

    Returns string

    Since

    2.0

  • set ExternalId(value): void

  • Parameters

    • value: string

    Returns void

ExternalName

  • get ExternalName(): string

  • Gets or sets the external name of the column.

    Returns string

    Since

    2.0

  • set ExternalName(value): void

  • Parameters

    • value: string

    Returns void

Formatter

IsValid

  • get IsValid(): boolean

  • Gets a value indicating whether the column has valid values: true if the column has valid values; otherwise, false.

    Returns boolean

    Since

    2.0

Name

  • get Name(): string

  • Gets or sets the name of the column.

    Returns string

    Since

    2.0

  • set Name(value): void

  • Parameters

    • value: string

    Returns void

PreferredAggregationMethod

  • get PreferredAggregationMethod(): null | string

  • Gets or sets the preferred aggregation method. If set to the name of an aggregation method, for instance "sum" or "avg", this method is used by plot heuristics when creating aggregated expressions from this column.

    Returns null | string

    Since

    2.0

  • set PreferredAggregationMethod(value): void

  • Parameters

    • value: null | string

    Returns void

PropertyNames

Get

  • Get(propertyName): unknown

  • Gets the value of a named property. Binary data properties are returned as UInt8Array.

    Parameters

    • propertyName: string | String

      The property name.

    Returns unknown

    The value of the property.

    Since

    2.0

PropertyExists

  • PropertyExists(name): boolean

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

    Since

    2.0

Set

  • Set(propertyName, value): void

  • Sets the value of a named property. Setting a binary data property expects the value to be an UInt8Array.

    Parameters

    • propertyName: string | String

      The property name.

    • value: any

      The value to set.

    Returns void

    Since

    2.0

SetCustomSortOrder

  • SetCustomSortOrder(values): void

  • Sets a custom sort order. The values in values must be of the same type as the values in the column. Column values not present in values will be sorted last.

    Parameters

    Returns void

    Since

    2.0

TryGetCustomSortOrder

  • TryGetCustomSortOrder(values): boolean

  • Tries to get the custom sort order of the column, if any.

    Parameters

    Returns boolean

    True if the column has a custom sort order; otherwise false.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability