All files / owid-grapher/grapher/controls Controls.tsx

54.02% Statements 188/348
83.33% Branches 5/6
20.83% Functions 5/24
54.02% Lines 188/348

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 4731x 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 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 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x         1x 1x 2x 2x 1x 1x 2x 2x 1x 1x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 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 1x 1x 1x 1x 1x 1x 13x 13x 1x 1x     1x 1x                                                                                                                                                                                                                                                          
import * as React from "react"
import { computed, action } from "mobx"
import { observer } from "mobx-react"
import { TimelineComponent } from "../timeline/TimelineComponent"
import { formatValue } from "../../clientUtils/formatValue"
import { FontAwesomeIcon } from "@fortawesome/react-fontawesome"
import { faDownload } from "@fortawesome/free-solid-svg-icons/faDownload"
import { faShareAlt } from "@fortawesome/free-solid-svg-icons/faShareAlt"
import { faExpand } from "@fortawesome/free-solid-svg-icons/faExpand"
import { faExternalLinkAlt } from "@fortawesome/free-solid-svg-icons/faExternalLinkAlt"
import { faChevronDown } from "@fortawesome/free-solid-svg-icons/faChevronDown"
import {
    FacetAxisDomain,
    FacetStrategy,
    GrapherTabOption,
    RelatedQuestionsConfig,
    StackMode,
} from "../core/GrapherConstants"
import { ShareMenu, ShareMenuManager } from "./ShareMenu"
import { TimelineController } from "../timeline/TimelineController"
import { AxisConfig } from "../axis/AxisConfig"
import { Tippy } from "../chart/Tippy"
import { Bounds } from "../../clientUtils/Bounds"
import classnames from "classnames"
 
export interface NoDataAreaToggleManager {
    showNoDataArea?: boolean
}
 
@observer
export class NoDataAreaToggle extends React.Component<{
    manager: NoDataAreaToggleManager
}> {
    @action.bound onToggle(): void {
        this.manager.showNoDataArea = !this.manager.showNoDataArea
    }
 
    @computed get manager(): NoDataAreaToggleManager {
        return this.props.manager
    }
 
    render(): JSX.Element {
        const label = "Show 'no data' area"
        return (
            <label className="clickable">
                <input
                    type="checkbox"
                    checked={this.manager.showNoDataArea}
                    onChange={this.onToggle}
                    data-track-note="chart-no-data-area-toggle"
                />{" "}
                &nbsp;{label}
            </label>
        )
    }
}
export interface AbsRelToggleManager {
    stackMode?: StackMode
    relativeToggleLabel?: string
}
 
@observer
export class AbsRelToggle extends React.Component<{
    manager: AbsRelToggleManager
}> {
    @action.bound onToggle(): void {
        this.manager.stackMode = this.isRelativeMode
            ? StackMode.absolute
            : StackMode.relative
    }
 
    @computed get isRelativeMode(): boolean {
        return this.manager.stackMode === StackMode.relative
    }
 
    @computed get manager(): AbsRelToggleManager {
        return this.props.manager
    }
 
    render(): JSX.Element {
        const label = this.manager.relativeToggleLabel ?? "Relative"
        return (
            <label className="clickable">
                <input
                    type="checkbox"
                    checked={this.isRelativeMode}
                    onChange={this.onToggle}
                    data-track-note="chart-abs-rel-toggle"
                />{" "}
                &nbsp;{label}
            </label>
        )
    }
}
 
export interface FacetYDomainToggleManager {
    yAxis?: AxisConfig
}
 
@observer
export class FacetYDomainToggle extends React.Component<{
    manager: FacetYDomainToggleManager
}> {
    @action.bound onToggle(): void {
        this.props.manager.yAxis!.facetDomain = this.isYDomainShared
            ? FacetAxisDomain.independent
            : FacetAxisDomain.shared
    }
 
    @computed get isYDomainShared(): boolean {
        const facetDomain =
            this.props.manager.yAxis!.facetDomain || FacetAxisDomain.shared
        return facetDomain === FacetAxisDomain.shared
    }
 
    render(): JSX.Element {
        return (
            <label className="clickable">
                <input
                    type="checkbox"
                    checked={this.isYDomainShared}
                    onChange={this.onToggle}
                    data-track-note="chart-facet-ydomain-toggle"
                />{" "}
                &nbsp;Uniform y-axis
            </label>
        )
    }
}
 
export interface ZoomToggleManager {
    zoomToSelection?: boolean
}
 
@observer
export class ZoomToggle extends React.Component<{
    manager: ZoomToggleManager
}> {
    @action.bound onToggle(): void {
        this.props.manager.zoomToSelection = this.props.manager.zoomToSelection
            ? undefined
            : true
    }
 
    render(): JSX.Element {
        const label = "Zoom to selection"
        return (
            <label className="clickable">
                <input
                    type="checkbox"
                    checked={this.props.manager.zoomToSelection}
                    onChange={this.onToggle}
                    data-track-note="chart-zoom-to-selection"
                />{" "}
                {label}
            </label>
        )
    }
}
 
export interface SmallCountriesFilterManager {
    populationFilterOption?: number
    minPopulationFilter?: number
}
 
@observer
export class FilterSmallCountriesToggle extends React.Component<{
    manager: SmallCountriesFilterManager
}> {
    @action.bound private onChange(): void {
        this.manager.minPopulationFilter = this.manager.minPopulationFilter
            ? undefined
            : this.filterOption
    }
 
    @computed private get manager(): SmallCountriesFilterManager {
        return this.props.manager
    }
 
    @computed private get filterOption(): number {
        return this.manager.populationFilterOption ?? 1e6
    }
 
    render(): JSX.Element {
        const label = `Hide countries < ${formatValue(
            this.filterOption,
            {}
        )} people`
        return (
            <label className="clickable">
                <input
                    type="checkbox"
                    checked={!!this.manager.minPopulationFilter}
                    onChange={this.onChange}
                    data-track-note="chart-filter-small-countries"
                />{" "}
                &nbsp;{label}
            </label>
        )
    }
}
 
export interface FacetStrategyDropdownManager {
    availableFacetStrategies: FacetStrategy[]
    facetStrategy?: FacetStrategy
    hideFacetControl?: boolean
    entityType?: string
}
 
// A drop-down button that, when clicked, shows a hovering visual display
// indicating the faceting options.
@observer
export class FacetStrategyDropdown extends React.Component<{
    manager: FacetStrategyDropdownManager
}> {
    render(): JSX.Element {
        return (
            <Tippy
                content={this.content}
                interactive={true}
                trigger={"click"}
                placement={"bottom-start"}
                arrow={false}
            >
                <div
                    className="FacetStrategyDropdown"
                    style={{ width: this.dropDownWidth }}
                >
                    {this.facetStrategyLabels[this.facetStrategy]}
                    <div>
                        <FontAwesomeIcon icon={faChevronDown} />
                    </div>
                </div>
            </Tippy>
        )
    }
 
    @computed get facetStrategyLabels(): { [key in FacetStrategy]: string } {
        // arbitrary entity names can be too long for our current design; as a trade-off,
        // we accept them only if they are not too long, otherwise we just use "item"
        const entityType = this.props.manager.entityType ?? "country"
        const entityLabel =
            entityType.length > "country".length ? "item" : entityType

        return {
            [FacetStrategy.none]: "All together",
            [FacetStrategy.entity]: `Split by ${entityLabel}`,
            [FacetStrategy.metric]: "Split by metric",
        }
    }
 
    @computed get strategies(): FacetStrategy[] {
        return (
            this.props.manager.availableFacetStrategies || [
                FacetStrategy.none,
                FacetStrategy.entity,
                FacetStrategy.metric,
            ]
        )
    }
 
    @computed get dropDownWidth(): string {
        const maxWidth = Math.max(
            ...this.strategies.map(
                (s) =>
                    Bounds.forText(this.facetStrategyLabels[s], {
                        fontSize: 12,
                    }).width
            )
        )
        return `${maxWidth + 45}px` // leave room for the chevron
    }
 
    // A hovering visual display giving options to be selected from
    @computed get content(): JSX.Element {
        const parts = this.strategies.map((value: FacetStrategy) => {
            const label = this.facetStrategyLabels[value]
            const children =
                value === FacetStrategy.none ? (
                    // a single solid block
                    <div className="FacetStrategyPreview-none-child"></div>
                ) : (
                    // a 3x2 grid of squares
                    <>
                        <div className="FacetStrategyPreview-split-child"></div>
                        <div className="FacetStrategyPreview-split-child"></div>
                        <div className="FacetStrategyPreview-split-child"></div>
                        <div className="FacetStrategyPreview-split-child"></div>
                        <div className="FacetStrategyPreview-split-child"></div>
                        <div className="FacetStrategyPreview-split-child"></div>
                    </>
                )
            return (
                <div
                    className={classnames({
                        FacetStrategyOption: true,
                        selected: value === this.facetStrategy,
                    })}
                    key={value.toString()}
                >
                    <a
                        onClick={(): void => {
                            this.props.manager.facetStrategy = value
                        }}
                    >
                        <div className="FacetStrategyLabel">{label}</div>
                        <div className={`FacetStrategyPreview-parent`}>
                            {children}
                        </div>
                    </a>
                </div>
            )
        })
        return <div className="FacetStrategyFloat">{parts}</div>
    }
 
    @computed get facetStrategy(): FacetStrategy {
        return this.props.manager.facetStrategy || FacetStrategy.none
    }
}
 
export interface FooterControlsManager extends ShareMenuManager {
    isShareMenuActive?: boolean
    isSelectingData?: boolean
    availableTabs?: GrapherTabOption[]
    currentTab?: GrapherTabOption
    isInIFrame?: boolean
    canonicalUrl?: string
    showTimeline?: boolean
    hasRelatedQuestion?: boolean
    relatedQuestions: RelatedQuestionsConfig[]
    footerControlsHeight?: number
    timelineController?: TimelineController
}
 
@observer
export class FooterControls extends React.Component<{
    manager: FooterControlsManager
}> {
    @computed private get manager(): FooterControlsManager {
        return this.props.manager
    }
 
    @action.bound onShareMenu(): void {
        this.manager.isShareMenuActive = !this.manager.isShareMenuActive
    }
 
    @computed private get availableTabs(): GrapherTabOption[] {
        return this.manager.availableTabs || []
    }
 
    private _getTabsElement(): JSX.Element {
        const { manager } = this
        return (
            <nav className="tabs">
                <ul>
                    {this.availableTabs.map((tabName) => {
                        return tabName !== GrapherTabOption.download ? (
                            <li
                                key={tabName}
                                className={
                                    "tab clickable" +
                                    (tabName === manager.currentTab
                                        ? " active"
                                        : "")
                                }
                            >
                                <a
                                    onClick={(): void => {
                                        manager.currentTab = tabName
                                    }}
                                    data-track-note={"chart-click-" + tabName}
                                >
                                    {tabName}
                                </a>
                            </li>
                        ) : null
                    })}
                    <li
                        className={
                            "tab clickable icon download-tab-button" +
                            (manager.currentTab === GrapherTabOption.download
                                ? " active"
                                : "")
                        }
                        title="Download as .png or .svg"
                    >
                        <a
                            data-track-note="chart-click-download"
                            onClick={(): GrapherTabOption =>
                                (manager.currentTab = GrapherTabOption.download)
                            }
                        >
                            <FontAwesomeIcon icon={faDownload} /> Download
                        </a>
                    </li>
                    <li className="clickable icon">
                        <a
                            title="Share"
                            onClick={this.onShareMenu}
                            data-track-note="chart-click-share"
                        >
                            <FontAwesomeIcon icon={faShareAlt} />
                        </a>
                    </li>
                    {manager.isInIFrame && (
                        <li className="clickable icon">
                            <a
                                title="Open chart in new tab"
                                href={manager.canonicalUrl}
                                data-track-note="chart-click-newtab"
                                target="_blank"
                                rel="noopener"
                            >
                                <FontAwesomeIcon icon={faExpand} />
                            </a>
                        </li>
                    )}
                </ul>
            </nav>
        )
    }
 
    render(): JSX.Element {
        const { manager } = this
        const { isShareMenuActive, hasRelatedQuestion, relatedQuestions } =
            manager
        const tabsElement = (
            <div className="footerRowSingle">{this._getTabsElement()}</div>
        )
 
        const shareMenuElement = isShareMenuActive && (
            <ShareMenu manager={manager} onDismiss={this.onShareMenu} />
        )
 
        const relatedQuestionElement = relatedQuestions &&
            hasRelatedQuestion && (
                <div className="relatedQuestion">
                    Related:&nbsp;
                    <a
                        href={relatedQuestions[0].url}
                        target="_blank"
                        rel="noopener"
                        data-track-note="chart-click-related"
                    >
                        {relatedQuestions[0].text}
                        <FontAwesomeIcon icon={faExternalLinkAlt} />
                    </a>
                </div>
            )
 
        const timeline = manager.showTimeline ? (
            <div className="footerRowSingle">
                <TimelineComponent
                    timelineController={this.manager.timelineController!}
                />
            </div>
        ) : null
 
        return (
            <div
                className={"ControlsFooter"}
                style={{ height: manager.footerControlsHeight ?? 1 }}
            >
                {timeline}
                {tabsElement}
                {shareMenuElement}
                {relatedQuestionElement}
            </div>
        )
    }
}