#ChartTypeBuilder

Chart type builder for switching and retrieving the chart type. Supports various chart types including table, bar, line, pie, scatter, and more.

#Methods

#constructor

Constructor

Definition:

constructor(doc: Y.Doc, dsl: Y.Map<any>)

Parameters:

#observe

Listens for chart type changes.

Definition:

observe(callback: ObserveCallback): () => void

Returns: () => void

Parameters:

#changeChartType

Sets the chart type.

Definition:

changeChartType(chartType: string)

Parameters:

#getChartType

Gets the current chart type.

Definition:

getChartType(): string

Returns: string

#getSupportedDimensionEncodings

Gets the dimension encodings supported by the current chart type.

Definition:

getSupportedDimensionEncodings()

#getRecommendedDimensionEncodings

Returns recommended dimension encodings in order based on the current chart type.

Definition:

getRecommendedDimensionEncodings(dimensionCount?: number)

Parameters:

#getSupportedMeasureEncodings

Gets the measure encodings supported by the current chart type.

Definition:

getSupportedMeasureEncodings()

#getRecommendedMeasureEncodings

Returns recommended measure encodings in order based on the current chart type.

Definition:

getRecommendedMeasureEncodings(measureCount?: number)

Parameters:

#toJSON

Exports to JSON.

Definition:

toJSON(): string

Returns: string

#getAvailableChartTypes

Gets all supported chart types.

Definition:

getAvailableChartTypes(): string[]

Returns: string[]