💄 (grapher) rename dodMarker -> detailsMarker

owid · Mar 6, 2024 · 4c73b35 · 4c73b35
1 parent e16f4d6
commit 4c73b35
Show file tree

Hide file tree

Showing 10 changed files with 27 additions and 25 deletions.
diff --git a/packages/@ourworldindata/components/src/MarkdownTextWrap/MarkdownTextWrap.tsx b/packages/@ourworldindata/components/src/MarkdownTextWrap/MarkdownTextWrap.tsx
@@ -642,15 +642,15 @@ export class MarkdownTextWrap extends React.Component<MarkdownTextWrapProps> {
         y: number,
         {
             textProps,
-            dodMarker = "superscript",
+            detailsMarker = "superscript",
         }: {
             textProps?: React.SVGProps<SVGTextElement>
-            dodMarker?: DetailsMarker
+            detailsMarker?: DetailsMarker
         } = {}
     ): JSX.Element | null {
         const { fontSize, lineHeight } = this
         const lines =
-            dodMarker === "superscript"
+            detailsMarker === "superscript"
                 ? this.svgLinesWithDodReferenceNumbers
                 : this.svgLines
         if (lines.length === 0) return null
@@ -690,7 +690,7 @@ export class MarkdownTextWrap extends React.Component<MarkdownTextWrapProps> {
                     ))}
                 </text>
                 {/* SVG doesn't support dotted underlines, so we draw them manually */}
-                {dodMarker === "underline" &&
+                {detailsMarker === "underline" &&
                     lines.map((line, lineIndex) => {
                         const y = (getLineY(lineIndex) + 2).toFixed(1)
                         let currWidth = 0

diff --git a/packages/@ourworldindata/grapher/src/axis/AxisViews.tsx b/packages/@ourworldindata/grapher/src/axis/AxisViews.tsx
@@ -157,7 +157,7 @@ interface DualAxisViewProps {
     labelColor?: string
     tickColor?: string
     lineWidth?: number
-    dodMarker?: DetailsMarker
+    detailsMarker?: DetailsMarker
 }
 
 @observer
@@ -169,7 +169,7 @@ export class DualAxisComponent extends React.Component<DualAxisViewProps> {
             labelColor,
             tickColor,
             lineWidth,
-            dodMarker,
+            detailsMarker,
         } = this.props
         const { bounds, horizontalAxis, verticalAxis, innerBounds } = dualAxis
 
@@ -195,7 +195,7 @@ export class DualAxisComponent extends React.Component<DualAxisViewProps> {
                 verticalAxis={verticalAxis}
                 labelColor={labelColor}
                 tickColor={tickColor}
-                dodMarker={dodMarker}
+                detailsMarker={detailsMarker}
             />
         )
 
@@ -208,7 +208,7 @@ export class DualAxisComponent extends React.Component<DualAxisViewProps> {
                 labelColor={labelColor}
                 tickColor={tickColor}
                 tickMarkWidth={lineWidth}
-                dodMarker={dodMarker}
+                detailsMarker={detailsMarker}
             />
         )
 
@@ -229,10 +229,10 @@ export class VerticalAxisComponent extends React.Component<{
     verticalAxis: VerticalAxis
     labelColor?: string
     tickColor?: string
-    dodMarker?: DetailsMarker
+    detailsMarker?: DetailsMarker
 }> {
     render(): JSX.Element {
-        const { bounds, verticalAxis, labelColor, tickColor, dodMarker } =
+        const { bounds, verticalAxis, labelColor, tickColor, detailsMarker } =
             this.props
         const { tickLabels, labelTextWrap } = verticalAxis
 
@@ -247,7 +247,7 @@ export class VerticalAxisComponent extends React.Component<{
                                 transform: "rotate(-90)",
                                 fill: labelColor || GRAPHER_DARK_TEXT,
                             },
-                            dodMarker,
+                            detailsMarker,
                         }
                     )}
                 {tickLabels.map((label, i) => {
@@ -285,7 +285,7 @@ export class HorizontalAxisComponent extends React.Component<{
     labelColor?: string
     tickColor?: string
     tickMarkWidth?: number
-    dodMarker?: DetailsMarker
+    detailsMarker?: DetailsMarker
 }> {
     @computed get scaleType(): ScaleType {
         return this.props.axis.scaleType
@@ -312,7 +312,7 @@ export class HorizontalAxisComponent extends React.Component<{
             labelColor,
             tickColor,
             tickMarkWidth,
-            dodMarker,
+            detailsMarker,
         } = this.props
         const { tickLabels, labelTextWrap: label, labelOffset, orient } = axis
         const horizontalAxisLabelsOnTop = orient === Position.top
@@ -348,7 +348,7 @@ export class HorizontalAxisComponent extends React.Component<{
                             textProps: {
                                 fill: labelColor || GRAPHER_DARK_TEXT,
                             },
-                            dodMarker,
+                            detailsMarker,
                         }
                     )}
                 {tickMarks}

diff --git a/packages/@ourworldindata/grapher/src/footer/Footer.tsx b/packages/@ourworldindata/grapher/src/footer/Footer.tsx
@@ -771,7 +771,7 @@ export class StaticFooter extends Footer<StaticFooterProps> {
                     note.renderSVG(
                         targetX,
                         targetY + sources.height + this.verticalPadding,
-                        { dodMarker: this.manager.detailsMarkerInSvg }
+                        { detailsMarker: this.manager.detailsMarkerInSvg }
                     )}
                 {showLicenseNextToSources
                     ? licenseAndOriginUrl.render(

diff --git a/packages/@ourworldindata/grapher/src/header/Header.tsx b/packages/@ourworldindata/grapher/src/header/Header.tsx
@@ -305,7 +305,7 @@ export class StaticHeader extends Header<StaticHeaderProps> {
                             textProps: {
                                 fill: manager.secondaryColorInStaticCharts,
                             },
-                            dodMarker: this.manager.detailsMarkerInSvg,
+                            detailsMarker: this.manager.detailsMarkerInSvg,
                         }
                     )}
             </g>

diff --git a/packages/@ourworldindata/grapher/src/lineCharts/LineChart.tsx b/packages/@ourworldindata/grapher/src/lineCharts/LineChart.tsx
@@ -796,7 +796,7 @@ export class LineChart
                             ? GRAPHER_AXIS_LINE_WIDTH_THICK
                             : GRAPHER_AXIS_LINE_WIDTH_DEFAULT
                     }
-                    dodMarker={manager.detailsMarkerInSvg}
+                    detailsMarker={manager.detailsMarkerInSvg}
                 />
                 <g clipPath={clipPath.id}>
                     {comparisonLines.map((line, index) => (

diff --git a/packages/@ourworldindata/grapher/src/scatterCharts/ScatterPlotChart.tsx b/packages/@ourworldindata/grapher/src/scatterCharts/ScatterPlotChart.tsx
@@ -791,7 +791,7 @@ export class ScatterPlotChart
                             ? GRAPHER_AXIS_LINE_WIDTH_THICK
                             : GRAPHER_AXIS_LINE_WIDTH_DEFAULT
                     }
-                    dodMarker={manager.detailsMarkerInSvg}
+                    detailsMarker={manager.detailsMarkerInSvg}
                 />
                 {comparisonLines &&
                     comparisonLines.map((line, i) => (

diff --git a/packages/@ourworldindata/grapher/src/stackedCharts/MarimekkoChart.tsx b/packages/@ourworldindata/grapher/src/stackedCharts/MarimekkoChart.tsx
@@ -1008,7 +1008,7 @@ export class MarimekkoChart
                             ? GRAPHER_AXIS_LINE_WIDTH_THICK
                             : GRAPHER_AXIS_LINE_WIDTH_DEFAULT
                     }
-                    dodMarker={manager.detailsMarkerInSvg}
+                    detailsMarker={manager.detailsMarkerInSvg}
                 />
                 <HorizontalCategoricalColorLegend manager={this} />
                 {this.renderBars()}

diff --git a/packages/@ourworldindata/grapher/src/stackedCharts/StackedAreaChart.tsx b/packages/@ourworldindata/grapher/src/stackedCharts/StackedAreaChart.tsx
@@ -542,7 +542,7 @@ export class StackedAreaChart
                             ? GRAPHER_AXIS_LINE_WIDTH_THICK
                             : GRAPHER_AXIS_LINE_WIDTH_DEFAULT
                     }
-                    dodMarker={manager.detailsMarkerInSvg}
+                    detailsMarker={manager.detailsMarkerInSvg}
                 />
                 <g clipPath={clipPath.id}>
                     {showLegend && <LineLegend manager={this} />}

diff --git a/packages/@ourworldindata/grapher/src/stackedCharts/StackedBarChart.tsx b/packages/@ourworldindata/grapher/src/stackedCharts/StackedBarChart.tsx
@@ -450,7 +450,7 @@ export class StackedBarChart
                     bounds={bounds}
                     verticalAxis={verticalAxis}
                     labelColor={manager.secondaryColorInStaticCharts}
-                    dodMarker={manager.detailsMarkerInSvg}
+                    detailsMarker={manager.detailsMarkerInSvg}
                 />
                 <VerticalAxisGridLines
                     verticalAxis={verticalAxis}

diff --git a/packages/@ourworldindata/types/src/grapherTypes/GrapherTypes.ts b/packages/@ourworldindata/types/src/grapherTypes/GrapherTypes.ts
@@ -61,10 +61,12 @@ export enum KeyChartLevel {
     Top = 3, // chart will show at the top of the all charts block
 }
 
-// How to mark a detail on demand
-// - superscript: add a superscript reference number
-// - underline: underline the text
-// - none: don't mark it
+/**
+ * How to mark a detail on demand:
+ * - superscript: add a superscript reference number
+ * - underline: underline the text
+ * - none: don't mark it
+ */
 export type DetailsMarker = "superscript" | "underline" | "none"
 
 export interface BasicChartInformation {