Add Yield Curve and Options Chart Types, Up/Down Markers Plugin

[SlicedSilver]

Type of PR: new features

PR checklist:

• Addresses an existing issue: fixes #
• Includes tests
• Documentation update

Overview of change:

Add Yield Curve and Options Chart Types, Up/Down Markers Plugin, and Documentation Updates

New Features:

1. Yield Curve Chart:

   • Added a new chart type specifically designed for displaying yield curves.
   • Introduced the createYieldCurveChart function.
   • Implemented specialized horizontal scale behavior for yield curves, including linear spacing and whitespace handling.

2. Options Chart:

   • Added a new chart type that uses price values on the horizontal scale.
   • Introduced the createOptionsChart function.
   • Implemented horizontal scale behavior for price-based charts.

3. Up/Down Markers Plugin:

   • Added the UpDownMarkersPrimitive plugin to display markers indicating price changes.
   • Implemented marker management with automatic expiration and update handling.

4. Codebase Improvements / API additions:

   • Added the ignoreWhitespaceIndices option to the time scale configuration.
   • Enhanced the updateSeriesData function to support historical updates.

5. Documentation:

   • Updated the documentation to include new chart types and their usage.
   • Added a new page for chart types, detailing the creation and use cases for standard time-based, yield curve, and options charts.

[github-actions]

size-limit report 📦

Path	Size
ESM	45.01 KB (+4.57% 🔺)
ESM createChart	42.16 KB (+0.86% 🔺)
ESM createChartEx	40.94 KB (+0.97% 🔺)
ESM Standalone	0 B (-100% 🔽)
Standalone	46.4 KB (+4.37% 🔺)
Plugin: Text Watermark	1.79 KB (+0.11% 🔺)
Plugin: Image Watermark	1.63 KB (+0.73% 🔺)
ESM createYieldCurveChart	41.54 KB (+100% 🔺)
ESM createOptionsChart	41.1 KB (+100% 🔺)
Standalone-ESM	46.49 KB (+100% 🔺)
Plugin: UpDownMarkersPrimitive	2.25 KB (+100% 🔺)

[SlicedSilver]

Since this is exported and thus included in the generated d.ts file lets give it a more explicit name

[illetid]

Not a review, just a question. Did you consider creating it using a custom series? From my point of view, managing the series via the series' primitive seems unintuitive. Since it’s a core plugin, we have access to all the source code, so we could potentially wrap the line and area series and add the up/down indicator logic on update. I haven’t thought much about it, so there might be other limitations with the custom series approach

[SlicedSilver]

As with most things it is a trade-off. In many ways it makes sense to create a custom series but there are some benefits to using a Primitive. The drawing of markers fits better into a primitive (conceptually), and the main reason for using a primitive is that it can be used on multiple types of series (and custom series) so we are not limiting this plugin to only working with one or two series which are copies of existing series types.
Finally, the up down markers plugin can be used without needing to use the setData / update passthrough methods if you use the manual setMarkers method. So my thinking is that using as a Primitive is a more flexible and lower level implementation which can make it useful in more use-cases.