All files / owid-grapher/grapher/stackedCharts StackedAreaChart.tsx

69.91% Statements 244/349
70.37% Branches 19/27
61.9% Functions 13/21
69.91% Lines 244/349

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 4791x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 12x 12x 12x 12x 12x 12x                                                     12x 12x       12x 12x 104x 104x 104x 104x 104x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 52x 52x 3301x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 12x 12x 12x 12x 12x 12x 12x 12x 52x 52x 3301x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 52x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x                                   12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 2x 2x 52x 52x 52x 52x 52x 52x 52x 52x 2x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 2x 2x 1x 1x 2x 2x 2x 1x 1x 1x     1x 1x 1x       1x 1x 2x 2x 2x 1x 1x     1x 1x     1x 1x 12x 12x 12x 12x 12x 12x             12x 12x 1x 1x     1x 1x           1x 1x 12x                                                                                                                                                                                                                                                                                                                                              
import * as React from "react"
import {
    reverse,
    clone,
    last,
    pointsToPath,
    getRelativeMouse,
    makeSafeForCSS,
    minBy,
    excludeUndefined,
} from "../../clientUtils/Util"
import { computed, action, observable } from "mobx"
import { SeriesName } from "../core/GrapherConstants"
import { observer } from "mobx-react"
import { DualAxisComponent } from "../axis/AxisViews"
import { DualAxis } from "../axis/Axis"
import {
    LineLabelSeries,
    LineLegend,
    LineLegendManager,
} from "../lineLegend/LineLegend"
import { NoDataModal } from "../noDataModal/NoDataModal"
import { Tooltip } from "../tooltip/Tooltip"
import { rgb } from "d3-color"
import {
    AbstactStackedChart,
    AbstactStackedChartProps,
} from "../stackedCharts/AbstractStackedChart"
import { StackedSeries } from "./StackedConstants"
import { stackSeries, withMissingValuesAsZeroes } from "./StackedUtils"
import { makeClipPath } from "../chart/ChartUtils"
import { Time } from "../../clientUtils/owidTypes"
 
interface AreasProps extends React.SVGAttributes<SVGGElement> {
    dualAxis: DualAxis
    seriesArr: readonly StackedSeries<Time>[]
    focusedSeriesNames: SeriesName[]
    onHover: (hoverIndex: number | undefined) => void
}
 
const BLUR_COLOR = "#ddd"
 
@observer
class Areas extends React.Component<AreasProps> {
    base: React.RefObject<SVGGElement> = React.createRef()
 
    @observable hoverIndex?: number
 
    @action.bound private onCursorMove(
        ev: React.MouseEvent<SVGGElement> | React.TouchEvent<SVGElement>
    ): void {
        const { dualAxis, seriesArr } = this.props

        if (this.base.current) {
            const mouse = getRelativeMouse(this.base.current, ev.nativeEvent)

            if (dualAxis.innerBounds.contains(mouse)) {
                const closestPoint = minBy(seriesArr[0].points, (d) =>
                    Math.abs(
                        dualAxis.horizontalAxis.place(d.position) - mouse.x
                    )
                )
                if (closestPoint) {
                    const index = seriesArr[0].points.indexOf(closestPoint)
                    this.hoverIndex = index
                } else {
                    this.hoverIndex = undefined
                }
            } else {
                this.hoverIndex = undefined
            }

            this.props.onHover(this.hoverIndex)
        }
    }
 
    @action.bound private onCursorLeave(): void {
        this.hoverIndex = undefined
        this.props.onHover(this.hoverIndex)
    }
 
    private seriesIsBlur(series: StackedSeries<Time>): boolean {
        return (
            this.props.focusedSeriesNames.length > 0 &&
            !this.props.focusedSeriesNames.includes(series.seriesName)
        )
    }
 
    @computed private get areas(): JSX.Element[] {
        const { dualAxis, seriesArr } = this.props
        const { horizontalAxis, verticalAxis } = dualAxis
        const xBottomLeft = [horizontalAxis.range[0], verticalAxis.range[0]]
        const xBottomRight = [horizontalAxis.range[1], verticalAxis.range[0]]
 
        // Stacked area chart stacks each series upon the previous series, so we must keep track of the last point set we used
        let prevPoints = [xBottomLeft, xBottomRight]
        return seriesArr.map((series) => {
            const mainPoints = series.points.map(
                (point) =>
                    [
                        horizontalAxis.place(point.position),
                        verticalAxis.place(point.value + point.valueOffset),
                    ] as [number, number]
            )
            const points = mainPoints.concat(reverse(clone(prevPoints)) as any)
            prevPoints = mainPoints
 
            return (
                <path
                    className={makeSafeForCSS(series.seriesName) + "-area"}
                    key={series.seriesName + "-area"}
                    strokeLinecap="round"
                    d={pointsToPath(points)}
                    fill={this.seriesIsBlur(series) ? BLUR_COLOR : series.color}
                    fillOpacity={0.7}
                    clipPath={this.props.clipPath}
                />
            )
        })
    }
 
    @computed private get borders(): JSX.Element[] {
        const { dualAxis, seriesArr } = this.props
        const { horizontalAxis, verticalAxis } = dualAxis
 
        // Stacked area chart stacks each series upon the previous series, so we must keep track of the last point set we used
        return seriesArr.map((series) => {
            const points = series.points.map(
                (point) =>
                    [
                        horizontalAxis.place(point.position),
                        verticalAxis.place(point.value + point.valueOffset),
                    ] as [number, number]
            )
 
            return (
                <path
                    className={makeSafeForCSS(series.seriesName) + "-border"}
                    key={series.seriesName + "-border"}
                    strokeLinecap="round"
                    d={pointsToPath(points)}
                    stroke={rgb(
                        this.seriesIsBlur(series) ? BLUR_COLOR : series.color
                    )
                        .darker(0.5)
                        .toString()}
                    strokeOpacity={0.7}
                    strokeWidth={0.5}
                    fill="none"
                    clipPath={this.props.clipPath}
                />
            )
        })
    }
 
    render(): JSX.Element {
        const { dualAxis, seriesArr } = this.props
        const { horizontalAxis, verticalAxis } = dualAxis
        const { hoverIndex } = this
 
        return (
            <g
                ref={this.base}
                className="Areas"
                onMouseMove={this.onCursorMove}
                onMouseLeave={this.onCursorLeave}
                onTouchStart={this.onCursorMove}
                onTouchMove={this.onCursorMove}
                onTouchEnd={this.onCursorLeave}
                onTouchCancel={this.onCursorLeave}
            >
                <rect
                    x={horizontalAxis.range[0]}
                    y={verticalAxis.range[1]}
                    width={horizontalAxis.range[1] - horizontalAxis.range[0]}
                    height={verticalAxis.range[0] - verticalAxis.range[1]}
                    opacity={0}
                    fill="rgba(255,255,255,0)"
                />
                {this.areas}
                {this.borders}
                {hoverIndex !== undefined && (
                    <g className="hoverIndicator">
                        {seriesArr.map((series) => {
                            const point = series.points[hoverIndex]
                            return this.seriesIsBlur(series) ||
                                point.fake ? null : (
                                <circle
                                    key={series.seriesName}
                                    cx={horizontalAxis.place(point.position)}
                                    cy={verticalAxis.place(
                                        point.value + point.valueOffset
                                    )}
                                    r={2}
                                    fill={series.color}
                                />
                            )
                        })}
                        <line
                            x1={horizontalAxis.place(
                                seriesArr[0].points[hoverIndex].position
                            )}
                            y1={verticalAxis.range[0]}
                            x2={horizontalAxis.place(
                                seriesArr[0].points[hoverIndex].position
                            )}
                            y2={verticalAxis.range[1]}
                            stroke="rgba(180,180,180,.4)"
                        />
                    </g>
                )}
            </g>
        )
    }
}
 
@observer
export class StackedAreaChart
    extends AbstactStackedChart
    implements LineLegendManager
{
    constructor(props: AbstactStackedChartProps) {
        super(props)
    }
 
    @computed get midpoints(): number[] {
        let prevY = 0
        return this.series.map((series) => {
            const lastValue = last(series.points)
            if (!lastValue) return 0
 
            const y = lastValue.value + lastValue.valueOffset
            const middleY = prevY + (y - prevY) / 2
            prevY = y
            return middleY
        })
    }
 
    @computed get labelSeries(): LineLabelSeries[] {
        const { midpoints } = this
        return this.series
            .map((series, index) => ({
                color: series.color,
                seriesName: series.seriesName,
                label: series.seriesName,
                yValue: midpoints[index],
            }))
            .reverse()
    }
 
    @computed get maxLineLegendWidth(): number {
        return Math.min(150, this.bounds.width / 3)
    }
 
    @computed get legendDimensions(): LineLegend | undefined {
        if (this.manager.hideLegend) return undefined
        return new LineLegend({ manager: this })
    }
 
    @observable hoveredPointIndex?: number
    @action.bound onHover(hoverIndex: number | undefined): void {
        this.hoveredPointIndex = hoverIndex
    }
 
    @observable hoverSeriesName?: SeriesName
    @action.bound onLineLegendClick(): void {
        if (this.manager.startSelectingWhenLineClicked)
            this.manager.isSelectingData = true
    }
 
    @computed protected get paddingForLegend(): number {
        const { legendDimensions } = this
        return legendDimensions ? legendDimensions.width : 20
    }
 
    @action.bound onLineLegendMouseOver(seriesName: SeriesName): void {
        this.hoverSeriesName = seriesName
    }
 
    @action.bound onLineLegendMouseLeave(): void {
        this.hoverSeriesName = undefined
    }
 
    @computed get focusedSeriesNames(): string[] {
        const { externalLegendFocusBin } = this.manager
        const focusedSeriesNames = excludeUndefined([
            this.props.manager.annotation?.entityName,
            this.hoverSeriesName,
        ])
        if (externalLegendFocusBin) {
            focusedSeriesNames.push(
                ...this.series
                    .map((s) => s.seriesName)
                    .filter((name) => externalLegendFocusBin.contains(name))
            )
        }
        return focusedSeriesNames
    }
 
    @computed get isFocusMode(): boolean {
        return this.focusedSeriesNames.length > 0
    }
 
    seriesIsBlur(series: StackedSeries<Time>): boolean {
        return (
            this.focusedSeriesNames.length > 0 &&
            !this.focusedSeriesNames.includes(series.seriesName)
        )
    }
 
    @computed private get tooltip(): JSX.Element | undefined {
        if (this.hoveredPointIndex === undefined) return undefined

        const { hoveredPointIndex, dualAxis, series } = this

        // Grab the first value to get the year from
        const bottomSeriesPoint = series[0].points[hoveredPointIndex]

        // If some data is missing, don't calculate a total
        const somePointsMissingForHoveredTime = series.some(
            (series) => series.points[hoveredPointIndex].fake
        )

        const legendBlockStyle = {
            width: "10px",
            height: "10px",
            display: "inline-block",
            marginRight: "2px",
        }

        const lastStackedPoint = last(series)!.points[hoveredPointIndex]
        const totalValue = lastStackedPoint.value + lastStackedPoint.valueOffset

        const yColumn = this.yColumns[0] // Assumes same type for all columns.

        return (
            <Tooltip
                tooltipManager={this.props.manager}
                x={dualAxis.horizontalAxis.place(bottomSeriesPoint.position)}
                y={
                    dualAxis.verticalAxis.rangeMin +
                    dualAxis.verticalAxis.rangeSize / 2
                }
                style={{ padding: "0.3em" }}
                offsetX={5}
            >
                <table style={{ fontSize: "0.9em", lineHeight: "1.4em" }}>
                    <tbody>
                        <tr>
                            <td>
                                <strong>
                                    {this.inputTable.timeColumnFormatFunction(
                                        bottomSeriesPoint.position
                                    )}
                                </strong>
                            </td>
                            <td></td>
                        </tr>
                        {series
                            .slice()
                            .reverse()
                            .map((series) => {
                                const point = series.points[hoveredPointIndex]
                                const isBlur = this.seriesIsBlur(series)
                                const textColor = isBlur ? "#ddd" : "#333"
                                const blockColor = isBlur
                                    ? BLUR_COLOR
                                    : series.color
                                return (
                                    <tr
                                        key={series.seriesName}
                                        style={{ color: textColor }}
                                    >
                                        <td
                                            style={{
                                                paddingRight: "0.8em",
                                                fontSize: "0.9em",
                                            }}
                                        >
                                            <div
                                                style={{
                                                    ...legendBlockStyle,
                                                    backgroundColor: blockColor,
                                                }}
                                            />{" "}
                                            {series.seriesName}
                                        </td>
                                        <td style={{ textAlign: "right" }}>
                                            {point.fake
                                                ? "No data"
                                                : yColumn.formatValueLong(
                                                      point.value
                                                  )}
                                        </td>
                                    </tr>
                                )
                            })}
                        {/* Total */}
                        {!somePointsMissingForHoveredTime && (
                            <tr>
                                <td style={{ fontSize: "0.9em" }}>
                                    <div
                                        style={{
                                            ...legendBlockStyle,
                                            backgroundColor: "transparent",
                                        }}
                                    />{" "}
                                    <strong>Total</strong>
                                </td>
                                <td style={{ textAlign: "right" }}>
                                    <span>
                                        <strong>
                                            {yColumn.formatValueLong(
                                                totalValue
                                            )}
                                        </strong>
                                    </span>
                                </td>
                            </tr>
                        )}
                    </tbody>
                </table>
            </Tooltip>
        )
    }
 
    render(): JSX.Element {
        if (this.failMessage)
            return (
                <NoDataModal
                    manager={this.manager}
                    bounds={this.props.bounds}
                    message={this.failMessage}
                />
            )
 
        const { bounds, dualAxis, renderUid, series } = this
 
        const showLegend = !this.manager.hideLegend
 
        const clipPath = makeClipPath(renderUid, {
            ...bounds,
            height: bounds.height * 2,
            x: dualAxis.innerBounds.x,
        })
 
        return (
            <g ref={this.base} className="StackedArea">
                {clipPath.element}
                <DualAxisComponent dualAxis={dualAxis} showTickMarks={true} />
                <g clipPath={clipPath.id}>
                    {showLegend && <LineLegend manager={this} />}
                    <Areas
                        dualAxis={dualAxis}
                        seriesArr={series}
                        focusedSeriesNames={this.focusedSeriesNames}
                        onHover={this.onHover}
                    />
                </g>
                {this.tooltip}
            </g>
        )
    }
    /** Whether we want to display series with only zeroes (inherited). False for this class, true for others */
    get showAllZeroSeries() {
        return false
    }
 
    @computed get lineLegendX(): number {
        return this.legendDimensions
            ? this.bounds.right - this.legendDimensions.width
            : 0
    }
 
    @computed get series(): readonly StackedSeries<number>[] {
        return stackSeries(withMissingValuesAsZeroes(this.unstackedSeries))
    }
}