refactor: rename stylingOptions to options to encompass all series options

Author: nima-taheri-mongodb

charts/core/src/Echart/Echart.types.ts

@@ -24,29 +24,29 @@ export interface StylingContext {
   seriesColor?: string;
 }
 
-// to convert an SeriesOption type of echarts into a more structured form aligned with LeafyGreen design standards,
+// to convert an SeriesOption type of echarts into a structured form more aligned with LeafyGreen design standards,
 // where the 'type', 'name', and 'data' fields are explicitly required and typed,
-// and all additional properties related to series styling are encapsulated within the 'stylingOptions' object
+// and all additional series properties encapsulated within the 'options' object
 interface DisciplinedSeriesOption<EChartType extends SeriesOption> {
   type: NonNullable<EChartType['type']>;
   name: string;
   data: NonNullable<EChartType['data']>;
-  stylingOptions: Omit<EChartType, 'type' | 'name' | 'data'>;
+  options: Omit<EChartType, 'type' | 'name' | 'data'>;
 }
 
 // all supported series options types disciplined and grouped into a single interface
 export interface EChartSeriesOptions {
   line: DisciplinedSeriesOption<LineSeriesOption>;
-  // TODO: to be leveraged in a follow-up PR that adds Bar chart support
+  // TODO: to be leveraged in a follow-up PR to add Bar chart support
   bar: DisciplinedSeriesOption<BarSeriesOption>;
 }
 
 // a disciplined substitute for SeriesOption type of echarts limited to the ones supported here
 export type EChartSeriesOption = Omit<
   ValuesOf<EChartSeriesOptions>,
-  'stylingOptions'
+  'options'
 > &
-  ValuesOf<EChartSeriesOptions>['stylingOptions'];
+  ValuesOf<EChartSeriesOptions>['options'];
 
 /**
  * TODO: This might need to be improved. `ComposeOption` appears to make most base option

charts/core/src/Series/Line/Line.tsx

@@ -8,7 +8,7 @@ export type LineProps = SeriesProps;
 
 function getDefaultLineOptions(
   stylingContext: StylingContext,
-): EChartSeriesOptions['line']['stylingOptions'] {
+): EChartSeriesOptions['line']['options'] {
   return {
     showSymbol: false,
     symbol: 'circle',
@@ -37,7 +37,7 @@ export const Line = (props: LineProps) => (
     type={'line'}
     name={props.name}
     data={props.data}
-    stylingOptions={getDefaultLineOptions}
+    options={getDefaultLineOptions}
   />
 );
 

charts/core/src/Series/Series.tsx

@@ -11,12 +11,12 @@ export function Series<T extends ValuesOf<EChartSeriesOptions>>({
   type,
   name,
   data,
-  stylingOptions,
+  options,
 }: {
   type: T['type'];
   name: T['name'];
   data: T['data'];
-  stylingOptions: (ctx: StylingContext) => T['stylingOptions'];
+  options: (ctx: StylingContext) => T['options'];
 }) {
   const {
     chart: { addSeries, ready, removeSeries },
@@ -35,7 +35,7 @@ export function Series<T extends ValuesOf<EChartSeriesOptions>>({
         type,
         name,
         data,
-        ...stylingOptions(context),
+        ...options(context),
       });
     } else {
       removeSeries(name);
@@ -57,7 +57,7 @@ export function Series<T extends ValuesOf<EChartSeriesOptions>>({
     type,
     name,
     data,
-    stylingOptions,
+    options,
   ]);
 
   return null;