update custom series usage example within the documentation

tradingview · Oct 8, 2023 · a976927 · a976927
1 parent b7101dc
commit a976927
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 4 deletions.
diff --git a/website/docs/plugins/intro.md b/website/docs/plugins/intro.md
@@ -44,7 +44,7 @@ WhitespaceData interface (have a valid time property for each data point).
 
 A custom series can be added to a chart using the
 [`addCustomSeries`](../api/interfaces/IChartApi.md#addcustomseries) method
-which expects a class implementing the
+which expects an instance of a class implementing the
 [ICustomSeriesPaneView](../api/interfaces/ICustomSeriesPaneView.md) interface
 as the first argument, and an optional set of options as the second argument.
 The series can then be used just like any other series, for example you would
@@ -55,8 +55,11 @@ class MyCustomSeries {
     /* Class implementing the ICustomSeriesPaneView interface */
 }
 
+// Create an instantiated custom series.
+const customSeriesInstance = new MyCustomSeries();
+
 const chart = createChart(document.getElementById('container'));
-const myCustomSeries = chart.addCustomSeries(MyCustomSeries, {
+const myCustomSeries = chart.addCustomSeries(customSeriesInstance, {
     // options for the MyCustomSeries
     customOption: 10,
 });

diff --git a/website/versioned_docs/version-4.1/plugins/intro.md b/website/versioned_docs/version-4.1/plugins/intro.md
@@ -44,7 +44,7 @@ WhitespaceData interface (have a valid time property for each data point).
 
 A custom series can be added to a chart using the
 [`addCustomSeries`](../api/interfaces/IChartApi.md#addcustomseries) method
-which expects a class implementing the
+which expects an instance of a class implementing the
 [ICustomSeriesPaneView](../api/interfaces/ICustomSeriesPaneView.md) interface
 as the first argument, and an optional set of options as the second argument.
 The series can then be used just like any other series, for example you would
@@ -55,8 +55,11 @@ class MyCustomSeries {
     /* Class implementing the ICustomSeriesPaneView interface */
 }
 
+// Create an instantiated custom series.
+const customSeriesInstance = new MyCustomSeries();
+
 const chart = createChart(document.getElementById('container'));
-const myCustomSeries = chart.addCustomSeries(MyCustomSeries, {
+const myCustomSeries = chart.addCustomSeries(customSeriesInstance, {
     // options for the MyCustomSeries
     customOption: 10,
 });