Allow arbitrary chart plugins

Author: Mischa Spelt

blazorbootstrap/Models/Charts/ChartPlugins/ChartPlugins.cs

@@ -1,7 +1,67 @@
-namespace BlazorBootstrap;
+using System.Diagnostics.CodeAnalysis;
+
+namespace BlazorBootstrap;
+
+public abstract class ChartPlugin { }
 
 public class ChartPlugins
 {
+  #region Fields
+
+  [JsonInclude]
+  [JsonExtensionData]
+  private Dictionary<string, object> customPlugins = new();
+
+  [JsonIgnore]
+  private Dictionary<Type, ChartPlugin> customPluginsByType = new();
+
+  #endregion
+
+  #region Methods
+
+  public void Add<T>( string key, T plugin )
+    where T : ChartPlugin
+  {
+    customPlugins.Add( key, plugin );
+    customPluginsByType.Add( typeof( T ), plugin );
+  }
+
+  public bool TryAdd<T>( string key, ChartPlugin plugin )
+    where T : ChartPlugin
+      => customPlugins.TryAdd( key, plugin ) && customPluginsByType.TryAdd( typeof( T ), plugin );
+
+  public T Get<T>( string key ) where T : ChartPlugin
+    => (T)customPlugins[ key ];
+
+  public T? Get<T>() where T : ChartPlugin
+    => customPluginsByType.TryGetValue( typeof( T ), out var plugin ) ? (T)plugin : null;
+
+  public bool TryGet<T>( string key, [NotNullWhen( true )] out T? value ) where T : ChartPlugin
+  {
+    value = null;
+    if( customPlugins.TryGetValue( key, out var plugin ) && ( plugin is T pluginAsT ) )
+    {
+      value = pluginAsT;
+      return true;
+    }
+
+    return false;
+  }
+
+  public bool TryGet<T>( [NotNullWhen( true )] out T? value ) where T : ChartPlugin
+  {
+    value = null;
+    if( customPluginsByType.TryGetValue( typeof( T ), out var plugin ) && ( plugin is T pluginAsT ) )
+    {
+      value = pluginAsT;
+      return true;
+    }
+
+    return false;
+  }
+
+  #endregion
+
   #region Properties, Indexers
 
   /// <summary>
@@ -23,13 +83,6 @@ public class ChartPlugins
   [JsonIgnore( Condition = JsonIgnoreCondition.WhenWritingNull )]
   public ChartPluginsTooltip? Tooltip { get; set; }
 
-  /// <summary>
-  /// Tooltip for automatic color selection.
-  /// <see href="https://www.chartjs.org/docs/latest/general/colors.html"/>
-  /// </summary>
-  [JsonIgnore( Condition = JsonIgnoreCondition.WhenWritingNull )]
-  public ChartPluginsColors? Colors { get; set; }
-
   /// <summary>
   /// Annotations are a way to draw over chart data, and can be used to draw guides, lines, or any other custom elements.
   /// </summary>
@@ -39,7 +92,7 @@ public class ChartPlugins
   #endregion
 }
 
-public class ChartPluginsAnnotation
+public class ChartPluginsAnnotation : ChartPlugin
 {
   #region Inner classes
 
@@ -93,7 +146,7 @@ public class ChartPluginsAnnotationsCommon
   #endregion
 }
 
-public class ChartPluginsLegend
+public class ChartPluginsLegend : ChartPlugin
 {
   #region Properties, Indexers
 
@@ -160,7 +213,7 @@ public class ChartPluginsLegend
   #endregion
 }
 
-public class ChartPluginsLegendTitle
+public class ChartPluginsLegendTitle : ChartPlugin
 {
   /// <summary>
   /// Color of the legend. Default value is 'black'.
@@ -190,7 +243,7 @@ public class ChartPluginsLegendTitle
 /// The chart label settings
 /// <see href="https://www.chartjs.org/docs/latest/configuration/legend.html#legend-label-configuration" />
 /// </summary>
-public class ChartPluginsLegendLabels
+public class ChartPluginsLegendLabels : ChartPlugin
 {
   /// <summary>
   /// Width of coloured box.
@@ -253,7 +306,7 @@ public class ChartPluginsLegendLabels
 /// The chart title defines text to draw at the top of the chart.
 /// <see href="https://www.chartjs.org/docs/latest/configuration/title.html" />
 /// </summary>
-public class ChartPluginsTitle
+public class ChartPluginsTitle : ChartPlugin
 {
   #region Properties, Indexers
 
@@ -291,7 +344,7 @@ public class ChartPluginsTitle
 /// Tooltip for bubble, doughnut, pie, polar area, and scatter charts
 /// <see href="https://www.chartjs.org/docs/latest/configuration/tooltip.html" />
 /// </summary>
-public class ChartPluginsTooltip
+public class ChartPluginsTooltip : ChartPlugin
 {
   #region Properties, Indexers
 
@@ -398,7 +451,7 @@ public class ChartPluginsTooltip
 /// <summary>
 ///     <see href="https://www.chartjs.org/docs/latest/general/fonts.html" />
 /// </summary>
-public class ChartPluginsTooltipFont
+public class ChartPluginsTooltipFont : ChartPlugin
 {
   #region Properties, Indexers
 
@@ -436,25 +489,3 @@ public class ChartPluginsTooltipFont
 
   #endregion
 }
-
-/// <summary>
-///   <see href="https://www.chartjs.org/docs/latest/general/colors.html" />
-/// </summary>
-public class ChartPluginsColors
-{
-  #region Properties, Indexers
-
-  /// <summary>
-  /// Whether the colors plugin is enabled.
-  /// </summary>
-  [JsonIgnore( Condition = JsonIgnoreCondition.WhenWritingNull )]
-  public bool? Enabled { get; set; }
-
-  /// <summary>
-  /// Whether the colors plugin should be used to select series colors, regardless of whether they are specified in the dataset.
-  /// </summary>
-  [JsonIgnore( Condition = JsonIgnoreCondition.WhenWritingNull )]
-  public bool? ForceOverride { get; set; }
-
-  #endregion
-}