search

Preparing search index...
The search index is not available

Class RVFieldFormattingDescriptor

Information about the field to be formatted.

Hierarchy

RVFieldFormattingDescriptor

Index

Constructors

constructor

Accessors

Constructors

constructor

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

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

Accessors

currentSettings

get currentSettings(): null | RVFormattingSpec
set currentSettings(value: null | RVFormattingSpec): void

The field's current formatting

Returns null | RVFormattingSpec
The field's current formatting

Parameters
- value: null | RVFormattingSpec
Returns void

dataType

get dataType(): RVDashboardDataType
set dataType(value: RVDashboardDataType): void

Data type of the field

Returns RVDashboardDataType
Data type of the field

Parameters
- value: RVDashboardDataType
Returns void

dateAggregationType

get dateAggregationType(): RVDashboardDateAggregationType
set dateAggregationType(value: RVDashboardDateAggregationType): void

Date aggregation type, if applicable.

Returns RVDashboardDateAggregationType
Date aggregation type, if applicable.

Parameters
- value: RVDashboardDateAggregationType
Returns void

fieldName

get fieldName(): string
set fieldName(value: string): void

Name of the field

Returns string
Name of the field

Parameters
- value: string
Returns void

isAggregated

get isAggregated(): boolean
set isAggregated(value: boolean): void

True iif the field to be formatted is aggregated.

Returns boolean
True iif the field to be formatted is aggregated.

Parameters
- value: boolean
Returns void