@sgonzaloc/react-financial-charts-tooltip 3.0.0

package/src/MACDTooltip.tsx

@@ -0,0 +1,116 @@
+import { functor, GenericChartComponent, last } from "@sgonzaloc/react-financial-charts-core";
+import { format } from "d3-format";
+import * as React from "react";
+import { ToolTipText } from "./ToolTipText";
+import { ToolTipTSpanLabel } from "./ToolTipTSpanLabel";
+
+export interface MACDTooltipProps {
+    readonly origin: number[] | ((width: number, height: number) => [number, number]);
+    readonly className?: string;
+    readonly fontFamily?: string;
+    readonly fontSize?: number;
+    readonly fontWeight?: number;
+    readonly labelFill?: string;
+    readonly labelFontWeight?: number;
+    readonly onClick?: (event: React.MouseEvent) => void;
+    readonly options: {
+        slow: number;
+        fast: number;
+        signal: number;
+    };
+    readonly appearance: {
+        strokeStyle: {
+            macd: string;
+            signal: string;
+        };
+        fillStyle: {
+            divergence: string;
+        };
+    };
+    readonly displayFormat: (value: number) => string;
+    readonly displayInit?: string;
+    readonly displayValuesFor: (props: MACDTooltipProps, moreProps: any) => any | undefined;
+    readonly yAccessor: (data: any) => { macd: number; signal: number; divergence: number };
+}
+
+export class MACDTooltip extends React.Component<MACDTooltipProps> {
+    public static defaultProps = {
+        className: "react-financial-charts-tooltip",
+        displayFormat: format(".2f"),
+        displayInit: "n/a",
+        displayValuesFor: (_: any, props: any) => props.currentItem,
+        origin: [0, 0],
+    };
+
+    public render() {
+        return <GenericChartComponent clip={false} svgDraw={this.renderSVG} drawOn={["mousemove"]} />;
+    }
+
+    private readonly renderSVG = (moreProps: any) => {
+        const {
+            onClick,
+            displayInit,
+            fontFamily,
+            fontSize,
+            fontWeight,
+            displayValuesFor,
+            displayFormat,
+            className,
+            yAccessor,
+            options,
+            origin: originProp,
+            appearance,
+            labelFill,
+            labelFontWeight,
+        } = this.props;
+
+        const {
+            chartConfig: { width, height },
+            fullData,
+        } = moreProps;
+
+        const currentItem = displayValuesFor(this.props, moreProps) ?? last(fullData);
+
+        const macdValue = currentItem && yAccessor(currentItem);
+
+        const macd = (macdValue?.macd && displayFormat(macdValue.macd)) || displayInit;
+        const signal = (macdValue?.signal && displayFormat(macdValue.signal)) || displayInit;
+        const divergence = (macdValue?.divergence && displayFormat(macdValue.divergence)) || displayInit;
+
+        const origin = functor(originProp);
+        const [x, y] = origin(width, height);
+
+        return (
+            <g className={className} transform={`translate(${x}, ${y})`} onClick={onClick}>
+                <ToolTipText x={0} y={0} fontFamily={fontFamily} fontSize={fontSize} fontWeight={fontWeight}>
+                    <ToolTipTSpanLabel fill={labelFill} fontWeight={labelFontWeight}>
+                        MACD (
+                    </ToolTipTSpanLabel>
+                    <tspan fill={appearance.strokeStyle.macd}>{options.slow}</tspan>
+                    <ToolTipTSpanLabel fill={labelFill} fontWeight={labelFontWeight}>
+                        ,{" "}
+                    </ToolTipTSpanLabel>
+                    <tspan fill={appearance.strokeStyle.macd}>{options.fast}</tspan>
+                    <ToolTipTSpanLabel fill={labelFill} fontWeight={labelFontWeight}>
+                        ):{" "}
+                    </ToolTipTSpanLabel>
+                    <tspan fill={appearance.strokeStyle.macd}>{macd}</tspan>
+                    <ToolTipTSpanLabel fill={labelFill} fontWeight={labelFontWeight}>
+                        {" "}
+                        Signal (
+                    </ToolTipTSpanLabel>
+                    <tspan fill={appearance.strokeStyle.signal}>{options.signal}</tspan>
+                    <ToolTipTSpanLabel fill={labelFill} fontWeight={labelFontWeight}>
+                        ):{" "}
+                    </ToolTipTSpanLabel>
+                    <tspan fill={appearance.strokeStyle.signal}>{signal}</tspan>
+                    <ToolTipTSpanLabel fill={labelFill} fontWeight={labelFontWeight}>
+                        {" "}
+                        Divergence:{" "}
+                    </ToolTipTSpanLabel>
+                    <tspan fill={appearance.fillStyle.divergence}>{divergence}</tspan>
+                </ToolTipText>
+            </g>
+        );
+    };
+}

package/src/MovingAverageTooltip.tsx

@@ -0,0 +1,145 @@
+import { functor, GenericChartComponent, last, MoreProps } from "@sgonzaloc/react-financial-charts-core";
+import { format } from "d3-format";
+import * as React from "react";
+import { ToolTipText } from "./ToolTipText";
+import { ToolTipTSpanLabel } from "./ToolTipTSpanLabel";
+
+export interface SingleMAToolTipProps {
+    readonly color: string;
+    readonly displayName: string;
+    readonly fontFamily?: string;
+    readonly fontSize?: number;
+    readonly fontWeight?: number;
+    readonly forChart: number | string;
+    readonly labelFill?: string;
+    readonly labelFontWeight?: number;
+    readonly onClick?: (event: React.MouseEvent<SVGRectElement, MouseEvent>, details: any) => void;
+    readonly options: any;
+    readonly origin: [number, number];
+    readonly textFill?: string;
+    readonly value: string;
+}
+
+export class SingleMAToolTip extends React.Component<SingleMAToolTipProps> {
+    public render() {
+        const { color, displayName, fontSize, fontFamily, fontWeight, textFill, labelFill, labelFontWeight, value } =
+            this.props;
+
+        const translate = "translate(" + this.props.origin[0] + ", " + this.props.origin[1] + ")";
+
+        return (
+            <g transform={translate}>
+                <line x1={0} y1={2} x2={0} y2={28} stroke={color} strokeWidth={4} />
+                <ToolTipText x={5} y={11} fontFamily={fontFamily} fontSize={fontSize} fontWeight={fontWeight}>
+                    <ToolTipTSpanLabel fill={labelFill} fontWeight={labelFontWeight}>
+                        {displayName}
+                    </ToolTipTSpanLabel>
+                    <tspan x={5} dy={15} fill={textFill}>
+                        {value}
+                    </tspan>
+                </ToolTipText>
+                <rect x={0} y={0} width={55} height={30} onClick={this.onClick} fill="none" stroke="none" />
+            </g>
+        );
+    }
+
+    private readonly onClick = (event: React.MouseEvent<SVGRectElement, MouseEvent>) => {
+        const { onClick, forChart, options } = this.props;
+        if (onClick !== undefined) {
+            onClick(event, { chartId: forChart, ...options });
+        }
+    };
+}
+
+interface MovingAverageTooltipProps {
+    readonly className?: string;
+    readonly displayFormat: (value: number) => string;
+    readonly origin: number[];
+    readonly displayInit?: string;
+    readonly displayValuesFor?: (props: MovingAverageTooltipProps, moreProps: any) => any;
+    readonly onClick?: (event: React.MouseEvent<SVGRectElement, MouseEvent>) => void;
+    readonly textFill?: string;
+    readonly labelFill?: string;
+    readonly fontFamily?: string;
+    readonly fontSize?: number;
+    readonly fontWeight?: number;
+    readonly width?: number;
+    readonly options: {
+        yAccessor: (data: any) => number;
+        type: string;
+        stroke: string;
+        windowSize: number;
+    }[];
+}
+
+// tslint:disable-next-line: max-classes-per-file
+export class MovingAverageTooltip extends React.Component<MovingAverageTooltipProps> {
+    public static defaultProps = {
+        className: "react-financial-charts-tooltip react-financial-charts-moving-average-tooltip",
+        displayFormat: format(".2f"),
+        displayInit: "n/a",
+        displayValuesFor: (_: any, props: any) => props.currentItem,
+        origin: [0, 10],
+        width: 65,
+    };
+
+    public render() {
+        return <GenericChartComponent clip={false} svgDraw={this.renderSVG} drawOn={["mousemove"]} />;
+    }
+
+    private readonly renderSVG = (moreProps: MoreProps) => {
+        const { chartId, chartConfig, chartConfig: { height = 0 } = {}, fullData } = moreProps;
+
+        const {
+            className,
+            displayInit = MovingAverageTooltip.defaultProps.displayInit,
+            onClick,
+            width = 65,
+            fontFamily,
+            fontSize,
+            fontWeight,
+            textFill,
+            labelFill,
+            origin: originProp,
+            displayFormat,
+            displayValuesFor = MovingAverageTooltip.defaultProps.displayValuesFor,
+            options,
+        } = this.props;
+
+        const currentItem = displayValuesFor(this.props, moreProps) ?? last(fullData);
+
+        const config = chartConfig!;
+
+        const origin = functor(originProp);
+        const [x, y] = origin(width, height);
+        const [ox, oy] = config.origin;
+
+        return (
+            <g transform={`translate(${ox + x}, ${oy + y})`} className={className}>
+                {options.map((each, idx) => {
+                    const yValue = currentItem && each.yAccessor(currentItem);
+
+                    const tooltipLabel = `${each.type} (${each.windowSize})`;
+                    const yDisplayValue = yValue ? displayFormat(yValue) : displayInit;
+                    return (
+                        <SingleMAToolTip
+                            key={idx}
+                            origin={[width * idx, 0]}
+                            color={each.stroke}
+                            displayName={tooltipLabel}
+                            value={yDisplayValue}
+                            options={each}
+                            forChart={chartId}
+                            onClick={onClick}
+                            fontFamily={fontFamily}
+                            fontSize={fontSize}
+                            fontWeight={fontWeight}
+                            textFill={textFill}
+                            labelFill={labelFill}
+                        />
+                    );
+                })}
+            </g>
+        );
+    };
+}

package/src/OHLCTooltip.tsx

@@ -0,0 +1,138 @@
+import { functor, GenericChartComponent, last } from "@sgonzaloc/react-financial-charts-core";
+import { format } from "d3-format";
+import * as React from "react";
+import { ToolTipText } from "./ToolTipText";
+import { ToolTipTSpanLabel } from "./ToolTipTSpanLabel";
+
+const displayTextsDefault = {
+    o: "O: ",
+    h: " H: ",
+    l: " L: ",
+    c: " C: ",
+    na: "n/a",
+};
+
+export interface OHLCTooltipProps {
+    readonly accessor?: (data: any) => any;
+    readonly className?: string;
+    readonly changeFormat?: (n: number | { valueOf(): number }) => string;
+    readonly displayTexts?: {
+        o: string;
+        h: string;
+        l: string;
+        c: string;
+        na: string;
+    };
+    readonly displayValuesFor?: (props: OHLCTooltipProps, moreProps: any) => any;
+    readonly fontFamily?: string;
+    readonly fontSize?: number;
+    readonly fontWeight?: number;
+    readonly labelFill?: string;
+    readonly labelFontWeight?: number;
+    readonly ohlcFormat?: (n: number | { valueOf(): number }) => string;
+    readonly onClick?: (event: React.MouseEvent<SVGGElement, MouseEvent>) => void;
+    readonly origin?: [number, number] | ((width: number, height: number) => [number, number]);
+    readonly percentFormat?: (n: number | { valueOf(): number }) => string;
+    readonly textFill?: string | ((item: any) => string);
+}
+
+export class OHLCTooltip extends React.Component<OHLCTooltipProps> {
+    public static defaultProps = {
+        accessor: (d: unknown) => d,
+        changeFormat: format("+.2f"),
+        className: "react-financial-charts-tooltip-hover",
+        displayTexts: displayTextsDefault,
+        displayValuesFor: (_: any, props: any) => props.currentItem,
+        fontFamily: "-apple-system, system-ui, 'Helvetica Neue', Ubuntu, sans-serif",
+        ohlcFormat: format(".2f"),
+        origin: [0, 0],
+        percentFormat: format("+.2%"),
+    };
+
+    public render() {
+        return <GenericChartComponent clip={false} svgDraw={this.renderSVG} drawOn={["mousemove"]} />;
+    }
+
+    private readonly renderSVG = (moreProps: any) => {
+        const {
+            accessor,
+            changeFormat = OHLCTooltip.defaultProps.changeFormat,
+            className,
+            displayTexts = OHLCTooltip.defaultProps.displayTexts,
+            displayValuesFor = OHLCTooltip.defaultProps.displayValuesFor,
+            fontFamily,
+            fontSize,
+            fontWeight,
+            labelFill,
+            labelFontWeight,
+            ohlcFormat = OHLCTooltip.defaultProps.ohlcFormat,
+            onClick,
+            percentFormat = OHLCTooltip.defaultProps.percentFormat,
+            textFill,
+        } = this.props;
+
+        const {
+            chartConfig: { width, height },
+            fullData,
+        } = moreProps;
+
+        const currentItem = displayValuesFor(this.props, moreProps) ?? last(fullData);
+
+        let open: string = displayTexts.na;
+        let high: string = displayTexts.na;
+        let low: string = displayTexts.na;
+        let close: string = displayTexts.na;
+        let change: string = displayTexts.na;
+
+        if (currentItem !== undefined && accessor !== undefined) {
+            const item = accessor(currentItem);
+            if (item !== undefined) {
+                open = ohlcFormat(item.open);
+                high = ohlcFormat(item.high);
+                low = ohlcFormat(item.low);
+                close = ohlcFormat(item.close);
+                change = `${changeFormat(item.close - item.open)} (${percentFormat(
+                    (item.close - item.open) / item.open,
+                )})`;
+            }
+        }
+
+        const { origin: originProp } = this.props;
+        const [x, y] = functor(originProp)(width, height);
+        const valueFill = functor(textFill)(currentItem);
+
+        return (
+            <g className={className} transform={`translate(${x}, ${y})`} onClick={onClick}>
+                <ToolTipText x={0} y={0} fontFamily={fontFamily} fontSize={fontSize} fontWeight={fontWeight}>
+                    <ToolTipTSpanLabel fill={labelFill} fontWeight={labelFontWeight} key="label_O">
+                        {displayTexts.o}
+                    </ToolTipTSpanLabel>
+                    <tspan key="value_O" fill={valueFill}>
+                        {open}
+                    </tspan>
+                    <ToolTipTSpanLabel fill={labelFill} fontWeight={labelFontWeight} key="label_H">
+                        {displayTexts.h}
+                    </ToolTipTSpanLabel>
+                    <tspan key="value_H" fill={valueFill}>
+                        {high}
+                    </tspan>
+                    <ToolTipTSpanLabel fill={labelFill} fontWeight={labelFontWeight} key="label_L">
+                        {displayTexts.l}
+                    </ToolTipTSpanLabel>
+                    <tspan key="value_L" fill={valueFill}>
+                        {low}
+                    </tspan>
+                    <ToolTipTSpanLabel fill={labelFill} fontWeight={labelFontWeight} key="label_C">
+                        {displayTexts.c}
+                    </ToolTipTSpanLabel>
+                    <tspan key="value_C" fill={valueFill}>
+                        {close}
+                    </tspan>
+                    <tspan key="value_Change" fill={valueFill}>
+                        {` ${change}`}
+                    </tspan>
+                </ToolTipText>
+            </g>
+        );
+    };
+}

package/src/RSITooltip.tsx

@@ -0,0 +1,80 @@
+import { functor, isDefined, GenericChartComponent } from "@sgonzaloc/react-financial-charts-core";
+import { format } from "d3-format";
+import * as React from "react";
+import { ToolTipText } from "./ToolTipText";
+import { ToolTipTSpanLabel } from "./ToolTipTSpanLabel";
+
+export interface RSITooltipProps {
+    readonly className?: string;
+    readonly displayFormat: (value: number) => string;
+    readonly displayInit?: string;
+    readonly displayValuesFor: (props: RSITooltipProps, moreProps: any) => any;
+    readonly fontFamily?: string;
+    readonly fontSize?: number;
+    readonly fontWeight?: number;
+    readonly labelFill?: string;
+    readonly labelFontWeight?: number;
+    readonly onClick?: (event: React.MouseEvent<SVGGElement, MouseEvent>) => void;
+    readonly origin: number[] | ((width: number, height: number) => number[]);
+    readonly options: {
+        windowSize: number;
+    };
+    readonly textFill?: string;
+    readonly yAccessor: (data: any) => number | undefined;
+}
+
+export class RSITooltip extends React.Component<RSITooltipProps> {
+    public static defaultProps = {
+        displayFormat: format(".2f"),
+        displayInit: "n/a",
+        displayValuesFor: (_: RSITooltipProps, props: any) => props.currentItem,
+        origin: [0, 0],
+        className: "react-financial-charts-tooltip",
+    };
+
+    public render() {
+        return <GenericChartComponent clip={false} svgDraw={this.renderSVG} drawOn={["mousemove"]} />;
+    }
+
+    private readonly renderSVG = (moreProps: any) => {
+        const {
+            onClick,
+            displayInit,
+            fontFamily,
+            fontSize,
+            fontWeight,
+            yAccessor,
+            displayFormat,
+            className,
+            options,
+            labelFill,
+            labelFontWeight,
+            textFill,
+            displayValuesFor,
+        } = this.props;
+
+        const {
+            chartConfig: { width, height },
+        } = moreProps;
+
+        const currentItem = displayValuesFor(this.props, moreProps);
+        const rsi = isDefined(currentItem) && yAccessor(currentItem);
+        const value = (rsi && displayFormat(rsi)) || displayInit;
+
+        const { origin: originProp } = this.props;
+        const origin = functor(originProp);
+        const [x, y] = origin(width, height);
+
+        const tooltipLabel = `RSI (${options.windowSize}): `;
+        return (
+            <g className={className} transform={`translate(${x}, ${y})`} onClick={onClick}>
+                <ToolTipText x={0} y={0} fontFamily={fontFamily} fontSize={fontSize} fontWeight={fontWeight}>
+                    <ToolTipTSpanLabel fill={labelFill} fontWeight={labelFontWeight}>
+                        {tooltipLabel}
+                    </ToolTipTSpanLabel>
+                    <tspan fill={textFill}>{value}</tspan>
+                </ToolTipText>
+            </g>
+        );
+    };
+}

package/src/SingleTooltip.tsx

@@ -0,0 +1,122 @@
+import * as React from "react";
+import { ToolTipText } from "./ToolTipText";
+import { ToolTipTSpanLabel } from "./ToolTipTSpanLabel";
+
+export type layouts = "horizontal" | "horizontalRows" | "horizontalInline" | "vertical" | "verticalRows";
+
+export interface SingleTooltipProps {
+    readonly origin: [number, number];
+    readonly yLabel: string;
+    readonly yValue: string;
+    readonly onClick?: (event: React.MouseEvent, details: any) => void;
+    readonly fontFamily?: string;
+    readonly fontSize?: number;
+    readonly fontWeight?: number;
+    readonly labelFill: string;
+    readonly valueFill: string;
+    readonly forChart: number | string;
+    readonly options: any;
+    readonly layout: layouts;
+    readonly withShape: boolean;
+}
+
+export class SingleTooltip extends React.Component<SingleTooltipProps> {
+    public static defaultProps = {
+        labelFill: "#4682B4",
+        valueFill: "#000000",
+        withShape: false,
+    };
+
+    /*
+     * Renders the value next to the label.
+     */
+    public renderValueNextToLabel() {
+        const { origin, yLabel, yValue, labelFill, valueFill, withShape, fontSize, fontFamily, fontWeight } =
+            this.props;
+
+        return (
+            <g transform={`translate(${origin[0]}, ${origin[1]})`} onClick={this.handleClick}>
+                {withShape ? <rect x="0" y="-6" width="6" height="6" fill={valueFill} /> : null}
+                <ToolTipText
+                    x={withShape ? 8 : 0}
+                    y={0}
+                    fontFamily={fontFamily}
+                    fontSize={fontSize}
+                    fontWeight={fontWeight}
+                >
+                    <ToolTipTSpanLabel fill={labelFill}>{yLabel}: </ToolTipTSpanLabel>
+                    <tspan fill={valueFill}>{yValue}</tspan>
+                </ToolTipText>
+            </g>
+        );
+    }
+
+    /*
+     * Renders the value beneath the label.
+     */
+    public renderValueBeneathLabel() {
+        const { origin, yLabel, yValue, labelFill, valueFill, withShape, fontSize, fontFamily, fontWeight } =
+            this.props;
+
+        return (
+            <g transform={`translate(${origin[0]}, ${origin[1]})`} onClick={this.handleClick}>
+                {withShape ? <line x1={0} y1={2} x2={0} y2={28} stroke={valueFill} strokeWidth="4px" /> : null}
+                <ToolTipText x={5} y={11} fontFamily={fontFamily} fontSize={fontSize} fontWeight={fontWeight}>
+                    <ToolTipTSpanLabel fill={labelFill}>{yLabel}</ToolTipTSpanLabel>
+                    <tspan x="5" dy="15" fill={valueFill}>
+                        {yValue}
+                    </tspan>
+                </ToolTipText>
+            </g>
+        );
+    }
+
+    /*
+     * Renders the value next to the label.
+     * The parent component must have a "text"-element.
+     */
+    public renderInline() {
+        const { yLabel, yValue, labelFill, valueFill, fontSize, fontFamily, fontWeight } = this.props;
+
+        return (
+            <tspan onClick={this.handleClick} fontFamily={fontFamily} fontSize={fontSize} fontWeight={fontWeight}>
+                <ToolTipTSpanLabel fill={labelFill}>{yLabel}:&nbsp;</ToolTipTSpanLabel>
+                <tspan fill={valueFill}>{yValue}&nbsp;&nbsp;</tspan>
+            </tspan>
+        );
+    }
+
+    public render() {
+        const { layout } = this.props;
+        let comp: React.ReactElement | null = null;
+
+        switch (layout) {
+            case "horizontal":
+                comp = this.renderValueNextToLabel();
+                break;
+            case "horizontalRows":
+                comp = this.renderValueBeneathLabel();
+                break;
+            case "horizontalInline":
+                comp = this.renderInline();
+                break;
+            case "vertical":
+                comp = this.renderValueNextToLabel();
+                break;
+            case "verticalRows":
+                comp = this.renderValueBeneathLabel();
+                break;
+            default:
+                comp = this.renderValueNextToLabel();
+        }
+
+        return comp;
+    }
+
+    private readonly handleClick = (event: React.MouseEvent) => {
+        const { onClick, forChart, options } = this.props;
+        if (onClick !== undefined) {
+            onClick(event, { chartId: forChart, ...options });
+        }
+    };
+}