Class RVFieldFormattingDescriptor

Information about the field to be formatted.

Index

Constructors

constructor

Accessors

currentSettings
dataType
dateAggregationType
fieldName
isAggregated

Constructors

constructor

new RVFieldFormattingDescriptor(
    fieldName: string,
    dataType: RVDashboardDataType,
    currentSettings: RVFormattingSpec | null,
    isAggregated: boolean,
    dateAggregationType: RVDashboardDateAggregationType,
): RVFieldFormattingDescriptor
Parameters
- fieldName: string
- dataType: RVDashboardDataType
- currentSettings: RVFormattingSpec | null
- isAggregated: boolean
- dateAggregationType: RVDashboardDateAggregationType
Returns RVFieldFormattingDescriptor

Accessors

currentSettings

get currentSettings(): RVFormattingSpec | null
The field's current formatting

Returns RVFormattingSpec | null
set currentSettings(value: RVFormattingSpec | null): void
Parameters
- value: RVFormattingSpec | null
Returns void

dataType

get dataType(): RVDashboardDataType
Data type of the field

Returns RVDashboardDataType
set dataType(value: RVDashboardDataType): void
Parameters
- value: RVDashboardDataType
Returns void

dateAggregationType

get dateAggregationType(): RVDashboardDateAggregationType
Date aggregation type, if applicable.

Returns RVDashboardDateAggregationType
set dateAggregationType(value: RVDashboardDateAggregationType): void
Parameters
- value: RVDashboardDateAggregationType
Returns void

fieldName

get fieldName(): string
Name of the field

Returns string
set fieldName(value: string): void
Parameters
- value: string
Returns void

isAggregated

get isAggregated(): boolean
True iif the field to be formatted is aggregated.

Returns boolean
set isAggregated(value: boolean): void
Parameters
- value: boolean
Returns void