About
Working with mods
API documentation
- Action mods
  - API documentation
- Visualization mods
  - API overview
  - API documentation

Interface AnalysisProperty<T>

Represents a property owned by the Spotfire document. These can be either document properties, data table properties or data column properties.

interface AnalysisProperty<
    T extends AnalysisPropertyDataType = AnalysisPropertyDataType,
> {
    dataType: DataType;
    isList: boolean;
    name: string;
    set(value: null | T | T[]): void;
    value<T2 extends AnalysisPropertyDataType>(): null | T2;
    valueList<T2 extends AnalysisPropertyDataType>(): T2[];
}

Type Parameters

T extends AnalysisPropertyDataType = AnalysisPropertyDataType

Hierarchy (View Summary)

AnalysisPropertyValue<T>
- AnalysisProperty

Index

Properties

dataType isList name

Methods

set value valueList

Properties

dataType

dataType: DataType

Get the Spotfire internal data type of the property.

isList

isList: boolean

Gets a value indicating whether the property is a list.

name

name: string

Gets the name of this instance.

Methods

set

set(value: null | T | T[]): void
Set the value of this instance.
Parameters
- value: null | T | T[]
  The value to set.
Returns void

value

value<T2 extends AnalysisPropertyDataType>(): null | T2
Gets the value held by this instance. Will throw if the value is a list, i.e. AnalysisPropertyValue.isList returns true;
Type Parameters
- T2 extends AnalysisPropertyDataType
Returns null | T2
Inherited from AnalysisPropertyValue.value

valueList

valueList<T2 extends AnalysisPropertyDataType>(): T2[]
Gets the value held by this instance. Will throw if the value is not a list, i.e. AnalysisPropertyValue.isList returns false;
Type Parameters
- T2 extends AnalysisPropertyDataType
Returns T2[]
Inherited from AnalysisPropertyValue.valueList