Class StdfColumnMetadata

Represents column-level metadata in STDF.

Since

2.1

Hierarchy (View Summary)

StdfMetadataCollection
- StdfColumnMetadata

Implements

Methods

[iterator]

"[iterator]"(): Iterator<StdfMetadataProperty>
Returns Iterator<StdfMetadataProperty>
Overrides StdfMetadataCollection.[iterator]

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

GetHashCode

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

Returns number
A hash code for the current object.

Inherited from StdfMetadataCollection.GetHashCode

ToString

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

Returns string
A string that represents the current object.

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

Default capability

constructor

new StdfColumnMetadata(): StdfColumnMetadata
Initializes a new instance of the Spotfire.Dxp.Data.Formats.Stdf.StdfColumnMetadata class.

Returns StdfColumnMetadata
Since
2.1

Overrides StdfMetadataCollection.constructor
new StdfColumnMetadata(
columnName: string | String,
dataType: StdfValueType,
): StdfColumnMetadata
Initializes a new instance of the Spotfire.Dxp.Data.Formats.Stdf.StdfColumnMetadata class.
Parameters
- columnName: string | String
  The column name.
- dataType: StdfValueType
  The column data type.
Returns StdfColumnMetadata
Since
2.1

Overrides StdfMetadataCollection.constructor

AssignedProperties

get AssignedProperties(): System.Collections.Generic.IList<StdfMetadataProperty>
Gets an enumerable over all non-mandatory metadata properties of the column.

Returns System.Collections.Generic.IList<StdfMetadataProperty>
Since
2.1

Count

get Count(): number
Gets the number of properties in the collection.

Returns number
Since
2.1

Inherited from StdfMetadataCollection.Count

DataType

get DataType(): StdfValueType
Gets the data type of the column.

Returns StdfValueType
Since
2.1

IsImmutable

get IsImmutable(): boolean
Gets a value indicating whether this instance is immutable or not.

Returns boolean
Since
2.1

Inherited from StdfMetadataCollection.IsImmutable

Name

get Name(): string
Gets the name of the column.

Returns string
Since
2.1

AddOrReplaceProperty

AddOrReplaceProperty(property: StdfMetadataProperty): void
Adds or replaces a metadata property to the collection.
Parameters
- property: StdfMetadataProperty
  The new or modified metadata property.
Returns void
Since
2.1

Inherited from StdfMetadataCollection.AddOrReplaceProperty

AddProperty

AddProperty(property: StdfMetadataProperty): void
Adds a new metadata property to the collection.
Parameters
- property: StdfMetadataProperty
  The new metadata property.
Returns void
Since
2.1

Inherited from StdfMetadataCollection.AddProperty
AddProperty(name: string | String, value: number | Int32): void
Adds a new metadata property to the collection.
Parameters
- name: string | String
  The name of the property.
- value: number | Int32
  The value of the property.
Returns void
Since
2.1

Inherited from StdfMetadataCollection.AddProperty
AddProperty(name: string | String, value: string | String): void
Adds a new metadata property to the collection.
Parameters
- name: string | String
  The name of the property.
- value: string | String
  The value of the property.
Returns void
Since
2.1

Inherited from StdfMetadataCollection.AddProperty

GetEnumerator

GetEnumerator(): System.Collections.Generic.IEnumerator<StdfMetadataProperty>
Gets an enumerator with all metadata properties in the collection.

Returns System.Collections.Generic.IEnumerator<StdfMetadataProperty>
An enumerator instance.

Since
2.1

Inherited from StdfMetadataCollection.GetEnumerator

GetProperty

GetProperty<T>(typeT: TypeRefParam<T>, name: string | String): JsType<T>
Gets the value of a metadata property.
Type Parameters
- T
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
- name: string | String
  The name of the property.
Returns JsType<T>
The value of the metadata property.

Since
2.1

Inherited from StdfMetadataCollection.GetProperty

ImmutableCopy

ImmutableCopy(): StdfColumnMetadata
Returns an immutable copy of this instance.

Returns StdfColumnMetadata
An immutable copy of this instance.

Since
2.1

MutableCopy

MutableCopy(): StdfColumnMetadata
Returns a mutable copy of this instance.

Returns StdfColumnMetadata
A mutable copy of this instance.

Since
2.1

RemoveProperty

RemoveProperty(name: string | String): void
Removes the property with the specified name from the collection.
Parameters
- name: string | String
  The property name.
Returns void
Since
2.1

Inherited from StdfMetadataCollection.RemoveProperty

TryGetProperty

TryGetProperty(
name: string | String,
property: OutParam<StdfMetadataProperty>,
): boolean
Looks up a metadata property by name.
Parameters
- name: string | String
  The name of the property.
- property: OutParam<StdfMetadataProperty>
  The metadata property.
Returns boolean
True if the name was found; otherwise, false.

Since
2.1

Inherited from StdfMetadataCollection.TryGetProperty
TryGetProperty<T>(
    typeT: TypeRefParam<T>,
    name: string | String,
    value: OutParam<T>,
): boolean
Gets the value of a metadata property.
Type Parameters
- T
Parameters
- typeT: TypeRefParam<T>
  Generic type argument
- name: string | String
  The name of the property.
- value: OutParam<T>
  The value of the property if found; otherwise, null.
Returns boolean
True if the name was found; otherwise, false.

Since
2.1

Inherited from StdfMetadataCollection.TryGetProperty

ValidateComplete

ValidateComplete(): void
Validates that the properties 'Name' and 'DateType' are correctly set. Throws an System.ArgumentException if they are not valid.

Returns void
Since
2.1

Class StdfColumnMetadata

Since

Hierarchy (View Summary)

Implements

Index

Methods

Default capability

Methods

[iterator]

Returns Iterator<StdfMetadataProperty>

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

constructor

Returns StdfColumnMetadata

Since

Parameters

Returns StdfColumnMetadata

Since

AssignedProperties

Returns System.Collections.Generic.IList<StdfMetadataProperty>

Since

Count

Returns number

Since

DataType

Returns StdfValueType

Since

IsImmutable

Returns boolean

Since

Name

Returns string

Since

AddOrReplaceProperty

Parameters

Returns void

Since

AddProperty

Parameters

Returns void

Since

Parameters

Returns void

Since

Parameters

Returns void

Since

GetEnumerator

Returns System.Collections.Generic.IEnumerator<StdfMetadataProperty>

Since

GetProperty

Type Parameters

Parameters

Returns JsType<T>

Since

ImmutableCopy

Returns StdfColumnMetadata

Since

MutableCopy

Returns StdfColumnMetadata

Since

RemoveProperty

Parameters

`Static`Equals