search

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

Class RVVisualizationFieldLabelElement

Field label to be localized. The field is being used in a visualization and can have some aggregation applied to it.

Hierarchy

RVFieldLabelElementBase
- RVVisualizationFieldLabelElement

Index

Constructors

constructor

Accessors

Constructors

constructor

new RVVisualizationFieldLabelElement(name?: null | string, label?: null | string, aggregationType?: RVDashboardAggregationType): RVVisualizationFieldLabelElement

Overrides RVFieldLabelElementBase.constructor

Parameters
- Optional name: null | string
- Optional label: null | string
- Optional aggregationType: RVDashboardAggregationType
Returns RVVisualizationFieldLabelElement

Accessors

aggregationType

get aggregationType(): RVDashboardAggregationType
set aggregationType(value: RVDashboardAggregationType): void

The aggregation type applied to the field, if any. Has value "NotSet" when the visualizationField is not a measure.

Returns RVDashboardAggregationType
The aggregation type applied to the field, if any. Has value "NotSet" when the visualizationField is not a measure.

Parameters
- value: RVDashboardAggregationType
Returns void

elementType

get elementType(): RVLocalizationElementType

Type of the localization element.

Returns RVLocalizationElementType

label

get label(): null | string
set label(value: null | string): void

The current label of the field.

Returns null | string
The current label of the field.

Parameters
- value: null | string
Returns void

name

get name(): null | string
set name(value: null | string): void

The name of the field

Returns null | string
The name of the field

Parameters
- value: null | string
Returns void