// 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, rollup, sum, Bin } from "d3-array"; import { scaleLinear, scaleSequential } from "d3-scale"; import { CardQueue } from "anki/cards"; import type { HistogramData } from "./histogram-graph"; import { interpolateGreens } from "d3-scale-chromatic"; import { dayLabel } from "anki/time"; import type { I18n } from "anki/i18n"; import { GraphRange } from "./graph-helpers"; import type { TableDatum } from "./graph-helpers"; export interface GraphData { dueCounts: Map; haveBacklog: boolean; } export function gatherData(data: pb.BackendProto.GraphsOut): GraphData { const isLearning = (card: pb.BackendProto.Card): boolean => [CardQueue.Learn, CardQueue.PreviewRepeat].includes(card.queue); let haveBacklog = false; const due = (data.cards as pb.BackendProto.Card[]) .filter((c: pb.BackendProto.Card) => { // reviews return ( [CardQueue.Review, CardQueue.DayLearn].includes(c.queue) || // or learning cards isLearning(c) ); }) .map((c: pb.BackendProto.Card) => { let dueDay: number; if (isLearning(c)) { const offset = c.due - data.nextDayAtSecs; dueDay = Math.floor(offset / 86_400) + 1; } else { // - testing just odue fails on day 1 // - testing just odid fails on lapsed cards that // have due calculated at regraduation time const due = c.originalDeckId && c.originalDue ? c.originalDue : c.due; dueDay = due - data.daysElapsed; } haveBacklog = haveBacklog || dueDay < 0; return dueDay; }); const dueCounts = rollup( due, (v) => v.length, (d) => d ); return { dueCounts, haveBacklog }; } function binValue(d: Bin, number>): number { return sum(d, (d) => d[1]); } export interface FutureDueOut { histogramData: HistogramData | null; tableData: TableDatum[]; } export function buildHistogram( sourceData: GraphData, range: GraphRange, backlog: boolean, i18n: I18n ): FutureDueOut { const output = { histogramData: null, tableData: [] }; // get min/max const data = sourceData.dueCounts; if (!data) { return output; } const [xMinOrig, origXMax] = extent(data.keys()); let xMin = xMinOrig; if (!backlog) { xMin = 0; } let xMax = origXMax; // cap max to selected range switch (range) { case GraphRange.Month: xMax = 31; break; case GraphRange.ThreeMonths: xMax = 90; break; case GraphRange.Year: xMax = 365; break; case GraphRange.AllTime: break; } // cap bars to available range const desiredBars = Math.min(70, xMax! - xMin!); const x = scaleLinear().domain([xMin!, xMax!]); const bins = histogram() .value((m) => { return m[0]; }) .domain(x.domain() as any) .thresholds(x.ticks(desiredBars))(data.entries() as any); // empty graph? if (!sum(bins, (bin) => bin.length)) { return output; } const adjustedRange = scaleLinear().range([0.7, 0.3]); const colourScale = scaleSequential((n) => interpolateGreens(adjustedRange(n)!) ).domain([xMin!, xMax!]); const total = sum(bins as any, binValue); function hoverText( data: HistogramData, binIdx: number, cumulative: number, _percent: number ): string { const bin = data.bins[binIdx]; const days = dayLabel(i18n, bin.x0!, bin.x1!); const cards = i18n.tr(i18n.TR.STATISTICS_CARDS_DUE, { cards: binValue(data.bins[binIdx] as any), }); const totalLabel = i18n.tr(i18n.TR.STATISTICS_RUNNING_TOTAL); return `${days}:
${cards}
${totalLabel}: ${cumulative}`; } function makeQuery(data: HistogramData, binIdx: number): string { const bin = data.bins[binIdx]; const start = bin.x0!; const end = bin.x1! - 1; if (start === end) { return `"prop:due=${start}"`; } const fromQuery = `"prop:due>=${start}"`; const tillQuery = `"prop:due<=${end}"`; return `${fromQuery} AND ${tillQuery}`; } const periodDays = xMax! - xMin!; const tableData = [ { label: i18n.tr(i18n.TR.STATISTICS_TOTAL), value: i18n.tr(i18n.TR.STATISTICS_REVIEWS, { reviews: total }), }, { label: i18n.tr(i18n.TR.STATISTICS_AVERAGE), value: i18n.tr(i18n.TR.STATISTICS_REVIEWS_PER_DAY, { count: Math.round(total / periodDays), }), }, { label: i18n.tr(i18n.TR.STATISTICS_DUE_TOMORROW), value: i18n.tr(i18n.TR.STATISTICS_REVIEWS, { reviews: sourceData.dueCounts.get(1) ?? 0, }), }, ]; return { histogramData: { scale: x, bins, total, hoverText, makeQuery, showArea: true, colourScale, binValue, }, tableData, }; }