stream-charts 1.0.1 → 1.1.1

package/dist/src/index.d.ts

@@ -1,16 +1,49 @@
-export { seriesFrom, emptySeries, seriesFromTuples, emptySeriesFor, datumOf, Datum, Series, PixelDatum } from './app/charts/datumSeries';
-export { emptyChartData, ChartData, initialChartData } from './app/charts/chartData';
-export { regexFilter } from './app/charts/regexFilter';
 export { Chart } from './app/charts/Chart';
-export { RasterPlot } from "./app/charts/RasterPlot";
-export { ScatterPlot } from "./app/charts/ScatterPlot";
-export { defaultMargin, useChart } from "./app/charts/hooks/useChart";
-export { AxisLocation, defaultLineStyle, Axes, SeriesLineStyle, ZoomResult, AxesLabelFont } from "./app/charts/axes";
-export { ContinuousAxis, addContinuousNumericXAxis, addContinuousNumericYAxis } from "./app/charts/ContinuousAxis";
-export { CategoryAxis } from "./app/charts/CategoryAxis";
-export { assignAxes, createPlotContainer, setClipPath, AxesAssignment, Range, TimeSeries } from "./app/charts/plot";
-export { Tracker, TrackerLabelLocation, TrackerAxisUpdate, TrackerAxisInfo } from "./app/charts/Tracker";
-export { Tooltip } from "./app/charts/Tooltip";
-export { RasterPlotTooltipContent } from "./app/charts/RasterPlotTooltipContent";
-export { ScatterPlotTooltipContent } from "./app/charts/ScatterPlotTooltipContent";
-export { formatNumber, formatTime, formatValue, formatChange, noop, formatValueChange, formatTimeChange, minMaxOf, minMaxYFor } from "./app/charts/utils";
+export { type AxisElementSelection, type SvgSelection, type GSelection, type LineSelection, type TextSelection, type RadialMagnifierSelection, type BarMagnifierSelection, type MagnifierTextSelection, type TrackerSelection } from './app/charts/d3types';
+export { noop, mouseInPlotAreaFor, textWidthOf, textDimensions, formatNumber, formatTime, formatValue, formatChange, formatTimeChange, formatValueChange, minMaxOf } from './app/charts/utils';
+export { type AxisTickStyle, defaultAxisTickStyle, type AxesFont, defaultAxesFont, type SeriesStyle, type SeriesLineStyle, defaultLineStyle, type BaseAxis, type ContinuousNumericAxis, type OrdinalStringAxis, AxisLocation, addOrdinalStringAxis, labelIdFor, type ZoomResult, calculateOrdinalConstrainedZoomFor, calculateConstrainedZoomFor, ordinalAxisZoomHandler, axesZoomHandler, calculatePanFor, panHandler, panHandler2D, axesForSeriesGen, continuousAxisRanges, continuousAxisIntervals, continuousRange } from './app/charts/axes/axes';
+export { AxisInterval } from './app/charts/axes/AxisInterval';
+export { ContinuousAxis, } from './app/charts/axes/ContinuousAxis';
+export { type ContinuousAxisRange, } from './app/charts/axes/ContinuousAxisRange';
+export { OrdinalAxis } from './app/charts/axes/OrdinalAxis';
+export { regexFilter } from './app/charts/filters/regexFilter';
+export { type AxesState, } from './app/charts/axes/AxesState';
+export * from './app/charts/hooks/useAxes';
+export { useAxes, type UseAxesValues, defaultAxesValues } from './app/charts/hooks/useAxes';
+export * from './app/charts/hooks/useChart';
+export { useChart, type NoTooltipMetadata, } from './app/charts/hooks/useChart';
+export * from './app/charts/hooks/useDataObservable';
+export { useDataObservable, } from './app/charts/hooks/useDataObservable';
+export * from './app/charts/hooks/useInitialData';
+export { useInitialData, } from './app/charts/hooks/useInitialData';
+export * from './app/charts/hooks/useMouse';
+export { useMouse, type UseMouseValues, defaultMouseValues, } from './app/charts/hooks/useMouse';
+export {} from './app/charts/hooks/usePlotDimensions';
+export { usePlotDimensions, type UsePlotDimensionsValues, defaultPlotDimensions, defaultMargin } from './app/charts/hooks/usePlotDimensions';
+export {} from './app/charts/hooks/useTooltip';
+export { useTooltip, type UseTooltipValues, defaultTooltipValues, type TooltipData } from './app/charts/hooks/useTooltip';
+export { type ChartData, defaultChartData, copyChartData } from './app/charts/observables/ChartData';
+export { type IterateChartData, copyIterateDataFrom, iteratesObservable } from './app/charts/observables/iterates';
+export { ordinalsObservable, type OrdinalChartData, type OrdinalStats, defaultOrdinalStats, type OrdinalValueStats, defaultOrdinalValueStats, type OrdinalDatumExtremum, initialMinValueDatum, initialMaxValueDatum, initialMinTimeDatum, initialMaxTimeDatum, valueStatusDatumOfDefault, isDefaultValueStatsDatum, copyOrdinalDataFrom, copyOrdinalStats, copyOrdinalValueStats, copyValueStatsForSeries, copyOrdinalDatumExtremum, } from './app/charts/observables/ordinals';
+export { type Series, createPlotContainer, type AxesAssignment, setClipPathG, assignAxes } from './app/charts/plots/plot';
+export { BarPlot } from './app/charts/plots/BarPlot';
+export { NoCurveFactory, PoincarePlot } from './app/charts/plots/PoincarePlot';
+export { RasterPlot } from './app/charts/plots/RasterPlot';
+export { ScatterPlot } from './app/charts/plots/ScatterPlot';
+export { type BaseSeries, seriesFrom, emptySeries, emptySeriesFor } from './app/charts/series/baseSeries';
+export { type IterateDatum, emptyIterateDatum, iterateDatumOf, nonEmptyIterateDatum, type IterateSeries, iterateSeriesFromTuples, } from './app/charts/series/iterateSeries';
+export { type OrdinalDatum, emptyOrdinalDatum, copyOrdinalDatum, ordinalDatumOf, nonEmptyOrdinalDatum, type OrdinalSeries, ordinateSeriesFromTuples, initialOrdinalChartData, } from './app/charts/series/ordinalSeries';
+export { type Datum, datumOf, emptyDatum, type TimeSeries, timeSeriesFromTuples, type PixelDatum } from './app/charts/series/timeSeries';
+export { type TimeSeriesChartData, emptyTimeSeriesChartData, initialTimeSeriesChartData, } from './app/charts/series/timeSeriesChartData';
+export { type BarSeriesStyle, type BarStyle, type LineStyle, defaultBarSeriesStyle, defaultMinMaxBarStyle, defaultWindowedMinMaxBarStyle, defaultWindowedMeanValueLineStyle, defaultValueLineStyle, defaultMeanValueLineStyle } from './app/charts/styling/barPlotStyle';
+export { type Margin, noMargins, type Dimensions, plotDimensionsFrom, containerDimensionsFrom } from './app/charts/styling/margins';
+export { type SvgStyle, initialSvgStyle, grabWidth, grabHeight, type SvgStrokeStyle, STROKE_COLOR, STROKE_WIDTH, STROKE_OPACITY, updateSvgStrokeColor, updateSvgStrokeWidth, updateSvgStrokeOpacity, applyStrokeStylesTo, type SvgFillStyle, updateSvgFillColor, updateSvgFillOpacity, applyFillStylesTo } from './app/charts/styling/svgStyle';
+export { TimeWindowBehavior, subscriptionTimeSeriesFor, subscriptionTimeSeriesWithCadenceFor, subscriptionIteratesFor, type WindowedOrdinalStats, subscriptionOrdinalXFor } from './app/charts/subscriptions/subscriptions';
+export { BarPlotTooltipContent } from './app/charts/tooltips/BarPlotTooltipContent';
+export { PoincarePlotTooltipContent } from './app/charts/tooltips/PoincarePlotTooltipContent';
+export { RasterPlotTooltipContent } from './app/charts/tooltips/RasterPlotTooltipContent';
+export { ScatterPlotTooltipContent } from './app/charts/tooltips/ScatterPlotTooltipContent';
+export { Tooltip } from './app/charts/tooltips/Tooltip';
+export { type TooltipStyle, defaultTooltipStyle, type TooltipDimensions, removeTooltip, tooltipX, tooltipY, categoryTooltipY, boundingPoints, findPointAndNeighbors } from './app/charts/tooltips/tooltipUtils';
+export { type TrackerAxisInfo, type TrackerAxisUpdate, TrackerLabelLocation, Tracker, } from './app/charts/trackers/Tracker';
+export { type TrackerLabelFont, defaultTrackerLabelFont, type TrackerStyle, defaultTrackerStyle, trackerControlInstance, removeTrackerControl, } from './app/charts/trackers/trackerUtils';

package/dist/src/index.js

@@ -1,17 +1,73 @@
-export { seriesFrom, emptySeries, seriesFromTuples, emptySeriesFor, datumOf } from './app/charts/datumSeries';
-export { emptyChartData, initialChartData } from './app/charts/chartData';
-export { regexFilter } from './app/charts/regexFilter';
 export { Chart } from './app/charts/Chart';
-export { RasterPlot } from "./app/charts/RasterPlot";
-export { ScatterPlot } from "./app/charts/ScatterPlot";
-export { defaultMargin, useChart } from "./app/charts/hooks/useChart";
-export { AxisLocation, defaultLineStyle } from "./app/charts/axes";
-export { ContinuousAxis, addContinuousNumericXAxis, addContinuousNumericYAxis } from "./app/charts/ContinuousAxis";
-export { CategoryAxis } from "./app/charts/CategoryAxis";
-export { assignAxes, createPlotContainer, setClipPath } from "./app/charts/plot";
-export { Tracker, TrackerLabelLocation } from "./app/charts/Tracker";
-export { Tooltip } from "./app/charts/Tooltip";
-export { RasterPlotTooltipContent } from "./app/charts/RasterPlotTooltipContent";
-export { ScatterPlotTooltipContent } from "./app/charts/ScatterPlotTooltipContent";
-export { formatNumber, formatTime, formatValue, formatChange, noop, formatValueChange, formatTimeChange, minMaxOf, minMaxYFor } from "./app/charts/utils";
+export { noop, mouseInPlotAreaFor, textWidthOf, textDimensions, formatNumber, formatTime, formatValue, formatChange, formatTimeChange, formatValueChange, minMaxOf } from './app/charts/utils';
+//
+// axes
+//
+export { defaultAxisTickStyle, defaultAxesFont, defaultLineStyle, AxisLocation, addOrdinalStringAxis, labelIdFor, calculateOrdinalConstrainedZoomFor, calculateConstrainedZoomFor, ordinalAxisZoomHandler, axesZoomHandler, calculatePanFor, panHandler, panHandler2D, axesForSeriesGen, continuousAxisRanges, continuousAxisIntervals, continuousRange } from './app/charts/axes/axes';
+export { AxisInterval } from './app/charts/axes/AxisInterval';
+export { ContinuousAxis, } from './app/charts/axes/ContinuousAxis';
+export { OrdinalAxis } from './app/charts/axes/OrdinalAxis';
+//
+// filters
+//
+export { regexFilter } from './app/charts/filters/regexFilter';
+export * from './app/charts/hooks/useAxes';
+export { useAxes, defaultAxesValues } from './app/charts/hooks/useAxes';
+export * from './app/charts/hooks/useChart';
+export { useChart, } from './app/charts/hooks/useChart';
+export * from './app/charts/hooks/useDataObservable';
+export { useDataObservable, } from './app/charts/hooks/useDataObservable';
+export * from './app/charts/hooks/useInitialData';
+export { useInitialData, } from './app/charts/hooks/useInitialData';
+export * from './app/charts/hooks/useMouse';
+export { useMouse, defaultMouseValues, } from './app/charts/hooks/useMouse';
+export { usePlotDimensions, defaultPlotDimensions, defaultMargin } from './app/charts/hooks/usePlotDimensions';
+export { useTooltip, defaultTooltipValues } from './app/charts/hooks/useTooltip';
+//
+// observables
+//
+//
+export { defaultChartData, copyChartData } from './app/charts/observables/ChartData';
+export { copyIterateDataFrom, iteratesObservable } from './app/charts/observables/iterates';
+export { ordinalsObservable, defaultOrdinalStats, defaultOrdinalValueStats, initialMinValueDatum, initialMaxValueDatum, initialMinTimeDatum, initialMaxTimeDatum, valueStatusDatumOfDefault, isDefaultValueStatsDatum, copyOrdinalDataFrom, copyOrdinalStats, copyOrdinalValueStats, copyValueStatsForSeries, copyOrdinalDatumExtremum, } from './app/charts/observables/ordinals';
+//
+// plots
+//
+export { createPlotContainer, setClipPathG, assignAxes } from './app/charts/plots/plot';
+export { BarPlot } from './app/charts/plots/BarPlot';
+export { NoCurveFactory, PoincarePlot } from './app/charts/plots/PoincarePlot';
+export { RasterPlot } from './app/charts/plots/RasterPlot';
+export { ScatterPlot } from './app/charts/plots/ScatterPlot';
+//
+// series
+//
+export { seriesFrom, emptySeries, emptySeriesFor } from './app/charts/series/baseSeries';
+export { emptyIterateDatum, iterateDatumOf, nonEmptyIterateDatum, iterateSeriesFromTuples, } from './app/charts/series/iterateSeries';
+export { emptyOrdinalDatum, copyOrdinalDatum, ordinalDatumOf, nonEmptyOrdinalDatum, ordinateSeriesFromTuples, initialOrdinalChartData, } from './app/charts/series/ordinalSeries';
+export { datumOf, emptyDatum, timeSeriesFromTuples } from './app/charts/series/timeSeries';
+export { emptyTimeSeriesChartData, initialTimeSeriesChartData, } from './app/charts/series/timeSeriesChartData';
+//
+// styling
+//
+export { defaultBarSeriesStyle, defaultMinMaxBarStyle, defaultWindowedMinMaxBarStyle, defaultWindowedMeanValueLineStyle, defaultValueLineStyle, defaultMeanValueLineStyle } from './app/charts/styling/barPlotStyle';
+export { noMargins, plotDimensionsFrom, containerDimensionsFrom } from './app/charts/styling/margins';
+export { initialSvgStyle, grabWidth, grabHeight, STROKE_COLOR, STROKE_WIDTH, STROKE_OPACITY, updateSvgStrokeColor, updateSvgStrokeWidth, updateSvgStrokeOpacity, applyStrokeStylesTo, updateSvgFillColor, updateSvgFillOpacity, applyFillStylesTo } from './app/charts/styling/svgStyle';
+//
+// subscriptions
+//
+export { TimeWindowBehavior, subscriptionTimeSeriesFor, subscriptionTimeSeriesWithCadenceFor, subscriptionIteratesFor, subscriptionOrdinalXFor } from './app/charts/subscriptions/subscriptions';
+//
+// tooltips
+//
+export { BarPlotTooltipContent } from './app/charts/tooltips/BarPlotTooltipContent';
+export { PoincarePlotTooltipContent } from './app/charts/tooltips/PoincarePlotTooltipContent';
+export { RasterPlotTooltipContent } from './app/charts/tooltips/RasterPlotTooltipContent';
+export { ScatterPlotTooltipContent } from './app/charts/tooltips/ScatterPlotTooltipContent';
+export { Tooltip } from './app/charts/tooltips/Tooltip';
+export { defaultTooltipStyle, removeTooltip, tooltipX, tooltipY, categoryTooltipY, boundingPoints, findPointAndNeighbors } from './app/charts/tooltips/tooltipUtils';
+//
+// trackers
+//
+export { TrackerLabelLocation, Tracker, } from './app/charts/trackers/Tracker';
+export { defaultTrackerLabelFont, defaultTrackerStyle, trackerControlInstance, removeTrackerControl, } from './app/charts/trackers/trackerUtils';
 //# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,UAAU,EACV,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,OAAO,EAIV,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAC,cAAc,EAAa,gBAAgB,EAAC,MAAM,wBAAwB,CAAA;AAClF,OAAO,EAAC,WAAW,EAAC,MAAM,0BAA0B,CAAA;AAEpD,OAAO,EAAC,KAAK,EAAC,MAAM,oBAAoB,CAAA;AACxC,OAAO,EAAC,UAAU,EAAC,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAC,WAAW,EAAC,MAAM,0BAA0B,CAAC;AAErD,OAAO,EAAC,aAAa,EAAE,QAAQ,EAAC,MAAM,6BAA6B,CAAC;AAEpE,OAAO,EACH,YAAY,EACZ,gBAAgB,EAKnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAC,cAAc,EAAE,yBAAyB,EAAE,yBAAyB,EAAC,MAAM,6BAA6B,CAAC;AACjH,OAAO,EAAC,YAAY,EAAC,MAAM,2BAA2B,CAAC;AACvD,OAAO,EAAC,UAAU,EAAE,mBAAmB,EAAE,WAAW,EAAoC,MAAM,mBAAmB,CAAC;AAElH,OAAO,EAAC,OAAO,EAAE,oBAAoB,EAAqC,MAAM,sBAAsB,CAAC;AAEvG,OAAO,EAAC,OAAO,EAAC,MAAM,sBAAsB,CAAC;AAC7C,OAAO,EAAC,wBAAwB,EAAC,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EAAC,yBAAyB,EAAC,MAAM,wCAAwC,CAAC;AAEjF,OAAO,EACH,YAAY,EACZ,UAAU,EACV,WAAW,EACX,YAAY,EACZ,IAAI,EACJ,iBAAiB,EACjB,gBAAgB,EAChB,QAAQ,EACR,UAAU,EACb,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,KAAK,EAAC,MAAM,oBAAoB,CAAA;AAcxC,OAAO,EACH,IAAI,EACJ,kBAAkB,EAClB,WAAW,EACX,cAAc,EACd,YAAY,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,gBAAgB,EAAE,iBAAiB,EACxF,QAAQ,EACX,MAAM,oBAAoB,CAAA;AAE3B,EAAE;AACF,OAAO;AACP,EAAE;AAEF,OAAO,EACiB,oBAAoB,EACzB,eAAe,EAER,gBAAgB,EAEtC,YAAY,EACZ,oBAAoB,EACpB,UAAU,EAEV,kCAAkC,EAAE,2BAA2B,EAC/D,sBAAsB,EAAE,eAAe,EACvC,eAAe,EAAE,UAAU,EAAE,YAAY,EACzC,gBAAgB,EAChB,oBAAoB,EAAE,uBAAuB,EAAE,eAAe,EACjE,MAAM,wBAAwB,CAAA;AAE/B,OAAO,EAAC,YAAY,EAAC,MAAM,gCAAgC,CAAA;AAE3D,OAAO,EACH,cAAc,GACjB,MAAM,kCAAkC,CAAA;AAMzC,OAAO,EACH,WAAW,EACd,MAAM,+BAA+B,CAAA;AAEtC,EAAE;AACF,UAAU;AACV,EAAE;AAEF,OAAO,EACH,WAAW,EACd,MAAM,kCAAkC,CAAA;AAUzC,cAAc,4BAA4B,CAAA;AAC1C,OAAO,EACH,OAAO,EACa,iBAAiB,EACxC,MAAM,4BAA4B,CAAA;AAEnC,cAAc,6BAA6B,CAAA;AAC3C,OAAO,EACH,QAAQ,GAEX,MAAM,6BAA6B,CAAA;AAEpC,cAAc,sCAAsC,CAAA;AACpD,OAAO,EACH,iBAAiB,GACpB,MAAM,sCAAsC,CAAA;AAE7C,cAAc,mCAAmC,CAAA;AACjD,OAAO,EACH,cAAc,GACjB,MAAM,mCAAmC,CAAA;AAE1C,cAAc,6BAA6B,CAAA;AAC3C,OAAO,EACH,QAAQ,EACa,kBAAkB,GAC1C,MAAM,6BAA6B,CAAA;AAGpC,OAAO,EACH,iBAAiB,EACa,qBAAqB,EACnD,aAAa,EAChB,MAAM,sCAAsC,CAAA;AAG7C,OAAO,EACH,UAAU,EACa,oBAAoB,EAE9C,MAAM,+BAA+B,CAAA;AAEtC,EAAE;AACF,cAAc;AACd,EAAE;AACF,EAAE;AAEF,OAAO,EACa,gBAAgB,EAChC,aAAa,EAChB,MAAM,oCAAoC,CAAA;AAE3C,OAAO,EAEH,mBAAmB,EACnB,kBAAkB,EACrB,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EACH,kBAAkB,EAEC,mBAAmB,EACd,wBAAwB,EAEhD,oBAAoB,EAAE,oBAAoB,EAC1C,mBAAmB,EAAE,mBAAmB,EACxC,yBAAyB,EACzB,wBAAwB,EACxB,mBAAmB,EAAE,gBAAgB,EAAE,qBAAqB,EAC5D,uBAAuB,EAAE,wBAAwB,GACpD,MAAM,mCAAmC,CAAA;AAE1C,EAAE;AACF,QAAQ;AACR,EAAE;AAEF,OAAO,EAEH,mBAAmB,EAEnB,YAAY,EACZ,UAAU,EACb,MAAM,yBAAyB,CAAA;AAEhC,OAAO,EACH,OAAO,EACV,MAAM,4BAA4B,CAAA;AAEnC,OAAO,EACH,cAAc,EACd,YAAY,EACf,MAAM,iCAAiC,CAAA;AAExC,OAAO,EACH,UAAU,EACb,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EACH,WAAW,EACd,MAAM,gCAAgC,CAAA;AAEvC,EAAE;AACF,SAAS;AACT,EAAE;AACF,OAAO,EAEH,UAAU,EACV,WAAW,EACX,cAAc,EACjB,MAAM,gCAAgC,CAAA;AAEvC,OAAO,EACgB,iBAAiB,EAAE,cAAc,EAAE,oBAAoB,EAE1E,uBAAuB,GAC1B,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EACgB,iBAAiB,EAAE,gBAAgB,EAAE,cAAc,EAAE,oBAAoB,EAE5F,wBAAwB,EACxB,uBAAuB,GAC1B,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EAEH,OAAO,EACP,UAAU,EAEV,oBAAoB,EAEvB,MAAM,gCAAgC,CAAA;AAEvC,OAAO,EAEH,wBAAwB,EACxB,0BAA0B,GAC7B,MAAM,yCAAyC,CAAA;AAEhD,EAAE;AACF,UAAU;AACV,EAAE;AAEF,OAAO,EAEH,qBAAqB,EACrB,qBAAqB,EAAE,6BAA6B,EAAE,iCAAiC,EACvF,qBAAqB,EAAE,yBAAyB,EACnD,MAAM,mCAAmC,CAAA;AAE1C,OAAO,EAEH,SAAS,EAET,kBAAkB,EAAE,uBAAuB,EAC9C,MAAM,8BAA8B,CAAA;AAErC,OAAO,EACY,eAAe,EAC9B,SAAS,EAAE,UAAU,EAErB,YAAY,EAAE,YAAY,EAAE,cAAc,EAC1C,oBAAoB,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,mBAAmB,EAEvF,kBAAkB,EAAE,oBAAoB,EAAE,iBAAiB,EAE9D,MAAM,+BAA+B,CAAA;AAEtC,EAAE;AACF,gBAAgB;AAChB,EAAE;AAEF,OAAO,EACH,kBAAkB,EAClB,yBAAyB,EAAE,oCAAoC,EAC/D,uBAAuB,EAEvB,uBAAuB,EAC1B,MAAM,0CAA0C,CAAA;AAEjD,EAAE;AACF,WAAW;AACX,EAAE;AAEF,OAAO,EACH,qBAAqB,EACxB,MAAM,6CAA6C,CAAA;AAEpD,OAAO,EACH,0BAA0B,EAC7B,MAAM,kDAAkD,CAAA;AAEzD,OAAO,EACH,wBAAwB,EAC3B,MAAM,gDAAgD,CAAA;AAEvD,OAAO,EACH,yBAAyB,EAC5B,MAAM,iDAAiD,CAAA;AAExD,OAAO,EACH,OAAO,EACV,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EACgB,mBAAmB,EAEtC,aAAa,EACb,QAAQ,EAAE,QAAQ,EAClB,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACxB,MAAM,oCAAoC,CAAA;AAE3C,EAAE;AACF,WAAW;AACX,EAAE;AAEF,OAAO,EAGH,oBAAoB,EACpB,OAAO,GACV,MAAM,+BAA+B,CAAA;AAEtC,OAAO,EACoB,uBAAuB,EAC3B,mBAAmB,EACtC,sBAAsB,EACtB,oBAAoB,GACvB,MAAM,oCAAoC,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "stream-charts",
-  "version": "1.0.1",
+  "version": "1.1.1",
   "description": "Charts for steaming data",
   "author": "Rob Philipp",
   "homepage": "https://robphilipp.github.io/stream-charts/",
@@ -9,9 +9,10 @@
   "main": "dist/src/index.js",
   "types": "dist/src/index.d.ts",
   "scripts": {
-    "test": "jest src/app/charts/*.test.ts",
+    "test": "jest src/app/charts/**/*.test.ts*",
     "build": "tsc",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "gen-docs": "npx typedoc src/app/charts/*"
   },
   "eslintConfig": {
     "extends": "react-app"
@@ -29,28 +30,37 @@
     ]
   },
   "devDependencies": {
-    "d3": "^7.0.3",
-    "prelude-ts": "^1.0.3",
-    "react": "^17.0.2",
-    "react-dom": "^17.0.2",
-    "rxjs": "^7.3.0",
-    "@types/d3": "^7.0.0",
-    "@types/jest": "^27.0.2",
-    "@types/node": "^16.9.5",
-    "@types/react": "^17.0.24",
-    "@types/react-dom": "^17.0.9",
-    "ts-jest": "^27.0.5",
-    "ts-loader": "^9.2.6",
-    "ts-node": "^10.2.1",
-    "@testing-library/jest-dom": "^5.14.1",
-    "jest": "^27.2.1",
-    "typescript": "^4.4.3"
+    "@babel/core": "^7.28.4",
+    "@babel/preset-env": "^7.28.3",
+    "@babel/preset-typescript": "^7.27.1",
+    "@jest/globals": "^30.2.0",
+    "@testing-library/dom": "^10.4.1",
+    "@testing-library/jest-dom": "^6.8.0",
+    "@testing-library/react": "^16.3.0",
+    "@testing-library/user-event": "^14.6.1",
+    "@types/d3": "^7.4.3",
+    "@types/jest": "^30.0.0",
+    "@types/node": "^24.6.0",
+    "@types/react": "^19.1.15",
+    "@types/react-dom": "^19.1.9",
+    "d3": "^7.9.0",
+    "data-frame-ts": "^1.0.3",
+    "jest": "^30.2.0",
+    "ts-jest": "^29.4.4",
+    "jest-util": "^30.2.0",
+    "react": "^19.1.1",
+    "react-dom": "^19.1.1",
+    "result-fn": "^0.5.0",
+    "rxjs": "^7.8.2",
+    "svg-table": "^0.1.2",
+    "typescript": "^5.9.2"
   },
   "files": [
     "package.json",
     "README.md",
     "changes.md",
     "dist/src/app/**",
-    "dist/src/index.*"
+    "dist/src/index.*",
+    "src/app/charts/**"
   ]
 }

package/src/app/charts/Chart.tsx

@@ -0,0 +1,334 @@
+import {JSX, useEffect, useMemo, useRef} from 'react'
+import {Dimensions, Margin, plotDimensionsFrom} from "./styling/margins";
+import {initialSvgStyle, SvgStyle} from "./styling/svgStyle";
+import {GSelection} from "./d3types";
+import ChartProvider from "./hooks/useChart";
+import PlotDimensionsProvider, {defaultMargin} from "./hooks/usePlotDimensions";
+import * as d3 from "d3";
+import {SeriesStyle} from "./axes/axes";
+import {createPlotContainer} from "./plots/plot";
+import {noop} from "./utils";
+import AxesProvider from "./hooks/useAxes";
+import MouseProvider from "./hooks/useMouse";
+import TooltipProvider from "./hooks/useTooltip";
+import {Observable, Subscription} from "rxjs";
+import DataObservableProvider from './hooks/useDataObservable';
+import {BaseSeries} from "./series/baseSeries";
+import InitialDataProvider from "./hooks/useInitialData";
+import {ChartData} from "./observables/ChartData";
+import {AxisInterval} from "./axes/AxisInterval";
+
+const defaultBackground = '#202020';
+
+/**
+ * @template CD refers to the chart-data that is used by the Observable that has the stream of data.
+ * @template D refers to the datum in the data-series
+ * @template S refers to the type for the series style
+ */
+interface Props<CD, D, S extends SeriesStyle> {
+    chartId: number
+    /**
+     * The width of the chart container
+     */
+    width: number
+    /**
+     * The height of the chart container
+     */
+    height: number
+    /**
+     * The margin between the edges of the chart container and the axes
+     */
+    margin?: Partial<Margin>
+    /**
+     * The base/default color of the chart lines. This can be overridden by the {@link Props.svgStyle} property.
+     */
+    color?: string
+    /**
+     * The base/default background color. This can be overridden by the {@link Props.svgStyle} property.
+     */
+    backgroundColor?: string
+    /**
+     * Overrides for the SVG style
+     */
+    svgStyle?: Partial<SvgStyle>
+    /**
+     * Map holding the series name to the series style associated with that series.
+     */
+    seriesStyles?: Map<string, S>
+
+    /*
+     | INITIAL DATA
+     */
+    /**
+     * Initial (static) data to plot before subscribing to the {@link TimeSeriesChartData} observable.
+     */
+    initialData: Array<BaseSeries<D>>
+    /**
+     * Optional conversion function that converts an array of base-series with datum type D to a
+     * descendent of a {@link ChartData} object
+     * @param initialData The initial array of series
+     */
+    asChartData?: (initialData: Array<BaseSeries<D>>) => CD
+    /**
+     * Regular expression that filters which series to display on the plot. Can be update while streaming
+     */
+    seriesFilter?: RegExp
+
+    /*
+     | DATA STREAM
+     */
+    /**
+     * {@link TimeSeriesChartData} RxJS `Observable` that feeds the chart data to display (i.e. the data stream).
+     */
+    seriesObservable?: Observable<CD>
+    /**
+     * The time-window (in milliseconds) to buffer the incoming data before updating the chart. This is
+     * a lever to reduce the lag between real-time and chart-time when a large amount of data is being
+     * sourced by the observable. Smaller time-windows result in smoother scrolling, but more updates, and
+     * possibly a larger lag.
+     */
+    windowingTime?: number
+    /**
+     * When switching to `true` from `false`, subscribes to the {@link seriesObservable}. When switching
+     * to `false` from `true`, unsubscribes from the {@link seriesObservable}.
+     */
+    shouldSubscribe?: boolean
+    /**
+     * Callback when the chart subscribes to the {@link TimeSeriesChartData} observable
+     * @param subscription The RxJS subscription
+     */
+    onSubscribe?: (subscription: Subscription) => void
+    /**
+     * Callback when the time range changes. This is generally used by plots where the
+     * x-axis starts to scroll as the data streams in past the end of the current time
+     * window.
+     * @param ranges A function that accepts the ranges, (start, end) associated with
+     * each axis in the plot. The ranges argument is a map(axis_id -> (start, end)).
+     * Where start and end refer to the range for the axis.
+     */
+    onUpdateAxesBounds?: (ranges: Map<string, AxisInterval>) => void
+    /**
+     * Callback for updating the current chart time. This is generally used by plots
+     * where the axes do not represent time, but rather some fix values, and the data
+     * hold time information
+     * @param time The current chart time
+     */
+    onUpdateChartTime?: (time: number) => void
+    /**
+     * Callback function that is called when new data arrives to the chart.
+     * @param seriesName The name of the series for which new data arrived
+     * @param data The new data that arrived in the windowing tine
+     * @see UseChartValues.windowingTime
+     */
+    onUpdateData?: (seriesName: string, data: Array<D>) => void
+
+    /**
+     * The child components of the chart (i.e. the axis, plot, tracker, tooltip)
+     */
+    children: JSX.Element | Array<JSX.Element>;
+}
+
+/**
+ * The chart container that holds the axes, plot, tracker, and tooltip. The chart manages the
+ * subscription, sets up the {@link useChart} hook via the {@link ChartProvider}.
+ * @param props The properties of the chart
+ * @template CD Chart data
+ * @template D The type of the datum type held in a series
+ * @template S The type of the series style
+ * @template TM The type of the tooltip metadata (the data about the series). If not specified,
+ * defaults to an empty object
+ * @constructor
+ * @example
+ *
+
+<Chart
+    width={useGridCellWidth()}
+    height={useGridCellHeight()}
+    margin={{...defaultMargin, top: 60, right: 75, left: 70}}
+    color={theme.color}
+    backgroundColor={theme.backgroundColor}
+    seriesStyles={new Map([
+        ['neuron1', {
+            ...defaultLineStyle,
+            color: 'orange',
+            lineWidth: 2,
+            highlightColor: 'orange'
+        }],
+        ['neuron6', {
+            ...defaultLineStyle,
+            color: theme.name === 'light' ? 'blue' : 'gray',
+            lineWidth: 3,
+            highlightColor: theme.name === 'light' ? 'blue' : 'gray',
+            highlightWidth: 5
+        }],
+    ])}
+    initialData={initialDataRef.current}
+    seriesFilter={filter}
+    seriesObservable={observableRef.current}
+    shouldSubscribe={running}
+    onUpdateTime={handleChartTimeUpdate}
+    windowingTime={150}
+>
+    <ContinuousAxis
+        axisId="x-axis-1"
+        location={AxisLocation.Bottom}
+        domain={[0, 5000]}
+        label="t (ms)"
+    />
+    <CategoryAxis
+        axisId="y-axis-1"
+        location={AxisLocation.Left}
+        categories={initialDataRef.current.map(series => series.name)}
+        label="neuron"
+    />
+    <CategoryAxis
+        axisId="y-axis-2"
+        location={AxisLocation.Right}
+        categories={initialDataRef.current.map(series => series.name)}
+        label="neuron"
+    />
+    <Tracker
+        visible={visibility.tracker}
+        labelLocation={TrackerLabelLocation.WithMouse}
+        style={{color: theme.color}}
+        font={{color: theme.color}}
+    />
+    <Tooltip
+        visible={visibility.tooltip}
+        style={{
+            fontColor: theme.color,
+            backgroundColor: theme.backgroundColor,
+            borderColor: theme.color,
+            backgroundOpacity: 0.9,
+        }}
+    >
+        <RasterPlotTooltipContent
+            xFormatter={value => formatNumber(value, " ,.0f") + ' ms'}
+            yFormatter={value => formatNumber(value, " ,.1f") + ' mV'}
+        />
+    </Tooltip>
+    <RasterPlot
+        spikeMargin={1}
+        dropDataAfter={5000}
+        panEnabled={true}
+        zoomEnabled={true}
+        zoomKeyModifiersRequired={true}
+    />
+</Chart>
+*/
+export function Chart<CD extends ChartData, D, S extends SeriesStyle, TM>(props: Props<CD, D, S>): JSX.Element {
+    const {
+        chartId,
+
+        width,
+        height,
+        color = '#d2933f',
+        backgroundColor = defaultBackground,
+        seriesStyles = new Map(),
+        initialData,
+        asChartData,
+        seriesFilter = /./,
+        seriesObservable,
+        windowingTime = 100,
+        shouldSubscribe = true,
+
+        onSubscribe = noop,
+        onUpdateAxesBounds = noop,
+        onUpdateChartTime = noop,
+        onUpdateData = noop,
+
+        children,
+    } = props
+
+    // override the defaults with the parent's properties, leaving any unset values as the default value
+    const margin = {...defaultMargin, ...props.margin}
+    const svgStyle = useMemo<SvgStyle>(
+        () => ({...initialSvgStyle, ...props.svgStyle, width: props.width, height: props.height}),
+        [props.height, props.svgStyle, props.width]
+    )
+
+    // hold a reference to the current width and the plot dimensions
+    const plotDimRef = useRef<Dimensions>(plotDimensionsFrom(width, height, margin))
+
+    // the container that holds the d3 svg element
+    const mainGRef = useRef<GSelection | null>(null)
+    const containerRef = useRef<SVGSVGElement>(null)
+
+    // creates the main <g> element for the chart if it doesn't already exist, otherwise
+    // updates the svg element with the updated dimensions or style properties
+    useEffect(
+        () => {
+            if (containerRef.current) {
+                // create the main SVG element if it doesn't already exist
+                if (!mainGRef.current) {
+                    mainGRef.current = createPlotContainer(chartId, containerRef.current, plotDimRef.current, color)
+                }
+
+                // build up the svg style from the defaults and any svg style object
+                // passed in as properties
+                const style = Object.getOwnPropertyNames(svgStyle)
+                    .map(name => `${name}: ${svgStyle[name]}; `)
+                    .join("")
+
+                // when the chart "backgroundColor" property is set (i.e. not the default value),
+                // then we need add it to the styles, overwriting any color that may have been
+                // set in the svg style object
+                const background = backgroundColor !== defaultBackground ?
+                    `background-color: ${backgroundColor}; ` :
+                    ''
+
+                // update the dimension and style
+                d3.select<SVGSVGElement, any>(containerRef.current)
+                    .attr('width', width)
+                    .attr('height', height)
+                    .attr('style', style + background + ` color: ${color}`)
+            }
+        },
+        [color, backgroundColor, height, svgStyle, width, chartId]
+    )
+
+    return (
+        <>
+            <svg ref={containerRef}/>
+            <PlotDimensionsProvider containerDimensions={{width, height}} margin={margin}>
+                <AxesProvider onUpdateAxesInterval={onUpdateAxesBounds}>
+                    <MouseProvider<D, TM>>
+                        <TooltipProvider<D, TM>>
+                            <InitialDataProvider<CD, D>
+                                initialData={initialData}
+                                asChartData={asChartData}
+                            >
+                                <DataObservableProvider<CD, D>
+                                    seriesObservable={seriesObservable}
+                                    windowingTime={windowingTime}
+                                    shouldSubscribe={shouldSubscribe}
+
+                                    onSubscribe={onSubscribe}
+                                    onUpdateData={onUpdateData}
+                                    onUpdateChartTime={onUpdateChartTime}
+                                >
+                                    <ChartProvider
+                                        chartId={chartId}
+                                        container={containerRef.current}
+                                        mainG={mainGRef.current}
+
+                                        color={color}
+                                        backgroundColor={backgroundColor}
+                                        svgStyle={svgStyle}
+                                        seriesStyles={seriesStyles}
+                                        seriesFilter={seriesFilter}
+                                    >
+                                        {
+                                            // the chart elements are the children
+                                            children
+                                        }
+                                    </ChartProvider>
+                                </DataObservableProvider>
+                            </InitialDataProvider>
+                        </TooltipProvider>
+                    </MouseProvider>
+                </AxesProvider>
+            </PlotDimensionsProvider>
+        </>
+    );
+}

package/src/app/charts/axes/AxesState.test.ts

@@ -0,0 +1,34 @@
+import {AxesState} from "./AxesState";
+import {AxisLocation, BaseAxis} from "./axes";
+import {AxisElementSelection} from "../d3types";
+
+describe('AxesState', () => {
+    describe('creating axes-state', () => {
+        it('should create an empty axes state', () => {
+            expect(AxesState.empty<BaseAxis>().isEmpty()).toBe(true)
+        });
+
+        it('should create an axes state with one axis', () => {
+            const axis: BaseAxis = {
+                axisId: 'new-axis',
+                location: AxisLocation.Bottom,
+                selection: undefined as unknown as AxisElementSelection
+            }
+            const axesState = AxesState.from<BaseAxis>(new Map([['new-added-axis', axis]]));
+            expect(axesState.isEmpty()).toBe(false);
+        })
+
+        it('should be able to start with an empty axes state and add to it', () => {
+            const axesState = AxesState.empty<BaseAxis>();
+            expect(axesState.isEmpty()).toBe(true);
+
+            const axis: BaseAxis = {
+                axisId: 'new-axis',
+                location: AxisLocation.Bottom,
+                selection: undefined as unknown as AxisElementSelection
+            }
+            const updatedAxesState = axesState.addAxis(axis, 'new-added-axis');
+            expect(updatedAxesState.isEmpty()).toBe(false);
+        })
+    })
+})