fix: seriesType type

Author: illetid

src/model/series/area-series.ts

@@ -24,19 +24,17 @@ export const areaStyleDefaults: AreaStyleOptions = {
 	lastPriceAnimation: LastPriceAnimationMode.Disabled,
 	pointMarkersVisible: false,
 };
-const seriesType = 'Area';
-const createPaneView = (series: ISeries<typeof seriesType>, model: IChartModelBase): IUpdatablePaneView => new SeriesAreaPaneView(series, model);
-
-export const createSeries = (): SeriesDefinition<typeof seriesType> => {
-	const definition: SeriesDefinitionInternal<typeof seriesType> = {
-		type: seriesType,
+const createPaneView = (series: ISeries<'Area'>, model: IChartModelBase): IUpdatablePaneView => new SeriesAreaPaneView(series, model);
+export const createSeries = (): SeriesDefinition<'Area'> => {
+	const definition: SeriesDefinitionInternal<'Area'> = {
+		type: 'Area',
 		isBuiltIn: true as const,
 		defaultOptions: areaStyleDefaults,
 		/**
 		 * @internal
 		 */
 		createPaneView: createPaneView,
 	};
-	return definition as SeriesDefinition<typeof seriesType>;
+	return definition as SeriesDefinition<'Area'>;
 };
-export const areaSeries: SeriesDefinition<typeof seriesType> = createSeries();
+export const areaSeries: SeriesDefinition<'Area'> = createSeries();

src/model/series/bar-series.ts

@@ -12,12 +12,11 @@ export const barStyleDefaults: BarStyleOptions = {
 	openVisible: true,
 	thinBars: true,
 };
-const seriesType = 'Bar';
-const createPaneView = (series: ISeries<typeof seriesType>, model: IChartModelBase): IUpdatablePaneView => new SeriesBarsPaneView(series, model);
+const createPaneView = (series: ISeries<'Bar'>, model: IChartModelBase): IUpdatablePaneView => new SeriesBarsPaneView(series, model);
 
-export const createSeries = (): SeriesDefinition<typeof seriesType> => {
-	const definition: SeriesDefinitionInternal<typeof seriesType> = {
-		type: seriesType,
+export const createSeries = (): SeriesDefinition<'Bar'> => {
+	const definition: SeriesDefinitionInternal<'Bar'> = {
+		type: 'Bar',
 		isBuiltIn: true as const,
 		defaultOptions: barStyleDefaults,
 		/**
@@ -26,6 +25,6 @@ export const createSeries = (): SeriesDefinition<typeof seriesType> => {
 		createPaneView: createPaneView,
 	};
 
-	return definition as SeriesDefinition<typeof seriesType>;
+	return definition as SeriesDefinition<'Bar'>;
 };
-export const barSeries: SeriesDefinition<typeof seriesType> = createSeries();
+export const barSeries: SeriesDefinition<'Bar'> = createSeries();

src/model/series/baseline-series.ts

@@ -35,19 +35,18 @@ export const baselineStyleDefaults: BaselineStyleOptions = {
 	lastPriceAnimation: LastPriceAnimationMode.Disabled,
 	pointMarkersVisible: false,
 };
-const seriesType = 'Baseline';
-const createPaneView = (series: ISeries<typeof seriesType>, model: IChartModelBase): IUpdatablePaneView => new SeriesBaselinePaneView(series, model);
+const createPaneView = (series: ISeries<'Baseline'>, model: IChartModelBase): IUpdatablePaneView => new SeriesBaselinePaneView(series, model);
 
-export const createSeries = (): SeriesDefinition<typeof seriesType> => {
-	const definition: SeriesDefinitionInternal<typeof seriesType> = {
-		type: seriesType,
+export const createSeries = (): SeriesDefinition<'Baseline'> => {
+	const definition: SeriesDefinitionInternal<'Baseline'> = {
+		type: 'Baseline',
 		isBuiltIn: true as const,
 		defaultOptions: baselineStyleDefaults,
 		/**
 		 * @internal
 		 */
 		createPaneView: createPaneView,
 	};
-	return definition as SeriesDefinition<typeof seriesType>;
+	return definition as SeriesDefinition<'Baseline'>;
 };
-export const baselineSeries: SeriesDefinition<typeof seriesType> = createSeries();
+export const baselineSeries: SeriesDefinition<'Baseline'> = createSeries();

src/model/series/candlestick-series.ts

@@ -18,20 +18,19 @@ export const candlestickStyleDefaults: CandlestickStyleOptions = {
 	wickUpColor: '#26a69a',
 	wickDownColor: '#ef5350',
 };
-const seriesType = 'Candlestick';
 
-const createPaneView = (series: ISeries<typeof seriesType>, model: IChartModelBase): IUpdatablePaneView => new SeriesCandlesticksPaneView(series, model);
+const createPaneView = (series: ISeries<'Candlestick'>, model: IChartModelBase): IUpdatablePaneView => new SeriesCandlesticksPaneView(series, model);
 
-export const createSeries = (): SeriesDefinition<typeof seriesType> => {
-	const definition: SeriesDefinitionInternal<typeof seriesType> = {
-		type: seriesType,
+export const createSeries = (): SeriesDefinition<'Candlestick'> => {
+	const definition: SeriesDefinitionInternal<'Candlestick'> = {
+		type: 'Candlestick',
 		isBuiltIn: true as const,
 		defaultOptions: candlestickStyleDefaults,
 		/**
 		 * @internal
 		 */
 		createPaneView: createPaneView,
 	};
-	return definition as SeriesDefinition<typeof seriesType>;
+	return definition as SeriesDefinition<'Candlestick'>;
 };
-export const candlestickSeries: SeriesDefinition<typeof seriesType> = createSeries();
+export const candlestickSeries: SeriesDefinition<'Candlestick'> = createSeries();

src/model/series/custom-series.ts

@@ -12,8 +12,7 @@ import { SeriesDefinition, SeriesDefinitionInternal } from './series-def';
 export const customStyleDefaults: CustomStyleOptions = {
 	color: '#2196f3',
 };
-const seriesType = 'Custom';
-const createPaneView = <HorzScaleItem>(series: ISeries<typeof seriesType>, model: IChartModelBase, customPaneView?: ICustomSeriesPaneView<HorzScaleItem>): IUpdatablePaneView => {
+const createPaneView = <HorzScaleItem>(series: ISeries<'Custom'>, model: IChartModelBase, customPaneView?: ICustomSeriesPaneView<HorzScaleItem>): IUpdatablePaneView => {
 	const paneView = ensure(customPaneView);
 	return new SeriesCustomPaneView(series, model, paneView);
 };
@@ -24,7 +23,7 @@ export const createCustomSeriesDefinition = <
 	TSeriesOptions extends CustomSeriesOptions = CustomSeriesOptions
 >(paneView: ICustomSeriesPaneView<HorzScaleItem, TData, TSeriesOptions>): SeriesDefinition<'Custom'> => {
 	const definition: SeriesDefinitionInternal<'Custom'> = {
-		type: seriesType,
+		type: 'Custom',
 		isBuiltIn: false as const,
 		defaultOptions: { ...customStyleDefaults, ...paneView.defaultOptions() },
 		/**

src/model/series/histogram-series.ts

@@ -10,20 +10,18 @@ export const histogramStyleDefaults: HistogramStyleOptions = {
 	color: '#26a69a',
 	base: 0,
 };
-const seriesType = 'Histogram';
+const createPaneView = (series: ISeries<'Histogram'>, model: IChartModelBase): IUpdatablePaneView => new SeriesHistogramPaneView(series, model);
 
-const createPaneView = (series: ISeries<typeof seriesType>, model: IChartModelBase): IUpdatablePaneView => new SeriesHistogramPaneView(series, model);
-
-export const createSeries = (): SeriesDefinition<typeof seriesType> => {
-	const definition: SeriesDefinitionInternal<typeof seriesType> = {
-		type: seriesType,
+export const createSeries = (): SeriesDefinition<'Histogram'> => {
+	const definition: SeriesDefinitionInternal<'Histogram'> = {
+		type: 'Histogram',
 		isBuiltIn: true as const,
 		defaultOptions: histogramStyleDefaults,
 		/**
 		 * @internal
 		 */
 		createPaneView: createPaneView,
 	};
-	return definition as SeriesDefinition<typeof seriesType>;
+	return definition as SeriesDefinition<'Histogram'>;
 };
-export const histogramSeries: SeriesDefinition<typeof seriesType> = createSeries();
+export const histogramSeries: SeriesDefinition<'Histogram'> = createSeries();

src/model/series/line-series.ts

@@ -21,21 +21,20 @@ export const lineStyleDefaults: LineStyleOptions = {
 	lastPriceAnimation: LastPriceAnimationMode.Disabled,
 	pointMarkersVisible: false,
 };
-const seriesType = 'Line';
 
 const createPaneView = (series: ISeries<'Line'>, model: IChartModelBase): IUpdatablePaneView => new SeriesLinePaneView(series, model);
 
-export const createLineSeries = (): SeriesDefinition<typeof seriesType> => {
-	const definition: SeriesDefinitionInternal<typeof seriesType> = {
-		type: seriesType,
+export const createLineSeries = (): SeriesDefinition<'Line'> => {
+	const definition: SeriesDefinitionInternal<'Line'> = {
+		type: 'Line',
 		isBuiltIn: true as const,
 		defaultOptions: lineStyleDefaults,
 		/**
 		 * @internal
 		 */
 		createPaneView: createPaneView,
 	};
-	return definition as SeriesDefinition<typeof seriesType>;
+	return definition as SeriesDefinition<'Line'>;
 };
-export const lineSeries: SeriesDefinition<typeof seriesType> = createLineSeries();
+export const lineSeries: SeriesDefinition<'Line'> = createLineSeries();
 

src/model/series/series-def.ts

@@ -5,10 +5,25 @@ import { ICustomSeriesPaneView } from '../icustom-series';
 import { ISeries } from '../iseries';
 import { SeriesStyleOptionsMap, SeriesType } from '../series-options';
 
+/**
+ * Series definition interface.
+ */
 export interface SeriesDefinition<T extends SeriesType> {
+	/**
+	 * Series type.
+	 */
 	readonly type: T;
+	/**
+	 * Indicates if the series is built-in.
+	 */
 	readonly isBuiltIn: boolean;
+	/**
+	 * Default series options.
+	 */
 	readonly defaultOptions: SeriesStyleOptionsMap[T];
+	/**
+	 * Custom pane view (optional).
+	 */
 	readonly customPaneView?: ICustomSeriesPaneView<unknown>;
 }