anki/ts/graphs/ease.ts
2021-01-26 12:47:17 +01:00

106 lines
3.1 KiB
TypeScript

// Copyright: Ankitects Pty Ltd and contributors
// License: GNU AGPL, version 3 or later; http://www.gnu.org/licenses/agpl.html
/* eslint
@typescript-eslint/no-non-null-assertion: "off",
@typescript-eslint/no-explicit-any: "off",
*/
import type pb from "anki/backend_proto";
import { extent, histogram, sum, Bin } from "d3-array";
import { scaleLinear, scaleSequential } from "d3-scale";
import { CardType } from "anki/cards";
import type { HistogramData } from "./histogram-graph";
import { interpolateRdYlGn } from "d3-scale-chromatic";
import type { I18n } from "anki/i18n";
import type { TableDatum, SearchDispatch } from "./graph-helpers";
export interface GraphData {
eases: number[];
}
export function gatherData(data: pb.BackendProto.GraphsOut): GraphData {
const eases = (data.cards as pb.BackendProto.Card[])
.filter((c) => [CardType.Review, CardType.Relearn].includes(c.ctype))
.map((c) => c.easeFactor / 10);
return { eases };
}
function makeQuery(start: number, end: number): string {
if (start === end) {
return `"prop:ease=${start / 100}"`;
}
const fromQuery = `"prop:ease>=${start / 100}"`;
const tillQuery = `"prop:ease<${end / 100}"`;
return `${fromQuery} AND ${tillQuery}`;
}
export function prepareData(
data: GraphData,
i18n: I18n,
dispatch: SearchDispatch,
browserLinksSupported: boolean
): [HistogramData | null, TableDatum[]] {
// get min/max
const allEases = data.eases;
if (!allEases.length) {
return [null, []];
}
const total = allEases.length;
const [, origXMax] = extent(allEases);
let xMax = origXMax;
const xMin = 130;
xMax = xMax! + 1;
const desiredBars = 20;
const scale = scaleLinear().domain([130, xMax!]).nice();
const bins = histogram()
.domain(scale.domain() as any)
.thresholds(scale.ticks(desiredBars))(allEases);
const colourScale = scaleSequential(interpolateRdYlGn).domain([xMin, 300]);
function hoverText(data: HistogramData, binIdx: number, _percent: number): string {
const bin = data.bins[binIdx];
const minPct = Math.floor(bin.x0!);
const maxPct = Math.floor(bin.x1!);
const percent = maxPct - minPct <= 10 ? `${bin.x0}%` : `${bin.x0}%-${bin.x1}%`;
return i18n.tr(i18n.TR.STATISTICS_CARD_EASE_TOOLTIP, {
cards: bin.length,
percent,
});
}
function onClick(bin: Bin<number, number>): void {
const start = bin.x0!;
const end = bin.x1! - 1;
const query = makeQuery(start, end);
dispatch("search", { query });
}
const xTickFormat = (num: number): string => `${num.toFixed(0)}%`;
const tableData = [
{
label: i18n.tr(i18n.TR.STATISTICS_AVERAGE_EASE),
value: xTickFormat(sum(allEases) / total),
},
];
return [
{
scale,
bins,
total,
hoverText,
onClick: browserLinksSupported ? onClick : null,
colourScale,
showArea: false,
xTickFormat,
},
tableData,
];
}